1 /*****************************************************************************
2 * intf.c : audio output API towards the interface modules
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: intf.c,v 1.19 2003/10/30 22:34:48 hartman Exp $
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., 59 Temple Place - Suite 330, Boston, MA 02111, 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 )
66 i = config_GetInt( p_object, "volume" );
67 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
72 /*****************************************************************************
73 * aout_VolumeSet : set the volume of the output device
74 *****************************************************************************/
75 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
78 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
82 config_PutInt( p_object, "volume", i_volume );
84 if ( p_aout == NULL ) return 0;
86 vlc_mutex_lock( &p_aout->mixer_lock );
87 if ( !p_aout->mixer.b_error )
89 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
91 vlc_mutex_unlock( &p_aout->mixer_lock );
93 vlc_object_release( p_aout );
95 val.b_bool = VLC_TRUE;
96 var_Set( p_aout, "intf-change", val );
100 /*****************************************************************************
101 * aout_VolumeInfos : get the boundary pi_soft
102 *****************************************************************************/
103 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
105 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
109 if ( p_aout == NULL ) return 0;
111 vlc_mutex_lock( &p_aout->mixer_lock );
112 if ( p_aout->mixer.b_error )
114 /* The output module is destroyed. */
119 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
121 vlc_mutex_unlock( &p_aout->mixer_lock );
123 vlc_object_release( p_aout );
127 /*****************************************************************************
128 * aout_VolumeUp : raise the output volume
129 *****************************************************************************
130 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
132 *****************************************************************************/
133 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
134 audio_volume_t * pi_volume )
136 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
140 i = config_GetInt( p_object, "volume" );
141 i += AOUT_VOLUME_STEP * i_nb_steps;
142 if ( i > AOUT_VOLUME_MAX )
146 config_PutInt( p_object, "volume", i );
147 config_PutInt( p_object, "saved-volume", i );
148 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
150 if ( p_aout == NULL ) return 0;
152 vlc_mutex_lock( &p_aout->mixer_lock );
153 if ( !p_aout->mixer.b_error )
155 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t)i );
157 vlc_mutex_unlock( &p_aout->mixer_lock );
159 vlc_object_release( p_aout );
163 /*****************************************************************************
164 * aout_VolumeDown : lower the output volume
165 *****************************************************************************
166 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
168 *****************************************************************************/
169 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
170 audio_volume_t * pi_volume )
172 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
176 i = config_GetInt( p_object, "volume" );
177 i -= AOUT_VOLUME_STEP * i_nb_steps;
178 if ( i < AOUT_VOLUME_MIN )
182 config_PutInt( p_object, "volume", i );
183 config_PutInt( p_object, "saved-volume", i );
184 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
186 if ( p_aout == NULL ) return 0;
188 vlc_mutex_lock( &p_aout->mixer_lock );
189 if ( !p_aout->mixer.b_error )
191 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t)i );
193 vlc_mutex_unlock( &p_aout->mixer_lock );
195 vlc_object_release( p_aout );
199 /*****************************************************************************
200 * aout_VolumeMute : Mute/un-mute the output volume
201 *****************************************************************************
202 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
203 * function (muted => 0).
204 *****************************************************************************/
205 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
208 audio_volume_t i_volume;
210 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
214 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
215 config_PutInt( p_object, "saved-volume", (int)i_volume );
216 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
221 i_volume = (audio_volume_t)config_GetInt( p_object, "saved-volume" );
222 i_result = aout_VolumeSet( p_object, i_volume );
223 if ( pi_volume != NULL ) *pi_volume = i_volume;
230 * The next functions are not supposed to be called by the interface, but
231 * are placeholders for software-only scaling.
234 /* Meant to be called by the output plug-in's Open(). */
235 void aout_VolumeSoftInit( aout_instance_t * p_aout )
239 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
240 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
241 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
243 i_volume = config_GetInt( p_aout, "volume" );
244 if ( i_volume < AOUT_VOLUME_MIN )
246 i_volume = AOUT_VOLUME_DEFAULT;
248 else if ( i_volume > AOUT_VOLUME_MAX )
250 i_volume = AOUT_VOLUME_MAX;
253 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
256 /* Placeholder for pf_volume_infos(). */
257 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
263 /* Placeholder for pf_volume_get(). */
264 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
266 *pi_volume = p_aout->output.i_volume;
271 /* Placeholder for pf_volume_set(). */
272 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
274 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
275 p_aout->output.i_volume = i_volume;
280 * The next functions are not supposed to be called by the interface, but
281 * are placeholders for unsupported scaling.
284 /* Meant to be called by the output plug-in's Open(). */
285 void aout_VolumeNoneInit( aout_instance_t * p_aout )
287 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
288 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
289 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
292 /* Placeholder for pf_volume_infos(). */
293 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
298 /* Placeholder for pf_volume_get(). */
299 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
304 /* Placeholder for pf_volume_set(). */
305 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
312 * Pipelines management
315 /*****************************************************************************
316 * aout_Restart : re-open the output device and rebuild the input and output
318 *****************************************************************************
319 * This function is used whenever the parameters of the output plug-in are
320 * changed (eg. selecting S/PDIF or PCM).
321 *****************************************************************************/
322 int aout_Restart( aout_instance_t * p_aout )
325 vlc_bool_t b_error = 0;
327 vlc_mutex_lock( &p_aout->mixer_lock );
329 if ( p_aout->i_nb_inputs == 0 )
331 vlc_mutex_unlock( &p_aout->mixer_lock );
332 msg_Err( p_aout, "no decoder thread" );
336 /* Lock all inputs. */
337 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
339 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
340 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
343 aout_MixerDelete( p_aout );
345 /* Re-open the output plug-in. */
346 aout_OutputDelete( p_aout );
348 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
350 /* Release all locks and report the error. */
351 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
353 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
355 vlc_mutex_unlock( &p_aout->mixer_lock );
359 if ( aout_MixerNew( p_aout ) == -1 )
361 aout_OutputDelete( p_aout );
362 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
364 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
366 vlc_mutex_unlock( &p_aout->mixer_lock );
370 /* Re-open all inputs. */
371 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
373 aout_input_t * p_input = p_aout->pp_inputs[i];
375 b_error |= aout_InputNew( p_aout, p_input );
376 p_input->b_changed = 1;
377 vlc_mutex_unlock( &p_input->lock );
380 vlc_mutex_unlock( &p_aout->mixer_lock );
385 /*****************************************************************************
386 * aout_FindAndRestart : find the audio output instance and restart
387 *****************************************************************************
388 * This is used for callbacks of the configuration variables, and we believe
389 * that when those are changed, it is a significant change which implies
390 * rebuilding the audio-device and audio-channels variables.
391 *****************************************************************************/
392 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
393 vlc_value_t oldval, vlc_value_t val, void *p_data )
395 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
398 if ( p_aout == NULL ) return VLC_SUCCESS;
400 if ( var_Type( p_aout, "audio-device" ) != 0 )
402 var_Destroy( p_aout, "audio-device" );
404 if ( var_Type( p_aout, "audio-channels" ) != 0 )
406 var_Destroy( p_aout, "audio-channels" );
409 aout_Restart( p_aout );
410 vlc_object_release( p_aout );
415 /*****************************************************************************
416 * aout_ChannelsRestart : change the audio device or channels and restart
417 *****************************************************************************/
418 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
419 vlc_value_t old_value, vlc_value_t new_value,
422 aout_instance_t * p_aout = (aout_instance_t *)p_this;
424 if ( !strcmp( psz_variable, "audio-device" ) )
426 /* This is supposed to be a significant change and supposes
427 * rebuilding the channel choices. */
428 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
430 var_Destroy( p_aout, "audio-channels" );
433 aout_Restart( p_aout );