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 *p_input = playlist_CurrentInput (pl_Get (obj));
49 aout_instance_t *p_aout = input_GetAout (p_input);
50 vlc_object_release (p_input);
53 #define findAout(o) findAout(VLC_OBJECT(o))
58 * The hardware volume cannot be set if the output module gets deleted, so
59 * we must take the mixer lock. The software volume cannot be set while the
60 * mixer is running, so we need the mixer lock (too).
62 * Here is a schematic of the i_volume range :
64 * |------------------------------+---------------------------------------|
67 * Between 0 and pi_soft, the volume is done in hardware by the output
68 * module. Above, the output module will change p_aout->mixer.i_multiplier
69 * (done in software). This scaling may result * in cropping errors and
70 * should be avoided as much as possible.
72 * It is legal to have *pi_soft == 0, and do everything in software.
73 * It is also legal to have *pi_soft == 1024, and completely avoid
74 * software scaling. However, some streams (esp. A/52) are encoded with
75 * a very low volume and users may complain.
84 /*****************************************************************************
85 * doVolumeChanges : handle all volume changes. Internal use only to ease
87 *****************************************************************************/
88 int doVolumeChanges( unsigned action, vlc_object_t * p_object, int i_nb_steps,
89 audio_volume_t i_volume, audio_volume_t * i_return_volume,
92 int i_result = VLC_SUCCESS;
93 int i_volume_step = 1, i_new_volume = 0;
94 bool b_var_mute = false;
95 aout_instance_t *p_aout = findAout( p_object );
97 if ( p_aout ) aout_lock_volume( p_aout );
99 b_var_mute = (bool)var_GetBool( p_object->p_libvlc, "volume-muted");
101 const bool b_unmute_condition = ( /* Also unmute on increments */
102 ( action == INCREMENT_VOLUME )
103 || /* On explicit unmute */
104 ( ( action == SET_MUTE ) && ( b_var_mute && !b_mute ) )
105 || /* On toggle from muted */
106 ( ( action == TOGGLE_MUTE ) && b_var_mute ) );
108 const bool b_mute_condition = ( !b_var_mute
110 ( ( action == SET_MUTE ) && b_mute )
112 ( action == TOGGLE_MUTE )
116 if ( b_unmute_condition )
118 /* Restore saved volume */
119 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
120 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
122 var_SetBool( p_object->p_libvlc, "volume-muted", false );
124 else if ( b_mute_condition )
126 /* We need an initial value to backup later */
127 i_volume = config_GetInt( p_object, "volume" );
130 if ( action == INCREMENT_VOLUME )
132 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
134 if ( !b_unmute_condition )
135 i_volume = config_GetInt( p_object, "volume" );
137 i_new_volume = (int) i_volume + i_volume_step * i_nb_steps;
139 if ( i_new_volume > AOUT_VOLUME_MAX )
140 i_volume = AOUT_VOLUME_MAX;
141 else if ( i_new_volume < AOUT_VOLUME_MIN )
142 i_volume = AOUT_VOLUME_MIN;
144 i_volume = i_new_volume;
146 if ( i_return_volume != NULL )
147 *i_return_volume = i_volume;
150 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
151 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
154 if ( b_mute_condition )
156 i_volume = AOUT_VOLUME_MIN;
157 var_SetBool( p_object->p_libvlc, "volume-muted", true );
160 /* Commit volume changes */
161 config_PutInt( p_object, "volume", i_volume );
165 aout_lock_mixer( p_aout );
166 aout_lock_input_fifos( p_aout );
167 if ( p_aout->p_mixer )
168 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
169 aout_unlock_input_fifos( p_aout );
170 aout_unlock_mixer( p_aout );
173 /* trigger callbacks */
174 var_TriggerCallback( p_object->p_libvlc, "volume-change");
177 var_SetBool( p_aout, "intf-change", true );
178 aout_unlock_volume( p_aout );
179 vlc_object_release( p_aout );
185 #undef aout_VolumeGet
186 /*****************************************************************************
187 * aout_VolumeGet : get the volume of the output device
188 *****************************************************************************/
189 int aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
192 aout_instance_t * p_aout = findAout( p_object );
194 if ( pi_volume == NULL ) return -1;
196 if ( p_aout == NULL )
198 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
202 aout_lock_volume( p_aout );
203 aout_lock_mixer( p_aout );
204 if ( p_aout->p_mixer )
206 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
210 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
212 aout_unlock_mixer( p_aout );
213 aout_unlock_volume( p_aout );
215 vlc_object_release( p_aout );
219 #undef aout_VolumeSet
220 /*****************************************************************************
221 * aout_VolumeSet : set the volume of the output device
222 *****************************************************************************/
223 int aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
225 return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
229 /*****************************************************************************
230 * aout_VolumeUp : raise the output volume
231 *****************************************************************************
232 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
234 *****************************************************************************/
235 int aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
236 audio_volume_t * pi_volume )
238 return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
241 #undef aout_VolumeDown
242 /*****************************************************************************
243 * aout_VolumeDown : lower the output volume
244 *****************************************************************************
245 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
247 *****************************************************************************/
248 int aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
249 audio_volume_t * pi_volume )
251 return aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
254 #undef aout_ToggleMute
255 /*****************************************************************************
256 * aout_ToggleMute : Mute/un-mute the output volume
257 *****************************************************************************
258 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
259 * function (muted => 0).
260 *****************************************************************************/
261 int aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
263 return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
266 /*****************************************************************************
267 * aout_IsMuted : Get the output volume mute status
268 *****************************************************************************/
269 bool aout_IsMuted( vlc_object_t * p_object )
272 aout_instance_t * p_aout = findAout( p_object );
273 if ( p_aout ) aout_lock_volume( p_aout );
274 b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
277 aout_unlock_volume( p_aout );
278 vlc_object_release( p_aout );
283 /*****************************************************************************
284 * aout_SetMute : Sets mute status
285 *****************************************************************************
286 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
287 * function (muted => 0).
288 *****************************************************************************/
289 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
292 return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
296 * The next functions are not supposed to be called by the interface, but
297 * are placeholders for software-only scaling.
300 /* Meant to be called by the output plug-in's Open(). */
301 void aout_VolumeSoftInit( aout_instance_t * p_aout )
305 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
306 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
308 i_volume = config_GetInt( p_aout, "volume" );
309 if ( i_volume < AOUT_VOLUME_MIN )
311 i_volume = AOUT_VOLUME_DEFAULT;
313 else if ( i_volume > AOUT_VOLUME_MAX )
315 i_volume = AOUT_VOLUME_MAX;
318 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
321 /* Placeholder for pf_volume_get(). */
322 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
324 *pi_volume = p_aout->output.i_volume;
329 /* Placeholder for pf_volume_set(). */
330 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
332 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
333 p_aout->output.i_volume = i_volume;
338 * The next functions are not supposed to be called by the interface, but
339 * are placeholders for unsupported scaling.
342 /* Meant to be called by the output plug-in's Open(). */
343 void aout_VolumeNoneInit( aout_instance_t * p_aout )
345 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
346 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
349 /* Placeholder for pf_volume_get(). */
350 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
352 (void)p_aout; (void)pi_volume;
356 /* Placeholder for pf_volume_set(). */
357 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
359 (void)p_aout; (void)i_volume;
365 * Pipelines management
368 /*****************************************************************************
369 * aout_Restart : re-open the output device and rebuild the input and output
371 *****************************************************************************
372 * This function is used whenever the parameters of the output plug-in are
373 * changed (eg. selecting S/PDIF or PCM).
374 *****************************************************************************/
375 static int aout_Restart( aout_instance_t * p_aout )
380 aout_lock_mixer( p_aout );
382 if ( p_aout->i_nb_inputs == 0 )
384 aout_unlock_mixer( p_aout );
385 msg_Err( p_aout, "no decoder thread" );
389 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
391 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
392 aout_lock_input_fifos( p_aout );
393 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
394 aout_unlock_input_fifos( p_aout );
397 /* Lock all inputs. */
398 aout_lock_input_fifos( p_aout );
399 aout_MixerDelete( p_aout );
401 /* Re-open the output plug-in. */
402 aout_OutputDelete( p_aout );
404 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
406 /* Release all locks and report the error. */
407 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
409 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
411 aout_unlock_input_fifos( p_aout );
412 aout_unlock_mixer( p_aout );
416 if ( aout_MixerNew( p_aout ) == -1 )
418 aout_OutputDelete( p_aout );
419 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
421 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
423 aout_unlock_input_fifos( p_aout );
424 aout_unlock_mixer( p_aout );
428 /* Re-open all inputs. */
429 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
431 aout_input_t * p_input = p_aout->pp_inputs[i];
432 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
433 p_input->b_changed = 1;
434 aout_unlock_input( p_aout, p_input );
437 aout_unlock_input_fifos( p_aout );
438 aout_unlock_mixer( p_aout );
443 /*****************************************************************************
444 * aout_FindAndRestart : find the audio output instance and restart
445 *****************************************************************************
446 * This is used for callbacks of the configuration variables, and we believe
447 * that when those are changed, it is a significant change which implies
448 * rebuilding the audio-device and audio-channels variables.
449 *****************************************************************************/
450 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
451 vlc_value_t oldval, vlc_value_t newval, void *p_data )
453 aout_instance_t * p_aout = findAout( pl_Get(p_this) );
455 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
456 if ( p_aout == NULL ) return VLC_SUCCESS;
458 var_Destroy( p_aout, "audio-device" );
459 var_Destroy( p_aout, "audio-channels" );
461 aout_Restart( p_aout );
462 vlc_object_release( p_aout );
467 /*****************************************************************************
468 * aout_ChannelsRestart : change the audio device or channels and restart
469 *****************************************************************************/
470 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
471 vlc_value_t oldval, vlc_value_t newval,
474 aout_instance_t * p_aout = (aout_instance_t *)p_this;
475 (void)oldval; (void)newval; (void)p_data;
477 if ( !strcmp( psz_variable, "audio-device" ) )
479 /* This is supposed to be a significant change and supposes
480 * rebuilding the channel choices. */
481 var_Destroy( p_aout, "audio-channels" );
483 aout_Restart( p_aout );
487 #undef aout_EnableFilter
488 /** Enable or disable an audio filter
489 * \param p_this a vlc object
490 * \param psz_name name of the filter
491 * \param b_add are we adding or removing the filter ?
493 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
496 aout_instance_t *p_aout = findAout( p_this );
498 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
501 AoutInputsMarkToRestart( p_aout );
505 vlc_object_release( p_aout );