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