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