git.sesse.net Git - vlc/blob - include/vlc_aout_mixer.h

   1 /*****************************************************************************
   2  * vlc_aout_mixer.h : audio output mixer interface
   3  *****************************************************************************
   4  * Copyright (C) 2002-2009 the VideoLAN team
   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
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, 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 /**
  29  * \file
  30  * This file defines functions, structures and macros for audio output mixer object
  31  */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 //#include <vlc_aout.h>
  38
  39 /* */
  40 typedef struct aout_mixer_sys_t aout_mixer_sys_t;
  41 typedef struct aout_mixer_t aout_mixer_t;
  42
  43 /**
  44  * audio output mixer
  45  */
  46 struct aout_mixer_t {
  47     VLC_COMMON_MEMBERS
  48
  49     /* Module */
  50     module_t *module;
  51
  52     /* Mixer format.
  53      *
  54      * You cannot modify it.
  55      */
  56     audio_sample_format_t fmt;
  57
  58     aout_fifo_t    *fifo;
  59
  60     /* Mix buffer (mandatory) */
  61     void (*mix)(aout_mixer_t *, aout_buffer_t *, float);
  62
  63     /* Private place holder for the aout_mixer_t module (optional)
  64      *
  65      * A module is free to use it as it wishes.
  66      */
  67     aout_mixer_sys_t *sys;
  68 };
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73
  74 #endif