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.
64 /*****************************************************************************
65 * aout_VolumeGet : get the volume of the output device
66 *****************************************************************************/
67 int __aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
70 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
73 if ( pi_volume == NULL ) return -1;
77 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
81 aout_lock_mixer( p_aout );
82 if ( p_aout->p_mixer )
84 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
88 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
90 aout_unlock_mixer( p_aout );
92 vlc_object_release( p_aout );
96 /*****************************************************************************
97 * aout_VolumeSet : set the volume of the output device
98 *****************************************************************************/
99 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
101 config_PutInt( p_object, "volume", i_volume );
102 var_SetBool( p_object->p_libvlc, "volume-change", true );
104 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
105 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
107 aout_instance_t *p_aout = vlc_object_find( p_object,
108 VLC_OBJECT_AOUT, FIND_ANYWHERE );
109 if ( p_aout == NULL )
112 int i_result = VLC_SUCCESS;
114 aout_lock_mixer( p_aout );
115 aout_lock_input_fifos( p_aout );
116 if ( p_aout->p_mixer )
117 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
118 aout_unlock_input_fifos( p_aout );
119 aout_unlock_mixer( p_aout );
121 var_SetBool( p_aout, "intf-change", true );
122 vlc_object_release( p_aout );
126 /*****************************************************************************
127 * aout_VolumeUp : raise the output volume
128 *****************************************************************************
129 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
131 *****************************************************************************/
132 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
133 audio_volume_t * pi_volume )
135 const int i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
137 int i_volume = config_GetInt( p_object, "volume" ) +
138 i_volume_step * i_nb_steps;
139 if ( i_volume > AOUT_VOLUME_MAX )
140 i_volume = AOUT_VOLUME_MAX;
141 else if ( i_volume < AOUT_VOLUME_MIN )
142 i_volume = AOUT_VOLUME_MIN;
143 if ( pi_volume != NULL )
144 *pi_volume = i_volume;
146 return __aout_VolumeSet( p_object, i_volume );
149 /*****************************************************************************
150 * aout_VolumeDown : lower the output volume
151 *****************************************************************************
152 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
154 *****************************************************************************/
155 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
156 audio_volume_t * pi_volume )
158 return __aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
161 /*****************************************************************************
162 * aout_ToggleMute : Mute/un-mute the output volume
163 *****************************************************************************
164 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
165 * function (muted => 0).
166 *****************************************************************************/
167 int __aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
169 return aout_SetMute( p_object, pi_volume, !aout_IsMuted( p_object ) );
172 /*****************************************************************************
173 * aout_IsMuted : Get the output volume mute status
174 *****************************************************************************/
175 bool aout_IsMuted( vlc_object_t * p_object )
177 return (bool)var_GetBool( p_object->p_libvlc, "volume-muted");
180 /*****************************************************************************
181 * aout_SetMute : Sets mute status
182 *****************************************************************************
183 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
184 * function (muted => 0).
185 *****************************************************************************/
186 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
190 audio_volume_t i_volume;
192 var_SetBool( p_object->p_libvlc, "volume-muted", (bool)b_mute );
193 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
198 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
199 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
200 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
201 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
206 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
207 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
209 i_result = aout_VolumeSet( p_object, i_volume );
210 if ( pi_volume != NULL ) *pi_volume = i_volume;
216 * The next functions are not supposed to be called by the interface, but
217 * are placeholders for software-only scaling.
220 /* Meant to be called by the output plug-in's Open(). */
221 void aout_VolumeSoftInit( aout_instance_t * p_aout )
225 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
226 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
228 i_volume = config_GetInt( p_aout, "volume" );
229 if ( i_volume < AOUT_VOLUME_MIN )
231 i_volume = AOUT_VOLUME_DEFAULT;
233 else if ( i_volume > AOUT_VOLUME_MAX )
235 i_volume = AOUT_VOLUME_MAX;
238 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
241 /* Placeholder for pf_volume_get(). */
242 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
244 *pi_volume = p_aout->output.i_volume;
249 /* Placeholder for pf_volume_set(). */
250 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
252 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
253 p_aout->output.i_volume = i_volume;
258 * The next functions are not supposed to be called by the interface, but
259 * are placeholders for unsupported scaling.
262 /* Meant to be called by the output plug-in's Open(). */
263 void aout_VolumeNoneInit( aout_instance_t * p_aout )
265 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
266 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
269 /* Placeholder for pf_volume_get(). */
270 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
272 (void)p_aout; (void)pi_volume;
276 /* Placeholder for pf_volume_set(). */
277 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
279 (void)p_aout; (void)i_volume;
285 * Pipelines management
288 /*****************************************************************************
289 * aout_Restart : re-open the output device and rebuild the input and output
291 *****************************************************************************
292 * This function is used whenever the parameters of the output plug-in are
293 * changed (eg. selecting S/PDIF or PCM).
294 *****************************************************************************/
295 static int aout_Restart( aout_instance_t * p_aout )
300 aout_lock_mixer( p_aout );
302 if ( p_aout->i_nb_inputs == 0 )
304 aout_unlock_mixer( p_aout );
305 msg_Err( p_aout, "no decoder thread" );
309 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
311 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
312 aout_lock_input_fifos( p_aout );
313 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
314 aout_unlock_input_fifos( p_aout );
317 /* Lock all inputs. */
318 aout_lock_input_fifos( p_aout );
319 aout_MixerDelete( p_aout );
321 /* Re-open the output plug-in. */
322 aout_OutputDelete( p_aout );
324 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
326 /* Release all locks and report the error. */
327 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
329 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
331 aout_unlock_input_fifos( p_aout );
332 aout_unlock_mixer( p_aout );
336 if ( aout_MixerNew( p_aout ) == -1 )
338 aout_OutputDelete( p_aout );
339 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
341 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
343 aout_unlock_input_fifos( p_aout );
344 aout_unlock_mixer( p_aout );
348 /* Re-open all inputs. */
349 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
351 aout_input_t * p_input = p_aout->pp_inputs[i];
352 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
353 p_input->b_changed = 1;
354 aout_unlock_input( p_aout, p_input );
357 aout_unlock_input_fifos( p_aout );
358 aout_unlock_mixer( p_aout );
363 /*****************************************************************************
364 * aout_FindAndRestart : find the audio output instance and restart
365 *****************************************************************************
366 * This is used for callbacks of the configuration variables, and we believe
367 * that when those are changed, it is a significant change which implies
368 * rebuilding the audio-device and audio-channels variables.
369 *****************************************************************************/
370 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
371 vlc_value_t oldval, vlc_value_t newval, void *p_data )
373 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
376 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
377 if ( p_aout == NULL ) return VLC_SUCCESS;
379 var_Destroy( p_aout, "audio-device" );
380 var_Destroy( p_aout, "audio-channels" );
382 aout_Restart( p_aout );
383 vlc_object_release( p_aout );
388 /*****************************************************************************
389 * aout_ChannelsRestart : change the audio device or channels and restart
390 *****************************************************************************/
391 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
392 vlc_value_t oldval, vlc_value_t newval,
395 aout_instance_t * p_aout = (aout_instance_t *)p_this;
396 (void)oldval; (void)newval; (void)p_data;
398 if ( !strcmp( psz_variable, "audio-device" ) )
400 /* This is supposed to be a significant change and supposes
401 * rebuilding the channel choices. */
402 var_Destroy( p_aout, "audio-channels" );
404 aout_Restart( p_aout );
408 #undef aout_EnableFilter
409 /** Enable or disable an audio filter
410 * \param p_this a vlc object
411 * \param psz_name name of the filter
412 * \param b_add are we adding or removing the filter ?
414 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
417 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
420 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
423 AoutInputsMarkToRestart( p_aout );
427 vlc_object_release( p_aout );