1 /*****************************************************************************
2 * intf.c : audio output API towards the interface modules
3 *****************************************************************************
4 * Copyright (C) 2002-2007 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 *****************************************************************************/
32 #include <vlc_common.h>
35 #include <stdlib.h> /* calloc(), malloc(), free() */
39 #include "aout_internal.h"
44 * The hardware volume cannot be set if the output module gets deleted, so
45 * we must take the mixer lock. The software volume cannot be set while the
46 * mixer is running, so we need the mixer lock (too).
48 * Here is a schematic of the i_volume range :
50 * |------------------------------+---------------------------------------|
53 * Between 0 and pi_soft, the volume is done in hardware by the output
54 * module. Above, the output module will change p_aout->mixer.i_multiplier
55 * (done in software). This scaling may result * in cropping errors and
56 * should be avoided as much as possible.
58 * It is legal to have *pi_soft == 0, and do everything in software.
59 * It is also legal to have *pi_soft == 1024, and completely avoid
60 * software scaling. However, some streams (esp. A/52) are encoded with
61 * a very low volume and users may complain.
70 /*****************************************************************************
71 * doVolumeChanges : handle all volume changes. Internal use only to ease
73 *****************************************************************************/
74 int doVolumeChanges( unsigned action, vlc_object_t * p_object, int i_nb_steps,
75 audio_volume_t i_volume, audio_volume_t * i_return_volume,
78 int i_result = VLC_SUCCESS;
79 int i_volume_step = 1;
80 bool b_var_mute = false;
81 aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
84 if ( p_aout ) aout_lock_volume( p_aout );
86 b_var_mute = (bool)var_GetBool( p_object->p_libvlc, "volume-muted");
88 const bool b_unmute_condition = ( /* Also unmute on increments */
89 ( action == INCREMENT_VOLUME )
90 || /* On explicit unmute */
91 ( ( action == SET_MUTE ) && ( b_var_mute && !b_mute ) )
92 || /* On toggle from muted */
93 ( ( action == TOGGLE_MUTE ) && b_var_mute ) );
95 const bool b_mute_condition = ( !b_var_mute
97 ( ( action == SET_MUTE ) && b_mute )
99 ( action == TOGGLE_MUTE )
103 if ( b_unmute_condition )
105 /* Restore saved volume */
106 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
107 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
109 var_SetBool( p_object->p_libvlc, "volume-muted", false );
111 else if ( b_mute_condition )
113 /* We need an initial value to backup later */
114 i_volume = config_GetInt( p_object, "volume" );
117 if ( action == INCREMENT_VOLUME )
119 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
121 i_volume = config_GetInt( p_object, "volume" )
122 + i_volume_step * i_nb_steps;
124 if ( i_volume > AOUT_VOLUME_MAX )
125 i_volume = AOUT_VOLUME_MAX;
126 else if ( i_volume < AOUT_VOLUME_MIN )
127 i_volume = AOUT_VOLUME_MIN;
128 if ( i_return_volume != NULL )
129 *i_return_volume = i_volume;
132 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
133 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
136 if ( b_mute_condition )
138 i_volume = AOUT_VOLUME_MIN;
139 var_SetBool( p_object->p_libvlc, "volume-muted", true );
142 /* Commit volume changes */
143 config_PutInt( p_object, "volume", i_volume );
147 aout_lock_mixer( p_aout );
148 aout_lock_input_fifos( p_aout );
149 if ( p_aout->p_mixer )
150 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
151 aout_unlock_input_fifos( p_aout );
152 aout_unlock_mixer( p_aout );
155 /* trigger callbacks */
156 var_TriggerCallback( p_object->p_libvlc, "volume-change");
157 if ( p_aout ) var_SetBool( p_aout, "intf-change", true );
161 aout_unlock_volume( p_aout );
162 vlc_object_release( p_aout );
168 /*****************************************************************************
169 * aout_VolumeGet : get the volume of the output device
170 *****************************************************************************/
171 int __aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
174 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
177 if ( pi_volume == NULL ) return -1;
179 if ( p_aout == NULL )
181 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
185 aout_lock_volume( p_aout );
186 aout_lock_mixer( p_aout );
187 if ( p_aout->p_mixer )
189 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
193 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
195 aout_unlock_mixer( p_aout );
196 aout_unlock_volume( p_aout );
198 vlc_object_release( p_aout );
202 /*****************************************************************************
203 * aout_VolumeSet : set the volume of the output device
204 *****************************************************************************/
205 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
207 return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
210 /*****************************************************************************
211 * aout_VolumeUp : raise the output volume
212 *****************************************************************************
213 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
215 *****************************************************************************/
216 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
217 audio_volume_t * pi_volume )
219 return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
222 /*****************************************************************************
223 * aout_VolumeDown : lower the output volume
224 *****************************************************************************
225 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
227 *****************************************************************************/
228 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
229 audio_volume_t * pi_volume )
231 return __aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
234 /*****************************************************************************
235 * aout_ToggleMute : Mute/un-mute the output volume
236 *****************************************************************************
237 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
238 * function (muted => 0).
239 *****************************************************************************/
240 int __aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
242 return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
245 /*****************************************************************************
246 * aout_IsMuted : Get the output volume mute status
247 *****************************************************************************/
248 bool aout_IsMuted( vlc_object_t * p_object )
251 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
253 if ( p_aout ) aout_lock_volume( p_aout );
254 b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
255 if ( p_aout ) aout_unlock_volume( p_aout );
259 /*****************************************************************************
260 * aout_SetMute : Sets mute status
261 *****************************************************************************
262 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
263 * function (muted => 0).
264 *****************************************************************************/
265 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
268 return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
272 * The next functions are not supposed to be called by the interface, but
273 * are placeholders for software-only scaling.
276 /* Meant to be called by the output plug-in's Open(). */
277 void aout_VolumeSoftInit( aout_instance_t * p_aout )
281 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
282 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
284 i_volume = config_GetInt( p_aout, "volume" );
285 if ( i_volume < AOUT_VOLUME_MIN )
287 i_volume = AOUT_VOLUME_DEFAULT;
289 else if ( i_volume > AOUT_VOLUME_MAX )
291 i_volume = AOUT_VOLUME_MAX;
294 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
297 /* Placeholder for pf_volume_get(). */
298 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
300 *pi_volume = p_aout->output.i_volume;
305 /* Placeholder for pf_volume_set(). */
306 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
308 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
309 p_aout->output.i_volume = i_volume;
314 * The next functions are not supposed to be called by the interface, but
315 * are placeholders for unsupported scaling.
318 /* Meant to be called by the output plug-in's Open(). */
319 void aout_VolumeNoneInit( aout_instance_t * p_aout )
321 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
322 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
325 /* Placeholder for pf_volume_get(). */
326 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
328 (void)p_aout; (void)pi_volume;
332 /* Placeholder for pf_volume_set(). */
333 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
335 (void)p_aout; (void)i_volume;
341 * Pipelines management
344 /*****************************************************************************
345 * aout_Restart : re-open the output device and rebuild the input and output
347 *****************************************************************************
348 * This function is used whenever the parameters of the output plug-in are
349 * changed (eg. selecting S/PDIF or PCM).
350 *****************************************************************************/
351 static int aout_Restart( aout_instance_t * p_aout )
356 aout_lock_mixer( p_aout );
358 if ( p_aout->i_nb_inputs == 0 )
360 aout_unlock_mixer( p_aout );
361 msg_Err( p_aout, "no decoder thread" );
365 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
367 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
368 aout_lock_input_fifos( p_aout );
369 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
370 aout_unlock_input_fifos( p_aout );
373 /* Lock all inputs. */
374 aout_lock_input_fifos( p_aout );
375 aout_MixerDelete( p_aout );
377 /* Re-open the output plug-in. */
378 aout_OutputDelete( p_aout );
380 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
382 /* Release all locks and report the error. */
383 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
385 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
387 aout_unlock_input_fifos( p_aout );
388 aout_unlock_mixer( p_aout );
392 if ( aout_MixerNew( p_aout ) == -1 )
394 aout_OutputDelete( p_aout );
395 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
397 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
399 aout_unlock_input_fifos( p_aout );
400 aout_unlock_mixer( p_aout );
404 /* Re-open all inputs. */
405 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
407 aout_input_t * p_input = p_aout->pp_inputs[i];
408 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
409 p_input->b_changed = 1;
410 aout_unlock_input( p_aout, p_input );
413 aout_unlock_input_fifos( p_aout );
414 aout_unlock_mixer( p_aout );
419 /*****************************************************************************
420 * aout_FindAndRestart : find the audio output instance and restart
421 *****************************************************************************
422 * This is used for callbacks of the configuration variables, and we believe
423 * that when those are changed, it is a significant change which implies
424 * rebuilding the audio-device and audio-channels variables.
425 *****************************************************************************/
426 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
427 vlc_value_t oldval, vlc_value_t newval, void *p_data )
429 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
432 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
433 if ( p_aout == NULL ) return VLC_SUCCESS;
435 var_Destroy( p_aout, "audio-device" );
436 var_Destroy( p_aout, "audio-channels" );
438 aout_Restart( p_aout );
439 vlc_object_release( p_aout );
444 /*****************************************************************************
445 * aout_ChannelsRestart : change the audio device or channels and restart
446 *****************************************************************************/
447 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
448 vlc_value_t oldval, vlc_value_t newval,
451 aout_instance_t * p_aout = (aout_instance_t *)p_this;
452 (void)oldval; (void)newval; (void)p_data;
454 if ( !strcmp( psz_variable, "audio-device" ) )
456 /* This is supposed to be a significant change and supposes
457 * rebuilding the channel choices. */
458 var_Destroy( p_aout, "audio-channels" );
460 aout_Restart( p_aout );
464 #undef aout_EnableFilter
465 /** Enable or disable an audio filter
466 * \param p_this a vlc object
467 * \param psz_name name of the filter
468 * \param b_add are we adding or removing the filter ?
470 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
473 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
476 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
479 AoutInputsMarkToRestart( p_aout );
483 vlc_object_release( p_aout );