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     if( config_GetType(varname) != VLC_VAR_STRING )
 193         return NULL;
 194
 195     libvlc_audio_output_device_t *list = NULL, **pp = &list;
 196     char **values, **texts;
 197     ssize_t count = config_GetPszChoices( varname, &values, &texts );
 198     for( ssize_t i = 0; i < count; i++ )
 199     {
 200         libvlc_audio_output_device_t *item = malloc( sizeof(*item) );
 201         if( unlikely(item == NULL) )
 202             break;
 203
 204         *pp = item;
 205         pp = &item->p_next;
 206         item->psz_device = values[i];
 207         item->psz_description = texts[i];
 208     }
 209
 210     *pp = NULL;
 211     free( texts );
 212     free( values );
 213     (void) p_instance;
 214     return list;
 215 }
 216
 217 void libvlc_audio_output_device_list_release( libvlc_audio_output_device_t *l )
 218 {
 219     while( l != NULL )
 220     {
 221         libvlc_audio_output_device_t *next = l->p_next;
 222
 223         free( l->psz_description );
 224         free( l->psz_device );
 225         free( l );
 226         l = next;
 227     }
 228 }
 229
 230 int libvlc_audio_output_device_count( libvlc_instance_t *p_instance,
 231                                       const char *psz_audio_output )
 232 {
 233     (void) p_instance; (void) psz_audio_output;
 234     return 0;
 235 }
 236
 237 char *libvlc_audio_output_device_longname( libvlc_instance_t *p_instance,
 238                                            const char *psz_audio_output,
 239                                            int i_device )
 240 {
 241     (void) p_instance; (void) psz_audio_output; (void) i_device;
 242     return NULL;
 243 }
 244
 245 char *libvlc_audio_output_device_id( libvlc_instance_t *p_instance,
 246                                      const char *psz_audio_output,
 247                                      int i_device )
 248 {
 249     (void) p_instance; (void) psz_audio_output; (void) i_device;
 250     return NULL;
 251 }
 252
 253 /*****************************
 254  * Set device for using
 255  *****************************/
 256 void libvlc_audio_output_device_set( libvlc_media_player_t *mp,
 257                                      const char *module, const char *devid )
 258 {
 259     if( devid == NULL )
 260         return;
 261
 262     if( module != NULL )
 263     {
 264         char *cfg_name;
 265
 266         if( asprintf( &cfg_name, "%s-audio-device", module ) == -1 )
 267             return;
 268
 269         if( !var_Type( mp, cfg_name ) )
 270             /* Don't recreate the same variable over and over and over... */
 271             var_Create( mp, cfg_name, VLC_VAR_STRING );
 272         var_SetString( mp, cfg_name, devid );
 273         free( cfg_name );
 274         return;
 275     }
 276
 277     audio_output_t *aout = GetAOut( mp );
 278     if( aout == NULL )
 279         return;
 280
 281     aout_DeviceSet( aout, devid );
 282     vlc_object_release( aout );
 283 }
 284
 285 char *libvlc_audio_output_device_get( libvlc_media_player_t *mp )
 286 {
 287     audio_output_t *aout = GetAOut( mp );
 288     if( aout == NULL )
 289         return NULL;
 290
 291     char *devid = aout_DeviceGet( aout );
 292
 293     vlc_object_release( aout );
 294
 295     return devid;
 296 }
 297
 298 int libvlc_audio_output_get_device_type( libvlc_media_player_t *mp )
 299 {
 300     (void) mp;
 301     return libvlc_AudioOutputDevice_Error;
 302 }
 303
 304 void libvlc_audio_output_set_device_type( libvlc_media_player_t *mp,
 305                                           int device_type )
 306 {
 307     (void) mp; (void) device_type;
 308 }
 309
 310 void libvlc_audio_toggle_mute( libvlc_media_player_t *mp )
 311 {
 312     int mute = libvlc_audio_get_mute( mp );
 313     if( mute != -1 )
 314         libvlc_audio_set_mute( mp, !mute );
 315 }
 316
 317 int libvlc_audio_get_mute( libvlc_media_player_t *mp )
 318 {
 319     int mute = -1;
 320
 321     audio_output_t *aout = GetAOut( mp );
 322     if( aout != NULL )
 323     {
 324         mute = aout_MuteGet( aout );
 325         vlc_object_release( aout );
 326     }
 327     return mute;
 328 }
 329
 330 void libvlc_audio_set_mute( libvlc_media_player_t *mp, int mute )
 331 {
 332     audio_output_t *aout = GetAOut( mp );
 333     if( aout != NULL )
 334     {
 335         mute = aout_MuteSet( aout, mute );
 336         vlc_object_release( aout );
 337     }
 338 }
 339
 340 int libvlc_audio_get_volume( libvlc_media_player_t *mp )
 341 {
 342     int volume = -1;
 343
 344     audio_output_t *aout = GetAOut( mp );
 345     if( aout != NULL )
 346     {
 347         float vol = aout_VolumeGet( aout );
 348         vlc_object_release( aout );
 349         volume = lroundf( vol * 100.f );
 350     }
 351     return volume;
 352 }
 353
 354 int libvlc_audio_set_volume( libvlc_media_player_t *mp, int volume )
 355 {
 356     float vol = volume / 100.f;
 357     if (!isgreaterequal(vol, 0.f))
 358     {
 359         libvlc_printerr( "Volume out of range" );
 360         return -1;
 361     }
 362
 363     int ret = -1;
 364     audio_output_t *aout = GetAOut( mp );
 365     if( aout != NULL )
 366     {
 367         ret = aout_VolumeSet( aout, vol );
 368         vlc_object_release( aout );
 369     }
 370     return ret;
 371 }
 372
 373 /*****************************************************************************
 374  * libvlc_audio_get_track_count : Get the number of available audio tracks
 375  *****************************************************************************/
 376 int libvlc_audio_get_track_count( libvlc_media_player_t *p_mi )
 377 {
 378     input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
 379     int i_track_count;
 380
 381     if( !p_input_thread )
 382         return -1;
 383
 384     i_track_count = var_CountChoices( p_input_thread, "audio-es" );
 385
 386     vlc_object_release( p_input_thread );
 387     return i_track_count;
 388 }
 389
 390 /*****************************************************************************
 391  * libvlc_audio_get_track_description : Get the description of available audio tracks
 392  *****************************************************************************/
 393 libvlc_track_description_t *
 394         libvlc_audio_get_track_description( libvlc_media_player_t *p_mi )
 395 {
 396     return libvlc_get_track_description( p_mi, "audio-es" );
 397 }
 398
 399 /*****************************************************************************
 400  * libvlc_audio_get_track : Get the current audio track
 401  *****************************************************************************/
 402 int libvlc_audio_get_track( libvlc_media_player_t *p_mi )
 403 {
 404     input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
 405     if( !p_input_thread )
 406         return -1;
 407
 408     int id = var_GetInteger( p_input_thread, "audio-es" );
 409     vlc_object_release( p_input_thread );
 410     return id;
 411 }
 412
 413 /*****************************************************************************
 414  * libvlc_audio_set_track : Set the current audio track
 415  *****************************************************************************/
 416 int libvlc_audio_set_track( libvlc_media_player_t *p_mi, int i_track )
 417 {
 418     input_thread_t *p_input_thread = libvlc_get_input_thread( p_mi );
 419     vlc_value_t val_list;
 420     int i_ret = -1;
 421
 422     if( !p_input_thread )
 423         return -1;
 424
 425     var_Change( p_input_thread, "audio-es", VLC_VAR_GETCHOICES, &val_list, NULL );
 426     for( int i = 0; i < val_list.p_list->i_count; i++ )
 427     {
 428         if( i_track == val_list.p_list->p_values[i].i_int )
 429         {
 430             if( var_SetInteger( p_input_thread, "audio-es", i_track ) < 0 )
 431                 break;
 432             i_ret = 0;
 433             goto end;
 434         }
 435     }
 436     libvlc_printerr( "Track identifier not found" );
 437 end:
 438     var_FreeList( &val_list, NULL );
 439     vlc_object_release( p_input_thread );
 440     return i_ret;
 441 }
 442
 443 /*****************************************************************************
 444  * libvlc_audio_get_channel : Get the current audio channel
 445  *****************************************************************************/
 446 int libvlc_audio_get_channel( libvlc_media_player_t *mp )
 447 {
 448     audio_output_t *p_aout = GetAOut( mp );
 449     if( !p_aout )
 450         return 0;
 451
 452     int val = var_GetInteger( p_aout, "stereo-mode" );
 453     vlc_object_release( p_aout );
 454     return val;
 455 }
 456
 457 /*****************************************************************************
 458  * libvlc_audio_set_channel : Set the current audio channel
 459  *****************************************************************************/
 460 int libvlc_audio_set_channel( libvlc_media_player_t *mp, int channel )
 461 {
 462     audio_output_t *p_aout = GetAOut( mp );
 463     int ret = 0;
 464
 465     if( !p_aout )
 466         return -1;
 467
 468     if( var_SetInteger( p_aout, "stereo-mode", channel ) < 0 )
 469     {
 470         libvlc_printerr( "Audio channel out of range" );
 471         ret = -1;
 472     }
 473     vlc_object_release( p_aout );
 474     return ret;
 475 }
 476
 477 /*****************************************************************************
 478  * libvlc_audio_get_delay : Get the current audio delay
 479  *****************************************************************************/
 480 int64_t libvlc_audio_get_delay( libvlc_media_player_t *p_mi )
 481 {
 482     input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
 483     int64_t val = 0;
 484     if( p_input_thread != NULL )
 485     {
 486       val = var_GetInteger( p_input_thread, "audio-delay" );
 487       vlc_object_release( p_input_thread );
 488     }
 489     return val;
 490 }
 491
 492 /*****************************************************************************
 493  * libvlc_audio_set_delay : Set the current audio delay
 494  *****************************************************************************/
 495 int libvlc_audio_set_delay( libvlc_media_player_t *p_mi, int64_t i_delay )
 496 {
 497     input_thread_t *p_input_thread = libvlc_get_input_thread ( p_mi );
 498     int ret = 0;
 499     if( p_input_thread != NULL )
 500     {
 501       var_SetInteger( p_input_thread, "audio-delay", i_delay );
 502       vlc_object_release( p_input_thread );
 503     }
 504     else
 505     {
 506       ret = -1;
 507     }
 508     return ret;
 509 }
 510
 511 /*****************************************************************************
 512  * libvlc_audio_equalizer_get_preset_count : Get the number of equalizer presets
 513  *****************************************************************************/
 514 unsigned libvlc_audio_equalizer_get_preset_count( void )
 515 {
 516     return NB_PRESETS;
 517 }
 518
 519 /*****************************************************************************
 520  * libvlc_audio_equalizer_get_preset_name : Get the name for a preset
 521  *****************************************************************************/
 522 const char *libvlc_audio_equalizer_get_preset_name( unsigned u_index )
 523 {
 524     if ( u_index >= NB_PRESETS )
 525         return NULL;
 526
 527     return preset_list_text[ u_index ];
 528 }
 529
 530 /*****************************************************************************
 531  * libvlc_audio_equalizer_get_band_count : Get the number of equalizer frequency bands
 532  *****************************************************************************/
 533 unsigned libvlc_audio_equalizer_get_band_count( void )
 534 {
 535     return EQZ_BANDS_MAX;
 536 }
 537
 538 /*****************************************************************************
 539  * libvlc_audio_equalizer_get_band_frequency : Get the frequency for a band
 540  *****************************************************************************/
 541 float libvlc_audio_equalizer_get_band_frequency( unsigned u_index )
 542 {
 543     if ( u_index >= EQZ_BANDS_MAX )
 544         return -1.f;
 545
 546     return f_iso_frequency_table_10b[ u_index ];
 547 }
 548
 549 /*****************************************************************************
 550  * libvlc_audio_equalizer_new : Create a new audio equalizer with zeroed values
 551  *****************************************************************************/
 552 libvlc_equalizer_t *libvlc_audio_equalizer_new( void )
 553 {
 554     libvlc_equalizer_t *p_equalizer;
 555     p_equalizer = malloc( sizeof( *p_equalizer ) );
 556     if ( unlikely( p_equalizer == NULL ) )
 557         return NULL;
 558
 559     p_equalizer->f_preamp = 0.f;
 560     for ( unsigned i = 0; i < EQZ_BANDS_MAX; i++ )
 561         p_equalizer->f_amp[ i ] = 0.f;
 562
 563     return p_equalizer;
 564 }
 565
 566 /*****************************************************************************
 567  * libvlc_audio_equalizer_new_from_preset : Create a new audio equalizer based on a preset
 568  *****************************************************************************/
 569 libvlc_equalizer_t *libvlc_audio_equalizer_new_from_preset( unsigned u_index )
 570 {
 571     libvlc_equalizer_t *p_equalizer;
 572
 573     if ( u_index >= NB_PRESETS )
 574         return NULL;
 575
 576     p_equalizer = malloc( sizeof( *p_equalizer ) );
 577     if ( unlikely( p_equalizer == NULL ) )
 578         return NULL;
 579
 580     p_equalizer->f_preamp = eqz_preset_10b[ u_index ].f_preamp;
 581
 582     for ( unsigned i = 0; i < EQZ_BANDS_MAX; i++ )
 583         p_equalizer->f_amp[ i ] = eqz_preset_10b[ u_index ].f_amp[ i ];
 584
 585     return p_equalizer;
 586 }
 587
 588 /*****************************************************************************
 589  * libvlc_audio_equalizer_release : Release a previously created equalizer
 590  *****************************************************************************/
 591 void libvlc_audio_equalizer_release( libvlc_equalizer_t *p_equalizer )
 592 {
 593     free( p_equalizer );
 594 }
 595
 596 /*****************************************************************************
 597  * libvlc_audio_equalizer_set_preamp : Set the preamp value for an equalizer
 598  *****************************************************************************/
 599 int libvlc_audio_equalizer_set_preamp( libvlc_equalizer_t *p_equalizer, float f_preamp )
 600 {
 601     if( isnan(f_preamp) )
 602         return -1;
 603     if( f_preamp < -20.f )
 604         f_preamp = -20.f;
 605     else if( f_preamp > 20.f )
 606         f_preamp = 20.f;
 607
 608     p_equalizer->f_preamp = f_preamp;
 609     return 0;
 610 }
 611
 612 /*****************************************************************************
 613  * libvlc_audio_equalizer_get_preamp : Get the preamp value for an equalizer
 614  *****************************************************************************/
 615 float libvlc_audio_equalizer_get_preamp( libvlc_equalizer_t *p_equalizer )
 616 {
 617     return p_equalizer->f_preamp;
 618 }
 619
 620 /*****************************************************************************
 621  * libvlc_audio_equalizer_set_amp_at_index : Set the amplification value for an equalizer band
 622  *****************************************************************************/
 623 int libvlc_audio_equalizer_set_amp_at_index( libvlc_equalizer_t *p_equalizer, float f_amp, unsigned u_band )
 624 {
 625     if( u_band >= EQZ_BANDS_MAX || isnan(f_amp) )
 626         return -1;
 627
 628
 629     if( f_amp < -20.f )
 630         f_amp = -20.f;
 631     else if( f_amp > 20.f )
 632         f_amp = 20.f;
 633
 634     p_equalizer->f_amp[ u_band ] = f_amp;
 635     return 0;
 636 }
 637
 638 /*****************************************************************************
 639  * libvlc_audio_equalizer_get_amp_at_index : Get the amplification value for an equalizer band
 640  *****************************************************************************/
 641 float libvlc_audio_equalizer_get_amp_at_index( libvlc_equalizer_t *p_equalizer, unsigned u_band )
 642 {
 643     if ( u_band >= EQZ_BANDS_MAX )
 644         return nanf("");
 645
 646     return p_equalizer->f_amp[ u_band ];
 647 }