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