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