audio_output.h 8.28 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
Sam Hocevar's avatar
   
Sam Hocevar committed
5
 * $Id: audio_output.h,v 1.34 2001/05/06 04:32:02 sam Exp $
6
 *
Sam Hocevar's avatar
   
Sam Hocevar committed
7
 * Authors: Michel Kaempf <maxx@via.ecp.fr>
8
9
10
11
12
 *
 * 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.
13
 * 
14
15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
18
 *
19
20
21
 * 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.
22
23
 *****************************************************************************/

Sam Hocevar's avatar
   
Sam Hocevar committed
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/*****************************************************************************
 * aout_bank_t, p_aout_bank (global variable)
 *****************************************************************************
 * This global variable is accessed by any function using the audio output.
 *****************************************************************************/
typedef struct
{
    /* 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;

extern aout_bank_t *p_aout_bank;

41
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
42
 * aout_increment_t
43
 *****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
44
45
46
 * 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.
47
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
48
typedef struct aout_increment_s
Michel Kaempf's avatar
Michel Kaempf committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
    /* 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;

69
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
70
 * aout_fifo_t
71
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
72
typedef struct aout_fifo_s
Michel Kaempf's avatar
Michel Kaempf committed
73
74
75
76
{
    /* See the fifo types below */
    int                 i_type;
    boolean_t           b_die;
Sam Hocevar's avatar
   
Sam Hocevar committed
77
    int                 i_fifo;      /* Just to keep track of the fifo index */
Michel Kaempf's avatar
Michel Kaempf committed
78

79
    int                 i_channels;
80
    boolean_t           b_stereo;
Michel Kaempf's avatar
Michel Kaempf committed
81
82
    long                l_rate;

83
84
    vlc_mutex_t         data_lock;
    vlc_cond_t          data_wait;
Michel Kaempf's avatar
Michel Kaempf committed
85

Michel Kaempf's avatar
Michel Kaempf committed
86
    long                l_frame_size;
Michel Kaempf's avatar
Michel Kaempf committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
    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
111
112
113
114
115
116
#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
117
118
119
120
121
#define AOUT_EMPTY_FIFO         0
#define AOUT_INTF_MONO_FIFO     1
#define AOUT_INTF_STEREO_FIFO   2
#define AOUT_ADEC_MONO_FIFO     3
#define AOUT_ADEC_STEREO_FIFO   4
Sam Hocevar's avatar
   
Sam Hocevar committed
122
#define AOUT_ADEC_SPDIF_FIFO    5
Michel Kaempf's avatar
Michel Kaempf committed
123

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

133
    vlc_mutex_t         fifos_lock;
Michel Kaempf's avatar
Michel Kaempf committed
134
135
    aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];

136
137
    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
Sam Hocevar's avatar
   
Sam Hocevar committed
138
139
140
141
142
    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 );
143

Michel Kaempf's avatar
Michel Kaempf committed
144
145
146
147
148
149
150
151
    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
152
    long                l_msleep;
Michel Kaempf's avatar
Michel Kaempf committed
153
154

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

158
159
160
161
    /* Path to the audio output device (default is set to "/dev/dsp") */
    char *              psz_device;
    int                 i_fd;

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

    /* 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 */

191

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

198
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
199
 * Prototypes
200
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
201
202
203
void            aout_InitBank           ( void );
void            aout_EndBank            ( void );

Vincent Seguin's avatar
Vincent Seguin committed
204
aout_thread_t * aout_CreateThread       ( int *pi_status );
Sam Hocevar's avatar
   
Sam Hocevar committed
205
void            aout_DestroyThread      ( aout_thread_t *, int * );
Vincent Seguin's avatar
Vincent Seguin committed
206

Sam Hocevar's avatar
   
Sam Hocevar committed
207
aout_fifo_t *   aout_CreateFifo         ( int, int, long, long, long, void * );
Michel Kaempf's avatar
Michel Kaempf committed
208
void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );
Sam Hocevar's avatar
   
Sam Hocevar committed
209
210
void            aout_FreeFifo           ( aout_fifo_t *p_fifo );