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, 2002 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 *****************************************************************************/
33 # include <stdint.h> /* int16_t .. */
35 # include <inttypes.h> /* int16_t .. */
42 #ifdef USE_A52DEC_TREE /* liba52 header file */
43 # include "include/a52.h"
45 # include "a52dec/a52.h"
49 #include <vlc_block.h>
50 #include <vlc_filter.h>
52 /*****************************************************************************
54 *****************************************************************************/
55 static int Create ( vlc_object_t * );
56 static void Destroy ( vlc_object_t * );
57 static void DoWork ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
59 static int Open ( vlc_object_t *, filter_sys_t *,
60 audio_format_t, audio_format_t );
62 static int OpenFilter ( vlc_object_t * );
63 static void CloseFilter( vlc_object_t * );
64 static block_t *Convert( filter_t *, block_t * );
66 /* liba52 channel order */
67 static const uint32_t pi_channels_in[] =
68 { AOUT_CHAN_LFE, AOUT_CHAN_LEFT, AOUT_CHAN_CENTER, AOUT_CHAN_RIGHT,
69 AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, 0 };
70 /* our internal channel order (WG-4 order) */
71 static const uint32_t pi_channels_out[] =
72 { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
73 AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 };
75 /*****************************************************************************
77 *****************************************************************************/
80 a52_state_t * p_liba52; /* liba52 internal structure */
81 vlc_bool_t b_dynrng; /* see below */
82 int i_flags; /* liba52 flags, see a52dec/doc/liba52.txt */
83 vlc_bool_t b_dontwarn;
84 int i_nb_channels; /* number of float32 per sample */
86 int pi_chan_table[AOUT_CHAN_MAX]; /* channel reordering */
89 /*****************************************************************************
91 *****************************************************************************/
92 #define DYNRNG_TEXT N_("A/52 dynamic range compression")
93 #define DYNRNG_LONGTEXT N_( \
94 "Dynamic range compression makes the loud sounds softer, and the soft " \
95 "sounds louder, so you can more easily listen to the stream in a noisy " \
96 "environment without disturbing anyone. If you disable the dynamic range "\
97 "compression the playback will be more adapted to a movie theater or a " \
99 #define UPMIX_TEXT N_("Enable internal upmixing")
100 #define UPMIX_LONGTEXT N_( \
101 "Enable the internal upmixing algorithm (not recommended).")
104 set_shortname( "A/52" );
105 set_description( _("ATSC A/52 (AC-3) audio decoder") );
106 set_category( CAT_INPUT );
107 set_subcategory( SUBCAT_INPUT_ACODEC );
108 add_bool( "a52-dynrng", 1, NULL, DYNRNG_TEXT, DYNRNG_LONGTEXT, VLC_FALSE );
109 add_bool( "a52-upmix", 0, NULL, UPMIX_TEXT, UPMIX_LONGTEXT, VLC_TRUE );
110 set_capability( "audio filter", 100 );
111 set_callbacks( Create, Destroy );
114 set_description( _("ATSC A/52 (AC-3) audio decoder") );
115 set_capability( "audio filter2", 100 );
116 set_callbacks( OpenFilter, CloseFilter );
119 /*****************************************************************************
121 *****************************************************************************/
122 static int Create( vlc_object_t *p_this )
124 aout_filter_t *p_filter = (aout_filter_t *)p_this;
125 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
128 if ( p_filter->input.i_format != VLC_FOURCC('a','5','2',' ')
130 || p_filter->output.i_format != VLC_FOURCC('f','i','3','2') )
132 || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
138 if ( p_filter->input.i_rate != p_filter->output.i_rate )
143 /* Allocate the memory needed to store the module's structure */
144 p_sys = malloc( sizeof(filter_sys_t) );
145 p_filter->p_sys = (struct aout_filter_sys_t *)p_sys;
148 msg_Err( p_filter, "out of memory" );
152 i_ret = Open( VLC_OBJECT(p_filter), p_sys,
153 p_filter->input, p_filter->output );
155 p_filter->pf_do_work = DoWork;
156 p_filter->b_in_place = 0;
161 /*****************************************************************************
163 *****************************************************************************/
164 static int Open( vlc_object_t *p_this, filter_sys_t *p_sys,
165 audio_format_t input, audio_format_t output )
167 p_sys->b_dynrng = config_GetInt( p_this, "a52-dynrng" );
168 p_sys->b_dontwarn = 0;
170 /* No upmixing: it's not necessary and some other filters may want to do
172 if ( aout_FormatNbChannels( &output ) > aout_FormatNbChannels( &input ) )
174 if ( ! config_GetInt( p_this, "a52-upmix" ) )
180 /* We'll do our own downmixing, thanks. */
181 p_sys->i_nb_channels = aout_FormatNbChannels( &output );
182 switch ( (output.i_physical_channels & AOUT_CHAN_PHYSMASK)
185 case AOUT_CHAN_CENTER:
186 if ( (output.i_original_channels & AOUT_CHAN_CENTER)
187 || (output.i_original_channels
188 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
190 p_sys->i_flags = A52_MONO;
192 else if ( output.i_original_channels & AOUT_CHAN_LEFT )
194 p_sys->i_flags = A52_CHANNEL1;
198 p_sys->i_flags = A52_CHANNEL2;
202 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
203 if ( output.i_original_channels & AOUT_CHAN_DOLBYSTEREO )
205 p_sys->i_flags = A52_DOLBY;
207 else if ( input.i_original_channels == AOUT_CHAN_CENTER )
209 p_sys->i_flags = A52_MONO;
211 else if ( input.i_original_channels & AOUT_CHAN_DUALMONO )
213 p_sys->i_flags = A52_CHANNEL;
215 else if ( !(output.i_original_channels & AOUT_CHAN_RIGHT) )
217 p_sys->i_flags = A52_CHANNEL1;
219 else if ( !(output.i_original_channels & AOUT_CHAN_LEFT) )
221 p_sys->i_flags = A52_CHANNEL2;
225 p_sys->i_flags = A52_STEREO;
229 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
230 p_sys->i_flags = A52_3F;
233 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
234 p_sys->i_flags = A52_2F1R;
237 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
238 | AOUT_CHAN_REARCENTER:
239 p_sys->i_flags = A52_3F1R;
242 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
243 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
244 p_sys->i_flags = A52_2F2R;
247 case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
248 | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
249 p_sys->i_flags = A52_3F2R;
253 msg_Warn( p_this, "unknown sample format!" );
257 if ( output.i_physical_channels & AOUT_CHAN_LFE )
259 p_sys->i_flags |= A52_LFE;
261 p_sys->i_flags |= A52_ADJUST_LEVEL;
263 /* Initialize liba52 */
264 p_sys->p_liba52 = a52_init( 0 );
265 if( p_sys->p_liba52 == NULL )
267 msg_Err( p_this, "unable to initialize liba52" );
272 aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
273 output.i_physical_channels & AOUT_CHAN_PHYSMASK,
274 p_sys->i_nb_channels,
275 p_sys->pi_chan_table );
280 /*****************************************************************************
281 * Interleave: helper function to interleave channels
282 *****************************************************************************/
283 static void Interleave( float * p_out, const float * p_in, int i_nb_channels,
286 /* We do not only have to interleave, but also reorder the channels */
289 for ( j = 0; j < i_nb_channels; j++ )
291 for ( i = 0; i < 256; i++ )
293 p_out[i * i_nb_channels + pi_chan_table[j]] = p_in[j * 256 + i];
298 /*****************************************************************************
299 * Duplicate: helper function to duplicate a unique channel
300 *****************************************************************************/
301 static void Duplicate( float * p_out, const float * p_in )
305 for ( i = 256; i--; )
313 /*****************************************************************************
314 * Exchange: helper function to exchange left & right channels
315 *****************************************************************************/
316 static void Exchange( float * p_out, const float * p_in )
319 const float * p_first = p_in + 256;
320 const float * p_second = p_in;
322 for ( i = 0; i < 256; i++ )
324 *p_out++ = *p_first++;
325 *p_out++ = *p_second++;
329 /*****************************************************************************
330 * DoWork: decode an ATSC A/52 frame.
331 *****************************************************************************/
332 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
333 aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
335 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
337 sample_t i_sample_level = (1 << 24);
339 sample_t i_sample_level = 1;
341 int i_flags = p_sys->i_flags;
342 int i_bytes_per_block = 256 * p_sys->i_nb_channels
346 /* Do the actual decoding now. */
347 a52_frame( p_sys->p_liba52, p_in_buf->p_buffer,
348 &i_flags, &i_sample_level, 0 );
350 if ( (i_flags & A52_CHANNEL_MASK) != (p_sys->i_flags & A52_CHANNEL_MASK)
351 && !p_sys->b_dontwarn )
354 "liba52 couldn't do the requested downmix 0x%x->0x%x",
355 p_sys->i_flags & A52_CHANNEL_MASK,
356 i_flags & A52_CHANNEL_MASK );
358 p_sys->b_dontwarn = 1;
361 if( !p_sys->b_dynrng )
363 a52_dynrng( p_sys->p_liba52, NULL, NULL );
366 for ( i = 0; i < 6; i++ )
368 sample_t * p_samples;
370 if( a52_block( p_sys->p_liba52 ) )
372 msg_Warn( p_aout, "a52_block failed for block %d", i );
375 p_samples = a52_samples( p_sys->p_liba52 );
377 if ( ((p_sys->i_flags & A52_CHANNEL_MASK) == A52_CHANNEL1
378 || (p_sys->i_flags & A52_CHANNEL_MASK) == A52_CHANNEL2
379 || (p_sys->i_flags & A52_CHANNEL_MASK) == A52_MONO)
380 && (p_filter->output.i_physical_channels
381 & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
383 Duplicate( (float *)(p_out_buf->p_buffer + i * i_bytes_per_block),
386 else if ( p_filter->output.i_original_channels
387 & AOUT_CHAN_REVERSESTEREO )
389 Exchange( (float *)(p_out_buf->p_buffer + i * i_bytes_per_block),
394 /* Interleave the *$£%ù samples. */
395 Interleave( (float *)(p_out_buf->p_buffer + i * i_bytes_per_block),
396 p_samples, p_sys->i_nb_channels, p_sys->pi_chan_table);
400 p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
401 p_out_buf->i_nb_bytes = i_bytes_per_block * 6;
404 /*****************************************************************************
405 * Destroy : deallocate data structures
406 *****************************************************************************/
407 static void Destroy( vlc_object_t *p_this )
409 aout_filter_t *p_filter = (aout_filter_t *)p_this;
410 filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
412 a52_free( p_sys->p_liba52 );
416 /*****************************************************************************
418 *****************************************************************************/
419 static int OpenFilter( vlc_object_t *p_this )
421 filter_t *p_filter = (filter_t *)p_this;
425 if( p_filter->fmt_in.i_codec != VLC_FOURCC('a','5','2',' ') )
430 p_filter->fmt_out.audio.i_format =
432 p_filter->fmt_out.i_codec = VLC_FOURCC('f','i','3','2');
434 p_filter->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
437 /* Allocate the memory needed to store the module's structure */
438 p_filter->p_sys = p_sys = malloc( sizeof(filter_sys_t) );
441 msg_Err( p_filter, "out of memory" );
445 i_ret = Open( VLC_OBJECT(p_filter), p_sys,
446 p_filter->fmt_in.audio, p_filter->fmt_out.audio );
448 p_filter->pf_audio_filter = Convert;
449 p_filter->fmt_out.audio.i_rate = p_filter->fmt_in.audio.i_rate;
454 /*****************************************************************************
455 * CloseFilter : deallocate data structures
456 *****************************************************************************/
457 static void CloseFilter( vlc_object_t *p_this )
459 filter_t *p_filter = (filter_t *)p_this;
460 filter_sys_t *p_sys = p_filter->p_sys;
462 a52_free( p_sys->p_liba52 );
466 static block_t *Convert( filter_t *p_filter, block_t *p_block )
468 aout_filter_t aout_filter;
469 aout_buffer_t in_buf, out_buf;
473 if( !p_block || !p_block->i_samples )
475 if( p_block ) p_block->pf_release( p_block );
479 i_out_size = p_block->i_samples *
480 p_filter->fmt_out.audio.i_bitspersample *
481 p_filter->fmt_out.audio.i_channels / 8;
483 p_out = p_filter->pf_audio_buffer_new( p_filter, i_out_size );
486 msg_Warn( p_filter, "can't get output buffer" );
487 p_block->pf_release( p_block );
491 p_out->i_samples = p_block->i_samples;
492 p_out->i_dts = p_block->i_dts;
493 p_out->i_pts = p_block->i_pts;
494 p_out->i_length = p_block->i_length;
496 aout_filter.p_sys = (struct aout_filter_sys_t *)p_filter->p_sys;
497 aout_filter.input = p_filter->fmt_in.audio;
498 aout_filter.input.i_format = p_filter->fmt_in.i_codec;
499 aout_filter.output = p_filter->fmt_out.audio;
500 aout_filter.output.i_format = p_filter->fmt_out.i_codec;
502 in_buf.p_buffer = p_block->p_buffer;
503 in_buf.i_nb_bytes = p_block->i_buffer;
504 in_buf.i_nb_samples = p_block->i_samples;
505 out_buf.p_buffer = p_out->p_buffer;
506 out_buf.i_nb_bytes = p_out->i_buffer;
507 out_buf.i_nb_samples = p_out->i_samples;
509 DoWork( (aout_instance_t *)p_filter, &aout_filter, &in_buf, &out_buf );
511 p_out->i_buffer = out_buf.i_nb_bytes;
512 p_out->i_samples = out_buf.i_nb_samples;
514 p_block->pf_release( p_block );