git.sesse.net Git - vlc/blob - modules/codec/faad.c

   1 /*****************************************************************************
   2  * decoder.c: AAC decoder using libfaad2
   3  *****************************************************************************
   4  * Copyright (C) 2001, 2003 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  23  *****************************************************************************/
  24
  25 #include <vlc/vlc.h>
  26 #include <vlc/aout.h>
  27 #include <vlc/decoder.h>
  28
  29 #include <faad.h>
  30
  31 /*****************************************************************************
  32  * Module descriptor
  33  *****************************************************************************/
  34 static int  Open( vlc_object_t * );
  35 static void Close( vlc_object_t * );
  36
  37 vlc_module_begin();
  38     set_description( _("AAC audio decoder (using libfaad2)") );
  39     set_capability( "decoder", 100 );
  40     set_callbacks( Open, Close );
  41 vlc_module_end();
  42
  43 /****************************************************************************
  44  * Local prototypes
  45  ****************************************************************************/
  46 static aout_buffer_t *DecodeBlock( decoder_t *, block_t ** );
  47 static void DoReordering( decoder_t *, uint32_t *, uint32_t *, int, int,
  48                           uint32_t * );
  49
  50 #define MAX_CHANNEL_POSITIONS 9
  51
  52 struct decoder_sys_t
  53 {
  54     /* faad handler */
  55     faacDecHandle *hfaad;
  56
  57     /* samples */
  58     audio_date_t date;
  59
  60     /* temporary buffer */
  61     uint8_t *p_buffer;
  62     int     i_buffer;
  63     int     i_buffer_size;
  64
  65     /* Channel positions of the current stream (for re-ordering) */
  66     uint32_t pi_channel_positions[MAX_CHANNEL_POSITIONS];
  67 };
  68
  69 static const uint32_t pi_channels_in[MAX_CHANNEL_POSITIONS] =
  70     { FRONT_CHANNEL_CENTER, FRONT_CHANNEL_LEFT, FRONT_CHANNEL_RIGHT,
  71       SIDE_CHANNEL_LEFT, SIDE_CHANNEL_RIGHT,
  72       BACK_CHANNEL_LEFT, BACK_CHANNEL_RIGHT,
  73       BACK_CHANNEL_CENTER, LFE_CHANNEL };
  74 static const uint32_t pi_channels_out[MAX_CHANNEL_POSITIONS] =
  75     { AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
  76       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
  77       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
  78       AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE };
  79 static const uint32_t pi_channels_ordered[MAX_CHANNEL_POSITIONS] =
  80     { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT,
  81       AOUT_CHAN_MIDDLELEFT, AOUT_CHAN_MIDDLERIGHT,
  82       AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
  83       AOUT_CHAN_CENTER, AOUT_CHAN_REARCENTER, AOUT_CHAN_LFE
  84     };
  85
  86 /*****************************************************************************
  87  * OpenDecoder: probe the decoder and return score
  88  *****************************************************************************/
  89 static int Open( vlc_object_t *p_this )
  90 {
  91     decoder_t *p_dec = (decoder_t*)p_this;
  92     decoder_sys_t *p_sys = p_dec->p_sys;
  93     faacDecConfiguration *cfg;
  94
  95     if( p_dec->fmt_in.i_codec != VLC_FOURCC('m','p','4','a') )
  96     {
  97         return VLC_EGENERIC;
  98     }
  99
 100     /* Allocate the memory needed to store the decoder's structure */
 101     if( ( p_dec->p_sys = p_sys =
 102           (decoder_sys_t *)malloc(sizeof(decoder_sys_t)) ) == NULL )
 103     {
 104         msg_Err( p_dec, "out of memory" );
 105         return VLC_EGENERIC;
 106     }
 107
 108     /* Open a faad context */
 109     if( ( p_sys->hfaad = faacDecOpen() ) == NULL )
 110     {
 111         msg_Err( p_dec, "cannot initialize faad" );
 112         return VLC_EGENERIC;
 113     }
 114
 115     /* Misc init */
 116     aout_DateSet( &p_sys->date, 0 );
 117     p_dec->fmt_out.i_cat = AUDIO_ES;
 118
 119     if (p_this->p_libvlc->i_cpu & CPU_CAPABILITY_FPU)
 120         p_dec->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
 121     else
 122         p_dec->fmt_out.i_codec = AOUT_FMT_S16_NE;
 123     p_dec->pf_decode_audio = DecodeBlock;
 124
 125     p_dec->fmt_out.audio.i_physical_channels =
 126         p_dec->fmt_out.audio.i_original_channels = 0;
 127
 128     if( p_dec->fmt_in.i_extra > 0 )
 129     {
 130         /* We have a decoder config so init the handle */
 131         unsigned long i_rate;
 132         unsigned char i_channels;
 133
 134         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 135                           p_dec->fmt_in.i_extra,
 136                           &i_rate, &i_channels ) < 0 )
 137         {
 138             return VLC_EGENERIC;
 139         }
 140
 141         p_dec->fmt_out.audio.i_rate = i_rate;
 142         p_dec->fmt_out.audio.i_channels = i_channels;
 143         aout_DateInit( &p_sys->date, i_rate );
 144     }
 145     else
 146     {
 147         /* Will be initalised from first frame */
 148         p_dec->fmt_out.audio.i_rate = 0;
 149         p_dec->fmt_out.audio.i_channels = 0;
 150     }
 151
 152     /* Set the faad config */
 153     cfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
 154     if (p_this->p_libvlc->i_cpu & CPU_CAPABILITY_FPU)
 155         cfg->outputFormat = FAAD_FMT_FLOAT;
 156     else
 157         cfg->outputFormat = FAAD_FMT_16BIT;
 158     faacDecSetConfiguration( p_sys->hfaad, cfg );
 159
 160     /* buffer */
 161     p_sys->i_buffer = p_sys->i_buffer_size = 0;
 162     p_sys->p_buffer = 0;
 163
 164     /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
 165     p_dec->b_need_packetized = VLC_TRUE;
 166
 167     return VLC_SUCCESS;
 168 }
 169
 170 /*****************************************************************************
 171  * DecodeBlock:
 172  *****************************************************************************/
 173 static aout_buffer_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 174 {
 175     decoder_sys_t *p_sys = p_dec->p_sys;
 176     block_t *p_block;
 177
 178     if( !pp_block || !*pp_block ) return NULL;
 179
 180     p_block = *pp_block;
 181
 182     if( p_block->i_flags&BLOCK_FLAG_DISCONTINUITY )
 183     {
 184         block_Release( p_block );
 185         return NULL;
 186     }
 187
 188     /* Append the block to the temporary buffer */
 189     if( p_sys->i_buffer_size < p_sys->i_buffer + p_block->i_buffer )
 190     {
 191         p_sys->i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
 192         p_sys->p_buffer = realloc( p_sys->p_buffer, p_sys->i_buffer_size );
 193     }
 194
 195     if( p_block->i_buffer )
 196     {
 197         memcpy( &p_sys->p_buffer[p_sys->i_buffer],
 198                 p_block->p_buffer, p_block->i_buffer );
 199         p_sys->i_buffer += p_block->i_buffer;
 200         p_block->i_buffer = 0;
 201     }
 202
 203     if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
 204     {
 205         /* We have a decoder config so init the handle */
 206         unsigned long i_rate;
 207         unsigned char i_channels;
 208
 209         if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
 210                           p_dec->fmt_in.i_extra,
 211                           &i_rate, &i_channels ) >= 0 )
 212         {
 213             p_dec->fmt_out.audio.i_rate = i_rate;
 214             p_dec->fmt_out.audio.i_channels = i_channels;
 215             aout_DateInit( &p_sys->date, i_rate );
 216         }
 217     }
 218
 219     if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
 220     {
 221         unsigned long i_rate;
 222         unsigned char i_channels;
 223
 224         /* Init faad with the first frame */
 225         if( faacDecInit( p_sys->hfaad,
 226                          p_sys->p_buffer, p_sys->i_buffer,
 227                          &i_rate, &i_channels ) < 0 )
 228         {
 229             block_Release( p_block );
 230             return NULL;
 231         }
 232
 233         p_dec->fmt_out.audio.i_rate = i_rate;
 234         p_dec->fmt_out.audio.i_channels = i_channels;
 235         aout_DateInit( &p_sys->date, i_rate );
 236     }
 237
 238     if( p_block->i_pts != 0 && p_block->i_pts != aout_DateGet( &p_sys->date ) )
 239     {
 240         aout_DateSet( &p_sys->date, p_block->i_pts );
 241     }
 242     else if( !aout_DateGet( &p_sys->date ) )
 243     {
 244         /* We've just started the stream, wait for the first PTS. */
 245         block_Release( p_block );
 246         p_sys->i_buffer = 0;
 247         return NULL;
 248     }
 249
 250     /* Decode all data */
 251     if( p_sys->i_buffer )
 252     {
 253         void *samples;
 254         faacDecFrameInfo frame;
 255         aout_buffer_t *p_out;
 256         int i, j;
 257
 258         samples = faacDecDecode( p_sys->hfaad, &frame,
 259                                  p_sys->p_buffer, p_sys->i_buffer );
 260
 261         if( frame.error > 0 )
 262         {
 263             msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
 264
 265             /* Flush the buffer */
 266             p_sys->i_buffer = 0;
 267             block_Release( p_block );
 268             return NULL;
 269         }
 270
 271         if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
 272         {
 273             msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
 274
 275             /* Flush the buffer */
 276             p_sys->i_buffer -= frame.bytesconsumed;
 277             if( p_sys->i_buffer > 0 )
 278             {
 279                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 280                          p_sys->i_buffer );
 281             }
 282             block_Release( p_block );
 283             return NULL;
 284         }
 285
 286         if( frame.samples <= 0 )
 287         {
 288             msg_Warn( p_dec, "decoded zero sample" );
 289
 290             /* Flush the buffer */
 291             p_sys->i_buffer -= frame.bytesconsumed;
 292             if( p_sys->i_buffer > 0 )
 293             {
 294                 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
 295                          p_sys->i_buffer );
 296             }
 297             block_Release( p_block );
 298             return NULL;
 299         }
 300
 301         /* We decoded a valid frame */
 302         if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
 303         {
 304             aout_DateInit( &p_sys->date, frame.samplerate );
 305             aout_DateSet( &p_sys->date, p_block->i_pts );
 306         }
 307         p_block->i_pts = 0;  /* PTS is valid only once */
 308
 309         p_dec->fmt_out.audio.i_rate = frame.samplerate;
 310         p_dec->fmt_out.audio.i_channels = frame.channels;
 311
 312
 313         /* Convert frame.channel_position to our own channel values */
 314         for( i = 0; i < frame.channels; i++ )
 315         {
 316             /* Find the channel code */
 317             for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
 318             {
 319                 if( frame.channel_position[i] == pi_channels_in[j] )
 320                 {
 321                     p_sys->pi_channel_positions[i] = pi_channels_out[j];
 322                     p_dec->fmt_out.audio.i_physical_channels |=
 323                         pi_channels_out[j];
 324                     break;
 325                 }
 326             }
 327
 328             if( j == MAX_CHANNEL_POSITIONS )
 329             {
 330                 msg_Warn( p_dec, "unknown channel ordering" );
 331                 block_Release( p_block );
 332                 return NULL;
 333             }
 334         }
 335         p_dec->fmt_out.audio.i_original_channels =
 336             p_dec->fmt_out.audio.i_physical_channels;
 337
 338         p_out = p_dec->pf_aout_buffer_new(p_dec, frame.samples/frame.channels);
 339         if( p_out == NULL )
 340         {
 341             p_sys->i_buffer = 0;
 342             block_Release( p_block );
 343             return NULL;
 344         }
 345
 346         p_out->start_date = aout_DateGet( &p_sys->date );
 347         p_out->end_date = aout_DateIncrement( &p_sys->date,
 348                                               frame.samples / frame.channels );
 349
 350         DoReordering( p_dec, (uint32_t *)p_out->p_buffer, samples,
 351                       frame.samples / frame.channels, frame.channels,
 352                       p_sys->pi_channel_positions );
 353
 354         p_sys->i_buffer -= frame.bytesconsumed;
 355         if( p_sys->i_buffer > 0 )
 356         {
 357             memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
 358                      p_sys->i_buffer );
 359         }
 360
 361         return p_out;
 362     }
 363
 364     block_Release( p_block );
 365     return NULL;
 366 }
 367
 368 /*****************************************************************************
 369  * Close:
 370  *****************************************************************************/
 371 static void Close( vlc_object_t *p_this )
 372 {
 373     decoder_t *p_dec = (decoder_t *)p_this;
 374     decoder_sys_t *p_sys = p_dec->p_sys;
 375
 376     faacDecClose( p_sys->hfaad );
 377     free( p_sys );
 378 }
 379
 380 /*****************************************************************************
 381  * DoReordering: do some channel re-ordering (the ac3 channel order is
 382  *   different from the aac one).
 383  *****************************************************************************/
 384 static void DoReordering( decoder_t *p_dec,
 385                           uint32_t *p_out, uint32_t *p_in, int i_samples,
 386                           int i_nb_channels, uint32_t *pi_chan_positions )
 387 {
 388     int pi_chan_table[MAX_CHANNEL_POSITIONS];
 389     int i, j, k;
 390
 391     /* Find the channels mapping */
 392     for( i = 0, j = 0; i < MAX_CHANNEL_POSITIONS; i++ )
 393     {
 394         for( k = 0; k < i_nb_channels; k++ )
 395         {
 396             if( pi_channels_ordered[i] == pi_chan_positions[k] )
 397             {
 398                 pi_chan_table[k] = j++;
 399                 break;
 400             }
 401         }
 402     }
 403
 404     /* Do the actual reordering */
 405     if( p_dec->p_libvlc->i_cpu & CPU_CAPABILITY_FPU )
 406         for( i = 0; i < i_samples; i++ )
 407             for( j = 0; j < i_nb_channels; j++ )
 408                 p_out[i * i_nb_channels + pi_chan_table[j]] =
 409                     p_in[i * i_nb_channels + j];
 410     else
 411         for( i = 0; i < i_samples; i++ )
 412             for( j = 0; j < i_nb_channels; j++ )
 413                 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
 414                     ((uint16_t *)p_in)[i * i_nb_channels + j];
 415 }