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