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