include/vlc_aout.h

   1 /*****************************************************************************
   2  * audio_output.h : audio output interface
   3  *****************************************************************************
   4  * Copyright (C) 2002-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #if !defined( __LIBVLC__ )
  25   #error You are not libvlc or one of its plugins. You cannot include this file
  26 #endif
  27
  28 #ifndef _VLC_AOUT_H
  29 #define _VLC_AOUT_H 1
  30
  31 # ifdef __cplusplus
  32 extern "C" {
  33 # endif
  34
  35 #include "vlc_es.h"
  36
  37 #define AOUT_FMTS_IDENTICAL( p_first, p_second ) (                          \
  38     ((p_first)->i_format == (p_second)->i_format)                           \
  39       && ((p_first)->i_rate == (p_second)->i_rate)                          \
  40       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
  41       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
  42
  43 /* Check if i_rate == i_rate and i_channels == i_channels */
  44 #define AOUT_FMTS_SIMILAR( p_first, p_second ) (                            \
  45     ((p_first)->i_rate == (p_second)->i_rate)                               \
  46       && ((p_first)->i_physical_channels == (p_second)->i_physical_channels)\
  47       && ((p_first)->i_original_channels == (p_second)->i_original_channels) )
  48
  49 #ifdef WORDS_BIGENDIAN
  50 #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','b')
  51 #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','b')
  52 #   define AOUT_FMT_S24_NE VLC_FOURCC('s','2','4','b')
  53 #   define AOUT_FMT_SPDIF_NE VLC_FOURCC('s','p','d','b')
  54 #else
  55 #   define AOUT_FMT_S16_NE VLC_FOURCC('s','1','6','l')
  56 #   define AOUT_FMT_U16_NE VLC_FOURCC('u','1','6','l')
  57 #   define AOUT_FMT_S24_NE VLC_FOURCC('s','2','4','l')
  58 #   define AOUT_FMT_SPDIF_NE VLC_FOURCC('s','p','d','i')
  59 #endif
  60
  61 #define AOUT_FMT_NON_LINEAR( p_format )                                    \
  62     ( ((p_format)->i_format == VLC_FOURCC('s','p','d','i'))                \
  63        || ((p_format)->i_format == VLC_FOURCC('s','p','d','b'))            \
  64        || ((p_format)->i_format == VLC_FOURCC('a','5','2',' '))            \
  65        || ((p_format)->i_format == VLC_FOURCC('d','t','s',' ')) )
  66
  67 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
  68 /*
  69  * Fixed-point format: 0xABBBBBBB
  70  * A == whole part      (sign + 3 bits)
  71  * B == fractional part (28 bits)
  72  *
  73  * Values are signed two's complement, so the effective range is:
  74  * 0x80000000 to 0x7fffffff
  75  *       -8.0 to +7.9999999962747097015380859375
  76  *
  77  * The smallest representable value is:
  78  * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
  79  *
  80  * 28 bits of fractional accuracy represent about
  81  * 8.6 digits of decimal accuracy.
  82  *
  83  * Fixed-point numbers can be added or subtracted as normal
  84  * integers, but multiplication requires shifting the 64-bit result
  85  * from 56 fractional bits back to 28 (and rounding.)
  86  */
  87 typedef int32_t vlc_fixed_t;
  88 #define FIXED32_FRACBITS 28
  89 #define FIXED32_MIN ((vlc_fixed_t) -0x80000000L)
  90 #define FIXED32_MAX ((vlc_fixed_t) +0x7fffffffL)
  91 #define FIXED32_ONE ((vlc_fixed_t) 0x10000000)
  92
  93
  94 /*
  95  * Channels descriptions
  96  */
  97
  98 /* Values available for physical and original channels */
  99 #define AOUT_CHAN_CENTER            0x1
 100 #define AOUT_CHAN_LEFT              0x2
 101 #define AOUT_CHAN_RIGHT             0x4
 102 #define AOUT_CHAN_REARCENTER        0x10
 103 #define AOUT_CHAN_REARLEFT          0x20
 104 #define AOUT_CHAN_REARRIGHT         0x40
 105 #define AOUT_CHAN_MIDDLELEFT        0x100
 106 #define AOUT_CHAN_MIDDLERIGHT       0x200
 107 #define AOUT_CHAN_LFE               0x1000
 108
 109 /* Values available for original channels only */
 110 #define AOUT_CHAN_DOLBYSTEREO       0x10000
 111 #define AOUT_CHAN_DUALMONO          0x20000
 112 #define AOUT_CHAN_REVERSESTEREO     0x40000
 113
 114 #define AOUT_CHAN_PHYSMASK          0xFFFF
 115 #define AOUT_CHAN_MAX               9
 116
 117 /* Values used for the audio-device and audio-channels object variables */
 118 #define AOUT_VAR_MONO               1
 119 #define AOUT_VAR_STEREO             2
 120 #define AOUT_VAR_2F2R               4
 121 #define AOUT_VAR_3F2R               5
 122 #define AOUT_VAR_5_1                6
 123 #define AOUT_VAR_6_1                7
 124 #define AOUT_VAR_7_1                8
 125 #define AOUT_VAR_SPDIF              10
 126
 127 #define AOUT_VAR_CHAN_STEREO        1
 128 #define AOUT_VAR_CHAN_RSTEREO       2
 129 #define AOUT_VAR_CHAN_LEFT          3
 130 #define AOUT_VAR_CHAN_RIGHT         4
 131 #define AOUT_VAR_CHAN_DOLBYS        5
 132
 133 /*****************************************************************************
 134  * Main audio output structures
 135  *****************************************************************************/
 136
 137 /** audio output buffer */
 138 struct aout_buffer_t
 139 {
 140     byte_t *                p_buffer;
 141     int                     i_alloc_type;
 142     /* i_size is the real size of the buffer (used for debug ONLY), i_nb_bytes
 143      * is the number of significative bytes in it. */
 144     size_t                  i_size, i_nb_bytes;
 145     unsigned int            i_nb_samples;
 146     mtime_t                 start_date, end_date;
 147     bool              b_discontinuity; /* Set on discontinuity (for non pcm stream) */
 148
 149     struct aout_buffer_t *  p_next;
 150
 151     /** Private data (aout_buffer_t will disappear soon so no need for an
 152      * aout_buffer_sys_t type) */
 153     void * p_sys;
 154
 155     /** This way the release can be overloaded */
 156     void (*pf_release)( aout_buffer_t * );
 157 };
 158
 159 #define aout_BufferFree( p_buffer ) do {                                    \
 160     if( p_buffer != NULL && (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP )   \
 161     {                                                                       \
 162         free( p_buffer );                                                   \
 163     }                                                                       \
 164     p_buffer = NULL; } while(0)
 165
 166 /* Size of a frame for S/PDIF output. */
 167 #define AOUT_SPDIF_SIZE 6144
 168
 169 /* Number of samples in an A/52 frame. */
 170 #define A52_FRAME_NB 1536
 171
 172 /* Max input rate factor (1/4 -> 4) */
 173 #define AOUT_MAX_INPUT_RATE (4)
 174
 175 /** date incrementation helper structure without long-term
 176  * rounding errors
 177  */
 178 struct audio_date_t
 179 {
 180     mtime_t  date;
 181     uint32_t i_divider;
 182     uint32_t i_remainder;
 183 };
 184
 185 /** allocation of memory in the audio output */
 186 typedef struct aout_alloc_t
 187 {
 188     int                     i_alloc_type;
 189     int                     i_bytes_per_sec;
 190 } aout_alloc_t;
 191
 192 #define AOUT_ALLOC_NONE     0
 193 #define AOUT_ALLOC_STACK    1
 194 #define AOUT_ALLOC_HEAP     2
 195
 196 /** audio output mixer */
 197 typedef struct aout_mixer_t
 198 {
 199     audio_sample_format_t   mixer;
 200     aout_alloc_t            output_alloc;
 201
 202     module_t *              p_module;
 203     struct aout_mixer_sys_t * p_sys;
 204     void                 (* pf_do_work)( struct aout_instance_t *,
 205                                          struct aout_buffer_t * );
 206
 207     /** If b_error == 1, there is no mixer. */
 208     bool              b_error;
 209     /** Multiplier used to raise or lower the volume of the sound in
 210      * software. Beware, this creates sound distortion and should be avoided
 211      * as much as possible. This isn't available for non-float32 mixer. */
 212     float                   f_multiplier;
 213 } aout_mixer_t;
 214
 215 /** audio output buffer FIFO */
 216 struct aout_fifo_t
 217 {
 218     aout_buffer_t *         p_first;
 219     aout_buffer_t **        pp_last;
 220     audio_date_t            end_date;
 221 };
 222
 223 /** audio output filter */
 224 struct aout_filter_t
 225 {
 226     VLC_COMMON_MEMBERS
 227
 228     audio_sample_format_t   input;
 229     audio_sample_format_t   output;
 230     aout_alloc_t            output_alloc;
 231
 232     module_t *              p_module;
 233     struct aout_filter_sys_t * p_sys;
 234     void                 (* pf_do_work)( struct aout_instance_t *,
 235                                          struct aout_filter_t *,
 236                                          struct aout_buffer_t *,
 237                                          struct aout_buffer_t * );
 238     bool              b_in_place;
 239     bool              b_continuity;
 240 };
 241
 242 #define AOUT_RESAMPLING_NONE     0
 243 #define AOUT_RESAMPLING_UP       1
 244 #define AOUT_RESAMPLING_DOWN     2
 245 /** an input stream for the audio output */
 246 struct aout_input_t
 247 {
 248     /* When this lock is taken, the pipeline cannot be changed by a
 249      * third-party. */
 250     vlc_mutex_t             lock;
 251
 252     /* The input thread that spawned this input */
 253     input_thread_t         *p_input_thread;
 254
 255     audio_sample_format_t   input;
 256     aout_alloc_t            input_alloc;
 257
 258     /* pre-filters */
 259     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
 260     int                     i_nb_filters;
 261
 262     /* resamplers */
 263     aout_filter_t *         pp_resamplers[AOUT_MAX_FILTERS];
 264     int                     i_nb_resamplers;
 265     int                     i_resampling_type;
 266     mtime_t                 i_resamp_start_date;
 267     int                     i_resamp_start_drift;
 268
 269     aout_fifo_t             fifo;
 270
 271     /* Mixer information */
 272     byte_t *                p_first_byte_to_mix;
 273     audio_replay_gain_t     replay_gain;
 274     float                   f_multiplier;
 275
 276     /* If b_restart == 1, the input pipeline will be re-created. */
 277     bool              b_restart;
 278
 279     /* If b_error == 1, there is no input pipeline. */
 280     bool              b_error;
 281
 282     /* Did we just change the output format? (expect buffer inconsistencies) */
 283     bool              b_changed;
 284
 285     /* last rate from input */
 286     int                     i_last_input_rate;
 287     /* internal caching delay from input */
 288     int                     i_pts_delay;
 289     /* desynchronisation delay request by the user */
 290     int                     i_desync;
 291
 292 };
 293
 294 /** an output stream for the audio output */
 295 typedef struct aout_output_t
 296 {
 297     audio_sample_format_t   output;
 298     /* Indicates whether the audio output is currently starving, to avoid
 299      * printing a 1,000 "output is starving" messages. */
 300     bool              b_starving;
 301
 302     /* post-filters */
 303     aout_filter_t *         pp_filters[AOUT_MAX_FILTERS];
 304     int                     i_nb_filters;
 305
 306     aout_fifo_t             fifo;
 307
 308     struct module_t *       p_module;
 309     struct aout_sys_t *     p_sys;
 310     void                 (* pf_play)( aout_instance_t * );
 311     int                  (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
 312     int                  (* pf_volume_set )( aout_instance_t *, audio_volume_t );
 313     int                  (* pf_volume_infos )( aout_instance_t *, audio_volume_t * );
 314     int                     i_nb_samples;
 315
 316     /* Current volume for the output - it's just a placeholder, the plug-in
 317      * may or may not use it. */
 318     audio_volume_t          i_volume;
 319
 320     /* If b_error == 1, there is no audio output pipeline. */
 321     bool              b_error;
 322 } aout_output_t;
 323
 324 /** audio output thread descriptor */
 325 struct aout_instance_t
 326 {
 327     VLC_COMMON_MEMBERS
 328
 329     /* Locks : please note that if you need several of these locks, it is
 330      * mandatory (to avoid deadlocks) to take them in the following order :
 331      * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
 332      * --Meuuh */
 333     /* When input_fifos_lock is taken, none of the p_input->fifo structures
 334      * can be read or modified by a third-party thread. */
 335     vlc_mutex_t             input_fifos_lock;
 336     /* When mixer_lock is taken, all decoder threads willing to mix a
 337      * buffer must wait until it is released. The output pipeline cannot
 338      * be modified. No input stream can be added or removed. */
 339     vlc_mutex_t             mixer_lock;
 340     /* When output_fifo_lock is taken, the p_aout->output.fifo structure
 341      * cannot be read or written  by a third-party thread. */
 342     vlc_mutex_t             output_fifo_lock;
 343
 344     /* Input streams & pre-filters */
 345     aout_input_t *          pp_inputs[AOUT_MAX_INPUTS];
 346     int                     i_nb_inputs;
 347
 348     /* Mixer */
 349     aout_mixer_t            mixer;
 350
 351     /* Output plug-in */
 352     aout_output_t           output;
 353 };
 354
 355 /*****************************************************************************
 356  * Prototypes
 357  *****************************************************************************/
 358
 359 /* From common.c : */
 360 VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
 361 VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
 362 VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
 363 VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
 364 VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
 365
 366 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, bool ) );
 367
 368 VLC_EXPORT( int, aout_CheckChannelReorder, ( const uint32_t *, const uint32_t *, uint32_t, int, int * ) );
 369 VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );
 370
 371 VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) );
 372 VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
 373 VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
 374 VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) );
 375
 376 VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) );
 377 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
 378
 379 /* From intf.c : */
 380 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
 381 VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
 382 #define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
 383 VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
 384 #define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
 385 VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
 386 #define aout_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
 387 VLC_EXPORT( int, __aout_VolumeInfos, ( vlc_object_t *, audio_volume_t * ) );
 388 #define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
 389 VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
 390 #define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
 391 VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
 392 #define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
 393 VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
 394 VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 395 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
 396
 397 VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, bool ));
 398
 399 #define aout_VisualNext(a) aout_VisualChange( VLC_OBJECT(a),1 )
 400 #define aout_VisualPrev(a) aout_VisualChange( VLC_OBJECT(a),-1 )
 401
 402 VLC_EXPORT( char *, aout_VisualChange, (vlc_object_t *, int ) );
 403
 404 # ifdef __cplusplus
 405 }
 406 # endif
 407
 408 #endif /* _VLC_AOUT_H */