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