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_common.h>
  30 #include <vlc_plugin.h>
  31 #include <vlc_input.h>
  32 #include <vlc_aout.h>
  33 #include <vlc_codec.h>
  34 #include <vlc_cpu.h>
  35
  36 #include <faad.h>
  37
  38 /*****************************************************************************
  39  * Module descriptor
  40  *****************************************************************************/
  41 static int  Open( vlc_object_t * );
  42 static void Close( vlc_object_t * );
  43
  44 vlc_module_begin ()
  45     set_description( N_("AAC audio decoder (using libfaad2)") )
  46     set_capability( "decoder", 100 )
  47     set_category( CAT_INPUT )
  48     set_subcategory( SUBCAT_INPUT_ACODEC )
  49     set_callbacks( Open, Close )
  50 vlc_module_end ()
  51
  52 /****************************************************************************
  53  * Local prototypes
  54  ****************************************************************************/
  55 static aout_buffer_t *DecodeBlock( decoder_t *, block_t ** );
  56 static void DoReordering( uint32_t *, uint32_t *, int, int, uint32_t * );
  57
  58 #define MAX_CHANNEL_POSITIONS 9
  59
  60 struct decoder_sys_t
  61 {
  62     /* faad handler */
  63     faacDecHandle *hfaad;
  64
  65     /* samples */
  66     date_t date;
  67
  68     /* temporary buffer */
  69     uint8_t *p_buffer;
  70     int     i_buffer;
  71     size_t  i_buffer_size;
  72
  73     /* Channel positions of the current stream (for re-ordering) */
  74     uint32_t pi_channel_positions[MAX_CHANNEL_POSITIONS];
  75
  76     bool b_sbr, b_ps;
  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_CODEC_MP4A )
 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 = malloc( sizeof(*p_sys) ) ) == NULL )
 128         return VLC_ENOMEM;
 129
 130     /* Open a faad context */
 131     if( ( p_sys->hfaad = faacDecOpen() ) == NULL )
 132     {
 133         msg_Err( p_dec, "cannot initialize faad" );
 134         return VLC_EGENERIC;
 135     }
 136
 137     /* Misc init */
 138     date_Set( &p_sys->date, 0 );
 139     p_dec->fmt_out.i_cat = AUDIO_ES;
 140
 141     if (HAVE_FPU)
 142         p_dec->fmt_out.i_codec = VLC_CODEC_FL32;
 143     else
 144         p_dec->fmt_out.i_codec = VLC_CODEC_S16N;
 145     p_dec->pf_decode_audio = DecodeBlock;
 146
 147     p_dec->fmt_out.audio.i_physical_channels =
 148         p_dec->fmt_out.audio.i_original_channels = 0;
 149
 150     if( p_dec->fmt_in.i_extra > 0 )
 151     {
 152         /* We have a decoder config so init the handle */
 153         unsigned long i_rate;
 154         unsigned char i_channels;
 155
 156         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 157                           p_dec->fmt_in.i_extra,
 158                           &i_rate, &i_channels ) < 0 )
 159         {
 160             msg_Err( p_dec, "Failed to initialize faad using extra data" );
 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         date_Init( &p_sys->date, i_rate, 1 );
 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 (HAVE_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 = NULL;
 189
 190     /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
 191     p_dec->b_need_packetized = true;
 192
 193     p_sys->b_sbr = p_sys->b_ps = false;
 194     return VLC_SUCCESS;
 195 }
 196
 197 /*****************************************************************************
 198  * DecodeBlock:
 199  *****************************************************************************/
 200 static aout_buffer_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 201 {
 202     decoder_sys_t *p_sys = p_dec->p_sys;
 203     block_t *p_block;
 204
 205     if( !pp_block || !*pp_block ) return NULL;
 206
 207     p_block = *pp_block;
 208
 209     if( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
 210     {
 211         block_Release( p_block );
 212         return NULL;
 213     }
 214
 215     /* Remove ADTS header if we have decoder specific config */
 216     if( p_dec->fmt_in.i_extra && p_block->i_buffer > 7 )
 217     {
 218         if( p_block->p_buffer[0] == 0xff &&
 219             ( p_block->p_buffer[1] & 0xf0 ) == 0xf0 ) /* syncword */
 220         {   /* ADTS header present */
 221             size_t i_header_size; /* 7 bytes (+ 2 bytes for crc) */
 222             i_header_size = 7 + ( ( p_block->p_buffer[1] & 0x01 ) ? 0 : 2 );
 223             /* FIXME: multiple blocks per frame */
 224             if( p_block->i_buffer > i_header_size )
 225             {
 226                 p_block->p_buffer += i_header_size;
 227                 p_block->i_buffer -= i_header_size;
 228             }
 229         }
 230     }
 231
 232     /* Append the block to the temporary buffer */
 233     if( p_sys->i_buffer_size < p_sys->i_buffer + p_block->i_buffer )
 234     {
 235         size_t  i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
 236         uint8_t *p_buffer     = realloc( p_sys->p_buffer, i_buffer_size );
 237         if( p_buffer )
 238         {
 239             p_sys->i_buffer_size = i_buffer_size;
 240             p_sys->p_buffer      = p_buffer;
 241         }
 242         else
 243         {
 244             p_block->i_buffer = 0;
 245         }
 246     }
 247
 248     if( p_block->i_buffer > 0 )
 249     {
 250         vlc_memcpy( &p_sys->p_buffer[p_sys->i_buffer],
 251                      p_block->p_buffer, p_block->i_buffer );
 252         p_sys->i_buffer += p_block->i_buffer;
 253         p_block->i_buffer = 0;
 254     }
 255
 256     if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
 257     {
 258         /* We have a decoder config so init the handle */
 259         unsigned long i_rate;
 260         unsigned char i_channels;
 261
 262         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 263                           p_dec->fmt_in.i_extra,
 264                           &i_rate, &i_channels ) >= 0 )
 265         {
 266             p_dec->fmt_out.audio.i_rate = i_rate;
 267             p_dec->fmt_out.audio.i_channels = i_channels;
 268             p_dec->fmt_out.audio.i_physical_channels
 269                 = p_dec->fmt_out.audio.i_original_channels
 270                 = pi_channels_guessed[i_channels];
 271
 272             date_Init( &p_sys->date, i_rate, 1 );
 273         }
 274     }
 275
 276     if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
 277     {
 278         unsigned long i_rate;
 279         unsigned char i_channels;
 280
 281         /* Init faad with the first frame */
 282         if( faacDecInit( p_sys->hfaad,
 283                          p_sys->p_buffer, p_sys->i_buffer,
 284                          &i_rate, &i_channels ) < 0 )
 285         {
 286             block_Release( p_block );
 287             return NULL;
 288         }
 289
 290         p_dec->fmt_out.audio.i_rate = i_rate;
 291         p_dec->fmt_out.audio.i_channels = i_channels;
 292         p_dec->fmt_out.audio.i_physical_channels
 293             = p_dec->fmt_out.audio.i_original_channels
 294             = pi_channels_guessed[i_channels];
 295         date_Init( &p_sys->date, i_rate, 1 );
 296     }
 297
 298     if( p_block->i_pts != 0 && p_block->i_pts != date_Get( &p_sys->date ) )
 299     {
 300         date_Set( &p_sys->date, p_block->i_pts );
 301     }
 302     else if( !date_Get( &p_sys->date ) )
 303     {
 304         /* We've just started the stream, wait for the first PTS. */
 305         block_Release( p_block );
 306         p_sys->i_buffer = 0;
 307         return NULL;
 308     }
 309
 310     /* Decode all data */
 311     if( p_sys->i_buffer )
 312     {
 313         void *samples;
 314         faacDecFrameInfo frame;
 315         aout_buffer_t *p_out;
 316         int i, j;
 317
 318         samples = faacDecDecode( p_sys->hfaad, &frame,
 319                                  p_sys->p_buffer, p_sys->i_buffer );
 320
 321         if( frame.error > 0 )
 322         {
 323             msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
 324
 325             /* Flush the buffer */
 326             p_sys->i_buffer = 0;
 327             block_Release( p_block );
 328             return NULL;
 329         }
 330
 331         if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
 332         {
 333             msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
 334
 335             /* Flush the buffer */
 336             p_sys->i_buffer -= frame.bytesconsumed;
 337             if( p_sys->i_buffer > 0 )
 338             {
 339                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 340                          p_sys->i_buffer );
 341             }
 342             block_Release( p_block );
 343             return NULL;
 344         }
 345
 346         if( frame.samples <= 0 )
 347         {
 348             msg_Warn( p_dec, "decoded zero sample" );
 349
 350             /* Flush the buffer */
 351             p_sys->i_buffer -= frame.bytesconsumed;
 352             if( p_sys->i_buffer > 0 )
 353             {
 354                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 355                          p_sys->i_buffer );
 356             }
 357             block_Release( p_block );
 358             return NULL;
 359         }
 360
 361         /* We decoded a valid frame */
 362         if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
 363         {
 364             date_Init( &p_sys->date, frame.samplerate, 1 );
 365             date_Set( &p_sys->date, p_block->i_pts );
 366         }
 367         p_block->i_pts = 0;  /* PTS is valid only once */
 368
 369         p_dec->fmt_out.audio.i_rate = frame.samplerate;
 370         p_dec->fmt_out.audio.i_channels = frame.channels;
 371         p_dec->fmt_out.audio.i_physical_channels
 372             = p_dec->fmt_out.audio.i_original_channels
 373             = pi_channels_guessed[frame.channels];
 374
 375         /* Adjust stream info when dealing with SBR/PS */
 376         if( p_sys->b_sbr != frame.sbr || p_sys->b_ps != frame.ps )
 377         {
 378             const char *psz_ext = (frame.sbr && frame.ps) ? "SBR+PS" :
 379                                     frame.sbr ? "SBR" : "PS";
 380
 381             msg_Dbg( p_dec, "AAC %s (channels: %u, samplerate: %lu)",
 382                     psz_ext, frame.channels, frame.samplerate );
 383
 384             if( !p_dec->p_description )
 385                 p_dec->p_description = vlc_meta_New();
 386             if( p_dec->p_description )
 387                 vlc_meta_AddExtra( p_dec->p_description, _("AAC extension"), psz_ext );
 388
 389             p_sys->b_sbr = frame.sbr; p_sys->b_ps = frame.ps;
 390         }
 391
 392         /* Convert frame.channel_position to our own channel values */
 393         p_dec->fmt_out.audio.i_physical_channels = 0;
 394         for( i = 0; i < frame.channels; i++ )
 395         {
 396             /* Find the channel code */
 397             for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
 398             {
 399                 if( frame.channel_position[i] == pi_channels_in[j] )
 400                     break;
 401             }
 402             if( j >= MAX_CHANNEL_POSITIONS )
 403             {
 404                 msg_Warn( p_dec, "unknown channel ordering" );
 405                 /* Invent something */
 406                 j = i;
 407             }
 408             /* */
 409             p_sys->pi_channel_positions[i] = pi_channels_out[j];
 410             if( p_dec->fmt_out.audio.i_physical_channels & pi_channels_out[j] )
 411                 frame.channels--; /* We loose a duplicated channel */
 412             else
 413                 p_dec->fmt_out.audio.i_physical_channels |= pi_channels_out[j];
 414         }
 415         p_dec->fmt_out.audio.i_original_channels =
 416             p_dec->fmt_out.audio.i_physical_channels;
 417
 418         p_out = decoder_NewAudioBuffer(p_dec, frame.samples/frame.channels);
 419         if( p_out == NULL )
 420         {
 421             p_sys->i_buffer = 0;
 422             block_Release( p_block );
 423             return NULL;
 424         }
 425
 426         p_out->i_pts = date_Get( &p_sys->date );
 427         p_out->i_length = date_Increment( &p_sys->date,
 428                                           frame.samples / frame.channels )
 429                           - p_out->i_pts;
 430
 431         DoReordering( (uint32_t *)p_out->p_buffer, samples,
 432                       frame.samples / frame.channels, frame.channels,
 433                       p_sys->pi_channel_positions );
 434
 435         p_sys->i_buffer -= frame.bytesconsumed;
 436         if( p_sys->i_buffer > 0 )
 437         {
 438             memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
 439                      p_sys->i_buffer );
 440         }
 441
 442         return p_out;
 443     }
 444
 445     block_Release( p_block );
 446     return NULL;
 447 }
 448
 449 /*****************************************************************************
 450  * Close:
 451  *****************************************************************************/
 452 static void Close( vlc_object_t *p_this )
 453 {
 454     decoder_t *p_dec = (decoder_t *)p_this;
 455     decoder_sys_t *p_sys = p_dec->p_sys;
 456
 457     faacDecClose( p_sys->hfaad );
 458     free( p_sys->p_buffer );
 459     free( p_sys );
 460 }
 461
 462 /*****************************************************************************
 463  * DoReordering: do some channel re-ordering (the ac3 channel order is
 464  *   different from the aac one).
 465  *****************************************************************************/
 466 static void DoReordering( uint32_t *p_out, uint32_t *p_in, int i_samples,
 467                           int i_nb_channels, uint32_t *pi_chan_positions )
 468 {
 469     int pi_chan_table[MAX_CHANNEL_POSITIONS];
 470     int i, j, k;
 471
 472     /* Find the channels mapping */
 473     for( i = 0, j = 0; i < MAX_CHANNEL_POSITIONS; i++ )
 474     {
 475         for( k = 0; k < i_nb_channels; k++ )
 476         {
 477             if( pi_channels_ordered[i] == pi_chan_positions[k] )
 478             {
 479                 pi_chan_table[k] = j++;
 480                 break;
 481             }
 482         }
 483     }
 484
 485     /* Do the actual reordering */
 486     if( HAVE_FPU )
 487         for( i = 0; i < i_samples; i++ )
 488             for( j = 0; j < i_nb_channels; j++ )
 489                 p_out[i * i_nb_channels + pi_chan_table[j]] =
 490                     p_in[i * i_nb_channels + j];
 491     else
 492         for( i = 0; i < i_samples; i++ )
 493             for( j = 0; j < i_nb_channels; j++ )
 494                 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
 495                     ((uint16_t *)p_in)[i * i_nb_channels + j];
 496 }
 497