- better communication between audio decoder and output: aout plugins
[vlc.git] / include / audio_output.h
1 /*****************************************************************************
2  * audio_output.h : audio output thread interface
3  *****************************************************************************
4  * Copyright (C) 1999, 2000 VideoLAN
5  * $Id: audio_output.h,v 1.40 2002/01/09 00:33:37 asmax Exp $
6  *
7  * Authors: Michel Kaempf <maxx@via.ecp.fr>
8  *          Cyril Deguet <asmax@via.ecp.fr>
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * aout_bank_t, p_aout_bank (global variable)
27  *****************************************************************************
28  * This global variable is accessed by any function using the audio output.
29  *****************************************************************************/
30 typedef struct aout_bank_s
31 {
32     /* Array to all the audio outputs */
33     struct aout_thread_s *pp_aout[ AOUT_MAX_THREADS ];
34
35     int                    i_count;
36     vlc_mutex_t            lock;  /* Global lock */
37
38 } aout_bank_t;
39
40 #ifndef PLUGIN
41 extern aout_bank_t *p_aout_bank;
42 #else
43 #   define p_aout_bank (p_symbols->p_aout_bank)
44 #endif
45
46 /*****************************************************************************
47  * aout_increment_t
48  *****************************************************************************
49  * This structure is used to keep the progression of an index up-to-date, in
50  * order to avoid rounding problems and heavy computations, as the function
51  * that handles this structure only uses additions.
52  *****************************************************************************/
53 typedef struct aout_increment_s
54 {
55     /* The remainder is used to keep track of the fractional part of the
56      * index. */
57     long                l_remainder;
58
59     /*
60      * The increment structure is initialized with the result of an euclidean
61      * division :
62      *
63      *  l_euclidean_numerator                           l_euclidean_remainder
64      * ----------------------- = l_euclidean_integer + -----------------------
65      * l_euclidean_denominator                         l_euclidean_denominator
66      *
67      */
68     long                l_euclidean_integer;
69     long                l_euclidean_remainder;
70     long                l_euclidean_denominator;
71
72 } aout_increment_t;
73
74 /*****************************************************************************
75  * aout_fifo_t
76  *****************************************************************************/
77 typedef struct aout_fifo_s
78 {
79     /* See the fifo types below */
80     int                 i_type;
81     boolean_t           b_die;
82     int                 i_fifo;      /* Just to keep track of the fifo index */
83
84     int                 i_channels;
85     boolean_t           b_stereo;
86     long                l_rate;
87
88     vlc_mutex_t         data_lock;
89     vlc_cond_t          data_wait;
90
91     long                l_frame_size;
92     void *              buffer;
93     mtime_t *           date;
94     /* The start frame is the first frame in the buffer that contains decoded
95      * audio data. It it also the first frame in the current timestamped frame
96      * area, ie the first dated frame in the decoded part of the buffer. :-p */
97     long                l_start_frame;
98     boolean_t           b_start_frame;
99     /* The next frame is the end frame of the current timestamped frame area,
100      * ie the first dated frame after the start frame. */
101     long                l_next_frame;
102     boolean_t           b_next_frame;
103     /* The end frame is the first frame, after the start frame, that doesn't
104      * contain decoded audio data. That's why the end frame is the first frame
105      * where the audio decoder can store its decoded audio frames. */
106     long                l_end_frame;
107
108     long                l_unit;
109     aout_increment_t    unit_increment;
110     /* The following variable is used to store the number of remaining audio
111      * units in the current timestamped frame area. */
112     long                l_units;
113
114 } aout_fifo_t;
115
116 #define AOUT_FIFO_ISEMPTY( fifo ) \
117   ( (fifo).l_end_frame == (fifo).l_start_frame )
118
119 #define AOUT_FIFO_ISFULL( fifo ) \
120   ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )
121
122 #define AOUT_EMPTY_FIFO         0
123 #define AOUT_INTF_MONO_FIFO     1
124 #define AOUT_INTF_STEREO_FIFO   2
125 #define AOUT_ADEC_MONO_FIFO     3
126 #define AOUT_ADEC_STEREO_FIFO   4
127 #define AOUT_ADEC_SPDIF_FIFO    5
128
129 /*****************************************************************************
130  * aout_thread_t : audio output thread descriptor
131  *****************************************************************************/
132 typedef struct aout_thread_s
133 {
134     vlc_thread_t        thread_id;
135     boolean_t           b_die;
136     boolean_t           b_active;
137
138     vlc_mutex_t         fifos_lock;
139     aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];
140
141     /* Plugin used and shortcuts to access its capabilities */
142     struct module_s *   p_module;
143     int              ( *pf_open )       ( p_aout_thread_t );
144     int              ( *pf_setformat )  ( p_aout_thread_t );
145     long             ( *pf_getbufinfo ) ( p_aout_thread_t, long );
146     void             ( *pf_play )       ( p_aout_thread_t, byte_t *, int );
147     void             ( *pf_close )      ( p_aout_thread_t );
148
149     void *              buffer;
150     /* The s32 buffer is used to mix all the audio fifos together before
151      * converting them and storing them in the audio output buffer */
152     s32 *               s32_buffer;
153
154     /* The size of the audio output buffer is kept in audio units, as this is
155      * the only unit that is common with every audio decoder and audio fifo */
156     long                l_units;
157     long                l_msleep;
158
159     /* date is the moment where the first audio unit of the output buffer
160      * will be played */
161     mtime_t             date;
162
163     /* Path to the audio output device (default is set to "/dev/dsp") */
164     char *              psz_device;
165     int                 i_fd;
166
167     /* The current volume */
168     int                 i_volume;
169     int                 i_savedvolume;
170     /* Format of the audio output samples */
171     int                 i_format;
172     /* Number of channels */
173     int                 i_channels;
174     /* Mono or Stereo sound */
175     boolean_t           b_stereo;
176     /* Rate and gain of the audio output sound (in Hz) */
177     long                l_rate;
178     long                l_gain;
179     int                 i_latency;
180
181     /* there might be some useful private structure, such as audio_buf_info
182      * for the OSS output */
183     p_aout_sys_t        p_sys;
184
185 } aout_thread_t;
186
187 /* Those are from <linux/soundcard.h> but are needed because of formats
188  * on other platforms */
189 #define AOUT_FMT_U8          0x00000008
190 #define AOUT_FMT_S16_LE      0x00000010           /* Little endian signed 16 */
191 #define AOUT_FMT_S16_BE      0x00000020              /* Big endian signed 16 */
192 #define AOUT_FMT_S8          0x00000040
193 #define AOUT_FMT_U16_LE      0x00000080                 /* Little endian U16 */
194 #define AOUT_FMT_U16_BE      0x00000100                    /* Big endian U16 */
195 #define AOUT_FMT_AC3         0x00000400                 /* Dolby Digital AC3 */
196
197 #ifdef WORDS_BIGENDIAN
198 #define AOUT_FMT_S16_NE      AOUT_FMT_S16_BE
199 #else
200 #define AOUT_FMT_S16_NE      AOUT_FMT_S16_LE
201 #endif
202
203 /* Number of samples in an AC3 frame */
204 #define AC3_FRAME_SIZE      1536
205
206 /* Size of a frame for spdif output */
207 #define SPDIF_FRAME_SIZE    6144
208
209 /*****************************************************************************
210  * Prototypes
211  *****************************************************************************/
212 #ifndef PLUGIN
213 void            aout_InitBank           ( void );
214 void            aout_EndBank            ( void );
215
216 aout_thread_t * aout_CreateThread       ( int *pi_status, int i_channels, 
217     long l_rate );
218 void            aout_DestroyThread      ( aout_thread_t *, int * );
219
220 aout_fifo_t *   aout_CreateFifo         ( int, int, long, long, long, void * );
221 void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );
222 void            aout_FreeFifo           ( aout_fifo_t *p_fifo );
223 #else
224 #   define aout_CreateFifo p_symbols->aout_CreateFifo
225 #   define aout_DestroyFifo p_symbols->aout_DestroyFifo
226 #endif
227