aout: move sync date from input to aout structure
[vlc.git] / 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     audio_sample_format_t   input;
55     float                   multiplier; /**< Replay gain multiplier */
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
110     /* Filters between mixer and output */
111     filter_t *filters[AOUT_MAX_FILTERS];
112     int       nb_filters;
113
114     bool need_restart;
115 } aout_owner_t;
116
117 typedef struct
118 {
119     audio_output_t output;
120     aout_owner_t   owner;
121 } aout_instance_t;
122
123 static inline aout_owner_t *aout_owner (audio_output_t *aout)
124 {
125     return &((aout_instance_t *)aout)->owner;
126 }
127
128 /****************************************************************************
129  * Prototypes
130  *****************************************************************************/
131
132 /* From input.c : */
133 int aout_InputNew( audio_output_t * p_aout, aout_input_t * p_input, const aout_request_vout_t * );
134 int aout_InputDelete( audio_output_t * p_aout, aout_input_t * p_input );
135 block_t *aout_InputPlay( audio_output_t *p_aout, aout_input_t *p_input,
136                          block_t *p_buffer, int i_input_rate, date_t * );
137 void aout_InputCheckAndRestart( audio_output_t * p_aout, aout_input_t * p_input );
138
139 /* From filters.c : */
140 int aout_FiltersCreatePipeline( vlc_object_t *, filter_t **, int *,
141     const audio_sample_format_t *, const audio_sample_format_t * );
142 #define aout_FiltersCreatePipeline(o, pv, pc, inf, outf) \
143         aout_FiltersCreatePipeline(VLC_OBJECT(o), pv, pc, inf, outf)
144 void aout_FiltersDestroyPipeline( filter_t *const *, unsigned );
145 void aout_FiltersPlay( filter_t *const *, unsigned, aout_buffer_t ** );
146
147 /* From mixer.c : */
148 struct audio_mixer *aout_MixerNew(vlc_object_t *, vlc_fourcc_t);
149 #define aout_MixerNew(o, f) aout_MixerNew(VLC_OBJECT(o), f)
150 void aout_MixerDelete(struct audio_mixer *);
151 void aout_MixerRun(struct audio_mixer *, block_t *, float);
152
153 /* From output.c : */
154 int aout_OutputNew( audio_output_t * p_aout,
155                     const audio_sample_format_t * p_format );
156 void aout_OutputPlay( audio_output_t * p_aout, aout_buffer_t * p_buffer );
157 void aout_OutputPause( audio_output_t * p_aout, bool, mtime_t );
158 void aout_OutputFlush( audio_output_t * p_aout, bool );
159 void aout_OutputDelete( audio_output_t * p_aout );
160
161
162 /* From common.c : */
163 /* Release with vlc_object_release() */
164 audio_output_t *aout_New ( vlc_object_t * );
165 #define aout_New(a) aout_New(VLC_OBJECT(a))
166
167 void aout_FifoInit( vlc_object_t *, aout_fifo_t *, uint32_t );
168 mtime_t aout_FifoFirstDate( const aout_fifo_t * ) VLC_USED;
169 #define aout_FifoInit(o, f, r) aout_FifoInit(VLC_OBJECT(o), f, r)
170 void aout_FifoPush( aout_fifo_t *, aout_buffer_t * );
171 aout_buffer_t *aout_FifoPop( aout_fifo_t * p_fifo ) VLC_USED;
172 void aout_FifoReset( aout_fifo_t * );
173 void aout_FifoMoveDates( aout_fifo_t *, mtime_t );
174 void aout_FifoDestroy( aout_fifo_t * p_fifo );
175 void aout_FormatsPrint(vlc_object_t *, const char *,
176                        const audio_sample_format_t *,
177                        const audio_sample_format_t *);
178 #define aout_FormatsPrint(o, t, a, b) \
179         aout_FormatsPrint(VLC_OBJECT(o), t, a, b)
180 bool aout_ChangeFilterString( vlc_object_t *manager, vlc_object_t *aout,
181                               const char *var, const char *name, bool b_add );
182
183 /* From dec.c */
184 int aout_DecNew(audio_output_t *, const audio_sample_format_t *,
185                 const audio_replay_gain_t *, const aout_request_vout_t *);
186 void aout_DecDelete(audio_output_t *);
187 block_t *aout_DecNewBuffer(audio_output_t *, size_t);
188 void aout_DecDeleteBuffer(audio_output_t *, block_t *);
189 int aout_DecPlay(audio_output_t *, block_t *, int i_input_rate);
190 int aout_DecGetResetLost(audio_output_t *);
191 void aout_DecChangePause(audio_output_t *, bool b_paused, mtime_t i_date);
192 void aout_DecFlush(audio_output_t *);
193 bool aout_DecIsEmpty(audio_output_t *);
194
195 /* Audio output locking */
196
197 #if !defined (NDEBUG) \
198  && defined __linux__ && (defined (__i386__) || defined (__x86_64__))
199 # define AOUT_DEBUG 1
200 #endif
201
202 #ifdef AOUT_DEBUG
203 enum
204 {
205     OUTPUT_LOCK=1,
206     VOLUME_LOCK=2,
207 };
208
209 void aout_lock_check (unsigned);
210 void aout_unlock_check (unsigned);
211
212 #else
213 # define aout_lock_check( i )   (void)0
214 # define aout_unlock_check( i ) (void)0
215 #endif
216
217 static inline void aout_lock( audio_output_t *p_aout )
218 {
219     aout_lock_check( OUTPUT_LOCK );
220     vlc_mutex_lock( &aout_owner(p_aout)->lock );
221 }
222
223 static inline void aout_unlock( audio_output_t *p_aout )
224 {
225     aout_unlock_check( OUTPUT_LOCK );
226     vlc_mutex_unlock( &aout_owner(p_aout)->lock );
227 }
228
229 static inline void aout_lock_volume( audio_output_t *p_aout )
230 {
231     aout_lock_check( VOLUME_LOCK );
232     vlc_mutex_lock( &aout_owner(p_aout)->volume.lock );
233 }
234
235 static inline void aout_unlock_volume( audio_output_t *p_aout )
236 {
237     aout_unlock_check( VOLUME_LOCK );
238     vlc_mutex_unlock( &aout_owner(p_aout)->volume.lock );
239 }
240
241 #define aout_assert_locked( aout ) \
242         vlc_assert_locked( &aout_owner(aout)->lock )
243
244 /* Helpers */
245
246 /**
247  * This function will safely mark aout input to be restarted as soon as
248  * possible to take configuration changes into account */
249 static inline void AoutInputsMarkToRestart( audio_output_t *p_aout )
250 {
251     aout_lock( p_aout );
252     if( aout_owner(p_aout)->input != NULL )
253         aout_owner(p_aout)->input->b_restart = true;
254     aout_unlock( p_aout );
255 }
256
257 #endif /* !LIBVLC_AOUT_INTERNAL_H */