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 playlist_t *pl = pl_Hold (obj->p_libvlc);
49 input_thread_t *p_input = playlist_CurrentInput (pl);
50 pl_Release (obj->p_libvlc);
54 aout_instance_t *p_aout = input_GetAout (p_input);
55 vlc_object_release (p_input);
62 * The hardware volume cannot be set if the output module gets deleted, so
63 * we must take the mixer lock. The software volume cannot be set while the
64 * mixer is running, so we need the mixer lock (too).
66 * Here is a schematic of the i_volume range :
68 * |------------------------------+---------------------------------------|
71 * Between 0 and pi_soft, the volume is done in hardware by the output
72 * module. Above, the output module will change p_aout->mixer.i_multiplier
73 * (done in software). This scaling may result * in cropping errors and
74 * should be avoided as much as possible.
76 * It is legal to have *pi_soft == 0, and do everything in software.
77 * It is also legal to have *pi_soft == 1024, and completely avoid
78 * software scaling. However, some streams (esp. A/52) are encoded with
79 * a very low volume and users may complain.
88 /*****************************************************************************
89 * doVolumeChanges : handle all volume changes. Internal use only to ease
91 *****************************************************************************/
92 int doVolumeChanges( unsigned action, vlc_object_t * p_object, int i_nb_steps,
93 audio_volume_t i_volume, audio_volume_t * i_return_volume,
96 int i_result = VLC_SUCCESS;
97 int i_volume_step = 1, i_new_volume = 0;
98 bool b_var_mute = false;
99 aout_instance_t *p_aout = findAout( p_object );
101 if ( p_aout ) aout_lock_volume( p_aout );
103 b_var_mute = (bool)var_GetBool( p_object->p_libvlc, "volume-muted");
105 const bool b_unmute_condition = ( /* Also unmute on increments */
106 ( action == INCREMENT_VOLUME )
107 || /* On explicit unmute */
108 ( ( action == SET_MUTE ) && ( b_var_mute && !b_mute ) )
109 || /* On toggle from muted */
110 ( ( action == TOGGLE_MUTE ) && b_var_mute ) );
112 const bool b_mute_condition = ( !b_var_mute
114 ( ( action == SET_MUTE ) && b_mute )
116 ( action == TOGGLE_MUTE )
120 if ( b_unmute_condition )
122 /* Restore saved volume */
123 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
124 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
126 var_SetBool( p_object->p_libvlc, "volume-muted", false );
128 else if ( b_mute_condition )
130 /* We need an initial value to backup later */
131 i_volume = config_GetInt( p_object, "volume" );
134 if ( action == INCREMENT_VOLUME )
136 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
138 if ( !b_unmute_condition )
139 i_volume = config_GetInt( p_object, "volume" );
141 i_new_volume = (int) i_volume + i_volume_step * i_nb_steps;
143 if ( i_new_volume > AOUT_VOLUME_MAX )
144 i_volume = AOUT_VOLUME_MAX;
145 else if ( i_new_volume < AOUT_VOLUME_MIN )
146 i_volume = AOUT_VOLUME_MIN;
148 i_volume = i_new_volume;
150 if ( i_return_volume != NULL )
151 *i_return_volume = i_volume;
154 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
155 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
158 if ( b_mute_condition )
160 i_volume = AOUT_VOLUME_MIN;
161 var_SetBool( p_object->p_libvlc, "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->p_libvlc, "volume-change");
179 if ( p_aout ) var_SetBool( p_aout, "intf-change", true );
183 aout_unlock_volume( p_aout );
184 vlc_object_release( p_aout );
190 #undef aout_VolumeGet
191 /*****************************************************************************
192 * aout_VolumeGet : get the volume of the output device
193 *****************************************************************************/
194 int aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
197 aout_instance_t * p_aout = findAout( p_object );
199 if ( pi_volume == NULL ) return -1;
201 if ( p_aout == NULL )
203 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
207 aout_lock_volume( p_aout );
208 aout_lock_mixer( p_aout );
209 if ( p_aout->p_mixer )
211 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
215 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
217 aout_unlock_mixer( p_aout );
218 aout_unlock_volume( p_aout );
220 vlc_object_release( p_aout );
224 #undef aout_VolumeSet
225 /*****************************************************************************
226 * aout_VolumeSet : set the volume of the output device
227 *****************************************************************************/
228 int aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
230 return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
234 /*****************************************************************************
235 * aout_VolumeUp : raise the output volume
236 *****************************************************************************
237 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
239 *****************************************************************************/
240 int aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
241 audio_volume_t * pi_volume )
243 return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
246 #undef aout_VolumeDown
247 /*****************************************************************************
248 * aout_VolumeDown : lower the output volume
249 *****************************************************************************
250 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
252 *****************************************************************************/
253 int aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
254 audio_volume_t * pi_volume )
256 return aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
259 #undef aout_ToggleMute
260 /*****************************************************************************
261 * aout_ToggleMute : Mute/un-mute the output volume
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_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
268 return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
271 /*****************************************************************************
272 * aout_IsMuted : Get the output volume mute status
273 *****************************************************************************/
274 bool aout_IsMuted( vlc_object_t * p_object )
277 aout_instance_t * p_aout = findAout( p_object );
278 if ( p_aout ) aout_lock_volume( p_aout );
279 b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
282 aout_unlock_volume( p_aout );
283 vlc_object_release( p_aout );
288 /*****************************************************************************
289 * aout_SetMute : Sets mute status
290 *****************************************************************************
291 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
292 * function (muted => 0).
293 *****************************************************************************/
294 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
297 return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
301 * The next functions are not supposed to be called by the interface, but
302 * are placeholders for software-only scaling.
305 /* Meant to be called by the output plug-in's Open(). */
306 void aout_VolumeSoftInit( aout_instance_t * p_aout )
310 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
311 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
313 i_volume = config_GetInt( p_aout, "volume" );
314 if ( i_volume < AOUT_VOLUME_MIN )
316 i_volume = AOUT_VOLUME_DEFAULT;
318 else if ( i_volume > AOUT_VOLUME_MAX )
320 i_volume = AOUT_VOLUME_MAX;
323 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
326 /* Placeholder for pf_volume_get(). */
327 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
329 *pi_volume = p_aout->output.i_volume;
334 /* Placeholder for pf_volume_set(). */
335 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
337 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
338 p_aout->output.i_volume = i_volume;
343 * The next functions are not supposed to be called by the interface, but
344 * are placeholders for unsupported scaling.
347 /* Meant to be called by the output plug-in's Open(). */
348 void aout_VolumeNoneInit( aout_instance_t * p_aout )
350 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
351 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
354 /* Placeholder for pf_volume_get(). */
355 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
357 (void)p_aout; (void)pi_volume;
361 /* Placeholder for pf_volume_set(). */
362 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
364 (void)p_aout; (void)i_volume;
370 * Pipelines management
373 /*****************************************************************************
374 * aout_Restart : re-open the output device and rebuild the input and output
376 *****************************************************************************
377 * This function is used whenever the parameters of the output plug-in are
378 * changed (eg. selecting S/PDIF or PCM).
379 *****************************************************************************/
380 static int aout_Restart( aout_instance_t * p_aout )
385 aout_lock_mixer( p_aout );
387 if ( p_aout->i_nb_inputs == 0 )
389 aout_unlock_mixer( p_aout );
390 msg_Err( p_aout, "no decoder thread" );
394 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
396 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
397 aout_lock_input_fifos( p_aout );
398 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
399 aout_unlock_input_fifos( p_aout );
402 /* Lock all inputs. */
403 aout_lock_input_fifos( p_aout );
404 aout_MixerDelete( p_aout );
406 /* Re-open the output plug-in. */
407 aout_OutputDelete( p_aout );
409 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
411 /* Release all locks and report the error. */
412 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
414 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
416 aout_unlock_input_fifos( p_aout );
417 aout_unlock_mixer( p_aout );
421 if ( aout_MixerNew( p_aout ) == -1 )
423 aout_OutputDelete( p_aout );
424 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
426 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
428 aout_unlock_input_fifos( p_aout );
429 aout_unlock_mixer( p_aout );
433 /* Re-open all inputs. */
434 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
436 aout_input_t * p_input = p_aout->pp_inputs[i];
437 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
438 p_input->b_changed = 1;
439 aout_unlock_input( p_aout, p_input );
442 aout_unlock_input_fifos( p_aout );
443 aout_unlock_mixer( p_aout );
448 /*****************************************************************************
449 * aout_FindAndRestart : find the audio output instance and restart
450 *****************************************************************************
451 * This is used for callbacks of the configuration variables, and we believe
452 * that when those are changed, it is a significant change which implies
453 * rebuilding the audio-device and audio-channels variables.
454 *****************************************************************************/
455 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
456 vlc_value_t oldval, vlc_value_t newval, void *p_data )
458 aout_instance_t * p_aout = findAout( p_this );
460 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
461 if ( p_aout == NULL ) return VLC_SUCCESS;
463 var_Destroy( p_aout, "audio-device" );
464 var_Destroy( p_aout, "audio-channels" );
466 aout_Restart( p_aout );
467 vlc_object_release( p_aout );
472 /*****************************************************************************
473 * aout_ChannelsRestart : change the audio device or channels and restart
474 *****************************************************************************/
475 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
476 vlc_value_t oldval, vlc_value_t newval,
479 aout_instance_t * p_aout = (aout_instance_t *)p_this;
480 (void)oldval; (void)newval; (void)p_data;
482 if ( !strcmp( psz_variable, "audio-device" ) )
484 /* This is supposed to be a significant change and supposes
485 * rebuilding the channel choices. */
486 var_Destroy( p_aout, "audio-channels" );
488 aout_Restart( p_aout );
492 #undef aout_EnableFilter
493 /** Enable or disable an audio filter
494 * \param p_this a vlc object
495 * \param psz_name name of the filter
496 * \param b_add are we adding or removing the filter ?
498 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
501 aout_instance_t *p_aout = findAout( p_this );
503 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
506 AoutInputsMarkToRestart( p_aout );
510 vlc_object_release( p_aout );