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