set volume-change variable also in volumeUp/volumeDown, because it seemed that when...
[vlc.git] / src / audio_output / intf.c
1 /*****************************************************************************
2  * intf.c : audio output API towards the interface modules
3  *****************************************************************************
4  * Copyright (C) 2002-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *
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.
13  *
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.
18  *
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  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27
28 #include <vlc/vlc.h>
29
30 #include <stdio.h>
31 #include <stdlib.h>                            /* calloc(), malloc(), free() */
32 #include <string.h>
33
34 #include <vlc_aout.h>
35 #include "aout_internal.h"
36
37 /*
38  * Volume management
39  *
40  * The hardware volume cannot be set if the output module gets deleted, so
41  * we must take the mixer lock. The software volume cannot be set while the
42  * mixer is running, so we need the mixer lock (too).
43  *
44  * Here is a schematic of the i_volume range :
45  *
46  * |------------------------------+---------------------------------------|
47  * 0                           pi_soft                                   1024
48  *
49  * Between 0 and pi_soft, the volume is done in hardware by the output
50  * module. Above, the output module will change p_aout->mixer.i_multiplier
51  * (done in software). This scaling may result * in cropping errors and
52  * should be avoided as much as possible.
53  *
54  * It is legal to have *pi_soft == 0, and do everything in software.
55  * It is also legal to have *pi_soft == 1024, and completely avoid
56  * software scaling. However, some streams (esp. A/52) are encoded with
57  * a very low volume and users may complain.
58  */
59
60 /*****************************************************************************
61  * aout_VolumeGet : get the volume of the output device
62  *****************************************************************************/
63 int __aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
64 {
65     int i_result = 0;
66     aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
67                                                 FIND_ANYWHERE );
68
69     if ( pi_volume == NULL ) return -1;
70
71     if ( p_aout == NULL )
72     {
73         *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
74         return 0;
75     }
76
77     vlc_mutex_lock( &p_aout->mixer_lock );
78     if ( !p_aout->mixer.b_error )
79     {
80         i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
81     }
82     else
83     {
84         *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
85     }
86     vlc_mutex_unlock( &p_aout->mixer_lock );
87
88     vlc_object_release( p_aout );
89     return i_result;
90 }
91
92 /*****************************************************************************
93  * aout_VolumeSet : set the volume of the output device
94  *****************************************************************************/
95 int __aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
96 {
97     vlc_value_t val;
98     aout_instance_t *p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT, FIND_ANYWHERE );
99     int i_result = 0;
100
101     config_PutInt( p_object, "volume", i_volume );
102
103     val.b_bool = VLC_TRUE;
104     var_Set( p_object->p_libvlc, "volume-change", val );
105
106     if ( p_aout == NULL ) return 0;
107
108     vlc_mutex_lock( &p_aout->mixer_lock );
109     if ( !p_aout->mixer.b_error )
110     {
111         i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
112     }
113     vlc_mutex_unlock( &p_aout->mixer_lock );
114
115     var_Set( p_aout, "intf-change", val );
116     vlc_object_release( p_aout );
117     return i_result;
118 }
119
120 /*****************************************************************************
121  * aout_VolumeInfos : get the boundary pi_soft
122  *****************************************************************************/
123 int __aout_VolumeInfos( vlc_object_t * p_object, audio_volume_t * pi_soft )
124 {
125     aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
126                                                 FIND_ANYWHERE );
127     int i_result;
128
129     if ( p_aout == NULL ) return 0;
130
131     vlc_mutex_lock( &p_aout->mixer_lock );
132     if ( p_aout->mixer.b_error )
133     {
134         /* The output module is destroyed. */
135         i_result = -1;
136     }
137     else
138     {
139         i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
140     }
141     vlc_mutex_unlock( &p_aout->mixer_lock );
142
143     vlc_object_release( p_aout );
144     return i_result;
145 }
146
147 /*****************************************************************************
148  * aout_VolumeUp : raise the output volume
149  *****************************************************************************
150  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
151  * function.
152  *****************************************************************************/
153 int __aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
154                    audio_volume_t * pi_volume )
155 {
156     aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
157                                                 FIND_ANYWHERE );
158     int i_result = 0, i_volume = 0, i_volume_step = 0;
159
160     i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
161     i_volume = config_GetInt( p_object, "volume" );
162     i_volume += i_volume_step * i_nb_steps;
163     if ( i_volume > AOUT_VOLUME_MAX )
164     {
165         i_volume = AOUT_VOLUME_MAX;
166     }
167     config_PutInt( p_object, "volume", i_volume );
168     var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
169     var_SetInteger( p_object->p_libvlc, "saved-volume" ,
170                     (audio_volume_t) i_volume );
171     if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
172
173     val.b_bool = VLC_TRUE;
174     var_Set( p_object->p_libvlc, "volume-change", val );
175
176     if ( p_aout == NULL ) return 0;
177
178     vlc_mutex_lock( &p_aout->mixer_lock );
179     if ( !p_aout->mixer.b_error )
180     {
181         i_result = p_aout->output.pf_volume_set( p_aout,
182                                                 (audio_volume_t) i_volume );
183     }
184     vlc_mutex_unlock( &p_aout->mixer_lock );
185
186     vlc_object_release( p_aout );
187     return i_result;
188 }
189
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
194  * function.
195  *****************************************************************************/
196 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
197                      audio_volume_t * pi_volume )
198 {
199     aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
200                                                 FIND_ANYWHERE );
201     int i_result = 0, i_volume = 0, i_volume_step = 0;
202
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 )
207     {
208         i_volume = AOUT_VOLUME_MIN;
209     }
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;
214
215     val.b_bool = VLC_TRUE;
216     var_Set( p_object->p_libvlc, "volume-change", val );
217
218     if ( p_aout == NULL ) return 0;
219
220     vlc_mutex_lock( &p_aout->mixer_lock );
221     if ( !p_aout->mixer.b_error )
222     {
223         i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
224     }
225     vlc_mutex_unlock( &p_aout->mixer_lock );
226
227     vlc_object_release( p_aout );
228     return i_result;
229 }
230
231 /*****************************************************************************
232  * aout_VolumeMute : Mute/un-mute the output volume
233  *****************************************************************************
234  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
235  * function (muted => 0).
236  *****************************************************************************/
237 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
238 {
239     int i_result;
240     audio_volume_t i_volume;
241
242     i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
243     if ( i_volume != 0 )
244     {
245         /* Mute */
246         i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
247         var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
248         var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
249         if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
250     }
251     else
252     {
253         /* Un-mute */
254         var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
255         i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
256                                                    "saved-volume" );
257         i_result = aout_VolumeSet( p_object, i_volume );
258         if ( pi_volume != NULL ) *pi_volume = i_volume;
259     }
260
261     return i_result;
262 }
263
264 /*
265  * The next functions are not supposed to be called by the interface, but
266  * are placeholders for software-only scaling.
267  */
268
269 /* Meant to be called by the output plug-in's Open(). */
270 void aout_VolumeSoftInit( aout_instance_t * p_aout )
271 {
272     int i_volume;
273
274     p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
275     p_aout->output.pf_volume_get = aout_VolumeSoftGet;
276     p_aout->output.pf_volume_set = aout_VolumeSoftSet;
277
278     i_volume = config_GetInt( p_aout, "volume" );
279     if ( i_volume < AOUT_VOLUME_MIN )
280     {
281         i_volume = AOUT_VOLUME_DEFAULT;
282     }
283     else if ( i_volume > AOUT_VOLUME_MAX )
284     {
285         i_volume = AOUT_VOLUME_MAX;
286     }
287
288     aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
289 }
290
291 /* Placeholder for pf_volume_infos(). */
292 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
293 {
294     (void)p_aout;
295     *pi_soft = 0;
296     return 0;
297 }
298
299 /* Placeholder for pf_volume_get(). */
300 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
301 {
302     *pi_volume = p_aout->output.i_volume;
303     return 0;
304 }
305
306
307 /* Placeholder for pf_volume_set(). */
308 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
309 {
310     aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
311     p_aout->output.i_volume = i_volume;
312     return 0;
313 }
314
315 /*
316  * The next functions are not supposed to be called by the interface, but
317  * are placeholders for unsupported scaling.
318  */
319
320 /* Meant to be called by the output plug-in's Open(). */
321 void aout_VolumeNoneInit( aout_instance_t * p_aout )
322 {
323     p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
324     p_aout->output.pf_volume_get = aout_VolumeNoneGet;
325     p_aout->output.pf_volume_set = aout_VolumeNoneSet;
326 }
327
328 /* Placeholder for pf_volume_infos(). */
329 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
330 {
331     (void)p_aout; (void)pi_soft;
332     return -1;
333 }
334
335 /* Placeholder for pf_volume_get(). */
336 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
337 {
338     (void)p_aout; (void)pi_volume;
339     return -1;
340 }
341
342 /* Placeholder for pf_volume_set(). */
343 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
344 {
345     (void)p_aout; (void)i_volume;
346     return -1;
347 }
348
349
350 /*
351  * Pipelines management
352  */
353
354 /*****************************************************************************
355  * aout_Restart : re-open the output device and rebuild the input and output
356  *                pipelines
357  *****************************************************************************
358  * This function is used whenever the parameters of the output plug-in are
359  * changed (eg. selecting S/PDIF or PCM).
360  *****************************************************************************/
361 static int aout_Restart( aout_instance_t * p_aout )
362 {
363     int i;
364     vlc_bool_t b_error = 0;
365
366     vlc_mutex_lock( &p_aout->mixer_lock );
367
368     if ( p_aout->i_nb_inputs == 0 )
369     {
370         vlc_mutex_unlock( &p_aout->mixer_lock );
371         msg_Err( p_aout, "no decoder thread" );
372         return -1;
373     }
374
375     /* Lock all inputs. */
376     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
377     {
378         vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
379         aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
380     }
381
382     aout_MixerDelete( p_aout );
383
384     /* Re-open the output plug-in. */
385     aout_OutputDelete( p_aout );
386
387     if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
388     {
389         /* Release all locks and report the error. */
390         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
391         {
392             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
393         }
394         vlc_mutex_unlock( &p_aout->mixer_lock );
395         return -1;
396     }
397
398     if ( aout_MixerNew( p_aout ) == -1 )
399     {
400         aout_OutputDelete( p_aout );
401         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
402         {
403             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
404         }
405         vlc_mutex_unlock( &p_aout->mixer_lock );
406         return -1;
407     }
408
409     /* Re-open all inputs. */
410     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
411     {
412         aout_input_t * p_input = p_aout->pp_inputs[i];
413
414         b_error |= aout_InputNew( p_aout, p_input );
415         p_input->b_changed = 1;
416         vlc_mutex_unlock( &p_input->lock );
417     }
418
419     vlc_mutex_unlock( &p_aout->mixer_lock );
420
421     return b_error;
422 }
423
424 /*****************************************************************************
425  * aout_FindAndRestart : find the audio output instance and restart
426  *****************************************************************************
427  * This is used for callbacks of the configuration variables, and we believe
428  * that when those are changed, it is a significant change which implies
429  * rebuilding the audio-device and audio-channels variables.
430  *****************************************************************************/
431 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
432                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
433 {
434     aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
435                                                 FIND_ANYWHERE );
436
437     (void)psz_name; (void)oldval; (void)newval; (void)p_data;
438     if ( p_aout == NULL ) return VLC_SUCCESS;
439
440     if ( var_Type( p_aout, "audio-device" ) != 0 )
441     {
442         var_Destroy( p_aout, "audio-device" );
443     }
444     if ( var_Type( p_aout, "audio-channels" ) != 0 )
445     {
446         var_Destroy( p_aout, "audio-channels" );
447     }
448
449     aout_Restart( p_aout );
450     vlc_object_release( p_aout );
451
452     return VLC_SUCCESS;
453 }
454
455 /*****************************************************************************
456  * aout_ChannelsRestart : change the audio device or channels and restart
457  *****************************************************************************/
458 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
459                           vlc_value_t oldval, vlc_value_t newval,
460                           void *p_data )
461 {
462     aout_instance_t * p_aout = (aout_instance_t *)p_this;
463     (void)oldval; (void)newval; (void)p_data;
464
465     if ( !strcmp( psz_variable, "audio-device" ) )
466     {
467         /* This is supposed to be a significant change and supposes
468          * rebuilding the channel choices. */
469         if ( var_Type( p_aout, "audio-channels" ) >= 0 )
470         {
471             var_Destroy( p_aout, "audio-channels" );
472         }
473     }
474     aout_Restart( p_aout );
475     return 0;
476 }
477
478 /** Enable or disable an audio filter
479  * \param p_this a vlc object
480  * \param psz_name name of the filter
481  * \param b_add are we adding or removing the filter ?
482  */
483 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
484                         vlc_bool_t b_add )
485 {
486     char *psz_parser, *psz_string;
487     aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
488                                                 FIND_ANYWHERE );
489
490     if( p_aout )
491         psz_string = var_GetNonEmptyString( p_aout, "audio-filter" );
492     else
493         psz_string = config_GetPsz( p_this, "audio-filter" );
494
495     if( !psz_string ) psz_string = strdup("");
496
497     psz_parser = strstr( psz_string, psz_name );
498
499     if( b_add )
500     {
501         if( !psz_parser )
502         {
503             psz_parser = psz_string;
504             asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
505                             psz_string, psz_name );
506             free( psz_parser );
507         }
508         else
509         {
510             vlc_object_release( p_aout );
511             return;
512         }
513     }
514     else
515     {
516         if( psz_parser )
517         {
518             memmove( psz_parser, psz_parser + strlen(psz_name) +
519                             (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
520                             strlen(psz_parser + strlen(psz_name)) + 1 );
521
522             if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
523             {
524                 *(psz_string+strlen(psz_string ) -1 ) = '\0';
525             }
526          }
527          else
528          {
529              free( psz_string );
530              return;
531          }
532     }
533
534     if( p_aout == NULL )
535         config_PutPsz( p_this, "audio-filter", psz_string );
536     else
537     {
538         var_SetString( p_aout, "audio-filter", psz_string );
539         for( int i = 0; i < p_aout->i_nb_inputs; i++ )
540             p_aout->pp_inputs[i]->b_restart = VLC_TRUE;
541         vlc_object_release( p_aout );
542     }
543     free( psz_string );
544 }
545
546 /**
547  * Change audio visualization
548  * -1 goes backwards, +1 goes forward
549  */
550 char *aout_VisualChange( vlc_object_t *p_this, int i_skip )
551 {
552     (void)p_this; (void)i_skip;
553     msg_Err( p_this, "FIXME: %s (%s %d) isn't implemented.", __func__,
554              __FILE__, __LINE__ );
555     return strdup("foobar");
556 }