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.
85 /*****************************************************************************
86 * doVolumeChanges : handle all volume changes. Internal use only to ease
88 *****************************************************************************/
90 int doVolumeChanges( unsigned action, vlc_object_t * p_object, int i_nb_steps,
91 audio_volume_t i_volume, audio_volume_t * i_return_volume,
94 int i_result = VLC_SUCCESS;
95 int i_volume_step = 1, i_new_volume = 0;
96 bool b_var_mute = false;
97 aout_instance_t *p_aout = findAout( p_object );
99 if ( p_aout ) aout_lock_volume( p_aout );
101 b_var_mute = (bool)var_GetBool( p_object->p_libvlc, "volume-muted");
103 const bool b_unmute_condition = ( /* Also unmute on increments */
104 ( action == INCREMENT_VOLUME )
105 || /* On explicit unmute */
106 ( ( action == SET_MUTE ) && ( b_var_mute && !b_mute ) )
107 || /* On toggle from muted */
108 ( ( action == TOGGLE_MUTE ) && b_var_mute ) );
110 const bool b_mute_condition = ( !b_var_mute
112 ( ( action == SET_MUTE ) && b_mute )
114 ( action == TOGGLE_MUTE )
118 if ( b_unmute_condition )
120 /* Restore saved volume */
121 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
122 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
124 var_SetBool( p_object->p_libvlc, "volume-muted", false );
126 else if ( b_mute_condition )
128 /* We need an initial value to backup later */
129 i_volume = config_GetInt( p_object, "volume" );
132 if ( action == INCREMENT_VOLUME )
134 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
136 if ( !b_unmute_condition )
137 i_volume = config_GetInt( p_object, "volume" );
139 i_new_volume = (int) i_volume + i_volume_step * i_nb_steps;
141 if ( i_new_volume > AOUT_VOLUME_MAX )
142 i_volume = AOUT_VOLUME_MAX;
143 else if ( i_new_volume < AOUT_VOLUME_MIN )
144 i_volume = AOUT_VOLUME_MIN;
146 i_volume = i_new_volume;
148 if ( i_return_volume != NULL )
149 *i_return_volume = i_volume;
152 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
153 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
156 if ( b_mute_condition )
158 i_volume = AOUT_VOLUME_MIN;
159 var_SetBool( p_object->p_libvlc, "volume-muted", true );
162 /* Commit volume changes */
163 config_PutInt( p_object, "volume", i_volume );
167 aout_lock_mixer( p_aout );
168 aout_lock_input_fifos( p_aout );
169 if ( p_aout->p_mixer )
170 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
171 aout_unlock_input_fifos( p_aout );
172 aout_unlock_mixer( p_aout );
175 /* trigger callbacks */
176 var_TriggerCallback( p_object->p_libvlc, "volume-change");
179 var_SetBool( p_aout, "intf-change", true );
180 aout_unlock_volume( p_aout );
181 vlc_object_release( p_aout );
187 #undef aout_VolumeGet
188 /*****************************************************************************
189 * aout_VolumeGet : get the volume of the output device
190 *****************************************************************************/
191 int aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
194 aout_instance_t * p_aout = findAout( p_object );
196 if ( pi_volume == NULL ) return -1;
198 if ( p_aout == NULL )
200 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
204 aout_lock_volume( p_aout );
205 aout_lock_mixer( p_aout );
206 if ( p_aout->p_mixer )
208 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
212 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
214 aout_unlock_mixer( p_aout );
215 aout_unlock_volume( p_aout );
217 vlc_object_release( p_aout );
221 #undef aout_VolumeSet
222 /*****************************************************************************
223 * aout_VolumeSet : set the volume of the output device
224 *****************************************************************************/
225 int aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
227 return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
231 /*****************************************************************************
232 * aout_VolumeUp : raise the output volume
233 *****************************************************************************
234 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
236 *****************************************************************************/
237 int aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
238 audio_volume_t * pi_volume )
240 return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
243 #undef aout_VolumeDown
244 /*****************************************************************************
245 * aout_VolumeDown : lower the output volume
246 *****************************************************************************
247 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
249 *****************************************************************************/
250 int aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
251 audio_volume_t * pi_volume )
253 return aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
256 #undef aout_ToggleMute
257 /*****************************************************************************
258 * aout_ToggleMute : Mute/un-mute the output volume
259 *****************************************************************************
260 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
261 * function (muted => 0).
262 *****************************************************************************/
263 int aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
265 return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
268 /*****************************************************************************
269 * aout_IsMuted : Get the output volume mute status
270 *****************************************************************************/
271 bool aout_IsMuted( vlc_object_t * p_object )
274 aout_instance_t * p_aout = findAout( p_object );
275 if ( p_aout ) aout_lock_volume( p_aout );
276 b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
279 aout_unlock_volume( p_aout );
280 vlc_object_release( p_aout );
285 /*****************************************************************************
286 * aout_SetMute : Sets mute status
287 *****************************************************************************
288 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
289 * function (muted => 0).
290 *****************************************************************************/
291 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
294 return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
298 * The next functions are not supposed to be called by the interface, but
299 * are placeholders for software-only scaling.
302 /* Meant to be called by the output plug-in's Open(). */
303 void aout_VolumeSoftInit( aout_instance_t * p_aout )
307 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
308 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
310 i_volume = config_GetInt( p_aout, "volume" );
311 if ( i_volume < AOUT_VOLUME_MIN )
313 i_volume = AOUT_VOLUME_DEFAULT;
315 else if ( i_volume > AOUT_VOLUME_MAX )
317 i_volume = AOUT_VOLUME_MAX;
320 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
323 /* Placeholder for pf_volume_get(). */
324 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
326 *pi_volume = p_aout->output.i_volume;
331 /* Placeholder for pf_volume_set(). */
332 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
334 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
335 p_aout->output.i_volume = i_volume;
340 * The next functions are not supposed to be called by the interface, but
341 * are placeholders for unsupported scaling.
344 /* Meant to be called by the output plug-in's Open(). */
345 void aout_VolumeNoneInit( aout_instance_t * p_aout )
347 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
348 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
351 /* Placeholder for pf_volume_get(). */
352 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
354 (void)p_aout; (void)pi_volume;
358 /* Placeholder for pf_volume_set(). */
359 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
361 (void)p_aout; (void)i_volume;
367 * Pipelines management
370 /*****************************************************************************
371 * aout_Restart : re-open the output device and rebuild the input and output
373 *****************************************************************************
374 * This function is used whenever the parameters of the output plug-in are
375 * changed (eg. selecting S/PDIF or PCM).
376 *****************************************************************************/
377 static int aout_Restart( aout_instance_t * p_aout )
382 aout_lock_mixer( p_aout );
384 if ( p_aout->i_nb_inputs == 0 )
386 aout_unlock_mixer( p_aout );
387 msg_Err( p_aout, "no decoder thread" );
391 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
393 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
394 aout_lock_input_fifos( p_aout );
395 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
396 aout_unlock_input_fifos( p_aout );
399 /* Lock all inputs. */
400 aout_lock_input_fifos( p_aout );
401 aout_MixerDelete( p_aout );
403 /* Re-open the output plug-in. */
404 aout_OutputDelete( p_aout );
406 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
408 /* Release all locks and report the error. */
409 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
411 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
413 aout_unlock_input_fifos( p_aout );
414 aout_unlock_mixer( p_aout );
418 if ( aout_MixerNew( p_aout ) == -1 )
420 aout_OutputDelete( p_aout );
421 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
423 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
425 aout_unlock_input_fifos( p_aout );
426 aout_unlock_mixer( p_aout );
430 /* Re-open all inputs. */
431 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
433 aout_input_t * p_input = p_aout->pp_inputs[i];
434 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
435 p_input->b_changed = 1;
436 aout_unlock_input( p_aout, p_input );
439 aout_unlock_input_fifos( p_aout );
440 aout_unlock_mixer( p_aout );
445 /*****************************************************************************
446 * aout_FindAndRestart : find the audio output instance and restart
447 *****************************************************************************
448 * This is used for callbacks of the configuration variables, and we believe
449 * that when those are changed, it is a significant change which implies
450 * rebuilding the audio-device and audio-channels variables.
451 *****************************************************************************/
452 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
453 vlc_value_t oldval, vlc_value_t newval, void *p_data )
455 aout_instance_t * p_aout = findAout( pl_Get(p_this) );
457 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
458 if ( p_aout == NULL ) return VLC_SUCCESS;
460 var_Destroy( p_aout, "audio-device" );
461 var_Destroy( p_aout, "audio-channels" );
463 aout_Restart( p_aout );
464 vlc_object_release( p_aout );
469 /*****************************************************************************
470 * aout_ChannelsRestart : change the audio device or channels and restart
471 *****************************************************************************/
472 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
473 vlc_value_t oldval, vlc_value_t newval,
476 aout_instance_t * p_aout = (aout_instance_t *)p_this;
477 (void)oldval; (void)newval; (void)p_data;
479 if ( !strcmp( psz_variable, "audio-device" ) )
481 /* This is supposed to be a significant change and supposes
482 * rebuilding the channel choices. */
483 var_Destroy( p_aout, "audio-channels" );
485 aout_Restart( p_aout );
489 #undef aout_EnableFilter
490 /** Enable or disable an audio filter
491 * \param p_this a vlc object
492 * \param psz_name name of the filter
493 * \param b_add are we adding or removing the filter ?
495 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
498 aout_instance_t *p_aout = findAout( p_this );
500 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
503 AoutInputsMarkToRestart( p_aout );
507 vlc_object_release( p_aout );