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"
41 #include <vlc_playlist.h>
43 static aout_instance_t *findAout (vlc_object_t *obj)
45 input_thread_t *(*pf_find_input) (vlc_object_t *);
47 pf_find_input = var_GetAddress (obj, "find-input-callback");
48 if (unlikely(pf_find_input == NULL))
51 input_thread_t *p_input = pf_find_input (obj);
55 aout_instance_t *p_aout = input_GetAout (p_input);
56 vlc_object_release (p_input);
59 #define findAout(o) findAout(VLC_OBJECT(o))
64 * The hardware volume cannot be set if the output module gets deleted, so
65 * we must take the mixer lock. The software volume cannot be set while the
66 * mixer is running, so we need the mixer lock (too).
68 * Here is a schematic of the i_volume range :
70 * |------------------------------+---------------------------------------|
73 * Between 0 and pi_soft, the volume is done in hardware by the output
74 * module. Above, the output module will change p_aout->mixer.i_multiplier
75 * (done in software). This scaling may result * in cropping errors and
76 * should be avoided as much as possible.
78 * It is legal to have *pi_soft == 0, and do everything in software.
79 * It is also legal to have *pi_soft == 1024, and completely avoid
80 * software scaling. However, some streams (esp. A/52) are encoded with
81 * a very low volume and users may complain.
91 /*****************************************************************************
92 * doVolumeChanges : handle all volume changes. Internal use only to ease
94 *****************************************************************************/
96 int doVolumeChanges( unsigned action, vlc_object_t * p_object, int i_nb_steps,
97 audio_volume_t i_volume, audio_volume_t * i_return_volume,
100 int i_result = VLC_SUCCESS;
101 int i_volume_step = 1, i_new_volume = 0;
102 bool b_var_mute = false;
103 aout_instance_t *p_aout = findAout( p_object );
105 if ( p_aout ) aout_lock_volume( p_aout );
107 b_var_mute = var_GetBool( p_object, "volume-muted");
109 const bool b_unmute_condition = ( b_var_mute
110 && ( /* Unmute: on increments */
111 ( action == INCREMENT_VOLUME )
112 || /* On explicit unmute */
113 ( ( action == SET_MUTE ) && !b_mute )
114 || /* On toggle from muted */
115 ( action == TOGGLE_MUTE )
118 const bool b_mute_condition = ( !b_var_mute
120 ( ( action == SET_MUTE ) && b_mute )
122 ( action == TOGGLE_MUTE )
126 if ( b_unmute_condition )
128 /* Restore saved volume */
129 i_volume = var_GetInteger( p_object, "saved-volume" );
130 var_SetBool( p_object, "volume-muted", false );
132 else if ( b_mute_condition )
134 /* We need an initial value to backup later */
135 i_volume = config_GetInt( p_object, "volume" );
138 if ( action == INCREMENT_VOLUME )
140 i_volume_step = var_InheritInteger( p_object, "volume-step" );
142 if ( !b_unmute_condition )
143 i_volume = config_GetInt( p_object, "volume" );
145 i_new_volume = (int) i_volume + i_volume_step * i_nb_steps;
147 if ( i_new_volume > AOUT_VOLUME_MAX )
148 i_volume = AOUT_VOLUME_MAX;
149 else if ( i_new_volume < AOUT_VOLUME_MIN )
150 i_volume = AOUT_VOLUME_MIN;
152 i_volume = i_new_volume;
155 var_SetInteger( p_object, "saved-volume" , i_volume );
158 if ( b_mute_condition )
160 i_volume = AOUT_VOLUME_MIN;
161 var_SetBool( p_object, "volume-muted", true );
164 /* Commit volume changes */
165 config_PutInt( p_object, "volume", i_volume );
169 aout_lock_mixer( p_aout );
170 aout_lock_input_fifos( p_aout );
171 if ( p_aout->p_mixer )
172 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
173 aout_unlock_input_fifos( p_aout );
174 aout_unlock_mixer( p_aout );
177 /* trigger callbacks */
178 var_TriggerCallback( p_object, "volume-change" );
181 var_SetBool( p_aout, "intf-change", true );
182 aout_unlock_volume( p_aout );
183 vlc_object_release( p_aout );
186 if ( i_return_volume != NULL )
187 *i_return_volume = i_volume;
191 #undef aout_VolumeGet
192 /*****************************************************************************
193 * aout_VolumeGet : get the volume of the output device
194 *****************************************************************************/
195 int aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
198 aout_instance_t * p_aout = findAout( p_object );
200 if ( pi_volume == NULL ) return -1;
202 if ( p_aout == NULL )
204 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
208 aout_lock_volume( p_aout );
209 aout_lock_mixer( p_aout );
210 if ( p_aout->p_mixer )
212 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
216 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
218 aout_unlock_mixer( p_aout );
219 aout_unlock_volume( p_aout );
221 vlc_object_release( p_aout );
225 #undef aout_VolumeSet
226 /*****************************************************************************
227 * aout_VolumeSet : set the volume of the output device
228 *****************************************************************************/
229 int aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
231 return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
235 /*****************************************************************************
236 * aout_VolumeUp : raise the output volume
237 *****************************************************************************
238 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
240 *****************************************************************************/
241 int aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
242 audio_volume_t * pi_volume )
244 return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
247 #undef aout_VolumeDown
248 /*****************************************************************************
249 * aout_VolumeDown : lower the output volume
250 *****************************************************************************
251 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
253 *****************************************************************************/
254 int aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
255 audio_volume_t * pi_volume )
257 return aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
260 #undef aout_ToggleMute
261 /*****************************************************************************
262 * aout_ToggleMute : Mute/un-mute the output volume
263 *****************************************************************************
264 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
265 * function (muted => 0).
266 *****************************************************************************/
267 int aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
269 return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
272 /*****************************************************************************
273 * aout_IsMuted : Get the output volume mute status
274 *****************************************************************************/
275 bool aout_IsMuted( vlc_object_t * p_object )
278 aout_instance_t * p_aout = findAout( p_object );
279 if ( p_aout ) aout_lock_volume( p_aout );
280 b_return_val = var_GetBool( p_object, "volume-muted");
283 aout_unlock_volume( p_aout );
284 vlc_object_release( p_aout );
289 /*****************************************************************************
290 * aout_SetMute : Sets mute status
291 *****************************************************************************
292 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
293 * function (muted => 0).
294 *****************************************************************************/
295 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
298 return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
302 * The next functions are not supposed to be called by the interface, but
303 * are placeholders for software-only scaling.
306 /* Meant to be called by the output plug-in's Open(). */
307 void aout_VolumeSoftInit( aout_instance_t * p_aout )
311 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
312 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
314 i_volume = config_GetInt( p_aout, "volume" );
315 if ( i_volume < AOUT_VOLUME_MIN )
317 i_volume = AOUT_VOLUME_DEFAULT;
319 else if ( i_volume > AOUT_VOLUME_MAX )
321 i_volume = AOUT_VOLUME_MAX;
324 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
327 /* Placeholder for pf_volume_get(). */
328 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
330 *pi_volume = p_aout->output.i_volume;
335 /* Placeholder for pf_volume_set(). */
336 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
338 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
339 p_aout->output.i_volume = i_volume;
344 * The next functions are not supposed to be called by the interface, but
345 * are placeholders for unsupported scaling.
348 /* Meant to be called by the output plug-in's Open(). */
349 void aout_VolumeNoneInit( aout_instance_t * p_aout )
351 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
352 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
355 /* Placeholder for pf_volume_get(). */
356 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
358 (void)p_aout; (void)pi_volume;
362 /* Placeholder for pf_volume_set(). */
363 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
365 (void)p_aout; (void)i_volume;
371 * Pipelines management
374 /*****************************************************************************
375 * aout_Restart : re-open the output device and rebuild the input and output
377 *****************************************************************************
378 * This function is used whenever the parameters of the output plug-in are
379 * changed (eg. selecting S/PDIF or PCM).
380 *****************************************************************************/
381 static int aout_Restart( aout_instance_t * p_aout )
386 aout_lock_mixer( p_aout );
388 if ( p_aout->i_nb_inputs == 0 )
390 aout_unlock_mixer( p_aout );
391 msg_Err( p_aout, "no decoder thread" );
395 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
397 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
398 aout_lock_input_fifos( p_aout );
399 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
400 aout_unlock_input_fifos( p_aout );
403 /* Lock all inputs. */
404 aout_lock_input_fifos( p_aout );
405 aout_MixerDelete( p_aout );
407 /* Re-open the output plug-in. */
408 aout_OutputDelete( p_aout );
410 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
412 /* Release all locks and report the error. */
413 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
415 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
417 aout_unlock_input_fifos( p_aout );
418 aout_unlock_mixer( p_aout );
422 if ( aout_MixerNew( p_aout ) == -1 )
424 aout_OutputDelete( p_aout );
425 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
427 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
429 aout_unlock_input_fifos( p_aout );
430 aout_unlock_mixer( p_aout );
434 /* Re-open all inputs. */
435 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
437 aout_input_t * p_input = p_aout->pp_inputs[i];
438 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
439 p_input->b_changed = 1;
440 aout_unlock_input( p_aout, p_input );
443 aout_unlock_input_fifos( p_aout );
444 aout_unlock_mixer( p_aout );
449 /*****************************************************************************
450 * aout_FindAndRestart : find the audio output instance and restart
451 *****************************************************************************
452 * This is used for callbacks of the configuration variables, and we believe
453 * that when those are changed, it is a significant change which implies
454 * rebuilding the audio-device and audio-channels variables.
455 *****************************************************************************/
456 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
457 vlc_value_t oldval, vlc_value_t newval, void *p_data )
459 aout_instance_t * p_aout = findAout( pl_Get(p_this) );
461 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
462 if ( p_aout == NULL ) return VLC_SUCCESS;
464 var_Destroy( p_aout, "audio-device" );
465 var_Destroy( p_aout, "audio-channels" );
467 aout_Restart( p_aout );
468 vlc_object_release( p_aout );
473 /*****************************************************************************
474 * aout_ChannelsRestart : change the audio device or channels and restart
475 *****************************************************************************/
476 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
477 vlc_value_t oldval, vlc_value_t newval,
480 aout_instance_t * p_aout = (aout_instance_t *)p_this;
481 (void)oldval; (void)newval; (void)p_data;
483 if ( !strcmp( psz_variable, "audio-device" ) )
485 /* This is supposed to be a significant change and supposes
486 * rebuilding the channel choices. */
487 var_Destroy( p_aout, "audio-channels" );
489 aout_Restart( p_aout );
493 #undef aout_EnableFilter
494 /** Enable or disable an audio filter
495 * \param p_this a vlc object
496 * \param psz_name name of the filter
497 * \param b_add are we adding or removing the filter ?
499 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
502 aout_instance_t *p_aout = findAout( p_this );
504 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
507 AoutInputsMarkToRestart( p_aout );
511 vlc_object_release( p_aout );