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