1 /*****************************************************************************
2 * aout_internal.h : internal defines for audio output
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: aout_internal.h,v 1.41 2003/10/27 21:54:10 gbazin Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
25 * aout_alloc_t : allocation of memory in the audio output
26 *****************************************************************************/
27 typedef struct aout_alloc_t
33 #define AOUT_ALLOC_NONE 0
34 #define AOUT_ALLOC_STACK 1
35 #define AOUT_ALLOC_HEAP 2
38 # define ALLOCA_TEST( p_alloc, p_new_buffer ) \
39 if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_STACK ) \
41 (p_new_buffer) = alloca( i_alloc_size + sizeof(aout_buffer_t) );\
45 # define ALLOCA_TEST( p_alloc, p_new_buffer )
48 #define aout_BufferAlloc( p_alloc, i_nb_usec, p_previous_buffer, \
50 if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_NONE ) \
52 (p_new_buffer) = p_previous_buffer; \
57 i_alloc_size = (int)( (uint64_t)(p_alloc)->i_bytes_per_sec \
58 * (i_nb_usec) / 1000000 + 1 ); \
59 ALLOCA_TEST( p_alloc, p_new_buffer ) \
61 (p_new_buffer) = malloc( i_alloc_size + sizeof(aout_buffer_t) );\
63 if ( p_new_buffer != NULL ) \
65 (p_new_buffer)->i_alloc_type = (p_alloc)->i_alloc_type; \
66 (p_new_buffer)->i_size = i_alloc_size; \
67 (p_new_buffer)->p_buffer = (byte_t *)(p_new_buffer) \
68 + sizeof(aout_buffer_t); \
69 if ( (p_previous_buffer) != NULL ) \
71 (p_new_buffer)->start_date = \
72 ((aout_buffer_t *)p_previous_buffer)->start_date;\
73 (p_new_buffer)->end_date = \
74 ((aout_buffer_t *)p_previous_buffer)->end_date; \
77 /* we'll keep that for a while --Meuuh */ \
78 /* else printf("%s:%d\n", __FILE__, __LINE__); */ \
81 #define aout_BufferFree( p_buffer ) \
82 if ( (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP ) \
87 /*****************************************************************************
88 * aout_fifo_t : audio output buffer FIFO
89 *****************************************************************************/
92 aout_buffer_t * p_first;
93 aout_buffer_t ** pp_last;
94 audio_date_t end_date;
97 /*****************************************************************************
98 * aout_filter_t : audio output filter
99 *****************************************************************************/
100 typedef struct aout_filter_t
104 audio_sample_format_t input;
105 audio_sample_format_t output;
106 aout_alloc_t output_alloc;
109 struct aout_filter_sys_t * p_sys;
110 void (* pf_do_work)( struct aout_instance_t *,
111 struct aout_filter_t *,
112 struct aout_buffer_t *,
113 struct aout_buffer_t * );
114 vlc_bool_t b_in_place;
115 vlc_bool_t b_continuity;
118 /*****************************************************************************
119 * aout_mixer_t : audio output mixer
120 *****************************************************************************/
121 typedef struct aout_mixer_t
123 audio_sample_format_t mixer;
124 aout_alloc_t output_alloc;
127 struct aout_mixer_sys_t * p_sys;
128 void (* pf_do_work)( struct aout_instance_t *,
129 struct aout_buffer_t * );
131 /* If b_error == 1, there is no mixer. */
133 /* Multiplier used to raise or lower the volume of the sound in
134 * software. Beware, this creates sound distortion and should be avoided
135 * as much as possible. This isn't available for non-float32 mixer. */
139 /*****************************************************************************
140 * aout_input_t : input stream for the audio output
141 *****************************************************************************/
142 #define AOUT_RESAMPLING_NONE 0
143 #define AOUT_RESAMPLING_UP 1
144 #define AOUT_RESAMPLING_DOWN 2
147 /* When this lock is taken, the pipeline cannot be changed by a
151 audio_sample_format_t input;
152 aout_alloc_t input_alloc;
155 aout_filter_t * pp_filters[AOUT_MAX_FILTERS];
159 aout_filter_t * pp_resamplers[AOUT_MAX_FILTERS];
161 int i_resampling_type;
162 mtime_t i_resamp_start_date;
163 int i_resamp_start_drift;
167 /* Mixer information */
168 byte_t * p_first_byte_to_mix;
170 /* If b_error == 1, there is no input pipeline. */
173 /* Did we just change the output format? (expect buffer inconsistencies) */
174 vlc_bool_t b_changed;
176 /* internal caching delay from input */
178 /* desynchronisation delay request by the user */
183 /*****************************************************************************
184 * aout_output_t : output stream for the audio output
185 *****************************************************************************/
186 typedef struct aout_output_t
188 audio_sample_format_t output;
189 /* Indicates whether the audio output is currently starving, to avoid
190 * printing a 1,000 "output is starving" messages. */
191 vlc_bool_t b_starving;
194 aout_filter_t * pp_filters[AOUT_MAX_FILTERS];
199 struct module_t * p_module;
200 struct aout_sys_t * p_sys;
201 void (* pf_play)( aout_instance_t * );
202 int (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
203 int (* pf_volume_set )( aout_instance_t *, audio_volume_t );
204 int (* pf_volume_infos )( aout_instance_t *, audio_volume_t * );
207 /* Current volume for the output - it's just a placeholder, the plug-in
208 * may or may not use it. */
209 audio_volume_t i_volume;
211 /* If b_error == 1, there is no audio output pipeline. */
215 /*****************************************************************************
216 * aout_instance_t : audio output thread descriptor
217 *****************************************************************************/
218 struct aout_instance_t
222 /* Locks : please note that if you need several of these locks, it is
223 * mandatory (to avoid deadlocks) to take them in the following order :
224 * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
226 /* When input_fifos_lock is taken, none of the p_input->fifo structures
227 * can be read or modified by a third-party thread. */
228 vlc_mutex_t input_fifos_lock;
229 /* When mixer_lock is taken, all decoder threads willing to mix a
230 * buffer must wait until it is released. The output pipeline cannot
231 * be modified. No input stream can be added or removed. */
232 vlc_mutex_t mixer_lock;
233 /* When output_fifo_lock is taken, the p_aout->output.fifo structure
234 * cannot be read or written by a third-party thread. */
235 vlc_mutex_t output_fifo_lock;
237 /* Input streams & pre-filters */
238 aout_input_t * pp_inputs[AOUT_MAX_INPUTS];
245 aout_output_t output;
248 /*****************************************************************************
250 *****************************************************************************/
252 int aout_InputNew( aout_instance_t * p_aout, aout_input_t * p_input );
253 int aout_InputDelete( aout_instance_t * p_aout, aout_input_t * p_input );
254 int aout_InputPlay( aout_instance_t * p_aout, aout_input_t * p_input,
255 aout_buffer_t * p_buffer );
257 /* From filters.c : */
258 int aout_FiltersCreatePipeline( aout_instance_t * p_aout,
259 aout_filter_t ** pp_filters,
261 const audio_sample_format_t * p_input_format,
262 const audio_sample_format_t * p_output_format );
263 void aout_FiltersDestroyPipeline( aout_instance_t * p_aout,
264 aout_filter_t ** pp_filters,
266 void aout_FiltersHintBuffers( aout_instance_t * p_aout,
267 aout_filter_t ** pp_filters,
268 int i_nb_filters, aout_alloc_t * p_first_alloc );
269 void aout_FiltersPlay( aout_instance_t * p_aout,
270 aout_filter_t ** pp_filters,
271 int i_nb_filters, aout_buffer_t ** pp_input_buffer );
274 int aout_MixerNew( aout_instance_t * p_aout );
275 void aout_MixerDelete( aout_instance_t * p_aout );
276 void aout_MixerRun( aout_instance_t * p_aout );
277 int aout_MixerMultiplierSet( aout_instance_t * p_aout, float f_multiplier );
278 int aout_MixerMultiplierGet( aout_instance_t * p_aout, float * pf_multiplier );
280 /* From output.c : */
281 int aout_OutputNew( aout_instance_t * p_aout,
282 audio_sample_format_t * p_format );
283 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer );
284 void aout_OutputDelete( aout_instance_t * p_aout );
285 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, vlc_bool_t ) );
287 /* From common.c : */
288 VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) );
289 VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
290 VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
291 VLC_EXPORT( void, aout_FormatsPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format1, const audio_sample_format_t * p_format2 ) );
292 VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) );
293 void aout_FifoInit( aout_instance_t *, aout_fifo_t *, uint32_t );
294 mtime_t aout_FifoNextStart( aout_instance_t *, aout_fifo_t * );
295 void aout_FifoPush( aout_instance_t *, aout_fifo_t *, aout_buffer_t * );
296 void aout_FifoSet( aout_instance_t *, aout_fifo_t *, mtime_t );
297 void aout_FifoMoveDates( aout_instance_t *, aout_fifo_t *, mtime_t );
298 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
299 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo );
300 VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) );
303 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
304 int aout_VolumeSoftGet( aout_instance_t *, audio_volume_t * );
305 int aout_VolumeSoftSet( aout_instance_t *, audio_volume_t );
306 int aout_VolumeSoftInfos( aout_instance_t *, audio_volume_t * );
307 VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
308 int aout_VolumeNoneGet( aout_instance_t *, audio_volume_t * );
309 int aout_VolumeNoneSet( aout_instance_t *, audio_volume_t );
310 int aout_VolumeNoneInfos( aout_instance_t *, audio_volume_t * );