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