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

   1 /*****************************************************************************
   2  * decoder.c: AAC decoder using libfaad2
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *          Gildas Bazin <gbazin@videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifdef HAVE_CONFIG_H
  26 # include "config.h"
  27 #endif
  28
  29 #include <vlc/vlc.h>
  30 #include <vlc_aout.h>
  31 #include <vlc_codec.h>
  32 #include <vlc_input.h>
  33
  34 #include <faad.h>
  35
  36 /*****************************************************************************
  37  * Module descriptor
  38  *****************************************************************************/
  39 static int  Open( vlc_object_t * );
  40 static void Close( vlc_object_t * );
  41
  42 vlc_module_begin();
  43     set_description( _("AAC audio decoder (using libfaad2)") );
  44     set_capability( "decoder", 100 );
  45     set_category( CAT_INPUT );
  46     set_subcategory( SUBCAT_INPUT_ACODEC );
  47     set_callbacks( Open, Close );
  48 vlc_module_end();
  49
  50 /****************************************************************************
  51  * Local prototypes
  52  ****************************************************************************/
  53 static aout_buffer_t *DecodeBlock( decoder_t *, block_t ** );
  54 static void DoReordering( uint32_t *, uint32_t *, int, int, uint32_t * );
  55
  56 #define MAX_CHANNEL_POSITIONS 9
  57
  58 struct decoder_sys_t
  59 {
  60     /* faad handler */
  61     faacDecHandle *hfaad;
  62
  63     /* samples */
  64     audio_date_t date;
  65
  66     /* temporary buffer */
  67     uint8_t *p_buffer;
  68     int     i_buffer;
  69     size_t  i_buffer_size;
  70
  71     /* Channel positions of the current stream (for re-ordering) */
  72     uint32_t pi_channel_positions[MAX_CHANNEL_POSITIONS];
  73
  74     vlc_bool_t b_sbr, b_ps;
  75
  76     int i_input_rate;
  77 };
  78
  79 static const uint32_t pi_channels_in[MAX_CHANNEL_POSITIONS] =
  80     { FRONT_CHANNEL_CENTER, FRONT_CHANNEL_LEFT, FRONT_CHANNEL_RIGHT,
  81       SIDE_CHANNEL_LEFT, SIDE_CHANNEL_RIGHT,
  82       BACK_CHANNEL_LEFT, BACK_CHANNEL_RIGHT,
  83       BACK_CHANNEL_CENTER, LFE_CHANNEL };
  84 static const uint32_t pi_channels_out[MAX_CHANNEL_POSITIONS] =
  85     { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
  86       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
  87       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
  88       AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE };
  89 static const uint32_t pi_channels_ordered[MAX_CHANNEL_POSITIONS] =
  90     { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
  91       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
  92       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
  93       AOUT_CHAN_CENTER, AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE
  94     };
  95 static const uint32_t pi_channels_guessed[MAX_CHANNEL_POSITIONS] =
  96     { 0, AOUT_CHAN_CENTER, AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT,
  97       AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_LFE,
  98       AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
  99           | AOUT_CHAN_REARRIGHT,
 100       AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
 101           | AOUT_CHAN_REARRIGHT | AOUT_CHAN_CENTER,
 102       AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARLEFT
 103           | AOUT_CHAN_REARRIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_LFE,
 104       AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_MIDDLELEFT
 105           | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
 106           | AOUT_CHAN_CENTER,
 107       AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_MIDDLELEFT
 108           | AOUT_CHAN_MIDDLERIGHT | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT
 109           | AOUT_CHAN_CENTER | AOUT_CHAN_LFE
 110     };
 111
 112 /*****************************************************************************
 113  * OpenDecoder: probe the decoder and return score
 114  *****************************************************************************/
 115 static int Open( vlc_object_t *p_this )
 116 {
 117     decoder_t *p_dec = (decoder_t*)p_this;
 118     decoder_sys_t *p_sys = p_dec->p_sys;
 119     faacDecConfiguration *cfg;
 120
 121     if( p_dec->fmt_in.i_codec != VLC_FOURCC('m','p','4','a') )
 122     {
 123         return VLC_EGENERIC;
 124     }
 125
 126     /* Allocate the memory needed to store the decoder's structure */
 127     if( ( p_dec->p_sys = p_sys =
 128           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
 129     {
 130         msg_Err( p_dec, "out of memory" );
 131         return VLC_EGENERIC;
 132     }
 133
 134     /* Open a faad context */
 135     if( ( p_sys->hfaad = faacDecOpen() ) == NULL )
 136     {
 137         msg_Err( p_dec, "cannot initialize faad" );
 138         return VLC_EGENERIC;
 139     }
 140
 141     /* Misc init */
 142     aout_DateSet( &p_sys->date, 0 );
 143     p_dec->fmt_out.i_cat = AUDIO_ES;
 144
 145     if (vlc_CPU() & CPU_CAPABILITY_FPU)
 146         p_dec->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
 147     else
 148         p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
 149     p_dec->pf_decode_audio = DecodeBlock;
 150
 151     p_dec->fmt_out.audio.i_physical_channels =
 152         p_dec->fmt_out.audio.i_original_channels = 0;
 153
 154     if( p_dec->fmt_in.i_extra > 0 )
 155     {
 156         /* We have a decoder config so init the handle */
 157         unsigned long i_rate;
 158         unsigned char i_channels;
 159
 160         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 161                           p_dec->fmt_in.i_extra,
 162                           &i_rate, &i_channels ) < 0 )
 163         {
 164             return VLC_EGENERIC;
 165         }
 166
 167         p_dec->fmt_out.audio.i_rate = i_rate;
 168         p_dec->fmt_out.audio.i_channels = i_channels;
 169         p_dec->fmt_out.audio.i_physical_channels
 170             = p_dec->fmt_out.audio.i_original_channels
 171             = pi_channels_guessed[i_channels];
 172         aout_DateInit( &p_sys->date, i_rate );
 173     }
 174     else
 175     {
 176         /* Will be initalised from first frame */
 177         p_dec->fmt_out.audio.i_rate = 0;
 178         p_dec->fmt_out.audio.i_channels = 0;
 179     }
 180
 181     /* Set the faad config */
 182     cfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
 183     if (vlc_CPU() & CPU_CAPABILITY_FPU)
 184         cfg->outputFormat = FAAD_FMT_FLOAT;
 185     else
 186         cfg->outputFormat = FAAD_FMT_16BIT;
 187     faacDecSetConfiguration( p_sys->hfaad, cfg );
 188
 189     /* buffer */
 190     p_sys->i_buffer = p_sys->i_buffer_size = 0;
 191     p_sys->p_buffer = 0;
 192
 193     p_sys->i_input_rate = INPUT_RATE_DEFAULT;
 194
 195     /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
 196     p_dec->b_need_packetized = VLC_TRUE;
 197
 198     p_sys->b_sbr = p_sys->b_ps = VLC_FALSE;
 199     return VLC_SUCCESS;
 200 }
 201
 202 /*****************************************************************************
 203  * DecodeBlock:
 204  *****************************************************************************/
 205 static aout_buffer_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 206 {
 207     decoder_sys_t *p_sys = p_dec->p_sys;
 208     block_t *p_block;
 209
 210     if( !pp_block || !*pp_block ) return NULL;
 211
 212     p_block = *pp_block;
 213
 214     if( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
 215     {
 216         block_Release( p_block );
 217         return NULL;
 218     }
 219
 220     if( p_block->i_rate > 0 )
 221         p_sys->i_input_rate = p_block->i_rate;
 222
 223     /* Append the block to the temporary buffer */
 224     if( p_sys->i_buffer_size < p_sys->i_buffer + p_block->i_buffer )
 225     {
 226         p_sys->i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
 227         p_sys->p_buffer = realloc( p_sys->p_buffer, p_sys->i_buffer_size );
 228     }
 229
 230     if( p_block->i_buffer )
 231     {
 232         memcpy( &p_sys->p_buffer[p_sys->i_buffer],
 233                 p_block->p_buffer, p_block->i_buffer );
 234         p_sys->i_buffer += p_block->i_buffer;
 235         p_block->i_buffer = 0;
 236     }
 237
 238     if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
 239     {
 240         /* We have a decoder config so init the handle */
 241         unsigned long i_rate;
 242         unsigned char i_channels;
 243
 244         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 245                           p_dec->fmt_in.i_extra,
 246                           &i_rate, &i_channels ) >= 0 )
 247         {
 248             p_dec->fmt_out.audio.i_rate = i_rate;
 249             p_dec->fmt_out.audio.i_channels = i_channels;
 250             aout_DateInit( &p_sys->date, i_rate );
 251         }
 252     }
 253
 254     if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
 255     {
 256         unsigned long i_rate;
 257         unsigned char i_channels;
 258
 259         /* Init faad with the first frame */
 260         if( faacDecInit( p_sys->hfaad,
 261                          p_sys->p_buffer, p_sys->i_buffer,
 262                          &i_rate, &i_channels ) < 0 )
 263         {
 264             block_Release( p_block );
 265             return NULL;
 266         }
 267
 268         p_dec->fmt_out.audio.i_rate = i_rate;
 269         p_dec->fmt_out.audio.i_channels = i_channels;
 270         aout_DateInit( &p_sys->date, i_rate );
 271     }
 272
 273     if( p_block->i_pts != 0 && p_block->i_pts != aout_DateGet( &p_sys->date ) )
 274     {
 275         aout_DateSet( &p_sys->date, p_block->i_pts );
 276     }
 277     else if( !aout_DateGet( &p_sys->date ) )
 278     {
 279         /* We've just started the stream, wait for the first PTS. */
 280         block_Release( p_block );
 281         p_sys->i_buffer = 0;
 282         return NULL;
 283     }
 284
 285     /* Decode all data */
 286     if( p_sys->i_buffer )
 287     {
 288         void *samples;
 289         faacDecFrameInfo frame;
 290         aout_buffer_t *p_out;
 291         int i, j;
 292
 293         samples = faacDecDecode( p_sys->hfaad, &frame,
 294                                  p_sys->p_buffer, p_sys->i_buffer );
 295
 296         if( frame.error > 0 )
 297         {
 298             msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
 299
 300             /* Flush the buffer */
 301             p_sys->i_buffer = 0;
 302             block_Release( p_block );
 303             return NULL;
 304         }
 305
 306         if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
 307         {
 308             msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
 309
 310             /* Flush the buffer */
 311             p_sys->i_buffer -= frame.bytesconsumed;
 312             if( p_sys->i_buffer > 0 )
 313             {
 314                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 315                          p_sys->i_buffer );
 316             }
 317             block_Release( p_block );
 318             return NULL;
 319         }
 320
 321         if( frame.samples <= 0 )
 322         {
 323             msg_Warn( p_dec, "decoded zero sample" );
 324
 325             /* Flush the buffer */
 326             p_sys->i_buffer -= frame.bytesconsumed;
 327             if( p_sys->i_buffer > 0 )
 328             {
 329                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 330                          p_sys->i_buffer );
 331             }
 332             block_Release( p_block );
 333             return NULL;
 334         }
 335
 336         /* We decoded a valid frame */
 337         if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
 338         {
 339             aout_DateInit( &p_sys->date, frame.samplerate );
 340             aout_DateSet( &p_sys->date, p_block->i_pts );
 341         }
 342         p_block->i_pts = 0;  /* PTS is valid only once */
 343
 344         p_dec->fmt_out.audio.i_rate = frame.samplerate;
 345         p_dec->fmt_out.audio.i_channels = frame.channels;
 346
 347         /* Adjust stream info when dealing with SBR/PS */
 348         if( (p_sys->b_sbr != frame.sbr || p_sys->b_ps != frame.ps) &&
 349             p_dec->p_parent->i_object_type == VLC_OBJECT_INPUT )
 350         {
 351           input_thread_t *p_input = (input_thread_t *)p_dec->p_parent;
 352           char *psz_cat;
 353           const char *psz_ext = (frame.sbr && frame.ps) ? "SBR+PS" :
 354                                     frame.sbr ? "SBR" : "PS";
 355
 356           msg_Dbg( p_dec, "AAC %s (channels: %u, samplerate: %lu)",
 357                    psz_ext, frame.channels, frame.samplerate );
 358
 359           asprintf( &psz_cat, _("Stream %d"), p_dec->fmt_in.i_id );
 360           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
 361                           _("AAC extension"), "%s", psz_ext );
 362           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
 363                          _("Channels"), "%d", frame.channels );
 364           input_Control( p_input, INPUT_ADD_INFO, psz_cat,
 365                          _("Sample rate"), _("%d Hz"), frame.samplerate );
 366           free( psz_cat );
 367           p_sys->b_sbr = frame.sbr; p_sys->b_ps = frame.ps;
 368         }
 369
 370         /* Convert frame.channel_position to our own channel values */
 371         p_dec->fmt_out.audio.i_physical_channels = 0;
 372         for( i = 0; i < frame.channels; i++ )
 373         {
 374             /* Find the channel code */
 375             for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
 376             {
 377                 if( frame.channel_position[i] == pi_channels_in[j] )
 378                     break;
 379             }
 380             if( j >= MAX_CHANNEL_POSITIONS )
 381             {
 382                 msg_Warn( p_dec, "unknown channel ordering" );
 383                 /* Invent something */
 384                 j = i;
 385             }
 386             /* */
 387             p_sys->pi_channel_positions[i] = pi_channels_out[j];
 388             if( p_dec->fmt_out.audio.i_physical_channels & pi_channels_out[j] )
 389                 frame.channels--; /* We loose a duplicated channel */
 390             else
 391                 p_dec->fmt_out.audio.i_physical_channels |= pi_channels_out[j];
 392         }
 393         p_dec->fmt_out.audio.i_original_channels =
 394             p_dec->fmt_out.audio.i_physical_channels;
 395
 396         p_out = p_dec->pf_aout_buffer_new(p_dec, frame.samples/frame.channels);
 397         if( p_out == NULL )
 398         {
 399             p_sys->i_buffer = 0;
 400             block_Release( p_block );
 401             return NULL;
 402         }
 403
 404         p_out->start_date = aout_DateGet( &p_sys->date );
 405         p_out->end_date = aout_DateIncrement( &p_sys->date,
 406             (frame.samples / frame.channels) * p_sys->i_input_rate / INPUT_RATE_DEFAULT );
 407
 408         DoReordering( (uint32_t *)p_out->p_buffer, samples,
 409                       frame.samples / frame.channels, frame.channels,
 410                       p_sys->pi_channel_positions );
 411
 412         p_sys->i_buffer -= frame.bytesconsumed;
 413         if( p_sys->i_buffer > 0 )
 414         {
 415             memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
 416                      p_sys->i_buffer );
 417         }
 418
 419         return p_out;
 420     }
 421
 422     block_Release( p_block );
 423     return NULL;
 424 }
 425
 426 /*****************************************************************************
 427  * Close:
 428  *****************************************************************************/
 429 static void Close( vlc_object_t *p_this )
 430 {
 431     decoder_t *p_dec = (decoder_t *)p_this;
 432     decoder_sys_t *p_sys = p_dec->p_sys;
 433
 434     faacDecClose( p_sys->hfaad );
 435     if( p_sys->p_buffer ) free( p_sys->p_buffer );
 436     free( p_sys );
 437 }
 438
 439 /*****************************************************************************
 440  * DoReordering: do some channel re-ordering (the ac3 channel order is
 441  *   different from the aac one).
 442  *****************************************************************************/
 443 static void DoReordering( uint32_t *p_out, uint32_t *p_in, int i_samples,
 444                           int i_nb_channels, uint32_t *pi_chan_positions )
 445 {
 446     int pi_chan_table[MAX_CHANNEL_POSITIONS];
 447     int i, j, k;
 448
 449     /* Find the channels mapping */
 450     for( k = 0, j = 0; k < i_nb_channels; k++ )
 451     {
 452         for( i = 0; i < MAX_CHANNEL_POSITIONS; i++ )
 453         {
 454             if( pi_channels_ordered[i] == pi_chan_positions[k] )
 455             {
 456                 pi_chan_table[k] = j++;
 457                 break;
 458             }
 459         }
 460     }
 461
 462     /* Do the actual reordering */
 463     if( vlc_CPU() & CPU_CAPABILITY_FPU )
 464         for( i = 0; i < i_samples; i++ )
 465             for( j = 0; j < i_nb_channels; j++ )
 466                 p_out[i * i_nb_channels + pi_chan_table[j]] =
 467                     p_in[i * i_nb_channels + j];
 468     else
 469         for( i = 0; i < i_samples; i++ )
 470             for( j = 0; j < i_nb_channels; j++ )
 471                 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
 472                     ((uint16_t *)p_in)[i * i_nb_channels + j];
 473 }