]> git.sesse.net Git - vlc/blob - lib/audio.c
libvlc: missing NULL terminator (fixes #13655)
[vlc] / lib / audio.c
1 /*****************************************************************************
2  * libvlc_audio.c: New libvlc audio control API
3  *****************************************************************************
4  * Copyright (C) 2006 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors: Filippo Carone <filippo@carone.org>
8  *          Jean-Paul Saman <jpsaman _at_ m2x _dot_ nl>
9  *
10  * This program is free software; you can redistribute it and/or modify it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <assert.h>
30 #include <math.h>
31
32 #include <vlc/libvlc.h>
33 #include <vlc/libvlc_media.h>
34 #include <vlc/libvlc_media_player.h>
35
36 #include <vlc_common.h>
37 #include <vlc_input.h>
38 #include <vlc_aout.h>
39 #include <vlc_modules.h>
40
41 #include "libvlc_internal.h"
42 #include "media_player_internal.h"
43
44 /*
45  * Remember to release the returned audio_output_t since it is locked at
46  * the end of this function.
47  */
48 static audio_output_t *GetAOut( libvlc_media_player_t *mp )
49 {
50     assert( mp != NULL );
51
52     audio_output_t *p_aout = input_resource_HoldAout( mp->input.p_resource );
53     if( p_aout == NULL )
54         libvlc_printerr( "No active audio output" );
55     return p_aout;
56 }
57
58 /*****************************************
59  * Get the list of available audio outputs
60  *****************************************/
61 libvlc_audio_output_t *
62         libvlc_audio_output_list_get( libvlc_instance_t *p_instance )
63 {
64     size_t count;
65     module_t **module_list = module_list_get( &count );
66     libvlc_audio_output_t *list = NULL;
67
68     for (size_t i = 0; i < count; i++)
69     {
70         module_t *module = module_list[i];
71
72         if( !module_provides( module, "audio output" ) )
73             continue;
74
75         libvlc_audio_output_t *item = malloc( sizeof( *item ) );
76         if( unlikely(item == NULL) )
77         {
78     error:
79             libvlc_printerr( "Not enough memory" );
80             libvlc_audio_output_list_release( list );
81             list = NULL;
82             break;
83         }
84
85         item->psz_name = strdup( module_get_object( module ) );
86         item->psz_description = strdup( module_get_name( module, true ) );
87         if( unlikely(item->psz_name == NULL || item->psz_description == NULL) )
88         {
89             free( item );
90             goto error;
91         }
92         item->p_next = list;
93         list = item;
94     }
95     module_list_free( module_list );
96
97     VLC_UNUSED( p_instance );
98     return list;
99 }
100
101 /********************************************
102  * Free the list of available audio outputs
103  ***********************************************/
104 void libvlc_audio_output_list_release( libvlc_audio_output_t *list )
105 {
106     while( list != NULL )
107     {
108         libvlc_audio_output_t *next = list->p_next;
109
110         free( list->psz_name );
111         free( list->psz_description );
112         free( list );
113         list = next;
114     }
115 }
116
117
118 /***********************
119  * Set the audio output.
120  ***********************/
121 int libvlc_audio_output_set( libvlc_media_player_t *mp, const char *psz_name )
122 {
123     char *value;
124
125     if( !module_exists( psz_name )
126      || asprintf( &value, "%s,none", psz_name ) == -1 )
127         return -1;
128     var_SetString( mp, "aout", value );
129     free( value );
130
131     /* Forget the existing audio output */
132     input_resource_ResetAout(mp->input.p_resource);
133
134     /* Create a new audio output */
135     audio_output_t *aout = input_resource_GetAout(mp->input.p_resource);
136     if( aout != NULL )
137         input_resource_PutAout(mp->input.p_resource, aout);
138
139     return 0;
140 }
141
142 libvlc_audio_output_device_t *
143 libvlc_audio_output_device_enum( libvlc_media_player_t *mp )
144 {
145     audio_output_t *aout = GetAOut( mp );
146     if( aout == NULL )
147         return NULL;
148
149     libvlc_audio_output_device_t *list, **pp = &list;
150     char **values, **texts;
151
152     int n = aout_DevicesList( aout, &values, &texts );
153     vlc_object_release( aout );
154     if( n < 0 )
155         goto err;
156
157     for (int i = 0; i < n; i++)
158     {
159         libvlc_audio_output_device_t *item = malloc( sizeof(*item) );
160         if( unlikely(item == NULL) )
161         {
162             free( texts[i] );
163             free( values[i] );
164             continue;
165         }
166
167         *pp = item;
168         pp = &item->p_next;
169         item->psz_device = values[i];
170         item->psz_description = texts[i];
171     }
172
173     free( texts );
174     free( values );
175 err:
176     *pp = NULL;
177     return list;
178 }
179
180 libvlc_audio_output_device_t *
181 libvlc_audio_output_device_list_get( libvlc_instance_t *p_instance,
182                                      const char *aout )
183 {
184     char varname[32];
185     if( (size_t)snprintf( varname, sizeof(varname), "%s-audio-device", aout )
186                                                            >= sizeof(varname) )
187         return NULL;
188
189     libvlc_audio_output_device_t *list = NULL, **pp = &list;
190     char **values, **texts;
191     ssize_t count = config_GetPszChoices( VLC_OBJECT(p_instance->p_libvlc_int),
192                                           varname, &values, &texts );
193     for( ssize_t i = 0; i < count; i++ )
194     {
195         libvlc_audio_output_device_t *item = malloc( sizeof(*item) );
196         if( unlikely(item == NULL) )
197             break;
198
199         *pp = item;
200         pp = &item->p_next;
201         item->psz_device = values[i];
202         item->psz_description = texts[i];
203     }
204
205     *pp = NULL;
206     free( texts );
207     free( values );
208     (void) p_instance;
209     return list;
210 }
211
212 void libvlc_audio_output_device_list_release( libvlc_audio_output_device_t *l )
213 {
214     while( l != NULL )
215     {
216         libvlc_audio_output_device_t *next = l->p_next;
217
218         free( l->psz_description );
219         free( l->psz_device );
220         free( l );
221         l = next;
222     }
223 }
224
225 int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
226                                       const char *psz_audio_output )
227 {
228     (void) p_instance; (void) psz_audio_output;
229     return 0;
230 }
231
232 char *libvlc_audio_output_device_longname( libvlc_instance_t *p_instance,
233                                            const char *psz_audio_output,
234                                            int i_device )
235 {
236     (void) p_instance; (void) psz_audio_output; (void) i_device;
237     return NULL;
238 }
239
240 char *libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
241                                      const char *psz_audio_output,
242                                      int i_device )
243 {
244     (void) p_instance; (void) psz_audio_output; (void) i_device;
245     return NULL;
246 }
247
248 /*****************************
249  * Set device for using
250  *****************************/
251 void libvlc_audio_output_device_set( libvlc_media_player_t *mp,
252                                      const char *module, const char *devid )
253 {
254     if( devid == NULL )
255         return;
256
257     if( module != NULL )
258     {
259         char *cfg_name;
260
261         if( asprintf( &cfg_name, "%s-audio-device", module ) == -1 )
262             return;
263
264         if( !var_Type( mp, cfg_name ) )
265             /* Don't recreate the same variable over and over and over... */
266             var_Create( mp, cfg_name, VLC_VAR_STRING );
267         var_SetString( mp, cfg_name, devid );
268         free( cfg_name );
269         return;
270     }
271
272     audio_output_t *aout = GetAOut( mp );
273     if( aout == NULL )
274         return;
275
276     aout_DeviceSet( aout, devid );
277     vlc_object_release( aout );
278 }
279
280 int libvlc_audio_output_get_device_type( libvlc_media_player_t *mp )
281 {
282     (void) mp;
283     return libvlc_AudioOutputDevice_Error;
284 }
285
286 void libvlc_audio_output_set_device_type( libvlc_media_player_t *mp,
287                                           int device_type )
288 {
289     (void) mp; (void) device_type;
290 }
291
292 void libvlc_audio_toggle_mute( libvlc_media_player_t *mp )
293 {
294     int mute = libvlc_audio_get_mute( mp );
295     if( mute != -1 )
296         libvlc_audio_set_mute( mp, !mute );
297 }
298
299 int libvlc_audio_get_mute( libvlc_media_player_t *mp )
300 {
301     int mute = -1;
302
303     audio_output_t *aout = GetAOut( mp );
304     if( aout != NULL )
305     {
306         mute = aout_MuteGet( aout );
307         vlc_object_release( aout );
308     }
309     return mute;
310 }
311
312 void libvlc_audio_set_mute( libvlc_media_player_t *mp, int mute )
313 {
314     audio_output_t *aout = GetAOut( mp );
315     if( aout != NULL )
316     {
317         mute = aout_MuteSet( aout, mute );
318         vlc_object_release( aout );
319     }
320 }
321
322 int libvlc_audio_get_volume( libvlc_media_player_t *mp )
323 {
324     int volume = -1;
325
326     audio_output_t *aout = GetAOut( mp );
327     if( aout != NULL )
328     {
329         float vol = aout_VolumeGet( aout );
330         vlc_object_release( aout );
331         volume = lroundf( vol * 100.f );
332     }
333     return volume;
334 }
335
336 int libvlc_audio_set_volume( libvlc_media_player_t *mp, int volume )
337 {
338     float vol = volume / 100.f;
339     if (!isgreaterequal(vol, 0.f))
340     {
341         libvlc_printerr( "Volume out of range" );
342         return -1;
343     }
344
345     int ret = -1;
346     audio_output_t *aout = GetAOut( mp );
347     if( aout != NULL )
348     {
349         ret = aout_VolumeSet( aout, vol );
350         vlc_object_release( aout );
351     }
352     return ret;
353 }
354
355 /*****************************************************************************
356  * libvlc_audio_get_track_count : Get the number of available audio tracks
357  *****************************************************************************/
358 int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi )
359 {
360     input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
361     int i_track_count;
362
363     if( !p_input_thread )
364         return -1;
365
366     i_track_count = var_CountChoices( p_input_thread, "audio-es" );
367
368     vlc_object_release( p_input_thread );
369     return i_track_count;
370 }
371
372 /*****************************************************************************
373  * libvlc_audio_get_track_description : Get the description of available audio tracks
374  *****************************************************************************/
375 libvlc_track_description_t *
376         libvlc_audio_get_track_description( libvlc_media_player_t *p_mi )
377 {
378     return libvlc_get_track_description( p_mi, "audio-es" );
379 }
380
381 /*****************************************************************************
382  * libvlc_audio_get_track : Get the current audio track
383  *****************************************************************************/
384 int libvlc_audio_get_track( libvlc_media_player_t *p_mi )
385 {
386     input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
387     if( !p_input_thread )
388         return -1;
389
390     int id = var_GetInteger( p_input_thread, "audio-es" );
391     vlc_object_release( p_input_thread );
392     return id;
393 }
394
395 /*****************************************************************************
396  * libvlc_audio_set_track : Set the current audio track
397  *****************************************************************************/
398 int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track )
399 {
400     input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
401     vlc_value_t val_list;
402     int i_ret = -1;
403
404     if( !p_input_thread )
405         return -1;
406
407     var_Change( p_input_thread, "audio-es", VLC_VAR_GETCHOICES, &val_list, NULL );
408     for( int i = 0; i < val_list.p_list->i_count; i++ )
409     {
410         if( i_track == val_list.p_list->p_values[i].i_int )
411         {
412             if( var_SetInteger( p_input_thread, "audio-es", i_track ) < 0 )
413                 break;
414             i_ret = 0;
415             goto end;
416         }
417     }
418     libvlc_printerr( "Track identifier not found" );
419 end:
420     var_FreeList( &val_list, NULL );
421     vlc_object_release( p_input_thread );
422     return i_ret;
423 }
424
425 /*****************************************************************************
426  * libvlc_audio_get_channel : Get the current audio channel
427  *****************************************************************************/
428 int libvlc_audio_get_channel( libvlc_media_player_t *mp )
429 {
430     audio_output_t *p_aout = GetAOut( mp );
431     if( !p_aout )
432         return 0;
433
434     int val = var_GetInteger( p_aout, "stereo-mode" );
435     vlc_object_release( p_aout );
436     return val;
437 }
438
439 /*****************************************************************************
440  * libvlc_audio_set_channel : Set the current audio channel
441  *****************************************************************************/
442 int libvlc_audio_set_channel( libvlc_media_player_t *mp, int channel )
443 {
444     audio_output_t *p_aout = GetAOut( mp );
445     int ret = 0;
446
447     if( !p_aout )
448         return -1;
449
450     if( var_SetInteger( p_aout, "stereo-mode", channel ) < 0 )
451     {
452         libvlc_printerr( "Audio channel out of range" );
453         ret = -1;
454     }
455     vlc_object_release( p_aout );
456     return ret;
457 }
458
459 /*****************************************************************************
460  * libvlc_audio_get_delay : Get the current audio delay
461  *****************************************************************************/
462 int64_t libvlc_audio_get_delay( libvlc_media_player_t *p_mi )
463 {
464     input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
465     int64_t val = 0;
466     if( p_input_thread != NULL )
467     {
468       val = var_GetTime( p_input_thread, "audio-delay" );
469       vlc_object_release( p_input_thread );
470     }
471     return val;
472 }
473
474 /*****************************************************************************
475  * libvlc_audio_set_delay : Set the current audio delay
476  *****************************************************************************/
477 int libvlc_audio_set_delay( libvlc_media_player_t *p_mi, int64_t i_delay )
478 {
479     input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
480     int ret = 0;
481     if( p_input_thread != NULL )
482     {
483       var_SetTime( p_input_thread, "audio-delay", i_delay );
484       vlc_object_release( p_input_thread );
485     }
486     else
487     {
488       ret = -1;
489     }
490     return ret;
491 }
492
493 /*****************************************************************************
494  * libvlc_audio_equalizer_get_preset_count : Get the number of equalizer presets
495  *****************************************************************************/
496 unsigned libvlc_audio_equalizer_get_preset_count( void )
497 {
498     return NB_PRESETS;
499 }
500
501 /*****************************************************************************
502  * libvlc_audio_equalizer_get_preset_name : Get the name for a preset
503  *****************************************************************************/
504 const char *libvlc_audio_equalizer_get_preset_name( unsigned u_index )
505 {
506     if ( u_index >= NB_PRESETS )
507         return NULL;
508
509     return preset_list_text[ u_index ];
510 }
511
512 /*****************************************************************************
513  * libvlc_audio_equalizer_get_band_count : Get the number of equalizer frequency bands
514  *****************************************************************************/
515 unsigned libvlc_audio_equalizer_get_band_count( void )
516 {
517     return EQZ_BANDS_MAX;
518 }
519
520 /*****************************************************************************
521  * libvlc_audio_equalizer_get_band_frequency : Get the frequency for a band
522  *****************************************************************************/
523 float libvlc_audio_equalizer_get_band_frequency( unsigned u_index )
524 {
525     if ( u_index >= EQZ_BANDS_MAX )
526         return -1.f;
527
528     return f_iso_frequency_table_10b[ u_index ];
529 }
530
531 /*****************************************************************************
532  * libvlc_audio_equalizer_new : Create a new audio equalizer with zeroed values
533  *****************************************************************************/
534 libvlc_equalizer_t *libvlc_audio_equalizer_new( void )
535 {
536     libvlc_equalizer_t *p_equalizer;
537     p_equalizer = malloc( sizeof( *p_equalizer ) );
538     if ( unlikely( p_equalizer == NULL ) )
539         return NULL;
540
541     p_equalizer->f_preamp = 0.f;
542     for ( unsigned i = 0; i < EQZ_BANDS_MAX; i++ )
543         p_equalizer->f_amp[ i ] = 0.f;
544
545     return p_equalizer;
546 }
547
548 /*****************************************************************************
549  * libvlc_audio_equalizer_new_from_preset : Create a new audio equalizer based on a preset
550  *****************************************************************************/
551 libvlc_equalizer_t *libvlc_audio_equalizer_new_from_preset( unsigned u_index )
552 {
553     libvlc_equalizer_t *p_equalizer;
554
555     if ( u_index >= NB_PRESETS )
556         return NULL;
557
558     p_equalizer = malloc( sizeof( *p_equalizer ) );
559     if ( unlikely( p_equalizer == NULL ) )
560         return NULL;
561
562     p_equalizer->f_preamp = eqz_preset_10b[ u_index ].f_preamp;
563
564     for ( unsigned i = 0; i < EQZ_BANDS_MAX; i++ )
565         p_equalizer->f_amp[ i ] = eqz_preset_10b[ u_index ].f_amp[ i ];
566
567     return p_equalizer;
568 }
569
570 /*****************************************************************************
571  * libvlc_audio_equalizer_release : Release a previously created equalizer
572  *****************************************************************************/
573 void libvlc_audio_equalizer_release( libvlc_equalizer_t *p_equalizer )
574 {
575     free( p_equalizer );
576 }
577
578 /*****************************************************************************
579  * libvlc_audio_equalizer_set_preamp : Set the preamp value for an equalizer
580  *****************************************************************************/
581 int libvlc_audio_equalizer_set_preamp( libvlc_equalizer_t *p_equalizer, float f_preamp )
582 {
583     if( isnan(f_preamp) )
584         return -1;
585     if( f_preamp < -20.f )
586         f_preamp = -20.f;
587     else if( f_preamp > 20.f )
588         f_preamp = 20.f;
589
590     p_equalizer->f_preamp = f_preamp;
591     return 0;
592 }
593
594 /*****************************************************************************
595  * libvlc_audio_equalizer_get_preamp : Get the preamp value for an equalizer
596  *****************************************************************************/
597 float libvlc_audio_equalizer_get_preamp( libvlc_equalizer_t *p_equalizer )
598 {
599     return p_equalizer->f_preamp;
600 }
601
602 /*****************************************************************************
603  * libvlc_audio_equalizer_set_amp_at_index : Set the amplification value for an equalizer band
604  *****************************************************************************/
605 int libvlc_audio_equalizer_set_amp_at_index( libvlc_equalizer_t *p_equalizer, float f_amp, unsigned u_band )
606 {
607     if( u_band >= EQZ_BANDS_MAX || isnan(f_amp) )
608         return -1;
609
610
611     if( f_amp < -20.f )
612         f_amp = -20.f;
613     else if( f_amp > 20.f )
614         f_amp = 20.f;
615
616     p_equalizer->f_amp[ u_band ] = f_amp;
617     return 0;
618 }
619
620 /*****************************************************************************
621  * libvlc_audio_equalizer_get_amp_at_index : Get the amplification value for an equalizer band
622  *****************************************************************************/
623 float libvlc_audio_equalizer_get_amp_at_index( libvlc_equalizer_t *p_equalizer, unsigned u_band )
624 {
625     if ( u_band >= EQZ_BANDS_MAX )
626         return nanf("");
627
628     return p_equalizer->f_amp[ u_band ];
629 }