Mercurial > SDL_sound_CoreAudio
annotate SDL_sound_internal.h @ 377:cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Tue, 02 Jul 2002 03:58:24 +0000 |
| parents | 5a72981b8cba |
| children | fb519e6028e3 |
| 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 * | |
|
184
47cc2de2ae36
Changed reference to "LICENSE" file to "COPYING".
Ryan C. Gordon <icculus@icculus.org>
parents:
143
diff
changeset
|
24 * Please see the file COPYING in the source's root directory. |
| 4 | 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 | |
| 322 | 38 #if (defined(_MSC_VER) && !defined(inline)) |
| 301 | 39 # define inline __inline__ |
| 40 #endif | |
| 41 | |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
42 #if (defined DEBUG_CHATTER) |
|
62
b13fafb976be
Changed _D macro to DBGSND.
Ryan C. Gordon <icculus@icculus.org>
parents:
42
diff
changeset
|
43 #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
|
44 #else |
|
62
b13fafb976be
Changed _D macro to DBGSND.
Ryan C. Gordon <icculus@icculus.org>
parents:
42
diff
changeset
|
45 #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
|
46 #endif |
|
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
47 |
|
377
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
48 #if HAVE_ASSERT_H |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
49 # include <assert.h> |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
50 #endif |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
51 |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
52 #ifdef _WIN32_WCE |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
53 extern char *strrchr(const char *s, int c); |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
54 # ifdef NDEBUG |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
55 # define assert(x) |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
56 # else |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
57 # define assert(x) if(!x) { fprintf(stderr,"Assertion failed in %s, line %s.\n",__FILE__,__LINE__); fclose(stderr); fclose(stdout); exit(1); } |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
58 # endif |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
59 #endif |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
60 |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
61 |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
62 #if (!defined assert) /* if all else fails. */ |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
63 # define assert(x) |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
64 #endif |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
65 |
|
cbb15ecf423a
WinCE (PocketPC) patches from Tyler.
Ryan C. Gordon <icculus@icculus.org>
parents:
340
diff
changeset
|
66 |
| 4 | 67 typedef struct __SOUND_DECODERFUNCTIONS__ |
| 68 { | |
| 69 /* This is a block of info about your decoder. See SDL_sound.h. */ | |
| 70 const Sound_DecoderInfo info; | |
| 71 | |
| 72 /* | |
|
42
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
73 * 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
|
74 * 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
|
75 * 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
|
76 * |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
77 * 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
|
78 * 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
|
79 * 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
|
80 * 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
|
81 * |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
82 * 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
|
83 * 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
|
84 * 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
|
85 */ |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
86 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
|
87 |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
88 /* |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
89 * 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
|
90 * 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
|
91 * lifespan. |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
92 */ |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
93 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
|
94 |
|
2b63642fb6ff
Removed MULTIPLE_STREAMS_PER_RWOPS and added init() and quit() methods to
Ryan C. Gordon <icculus@icculus.org>
parents:
39
diff
changeset
|
95 /* |
| 4 | 96 * Returns non-zero if (sample) has a valid fileformat that this |
| 97 * driver can handle. Zero if this driver can NOT handle the data. | |
| 98 * | |
| 99 * Extension, which may be NULL, is just a hint as to the form of | |
| 100 * data that is being passed in. Most decoders should determine if | |
| 101 * they can handle the data by the data itself, but others, like | |
| 102 * the raw data handler, need this hint to know if they should | |
| 103 * accept the data in the first place. | |
| 104 * | |
| 105 * (sample)'s (opaque) field should be cast to a Sound_SampleInternal | |
| 106 * pointer: | |
| 107 * | |
| 108 * Sound_SampleInternal *internal; | |
| 109 * internal = (Sound_SampleInternal *) sample->opaque; | |
| 110 * | |
| 111 * Certain fields of sample will be filled in for the decoder before | |
| 112 * this call, and others should be filled in by the decoder. Some | |
| 113 * fields are offlimits, and should NOT be modified. The list: | |
| 114 * | |
| 115 * in Sound_SampleInternal section: | |
| 116 * Sound_Sample *next; (offlimits) | |
| 117 * Sound_Sample *prev; (offlimits) | |
| 118 * SDL_RWops *rw; (can use, but do NOT close it) | |
| 119 * const Sound_DecoderFunctions *funcs; (that's this structure) | |
|
143
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
120 * Sound_AudioCVT sdlcvt; (offlimits) |
| 4 | 121 * void *buffer; (offlimits until read() method) |
| 122 * 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
|
123 * void *decoder_private; (read and write access) |
| 4 | 124 * |
| 125 * in rest of Sound_Sample: | |
| 126 * void *opaque; (this was internal section, above) | |
| 127 * const Sound_DecoderInfo *decoder; (read only) | |
| 128 * Sound_AudioInfo desired; (read only, usually not needed here) | |
| 129 * Sound_AudioInfo actual; (please fill this in) | |
| 130 * void *buffer; (offlimits) | |
| 131 * Uint32 buffer_size; (offlimits) | |
| 132 * Sound_SampleFlags flags; (set appropriately) | |
| 133 */ | |
| 134 int (*open)(Sound_Sample *sample, const char *ext); | |
| 135 | |
| 136 /* | |
| 137 * Clean up. SDL_sound is done with this sample, so the decoder should | |
| 138 * clean up any resources it allocated. Anything that wasn't | |
| 139 * explicitly allocated by the decoder should be LEFT ALONE, since | |
| 140 * the higher-level SDL_sound layer will clean up its own mess. | |
| 141 */ | |
| 142 void (*close)(Sound_Sample *sample); | |
| 143 | |
| 144 /* | |
| 145 * Get more data from (sample). The decoder should get a pointer to | |
| 146 * the internal structure... | |
| 147 * | |
| 148 * Sound_SampleInternal *internal; | |
| 149 * internal = (Sound_SampleInternal *) sample->opaque; | |
| 150 * | |
| 151 * ...and then start decoding. Fill in up to internal->buffer_size | |
| 152 * bytes of decoded sound in the space pointed to by | |
| 153 * internal->buffer. The encoded data is read in from internal->rw. | |
| 154 * Data should be decoded in the format specified during the | |
| 155 * decoder's open() method in the sample->actual field. The | |
| 156 * conversion to the desired format is done at a higher level. | |
| 157 * | |
| 158 * The return value is the number of bytes decoded into | |
| 159 * internal->buffer, which can be no more than internal->buffer_size, | |
| 160 * but can be less. If it is less, you should set a state flag: | |
| 161 * | |
| 162 * If there's just no more data (end of file, etc), then do: | |
| 163 * sample->flags |= SOUND_SAMPLEFLAG_EOF; | |
| 164 * | |
| 165 * If there's an unrecoverable error, then do: | |
| 166 * Sound_SetError(ERR_EXPLAIN_WHAT_WENT_WRONG); | |
| 167 * sample->flags |= SOUND_SAMPLEFLAG_ERROR; | |
| 168 * | |
| 169 * If there's more data, but you'd have to block for considerable | |
| 170 * amounts of time to get at it, or there's a recoverable error, | |
| 171 * then do: | |
| 172 * Sound_SetError(ERR_EXPLAIN_WHAT_WENT_WRONG); | |
| 173 * sample->flags |= SOUND_SAMPLEFLAG_EAGAIN; | |
| 174 * | |
| 175 * SDL_sound will not call your read() method for any samples with | |
| 176 * SOUND_SAMPLEFLAG_EOF or SOUND_SAMPLEFLAG_ERROR set. The | |
| 177 * SOUND_SAMPLEFLAG_EAGAIN flag is reset before each call to this | |
| 178 * method. | |
| 179 */ | |
|
12
2888101dcf98
Added _D(()) macro, decoder_private field, and changed read() method from
Ryan C. Gordon <icculus@icculus.org>
parents:
4
diff
changeset
|
180 Uint32 (*read)(Sound_Sample *sample); |
|
223
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
181 |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
182 /* |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
183 * Reset the decoding to the beginning of the stream. Nonzero on |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
184 * success, zero on failure. |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
185 * |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
186 * The purpose of this method is to allow for higher efficiency than |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
187 * an application could get by just recreating the sample externally; |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
188 * not only do they not have to reopen the RWops, reallocate buffers, |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
189 * and potentially pass the data through several rejecting decoders, |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
190 * but certain decoders will not have to recreate their existing |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
191 * state (search for metadata, etc) since they already know they |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
192 * have a valid audio stream with a given set of characteristics. |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
193 * |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
194 * The decoder is responsible for calling seek() on the associated |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
195 * SDL_RWops. A failing call to seek() should be the ONLY reason that |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
196 * this method should ever fail! |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
197 */ |
|
249186e31431
Sound_Rewind() support code.
Ryan C. Gordon <icculus@icculus.org>
parents:
184
diff
changeset
|
198 int (*rewind)(Sound_Sample *sample); |
|
306
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
199 |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
200 /* |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
201 * Reposition the decoding to an arbitrary point. Nonzero on |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
202 * success, zero on failure. |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
203 * |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
204 * The purpose of this method is to allow for higher efficiency than |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
205 * an application could get by just rewinding the sample and |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
206 * decoding to a given point. |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
207 * |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
208 * The decoder is responsible for calling seek() on the associated |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
209 * SDL_RWops. |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
210 * |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
211 * If there is an error, try to recover so that the next read will |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
212 * continue as if nothing happened. |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
213 */ |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
214 int (*seek)(Sound_Sample *sample, Uint32 ms); |
| 4 | 215 } Sound_DecoderFunctions; |
| 216 | |
| 217 | |
|
143
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
218 /* A structure to hold a set of audio conversion filters and buffers */ |
|
340
5a72981b8cba
Added optional, experimental audio conversion routines by Frank Ranostaj.
Ryan C. Gordon <icculus@icculus.org>
parents:
322
diff
changeset
|
219 #if (defined SOUND_USE_ALTCVT) |
|
5a72981b8cba
Added optional, experimental audio conversion routines by Frank Ranostaj.
Ryan C. Gordon <icculus@icculus.org>
parents:
322
diff
changeset
|
220 #include "alt_audio_convert.h" |
|
5a72981b8cba
Added optional, experimental audio conversion routines by Frank Ranostaj.
Ryan C. Gordon <icculus@icculus.org>
parents:
322
diff
changeset
|
221 #else |
|
143
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
222 typedef struct Sound_AudioCVT |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
223 { |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
224 int needed; /* Set to 1 if conversion possible */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
225 Uint16 src_format; /* Source audio format */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
226 Uint16 dst_format; /* Target audio format */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
227 double rate_incr; /* Rate conversion increment */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
228 Uint8 *buf; /* Buffer to hold entire audio data */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
229 int len; /* Length of original audio buffer */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
230 int len_cvt; /* Length of converted audio buffer */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
231 int len_mult; /* buffer must be len*len_mult big */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
232 double len_ratio; /* Given len, final size is len*len_ratio */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
233 void (*filters[20])(struct Sound_AudioCVT *cvt, Uint16 *format); |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
234 int filter_index; /* Current audio conversion function */ |
|
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
235 } Sound_AudioCVT; |
|
340
5a72981b8cba
Added optional, experimental audio conversion routines by Frank Ranostaj.
Ryan C. Gordon <icculus@icculus.org>
parents:
322
diff
changeset
|
236 #endif |
|
143
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
237 |
| 4 | 238 typedef struct __SOUND_SAMPLEINTERNAL__ |
| 239 { | |
| 240 Sound_Sample *next; | |
| 241 Sound_Sample *prev; | |
| 242 SDL_RWops *rw; | |
| 243 const Sound_DecoderFunctions *funcs; | |
|
143
3e60862fbd76
Start of audio converter work.
Ryan C. Gordon <icculus@icculus.org>
parents:
107
diff
changeset
|
244 Sound_AudioCVT sdlcvt; |
| 4 | 245 void *buffer; |
| 246 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
|
247 void *decoder_private; |
| 4 | 248 } Sound_SampleInternal; |
| 249 | |
| 250 | |
| 251 /* error messages... */ | |
| 252 #define ERR_IS_INITIALIZED "Already initialized" | |
| 253 #define ERR_NOT_INITIALIZED "Not initialized" | |
| 254 #define ERR_INVALID_ARGUMENT "Invalid argument" | |
| 255 #define ERR_OUT_OF_MEMORY "Out of memory" | |
| 256 #define ERR_NOT_SUPPORTED "Operation not supported" | |
| 257 #define ERR_UNSUPPORTED_FORMAT "Sound format unsupported" | |
| 258 #define ERR_NOT_A_HANDLE "Not a file handle" | |
| 259 #define ERR_NO_SUCH_FILE "No such file" | |
| 260 #define ERR_PAST_EOF "Past end of file" | |
| 261 #define ERR_IO_ERROR "I/O error" | |
| 262 #define ERR_COMPRESSION "(De)compression error" | |
| 263 #define ERR_PREV_ERROR "Previous decoding already caused an error" | |
| 264 #define ERR_PREV_EOF "Previous decoding already triggered EOF" | |
|
306
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
265 #define ERR_CANNOT_SEEK "Sample is not seekable" |
| 4 | 266 |
| 267 /* | |
| 268 * Call this to set the message returned by Sound_GetError(). | |
| 269 * Please only use the ERR_* constants above, or add new constants to the | |
| 270 * above group, but I want these all in one place. | |
| 271 * | |
| 272 * Calling this with a NULL argument is a safe no-op. | |
| 273 */ | |
|
306
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
274 void __Sound_SetError(const char *err); |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
275 |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
276 /* !!! FIXME: Clean up elsewhere and get rid of this. */ |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
277 #define Sound_SetError __Sound_SetError |
| 4 | 278 |
|
306
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
279 /* |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
280 * Call this to convert milliseconds to an actual byte position, based on |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
281 * audio data characteristics. |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
282 */ |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
283 Uint32 __Sound_convertMsToBytePos(Sound_AudioInfo *info, Uint32 ms); |
| 4 | 284 |
| 285 /* | |
| 286 * Use this if you need a cross-platform stricmp(). | |
| 287 */ | |
| 288 int __Sound_strcasecmp(const char *x, const char *y); | |
| 289 | |
| 290 | |
| 291 /* These get used all over for lessening code clutter. */ | |
|
306
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
292 #define BAIL_MACRO(e, r) { __Sound_SetError(e); return r; } |
|
c97be6e1bd27
Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents:
301
diff
changeset
|
293 #define BAIL_IF_MACRO(c, e, r) if (c) { __Sound_SetError(e); return r; } |
| 4 | 294 |
| 295 | |
| 296 | |
| 297 | |
| 298 /*--------------------------------------------------------------------------*/ | |
| 299 /*--------------------------------------------------------------------------*/ | |
| 300 /*------------ ----------------*/ | |
| 301 /*------------ You MUST implement the following functions ----------------*/ | |
| 302 /*------------ if porting to a new platform. ----------------*/ | |
| 303 /*------------ (see platform/unix.c for an example) ----------------*/ | |
| 304 /*------------ ----------------*/ | |
| 305 /*--------------------------------------------------------------------------*/ | |
| 306 /*--------------------------------------------------------------------------*/ | |
| 307 | |
| 308 | |
| 309 /* (None, right now.) */ | |
| 310 | |
| 311 | |
| 312 #ifdef __cplusplus | |
| 313 extern "C" { | |
| 314 #endif | |
| 315 | |
| 316 #endif /* defined _INCLUDE_SDL_SOUND_INTERNAL_H_ */ | |
| 317 | |
| 318 /* end of SDL_sound_internal.h ... */ | |
| 319 |