* Major API change of the audio output. New aout_Dec* functions.
[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.4 2002/09/26 22:40:25 massiot 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         /* The output module is destroyed. */
71         vlc_mutex_unlock( &p_aout->mixer_lock );
72         msg_Err( p_aout, "VolumeGet called without output module" );
73         return -1;
74     }
75
76     i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
77
78     vlc_mutex_unlock( &p_aout->mixer_lock );
79     return i_result;
80 }
81
82 /*****************************************************************************
83  * aout_VolumeSet : set the volume of the output device
84  *****************************************************************************/
85 int aout_VolumeSet( aout_instance_t * p_aout, audio_volume_t i_volume )
86 {
87     int i_result;
88
89     vlc_mutex_lock( &p_aout->mixer_lock );
90
91     if ( p_aout->mixer.b_error )
92     {
93         /* The output module is destroyed. */
94         vlc_mutex_unlock( &p_aout->mixer_lock );
95         msg_Err( p_aout, "VolumeSet called without output module" );
96         return -1;
97     }
98
99     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
100
101     vlc_mutex_unlock( &p_aout->mixer_lock );
102     return i_result;
103 }
104
105 /*****************************************************************************
106  * aout_VolumeInfos : get the boundaries pi_low_soft and pi_high_soft
107  *****************************************************************************/
108 int aout_VolumeInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
109 {
110     int i_result;
111
112     vlc_mutex_lock( &p_aout->mixer_lock );
113
114     if ( p_aout->mixer.b_error )
115     {
116         /* The output module is destroyed. */
117         vlc_mutex_unlock( &p_aout->mixer_lock );
118         msg_Err( p_aout, "VolumeInfos called without output module" );
119         return -1;
120     }
121
122     i_result = p_aout->output.pf_volume_infos( p_aout, pi_soft );
123
124     vlc_mutex_unlock( &p_aout->mixer_lock );
125     return i_result;
126 }
127
128 /*****************************************************************************
129  * aout_VolumeUp : raise the output volume
130  *****************************************************************************
131  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
132  * function.
133  *****************************************************************************/
134 int aout_VolumeUp( aout_instance_t * p_aout, int i_nb_steps,
135                    audio_volume_t * pi_volume )
136 {
137     int i_result;
138     audio_volume_t i_volume;
139
140     vlc_mutex_lock( &p_aout->mixer_lock );
141
142     if ( p_aout->mixer.b_error )
143     {
144         /* The output module is destroyed. */
145         vlc_mutex_unlock( &p_aout->mixer_lock );
146         msg_Err( p_aout, "VolumeUp called without output module" );
147         return -1;
148     }
149
150     if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
151     {
152         vlc_mutex_unlock( &p_aout->mixer_lock );
153         return -1;
154     }
155
156     i_volume += AOUT_VOLUME_STEP * i_nb_steps;
157     if ( i_volume > 1024 ) i_volume = 1024;
158
159     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
160
161     vlc_mutex_unlock( &p_aout->mixer_lock );
162
163     if ( pi_volume != NULL ) *pi_volume = i_volume;
164     return i_result;
165 }
166
167 /*****************************************************************************
168  * aout_VolumeDown : lower the output volume
169  *****************************************************************************
170  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
171  * function.
172  *****************************************************************************/
173 int aout_VolumeDown( aout_instance_t * p_aout, int i_nb_steps,
174                      audio_volume_t * pi_volume )
175 {
176     int i_result;
177     audio_volume_t i_volume;
178
179     vlc_mutex_lock( &p_aout->mixer_lock );
180
181     if ( p_aout->mixer.b_error )
182     {
183         /* The output module is destroyed. */
184         vlc_mutex_unlock( &p_aout->mixer_lock );
185         msg_Err( p_aout, "VolumeUp called without output module" );
186         return -1;
187     }
188
189     if ( p_aout->output.pf_volume_get( p_aout, &i_volume ) )
190     {
191         vlc_mutex_unlock( &p_aout->mixer_lock );
192         return -1;
193     }
194
195     if ( i_volume < AOUT_VOLUME_STEP * i_nb_steps )
196         i_volume = 0;
197     else
198         i_volume -= AOUT_VOLUME_STEP * i_nb_steps;
199
200     i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
201
202     vlc_mutex_unlock( &p_aout->mixer_lock );
203
204     if ( pi_volume != NULL ) *pi_volume = i_volume;
205     return i_result;
206 }
207
208 /*
209  * The next functions are not supposed to be called by the interface, but
210  * are placeholders for software-only scaling.
211  */
212
213 /* Meant to be called by the output plug-in's Open(). */
214 void aout_VolumeSoftInit( aout_instance_t * p_aout )
215 {
216     int i_volume;
217
218     p_aout->output.pf_volume_infos = aout_VolumeSoftInfos;
219     p_aout->output.pf_volume_get = aout_VolumeSoftGet;
220     p_aout->output.pf_volume_set = aout_VolumeSoftSet;
221
222     i_volume = config_GetInt( p_aout, "volume" );
223     if ( i_volume == -1 )
224     {
225         i_volume = AOUT_VOLUME_DEFAULT;
226     }
227
228     aout_VolumeSoftSet( p_aout, i_volume );
229 }
230
231 /* Placeholder for pf_volume_infos(). */
232 int aout_VolumeSoftInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
233 {
234     *pi_soft = 0;
235     return 0;
236 }
237
238 /* Placeholder for pf_volume_get(). */
239 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
240 {
241     *pi_volume = p_aout->output.i_volume;
242     return 0;
243 }
244
245
246 /* Placeholder for pf_volume_set(). */
247 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
248 {
249     aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
250     p_aout->output.i_volume = i_volume;
251     return 0;
252 }
253
254 /*
255  * The next functions are not supposed to be called by the interface, but
256  * are placeholders for unsupported scaling.
257  */
258
259 /* Meant to be called by the output plug-in's Open(). */
260 void aout_VolumeNoneInit( aout_instance_t * p_aout )
261 {
262     p_aout->output.pf_volume_infos = aout_VolumeNoneInfos;
263     p_aout->output.pf_volume_get = aout_VolumeNoneGet;
264     p_aout->output.pf_volume_set = aout_VolumeNoneSet;
265 }
266
267 /* Placeholder for pf_volume_infos(). */
268 int aout_VolumeNoneInfos( aout_instance_t * p_aout, audio_volume_t * pi_soft )
269 {
270     return -1;
271 }
272
273 /* Placeholder for pf_volume_get(). */
274 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
275 {
276     return -1;
277 }
278
279 /* Placeholder for pf_volume_set(). */
280 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
281 {
282     return -1;
283 }
284
285
286 /*
287  * Pipelines management
288  */
289
290 /*****************************************************************************
291  * aout_Restart : re-open the output device and rebuild the input and output
292  *                pipelines
293  *****************************************************************************
294  * This function is used whenever the parameters of the output plug-in are
295  * changed (eg. selecting S/PDIF or PCM).
296  *****************************************************************************/
297 int aout_Restart( aout_instance_t * p_aout )
298 {
299     int i;
300     vlc_bool_t b_error = 0;
301
302     vlc_mutex_lock( &p_aout->mixer_lock );
303
304     if ( p_aout->i_nb_inputs == 0 )
305     {
306         vlc_mutex_unlock( &p_aout->mixer_lock );
307         msg_Err( p_aout, "no decoder thread" );
308         return -1;
309     }
310
311     /* Lock all inputs. */
312     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
313     {
314         vlc_mutex_lock( &p_aout->pp_inputs[i]->lock );
315         aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
316     }
317
318     aout_MixerDelete( p_aout );
319
320     /* Re-open the output plug-in. */
321     aout_OutputDelete( p_aout );
322     if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
323     {
324         /* Release all locks and report the error. */
325         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
326         {
327             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
328         }
329         vlc_mutex_unlock( &p_aout->mixer_lock );
330         return -1;
331     }
332
333     if ( aout_MixerNew( p_aout ) == -1 )
334     {
335         aout_OutputDelete( p_aout );
336         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
337         {
338             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
339         }
340         vlc_mutex_unlock( &p_aout->mixer_lock );
341         return -1;
342     }
343
344     /* Re-open all inputs. */
345     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
346     {
347         aout_input_t * p_input = p_aout->pp_inputs[i];
348
349         b_error |= aout_InputNew( p_aout, p_input );
350         vlc_mutex_unlock( &p_input->lock );
351     }
352
353     vlc_mutex_unlock( &p_aout->mixer_lock );
354
355     return b_error;
356 }
357