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