4a236730c9a4759464f8b534b0e01930595a40c0
[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 # include <vlc_aout_mixer.h>
28
29 typedef struct
30 {
31     struct vout_thread_t  *(*pf_request_vout)( void *, struct vout_thread_t *,
32                                                video_format_t *, bool );
33     void *p_private;
34 } aout_request_vout_t;
35
36 struct filter_owner_sys_t
37 {
38     aout_instance_t *p_aout;
39     aout_input_t    *p_input;
40 };
41
42 block_t *aout_FilterBufferNew( filter_t *, int );
43
44 /** an input stream for the audio output */
45 struct aout_input_t
46 {
47     /* When this lock is taken, the pipeline cannot be changed by a
48      * third-party. */
49     vlc_mutex_t             lock;
50
51     audio_sample_format_t   input;
52
53     /* pre-filters */
54     filter_t *              pp_filters[AOUT_MAX_FILTERS];
55     int                     i_nb_filters;
56
57     filter_t *              p_playback_rate_filter;
58
59     /* resamplers */
60     filter_t *              pp_resamplers[AOUT_MAX_FILTERS];
61     int                     i_nb_resamplers;
62     int                     i_resampling_type;
63     mtime_t                 i_resamp_start_date;
64     int                     i_resamp_start_drift;
65
66     /* Mixer information */
67     audio_replay_gain_t     replay_gain;
68
69     /* If b_restart == 1, the input pipeline will be re-created. */
70     bool              b_restart;
71
72     /* If b_error == 1, there is no input pipeline. */
73     bool              b_error;
74
75     /* last rate from input */
76     int               i_last_input_rate;
77
78     /* */
79     int               i_buffer_lost;
80
81     /* */
82     bool              b_paused;
83     mtime_t           i_pause_date;
84
85     /* */
86     bool                b_recycle_vout;
87     aout_request_vout_t request_vout;
88
89     /* */
90     aout_mixer_input_t mixer;
91  };
92
93 /****************************************************************************
94  * Prototypes
95  *****************************************************************************/
96
97 /* From input.c : */
98 int aout_InputNew( aout_instance_t * p_aout, aout_input_t * p_input, const aout_request_vout_t * );
99 int aout_InputDelete( aout_instance_t * p_aout, aout_input_t * p_input );
100 void aout_InputPlay( aout_instance_t * p_aout, aout_input_t * p_input,
101                      aout_buffer_t * p_buffer, int i_input_rate );
102 void aout_InputCheckAndRestart( aout_instance_t * p_aout, aout_input_t * p_input );
103
104 /* From filters.c : */
105 int aout_FiltersCreatePipeline( aout_instance_t *, filter_t **, int *,
106     const audio_sample_format_t *, const audio_sample_format_t * );
107 void aout_FiltersDestroyPipeline( filter_t *const *, unsigned );
108 void aout_FiltersPlay( filter_t *const *, unsigned, aout_buffer_t ** );
109
110 /* From mixer.c : */
111 int aout_MixerNew( aout_instance_t * p_aout );
112 void aout_MixerDelete( aout_instance_t * p_aout );
113 void aout_MixerRun( aout_instance_t * p_aout, float );
114
115 /* From output.c : */
116 int aout_OutputNew( aout_instance_t * p_aout,
117                     const audio_sample_format_t * p_format );
118 void aout_OutputPlay( aout_instance_t * p_aout, aout_buffer_t * p_buffer );
119 void aout_OutputPause( aout_instance_t * p_aout, bool, mtime_t );
120 void aout_OutputDelete( aout_instance_t * p_aout );
121
122
123 /* From common.c : */
124 #define aout_New(a) __aout_New(VLC_OBJECT(a))
125 /* Release with vlc_object_release() */
126 aout_instance_t * __aout_New ( vlc_object_t * );
127
128 void aout_FifoInit( vlc_object_t *, aout_fifo_t *, uint32_t );
129 #define aout_FifoInit(o, f, r) aout_FifoInit(VLC_OBJECT(o), f, r)
130 mtime_t aout_FifoNextStart( const aout_fifo_t * ) VLC_USED;
131 void aout_FifoPush( aout_fifo_t *, aout_buffer_t * );
132 void aout_FifoSet( aout_fifo_t *, mtime_t );
133 void aout_FifoMoveDates( aout_fifo_t *, mtime_t );
134 void aout_FifoDestroy( aout_fifo_t * p_fifo );
135 void aout_FormatsPrint( aout_instance_t * p_aout, const char * psz_text, const audio_sample_format_t * p_format1, const audio_sample_format_t * p_format2 );
136 bool aout_ChangeFilterString( vlc_object_t *, aout_instance_t *, const char *psz_variable, const char *psz_name, bool b_add );
137
138 /* From dec.c */
139 aout_input_t *aout_DecNew( aout_instance_t *, audio_sample_format_t *,
140                    const audio_replay_gain_t *, const aout_request_vout_t * );
141 void aout_DecDelete ( aout_instance_t *, aout_input_t * );
142 aout_buffer_t * aout_DecNewBuffer( aout_input_t *, size_t );
143 void aout_DecDeleteBuffer( aout_instance_t *, aout_input_t *, aout_buffer_t * );
144 int aout_DecPlay( aout_instance_t *, aout_input_t *, aout_buffer_t *, int i_input_rate );
145 int aout_DecGetResetLost( aout_instance_t *, aout_input_t * );
146 void aout_DecChangePause( aout_instance_t *, aout_input_t *, bool b_paused, mtime_t i_date );
147 void aout_DecFlush( aout_instance_t *, aout_input_t * );
148 bool aout_DecIsEmpty( aout_instance_t * p_aout, aout_input_t * p_input );
149
150 /* Audio output locking */
151
152 #if !defined (NDEBUG) \
153  && defined __linux__ && (defined (__i386__) || defined (__x86_64__))
154 # define AOUT_DEBUG 1
155 #endif
156
157 #ifdef AOUT_DEBUG
158 enum
159 {
160     OUTPUT_LOCK=1,
161     VOLUME_LOCK=2,
162 };
163
164 void aout_lock_check (unsigned);
165 void aout_unlock_check (unsigned);
166
167 #else
168 # define aout_lock_check( i )   (void)0
169 # define aout_unlock_check( i ) (void)0
170 #endif
171
172 static inline void aout_lock( aout_instance_t *p_aout )
173 {
174     aout_lock_check( OUTPUT_LOCK );
175     vlc_mutex_lock( &p_aout->lock );
176 }
177
178 static inline void aout_unlock( aout_instance_t *p_aout )
179 {
180     aout_unlock_check( OUTPUT_LOCK );
181     vlc_mutex_unlock( &p_aout->lock );
182 }
183
184 static inline void aout_lock_volume( aout_instance_t *p_aout )
185 {
186     aout_lock_check( VOLUME_LOCK );
187     vlc_mutex_lock( &p_aout->volume_lock );
188 }
189
190 static inline void aout_unlock_volume( aout_instance_t *p_aout )
191 {
192     aout_unlock_check( VOLUME_LOCK );
193     vlc_mutex_unlock( &p_aout->volume_lock );
194 }
195
196 /* Helpers */
197
198 /**
199  * This function will safely mark aout input to be restarted as soon as
200  * possible to take configuration changes into account */
201 static inline void AoutInputsMarkToRestart( aout_instance_t *p_aout )
202 {
203     aout_lock( p_aout );
204     if( p_aout->p_input != NULL )
205         p_aout->p_input->b_restart = true;
206     aout_unlock( p_aout );
207 }
208
209 #endif /* !LIBVLC_AOUT_INTERNAL_H */