Mercurial > SDL_sound_CoreAudio
annotate SDL_sound_internal.h @ 81:c047ae35d5fa
From Max Horn: fixes header installation.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Tue, 25 Sep 2001 21:00:02 +0000 |
| parents | b13fafb976be |
| children | 6d9fdec2f708 |
| rev | line source |
|---|---|
| 4 | 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 * Internal function/structure declaration. Do NOT include in your | |
| 22 * application. | |
| 23 * | |
| 24 * Please see the file LICENSE in the source's root directory. | |
| 25 * | |
| 26 * This file written by Ryan C. Gordon. (icculus@clutteredmind.org) | |
| 27 */ | |
| 28 | |
| 29 #ifndef _INCLUDE_SDL_SOUND_INTERNAL_H_ | |
| 30 #define _INCLUDE_SDL_SOUND_INTERNAL_H_ | |
| 31 | |
| 32 #ifndef __SDL_SOUND_INTERNAL__ | |
| 33 #error Do not include this header from your applications. | |
| 34 #endif | |
| 35 | |
| 36 #include "SDL.h" | |
| 37 | |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
38 #if (defined DEBUG_CHATTER) |
|
62
b13fafb976be
Changed _D macro to DBGSND.
Ryan C. Gordon <icculus@icculus.org>
parents:
42
diff
changeset
|
39 #define SNDDBG(x) printf x |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
40 #else |
|
62
b13fafb976be
Changed _D macro to DBGSND.
Ryan C. Gordon <icculus@icculus.org>
parents:
42
diff
changeset
|
41 #define SNDDBG(x) |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
42 #endif |
|
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
43 |
| 4 | 44 typedef struct __SOUND_DECODERFUNCTIONS__ |
| 45 { | |
| 46 /* This is a block of info about your decoder. See SDL_sound.h. */ | |
| 47 const Sound_DecoderInfo info; | |
| 48 | |
| 49 /* | |
|
42
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
50 * This is called during the Sound_Init() function. Use this to |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
51 * set up any global state that your decoder needs, such as |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
52 * initializing an external library, etc. |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
53 * |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
54 * Return non-zero if initialization is successful, zero if there's |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
55 * a fatal error. If this method fails, then this decoder is |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
56 * flagged as unavailable until SDL_sound() is shut down and |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
57 * reinitialized, in which case this method will be tried again. |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
58 * |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
59 * Note that the decoders quit() method won't be called if this |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
60 * method fails, so if you can't intialize, you'll have to clean |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
61 * up the half-initialized state in this method. |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
62 */ |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
63 int (*init)(void); |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
64 |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
65 /* |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
66 * This is called during the Sound_Quit() function. Use this to |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
67 * clean up any global state that your decoder has used during its |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
68 * lifespan. |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
69 */ |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
70 void (*quit)(void); |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
71 |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
72 /* |
| 4 | 73 * Returns non-zero if (sample) has a valid fileformat that this |
| 74 * driver can handle. Zero if this driver can NOT handle the data. | |
| 75 * | |
| 76 * Extension, which may be NULL, is just a hint as to the form of | |
| 77 * data that is being passed in. Most decoders should determine if | |
| 78 * they can handle the data by the data itself, but others, like | |
| 79 * the raw data handler, need this hint to know if they should | |
| 80 * accept the data in the first place. | |
| 81 * | |
| 82 * (sample)'s (opaque) field should be cast to a Sound_SampleInternal | |
| 83 * pointer: | |
| 84 * | |
| 85 * Sound_SampleInternal *internal; | |
| 86 * internal = (Sound_SampleInternal *) sample->opaque; | |
| 87 * | |
| 88 * Certain fields of sample will be filled in for the decoder before | |
| 89 * this call, and others should be filled in by the decoder. Some | |
| 90 * fields are offlimits, and should NOT be modified. The list: | |
| 91 * | |
| 92 * in Sound_SampleInternal section: | |
| 93 * Sound_Sample *next; (offlimits) | |
| 94 * Sound_Sample *prev; (offlimits) | |
| 95 * SDL_RWops *rw; (can use, but do NOT close it) | |
| 96 * const Sound_DecoderFunctions *funcs; (that's this structure) | |
| 97 * SDL_AudioCVT sdlcvt; (offlimits) | |
| 98 * void *buffer; (offlimits until read() method) | |
| 99 * Uint32 buffer_size; (offlimits until read() method) | |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
100 * void *decoder_private; (read and write access) |
| 4 | 101 * |
| 102 * in rest of Sound_Sample: | |
| 103 * void *opaque; (this was internal section, above) | |
| 104 * const Sound_DecoderInfo *decoder; (read only) | |
| 105 * Sound_AudioInfo desired; (read only, usually not needed here) | |
| 106 * Sound_AudioInfo actual; (please fill this in) | |
| 107 * void *buffer; (offlimits) | |
| 108 * Uint32 buffer_size; (offlimits) | |
| 109 * Sound_SampleFlags flags; (set appropriately) | |
| 110 */ | |
| 111 int (*open)(Sound_Sample *sample, const char *ext); | |
| 112 | |
| 113 /* | |
| 114 * Clean up. SDL_sound is done with this sample, so the decoder should | |
| 115 * clean up any resources it allocated. Anything that wasn't | |
| 116 * explicitly allocated by the decoder should be LEFT ALONE, since | |
| 117 * the higher-level SDL_sound layer will clean up its own mess. | |
| 118 */ | |
| 119 void (*close)(Sound_Sample *sample); | |
| 120 | |
| 121 /* | |
| 122 * Get more data from (sample). The decoder should get a pointer to | |
| 123 * the internal structure... | |
| 124 * | |
| 125 * Sound_SampleInternal *internal; | |
| 126 * internal = (Sound_SampleInternal *) sample->opaque; | |
| 127 * | |
| 128 * ...and then start decoding. Fill in up to internal->buffer_size | |
| 129 * bytes of decoded sound in the space pointed to by | |
| 130 * internal->buffer. The encoded data is read in from internal->rw. | |
| 131 * Data should be decoded in the format specified during the | |
| 132 * decoder's open() method in the sample->actual field. The | |
| 133 * conversion to the desired format is done at a higher level. | |
| 134 * | |
| 135 * The return value is the number of bytes decoded into | |
| 136 * internal->buffer, which can be no more than internal->buffer_size, | |
| 137 * but can be less. If it is less, you should set a state flag: | |
| 138 * | |
| 139 * If there's just no more data (end of file, etc), then do: | |
| 140 * sample->flags |= SOUND_SAMPLEFLAG_EOF; | |
| 141 * | |
| 142 * If there's an unrecoverable error, then do: | |
| 143 * Sound_SetError(ERR_EXPLAIN_WHAT_WENT_WRONG); | |
| 144 * sample->flags |= SOUND_SAMPLEFLAG_ERROR; | |
| 145 * | |
| 146 * If there's more data, but you'd have to block for considerable | |
| 147 * amounts of time to get at it, or there's a recoverable error, | |
| 148 * then do: | |
| 149 * Sound_SetError(ERR_EXPLAIN_WHAT_WENT_WRONG); | |
| 150 * sample->flags |= SOUND_SAMPLEFLAG_EAGAIN; | |
| 151 * | |
| 152 * SDL_sound will not call your read() method for any samples with | |
| 153 * SOUND_SAMPLEFLAG_EOF or SOUND_SAMPLEFLAG_ERROR set. The | |
| 154 * SOUND_SAMPLEFLAG_EAGAIN flag is reset before each call to this | |
| 155 * method. | |
| 156 */ | |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
157 Uint32 (*read)(Sound_Sample *sample); |
| 4 | 158 } Sound_DecoderFunctions; |
| 159 | |
| 160 | |
| 161 typedef struct __SOUND_SAMPLEINTERNAL__ | |
| 162 { | |
| 163 Sound_Sample *next; | |
| 164 Sound_Sample *prev; | |
| 165 SDL_RWops *rw; | |
| 166 const Sound_DecoderFunctions *funcs; | |
| 167 SDL_AudioCVT sdlcvt; | |
| 168 void *buffer; | |
| 169 Uint32 buffer_size; | |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
170 void *decoder_private; |
| 4 | 171 } Sound_SampleInternal; |
| 172 | |
| 173 | |
| 174 | |
| 175 /* error messages... */ | |
| 176 #define ERR_IS_INITIALIZED "Already initialized" | |
| 177 #define ERR_NOT_INITIALIZED "Not initialized" | |
| 178 #define ERR_INVALID_ARGUMENT "Invalid argument" | |
| 179 #define ERR_OUT_OF_MEMORY "Out of memory" | |
| 180 #define ERR_NOT_SUPPORTED "Operation not supported" | |
| 181 #define ERR_UNSUPPORTED_FORMAT "Sound format unsupported" | |
| 182 #define ERR_NOT_A_HANDLE "Not a file handle" | |
| 183 #define ERR_NO_SUCH_FILE "No such file" | |
| 184 #define ERR_PAST_EOF "Past end of file" | |
| 185 #define ERR_IO_ERROR "I/O error" | |
| 186 #define ERR_COMPRESSION "(De)compression error" | |
| 187 #define ERR_PREV_ERROR "Previous decoding already caused an error" | |
| 188 #define ERR_PREV_EOF "Previous decoding already triggered EOF" | |
| 189 | |
| 190 /* | |
| 191 * Call this to set the message returned by Sound_GetError(). | |
| 192 * Please only use the ERR_* constants above, or add new constants to the | |
| 193 * above group, but I want these all in one place. | |
| 194 * | |
| 195 * Calling this with a NULL argument is a safe no-op. | |
| 196 */ | |
| 197 void Sound_SetError(const char *err); | |
| 198 | |
| 199 | |
| 200 /* | |
| 201 * Use this if you need a cross-platform stricmp(). | |
| 202 */ | |
| 203 int __Sound_strcasecmp(const char *x, const char *y); | |
| 204 | |
| 205 | |
| 206 /* These get used all over for lessening code clutter. */ | |
| 207 #define BAIL_MACRO(e, r) { Sound_SetError(e); return r; } | |
| 208 #define BAIL_IF_MACRO(c, e, r) if (c) { Sound_SetError(e); return r; } | |
| 209 | |
| 210 | |
| 211 | |
| 212 | |
| 213 /*--------------------------------------------------------------------------*/ | |
| 214 /*--------------------------------------------------------------------------*/ | |
| 215 /*------------ ----------------*/ | |
| 216 /*------------ You MUST implement the following functions ----------------*/ | |
| 217 /*------------ if porting to a new platform. ----------------*/ | |
| 218 /*------------ (see platform/unix.c for an example) ----------------*/ | |
| 219 /*------------ ----------------*/ | |
| 220 /*--------------------------------------------------------------------------*/ | |
| 221 /*--------------------------------------------------------------------------*/ | |
| 222 | |
| 223 | |
| 224 /* (None, right now.) */ | |
| 225 | |
| 226 | |
| 227 #ifdef __cplusplus | |
| 228 extern "C" { | |
| 229 #endif | |
| 230 | |
| 231 #endif /* defined _INCLUDE_SDL_SOUND_INTERNAL_H_ */ | |
| 232 | |
| 233 /* end of SDL_sound_internal.h ... */ | |
| 234 |