python/midi.c

   1 /*
   2   midi.c -- implement Python midi parser module
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2001--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7             Jan Nieuwenhuizen <janneke@gnu.org>
   8
   9 */
  10
  11 /*
  12
  13 python
  14 import midi
  15 s = open ("s.midi").read ()
  16 midi.parse_track (s)
  17 midi.parse (s)
  18
  19
  20 returns a MIDI file as the tuple
  21
  22  (format, division, TRACKLIST)
  23
  24 each track is an EVENTLIST, where EVENT is
  25
  26   (time, (type, ARG1, [ARG2]))
  27
  28 */
  29
  30 #include <Python.h>
  31
  32 /* PyMIDINIT_FUNC isn't defined in Python < 2.3 */
  33 #ifndef PyMODINIT_FUNC
  34 #       if defined(__cplusplus)
  35 #               define PyMODINIT_FUNC extern "C" void
  36 #       else /* __cplusplus */
  37 #               define PyMODINIT_FUNC void
  38 #       endif /* __cplusplus */
  39 #endif
  40
  41 #if 0
  42 int x = 0;
  43 int *track = &x;
  44 #define debug_print(f, args...) fprintf (stderr, "%s:%d: track: %p :" f, __FUNCTION__, __LINE__, *track, ##args)
  45 #else
  46 #define debug_print(f, args...)
  47 #endif
  48
  49 static PyObject *Midi_error;
  50 static PyObject *Midi_warning;
  51
  52 static PyObject *
  53 midi_error (char const *func, char *s)
  54 {
  55   char *dest = (char*) malloc (sizeof (char) * (strlen (func) + strlen (s) + 1));
  56   strcpy (dest, func);
  57   strcat (dest, s);
  58   PyErr_SetString (Midi_error, dest);
  59   free (dest);
  60
  61   return 0;
  62 }
  63
  64 static PyObject *
  65 midi_warning (char const *s)
  66 {
  67   PyErr_SetString (Midi_warning, s);
  68   return 0;
  69 }
  70
  71
  72 typedef struct message {
  73   unsigned char msg;
  74   char * description;
  75 } message_t;
  76
  77 message_t channelVoiceMessages[] = {
  78   0x80, "NOTE_OFF",
  79   0x90, "NOTE_ON",
  80   0xA0, "POLYPHONIC_KEY_PRESSURE",
  81   0xB0, "CONTROLLER_CHANGE",
  82   0xC0, "PROGRAM_CHANGE",
  83   0xD0, "CHANNEL_KEY_PRESSURE",
  84   0xE0, "PITCH_BEND",
  85   0,0
  86 };
  87
  88 message_t channelModeMessages[] = {
  89   0x78, "ALL_SOUND_OFF",
  90   0x79, "RESET_ALL_CONTROLLERS",
  91   0x7A, "LOCAL_CONTROL",
  92   0x7B, "ALL_NOTES_OFF",
  93   0x7C, "OMNI_MODE_OFF",
  94   0x7D, "OMNI_MODE_ON",
  95   0x7E, "MONO_MODE_ON",
  96   0x7F, "POLY_MODE_ON",
  97   0,0
  98 };
  99
 100 message_t metaEvents[] = {
 101   0x00, "SEQUENCE_NUMBER",
 102   0x01, "TEXT_EVENT",
 103   0x02, "COPYRIGHT_NOTICE",
 104   0x03, "SEQUENCE_TRACK_NAME",
 105   0x04, "INSTRUMENT_NAME",
 106   0x05, "LYRIC",
 107   0x06, "MARKER",
 108   0x07, "CUE_POINT",
 109   0x20, "MIDI_CHANNEL_PREFIX",
 110   0x21, "MIDI_PORT",
 111   0x2F, "END_OF_TRACK",
 112   0x51, "SET_TEMPO",
 113   0x54, "SMTPE_OFFSET",
 114   0x58, "TIME_SIGNATURE",
 115   0x59, "KEY_SIGNATURE",
 116   0x7F, "SEQUENCER_SPECIFIC_META_EVENT",
 117   0xFF, "META_EVENT",
 118   0,0
 119 };
 120
 121 void
 122 add_constants (PyObject *dict)
 123 {
 124   message_t * p[] = {metaEvents, channelModeMessages, channelVoiceMessages ,0};
 125   int i,j;
 126   for ( j =0; p[j]; j++)
 127     for ( i = 0; p[j][i].description; i++)
 128       PyDict_SetItemString (dict, p[j][i].description, Py_BuildValue ("i", p[j][i].msg));
 129 }
 130
 131 unsigned long int
 132 get_number (unsigned char ** str, unsigned char * end_str, int length)
 133 {
 134   /* # MIDI uses big-endian for everything */
 135   long sum = 0;
 136   int i = 0;
 137
 138   for (; i < length; i++)
 139     sum = (sum << 8) + (unsigned char) (*str)[i];
 140
 141   *str += length;
 142   debug_print ("%d:\n", sum);
 143   return sum;
 144 }
 145
 146 unsigned long int
 147 get_variable_length_number (unsigned char **str, unsigned char * end_str)
 148 {
 149   long sum = 0;
 150   int i = 0;
 151   while (*str < end_str)
 152     {
 153       unsigned char x = **str;
 154       (*str) ++;
 155       sum = (sum << 7) + (x & 0x7F);
 156       if (!(x & 0x80))
 157         break;
 158     }
 159   debug_print ("%d:\n", sum);
 160   return sum;
 161 }
 162
 163 PyObject *
 164 read_one_byte (unsigned char **track, unsigned char *end,
 165                unsigned char x)
 166 {
 167   PyObject *pyev = Py_BuildValue ("(i)", x);
 168   debug_print ("%x:%s", x, "event\n");
 169
 170   return pyev;
 171 }
 172
 173 PyObject *
 174 read_two_bytes (unsigned char **track, unsigned char *end,
 175                 unsigned char x)
 176 {
 177   PyObject *pyev = Py_BuildValue ("(ii)", x, (*track)[0]);
 178   *track += 1;
 179   debug_print ("%x:%s", x, "event\n");
 180   return pyev;
 181 }
 182
 183 PyObject *
 184 read_three_bytes (unsigned char **track, unsigned char *end,
 185                   unsigned char x)
 186 {
 187   PyObject *pyev = Py_BuildValue ("(iii)", x, (*track)[0],
 188                                   (*track)[1]);
 189
 190   *track += 2;
 191   debug_print ("%x:%s", x, "event\n");
 192   return pyev;
 193 }
 194
 195 PyObject *
 196 read_string (unsigned char **track, unsigned char *end)
 197 {
 198   unsigned long length = get_variable_length_number (track, end);
 199   if (length > end - *track)
 200     length = end - *track;
 201
 202   *track += length;
 203   return Py_BuildValue ("s#", ((*track) -length), length);
 204 }
 205
 206 typedef PyObject* (*Read_midi_event)
 207      (unsigned char **track, unsigned char *end,
 208       unsigned char x);
 209
 210
 211 static PyObject *
 212 read_f0_byte (unsigned char **track, unsigned char *end,
 213               unsigned char x)
 214
 215 {
 216   debug_print ("%x:%s", x, "event\n");
 217   if (x == 0xff)
 218     {
 219       unsigned char z = (*track)[0 ];
 220       *track += 1;
 221       debug_print ("%x:%s", z, "f0-event\n");
 222
 223       return Py_BuildValue ("(iiO)", x, z, read_string (track, end));
 224     }
 225
 226   return Py_BuildValue ("(iO)", x, read_string (track, end));
 227 }
 228
 229 Read_midi_event read_midi_event [16] =
 230 {
 231   read_one_byte,  //  0
 232   read_one_byte,  // 10
 233   read_one_byte,  // 20
 234   read_one_byte,  // 30
 235   read_one_byte,  // 40
 236   read_one_byte,  // 50
 237   read_one_byte,  // 60 data entry.
 238   read_two_bytes, // 70 all notes off
 239   read_three_bytes, // 80 note off
 240   read_three_bytes, // 90 note on
 241   read_three_bytes, // a0 poly aftertouch
 242   read_three_bytes, // b0 control
 243   read_two_bytes,  // c0 prog change
 244   read_two_bytes, // d0 ch aftertouch
 245   read_three_bytes, // e0 pitchwheel range
 246   read_f0_byte,   // f0
 247 };
 248
 249
 250 static PyObject *
 251 read_event (unsigned char **track, unsigned char *end, PyObject *time,
 252             unsigned char *running_status)
 253 {
 254   int rsb_skip = ((**track & 0x80)) ? 1 :0;
 255
 256   unsigned char x = (rsb_skip) ? (*track)[0]: *running_status;
 257
 258   PyObject * bare_event = 0;
 259   debug_print ("%x:%s", x, "event\n");
 260   *running_status = x;
 261   *track += rsb_skip;
 262
 263   //  printf ("%x %x %d next %x\n", x, (*track)[0], rsb_skip, (*track)[1]);
 264   bare_event = (*read_midi_event[x >> 4]) (track, end, x);
 265   if (bare_event)
 266     return Py_BuildValue ("(OO)", time, bare_event);
 267   else
 268     return NULL;
 269 }
 270
 271 static PyObject *
 272 midi_parse_track (unsigned char **track, unsigned char *track_end)
 273 {
 274   unsigned int time = 0;
 275   unsigned char running_status;
 276   unsigned long track_len, track_size;
 277   PyObject *pytrack = 0;
 278
 279   debug_print ("%s", "\n");
 280
 281   track_size = track_end - *track;
 282
 283   debug_print ("%s", "\n");
 284   if (memcmp (*track, "MTrk", 4))
 285     return midi_error (__FUNCTION__,  ": MTrk expected");
 286
 287   *track += 4;
 288
 289   track_len = get_number (track, *track + 4, 4);
 290
 291
 292   debug_print ("track_len: %u\n", track_len);
 293   debug_print ("track_size: %u\n", track_size);
 294   debug_print ("track begin: %p\n", track);
 295   debug_print ("track end: %p\n", track + track_len);
 296
 297   if (track_len > track_size)
 298     return midi_error (__FUNCTION__,  ": track size corrupt");
 299
 300   pytrack = PyList_New (0);
 301
 302   track_end = *track + track_len;
 303
 304   {
 305     PyObject *pytime = PyInt_FromLong (0L);
 306     while (*track < track_end)
 307       {
 308         long dt = get_variable_length_number(track, track_end);
 309         PyObject *pyev = 0;
 310
 311         time += dt;
 312         if (dt)
 313           pytime = PyInt_FromLong (time);
 314
 315         pyev = read_event (track, track_end, pytime,
 316                            &running_status);
 317         if (pyev)
 318           PyList_Append (pytrack, pyev);
 319       }
 320   }
 321
 322   *track = track_end;
 323   return pytrack;
 324 }
 325
 326
 327 static PyObject *
 328 pymidi_parse_track (PyObject *self, PyObject *args)
 329 {
 330   unsigned char *track, *track_end;
 331   unsigned long track_size, track_len;
 332
 333   PyObject * sobj = PyTuple_GetItem (args, 0);
 334
 335   debug_print ("%s", "\n");
 336   if (!PyArg_ParseTuple (args, "s#", &track, &track_size))
 337     return 0;
 338
 339   if (track_size < 0)
 340     return midi_error (__FUNCTION__,   ": negative track size");
 341
 342   track_end = track + track_size;
 343
 344   return midi_parse_track (&track, track_end);
 345 }
 346
 347 static PyObject *
 348 midi_parse (unsigned char **midi,unsigned  char *midi_end)
 349 {
 350   PyObject *pymidi = 0;
 351   unsigned long header_len;
 352   unsigned format, tracks;
 353   int division;
 354   int i;
 355
 356   debug_print ("%s", "\n");
 357
 358   /* Header */
 359   header_len = get_number (midi, *midi + 4, 4);
 360
 361
 362   if (header_len < 6)
 363     return midi_error (__FUNCTION__,  ": header too short");
 364
 365   format = get_number (midi, *midi + 2, 2);
 366   tracks = get_number (midi, *midi + 2, 2);
 367
 368   if (tracks > 32)
 369     return midi_error (__FUNCTION__,  ": too many tracks");
 370
 371   division = get_number (midi, *midi + 2, 2) * 4;
 372
 373
 374   if (division < 0)
 375     /* return midi_error ("can't handle non-metrical time"); */
 376     ;
 377   *midi += header_len - 6;
 378
 379   pymidi = PyList_New (0);
 380
 381   /* Tracks */
 382   for (i = 0; i < tracks; i++)
 383     PyList_Append (pymidi, midi_parse_track (midi, midi_end));
 384
 385   pymidi = Py_BuildValue ("(OO)", Py_BuildValue ("(ii)", format, division),
 386                           pymidi);
 387   return pymidi;
 388 }
 389
 390 static PyObject *
 391 pymidi_parse (PyObject *self, PyObject *args)
 392 {
 393   unsigned char *midi, *midi_end;
 394   unsigned long midi_size, midi_len;
 395
 396   PyObject *sobj = PyTuple_GetItem (args, 0);
 397
 398   debug_print ("%s", "\n");
 399   if (!PyArg_ParseTuple (args, "s#", &midi, &midi_size))
 400     return 0;
 401
 402   if (memcmp (midi, "MThd", 4))
 403       return midi_error (__FUNCTION__,  ": MThd expected");
 404
 405   midi += 4;
 406
 407   midi_end = midi + midi_size;
 408
 409   return midi_parse (&midi, midi_end);
 410 }
 411
 412
 413 static PyMethodDef MidiMethods[] =
 414 {
 415   {"parse",  pymidi_parse, 1},
 416   {"parse_track",  pymidi_parse_track, 1},
 417   {0, 0}        /* Sentinel */
 418 };
 419
 420 PyMODINIT_FUNC
 421 initmidi (void)
 422 {
 423   PyObject *m, *d;
 424   m = Py_InitModule ("midi", MidiMethods);
 425   d = PyModule_GetDict (m);
 426
 427   Midi_error = PyString_FromString ("midi.error");
 428   PyDict_SetItemString (d, "error", Midi_error);
 429   add_constants (d);
 430   Midi_warning = PyString_FromString ("midi.warning");
 431   PyDict_SetItemString (d, "warning", Midi_warning);
 432 }
 433