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