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