git.sesse.net Git - vlc/blob - modules/demux/smf.c

   1 /*****************************************************************************
   2  * smf.c : Standard MIDI File (.mid) demux module for vlc
   3  *****************************************************************************
   4  * Copyright © 2007 Rémi Denis-Courmont
   5  * $Id$
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  20  *****************************************************************************/
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26 #include <vlc_common.h>
  27 #include <vlc_plugin.h>
  28 #include <vlc_demux.h>
  29 #include <vlc_aout.h>
  30 #include <vlc_codecs.h>
  31 #include <vlc_charset.h>
  32 #include <limits.h>
  33
  34 #include <assert.h>
  35
  36 #define TEMPO_MIN  20
  37 #define TEMPO_MAX 250 /* Beats per minute */
  38
  39 static int  Open  (vlc_object_t *);
  40 static void Close (vlc_object_t *);
  41
  42 vlc_module_begin ();
  43     set_description (N_("SMF demuxer"));
  44     set_category (CAT_INPUT);
  45     set_subcategory (SUBCAT_INPUT_DEMUX);
  46     set_capability ("demux", 20);
  47     set_callbacks (Open, Close);
  48 vlc_module_end ();
  49
  50 static int Demux   (demux_t *);
  51 static int Control (demux_t *, int i_query, va_list args);
  52
  53 typedef struct smf_track_t
  54 {
  55     int64_t  offset; /* Read offset in the file (stream_Tell) */
  56     int64_t  end;    /* End offset in the file */
  57     uint64_t next;   /* Time of next message (in term of pulses) */
  58     uint8_t  running_event; /* Running (previous) event */
  59 } mtrk_t;
  60
  61 static int ReadDeltaTime (stream_t *s, mtrk_t *track);
  62
  63 struct demux_sys_t
  64 {
  65     es_out_id_t *es;
  66     date_t       pts;
  67     uint64_t     pulse; /* Pulses counter */
  68
  69     unsigned     ppqn;   /* Pulses Per Quarter Note */
  70     /* by the way, "quarter note" is "noire" in French */
  71
  72     unsigned     trackc; /* Number of tracks */
  73     mtrk_t       trackv[0]; /* Track states */
  74 };
  75
  76 /*****************************************************************************
  77  * Open: check file and initializes structures
  78  *****************************************************************************/
  79 static int Open (vlc_object_t * p_this)
  80 {
  81     demux_t       *p_demux = (demux_t *)p_this;
  82     stream_t      *stream = p_demux->s;
  83     demux_sys_t   *p_sys;
  84     const uint8_t *peek;
  85     unsigned       tracks, ppqn;
  86     bool     multitrack;
  87
  88     /* (Try to) parse the SMF header */
  89     /* Header chunk always has 6 bytes payload */
  90     if (stream_Peek (stream, &peek, 14) < 14)
  91         return VLC_EGENERIC;
  92
  93     /* Skip RIFF MIDI header if present */
  94     if (!memcmp (peek, "RIFF", 4) && !memcmp (peek + 8, "RMID", 4))
  95     {
  96         uint32_t riff_len = GetDWLE (peek + 4);
  97
  98         msg_Dbg (p_this, "detected RIFF MIDI file (%u bytes)",
  99                  (unsigned)riff_len);
 100         if ((stream_Read (stream, NULL, 12) < 12))
 101             return VLC_EGENERIC;
 102
 103         /* Look for the RIFF data chunk */
 104         for (;;)
 105         {
 106             char chnk_hdr[8];
 107             uint32_t chnk_len;
 108
 109             if ((riff_len < 8)
 110              || (stream_Read (stream, chnk_hdr, 8) < 8))
 111                 return VLC_EGENERIC;
 112
 113             riff_len -= 8;
 114             chnk_len = GetDWLE (chnk_hdr + 4);
 115             if (riff_len < chnk_len)
 116                 return VLC_EGENERIC;
 117             riff_len -= chnk_len;
 118
 119             if (!memcmp (chnk_hdr, "data", 4))
 120                 break; /* found! */
 121
 122             if (stream_Read (stream, NULL, chnk_len) < (ssize_t)chnk_len)
 123                 return VLC_EGENERIC;
 124         }
 125
 126         /* Read real SMF header. Assume RIFF data chunk length is proper. */
 127         if (stream_Peek (stream, &peek, 14) < 14)
 128             return VLC_EGENERIC;
 129     }
 130
 131     if (memcmp (peek, "MThd\x00\x00\x00\x06", 8))
 132         return VLC_EGENERIC;
 133     peek += 8;
 134
 135     /* First word: SMF type */
 136     switch (GetWBE (peek))
 137     {
 138         case 0:
 139             multitrack = false;
 140             break;
 141         case 1:
 142             multitrack = true;
 143             break;
 144         default:
 145             /* We don't implement SMF2 (as do many) */
 146             msg_Err (p_this, "unsupported SMF file type %u", GetWBE (peek));
 147             return VLC_EGENERIC;
 148     }
 149     peek += 2;
 150
 151     /* Second word: number of tracks */
 152     tracks = GetWBE (peek);
 153     peek += 2;
 154     if (!multitrack && (tracks != 1))
 155     {
 156         msg_Err (p_this, "invalid SMF type 0 file");
 157         return VLC_EGENERIC;
 158     }
 159
 160     msg_Dbg (p_this, "detected Standard MIDI File (type %u) with %u track(s)",
 161              multitrack, tracks);
 162
 163     /* Third/last word: timing */
 164     ppqn = GetWBE (peek);
 165     if (ppqn & 0x8000)
 166     {
 167         /* FIXME */
 168         msg_Err (p_this, "SMPTE timestamps not implemented");
 169         return VLC_EGENERIC;
 170     }
 171     else
 172     {
 173         msg_Dbg (p_this, " %u pulses per quarter note", ppqn);
 174     }
 175
 176     p_sys = malloc (sizeof (*p_sys) + (sizeof (mtrk_t) * tracks));
 177     if (p_sys == NULL)
 178         return VLC_ENOMEM;
 179
 180     /* We've had a valid SMF header - now skip it*/
 181     if (stream_Read (stream, NULL, 14) < 14)
 182         goto error;
 183
 184     p_demux->pf_demux   = Demux;
 185     p_demux->pf_control = Control;
 186     p_demux->p_sys      = p_sys;
 187
 188     /* Default SMF tempo is 120BPM, i.e. half a second per quarter note */
 189     date_Init (&p_sys->pts, ppqn * 2, 1);
 190     date_Set (&p_sys->pts, 1);
 191     p_sys->pulse        = 0;
 192     p_sys->ppqn         = ppqn;
 193
 194     p_sys->trackc       = tracks;
 195     /* Prefetch track offsets */
 196     for (unsigned i = 0; i < tracks; i++)
 197     {
 198         uint8_t head[8];
 199
 200         if (i > 0)
 201         {
 202             /* Seeking screws streaming up, but there is no way around this,
 203              * as SMF1 tracks are performed simultaneously.
 204              * Not a big deal as SMF1 are usually only a few kbytes anyway. */
 205             if (stream_Seek (stream,  p_sys->trackv[i-1].end))
 206             {
 207                 msg_Err (p_this, "cannot build SMF index (corrupted file?)");
 208                 goto error;
 209             }
 210         }
 211
 212         for (;;)
 213         {
 214             stream_Read (stream, head, 8);
 215             if (memcmp (head, "MTrk", 4) == 0)
 216                 break;
 217
 218             msg_Dbg (p_this, "skipping unknown SMF chunk");
 219             stream_Read (stream, NULL, GetDWBE (head + 4));
 220         }
 221
 222         p_sys->trackv[i].offset = stream_Tell (stream);
 223         p_sys->trackv[i].end = p_sys->trackv[i].offset + GetDWBE (head + 4);
 224         p_sys->trackv[i].next = 0;
 225         ReadDeltaTime (stream, p_sys->trackv + i);
 226         p_sys->trackv[i].running_event = 0xF6;
 227         /* Why 0xF6 (Tuning Calibration)?
 228          * Because it has zero bytes of data, so the parser will detect the
 229          * error if the first event uses running status. */
 230     }
 231
 232     es_format_t  fmt;
 233     es_format_Init (&fmt, AUDIO_ES, VLC_FOURCC('M', 'I', 'D', 'I'));
 234     p_sys->es = es_out_Add (p_demux->out, &fmt);
 235
 236     return VLC_SUCCESS;
 237
 238 error:
 239     free (p_sys);
 240     return VLC_EGENERIC;
 241 }
 242
 243 /**
 244  * Releases allocate resources.
 245  */
 246 static void Close (vlc_object_t * p_this)
 247 {
 248     demux_t *p_demux = (demux_t *)p_this;
 249     demux_sys_t *p_sys = p_demux->p_sys;
 250
 251     free (p_sys);
 252 }
 253
 254 /**
 255  * Reads MIDI variable length (7, 14, 21 or 28 bits) integer.
 256  * @return read value, or -1 on EOF/error.
 257  */
 258 static int32_t ReadVarInt (stream_t *s)
 259 {
 260     uint32_t val = 0;
 261     uint8_t byte;
 262
 263     for (unsigned i = 0; i < 4; i++)
 264     {
 265         if (stream_Read (s, &byte, 1) < 1)
 266             return -1;
 267
 268         val = (val << 7) | (byte & 0x7f);
 269         if ((byte & 0x80) == 0)
 270             return val;
 271     }
 272
 273     return -1;
 274 }
 275
 276
 277 /**
 278  * Reads (delta) time from the next event of a given track.
 279  * @param s stream to read data from (must be positioned at the right offset)
 280  */
 281 static int ReadDeltaTime (stream_t *s, mtrk_t *track)
 282 {
 283     int32_t delta_time;
 284
 285     assert (stream_Tell (s) == track->offset);
 286
 287     if (track->offset >= track->end)
 288     {
 289         /* This track is done */
 290         track->next = UINT64_MAX;
 291         return 0;
 292     }
 293
 294     delta_time = ReadVarInt (s);
 295     if (delta_time < 0)
 296         return -1;
 297
 298     track->next += delta_time;
 299     track->offset = stream_Tell (s);
 300     return 0;
 301 }
 302
 303
 304 /**
 305  * Non-MIDI Meta events handler
 306  */
 307 static
 308 int HandleMeta (demux_t *p_demux, mtrk_t *tr)
 309 {
 310     stream_t *s = p_demux->s;
 311     demux_sys_t *p_sys = p_demux->p_sys;
 312     uint8_t *payload;
 313     uint8_t type;
 314     int32_t length;
 315     int ret = 0;
 316
 317     if (stream_Read (s, &type, 1) != 1)
 318         return -1;
 319
 320     length = ReadVarInt (s);
 321     if (length < 0)
 322         return -1;
 323
 324     payload = malloc (length + 1);
 325     if ((payload == NULL)
 326      || (stream_Read (s, payload, length) != length))
 327     {
 328         free (payload);
 329         return -1;
 330     }
 331
 332     payload[length] = '\0';
 333
 334     switch (type)
 335     {
 336         case 0x00: /* Sequence Number */
 337             break;
 338
 339         case 0x01: /* Text (comment) */
 340             EnsureUTF8 ((char *)payload);
 341             msg_Info (p_demux, "Text      : %s", (char *)payload);
 342             break;
 343
 344         case 0x02: /* Copyright */
 345             EnsureUTF8 ((char *)payload);
 346             msg_Info (p_demux, "Copyright : %s", (char *)payload);
 347             break;
 348
 349         case 0x03: /* Track name */
 350             EnsureUTF8 ((char *)payload);
 351             msg_Info (p_demux, "Track name: %s", (char *)payload);
 352             break;
 353
 354         case 0x04: /* Instrument name */
 355             EnsureUTF8 ((char *)payload);
 356             msg_Info (p_demux, "Instrument: %s", (char *)payload);
 357             break;
 358
 359         case 0x05: /* Lyric (one syllable) */
 360             /*EnsureUTF8 ((char *)payload);*/
 361             break;
 362
 363         case 0x06: /* Marker text */
 364             EnsureUTF8 ((char *)payload);
 365             msg_Info (p_demux, "Marker    : %s", (char *)payload);
 366
 367         case 0x07: /* Cue point (WAVE filename) */
 368             EnsureUTF8 ((char *)payload);
 369             msg_Info (p_demux, "Cue point : %s", (char *)payload);
 370             break;
 371
 372         case 0x08: /* Program/Patch name */
 373             EnsureUTF8 ((char *)payload);
 374             msg_Info (p_demux, "Patch name: %s", (char *)payload);
 375             break;
 376
 377         case 0x09: /* MIDI port name */
 378             EnsureUTF8 ((char *)payload);
 379             msg_Dbg (p_demux, "MIDI port : %s", (char *)payload);
 380             break;
 381
 382         case 0x2F: /* End of track */
 383             if (tr->end != stream_Tell (s))
 384             {
 385                 msg_Err (p_demux, "misplaced end of track");
 386                 ret = -1;
 387             }
 388             break;
 389
 390         case 0x51: /* Tempo */
 391             if (length == 3)
 392             {
 393                 uint32_t uspqn = (payload[0] << 16)
 394                                | (payload[1] << 8) | payload[2];
 395                 unsigned tempo = 60 * 1000000 / (uspqn ? uspqn : 1);
 396                 msg_Dbg (p_demux, "tempo: %uus/qn -> %u BPM",
 397                          (unsigned)uspqn, tempo);
 398
 399                 if (tempo < TEMPO_MIN)
 400                 {
 401                     msg_Warn (p_demux, "tempo too slow -> %u BPM", TEMPO_MIN);
 402                     tempo = TEMPO_MIN;
 403                 }
 404                 else
 405                 if (tempo > TEMPO_MAX)
 406                 {
 407                     msg_Warn (p_demux, "tempo too fast -> %u BPM", TEMPO_MAX);
 408                     tempo = TEMPO_MAX;
 409                 }
 410                 date_Change (&p_sys->pts, p_sys->ppqn * tempo, 60);
 411             }
 412             else
 413                 ret = -1;
 414             break;
 415
 416         case 0x54: /* SMPTE offset */
 417             if (length == 5)
 418                 msg_Warn (p_demux, "SMPTE offset not implemented");
 419             else
 420                 ret = -1;
 421             break;
 422
 423         case 0x58: /* Time signature */
 424             if (length == 4)
 425                 ;
 426             else
 427                 ret = -1;
 428             break;
 429
 430         case 0x59: /* Key signature */
 431             if (length == 2)
 432                 ;
 433             else
 434                 ret = -1;
 435             break;
 436
 437         case 0x7f: /* Proprietary event */
 438             msg_Dbg (p_demux, "ignored proprietary SMF Meta Event (%d bytes)",
 439                      length);
 440             break;
 441
 442         default:
 443             msg_Warn (p_demux, "unknown SMF Meta Event type 0x%02X (%d bytes)",
 444                       type, length);
 445     }
 446
 447     free (payload);
 448     return 0;
 449 }
 450
 451
 452
 453 static
 454 int HandleMessage (demux_t *p_demux, mtrk_t *tr)
 455 {
 456     stream_t *s = p_demux->s;
 457     block_t *block;
 458     uint8_t first, event;
 459     unsigned datalen;
 460
 461     if (stream_Seek (s, tr->offset)
 462      || (stream_Read (s, &first, 1) != 1))
 463         return -1;
 464
 465     event = (first & 0x80) ? first : tr->running_event;
 466
 467     switch (event & 0xf0)
 468     {
 469         case 0xF0: /* System Exclusive */
 470             switch (event)
 471             {
 472                 case 0xF0: /* System Specific */
 473                 {
 474                     /* TODO: don't skip these */
 475                     stream_Read (s, NULL, 1); /* Manuf ID */
 476                     for (;;)
 477                     {
 478                         uint8_t c;
 479                         if (stream_Read (s, &c, 1) != 1)
 480                             return -1;
 481                         if (c == 0xF7)
 482                             goto skip;
 483                     }
 484                     /* never reached */
 485                 }
 486                 case 0xFF: /* SMF Meta Event */
 487                     if (HandleMeta (p_demux, tr))
 488                         return -1;
 489                     /* We MUST NOT pass this event forward. It would be
 490                      * confused as a MIDI Reset real-time event. */
 491                     goto skip;
 492                 case 0xF1:
 493                 case 0xF3:
 494                     datalen = 1;
 495                     break;
 496                 case 0xF2:
 497                     datalen = 2;
 498                     break;
 499                 case 0xF4:
 500                 case 0xF5:
 501                     /* We cannot handle undefined "common" (non-real-time)
 502                      * events inside SMF, as we cannot differentiate a
 503                      * one byte delta-time (< 0x80) from event data. */
 504                 case 0xF7: /* End of sysex -> should never happen(?) */
 505                     msg_Err (p_demux, "unknown MIDI event 0x%02X", event);
 506                     return -1; /* undefined events */
 507                 default:
 508                     datalen = 0;
 509                     break;
 510             }
 511         case 0xC0:
 512         case 0xD0:
 513             datalen = 1;
 514             break;
 515         default:
 516             datalen = 2;
 517             break;
 518     }
 519
 520     /* FIXME: one message per block is very inefficient */
 521     block = block_New (p_demux, 1 + datalen);
 522     if (block == NULL)
 523         goto skip;
 524
 525     block->p_buffer[0] = event;
 526     if (first & 0x80)
 527     {
 528         stream_Read (s, block->p_buffer + 1, datalen);
 529     }
 530     else
 531     {
 532         if (datalen == 0)
 533         {
 534             msg_Err (p_demux, "malformatted MIDI event");
 535             return -1; /* can't use implicit running status with empty payload! */
 536         }
 537
 538         block->p_buffer[1] = first;
 539         if (datalen > 1)
 540             stream_Read (s, block->p_buffer + 2, datalen - 1);
 541     }
 542
 543     block->i_dts = block->i_pts = date_Get (&p_demux->p_sys->pts);
 544     es_out_Send (p_demux->out, p_demux->p_sys->es, block);
 545
 546 skip:
 547     if (event < 0xF8)
 548         /* If event is not real-time, update running status */
 549         tr->running_event = event;
 550
 551     tr->offset = stream_Tell (s);
 552     return 0;
 553 }
 554
 555 /*****************************************************************************
 556  * Demux: read chunks and send them to the synthetizer
 557  *****************************************************************************
 558  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
 559  *****************************************************************************/
 560 static int Demux (demux_t *p_demux)
 561 {
 562     stream_t *s = p_demux->s;
 563     demux_sys_t *p_sys = p_demux->p_sys;
 564     uint64_t     pulse = p_sys->pulse, next_pulse = UINT64_MAX;
 565
 566     if (pulse == UINT64_MAX)
 567         return 0; /* all tracks are done */
 568
 569     es_out_Control (p_demux->out, ES_OUT_SET_PCR, date_Get (&p_sys->pts));
 570
 571     for (unsigned i = 0; i < p_sys->trackc; i++)
 572     {
 573         mtrk_t *track = p_sys->trackv + i;
 574
 575         while (track->next == pulse)
 576         {
 577             if (HandleMessage (p_demux, track)
 578              || ReadDeltaTime (s, track))
 579             {
 580                 msg_Err (p_demux, "fatal parsing error");
 581                 return VLC_EGENERIC;
 582             }
 583         }
 584
 585         if (track->next < next_pulse)
 586             next_pulse = track->next;
 587     }
 588
 589     mtime_t cur_tick = (date_Get (&p_sys->pts) + 9999) / 10000, last_tick;
 590     if (next_pulse != UINT64_MAX)
 591         last_tick = date_Increment (&p_sys->pts, next_pulse - pulse) / 10000;
 592     else
 593         last_tick = cur_tick + 1;
 594
 595     /* MIDI Tick emulation (ping the decoder every 10ms) */
 596     while (cur_tick < last_tick)
 597     {
 598         block_t *tick = block_New (p_demux, 1);
 599         if (tick == NULL)
 600             break;
 601
 602         tick->p_buffer[0] = 0xF9;
 603         tick->i_dts = tick->i_pts = cur_tick++ * 10000;
 604         es_out_Send (p_demux->out, p_sys->es, tick);
 605     }
 606
 607     p_sys->pulse = next_pulse;
 608
 609     return 1;
 610 }
 611
 612
 613 /*****************************************************************************
 614  * Control:
 615  *****************************************************************************/
 616 static int Control (demux_t *p_demux, int i_query, va_list args)
 617 {
 618     demux_sys_t *p_sys = p_demux->p_sys;
 619
 620     switch (i_query)
 621     {
 622         case DEMUX_GET_TIME:
 623         {
 624             *(va_arg (args, int64_t *)) = date_Get (&p_sys->pts);
 625             return 0;
 626         }
 627 #if 0
 628         /* TODO: */
 629         case DEMUX_SET_TIME:
 630         case DEMUX_GET_POSITION:
 631         case DEMUX_SET_POSITION:
 632         case DEMUX_GET_LENGTH:
 633 #endif
 634     }
 635     return VLC_EGENERIC;
 636 }