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