git.sesse.net Git - vlc/blob - modules/audio_filter/converter/a52tofloat32.c

   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 VideoLAN
   7  * $Id$
   8  *
   9  * Authors: Gildas Bazin <gbazin@videolan.org>
  10  *          Christophe Massiot <massiot@via.ecp.fr>
  11  *
  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.
  16  *
  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.
  21  *
  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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  25  *****************************************************************************/
  26
  27 /*****************************************************************************
  28  * Preamble
  29  *****************************************************************************/
  30 #include <vlc/vlc.h>
  31
  32 #include <stdlib.h>                                      /* malloc(), free() */
  33 #include <string.h>                                              /* strdup() */
  34 #ifdef HAVE_STDINT_H
  35 #   include <stdint.h>                                         /* int16_t .. */
  36 #elif HAVE_INTTYPES_H
  37 #   include <inttypes.h>                                       /* int16_t .. */
  38 #endif
  39
  40 #ifdef HAVE_UNISTD_H
  41 #   include <unistd.h>
  42 #endif
  43
  44 #ifdef USE_A52DEC_TREE                                 /* liba52 header file */
  45 #   include "include/a52.h"
  46 #else
  47 #   include "a52dec/a52.h"
  48 #endif
  49
  50 #include <vlc/decoder.h>
  51 #include "aout_internal.h"
  52 #include "vlc_filter.h"
  53
  54 /*****************************************************************************
  55  * Local prototypes
  56  *****************************************************************************/
  57 static int  Create    ( vlc_object_t * );
  58 static void Destroy   ( vlc_object_t * );
  59 static void DoWork    ( aout_instance_t *, aout_filter_t *, aout_buffer_t *,
  60                         aout_buffer_t * );
  61 static int  Open      ( vlc_object_t *, filter_sys_t *,
  62                         audio_format_t, audio_format_t );
  63
  64 static int  OpenFilter ( vlc_object_t * );
  65 static void CloseFilter( vlc_object_t * );
  66 static block_t *Convert( filter_t *, block_t * );
  67
  68 /* liba52 channel order */
  69 static const uint32_t pi_channels_in[] =
  70 { AOUT_CHAN_LFE, AOUT_CHAN_LEFT, AOUT_CHAN_CENTER, AOUT_CHAN_RIGHT,
  71   AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT, 0 };
  72 /* our internal channel order (WG-4 order) */
  73 static const uint32_t pi_channels_out[] =
  74 { AOUT_CHAN_LEFT, AOUT_CHAN_RIGHT, AOUT_CHAN_REARLEFT, AOUT_CHAN_REARRIGHT,
  75   AOUT_CHAN_CENTER, AOUT_CHAN_LFE, 0 };
  76
  77 /*****************************************************************************
  78  * Local structures
  79  *****************************************************************************/
  80 struct filter_sys_t
  81 {
  82     a52_state_t * p_liba52; /* liba52 internal structure */
  83     vlc_bool_t b_dynrng; /* see below */
  84     int i_flags; /* liba52 flags, see a52dec/doc/liba52.txt */
  85     vlc_bool_t b_dontwarn;
  86     int i_nb_channels; /* number of float32 per sample */
  87
  88     int pi_chan_table[AOUT_CHAN_MAX]; /* channel reordering */
  89 };
  90
  91 /*****************************************************************************
  92  * Module descriptor
  93  *****************************************************************************/
  94 #define DYNRNG_TEXT N_("A/52 dynamic range compression")
  95 #define DYNRNG_LONGTEXT N_( \
  96     "Dynamic range compression makes the loud sounds softer, and the soft " \
  97     "sounds louder, so you can more easily listen to the stream in a noisy " \
  98     "environment without disturbing anyone. If you disable the dynamic range "\
  99     "compression the playback will be more adapted to a movie theater or a " \
 100     "listening room.")
 101
 102 vlc_module_begin();
 103     set_description( _("ATSC A/52 (AC-3) audio decoder") );
 104     add_bool( "a52-dynrng", 1, NULL, DYNRNG_TEXT, DYNRNG_LONGTEXT, VLC_FALSE );
 105     set_capability( "audio filter", 100 );
 106     set_callbacks( Create, Destroy );
 107
 108     add_submodule();
 109     set_description( _("ATSC A/52 (AC-3) audio decoder") );
 110     set_capability( "audio filter2", 100 );
 111     set_callbacks( OpenFilter, CloseFilter );
 112 vlc_module_end();
 113
 114 /*****************************************************************************
 115  * Create:
 116  *****************************************************************************/
 117 static int Create( vlc_object_t *p_this )
 118 {
 119     aout_filter_t *p_filter = (aout_filter_t *)p_this;
 120     filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
 121     int i_ret;
 122
 123     if ( p_filter->input.i_format != VLC_FOURCC('a','5','2',' ')
 124           || p_filter->output.i_format != VLC_FOURCC('f','l','3','2') )
 125     {
 126         return -1;
 127     }
 128
 129     if ( p_filter->input.i_rate != p_filter->output.i_rate )
 130     {
 131         return -1;
 132     }
 133
 134     /* Allocate the memory needed to store the module's structure */
 135     p_sys = malloc( sizeof(filter_sys_t) );
 136     p_filter->p_sys = (struct aout_filter_sys_t *)p_sys;
 137     if( p_sys == NULL )
 138     {
 139         msg_Err( p_filter, "out of memory" );
 140         return -1;
 141     }
 142
 143     i_ret = Open( VLC_OBJECT(p_filter), p_sys,
 144                   p_filter->input, p_filter->output );
 145
 146     p_filter->pf_do_work = DoWork;
 147     p_filter->b_in_place = 0;
 148
 149     return i_ret;
 150 }
 151
 152 /*****************************************************************************
 153  * Open:
 154  *****************************************************************************/
 155 static int Open( vlc_object_t *p_this, filter_sys_t *p_sys,
 156                  audio_format_t input, audio_format_t output )
 157 {
 158     p_sys->b_dynrng = config_GetInt( p_this, "a52-dynrng" );
 159     p_sys->b_dontwarn = 0;
 160
 161     /* We'll do our own downmixing, thanks. */
 162     p_sys->i_nb_channels = aout_FormatNbChannels( &output );
 163     switch ( (output.i_physical_channels & AOUT_CHAN_PHYSMASK)
 164               & ~AOUT_CHAN_LFE )
 165     {
 166     case AOUT_CHAN_CENTER:
 167         if ( (output.i_original_channels & AOUT_CHAN_CENTER)
 168               || (output.i_original_channels
 169                    & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
 170         {
 171             p_sys->i_flags = A52_MONO;
 172         }
 173         else if ( output.i_original_channels & AOUT_CHAN_LEFT )
 174         {
 175             p_sys->i_flags = A52_CHANNEL1;
 176         }
 177         else
 178         {
 179             p_sys->i_flags = A52_CHANNEL2;
 180         }
 181         break;
 182
 183     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT:
 184         if ( output.i_original_channels & AOUT_CHAN_DOLBYSTEREO )
 185         {
 186             p_sys->i_flags = A52_DOLBY;
 187         }
 188         else if ( input.i_original_channels == AOUT_CHAN_CENTER )
 189         {
 190             p_sys->i_flags = A52_MONO;
 191         }
 192         else if ( input.i_original_channels & AOUT_CHAN_DUALMONO )
 193         {
 194             p_sys->i_flags = A52_CHANNEL;
 195         }
 196         else if ( !(output.i_original_channels & AOUT_CHAN_RIGHT) )
 197         {
 198             p_sys->i_flags = A52_CHANNEL1;
 199         }
 200         else if ( !(output.i_original_channels & AOUT_CHAN_LEFT) )
 201         {
 202             p_sys->i_flags = A52_CHANNEL2;
 203         }
 204         else
 205         {
 206             p_sys->i_flags = A52_STEREO;
 207         }
 208         break;
 209
 210     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER:
 211         p_sys->i_flags = A52_3F;
 212         break;
 213
 214     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_REARCENTER:
 215         p_sys->i_flags = A52_2F1R;
 216         break;
 217
 218     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 219           | AOUT_CHAN_REARCENTER:
 220         p_sys->i_flags = A52_3F1R;
 221         break;
 222
 223     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
 224           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
 225         p_sys->i_flags = A52_2F2R;
 226         break;
 227
 228     case AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER
 229           | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT:
 230         p_sys->i_flags = A52_3F2R;
 231         break;
 232
 233     default:
 234         msg_Warn( p_this, "unknown sample format!" );
 235         free( p_sys );
 236         return VLC_EGENERIC;
 237     }
 238     if ( output.i_physical_channels & AOUT_CHAN_LFE )
 239     {
 240         p_sys->i_flags |= A52_LFE;
 241     }
 242     p_sys->i_flags |= A52_ADJUST_LEVEL;
 243
 244     /* Initialize liba52 */
 245     p_sys->p_liba52 = a52_init( 0 );
 246     if( p_sys->p_liba52 == NULL )
 247     {
 248         msg_Err( p_this, "unable to initialize liba52" );
 249         free( p_sys );
 250         return VLC_EGENERIC;
 251     }
 252
 253     aout_CheckChannelReorder( pi_channels_in, pi_channels_out,
 254                               output.i_physical_channels & AOUT_CHAN_PHYSMASK,
 255                               p_sys->i_nb_channels,
 256                               p_sys->pi_chan_table );
 257
 258     return VLC_SUCCESS;
 259 }
 260
 261 /*****************************************************************************
 262  * Interleave: helper function to interleave channels
 263  *****************************************************************************/
 264 static void Interleave( float * p_out, const float * p_in, int i_nb_channels,
 265                         int *pi_chan_table )
 266 {
 267     /* We do not only have to interleave, but also reorder the channels */
 268
 269     int i, j;
 270     for ( j = 0; j < i_nb_channels; j++ )
 271     {
 272         for ( i = 0; i < 256; i++ )
 273         {
 274             p_out[i * i_nb_channels + pi_chan_table[j]] = p_in[j * 256 + i];
 275         }
 276     }
 277 }
 278
 279 /*****************************************************************************
 280  * Duplicate: helper function to duplicate a unique channel
 281  *****************************************************************************/
 282 static void Duplicate( float * p_out, const float * p_in )
 283 {
 284     int i;
 285
 286     for ( i = 256; i--; )
 287     {
 288         *p_out++ = *p_in;
 289         *p_out++ = *p_in;
 290         p_in++;
 291     }
 292 }
 293
 294 /*****************************************************************************
 295  * Exchange: helper function to exchange left & right channels
 296  *****************************************************************************/
 297 static void Exchange( float * p_out, const float * p_in )
 298 {
 299     int i;
 300     const float * p_first = p_in + 256;
 301     const float * p_second = p_in;
 302
 303     for ( i = 0; i < 256; i++ )
 304     {
 305         *p_out++ = *p_first++;
 306         *p_out++ = *p_second++;
 307     }
 308 }
 309
 310 /*****************************************************************************
 311  * DoWork: decode an ATSC A/52 frame.
 312  *****************************************************************************/
 313 static void DoWork( aout_instance_t * p_aout, aout_filter_t * p_filter,
 314                     aout_buffer_t * p_in_buf, aout_buffer_t * p_out_buf )
 315 {
 316     filter_sys_t    *p_sys = (filter_sys_t *)p_filter->p_sys;
 317     sample_t        i_sample_level = 1;
 318     int             i_flags = p_sys->i_flags;
 319     int             i_bytes_per_block = 256 * p_sys->i_nb_channels
 320                       * sizeof(float);
 321     int             i;
 322
 323     /* Do the actual decoding now. */
 324     a52_frame( p_sys->p_liba52, p_in_buf->p_buffer,
 325                &i_flags, &i_sample_level, 0 );
 326
 327     if ( (i_flags & A52_CHANNEL_MASK) != (p_sys->i_flags & A52_CHANNEL_MASK)
 328           && !p_sys->b_dontwarn )
 329     {
 330         msg_Warn( p_filter,
 331                   "liba52 couldn't do the requested downmix 0x%x->0x%x",
 332                   p_sys->i_flags  & A52_CHANNEL_MASK,
 333                   i_flags & A52_CHANNEL_MASK );
 334
 335         p_sys->b_dontwarn = 1;
 336     }
 337
 338     if( !p_sys->b_dynrng )
 339     {
 340         a52_dynrng( p_sys->p_liba52, NULL, NULL );
 341     }
 342
 343     for ( i = 0; i < 6; i++ )
 344     {
 345         sample_t * p_samples;
 346
 347         if( a52_block( p_sys->p_liba52 ) )
 348         {
 349             msg_Warn( p_filter, "a52_block failed for block %d", i );
 350         }
 351
 352         p_samples = a52_samples( p_sys->p_liba52 );
 353
 354         if ( ((p_sys->i_flags & A52_CHANNEL_MASK) == A52_CHANNEL1
 355                || (p_sys->i_flags & A52_CHANNEL_MASK) == A52_CHANNEL2
 356                || (p_sys->i_flags & A52_CHANNEL_MASK) == A52_MONO)
 357               && (p_filter->output.i_physical_channels
 358                    & (AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT)) )
 359         {
 360             Duplicate( (float *)(p_out_buf->p_buffer + i * i_bytes_per_block),
 361                        p_samples );
 362         }
 363         else if ( p_filter->output.i_original_channels
 364                     & AOUT_CHAN_REVERSESTEREO )
 365         {
 366             Exchange( (float *)(p_out_buf->p_buffer + i * i_bytes_per_block),
 367                       p_samples );
 368         }
 369         else
 370         {
 371             /* Interleave the *$£%ù samples. */
 372             Interleave( (float *)(p_out_buf->p_buffer + i * i_bytes_per_block),
 373                         p_samples, p_sys->i_nb_channels, p_sys->pi_chan_table);
 374         }
 375     }
 376
 377     p_out_buf->i_nb_samples = p_in_buf->i_nb_samples;
 378     p_out_buf->i_nb_bytes = i_bytes_per_block * 6;
 379 }
 380
 381 /*****************************************************************************
 382  * Destroy : deallocate data structures
 383  *****************************************************************************/
 384 static void Destroy( vlc_object_t *p_this )
 385 {
 386     aout_filter_t *p_filter = (aout_filter_t *)p_this;
 387     filter_sys_t *p_sys = (filter_sys_t *)p_filter->p_sys;
 388
 389     a52_free( p_sys->p_liba52 );
 390     free( p_sys );
 391 }
 392
 393 /*****************************************************************************
 394  * OpenFilter:
 395  *****************************************************************************/
 396 static int OpenFilter( vlc_object_t *p_this )
 397 {
 398     filter_t *p_filter = (filter_t *)p_this;
 399     filter_sys_t *p_sys;
 400     int i_ret;
 401
 402     if( p_filter->fmt_in.i_codec != VLC_FOURCC('a','5','2',' ')  )
 403     {
 404         return VLC_EGENERIC;
 405     }
 406
 407     p_filter->fmt_out.audio.i_format =
 408         p_filter->fmt_out.i_codec = VLC_FOURCC('f','l','3','2');
 409
 410     /* Allocate the memory needed to store the module's structure */
 411     p_sys = p_filter->p_sys = malloc( sizeof(filter_sys_t) );
 412     if( p_sys == NULL )
 413     {
 414         msg_Err( p_filter, "out of memory" );
 415         return VLC_EGENERIC;
 416     }
 417
 418     /* Allocate the memory needed to store the module's structure */
 419     p_filter->p_sys = p_sys = malloc( sizeof(filter_sys_t) );
 420     if( p_sys == NULL )
 421     {
 422         msg_Err( p_filter, "out of memory" );
 423         return VLC_EGENERIC;
 424     }
 425
 426     i_ret = Open( VLC_OBJECT(p_filter), p_sys,
 427                   p_filter->fmt_in.audio, p_filter->fmt_out.audio );
 428
 429     p_filter->pf_audio_filter = Convert;
 430
 431     return i_ret;
 432 }
 433
 434 /*****************************************************************************
 435  * CloseFilter : deallocate data structures
 436  *****************************************************************************/
 437 static void CloseFilter( vlc_object_t *p_this )
 438 {
 439     filter_t *p_filter = (filter_t *)p_this;
 440     filter_sys_t *p_sys = p_filter->p_sys;
 441
 442     a52_free( p_sys->p_liba52 );
 443     free( p_sys );
 444 }
 445
 446 static block_t *Convert( filter_t *p_filter, block_t *p_block )
 447 {
 448     aout_filter_t aout_filter;
 449     aout_buffer_t in_buf, out_buf;
 450     block_t *p_out;
 451     int i_out_size;
 452
 453     if( !p_block || !p_block->i_samples )
 454     {
 455         if( p_block ) p_block->pf_release( p_block );
 456         return NULL;
 457     }
 458
 459     i_out_size = p_block->i_samples *
 460       p_filter->fmt_out.audio.i_bitspersample *
 461         p_filter->fmt_out.audio.i_channels / 8;
 462
 463     p_out = p_filter->pf_audio_buffer_new( p_filter, i_out_size );
 464     if( !p_out )
 465     {
 466         msg_Warn( p_filter, "can't get output buffer" );
 467         p_block->pf_release( p_block );
 468         return NULL;
 469     }
 470
 471     p_out->i_samples = p_block->i_samples;
 472     p_out->i_dts = p_block->i_dts;
 473     p_out->i_pts = p_block->i_pts;
 474     p_out->i_length = p_block->i_length;
 475
 476     aout_filter.p_sys = (struct aout_filter_sys_t *)p_filter->p_sys;
 477     aout_filter.input = p_filter->fmt_in.audio;
 478     aout_filter.input.i_format = p_filter->fmt_in.i_codec;
 479     aout_filter.output = p_filter->fmt_out.audio;
 480     aout_filter.output.i_format = p_filter->fmt_out.i_codec;
 481
 482     in_buf.p_buffer = p_block->p_buffer;
 483     in_buf.i_nb_bytes = p_block->i_buffer;
 484     in_buf.i_nb_samples = p_block->i_samples;
 485     out_buf.p_buffer = p_out->p_buffer;
 486     out_buf.i_nb_bytes = p_out->i_buffer;
 487     out_buf.i_nb_samples = p_out->i_samples;
 488
 489     DoWork( (aout_instance_t *)p_filter, &aout_filter, &in_buf, &out_buf );
 490
 491     p_out->i_buffer = out_buf.i_nb_bytes;
 492     p_out->i_samples = out_buf.i_nb_samples;
 493
 494     p_block->pf_release( p_block );
 495
 496     return p_out;
 497 }