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

   1 /*****************************************************************************
   2  * mpeg_audio.c: parse MPEG audio sync info and packetize the stream
   3  *****************************************************************************
   4  * Copyright (C) 2001-2003 VideoLAN
   5  * $Id: mpeg_audio.c,v 1.12 2003/02/18 18:49:11 fenrir Exp $
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Eric Petit <titer@videolan.org>
   9  *          Christophe Massiot <massiot@via.ecp.fr>
  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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  24  *****************************************************************************/
  25
  26 /*****************************************************************************
  27  * Preamble
  28  *****************************************************************************/
  29 #include <stdlib.h>                                      /* malloc(), free() */
  30 #include <string.h>                                              /* strdup() */
  31
  32 #include <vlc/vlc.h>
  33 #include <vlc/aout.h>
  34 #include <vlc/decoder.h>
  35
  36 /*****************************************************************************
  37  * dec_thread_t : decoder thread descriptor
  38  *****************************************************************************/
  39 typedef struct dec_thread_t
  40 {
  41     /*
  42      * Thread properties
  43      */
  44     vlc_thread_t        thread_id;                /* id for thread functions */
  45
  46     /*
  47      * Input properties
  48      */
  49     decoder_fifo_t *    p_fifo;                /* stores the PES stream data */
  50     bit_stream_t        bit_stream;
  51
  52     /*
  53      * Output properties
  54      */
  55     aout_instance_t *   p_aout; /* opaque */
  56     aout_input_t *      p_aout_input; /* opaque */
  57     audio_sample_format_t output_format;
  58 } dec_thread_t;
  59
  60 #define MAX_FRAME_SIZE 10000
  61 /* This isn't the place to put mad-specific stuff. However, it makes the
  62  * mad plug-in's life much easier if we put 8 extra bytes at the end of the
  63  * buffer, because that way it doesn't have to copy the aout_buffer_t to a
  64  * bigger buffer. This has no implication on other plug-ins, and we only
  65  * lose 8 bytes per frame. --Meuuh */
  66 #define MAD_BUFFER_GUARD 8
  67
  68
  69 /****************************************************************************
  70  * Local prototypes
  71  ****************************************************************************/
  72 static int  Open           ( vlc_object_t * );
  73 static int  RunDecoder     ( decoder_fifo_t * );
  74
  75 static void EndThread      ( dec_thread_t * );
  76
  77 static int SyncInfo( uint32_t i_header, unsigned int * pi_channels,
  78                      unsigned int * pi_sample_rate, unsigned int * pi_bit_rate,
  79                      unsigned int * pi_frame_length,
  80                      unsigned int * pi_current_frame_length,
  81                      unsigned int * pi_layer );
  82
  83 /*****************************************************************************
  84  * Module descriptor
  85  *****************************************************************************/
  86 vlc_module_begin();
  87     set_description( _("MPEG audio layer I/II/III parser") );
  88     set_capability( "decoder", 100 );
  89     set_callbacks( Open, NULL );
  90 vlc_module_end();
  91
  92 /*****************************************************************************
  93  * OpenDecoder: probe the decoder and return score
  94  *****************************************************************************/
  95 static int Open( vlc_object_t *p_this )
  96 {
  97     decoder_fifo_t *p_fifo = (decoder_fifo_t*) p_this;
  98
  99     if( p_fifo->i_fourcc != VLC_FOURCC( 'm', 'p', 'g', 'a') )
 100     {
 101         return VLC_EGENERIC;
 102     }
 103
 104     p_fifo->pf_run = RunDecoder;
 105     return VLC_SUCCESS;
 106 }
 107
 108 /*****************************************************************************
 109  * RunDecoder: this function is called just after the thread is created
 110  *****************************************************************************/
 111 static int RunDecoder( decoder_fifo_t *p_fifo )
 112 {
 113     dec_thread_t * p_dec;
 114     audio_date_t end_date;
 115     unsigned int i_layer = 0;
 116     byte_t p_sync[MAD_BUFFER_GUARD];
 117     mtime_t pts;
 118     int i_free_frame_size = 0;
 119
 120     /* Allocate the memory needed to store the thread's structure */
 121     p_dec = malloc( sizeof(dec_thread_t) );
 122     if( p_dec == NULL )
 123     {
 124         msg_Err( p_fifo, "out of memory" );
 125         DecoderError( p_fifo );
 126         return -1;
 127     }
 128
 129     /* Initialize the thread properties */
 130     p_dec->p_aout = NULL;
 131     p_dec->p_aout_input = NULL;
 132     p_dec->p_fifo = p_fifo;
 133
 134     aout_DateSet( &end_date, 0 );
 135
 136     /* Init the bitstream */
 137     if( InitBitstream( &p_dec->bit_stream, p_dec->p_fifo,
 138                        NULL, NULL ) != VLC_SUCCESS )
 139     {
 140         msg_Err( p_fifo, "cannot initialize bitstream" );
 141         DecoderError( p_fifo );
 142         free( p_dec );
 143         return -1;
 144     }
 145
 146     /* Init sync buffer. */
 147     NextPTS( &p_dec->bit_stream, &pts, NULL );
 148     GetChunk( &p_dec->bit_stream, p_sync, MAD_BUFFER_GUARD );
 149
 150     /* Decoder thread's main loop */
 151     while ( !p_dec->p_fifo->b_die && !p_dec->p_fifo->b_error )
 152     {
 153         int i_current_frame_size;
 154         unsigned int i_rate, i_original_channels, i_frame_size, i_frame_length;
 155         unsigned int i_new_layer, i_bit_rate;
 156         uint32_t i_header;
 157         aout_buffer_t * p_buffer;
 158         int i;
 159
 160         /* Look for sync word - should be 0xffe */
 161         if ( (p_sync[0] != 0xff) || ((p_sync[1] & 0xe0) != 0xe0) )
 162         {
 163             msg_Warn( p_dec->p_fifo, "no sync - skipping" );
 164             /* Look inside the sync buffer. */
 165             for ( i = 1; i < MAD_BUFFER_GUARD - 1; i++ )
 166             {
 167                 if ( (p_sync[i] == 0xff) && ((p_sync[i + 1] & 0xe0) != 0xe0) )
 168                     break;
 169             }
 170             if ( i < MAD_BUFFER_GUARD - 1 )
 171             {
 172                 /* Found it ! */
 173                 memmove( p_sync, &p_sync[i], MAD_BUFFER_GUARD - i );
 174                 GetChunk( &p_dec->bit_stream, &p_sync[MAD_BUFFER_GUARD - i],
 175                           i );
 176             }
 177             else
 178             {
 179                 if ( p_sync[MAD_BUFFER_GUARD - 1] == 0xff
 180                       && ShowBits( &p_dec->bit_stream, 3 ) == 0x3 )
 181                 {
 182                     /* Found it ! */
 183                     p_sync[0] = p_sync[MAD_BUFFER_GUARD - 1];
 184                     GetChunk( &p_dec->bit_stream,
 185                               &p_sync[1], MAD_BUFFER_GUARD - 1 );
 186                 }
 187                 else
 188                 {
 189                     /* Scan the stream. */
 190                     while ( ShowBits( &p_dec->bit_stream, 11 ) != 0x07ff &&
 191                             (!p_dec->p_fifo->b_die) &&
 192                             (!p_dec->p_fifo->b_error) )
 193                     {
 194                         RemoveBits( &p_dec->bit_stream, 8 );
 195                     }
 196                     if ( p_dec->p_fifo->b_die || p_dec->p_fifo->b_error )
 197                         break;
 198                     NextPTS( &p_dec->bit_stream, &pts, NULL );
 199                     GetChunk( &p_dec->bit_stream,p_sync, MAD_BUFFER_GUARD );
 200                 }
 201             }
 202         }
 203         if ( p_dec->p_fifo->b_die || p_dec->p_fifo->b_error ) break;
 204
 205         /* Set the Presentation Time Stamp */
 206         if ( pts != 0 && pts != aout_DateGet( &end_date ) )
 207         {
 208             aout_DateSet( &end_date, pts );
 209         }
 210
 211         /* Get frame header */
 212         i_header = (p_sync[0] << 24) | (p_sync[1] << 16) | (p_sync[2] << 8)
 213                      | p_sync[3];
 214
 215         /* Check if frame is valid and get frame info */
 216         i_current_frame_size = SyncInfo( i_header,
 217                                          &i_original_channels, &i_rate,
 218                                          &i_bit_rate, &i_frame_length,
 219                                          &i_frame_size, &i_new_layer );
 220         if ( !i_current_frame_size )
 221             i_current_frame_size = i_free_frame_size;
 222
 223         if ( i_current_frame_size == -1 )
 224         {
 225             msg_Warn( p_dec->p_fifo, "syncinfo failed" );
 226             /* This is probably an emulated startcode, drop the first byte
 227              * to force looking for the next startcode. */
 228             memmove( p_sync, &p_sync[1], MAD_BUFFER_GUARD - 1 );
 229             p_sync[MAD_BUFFER_GUARD - 1] = GetBits( &p_dec->bit_stream, 8 );
 230             continue;
 231         }
 232         if ( (unsigned int)i_current_frame_size > i_frame_size )
 233         {
 234             msg_Warn( p_dec->p_fifo, "frame too big %d > %d",
 235                       i_current_frame_size, i_frame_size );
 236             memmove( p_sync, &p_sync[1], MAD_BUFFER_GUARD - 1 );
 237             p_sync[MAD_BUFFER_GUARD - 1] = GetBits( &p_dec->bit_stream, 8 );
 238             continue;
 239         }
 240
 241         if( (p_dec->p_aout_input != NULL) &&
 242             ( (p_dec->output_format.i_rate != i_rate)
 243                 || (p_dec->output_format.i_original_channels
 244                       != i_original_channels)
 245                 || (p_dec->output_format.i_bytes_per_frame
 246                       != i_frame_size + MAD_BUFFER_GUARD)
 247                 || (p_dec->output_format.i_frame_length != i_frame_length)
 248                 || (i_layer != i_new_layer) ) )
 249         {
 250             /* Parameters changed - this should not happen. */
 251             aout_DecDelete( p_dec->p_aout, p_dec->p_aout_input );
 252             p_dec->p_aout_input = NULL;
 253         }
 254
 255         /* Creating the audio input if not created yet. */
 256         if( p_dec->p_aout_input == NULL )
 257         {
 258             i_layer = i_new_layer;
 259             if ( i_layer == 3 )
 260             {
 261                 p_dec->output_format.i_format = VLC_FOURCC('m','p','g','3');
 262             }
 263             else
 264             {
 265                 p_dec->output_format.i_format = VLC_FOURCC('m','p','g','a');
 266             }
 267             p_dec->output_format.i_rate = i_rate;
 268             p_dec->output_format.i_original_channels = i_original_channels;
 269             p_dec->output_format.i_physical_channels
 270                        = i_original_channels & AOUT_CHAN_PHYSMASK;
 271             p_dec->output_format.i_bytes_per_frame = i_frame_size
 272                                                         + MAD_BUFFER_GUARD;
 273             p_dec->output_format.i_frame_length = i_frame_length;
 274             aout_DateInit( &end_date, i_rate );
 275             p_dec->p_aout_input = aout_DecNew( p_dec->p_fifo,
 276                                                &p_dec->p_aout,
 277                                                &p_dec->output_format );
 278
 279             if ( p_dec->p_aout_input == NULL )
 280             {
 281                 p_dec->p_fifo->b_error = 1;
 282                 break;
 283             }
 284         }
 285
 286         if ( !aout_DateGet( &end_date ) )
 287         {
 288             byte_t p_junk[MAX_FRAME_SIZE];
 289             int    i_skip = i_current_frame_size - MAD_BUFFER_GUARD;
 290
 291             /* We've just started the stream, wait for the first PTS. */
 292             while( i_skip > 0 )
 293             {
 294                 int i_read;
 295
 296                 i_read = __MIN( i_current_frame_size  - MAD_BUFFER_GUARD, MAX_FRAME_SIZE );
 297                 GetChunk( &p_dec->bit_stream, p_junk, i_read );
 298
 299                 i_skip -= i_read;
 300             }
 301             NextPTS( &p_dec->bit_stream, &pts, NULL );
 302             GetChunk( &p_dec->bit_stream, p_sync, MAD_BUFFER_GUARD );
 303             continue;
 304         }
 305
 306         p_buffer = aout_DecNewBuffer( p_dec->p_aout, p_dec->p_aout_input,
 307                                       i_frame_length );
 308         if ( p_buffer == NULL )
 309         {
 310             p_dec->p_fifo->b_error = 1;
 311             break;
 312         }
 313         p_buffer->start_date = aout_DateGet( &end_date );
 314         p_buffer->end_date = aout_DateIncrement( &end_date,
 315                                                  i_frame_length );
 316
 317         /* Get the whole frame. */
 318         memcpy( p_buffer->p_buffer, p_sync, MAD_BUFFER_GUARD );
 319         if ( i_current_frame_size )
 320         {
 321             GetChunk( &p_dec->bit_stream, p_buffer->p_buffer + MAD_BUFFER_GUARD,
 322                       i_current_frame_size - MAD_BUFFER_GUARD );
 323         }
 324         else
 325         {
 326             /* Free bit-rate stream. Peek at next frame header. */
 327             i = MAD_BUFFER_GUARD;
 328             for ( ; ; )
 329             {
 330                 int i_next_real_frame_size;
 331                 unsigned int i_next_channels, i_next_rate, i_next_bit_rate;
 332                 unsigned int i_next_frame_length, i_next_frame_size;
 333                 unsigned int i_next_layer;
 334                 while ( ShowBits( &p_dec->bit_stream, 11 ) != 0x07ff &&
 335                         (!p_dec->p_fifo->b_die) &&
 336                         (!p_dec->p_fifo->b_error) &&
 337                         i < (int)i_frame_size + MAD_BUFFER_GUARD )
 338                 {
 339                     ((uint8_t *)p_buffer->p_buffer)[i++] =
 340                                 GetBits( &p_dec->bit_stream, 8 );
 341                 }
 342                 if ( p_dec->p_fifo->b_die || p_dec->p_fifo->b_error
 343                       || i == (int)i_frame_size + MAD_BUFFER_GUARD )
 344                     break;
 345                 i_header = ShowBits( &p_dec->bit_stream, 8 );
 346                 i_next_real_frame_size = SyncInfo( i_header,
 347                                          &i_next_channels, &i_next_rate,
 348                                          &i_next_bit_rate, &i_next_frame_length,
 349                                          &i_next_frame_size, &i_next_layer );
 350                 if ( i_next_real_frame_size != 0 ||
 351                      i_next_channels != i_original_channels ||
 352                      i_next_rate != i_rate ||
 353                      i_next_bit_rate != i_bit_rate ||
 354                      i_next_frame_length != i_frame_length ||
 355                      i_next_frame_size != i_frame_size ||
 356                      i_next_layer != i_new_layer )
 357                 {
 358                     /* This is an emulated start code, try again. */
 359                     continue;
 360                 }
 361                 i_free_frame_size = i;
 362                 break;
 363             }
 364             if ( p_dec->p_fifo->b_die || p_dec->p_fifo->b_error )
 365                 break;
 366             if ( i == (int)i_frame_size + MAD_BUFFER_GUARD )
 367             {
 368                 /* Couldn't find the next start-code. This is sooo
 369                  * embarassing. */
 370                 aout_DecDeleteBuffer( p_dec->p_aout, p_dec->p_aout_input,
 371                                       p_buffer );
 372                 NextPTS( &p_dec->bit_stream, &pts, NULL );
 373                 GetChunk( &p_dec->bit_stream, p_sync, MAD_BUFFER_GUARD );
 374                 continue;
 375             }
 376         }
 377         if( p_dec->p_fifo->b_die )
 378         {
 379             aout_DecDeleteBuffer( p_dec->p_aout, p_dec->p_aout_input,
 380                                   p_buffer );
 381             break;
 382         }
 383         /* Get beginning of next frame. */
 384         NextPTS( &p_dec->bit_stream, &pts, NULL );
 385         GetChunk( &p_dec->bit_stream, p_buffer->p_buffer + i_current_frame_size,
 386                   MAD_BUFFER_GUARD );
 387         memcpy( p_sync, p_buffer->p_buffer + i_current_frame_size,
 388                 MAD_BUFFER_GUARD );
 389
 390         p_buffer->i_nb_bytes = i_current_frame_size + MAD_BUFFER_GUARD;
 391
 392         /* Send the buffer to the aout core. */
 393         aout_DecPlay( p_dec->p_aout, p_dec->p_aout_input, p_buffer );
 394     }
 395
 396     if( p_dec->p_fifo->b_error )
 397     {
 398         DecoderError( p_dec->p_fifo );
 399     }
 400
 401     EndThread( p_dec );
 402
 403     return 0;
 404 }
 405
 406 /*****************************************************************************
 407  * EndThread : thread destruction
 408  *****************************************************************************/
 409 static void EndThread( dec_thread_t * p_dec )
 410 {
 411     if ( p_dec->p_aout_input != NULL )
 412     {
 413         aout_DecDelete( p_dec->p_aout, p_dec->p_aout_input );
 414     }
 415
 416     CloseBitstream( &p_dec->bit_stream );
 417     free( p_dec );
 418 }
 419
 420 /*****************************************************************************
 421  * SyncInfo: parse MPEG audio sync info
 422  *****************************************************************************/
 423 static int SyncInfo( uint32_t i_header, unsigned int * pi_channels,
 424                      unsigned int * pi_sample_rate, unsigned int * pi_bit_rate,
 425                      unsigned int * pi_frame_length,
 426                      unsigned int * pi_frame_size, unsigned int * pi_layer )
 427 {
 428     static const int pppi_mpegaudio_bitrate[2][3][16] =
 429     {
 430         {
 431             /* v1 l1 */
 432             { 0, 32, 64, 96, 128, 160, 192, 224, 256, 288, 320, 352, 384,
 433               416, 448, 0},
 434             /* v1 l2 */
 435             { 0, 32, 48, 56,  64,  80,  96, 112, 128, 160, 192, 224, 256,
 436               320, 384, 0},
 437             /* v1 l3 */
 438             { 0, 32, 40, 48,  56,  64,  80,  96, 112, 128, 160, 192, 224,
 439               256, 320, 0}
 440         },
 441
 442         {
 443             /* v2 l1 */
 444             { 0, 32, 48, 56,  64,  80,  96, 112, 128, 144, 160, 176, 192,
 445               224, 256, 0},
 446             /* v2 l2 */
 447             { 0,  8, 16, 24,  32,  40,  48,  56,  64,  80,  96, 112, 128,
 448               144, 160, 0},
 449             /* v2 l3 */
 450             { 0,  8, 16, 24,  32,  40,  48,  56,  64,  80,  96, 112, 128,
 451               144, 160, 0}
 452         }
 453     };
 454
 455     static const int ppi_mpegaudio_samplerate[2][4] = /* version 1 then 2 */
 456     {
 457         { 44100, 48000, 32000, 0 },
 458         { 22050, 24000, 16000, 0 }
 459     };
 460
 461     int i_version, i_mode, i_emphasis;
 462     vlc_bool_t b_padding, b_mpeg_2_5;
 463     int i_current_frame_size = 0;
 464     int i_bitrate_index, i_samplerate_index;
 465     int i_max_bit_rate;
 466
 467     b_mpeg_2_5  = 1 - ((i_header & 0x100000) >> 20);
 468     i_version   = 1 - ((i_header & 0x80000) >> 19);
 469     *pi_layer   = 4 - ((i_header & 0x60000) >> 17);
 470     /* CRC */
 471     i_bitrate_index = (i_header & 0xf000) >> 12;
 472     i_samplerate_index = (i_header & 0xc00) >> 10;
 473     b_padding   = (i_header & 0x200) >> 9;
 474     /* Extension */
 475     i_mode      = (i_header & 0xc0) >> 6;
 476     /* Modeext, copyright & original */
 477     i_emphasis  = i_header & 0x3;
 478
 479     if( *pi_layer != 4 &&
 480         i_bitrate_index < 0x0f &&
 481         i_samplerate_index != 0x03 &&
 482         i_emphasis != 0x02 )
 483     {
 484         switch ( i_mode )
 485         {
 486         case 0: /* stereo */
 487         case 1: /* joint stereo */
 488             *pi_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT;
 489             break;
 490         case 2: /* dual-mono */
 491             *pi_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
 492                             | AOUT_CHAN_DUALMONO;
 493             break;
 494         case 3: /* mono */
 495             *pi_channels = AOUT_CHAN_CENTER;
 496             break;
 497         }
 498         *pi_bit_rate = pppi_mpegaudio_bitrate[i_version][*pi_layer-1][i_bitrate_index];
 499         i_max_bit_rate = pppi_mpegaudio_bitrate[i_version][*pi_layer-1][14];
 500         *pi_sample_rate = ppi_mpegaudio_samplerate[i_version][i_samplerate_index];
 501
 502         if ( b_mpeg_2_5 )
 503         {
 504             *pi_sample_rate >>= 1;
 505         }
 506
 507         switch( *pi_layer )
 508         {
 509         case 1:
 510             i_current_frame_size = ( 12000 *
 511                                         *pi_bit_rate / *pi_sample_rate
 512                                         + b_padding ) * 4;
 513             *pi_frame_size = ( 12000 *
 514                                   i_max_bit_rate / *pi_sample_rate + 1 ) * 4;
 515             *pi_frame_length = 384;
 516             break;
 517
 518         case 2:
 519             i_current_frame_size = 144000 *
 520                                       *pi_bit_rate / *pi_sample_rate
 521                                       + b_padding;
 522             *pi_frame_size = 144000 * i_max_bit_rate / *pi_sample_rate + 1;
 523             *pi_frame_length = 1152;
 524             break;
 525
 526         case 3:
 527             i_current_frame_size = ( i_version ? 72000 : 144000 ) *
 528                                    *pi_bit_rate / *pi_sample_rate + b_padding;
 529             *pi_frame_size = ( i_version ? 72000 : 144000 ) *
 530                                  i_max_bit_rate / *pi_sample_rate + 1;
 531             *pi_frame_length = i_version ? 576 : 1152;
 532             break;
 533
 534         default:
 535             break;
 536         }
 537     }
 538     else
 539     {
 540         return -1;
 541     }
 542
 543     return i_current_frame_size;
 544 }
 545