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