1 /*****************************************************************************
2 * intf.c : audio output API towards the interface modules
3 *****************************************************************************
4 * Copyright (C) 2002-2004 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 *****************************************************************************/
27 #include <stdlib.h> /* calloc(), malloc(), free() */
32 #include "audio_output.h"
33 #include "aout_internal.h"
39 * The hardware volume cannot be set if the output module gets deleted, so
40 * we must take the mixer lock. The software volume cannot be set while the
41 * mixer is running, so we need the mixer lock (too).
43 * Here is a schematic of the i_volume range :
45 * |------------------------------+---------------------------------------|
48 * Between 0 and pi_soft, the volume is done in hardware by the output
49 * module. Above, the output module will change p_aout->mixer.i_multiplier
50 * (done in software). This scaling may result * in cropping errors and
51 * should be avoided as much as possible.
53 * It is legal to have *pi_soft == 0, and do everything in software.
54 * It is also legal to have *pi_soft == 1024, and completely avoid
55 * software scaling. However, some streams (esp. A/52) are encoded with
56 * a very low volume and users may complain.
59 /*****************************************************************************
60 * aout_VolumeGet : get the volume of the output device
61 *****************************************************************************/
62 int __aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
65 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
68 if ( pi_volume == NULL ) return -1;
72 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
76 vlc_mutex_lock( &p_aout->mixer_lock );
77 if ( !p_aout->mixer.b_error )
79 i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
83 *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
85 vlc_mutex_unlock( &p_aout->mixer_lock );
87 vlc_object_release( p_aout );
91 /*****************************************************************************
92 * aout_VolumeSet : set the volume of the output device
93 *****************************************************************************/
94 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
97 aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT, FIND_ANYWHERE );
100 config_PutInt( p_object, "volume", i_volume );
102 val.b_bool = VLC_TRUE;
103 var_Set( p_object->p_vlc, "volume-change", val );
105 if ( p_aout == NULL ) return 0;
107 vlc_mutex_lock( &p_aout->mixer_lock );
108 if ( !p_aout->mixer.b_error )
110 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
112 vlc_mutex_unlock( &p_aout->mixer_lock );
114 var_Set( p_aout, "intf-change", val );
115 vlc_object_release( p_aout );
119 /*****************************************************************************
120 * aout_VolumeInfos : get the boundary pi_soft
121 *****************************************************************************/
122 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
124 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
128 if ( p_aout == NULL ) return 0;
130 vlc_mutex_lock( &p_aout->mixer_lock );
131 if ( p_aout->mixer.b_error )
133 /* The output module is destroyed. */
138 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
140 vlc_mutex_unlock( &p_aout->mixer_lock );
142 vlc_object_release( p_aout );
146 /*****************************************************************************
147 * aout_VolumeUp : raise the output volume
148 *****************************************************************************
149 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
151 *****************************************************************************/
152 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
153 audio_volume_t * pi_volume )
155 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
157 int i_result = 0, i_volume = 0, i_volume_step = 0;
159 i_volume_step = config_GetInt( p_object->p_vlc, "volume-step" );
160 i_volume = config_GetInt( p_object, "volume" );
161 i_volume += i_volume_step * i_nb_steps;
162 if ( i_volume > AOUT_VOLUME_MAX )
164 i_volume = AOUT_VOLUME_MAX;
166 config_PutInt( p_object, "volume", i_volume );
167 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
168 var_SetInteger( p_object->p_libvlc, "saved-volume" ,
169 (audio_volume_t) i_volume );
170 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
172 if ( p_aout == NULL ) return 0;
174 vlc_mutex_lock( &p_aout->mixer_lock );
175 if ( !p_aout->mixer.b_error )
177 i_result = p_aout->output.pf_volume_set( p_aout,
178 (audio_volume_t) i_volume );
180 vlc_mutex_unlock( &p_aout->mixer_lock );
182 vlc_object_release( p_aout );
186 /*****************************************************************************
187 * aout_VolumeDown : lower the output volume
188 *****************************************************************************
189 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
191 *****************************************************************************/
192 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
193 audio_volume_t * pi_volume )
195 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
197 int i_result = 0, i_volume = 0, i_volume_step = 0;
199 i_volume_step = config_GetInt( p_object->p_vlc, "volume-step" );
200 i_volume = config_GetInt( p_object, "volume" );
201 i_volume -= i_volume_step * i_nb_steps;
202 if ( i_volume < AOUT_VOLUME_MIN )
204 i_volume = AOUT_VOLUME_MIN;
206 config_PutInt( p_object, "volume", i_volume );
207 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
208 var_SetInteger( p_object->p_libvlc, "saved-volume", (audio_volume_t) i_volume );
209 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
211 if ( p_aout == NULL ) return 0;
213 vlc_mutex_lock( &p_aout->mixer_lock );
214 if ( !p_aout->mixer.b_error )
216 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
218 vlc_mutex_unlock( &p_aout->mixer_lock );
220 vlc_object_release( p_aout );
224 /*****************************************************************************
225 * aout_VolumeMute : Mute/un-mute the output volume
226 *****************************************************************************
227 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
228 * function (muted => 0).
229 *****************************************************************************/
230 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
233 audio_volume_t i_volume;
235 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
239 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
240 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
241 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
242 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
247 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
248 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
250 i_result = aout_VolumeSet( p_object, i_volume );
251 if ( pi_volume != NULL ) *pi_volume = i_volume;
258 * The next functions are not supposed to be called by the interface, but
259 * are placeholders for software-only scaling.
262 /* Meant to be called by the output plug-in's Open(). */
263 void aout_VolumeSoftInit( aout_instance_t * p_aout )
267 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
268 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
269 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
271 i_volume = config_GetInt( p_aout, "volume" );
272 if ( i_volume < AOUT_VOLUME_MIN )
274 i_volume = AOUT_VOLUME_DEFAULT;
276 else if ( i_volume > AOUT_VOLUME_MAX )
278 i_volume = AOUT_VOLUME_MAX;
281 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
284 /* Placeholder for pf_volume_infos(). */
285 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
291 /* Placeholder for pf_volume_get(). */
292 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
294 *pi_volume = p_aout->output.i_volume;
299 /* Placeholder for pf_volume_set(). */
300 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
302 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
303 p_aout->output.i_volume = i_volume;
308 * The next functions are not supposed to be called by the interface, but
309 * are placeholders for unsupported scaling.
312 /* Meant to be called by the output plug-in's Open(). */
313 void aout_VolumeNoneInit( aout_instance_t * p_aout )
315 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
316 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
317 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
320 /* Placeholder for pf_volume_infos(). */
321 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
326 /* Placeholder for pf_volume_get(). */
327 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
332 /* Placeholder for pf_volume_set(). */
333 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
340 * Pipelines management
343 /*****************************************************************************
344 * aout_Restart : re-open the output device and rebuild the input and output
346 *****************************************************************************
347 * This function is used whenever the parameters of the output plug-in are
348 * changed (eg. selecting S/PDIF or PCM).
349 *****************************************************************************/
350 int aout_Restart( aout_instance_t * p_aout )
353 vlc_bool_t b_error = 0;
355 vlc_mutex_lock( &p_aout->mixer_lock );
357 if ( p_aout->i_nb_inputs == 0 )
359 vlc_mutex_unlock( &p_aout->mixer_lock );
360 msg_Err( p_aout, "no decoder thread" );
364 /* Lock all inputs. */
365 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
367 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
368 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
371 aout_MixerDelete( p_aout );
373 /* Re-open the output plug-in. */
374 aout_OutputDelete( p_aout );
376 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
378 /* Release all locks and report the error. */
379 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
381 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
383 vlc_mutex_unlock( &p_aout->mixer_lock );
387 if ( aout_MixerNew( p_aout ) == -1 )
389 aout_OutputDelete( p_aout );
390 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
392 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
394 vlc_mutex_unlock( &p_aout->mixer_lock );
398 /* Re-open all inputs. */
399 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
401 aout_input_t * p_input = p_aout->pp_inputs[i];
403 b_error |= aout_InputNew( p_aout, p_input );
404 p_input->b_changed = 1;
405 vlc_mutex_unlock( &p_input->lock );
408 vlc_mutex_unlock( &p_aout->mixer_lock );
413 /*****************************************************************************
414 * aout_FindAndRestart : find the audio output instance and restart
415 *****************************************************************************
416 * This is used for callbacks of the configuration variables, and we believe
417 * that when those are changed, it is a significant change which implies
418 * rebuilding the audio-device and audio-channels variables.
419 *****************************************************************************/
420 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
421 vlc_value_t oldval, vlc_value_t val, void *p_data )
423 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
426 if ( p_aout == NULL ) return VLC_SUCCESS;
428 if ( var_Type( p_aout, "audio-device" ) != 0 )
430 var_Destroy( p_aout, "audio-device" );
432 if ( var_Type( p_aout, "audio-channels" ) != 0 )
434 var_Destroy( p_aout, "audio-channels" );
437 aout_Restart( p_aout );
438 vlc_object_release( p_aout );
443 /*****************************************************************************
444 * aout_ChannelsRestart : change the audio device or channels and restart
445 *****************************************************************************/
446 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
447 vlc_value_t old_value, vlc_value_t new_value,
450 aout_instance_t * p_aout = (aout_instance_t *)p_this;
452 if ( !strcmp( psz_variable, "audio-device" ) )
454 /* This is supposed to be a significant change and supposes
455 * rebuilding the channel choices. */
456 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
458 var_Destroy( p_aout, "audio-channels" );
461 aout_Restart( p_aout );