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 )
136 const int i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
138 int i_volume = config_GetInt( p_object, "volume" ) +
139 i_volume_step * i_nb_steps;
140 if ( i_volume > AOUT_VOLUME_MAX )
141 i_volume = AOUT_VOLUME_MAX;
142 else if ( i_volume < AOUT_VOLUME_MIN )
143 i_volume = AOUT_VOLUME_MIN;
144 if ( pi_volume != NULL )
145 *pi_volume = i_volume;
147 return __aout_VolumeSet( p_object, i_volume );
150 /*****************************************************************************
151 * aout_VolumeDown : lower the output volume
152 *****************************************************************************
153 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
155 *****************************************************************************/
156 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
157 audio_volume_t * pi_volume )
159 return __aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
162 /*****************************************************************************
163 * aout_ToggleMute : Mute/un-mute the output volume
164 *****************************************************************************
165 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
166 * function (muted => 0).
167 *****************************************************************************/
168 int __aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
171 audio_volume_t i_volume;
173 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
177 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
178 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
179 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
180 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
185 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
186 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
188 i_result = aout_VolumeSet( p_object, i_volume );
189 if ( pi_volume != NULL ) *pi_volume = i_volume;
196 * The next functions are not supposed to be called by the interface, but
197 * are placeholders for software-only scaling.
200 /* Meant to be called by the output plug-in's Open(). */
201 void aout_VolumeSoftInit( aout_instance_t * p_aout )
205 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
206 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
208 i_volume = config_GetInt( p_aout, "volume" );
209 if ( i_volume < AOUT_VOLUME_MIN )
211 i_volume = AOUT_VOLUME_DEFAULT;
213 else if ( i_volume > AOUT_VOLUME_MAX )
215 i_volume = AOUT_VOLUME_MAX;
218 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
221 /* Placeholder for pf_volume_get(). */
222 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
224 *pi_volume = p_aout->output.i_volume;
229 /* Placeholder for pf_volume_set(). */
230 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
232 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
233 p_aout->output.i_volume = i_volume;
238 * The next functions are not supposed to be called by the interface, but
239 * are placeholders for unsupported scaling.
242 /* Meant to be called by the output plug-in's Open(). */
243 void aout_VolumeNoneInit( aout_instance_t * p_aout )
245 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
246 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
249 /* Placeholder for pf_volume_get(). */
250 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
252 (void)p_aout; (void)pi_volume;
256 /* Placeholder for pf_volume_set(). */
257 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
259 (void)p_aout; (void)i_volume;
265 * Pipelines management
268 /*****************************************************************************
269 * aout_Restart : re-open the output device and rebuild the input and output
271 *****************************************************************************
272 * This function is used whenever the parameters of the output plug-in are
273 * changed (eg. selecting S/PDIF or PCM).
274 *****************************************************************************/
275 static int aout_Restart( aout_instance_t * p_aout )
280 aout_lock_mixer( p_aout );
282 if ( p_aout->i_nb_inputs == 0 )
284 aout_unlock_mixer( p_aout );
285 msg_Err( p_aout, "no decoder thread" );
289 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
291 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
292 aout_lock_input_fifos( p_aout );
293 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
294 aout_unlock_input_fifos( p_aout );
297 /* Lock all inputs. */
298 aout_lock_input_fifos( p_aout );
299 aout_MixerDelete( p_aout );
301 /* Re-open the output plug-in. */
302 aout_OutputDelete( p_aout );
304 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
306 /* Release all locks and report the error. */
307 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
309 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
311 aout_unlock_input_fifos( p_aout );
312 aout_unlock_mixer( p_aout );
316 if ( aout_MixerNew( p_aout ) == -1 )
318 aout_OutputDelete( p_aout );
319 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
321 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
323 aout_unlock_input_fifos( p_aout );
324 aout_unlock_mixer( p_aout );
328 /* Re-open all inputs. */
329 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
331 aout_input_t * p_input = p_aout->pp_inputs[i];
332 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
333 p_input->b_changed = 1;
334 aout_unlock_input( p_aout, p_input );
337 aout_unlock_input_fifos( p_aout );
338 aout_unlock_mixer( p_aout );
343 /*****************************************************************************
344 * aout_FindAndRestart : find the audio output instance and restart
345 *****************************************************************************
346 * This is used for callbacks of the configuration variables, and we believe
347 * that when those are changed, it is a significant change which implies
348 * rebuilding the audio-device and audio-channels variables.
349 *****************************************************************************/
350 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
351 vlc_value_t oldval, vlc_value_t newval, void *p_data )
353 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
356 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
357 if ( p_aout == NULL ) return VLC_SUCCESS;
359 var_Destroy( p_aout, "audio-device" );
360 var_Destroy( p_aout, "audio-channels" );
362 aout_Restart( p_aout );
363 vlc_object_release( p_aout );
368 /*****************************************************************************
369 * aout_ChannelsRestart : change the audio device or channels and restart
370 *****************************************************************************/
371 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
372 vlc_value_t oldval, vlc_value_t newval,
375 aout_instance_t * p_aout = (aout_instance_t *)p_this;
376 (void)oldval; (void)newval; (void)p_data;
378 if ( !strcmp( psz_variable, "audio-device" ) )
380 /* This is supposed to be a significant change and supposes
381 * rebuilding the channel choices. */
382 var_Destroy( p_aout, "audio-channels" );
384 aout_Restart( p_aout );
388 #undef aout_EnableFilter
389 /** Enable or disable an audio filter
390 * \param p_this a vlc object
391 * \param psz_name name of the filter
392 * \param b_add are we adding or removing the filter ?
394 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
397 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
400 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
403 AoutInputsMarkToRestart( p_aout );
407 vlc_object_release( p_aout );