slouken@0
|
1 |
/*
|
slouken@0
|
2 |
SDL - Simple DirectMedia Layer
|
slouken@769
|
3 |
Copyright (C) 1997-2004 Sam Lantinga
|
slouken@0
|
4 |
|
slouken@0
|
5 |
This library is free software; you can redistribute it and/or
|
slouken@0
|
6 |
modify it under the terms of the GNU Library General Public
|
slouken@0
|
7 |
License as published by the Free Software Foundation; either
|
slouken@0
|
8 |
version 2 of the License, or (at your option) any later version.
|
slouken@0
|
9 |
|
slouken@0
|
10 |
This library is distributed in the hope that it will be useful,
|
slouken@0
|
11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
slouken@0
|
12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
slouken@0
|
13 |
Library General Public License for more details.
|
slouken@0
|
14 |
|
slouken@0
|
15 |
You should have received a copy of the GNU Library General Public
|
slouken@0
|
16 |
License along with this library; if not, write to the Free
|
slouken@0
|
17 |
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
slouken@0
|
18 |
|
slouken@0
|
19 |
Sam Lantinga
|
slouken@251
|
20 |
slouken@libsdl.org
|
slouken@0
|
21 |
*/
|
slouken@0
|
22 |
|
slouken@0
|
23 |
#ifdef SAVE_RCSID
|
slouken@0
|
24 |
static char rcsid =
|
slouken@0
|
25 |
"@(#) $Id$";
|
slouken@0
|
26 |
#endif
|
slouken@0
|
27 |
|
slouken@0
|
28 |
/* Access to the raw audio mixing buffer for the SDL library */
|
slouken@0
|
29 |
|
slouken@0
|
30 |
#ifndef _SDL_audio_h
|
slouken@0
|
31 |
#define _SDL_audio_h
|
slouken@0
|
32 |
|
slouken@0
|
33 |
#include <stdio.h>
|
slouken@0
|
34 |
|
slouken@0
|
35 |
#include "SDL_main.h"
|
slouken@0
|
36 |
#include "SDL_types.h"
|
slouken@0
|
37 |
#include "SDL_error.h"
|
slouken@0
|
38 |
#include "SDL_rwops.h"
|
slouken@0
|
39 |
#include "SDL_byteorder.h"
|
slouken@0
|
40 |
|
slouken@0
|
41 |
#include "begin_code.h"
|
slouken@0
|
42 |
/* Set up for C function definitions, even when using C++ */
|
slouken@0
|
43 |
#ifdef __cplusplus
|
slouken@0
|
44 |
extern "C" {
|
slouken@0
|
45 |
#endif
|
slouken@0
|
46 |
|
slouken@0
|
47 |
/* The calculated values in this structure are calculated by SDL_OpenAudio() */
|
slouken@0
|
48 |
typedef struct {
|
slouken@0
|
49 |
int freq; /* DSP frequency -- samples per second */
|
slouken@0
|
50 |
Uint16 format; /* Audio data format */
|
slouken@0
|
51 |
Uint8 channels; /* Number of channels: 1 mono, 2 stereo */
|
slouken@0
|
52 |
Uint8 silence; /* Audio buffer silence value (calculated) */
|
slouken@188
|
53 |
Uint16 samples; /* Audio buffer size in samples (power of 2) */
|
slouken@0
|
54 |
Uint16 padding; /* Necessary for some compile environments */
|
slouken@0
|
55 |
Uint32 size; /* Audio buffer size in bytes (calculated) */
|
slouken@0
|
56 |
/* This function is called when the audio device needs more data.
|
slouken@0
|
57 |
'stream' is a pointer to the audio data buffer
|
slouken@0
|
58 |
'len' is the length of that buffer in bytes.
|
slouken@0
|
59 |
Once the callback returns, the buffer will no longer be valid.
|
slouken@0
|
60 |
Stereo samples are stored in a LRLRLR ordering.
|
slouken@0
|
61 |
*/
|
slouken@0
|
62 |
void (*callback)(void *userdata, Uint8 *stream, int len);
|
slouken@0
|
63 |
void *userdata;
|
slouken@0
|
64 |
} SDL_AudioSpec;
|
slouken@0
|
65 |
|
slouken@0
|
66 |
/* Audio format flags (defaults to LSB byte order) */
|
slouken@0
|
67 |
#define AUDIO_U8 0x0008 /* Unsigned 8-bit samples */
|
slouken@0
|
68 |
#define AUDIO_S8 0x8008 /* Signed 8-bit samples */
|
slouken@0
|
69 |
#define AUDIO_U16LSB 0x0010 /* Unsigned 16-bit samples */
|
slouken@0
|
70 |
#define AUDIO_S16LSB 0x8010 /* Signed 16-bit samples */
|
slouken@0
|
71 |
#define AUDIO_U16MSB 0x1010 /* As above, but big-endian byte order */
|
slouken@0
|
72 |
#define AUDIO_S16MSB 0x9010 /* As above, but big-endian byte order */
|
slouken@0
|
73 |
#define AUDIO_U16 AUDIO_U16LSB
|
slouken@0
|
74 |
#define AUDIO_S16 AUDIO_S16LSB
|
slouken@0
|
75 |
|
slouken@0
|
76 |
/* Native audio byte ordering */
|
slouken@0
|
77 |
#if SDL_BYTEORDER == SDL_LIL_ENDIAN
|
slouken@0
|
78 |
#define AUDIO_U16SYS AUDIO_U16LSB
|
slouken@0
|
79 |
#define AUDIO_S16SYS AUDIO_S16LSB
|
slouken@0
|
80 |
#else
|
slouken@0
|
81 |
#define AUDIO_U16SYS AUDIO_U16MSB
|
slouken@0
|
82 |
#define AUDIO_S16SYS AUDIO_S16MSB
|
slouken@0
|
83 |
#endif
|
slouken@0
|
84 |
|
slouken@0
|
85 |
|
slouken@0
|
86 |
/* A structure to hold a set of audio conversion filters and buffers */
|
slouken@0
|
87 |
typedef struct SDL_AudioCVT {
|
slouken@0
|
88 |
int needed; /* Set to 1 if conversion possible */
|
slouken@0
|
89 |
Uint16 src_format; /* Source audio format */
|
slouken@0
|
90 |
Uint16 dst_format; /* Target audio format */
|
slouken@0
|
91 |
double rate_incr; /* Rate conversion increment */
|
slouken@0
|
92 |
Uint8 *buf; /* Buffer to hold entire audio data */
|
slouken@0
|
93 |
int len; /* Length of original audio buffer */
|
slouken@0
|
94 |
int len_cvt; /* Length of converted audio buffer */
|
slouken@0
|
95 |
int len_mult; /* buffer must be len*len_mult big */
|
slouken@0
|
96 |
double len_ratio; /* Given len, final size is len*len_ratio */
|
slouken@0
|
97 |
void (*filters[10])(struct SDL_AudioCVT *cvt, Uint16 format);
|
slouken@0
|
98 |
int filter_index; /* Current audio conversion function */
|
slouken@0
|
99 |
} SDL_AudioCVT;
|
slouken@0
|
100 |
|
slouken@0
|
101 |
|
slouken@0
|
102 |
/* Function prototypes */
|
slouken@0
|
103 |
|
slouken@0
|
104 |
/* These functions are used internally, and should not be used unless you
|
slouken@0
|
105 |
* have a specific need to specify the audio driver you want to use.
|
slouken@0
|
106 |
* You should normally use SDL_Init() or SDL_InitSubSystem().
|
slouken@0
|
107 |
*/
|
slouken@337
|
108 |
extern DECLSPEC int SDLCALL SDL_AudioInit(const char *driver_name);
|
slouken@337
|
109 |
extern DECLSPEC void SDLCALL SDL_AudioQuit(void);
|
slouken@0
|
110 |
|
slouken@0
|
111 |
/* This function fills the given character buffer with the name of the
|
slouken@0
|
112 |
* current audio driver, and returns a pointer to it if the audio driver has
|
slouken@0
|
113 |
* been initialized. It returns NULL if no driver has been initialized.
|
slouken@0
|
114 |
*/
|
slouken@337
|
115 |
extern DECLSPEC char * SDLCALL SDL_AudioDriverName(char *namebuf, int maxlen);
|
slouken@0
|
116 |
|
slouken@0
|
117 |
/*
|
slouken@0
|
118 |
* This function opens the audio device with the desired parameters, and
|
slouken@0
|
119 |
* returns 0 if successful, placing the actual hardware parameters in the
|
slouken@0
|
120 |
* structure pointed to by 'obtained'. If 'obtained' is NULL, the audio
|
slouken@0
|
121 |
* data passed to the callback function will be guaranteed to be in the
|
slouken@0
|
122 |
* requested format, and will be automatically converted to the hardware
|
slouken@0
|
123 |
* audio format if necessary. This function returns -1 if it failed
|
slouken@0
|
124 |
* to open the audio device, or couldn't set up the audio thread.
|
slouken@0
|
125 |
*
|
slouken@0
|
126 |
* When filling in the desired audio spec structure,
|
slouken@0
|
127 |
* 'desired->freq' should be the desired audio frequency in samples-per-second.
|
slouken@0
|
128 |
* 'desired->format' should be the desired audio format.
|
slouken@0
|
129 |
* 'desired->samples' is the desired size of the audio buffer, in samples.
|
slouken@0
|
130 |
* This number should be a power of two, and may be adjusted by the audio
|
slouken@0
|
131 |
* driver to a value more suitable for the hardware. Good values seem to
|
slouken@0
|
132 |
* range between 512 and 8096 inclusive, depending on the application and
|
slouken@0
|
133 |
* CPU speed. Smaller values yield faster response time, but can lead
|
slouken@0
|
134 |
* to underflow if the application is doing heavy processing and cannot
|
slouken@0
|
135 |
* fill the audio buffer in time. A stereo sample consists of both right
|
slouken@0
|
136 |
* and left channels in LR ordering.
|
slouken@0
|
137 |
* Note that the number of samples is directly related to time by the
|
slouken@0
|
138 |
* following formula: ms = (samples*1000)/freq
|
slouken@0
|
139 |
* 'desired->size' is the size in bytes of the audio buffer, and is
|
slouken@0
|
140 |
* calculated by SDL_OpenAudio().
|
slouken@0
|
141 |
* 'desired->silence' is the value used to set the buffer to silence,
|
slouken@0
|
142 |
* and is calculated by SDL_OpenAudio().
|
slouken@0
|
143 |
* 'desired->callback' should be set to a function that will be called
|
slouken@0
|
144 |
* when the audio device is ready for more data. It is passed a pointer
|
slouken@0
|
145 |
* to the audio buffer, and the length in bytes of the audio buffer.
|
slouken@0
|
146 |
* This function usually runs in a separate thread, and so you should
|
slouken@0
|
147 |
* protect data structures that it accesses by calling SDL_LockAudio()
|
slouken@0
|
148 |
* and SDL_UnlockAudio() in your code.
|
slouken@0
|
149 |
* 'desired->userdata' is passed as the first parameter to your callback
|
slouken@0
|
150 |
* function.
|
slouken@0
|
151 |
*
|
slouken@0
|
152 |
* The audio device starts out playing silence when it's opened, and should
|
slouken@0
|
153 |
* be enabled for playing by calling SDL_PauseAudio(0) when you are ready
|
slouken@0
|
154 |
* for your audio callback function to be called. Since the audio driver
|
slouken@0
|
155 |
* may modify the requested size of the audio buffer, you should allocate
|
slouken@0
|
156 |
* any local mixing buffers after you open the audio device.
|
slouken@0
|
157 |
*/
|
slouken@337
|
158 |
extern DECLSPEC int SDLCALL SDL_OpenAudio(SDL_AudioSpec *desired, SDL_AudioSpec *obtained);
|
slouken@0
|
159 |
|
slouken@0
|
160 |
/*
|
slouken@0
|
161 |
* Get the current audio state:
|
slouken@0
|
162 |
*/
|
slouken@0
|
163 |
typedef enum {
|
slouken@0
|
164 |
SDL_AUDIO_STOPPED = 0,
|
slouken@0
|
165 |
SDL_AUDIO_PLAYING,
|
slouken@0
|
166 |
SDL_AUDIO_PAUSED
|
slouken@0
|
167 |
} SDL_audiostatus;
|
slouken@337
|
168 |
extern DECLSPEC SDL_audiostatus SDLCALL SDL_GetAudioStatus(void);
|
slouken@0
|
169 |
|
slouken@0
|
170 |
/*
|
slouken@0
|
171 |
* This function pauses and unpauses the audio callback processing.
|
slouken@0
|
172 |
* It should be called with a parameter of 0 after opening the audio
|
slouken@0
|
173 |
* device to start playing sound. This is so you can safely initialize
|
slouken@0
|
174 |
* data for your callback function after opening the audio device.
|
slouken@0
|
175 |
* Silence will be written to the audio device during the pause.
|
slouken@0
|
176 |
*/
|
slouken@337
|
177 |
extern DECLSPEC void SDLCALL SDL_PauseAudio(int pause_on);
|
slouken@0
|
178 |
|
slouken@0
|
179 |
/*
|
slouken@0
|
180 |
* This function loads a WAVE from the data source, automatically freeing
|
slouken@0
|
181 |
* that source if 'freesrc' is non-zero. For example, to load a WAVE file,
|
slouken@0
|
182 |
* you could do:
|
slouken@0
|
183 |
* SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
|
slouken@0
|
184 |
*
|
slouken@0
|
185 |
* If this function succeeds, it returns the given SDL_AudioSpec,
|
slouken@0
|
186 |
* filled with the audio data format of the wave data, and sets
|
slouken@0
|
187 |
* 'audio_buf' to a malloc()'d buffer containing the audio data,
|
slouken@0
|
188 |
* and sets 'audio_len' to the length of that audio buffer, in bytes.
|
slouken@0
|
189 |
* You need to free the audio buffer with SDL_FreeWAV() when you are
|
slouken@0
|
190 |
* done with it.
|
slouken@0
|
191 |
*
|
slouken@0
|
192 |
* This function returns NULL and sets the SDL error message if the
|
slouken@0
|
193 |
* wave file cannot be opened, uses an unknown data format, or is
|
slouken@0
|
194 |
* corrupt. Currently raw and MS-ADPCM WAVE files are supported.
|
slouken@0
|
195 |
*/
|
slouken@337
|
196 |
extern DECLSPEC SDL_AudioSpec * SDLCALL SDL_LoadWAV_RW(SDL_RWops *src, int freesrc, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len);
|
slouken@0
|
197 |
|
slouken@0
|
198 |
/* Compatibility convenience function -- loads a WAV from a file */
|
slouken@0
|
199 |
#define SDL_LoadWAV(file, spec, audio_buf, audio_len) \
|
slouken@0
|
200 |
SDL_LoadWAV_RW(SDL_RWFromFile(file, "rb"),1, spec,audio_buf,audio_len)
|
slouken@0
|
201 |
|
slouken@0
|
202 |
/*
|
slouken@0
|
203 |
* This function frees data previously allocated with SDL_LoadWAV_RW()
|
slouken@0
|
204 |
*/
|
slouken@337
|
205 |
extern DECLSPEC void SDLCALL SDL_FreeWAV(Uint8 *audio_buf);
|
slouken@0
|
206 |
|
slouken@0
|
207 |
/*
|
slouken@0
|
208 |
* This function takes a source format and rate and a destination format
|
slouken@0
|
209 |
* and rate, and initializes the 'cvt' structure with information needed
|
slouken@0
|
210 |
* by SDL_ConvertAudio() to convert a buffer of audio data from one format
|
slouken@0
|
211 |
* to the other.
|
slouken@0
|
212 |
* This function returns 0, or -1 if there was an error.
|
slouken@0
|
213 |
*/
|
slouken@337
|
214 |
extern DECLSPEC int SDLCALL SDL_BuildAudioCVT(SDL_AudioCVT *cvt,
|
slouken@0
|
215 |
Uint16 src_format, Uint8 src_channels, int src_rate,
|
slouken@0
|
216 |
Uint16 dst_format, Uint8 dst_channels, int dst_rate);
|
slouken@0
|
217 |
|
slouken@0
|
218 |
/* Once you have initialized the 'cvt' structure using SDL_BuildAudioCVT(),
|
slouken@0
|
219 |
* created an audio buffer cvt->buf, and filled it with cvt->len bytes of
|
slouken@0
|
220 |
* audio data in the source format, this function will convert it in-place
|
slouken@0
|
221 |
* to the desired format.
|
slouken@0
|
222 |
* The data conversion may expand the size of the audio data, so the buffer
|
slouken@0
|
223 |
* cvt->buf should be allocated after the cvt structure is initialized by
|
slouken@0
|
224 |
* SDL_BuildAudioCVT(), and should be cvt->len*cvt->len_mult bytes long.
|
slouken@0
|
225 |
*/
|
slouken@337
|
226 |
extern DECLSPEC int SDLCALL SDL_ConvertAudio(SDL_AudioCVT *cvt);
|
slouken@0
|
227 |
|
slouken@0
|
228 |
/*
|
slouken@0
|
229 |
* This takes two audio buffers of the playing audio format and mixes
|
slouken@0
|
230 |
* them, performing addition, volume adjustment, and overflow clipping.
|
slouken@0
|
231 |
* The volume ranges from 0 - 128, and should be set to SDL_MIX_MAXVOLUME
|
slouken@0
|
232 |
* for full audio volume. Note this does not change hardware volume.
|
slouken@0
|
233 |
* This is provided for convenience -- you can mix your own audio data.
|
slouken@0
|
234 |
*/
|
slouken@0
|
235 |
#define SDL_MIX_MAXVOLUME 128
|
slouken@337
|
236 |
extern DECLSPEC void SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, Uint32 len, int volume);
|
slouken@0
|
237 |
|
slouken@0
|
238 |
/*
|
slouken@0
|
239 |
* The lock manipulated by these functions protects the callback function.
|
slouken@0
|
240 |
* During a LockAudio/UnlockAudio pair, you can be guaranteed that the
|
slouken@0
|
241 |
* callback function is not running. Do not call these from the callback
|
slouken@0
|
242 |
* function or you will cause deadlock.
|
slouken@0
|
243 |
*/
|
slouken@337
|
244 |
extern DECLSPEC void SDLCALL SDL_LockAudio(void);
|
slouken@337
|
245 |
extern DECLSPEC void SDLCALL SDL_UnlockAudio(void);
|
slouken@0
|
246 |
|
slouken@0
|
247 |
/*
|
slouken@0
|
248 |
* This function shuts down audio processing and closes the audio device.
|
slouken@0
|
249 |
*/
|
slouken@337
|
250 |
extern DECLSPEC void SDLCALL SDL_CloseAudio(void);
|
slouken@0
|
251 |
|
slouken@0
|
252 |
|
slouken@0
|
253 |
/* Ends C function definitions when using C++ */
|
slouken@0
|
254 |
#ifdef __cplusplus
|
slouken@0
|
255 |
}
|
slouken@0
|
256 |
#endif
|
slouken@0
|
257 |
#include "close_code.h"
|
slouken@0
|
258 |
|
slouken@0
|
259 |
#endif /* _SDL_audio_h */
|