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 aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT, FIND_ANYWHERE );
104 config_PutInt( p_object, "volume", i_volume );
105 var_SetBool( p_object->p_libvlc, "volume-change", true );
107 if ( p_aout == NULL ) return 0;
109 aout_lock_mixer( p_aout );
110 if ( !p_aout->mixer.b_error )
112 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
114 aout_unlock_mixer( p_aout );
116 var_SetBool( p_aout, "intf-change", true );
117 vlc_object_release( p_aout );
121 /*****************************************************************************
122 * aout_VolumeInfos : get the boundary pi_soft
123 *****************************************************************************/
124 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
126 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
130 if ( p_aout == NULL ) return 0;
132 aout_lock_mixer( p_aout );
133 if ( p_aout->mixer.b_error )
135 /* The output module is destroyed. */
140 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
142 aout_unlock_mixer( p_aout );
144 vlc_object_release( p_aout );
148 /*****************************************************************************
149 * aout_VolumeUp : raise the output volume
150 *****************************************************************************
151 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
153 *****************************************************************************/
154 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
155 audio_volume_t * pi_volume )
157 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
159 int i_result = 0, i_volume = 0, i_volume_step = 0;
161 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
162 i_volume = config_GetInt( p_object, "volume" );
163 i_volume += i_volume_step * i_nb_steps;
164 if ( i_volume > AOUT_VOLUME_MAX )
166 i_volume = AOUT_VOLUME_MAX;
168 config_PutInt( p_object, "volume", i_volume );
169 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
170 var_SetInteger( p_object->p_libvlc, "saved-volume" ,
171 (audio_volume_t) i_volume );
172 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
174 var_SetBool( p_object->p_libvlc, "volume-change", true );
176 if ( p_aout == NULL ) return 0;
178 aout_lock_mixer( p_aout );
179 if ( !p_aout->mixer.b_error )
181 i_result = p_aout->output.pf_volume_set( p_aout,
182 (audio_volume_t) i_volume );
184 aout_unlock_mixer( p_aout );
186 vlc_object_release( p_aout );
190 /*****************************************************************************
191 * aout_VolumeDown : lower the output volume
192 *****************************************************************************
193 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
195 *****************************************************************************/
196 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
197 audio_volume_t * pi_volume )
199 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
201 int i_result = 0, i_volume = 0, i_volume_step = 0;
203 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
204 i_volume = config_GetInt( p_object, "volume" );
205 i_volume -= i_volume_step * i_nb_steps;
206 if ( i_volume < AOUT_VOLUME_MIN )
208 i_volume = AOUT_VOLUME_MIN;
210 config_PutInt( p_object, "volume", i_volume );
211 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
212 var_SetInteger( p_object->p_libvlc, "saved-volume", (audio_volume_t) i_volume );
213 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
215 var_SetBool( p_object->p_libvlc, "volume-change", true );
217 if ( p_aout == NULL ) return 0;
219 aout_lock_mixer( p_aout );
220 if ( !p_aout->mixer.b_error )
222 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
224 aout_unlock_mixer( p_aout );
226 vlc_object_release( p_aout );
230 /*****************************************************************************
231 * aout_VolumeMute : Mute/un-mute the output volume
232 *****************************************************************************
233 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
234 * function (muted => 0).
235 *****************************************************************************/
236 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
239 audio_volume_t i_volume;
241 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
245 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
246 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
247 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
248 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
253 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
254 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
256 i_result = aout_VolumeSet( p_object, i_volume );
257 if ( pi_volume != NULL ) *pi_volume = i_volume;
264 * The next functions are not supposed to be called by the interface, but
265 * are placeholders for software-only scaling.
268 /* Meant to be called by the output plug-in's Open(). */
269 void aout_VolumeSoftInit( aout_instance_t * p_aout )
273 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
274 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
275 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
277 i_volume = config_GetInt( p_aout, "volume" );
278 if ( i_volume < AOUT_VOLUME_MIN )
280 i_volume = AOUT_VOLUME_DEFAULT;
282 else if ( i_volume > AOUT_VOLUME_MAX )
284 i_volume = AOUT_VOLUME_MAX;
287 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
290 /* Placeholder for pf_volume_infos(). */
291 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
298 /* Placeholder for pf_volume_get(). */
299 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
301 *pi_volume = p_aout->output.i_volume;
306 /* Placeholder for pf_volume_set(). */
307 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
309 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
310 p_aout->output.i_volume = i_volume;
315 * The next functions are not supposed to be called by the interface, but
316 * are placeholders for unsupported scaling.
319 /* Meant to be called by the output plug-in's Open(). */
320 void aout_VolumeNoneInit( aout_instance_t * p_aout )
322 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
323 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
324 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
327 /* Placeholder for pf_volume_infos(). */
328 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
330 (void)p_aout; (void)pi_soft;
334 /* Placeholder for pf_volume_get(). */
335 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
337 (void)p_aout; (void)pi_volume;
341 /* Placeholder for pf_volume_set(). */
342 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
344 (void)p_aout; (void)i_volume;
350 * Pipelines management
353 /*****************************************************************************
354 * aout_Restart : re-open the output device and rebuild the input and output
356 *****************************************************************************
357 * This function is used whenever the parameters of the output plug-in are
358 * changed (eg. selecting S/PDIF or PCM).
359 *****************************************************************************/
360 static int aout_Restart( aout_instance_t * p_aout )
365 aout_lock_mixer( p_aout );
367 if ( p_aout->i_nb_inputs == 0 )
369 aout_unlock_mixer( p_aout );
370 msg_Err( p_aout, "no decoder thread" );
374 /* Lock all inputs. */
375 aout_lock_input_fifos( p_aout );
377 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
379 aout_lock_input( p_aout, p_aout->pp_inputs[i] );
380 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
383 aout_MixerDelete( p_aout );
385 /* Re-open the output plug-in. */
386 aout_OutputDelete( p_aout );
388 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
390 /* Release all locks and report the error. */
391 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
393 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
395 aout_unlock_input_fifos( p_aout );
396 aout_unlock_mixer( p_aout );
400 if ( aout_MixerNew( p_aout ) == -1 )
402 aout_OutputDelete( p_aout );
403 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
405 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
407 aout_unlock_input_fifos( p_aout );
408 aout_unlock_mixer( p_aout );
412 /* Re-open all inputs. */
413 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
415 aout_input_t * p_input = p_aout->pp_inputs[i];
416 b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
417 p_input->b_changed = 1;
418 aout_unlock_input( p_aout, p_input );
421 aout_unlock_input_fifos( p_aout );
422 aout_unlock_mixer( p_aout );
427 /*****************************************************************************
428 * aout_FindAndRestart : find the audio output instance and restart
429 *****************************************************************************
430 * This is used for callbacks of the configuration variables, and we believe
431 * that when those are changed, it is a significant change which implies
432 * rebuilding the audio-device and audio-channels variables.
433 *****************************************************************************/
434 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
435 vlc_value_t oldval, vlc_value_t newval, void *p_data )
437 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
440 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
441 if ( p_aout == NULL ) return VLC_SUCCESS;
443 if ( var_Type( p_aout, "audio-device" ) != 0 )
445 var_Destroy( p_aout, "audio-device" );
447 if ( var_Type( p_aout, "audio-channels" ) != 0 )
449 var_Destroy( p_aout, "audio-channels" );
452 aout_Restart( p_aout );
453 vlc_object_release( p_aout );
458 /*****************************************************************************
459 * aout_ChannelsRestart : change the audio device or channels and restart
460 *****************************************************************************/
461 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
462 vlc_value_t oldval, vlc_value_t newval,
465 aout_instance_t * p_aout = (aout_instance_t *)p_this;
466 (void)oldval; (void)newval; (void)p_data;
468 if ( !strcmp( psz_variable, "audio-device" ) )
470 /* This is supposed to be a significant change and supposes
471 * rebuilding the channel choices. */
472 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
474 var_Destroy( p_aout, "audio-channels" );
477 aout_Restart( p_aout );
481 /** Enable or disable an audio filter
482 * \param p_this a vlc object
483 * \param psz_name name of the filter
484 * \param b_add are we adding or removing the filter ?
486 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
489 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
492 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
495 AoutInputsMarkToRestart( p_aout );
499 vlc_object_release( p_aout );
503 * Change audio visualization
504 * -1 goes backwards, +1 goes forward
506 char *aout_VisualChange( vlc_object_t *p_this, int i_skip )
508 (void)p_this; (void)i_skip;
509 msg_Err( p_this, "FIXME: %s (%s %d) isn't implemented.", __func__,
510 __FILE__, __LINE__ );
511 return strdup("foobar");