audio_output.h 8.56 KB
Newer Older
1
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
2
 * audio_output.h : audio output thread interface
3
 *****************************************************************************
4
 * Copyright (C) 1999, 2000 VideoLAN
gbazin's avatar
   
gbazin committed
5
 * $Id: audio_output.h,v 1.42 2002/02/24 20:51:09 gbazin Exp $
6
 *
Sam Hocevar's avatar
   
Sam Hocevar committed
7
 * Authors: Michel Kaempf <maxx@via.ecp.fr>
8
 *          Cyril Deguet <asmax@via.ecp.fr>
9
10
11
12
13
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
14
 * 
15
16
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17
18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
19
 *
20
21
22
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23
24
 *****************************************************************************/

Sam Hocevar's avatar
   
Sam Hocevar committed
25
26
27
28
29
/*****************************************************************************
 * aout_bank_t, p_aout_bank (global variable)
 *****************************************************************************
 * This global variable is accessed by any function using the audio output.
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
30
typedef struct aout_bank_s
Sam Hocevar's avatar
   
Sam Hocevar committed
31
32
33
34
35
36
37
38
39
{
    /* Array to all the audio outputs */
    struct aout_thread_s *pp_aout[ AOUT_MAX_THREADS ];

    int                    i_count;
    vlc_mutex_t            lock;  /* Global lock */

} aout_bank_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
40
#ifndef PLUGIN
Sam Hocevar's avatar
   
Sam Hocevar committed
41
extern aout_bank_t *p_aout_bank;
Sam Hocevar's avatar
   
Sam Hocevar committed
42
43
44
#else
#   define p_aout_bank (p_symbols->p_aout_bank)
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
45

46
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
47
 * aout_increment_t
48
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
49
50
51
 * This structure is used to keep the progression of an index up-to-date, in
 * order to avoid rounding problems and heavy computations, as the function
 * that handles this structure only uses additions.
52
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
53
typedef struct aout_increment_s
Michel Kaempf's avatar
Michel Kaempf committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
    /* The remainder is used to keep track of the fractional part of the
     * index. */
    long                l_remainder;

    /*
     * The increment structure is initialized with the result of an euclidean
     * division :
     *
     *  l_euclidean_numerator                           l_euclidean_remainder
     * ----------------------- = l_euclidean_integer + -----------------------
     * l_euclidean_denominator                         l_euclidean_denominator
     *
     */
    long                l_euclidean_integer;
    long                l_euclidean_remainder;
    long                l_euclidean_denominator;

} aout_increment_t;

74
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
75
 * aout_fifo_t
76
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
77
typedef struct aout_fifo_s
Michel Kaempf's avatar
Michel Kaempf committed
78
79
80
81
{
    /* See the fifo types below */
    int                 i_type;
    boolean_t           b_die;
Sam Hocevar's avatar
   
Sam Hocevar committed
82
    int                 i_fifo;      /* Just to keep track of the fifo index */
Michel Kaempf's avatar
Michel Kaempf committed
83

84
    int                 i_channels;
85
    boolean_t           b_stereo;
Michel Kaempf's avatar
Michel Kaempf committed
86
87
    long                l_rate;

88
89
    vlc_mutex_t         data_lock;
    vlc_cond_t          data_wait;
Michel Kaempf's avatar
Michel Kaempf committed
90

Michel Kaempf's avatar
Michel Kaempf committed
91
    long                l_frame_size;
Michel Kaempf's avatar
Michel Kaempf committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
    void *              buffer;
    mtime_t *           date;
    /* The start frame is the first frame in the buffer that contains decoded
     * audio data. It it also the first frame in the current timestamped frame
     * area, ie the first dated frame in the decoded part of the buffer. :-p */
    long                l_start_frame;
    boolean_t           b_start_frame;
    /* The next frame is the end frame of the current timestamped frame area,
     * ie the first dated frame after the start frame. */
    long                l_next_frame;
    boolean_t           b_next_frame;
    /* The end frame is the first frame, after the start frame, that doesn't
     * contain decoded audio data. That's why the end frame is the first frame
     * where the audio decoder can store its decoded audio frames. */
    long                l_end_frame;

    long                l_unit;
    aout_increment_t    unit_increment;
    /* The following variable is used to store the number of remaining audio
     * units in the current timestamped frame area. */
    long                l_units;

} aout_fifo_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
116
117
118
119
120
121
#define AOUT_FIFO_ISEMPTY( fifo ) \
  ( (fifo).l_end_frame == (fifo).l_start_frame )

#define AOUT_FIFO_ISFULL( fifo ) \
  ( ((((fifo).l_end_frame + 1) - (fifo).l_start_frame) & AOUT_FIFO_SIZE) == 0 )

Michel Kaempf's avatar
Michel Kaempf committed
122
#define AOUT_EMPTY_FIFO         0
Cyril Deguet's avatar
   
Cyril Deguet committed
123
124
125
#define AOUT_ADEC_MONO_FIFO     1
#define AOUT_ADEC_STEREO_FIFO   2
#define AOUT_ADEC_SPDIF_FIFO    3
Michel Kaempf's avatar
Michel Kaempf committed
126

127
/*****************************************************************************
128
 * aout_thread_t : audio output thread descriptor
129
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
130
131
typedef struct aout_thread_s
{
132
    vlc_thread_t        thread_id;
Michel Kaempf's avatar
Michel Kaempf committed
133
    boolean_t           b_die;
Sam Hocevar's avatar
Sam Hocevar committed
134
    boolean_t           b_active;
Michel Kaempf's avatar
Michel Kaempf committed
135

136
    vlc_mutex_t         fifos_lock;
Michel Kaempf's avatar
Michel Kaempf committed
137
138
    aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];

139
140
    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
Sam Hocevar's avatar
   
Sam Hocevar committed
141
142
143
144
145
    int              ( *pf_open )       ( p_aout_thread_t );
    int              ( *pf_setformat )  ( p_aout_thread_t );
    long             ( *pf_getbufinfo ) ( p_aout_thread_t, long );
    void             ( *pf_play )       ( p_aout_thread_t, byte_t *, int );
    void             ( *pf_close )      ( p_aout_thread_t );
146

Michel Kaempf's avatar
Michel Kaempf committed
147
148
149
150
151
152
153
154
    void *              buffer;
    /* The s32 buffer is used to mix all the audio fifos together before
     * converting them and storing them in the audio output buffer */
    s32 *               s32_buffer;

    /* The size of the audio output buffer is kept in audio units, as this is
     * the only unit that is common with every audio decoder and audio fifo */
    long                l_units;
Michel Kaempf's avatar
Michel Kaempf committed
155
    long                l_msleep;
Michel Kaempf's avatar
Michel Kaempf committed
156
157

    /* date is the moment where the first audio unit of the output buffer
Michel Kaempf's avatar
Michel Kaempf committed
158
159
     * will be played */
    mtime_t             date;
Michel Kaempf's avatar
Michel Kaempf committed
160

Sam Hocevar's avatar
   
Sam Hocevar committed
161
    /* The current volume */
Sam Hocevar's avatar
   
Sam Hocevar committed
162
163
    int                 i_volume;
    int                 i_savedvolume;
164
165
166
167
    /* Format of the audio output samples */
    int                 i_format;
    /* Number of channels */
    int                 i_channels;
168
169
    /* Mono or Stereo sound */
    boolean_t           b_stereo;
170
171
172
    /* Rate and gain of the audio output sound (in Hz) */
    long                l_rate;
    long                l_gain;
173
    int                 i_latency;
174
175
176
177
178

    /* there might be some useful private structure, such as audio_buf_info
     * for the OSS output */
    p_aout_sys_t        p_sys;

Michel Kaempf's avatar
Michel Kaempf committed
179
180
} aout_thread_t;

181
182
183
184
185
186
187
188
/* Those are from <linux/soundcard.h> but are needed because of formats
 * on other platforms */
#define AOUT_FMT_U8          0x00000008
#define AOUT_FMT_S16_LE      0x00000010           /* Little endian signed 16 */
#define AOUT_FMT_S16_BE      0x00000020              /* Big endian signed 16 */
#define AOUT_FMT_S8          0x00000040
#define AOUT_FMT_U16_LE      0x00000080                 /* Little endian U16 */
#define AOUT_FMT_U16_BE      0x00000100                    /* Big endian U16 */
189
190
#define AOUT_FMT_AC3         0x00000400                 /* Dolby Digital AC3 */

Sam Hocevar's avatar
   
Sam Hocevar committed
191
#ifdef WORDS_BIGENDIAN
192
#define AOUT_FMT_S16_NE      AOUT_FMT_S16_BE
Sam Hocevar's avatar
   
Sam Hocevar committed
193
194
#else
#define AOUT_FMT_S16_NE      AOUT_FMT_S16_LE
195
196
#endif

197
198
199
/* Number of samples in an AC3 frame */
#define AC3_FRAME_SIZE      1536

200
/* Size of a frame for spdif output */
201
#define SPDIF_FRAME_SIZE    6144
202

203
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
204
 * Prototypes
205
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
206
#ifndef PLUGIN
Sam Hocevar's avatar
   
Sam Hocevar committed
207
208
209
void            aout_InitBank           ( void );
void            aout_EndBank            ( void );

210
211
aout_thread_t * aout_CreateThread       ( int *pi_status, int i_channels, 
    long l_rate );
Sam Hocevar's avatar
   
Sam Hocevar committed
212
void            aout_DestroyThread      ( aout_thread_t *, int * );
Vincent Seguin's avatar
Vincent Seguin committed
213

Sam Hocevar's avatar
   
Sam Hocevar committed
214
aout_fifo_t *   aout_CreateFifo         ( int, int, long, long, long, void * );
Michel Kaempf's avatar
Michel Kaempf committed
215
void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );
Sam Hocevar's avatar
   
Sam Hocevar committed
216
void            aout_FreeFifo           ( aout_fifo_t *p_fifo );
Sam Hocevar's avatar
   
Sam Hocevar committed
217
218
219
220
#else
#   define aout_CreateFifo p_symbols->aout_CreateFifo
#   define aout_DestroyFifo p_symbols->aout_DestroyFifo
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
221