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