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 VLC authors and VideoLAN
   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 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 LIBVLC_AOUT_INTERNAL_H
  25 # define LIBVLC_AOUT_INTERNAL_H 1
  26
  27 # include <vlc_atomic.h>
  28
  29 /* Max input rate factor (1/4 -> 4) */
  30 # define AOUT_MAX_INPUT_RATE (4)
  31
  32 # define AOUT_MAX_FILTERS 10
  33
  34 enum {
  35     AOUT_RESAMPLING_NONE=0,
  36     AOUT_RESAMPLING_UP,
  37     AOUT_RESAMPLING_DOWN
  38 };
  39
  40 typedef struct
  41 {
  42     struct vout_thread_t  *(*pf_request_vout)( void *, struct vout_thread_t *,
  43                                                video_format_t *, bool );
  44     void *p_private;
  45 } aout_request_vout_t;
  46
  47 typedef struct aout_volume aout_volume_t;
  48
  49 /** an input stream for the audio output */
  50 struct aout_input_t
  51 {
  52     unsigned            samplerate; /**< Input sample rate */
  53
  54     int                     i_resampling_type;
  55     int                     i_resamp_start_drift;
  56
  57     /* last rate from input */
  58     int               i_last_input_rate;
  59
  60     /* */
  61     int               i_buffer_lost;
  62 };
  63
  64 typedef struct
  65 {
  66     vlc_mutex_t lock;
  67     module_t *module; /**< Output plugin (or NULL if inactive) */
  68     aout_input_t *input;
  69     aout_volume_t *volume;
  70
  71     struct
  72     {
  73         date_t date;
  74     } sync;
  75
  76     audio_sample_format_t input_format;
  77     audio_sample_format_t mixer_format;
  78
  79     filter_t *rate_filter; /**< The filter adjusting samples count
  80         (either the scaletempo filter or a resampler) */
  81     filter_t *resampler; /**< The resampler */
  82     filter_t *filters[AOUT_MAX_FILTERS]; /**< Configured user filters
  83         (e.g. equalization) and their conversions */
  84     unsigned nb_filters;
  85     unsigned nb_converters;
  86     filter_t *converters[5]; /**< Converters to the output */
  87
  88     aout_request_vout_t request_vout;
  89     bool recycle_vout;
  90
  91     vlc_atomic_t restart;
  92 } aout_owner_t;
  93
  94 typedef struct
  95 {
  96     audio_output_t output;
  97     aout_owner_t   owner;
  98 } aout_instance_t;
  99
 100 static inline aout_owner_t *aout_owner (audio_output_t *aout)
 101 {
 102     return &((aout_instance_t *)aout)->owner;
 103 }
 104
 105 /****************************************************************************
 106  * Prototypes
 107  *****************************************************************************/
 108
 109 /* From input.c : */
 110 aout_input_t *aout_InputNew(const audio_sample_format_t *);
 111 void aout_InputDelete(aout_input_t *);
 112 block_t *aout_InputPlay( audio_output_t *p_aout, aout_input_t *p_input,
 113                          block_t *p_buffer, int i_input_rate, date_t * );
 114
 115 /* From filters.c : */
 116 int aout_FiltersCreatePipeline( vlc_object_t *, filter_t **, unsigned *,
 117     unsigned, const audio_sample_format_t *, const audio_sample_format_t * );
 118 #define aout_FiltersCreatePipeline(o, pv, pc, max, inf, outf) \
 119         aout_FiltersCreatePipeline(VLC_OBJECT(o), pv, pc, max, inf, outf)
 120 void aout_FiltersDestroyPipeline( filter_t *const *, unsigned );
 121 void aout_FiltersPlay( filter_t *const *, unsigned, block_t ** );
 122
 123 int aout_FiltersNew(audio_output_t *, const audio_sample_format_t *,
 124                    const audio_sample_format_t *, const aout_request_vout_t *);
 125 void aout_FiltersDelete(audio_output_t *);
 126
 127 /* From mixer.c : */
 128 aout_volume_t *aout_volume_New(vlc_object_t *, const audio_replay_gain_t *);
 129 #define aout_volume_New(o, g) aout_volume_New(VLC_OBJECT(o), g)
 130 int aout_volume_SetFormat(aout_volume_t *, vlc_fourcc_t);
 131 void aout_volume_SetVolume(aout_volume_t *, float);
 132 int aout_volume_Amplify(aout_volume_t *, block_t *);
 133 void aout_volume_Delete(aout_volume_t *);
 134
 135
 136 /* From output.c : */
 137 audio_output_t *aout_New (vlc_object_t *);
 138 #define aout_New(a) aout_New(VLC_OBJECT(a))
 139 void aout_Destroy (audio_output_t *);
 140
 141 int aout_OutputNew( audio_output_t * p_aout,
 142                     const audio_sample_format_t * p_format );
 143 void aout_OutputPlay( audio_output_t * p_aout, block_t * p_buffer );
 144 void aout_OutputPause( audio_output_t * p_aout, bool, mtime_t );
 145 void aout_OutputFlush( audio_output_t * p_aout, bool );
 146 void aout_OutputDelete( audio_output_t * p_aout );
 147
 148
 149 /* From common.c : */
 150 void aout_FormatsPrint(vlc_object_t *, const char *,
 151                        const audio_sample_format_t *,
 152                        const audio_sample_format_t *);
 153 #define aout_FormatsPrint(o, t, a, b) \
 154         aout_FormatsPrint(VLC_OBJECT(o), t, a, b)
 155 bool aout_ChangeFilterString( vlc_object_t *manager, vlc_object_t *aout,
 156                               const char *var, const char *name, bool b_add );
 157
 158 /* From dec.c */
 159 int aout_DecNew(audio_output_t *, const audio_sample_format_t *,
 160                 const audio_replay_gain_t *, const aout_request_vout_t *);
 161 void aout_DecDelete(audio_output_t *);
 162 block_t *aout_DecNewBuffer(audio_output_t *, size_t);
 163 void aout_DecDeleteBuffer(audio_output_t *, block_t *);
 164 int aout_DecPlay(audio_output_t *, block_t *, int i_input_rate);
 165 int aout_DecGetResetLost(audio_output_t *);
 166 void aout_DecChangePause(audio_output_t *, bool b_paused, mtime_t i_date);
 167 void aout_DecFlush(audio_output_t *);
 168 bool aout_DecIsEmpty(audio_output_t *);
 169
 170 void aout_InputRequestRestart(audio_output_t *);
 171
 172 /* Audio output locking */
 173 static inline void aout_lock( audio_output_t *p_aout )
 174 {
 175     vlc_mutex_lock( &aout_owner(p_aout)->lock );
 176 }
 177
 178 static inline void aout_unlock( audio_output_t *p_aout )
 179 {
 180     vlc_mutex_unlock( &aout_owner(p_aout)->lock );
 181 }
 182
 183 #define aout_assert_locked( aout ) \
 184         vlc_assert_locked( &aout_owner(aout)->lock )
 185
 186 #endif /* !LIBVLC_AOUT_INTERNAL_H */