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 vlc_mutex_lock( &p_aout->mixer_lock );
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 vlc_mutex_unlock( &p_aout->mixer_lock );
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 )
102 aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT, FIND_ANYWHERE );
105 config_PutInt( p_object, "volume", i_volume );
108 var_Set( p_object->p_libvlc, "volume-change", val );
110 if ( p_aout == NULL ) return 0;
112 vlc_mutex_lock( &p_aout->mixer_lock );
113 if ( !p_aout->mixer.b_error )
115 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
117 vlc_mutex_unlock( &p_aout->mixer_lock );
119 var_Set( p_aout, "intf-change", val );
120 vlc_object_release( p_aout );
124 /*****************************************************************************
125 * aout_VolumeInfos : get the boundary pi_soft
126 *****************************************************************************/
127 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
129 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
133 if ( p_aout == NULL ) return 0;
135 vlc_mutex_lock( &p_aout->mixer_lock );
136 if ( p_aout->mixer.b_error )
138 /* The output module is destroyed. */
143 i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
145 vlc_mutex_unlock( &p_aout->mixer_lock );
147 vlc_object_release( p_aout );
151 /*****************************************************************************
152 * aout_VolumeUp : raise the output volume
153 *****************************************************************************
154 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
156 *****************************************************************************/
157 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
158 audio_volume_t * pi_volume )
161 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
163 int i_result = 0, i_volume = 0, i_volume_step = 0;
165 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
166 i_volume = config_GetInt( p_object, "volume" );
167 i_volume += i_volume_step * i_nb_steps;
168 if ( i_volume > AOUT_VOLUME_MAX )
170 i_volume = AOUT_VOLUME_MAX;
172 config_PutInt( p_object, "volume", i_volume );
173 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
174 var_SetInteger( p_object->p_libvlc, "saved-volume" ,
175 (audio_volume_t) i_volume );
176 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
179 var_Set( p_object->p_libvlc, "volume-change", val );
181 if ( p_aout == NULL ) return 0;
183 vlc_mutex_lock( &p_aout->mixer_lock );
184 if ( !p_aout->mixer.b_error )
186 i_result = p_aout->output.pf_volume_set( p_aout,
187 (audio_volume_t) i_volume );
189 vlc_mutex_unlock( &p_aout->mixer_lock );
191 vlc_object_release( p_aout );
195 /*****************************************************************************
196 * aout_VolumeDown : lower the output volume
197 *****************************************************************************
198 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
200 *****************************************************************************/
201 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
202 audio_volume_t * pi_volume )
205 aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
207 int i_result = 0, i_volume = 0, i_volume_step = 0;
209 i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
210 i_volume = config_GetInt( p_object, "volume" );
211 i_volume -= i_volume_step * i_nb_steps;
212 if ( i_volume < AOUT_VOLUME_MIN )
214 i_volume = AOUT_VOLUME_MIN;
216 config_PutInt( p_object, "volume", i_volume );
217 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
218 var_SetInteger( p_object->p_libvlc, "saved-volume", (audio_volume_t) i_volume );
219 if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
222 var_Set( p_object->p_libvlc, "volume-change", val );
224 if ( p_aout == NULL ) return 0;
226 vlc_mutex_lock( &p_aout->mixer_lock );
227 if ( !p_aout->mixer.b_error )
229 i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
231 vlc_mutex_unlock( &p_aout->mixer_lock );
233 vlc_object_release( p_aout );
237 /*****************************************************************************
238 * aout_VolumeMute : Mute/un-mute the output volume
239 *****************************************************************************
240 * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
241 * function (muted => 0).
242 *****************************************************************************/
243 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
246 audio_volume_t i_volume;
248 i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
252 i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
253 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
254 var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
255 if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
260 var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
261 i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
263 i_result = aout_VolumeSet( p_object, i_volume );
264 if ( pi_volume != NULL ) *pi_volume = i_volume;
271 * The next functions are not supposed to be called by the interface, but
272 * are placeholders for software-only scaling.
275 /* Meant to be called by the output plug-in's Open(). */
276 void aout_VolumeSoftInit( aout_instance_t * p_aout )
280 p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
281 p_aout->output.pf_volume_get = aout_VolumeSoftGet;
282 p_aout->output.pf_volume_set = aout_VolumeSoftSet;
284 i_volume = config_GetInt( p_aout, "volume" );
285 if ( i_volume < AOUT_VOLUME_MIN )
287 i_volume = AOUT_VOLUME_DEFAULT;
289 else if ( i_volume > AOUT_VOLUME_MAX )
291 i_volume = AOUT_VOLUME_MAX;
294 aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
297 /* Placeholder for pf_volume_infos(). */
298 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
305 /* Placeholder for pf_volume_get(). */
306 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
308 *pi_volume = p_aout->output.i_volume;
313 /* Placeholder for pf_volume_set(). */
314 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
316 aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
317 p_aout->output.i_volume = i_volume;
322 * The next functions are not supposed to be called by the interface, but
323 * are placeholders for unsupported scaling.
326 /* Meant to be called by the output plug-in's Open(). */
327 void aout_VolumeNoneInit( aout_instance_t * p_aout )
329 p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
330 p_aout->output.pf_volume_get = aout_VolumeNoneGet;
331 p_aout->output.pf_volume_set = aout_VolumeNoneSet;
334 /* Placeholder for pf_volume_infos(). */
335 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
337 (void)p_aout; (void)pi_soft;
341 /* Placeholder for pf_volume_get(). */
342 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
344 (void)p_aout; (void)pi_volume;
348 /* Placeholder for pf_volume_set(). */
349 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
351 (void)p_aout; (void)i_volume;
357 * Pipelines management
360 /*****************************************************************************
361 * aout_Restart : re-open the output device and rebuild the input and output
363 *****************************************************************************
364 * This function is used whenever the parameters of the output plug-in are
365 * changed (eg. selecting S/PDIF or PCM).
366 *****************************************************************************/
367 static int aout_Restart( aout_instance_t * p_aout )
372 vlc_mutex_lock( &p_aout->mixer_lock );
374 if ( p_aout->i_nb_inputs == 0 )
376 vlc_mutex_unlock( &p_aout->mixer_lock );
377 msg_Err( p_aout, "no decoder thread" );
381 /* Lock all inputs. */
382 vlc_mutex_lock( &p_aout->input_fifos_lock );
384 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
386 vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
387 aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
390 aout_MixerDelete( p_aout );
392 /* Re-open the output plug-in. */
393 aout_OutputDelete( p_aout );
395 if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
397 /* Release all locks and report the error. */
398 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
400 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
402 vlc_mutex_unlock( &p_aout->input_fifos_lock );
403 vlc_mutex_unlock( &p_aout->mixer_lock );
407 if ( aout_MixerNew( p_aout ) == -1 )
409 aout_OutputDelete( p_aout );
410 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
412 vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
414 vlc_mutex_unlock( &p_aout->input_fifos_lock );
415 vlc_mutex_unlock( &p_aout->mixer_lock );
419 /* Re-open all inputs. */
420 for ( i = 0; i < p_aout->i_nb_inputs; i++ )
422 aout_input_t * p_input = p_aout->pp_inputs[i];
424 b_error |= aout_InputNew( p_aout, p_input );
425 p_input->b_changed = 1;
426 vlc_mutex_unlock( &p_input->lock );
429 vlc_mutex_unlock( &p_aout->input_fifos_lock );
430 vlc_mutex_unlock( &p_aout->mixer_lock );
435 /*****************************************************************************
436 * aout_FindAndRestart : find the audio output instance and restart
437 *****************************************************************************
438 * This is used for callbacks of the configuration variables, and we believe
439 * that when those are changed, it is a significant change which implies
440 * rebuilding the audio-device and audio-channels variables.
441 *****************************************************************************/
442 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
443 vlc_value_t oldval, vlc_value_t newval, void *p_data )
445 aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
448 (void)psz_name; (void)oldval; (void)newval; (void)p_data;
449 if ( p_aout == NULL ) return VLC_SUCCESS;
451 if ( var_Type( p_aout, "audio-device" ) != 0 )
453 var_Destroy( p_aout, "audio-device" );
455 if ( var_Type( p_aout, "audio-channels" ) != 0 )
457 var_Destroy( p_aout, "audio-channels" );
460 aout_Restart( p_aout );
461 vlc_object_release( p_aout );
466 /*****************************************************************************
467 * aout_ChannelsRestart : change the audio device or channels and restart
468 *****************************************************************************/
469 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
470 vlc_value_t oldval, vlc_value_t newval,
473 aout_instance_t * p_aout = (aout_instance_t *)p_this;
474 (void)oldval; (void)newval; (void)p_data;
476 if ( !strcmp( psz_variable, "audio-device" ) )
478 /* This is supposed to be a significant change and supposes
479 * rebuilding the channel choices. */
480 if ( var_Type( p_aout, "audio-channels" ) >= 0 )
482 var_Destroy( p_aout, "audio-channels" );
485 aout_Restart( p_aout );
489 /** Enable or disable an audio filter
490 * \param p_this a vlc object
491 * \param psz_name name of the filter
492 * \param b_add are we adding or removing the filter ?
494 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
497 aout_instance_t *p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
500 if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
503 AoutInputsMarkToRestart( p_aout );
507 vlc_object_release( p_aout );
511 * Change audio visualization
512 * -1 goes backwards, +1 goes forward
514 char *aout_VisualChange( vlc_object_t *p_this, int i_skip )
516 (void)p_this; (void)i_skip;
517 msg_Err( p_this, "FIXME: %s (%s %d) isn't implemented.", __func__,
518 __FILE__, __LINE__ );
519 return strdup("foobar");