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