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->mixer.b_error )
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;
113 aout_lock_mixer( p_aout );
115 if ( !p_aout->mixer.b_error )
116 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
118 aout_unlock_mixer( p_aout );
120 var_SetBool( p_aout, "intf-change", true );
121 vlc_object_release( p_aout );
125 /*****************************************************************************
126 * aout_VolumeInfos : get the boundary pi_soft
127 *****************************************************************************/
128 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
130 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
134 if ( p_aout == NULL ) return 0;
136 aout_lock_mixer( p_aout );
137 if ( p_aout->mixer.b_error )
139 /* The output module is destroyed. */
144 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
146 aout_unlock_mixer( p_aout );
148 vlc_object_release( p_aout );
152 /*****************************************************************************
153 * aout_VolumeUp : raise the output volume
154 *****************************************************************************
155 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
157 *****************************************************************************/
158 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
159 audio_volume_t * pi_volume )
162 const int i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
164 int i_volume = config_GetInt( p_object, "volume" ) +
165 i_volume_step * i_nb_steps;
166 if ( i_volume > AOUT_VOLUME_MAX )
167 i_volume = AOUT_VOLUME_MAX;
168 else if ( i_volume < AOUT_VOLUME_MIN )
169 i_volume = AOUT_VOLUME_MIN;
171 config_PutInt( p_object, "volume", i_volume );
172 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
173 var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
174 if ( pi_volume != NULL )
175 *pi_volume = i_volume;
177 var_SetBool( p_object->p_libvlc, "volume-change", true );
179 aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
181 if ( p_aout == NULL )
185 aout_lock_mixer( p_aout );
186 if ( !p_aout->mixer.b_error )
187 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
189 i_result = VLC_SUCCESS;
190 aout_unlock_mixer( p_aout );
192 vlc_object_release( p_aout );
196 /*****************************************************************************
197 * aout_VolumeDown : lower the output volume
198 *****************************************************************************
199 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
201 *****************************************************************************/
202 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
203 audio_volume_t * pi_volume )
205 return __aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
208 /*****************************************************************************
209 * aout_ToggleMute : Mute/un-mute the output volume
210 *****************************************************************************
211 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
212 * function (muted => 0).
213 *****************************************************************************/
214 int __aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
217 audio_volume_t i_volume;
219 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
223 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
224 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
225 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
226 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
231 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
232 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
234 i_result = aout_VolumeSet( p_object, i_volume );
235 if ( pi_volume != NULL ) *pi_volume = i_volume;
242 * The next functions are not supposed to be called by the interface, but
243 * are placeholders for software-only scaling.
246 /* Meant to be called by the output plug-in's Open(). */
247 void aout_VolumeSoftInit( aout_instance_t * p_aout )
251 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
252 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
253 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
255 i_volume = config_GetInt( p_aout, "volume" );
256 if ( i_volume < AOUT_VOLUME_MIN )
258 i_volume = AOUT_VOLUME_DEFAULT;
260 else if ( i_volume > AOUT_VOLUME_MAX )
262 i_volume = AOUT_VOLUME_MAX;
265 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
268 /* Placeholder for pf_volume_infos(). */
269 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
276 /* Placeholder for pf_volume_get(). */
277 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
279 *pi_volume = p_aout->output.i_volume;
284 /* Placeholder for pf_volume_set(). */
285 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
287 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
288 p_aout->output.i_volume = i_volume;
293 * The next functions are not supposed to be called by the interface, but
294 * are placeholders for unsupported scaling.
297 /* Meant to be called by the output plug-in's Open(). */
298 void aout_VolumeNoneInit( aout_instance_t * p_aout )
300 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
301 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
302 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
305 /* Placeholder for pf_volume_infos(). */
306 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
308 (void)p_aout; (void)pi_soft;
312 /* Placeholder for pf_volume_get(). */
313 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
315 (void)p_aout; (void)pi_volume;
319 /* Placeholder for pf_volume_set(). */
320 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
322 (void)p_aout; (void)i_volume;
328 * Pipelines management
331 /*****************************************************************************
332 * aout_Restart : re-open the output device and rebuild the input and output
334 *****************************************************************************
335 * This function is used whenever the parameters of the output plug-in are
336 * changed (eg. selecting S/PDIF or PCM).
337 *****************************************************************************/
338 static int aout_Restart( aout_instance_t * p_aout )
343 aout_lock_mixer( p_aout );
345 if ( p_aout->i_nb_inputs == 0 )
347 aout_unlock_mixer( p_aout );
348 msg_Err( p_aout, "no decoder thread" );
352 /* Lock all inputs. */
353 aout_lock_input_fifos( p_aout );
355 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
357 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
358 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
361 aout_MixerDelete( p_aout );
363 /* Re-open the output plug-in. */
364 aout_OutputDelete( p_aout );
366 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
368 /* Release all locks and report the error. */
369 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
371 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
373 aout_unlock_input_fifos( p_aout );
374 aout_unlock_mixer( p_aout );
378 if ( aout_MixerNew( p_aout ) == -1 )
380 aout_OutputDelete( p_aout );
381 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
383 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
385 aout_unlock_input_fifos( p_aout );
386 aout_unlock_mixer( p_aout );
390 /* Re-open all inputs. */
391 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
393 aout_input_t * p_input = p_aout->pp_inputs[i];
394 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
395 p_input->b_changed = 1;
396 aout_unlock_input( p_aout, p_input );
399 aout_unlock_input_fifos( p_aout );
400 aout_unlock_mixer( p_aout );
405 /*****************************************************************************
406 * aout_FindAndRestart : find the audio output instance and restart
407 *****************************************************************************
408 * This is used for callbacks of the configuration variables, and we believe
409 * that when those are changed, it is a significant change which implies
410 * rebuilding the audio-device and audio-channels variables.
411 *****************************************************************************/
412 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
413 vlc_value_t oldval, vlc_value_t newval, void *p_data )
415 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
418 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
419 if ( p_aout == NULL ) return VLC_SUCCESS;
421 var_Destroy( p_aout, "audio-device" );
422 var_Destroy( p_aout, "audio-channels" );
424 aout_Restart( p_aout );
425 vlc_object_release( p_aout );
430 /*****************************************************************************
431 * aout_ChannelsRestart : change the audio device or channels and restart
432 *****************************************************************************/
433 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
434 vlc_value_t oldval, vlc_value_t newval,
437 aout_instance_t * p_aout = (aout_instance_t *)p_this;
438 (void)oldval; (void)newval; (void)p_data;
440 if ( !strcmp( psz_variable, "audio-device" ) )
442 /* This is supposed to be a significant change and supposes
443 * rebuilding the channel choices. */
444 var_Destroy( p_aout, "audio-channels" );
446 aout_Restart( p_aout );
450 #undef aout_EnableFilter
451 /** Enable or disable an audio filter
452 * \param p_this a vlc object
453 * \param psz_name name of the filter
454 * \param b_add are we adding or removing the filter ?
456 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
459 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
462 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
465 AoutInputsMarkToRestart( p_aout );
469 vlc_object_release( p_aout );