1 /*****************************************************************************
2 * intf.c : audio output API towards the interface modules
3 *****************************************************************************
4 * Copyright (C) 2002 VideoLAN
5 * $Id: intf.c,v 1.18 2003/08/03 23:11:21 gbazin 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 )
77 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
81 config_PutInt( p_object, "volume", i_volume );
83 if ( p_aout == NULL ) return 0;
85 vlc_mutex_lock( &p_aout->mixer_lock );
86 if ( !p_aout->mixer.b_error )
88 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
90 vlc_mutex_unlock( &p_aout->mixer_lock );
92 vlc_object_release( p_aout );
96 /*****************************************************************************
97 * aout_VolumeInfos : get the boundary pi_soft
98 *****************************************************************************/
99 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
101 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
105 if ( p_aout == NULL ) return 0;
107 vlc_mutex_lock( &p_aout->mixer_lock );
108 if ( p_aout->mixer.b_error )
110 /* The output module is destroyed. */
115 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
117 vlc_mutex_unlock( &p_aout->mixer_lock );
119 vlc_object_release( p_aout );
123 /*****************************************************************************
124 * aout_VolumeUp : raise the output volume
125 *****************************************************************************
126 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
128 *****************************************************************************/
129 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
130 audio_volume_t * pi_volume )
132 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
136 i = config_GetInt( p_object, "volume" );
137 i += AOUT_VOLUME_STEP * i_nb_steps;
138 if ( i > AOUT_VOLUME_MAX )
142 config_PutInt( p_object, "volume", i );
143 config_PutInt( p_object, "saved-volume", i );
144 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
146 if ( p_aout == NULL ) return 0;
148 vlc_mutex_lock( &p_aout->mixer_lock );
149 if ( !p_aout->mixer.b_error )
151 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t)i );
153 vlc_mutex_unlock( &p_aout->mixer_lock );
155 vlc_object_release( p_aout );
159 /*****************************************************************************
160 * aout_VolumeDown : lower the output volume
161 *****************************************************************************
162 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
164 *****************************************************************************/
165 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
166 audio_volume_t * pi_volume )
168 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
172 i = config_GetInt( p_object, "volume" );
173 i -= AOUT_VOLUME_STEP * i_nb_steps;
174 if ( i < AOUT_VOLUME_MIN )
178 config_PutInt( p_object, "volume", i );
179 config_PutInt( p_object, "saved-volume", i );
180 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
182 if ( p_aout == NULL ) return 0;
184 vlc_mutex_lock( &p_aout->mixer_lock );
185 if ( !p_aout->mixer.b_error )
187 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t)i );
189 vlc_mutex_unlock( &p_aout->mixer_lock );
191 vlc_object_release( p_aout );
195 /*****************************************************************************
196 * aout_VolumeMute : Mute/un-mute the output volume
197 *****************************************************************************
198 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
199 * function (muted => 0).
200 *****************************************************************************/
201 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
204 audio_volume_t i_volume;
206 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
210 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
211 config_PutInt( p_object, "saved-volume", (int)i_volume );
212 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
217 i_volume = (audio_volume_t)config_GetInt( p_object, "saved-volume" );
218 i_result = aout_VolumeSet( p_object, i_volume );
219 if ( pi_volume != NULL ) *pi_volume = i_volume;
226 * The next functions are not supposed to be called by the interface, but
227 * are placeholders for software-only scaling.
230 /* Meant to be called by the output plug-in's Open(). */
231 void aout_VolumeSoftInit( aout_instance_t * p_aout )
235 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
236 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
237 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
239 i_volume = config_GetInt( p_aout, "volume" );
240 if ( i_volume < AOUT_VOLUME_MIN )
242 i_volume = AOUT_VOLUME_DEFAULT;
244 else if ( i_volume > AOUT_VOLUME_MAX )
246 i_volume = AOUT_VOLUME_MAX;
249 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
252 /* Placeholder for pf_volume_infos(). */
253 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
259 /* Placeholder for pf_volume_get(). */
260 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
262 *pi_volume = p_aout->output.i_volume;
267 /* Placeholder for pf_volume_set(). */
268 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
270 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
271 p_aout->output.i_volume = i_volume;
276 * The next functions are not supposed to be called by the interface, but
277 * are placeholders for unsupported scaling.
280 /* Meant to be called by the output plug-in's Open(). */
281 void aout_VolumeNoneInit( aout_instance_t * p_aout )
283 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
284 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
285 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
288 /* Placeholder for pf_volume_infos(). */
289 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
294 /* Placeholder for pf_volume_get(). */
295 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
300 /* Placeholder for pf_volume_set(). */
301 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
308 * Pipelines management
311 /*****************************************************************************
312 * aout_Restart : re-open the output device and rebuild the input and output
314 *****************************************************************************
315 * This function is used whenever the parameters of the output plug-in are
316 * changed (eg. selecting S/PDIF or PCM).
317 *****************************************************************************/
318 int aout_Restart( aout_instance_t * p_aout )
321 vlc_bool_t b_error = 0;
323 vlc_mutex_lock( &p_aout->mixer_lock );
325 if ( p_aout->i_nb_inputs == 0 )
327 vlc_mutex_unlock( &p_aout->mixer_lock );
328 msg_Err( p_aout, "no decoder thread" );
332 /* Lock all inputs. */
333 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
335 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
336 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
339 aout_MixerDelete( p_aout );
341 /* Re-open the output plug-in. */
342 aout_OutputDelete( p_aout );
344 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
346 /* Release all locks and report the error. */
347 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
349 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
351 vlc_mutex_unlock( &p_aout->mixer_lock );
355 if ( aout_MixerNew( p_aout ) == -1 )
357 aout_OutputDelete( p_aout );
358 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
360 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
362 vlc_mutex_unlock( &p_aout->mixer_lock );
366 /* Re-open all inputs. */
367 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
369 aout_input_t * p_input = p_aout->pp_inputs[i];
371 b_error |= aout_InputNew( p_aout, p_input );
372 p_input->b_changed = 1;
373 vlc_mutex_unlock( &p_input->lock );
376 vlc_mutex_unlock( &p_aout->mixer_lock );
381 /*****************************************************************************
382 * aout_FindAndRestart : find the audio output instance and restart
383 *****************************************************************************
384 * This is used for callbacks of the configuration variables, and we believe
385 * that when those are changed, it is a significant change which implies
386 * rebuilding the audio-device and audio-channels variables.
387 *****************************************************************************/
388 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
389 vlc_value_t oldval, vlc_value_t val, void *p_data )
391 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
394 if ( p_aout == NULL ) return VLC_SUCCESS;
396 if ( var_Type( p_aout, "audio-device" ) != 0 )
398 var_Destroy( p_aout, "audio-device" );
400 if ( var_Type( p_aout, "audio-channels" ) != 0 )
402 var_Destroy( p_aout, "audio-channels" );
405 aout_Restart( p_aout );
406 vlc_object_release( p_aout );
411 /*****************************************************************************
412 * aout_ChannelsRestart : change the audio device or channels and restart
413 *****************************************************************************/
414 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
415 vlc_value_t old_value, vlc_value_t new_value,
418 aout_instance_t * p_aout = (aout_instance_t *)p_this;
420 if ( !strcmp( psz_variable, "audio-device" ) )
422 /* This is supposed to be a significant change and supposes
423 * rebuilding the channel choices. */
424 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
426 var_Destroy( p_aout, "audio-channels" );
429 aout_Restart( p_aout );