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     audio_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_FOURCC('m','p','4','a') )
 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     aout_DateSet( &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_FOURCC('f','l','3','2');
 142     else
 143         p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
 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             return VLC_EGENERIC;
 160         }
 161
 162         p_dec->fmt_out.audio.i_rate = i_rate;
 163         p_dec->fmt_out.audio.i_channels = i_channels;
 164         p_dec->fmt_out.audio.i_physical_channels
 165             = p_dec->fmt_out.audio.i_original_channels
 166             = pi_channels_guessed[i_channels];
 167         aout_DateInit( &p_sys->date, i_rate );
 168     }
 169     else
 170     {
 171         /* Will be initalised from first frame */
 172         p_dec->fmt_out.audio.i_rate = 0;
 173         p_dec->fmt_out.audio.i_channels = 0;
 174     }
 175
 176     /* Set the faad config */
 177     cfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
 178     if (vlc_CPU() & CPU_CAPABILITY_FPU)
 179         cfg->outputFormat = FAAD_FMT_FLOAT;
 180     else
 181         cfg->outputFormat = FAAD_FMT_16BIT;
 182     faacDecSetConfiguration( p_sys->hfaad, cfg );
 183
 184     /* buffer */
 185     p_sys->i_buffer = p_sys->i_buffer_size = 0;
 186     p_sys->p_buffer = NULL;
 187
 188     /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
 189     p_dec->b_need_packetized = true;
 190
 191     p_sys->b_sbr = p_sys->b_ps = false;
 192     return VLC_SUCCESS;
 193 }
 194
 195 /*****************************************************************************
 196  * DecodeBlock:
 197  *****************************************************************************/
 198 static aout_buffer_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 199 {
 200     decoder_sys_t *p_sys = p_dec->p_sys;
 201     block_t *p_block;
 202
 203     if( !pp_block || !*pp_block ) return NULL;
 204
 205     p_block = *pp_block;
 206
 207     if( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
 208     {
 209         block_Release( p_block );
 210         return NULL;
 211     }
 212
 213     /* Remove ADTS header if we have decoder specific config */
 214     if( p_dec->fmt_in.i_extra && p_block->i_buffer > 7 )
 215     {
 216         if( p_block->p_buffer[0] == 0xff &&
 217             ( p_block->p_buffer[1] & 0xf0 ) == 0xf0 ) /* syncword */
 218         {   /* ADTS header present */
 219             size_t i_header_size; /* 7 bytes (+ 2 bytes for crc) */
 220             i_header_size = 7 + ( ( p_block->p_buffer[1] & 0x01 ) ? 0 : 2 );
 221             /* FIXME: multiple blocks per frame */
 222             if( p_block->i_buffer > i_header_size )
 223             {
 224                 vlc_memcpy( p_block->p_buffer,
 225                             p_block->p_buffer + i_header_size,
 226                             p_block->i_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         p_sys->i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
 236         p_sys->p_buffer = realloc( p_sys->p_buffer, p_sys->i_buffer_size );
 237     }
 238
 239     if( p_block->i_buffer > 0 )
 240     {
 241         vlc_memcpy( &p_sys->p_buffer[p_sys->i_buffer],
 242                      p_block->p_buffer, p_block->i_buffer );
 243         p_sys->i_buffer += p_block->i_buffer;
 244         p_block->i_buffer = 0;
 245     }
 246
 247     if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
 248     {
 249         /* We have a decoder config so init the handle */
 250         unsigned long i_rate;
 251         unsigned char i_channels;
 252
 253         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 254                           p_dec->fmt_in.i_extra,
 255                           &i_rate, &i_channels ) >= 0 )
 256         {
 257             p_dec->fmt_out.audio.i_rate = i_rate;
 258             p_dec->fmt_out.audio.i_channels = i_channels;
 259             p_dec->fmt_out.audio.i_physical_channels
 260                 = p_dec->fmt_out.audio.i_original_channels
 261                 = pi_channels_guessed[i_channels];
 262
 263             aout_DateInit( &p_sys->date, i_rate );
 264         }
 265     }
 266
 267     if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
 268     {
 269         unsigned long i_rate;
 270         unsigned char i_channels;
 271
 272         /* Init faad with the first frame */
 273         if( faacDecInit( p_sys->hfaad,
 274                          p_sys->p_buffer, p_sys->i_buffer,
 275                          &i_rate, &i_channels ) < 0 )
 276         {
 277             block_Release( p_block );
 278             return NULL;
 279         }
 280
 281         p_dec->fmt_out.audio.i_rate = i_rate;
 282         p_dec->fmt_out.audio.i_channels = i_channels;
 283         p_dec->fmt_out.audio.i_physical_channels
 284             = p_dec->fmt_out.audio.i_original_channels
 285             = pi_channels_guessed[i_channels];
 286         aout_DateInit( &p_sys->date, i_rate );
 287     }
 288
 289     if( p_block->i_pts != 0 && p_block->i_pts != aout_DateGet( &p_sys->date ) )
 290     {
 291         aout_DateSet( &p_sys->date, p_block->i_pts );
 292     }
 293     else if( !aout_DateGet( &p_sys->date ) )
 294     {
 295         /* We've just started the stream, wait for the first PTS. */
 296         block_Release( p_block );
 297         p_sys->i_buffer = 0;
 298         return NULL;
 299     }
 300
 301     /* Decode all data */
 302     if( p_sys->i_buffer )
 303     {
 304         void *samples;
 305         faacDecFrameInfo frame;
 306         aout_buffer_t *p_out;
 307         int i, j;
 308
 309         samples = faacDecDecode( p_sys->hfaad, &frame,
 310                                  p_sys->p_buffer, p_sys->i_buffer );
 311
 312         if( frame.error > 0 )
 313         {
 314             msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
 315
 316             /* Flush the buffer */
 317             p_sys->i_buffer = 0;
 318             block_Release( p_block );
 319             return NULL;
 320         }
 321
 322         if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
 323         {
 324             msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
 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         if( frame.samples <= 0 )
 338         {
 339             msg_Warn( p_dec, "decoded zero sample" );
 340
 341             /* Flush the buffer */
 342             p_sys->i_buffer -= frame.bytesconsumed;
 343             if( p_sys->i_buffer > 0 )
 344             {
 345                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 346                          p_sys->i_buffer );
 347             }
 348             block_Release( p_block );
 349             return NULL;
 350         }
 351
 352         /* We decoded a valid frame */
 353         if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
 354         {
 355             aout_DateInit( &p_sys->date, frame.samplerate );
 356             aout_DateSet( &p_sys->date, p_block->i_pts );
 357         }
 358         p_block->i_pts = 0;  /* PTS is valid only once */
 359
 360         p_dec->fmt_out.audio.i_rate = frame.samplerate;
 361         p_dec->fmt_out.audio.i_channels = frame.channels;
 362         p_dec->fmt_out.audio.i_physical_channels
 363             = p_dec->fmt_out.audio.i_original_channels
 364             = pi_channels_guessed[frame.channels];
 365
 366         /* Adjust stream info when dealing with SBR/PS */
 367         if( p_sys->b_sbr != frame.sbr || p_sys->b_ps != frame.ps )
 368         {
 369             const char *psz_ext = (frame.sbr && frame.ps) ? "SBR+PS" :
 370                                     frame.sbr ? "SBR" : "PS";
 371
 372             msg_Dbg( p_dec, "AAC %s (channels: %u, samplerate: %lu)",
 373                     psz_ext, frame.channels, frame.samplerate );
 374
 375             if( !p_dec->p_description )
 376                 p_dec->p_description = vlc_meta_New();
 377             if( p_dec->p_description )
 378                 vlc_meta_AddExtra( p_dec->p_description, _("AAC extension"), psz_ext );
 379
 380             p_sys->b_sbr = frame.sbr; p_sys->b_ps = frame.ps;
 381         }
 382
 383         /* Convert frame.channel_position to our own channel values */
 384         p_dec->fmt_out.audio.i_physical_channels = 0;
 385         for( i = 0; i < frame.channels; i++ )
 386         {
 387             /* Find the channel code */
 388             for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
 389             {
 390                 if( frame.channel_position[i] == pi_channels_in[j] )
 391                     break;
 392             }
 393             if( j >= MAX_CHANNEL_POSITIONS )
 394             {
 395                 msg_Warn( p_dec, "unknown channel ordering" );
 396                 /* Invent something */
 397                 j = i;
 398             }
 399             /* */
 400             p_sys->pi_channel_positions[i] = pi_channels_out[j];
 401             if( p_dec->fmt_out.audio.i_physical_channels & pi_channels_out[j] )
 402                 frame.channels--; /* We loose a duplicated channel */
 403             else
 404                 p_dec->fmt_out.audio.i_physical_channels |= pi_channels_out[j];
 405         }
 406         p_dec->fmt_out.audio.i_original_channels =
 407             p_dec->fmt_out.audio.i_physical_channels;
 408
 409         p_out = decoder_NewAudioBuffer(p_dec, frame.samples/frame.channels);
 410         if( p_out == NULL )
 411         {
 412             p_sys->i_buffer = 0;
 413             block_Release( p_block );
 414             return NULL;
 415         }
 416
 417         p_out->start_date = aout_DateGet( &p_sys->date );
 418         p_out->end_date = aout_DateIncrement( &p_sys->date, frame.samples / frame.channels );
 419
 420         DoReordering( (uint32_t *)p_out->p_buffer, samples,
 421                       frame.samples / frame.channels, frame.channels,
 422                       p_sys->pi_channel_positions );
 423
 424         p_sys->i_buffer -= frame.bytesconsumed;
 425         if( p_sys->i_buffer > 0 )
 426         {
 427             memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
 428                      p_sys->i_buffer );
 429         }
 430
 431         return p_out;
 432     }
 433
 434     block_Release( p_block );
 435     return NULL;
 436 }
 437
 438 /*****************************************************************************
 439  * Close:
 440  *****************************************************************************/
 441 static void Close( vlc_object_t *p_this )
 442 {
 443     decoder_t *p_dec = (decoder_t *)p_this;
 444     decoder_sys_t *p_sys = p_dec->p_sys;
 445
 446     faacDecClose( p_sys->hfaad );
 447     free( p_sys->p_buffer );
 448     free( p_sys );
 449 }
 450
 451 /*****************************************************************************
 452  * DoReordering: do some channel re-ordering (the ac3 channel order is
 453  *   different from the aac one).
 454  *****************************************************************************/
 455 static void DoReordering( uint32_t *p_out, uint32_t *p_in, int i_samples,
 456                           int i_nb_channels, uint32_t *pi_chan_positions )
 457 {
 458     int pi_chan_table[MAX_CHANNEL_POSITIONS];
 459     int i, j, k;
 460
 461     /* Find the channels mapping */
 462     for( i = 0, j = 0; i < MAX_CHANNEL_POSITIONS; i++ )
 463     {
 464         for( k = 0; k < i_nb_channels; k++ )
 465         {
 466             if( pi_channels_ordered[i] == pi_chan_positions[k] )
 467             {
 468                 pi_chan_table[k] = j++;
 469                 break;
 470             }
 471         }
 472     }
 473
 474     /* Do the actual reordering */
 475     if( vlc_CPU() & CPU_CAPABILITY_FPU )
 476         for( i = 0; i < i_samples; i++ )
 477             for( j = 0; j < i_nb_channels; j++ )
 478                 p_out[i * i_nb_channels + pi_chan_table[j]] =
 479                     p_in[i * i_nb_channels + j];
 480     else
 481         for( i = 0; i < i_samples; i++ )
 482             for( j = 0; j < i_nb_channels; j++ )
 483                 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
 484                     ((uint16_t *)p_in)[i * i_nb_channels + j];
 485 }
 486