deac/MIDI.js
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add demos and more code examples to README

Browse source
This commit is contained in:
Michael Deal 2013-01-22 16:23:40 -08:00
parent edbb8113b8
commit 53c40f3cf3
1 changed files with 58 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -1,12 +1,55 @@
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
-------------
* <a href="./js/MIDI.loadPlugin.js">MIDI.loadPlugin.js</a>: Decides which framework is best to use, and sends request.
<pre>
// interface to download soundfont, then execute callback;
MIDI.loadPlugin(callback);
// simple example to get started;
MIDI.loadPlugin({
instrument: "acoustic_grand_piano", // or 1 (default)
instruments: [ "acoustic_grand_piano", "acoustic_guitar_nylon" ], // or multiple instruments
callback: function() { }
instrument: "acoustic_grand_piano", // or 1 (default)
instruments: [ "acoustic_grand_piano", "acoustic_guitar_nylon" ], // or multiple instruments
callback: function() { }
});
</pre>
@ -21,7 +64,7 @@ MIDI.keyToNote = object; // A0 => 21
MIDI.noteToKey = object; // 21 => A0
</pre>
* <a href="./js/MIDI.Player.js">MIDI.Player.js</a>: Streams the MIDI to the browser.
<pre>
<pre>
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.
@ -33,21 +76,21 @@ 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!
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!
});
<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!
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!
});</pre>
* <a href="./js/Color.js">Color.js</a>: Color conversions, music isn&rsquo;t complete without!