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