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  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VLC_AOUT_MIXER_H
  26 #define VLC_AOUT_MIXER_H 1
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 /**
  33  * \defgroup audio_volume Audio output volume
  34  * \ingroup audio_output
  35  * @{
  36  * \file
  37  * This file defines functions, structures and macros for audio output mixer object
  38  */
  39
  40 typedef struct audio_volume audio_volume_t;
  41
  42 /**
  43  * Audio volume
  44  */
  45 struct audio_volume
  46 {
  47     VLC_COMMON_MEMBERS
  48
  49     vlc_fourcc_t format; /**< Audio samples format */
  50     void (*amplify)(audio_volume_t *, block_t *, float); /**< Amplifier */
  51 };
  52
  53 /** @} */
  54
  55 #ifdef __cplusplus
  56 }
  57 #endif
  58
  59 #endif