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