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