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