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