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