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