git.sesse.net Git - vlc/blob - modules/codec/a52.c

   1 /*****************************************************************************
   2  * a52.c: parse A/52 audio sync info and packetize the stream
   3  *****************************************************************************
   4  * Copyright (C) 2001-2002 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Stéphane Borel <stef@via.ecp.fr>
   8  *          Christophe Massiot <massiot@via.ecp.fr>
   9  *          Gildas Bazin <gbazin@videolan.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <vlc_common.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_codec.h>
  36 #include <vlc_aout.h>
  37 #include <vlc_block_helper.h>
  38
  39 #include "a52.h"
  40
  41 /*****************************************************************************
  42  * Module descriptor
  43  *****************************************************************************/
  44 static int  OpenDecoder   ( vlc_object_t * );
  45 static int  OpenPacketizer( vlc_object_t * );
  46 static void CloseCommon   ( vlc_object_t * );
  47
  48 vlc_module_begin ()
  49     set_description( N_("A/52 parser") )
  50     set_capability( "decoder", 100 )
  51     set_callbacks( OpenDecoder, CloseCommon )
  52     set_category( CAT_INPUT )
  53     set_subcategory( SUBCAT_INPUT_ACODEC )
  54
  55     add_submodule ()
  56     set_description( N_("A/52 audio packetizer") )
  57     set_capability( "packetizer", 10 )
  58     set_callbacks( OpenPacketizer, CloseCommon )
  59 vlc_module_end ()
  60
  61 /*****************************************************************************
  62  * decoder_sys_t : decoder descriptor
  63  *****************************************************************************/
  64
  65 struct decoder_sys_t
  66 {
  67     /* Module mode */
  68     bool b_packetizer;
  69
  70     /*
  71      * Input properties
  72      */
  73     int i_state;
  74
  75     block_bytestream_t bytestream;
  76
  77     /*
  78      * Common properties
  79      */
  80     date_t  end_date;
  81
  82     mtime_t i_pts;
  83
  84     vlc_a52_header_t frame;
  85 };
  86
  87 enum {
  88
  89     STATE_NOSYNC,
  90     STATE_SYNC,
  91     STATE_HEADER,
  92     STATE_NEXT_SYNC,
  93     STATE_GET_DATA,
  94     STATE_SEND_DATA
  95 };
  96
  97 /****************************************************************************
  98  * Local prototypes
  99  ****************************************************************************/
 100 static void *DecodeBlock  ( decoder_t *, block_t ** );
 101
 102 static uint8_t       *GetOutBuffer ( decoder_t *, void ** );
 103 static aout_buffer_t *GetAoutBuffer( decoder_t * );
 104 static block_t       *GetSoutBuffer( decoder_t * );
 105
 106 /*****************************************************************************
 107  * OpenCommon: probe the decoder/packetizer and return score
 108  *****************************************************************************/
 109 static int OpenCommon( vlc_object_t *p_this, bool b_packetizer )
 110 {
 111     decoder_t *p_dec = (decoder_t*)p_this;
 112     decoder_sys_t *p_sys;
 113     vlc_fourcc_t i_codec;
 114
 115     switch( p_dec->fmt_in.i_codec )
 116     {
 117     case VLC_CODEC_A52:
 118         i_codec = VLC_CODEC_A52;
 119         break;
 120     case VLC_CODEC_EAC3:
 121         /* XXX ugly hack, a52 does not support eac3 so no eac3 pass-through
 122          * support */
 123         if( !b_packetizer )
 124             return VLC_EGENERIC;
 125         i_codec = VLC_CODEC_EAC3;
 126         break;
 127     default:
 128         return VLC_EGENERIC;
 129     }
 130
 131     /* Allocate the memory needed to store the decoder's structure */
 132     if( ( p_dec->p_sys = p_sys =
 133           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
 134         return VLC_ENOMEM;
 135
 136     /* Misc init */
 137     p_sys->b_packetizer = b_packetizer;
 138     p_sys->i_state = STATE_NOSYNC;
 139     date_Set( &p_sys->end_date, 0 );
 140     p_sys->i_pts = VLC_TS_INVALID;
 141
 142     p_sys->bytestream = block_BytestreamInit();
 143
 144     /* Set output properties */
 145     p_dec->fmt_out.i_cat = AUDIO_ES;
 146     p_dec->fmt_out.i_codec = i_codec;
 147     p_dec->fmt_out.audio.i_rate = 0; /* So end_date gets initialized */
 148     p_dec->fmt_out.audio.i_bytes_per_frame = 0;
 149
 150     /* Set callback */
 151     if( b_packetizer )
 152         p_dec->pf_packetize    = (block_t *(*)(decoder_t *, block_t **))
 153             DecodeBlock;
 154     else
 155         p_dec->pf_decode_audio = (aout_buffer_t *(*)(decoder_t *, block_t **))
 156             DecodeBlock;
 157     return VLC_SUCCESS;
 158 }
 159
 160 static int OpenDecoder( vlc_object_t *p_this )
 161 {
 162     /* HACK: Don't use this codec if we don't have an a52 audio filter */
 163     if( !module_exists( "a52tofloat32" ) )
 164         return VLC_EGENERIC;
 165     return OpenCommon( p_this, false );
 166 }
 167
 168 static int OpenPacketizer( vlc_object_t *p_this )
 169 {
 170     return OpenCommon( p_this, true );
 171 }
 172
 173 /****************************************************************************
 174  * DecodeBlock: the whole thing
 175  ****************************************************************************
 176  * This function is called just after the thread is launched.
 177  ****************************************************************************/
 178 static void *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 179 {
 180     decoder_sys_t *p_sys = p_dec->p_sys;
 181     uint8_t p_header[VLC_A52_HEADER_SIZE];
 182     uint8_t *p_buf;
 183     void *p_out_buffer;
 184
 185     if( !pp_block || !*pp_block ) return NULL;
 186
 187     if( (*pp_block)->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
 188     {
 189         if( (*pp_block)->i_flags&BLOCK_FLAG_CORRUPTED )
 190         {
 191             p_sys->i_state = STATE_NOSYNC;
 192             block_BytestreamEmpty( &p_sys->bytestream );
 193         }
 194         date_Set( &p_sys->end_date, 0 );
 195         block_Release( *pp_block );
 196         return NULL;
 197     }
 198
 199     if( !date_Get( &p_sys->end_date ) && (*pp_block)->i_pts <= VLC_TS_INVALID)
 200     {
 201         /* We've just started the stream, wait for the first PTS. */
 202         block_Release( *pp_block );
 203         return NULL;
 204     }
 205
 206     block_BytestreamPush( &p_sys->bytestream, *pp_block );
 207
 208     while( 1 )
 209     {
 210         switch( p_sys->i_state )
 211         {
 212         case STATE_NOSYNC:
 213             while( block_PeekBytes( &p_sys->bytestream, p_header, 2 )
 214                    == VLC_SUCCESS )
 215             {
 216                 if( p_header[0] == 0x0b && p_header[1] == 0x77 )
 217                 {
 218                     p_sys->i_state = STATE_SYNC;
 219                     break;
 220                 }
 221                 block_SkipByte( &p_sys->bytestream );
 222             }
 223             if( p_sys->i_state != STATE_SYNC )
 224             {
 225                 block_BytestreamFlush( &p_sys->bytestream );
 226
 227                 /* Need more data */
 228                 return NULL;
 229             }
 230
 231         case STATE_SYNC:
 232             /* New frame, set the Presentation Time Stamp */
 233             p_sys->i_pts = p_sys->bytestream.p_block->i_pts;
 234             if( p_sys->i_pts > VLC_TS_INVALID &&
 235                 p_sys->i_pts != date_Get( &p_sys->end_date ) )
 236             {
 237                 date_Set( &p_sys->end_date, p_sys->i_pts );
 238             }
 239             p_sys->i_state = STATE_HEADER;
 240
 241         case STATE_HEADER:
 242             /* Get A/52 frame header (VLC_A52_HEADER_SIZE bytes) */
 243             if( block_PeekBytes( &p_sys->bytestream, p_header,
 244                                  VLC_A52_HEADER_SIZE ) != VLC_SUCCESS )
 245             {
 246                 /* Need more data */
 247                 return NULL;
 248             }
 249
 250             /* Check if frame is valid and get frame info */
 251             if( vlc_a52_header_Parse( &p_sys->frame, p_header, VLC_A52_HEADER_SIZE ) )
 252             {
 253                 msg_Dbg( p_dec, "emulated sync word" );
 254                 block_SkipByte( &p_sys->bytestream );
 255                 p_sys->i_state = STATE_NOSYNC;
 256                 break;
 257             }
 258
 259             p_sys->i_state = STATE_NEXT_SYNC;
 260
 261         case STATE_NEXT_SYNC:
 262             /* TODO: If pp_block == NULL, flush the buffer without checking the
 263              * next sync word */
 264
 265             /* Check if next expected frame contains the sync word */
 266             if( block_PeekOffsetBytes( &p_sys->bytestream,
 267                                        p_sys->frame.i_size, p_header, 2 )
 268                 != VLC_SUCCESS )
 269             {
 270                 /* Need more data */
 271                 return NULL;
 272             }
 273
 274             if( p_sys->b_packetizer &&
 275                 p_header[0] == 0 && p_header[1] == 0 )
 276             {
 277                 /* A52 wav files and audio CD's use stuffing */
 278                 p_sys->i_state = STATE_GET_DATA;
 279                 break;
 280             }
 281
 282             if( p_header[0] != 0x0b || p_header[1] != 0x77 )
 283             {
 284                 msg_Dbg( p_dec, "emulated sync word "
 285                          "(no sync on following frame)" );
 286                 p_sys->i_state = STATE_NOSYNC;
 287                 block_SkipByte( &p_sys->bytestream );
 288                 break;
 289             }
 290             p_sys->i_state = STATE_SEND_DATA;
 291             break;
 292
 293         case STATE_GET_DATA:
 294             /* Make sure we have enough data.
 295              * (Not useful if we went through NEXT_SYNC) */
 296             if( block_WaitBytes( &p_sys->bytestream,
 297                                  p_sys->frame.i_size ) != VLC_SUCCESS )
 298             {
 299                 /* Need more data */
 300                 return NULL;
 301             }
 302             p_sys->i_state = STATE_SEND_DATA;
 303
 304         case STATE_SEND_DATA:
 305             if( !(p_buf = GetOutBuffer( p_dec, &p_out_buffer )) )
 306             {
 307                 //p_dec->b_error = true;
 308                 return NULL;
 309             }
 310
 311             /* Copy the whole frame into the buffer. When we reach this point
 312              * we already know we have enough data available. */
 313             block_GetBytes( &p_sys->bytestream, p_buf, p_sys->frame.i_size );
 314
 315             /* Make sure we don't reuse the same pts twice */
 316             if( p_sys->i_pts == p_sys->bytestream.p_block->i_pts )
 317                 p_sys->i_pts = p_sys->bytestream.p_block->i_pts = VLC_TS_INVALID;
 318
 319             /* So p_block doesn't get re-added several times */
 320             *pp_block = block_BytestreamPop( &p_sys->bytestream );
 321
 322             p_sys->i_state = STATE_NOSYNC;
 323
 324             return p_out_buffer;
 325         }
 326     }
 327
 328     return NULL;
 329 }
 330
 331 /*****************************************************************************
 332  * CloseCommon: clean up the decoder
 333  *****************************************************************************/
 334 static void CloseCommon( vlc_object_t *p_this )
 335 {
 336     decoder_t *p_dec = (decoder_t*)p_this;
 337     decoder_sys_t *p_sys = p_dec->p_sys;
 338
 339     block_BytestreamRelease( &p_sys->bytestream );
 340
 341     free( p_sys );
 342 }
 343
 344 /*****************************************************************************
 345  * GetOutBuffer:
 346  *****************************************************************************/
 347 static uint8_t *GetOutBuffer( decoder_t *p_dec, void **pp_out_buffer )
 348 {
 349     decoder_sys_t *p_sys = p_dec->p_sys;
 350     uint8_t *p_buf;
 351
 352     if( p_dec->fmt_out.audio.i_rate != p_sys->frame.i_rate )
 353     {
 354         msg_Dbg( p_dec, "A/52 channels:%d samplerate:%d bitrate:%d",
 355                  p_sys->frame.i_channels, p_sys->frame.i_rate, p_sys->frame.i_bitrate );
 356
 357         date_Init( &p_sys->end_date, p_sys->frame.i_rate, 1 );
 358         date_Set( &p_sys->end_date, p_sys->i_pts );
 359     }
 360
 361     p_dec->fmt_out.audio.i_rate     = p_sys->frame.i_rate;
 362     p_dec->fmt_out.audio.i_channels = p_sys->frame.i_channels;
 363     if( p_dec->fmt_out.audio.i_bytes_per_frame < p_sys->frame.i_size )
 364         p_dec->fmt_out.audio.i_bytes_per_frame = p_sys->frame.i_size;
 365     p_dec->fmt_out.audio.i_frame_length = p_sys->frame.i_samples;
 366
 367     p_dec->fmt_out.audio.i_original_channels = p_sys->frame.i_channels_conf;
 368     p_dec->fmt_out.audio.i_physical_channels =
 369         p_sys->frame.i_channels_conf & AOUT_CHAN_PHYSMASK;
 370
 371     p_dec->fmt_out.i_bitrate = p_sys->frame.i_bitrate;
 372
 373     if( p_sys->b_packetizer )
 374     {
 375         block_t *p_sout_buffer = GetSoutBuffer( p_dec );
 376         p_buf = p_sout_buffer ? p_sout_buffer->p_buffer : NULL;
 377         *pp_out_buffer = p_sout_buffer;
 378     }
 379     else
 380     {
 381         aout_buffer_t *p_aout_buffer = GetAoutBuffer( p_dec );
 382         p_buf = p_aout_buffer ? p_aout_buffer->p_buffer : NULL;
 383         *pp_out_buffer = p_aout_buffer;
 384     }
 385
 386     return p_buf;
 387 }
 388
 389 /*****************************************************************************
 390  * GetAoutBuffer:
 391  *****************************************************************************/
 392 static aout_buffer_t *GetAoutBuffer( decoder_t *p_dec )
 393 {
 394     decoder_sys_t *p_sys = p_dec->p_sys;
 395     aout_buffer_t *p_buf;
 396
 397     p_buf = decoder_NewAudioBuffer( p_dec, p_sys->frame.i_samples );
 398     if( p_buf == NULL ) return NULL;
 399
 400     p_buf->i_pts = date_Get( &p_sys->end_date );
 401     p_buf->i_length = date_Increment( &p_sys->end_date,
 402                                       p_sys->frame.i_samples ) - p_buf->i_pts;
 403
 404     return p_buf;
 405 }
 406
 407 /*****************************************************************************
 408  * GetSoutBuffer:
 409  *****************************************************************************/
 410 static block_t *GetSoutBuffer( decoder_t *p_dec )
 411 {
 412     decoder_sys_t *p_sys = p_dec->p_sys;
 413     block_t *p_block;
 414
 415     p_block = block_New( p_dec, p_sys->frame.i_size );
 416     if( p_block == NULL ) return NULL;
 417
 418     p_block->i_pts = p_block->i_dts = date_Get( &p_sys->end_date );
 419
 420     p_block->i_length =
 421         date_Increment( &p_sys->end_date, p_sys->frame.i_samples ) - p_block->i_pts;
 422
 423     return p_block;
 424 }
 425