VolumeGet/VolumeSet now work even if no file is playing.
[vlc.git] / src / audio_output / intf.c
1 /*****************************************************************************
2  * intf.c : audio output API towards the interface modules
3  *****************************************************************************
4  * Copyright (C) 2002 VideoLAN
5  * $Id: intf.c,v 1.13 2003/01/16 13:22:30 hartman Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <stdlib.h>                            /* calloc(), malloc(), free() */
28 #include <string.h>
29
30 #include <vlc/vlc.h>
31
32 #include "audio_output.h"
33 #include "aout_internal.h"
34
35
36 /*
37  * Volume management
38  *
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).
42  *
43  * Here is a schematic of the i_volume range :
44  *
45  * |------------------------------+---------------------------------------|
46  * 0                           pi_soft                                   1024
47  *
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.
52  *
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.
57  */
58
59 /*****************************************************************************
60  * aout_VolumeGet : get the volume of the output device
61  *****************************************************************************/
62 int aout_VolumeGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
63 {
64     int i_result;
65
66     vlc_mutex_lock( &p_aout->mixer_lock );
67
68     if ( p_aout->mixer.b_error )
69     {
70         int i;
71         /* The output module is destroyed. */
72         vlc_mutex_unlock( &p_aout->mixer_lock );
73         i = config_GetInt( p_aout, "volume" );
74         if (pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
75         return 0;
76     }
77
78     i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
79
80     vlc_mutex_unlock( &p_aout->mixer_lock );
81     return i_result;
82 }
83
84 /*****************************************************************************
85  * aout_VolumeSet : set the volume of the output device
86  *****************************************************************************/
87 int aout_VolumeSet( aout_instance_t * p_aout, audio_volume_t i_volume )
88 {
89     int i_result;
90
91     vlc_mutex_lock( &p_aout->mixer_lock );
92
93     if ( p_aout->mixer.b_error )
94     {
95         int i;
96         /* The output module is destroyed. */
97         vlc_mutex_unlock( &p_aout->mixer_lock );
98         config_PutInt( p_aout, "volume", i_volume );
99         return 0;
100     }
101
102     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
103
104     vlc_mutex_unlock( &p_aout->mixer_lock );
105     return i_result;
106 }
107
108 /*****************************************************************************
109  * aout_VolumeInfos : get the boundary pi_soft
110  *****************************************************************************/
111 int aout_VolumeInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
112 {
113     int i_result;
114
115     vlc_mutex_lock( &p_aout->mixer_lock );
116
117     if ( p_aout->mixer.b_error )
118     {
119         /* The output module is destroyed. */
120         vlc_mutex_unlock( &p_aout->mixer_lock );
121         msg_Err( p_aout, "VolumeInfos called without output module" );
122         return -1;
123     }
124
125     i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
126
127     vlc_mutex_unlock( &p_aout->mixer_lock );
128     return i_result;
129 }
130
131 /*****************************************************************************
132  * aout_VolumeUp : raise the output volume
133  *****************************************************************************
134  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
135  * function.
136  *****************************************************************************/
137 int aout_VolumeUp( aout_instance_t * p_aout, int i_nb_steps,
138                    audio_volume_t * pi_volume )
139 {
140     int i_result;
141     audio_volume_t i_volume;
142
143     vlc_mutex_lock( &p_aout->mixer_lock );
144
145     if ( p_aout->mixer.b_error )
146     {
147         int i;
148         /* The output module is destroyed. */
149         vlc_mutex_unlock( &p_aout->mixer_lock );
150         i = config_GetInt( p_aout, "volume" );
151         i += AOUT_VOLUME_STEP * i_nb_steps;
152         if ( i > AOUT_VOLUME_MAX )
153         {
154             i = AOUT_VOLUME_MAX;
155         }
156         config_PutInt( p_aout, "volume", i );
157         if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
158         return 0;
159     }
160
161     if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
162     {
163         vlc_mutex_unlock( &p_aout->mixer_lock );
164         return -1;
165     }
166
167     i_volume += AOUT_VOLUME_STEP * i_nb_steps;
168     if ( i_volume > AOUT_VOLUME_MAX ) i_volume = AOUT_VOLUME_MAX;
169
170     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
171
172     vlc_mutex_unlock( &p_aout->mixer_lock );
173
174     if ( pi_volume != NULL ) *pi_volume = i_volume;
175     return i_result;
176 }
177
178 /*****************************************************************************
179  * aout_VolumeDown : lower the output volume
180  *****************************************************************************
181  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
182  * function.
183  *****************************************************************************/
184 int aout_VolumeDown( aout_instance_t * p_aout, int i_nb_steps,
185                      audio_volume_t * pi_volume )
186 {
187     int i_result;
188     audio_volume_t i_volume;
189
190     vlc_mutex_lock( &p_aout->mixer_lock );
191
192     if ( p_aout->mixer.b_error )
193     {
194         int i;
195         /* The output module is destroyed. */
196         vlc_mutex_unlock( &p_aout->mixer_lock );
197         i = config_GetInt( p_aout, "volume" );
198         i -= AOUT_VOLUME_STEP * i_nb_steps;
199         if ( i < 0 )
200         {
201             i = AOUT_VOLUME_MAX;
202         }
203         config_PutInt( p_aout, "volume", i );
204         if ( pi_volume != NULL ) *pi_volume = (audio_volume_t)i;
205         return 0;
206     }
207
208     if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
209     {
210         vlc_mutex_unlock( &p_aout->mixer_lock );
211         return -1;
212     }
213
214     if ( i_volume < AOUT_VOLUME_STEP * i_nb_steps )
215         i_volume = 0;
216     else
217         i_volume -= AOUT_VOLUME_STEP * i_nb_steps;
218
219     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
220
221     vlc_mutex_unlock( &p_aout->mixer_lock );
222
223     if ( pi_volume != NULL ) *pi_volume = i_volume;
224     return i_result;
225 }
226
227 /*****************************************************************************
228  * aout_VolumeMute : Mute/un-mute the output volume
229  *****************************************************************************
230  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
231  * function (muted => 0).
232  *****************************************************************************/
233 int aout_VolumeMute( aout_instance_t * p_aout, audio_volume_t * pi_volume )
234 {
235     int i_result;
236     audio_volume_t i_volume;
237
238     vlc_mutex_lock( &p_aout->mixer_lock );
239
240     if ( p_aout->mixer.b_error )
241     {
242         /* The output module is destroyed. */
243         vlc_mutex_unlock( &p_aout->mixer_lock );
244         config_PutInt( p_aout, "volume", 0 );
245         if ( pi_volume != NULL ) *pi_volume = 0;
246         return 0;
247     }
248
249     if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
250     {
251         vlc_mutex_unlock( &p_aout->mixer_lock );
252         return -1;
253     }
254
255     if ( i_volume == 0 )
256     {
257         i_volume = p_aout->output.i_saved_volume;
258     }
259     else
260     {
261         p_aout->output.i_saved_volume = i_volume;
262         i_volume = 0;
263     }
264
265     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
266
267     vlc_mutex_unlock( &p_aout->mixer_lock );
268
269     if ( pi_volume != NULL ) *pi_volume = i_volume;
270     return i_result;
271 }
272
273 /*
274  * The next functions are not supposed to be called by the interface, but
275  * are placeholders for software-only scaling.
276  */
277
278 /* Meant to be called by the output plug-in's Open(). */
279 void aout_VolumeSoftInit( aout_instance_t * p_aout )
280 {
281     int i_volume;
282
283     p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
284     p_aout->output.pf_volume_get = aout_VolumeSoftGet;
285     p_aout->output.pf_volume_set = aout_VolumeSoftSet;
286
287     i_volume = config_GetInt( p_aout, "volume" );
288     if ( i_volume < 0 )
289     {
290         i_volume = AOUT_VOLUME_DEFAULT;
291     }
292     else if ( i_volume > AOUT_VOLUME_MAX )
293     {
294         i_volume = AOUT_VOLUME_MAX;
295     }
296
297     aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
298 }
299
300 /* Placeholder for pf_volume_infos(). */
301 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
302 {
303     *pi_soft = 0;
304     return 0;
305 }
306
307 /* Placeholder for pf_volume_get(). */
308 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
309 {
310     *pi_volume = p_aout->output.i_volume;
311     return 0;
312 }
313
314
315 /* Placeholder for pf_volume_set(). */
316 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
317 {
318     aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
319     p_aout->output.i_volume = i_volume;
320     return 0;
321 }
322
323 /*
324  * The next functions are not supposed to be called by the interface, but
325  * are placeholders for unsupported scaling.
326  */
327
328 /* Meant to be called by the output plug-in's Open(). */
329 void aout_VolumeNoneInit( aout_instance_t * p_aout )
330 {
331     p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
332     p_aout->output.pf_volume_get = aout_VolumeNoneGet;
333     p_aout->output.pf_volume_set = aout_VolumeNoneSet;
334 }
335
336 /* Placeholder for pf_volume_infos(). */
337 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
338 {
339     return -1;
340 }
341
342 /* Placeholder for pf_volume_get(). */
343 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
344 {
345     return -1;
346 }
347
348 /* Placeholder for pf_volume_set(). */
349 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
350 {
351     return -1;
352 }
353
354
355 /*
356  * Pipelines management
357  */
358
359 /*****************************************************************************
360  * aout_Restart : re-open the output device and rebuild the input and output
361  *                pipelines
362  *****************************************************************************
363  * This function is used whenever the parameters of the output plug-in are
364  * changed (eg. selecting S/PDIF or PCM).
365  *****************************************************************************/
366 int aout_Restart( aout_instance_t * p_aout )
367 {
368     int i;
369     vlc_bool_t b_error = 0;
370
371     vlc_mutex_lock( &p_aout->mixer_lock );
372
373     if ( p_aout->i_nb_inputs == 0 )
374     {
375         vlc_mutex_unlock( &p_aout->mixer_lock );
376         msg_Err( p_aout, "no decoder thread" );
377         return -1;
378     }
379
380     /* Lock all inputs. */
381     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
382     {
383         vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
384         aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
385     }
386
387     aout_MixerDelete( p_aout );
388
389     /* Re-open the output plug-in. */
390     aout_OutputDelete( p_aout );
391
392     if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
393     {
394         /* Release all locks and report the error. */
395         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
396         {
397             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
398         }
399         vlc_mutex_unlock( &p_aout->mixer_lock );
400         return -1;
401     }
402
403     if ( aout_MixerNew( p_aout ) == -1 )
404     {
405         aout_OutputDelete( p_aout );
406         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
407         {
408             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
409         }
410         vlc_mutex_unlock( &p_aout->mixer_lock );
411         return -1;
412     }
413
414     /* Re-open all inputs. */
415     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
416     {
417         aout_input_t * p_input = p_aout->pp_inputs[i];
418
419         b_error |= aout_InputNew( p_aout, p_input );
420         vlc_mutex_unlock( &p_input->lock );
421     }
422
423     vlc_mutex_unlock( &p_aout->mixer_lock );
424
425     return b_error;
426 }
427
428 /*****************************************************************************
429  * aout_FindAndRestart : find the audio output instance and restart
430  *****************************************************************************
431  * This is used for callbacks of the configuration variables, and we believe
432  * that when those are changed, it is a significant change which implies
433  * rebuilding the audio-device and audio-channels variables.
434  *****************************************************************************/
435 void aout_FindAndRestart( vlc_object_t * p_this )
436 {
437     aout_instance_t * p_aout = vlc_object_find( p_this, VLC_OBJECT_AOUT,
438                                                 FIND_ANYWHERE );
439
440     if ( p_aout == NULL ) return;
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
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 old_value, vlc_value_t new_value,
460                           void * unused )
461 {
462     aout_instance_t * p_aout = (aout_instance_t *)p_this;
463
464     if ( !strcmp( psz_variable, "audio-device" ) )
465     {
466         /* This is supposed to be a significant change and supposes
467          * rebuilding the channel choices. */
468         if ( var_Type( p_aout, "audio-channels" ) >= 0 )
469         {
470             var_Destroy( p_aout, "audio-channels" );
471         }
472     }
473     aout_Restart( p_aout );
474     return 0;
475 }