fix previous commit
[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     vlc_value_t val;
157     aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
158                                                 FIND_ANYWHERE );
159     int i_result = 0, i_volume = 0, i_volume_step = 0;
160
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 )
165     {
166         i_volume = AOUT_VOLUME_MAX;
167     }
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;
173
174     val.b_bool = VLC_TRUE;
175     var_Set( p_object->p_libvlc, "volume-change", val );
176
177     if ( p_aout == NULL ) return 0;
178
179     vlc_mutex_lock( &p_aout->mixer_lock );
180     if ( !p_aout->mixer.b_error )
181     {
182         i_result = p_aout->output.pf_volume_set( p_aout,
183                                                 (audio_volume_t) i_volume );
184     }
185     vlc_mutex_unlock( &p_aout->mixer_lock );
186
187     vlc_object_release( p_aout );
188     return i_result;
189 }
190
191 /*****************************************************************************
192  * aout_VolumeDown : lower the output volume
193  *****************************************************************************
194  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
195  * function.
196  *****************************************************************************/
197 int __aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
198                      audio_volume_t * pi_volume )
199 {
200     vlc_value_t val;
201     aout_instance_t * p_aout = vlc_object_find( p_object, VLC_OBJECT_AOUT,
202                                                 FIND_ANYWHERE );
203     int i_result = 0, i_volume = 0, i_volume_step = 0;
204
205     i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
206     i_volume = config_GetInt( p_object, "volume" );
207     i_volume -= i_volume_step * i_nb_steps;
208     if ( i_volume < AOUT_VOLUME_MIN )
209     {
210         i_volume = AOUT_VOLUME_MIN;
211     }
212     config_PutInt( p_object, "volume", i_volume );
213     var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
214     var_SetInteger( p_object->p_libvlc, "saved-volume", (audio_volume_t) i_volume );
215     if ( pi_volume != NULL ) *pi_volume = (audio_volume_t) i_volume;
216
217     val.b_bool = VLC_TRUE;
218     var_Set( p_object->p_libvlc, "volume-change", val );
219
220     if ( p_aout == NULL ) return 0;
221
222     vlc_mutex_lock( &p_aout->mixer_lock );
223     if ( !p_aout->mixer.b_error )
224     {
225         i_result = p_aout->output.pf_volume_set( p_aout, (audio_volume_t) i_volume );
226     }
227     vlc_mutex_unlock( &p_aout->mixer_lock );
228
229     vlc_object_release( p_aout );
230     return i_result;
231 }
232
233 /*****************************************************************************
234  * aout_VolumeMute : Mute/un-mute the output volume
235  *****************************************************************************
236  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
237  * function (muted => 0).
238  *****************************************************************************/
239 int __aout_VolumeMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
240 {
241     int i_result;
242     audio_volume_t i_volume;
243
244     i_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
245     if ( i_volume != 0 )
246     {
247         /* Mute */
248         i_result = aout_VolumeSet( p_object, AOUT_VOLUME_MIN );
249         var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
250         var_SetInteger( p_object->p_libvlc, "saved-volume", (int)i_volume );
251         if ( pi_volume != NULL ) *pi_volume = AOUT_VOLUME_MIN;
252     }
253     else
254     {
255         /* Un-mute */
256         var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
257         i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
258                                                    "saved-volume" );
259         i_result = aout_VolumeSet( p_object, i_volume );
260         if ( pi_volume != NULL ) *pi_volume = i_volume;
261     }
262
263     return i_result;
264 }
265
266 /*
267  * The next functions are not supposed to be called by the interface, but
268  * are placeholders for software-only scaling.
269  */
270
271 /* Meant to be called by the output plug-in's Open(). */
272 void aout_VolumeSoftInit( aout_instance_t * p_aout )
273 {
274     int i_volume;
275
276     p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
277     p_aout->output.pf_volume_get = aout_VolumeSoftGet;
278     p_aout->output.pf_volume_set = aout_VolumeSoftSet;
279
280     i_volume = config_GetInt( p_aout, "volume" );
281     if ( i_volume < AOUT_VOLUME_MIN )
282     {
283         i_volume = AOUT_VOLUME_DEFAULT;
284     }
285     else if ( i_volume > AOUT_VOLUME_MAX )
286     {
287         i_volume = AOUT_VOLUME_MAX;
288     }
289
290     aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
291 }
292
293 /* Placeholder for pf_volume_infos(). */
294 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
295 {
296     (void)p_aout;
297     *pi_soft = 0;
298     return 0;
299 }
300
301 /* Placeholder for pf_volume_get(). */
302 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
303 {
304     *pi_volume = p_aout->output.i_volume;
305     return 0;
306 }
307
308
309 /* Placeholder for pf_volume_set(). */
310 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
311 {
312     aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
313     p_aout->output.i_volume = i_volume;
314     return 0;
315 }
316
317 /*
318  * The next functions are not supposed to be called by the interface, but
319  * are placeholders for unsupported scaling.
320  */
321
322 /* Meant to be called by the output plug-in's Open(). */
323 void aout_VolumeNoneInit( aout_instance_t * p_aout )
324 {
325     p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
326     p_aout->output.pf_volume_get = aout_VolumeNoneGet;
327     p_aout->output.pf_volume_set = aout_VolumeNoneSet;
328 }
329
330 /* Placeholder for pf_volume_infos(). */
331 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
332 {
333     (void)p_aout; (void)pi_soft;
334     return -1;
335 }
336
337 /* Placeholder for pf_volume_get(). */
338 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
339 {
340     (void)p_aout; (void)pi_volume;
341     return -1;
342 }
343
344 /* Placeholder for pf_volume_set(). */
345 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
346 {
347     (void)p_aout; (void)i_volume;
348     return -1;
349 }
350
351
352 /*
353  * Pipelines management
354  */
355
356 /*****************************************************************************
357  * aout_Restart : re-open the output device and rebuild the input and output
358  *                pipelines
359  *****************************************************************************
360  * This function is used whenever the parameters of the output plug-in are
361  * changed (eg. selecting S/PDIF or PCM).
362  *****************************************************************************/
363 static int aout_Restart( aout_instance_t * p_aout )
364 {
365     int i;
366     vlc_bool_t b_error = 0;
367
368     vlc_mutex_lock( &p_aout->mixer_lock );
369
370     if ( p_aout->i_nb_inputs == 0 )
371     {
372         vlc_mutex_unlock( &p_aout->mixer_lock );
373         msg_Err( p_aout, "no decoder thread" );
374         return -1;
375     }
376
377     /* Lock all inputs. */
378     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
379     {
380         vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
381         aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
382     }
383
384     aout_MixerDelete( p_aout );
385
386     /* Re-open the output plug-in. */
387     aout_OutputDelete( p_aout );
388
389     if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
390     {
391         /* Release all locks and report the error. */
392         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
393         {
394             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
395         }
396         vlc_mutex_unlock( &p_aout->mixer_lock );
397         return -1;
398     }
399
400     if ( aout_MixerNew( p_aout ) == -1 )
401     {
402         aout_OutputDelete( p_aout );
403         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
404         {
405             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
406         }
407         vlc_mutex_unlock( &p_aout->mixer_lock );
408         return -1;
409     }
410
411     /* Re-open all inputs. */
412     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
413     {
414         aout_input_t * p_input = p_aout->pp_inputs[i];
415
416         b_error |= aout_InputNew( p_aout, p_input );
417         p_input->b_changed = 1;
418         vlc_mutex_unlock( &p_input->lock );
419     }
420
421     vlc_mutex_unlock( &p_aout->mixer_lock );
422
423     return b_error;
424 }
425
426 /*****************************************************************************
427  * aout_FindAndRestart : find the audio output instance and restart
428  *****************************************************************************
429  * This is used for callbacks of the configuration variables, and we believe
430  * that when those are changed, it is a significant change which implies
431  * rebuilding the audio-device and audio-channels variables.
432  *****************************************************************************/
433 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
434                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
435 {
436     aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
437                                                 FIND_ANYWHERE );
438
439     (void)psz_name; (void)oldval; (void)newval; (void)p_data;
440     if ( p_aout == NULL ) return VLC_SUCCESS;
441
442     if ( var_Type( p_aout, "audio-device" ) != 0 )
443     {
444         var_Destroy( p_aout, "audio-device" );
445     }
446     if ( var_Type( p_aout, "audio-channels" ) != 0 )
447     {
448         var_Destroy( p_aout, "audio-channels" );
449     }
450
451     aout_Restart( p_aout );
452     vlc_object_release( p_aout );
453
454     return VLC_SUCCESS;
455 }
456
457 /*****************************************************************************
458  * aout_ChannelsRestart : change the audio device or channels and restart
459  *****************************************************************************/
460 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
461                           vlc_value_t oldval, vlc_value_t newval,
462                           void *p_data )
463 {
464     aout_instance_t * p_aout = (aout_instance_t *)p_this;
465     (void)oldval; (void)newval; (void)p_data;
466
467     if ( !strcmp( psz_variable, "audio-device" ) )
468     {
469         /* This is supposed to be a significant change and supposes
470          * rebuilding the channel choices. */
471         if ( var_Type( p_aout, "audio-channels" ) >= 0 )
472         {
473             var_Destroy( p_aout, "audio-channels" );
474         }
475     }
476     aout_Restart( p_aout );
477     return 0;
478 }
479
480 /** Enable or disable an audio filter
481  * \param p_this a vlc object
482  * \param psz_name name of the filter
483  * \param b_add are we adding or removing the filter ?
484  */
485 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
486                         vlc_bool_t b_add )
487 {
488     char *psz_parser, *psz_string;
489     aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
490                                                 FIND_ANYWHERE );
491
492     if( p_aout )
493         psz_string = var_GetNonEmptyString( p_aout, "audio-filter" );
494     else
495         psz_string = config_GetPsz( p_this, "audio-filter" );
496
497     if( !psz_string ) psz_string = strdup("");
498
499     psz_parser = strstr( psz_string, psz_name );
500
501     if( b_add )
502     {
503         if( !psz_parser )
504         {
505             psz_parser = psz_string;
506             asprintf( &psz_string, (*psz_string) ? "%s:%s" : "%s%s",
507                             psz_string, psz_name );
508             free( psz_parser );
509         }
510         else
511         {
512             vlc_object_release( p_aout );
513             return;
514         }
515     }
516     else
517     {
518         if( psz_parser )
519         {
520             memmove( psz_parser, psz_parser + strlen(psz_name) +
521                             (*(psz_parser + strlen(psz_name)) == ':' ? 1 : 0 ),
522                             strlen(psz_parser + strlen(psz_name)) + 1 );
523
524             if( *(psz_string+strlen(psz_string ) -1 ) == ':' )
525             {
526                 *(psz_string+strlen(psz_string ) -1 ) = '\0';
527             }
528          }
529          else
530          {
531              free( psz_string );
532              return;
533          }
534     }
535
536     if( p_aout == NULL )
537         config_PutPsz( p_this, "audio-filter", psz_string );
538     else
539     {
540         var_SetString( p_aout, "audio-filter", psz_string );
541         for( int i = 0; i < p_aout->i_nb_inputs; i++ )
542             p_aout->pp_inputs[i]->b_restart = VLC_TRUE;
543         vlc_object_release( p_aout );
544     }
545     free( psz_string );
546 }
547
548 /**
549  * Change audio visualization
550  * -1 goes backwards, +1 goes forward
551  */
552 char *aout_VisualChange( vlc_object_t *p_this, int i_skip )
553 {
554     (void)p_this; (void)i_skip;
555     msg_Err( p_this, "FIXME: %s (%s %d) isn't implemented.", __func__,
556              __FILE__, __LINE__ );
557     return strdup("foobar");
558 }