1 /*****************************************************************************
2 * intf.c : audio output API towards the interface modules
3 *****************************************************************************
4 * Copyright (C) 2002-2004 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 /*****************************************************************************
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( vlc_object_t * p_object, audio_volume_t * pi_volume )
64 int i_volume, i_result = 0;
65 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
68 i_volume = config_GetInt( p_object, "volume" );
69 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i_volume;
71 if ( p_aout == NULL ) return 0;
73 vlc_mutex_lock( &p_aout->mixer_lock );
74 if ( !p_aout->mixer.b_error )
76 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
78 vlc_mutex_unlock( &p_aout->mixer_lock );
80 vlc_object_release( p_aout );
84 /*****************************************************************************
85 * aout_VolumeSet : set the volume of the output device
86 *****************************************************************************/
87 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
90 aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT, FIND_ANYWHERE );
93 config_PutInt( p_object, "volume", i_volume );
95 val.b_bool = VLC_TRUE;
96 var_Set( p_object->p_vlc, "volume-change", val );
98 if ( p_aout == NULL ) return 0;
100 vlc_mutex_lock( &p_aout->mixer_lock );
101 if ( !p_aout->mixer.b_error )
103 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
105 vlc_mutex_unlock( &p_aout->mixer_lock );
107 var_Set( p_aout, "intf-change", val );
108 vlc_object_release( p_aout );
112 /*****************************************************************************
113 * aout_VolumeInfos : get the boundary pi_soft
114 *****************************************************************************/
115 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
117 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
121 if ( p_aout == NULL ) return 0;
123 vlc_mutex_lock( &p_aout->mixer_lock );
124 if ( p_aout->mixer.b_error )
126 /* The output module is destroyed. */
131 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
133 vlc_mutex_unlock( &p_aout->mixer_lock );
135 vlc_object_release( p_aout );
139 /*****************************************************************************
140 * aout_VolumeUp : raise the output volume
141 *****************************************************************************
142 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
144 *****************************************************************************/
145 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
146 audio_volume_t * pi_volume )
148 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
150 int i_result = 0, i_volume = 0, i_volume_step = 0;
152 i_volume_step = config_GetInt( p_object->p_vlc, "volume-step" );
153 i_volume = config_GetInt( p_object, "volume" );
154 i_volume += i_volume_step * i_nb_steps;
155 if ( i_volume > AOUT_VOLUME_MAX )
157 i_volume = AOUT_VOLUME_MAX;
159 config_PutInt( p_object, "volume", i_volume );
160 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
161 var_SetInteger( p_object->p_libvlc, "saved-volume" , (audio_volume_t) i_volume );
162 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
164 if ( p_aout == NULL ) return 0;
166 vlc_mutex_lock( &p_aout->mixer_lock );
167 if ( !p_aout->mixer.b_error )
169 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
171 vlc_mutex_unlock( &p_aout->mixer_lock );
173 vlc_object_release( p_aout );
177 /*****************************************************************************
178 * aout_VolumeDown : lower the output volume
179 *****************************************************************************
180 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
182 *****************************************************************************/
183 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
184 audio_volume_t * pi_volume )
186 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
188 int i_result = 0, i_volume = 0, i_volume_step = 0;
190 i_volume_step = config_GetInt( p_object->p_vlc, "volume-step" );
191 i_volume = config_GetInt( p_object, "volume" );
192 i_volume -= i_volume_step * i_nb_steps;
193 if ( i_volume < AOUT_VOLUME_MIN )
195 i_volume = AOUT_VOLUME_MIN;
197 config_PutInt( p_object, "volume", i_volume );
198 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
199 var_SetInteger( p_object->p_libvlc, "saved-volume", (audio_volume_t) i_volume );
200 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
202 if ( p_aout == NULL ) return 0;
204 vlc_mutex_lock( &p_aout->mixer_lock );
205 if ( !p_aout->mixer.b_error )
207 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
209 vlc_mutex_unlock( &p_aout->mixer_lock );
211 vlc_object_release( p_aout );
215 /*****************************************************************************
216 * aout_VolumeMute : Mute/un-mute the output volume
217 *****************************************************************************
218 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
219 * function (muted => 0).
220 *****************************************************************************/
221 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
224 audio_volume_t i_volume;
226 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
230 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
231 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
232 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
233 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
238 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
239 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
241 i_result = aout_VolumeSet( p_object, i_volume );
242 if ( pi_volume != NULL ) *pi_volume = i_volume;
249 * The next functions are not supposed to be called by the interface, but
250 * are placeholders for software-only scaling.
253 /* Meant to be called by the output plug-in's Open(). */
254 void aout_VolumeSoftInit( aout_instance_t * p_aout )
258 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
259 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
260 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
262 i_volume = config_GetInt( p_aout, "volume" );
263 if ( i_volume < AOUT_VOLUME_MIN )
265 i_volume = AOUT_VOLUME_DEFAULT;
267 else if ( i_volume > AOUT_VOLUME_MAX )
269 i_volume = AOUT_VOLUME_MAX;
272 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
275 /* Placeholder for pf_volume_infos(). */
276 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
282 /* Placeholder for pf_volume_get(). */
283 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
285 *pi_volume = p_aout->output.i_volume;
290 /* Placeholder for pf_volume_set(). */
291 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
293 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
294 p_aout->output.i_volume = i_volume;
299 * The next functions are not supposed to be called by the interface, but
300 * are placeholders for unsupported scaling.
303 /* Meant to be called by the output plug-in's Open(). */
304 void aout_VolumeNoneInit( aout_instance_t * p_aout )
306 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
307 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
308 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
311 /* Placeholder for pf_volume_infos(). */
312 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
317 /* Placeholder for pf_volume_get(). */
318 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
323 /* Placeholder for pf_volume_set(). */
324 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
331 * Pipelines management
334 /*****************************************************************************
335 * aout_Restart : re-open the output device and rebuild the input and output
337 *****************************************************************************
338 * This function is used whenever the parameters of the output plug-in are
339 * changed (eg. selecting S/PDIF or PCM).
340 *****************************************************************************/
341 int aout_Restart( aout_instance_t * p_aout )
344 vlc_bool_t b_error = 0;
346 vlc_mutex_lock( &p_aout->mixer_lock );
348 if ( p_aout->i_nb_inputs == 0 )
350 vlc_mutex_unlock( &p_aout->mixer_lock );
351 msg_Err( p_aout, "no decoder thread" );
355 /* Lock all inputs. */
356 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
358 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
359 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
362 aout_MixerDelete( p_aout );
364 /* Re-open the output plug-in. */
365 aout_OutputDelete( p_aout );
367 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
369 /* Release all locks and report the error. */
370 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
372 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
374 vlc_mutex_unlock( &p_aout->mixer_lock );
378 if ( aout_MixerNew( p_aout ) == -1 )
380 aout_OutputDelete( p_aout );
381 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
383 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
385 vlc_mutex_unlock( &p_aout->mixer_lock );
389 /* Re-open all inputs. */
390 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
392 aout_input_t * p_input = p_aout->pp_inputs[i];
394 b_error |= aout_InputNew( p_aout, p_input );
395 p_input->b_changed = 1;
396 vlc_mutex_unlock( &p_input->lock );
399 vlc_mutex_unlock( &p_aout->mixer_lock );
404 /*****************************************************************************
405 * aout_FindAndRestart : find the audio output instance and restart
406 *****************************************************************************
407 * This is used for callbacks of the configuration variables, and we believe
408 * that when those are changed, it is a significant change which implies
409 * rebuilding the audio-device and audio-channels variables.
410 *****************************************************************************/
411 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
412 vlc_value_t oldval, vlc_value_t val, void *p_data )
414 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
417 if ( p_aout == NULL ) return VLC_SUCCESS;
419 if ( var_Type( p_aout, "audio-device" ) != 0 )
421 var_Destroy( p_aout, "audio-device" );
423 if ( var_Type( p_aout, "audio-channels" ) != 0 )
425 var_Destroy( p_aout, "audio-channels" );
428 aout_Restart( p_aout );
429 vlc_object_release( p_aout );
434 /*****************************************************************************
435 * aout_ChannelsRestart : change the audio device or channels and restart
436 *****************************************************************************/
437 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
438 vlc_value_t old_value, vlc_value_t new_value,
441 aout_instance_t * p_aout = (aout_instance_t *)p_this;
443 if ( !strcmp( psz_variable, "audio-device" ) )
445 /* This is supposed to be a significant change and supposes
446 * rebuilding the channel choices. */
447 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
449 var_Destroy( p_aout, "audio-channels" );
452 aout_Restart( p_aout );