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