imclab / smflite

A minimal class library for handling standard MIDI files on Unity.

smflite

smflite is a minimal class library for handling standard MIDI files (SMF) on Unity.

What it is used for

• Audio visual app: synchronize animations to pre-recorded audio clips.
• Rhythm games: retrieve timing information from song data.

What it can't be used for

• Playback MIDI song files.
• Retrieve metadata or sys-ex data from SMFs.

How to use

First of all, load a MIDI file with MidiFileLoader.Load. It returns a MidiFileContainer instance which contains song data.

MidiFileContainer song = MidiFileLoader.Load (smfAsset.bytes);

And then create MidiTrackSequencer with the song data. You can specify a BPM value for playback here.

seq = new MidiTrackSequencer (song.tracks[0], song.division, bpm);

Call the Start method with the sequencer class. It return a set of midi events (MidiEvent) which is placed at the beginning of the song.

foreach (MidiEvent e in seq.Start ()) {
  // Do something with a MidiEvent.
}

Call the Advance method on every frame. You should give a delta-time, and then it returns a set of midi events which occurred between the previous frame and the current one.

void Update() {
  if (seq.Playing) {
    foreach (MidiEvent e in seq.Advance (Time.deltaTime)) {
      // Do something with a MidiEvent.
    }
  }
}

Run it until the Playing property becomes false.

You can find a sample project in the [test branch] (https://github.com/keijiro/smflite/tree/test) of this repository.

License

Copyright (C) 2013 Keijiro Takahashi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.