a362ecb524822139e152bf04f377e066bb1793bb
[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     p_sys->pulse        = 0;
142     p_sys->ppqn         = ppqn;
143
144     p_sys->trackc       = tracks;
145     /* Prefetch track offsets */
146     for (unsigned i = 0; i < tracks; i++)
147     {
148         uint8_t head[8];
149
150         if (i > 0)
151         {
152             /* Seeking screws streaming up, but there is no way around this,
153              * as SMF1 tracks are performed simultaneously.
154              * Not a big deal as SMF1 are usually only a few kbytes anyway. */
155             if (stream_Seek (stream,  p_sys->trackv[i-1].end))
156             {
157                 msg_Err (p_this, "cannot build SMF index (corrupted file?)");
158                 goto error;
159             }
160         }
161
162         for (;;)
163         {
164             stream_Read (stream, head, 8);
165             if (memcmp (head, "MTrk", 4) == 0)
166                 break;
167
168             msg_Dbg (p_this, "skipping unknown SMF chunk");
169             stream_Read (stream, NULL, GetDWBE (head + 4));
170         }
171
172         p_sys->trackv[i].offset = stream_Tell (stream);
173         p_sys->trackv[i].end = p_sys->trackv[i].offset + GetDWBE (head + 4);
174         msg_Dbg (p_this, "track %u: 0x"I64Fx"-0x"I64Fx, i,
175                  p_sys->trackv[i].offset, p_sys->trackv[i].end);
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 static
257 int HandleMessage (demux_t *p_demux, mtrk_t *tr)
258 {
259     stream_t *s = p_demux->s;
260     block_t *block;
261     uint8_t first, event;
262     unsigned datalen;
263
264     if (stream_Seek (s, tr->offset)
265      || (stream_Read (s, &first, 1) != 1))
266         return -1;
267
268     event = (first & 0x80) ? first : tr->running_event;
269     msg_Dbg (p_demux, "MIDI event 0x%02X", event);
270
271     switch (event & 0xf0)
272     {
273         case 0xF0: /* System Exclusive */
274             switch (event)
275             {
276                 case 0xF0: /* System Specific */
277                 {
278                     /* TODO: don't skip these */
279                     stream_Read (s, NULL, 1); /* Manuf ID */
280                     for (;;)
281                     {
282                         uint8_t c;
283                         if (stream_Read (s, &c, 1) != 1)
284                             return -1;
285                         if (c == 0xF7)
286                             goto skip;
287                     }
288                 }
289                 case 0xFF: /* SMF Meta Event */
290                 {
291                     uint8_t type;
292                     int32_t length;
293
294                     if (stream_Read (s, &type, 1) != 1)
295                         return -1;
296                     length = ReadVarInt (s);
297                     if (length < 0)
298                         return -1;
299
300                     msg_Warn (p_demux,
301                               "unknown SMF Meta Event type 0x%02X (%d bytes)",
302                               type, length);
303                     /* TODO: parse these */
304                     if (stream_Read (s, NULL, length) != length)
305                         return -1;
306
307                     /* We MUST NOT pass this event to forward. It would be
308                      * confused as a MIDI Reset real-time event. */
309                     goto skip;
310                 }
311                 case 0xF1:
312                 case 0xF3:
313                     datalen = 1;
314                     break;
315                 case 0xF2:
316                     datalen = 2;
317                     break;
318                 case 0xF4:
319                 case 0xF5:
320                     /* We cannot handle undefined "common" (non-real-time)
321                      * events inside SMF, as we cannot differentiate a
322                      * one byte delta-time (< 0x80) from event data. */
323                 case 0xF7: /* End of sysex -> should never happen(?) */
324                     msg_Err (p_demux, "unknown MIDI event 0x%02X", event);
325                     return -1; /* undefined events */
326                 default:
327                     datalen = 0;
328                     break;
329             }
330         case 0xC0:
331         case 0xD0:
332             datalen = 1;
333             break;
334         default:
335             datalen = 2;
336             break;
337     }
338
339     /* FIXME: one message per block is very inefficient */
340     block = block_New (p_demux, 1 + datalen);
341     if (block == NULL)
342         goto skip;
343
344     block->p_buffer[0] = event;
345     if (first & 0x80)
346     {
347         stream_Read (s, block->p_buffer + 1, datalen);
348     }
349     else
350     {
351         if (datalen == 0)
352         {
353             msg_Err (p_demux, "malformatted MIDI event");
354             return -1; /* can't use implicit running status with empty payload! */
355         }
356
357         block->p_buffer[1] = first;
358         if (datalen > 1)
359             stream_Read (s, block->p_buffer + 2, datalen - 1);
360     }
361
362     block->i_dts = block->i_pts = date_Get (&p_demux->p_sys->pts);
363     es_out_Send (p_demux->out, p_demux->p_sys->es, block);
364
365 skip:
366     if (event < 0xF8)
367         /* If event is not real-time, update running status */
368         tr->running_event = event;
369
370     tr->offset = stream_Tell (s);
371     return 0;
372 }
373
374 /*****************************************************************************
375  * Demux: read chunks and send them to the synthetizer
376  *****************************************************************************
377  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
378  *****************************************************************************/
379 static int Demux (demux_t *p_demux)
380 {
381     stream_t *s = p_demux->s;
382     demux_sys_t *p_sys = p_demux->p_sys;
383     uint64_t     pulse = p_sys->pulse, next_pulse = UINT64_MAX;
384
385     if (pulse == UINT64_MAX)
386         return 0; /* all tracks are done */
387
388     es_out_Control (p_demux->out, ES_OUT_SET_PCR, date_Get (&p_sys->pts));
389
390     msg_Dbg (p_demux, "pulse %llu", pulse);
391     for (unsigned i = 0; i < p_sys->trackc; i++)
392     {
393         mtrk_t *track = p_sys->trackv + i;
394
395         while (track->next == pulse)
396         {
397             msg_Dbg (p_demux, "event on track %u", i);
398             if (HandleMessage (p_demux, track)
399              || ReadDeltaTime (s, track))
400             {
401                 msg_Err (p_demux, "fatal parsing error");
402                 return VLC_EGENERIC;
403             }
404         }
405
406         if (track->next < next_pulse)
407             next_pulse = track->next;
408     }
409
410     if (next_pulse != UINT64_MAX)
411         date_Increment (&p_sys->pts, next_pulse - pulse);
412     p_sys->pulse = next_pulse;
413
414     return 1;
415 }
416
417
418 /*****************************************************************************
419  * Control:
420  *****************************************************************************/
421 static int Control (demux_t *p_demux, int i_query, va_list args)
422 {
423     return demux2_vaControlHelper (p_demux->s, 0, -1, 0, 1, i_query, args);
424 }