Decode G.726 in Wav
[vlc.git] / modules / demux / wav.c
1 /*****************************************************************************
2  * wav.c : wav file input module for vlc
3  *****************************************************************************
4  * Copyright (C) 2001-2008 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 static int ChunkFind( demux_t *, const char *, unsigned int * );
77
78 static int FrameInfo_IMA_ADPCM( unsigned int *, int *, const es_format_t * );
79 static int FrameInfo_MS_ADPCM ( unsigned int *, int *, const es_format_t * );
80 static int FrameInfo_PCM      ( unsigned int *, int *, const es_format_t * );
81 static int FrameInfo_MSGSM    ( unsigned int *, int *, const es_format_t * );
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, WAVE_SPEAKER_BACK_CENTER,
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, AOUT_CHAN_REARCENTER,
92       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT, 0 };
93
94 /*****************************************************************************
95  * Open: check file and initializes structures
96  *****************************************************************************/
97 static int Open( vlc_object_t * p_this )
98 {
99     demux_t     *p_demux = (demux_t*)p_this;
100     demux_sys_t *p_sys;
101
102     const uint8_t *p_peek;
103     unsigned int i_size;
104     unsigned int i_extended;
105     const char        *psz_name;
106
107     WAVEFORMATEXTENSIBLE *p_wf_ext = NULL;
108     WAVEFORMATEX         *p_wf = NULL;
109
110     /* Is it a wav file ? */
111     if( stream_Peek( p_demux->s, &p_peek, 12 ) < 12 )
112         return VLC_EGENERIC;
113
114     if( memcmp( p_peek, "RIFF", 4 ) || memcmp( &p_peek[8], "WAVE", 4 ) )
115     {
116         return VLC_EGENERIC;
117     }
118
119     p_demux->pf_demux   = Demux;
120     p_demux->pf_control = Control;
121     p_demux->p_sys      = p_sys = malloc( sizeof( *p_sys ) );
122     if( p_sys == NULL )
123         return VLC_ENOMEM;
124
125     p_sys->p_es         = NULL;
126     p_sys->b_chan_reorder = false;
127     p_sys->i_channel_mask = 0;
128
129     /* skip riff header */
130     if( stream_Read( p_demux->s, NULL, 12 ) != 12 )
131         goto error;
132
133     /* search fmt chunk */
134     if( ChunkFind( p_demux, "fmt ", &i_size ) )
135     {
136         msg_Err( p_demux, "cannot find 'fmt ' chunk" );
137         goto error;
138     }
139     i_size += 2;
140     if( i_size < sizeof( WAVEFORMATEX ) )
141     {
142         msg_Err( p_demux, "invalid 'fmt ' chunk" );
143         goto error;
144     }
145     if( stream_Read( p_demux->s, NULL, 8 ) != 8 )
146         goto error;
147
148
149     /* load waveformatex */
150     p_wf_ext = malloc( i_size );
151     if( p_wf_ext == NULL )
152          goto error;
153
154     p_wf = &p_wf_ext->Format;
155     p_wf->cbSize = 0;
156     i_size -= 2;
157     if( stream_Read( p_demux->s, p_wf, i_size ) != (int)i_size ||
158         ( ( i_size & 1 ) && stream_Read( p_demux->s, NULL, 1 ) != 1 ) )
159     {
160         msg_Err( p_demux, "cannot load 'fmt ' chunk" );
161         goto error;
162     }
163
164     es_format_Init( &p_sys->fmt, AUDIO_ES, 0 );
165     wf_tag_to_fourcc( GetWLE( &p_wf->wFormatTag ), &p_sys->fmt.i_codec,
166                       &psz_name );
167     p_sys->fmt.audio.i_channels = GetWLE ( &p_wf->nChannels );
168     p_sys->fmt.audio.i_rate = GetDWLE( &p_wf->nSamplesPerSec );
169     p_sys->fmt.audio.i_blockalign = GetWLE( &p_wf->nBlockAlign );
170     p_sys->fmt.i_bitrate = GetDWLE( &p_wf->nAvgBytesPerSec ) * 8;
171     p_sys->fmt.audio.i_bitspersample = GetWLE( &p_wf->wBitsPerSample );
172     if( i_size >= sizeof(WAVEFORMATEX) )
173         p_sys->fmt.i_extra = __MIN( GetWLE( &p_wf->cbSize ), i_size - sizeof(WAVEFORMATEX) );
174     i_extended = 0;
175
176     /* Handle new WAVE_FORMAT_EXTENSIBLE wav files */
177     /* see the following link for more information:
178      * http://www.microsoft.com/whdc/device/audio/multichaud.mspx#EFAA */
179     if( GetWLE( &p_wf->wFormatTag ) == WAVE_FORMAT_EXTENSIBLE &&
180         i_size >= sizeof( WAVEFORMATEXTENSIBLE ) &&
181         ( p_sys->fmt.i_extra + sizeof( WAVEFORMATEX )
182             >= sizeof( WAVEFORMATEXTENSIBLE ) ) )
183     {
184         unsigned i, i_channel_mask;
185         GUID guid_subformat;
186
187         guid_subformat = p_wf_ext->SubFormat;
188         guid_subformat.Data1 = GetDWLE( &p_wf_ext->SubFormat.Data1 );
189         guid_subformat.Data2 = GetWLE( &p_wf_ext->SubFormat.Data2 );
190         guid_subformat.Data3 = GetWLE( &p_wf_ext->SubFormat.Data3 );
191
192         sf_tag_to_fourcc( &guid_subformat, &p_sys->fmt.i_codec, &psz_name );
193
194         i_extended = sizeof( WAVEFORMATEXTENSIBLE ) - sizeof( WAVEFORMATEX );
195         p_sys->fmt.i_extra -= i_extended;
196
197         i_channel_mask = GetDWLE( &p_wf_ext->dwChannelMask );
198         if( i_channel_mask )
199         {
200             int i_match = 0;
201             for( i = 0; i < sizeof(pi_channels_src)/sizeof(*pi_channels_src); i++ )
202             {
203                 if( i_channel_mask & pi_channels_src[i] )
204                 {
205                     if( !( p_sys->i_channel_mask & pi_channels_in[i] ) )
206                         i_match++;
207
208                     i_channel_mask &= ~pi_channels_src[i];
209                     p_sys->i_channel_mask |= pi_channels_in[i];
210
211                     if( i_match >= p_sys->fmt.audio.i_channels )
212                         break;
213                 }
214             }
215             if( i_channel_mask )
216                 msg_Warn( p_demux, "Some channels are unrecognized or uselessly specified (0x%x)", i_channel_mask );
217             if( i_match < p_sys->fmt.audio.i_channels )
218             {
219                 int i_missing = p_sys->fmt.audio.i_channels - i_match;
220                 msg_Warn( p_demux, "Trying to fill up unspecified position for %d channels", p_sys->fmt.audio.i_channels - i_match );
221
222                 static const uint32_t pi_pair[] = { AOUT_CHAN_REARLEFT|AOUT_CHAN_REARRIGHT,
223                                                     AOUT_CHAN_MIDDLELEFT|AOUT_CHAN_MIDDLERIGHT,
224                                                     AOUT_CHAN_LEFT|AOUT_CHAN_RIGHT };
225                 static const uint32_t pi_center[] = { AOUT_CHAN_REARCENTER,
226                                                       0,
227                                                       AOUT_CHAN_CENTER };
228
229                 /* Try to complete with pair */
230                 for( unsigned i = 0; i < sizeof(pi_pair)/sizeof(*pi_pair); i++ )
231                 {
232                     if( i_missing >= 2 && !(p_sys->i_channel_mask & pi_pair[i] ) )
233                     {
234                         i_missing -= 2;
235                         p_sys->i_channel_mask |= pi_pair[i];
236                     }
237                 }
238                 /* Well fill up with what we can */
239                 for( unsigned i = 0; i < sizeof(pi_channels_in)/sizeof(*pi_channels_in) && i_missing > 0; i++ )
240                 {
241                     if( !( p_sys->i_channel_mask & pi_channels_in[i] ) )
242                     {
243                         p_sys->i_channel_mask |= pi_channels_in[i];
244                         i_missing--;
245
246                         if( i_missing <= 0 )
247                             break;
248                     }
249                 }
250
251                 i_match = p_sys->fmt.audio.i_channels - i_missing;
252             }
253             if( i_match < p_sys->fmt.audio.i_channels )
254             {
255                 msg_Err( p_demux, "Invalid/unsupported channel mask" );
256                 p_sys->i_channel_mask = 0;
257             }
258         }
259     }
260     else if( GetWLE( &p_wf->wFormatTag ) == WAVE_FORMAT_PCM &&
261              p_sys->fmt.audio.i_channels > 2 && p_sys->fmt.audio.i_channels <= 9 )
262     {
263         for( int i = 0; i < p_sys->fmt.audio.i_channels; i++ )
264             p_sys->i_channel_mask |= pi_channels_in[i];
265     }
266
267     if( p_sys->i_channel_mask )
268     {
269         if( p_sys->fmt.i_codec == VLC_FOURCC('a','r','a','w') ||
270             p_sys->fmt.i_codec == VLC_FOURCC('p','c','m',' ') ||
271             p_sys->fmt.i_codec == VLC_FOURCC('a','f','l','t') )
272             p_sys->b_chan_reorder =
273                 aout_CheckChannelReorder( pi_channels_in, NULL,
274                                           p_sys->i_channel_mask,
275                                           p_sys->fmt.audio.i_channels,
276                                           p_sys->pi_chan_table );
277
278         msg_Dbg( p_demux, "channel mask: %x, reordering: %i",
279                  p_sys->i_channel_mask, (int)p_sys->b_chan_reorder );
280     }
281
282     p_sys->fmt.audio.i_physical_channels =
283     p_sys->fmt.audio.i_original_channels = p_sys->i_channel_mask;
284
285     if( p_sys->fmt.i_extra > 0 )
286     {
287         p_sys->fmt.p_extra = malloc( p_sys->fmt.i_extra );
288         if( !p_sys->fmt.p_extra )
289         {
290             p_sys->fmt.i_extra = 0;
291             goto error;
292         }
293         memcpy( p_sys->fmt.p_extra, ((uint8_t *)p_wf) + i_extended,
294                 p_sys->fmt.i_extra );
295     }
296
297     msg_Dbg( p_demux, "format: 0x%4.4x, fourcc: %4.4s, channels: %d, "
298              "freq: %u Hz, bitrate: %uKo/s, blockalign: %d, bits/samples: %d, "
299              "extra size: %d",
300              GetWLE( &p_wf->wFormatTag ), (char *)&p_sys->fmt.i_codec,
301              p_sys->fmt.audio.i_channels, p_sys->fmt.audio.i_rate,
302              p_sys->fmt.i_bitrate / 8 / 1024, p_sys->fmt.audio.i_blockalign,
303              p_sys->fmt.audio.i_bitspersample, p_sys->fmt.i_extra );
304
305     free( p_wf );
306     p_wf = NULL;
307
308     switch( p_sys->fmt.i_codec )
309     {
310     case VLC_FOURCC( 'a', 'r', 'a', 'w' ):
311     case VLC_FOURCC( 'a', 'f', 'l', 't' ):
312     case VLC_FOURCC( 'u', 'l', 'a', 'w' ):
313     case VLC_CODEC_ALAW:
314     case VLC_CODEC_MULAW:
315     case VLC_FOURCC( 'p', 'c', 'm', ' ' ):
316         if( FrameInfo_PCM( &p_sys->i_frame_size, &p_sys->i_frame_samples,
317                            &p_sys->fmt ) )
318             goto error;
319         break;
320     case VLC_FOURCC( 'm', 's', 0x00, 0x02 ):
321         if( FrameInfo_MS_ADPCM( &p_sys->i_frame_size, &p_sys->i_frame_samples,
322                                 &p_sys->fmt ) )
323             goto error;
324         break;
325     case VLC_FOURCC( 'm', 's', 0x00, 0x11 ):
326         if( FrameInfo_IMA_ADPCM( &p_sys->i_frame_size, &p_sys->i_frame_samples,
327                                  &p_sys->fmt ) )
328             goto error;
329         break;
330     case VLC_FOURCC( 'm', 's', 0x00, 0x61 ):
331     case VLC_FOURCC( 'm', 's', 0x00, 0x62 ):
332         /* FIXME not sure at all FIXME */
333         if( FrameInfo_MS_ADPCM( &p_sys->i_frame_size, &p_sys->i_frame_samples,
334                                 &p_sys->fmt ) )
335             goto error;
336         break;
337     case VLC_CODEC_MPGA:
338     case VLC_CODEC_A52:
339         /* FIXME set end of area FIXME */
340         goto error;
341     case VLC_CODEC_GSM_MS:
342     case VLC_CODEC_ADPCM_G726:
343         if( FrameInfo_MSGSM( &p_sys->i_frame_size, &p_sys->i_frame_samples,
344                              &p_sys->fmt ) )
345             goto error;
346         break;
347     default:
348         msg_Err( p_demux, "unsupported codec (%4.4s)",
349                  (char*)&p_sys->fmt.i_codec );
350         goto error;
351     }
352
353     if( p_sys->i_frame_size <= 0 || p_sys->i_frame_samples <= 0 )
354     {
355         msg_Dbg( p_demux, "invalid frame size: %i %i", p_sys->i_frame_size,
356                                                        p_sys->i_frame_samples );
357         goto error;
358     }
359     if( p_sys->fmt.audio.i_rate <= 0 )
360     {
361         msg_Dbg( p_demux, "invalid sample rate: %i", p_sys->fmt.audio.i_rate );
362         goto error;
363     }
364
365     msg_Dbg( p_demux, "found %s audio format", psz_name );
366
367     if( ChunkFind( p_demux, "data", &p_sys->i_data_size ) )
368     {
369         msg_Err( p_demux, "cannot find 'data' chunk" );
370         goto error;
371     }
372     if( stream_Read( p_demux->s, NULL, 8 ) != 8 )
373         goto error;
374     p_sys->i_data_pos = stream_Tell( p_demux->s );
375
376     if( p_sys->fmt.i_bitrate <= 0 )
377     {
378         p_sys->fmt.i_bitrate = (int64_t)p_sys->i_frame_size *
379             p_sys->fmt.audio.i_rate * 8 / p_sys->i_frame_samples;
380     }
381
382     p_sys->p_es = es_out_Add( p_demux->out, &p_sys->fmt );
383
384     date_Init( &p_sys->pts, p_sys->fmt.audio.i_rate, 1 );
385     date_Set( &p_sys->pts, 1 );
386
387     return VLC_SUCCESS;
388
389 error:
390     msg_Err( p_demux, "An error occured during wav demuxing" );
391     free( p_wf );
392     free( p_sys );
393     return VLC_EGENERIC;
394 }
395
396 /*****************************************************************************
397  * Demux: read packet and send them to decoders
398  *****************************************************************************
399  * Returns -1 in case of error, 0 in case of EOF, 1 otherwise
400  *****************************************************************************/
401 static int Demux( demux_t *p_demux )
402 {
403     demux_sys_t *p_sys = p_demux->p_sys;
404     block_t     *p_block;
405     const int64_t i_pos = stream_Tell( p_demux->s );
406
407     if( p_sys->i_data_size > 0 &&
408         i_pos >= p_sys->i_data_pos + p_sys->i_data_size )
409     {
410         /* EOF */
411         return 0;
412     }
413
414     if( ( p_block = stream_Block( p_demux->s, p_sys->i_frame_size ) ) == NULL )
415     {
416         msg_Warn( p_demux, "cannot read data" );
417         return 0;
418     }
419
420     p_block->i_dts =
421     p_block->i_pts = date_Increment( &p_sys->pts, p_sys->i_frame_samples );
422
423     /* set PCR */
424     es_out_Control( p_demux->out, ES_OUT_SET_PCR, p_block->i_pts );
425
426     /* Do the channel reordering */
427     if( p_sys->b_chan_reorder )
428         aout_ChannelReorder( p_block->p_buffer, p_block->i_buffer,
429                              p_sys->fmt.audio.i_channels,
430                              p_sys->pi_chan_table,
431                              p_sys->fmt.audio.i_bitspersample );
432
433     es_out_Send( p_demux->out, p_sys->p_es, p_block );
434
435     return 1;
436 }
437
438 /*****************************************************************************
439  * Close: frees unused data
440  *****************************************************************************/
441 static void Close ( vlc_object_t * p_this )
442 {
443     demux_t     *p_demux = (demux_t*)p_this;
444     demux_sys_t *p_sys  = p_demux->p_sys;
445
446     free( p_sys );
447 }
448
449 /*****************************************************************************
450  * Control:
451  *****************************************************************************/
452 static int Control( demux_t *p_demux, int i_query, va_list args )
453 {
454     demux_sys_t *p_sys  = p_demux->p_sys;
455     int64_t i_end = -1;
456
457     if( p_sys->i_data_size > 0 )
458         i_end = p_sys->i_data_pos + p_sys->i_data_size;
459
460     return demux_vaControlHelper( p_demux->s, p_sys->i_data_pos, i_end,
461                                    p_sys->fmt.i_bitrate,
462                                    p_sys->fmt.audio.i_blockalign,
463                                    i_query, args );
464 }
465
466 /*****************************************************************************
467  * Local functions
468  *****************************************************************************/
469 static int ChunkFind( demux_t *p_demux, const char *fcc, unsigned int *pi_size )
470 {
471     const uint8_t *p_peek;
472
473     for( ;; )
474     {
475         uint32_t i_size;
476
477         if( stream_Peek( p_demux->s, &p_peek, 8 ) < 8 )
478         {
479             msg_Err( p_demux, "cannot peek" );
480             return VLC_EGENERIC;
481         }
482
483         i_size = GetDWLE( p_peek + 4 );
484
485         msg_Dbg( p_demux, "chunk: fcc=`%4.4s` size=%"PRIu32, p_peek, i_size );
486
487         if( !memcmp( p_peek, fcc, 4 ) )
488         {
489             if( pi_size )
490             {
491                 *pi_size = i_size;
492             }
493             return VLC_SUCCESS;
494         }
495
496         /* Skip chunk */
497         if( stream_Read( p_demux->s, NULL, 8 ) != 8 ||
498             stream_Read( p_demux->s, NULL, i_size ) != (int)i_size ||
499             ( (i_size & 1) && stream_Read( p_demux->s, NULL, 1 ) != 1 ) )
500             return VLC_EGENERIC;
501     }
502 }
503
504 static int FrameInfo_PCM( unsigned int *pi_size, int *pi_samples,
505                           const es_format_t *p_fmt )
506 {
507     int i_bytes;
508
509     /* read samples for 50ms of */
510     *pi_samples = __MAX( p_fmt->audio.i_rate / 20, 1 );
511
512     i_bytes = *pi_samples * p_fmt->audio.i_channels *
513         ( (p_fmt->audio.i_bitspersample + 7) / 8 );
514
515     if( p_fmt->audio.i_blockalign > 0 )
516     {
517         const int i_modulo = i_bytes % p_fmt->audio.i_blockalign;
518         if( i_modulo > 0 )
519             i_bytes += p_fmt->audio.i_blockalign - i_modulo;
520     }
521
522     *pi_size = i_bytes;
523     return VLC_SUCCESS;
524 }
525
526 static int FrameInfo_MS_ADPCM( unsigned int *pi_size, int *pi_samples,
527                                const es_format_t *p_fmt )
528 {
529     if( p_fmt->audio.i_channels <= 0 )
530         return VLC_EGENERIC;
531
532     *pi_samples = 2 + 2 * ( p_fmt->audio.i_blockalign -
533         7 * p_fmt->audio.i_channels ) / p_fmt->audio.i_channels;
534     *pi_size = p_fmt->audio.i_blockalign;
535
536     return VLC_SUCCESS;
537 }
538
539 static int FrameInfo_IMA_ADPCM( unsigned int *pi_size, int *pi_samples,
540                                 const es_format_t *p_fmt )
541 {
542     if( p_fmt->audio.i_channels <= 0 )
543         return VLC_EGENERIC;
544
545     *pi_samples = 2 * ( p_fmt->audio.i_blockalign -
546         4 * p_fmt->audio.i_channels ) / p_fmt->audio.i_channels;
547     *pi_size = p_fmt->audio.i_blockalign;
548
549     return VLC_SUCCESS;
550 }
551
552 static int FrameInfo_MSGSM( unsigned int *pi_size, int *pi_samples,
553                             const es_format_t *p_fmt )
554 {
555     if( p_fmt->i_bitrate <= 0 )
556         return VLC_EGENERIC;
557
558     *pi_samples = ( p_fmt->audio.i_blockalign * p_fmt->audio.i_rate * 8)
559                     / p_fmt->i_bitrate;
560     *pi_size = p_fmt->audio.i_blockalign;
561
562     return VLC_SUCCESS;
563 }
564