1 /*****************************************************************************
2 * faad.c: AAC decoder using libfaad2
3 *****************************************************************************
4 * Copyright (C) 2001, 2003 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Gildas Bazin <gbazin@videolan.org>
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.
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.
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 *****************************************************************************/
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
31 #include <vlc_input.h>
32 #include <vlc_codec.h>
37 /*****************************************************************************
39 *****************************************************************************/
40 static int Open( vlc_object_t * );
41 static void Close( vlc_object_t * );
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 )
51 /****************************************************************************
53 ****************************************************************************/
54 static block_t *DecodeBlock( decoder_t *, block_t ** );
55 static void DoReordering( uint32_t *, uint32_t *, int, int, uint32_t * );
57 #define MAX_CHANNEL_POSITIONS 9
67 /* temporary buffer */
72 /* Channel positions of the current stream (for re-ordering) */
73 uint32_t pi_channel_positions[MAX_CHANNEL_POSITIONS];
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
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
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
111 /*****************************************************************************
112 * OpenDecoder: probe the decoder and return score
113 *****************************************************************************/
114 static int Open( vlc_object_t *p_this )
116 decoder_t *p_dec = (decoder_t*)p_this;
117 decoder_sys_t *p_sys = p_dec->p_sys;
118 faacDecConfiguration *cfg;
120 if( p_dec->fmt_in.i_codec != VLC_CODEC_MP4A )
125 /* Allocate the memory needed to store the decoder's structure */
126 if( ( p_dec->p_sys = p_sys = malloc( sizeof(*p_sys) ) ) == NULL )
129 /* Open a faad context */
130 if( ( p_sys->hfaad = faacDecOpen() ) == NULL )
132 msg_Err( p_dec, "cannot initialize faad" );
138 date_Set( &p_sys->date, 0 );
139 p_dec->fmt_out.i_cat = AUDIO_ES;
142 p_dec->fmt_out.i_codec = VLC_CODEC_FL32;
144 p_dec->fmt_out.i_codec = VLC_CODEC_S16N;
145 p_dec->pf_decode_audio = DecodeBlock;
147 p_dec->fmt_out.audio.i_physical_channels =
148 p_dec->fmt_out.audio.i_original_channels = 0;
150 if( p_dec->fmt_in.i_extra > 0 )
152 /* We have a decoder config so init the handle */
153 unsigned long i_rate;
154 unsigned char i_channels;
156 if( faacDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
157 p_dec->fmt_in.i_extra,
158 &i_rate, &i_channels ) < 0 )
160 msg_Err( p_dec, "Failed to initialize faad using extra data" );
161 faacDecClose( p_sys->hfaad );
166 p_dec->fmt_out.audio.i_rate = i_rate;
167 p_dec->fmt_out.audio.i_channels = i_channels;
168 p_dec->fmt_out.audio.i_physical_channels
169 = p_dec->fmt_out.audio.i_original_channels
170 = pi_channels_guessed[i_channels];
171 date_Init( &p_sys->date, i_rate, 1 );
175 /* Will be initalised from first frame */
176 p_dec->fmt_out.audio.i_rate = 0;
177 p_dec->fmt_out.audio.i_channels = 0;
180 /* Set the faad config */
181 cfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
183 cfg->outputFormat = FAAD_FMT_FLOAT;
185 cfg->outputFormat = FAAD_FMT_16BIT;
186 faacDecSetConfiguration( p_sys->hfaad, cfg );
189 p_sys->i_buffer = p_sys->i_buffer_size = 0;
190 p_sys->p_buffer = NULL;
192 /* Faad2 can't deal with truncated data (eg. from MPEG TS) */
193 p_dec->b_need_packetized = true;
195 p_sys->b_sbr = p_sys->b_ps = false;
199 /*****************************************************************************
201 *****************************************************************************/
202 static block_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
204 decoder_sys_t *p_sys = p_dec->p_sys;
207 if( !pp_block || !*pp_block ) return NULL;
211 if( p_block->i_flags&(BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
213 block_Release( p_block );
217 /* Remove ADTS header if we have decoder specific config */
218 if( p_dec->fmt_in.i_extra && p_block->i_buffer > 7 )
220 if( p_block->p_buffer[0] == 0xff &&
221 ( p_block->p_buffer[1] & 0xf0 ) == 0xf0 ) /* syncword */
222 { /* ADTS header present */
223 size_t i_header_size; /* 7 bytes (+ 2 bytes for crc) */
224 i_header_size = 7 + ( ( p_block->p_buffer[1] & 0x01 ) ? 0 : 2 );
225 /* FIXME: multiple blocks per frame */
226 if( p_block->i_buffer > i_header_size )
228 p_block->p_buffer += i_header_size;
229 p_block->i_buffer -= i_header_size;
234 /* Append the block to the temporary buffer */
235 if( p_sys->i_buffer_size < p_sys->i_buffer + p_block->i_buffer )
237 size_t i_buffer_size = p_sys->i_buffer + p_block->i_buffer;
238 uint8_t *p_buffer = realloc( p_sys->p_buffer, i_buffer_size );
241 p_sys->i_buffer_size = i_buffer_size;
242 p_sys->p_buffer = p_buffer;
246 p_block->i_buffer = 0;
250 if( p_block->i_buffer > 0 )
252 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;
258 if( p_dec->fmt_out.audio.i_rate == 0 && p_dec->fmt_in.i_extra > 0 )
260 /* We have a decoder config so init the handle */
261 unsigned long i_rate;
262 unsigned char i_channels;
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 )
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];
274 date_Init( &p_sys->date, i_rate, 1 );
278 if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->i_buffer )
280 unsigned long i_rate;
281 unsigned char i_channels;
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 )
288 block_Release( p_block );
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 date_Init( &p_sys->date, i_rate, 1 );
300 if( p_block->i_pts > VLC_TS_INVALID && p_block->i_pts != date_Get( &p_sys->date ) )
302 date_Set( &p_sys->date, p_block->i_pts );
304 else if( !date_Get( &p_sys->date ) )
306 /* We've just started the stream, wait for the first PTS. */
307 block_Release( p_block );
312 /* Decode all data */
313 if( p_sys->i_buffer )
316 faacDecFrameInfo frame;
319 samples = faacDecDecode( p_sys->hfaad, &frame,
320 p_sys->p_buffer, p_sys->i_buffer );
322 if( frame.error > 0 )
324 msg_Warn( p_dec, "%s", faacDecGetErrorMessage( frame.error ) );
326 if( frame.error == 21 )
329 * Once an "Unexpected channel configuration change" error
330 * occurs, it will occurs afterwards, and we got no sound.
331 * Reinitialization of the decoder is required.
333 unsigned long i_rate;
334 unsigned char i_channels;
335 faacDecHandle *hfaad;
336 faacDecConfiguration *cfg,*oldcfg;
338 oldcfg = faacDecGetCurrentConfiguration( p_sys->hfaad );
339 hfaad = faacDecOpen();
340 cfg = faacDecGetCurrentConfiguration( hfaad );
341 if( oldcfg->defSampleRate )
342 cfg->defSampleRate = oldcfg->defSampleRate;
343 cfg->defObjectType = oldcfg->defObjectType;
344 cfg->outputFormat = oldcfg->outputFormat;
345 faacDecSetConfiguration( hfaad, cfg );
347 if( faacDecInit( hfaad, p_sys->p_buffer, p_sys->i_buffer,
348 &i_rate,&i_channels ) < 0 )
350 /* reinitialization failed */
351 faacDecClose( hfaad );
352 faacDecSetConfiguration( p_sys->hfaad, oldcfg );
356 faacDecClose( p_sys->hfaad );
357 p_sys->hfaad = hfaad;
358 p_dec->fmt_out.audio.i_rate = i_rate;
359 p_dec->fmt_out.audio.i_channels = i_channels;
360 p_dec->fmt_out.audio.i_physical_channels
361 = p_dec->fmt_out.audio.i_original_channels
362 = pi_channels_guessed[i_channels];
363 date_Init( &p_sys->date, i_rate, 1 );
367 /* Flush the buffer */
369 block_Release( p_block );
373 if( frame.channels <= 0 || frame.channels > 8 || frame.channels == 7 )
375 msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
377 /* Flush the buffer */
378 p_sys->i_buffer -= frame.bytesconsumed;
379 if( p_sys->i_buffer > 0 )
381 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
384 block_Release( p_block );
388 if( frame.samples <= 0 )
390 msg_Warn( p_dec, "decoded zero sample" );
392 /* Flush the buffer */
393 p_sys->i_buffer -= frame.bytesconsumed;
394 if( p_sys->i_buffer > 0 )
396 memmove( p_sys->p_buffer,&p_sys->p_buffer[frame.bytesconsumed],
399 block_Release( p_block );
403 /* We decoded a valid frame */
404 if( p_dec->fmt_out.audio.i_rate != frame.samplerate )
406 date_Init( &p_sys->date, frame.samplerate, 1 );
407 date_Set( &p_sys->date, p_block->i_pts );
409 p_block->i_pts = VLC_TS_INVALID; /* PTS is valid only once */
411 p_dec->fmt_out.audio.i_rate = frame.samplerate;
412 p_dec->fmt_out.audio.i_channels = frame.channels;
414 /* Adjust stream info when dealing with SBR/PS */
415 bool b_sbr = (frame.sbr == 1) || (frame.sbr == 2);
416 if( p_sys->b_sbr != b_sbr || p_sys->b_ps != frame.ps )
418 const char *psz_ext = (b_sbr && frame.ps) ? "SBR+PS" :
419 b_sbr ? "SBR" : "PS";
421 msg_Dbg( p_dec, "AAC %s (channels: %u, samplerate: %lu)",
422 psz_ext, frame.channels, frame.samplerate );
424 if( !p_dec->p_description )
425 p_dec->p_description = vlc_meta_New();
426 if( p_dec->p_description )
427 vlc_meta_AddExtra( p_dec->p_description, _("AAC extension"), psz_ext );
429 p_sys->b_sbr = b_sbr;
430 p_sys->b_ps = frame.ps;
433 /* Convert frame.channel_position to our own channel values */
434 p_dec->fmt_out.audio.i_physical_channels = 0;
435 const uint32_t nbChannels = frame.channels;
437 for( unsigned i = 0; i < nbChannels; i++ )
439 /* Find the channel code */
440 for( j = 0; j < MAX_CHANNEL_POSITIONS; j++ )
442 if( frame.channel_position[i] == pi_channels_in[j] )
445 if( j >= MAX_CHANNEL_POSITIONS )
447 msg_Warn( p_dec, "unknown channel ordering" );
448 /* Invent something */
452 p_sys->pi_channel_positions[i] = pi_channels_out[j];
453 if( p_dec->fmt_out.audio.i_physical_channels & pi_channels_out[j] )
454 frame.channels--; /* We loose a duplicated channel */
456 p_dec->fmt_out.audio.i_physical_channels |= pi_channels_out[j];
458 if ( nbChannels != frame.channels )
460 p_dec->fmt_out.audio.i_physical_channels
461 = p_dec->fmt_out.audio.i_original_channels
462 = pi_channels_guessed[nbChannels];
466 p_dec->fmt_out.audio.i_original_channels =
467 p_dec->fmt_out.audio.i_physical_channels;
469 p_dec->fmt_out.audio.i_channels = nbChannels;
470 p_out = decoder_NewAudioBuffer( p_dec, frame.samples / nbChannels );
474 block_Release( p_block );
478 p_out->i_pts = date_Get( &p_sys->date );
479 p_out->i_length = date_Increment( &p_sys->date,
480 frame.samples / nbChannels )
483 DoReordering( (uint32_t *)p_out->p_buffer, samples,
484 frame.samples / nbChannels, nbChannels,
485 p_sys->pi_channel_positions );
487 p_sys->i_buffer -= frame.bytesconsumed;
488 if( p_sys->i_buffer > 0 )
490 memmove( p_sys->p_buffer, &p_sys->p_buffer[frame.bytesconsumed],
497 block_Release( p_block );
501 /*****************************************************************************
503 *****************************************************************************/
504 static void Close( vlc_object_t *p_this )
506 decoder_t *p_dec = (decoder_t *)p_this;
507 decoder_sys_t *p_sys = p_dec->p_sys;
509 faacDecClose( p_sys->hfaad );
510 free( p_sys->p_buffer );
514 /*****************************************************************************
515 * DoReordering: do some channel re-ordering (the ac3 channel order is
516 * different from the aac one).
517 *****************************************************************************/
518 static void DoReordering( uint32_t *p_out, uint32_t *p_in, int i_samples,
519 int i_nb_channels, uint32_t *pi_chan_positions )
521 int pi_chan_table[MAX_CHANNEL_POSITIONS] = {0};
524 /* Find the channels mapping */
525 for( i = 0, j = 0; i < MAX_CHANNEL_POSITIONS; i++ )
527 for( k = 0; k < i_nb_channels; k++ )
529 if( pi_channels_ordered[i] == pi_chan_positions[k] )
531 pi_chan_table[k] = j++;
537 /* Do the actual reordering */
539 for( i = 0; i < i_samples; i++ )
540 for( j = 0; j < i_nb_channels; j++ )
541 p_out[i * i_nb_channels + pi_chan_table[j]] =
542 p_in[i * i_nb_channels + j];
544 for( i = 0; i < i_samples; i++ )
545 for( j = 0; j < i_nb_channels; j++ )
546 ((uint16_t *)p_out)[i * i_nb_channels + pi_chan_table[j]] =
547 ((uint16_t *)p_in)[i * i_nb_channels + j];