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