1 /*****************************************************************************
2 * a52tofloat32.c: ATSC A/52 aka AC-3 decoder plugin for VLC.
3 * This plugin makes use of liba52 to decode A/52 audio
4 * (http://liba52.sf.net/).
5 *****************************************************************************
6 * Copyright (C) 2001-2009 the VideoLAN team
9 * Authors: Gildas Bazin <gbazin@videolan.org>
10 * Christophe Massiot <massiot@via.ecp.fr>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
27 /*****************************************************************************
29 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
37 #include <stdint.h> /* int16_t .. */
43 #ifdef USE_A52DEC_TREE /* liba52 header file */
44 # include "include/a52.h"
46 # include "a52dec/a52.h"
50 #include <vlc_block.h>
51 #include <vlc_filter.h>
53 /*****************************************************************************
55 *****************************************************************************/
56 static int Create ( vlc_object_t * );
57 static void Destroy ( vlc_object_t * );
58 static void DoWork ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
60 static int Open ( vlc_object_t *, filter_sys_t *,
61 audio_format_t, audio_format_t );
63 static int OpenFilter ( vlc_object_t * );
64 static void CloseFilter( vlc_object_t * );
65 static block_t *Convert( filter_t *, block_t * );
67 /* liba52 channel order */
68 static const uint32_t pi_channels_in[] =
69 { AOUT_CHAN_LFE, AOUT_CHAN_LEFT, AOUT_CHAN_CENTER, AOUT_CHAN_RIGHT,
70 AOUT_CHAN_REARLEFT, AOUT_CHAN_REARCENTER, AOUT_CHAN_REARRIGHT, 0 };
72 /*****************************************************************************
74 *****************************************************************************/
77 a52_state_t * p_liba52; /* liba52 internal structure */
78 bool b_dynrng; /* see below */
79 int i_flags; /* liba52 flags, see a52dec/doc/liba52.txt */
81 int i_nb_channels; /* number of float32 per sample */
83 int pi_chan_table[AOUT_CHAN_MAX]; /* channel reordering */
86 /*****************************************************************************
88 *****************************************************************************/
89 #define DYNRNG_TEXT N_("A/52 dynamic range compression")
90 #define DYNRNG_LONGTEXT N_( \
91 "Dynamic range compression makes the loud sounds softer, and the soft " \
92 "sounds louder, so you can more easily listen to the stream in a noisy " \
93 "environment without disturbing anyone. If you disable the dynamic range "\
94 "compression the playback will be more adapted to a movie theater or a " \
96 #define UPMIX_TEXT N_("Enable internal upmixing")
97 #define UPMIX_LONGTEXT N_( \
98 "Enable the internal upmixing algorithm (not recommended).")
101 set_shortname( "A/52" )
102 set_description( N_("ATSC A/52 (AC-3) audio decoder") )
103 set_category( CAT_INPUT )
104 set_subcategory( SUBCAT_INPUT_ACODEC )
105 add_bool( "a52-dynrng", true, NULL, DYNRNG_TEXT, DYNRNG_LONGTEXT, false )
106 add_bool( "a52-upmix", false, NULL, UPMIX_TEXT, UPMIX_LONGTEXT, true )
107 set_capability( "audio filter", 100 )
108 set_callbacks( Create, Destroy )
111 set_description( N_("ATSC A/52 (AC-3) audio decoder") )
112 set_capability( "audio filter2", 100 )
113 set_callbacks( OpenFilter, CloseFilter )
116 /*****************************************************************************
118 *****************************************************************************/
119 static int Create( vlc_object_t *p_this )
121 aout_filter_t *p_filter = (aout_filter_t *)p_this;
125 if ( p_filter->input.i_format != VLC_CODEC_A52
127 || p_filter->output.i_format != VLC_CODEC_FI32 )
129 || p_filter->output.i_format != VLC_CODEC_FL32 )
135 if ( p_filter->input.i_rate != p_filter->output.i_rate )
140 /* Allocate the memory needed to store the module's structure */
141 p_sys = malloc( sizeof(filter_sys_t) );
142 p_filter->p_sys = (struct aout_filter_sys_t *)p_sys;
146 i_ret = Open( VLC_OBJECT(p_filter), p_sys,
147 p_filter->input, p_filter->output );
149 p_filter->pf_do_work = DoWork;
150 p_filter->b_in_place = 0;
155 /*****************************************************************************
157 *****************************************************************************/
158 static int Open( vlc_object_t *p_this, filter_sys_t *p_sys,
159 audio_format_t input, audio_format_t output )
161 p_sys->b_dynrng = config_GetInt( p_this, "a52-dynrng" );
162 p_sys->b_dontwarn = 0;
164 /* No upmixing: it's not necessary and some other filters may want to do
166 if ( aout_FormatNbChannels( &output ) > aout_FormatNbChannels( &input ) )
168 if ( ! config_GetInt( p_this, "a52-upmix" ) )
174 /* We'll do our own downmixing, thanks. */
175 p_sys->i_nb_channels = aout_FormatNbChannels( &output );
176 switch ( (output.i_physical_channels & AOUT_CHAN_PHYSMASK)
179 case AOUT_CHAN_CENTER:
180 if ( (output.i_original_channels & AOUT_CHAN_CENTER)
181 || (output.i_original_channels
182 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
184 p_sys->i_flags = A52_MONO;
186 else if ( output.i_original_channels & AOUT_CHAN_LEFT )
188 p_sys->i_flags = A52_CHANNEL1;
192 p_sys->i_flags = A52_CHANNEL2;
196 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
197 if ( output.i_original_channels & AOUT_CHAN_DOLBYSTEREO )
199 p_sys->i_flags = A52_DOLBY;
201 else if ( input.i_original_channels == AOUT_CHAN_CENTER )
203 p_sys->i_flags = A52_MONO;
205 else if ( input.i_original_channels & AOUT_CHAN_DUALMONO )
207 p_sys->i_flags = A52_CHANNEL;
209 else if ( !(output.i_original_channels & AOUT_CHAN_RIGHT) )
211 p_sys->i_flags = A52_CHANNEL1;
213 else if ( !(output.i_original_channels & AOUT_CHAN_LEFT) )
215 p_sys->i_flags = A52_CHANNEL2;
219 p_sys->i_flags = A52_STEREO;
223 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
224 p_sys->i_flags = A52_3F;
227 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
228 p_sys->i_flags = A52_2F1R;
231 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
232 | AOUT_CHAN_REARCENTER:
233 p_sys->i_flags = A52_3F1R;
236 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
237 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
238 p_sys->i_flags = A52_2F2R;
241 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
242 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
243 p_sys->i_flags = A52_3F2R;
247 msg_Warn( p_this, "unknown sample format!" );
251 if ( output.i_physical_channels & AOUT_CHAN_LFE )
253 p_sys->i_flags |= A52_LFE;
255 p_sys->i_flags |= A52_ADJUST_LEVEL;
257 /* Initialize liba52 */
258 p_sys->p_liba52 = a52_init( 0 );
259 if( p_sys->p_liba52 == NULL )
261 msg_Err( p_this, "unable to initialize liba52" );
266 aout_CheckChannelReorder( pi_channels_in, NULL,
267 output.i_physical_channels & AOUT_CHAN_PHYSMASK,
268 p_sys->i_nb_channels,
269 p_sys->pi_chan_table );
274 /*****************************************************************************
275 * Interleave: helper function to interleave channels
276 *****************************************************************************/
277 static void Interleave( sample_t * p_out, const sample_t * p_in,
278 int i_nb_channels, int *pi_chan_table )
280 /* We do not only have to interleave, but also reorder the channels */
283 for ( j = 0; j < i_nb_channels; j++ )
285 for ( i = 0; i < 256; i++ )
287 p_out[i * i_nb_channels + pi_chan_table[j]] = p_in[j * 256 + i];
292 /*****************************************************************************
293 * Duplicate: helper function to duplicate a unique channel
294 *****************************************************************************/
295 static void Duplicate( sample_t * p_out, const sample_t * p_in )
299 for ( i = 256; i--; )
307 /*****************************************************************************
308 * Exchange: helper function to exchange left & right channels
309 *****************************************************************************/
310 static void Exchange( sample_t * p_out, const sample_t * p_in )
313 const sample_t * p_first = p_in + 256;
314 const sample_t * p_second = p_in;
316 for ( i = 0; i < 256; i++ )
318 *p_out++ = *p_first++;
319 *p_out++ = *p_second++;
323 /*****************************************************************************
324 * DoWork: decode an ATSC A/52 frame.
325 *****************************************************************************/
326 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
327 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
329 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
331 sample_t i_sample_level = (1 << 24);
333 sample_t i_sample_level = 1;
335 int i_flags = p_sys->i_flags;
336 int i_bytes_per_block = 256 * p_sys->i_nb_channels
340 /* Do the actual decoding now. */
341 a52_frame( p_sys->p_liba52, p_in_buf->p_buffer,
342 &i_flags, &i_sample_level, 0 );
344 if ( (i_flags & A52_CHANNEL_MASK) != (p_sys->i_flags & A52_CHANNEL_MASK)
345 && !p_sys->b_dontwarn )
348 "liba52 couldn't do the requested downmix 0x%x->0x%x",
349 p_sys->i_flags & A52_CHANNEL_MASK,
350 i_flags & A52_CHANNEL_MASK );
352 p_sys->b_dontwarn = 1;
355 if( !p_sys->b_dynrng )
357 a52_dynrng( p_sys->p_liba52, NULL, NULL );
360 for ( i = 0; i < 6; i++ )
362 sample_t * p_samples;
364 if( a52_block( p_sys->p_liba52 ) )
366 msg_Warn( p_aout, "a52_block failed for block %d", i );
369 p_samples = a52_samples( p_sys->p_liba52 );
371 if ( ((p_sys->i_flags & A52_CHANNEL_MASK) == A52_CHANNEL1
372 || (p_sys->i_flags & A52_CHANNEL_MASK) == A52_CHANNEL2
373 || (p_sys->i_flags & A52_CHANNEL_MASK) == A52_MONO)
374 && (p_filter->output.i_physical_channels
375 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
377 Duplicate( (sample_t *)(p_out_buf->p_buffer + i * i_bytes_per_block),
380 else if ( p_filter->output.i_original_channels
381 & AOUT_CHAN_REVERSESTEREO )
383 Exchange( (sample_t *)(p_out_buf->p_buffer + i * i_bytes_per_block),
388 /* Interleave the *$£%ù samples. */
389 Interleave( (sample_t *)(p_out_buf->p_buffer + i * i_bytes_per_block),
390 p_samples, p_sys->i_nb_channels, p_sys->pi_chan_table);
394 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
395 p_out_buf->i_nb_bytes = i_bytes_per_block * 6;
398 /*****************************************************************************
399 * Destroy : deallocate data structures
400 *****************************************************************************/
401 static void Destroy( vlc_object_t *p_this )
403 aout_filter_t *p_filter = (aout_filter_t *)p_this;
404 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
406 a52_free( p_sys->p_liba52 );
410 /*****************************************************************************
412 *****************************************************************************/
413 static int OpenFilter( vlc_object_t *p_this )
415 filter_t *p_filter = (filter_t *)p_this;
419 if( p_filter->fmt_in.i_codec != VLC_CODEC_A52 )
424 p_filter->fmt_out.audio.i_format =
426 p_filter->fmt_out.i_codec = VLC_CODEC_FI32;
428 p_filter->fmt_out.i_codec = VLC_CODEC_FL32;
430 p_filter->fmt_out.audio.i_bitspersample =
431 aout_BitsPerSample( p_filter->fmt_out.i_codec );
433 /* Allocate the memory needed to store the module's structure */
434 p_filter->p_sys = p_sys = malloc( sizeof(filter_sys_t) );
438 i_ret = Open( VLC_OBJECT(p_filter), p_sys,
439 p_filter->fmt_in.audio, p_filter->fmt_out.audio );
441 p_filter->pf_audio_filter = Convert;
442 p_filter->fmt_out.audio.i_rate = p_filter->fmt_in.audio.i_rate;
447 /*****************************************************************************
448 * CloseFilter : deallocate data structures
449 *****************************************************************************/
450 static void CloseFilter( vlc_object_t *p_this )
452 filter_t *p_filter = (filter_t *)p_this;
453 filter_sys_t *p_sys = p_filter->p_sys;
455 a52_free( p_sys->p_liba52 );
459 static block_t *Convert( filter_t *p_filter, block_t *p_block )
461 aout_filter_t aout_filter;
462 aout_buffer_t in_buf, out_buf;
466 if( !p_block || !p_block->i_nb_samples )
469 block_Release( p_block );
473 i_out_size = p_block->i_nb_samples *
474 p_filter->fmt_out.audio.i_bitspersample *
475 p_filter->fmt_out.audio.i_channels / 8;
477 p_out = p_filter->pf_audio_buffer_new( p_filter, i_out_size );
480 msg_Warn( p_filter, "can't get output buffer" );
481 block_Release( p_block );
485 p_out->i_nb_samples = p_block->i_nb_samples;
486 p_out->i_dts = p_block->i_dts;
487 p_out->i_pts = p_block->i_pts;
488 p_out->i_length = p_block->i_length;
490 aout_filter.p_sys = (struct aout_filter_sys_t *)p_filter->p_sys;
491 aout_filter.input = p_filter->fmt_in.audio;
492 aout_filter.input.i_format = p_filter->fmt_in.i_codec;
493 aout_filter.output = p_filter->fmt_out.audio;
494 aout_filter.output.i_format = p_filter->fmt_out.i_codec;
496 in_buf.p_buffer = p_block->p_buffer;
497 in_buf.i_nb_bytes = p_block->i_buffer;
498 in_buf.i_nb_samples = p_block->i_nb_samples;
499 out_buf.p_buffer = p_out->p_buffer;
500 out_buf.i_nb_bytes = p_out->i_buffer;
501 out_buf.i_nb_samples = p_out->i_nb_samples;
503 DoWork( (aout_instance_t *)p_filter, &aout_filter, &in_buf, &out_buf );
505 p_out->i_buffer = out_buf.i_nb_bytes;
506 p_out->i_nb_samples = out_buf.i_nb_samples;
508 block_Release( p_block );