1 /*****************************************************************************
2 * aout_internal.h : internal defines for audio output
3 *****************************************************************************
4 * Copyright (C) 2002 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 /*****************************************************************************
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) );\
42 i_alloc_type = AOUT_ALLOC_STACK; \
46 # define ALLOCA_TEST( p_alloc, p_new_buffer )
49 #define aout_BufferAlloc( p_alloc, i_nb_usec, p_previous_buffer, \
51 if ( (p_alloc)->i_alloc_type == AOUT_ALLOC_NONE ) \
53 (p_new_buffer) = p_previous_buffer; \
57 int i_alloc_size, i_alloc_type; \
58 i_alloc_size = (int)( (uint64_t)(p_alloc)->i_bytes_per_sec \
59 * (i_nb_usec) / 1000000 + 1 ); \
60 ALLOCA_TEST( p_alloc, p_new_buffer ) \
62 (p_new_buffer) = malloc( i_alloc_size + sizeof(aout_buffer_t) );\
63 i_alloc_type = AOUT_ALLOC_HEAP; \
65 if ( p_new_buffer != NULL ) \
67 (p_new_buffer)->i_alloc_type = i_alloc_type; \
68 (p_new_buffer)->i_size = i_alloc_size; \
69 (p_new_buffer)->p_buffer = (byte_t *)(p_new_buffer) \
70 + sizeof(aout_buffer_t); \
71 if ( (p_previous_buffer) != NULL ) \
73 (p_new_buffer)->start_date = \
74 ((aout_buffer_t *)p_previous_buffer)->start_date;\
75 (p_new_buffer)->end_date = \
76 ((aout_buffer_t *)p_previous_buffer)->end_date; \
79 /* we'll keep that for a while --Meuuh */ \
80 /* else printf("%s:%d\n", __FILE__, __LINE__); */ \
83 #define aout_BufferFree( p_buffer ) \
84 if ( (p_buffer)->i_alloc_type == AOUT_ALLOC_HEAP ) \
89 /*****************************************************************************
90 * aout_fifo_t : audio output buffer FIFO
91 *****************************************************************************/
94 aout_buffer_t * p_first;
95 aout_buffer_t ** pp_last;
96 audio_date_t end_date;
99 /*****************************************************************************
100 * aout_filter_t : audio output filter
101 *****************************************************************************/
106 audio_sample_format_t input;
107 audio_sample_format_t output;
108 aout_alloc_t output_alloc;
111 struct aout_filter_sys_t * p_sys;
112 void (* pf_do_work)( struct aout_instance_t *,
113 struct aout_filter_t *,
114 struct aout_buffer_t *,
115 struct aout_buffer_t * );
116 vlc_bool_t b_in_place;
117 vlc_bool_t b_continuity;
120 /*****************************************************************************
121 * aout_mixer_t : audio output mixer
122 *****************************************************************************/
123 typedef struct aout_mixer_t
125 audio_sample_format_t mixer;
126 aout_alloc_t output_alloc;
129 struct aout_mixer_sys_t * p_sys;
130 void (* pf_do_work)( struct aout_instance_t *,
131 struct aout_buffer_t * );
133 /* If b_error == 1, there is no mixer. */
135 /* Multiplier used to raise or lower the volume of the sound in
136 * software. Beware, this creates sound distortion and should be avoided
137 * as much as possible. This isn't available for non-float32 mixer. */
141 /*****************************************************************************
142 * aout_input_t : input stream for the audio output
143 *****************************************************************************/
144 #define AOUT_RESAMPLING_NONE 0
145 #define AOUT_RESAMPLING_UP 1
146 #define AOUT_RESAMPLING_DOWN 2
149 /* When this lock is taken, the pipeline cannot be changed by a
153 /* The input thread that spawned this input */
154 input_thread_t *p_input_thread;
156 audio_sample_format_t input;
157 aout_alloc_t input_alloc;
160 aout_filter_t * pp_filters[AOUT_MAX_FILTERS];
164 aout_filter_t * pp_resamplers[AOUT_MAX_FILTERS];
166 int i_resampling_type;
167 mtime_t i_resamp_start_date;
168 int i_resamp_start_drift;
172 /* Mixer information */
173 byte_t * p_first_byte_to_mix;
175 /* If b_restart == 1, the input pipeline will be re-created. */
176 vlc_bool_t b_restart;
178 /* If b_error == 1, there is no input pipeline. */
181 /* Did we just change the output format? (expect buffer inconsistencies) */
182 vlc_bool_t b_changed;
184 /* internal caching delay from input */
186 /* desynchronisation delay request by the user */
191 /*****************************************************************************
192 * aout_output_t : output stream for the audio output
193 *****************************************************************************/
194 typedef struct aout_output_t
196 audio_sample_format_t output;
197 /* Indicates whether the audio output is currently starving, to avoid
198 * printing a 1,000 "output is starving" messages. */
199 vlc_bool_t b_starving;
202 aout_filter_t * pp_filters[AOUT_MAX_FILTERS];
207 struct module_t * p_module;
208 struct aout_sys_t * p_sys;
209 void (* pf_play)( aout_instance_t * );
210 int (* pf_volume_get )( aout_instance_t *, audio_volume_t * );
211 int (* pf_volume_set )( aout_instance_t *, audio_volume_t );
212 int (* pf_volume_infos )( aout_instance_t *, audio_volume_t * );
215 /* Current volume for the output - it's just a placeholder, the plug-in
216 * may or may not use it. */
217 audio_volume_t i_volume;
219 /* If b_error == 1, there is no audio output pipeline. */
223 /*****************************************************************************
224 * aout_instance_t : audio output thread descriptor
225 *****************************************************************************/
226 struct aout_instance_t
230 /* Locks : please note that if you need several of these locks, it is
231 * mandatory (to avoid deadlocks) to take them in the following order :
232 * mixer_lock, p_input->lock, output_fifo_lock, input_fifos_lock.
234 /* When input_fifos_lock is taken, none of the p_input->fifo structures
235 * can be read or modified by a third-party thread. */
236 vlc_mutex_t input_fifos_lock;
237 /* When mixer_lock is taken, all decoder threads willing to mix a
238 * buffer must wait until it is released. The output pipeline cannot
239 * be modified. No input stream can be added or removed. */
240 vlc_mutex_t mixer_lock;
241 /* When output_fifo_lock is taken, the p_aout->output.fifo structure
242 * cannot be read or written by a third-party thread. */
243 vlc_mutex_t output_fifo_lock;
245 /* Input streams & pre-filters */
246 aout_input_t * pp_inputs[AOUT_MAX_INPUTS];
253 aout_output_t output;
256 /*****************************************************************************
258 *****************************************************************************/
260 int aout_InputNew( aout_instance_t * p_aout, aout_input_t * p_input );
261 int aout_InputDelete( aout_instance_t * p_aout, aout_input_t * p_input );
262 int aout_InputPlay( aout_instance_t * p_aout, aout_input_t * p_input,
263 aout_buffer_t * p_buffer );
265 /* From filters.c : */
266 VLC_EXPORT( int, aout_FiltersCreatePipeline, ( aout_instance_t * p_aout, aout_filter_t ** pp_filters, int * pi_nb_filters, const audio_sample_format_t * p_input_format, const audio_sample_format_t * p_output_format ) );
267 VLC_EXPORT( void, aout_FiltersDestroyPipeline, ( aout_instance_t * p_aout, aout_filter_t ** pp_filters, int i_nb_filters ) );
268 VLC_EXPORT( void, aout_FiltersPlay, ( aout_instance_t * p_aout, aout_filter_t ** pp_filters, int i_nb_filters, aout_buffer_t ** pp_input_buffer ) );
269 void aout_FiltersHintBuffers( aout_instance_t * p_aout, aout_filter_t ** pp_filters, int i_nb_filters, aout_alloc_t * p_first_alloc );
272 int aout_MixerNew( aout_instance_t * p_aout );
273 void aout_MixerDelete( aout_instance_t * p_aout );
274 void aout_MixerRun( aout_instance_t * p_aout );
275 int aout_MixerMultiplierSet( aout_instance_t * p_aout, float f_multiplier );
276 int aout_MixerMultiplierGet( aout_instance_t * p_aout, float * pf_multiplier );
278 /* From output.c : */
279 int aout_OutputNew( aout_instance_t * p_aout,
280 audio_sample_format_t * p_format );
281 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer );
282 void aout_OutputDelete( aout_instance_t * p_aout );
283 VLC_EXPORT( aout_buffer_t *, aout_OutputNextBuffer, ( aout_instance_t *, mtime_t, vlc_bool_t ) );
285 /* From common.c : */
286 VLC_EXPORT( unsigned int, aout_FormatNbChannels, ( const audio_sample_format_t * p_format ) );
287 VLC_EXPORT( void, aout_FormatPrepare, ( audio_sample_format_t * p_format ) );
288 VLC_EXPORT( void, aout_FormatPrint, ( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format ) );
289 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 ) );
290 VLC_EXPORT( const char *, aout_FormatPrintChannels, ( const audio_sample_format_t * ) );
291 void aout_FifoInit( aout_instance_t *, aout_fifo_t *, uint32_t );
292 mtime_t aout_FifoNextStart( aout_instance_t *, aout_fifo_t * );
293 void aout_FifoPush( aout_instance_t *, aout_fifo_t *, aout_buffer_t * );
294 void aout_FifoSet( aout_instance_t *, aout_fifo_t *, mtime_t );
295 void aout_FifoMoveDates( aout_instance_t *, aout_fifo_t *, mtime_t );
296 VLC_EXPORT( aout_buffer_t *, aout_FifoPop, ( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) );
297 void aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo );
298 VLC_EXPORT( mtime_t, aout_FifoFirstDate, ( aout_instance_t *, aout_fifo_t * ) );
301 VLC_EXPORT( void, aout_VolumeSoftInit, ( aout_instance_t * ) );
302 int aout_VolumeSoftGet( aout_instance_t *, audio_volume_t * );
303 int aout_VolumeSoftSet( aout_instance_t *, audio_volume_t );
304 int aout_VolumeSoftInfos( aout_instance_t *, audio_volume_t * );
305 VLC_EXPORT( void, aout_VolumeNoneInit, ( aout_instance_t * ) );
306 int aout_VolumeNoneGet( aout_instance_t *, audio_volume_t * );
307 int aout_VolumeNoneSet( aout_instance_t *, audio_volume_t );
308 int aout_VolumeNoneInfos( aout_instance_t *, audio_volume_t * );