slouken@0
|
1 |
/*
|
slouken@5535
|
2 |
Simple DirectMedia Layer
|
slouken@5535
|
3 |
Copyright (C) 1997-2011 Sam Lantinga <slouken@libsdl.org>
|
slouken@0
|
4 |
|
slouken@5535
|
5 |
This software is provided 'as-is', without any express or implied
|
slouken@5535
|
6 |
warranty. In no event will the authors be held liable for any damages
|
slouken@5535
|
7 |
arising from the use of this software.
|
slouken@0
|
8 |
|
slouken@5535
|
9 |
Permission is granted to anyone to use this software for any purpose,
|
slouken@5535
|
10 |
including commercial applications, and to alter it and redistribute it
|
slouken@5535
|
11 |
freely, subject to the following restrictions:
|
slouken@0
|
12 |
|
slouken@5535
|
13 |
1. The origin of this software must not be misrepresented; you must not
|
slouken@5535
|
14 |
claim that you wrote the original software. If you use this software
|
slouken@5535
|
15 |
in a product, an acknowledgment in the product documentation would be
|
slouken@5535
|
16 |
appreciated but is not required.
|
slouken@5535
|
17 |
2. Altered source versions must be plainly marked as such, and must not be
|
slouken@5535
|
18 |
misrepresented as being the original software.
|
slouken@5535
|
19 |
3. This notice may not be removed or altered from any source distribution.
|
slouken@0
|
20 |
*/
|
slouken@0
|
21 |
|
slouken@1895
|
22 |
/**
|
slouken@3407
|
23 |
* \file SDL_audio.h
|
slouken@3407
|
24 |
*
|
slouken@3407
|
25 |
* Access to the raw audio mixing buffer for the SDL library.
|
slouken@1895
|
26 |
*/
|
slouken@0
|
27 |
|
slouken@0
|
28 |
#ifndef _SDL_audio_h
|
slouken@0
|
29 |
#define _SDL_audio_h
|
slouken@0
|
30 |
|
slouken@1353
|
31 |
#include "SDL_stdinc.h"
|
slouken@0
|
32 |
#include "SDL_error.h"
|
slouken@1358
|
33 |
#include "SDL_endian.h"
|
slouken@1358
|
34 |
#include "SDL_mutex.h"
|
slouken@1358
|
35 |
#include "SDL_thread.h"
|
slouken@0
|
36 |
#include "SDL_rwops.h"
|
slouken@0
|
37 |
|
slouken@0
|
38 |
#include "begin_code.h"
|
slouken@0
|
39 |
/* Set up for C function definitions, even when using C++ */
|
slouken@0
|
40 |
#ifdef __cplusplus
|
slouken@1895
|
41 |
/* *INDENT-OFF* */
|
slouken@0
|
42 |
extern "C" {
|
slouken@1895
|
43 |
/* *INDENT-ON* */
|
slouken@0
|
44 |
#endif
|
slouken@0
|
45 |
|
slouken@3407
|
46 |
/**
|
slouken@3407
|
47 |
* \brief Audio format flags.
|
slouken@3407
|
48 |
*
|
slouken@3407
|
49 |
* These are what the 16 bits in SDL_AudioFormat currently mean...
|
slouken@3407
|
50 |
* (Unspecified bits are always zero).
|
slouken@3407
|
51 |
*
|
slouken@3407
|
52 |
* \verbatim
|
slouken@3407
|
53 |
++-----------------------sample is signed if set
|
slouken@3407
|
54 |
||
|
slouken@3407
|
55 |
|| ++-----------sample is bigendian if set
|
slouken@3407
|
56 |
|| ||
|
slouken@3407
|
57 |
|| || ++---sample is float if set
|
slouken@3407
|
58 |
|| || ||
|
slouken@3407
|
59 |
|| || || +---sample bit size---+
|
slouken@3407
|
60 |
|| || || | |
|
slouken@3407
|
61 |
15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
|
slouken@3407
|
62 |
\endverbatim
|
slouken@3407
|
63 |
*
|
slouken@3407
|
64 |
* There are macros in SDL 1.3 and later to query these bits.
|
slouken@3407
|
65 |
*/
|
icculus@1964
|
66 |
typedef Uint16 SDL_AudioFormat;
|
icculus@1964
|
67 |
|
slouken@3407
|
68 |
/**
|
slouken@3407
|
69 |
* \name Audio flags
|
slouken@3407
|
70 |
*/
|
slouken@3407
|
71 |
/*@{*/
|
icculus@1964
|
72 |
|
icculus@1964
|
73 |
#define SDL_AUDIO_MASK_BITSIZE (0xFF)
|
icculus@1964
|
74 |
#define SDL_AUDIO_MASK_DATATYPE (1<<8)
|
icculus@1964
|
75 |
#define SDL_AUDIO_MASK_ENDIAN (1<<12)
|
icculus@1964
|
76 |
#define SDL_AUDIO_MASK_SIGNED (1<<15)
|
icculus@1964
|
77 |
#define SDL_AUDIO_BITSIZE(x) (x & SDL_AUDIO_MASK_BITSIZE)
|
icculus@1964
|
78 |
#define SDL_AUDIO_ISFLOAT(x) (x & SDL_AUDIO_MASK_DATATYPE)
|
icculus@1964
|
79 |
#define SDL_AUDIO_ISBIGENDIAN(x) (x & SDL_AUDIO_MASK_ENDIAN)
|
icculus@1964
|
80 |
#define SDL_AUDIO_ISSIGNED(x) (x & SDL_AUDIO_MASK_SIGNED)
|
icculus@1964
|
81 |
#define SDL_AUDIO_ISINT(x) (!SDL_AUDIO_ISFLOAT(x))
|
icculus@1964
|
82 |
#define SDL_AUDIO_ISLITTLEENDIAN(x) (!SDL_AUDIO_ISBIGENDIAN(x))
|
icculus@1964
|
83 |
#define SDL_AUDIO_ISUNSIGNED(x) (!SDL_AUDIO_ISSIGNED(x))
|
icculus@1964
|
84 |
|
slouken@3407
|
85 |
/**
|
slouken@3407
|
86 |
* \name Audio format flags
|
slouken@3407
|
87 |
*
|
slouken@3407
|
88 |
* Defaults to LSB byte order.
|
slouken@3407
|
89 |
*/
|
slouken@3407
|
90 |
/*@{*/
|
slouken@3407
|
91 |
#define AUDIO_U8 0x0008 /**< Unsigned 8-bit samples */
|
slouken@3407
|
92 |
#define AUDIO_S8 0x8008 /**< Signed 8-bit samples */
|
slouken@3407
|
93 |
#define AUDIO_U16LSB 0x0010 /**< Unsigned 16-bit samples */
|
slouken@3407
|
94 |
#define AUDIO_S16LSB 0x8010 /**< Signed 16-bit samples */
|
slouken@3407
|
95 |
#define AUDIO_U16MSB 0x1010 /**< As above, but big-endian byte order */
|
slouken@3407
|
96 |
#define AUDIO_S16MSB 0x9010 /**< As above, but big-endian byte order */
|
slouken@0
|
97 |
#define AUDIO_U16 AUDIO_U16LSB
|
slouken@0
|
98 |
#define AUDIO_S16 AUDIO_S16LSB
|
slouken@3407
|
99 |
/*@}*/
|
slouken@0
|
100 |
|
slouken@3407
|
101 |
/**
|
slouken@3407
|
102 |
* \name int32 support
|
slouken@3407
|
103 |
*
|
slouken@3407
|
104 |
* New to SDL 1.3.
|
slouken@3407
|
105 |
*/
|
slouken@3407
|
106 |
/*@{*/
|
slouken@3407
|
107 |
#define AUDIO_S32LSB 0x8020 /**< 32-bit integer samples */
|
slouken@3407
|
108 |
#define AUDIO_S32MSB 0x9020 /**< As above, but big-endian byte order */
|
icculus@1964
|
109 |
#define AUDIO_S32 AUDIO_S32LSB
|
slouken@3407
|
110 |
/*@}*/
|
icculus@1964
|
111 |
|
slouken@3407
|
112 |
/**
|
slouken@3407
|
113 |
* \name float32 support
|
slouken@3407
|
114 |
*
|
slouken@3407
|
115 |
* New to SDL 1.3.
|
slouken@3407
|
116 |
*/
|
slouken@3407
|
117 |
/*@{*/
|
slouken@3407
|
118 |
#define AUDIO_F32LSB 0x8120 /**< 32-bit floating point samples */
|
slouken@3407
|
119 |
#define AUDIO_F32MSB 0x9120 /**< As above, but big-endian byte order */
|
icculus@1964
|
120 |
#define AUDIO_F32 AUDIO_F32LSB
|
slouken@3407
|
121 |
/*@}*/
|
icculus@1964
|
122 |
|
slouken@3407
|
123 |
/**
|
slouken@3407
|
124 |
* \name Native audio byte ordering
|
slouken@3407
|
125 |
*/
|
slouken@3407
|
126 |
/*@{*/
|
slouken@0
|
127 |
#if SDL_BYTEORDER == SDL_LIL_ENDIAN
|
slouken@0
|
128 |
#define AUDIO_U16SYS AUDIO_U16LSB
|
slouken@0
|
129 |
#define AUDIO_S16SYS AUDIO_S16LSB
|
icculus@1964
|
130 |
#define AUDIO_S32SYS AUDIO_S32LSB
|
icculus@1964
|
131 |
#define AUDIO_F32SYS AUDIO_F32LSB
|
slouken@0
|
132 |
#else
|
slouken@0
|
133 |
#define AUDIO_U16SYS AUDIO_U16MSB
|
slouken@0
|
134 |
#define AUDIO_S16SYS AUDIO_S16MSB
|
icculus@1964
|
135 |
#define AUDIO_S32SYS AUDIO_S32MSB
|
icculus@1964
|
136 |
#define AUDIO_F32SYS AUDIO_F32MSB
|
slouken@0
|
137 |
#endif
|
slouken@3407
|
138 |
/*@}*/
|
slouken@0
|
139 |
|
slouken@3407
|
140 |
/**
|
slouken@3407
|
141 |
* \name Allow change flags
|
slouken@3407
|
142 |
*
|
slouken@3407
|
143 |
* Which audio format changes are allowed when opening a device.
|
slouken@3407
|
144 |
*/
|
slouken@3407
|
145 |
/*@{*/
|
slouken@2866
|
146 |
#define SDL_AUDIO_ALLOW_FREQUENCY_CHANGE 0x00000001
|
slouken@2866
|
147 |
#define SDL_AUDIO_ALLOW_FORMAT_CHANGE 0x00000002
|
slouken@2866
|
148 |
#define SDL_AUDIO_ALLOW_CHANNELS_CHANGE 0x00000004
|
slouken@2866
|
149 |
#define SDL_AUDIO_ALLOW_ANY_CHANGE (SDL_AUDIO_ALLOW_FREQUENCY_CHANGE|SDL_AUDIO_ALLOW_FORMAT_CHANGE|SDL_AUDIO_ALLOW_CHANNELS_CHANGE)
|
slouken@3407
|
150 |
/*@}*/
|
slouken@0
|
151 |
|
slouken@3407
|
152 |
/*@}*//*Audio flags*/
|
slouken@3407
|
153 |
|
slouken@3407
|
154 |
/**
|
slouken@3554
|
155 |
* This function is called when the audio device needs more data.
|
slouken@3554
|
156 |
*
|
slouken@3554
|
157 |
* \param userdata An application-specific parameter saved in
|
slouken@3554
|
158 |
* the SDL_AudioSpec structure
|
slouken@3554
|
159 |
* \param stream A pointer to the audio data buffer.
|
slouken@3554
|
160 |
* \param len The length of that buffer in bytes.
|
slouken@3554
|
161 |
*
|
slouken@3554
|
162 |
* Once the callback returns, the buffer will no longer be valid.
|
slouken@3554
|
163 |
* Stereo samples are stored in a LRLRLR ordering.
|
slouken@3554
|
164 |
*/
|
slouken@3554
|
165 |
typedef void (SDLCALL * SDL_AudioCallback) (void *userdata, Uint8 * stream,
|
slouken@3554
|
166 |
int len);
|
slouken@3554
|
167 |
|
slouken@3554
|
168 |
/**
|
slouken@3407
|
169 |
* The calculated values in this structure are calculated by SDL_OpenAudio().
|
slouken@3407
|
170 |
*/
|
slouken@3407
|
171 |
typedef struct SDL_AudioSpec
|
slouken@3407
|
172 |
{
|
slouken@3407
|
173 |
int freq; /**< DSP frequency -- samples per second */
|
slouken@3407
|
174 |
SDL_AudioFormat format; /**< Audio data format */
|
slouken@3407
|
175 |
Uint8 channels; /**< Number of channels: 1 mono, 2 stereo */
|
slouken@3407
|
176 |
Uint8 silence; /**< Audio buffer silence value (calculated) */
|
slouken@3407
|
177 |
Uint16 samples; /**< Audio buffer size in samples (power of 2) */
|
slouken@3407
|
178 |
Uint16 padding; /**< Necessary for some compile environments */
|
slouken@3407
|
179 |
Uint32 size; /**< Audio buffer size in bytes (calculated) */
|
slouken@3554
|
180 |
SDL_AudioCallback callback;
|
slouken@3407
|
181 |
void *userdata;
|
slouken@3407
|
182 |
} SDL_AudioSpec;
|
slouken@3407
|
183 |
|
slouken@3407
|
184 |
|
icculus@1983
|
185 |
struct SDL_AudioCVT;
|
slouken@1985
|
186 |
typedef void (SDLCALL * SDL_AudioFilter) (struct SDL_AudioCVT * cvt,
|
slouken@1985
|
187 |
SDL_AudioFormat format);
|
icculus@1983
|
188 |
|
slouken@3407
|
189 |
/**
|
slouken@3407
|
190 |
* A structure to hold a set of audio conversion filters and buffers.
|
slouken@3407
|
191 |
*/
|
slouken@1895
|
192 |
typedef struct SDL_AudioCVT
|
slouken@1895
|
193 |
{
|
slouken@3407
|
194 |
int needed; /**< Set to 1 if conversion possible */
|
slouken@3407
|
195 |
SDL_AudioFormat src_format; /**< Source audio format */
|
slouken@3407
|
196 |
SDL_AudioFormat dst_format; /**< Target audio format */
|
slouken@3407
|
197 |
double rate_incr; /**< Rate conversion increment */
|
slouken@3407
|
198 |
Uint8 *buf; /**< Buffer to hold entire audio data */
|
slouken@3407
|
199 |
int len; /**< Length of original audio buffer */
|
slouken@3407
|
200 |
int len_cvt; /**< Length of converted audio buffer */
|
slouken@3407
|
201 |
int len_mult; /**< buffer must be len*len_mult big */
|
slouken@3407
|
202 |
double len_ratio; /**< Given len, final size is len*len_ratio */
|
slouken@3407
|
203 |
SDL_AudioFilter filters[10]; /**< Filter list */
|
slouken@3407
|
204 |
int filter_index; /**< Current audio conversion function */
|
slouken@0
|
205 |
} SDL_AudioCVT;
|
slouken@0
|
206 |
|
slouken@0
|
207 |
|
slouken@0
|
208 |
/* Function prototypes */
|
slouken@0
|
209 |
|
slouken@3407
|
210 |
/**
|
slouken@3407
|
211 |
* \name Driver discovery functions
|
slouken@3407
|
212 |
*
|
slouken@3407
|
213 |
* These functions return the list of built in audio drivers, in the
|
slouken@3407
|
214 |
* order that they are normally initialized by default.
|
slouken@1895
|
215 |
*/
|
slouken@3407
|
216 |
/*@{*/
|
slouken@1895
|
217 |
extern DECLSPEC int SDLCALL SDL_GetNumAudioDrivers(void);
|
slouken@1895
|
218 |
extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
|
slouken@3407
|
219 |
/*@}*/
|
slouken@1895
|
220 |
|
slouken@3407
|
221 |
/**
|
slouken@3407
|
222 |
* \name Initialization and cleanup
|
slouken@3407
|
223 |
*
|
slouken@3407
|
224 |
* \internal These functions are used internally, and should not be used unless
|
slouken@3407
|
225 |
* you have a specific need to specify the audio driver you want to
|
slouken@3407
|
226 |
* use. You should normally use SDL_Init() or SDL_InitSubSystem().
|
slouken@0
|
227 |
*/
|
slouken@3407
|
228 |
/*@{*/
|
slouken@337
|
229 |
extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
|
slouken@337
|
230 |
extern DECLSPEC void SDLCALL SDL_AudioQuit(void);
|
slouken@3407
|
231 |
/*@}*/
|
slouken@0
|
232 |
|
slouken@3407
|
233 |
/**
|
slouken@3407
|
234 |
* This function returns the name of the current audio driver, or NULL
|
slouken@3407
|
235 |
* if no driver has been initialized.
|
slouken@0
|
236 |
*/
|
slouken@1895
|
237 |
extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);
|
slouken@0
|
238 |
|
slouken@3407
|
239 |
/**
|
slouken@3407
|
240 |
* This function opens the audio device with the desired parameters, and
|
slouken@3407
|
241 |
* returns 0 if successful, placing the actual hardware parameters in the
|
slouken@3407
|
242 |
* structure pointed to by \c obtained. If \c obtained is NULL, the audio
|
slouken@3407
|
243 |
* data passed to the callback function will be guaranteed to be in the
|
slouken@3407
|
244 |
* requested format, and will be automatically converted to the hardware
|
slouken@3407
|
245 |
* audio format if necessary. This function returns -1 if it failed
|
slouken@3407
|
246 |
* to open the audio device, or couldn't set up the audio thread.
|
slouken@3407
|
247 |
*
|
slouken@3407
|
248 |
* When filling in the desired audio spec structure,
|
slouken@3407
|
249 |
* - \c desired->freq should be the desired audio frequency in samples-per-
|
slouken@3407
|
250 |
* second.
|
slouken@3407
|
251 |
* - \c desired->format should be the desired audio format.
|
slouken@3407
|
252 |
* - \c desired->samples is the desired size of the audio buffer, in
|
slouken@3407
|
253 |
* samples. This number should be a power of two, and may be adjusted by
|
slouken@3407
|
254 |
* the audio driver to a value more suitable for the hardware. Good values
|
slouken@3407
|
255 |
* seem to range between 512 and 8096 inclusive, depending on the
|
slouken@3407
|
256 |
* application and CPU speed. Smaller values yield faster response time,
|
slouken@3407
|
257 |
* but can lead to underflow if the application is doing heavy processing
|
slouken@3407
|
258 |
* and cannot fill the audio buffer in time. A stereo sample consists of
|
slouken@3407
|
259 |
* both right and left channels in LR ordering.
|
slouken@3407
|
260 |
* Note that the number of samples is directly related to time by the
|
slouken@3407
|
261 |
* following formula: \code ms = (samples*1000)/freq \endcode
|
slouken@3407
|
262 |
* - \c desired->size is the size in bytes of the audio buffer, and is
|
slouken@3407
|
263 |
* calculated by SDL_OpenAudio().
|
slouken@3407
|
264 |
* - \c desired->silence is the value used to set the buffer to silence,
|
slouken@3407
|
265 |
* and is calculated by SDL_OpenAudio().
|
slouken@3407
|
266 |
* - \c desired->callback should be set to a function that will be called
|
slouken@3407
|
267 |
* when the audio device is ready for more data. It is passed a pointer
|
slouken@3407
|
268 |
* to the audio buffer, and the length in bytes of the audio buffer.
|
slouken@3407
|
269 |
* This function usually runs in a separate thread, and so you should
|
slouken@3407
|
270 |
* protect data structures that it accesses by calling SDL_LockAudio()
|
slouken@3407
|
271 |
* and SDL_UnlockAudio() in your code.
|
slouken@3407
|
272 |
* - \c desired->userdata is passed as the first parameter to your callback
|
slouken@3407
|
273 |
* function.
|
slouken@3407
|
274 |
*
|
slouken@3407
|
275 |
* The audio device starts out playing silence when it's opened, and should
|
slouken@3407
|
276 |
* be enabled for playing by calling \c SDL_PauseAudio(0) when you are ready
|
slouken@3407
|
277 |
* for your audio callback function to be called. Since the audio driver
|
slouken@3407
|
278 |
* may modify the requested size of the audio buffer, you should allocate
|
slouken@3407
|
279 |
* any local mixing buffers after you open the audio device.
|
slouken@0
|
280 |
*/
|
slouken@2866
|
281 |
extern DECLSPEC int SDLCALL SDL_OpenAudio(SDL_AudioSpec * desired,
|
slouken@1895
|
282 |
SDL_AudioSpec * obtained);
|
slouken@0
|
283 |
|
slouken@3407
|
284 |
/**
|
slouken@3407
|
285 |
* SDL Audio Device IDs.
|
slouken@3407
|
286 |
*
|
slouken@3407
|
287 |
* A successful call to SDL_OpenAudio() is always device id 1, and legacy
|
icculus@1964
|
288 |
* SDL audio APIs assume you want this device ID. SDL_OpenAudioDevice() calls
|
icculus@1964
|
289 |
* always returns devices >= 2 on success. The legacy calls are good both
|
icculus@1964
|
290 |
* for backwards compatibility and when you don't care about multiple,
|
icculus@1964
|
291 |
* specific, or capture devices.
|
icculus@1964
|
292 |
*/
|
icculus@1964
|
293 |
typedef Uint32 SDL_AudioDeviceID;
|
icculus@1964
|
294 |
|
slouken@3407
|
295 |
/**
|
slouken@3407
|
296 |
* Get the number of available devices exposed by the current driver.
|
icculus@1964
|
297 |
* Only valid after a successfully initializing the audio subsystem.
|
icculus@2049
|
298 |
* Returns -1 if an explicit list of devices can't be determined; this is
|
icculus@2049
|
299 |
* not an error. For example, if SDL is set up to talk to a remote audio
|
icculus@2049
|
300 |
* server, it can't list every one available on the Internet, but it will
|
icculus@2049
|
301 |
* still allow a specific host to be specified to SDL_OpenAudioDevice().
|
slouken@3407
|
302 |
*
|
slouken@3407
|
303 |
* In many common cases, when this function returns a value <= 0, it can still
|
icculus@2049
|
304 |
* successfully open the default device (NULL for first argument of
|
icculus@2049
|
305 |
* SDL_OpenAudioDevice()).
|
icculus@1964
|
306 |
*/
|
icculus@1964
|
307 |
extern DECLSPEC int SDLCALL SDL_GetNumAudioDevices(int iscapture);
|
icculus@1964
|
308 |
|
slouken@3407
|
309 |
/**
|
slouken@3407
|
310 |
* Get the human-readable name of a specific audio device.
|
icculus@1964
|
311 |
* Must be a value between 0 and (number of audio devices-1).
|
icculus@1964
|
312 |
* Only valid after a successfully initializing the audio subsystem.
|
icculus@2049
|
313 |
* The values returned by this function reflect the latest call to
|
icculus@2049
|
314 |
* SDL_GetNumAudioDevices(); recall that function to redetect available
|
icculus@2049
|
315 |
* hardware.
|
slouken@3407
|
316 |
*
|
slouken@3407
|
317 |
* The string returned by this function is UTF-8 encoded, read-only, and
|
icculus@2049
|
318 |
* managed internally. You are not to free it. If you need to keep the
|
icculus@2049
|
319 |
* string for any length of time, you should make your own copy of it, as it
|
icculus@2049
|
320 |
* will be invalid next time any of several other SDL functions is called.
|
icculus@1964
|
321 |
*/
|
icculus@2049
|
322 |
extern DECLSPEC const char *SDLCALL SDL_GetAudioDeviceName(int index,
|
icculus@2049
|
323 |
int iscapture);
|
icculus@1964
|
324 |
|
icculus@1964
|
325 |
|
slouken@3407
|
326 |
/**
|
slouken@3407
|
327 |
* Open a specific audio device. Passing in a device name of NULL requests
|
icculus@2049
|
328 |
* the most reasonable default (and is equivalent to calling SDL_OpenAudio()).
|
slouken@3407
|
329 |
*
|
slouken@3407
|
330 |
* The device name is a UTF-8 string reported by SDL_GetAudioDeviceName(), but
|
icculus@2049
|
331 |
* some drivers allow arbitrary and driver-specific strings, such as a
|
icculus@2049
|
332 |
* hostname/IP address for a remote audio server, or a filename in the
|
icculus@2049
|
333 |
* diskaudio driver.
|
slouken@3407
|
334 |
*
|
slouken@3407
|
335 |
* \return 0 on error, a valid device ID that is >= 2 on success.
|
slouken@3407
|
336 |
*
|
icculus@2049
|
337 |
* SDL_OpenAudio(), unlike this function, always acts on device ID 1.
|
icculus@1964
|
338 |
*/
|
slouken@1967
|
339 |
extern DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(const char
|
slouken@1967
|
340 |
*device,
|
slouken@1967
|
341 |
int iscapture,
|
slouken@1967
|
342 |
const
|
slouken@1967
|
343 |
SDL_AudioSpec *
|
slouken@1967
|
344 |
desired,
|
slouken@1967
|
345 |
SDL_AudioSpec *
|
slouken@2866
|
346 |
obtained,
|
slouken@2866
|
347 |
int
|
slouken@2866
|
348 |
allowed_changes);
|
icculus@1964
|
349 |
|
icculus@1964
|
350 |
|
icculus@1964
|
351 |
|
slouken@3407
|
352 |
/**
|
slouken@3407
|
353 |
* \name Audio state
|
slouken@3407
|
354 |
*
|
slouken@3407
|
355 |
* Get the current audio state.
|
slouken@0
|
356 |
*/
|
slouken@3407
|
357 |
/*@{*/
|
slouken@1895
|
358 |
typedef enum
|
slouken@1895
|
359 |
{
|
slouken@1895
|
360 |
SDL_AUDIO_STOPPED = 0,
|
slouken@1895
|
361 |
SDL_AUDIO_PLAYING,
|
slouken@1895
|
362 |
SDL_AUDIO_PAUSED
|
slouken@3537
|
363 |
} SDL_AudioStatus;
|
slouken@3537
|
364 |
extern DECLSPEC SDL_AudioStatus SDLCALL SDL_GetAudioStatus(void);
|
slouken@0
|
365 |
|
slouken@3537
|
366 |
extern DECLSPEC SDL_AudioStatus SDLCALL
|
slouken@1967
|
367 |
SDL_GetAudioDeviceStatus(SDL_AudioDeviceID dev);
|
slouken@3407
|
368 |
/*@}*//*Audio State*/
|
icculus@1964
|
369 |
|
slouken@3407
|
370 |
/**
|
slouken@3407
|
371 |
* \name Pause audio functions
|
slouken@3407
|
372 |
*
|
slouken@3407
|
373 |
* These functions pause and unpause the audio callback processing.
|
slouken@3407
|
374 |
* They should be called with a parameter of 0 after opening the audio
|
slouken@3407
|
375 |
* device to start playing sound. This is so you can safely initialize
|
slouken@3407
|
376 |
* data for your callback function after opening the audio device.
|
slouken@3407
|
377 |
* Silence will be written to the audio device during the pause.
|
slouken@0
|
378 |
*/
|
slouken@3407
|
379 |
/*@{*/
|
slouken@337
|
380 |
extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
|
icculus@1964
|
381 |
extern DECLSPEC void SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev,
|
icculus@1964
|
382 |
int pause_on);
|
slouken@3407
|
383 |
/*@}*//*Pause audio functions*/
|
slouken@0
|
384 |
|
slouken@3407
|
385 |
/**
|
slouken@3407
|
386 |
* This function loads a WAVE from the data source, automatically freeing
|
slouken@3407
|
387 |
* that source if \c freesrc is non-zero. For example, to load a WAVE file,
|
slouken@3407
|
388 |
* you could do:
|
slouken@3407
|
389 |
* \code
|
slouken@3407
|
390 |
* SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
|
slouken@3407
|
391 |
* \endcode
|
slouken@0
|
392 |
*
|
slouken@3407
|
393 |
* If this function succeeds, it returns the given SDL_AudioSpec,
|
slouken@3407
|
394 |
* filled with the audio data format of the wave data, and sets
|
slouken@3407
|
395 |
* \c *audio_buf to a malloc()'d buffer containing the audio data,
|
slouken@3407
|
396 |
* and sets \c *audio_len to the length of that audio buffer, in bytes.
|
slouken@3407
|
397 |
* You need to free the audio buffer with SDL_FreeWAV() when you are
|
slouken@3407
|
398 |
* done with it.
|
slouken@0
|
399 |
*
|
slouken@3407
|
400 |
* This function returns NULL and sets the SDL error message if the
|
slouken@3407
|
401 |
* wave file cannot be opened, uses an unknown data format, or is
|
slouken@3407
|
402 |
* corrupt. Currently raw and MS-ADPCM WAVE files are supported.
|
slouken@0
|
403 |
*/
|
slouken@1895
|
404 |
extern DECLSPEC SDL_AudioSpec *SDLCALL SDL_LoadWAV_RW(SDL_RWops * src,
|
slouken@1895
|
405 |
int freesrc,
|
slouken@1895
|
406 |
SDL_AudioSpec * spec,
|
slouken@1895
|
407 |
Uint8 ** audio_buf,
|
slouken@1895
|
408 |
Uint32 * audio_len);
|
slouken@0
|
409 |
|
slouken@3407
|
410 |
/**
|
slouken@3407
|
411 |
* Loads a WAV from a file.
|
slouken@3407
|
412 |
* Compatibility convenience function.
|
slouken@3407
|
413 |
*/
|
slouken@0
|
414 |
#define SDL_LoadWAV(file, spec, audio_buf, audio_len) \
|
slouken@0
|
415 |
SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)
|
slouken@0
|
416 |
|
slouken@3407
|
417 |
/**
|
slouken@3407
|
418 |
* This function frees data previously allocated with SDL_LoadWAV_RW()
|
slouken@0
|
419 |
*/
|
slouken@1895
|
420 |
extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 * audio_buf);
|
slouken@0
|
421 |
|
slouken@3407
|
422 |
/**
|
slouken@3407
|
423 |
* This function takes a source format and rate and a destination format
|
slouken@3407
|
424 |
* and rate, and initializes the \c cvt structure with information needed
|
slouken@3407
|
425 |
* by SDL_ConvertAudio() to convert a buffer of audio data from one format
|
slouken@3407
|
426 |
* to the other.
|
slouken@3407
|
427 |
*
|
slouken@3407
|
428 |
* \return -1 if the format conversion is not supported, 0 if there's
|
icculus@1964
|
429 |
* no conversion needed, or 1 if the audio filter is set up.
|
slouken@0
|
430 |
*/
|
slouken@1895
|
431 |
extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT * cvt,
|
icculus@1983
|
432 |
SDL_AudioFormat src_format,
|
slouken@1895
|
433 |
Uint8 src_channels,
|
slouken@1895
|
434 |
int src_rate,
|
icculus@1983
|
435 |
SDL_AudioFormat dst_format,
|
slouken@1895
|
436 |
Uint8 dst_channels,
|
slouken@1895
|
437 |
int dst_rate);
|
slouken@0
|
438 |
|
slouken@3407
|
439 |
/**
|
slouken@3407
|
440 |
* Once you have initialized the \c cvt structure using SDL_BuildAudioCVT(),
|
slouken@3407
|
441 |
* created an audio buffer \c cvt->buf, and filled it with \c cvt->len bytes of
|
slouken@3407
|
442 |
* audio data in the source format, this function will convert it in-place
|
slouken@3407
|
443 |
* to the desired format.
|
slouken@3407
|
444 |
*
|
slouken@3407
|
445 |
* The data conversion may expand the size of the audio data, so the buffer
|
slouken@3407
|
446 |
* \c cvt->buf should be allocated after the \c cvt structure is initialized by
|
slouken@3407
|
447 |
* SDL_BuildAudioCVT(), and should be \c cvt->len*cvt->len_mult bytes long.
|
slouken@0
|
448 |
*/
|
slouken@1895
|
449 |
extern DECLSPEC int SDLCALL SDL_ConvertAudio(SDL_AudioCVT * cvt);
|
slouken@0
|
450 |
|
slouken@3407
|
451 |
#define SDL_MIX_MAXVOLUME 128
|
slouken@3407
|
452 |
/**
|
slouken@3407
|
453 |
* This takes two audio buffers of the playing audio format and mixes
|
slouken@3407
|
454 |
* them, performing addition, volume adjustment, and overflow clipping.
|
slouken@3407
|
455 |
* The volume ranges from 0 - 128, and should be set to ::SDL_MIX_MAXVOLUME
|
slouken@3407
|
456 |
* for full audio volume. Note this does not change hardware volume.
|
slouken@3407
|
457 |
* This is provided for convenience -- you can mix your own audio data.
|
slouken@0
|
458 |
*/
|
slouken@1895
|
459 |
extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 * dst, const Uint8 * src,
|
slouken@1895
|
460 |
Uint32 len, int volume);
|
slouken@0
|
461 |
|
slouken@3407
|
462 |
/**
|
slouken@3407
|
463 |
* This works like SDL_MixAudio(), but you specify the audio format instead of
|
icculus@1964
|
464 |
* using the format of audio device 1. Thus it can be used when no audio
|
icculus@1964
|
465 |
* device is open at all.
|
icculus@1964
|
466 |
*/
|
slouken@1967
|
467 |
extern DECLSPEC void SDLCALL SDL_MixAudioFormat(Uint8 * dst,
|
slouken@1967
|
468 |
const Uint8 * src,
|
icculus@1964
|
469 |
SDL_AudioFormat format,
|
icculus@1964
|
470 |
Uint32 len, int volume);
|
icculus@1964
|
471 |
|
slouken@3407
|
472 |
/**
|
slouken@3407
|
473 |
* \name Audio lock functions
|
slouken@3407
|
474 |
*
|
slouken@3407
|
475 |
* The lock manipulated by these functions protects the callback function.
|
slouken@3407
|
476 |
* During a SDL_LockAudio()/SDL_UnlockAudio() pair, you can be guaranteed that
|
slouken@3407
|
477 |
* the callback function is not running. Do not call these from the callback
|
slouken@3407
|
478 |
* function or you will cause deadlock.
|
slouken@0
|
479 |
*/
|
slouken@3407
|
480 |
/*@{*/
|
slouken@337
|
481 |
extern DECLSPEC void SDLCALL SDL_LockAudio(void);
|
icculus@1964
|
482 |
extern DECLSPEC void SDLCALL SDL_LockAudioDevice(SDL_AudioDeviceID dev);
|
slouken@337
|
483 |
extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
|
icculus@1964
|
484 |
extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev);
|
slouken@3407
|
485 |
/*@}*//*Audio lock functions*/
|
slouken@0
|
486 |
|
slouken@3407
|
487 |
/**
|
slouken@3407
|
488 |
* This function shuts down audio processing and closes the audio device.
|
slouken@0
|
489 |
*/
|
slouken@337
|
490 |
extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
|
icculus@1964
|
491 |
extern DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID dev);
|
icculus@1964
|
492 |
|
slouken@3407
|
493 |
/**
|
slouken@3407
|
494 |
* \return 1 if audio device is still functioning, zero if not, -1 on error.
|
icculus@1964
|
495 |
*/
|
icculus@1964
|
496 |
extern DECLSPEC int SDLCALL SDL_AudioDeviceConnected(SDL_AudioDeviceID dev);
|
slouken@0
|
497 |
|
slouken@0
|
498 |
|
slouken@0
|
499 |
/* Ends C function definitions when using C++ */
|
slouken@0
|
500 |
#ifdef __cplusplus
|
slouken@1895
|
501 |
/* *INDENT-OFF* */
|
slouken@0
|
502 |
}
|
slouken@1895
|
503 |
/* *INDENT-ON* */
|
slouken@0
|
504 |
#endif
|
slouken@0
|
505 |
#include "close_code.h"
|
slouken@0
|
506 |
|
slouken@0
|
507 |
#endif /* _SDL_audio_h */
|
slouken@1895
|
508 |
|
slouken@1895
|
509 |
/* vi: set ts=4 sw=4 expandtab: */
|