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 #undef aout_VolumeGet
 191 /*****************************************************************************
 192  * aout_VolumeGet : get the volume of the output device
 193  *****************************************************************************/
 194 int aout_VolumeGet( vlc_object_t * p_object, audio_volume_t * pi_volume )
 195 {
 196     int i_result = 0;
 197     aout_instance_t * p_aout = findAout( p_object );
 198
 199     if ( pi_volume == NULL ) return -1;
 200
 201     if ( p_aout == NULL )
 202     {
 203         *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
 204         return 0;
 205     }
 206
 207     aout_lock_volume( p_aout );
 208     aout_lock_mixer( p_aout );
 209     if ( p_aout->p_mixer )
 210     {
 211         i_result = p_aout->output.pf_volume_get( p_aout, pi_volume );
 212     }
 213     else
 214     {
 215         *pi_volume = (audio_volume_t)config_GetInt( p_object, "volume" );
 216     }
 217     aout_unlock_mixer( p_aout );
 218     aout_unlock_volume( p_aout );
 219
 220     vlc_object_release( p_aout );
 221     return i_result;
 222 }
 223
 224 #undef aout_VolumeSet
 225 /*****************************************************************************
 226  * aout_VolumeSet : set the volume of the output device
 227  *****************************************************************************/
 228 int aout_VolumeSet( vlc_object_t * p_object, audio_volume_t i_volume )
 229 {
 230     return doVolumeChanges( SET_VOLUME, p_object, 1, i_volume, NULL, true );
 231 }
 232
 233 #undef aout_VolumeUp
 234 /*****************************************************************************
 235  * aout_VolumeUp : raise the output volume
 236  *****************************************************************************
 237  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 238  * function.
 239  *****************************************************************************/
 240 int aout_VolumeUp( vlc_object_t * p_object, int i_nb_steps,
 241                    audio_volume_t * pi_volume )
 242 {
 243     return doVolumeChanges( INCREMENT_VOLUME, p_object, i_nb_steps, 0, pi_volume, true );
 244 }
 245
 246 #undef aout_VolumeDown
 247 /*****************************************************************************
 248  * aout_VolumeDown : lower the output volume
 249  *****************************************************************************
 250  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 251  * function.
 252  *****************************************************************************/
 253 int aout_VolumeDown( vlc_object_t * p_object, int i_nb_steps,
 254                      audio_volume_t * pi_volume )
 255 {
 256     return aout_VolumeUp( p_object, -i_nb_steps, pi_volume );
 257 }
 258
 259 #undef aout_ToggleMute
 260 /*****************************************************************************
 261  * aout_ToggleMute : Mute/un-mute the output volume
 262  *****************************************************************************
 263  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 264  * function (muted => 0).
 265  *****************************************************************************/
 266 int aout_ToggleMute( vlc_object_t * p_object, audio_volume_t * pi_volume )
 267 {
 268     return doVolumeChanges( TOGGLE_MUTE, p_object, 1, 0, pi_volume, true );
 269 }
 270
 271 /*****************************************************************************
 272  * aout_IsMuted : Get the output volume mute status
 273  *****************************************************************************/
 274 bool aout_IsMuted( vlc_object_t * p_object )
 275 {
 276     bool b_return_val;
 277     aout_instance_t * p_aout = findAout( p_object );
 278     if ( p_aout ) aout_lock_volume( p_aout );
 279     b_return_val = var_GetBool( p_object->p_libvlc, "volume-muted");
 280     if ( p_aout )
 281     {
 282         aout_unlock_volume( p_aout );
 283         vlc_object_release( p_aout );
 284     }
 285     return b_return_val;
 286 }
 287
 288 /*****************************************************************************
 289  * aout_SetMute : Sets mute status
 290  *****************************************************************************
 291  * If pi_volume != NULL, *pi_volume will contain the volume at the end of the
 292  * function (muted => 0).
 293  *****************************************************************************/
 294 int aout_SetMute( vlc_object_t * p_object, audio_volume_t * pi_volume,
 295                   bool b_mute )
 296 {
 297     return doVolumeChanges( SET_MUTE, p_object, 1, 0, pi_volume, b_mute );
 298 }
 299
 300 /*
 301  * The next functions are not supposed to be called by the interface, but
 302  * are placeholders for software-only scaling.
 303  */
 304
 305 /* Meant to be called by the output plug-in's Open(). */
 306 void aout_VolumeSoftInit( aout_instance_t * p_aout )
 307 {
 308     int i_volume;
 309
 310     p_aout->output.pf_volume_get = aout_VolumeSoftGet;
 311     p_aout->output.pf_volume_set = aout_VolumeSoftSet;
 312
 313     i_volume = config_GetInt( p_aout, "volume" );
 314     if ( i_volume < AOUT_VOLUME_MIN )
 315     {
 316         i_volume = AOUT_VOLUME_DEFAULT;
 317     }
 318     else if ( i_volume > AOUT_VOLUME_MAX )
 319     {
 320         i_volume = AOUT_VOLUME_MAX;
 321     }
 322
 323     aout_VolumeSoftSet( p_aout, (audio_volume_t)i_volume );
 324 }
 325
 326 /* Placeholder for pf_volume_get(). */
 327 int aout_VolumeSoftGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
 328 {
 329     *pi_volume = p_aout->output.i_volume;
 330     return 0;
 331 }
 332
 333
 334 /* Placeholder for pf_volume_set(). */
 335 int aout_VolumeSoftSet( aout_instance_t * p_aout, audio_volume_t i_volume )
 336 {
 337     aout_MixerMultiplierSet( p_aout, (float)i_volume / AOUT_VOLUME_DEFAULT );
 338     p_aout->output.i_volume = i_volume;
 339     return 0;
 340 }
 341
 342 /*
 343  * The next functions are not supposed to be called by the interface, but
 344  * are placeholders for unsupported scaling.
 345  */
 346
 347 /* Meant to be called by the output plug-in's Open(). */
 348 void aout_VolumeNoneInit( aout_instance_t * p_aout )
 349 {
 350     p_aout->output.pf_volume_get = aout_VolumeNoneGet;
 351     p_aout->output.pf_volume_set = aout_VolumeNoneSet;
 352 }
 353
 354 /* Placeholder for pf_volume_get(). */
 355 int aout_VolumeNoneGet( aout_instance_t * p_aout, audio_volume_t * pi_volume )
 356 {
 357     (void)p_aout; (void)pi_volume;
 358     return -1;
 359 }
 360
 361 /* Placeholder for pf_volume_set(). */
 362 int aout_VolumeNoneSet( aout_instance_t * p_aout, audio_volume_t i_volume )
 363 {
 364     (void)p_aout; (void)i_volume;
 365     return -1;
 366 }
 367
 368
 369 /*
 370  * Pipelines management
 371  */
 372
 373 /*****************************************************************************
 374  * aout_Restart : re-open the output device and rebuild the input and output
 375  *                pipelines
 376  *****************************************************************************
 377  * This function is used whenever the parameters of the output plug-in are
 378  * changed (eg. selecting S/PDIF or PCM).
 379  *****************************************************************************/
 380 static int aout_Restart( aout_instance_t * p_aout )
 381 {
 382     int i;
 383     bool b_error = 0;
 384
 385     aout_lock_mixer( p_aout );
 386
 387     if ( p_aout->i_nb_inputs == 0 )
 388     {
 389         aout_unlock_mixer( p_aout );
 390         msg_Err( p_aout, "no decoder thread" );
 391         return -1;
 392     }
 393
 394     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 395     {
 396         aout_lock_input( p_aout, p_aout->pp_inputs[i] );
 397         aout_lock_input_fifos( p_aout );
 398         aout_InputDelete( p_aout, p_aout->pp_inputs[i] );
 399         aout_unlock_input_fifos( p_aout );
 400     }
 401
 402     /* Lock all inputs. */
 403     aout_lock_input_fifos( p_aout );
 404     aout_MixerDelete( p_aout );
 405
 406     /* Re-open the output plug-in. */
 407     aout_OutputDelete( p_aout );
 408
 409     if ( aout_OutputNew( p_aout, &p_aout->pp_inputs[0]->input ) == -1 )
 410     {
 411         /* Release all locks and report the error. */
 412         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 413         {
 414             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
 415         }
 416         aout_unlock_input_fifos( p_aout );
 417         aout_unlock_mixer( p_aout );
 418         return -1;
 419     }
 420
 421     if ( aout_MixerNew( p_aout ) == -1 )
 422     {
 423         aout_OutputDelete( p_aout );
 424         for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 425         {
 426             vlc_mutex_unlock( &p_aout->pp_inputs[i]->lock );
 427         }
 428         aout_unlock_input_fifos( p_aout );
 429         aout_unlock_mixer( p_aout );
 430         return -1;
 431     }
 432
 433     /* Re-open all inputs. */
 434     for ( i = 0; i < p_aout->i_nb_inputs; i++ )
 435     {
 436         aout_input_t * p_input = p_aout->pp_inputs[i];
 437         b_error |= aout_InputNew( p_aout, p_input, &p_input->request_vout );
 438         p_input->b_changed = 1;
 439         aout_unlock_input( p_aout, p_input );
 440     }
 441
 442     aout_unlock_input_fifos( p_aout );
 443     aout_unlock_mixer( p_aout );
 444
 445     return b_error;
 446 }
 447
 448 /*****************************************************************************
 449  * aout_FindAndRestart : find the audio output instance and restart
 450  *****************************************************************************
 451  * This is used for callbacks of the configuration variables, and we believe
 452  * that when those are changed, it is a significant change which implies
 453  * rebuilding the audio-device and audio-channels variables.
 454  *****************************************************************************/
 455 int aout_FindAndRestart( vlc_object_t * p_this, const char *psz_name,
 456                          vlc_value_t oldval, vlc_value_t newval, void *p_data )
 457 {
 458     aout_instance_t * p_aout = findAout( p_this );
 459
 460     (void)psz_name; (void)oldval; (void)newval; (void)p_data;
 461     if ( p_aout == NULL ) return VLC_SUCCESS;
 462
 463     var_Destroy( p_aout, "audio-device" );
 464     var_Destroy( p_aout, "audio-channels" );
 465
 466     aout_Restart( p_aout );
 467     vlc_object_release( p_aout );
 468
 469     return VLC_SUCCESS;
 470 }
 471
 472 /*****************************************************************************
 473  * aout_ChannelsRestart : change the audio device or channels and restart
 474  *****************************************************************************/
 475 int aout_ChannelsRestart( vlc_object_t * p_this, const char * psz_variable,
 476                           vlc_value_t oldval, vlc_value_t newval,
 477                           void *p_data )
 478 {
 479     aout_instance_t * p_aout = (aout_instance_t *)p_this;
 480     (void)oldval; (void)newval; (void)p_data;
 481
 482     if ( !strcmp( psz_variable, "audio-device" ) )
 483     {
 484         /* This is supposed to be a significant change and supposes
 485          * rebuilding the channel choices. */
 486         var_Destroy( p_aout, "audio-channels" );
 487     }
 488     aout_Restart( p_aout );
 489     return 0;
 490 }
 491
 492 #undef aout_EnableFilter
 493 /** Enable or disable an audio filter
 494  * \param p_this a vlc object
 495  * \param psz_name name of the filter
 496  * \param b_add are we adding or removing the filter ?
 497  */
 498 void aout_EnableFilter( vlc_object_t *p_this, const char *psz_name,
 499                         bool b_add )
 500 {
 501     aout_instance_t *p_aout = findAout( p_this );
 502
 503     if( AoutChangeFilterString( p_this, p_aout, "audio-filter", psz_name, b_add ) )
 504     {
 505         if( p_aout )
 506             AoutInputsMarkToRestart( p_aout );
 507     }
 508
 509     if( p_aout )
 510         vlc_object_release( p_aout );
 511 }