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