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