1 /*****************************************************************************
2 * intf.c : audio output API towards the interface modules
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: intf.c,v 1.8 2002/11/14 22:38:48 massiot 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 /*****************************************************************************
26 *****************************************************************************/
27 #include <stdlib.h> /* calloc(), malloc(), free() */
32 #include "audio_output.h"
33 #include "aout_internal.h"
39 * The hardware volume cannot be set if the output module gets deleted, so
40 * we must take the mixer lock. The software volume cannot be set while the
41 * mixer is running, so we need the mixer lock (too).
43 * Here is a schematic of the i_volume range :
45 * |------------------------------+---------------------------------------|
48 * Between 0 and pi_soft, the volume is done in hardware by the output
49 * module. Above, the output module will change p_aout->mixer.i_multiplier
50 * (done in software). This scaling may result * in cropping errors and
51 * should be avoided as much as possible.
53 * It is legal to have *pi_soft == 0, and do everything in software.
54 * It is also legal to have *pi_soft == 1024, and completely avoid
55 * software scaling. However, some streams (esp. A/52) are encoded with
56 * a very low volume and users may complain.
59 /*****************************************************************************
60 * aout_VolumeGet : get the volume of the output device
61 *****************************************************************************/
62 int aout_VolumeGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
66 vlc_mutex_lock( &p_aout->mixer_lock );
68 if ( p_aout->mixer.b_error )
70 /* The output module is destroyed. */
71 vlc_mutex_unlock( &p_aout->mixer_lock );
72 msg_Err( p_aout, "VolumeGet called without output module" );
76 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
78 vlc_mutex_unlock( &p_aout->mixer_lock );
82 /*****************************************************************************
83 * aout_VolumeSet : set the volume of the output device
84 *****************************************************************************/
85 int aout_VolumeSet( aout_instance_t * p_aout, audio_volume_t i_volume )
89 vlc_mutex_lock( &p_aout->mixer_lock );
91 if ( p_aout->mixer.b_error )
93 /* The output module is destroyed. */
94 vlc_mutex_unlock( &p_aout->mixer_lock );
95 msg_Err( p_aout, "VolumeSet called without output module" );
99 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
101 vlc_mutex_unlock( &p_aout->mixer_lock );
105 /*****************************************************************************
106 * aout_VolumeInfos : get the boundary pi_soft
107 *****************************************************************************/
108 int aout_VolumeInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
112 vlc_mutex_lock( &p_aout->mixer_lock );
114 if ( p_aout->mixer.b_error )
116 /* The output module is destroyed. */
117 vlc_mutex_unlock( &p_aout->mixer_lock );
118 msg_Err( p_aout, "VolumeInfos called without output module" );
122 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
124 vlc_mutex_unlock( &p_aout->mixer_lock );
128 /*****************************************************************************
129 * aout_VolumeUp : raise the output volume
130 *****************************************************************************
131 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
133 *****************************************************************************/
134 int aout_VolumeUp( aout_instance_t * p_aout, int i_nb_steps,
135 audio_volume_t * pi_volume )
138 audio_volume_t i_volume;
140 vlc_mutex_lock( &p_aout->mixer_lock );
142 if ( p_aout->mixer.b_error )
144 /* The output module is destroyed. */
145 vlc_mutex_unlock( &p_aout->mixer_lock );
146 msg_Err( p_aout, "VolumeUp called without output module" );
150 if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
152 vlc_mutex_unlock( &p_aout->mixer_lock );
156 i_volume += AOUT_VOLUME_STEP * i_nb_steps;
157 if ( i_volume > 1024 ) i_volume = 1024;
159 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
161 vlc_mutex_unlock( &p_aout->mixer_lock );
163 if ( pi_volume != NULL ) *pi_volume = i_volume;
167 /*****************************************************************************
168 * aout_VolumeDown : lower the output volume
169 *****************************************************************************
170 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
172 *****************************************************************************/
173 int aout_VolumeDown( aout_instance_t * p_aout, int i_nb_steps,
174 audio_volume_t * pi_volume )
177 audio_volume_t i_volume;
179 vlc_mutex_lock( &p_aout->mixer_lock );
181 if ( p_aout->mixer.b_error )
183 /* The output module is destroyed. */
184 vlc_mutex_unlock( &p_aout->mixer_lock );
185 msg_Err( p_aout, "VolumeUp called without output module" );
189 if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
191 vlc_mutex_unlock( &p_aout->mixer_lock );
195 if ( i_volume < AOUT_VOLUME_STEP * i_nb_steps )
198 i_volume -= AOUT_VOLUME_STEP * i_nb_steps;
200 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
202 vlc_mutex_unlock( &p_aout->mixer_lock );
204 if ( pi_volume != NULL ) *pi_volume = i_volume;
209 * The next functions are not supposed to be called by the interface, but
210 * are placeholders for software-only scaling.
213 /* Meant to be called by the output plug-in's Open(). */
214 void aout_VolumeSoftInit( aout_instance_t * p_aout )
218 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
219 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
220 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
222 i_volume = config_GetInt( p_aout, "volume" );
225 i_volume = AOUT_VOLUME_DEFAULT;
227 else if ( i_volume > AOUT_VOLUME_MAX )
229 i_volume = AOUT_VOLUME_MAX;
232 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
235 /* Placeholder for pf_volume_infos(). */
236 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
242 /* Placeholder for pf_volume_get(). */
243 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
245 *pi_volume = p_aout->output.i_volume;
250 /* Placeholder for pf_volume_set(). */
251 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
253 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
254 p_aout->output.i_volume = i_volume;
259 * The next functions are not supposed to be called by the interface, but
260 * are placeholders for unsupported scaling.
263 /* Meant to be called by the output plug-in's Open(). */
264 void aout_VolumeNoneInit( aout_instance_t * p_aout )
266 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
267 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
268 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
271 /* Placeholder for pf_volume_infos(). */
272 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
277 /* Placeholder for pf_volume_get(). */
278 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
283 /* Placeholder for pf_volume_set(). */
284 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
291 * Pipelines management
294 /*****************************************************************************
295 * aout_Restart : re-open the output device and rebuild the input and output
297 *****************************************************************************
298 * This function is used whenever the parameters of the output plug-in are
299 * changed (eg. selecting S/PDIF or PCM).
300 *****************************************************************************/
301 int aout_Restart( aout_instance_t * p_aout )
304 vlc_bool_t b_error = 0;
306 vlc_mutex_lock( &p_aout->mixer_lock );
308 if ( p_aout->i_nb_inputs == 0 )
310 vlc_mutex_unlock( &p_aout->mixer_lock );
311 msg_Err( p_aout, "no decoder thread" );
315 /* Lock all inputs. */
316 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
318 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
319 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
322 aout_MixerDelete( p_aout );
324 /* Re-open the output plug-in. */
325 aout_OutputDelete( p_aout );
327 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
329 /* Release all locks and report the error. */
330 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
332 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
334 vlc_mutex_unlock( &p_aout->mixer_lock );
338 if ( aout_MixerNew( p_aout ) == -1 )
340 aout_OutputDelete( p_aout );
341 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
343 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
345 vlc_mutex_unlock( &p_aout->mixer_lock );
349 /* Re-open all inputs. */
350 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
352 aout_input_t * p_input = p_aout->pp_inputs[i];
354 b_error |= aout_InputNew( p_aout, p_input );
355 vlc_mutex_unlock( &p_input->lock );
358 vlc_mutex_unlock( &p_aout->mixer_lock );
363 /*****************************************************************************
364 * aout_FindAndRestart : find the audio output instance and restart
365 *****************************************************************************
366 * This is used for callbacks of the configuration variables, and we believe
367 * that when those are changed, it is a significant change which implies
368 * rebuilding the audio-device and audio-channels variables.
369 *****************************************************************************/
370 void aout_FindAndRestart( vlc_object_t * p_this )
372 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
375 if ( p_aout == NULL ) return;
377 if ( var_Type( p_aout, "audio-device" ) >= 0 )
379 var_Destroy( p_aout, "audio-device" );
381 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
383 var_Destroy( p_aout, "audio-channels" );
386 aout_Restart( p_aout );
387 vlc_object_release( p_aout );
390 /*****************************************************************************
391 * aout_ChannelsRestart : change the audio device or channels and restart
392 *****************************************************************************/
393 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
394 vlc_value_t old_value, vlc_value_t new_value,
397 aout_instance_t * p_aout = (aout_instance_t *)p_this;
399 if ( !strcmp( psz_variable, "audio-device" ) )
401 /* This is supposed to be a significant change and supposes
402 * rebuilding the channel choices. */
403 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
405 var_Destroy( p_aout, "audio-channels" );
408 aout_Restart( p_aout );