audio_output.h 8.39 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.43 2002/02/24 22:06:50 sam 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
{
    /* The remainder is used to keep track of the fractional part of the
     * index. */
Sam Hocevar's avatar
   
Sam Hocevar committed
57
    int i_r;
Michel Kaempf's avatar
Michel Kaempf committed
58
59
60
61
62

    /*
     * The increment structure is initialized with the result of an euclidean
     * division :
     *
Sam Hocevar's avatar
   
Sam Hocevar committed
63
64
65
     *  i_x           i_b
     * ----- = i_a + -----
     *  i_y           i_c
Michel Kaempf's avatar
Michel Kaempf committed
66
67
     *
     */
Sam Hocevar's avatar
   
Sam Hocevar committed
68
    int i_a, i_b, i_c;
Michel Kaempf's avatar
Michel Kaempf committed
69
70
71

} aout_increment_t;

72
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
73
 * aout_fifo_t
74
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
75
typedef struct aout_fifo_s
Michel Kaempf's avatar
Michel Kaempf committed
76
{
Sam Hocevar's avatar
   
Sam Hocevar committed
77
78
79
80
81
82
    /* See the fifo formats below */
    int                 i_format;
    int                 i_channels;
    int                 i_rate;
    int                 i_frame_size;

Michel Kaempf's avatar
Michel Kaempf committed
83
    boolean_t           b_die;
Sam Hocevar's avatar
   
Sam Hocevar committed
84
    int                 i_fifo;      /* Just to keep track of the fifo index */
Michel Kaempf's avatar
Michel Kaempf committed
85

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

    void *              buffer;
    mtime_t *           date;
Sam Hocevar's avatar
   
Sam Hocevar committed
91

Michel Kaempf's avatar
Michel Kaempf committed
92
93
94
    /* 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 */
Sam Hocevar's avatar
   
Sam Hocevar committed
95
    int                 i_start_frame;
Michel Kaempf's avatar
Michel Kaempf committed
96
97
98
    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. */
Sam Hocevar's avatar
   
Sam Hocevar committed
99
    int                 i_next_frame;
Michel Kaempf's avatar
Michel Kaempf committed
100
101
102
103
    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. */
Sam Hocevar's avatar
   
Sam Hocevar committed
104
    int                 i_end_frame;
Michel Kaempf's avatar
Michel Kaempf committed
105

Sam Hocevar's avatar
   
Sam Hocevar committed
106
107
108
109
110
    /* Current index in p_aout->buffer */
    int                 i_unit;
    /* Max index in p_aout->buffer */
    int                 i_unit_limit;
    /* Structure used to calculate i_unit with a Bresenham algorithm */
Michel Kaempf's avatar
Michel Kaempf committed
111
    aout_increment_t    unit_increment;
Sam Hocevar's avatar
   
Sam Hocevar committed
112

Michel Kaempf's avatar
Michel Kaempf committed
113
114
    /* The following variable is used to store the number of remaining audio
     * units in the current timestamped frame area. */
Sam Hocevar's avatar
   
Sam Hocevar committed
115
    int                 i_units;
Michel Kaempf's avatar
Michel Kaempf committed
116
117
118

} aout_fifo_t;

Sam Hocevar's avatar
   
Sam Hocevar committed
119
#define AOUT_FIFO_ISEMPTY( fifo ) \
Sam Hocevar's avatar
   
Sam Hocevar committed
120
  ( (fifo).i_end_frame == (fifo).i_start_frame )
Sam Hocevar's avatar
   
Sam Hocevar committed
121
122

#define AOUT_FIFO_ISFULL( fifo ) \
Sam Hocevar's avatar
   
Sam Hocevar committed
123
124
125
126
  ( ((((fifo).i_end_frame + 1) - (fifo).i_start_frame) & AOUT_FIFO_SIZE) == 0 )

#define AOUT_FIFO_INC( i_index ) \
  ( ((i_index) + 1) & AOUT_FIFO_SIZE )
Sam Hocevar's avatar
   
Sam Hocevar committed
127

Sam Hocevar's avatar
   
Sam Hocevar committed
128
129
130
131
/* List of known fifo formats */
#define AOUT_FIFO_NONE    0
#define AOUT_FIFO_PCM     1
#define AOUT_FIFO_SPDIF   2
Michel Kaempf's avatar
Michel Kaempf committed
132

133
/*****************************************************************************
134
 * aout_thread_t : audio output thread descriptor
135
 *****************************************************************************/
Michel Kaempf's avatar
Michel Kaempf committed
136
137
typedef struct aout_thread_s
{
138
    vlc_thread_t        thread_id;
Michel Kaempf's avatar
Michel Kaempf committed
139
    boolean_t           b_die;
Sam Hocevar's avatar
Sam Hocevar committed
140
    boolean_t           b_active;
Michel Kaempf's avatar
Michel Kaempf committed
141

142
    vlc_mutex_t         fifos_lock;
Michel Kaempf's avatar
Michel Kaempf committed
143
144
    aout_fifo_t         fifo[ AOUT_MAX_FIFOS ];

145
146
    /* Plugin used and shortcuts to access its capabilities */
    struct module_s *   p_module;
Sam Hocevar's avatar
   
Sam Hocevar committed
147
148
    int              ( *pf_open )       ( p_aout_thread_t );
    int              ( *pf_setformat )  ( p_aout_thread_t );
Sam Hocevar's avatar
   
Sam Hocevar committed
149
    int              ( *pf_getbufinfo ) ( p_aout_thread_t, int );
Sam Hocevar's avatar
   
Sam Hocevar committed
150
151
    void             ( *pf_play )       ( p_aout_thread_t, byte_t *, int );
    void             ( *pf_close )      ( p_aout_thread_t );
152

Michel Kaempf's avatar
Michel Kaempf committed
153
154
155
156
157
158
159
    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 */
Sam Hocevar's avatar
   
Sam Hocevar committed
160
161
    int                 i_units;
    int                 i_msleep;
Michel Kaempf's avatar
Michel Kaempf committed
162
163

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

Sam Hocevar's avatar
   
Sam Hocevar committed
167
    /* The current volume */
Sam Hocevar's avatar
   
Sam Hocevar committed
168
169
    int                 i_volume;
    int                 i_savedvolume;
Sam Hocevar's avatar
   
Sam Hocevar committed
170
171
172

    /* Format of the audio output samples, number of channels, and
     * rate and gain (in Hz) of the audio output sound */
173
174
    int                 i_format;
    int                 i_channels;
Sam Hocevar's avatar
   
Sam Hocevar committed
175
176
177
    int                 i_rate;

    /* Latency of the audio output plugin, in bytes */
178
    int                 i_latency;
179
180
181
182
183

    /* 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
184
185
} aout_thread_t;

186
187
188
189
190
191
192
193
/* 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 */
194
195
#define AOUT_FMT_AC3         0x00000400                 /* Dolby Digital AC3 */

Sam Hocevar's avatar
   
Sam Hocevar committed
196
#ifdef WORDS_BIGENDIAN
197
#define AOUT_FMT_S16_NE      AOUT_FMT_S16_BE
Sam Hocevar's avatar
   
Sam Hocevar committed
198
199
#else
#define AOUT_FMT_S16_NE      AOUT_FMT_S16_LE
200
201
#endif

202
203
204
/* Number of samples in an AC3 frame */
#define AC3_FRAME_SIZE      1536

205
/* Size of a frame for spdif output */
206
#define SPDIF_FRAME_SIZE    6144
207

208
/*****************************************************************************
Michel Kaempf's avatar
Michel Kaempf committed
209
 * Prototypes
210
 *****************************************************************************/
Sam Hocevar's avatar
   
Sam Hocevar committed
211
#ifndef PLUGIN
Sam Hocevar's avatar
   
Sam Hocevar committed
212
213
214
void            aout_InitBank           ( void );
void            aout_EndBank            ( void );

Sam Hocevar's avatar
   
Sam Hocevar committed
215
aout_thread_t * aout_CreateThread       ( int *, int, int );
Sam Hocevar's avatar
   
Sam Hocevar committed
216
void            aout_DestroyThread      ( aout_thread_t *, int * );
Vincent Seguin's avatar
Vincent Seguin committed
217

Sam Hocevar's avatar
   
Sam Hocevar committed
218
aout_fifo_t *   aout_CreateFifo         ( int, int, int, int, void * );
Michel Kaempf's avatar
Michel Kaempf committed
219
void            aout_DestroyFifo        ( aout_fifo_t *p_fifo );
Sam Hocevar's avatar
   
Sam Hocevar committed
220
void            aout_FreeFifo           ( aout_fifo_t *p_fifo );
Sam Hocevar's avatar
   
Sam Hocevar committed
221
222
223
224
#else
#   define aout_CreateFifo p_symbols->aout_CreateFifo
#   define aout_DestroyFifo p_symbols->aout_DestroyFifo
#endif
Sam Hocevar's avatar
   
Sam Hocevar committed
225