git.sesse.net Git - vlc/blob - 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 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>                            /* calloc(), malloc(), free() */
  36 #include <string.h>
  37
  38 #include <vlc_aout.h>
  39 #include "aout_internal.h"
  40
  41 #include <vlc_playlist.h>
  42
  43 static aout_instance_t *findAout (vlc_object_t *obj)
  44 {
  45     input_thread_t *p_input = playlist_CurrentInput (pl_Get (obj));
  46     if (p_input == NULL)
  47        return NULL;
  48
  49     aout_instance_t *p_aout = input_GetAout (p_input);
  50     vlc_object_release (p_input);
  51     return p_aout;
  52 }
  53
  54 /*
  55  * Volume management
  56  *
  57  * The hardware volume cannot be set if the output module gets deleted, so
  58  * we must take the mixer lock. The software volume cannot be set while the
  59  * mixer is running, so we need the mixer lock (too).
  60  *
  61  * Here is a schematic of the i_volume range :
  62  *
  63  * |------------------------------+---------------------------------------|
  64  * 0                           pi_soft                                   1024
  65  *
  66  * Between 0 and pi_soft, the volume is done in hardware by the output
  67  * module. Above, the output module will change p_aout->mixer.i_multiplier
  68  * (done in software). This scaling may result * in cropping errors and
  69  * should be avoided as much as possible.
  70  *
  71  * It is legal to have *pi_soft == 0, and do everything in software.
  72  * It is also legal to have *pi_soft == 1024, and completely avoid
  73  * software scaling. However, some streams (esp. A/52) are encoded with
  74  * a very low volume and users may complain.
  75  */
  76
  77 enum {
  78     SET_MUTE=1,
  79     SET_VOLUME=2,
  80     INCREMENT_VOLUME=4,
  81     TOGGLE_MUTE=8
  82 };
  83 /*****************************************************************************
  84  * doVolumeChanges : handle all volume changes. Internal use only to ease
  85  *                   variables locking.
  86  *****************************************************************************/
  87 int doVolumeChanges( unsigned action, vlc_object_t * p_object, int i_nb_steps,
  88                 audio_volume_t i_volume, audio_volume_t * i_return_volume,
  89                 bool b_mute )
  90 {
  91     int i_result = VLC_SUCCESS;
  92     int i_volume_step = 1, i_new_volume = 0;
  93     bool b_var_mute = false;
  94     aout_instance_t *p_aout = findAout( p_object );
  95
  96     if ( p_aout ) aout_lock_volume( p_aout );
  97
  98     b_var_mute = (bool)var_GetBool( p_object->p_libvlc, "volume-muted");
  99
 100     const bool b_unmute_condition = ( /* Also unmute on increments */
 101                     ( action == INCREMENT_VOLUME )
 102                     || /* On explicit unmute */
 103                     ( ( action == SET_MUTE ) && ( b_var_mute && !b_mute ) )
 104                     || /* On toggle from muted */
 105                     ( ( action == TOGGLE_MUTE ) && b_var_mute ) );
 106
 107     const bool b_mute_condition = ( !b_var_mute
 108                     && ( /* explicit */
 109                         ( ( action == SET_MUTE ) && b_mute )
 110                         || /* or toggle */
 111                         ( action == TOGGLE_MUTE )
 112                     ));
 113
 114     /* On UnMute */
 115     if ( b_unmute_condition )
 116     {
 117         /* Restore saved volume */
 118         var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
 119         i_volume = (audio_volume_t)var_GetInteger( p_object->p_libvlc,
 120                                                    "saved-volume" );
 121         var_SetBool( p_object->p_libvlc, "volume-muted", false );
 122     }
 123     else if ( b_mute_condition )
 124     {
 125         /* We need an initial value to backup later */
 126         i_volume = config_GetInt( p_object, "volume" );
 127     }
 128
 129     if ( action == INCREMENT_VOLUME )
 130     {
 131         i_volume_step = config_GetInt( p_object->p_libvlc, "volume-step" );
 132
 133         if ( !b_unmute_condition )
 134             i_volume = config_GetInt( p_object, "volume" );
 135
 136         i_new_volume = (int) i_volume + i_volume_step * i_nb_steps;
 137
 138         if ( i_new_volume > AOUT_VOLUME_MAX )
 139             i_volume = AOUT_VOLUME_MAX;
 140         else if ( i_new_volume < AOUT_VOLUME_MIN )
 141             i_volume = AOUT_VOLUME_MIN;
 142         else
 143             i_volume = i_new_volume;
 144
 145         if ( i_return_volume != NULL )
 146             *i_return_volume = i_volume;
 147     }
 148
 149     var_Create( p_object->p_libvlc, "saved-volume", VLC_VAR_INTEGER );
 150     var_SetInteger( p_object->p_libvlc, "saved-volume" , i_volume );
 151
 152     /* On Mute */
 153     if ( b_mute_condition )
 154     {
 155         i_volume = AOUT_VOLUME_MIN;
 156         var_SetBool( p_object->p_libvlc, "volume-muted", true );
 157     }
 158
 159     /* Commit volume changes */
 160     config_PutInt( p_object, "volume", i_volume );
 161
 162     if ( p_aout )
 163     {
 164         aout_lock_mixer( p_aout );
 165         aout_lock_input_fifos( p_aout );
 166             if ( p_aout->p_mixer )
 167                 i_result = p_aout->output.pf_volume_set( p_aout, i_volume );
 168         aout_unlock_input_fifos( p_aout );
 169         aout_unlock_mixer( p_aout );
 170     }
 171
 172     /* trigger callbacks */
 173     var_TriggerCallback( p_object->p_libvlc, "volume-change");
 174     if ( p_aout )
 175     {
 176         var_SetBool( p_aout, "intf-change", true );
 177         aout_unlock_volume( p_aout );
 178         vlc_object_release( p_aout );
 179     }
 180
 181     return i_result;
 182 }
 183
 184 #undef aout_VolumeGet
 185 /*****************************************************************************
 186  * aout_VolumeGet : get the volume of the output device
 187  *****************************************************************************/
 188 int aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
 189 {
 190     int i_result = 0;
 191     aout_instance_t * p_aout = findAout( p_object );
 192
 193     if ( pi_volume == NULL ) return -1;
 194
 195     if ( p_aout == NULL )
 196     {
 197         *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
 198         return 0;
 199     }
 200
 201     aout_lock_volume( p_aout );
 202     aout_lock_mixer( p_aout );
 203     if ( p_aout->p_mixer )
 204     {
 205         i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
 206     }
 207     else
 208     {
 209         *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
 210     }
 211     aout_unlock_mixer( p_aout );
 212     aout_unlock_volume( p_aout );
 213
 214     vlc_object_release( p_aout );
 215     return i_result;
 216 }
 217
 218 #undef aout_VolumeSet
 219 /*****************************************************************************
 220  * aout_VolumeSet : set the volume of the output device
 221  *****************************************************************************/
 222 int aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
 223 {
 224     return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
 225 }
 226
 227 #undef aout_VolumeUp
 228 /*****************************************************************************
 229  * aout_VolumeUp : raise the output volume
 230  *****************************************************************************
 231  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 232  * function.
 233  *****************************************************************************/
 234 int aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
 235                    audio_volume_t * pi_volume )
 236 {
 237     return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
 238 }
 239
 240 #undef aout_VolumeDown
 241 /*****************************************************************************
 242  * aout_VolumeDown : lower the output volume
 243  *****************************************************************************
 244  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 245  * function.
 246  *****************************************************************************/
 247 int aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
 248                      audio_volume_t * pi_volume )
 249 {
 250     return aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
 251 }
 252
 253 #undef aout_ToggleMute
 254 /*****************************************************************************
 255  * aout_ToggleMute : Mute/un-mute the output volume
 256  *****************************************************************************
 257  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 258  * function (muted => 0).
 259  *****************************************************************************/
 260 int aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
 261 {
 262     return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
 263 }
 264
 265 /*****************************************************************************
 266  * aout_IsMuted : Get the output volume mute status
 267  *****************************************************************************/
 268 bool aout_IsMuted( vlc_object_t * p_object )
 269 {
 270     bool b_return_val;
 271     aout_instance_t * p_aout = findAout( p_object );
 272     if ( p_aout ) aout_lock_volume( p_aout );
 273     b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
 274     if ( p_aout )
 275     {
 276         aout_unlock_volume( p_aout );
 277         vlc_object_release( p_aout );
 278     }
 279     return b_return_val;
 280 }
 281
 282 /*****************************************************************************
 283  * aout_SetMute : Sets mute status
 284  *****************************************************************************
 285  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 286  * function (muted => 0).
 287  *****************************************************************************/
 288 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
 289                   bool b_mute )
 290 {
 291     return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
 292 }
 293
 294 /*
 295  * The next functions are not supposed to be called by the interface, but
 296  * are placeholders for software-only scaling.
 297  */
 298
 299 /* Meant to be called by the output plug-in's Open(). */
 300 void aout_VolumeSoftInit( aout_instance_t * p_aout )
 301 {
 302     int i_volume;
 303
 304     p_aout->output.pf_volume_get = aout_VolumeSoftGet;
 305     p_aout->output.pf_volume_set = aout_VolumeSoftSet;
 306
 307     i_volume = config_GetInt( p_aout, "volume" );
 308     if ( i_volume < AOUT_VOLUME_MIN )
 309     {
 310         i_volume = AOUT_VOLUME_DEFAULT;
 311     }
 312     else if ( i_volume > AOUT_VOLUME_MAX )
 313     {
 314         i_volume = AOUT_VOLUME_MAX;
 315     }
 316
 317     aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
 318 }
 319
 320 /* Placeholder for pf_volume_get(). */
 321 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
 322 {
 323     *pi_volume = p_aout->output.i_volume;
 324     return 0;
 325 }
 326
 327
 328 /* Placeholder for pf_volume_set(). */
 329 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
 330 {
 331     aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
 332     p_aout->output.i_volume = i_volume;
 333     return 0;
 334 }
 335
 336 /*
 337  * The next functions are not supposed to be called by the interface, but
 338  * are placeholders for unsupported scaling.
 339  */
 340
 341 /* Meant to be called by the output plug-in's Open(). */
 342 void aout_VolumeNoneInit( aout_instance_t * p_aout )
 343 {
 344     p_aout->output.pf_volume_get = aout_VolumeNoneGet;
 345     p_aout->output.pf_volume_set = aout_VolumeNoneSet;
 346 }
 347
 348 /* Placeholder for pf_volume_get(). */
 349 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
 350 {
 351     (void)p_aout; (void)pi_volume;
 352     return -1;
 353 }
 354
 355 /* Placeholder for pf_volume_set(). */
 356 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
 357 {
 358     (void)p_aout; (void)i_volume;
 359     return -1;
 360 }
 361
 362
 363 /*
 364  * Pipelines management
 365  */
 366
 367 /*****************************************************************************
 368  * aout_Restart : re-open the output device and rebuild the input and output
 369  *                pipelines
 370  *****************************************************************************
 371  * This function is used whenever the parameters of the output plug-in are
 372  * changed (eg. selecting S/PDIF or PCM).
 373  *****************************************************************************/
 374 static int aout_Restart( aout_instance_t * p_aout )
 375 {
 376     int i;
 377     bool b_error = 0;
 378
 379     aout_lock_mixer( p_aout );
 380
 381     if ( p_aout->i_nb_inputs == 0 )
 382     {
 383         aout_unlock_mixer( p_aout );
 384         msg_Err( p_aout, "no decoder thread" );
 385         return -1;
 386     }
 387
 388     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 389     {
 390         aout_lock_input( p_aout, p_aout->pp_inputs[i] );
 391         aout_lock_input_fifos( p_aout );
 392         aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
 393         aout_unlock_input_fifos( p_aout );
 394     }
 395
 396     /* Lock all inputs. */
 397     aout_lock_input_fifos( p_aout );
 398     aout_MixerDelete( p_aout );
 399
 400     /* Re-open the output plug-in. */
 401     aout_OutputDelete( p_aout );
 402
 403     if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
 404     {
 405         /* Release all locks and report the error. */
 406         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 407         {
 408             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
 409         }
 410         aout_unlock_input_fifos( p_aout );
 411         aout_unlock_mixer( p_aout );
 412         return -1;
 413     }
 414
 415     if ( aout_MixerNew( p_aout ) == -1 )
 416     {
 417         aout_OutputDelete( p_aout );
 418         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 419         {
 420             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
 421         }
 422         aout_unlock_input_fifos( p_aout );
 423         aout_unlock_mixer( p_aout );
 424         return -1;
 425     }
 426
 427     /* Re-open all inputs. */
 428     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 429     {
 430         aout_input_t * p_input = p_aout->pp_inputs[i];
 431         b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
 432         p_input->b_changed = 1;
 433         aout_unlock_input( p_aout, p_input );
 434     }
 435
 436     aout_unlock_input_fifos( p_aout );
 437     aout_unlock_mixer( p_aout );
 438
 439     return b_error;
 440 }
 441
 442 /*****************************************************************************
 443  * aout_FindAndRestart : find the audio output instance and restart
 444  *****************************************************************************
 445  * This is used for callbacks of the configuration variables, and we believe
 446  * that when those are changed, it is a significant change which implies
 447  * rebuilding the audio-device and audio-channels variables.
 448  *****************************************************************************/
 449 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
 450                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 451 {
 452     aout_instance_t * p_aout = findAout( p_this );
 453
 454     (void)psz_name; (void)oldval; (void)newval; (void)p_data;
 455     if ( p_aout == NULL ) return VLC_SUCCESS;
 456
 457     var_Destroy( p_aout, "audio-device" );
 458     var_Destroy( p_aout, "audio-channels" );
 459
 460     aout_Restart( p_aout );
 461     vlc_object_release( p_aout );
 462
 463     return VLC_SUCCESS;
 464 }
 465
 466 /*****************************************************************************
 467  * aout_ChannelsRestart : change the audio device or channels and restart
 468  *****************************************************************************/
 469 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
 470                           vlc_value_t oldval, vlc_value_t newval,
 471                           void *p_data )
 472 {
 473     aout_instance_t * p_aout = (aout_instance_t *)p_this;
 474     (void)oldval; (void)newval; (void)p_data;
 475
 476     if ( !strcmp( psz_variable, "audio-device" ) )
 477     {
 478         /* This is supposed to be a significant change and supposes
 479          * rebuilding the channel choices. */
 480         var_Destroy( p_aout, "audio-channels" );
 481     }
 482     aout_Restart( p_aout );
 483     return 0;
 484 }
 485
 486 #undef aout_EnableFilter
 487 /** Enable or disable an audio filter
 488  * \param p_this a vlc object
 489  * \param psz_name name of the filter
 490  * \param b_add are we adding or removing the filter ?
 491  */
 492 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
 493                         bool b_add )
 494 {
 495     aout_instance_t *p_aout = findAout( p_this );
 496
 497     if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
 498     {
 499         if( p_aout )
 500             AoutInputsMarkToRestart( p_aout );
 501     }
 502
 503     if( p_aout )
 504         vlc_object_release( p_aout );
 505 }