git.sesse.net Git - vlc/blob - src/audio_output/aout_internal.h

   1 /*****************************************************************************
   2  * aout_internal.h : internal defines for audio output
   3  *****************************************************************************
   4  * Copyright (C) 2002 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 #ifndef LIBVLC_AOUT_INTERNAL_H
  25 # define LIBVLC_AOUT_INTERNAL_H 1
  26
  27 /* Max input rate factor (1/4 -> 4) */
  28 # define AOUT_MAX_INPUT_RATE (4)
  29
  30 enum {
  31     AOUT_RESAMPLING_NONE=0,
  32     AOUT_RESAMPLING_UP,
  33     AOUT_RESAMPLING_DOWN
  34 };
  35
  36 typedef struct
  37 {
  38     struct vout_thread_t  *(*pf_request_vout)( void *, struct vout_thread_t *,
  39                                                video_format_t *, bool );
  40     void *p_private;
  41 } aout_request_vout_t;
  42
  43 struct filter_owner_sys_t
  44 {
  45     audio_output_t *p_aout;
  46     aout_input_t    *p_input;
  47 };
  48
  49 block_t *aout_FilterBufferNew( filter_t *, int );
  50
  51 /** an input stream for the audio output */
  52 struct aout_input_t
  53 {
  54     float                   multiplier; /**< Replay gain multiplier */
  55     unsigned            samplerate; /**< Input sample rate */
  56
  57     /* pre-filters */
  58     filter_t *              pp_filters[AOUT_MAX_FILTERS];
  59     int                     i_nb_filters;
  60
  61     filter_t *              p_playback_rate_filter;
  62
  63     /* resamplers */
  64     filter_t *              pp_resamplers[AOUT_MAX_FILTERS];
  65     int                     i_nb_resamplers;
  66     int                     i_resampling_type;
  67     mtime_t                 i_resamp_start_date;
  68     int                     i_resamp_start_drift;
  69
  70     /* Mixer information */
  71     audio_replay_gain_t     replay_gain;
  72
  73     /* If b_restart == 1, the input pipeline will be re-created. */
  74     bool              b_restart;
  75
  76     /* If b_error == 1, there is no input pipeline. */
  77     bool              b_error;
  78
  79     /* last rate from input */
  80     int               i_last_input_rate;
  81
  82     /* */
  83     int               i_buffer_lost;
  84
  85     /* */
  86     bool                b_recycle_vout;
  87     aout_request_vout_t request_vout;
  88 };
  89
  90 typedef struct
  91 {
  92     vlc_mutex_t lock;
  93     module_t *module; /**< Output plugin (or NULL if inactive) */
  94     aout_input_t *input;
  95
  96     struct
  97     {
  98         date_t date;
  99     } sync;
 100
 101     struct
 102     {
 103         vlc_mutex_t lock;
 104         float multiplier; /**< Software volume amplification multiplier */
 105         struct audio_mixer *mixer; /**< Software volume plugin */
 106     } volume; /**< Volume and gain management (FIXME: input manager?) */
 107
 108     audio_sample_format_t mixer_format;
 109     audio_sample_format_t input_format;
 110
 111     /* Filters between mixer and output */
 112     filter_t *filters[AOUT_MAX_FILTERS];
 113     int       nb_filters;
 114
 115     bool need_restart;
 116 } aout_owner_t;
 117
 118 typedef struct
 119 {
 120     audio_output_t output;
 121     aout_owner_t   owner;
 122 } aout_instance_t;
 123
 124 static inline aout_owner_t *aout_owner (audio_output_t *aout)
 125 {
 126     return &((aout_instance_t *)aout)->owner;
 127 }
 128
 129 /****************************************************************************
 130  * Prototypes
 131  *****************************************************************************/
 132
 133 /* From input.c : */
 134 int aout_InputNew(audio_output_t *, const audio_sample_format_t *,
 135                   aout_input_t *, const aout_request_vout_t *);
 136 int aout_InputDelete( audio_output_t * p_aout, aout_input_t * p_input );
 137 block_t *aout_InputPlay( audio_output_t *p_aout, aout_input_t *p_input,
 138                          block_t *p_buffer, int i_input_rate, date_t * );
 139 void aout_InputCheckAndRestart( audio_output_t * p_aout, aout_input_t * p_input );
 140
 141 /* From filters.c : */
 142 int aout_FiltersCreatePipeline( vlc_object_t *, filter_t **, int *,
 143     const audio_sample_format_t *, const audio_sample_format_t * );
 144 #define aout_FiltersCreatePipeline(o, pv, pc, inf, outf) \
 145         aout_FiltersCreatePipeline(VLC_OBJECT(o), pv, pc, inf, outf)
 146 void aout_FiltersDestroyPipeline( filter_t *const *, unsigned );
 147 void aout_FiltersPlay( filter_t *const *, unsigned, aout_buffer_t ** );
 148
 149 /* From mixer.c : */
 150 struct audio_mixer *aout_MixerNew(vlc_object_t *, vlc_fourcc_t);
 151 #define aout_MixerNew(o, f) aout_MixerNew(VLC_OBJECT(o), f)
 152 void aout_MixerDelete(struct audio_mixer *);
 153 void aout_MixerRun(struct audio_mixer *, block_t *, float);
 154
 155 /* From output.c : */
 156 int aout_OutputNew( audio_output_t * p_aout,
 157                     const audio_sample_format_t * p_format );
 158 void aout_OutputPlay( audio_output_t * p_aout, aout_buffer_t * p_buffer );
 159 void aout_OutputPause( audio_output_t * p_aout, bool, mtime_t );
 160 void aout_OutputFlush( audio_output_t * p_aout, bool );
 161 void aout_OutputDelete( audio_output_t * p_aout );
 162
 163
 164 /* From common.c : */
 165 /* Release with vlc_object_release() */
 166 audio_output_t *aout_New ( vlc_object_t * );
 167 #define aout_New(a) aout_New(VLC_OBJECT(a))
 168
 169 void aout_FifoInit( vlc_object_t *, aout_fifo_t *, uint32_t );
 170 mtime_t aout_FifoFirstDate( const aout_fifo_t * ) VLC_USED;
 171 #define aout_FifoInit(o, f, r) aout_FifoInit(VLC_OBJECT(o), f, r)
 172 void aout_FifoPush( aout_fifo_t *, aout_buffer_t * );
 173 aout_buffer_t *aout_FifoPop( aout_fifo_t * p_fifo ) VLC_USED;
 174 void aout_FifoReset( aout_fifo_t * );
 175 void aout_FifoMoveDates( aout_fifo_t *, mtime_t );
 176 void aout_FifoDestroy( aout_fifo_t * p_fifo );
 177 void aout_FormatsPrint(vlc_object_t *, const char *,
 178                        const audio_sample_format_t *,
 179                        const audio_sample_format_t *);
 180 #define aout_FormatsPrint(o, t, a, b) \
 181         aout_FormatsPrint(VLC_OBJECT(o), t, a, b)
 182 bool aout_ChangeFilterString( vlc_object_t *manager, vlc_object_t *aout,
 183                               const char *var, const char *name, bool b_add );
 184
 185 /* From dec.c */
 186 int aout_DecNew(audio_output_t *, const audio_sample_format_t *,
 187                 const audio_replay_gain_t *, const aout_request_vout_t *);
 188 void aout_DecDelete(audio_output_t *);
 189 block_t *aout_DecNewBuffer(audio_output_t *, size_t);
 190 void aout_DecDeleteBuffer(audio_output_t *, block_t *);
 191 int aout_DecPlay(audio_output_t *, block_t *, int i_input_rate);
 192 int aout_DecGetResetLost(audio_output_t *);
 193 void aout_DecChangePause(audio_output_t *, bool b_paused, mtime_t i_date);
 194 void aout_DecFlush(audio_output_t *);
 195 bool aout_DecIsEmpty(audio_output_t *);
 196
 197 /* Audio output locking */
 198
 199 #if !defined (NDEBUG) \
 200  && defined __linux__ && (defined (__i386__) || defined (__x86_64__))
 201 # define AOUT_DEBUG 1
 202 #endif
 203
 204 #ifdef AOUT_DEBUG
 205 enum
 206 {
 207     OUTPUT_LOCK=1,
 208     VOLUME_LOCK=2,
 209 };
 210
 211 void aout_lock_check (unsigned);
 212 void aout_unlock_check (unsigned);
 213
 214 #else
 215 # define aout_lock_check( i )   (void)0
 216 # define aout_unlock_check( i ) (void)0
 217 #endif
 218
 219 static inline void aout_lock( audio_output_t *p_aout )
 220 {
 221     aout_lock_check( OUTPUT_LOCK );
 222     vlc_mutex_lock( &aout_owner(p_aout)->lock );
 223 }
 224
 225 static inline void aout_unlock( audio_output_t *p_aout )
 226 {
 227     aout_unlock_check( OUTPUT_LOCK );
 228     vlc_mutex_unlock( &aout_owner(p_aout)->lock );
 229 }
 230
 231 static inline void aout_lock_volume( audio_output_t *p_aout )
 232 {
 233     aout_lock_check( VOLUME_LOCK );
 234     vlc_mutex_lock( &aout_owner(p_aout)->volume.lock );
 235 }
 236
 237 static inline void aout_unlock_volume( audio_output_t *p_aout )
 238 {
 239     aout_unlock_check( VOLUME_LOCK );
 240     vlc_mutex_unlock( &aout_owner(p_aout)->volume.lock );
 241 }
 242
 243 #define aout_assert_locked( aout ) \
 244         vlc_assert_locked( &aout_owner(aout)->lock )
 245
 246 /* Helpers */
 247
 248 /**
 249  * This function will safely mark aout input to be restarted as soon as
 250  * possible to take configuration changes into account */
 251 static inline void AoutInputsMarkToRestart( audio_output_t *p_aout )
 252 {
 253     aout_lock( p_aout );
 254     if( aout_owner(p_aout)->input != NULL )
 255         aout_owner(p_aout)->input->b_restart = true;
 256     aout_unlock( p_aout );
 257 }
 258
 259 #endif /* !LIBVLC_AOUT_INTERNAL_H */