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 if ( !b_unmute_condition )
122 i_volume = config_GetInt( p_object, "volume" );
123 i_volume += i_volume_step * i_nb_steps;
125 if ( i_volume > AOUT_VOLUME_MAX )
126 i_volume = AOUT_VOLUME_MAX;
127 else if ( i_volume < AOUT_VOLUME_MIN )
128 i_volume = AOUT_VOLUME_MIN;
129 if ( i_return_volume != NULL )
130 *i_return_volume = i_volume;
133 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
134 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
137 if ( b_mute_condition )
139 i_volume = AOUT_VOLUME_MIN;
140 var_SetBool( p_object->p_libvlc, "volume-muted", true );
143 /* Commit volume changes */
144 config_PutInt( p_object, "volume", i_volume );
148 aout_lock_mixer( p_aout );
149 aout_lock_input_fifos( p_aout );
150 if ( p_aout->p_mixer )
151 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
152 aout_unlock_input_fifos( p_aout );
153 aout_unlock_mixer( p_aout );
156 /* trigger callbacks */
157 var_TriggerCallback( p_object->p_libvlc, "volume-change");
158 if ( p_aout ) var_SetBool( p_aout, "intf-change", true );
162 aout_unlock_volume( p_aout );
163 vlc_object_release( p_aout );
169 /*****************************************************************************
170 * aout_VolumeGet : get the volume of the output device
171 *****************************************************************************/
172 int __aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
175 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
178 if ( pi_volume == NULL ) return -1;
180 if ( p_aout == NULL )
182 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
186 aout_lock_volume( p_aout );
187 aout_lock_mixer( p_aout );
188 if ( p_aout->p_mixer )
190 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
194 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
196 aout_unlock_mixer( p_aout );
197 aout_unlock_volume( p_aout );
199 vlc_object_release( p_aout );
203 /*****************************************************************************
204 * aout_VolumeSet : set the volume of the output device
205 *****************************************************************************/
206 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
208 return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
211 /*****************************************************************************
212 * aout_VolumeUp : raise the output volume
213 *****************************************************************************
214 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
216 *****************************************************************************/
217 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
218 audio_volume_t * pi_volume )
220 return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
223 /*****************************************************************************
224 * aout_VolumeDown : lower the output volume
225 *****************************************************************************
226 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
228 *****************************************************************************/
229 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
230 audio_volume_t * pi_volume )
232 return __aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
235 /*****************************************************************************
236 * aout_ToggleMute : Mute/un-mute the output volume
237 *****************************************************************************
238 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
239 * function (muted => 0).
240 *****************************************************************************/
241 int __aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
243 return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
246 /*****************************************************************************
247 * aout_IsMuted : Get the output volume mute status
248 *****************************************************************************/
249 bool aout_IsMuted( vlc_object_t * p_object )
252 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
254 if ( p_aout ) aout_lock_volume( p_aout );
255 b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
256 if ( p_aout ) aout_unlock_volume( p_aout );
260 /*****************************************************************************
261 * aout_SetMute : Sets mute status
262 *****************************************************************************
263 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
264 * function (muted => 0).
265 *****************************************************************************/
266 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
269 return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
273 * The next functions are not supposed to be called by the interface, but
274 * are placeholders for software-only scaling.
277 /* Meant to be called by the output plug-in's Open(). */
278 void aout_VolumeSoftInit( aout_instance_t * p_aout )
282 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
283 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
285 i_volume = config_GetInt( p_aout, "volume" );
286 if ( i_volume < AOUT_VOLUME_MIN )
288 i_volume = AOUT_VOLUME_DEFAULT;
290 else if ( i_volume > AOUT_VOLUME_MAX )
292 i_volume = AOUT_VOLUME_MAX;
295 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
298 /* Placeholder for pf_volume_get(). */
299 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
301 *pi_volume = p_aout->output.i_volume;
306 /* Placeholder for pf_volume_set(). */
307 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
309 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
310 p_aout->output.i_volume = i_volume;
315 * The next functions are not supposed to be called by the interface, but
316 * are placeholders for unsupported scaling.
319 /* Meant to be called by the output plug-in's Open(). */
320 void aout_VolumeNoneInit( aout_instance_t * p_aout )
322 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
323 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
326 /* Placeholder for pf_volume_get(). */
327 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
329 (void)p_aout; (void)pi_volume;
333 /* Placeholder for pf_volume_set(). */
334 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
336 (void)p_aout; (void)i_volume;
342 * Pipelines management
345 /*****************************************************************************
346 * aout_Restart : re-open the output device and rebuild the input and output
348 *****************************************************************************
349 * This function is used whenever the parameters of the output plug-in are
350 * changed (eg. selecting S/PDIF or PCM).
351 *****************************************************************************/
352 static int aout_Restart( aout_instance_t * p_aout )
357 aout_lock_mixer( p_aout );
359 if ( p_aout->i_nb_inputs == 0 )
361 aout_unlock_mixer( p_aout );
362 msg_Err( p_aout, "no decoder thread" );
366 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
368 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
369 aout_lock_input_fifos( p_aout );
370 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
371 aout_unlock_input_fifos( p_aout );
374 /* Lock all inputs. */
375 aout_lock_input_fifos( p_aout );
376 aout_MixerDelete( p_aout );
378 /* Re-open the output plug-in. */
379 aout_OutputDelete( p_aout );
381 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
383 /* Release all locks and report the error. */
384 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
386 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
388 aout_unlock_input_fifos( p_aout );
389 aout_unlock_mixer( p_aout );
393 if ( aout_MixerNew( p_aout ) == -1 )
395 aout_OutputDelete( p_aout );
396 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
398 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
400 aout_unlock_input_fifos( p_aout );
401 aout_unlock_mixer( p_aout );
405 /* Re-open all inputs. */
406 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
408 aout_input_t * p_input = p_aout->pp_inputs[i];
409 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
410 p_input->b_changed = 1;
411 aout_unlock_input( p_aout, p_input );
414 aout_unlock_input_fifos( p_aout );
415 aout_unlock_mixer( p_aout );
420 /*****************************************************************************
421 * aout_FindAndRestart : find the audio output instance and restart
422 *****************************************************************************
423 * This is used for callbacks of the configuration variables, and we believe
424 * that when those are changed, it is a significant change which implies
425 * rebuilding the audio-device and audio-channels variables.
426 *****************************************************************************/
427 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
428 vlc_value_t oldval, vlc_value_t newval, void *p_data )
430 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
433 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
434 if ( p_aout == NULL ) return VLC_SUCCESS;
436 var_Destroy( p_aout, "audio-device" );
437 var_Destroy( p_aout, "audio-channels" );
439 aout_Restart( p_aout );
440 vlc_object_release( p_aout );
445 /*****************************************************************************
446 * aout_ChannelsRestart : change the audio device or channels and restart
447 *****************************************************************************/
448 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
449 vlc_value_t oldval, vlc_value_t newval,
452 aout_instance_t * p_aout = (aout_instance_t *)p_this;
453 (void)oldval; (void)newval; (void)p_data;
455 if ( !strcmp( psz_variable, "audio-device" ) )
457 /* This is supposed to be a significant change and supposes
458 * rebuilding the channel choices. */
459 var_Destroy( p_aout, "audio-channels" );
461 aout_Restart( p_aout );
465 #undef aout_EnableFilter
466 /** Enable or disable an audio filter
467 * \param p_this a vlc object
468 * \param psz_name name of the filter
469 * \param b_add are we adding or removing the filter ?
471 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
474 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
477 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
480 AoutInputsMarkToRestart( p_aout );
484 vlc_object_release( p_aout );