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