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

   1 /***************************************************************************
   2              libmad.c  -  description
   3                -------------------
   4     Functions that are called by libmad to communicate with vlc decoder
   5     infrastructure.
   6
   7     begin                : Mon Nov 5 2001
   8     copyright            : (C) 2001 by Jean-Paul Saman
   9     email                : jpsaman@wxs.nl
  10  ***************************************************************************/
  11
  12 /***************************************************************************
  13  *                                                                         *
  14  *   This program is free software; you can redistribute it and/or modify  *
  15  *   it under the terms of the GNU General Public License as published by  *
  16  *   the Free Software Foundation; either version 2 of the License, or     *
  17  *   (at your option) any later version.                                   *
  18  *                                                                         *
  19  ***************************************************************************/
  20
  21 /*****************************************************************************
  22  * Preamble
  23  *****************************************************************************/
  24 #include <stdlib.h>                                      /* malloc(), free() */
  25 #include <string.h>                                              /* strdup() */
  26
  27 #include <vlc/vlc.h>
  28 #include <vlc/aout.h>
  29 #include <vlc/decoder.h>
  30
  31 /*****************************************************************************
  32  * Libmad includes files
  33  *****************************************************************************/
  34 #include <mad.h>
  35 #include "decoder.h"
  36 #include "libmad.h"
  37
  38 static void PrintFrameInfo(struct mad_header *Header);
  39
  40 /*****************************************************************************
  41  * libmad_input: this function is called by libmad when the input buffer needs
  42  * to be filled.
  43  *****************************************************************************/
  44 enum mad_flow libmad_input( void *p_data, struct mad_stream *p_stream )
  45 {
  46     mad_adec_thread_t * p_dec = (mad_adec_thread_t *) p_data;
  47     size_t   i_wanted, i_left;
  48
  49     if ( p_dec->p_fifo->b_die )
  50     {
  51         msg_Dbg( p_dec->p_fifo, "stopping libmad decoder" );
  52         return MAD_FLOW_STOP;
  53     }
  54
  55     if ( p_dec->p_fifo->b_error )
  56     {
  57         msg_Warn( p_dec->p_fifo, "ignoring current audio frame" );
  58         return MAD_FLOW_IGNORE;
  59     }
  60
  61     /* libmad_stream_buffer does not consume the total buffer, it consumes
  62      * only data for one frame only. So all data left in the buffer should
  63      * be put back in front. */
  64     if ( !p_stream->buffer || p_stream->error == MAD_ERROR_BUFLEN )
  65     {
  66        /* libmad does not consume all the buffer it's given. Some data,
  67         * part of a truncated frame, is left unused at the end of the
  68         * buffer. Those datas must be put back at the beginning of the
  69         * buffer and taken in account for refilling the buffer. This
  70         * means that the input buffer must be large enough to hold a
  71         * complete frame at the highest observable bit-rate (currently
  72         * 448 kb/s). XXX=XXX Is 2016 bytes the size of the largest frame?
  73         * (448000*(1152/32000))/8 */
  74         if( p_stream->next_frame )
  75         {
  76             i_left = p_stream->bufend - p_stream->next_frame;
  77             if( p_dec->buffer != p_stream->next_frame )
  78             {
  79                 memcpy( p_dec->buffer, p_stream->next_frame, i_left );
  80             }
  81             i_wanted = MAD_BUFFER_MDLEN - i_left;
  82
  83             /* Store timestamp for next frame */
  84             p_dec->i_next_pts = p_dec->p_fifo->p_first->i_pts;
  85         }
  86         else
  87         {
  88             i_wanted = MAD_BUFFER_MDLEN;
  89             i_left = 0;
  90
  91             /* Store timestamp for this frame */
  92             p_dec->i_current_pts = p_dec->p_fifo->p_first->i_pts;
  93         }
  94
  95         /* Fill-in the buffer. If an error occurs print a message and leave
  96          * the decoding loop. If the end of stream is reached we also leave
  97          * the loop but the return status is left untouched. */
  98         if( i_wanted > p_dec->p_data->p_payload_end
  99                         - p_dec->p_data->p_payload_start )
 100         {
 101             i_wanted = p_dec->p_data->p_payload_end
 102                         - p_dec->p_data->p_payload_start;
 103             memcpy( p_dec->buffer + i_left,
 104                     p_dec->p_data->p_payload_start, i_wanted );
 105             NextDataPacket( p_dec->p_fifo, &p_dec->p_data );
 106         }
 107         else
 108         {
 109             memcpy( p_dec->buffer + i_left,
 110                     p_dec->p_data->p_payload_start, i_wanted );
 111             p_dec->p_data->p_payload_start += i_wanted;
 112         }
 113
 114         if ( p_dec->p_fifo->b_die )
 115         {
 116             msg_Dbg( p_dec->p_fifo, "stopping libmad decoder" );
 117             return MAD_FLOW_STOP;
 118         }
 119
 120         if ( p_dec->p_fifo->b_error )
 121         {
 122             msg_Warn( p_dec->p_fifo, "ignoring current audio frame" );
 123             return MAD_FLOW_IGNORE;
 124         }
 125
 126         /* Pipe the new buffer content to libmad's stream decoder facility.
 127          * Libmad never copies the buffer, but just references it. So keep
 128          * it in mad_adec_thread_t structure. */
 129         mad_stream_buffer( p_stream, (unsigned char*) &p_dec->buffer,
 130                            i_left + i_wanted );
 131         p_stream->error = 0;
 132     }
 133
 134     return MAD_FLOW_CONTINUE;
 135 }
 136
 137 /*****************************************************************************
 138  * libmad_output: this function is called just after the frame is decoded
 139  *****************************************************************************/
 140 enum mad_flow libmad_output( void *p_data, struct mad_header const *p_header,
 141                              struct mad_pcm *p_pcm )
 142 {
 143     mad_adec_thread_t * p_dec = (mad_adec_thread_t *) p_data;
 144     aout_buffer_t *     p_buffer;
 145     mad_fixed_t const * p_left = p_pcm->samples[0];
 146     mad_fixed_t const * p_right = p_pcm->samples[1];
 147     register int        i_samples = p_pcm->length;
 148     mad_fixed_t *       p_samples;
 149
 150     /* Creating the audio output fifo. Assume the samplerate and nr of channels
 151      * from the first decoded frame is right for the entire audio track. */
 152     if( (p_dec->p_aout_input != NULL) &&
 153         (p_dec->output_format.i_rate != p_pcm->samplerate) )
 154     {
 155         /* Parameters changed - this should not happen. */
 156         aout_InputDelete( p_dec->p_aout, p_dec->p_aout_input );
 157         p_dec->p_aout_input = NULL;
 158     }
 159
 160     /* Creating the audio input if not created yet. */
 161     if( p_dec->p_aout_input == NULL )
 162     {
 163         p_dec->output_format.i_rate = p_pcm->samplerate;
 164         /* p_dec->output_format.i_channels = p_pcm->channels; */
 165         aout_DateInit( &p_dec->end_date, p_pcm->samplerate );
 166         p_dec->p_aout_input = aout_InputNew( p_dec->p_fifo,
 167                                              &p_dec->p_aout,
 168                                              &p_dec->output_format );
 169
 170         if ( p_dec->p_aout_input == NULL )
 171         {
 172             p_dec->p_fifo->b_error = VLC_TRUE;
 173             return MAD_FLOW_BREAK;
 174         }
 175     }
 176
 177     if( p_dec->i_current_pts )
 178     {
 179         /* Set the Presentation Time Stamp */
 180         if( p_dec->i_current_pts != aout_DateGet( &p_dec->end_date ) )
 181         {
 182             aout_DateSet( &p_dec->end_date, p_dec->i_current_pts );
 183         }
 184
 185         p_dec->i_current_pts = 0;
 186     }
 187     else if( p_dec->i_next_pts )
 188     {
 189         /* No PTS this time, but it'll be for next frame */
 190         p_dec->i_current_pts = p_dec->i_next_pts;
 191         p_dec->i_next_pts = 0;
 192     }
 193
 194     if( !aout_DateGet( &p_dec->end_date ) )
 195     {
 196         /* No date available yet, wait for the first PTS. */
 197         return MAD_FLOW_CONTINUE;
 198     }
 199
 200     p_buffer = aout_BufferNew( p_dec->p_aout, p_dec->p_aout_input, i_samples );
 201
 202     if ( p_buffer == NULL )
 203     {
 204         msg_Err( p_dec->p_fifo, "allocating new buffer failed" );
 205         return MAD_FLOW_BREAK;
 206     }
 207
 208     p_buffer->start_date = aout_DateGet( &p_dec->end_date );
 209     p_buffer->end_date = aout_DateIncrement( &p_dec->end_date, i_samples );
 210
 211     /* Interleave and keep buffers in mad_fixed_t format */
 212     p_samples = (mad_fixed_t *)p_buffer->p_buffer;
 213
 214     switch( p_pcm->channels )
 215     {
 216     case 2:
 217         while( i_samples-- )
 218         {
 219             *p_samples++ = *p_left++;
 220             *p_samples++ = *p_right++;
 221         }
 222         break;
 223     case 1:
 224         while( i_samples-- )
 225         {
 226             *p_samples++ = *p_left;
 227             *p_samples++ = *p_left++;
 228         }
 229         break;
 230     default:
 231         msg_Err( p_dec->p_fifo, "cannot interleave %i channels",
 232                                 p_pcm->channels );
 233     }
 234
 235     aout_BufferPlay( p_dec->p_aout, p_dec->p_aout_input, p_buffer );
 236
 237     return MAD_FLOW_CONTINUE;
 238 }
 239
 240 /*****************************************************************************
 241  * libmad_error: this function is called when an error occurs during decoding
 242  *****************************************************************************/
 243 enum mad_flow libmad_error( void *data, struct mad_stream *p_libmad_stream,
 244                             struct mad_frame *p_libmad_frame )
 245 {
 246     mad_adec_thread_t *p_dec = (mad_adec_thread_t *) data;
 247     enum mad_flow result = MAD_FLOW_CONTINUE;
 248
 249     switch (p_libmad_stream->error)
 250     {
 251     case MAD_ERROR_BUFLEN:                /* input buffer too small (or EOF) */
 252         msg_Err( p_dec->p_fifo, "input buffer too small (or EOF)" );
 253         result = MAD_FLOW_CONTINUE;
 254         break;
 255     case MAD_ERROR_BUFPTR:                /* invalid (null) buffer pointer */
 256         msg_Err( p_dec->p_fifo, "invalid (null) buffer pointer" );
 257         result = MAD_FLOW_STOP;
 258         break;
 259     case MAD_ERROR_NOMEM:                 /* not enough memory */
 260         msg_Err( p_dec->p_fifo, "invalid (null) buffer pointer" );
 261         result = MAD_FLOW_STOP;
 262         break;
 263     case MAD_ERROR_LOSTSYNC:            /* lost synchronization */
 264         msg_Err( p_dec->p_fifo, "lost synchronization" );
 265         mad_stream_sync(p_libmad_stream);
 266         result = MAD_FLOW_CONTINUE;
 267         break;
 268     case MAD_ERROR_BADLAYER:            /* reserved header layer value */
 269         msg_Err( p_dec->p_fifo, "reserved header layer value" );
 270         result = MAD_FLOW_CONTINUE;
 271         break;
 272     case MAD_ERROR_BADBITRATE:        /* forbidden bitrate value */
 273         msg_Err( p_dec->p_fifo, "forbidden bitrate value" );
 274         result = MAD_FLOW_CONTINUE;
 275         break;
 276     case MAD_ERROR_BADSAMPLERATE: /* reserved sample frequency value */
 277         msg_Err( p_dec->p_fifo, "reserved sample frequency value" );
 278         result = MAD_FLOW_CONTINUE;
 279         break;
 280     case MAD_ERROR_BADEMPHASIS:     /* reserved emphasis value */
 281         msg_Err( p_dec->p_fifo, "reserverd emphasis value" );
 282         result = MAD_FLOW_CONTINUE;
 283         break;
 284     case MAD_ERROR_BADCRC:                /* CRC check failed */
 285         msg_Err( p_dec->p_fifo, "CRC check failed" );
 286         result = MAD_FLOW_CONTINUE;
 287         break;
 288     case MAD_ERROR_BADBITALLOC:     /* forbidden bit allocation value */
 289         msg_Err( p_dec->p_fifo, "forbidden bit allocation value" );
 290         result = MAD_FLOW_IGNORE;
 291         break;
 292     case MAD_ERROR_BADSCALEFACTOR:/* bad scalefactor index */
 293         msg_Err( p_dec->p_fifo, "bad scalefactor index" );
 294         result = MAD_FLOW_CONTINUE;
 295         break;
 296     case MAD_ERROR_BADFRAMELEN:     /* bad frame length */
 297         msg_Err( p_dec->p_fifo, "bad frame length" );
 298         result = MAD_FLOW_CONTINUE;
 299         break;
 300     case MAD_ERROR_BADBIGVALUES:    /* bad big_values count */
 301         msg_Err( p_dec->p_fifo, "bad big values count" );
 302         result = MAD_FLOW_IGNORE;
 303         break;
 304     case MAD_ERROR_BADBLOCKTYPE:    /* reserved block_type */
 305         msg_Err( p_dec->p_fifo, "reserverd block_type" );
 306         result = MAD_FLOW_IGNORE;
 307         break;
 308     case MAD_ERROR_BADSCFSI:            /* bad scalefactor selection info */
 309         msg_Err( p_dec->p_fifo, "bad scalefactor selection info" );
 310         result = MAD_FLOW_CONTINUE;
 311         break;
 312     case MAD_ERROR_BADDATAPTR:        /* bad main_data_begin pointer */
 313         msg_Err( p_dec->p_fifo, "bad main_data_begin pointer" );
 314         result = MAD_FLOW_STOP;
 315         break;
 316     case MAD_ERROR_BADPART3LEN:     /* bad audio data length */
 317         msg_Err( p_dec->p_fifo, "bad audio data length" );
 318         result = MAD_FLOW_IGNORE;
 319         break;
 320     case MAD_ERROR_BADHUFFTABLE:    /* bad Huffman table select */
 321         msg_Err( p_dec->p_fifo, "bad Huffman table select" );
 322         result = MAD_FLOW_IGNORE;
 323         break;
 324     case MAD_ERROR_BADHUFFDATA:     /* Huffman data overrun */
 325         msg_Err( p_dec->p_fifo, "Huffman data overrun" );
 326         result = MAD_FLOW_IGNORE;
 327         break;
 328     case MAD_ERROR_BADSTEREO:         /* incompatible block_type for JS */
 329         msg_Err( p_dec->p_fifo, "incompatible block_type for JS" );
 330         result = MAD_FLOW_IGNORE;
 331         break;
 332     default:
 333         msg_Err( p_dec->p_fifo, "unknown error occured stopping decoder" );
 334         result = MAD_FLOW_STOP;
 335         break;
 336     }
 337
 338     return (MAD_RECOVERABLE(p_libmad_stream->error)? result: MAD_FLOW_STOP);
 339     //return (MAD_FLOW_CONTINUE);
 340 }
 341
 342 /*****************************************************************************
 343  * libmad_message: this function is called to send a message
 344  *****************************************************************************/
 345 /* enum mad_flow libmad_message(void *, void*, unsigned int*)
 346  * {
 347  *     return MAD_FLOW_CONTINUE;
 348  * }
 349  */
 350
 351
 352
 353 /****************************************************************************
 354  * Print human readable informations about an audio MPEG frame.                         *
 355  ****************************************************************************/
 356 static void PrintFrameInfo(struct mad_header *Header)
 357 {
 358         const char      *Layer,
 359                         *Mode,
 360                         *Emphasis;
 361
 362         /* Convert the layer number to its printed representation. */
 363         switch(Header->layer)
 364         {
 365                 case MAD_LAYER_I:
 366                         Layer="I";
 367                         break;
 368                 case MAD_LAYER_II:
 369                         Layer="II";
 370                         break;
 371                 case MAD_LAYER_III:
 372                         Layer="III";
 373                         break;
 374                 default:
 375                         Layer="(unexpected layer value)";
 376                         break;
 377         }
 378
 379         /* Convert the audio mode to its printed representation. */
 380         switch(Header->mode)
 381         {
 382                 case MAD_MODE_SINGLE_CHANNEL:
 383                         Mode="single channel";
 384                         break;
 385                 case MAD_MODE_DUAL_CHANNEL:
 386                         Mode="dual channel";
 387                         break;
 388                 case MAD_MODE_JOINT_STEREO:
 389                         Mode="joint (MS/intensity) stereo";
 390                         break;
 391                 case MAD_MODE_STEREO:
 392                         Mode="normal LR stereo";
 393                         break;
 394                 default:
 395                         Mode="(unexpected mode value)";
 396                         break;
 397         }
 398
 399         /* Convert the emphasis to its printed representation. */
 400         switch(Header->emphasis)
 401         {
 402                 case MAD_EMPHASIS_NONE:
 403                         Emphasis="no";
 404                         break;
 405                 case MAD_EMPHASIS_50_15_US:
 406                         Emphasis="50/15 us";
 407                         break;
 408                 case MAD_EMPHASIS_CCITT_J_17:
 409                         Emphasis="CCITT J.17";
 410                         break;
 411                 default:
 412                         Emphasis="(unexpected emphasis value)";
 413                         break;
 414         }
 415
 416 //X     msg_Err("statistics: %lu kb/s audio mpeg layer %s stream %s crc, "
 417 //X                     "%s with %s emphasis at %d Hz sample rate\n",
 418 //X                     Header->bitrate,Layer,
 419 //X                     Header->flags&MAD_FLAG_PROTECTION?"with":"without",
 420 //X                     Mode,Emphasis,Header->samplerate);
 421 }