src/midifile.h

   1 // Emacs style mode select   -*- C++ -*-
   2 //-----------------------------------------------------------------------------
   3 //
   4 // Copyright(C) 2009 Simon Howard
   5 //
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  19 // 02111-1307, USA.
  20 //
  21 // DESCRIPTION:
  22 //     MIDI file parsing.
  23 //
  24 //-----------------------------------------------------------------------------
  25
  26 #ifndef MIDIFILE_H
  27 #define MIDIFILE_H
  28
  29 typedef struct midi_file_s midi_file_t;
  30 typedef struct midi_track_iter_s midi_track_iter_t;
  31
  32 #define MIDI_CHANNELS_PER_TRACK 16
  33
  34 typedef enum
  35 {
  36     MIDI_EVENT_NOTE_OFF        = 0x80,
  37     MIDI_EVENT_NOTE_ON         = 0x90,
  38     MIDI_EVENT_AFTERTOUCH      = 0xa0,
  39     MIDI_EVENT_CONTROLLER      = 0xb0,
  40     MIDI_EVENT_PROGRAM_CHANGE  = 0xc0,
  41     MIDI_EVENT_CHAN_AFTERTOUCH = 0xd0,
  42     MIDI_EVENT_PITCH_BEND      = 0xe0,
  43
  44     MIDI_EVENT_SYSEX           = 0xf0,
  45     MIDI_EVENT_SYSEX_SPLIT     = 0xf7,
  46     MIDI_EVENT_META            = 0xff,
  47 } midi_event_type_t;
  48
  49 typedef enum
  50 {
  51     MIDI_CONTROLLER_BANK_SELECT     = 0x0,
  52     MIDI_CONTROLLER_MODULATION      = 0x1,
  53     MIDI_CONTROLLER_BREATH_CONTROL  = 0x2,
  54     MIDI_CONTROLLER_FOOT_CONTROL    = 0x3,
  55     MIDI_CONTROLLER_PORTAMENTO      = 0x4,
  56     MIDI_CONTROLLER_DATA_ENTRY      = 0x5,
  57
  58     MIDI_CONTROLLER_MAIN_VOLUME     = 0x7,
  59     MIDI_CONTROLLER_PAN             = 0xa
  60 } midi_controller_t;
  61
  62 typedef enum
  63 {
  64     MIDI_META_SEQUENCE_NUMBER       = 0x0,
  65
  66     MIDI_META_TEXT                  = 0x1,
  67     MIDI_META_COPYRIGHT             = 0x2,
  68     MIDI_META_TRACK_NAME            = 0x3,
  69     MIDI_META_INSTR_NAME            = 0x4,
  70     MIDI_META_LYRICS                = 0x5,
  71     MIDI_META_MARKER                = 0x6,
  72     MIDI_META_CUE_POINT             = 0x7,
  73
  74     MIDI_META_CHANNEL_PREFIX        = 0x20,
  75     MIDI_META_END_OF_TRACK          = 0x2f,
  76
  77     MIDI_META_SET_TEMPO             = 0x51,
  78     MIDI_META_SMPTE_OFFSET          = 0x54,
  79     MIDI_META_TIME_SIGNATURE        = 0x58,
  80     MIDI_META_KEY_SIGNATURE         = 0x59,
  81     MIDI_META_SEQUENCER_SPECIFIC    = 0x7f,
  82 } midi_meta_event_type_t;
  83
  84 typedef struct
  85 {
  86     // Meta event type:
  87
  88     unsigned int type;
  89
  90     // Length:
  91
  92     unsigned int length;
  93
  94     // Meta event data:
  95
  96     byte *data;
  97 } midi_meta_event_data_t;
  98
  99 typedef struct
 100 {
 101     // Length:
 102
 103     unsigned int length;
 104
 105     // Event data:
 106
 107     byte *data;
 108 } midi_sysex_event_data_t;
 109
 110 typedef struct
 111 {
 112     // The channel number to which this applies:
 113
 114     unsigned int channel;
 115
 116     // Extra parameters:
 117
 118     unsigned int param1;
 119     unsigned int param2;
 120 } midi_channel_event_data_t;
 121
 122 typedef struct
 123 {
 124     // Time between the previous event and this event.
 125     unsigned int delta_time;
 126
 127     // Type of event:
 128     midi_event_type_t event_type;
 129
 130     union
 131     {
 132         midi_channel_event_data_t channel;
 133         midi_meta_event_data_t meta;
 134         midi_sysex_event_data_t sysex;
 135     } data;
 136 } midi_event_t;
 137
 138 // Load a MIDI file.
 139
 140 midi_file_t *MIDI_LoadFile(char *filename);
 141
 142 // Free a MIDI file.
 143
 144 void MIDI_FreeFile(midi_file_t *file);
 145
 146 // Get the time division value from the MIDI header.
 147
 148 unsigned int MIDI_GetFileTimeDivision(midi_file_t *file);
 149
 150 // Get the number of tracks in a MIDI file.
 151
 152 unsigned int MIDI_NumTracks(midi_file_t *file);
 153
 154 // Start iterating over the events in a track.
 155
 156 midi_track_iter_t *MIDI_IterateTrack(midi_file_t *file, unsigned int track_num);
 157
 158 // Free an iterator.
 159
 160 void MIDI_FreeIterator(midi_track_iter_t *iter);
 161
 162 // Get the time until the next MIDI event in a track.
 163
 164 unsigned int MIDI_GetDeltaTime(midi_track_iter_t *iter);
 165
 166 // Get a pointer to the next MIDI event.
 167
 168 int MIDI_GetNextEvent(midi_track_iter_t *iter, midi_event_t **event);
 169
 170 // Reset an iterator to the beginning of a track.
 171
 172 void MIDI_RestartIterator(midi_track_iter_t *iter);
 173
 174 #endif /* #ifndef MIDIFILE_H */
 175