Mercurial > SDL_sound_CoreAudio
annotate SDL_sound.h @ 19:734e5d75acec
Now includes SDL_endian.h ...
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Wed, 19 Sep 2001 08:29:54 +0000 |
| parents | 4368fdb091b1 |
| children | 0e27c909c952 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 * SDL_sound -- An abstract sound format decoding API. | |
| 3 * Copyright (C) 2001 Ryan C. Gordon. | |
| 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 * This library is distributed in the hope that it will be useful, | |
| 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 * Lesser General Public License for more details. | |
| 14 * | |
| 15 * You should have received a copy of the GNU Lesser General Public | |
| 16 * License along with this library; if not, write to the Free Software | |
| 17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
| 18 */ | |
| 19 | |
| 20 /** | |
| 21 * The basic gist of SDL_sound is that you use an SDL_RWops to get sound data | |
| 22 * into this library, and SDL_sound will take that data, in one of several | |
| 23 * popular formats, and decode it into raw waveform data in the format of | |
| 24 * your choice. This gives you a nice abstraction for getting sound into your | |
| 25 * game or application; just feed it to SDL_sound, and it will handle | |
| 26 * decoding and converting, so you can just pass it to your SDL audio | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
27 * callback (or whatever). Since it gets data from an SDL_RWops, you can get |
| 0 | 28 * the initial sound data from any number of sources: file, memory buffer, |
| 29 * network connection, etc. | |
| 30 * | |
| 31 * As the name implies, this library depends on SDL: Simple Directmedia Layer, | |
| 32 * which is a powerful, free, and cross-platform multimedia library. It can | |
| 33 * be found at http://www.libsdl.org/ | |
| 34 * | |
| 35 * Support is in place or planned for the following sound formats: | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
36 * - .WAV (Microsoft WAVfile RIFF data, internal.) |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
37 * - .VOC (Creative Labs' Voice format, internal.) |
| 11 | 38 * - .MP3 (MPEG-1 Layer 3 support, via the SMPEG library.) |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
39 * - .MID (MIDI music converted to Waveform data, via Timidity.) |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
40 * - .MOD (MOD files, via MikMod.) |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
41 * - .OGG (Ogg files, via Ogg Vorbis libraries.) |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
42 * - .RAW (Raw sound data in any format, internal.) |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
43 * - .CDA (CD audio read into a sound buffer, internal.) |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
44 * - .AU |
|
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
45 * - .AIFF |
| 0 | 46 * |
| 47 * (...and more to come...) | |
| 48 * | |
| 49 * Please see the file LICENSE in the source's root directory. | |
| 50 * | |
| 51 * This file written by Ryan C. Gordon. (icculus@clutteredmind.org) | |
| 52 */ | |
| 53 | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
54 #ifndef _INCLUDE_SDL_SOUND_H_ |
|
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
55 #define _INCLUDE_SDL_SOUND_H_ |
| 0 | 56 |
| 57 #include "SDL.h" | |
|
19
734e5d75acec
Now includes SDL_endian.h ...
Ryan C. Gordon <icculus@icculus.org>
parents:
15
diff
changeset
|
58 #include "SDL_endian.h" |
| 0 | 59 |
| 60 #ifdef __cplusplus | |
| 61 extern "C" { | |
| 62 #endif | |
| 63 | |
| 64 /* | |
| 65 * These are flags that are used in a Sound_Sample (below) to show various | |
| 66 * states. | |
| 67 * | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
68 * To use: "if (sample->flags & SOUND_SAMPLEFLAG_ERROR) { dosomething(); }" |
| 0 | 69 */ |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
70 typedef enum __SOUND_SAMPLEFLAGS__ |
| 0 | 71 { |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
72 SOUND_SAMPLEFLAG_NONE = 0, /* Null flag. */ |
| 0 | 73 |
| 74 /* these are set at sample creation time... */ | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
75 SOUND_SAMPLEFLAG_NEEDSEEK = 1, /* SDL_RWops must be able to seek. */ |
| 0 | 76 |
| 77 /* these are set during decoding... */ | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
78 SOUND_SAMPLEFLAG_EOF = 1 << 29, /* end of input stream. */ |
|
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
79 SOUND_SAMPLEFLAG_ERROR = 1 << 30, /* unrecoverable error. */ |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
80 SOUND_SAMPLEFLAG_EAGAIN = 1 << 31 /* would block, or temp error. */ |
| 0 | 81 } Sound_SampleFlags; |
| 82 | |
| 83 | |
| 84 /* | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
85 * Basics of a decoded sample's data structure: data format (see AUDIO_U8 and |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
86 * friends in SDL_audio.h), number of channels, and sample rate. If you need |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
87 * more explanation than that, you should stop developing sound code right |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
88 * now. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
89 */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
90 typedef struct __SOUND_AUDIOINFO__ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
91 { |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
92 Uint16 format; |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
93 Uint8 channels; |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
94 Uint32 rate; |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
95 } Sound_AudioInfo; |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
96 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
97 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
98 /* |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
99 * Each decoder sets up one of these structs, which can be retrieved via |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
100 * the Sound_AvailableDecoders() function. EVERY FIELD IN THIS IS READ-ONLY. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
101 */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
102 typedef struct __SOUND_DECODERINFO__ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
103 { |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
104 const char *extension; /* standard file extension. "MP3", "WAV"... */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
105 const char *description; /* Human readable description of decoder. */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
106 const char *author; /* "Name Of Author <email@emailhost.dom>" */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
107 const char *url; /* URL specific to this decoder. */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
108 } Sound_DecoderInfo; |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
109 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
110 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
111 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
112 /* |
| 0 | 113 * The Sound_Sample structure is the heart of SDL_sound. This holds |
| 114 * information about a source of sound data as it is being decoded. | |
| 115 * EVERY FIELD IN THIS IS READ-ONLY. Please use the API functions to | |
| 116 * change them. | |
| 117 */ | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
118 typedef struct __SOUND_SAMPLE__ |
| 0 | 119 { |
| 120 void *opaque; /* Internal use only. */ | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
121 const Sound_DecoderInfo *decoder; /* Decoder used for this sample. */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
122 Sound_AudioInfo desired; /* Desired audio format for conversion. */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
123 Sound_AudioInfo actual; /* Actual audio format of sample. */ |
| 0 | 124 void *buffer; /* Decoded sound data lands in here. */ |
| 125 Uint32 buffer_size; /* Current size of (buffer), in bytes. */ | |
| 126 Sound_SampleFlags flags; /* Flags relating to this sample. */ | |
| 127 } Sound_Sample; | |
| 128 | |
| 129 | |
| 130 /* | |
| 131 * Just what it says: a x.y.z style version number... | |
| 132 */ | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
133 typedef struct __SOUND_VERSION__ |
| 0 | 134 { |
| 135 int major; | |
| 136 int minor; | |
| 137 int patch; | |
| 138 } Sound_Version; | |
| 139 | |
| 140 | |
| 141 | |
| 142 /* functions and macros... */ | |
| 143 | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
144 #define SOUND_VER_MAJOR 0 |
|
15
4368fdb091b1
Upped version to 0.1.0.
Ryan C. Gordon <icculus@icculus.org>
parents:
11
diff
changeset
|
145 #define SOUND_VER_MINOR 1 |
|
4368fdb091b1
Upped version to 0.1.0.
Ryan C. Gordon <icculus@icculus.org>
parents:
11
diff
changeset
|
146 #define SOUND_VER_PATCH 0 |
| 0 | 147 |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
148 #define SOUND_VERSION(x) { \ |
|
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
149 (x)->major = SOUND_VER_MAJOR; \ |
|
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
150 (x)->minor = SOUND_VER_MINOR; \ |
|
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
151 (x)->patch = SOUND_VER_PATCH; \ |
| 0 | 152 } |
| 153 | |
| 154 /** | |
| 155 * Get the version of SDL_sound that is linked against your program. If you | |
| 156 * are using a shared library (DLL) version of SDL_sound, then it is possible | |
| 157 * that it will be different than the version you compiled against. | |
| 158 * | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
159 * This is a real function; the macro SOUND_VERSION tells you what version |
| 0 | 160 * of SDL_sound you compiled against: |
| 161 * | |
| 162 * Sound_Version compiled; | |
| 163 * Sound_Version linked; | |
| 164 * | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
165 * SOUND_VERSION(&compiled); |
| 0 | 166 * Sound_GetLinkedVersion(&linked); |
| 167 * printf("We compiled against SDL_sound version %d.%d.%d ...\n", | |
| 168 * compiled.major, compiled.minor, compiled.patch); | |
| 169 * printf("But we linked against SDL_sound version %d.%d.%d.\n", | |
| 170 * linked.major, linked.minor, linked.patch); | |
| 171 * | |
| 172 * This function may be called safely at any time, even before Sound_Init(). | |
| 173 */ | |
| 174 extern DECLSPEC void Sound_GetLinkedVersion(Sound_Version *ver); | |
| 175 | |
| 176 | |
| 177 /** | |
| 178 * Initialize SDL_sound. This must be called before any other SDL_sound | |
| 179 * function (except perhaps Sound_GetLinkedVersion()). You should call | |
| 180 * SDL_Init() before calling this. Sound_Init() will attempt to call | |
| 181 * SDL_Init(SDL_INIT_AUDIO), just in case. This is a safe behaviour, but it | |
| 182 * may not configure SDL to your liking by itself. | |
| 183 * | |
| 184 * @return nonzero on success, zero on error. Specifics of the error can be | |
| 185 * gleaned from Sound_GetLastError(). | |
| 186 */ | |
| 187 extern DECLSPEC int Sound_Init(void); | |
| 188 | |
| 189 | |
| 190 /** | |
| 191 * Shutdown SDL_sound. This closes any SDL_RWops that were being used as | |
| 192 * sound sources, and frees any resources in use by SDL_sound. | |
| 193 * | |
| 194 * All Sound_Sample pointers you had prior to this call are INVALIDATED. | |
| 195 * | |
| 196 * Once successfully deinitialized, Sound_Init() can be called again to | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
197 * restart the subsystem. All default API states are restored at this |
| 0 | 198 * point. |
| 199 * | |
| 200 * You should call this BEFORE SDL_Quit(). This will NOT call SDL_Quit() | |
| 201 * for you! | |
| 202 * | |
| 203 * @return nonzero on success, zero on error. Specifics of the error can be | |
| 204 * gleaned from Sound_GetLastError(). If failure, state of SDL_sound | |
| 205 * is undefined, and probably badly screwed up. | |
| 206 */ | |
| 207 extern DECLSPEC int Sound_Quit(void); | |
| 208 | |
| 209 | |
| 210 /** | |
| 211 * Get a list of sound formats supported by this implementation of SDL_sound. | |
| 212 * This is for informational purposes only. Note that the extension listed is | |
| 11 | 213 * merely convention: if we list "MP3", you can open an MPEG-1 Layer 3 audio |
| 0 | 214 * file with an extension of "XYZ", if you like. The file extensions are |
| 215 * informational, and only required as a hint to choosing the correct | |
| 216 * decoder, since the sound data may not be coming from a file at all, thanks | |
| 217 * to the abstraction that an SDL_RWops provides. | |
| 218 * | |
| 219 * The returned value is an array of pointers to Sound_DecoderInfo structures, | |
| 220 * with a NULL entry to signify the end of the list: | |
| 221 * | |
| 222 * Sound_DecoderInfo **i; | |
| 223 * | |
| 224 * for (i = Sound_AvailableDecoders(); *i != NULL; i++) | |
| 225 * { | |
| 226 * printf("Supported sound format: [%s], which is [%s].\n", | |
| 227 * i->extension, i->description); | |
| 228 * // ...and other fields... | |
| 229 * } | |
| 230 * | |
| 231 * The return values are pointers to static internal memory, and should | |
| 232 * be considered READ ONLY, and never freed. | |
| 233 * | |
| 234 * @return READ ONLY Null-terminated array of READ ONLY structures. | |
| 235 */ | |
| 236 extern DECLSPEC const Sound_DecoderInfo **Sound_AvailableDecoders(void); | |
| 237 | |
| 238 | |
| 239 /** | |
| 240 * Get the last SDL_sound error message as a null-terminated string. | |
| 241 * This will be NULL if there's been no error since the last call to this | |
| 242 * function. The pointer returned by this call points to an internal buffer. | |
| 243 * Each thread has a unique error state associated with it, but each time | |
| 244 * a new error message is set, it will overwrite the previous one associated | |
| 245 * with that thread. It is safe to call this function at anytime, even | |
| 246 * before Sound_Init(). | |
| 247 * | |
| 248 * @return READ ONLY string of last error message. | |
| 249 */ | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
250 extern DECLSPEC const char *Sound_GetError(void); |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
251 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
252 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
253 /** |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
254 * Clear the current error message, so the next call to Sound_GetError() will |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
255 * return NULL. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
256 */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
257 extern DECLSPEC void Sound_ClearError(void); |
| 0 | 258 |
| 259 | |
| 260 /** | |
| 261 * Start decoding a new sound sample. The data is read via an SDL_RWops | |
| 262 * structure (see SDL_rwops.h in the SDL include directory), so it may be | |
| 263 * coming from memory, disk, network stream, etc. The (ext) parameter is | |
| 264 * merely a hint to determining the correct decoder; if you specify, for | |
| 265 * example, "mp3" for an extension, and one of the decoders lists that | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
266 * as a handled extension, then that decoder is given first shot at trying |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
267 * to claim the data for decoding. If none of the extensions match (or the |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
268 * extension is NULL), then every decoder examines the data to determine if |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
269 * it can handle it, until one accepts it. In such a case your SDL_RWops will |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
270 * need to be capable of rewinding to the start of the stream. |
| 0 | 271 * If no decoders can handle the data, a NULL value is returned, and a human |
| 272 * readable error message can be fetched from Sound_GetLastError(). | |
| 273 * Optionally, a desired audio format can be specified. If the incoming data | |
| 274 * is in a different format, SDL_sound will convert it to the desired format | |
| 275 * on the fly. Note that this can be an expensive operation, so it may be | |
| 276 * wise to convert data before you need to play it back, if possible, or | |
| 277 * make sure your data is initially in the format that you need it in. | |
| 278 * If you don't want to convert the data, you can specify NULL for a desired | |
| 279 * format. The incoming format of the data, preconversion, can be found | |
| 280 * in the Sound_Sample structure. | |
| 281 * Note that the raw sound data "decoder" needs you to specify both the | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
282 * extension "RAW" and a "desired" format, or it will refuse to handle |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
283 * the data. This is to prevent it from catching all formats unsupported |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
284 * by the other decoders. |
| 0 | 285 * Finally, specify an initial buffer size; this is the number of bytes that |
| 286 * will be allocated to store each read from the sound buffer. The more you | |
| 287 * can safely allocate, the more decoding can be done in one block, but the | |
| 288 * more resources you have to use up, and the longer each decoding call will | |
| 289 * take. Note that different data formats require more or less space to | |
| 290 * store. This buffer can be resized via Sound_SetBufferSize() ... | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
291 * The buffer size specified must be a multiple of the size of a single |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
292 * sample (not to be confused with a single Sound_Sample). So, if you want |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
293 * 16-bit, stereo samples, then your sample size is (2 channels * 16 bits), |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
294 * or 32 bits per sample, which is four bytes. In such a case, you could |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
295 * specify 128 or 132 bytes for a buffer, but not 129, 130, or 131, although |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
296 * in reality, you'll want to specify a MUCH larger buffer. |
| 0 | 297 * When you are done with this Sound_Sample pointer, you can dispose of it |
| 298 * via Sound_FreeSample(). | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
299 * You do not have to keep a reference to (rw) around. If this function |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
300 * suceeds, it stores (rw) internally (and disposes of it during the call |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
301 * to Sound_FreeSample()). If this function fails, it will dispose of the |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
302 * SDL_RWops for you. |
| 0 | 303 * |
| 304 * @param rw SDL_RWops with sound data. | |
| 305 * @param ext File extension normally associated with a data format. | |
| 306 * Can usually be NULL. | |
| 307 * @param desired Format to convert sound data into. Can usually be NULL, | |
| 308 * if you don't need conversion. | |
| 309 * @return Sound_Sample pointer, which is used as a handle to several other | |
| 310 * SDL_sound APIs. NULL on error. If error, use | |
| 311 * Sound_GetLastError() to see what went wrong. | |
| 312 */ | |
| 313 extern DECLSPEC Sound_Sample *Sound_NewSample(SDL_RWops *rw, const char *ext, | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
314 Sound_AudioInfo *desired, |
| 0 | 315 Uint32 bufferSize); |
| 316 | |
| 317 /** | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
318 * This is identical to Sound_NewSample(), but it creates an SDL_RWops for you |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
319 * from the file located in (filename). Note that (filename) is specified in |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
320 * platform-dependent notation. ("C:\\music\\mysong.mp3" on windows, and |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
321 * "/home/icculus/music/mysong.mp3" or whatever on Unix, etc.) |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
322 * Sound_NewSample()'s "ext" parameter is gleaned from the contents of |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
323 * (filename). |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
324 * |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
325 * @param filename file containing sound data. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
326 * @param desired Format to convert sound data into. Can usually be NULL, |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
327 * if you don't need conversion. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
328 * @param bufferSize size, in bytes, of initial read buffer. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
329 * @return Sound_Sample pointer, which is used as a handle to several other |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
330 * SDL_sound APIs. NULL on error. If error, use |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
331 * Sound_GetLastError() to see what went wrong. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
332 */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
333 extern DECLSPEC Sound_Sample *Sound_NewSampleFromFile(const char *filename, |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
334 Sound_AudioInfo *desired, |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
335 Uint32 bufferSize); |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
336 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
337 /** |
| 0 | 338 * Dispose of a Sound_Sample pointer that was returned from Sound_NewSample(). |
| 339 * This will also close/dispose of the SDL_RWops that was used at creation | |
| 340 * time, so there's no need to keep a reference to that around. | |
| 341 * The Sound_Sample pointer is invalid after this call, and will almost | |
| 342 * certainly result in a crash if you attempt to keep using it. | |
| 343 * | |
| 344 * @param sample The Sound_Sample to delete. | |
| 345 */ | |
| 346 extern DECLSPEC void Sound_FreeSample(Sound_Sample *sample); | |
| 347 | |
| 348 | |
| 349 /** | |
|
3
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
350 * Change the current buffer size for a sample. If the buffer size could |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
351 * be changed, then the sample->buffer and sample->buffer_size fields will |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
352 * reflect that. If they could not be changed, then your original sample |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
353 * state is preserved. If the buffer is shrinking, the data at the end of |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
354 * buffer is truncated. If the buffer is growing, the contents of the new |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
355 * space at the end is undefined until you decode more into it or initialize |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
356 * it yourself. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
357 * |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
358 * The buffer size specified must be a multiple of the size of a single |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
359 * sample (not to be confused with a single Sound_Sample). So, if you want |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
360 * 16-bit, stereo samples, then your sample size is (2 channels * 16 bits), |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
361 * or 32 bits per sample, which is four bytes. In such a case, you could |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
362 * specify 128 or 132 bytes for a buffer, but not 129, 130, or 131, although |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
363 * in reality, you'll want to specify a MUCH larger buffer. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
364 * |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
365 * @param sample The Sound_Sample whose buffer to modify. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
366 * @param new_size The desired size, in bytes, of the new buffer. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
367 * @return non-zero if buffer size changed, zero on failure. |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
368 */ |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
369 extern DECLSPEC int Sound_SetBufferSize(Sound_Sample *sample, Uint32 new_size); |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
370 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
371 |
|
fd6cd0e04e6f
First stab at implementation complete.
Ryan C. Gordon <icculus@icculus.org>
parents:
1
diff
changeset
|
372 /** |
| 0 | 373 * Decode more of the sound data in a Sound_Sample. It will decode at most |
| 374 * sample->buffer_size bytes into sample->buffer in the desired format, and | |
| 375 * return the number of decoded bytes. | |
| 376 * If sample->buffer_size bytes could not be decoded, then please refer to | |
| 377 * sample->flags to determine if this was an End-of-stream or error condition. | |
| 378 * | |
| 379 * @param sample Do more decoding to this Sound_Sample. | |
| 380 * @return number of bytes decoded into sample->buffer. If it is less than | |
| 381 * sample->buffer_size, then you should check sample->flags to see | |
| 382 * what the current state of the sample is (EOF, error, read again). | |
| 383 */ | |
| 384 extern DECLSPEC Uint32 Sound_Decode(Sound_Sample *sample); | |
| 385 | |
| 386 | |
| 387 /** | |
| 388 * Decode the remainder of the sound data in a Sound_Sample. This will | |
| 389 * dynamically allocate memory for the ENTIRE remaining sample. | |
| 390 * sample->buffer_size and sample->buffer will be updated to reflect the | |
| 391 * new buffer. Please refer to sample->flags to determine if the decoding | |
| 392 * finished due to an End-of-stream or error condition. | |
| 393 * | |
| 394 * Be aware that sound data can take a large amount of memory, and that | |
| 395 * this function may block for quite awhile while processing. Also note | |
| 396 * that a streaming source (for example, from a SDL_RWops that is getting | |
| 397 * fed from an Internet radio feed that doesn't end) may fill all available | |
| 398 * memory before giving up...be sure to use this on finite sound sources | |
| 399 * only! | |
| 400 * | |
| 401 * @param sample Do all decoding for this Sound_Sample. | |
| 402 * @return number of bytes decoded into sample->buffer. If it is less than | |
| 403 * sample->buffer_size, then you should check sample->flags to see | |
| 404 * what the current state of the sample is (EOF, error, read again). | |
| 405 */ | |
| 406 extern DECLSPEC Uint32 Sound_DecodeAll(Sound_Sample *sample); | |
| 407 | |
| 408 #ifdef __cplusplus | |
| 409 } | |
| 410 #endif | |
| 411 | |
|
1
508aac690b19
Whoops...changed some overlooked "voice" to "sound".
Ryan C. Gordon <icculus@icculus.org>
parents:
0
diff
changeset
|
412 #endif /* !defined _INCLUDE_SDL_SOUND_H_ */ |
| 0 | 413 |
| 414 /* end of SDL_sound.h ... */ | |
| 415 |