MIDI.js/README.md

109 lines
5.2 KiB
Markdown
Raw Normal View History

CODE EXAMPLES (from the repo)
* ./demo-Basic.html is the most basic implementation as seen here:
<pre>
MIDI.loadPlugin({
soundfontUrl: "./soundfont/", // path to soundfont directory
instruments: [ "acoustic_grand_piano", "synth_drum" ], // multiple instruments
callback: function() {
MIDI.programChange(0, 0); // change channel 0 to instrument 0 (acoustic_grand_piano)
MIDI.programChange(1, 118); // change channel 1 to instrument 118 (synth_drum)
for (var n = 0; n < 100; n ++) {
var delay = n / 4; // play one note every quarter second
var note = MIDI.pianoKeyOffset + n; // the MIDI note
var velocity = 127; // how hard the note hits
// play the note
MIDI.noteOn(0, note, velocity, delay);
// play the some note 3-steps up
MIDI.noteOn(1, note + 3, velocity, delay);
}
}
});
</pre>
* ./demo-MIDIPlayer.html shows how to parse MIDI files, and interact with the data stream.
* ./demo-WhitneyMusicBox.html is a audio/visual experiment by Jim Bumgardner
-------------
DEMOS
* <a href="http://qiao.github.com/euphony/">Euphony 3D Piano</a>
* <a href="http://labs.uxmonk.com/simon-says/">Simon Says</a>
* <a href="http://labs.uxmonk.com/brite-lite/">Brite Lite</a>
* <a href="http://mudcu.be/piano/">Color Piano</a>
-------------
SOUNDFONT GENERATORS (*not* required to get started!)
* Ruby
* Shell
-------------
2013-01-23 01:09:06 +01:00
* <a href="./js/MIDI.loadPlugin.js">MIDI.loadPlugin.js</a>: Decides which framework is best to use, and sends request.
2012-02-16 05:46:03 +01:00
<pre>
// interface to download soundfont, then execute callback;
2012-11-21 11:29:57 +01:00
MIDI.loadPlugin(callback);
2012-02-16 05:46:03 +01:00
// simple example to get started;
2012-11-21 11:29:57 +01:00
MIDI.loadPlugin({
instrument: "acoustic_grand_piano", // or 1 (default)
instruments: [ "acoustic_grand_piano", "acoustic_guitar_nylon" ], // or multiple instruments
callback: function() { }
2012-11-21 11:29:57 +01:00
});
2012-02-16 05:46:03 +01:00
</pre>
2013-01-23 01:09:06 +01:00
* <a href="./soundfont/soundfont-ogg.js">MIDI.Soundfont.js</a>: Customizable base64 Soundfont.
* <a href="./js/MIDI.Plugin.js">MIDI.Plugin.js</a>: Ties together the following frameworks;
<pre>
2012-02-16 05:46:03 +01:00
MIDI.noteOn(channel, note, velocity, delay);
MIDI.noteOff(channel, note, delay);
MIDI.chordOn(channel, chord, velocity, delay);
MIDI.chordOff(channel, chord, delay);
MIDI.keyToNote = object; // A0 => 21
MIDI.noteToKey = object; // 21 => A0
2013-01-23 01:09:06 +01:00
</pre>
* <a href="./js/MIDI.Player.js">MIDI.Player.js</a>: Streams the MIDI to the browser.
<pre>
2012-02-16 05:46:03 +01:00
MIDI.Player.currentTime = integer; // time we are at now within the song.
MIDI.Player.endTime = integer; // time when song ends.
MIDI.Player.playing = boolean; // are we playing? yes or no.
MIDI.Player.loadFile(file, callback); // load .MIDI from base64 or binary XML request.
MIDI.Player.start(); // start the MIDI track (you can put this in the loadFile callback)
MIDI.Player.resume(); // resume the MIDI track from pause.
MIDI.Player.pause(); // pause the MIDI track.
MIDI.Player.stop(); // stops all audio being played, and resets currentTime to 0.
<b>Callback whenever a note is played;</b>
MIDI.Player.removeListener(); // removes current listener.
MIDI.Player.addListener(function(data) { // set it to your own function!
var now = data.now; // where we are now
var end = data.end; // time when song ends
var channel = data.channel; // channel note is playing on
var message = data.message; // 128 is noteOff, 144 is noteOn
var note = data.note; // the note
var velocity = data.velocity; // the velocity of the note
// then do whatever you want with the information!
2012-02-16 05:46:03 +01:00
});
<b>Smooth animation, interpolates between onMidiEvent calls;</b>
MIDI.Player.clearAnimation(); // clears current animation.
MIDI.Player.setAnimation(function(data) {
var now = data.now; // where we are now
var end = data.end; // time when song ends
var events = data.events; // all the notes currently being processed
// then do what you want with the information!
2013-01-23 01:09:06 +01:00
});</pre>
* <a href="./js/Color.js">Color.js</a>: Color conversions, music isn&rsquo;t complete without!
<pre>Color.Space(0xff0000, "HEX>RGB>HSL");</pre>
* <a href="./js/DOMLoader.script.js">DOMLoader.script.js</a>: Loads scripts in synchronously, or asynchronously.
<pre>DOMLoader.script.add(src, callback);</pre>
* <a href="./js/DOMLoader.XMLHttp.js">DOMLoader.XMLHttp.js</a>: Cross-browser XMLHttpd request.
<pre>DOMLoader.sendRequest(src, callback);</pre>
* <a href="./js/MusicTheory.Synesthesia.js">MusicTheory.Synesthesia.js</a>: Note-to-color mappings (from Isaac Newton onwards).
2012-02-16 05:46:03 +01:00
<h3>Many thanks to the authors of these libraries;</h3>
2013-01-23 01:09:06 +01:00
* <a href="http://dev.w3.org/html5/spec/Overview.html">&lt;audio&gt;</a>: HTML5 specs
* <a href="https://dvcs.w3.org/hg/audio/raw-file/tip/webaudio/specification.html">WebAudioAPI</a>: W3C proposal by Google
* Java package: <a href="https://github.com/abudaan/midibridge-js">MIDIBridge</a> by <a href="http://abumarkub.net">Daniel van der Meer</a>. Supports MIDI keyboard, and 128 General MIDI instruments.
* Flash package: <a href="http://www.schillmania.com/projects/soundmanager2/">SoundManager2</a> by <a href="http://schillmania.com">Scott Schiller</a>
* <a href="https://github.com/gasman/jasmid">jasmid</a>: Reads MIDI file byte-code, and translats into a Javascript array.
* <a href="http://blog.danguer.com/2011/10/24/base64-binary-decoding-in-javascript/">base642binary.js</a>: Cleans up XML base64-requests for Web Audio API.