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