1 /*****************************************************************************
2 * faad.c: AAC decoder using libfaad2
3 *****************************************************************************
4 * Copyright (C) 2001, 2003 VLC authors and VideoLAN
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 it
11 * under the terms of the GNU Lesser General Public License as published by
12 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
26 * NOTA BENE: this module requires the linking against a library which is
27 * known to require licensing under the GNU General Public License version 2
28 * (or later). Therefore, the result of compiling this module will normally
29 * be subject to the terms of that later license.
30 *****************************************************************************/
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include <vlc_input.h>
40 #include <vlc_codec.h>
45 #include "../packetizer/mpeg4audio.h"
47 /*****************************************************************************
49 *****************************************************************************/
50 static int Open( vlc_object_t
* );
51 static void Close( vlc_object_t
* );
54 set_description( N_("AAC audio decoder (using libfaad2)") )
55 set_capability( "audio decoder", 100 )
56 set_category( CAT_INPUT
)
57 set_subcategory( SUBCAT_INPUT_ACODEC
)
58 set_callbacks( Open
, Close
)
61 /****************************************************************************
63 ****************************************************************************/
64 static int DecodeBlock( decoder_t
*, block_t
* );
65 static void Flush( decoder_t
* );
66 static void DoReordering( uint32_t *, uint32_t *, int, int, uint8_t * );
71 NeAACDecHandle
*hfaad
;
76 /* temporary buffer */
79 /* Channel positions of the current stream (for re-ordering) */
80 uint32_t pi_channel_positions
[MPEG4_ASC_MAX_INDEXEDPOS
];
82 bool b_sbr
, b_ps
, b_discontinuity
;
85 #if MPEG4_ASC_MAX_INDEXEDPOS != LFE_CHANNEL
86 #error MPEG4_ASC_MAX_INDEXEDPOS != LFE_CHANNEL
89 #define FAAD_CHANNEL_ID_COUNT (LFE_CHANNEL + 1)
90 static const uint32_t pi_tovlcmapping
[FAAD_CHANNEL_ID_COUNT
] =
92 [UNKNOWN_CHANNEL
] = 0,
93 [FRONT_CHANNEL_CENTER
] = AOUT_CHAN_CENTER
,
94 [FRONT_CHANNEL_LEFT
] = AOUT_CHAN_LEFT
,
95 [FRONT_CHANNEL_RIGHT
] = AOUT_CHAN_RIGHT
,
96 [SIDE_CHANNEL_LEFT
] = AOUT_CHAN_MIDDLELEFT
,
97 [SIDE_CHANNEL_RIGHT
] = AOUT_CHAN_MIDDLERIGHT
,
98 [BACK_CHANNEL_LEFT
] = AOUT_CHAN_REARLEFT
,
99 [BACK_CHANNEL_RIGHT
] = AOUT_CHAN_REARRIGHT
,
100 [BACK_CHANNEL_CENTER
] = AOUT_CHAN_REARCENTER
,
101 [LFE_CHANNEL
] = AOUT_CHAN_LFE
104 /*****************************************************************************
105 * OpenDecoder: probe the decoder and return score
106 *****************************************************************************/
107 static int Open( vlc_object_t
*p_this
)
109 decoder_t
*p_dec
= (decoder_t
*)p_this
;
110 decoder_sys_t
*p_sys
;
111 NeAACDecConfiguration
*cfg
;
113 if( p_dec
->fmt_in
.i_codec
!= VLC_CODEC_MP4A
)
118 /* Allocate the memory needed to store the decoder's structure */
119 if( ( p_dec
->p_sys
= p_sys
= malloc( sizeof(*p_sys
) ) ) == NULL
)
122 /* Open a faad context */
123 if( ( p_sys
->hfaad
= NeAACDecOpen() ) == NULL
)
125 msg_Err( p_dec
, "cannot initialize faad" );
131 date_Set( &p_sys
->date
, 0 );
133 p_dec
->fmt_out
.audio
.channel_type
= p_dec
->fmt_in
.audio
.channel_type
;
135 if( p_dec
->fmt_in
.i_extra
> 0 )
137 /* We have a decoder config so init the handle */
138 unsigned long i_rate
;
139 unsigned char i_channels
;
141 if( NeAACDecInit2( p_sys
->hfaad
, p_dec
->fmt_in
.p_extra
,
142 p_dec
->fmt_in
.i_extra
,
143 &i_rate
, &i_channels
) < 0 )
145 msg_Err( p_dec
, "Failed to initialize faad using extra data" );
146 NeAACDecClose( p_sys
->hfaad
);
151 p_dec
->fmt_out
.audio
.i_rate
= i_rate
;
152 p_dec
->fmt_out
.audio
.i_channels
= i_channels
;
153 p_dec
->fmt_out
.audio
.i_physical_channels
154 = mpeg4_asc_channelsbyindex
[i_channels
];
155 date_Init( &p_sys
->date
, i_rate
, 1 );
159 p_dec
->fmt_out
.audio
.i_physical_channels
= 0;
160 /* Will be initalised from first frame */
161 p_dec
->fmt_out
.audio
.i_rate
= 0;
162 p_dec
->fmt_out
.audio
.i_channels
= 0;
165 p_dec
->fmt_out
.i_codec
= HAVE_FPU
? VLC_CODEC_FL32
: VLC_CODEC_S16N
;
166 p_dec
->fmt_out
.audio
.i_chan_mode
= p_dec
->fmt_in
.audio
.i_chan_mode
;
168 /* Set the faad config */
169 cfg
= NeAACDecGetCurrentConfiguration( p_sys
->hfaad
);
170 if( p_dec
->fmt_in
.audio
.i_rate
)
171 cfg
->defSampleRate
= p_dec
->fmt_in
.audio
.i_rate
;
172 cfg
->outputFormat
= HAVE_FPU
? FAAD_FMT_FLOAT
: FAAD_FMT_16BIT
;
173 NeAACDecSetConfiguration( p_sys
->hfaad
, cfg
);
176 p_sys
->p_block
= NULL
;
178 p_sys
->b_discontinuity
=
179 p_sys
->b_sbr
= p_sys
->b_ps
= false;
181 p_dec
->pf_decode
= DecodeBlock
;
182 p_dec
->pf_flush
= Flush
;
186 /*****************************************************************************
188 *****************************************************************************/
189 static void FlushBuffer( decoder_sys_t
*p_sys
, size_t i_used
)
191 block_t
*p_block
= p_sys
->p_block
;
194 if( i_used
< p_block
->i_buffer
)
197 for( ; i_used
< p_block
->i_buffer
; i_used
++ )
198 if( p_block
->p_buffer
[i_used
] != 0x00 )
201 p_block
->i_buffer
-= i_used
;
202 p_block
->p_buffer
+= i_used
;
204 else p_block
->i_buffer
= 0;
205 if( p_block
->i_buffer
== 0 )
207 block_Release( p_block
);
208 p_sys
->p_block
= NULL
;
213 /*****************************************************************************
215 *****************************************************************************/
216 static void Flush( decoder_t
*p_dec
)
218 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
220 date_Set( &p_sys
->date
, VLC_TS_INVALID
);
221 FlushBuffer( p_sys
, SIZE_MAX
);
224 /*****************************************************************************
226 *****************************************************************************/
227 static int DecodeBlock( decoder_t
*p_dec
, block_t
*p_block
)
229 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
231 if( !p_block
) /* No Drain */
232 return VLCDEC_SUCCESS
;
234 if( p_block
->i_flags
& (BLOCK_FLAG_DISCONTINUITY
| BLOCK_FLAG_CORRUPTED
) )
237 if( p_block
->i_flags
& (BLOCK_FLAG_CORRUPTED
) )
239 block_Release( p_block
);
240 return VLCDEC_SUCCESS
;
244 /* Remove ADTS header if we have decoder specific config */
245 if( p_dec
->fmt_in
.i_extra
&& p_block
->i_buffer
> 7 )
247 if( p_block
->p_buffer
[0] == 0xff &&
248 ( p_block
->p_buffer
[1] & 0xf0 ) == 0xf0 ) /* syncword */
249 { /* ADTS header present */
250 size_t i_header_size
; /* 7 bytes (+ 2 bytes for crc) */
251 i_header_size
= 7 + ( ( p_block
->p_buffer
[1] & 0x01 ) ? 0 : 2 );
252 /* FIXME: multiple blocks per frame */
253 if( p_block
->i_buffer
> i_header_size
)
255 p_block
->p_buffer
+= i_header_size
;
256 p_block
->i_buffer
-= i_header_size
;
261 const mtime_t i_pts
= p_block
->i_pts
;
263 /* Append block as temporary buffer */
264 if( p_sys
->p_block
== NULL
)
266 p_sys
->p_block
= p_block
;
270 p_sys
->p_block
->p_next
= p_block
;
271 block_t
*p_prev
= p_sys
->p_block
;
272 p_sys
->p_block
= block_ChainGather( p_sys
->p_block
);
273 if( p_sys
->p_block
== NULL
)
274 block_ChainRelease( p_prev
);
277 /* !Warn: do not use p_block beyond this point */
279 if( p_dec
->fmt_out
.audio
.i_rate
== 0 )
281 unsigned long i_rate
= 0;
282 unsigned char i_channels
;
284 /* Init from DecoderConfig */
285 if( p_dec
->fmt_in
.i_extra
> 0 &&
286 NeAACDecInit2( p_sys
->hfaad
, p_dec
->fmt_in
.p_extra
,
287 p_dec
->fmt_in
.i_extra
, &i_rate
, &i_channels
) != 0 )
289 /* Failed, will try from data */
293 if( i_rate
== 0 && p_sys
->p_block
&& p_sys
->p_block
->i_buffer
)
295 /* Init faad with the first frame */
296 long i_read
= NeAACDecInit( p_sys
->hfaad
,
297 p_sys
->p_block
->p_buffer
, p_sys
->p_block
->i_buffer
,
298 &i_rate
, &i_channels
);
299 if( i_read
< 0 || (size_t) i_read
> p_sys
->p_block
->i_buffer
)
302 FlushBuffer( p_sys
, i_read
);
307 /* Can not init decoder at all for now */
308 FlushBuffer( p_sys
, SIZE_MAX
);
309 return VLCDEC_SUCCESS
;
312 /* Decoder Initialized */
313 p_dec
->fmt_out
.audio
.i_rate
= i_rate
;
314 p_dec
->fmt_out
.audio
.i_channels
= i_channels
;
315 p_dec
->fmt_out
.audio
.i_physical_channels
316 = mpeg4_asc_channelsbyindex
[i_channels
];
317 date_Init( &p_sys
->date
, i_rate
, 1 );
320 if( i_pts
> VLC_TS_INVALID
&& i_pts
!= date_Get( &p_sys
->date
) )
322 date_Set( &p_sys
->date
, i_pts
);
324 else if( !date_Get( &p_sys
->date
) )
326 /* We've just started the stream, wait for the first PTS. */
327 FlushBuffer( p_sys
, SIZE_MAX
);
328 return VLCDEC_SUCCESS
;
331 /* Decode all data */
332 while( p_sys
->p_block
&& p_sys
->p_block
->i_buffer
> 0 )
335 NeAACDecFrameInfo frame
;
336 block_t
*p_out
= NULL
;
338 samples
= NeAACDecDecode( p_sys
->hfaad
, &frame
,
339 p_sys
->p_block
->p_buffer
,
340 p_sys
->p_block
->i_buffer
);
342 if( frame
.error
> 0 )
344 msg_Warn( p_dec
, "%s", NeAACDecGetErrorMessage( frame
.error
) );
346 if( frame
.error
== 21 || frame
.error
== 12 )
349 * Once an "Unexpected channel configuration change"
350 * or a "Invalid number of channels" error
351 * occurs, it will occurs afterwards, and we got no sound.
352 * Reinitialization of the decoder is required.
354 unsigned long i_rate
;
355 unsigned char i_channels
;
356 NeAACDecHandle
*hfaad
;
357 NeAACDecConfiguration
*cfg
,*oldcfg
;
359 oldcfg
= NeAACDecGetCurrentConfiguration( p_sys
->hfaad
);
360 hfaad
= NeAACDecOpen();
361 cfg
= NeAACDecGetCurrentConfiguration( hfaad
);
362 if( oldcfg
->defSampleRate
)
363 cfg
->defSampleRate
= oldcfg
->defSampleRate
;
364 cfg
->defObjectType
= oldcfg
->defObjectType
;
365 cfg
->outputFormat
= oldcfg
->outputFormat
;
366 NeAACDecSetConfiguration( hfaad
, cfg
);
368 if( NeAACDecInit( hfaad
,
369 p_sys
->p_block
->p_buffer
,
370 p_sys
->p_block
->i_buffer
,
371 &i_rate
,&i_channels
) < 0 )
373 /* reinitialization failed */
374 NeAACDecClose( hfaad
);
375 NeAACDecSetConfiguration( p_sys
->hfaad
, oldcfg
);
379 NeAACDecClose( p_sys
->hfaad
);
380 p_sys
->hfaad
= hfaad
;
381 p_dec
->fmt_out
.audio
.i_rate
= i_rate
;
382 p_dec
->fmt_out
.audio
.i_channels
= i_channels
;
383 p_dec
->fmt_out
.audio
.i_physical_channels
384 = mpeg4_asc_channelsbyindex
[i_channels
];
385 date_Init( &p_sys
->date
, i_rate
, 1 );
390 p_sys
->b_discontinuity
= true;
395 if( frame
.channels
== 0 || frame
.channels
>= 64 )
397 msg_Warn( p_dec
, "invalid channels count: %i", frame
.channels
);
398 if( frame
.channels
== 0 )
399 p_sys
->b_discontinuity
= true;
400 FlushBuffer( p_sys
, frame
.bytesconsumed
? frame
.bytesconsumed
: SIZE_MAX
);
404 if( frame
.samples
== 0 )
406 msg_Warn( p_dec
, "decoded zero sample" );
407 FlushBuffer( p_sys
, frame
.bytesconsumed
? frame
.bytesconsumed
: SIZE_MAX
);
411 /* We decoded a valid frame */
412 if( p_dec
->fmt_out
.audio
.i_rate
!= frame
.samplerate
)
414 date_Init( &p_sys
->date
, frame
.samplerate
, 1 );
415 date_Set( &p_sys
->date
, i_pts
);
418 p_dec
->fmt_out
.audio
.i_rate
= frame
.samplerate
;
420 /* Adjust stream info when dealing with SBR/PS */
421 bool b_sbr
= (frame
.sbr
== 1) || (frame
.sbr
== 2);
422 if( p_sys
->b_sbr
!= b_sbr
|| p_sys
->b_ps
!= frame
.ps
)
424 const char *psz_ext
= (b_sbr
&& frame
.ps
) ? "SBR+PS" :
425 b_sbr
? "SBR" : "PS";
427 msg_Dbg( p_dec
, "AAC %s (channels: %u, samplerate: %lu)",
428 psz_ext
, frame
.channels
, frame
.samplerate
);
430 if( !p_dec
->p_description
)
431 p_dec
->p_description
= vlc_meta_New();
432 if( p_dec
->p_description
)
433 vlc_meta_AddExtra( p_dec
->p_description
, _("AAC extension"), psz_ext
);
435 p_sys
->b_sbr
= b_sbr
;
436 p_sys
->b_ps
= frame
.ps
;
439 #ifndef FAAD2_VIDEOLAN_PATCHED
440 /* PS Enabled FAAD PCA bug hotfix (contribs has patch) */
441 if( frame
.channels
== 8 )
443 const uint8_t psbugconfig
[3][8] = { { 2, 3, 2, 3, 2, 3, 6, 7 }, /* fdk 7.1 (4 Front) */
444 { 2, 3, 2, 3, 2, 3, 4, 5 }, /* 7.1 */
445 { 1, 2, 3, 4, 5, 6, 7, 9 } };/* fixed */
446 for( size_t i
=0; i
<2; i
++ )
448 if( !memcmp( frame
.channel_position
, psbugconfig
[i
], 8 ) )
450 msg_Warn( p_dec
, "Unpatched FAAD2 library with PS Bug. Trying to workaround !" );
451 memcpy( frame
.channel_position
, psbugconfig
[2], 8 );
457 /* Hotfix channels misdetection/repetition for FDK 7.1 */
461 const uint8_t faulty
[8];
462 const uint8_t fixed
[8];
463 } const channel_repeat_fixes
[] = {
464 { 7, { 2, 3, 2, 3, 2, 3, 6 }, { 1, 2, 3, 6, 7, 8, 9 } }, /* 3F 3R LFE #18273 */
465 { 8, { 1, 2, 3, 6, 7, 6, 7, 9 }, { 1, 2, 3, 6, 7, 4, 5, 9 } }, /* FDK encoded 7.1 */
468 for( size_t i
=0; i
<ARRAY_SIZE(channel_repeat_fixes
); i
++ )
470 if( channel_repeat_fixes
[i
].chans
== frame
.channels
&&
471 !memcmp( frame
.channel_position
, channel_repeat_fixes
[i
].faulty
,
472 channel_repeat_fixes
[i
].chans
) )
474 msg_Warn( p_dec
, "Patching for Front channel repeat bug" );
475 memcpy( frame
.channel_position
, channel_repeat_fixes
[i
].fixed
,
476 channel_repeat_fixes
[i
].chans
);
481 /* Handle > 1 local pair 5.1 setups.
482 In case of more than 1 channel pair per area, faad will have repeats
483 in channels sequence. We need to remap to available surround channels.
484 Front > Middle > Rear:
485 In case of 4 middle, it maps to 2F 2M if no previous front.
486 In case of 4 rear, it maps to 2M 2R if no previous rear.
488 unsigned i_faadused
= 0;
489 for( unsigned i
=0; i
<frame
.channels
; i
++ )
490 if( frame
.channel_position
[i
] > 0 )
491 i_faadused
|= 1 << frame
.channel_position
[i
];
493 for( size_t i
=3; i
<frame
.channels
; i
++ )
495 if( frame
.channel_position
[i
- 3] == frame
.channel_position
[i
- 1] &&
496 frame
.channel_position
[i
- 2] == frame
.channel_position
[i
] &&
497 frame
.channel_position
[i
- 1] >= SIDE_CHANNEL_LEFT
&&
498 frame
.channel_position
[i
- 1] <= BACK_CHANNEL_CENTER
&&
499 frame
.channel_position
[i
- 1] >= SIDE_CHANNEL_LEFT
&&
500 frame
.channel_position
[i
- 1] <= BACK_CHANNEL_CENTER
)
502 if( ( (1 << (frame
.channel_position
[i
- 3] - 2)) & i_faadused
) == 0 &&
503 ( (1 << (frame
.channel_position
[i
- 2] - 2)) & i_faadused
) == 0 )
505 frame
.channel_position
[i
- 3] -= 2;
506 frame
.channel_position
[i
- 2] -= 2;
507 i_faadused
|= 1 << frame
.channel_position
[i
- 3];
508 i_faadused
|= 1 << frame
.channel_position
[i
- 2];
513 /* Convert frame.channel_position to our own channel values */
514 p_dec
->fmt_out
.audio
.i_physical_channels
= 0;
515 uint32_t pi_faad_channels_positions
[FAAD_CHANNEL_ID_COUNT
] = {0};
516 uint8_t pi_neworder_table
[AOUT_CHAN_MAX
];
517 for( size_t i
= 0; i
< frame
.channels
; i
++ )
519 unsigned pos
= frame
.channel_position
[i
];
520 if( likely(pos
< FAAD_CHANNEL_ID_COUNT
) )
522 pi_faad_channels_positions
[i
] = pi_tovlcmapping
[pos
];
523 p_dec
->fmt_out
.audio
.i_physical_channels
|= pi_faad_channels_positions
[i
];
525 else pi_faad_channels_positions
[i
] = 0;
528 aout_CheckChannelReorder( pi_faad_channels_positions
, NULL
,
529 p_dec
->fmt_out
.audio
.i_physical_channels
, pi_neworder_table
);
532 p_dec
->fmt_out
.audio
.i_channels
= popcount(p_dec
->fmt_out
.audio
.i_physical_channels
);
534 if( !decoder_UpdateAudioFormat( p_dec
) && p_dec
->fmt_out
.audio
.i_channels
> 0 )
535 p_out
= decoder_NewAudioBuffer( p_dec
, frame
.samples
/ p_dec
->fmt_out
.audio
.i_channels
);
539 p_out
->i_pts
= date_Get( &p_sys
->date
);
540 p_out
->i_length
= date_Increment( &p_sys
->date
,
541 frame
.samples
/ frame
.channels
)
544 /* Don't kill speakers if some weird mapping does not gets 1:1 */
545 if( popcount(p_dec
->fmt_out
.audio
.i_physical_channels
) != frame
.channels
)
546 memset( p_out
->p_buffer
, 0, p_out
->i_buffer
);
548 /* FIXME: replace when aout_channel_reorder can take samples from a different buffer */
549 DoReordering( (uint32_t *)p_out
->p_buffer
, samples
,
550 frame
.samples
/ frame
.channels
, frame
.channels
,
553 if( p_sys
->b_discontinuity
)
555 p_out
->i_flags
|= BLOCK_FLAG_DISCONTINUITY
;
556 p_sys
->b_discontinuity
= false;
559 decoder_QueueAudio( p_dec
, p_out
);
563 date_Increment( &p_sys
->date
, frame
.samples
/ frame
.channels
);
566 FlushBuffer( p_sys
, frame
.bytesconsumed
? frame
.bytesconsumed
: SIZE_MAX
);
568 if( p_sys
->p_block
&& p_sys
->p_block
->i_buffer
== 1 )
570 /* Drop byte of padding */
571 FlushBuffer( p_sys
, 0 );
577 return VLCDEC_SUCCESS
;
580 /*****************************************************************************
582 *****************************************************************************/
583 static void Close( vlc_object_t
*p_this
)
585 decoder_t
*p_dec
= (decoder_t
*)p_this
;
586 decoder_sys_t
*p_sys
= p_dec
->p_sys
;
588 NeAACDecClose( p_sys
->hfaad
);
589 FlushBuffer( p_sys
, SIZE_MAX
);
593 /*****************************************************************************
594 * DoReordering: do some channel re-ordering (the ac3 channel order is
595 * different from the aac one).
596 *****************************************************************************/
597 static void DoReordering( uint32_t *p_out
, uint32_t *p_in
, int i_samples
,
598 int i_nb_channels
, uint8_t *pi_chan_positions
)
601 #define CAST_SAMPLE(a) a
603 #define CAST_SAMPLE(a) ((uint16_t *)a)
605 /* Do the actual reordering */
606 for( int i
= 0; i
< i_samples
; i
++ )
608 for( int j
= 0; j
< i_nb_channels
; j
++ )
610 CAST_SAMPLE(p_out
)[i
* i_nb_channels
+ pi_chan_positions
[j
]] =
611 CAST_SAMPLE(p_in
)[i
* i_nb_channels
+ j
];