1 /*****************************************************************************
2 * audio_output.h : audio output interface
3 *****************************************************************************
4 * Copyright (C) 2002-2005 the VideoLAN team
7 * Authors: Christophe Massiot <massiot@via.ecp.fr>
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.
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.
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 *****************************************************************************/
24 #if !defined( __LIBVLC__ )
25 #error You are not libvlc or one of its plugins. You cannot include this file
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) )
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) )
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')
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')
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',' ')) )
67 /* This is heavily borrowed from libmad, by Robert Leslie <rob@mars.org> */
69 * Fixed-point format: 0xABBBBBBB
70 * A == whole part (sign + 3 bits)
71 * B == fractional part (28 bits)
73 * Values are signed two's complement, so the effective range is:
74 * 0x80000000 to 0x7fffffff
75 * -8.0 to +7.9999999962747097015380859375
77 * The smallest representable value is:
78 * 0x00000001 == 0.0000000037252902984619140625 (i.e. about 3.725e-9)
80 * 28 bits of fractional accuracy represent about
81 * 8.6 digits of decimal accuracy.
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.)
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)
95 * Channels descriptions
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
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
114 #define AOUT_CHAN_PHYSMASK 0xFFFF
115 #define AOUT_CHAN_MAX 9
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
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
133 /*****************************************************************************
134 * Main audio output structures
135 *****************************************************************************/
137 /** audio output buffer */
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;
148 struct aout_buffer_t * p_next;
150 /** Private data (aout_buffer_t will disappear soon so no need for an
151 * aout_buffer_sys_t type) */
154 /** This way the release can be overloaded */
155 void (*pf_release)( aout_buffer_t * );
158 #define aout_BufferFree( p_buffer ) \
159 if( p_buffer != NULL && (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP ) \
165 /* Size of a frame for S/PDIF output. */
166 #define AOUT_SPDIF_SIZE 6144
168 /* Number of samples in an A/52 frame. */
169 #define A52_FRAME_NB 1536
171 /** date incrementation helper structure without long-term
178 uint32_t i_remainder;
181 /** allocation of memory in the audio output */
182 typedef struct aout_alloc_t
188 #define AOUT_ALLOC_NONE 0
189 #define AOUT_ALLOC_STACK 1
190 #define AOUT_ALLOC_HEAP 2
192 /** audio output mixer */
193 typedef struct aout_mixer_t
195 audio_sample_format_t mixer;
196 aout_alloc_t output_alloc;
199 struct aout_mixer_sys_t * p_sys;
200 void (* pf_do_work)( struct aout_instance_t *,
201 struct aout_buffer_t * );
203 /** If b_error == 1, there is no mixer. */
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. */
211 /** audio output buffer FIFO */
214 aout_buffer_t * p_first;
215 aout_buffer_t ** pp_last;
216 audio_date_t end_date;
219 /** audio output filter */
224 audio_sample_format_t input;
225 audio_sample_format_t output;
226 aout_alloc_t output_alloc;
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 vlc_bool_t b_in_place;
235 vlc_bool_t b_continuity;
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 */
244 /* When this lock is taken, the pipeline cannot be changed by a
248 /* The input thread that spawned this input */
249 input_thread_t *p_input_thread;
251 audio_sample_format_t input;
252 aout_alloc_t input_alloc;
255 aout_filter_t * pp_filters[AOUT_MAX_FILTERS];
259 aout_filter_t * pp_resamplers[AOUT_MAX_FILTERS];
261 int i_resampling_type;
262 mtime_t i_resamp_start_date;
263 int i_resamp_start_drift;
267 /* Mixer information */
268 byte_t * p_first_byte_to_mix;
270 /* If b_restart == 1, the input pipeline will be re-created. */
271 vlc_bool_t b_restart;
273 /* If b_error == 1, there is no input pipeline. */
276 /* Did we just change the output format? (expect buffer inconsistencies) */
277 vlc_bool_t b_changed;
279 /* internal caching delay from input */
281 /* desynchronisation delay request by the user */
286 /** an output stream for the audio output */
287 typedef struct aout_output_t
289 audio_sample_format_t output;
290 /* Indicates whether the audio output is currently starving, to avoid
291 * printing a 1,000 "output is starving" messages. */
292 vlc_bool_t b_starving;
295 aout_filter_t * pp_filters[AOUT_MAX_FILTERS];
300 struct module_t * p_module;
301 struct aout_sys_t * p_sys;
302 void (* pf_play)( aout_instance_t * );
303 int (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
304 int (* pf_volume_set )( aout_instance_t *, audio_volume_t );
305 int (* pf_volume_infos )( aout_instance_t *, audio_volume_t * );
308 /* Current volume for the output - it's just a placeholder, the plug-in
309 * may or may not use it. */
310 audio_volume_t i_volume;
312 /* If b_error == 1, there is no audio output pipeline. */
316 /** audio output thread descriptor */
317 struct aout_instance_t
321 /* Locks : please note that if you need several of these locks, it is
322 * mandatory (to avoid deadlocks) to take them in the following order :
323 * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
325 /* When input_fifos_lock is taken, none of the p_input->fifo structures
326 * can be read or modified by a third-party thread. */
327 vlc_mutex_t input_fifos_lock;
328 /* When mixer_lock is taken, all decoder threads willing to mix a
329 * buffer must wait until it is released. The output pipeline cannot
330 * be modified. No input stream can be added or removed. */
331 vlc_mutex_t mixer_lock;
332 /* When output_fifo_lock is taken, the p_aout->output.fifo structure
333 * cannot be read or written by a third-party thread. */
334 vlc_mutex_t output_fifo_lock;
336 /* Input streams & pre-filters */
337 aout_input_t * pp_inputs[AOUT_MAX_INPUTS];
344 aout_output_t output;
347 /*****************************************************************************
349 *****************************************************************************/
351 /* From common.c : */
352 VLC_EXPORT( void, aout_DateInit, ( audio_date_t *, uint32_t ) );
353 VLC_EXPORT( void, aout_DateSet, ( audio_date_t *, mtime_t ) );
354 VLC_EXPORT( void, aout_DateMove, ( audio_date_t *, mtime_t ) );
355 VLC_EXPORT( mtime_t, aout_DateGet, ( const audio_date_t * ) );
356 VLC_EXPORT( mtime_t, aout_DateIncrement, ( audio_date_t *, uint32_t ) );
358 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, vlc_bool_t ) );
360 VLC_EXPORT( int, aout_CheckChannelReorder, ( const uint32_t *, const uint32_t *, uint32_t, int, int * ) );
361 VLC_EXPORT( void, aout_ChannelReorder, ( uint8_t *, int, int, const int *, int ) );
363 VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) );
364 VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
365 VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
366 VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) );
368 VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) );
369 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
372 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
373 VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
374 #define aout_VolumeGet(a, b) __aout_VolumeGet(VLC_OBJECT(a), b)
375 VLC_EXPORT( int, __aout_VolumeGet, ( vlc_object_t *, audio_volume_t * ) );
376 #define aout_VolumeSet(a, b) __aout_VolumeSet(VLC_OBJECT(a), b)
377 VLC_EXPORT( int, __aout_VolumeSet, ( vlc_object_t *, audio_volume_t ) );
378 #define aout_VolumeInfos(a, b) __aout_VolumeInfos(VLC_OBJECT(a), b)
379 VLC_EXPORT( int, __aout_VolumeInfos, ( vlc_object_t *, audio_volume_t * ) );
380 #define aout_VolumeUp(a, b, c) __aout_VolumeUp(VLC_OBJECT(a), b, c)
381 VLC_EXPORT( int, __aout_VolumeUp, ( vlc_object_t *, int, audio_volume_t * ) );
382 #define aout_VolumeDown(a, b, c) __aout_VolumeDown(VLC_OBJECT(a), b, c)
383 VLC_EXPORT( int, __aout_VolumeDown, ( vlc_object_t *, int, audio_volume_t * ) );
384 #define aout_VolumeMute(a, b) __aout_VolumeMute(VLC_OBJECT(a), b)
385 VLC_EXPORT( int, __aout_VolumeMute, ( vlc_object_t *, audio_volume_t * ) );
386 VLC_EXPORT( int, aout_Restart, ( aout_instance_t * p_aout ) );
387 VLC_EXPORT( int, aout_FindAndRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
388 VLC_EXPORT( int, aout_ChannelsRestart, ( vlc_object_t *, const char *, vlc_value_t, vlc_value_t, void * ) );
390 VLC_EXPORT( void, aout_EnableFilter, (vlc_object_t *, const char *, vlc_bool_t ));
392 #define aout_VisualNext(a) aout_VisualChange( VLC_OBJECT(a),1 )
393 #define aout_VisualPrev(a) aout_VisualChange( VLC_OBJECT(a),-1 )
395 VLC_EXPORT( char *, aout_VisualChange, (vlc_object_t *, int ) );
401 #endif /* _VLC_AOUT_H */