ChunkFind: fix skipping very large chunks
[vlc.git] / modules / demux / wav.c
1 /*****************************************************************************
2  * wav.c : wav file input module for vlc
3  *****************************************************************************
4  * Copyright (C) 2001-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_demux.h>
35 #include <vlc_aout.h>
36 #include <vlc_codecs.h>
37
38 /*****************************************************************************
39  * Module descriptor
40  *****************************************************************************/
41 static int  Open ( vlc_object_t * );
42 static void Close( vlc_object_t * );
43
44 vlc_module_begin();
45     set_description( N_("WAV demuxer") );
46     set_category( CAT_INPUT );
47     set_subcategory( SUBCAT_INPUT_DEMUX );
48     set_capability( "demux", 142 );
49     set_callbacks( Open, Close );
50 vlc_module_end();
51
52 /*****************************************************************************
53  * Local prototypes
54  *****************************************************************************/
55 static int Demux  ( demux_t * );
56 static int Control( demux_t *, int i_query, va_list args );
57
58 struct demux_sys_t
59 {
60     es_format_t     fmt;
61     es_out_id_t     *p_es;
62
63     int64_t         i_data_pos;
64     unsigned int    i_data_size;
65
66     unsigned int    i_frame_size;
67     int             i_frame_samples;
68
69     date_t          pts;
70
71     uint32_t i_channel_mask;
72     bool b_chan_reorder;              /* do we need channel reordering */
73     int pi_chan_table[AOUT_CHAN_MAX];
74 };
75
76 #define __EVEN( x ) (((x) + 1) & ~1)
77
78 static int ChunkFind( demux_t *, const char *, unsigned int * );
79
80 static void FrameInfo_IMA_ADPCM( demux_t *, unsigned int *, int * );
81 static void FrameInfo_MS_ADPCM ( demux_t *, unsigned int *, int * );
82 static void FrameInfo_PCM      ( demux_t *, unsigned int *, int * );
83
84 static const uint32_t pi_channels_src[] =
85     { WAVE_SPEAKER_FRONT_LEFT, WAVE_SPEAKER_FRONT_RIGHT,
86       WAVE_SPEAKER_FRONT_CENTER, WAVE_SPEAKER_LOW_FREQUENCY,
87       WAVE_SPEAKER_BACK_LEFT, WAVE_SPEAKER_BACK_RIGHT,
88       WAVE_SPEAKER_SIDE_LEFT, WAVE_SPEAKER_SIDE_RIGHT, 0 };
89 static const uint32_t pi_channels_in[] =
90     { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
91       AOUT_CHAN_CENTER, AOUT_CHAN_LFE,
92       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
93       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT, 0 };
94 static const uint32_t pi_channels_out[] =
95     { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
96       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
97       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
98       AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 };
99
100 /*****************************************************************************
101  * Open: check file and initializes structures
102  *****************************************************************************/
103 static int Open( vlc_object_t * p_this )
104 {
105     demux_t     *p_demux = (demux_t*)p_this;
106     demux_sys_t *p_sys;
107
108     const uint8_t *p_peek;
109     unsigned int i_size, i_extended;
110     const char        *psz_name;
111
112     WAVEFORMATEXTENSIBLE *p_wf_ext = NULL;
113     WAVEFORMATEX         *p_wf = NULL;
114
115     /* Is it a wav file ? */
116     if( stream_Peek( p_demux->s, &p_peek, 12 ) < 12 ) return VLC_EGENERIC;
117
118     if( memcmp( p_peek, "RIFF", 4 ) || memcmp( &p_peek[8], "WAVE", 4 ) )
119     {
120         return VLC_EGENERIC;
121     }
122
123     p_demux->pf_demux   = Demux;
124     p_demux->pf_control = Control;
125     p_demux->p_sys      = p_sys = malloc( sizeof( demux_sys_t ) );
126     if( p_sys == NULL )
127         return VLC_ENOMEM;
128
129     p_sys->p_es         = NULL;
130     p_sys->b_chan_reorder = 0;
131     p_sys->i_channel_mask = 0;
132
133     /* skip riff header */
134     stream_Read( p_demux->s, NULL, 12 );  /* cannot fail as peek succeed */
135
136     /* search fmt chunk */
137     if( ChunkFind( p_demux, "fmt ", &i_size ) )
138     {
139         msg_Err( p_demux, "cannot find 'fmt ' chunk" );
140         goto error;
141     }
142     if( i_size < sizeof( WAVEFORMATEX ) - 2 )   /* XXX -2 isn't a typo */
143     {
144         msg_Err( p_demux, "invalid 'fmt ' chunk" );
145         goto error;
146     }
147     stream_Read( p_demux->s, NULL, 8 );   /* Cannot fail */
148
149     /* load waveformatex */
150     p_wf_ext = malloc( __EVEN( i_size ) + 2 );
151     if( p_wf_ext == NULL )
152          goto error;
153
154     p_wf = (WAVEFORMATEX *)p_wf_ext;
155     p_wf->cbSize = 0;
156     if( stream_Read( p_demux->s,
157                      p_wf, __EVEN( i_size ) ) < (int)__EVEN( i_size ) )
158     {
159         msg_Err( p_demux, "cannot load 'fmt ' chunk" );
160         goto error;
161     }
162
163     es_format_Init( &p_sys->fmt, AUDIO_ES, 0 );
164     wf_tag_to_fourcc( GetWLE( &p_wf->wFormatTag ), &p_sys->fmt.i_codec,
165                       &psz_name );
166     p_sys->fmt.audio.i_channels = GetWLE ( &p_wf->nChannels );
167     p_sys->fmt.audio.i_rate = GetDWLE( &p_wf->nSamplesPerSec );
168     p_sys->fmt.audio.i_blockalign = GetWLE( &p_wf->nBlockAlign );
169     p_sys->fmt.i_bitrate = GetDWLE( &p_wf->nAvgBytesPerSec ) * 8;
170     p_sys->fmt.audio.i_bitspersample = GetWLE( &p_wf->wBitsPerSample );
171     p_sys->fmt.i_extra = GetWLE( &p_wf->cbSize );
172     i_extended = 0;
173
174     /* Handle new WAVE_FORMAT_EXTENSIBLE wav files */
175     /* see the following link for more information:
176      * http://www.microsoft.com/whdc/device/audio/multichaud.mspx#EFAA */
177     if( GetWLE( &p_wf->wFormatTag ) == WAVE_FORMAT_EXTENSIBLE &&
178         i_size >= sizeof( WAVEFORMATEXTENSIBLE ) )
179     {
180         unsigned i, i_channel_mask;
181         GUID guid_subformat;
182
183         guid_subformat = p_wf_ext->SubFormat;
184         guid_subformat.Data1 = GetDWLE( &p_wf_ext->SubFormat.Data1 );
185         guid_subformat.Data2 = GetWLE( &p_wf_ext->SubFormat.Data2 );
186         guid_subformat.Data3 = GetWLE( &p_wf_ext->SubFormat.Data3 );
187
188         sf_tag_to_fourcc( &guid_subformat, &p_sys->fmt.i_codec, &psz_name );
189
190         i_extended = sizeof( WAVEFORMATEXTENSIBLE ) - sizeof( WAVEFORMATEX );
191         p_sys->fmt.i_extra -= i_extended;
192
193         i_channel_mask = GetDWLE( &p_wf_ext->dwChannelMask );
194         if( i_channel_mask )
195         {
196             for( i = 0; i < sizeof(pi_channels_src)/sizeof(uint32_t); i++ )
197             {
198                 if( i_channel_mask & pi_channels_src[i] )
199                     p_sys->i_channel_mask |= pi_channels_in[i];
200             }
201
202             if( p_sys->fmt.i_codec == VLC_FOURCC('a','r','a','w') ||
203                 p_sys->fmt.i_codec == VLC_FOURCC('p','c','m',' ') ||
204                 p_sys->fmt.i_codec == VLC_FOURCC('a','f','l','t') )
205
206             p_sys->b_chan_reorder =
207                 aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
208                                           p_sys->i_channel_mask,
209                                           p_sys->fmt.audio.i_channels,
210                                           p_sys->pi_chan_table );
211
212             msg_Dbg( p_demux, "channel mask: %x, reordering: %i",
213                      p_sys->i_channel_mask, (int)p_sys->b_chan_reorder );
214         }
215         p_sys->fmt.audio.i_physical_channels =
216             p_sys->fmt.audio.i_original_channels =
217                 p_sys->i_channel_mask;
218     }
219
220     if( p_sys->fmt.i_extra > 0 )
221     {
222         p_sys->fmt.p_extra = malloc( p_sys->fmt.i_extra );
223         memcpy( p_sys->fmt.p_extra, ((uint8_t *)p_wf) + i_extended,
224                 p_sys->fmt.i_extra );
225     }
226
227     msg_Dbg( p_demux, "format: 0x%4.4x, fourcc: %4.4s, channels: %d, "
228              "freq: %u Hz, bitrate: %uKo/s, blockalign: %d, bits/samples: %d, "
229              "extra size: %d",
230              GetWLE( &p_wf->wFormatTag ), (char *)&p_sys->fmt.i_codec,
231              p_sys->fmt.audio.i_channels, p_sys->fmt.audio.i_rate,
232              p_sys->fmt.i_bitrate / 8 / 1024, p_sys->fmt.audio.i_blockalign,
233              p_sys->fmt.audio.i_bitspersample, p_sys->fmt.i_extra );
234
235     free( p_wf );
236     p_wf = NULL;
237
238     switch( p_sys->fmt.i_codec )
239     {
240     case VLC_FOURCC( 'a', 'r', 'a', 'w' ):
241     case VLC_FOURCC( 'a', 'f', 'l', 't' ):
242     case VLC_FOURCC( 'u', 'l', 'a', 'w' ):
243     case VLC_FOURCC( 'a', 'l', 'a', 'w' ):
244     case VLC_FOURCC( 'm', 'l', 'a', 'w' ):
245     case VLC_FOURCC( 'p', 'c', 'm', ' ' ):
246         FrameInfo_PCM( p_demux, &p_sys->i_frame_size,
247                        &p_sys->i_frame_samples );
248         break;
249     case VLC_FOURCC( 'm', 's', 0x00, 0x02 ):
250         FrameInfo_MS_ADPCM( p_demux, &p_sys->i_frame_size,
251                             &p_sys->i_frame_samples );
252         break;
253     case VLC_FOURCC( 'm', 's', 0x00, 0x11 ):
254         FrameInfo_IMA_ADPCM( p_demux, &p_sys->i_frame_size,
255                              &p_sys->i_frame_samples );
256         break;
257     case VLC_FOURCC( 'm', 's', 0x00, 0x61 ):
258     case VLC_FOURCC( 'm', 's', 0x00, 0x62 ):
259         /* FIXME not sure at all FIXME */
260         FrameInfo_MS_ADPCM( p_demux, &p_sys->i_frame_size,
261                             &p_sys->i_frame_samples );
262         break;
263     case VLC_FOURCC( 'm', 'p', 'g', 'a' ):
264     case VLC_FOURCC( 'a', '5', '2', ' ' ):
265         /* FIXME set end of area FIXME */
266         goto error;
267     default:
268         msg_Err( p_demux, "unsupported codec (%4.4s)",
269                  (char*)&p_sys->fmt.i_codec );
270         goto error;
271     }
272
273     msg_Dbg( p_demux, "found %s audio format", psz_name );
274
275     if( ChunkFind( p_demux, "data", &p_sys->i_data_size ) )
276     {
277         msg_Err( p_demux, "cannot find 'data' chunk" );
278         goto error;
279     }
280     stream_Read( p_demux->s, NULL, 8 );   /* Cannot fail */
281     p_sys->i_data_pos = stream_Tell( p_demux->s );
282
283     if( p_sys->fmt.i_bitrate <= 0 )
284     {
285         p_sys->fmt.i_bitrate = (mtime_t)p_sys->i_frame_size *
286             p_sys->fmt.audio.i_rate * 8 / p_sys->i_frame_samples;
287     }
288
289     p_sys->p_es = es_out_Add( p_demux->out, &p_sys->fmt );
290
291     date_Init( &p_sys->pts, p_sys->fmt.audio.i_rate, 1 );
292     date_Set( &p_sys->pts, 1 );
293
294     return VLC_SUCCESS;
295
296 error:
297     free( p_wf );
298     free( p_sys );
299     return VLC_EGENERIC;
300 }
301
302 /*****************************************************************************
303  * Demux: read packet and send them to decoders
304  *****************************************************************************
305  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
306  *****************************************************************************/
307 static int Demux( demux_t *p_demux )
308 {
309     demux_sys_t *p_sys = p_demux->p_sys;
310     int64_t     i_pos;
311     block_t     *p_block;
312
313     i_pos = stream_Tell( p_demux->s );
314
315     if( p_sys->i_data_size > 0 &&
316         i_pos >= p_sys->i_data_pos + p_sys->i_data_size )
317     {
318         /* EOF */
319         return 0;
320     }
321
322     if( ( p_block = stream_Block( p_demux->s, p_sys->i_frame_size ) ) == NULL )
323     {
324         msg_Warn( p_demux, "cannot read data" );
325         return 0;
326     }
327
328     p_block->i_dts = p_block->i_pts =
329         date_Increment( &p_sys->pts, p_sys->i_frame_samples );
330
331     /* set PCR */
332     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
333
334     /* Do the channel reordering */
335     if( p_sys->b_chan_reorder )
336         aout_ChannelReorder( p_block->p_buffer, p_block->i_buffer,
337                              p_sys->fmt.audio.i_channels,
338                              p_sys->pi_chan_table,
339                              p_sys->fmt.audio.i_bitspersample );
340
341     es_out_Send( p_demux->out, p_sys->p_es, p_block );
342
343     return 1;
344 }
345
346 /*****************************************************************************
347  * Close: frees unused data
348  *****************************************************************************/
349 static void Close ( vlc_object_t * p_this )
350 {
351     demux_t     *p_demux = (demux_t*)p_this;
352     demux_sys_t *p_sys  = p_demux->p_sys;
353
354     free( p_sys );
355 }
356
357 /*****************************************************************************
358  * Control:
359  *****************************************************************************/
360 static int Control( demux_t *p_demux, int i_query, va_list args )
361 {
362     demux_sys_t *p_sys  = p_demux->p_sys;
363     int64_t i_end = -1;
364
365     if( p_sys->i_data_size > 0 )
366     {
367         i_end = p_sys->i_data_pos + p_sys->i_data_size;
368     }
369
370     return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, i_end,
371                                    p_sys->fmt.i_bitrate,
372                                    p_sys->fmt.audio.i_blockalign,
373                                    i_query, args );
374 }
375
376 /*****************************************************************************
377  * Local functions
378  *****************************************************************************/
379 static int ChunkFind( demux_t *p_demux, const char *fcc, unsigned int *pi_size )
380 {
381     const uint8_t *p_peek;
382
383     for( ;; )
384     {
385         uint32_t i_size;
386
387         if( stream_Peek( p_demux->s, &p_peek, 8 ) < 8 )
388         {
389             msg_Err( p_demux, "cannot peek" );
390             return VLC_EGENERIC;
391         }
392
393         i_size = GetDWLE( p_peek + 4 );
394
395         msg_Dbg( p_demux, "chunk: fcc=`%4.4s` size=%"PRIu32, p_peek, i_size );
396
397         if( !memcmp( p_peek, fcc, 4 ) )
398         {
399             if( pi_size )
400             {
401                 *pi_size = i_size;
402             }
403             return VLC_SUCCESS;
404         }
405
406         /* Skip chunk */
407         if( stream_Read( p_demux->s, NULL, 8 ) != 8
408          || stream_Read( p_demux->s, NULL, i_size ) != i_size
409          || ((i_size & 1) && stream_Read( p_demux->s, NULL, 1 ) != 1 ))
410             return VLC_EGENERIC;
411     }
412 }
413
414 static void FrameInfo_PCM( demux_t *p_demux, unsigned int *pi_size,
415                            int *pi_samples )
416 {
417     demux_sys_t *p_sys = p_demux->p_sys;
418     int i_bytes, i_modulo;
419
420     /* read samples for 50ms of */
421     *pi_samples = __MAX( p_sys->fmt.audio.i_rate / 20, 1 );
422
423     i_bytes = *pi_samples * p_sys->fmt.audio.i_channels *
424         ( (p_sys->fmt.audio.i_bitspersample + 7) / 8 );
425
426     if( p_sys->fmt.audio.i_blockalign > 0 )
427     {
428         if( ( i_modulo = i_bytes % p_sys->fmt.audio.i_blockalign ) != 0 )
429         {
430             i_bytes += p_sys->fmt.audio.i_blockalign - i_modulo;
431         }
432     }
433
434     *pi_size = i_bytes;
435 }
436
437 static void FrameInfo_MS_ADPCM( demux_t *p_demux, unsigned int *pi_size,
438                                 int *pi_samples )
439 {
440     demux_sys_t *p_sys = p_demux->p_sys;
441
442     *pi_samples = 2 + 2 * ( p_sys->fmt.audio.i_blockalign -
443         7 * p_sys->fmt.audio.i_channels ) / p_sys->fmt.audio.i_channels;
444
445     *pi_size = p_sys->fmt.audio.i_blockalign;
446 }
447
448 static void FrameInfo_IMA_ADPCM( demux_t *p_demux, unsigned int *pi_size,
449                                  int *pi_samples )
450 {
451     demux_sys_t *p_sys = p_demux->p_sys;
452
453     *pi_samples = 2 * ( p_sys->fmt.audio.i_blockalign -
454         4 * p_sys->fmt.audio.i_channels ) / p_sys->fmt.audio.i_channels;
455
456     *pi_size = p_sys->fmt.audio.i_blockalign;
457 }