codec: faad: keep the input channel_type
[vlc.git] / modules / codec / faad.c
blob1711ab45967394e4f7590fe5a9093e547e06b3e8
1 /*****************************************************************************
2 * faad.c: AAC decoder using libfaad2
3 *****************************************************************************
4 * Copyright (C) 2001, 2003 VLC authors and VideoLAN
5 * $Id$
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 *****************************************************************************/
33 #ifdef HAVE_CONFIG_H
34 # include "config.h"
35 #endif
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include <vlc_input.h>
40 #include <vlc_codec.h>
41 #include <vlc_cpu.h>
42 #include <vlc_aout.h>
44 #include <neaacdec.h>
45 #include "../packetizer/mpeg4audio.h"
47 /*****************************************************************************
48 * Module descriptor
49 *****************************************************************************/
50 static int Open( vlc_object_t * );
51 static void Close( vlc_object_t * );
53 vlc_module_begin ()
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 )
59 vlc_module_end ()
61 /****************************************************************************
62 * Local prototypes
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 * );
68 struct decoder_sys_t
70 /* faad handler */
71 NeAACDecHandle *hfaad;
73 /* samples */
74 date_t date;
76 /* temporary buffer */
77 block_t *p_block;
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
87 #endif
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 )
115 return VLC_EGENERIC;
118 /* Allocate the memory needed to store the decoder's structure */
119 if( ( p_dec->p_sys = p_sys = malloc( sizeof(*p_sys) ) ) == NULL )
120 return VLC_ENOMEM;
122 /* Open a faad context */
123 if( ( p_sys->hfaad = NeAACDecOpen() ) == NULL )
125 msg_Err( p_dec, "cannot initialize faad" );
126 free( p_sys );
127 return VLC_EGENERIC;
130 /* Misc init */
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 );
147 free( p_sys );
148 return VLC_EGENERIC;
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 );
157 else
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 );
175 /* buffer */
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;
183 return VLC_SUCCESS;
186 /*****************************************************************************
187 * FlushBuffer:
188 *****************************************************************************/
189 static void FlushBuffer( decoder_sys_t *p_sys, size_t i_used )
191 block_t *p_block = p_sys->p_block;
192 if( p_block )
194 if( i_used < p_block->i_buffer )
196 /* Drop padding */
197 for( ; i_used < p_block->i_buffer; i_used++ )
198 if( p_block->p_buffer[i_used] != 0x00 )
199 break;
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 /*****************************************************************************
214 * Flush:
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 /*****************************************************************************
225 * DecodeBlock:
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) )
236 Flush( p_dec );
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;
268 else
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 && p_dec->fmt_in.i_extra > 0 )
281 /* We have a decoder config so init the handle */
282 unsigned long i_rate;
283 unsigned char i_channels;
285 if( NeAACDecInit2( p_sys->hfaad, p_dec->fmt_in.p_extra,
286 p_dec->fmt_in.i_extra,
287 &i_rate, &i_channels ) >= 0 )
289 p_dec->fmt_out.audio.i_rate = i_rate;
290 p_dec->fmt_out.audio.i_channels = i_channels;
291 p_dec->fmt_out.audio.i_physical_channels
292 = mpeg4_asc_channelsbyindex[i_channels];
294 date_Init( &p_sys->date, i_rate, 1 );
298 if( p_dec->fmt_out.audio.i_rate == 0 && p_sys->p_block && p_sys->p_block->i_buffer )
300 unsigned long i_rate;
301 unsigned char i_channels;
303 /* Init faad with the first frame */
304 if( NeAACDecInit( p_sys->hfaad,
305 p_sys->p_block->p_buffer, p_sys->p_block->i_buffer,
306 &i_rate, &i_channels ) < 0 )
308 return VLCDEC_SUCCESS;
311 p_dec->fmt_out.audio.i_rate = i_rate;
312 p_dec->fmt_out.audio.i_channels = i_channels;
313 p_dec->fmt_out.audio.i_physical_channels
314 = mpeg4_asc_channelsbyindex[i_channels];
315 date_Init( &p_sys->date, i_rate, 1 );
318 if( i_pts > VLC_TS_INVALID && i_pts != date_Get( &p_sys->date ) )
320 date_Set( &p_sys->date, i_pts );
322 else if( !date_Get( &p_sys->date ) )
324 /* We've just started the stream, wait for the first PTS. */
325 FlushBuffer( p_sys, SIZE_MAX );
326 return VLCDEC_SUCCESS;
329 /* Decode all data */
330 if( p_sys->p_block && p_sys->p_block->i_buffer > 1 )
332 void *samples;
333 NeAACDecFrameInfo frame;
334 block_t *p_out = NULL;
336 samples = NeAACDecDecode( p_sys->hfaad, &frame,
337 p_sys->p_block->p_buffer,
338 p_sys->p_block->i_buffer );
340 if( frame.error > 0 )
342 msg_Warn( p_dec, "%s", NeAACDecGetErrorMessage( frame.error ) );
344 if( frame.error == 21 || frame.error == 12 )
347 * Once an "Unexpected channel configuration change"
348 * or a "Invalid number of channels" error
349 * occurs, it will occurs afterwards, and we got no sound.
350 * Reinitialization of the decoder is required.
352 unsigned long i_rate;
353 unsigned char i_channels;
354 NeAACDecHandle *hfaad;
355 NeAACDecConfiguration *cfg,*oldcfg;
357 oldcfg = NeAACDecGetCurrentConfiguration( p_sys->hfaad );
358 hfaad = NeAACDecOpen();
359 cfg = NeAACDecGetCurrentConfiguration( hfaad );
360 if( oldcfg->defSampleRate )
361 cfg->defSampleRate = oldcfg->defSampleRate;
362 cfg->defObjectType = oldcfg->defObjectType;
363 cfg->outputFormat = oldcfg->outputFormat;
364 NeAACDecSetConfiguration( hfaad, cfg );
366 if( NeAACDecInit( hfaad,
367 p_sys->p_block->p_buffer,
368 p_sys->p_block->i_buffer,
369 &i_rate,&i_channels ) < 0 )
371 /* reinitialization failed */
372 NeAACDecClose( hfaad );
373 NeAACDecSetConfiguration( p_sys->hfaad, oldcfg );
375 else
377 NeAACDecClose( p_sys->hfaad );
378 p_sys->hfaad = hfaad;
379 p_dec->fmt_out.audio.i_rate = i_rate;
380 p_dec->fmt_out.audio.i_channels = i_channels;
381 p_dec->fmt_out.audio.i_physical_channels
382 = mpeg4_asc_channelsbyindex[i_channels];
383 date_Init( &p_sys->date, i_rate, 1 );
387 Flush( p_dec );
388 p_sys->b_discontinuity = true;
390 return VLCDEC_SUCCESS;
393 if( frame.channels == 0 || frame.channels >= 64 )
395 msg_Warn( p_dec, "invalid channels count: %i", frame.channels );
396 FlushBuffer( p_sys, frame.bytesconsumed );
397 if( frame.channels == 0 )
399 p_sys->b_discontinuity = true;
400 return VLCDEC_SUCCESS;
404 if( frame.samples == 0 )
406 msg_Warn( p_dec, "decoded zero sample" );
407 FlushBuffer( p_sys, frame.bytesconsumed );
408 return VLCDEC_SUCCESS;
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 );
452 break;
457 /* Hotfix channels misdetection/repetition for FDK 7.1 */
458 struct
460 const uint8_t chans;
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 );
477 break;
480 #endif
482 /* Convert frame.channel_position to our own channel values */
483 p_dec->fmt_out.audio.i_physical_channels = 0;
484 uint32_t pi_faad_channels_positions[FAAD_CHANNEL_ID_COUNT] = {0};
485 uint8_t pi_neworder_table[AOUT_CHAN_MAX];
486 for( size_t i = 0; i < frame.channels; i++ )
488 unsigned pos = frame.channel_position[i];
489 if( likely(pos < FAAD_CHANNEL_ID_COUNT) )
491 pi_faad_channels_positions[i] = pi_tovlcmapping[pos];
492 p_dec->fmt_out.audio.i_physical_channels |= pi_faad_channels_positions[i];
494 else pi_faad_channels_positions[i] = 0;
497 aout_CheckChannelReorder( pi_faad_channels_positions, NULL,
498 p_dec->fmt_out.audio.i_physical_channels, pi_neworder_table );
501 p_dec->fmt_out.audio.i_channels = popcount(p_dec->fmt_out.audio.i_physical_channels);
503 if( !decoder_UpdateAudioFormat( p_dec ) && p_dec->fmt_out.audio.i_channels > 0 )
504 p_out = decoder_NewAudioBuffer( p_dec, frame.samples / p_dec->fmt_out.audio.i_channels );
506 if( p_out )
508 p_out->i_pts = date_Get( &p_sys->date );
509 p_out->i_length = date_Increment( &p_sys->date,
510 frame.samples / frame.channels )
511 - p_out->i_pts;
513 /* Don't kill speakers if some weird mapping does not gets 1:1 */
514 if( popcount(p_dec->fmt_out.audio.i_physical_channels) != frame.channels )
515 memset( p_out->p_buffer, 0, p_out->i_buffer );
517 /* FIXME: replace when aout_channel_reorder can take samples from a different buffer */
518 DoReordering( (uint32_t *)p_out->p_buffer, samples,
519 frame.samples / frame.channels, frame.channels,
520 pi_neworder_table );
522 if( p_sys->b_discontinuity )
524 p_out->i_flags |= BLOCK_FLAG_DISCONTINUITY;
525 p_sys->b_discontinuity = false;
528 decoder_QueueAudio( p_dec, p_out );
530 else
532 date_Increment( &p_sys->date, frame.samples / frame.channels );
535 FlushBuffer( p_sys, frame.bytesconsumed );
537 return VLCDEC_SUCCESS;
539 else
541 /* Drop byte of padding */
542 FlushBuffer( p_sys, 0 );
545 return VLCDEC_SUCCESS;
548 /*****************************************************************************
549 * Close:
550 *****************************************************************************/
551 static void Close( vlc_object_t *p_this )
553 decoder_t *p_dec = (decoder_t *)p_this;
554 decoder_sys_t *p_sys = p_dec->p_sys;
556 NeAACDecClose( p_sys->hfaad );
557 FlushBuffer( p_sys, SIZE_MAX );
558 free( p_sys );
561 /*****************************************************************************
562 * DoReordering: do some channel re-ordering (the ac3 channel order is
563 * different from the aac one).
564 *****************************************************************************/
565 static void DoReordering( uint32_t *p_out, uint32_t *p_in, int i_samples,
566 int i_nb_channels, uint8_t *pi_chan_positions )
568 #if HAVE_FPU
569 #define CAST_SAMPLE(a) a
570 #else
571 #define CAST_SAMPLE(a) ((uint16_t *)a)
572 #endif
573 /* Do the actual reordering */
574 for( int i = 0; i < i_samples; i++ )
576 for( int j = 0; j < i_nb_channels; j++ )
578 CAST_SAMPLE(p_out)[i * i_nb_channels + pi_chan_positions[j]] =
579 CAST_SAMPLE(p_in)[i * i_nb_channels + j];