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