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