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