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