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