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