include/vlc_aout_volume.h

   1 /*****************************************************************************
   2  * vlc_aout_volume.h: audio volume module
   3  *****************************************************************************
   4  * Copyright (C) 2002-2009 VLC authors and VideoLAN
   5  *
   6  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   7  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_AOUT_MIXER_H
  25 #define VLC_AOUT_MIXER_H 1
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /**
  32  * \defgroup audio_volume Audio output volume
  33  * \ingroup audio_output
  34  * @{
  35  * \file
  36  * This file defines functions, structures and macros for audio output mixer object
  37  */
  38
  39 typedef struct audio_volume audio_volume_t;
  40
  41 /**
  42  * Audio volume
  43  */
  44 struct audio_volume
  45 {
  46     struct vlc_object_t obj;
  47
  48     vlc_fourcc_t format; /**< Audio samples format */
  49     void (*amplify)(audio_volume_t *, block_t *, float); /**< Amplifier */
  50 };
  51
  52 /** @} */
  53
  54 #ifdef __cplusplus
  55 }
  56 #endif
  57
  58 #endif