Mercurial > SDL_sound_CoreAudio
annotate decoders/ogg.c @ 207:857e53c5a2da
Renamed from mod.c (see modplug.c for the OTHER mod decoder).
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Thu, 10 Jan 2002 01:16:24 +0000 |
| parents | 47cc2de2ae36 |
| children | c9772a9f5271 |
| rev | line source |
|---|---|
| 24 | 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 * Ogg Vorbis decoder for SDL_sound. | |
| 22 * | |
| 23 * This driver handles .OGG audio files, and depends on libvorbisfile to | |
| 24 * do the actual decoding work. libvorbisfile is part of libvorbis, which | |
| 25 * is part of the Ogg Vorbis project. | |
| 26 * | |
| 27 * Ogg Vorbis: http://www.xiph.org/ogg/vorbis/ | |
| 28 * vorbisfile documentation: http://www.xiph.org/ogg/vorbis/doc/vorbisfile/ | |
| 29 * | |
|
184
47cc2de2ae36
Changed reference to "LICENSE" file to "COPYING".
Ryan C. Gordon <icculus@icculus.org>
parents:
149
diff
changeset
|
30 * Please see the file COPYING in the source's root directory. |
| 24 | 31 * |
| 32 * This file written by Ryan C. Gordon. (icculus@clutteredmind.org) | |
| 33 */ | |
| 34 | |
|
106
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
35 #if HAVE_CONFIG_H |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
36 # include <config.h> |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
37 #endif |
|
100
6d9fdec2f708
added config.h, added --enable-debug flag, various other changes to the build system
fingolfin
parents:
63
diff
changeset
|
38 |
|
104
103cfcb3c014
Updated to fix build system problem.
Ryan C. Gordon <icculus@icculus.org>
parents:
100
diff
changeset
|
39 #ifdef SOUND_SUPPORTS_OGG |
|
103cfcb3c014
Updated to fix build system problem.
Ryan C. Gordon <icculus@icculus.org>
parents:
100
diff
changeset
|
40 |
| 24 | 41 #include <stdio.h> |
| 42 #include <stdlib.h> | |
| 43 #include <string.h> | |
| 44 #include <math.h> | |
| 45 #include <assert.h> | |
|
106
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
46 |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
47 #include "SDL_sound.h" |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
48 |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
49 #define __SDL_SOUND_INTERNAL__ |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
50 #include "SDL_sound_internal.h" |
|
40de367eb59e
Changing my include structure to do this right.
Ryan C. Gordon <icculus@icculus.org>
parents:
104
diff
changeset
|
51 |
| 24 | 52 #include "vorbis/codec.h" |
| 53 #include "vorbis/vorbisfile.h" | |
| 54 | |
| 55 | |
|
47
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
56 static int OGG_init(void); |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
57 static void OGG_quit(void); |
| 24 | 58 static int OGG_open(Sound_Sample *sample, const char *ext); |
| 59 static void OGG_close(Sound_Sample *sample); | |
| 60 static Uint32 OGG_read(Sound_Sample *sample); | |
| 61 | |
|
149
1df5c106504e
Decoders can now list multiple file extensions.
Ryan C. Gordon <icculus@icculus.org>
parents:
122
diff
changeset
|
62 static const char *extensions_ogg[] = { "OGG", NULL }; |
| 24 | 63 const Sound_DecoderFunctions __Sound_DecoderFunctions_OGG = |
| 64 { | |
| 65 { | |
|
149
1df5c106504e
Decoders can now list multiple file extensions.
Ryan C. Gordon <icculus@icculus.org>
parents:
122
diff
changeset
|
66 extensions_ogg, |
| 24 | 67 "Ogg Vorbis audio through VorbisFile", |
| 68 "Ryan C. Gordon <icculus@clutteredmind.org>", | |
| 69 "http://www.icculus.org/SDL_sound/" | |
| 70 }, | |
| 71 | |
|
47
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
72 OGG_init, /* init() method */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
73 OGG_quit, /* quit() method */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
74 OGG_open, /* open() method */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
75 OGG_close, /* close() method */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
76 OGG_read /* read() method */ |
| 24 | 77 }; |
| 78 | |
| 79 | |
|
47
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
80 static int OGG_init(void) |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
81 { |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
82 return(1); /* always succeeds. */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
83 } /* OGG_init */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
84 |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
85 |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
86 static void OGG_quit(void) |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
87 { |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
88 /* it's a no-op. */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
89 } /* OGG_quit */ |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
90 |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
91 |
|
ea58bc3b15d7
Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents:
24
diff
changeset
|
92 |
| 24 | 93 /* |
| 94 * These are callbacks from vorbisfile that let them read data from | |
| 95 * a RWops... | |
| 96 */ | |
| 97 | |
|
63
9669aa13d3e0
Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents:
59
diff
changeset
|
98 static size_t RWops_ogg_read(void *ptr, size_t size, size_t nmemb, void *datasource) |
| 24 | 99 { |
| 100 return((size_t) SDL_RWread((SDL_RWops *) datasource, ptr, size, nmemb)); | |
| 101 } /* RWops_ogg_read */ | |
| 102 | |
| 122 | 103 static int RWops_ogg_seek(void *datasource, ogg_int64_t offset, int whence) |
| 24 | 104 { |
| 105 return(SDL_RWseek((SDL_RWops *) datasource, offset, whence)); | |
| 106 } /* RWops_ogg_seek */ | |
| 107 | |
|
63
9669aa13d3e0
Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents:
59
diff
changeset
|
108 static int RWops_ogg_close(void *datasource) |
| 24 | 109 { |
| 110 /* do nothing; SDL_sound will delete the RWops at a higher level. */ | |
| 111 return(0); /* this is success in fclose(), so I guess that's okay. */ | |
| 112 } /* RWops_ogg_close */ | |
| 113 | |
|
63
9669aa13d3e0
Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents:
59
diff
changeset
|
114 static long RWops_ogg_tell(void *datasource) |
| 24 | 115 { |
| 116 return((long) SDL_RWtell((SDL_RWops *) datasource)); | |
| 117 } /* RWops_ogg_tell */ | |
| 118 | |
| 119 static const ov_callbacks RWops_ogg_callbacks = | |
| 120 { | |
| 121 RWops_ogg_read, | |
| 122 RWops_ogg_seek, | |
| 123 RWops_ogg_close, | |
| 124 RWops_ogg_tell | |
| 125 }; | |
| 126 | |
| 127 | |
| 128 /* Return a human readable version of an VorbisFile error code... */ | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
129 #if (defined DEBUG_CHATTER) |
| 24 | 130 static const char *ogg_error(int errnum) |
| 131 { | |
| 132 switch(errnum) | |
| 133 { | |
| 134 case OV_EREAD: | |
| 135 return("i/o error"); | |
| 136 case OV_ENOTVORBIS: | |
| 137 return("not a vorbis file"); | |
| 138 case OV_EVERSION: | |
| 139 return("Vorbis version mismatch"); | |
| 140 case OV_EBADHEADER: | |
| 141 return("invalid Vorbis bitstream header"); | |
| 142 case OV_EFAULT: | |
| 143 return("internal logic fault in Vorbis library"); | |
| 144 } /* switch */ | |
| 145 | |
| 146 return("unknown error"); | |
| 147 } /* ogg_error */ | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
148 #endif |
| 24 | 149 |
| 150 static __inline__ void output_ogg_comments(OggVorbis_File *vf) | |
| 151 { | |
| 152 #if (defined DEBUG_CHATTER) | |
| 153 int i; | |
| 154 vorbis_comment *vc = ov_comment(vf, -1); | |
| 155 | |
| 156 if (vc == NULL) | |
| 157 return; | |
| 158 | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
159 SNDDBG(("OGG: vendor == [%s].\n", vc->vendor)); |
| 24 | 160 for (i = 0; i < vc->comments; i++) |
| 161 { | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
162 SNDDBG(("OGG: user comment [%s].\n", vc->user_comments[i])); |
| 24 | 163 } /* for */ |
| 164 #endif | |
| 165 } /* output_ogg_comments */ | |
| 166 | |
| 167 | |
| 168 static int OGG_open(Sound_Sample *sample, const char *ext) | |
| 169 { | |
| 170 int rc; | |
| 171 OggVorbis_File *vf; | |
| 172 vorbis_info *info; | |
| 173 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque; | |
| 174 | |
| 175 vf = (OggVorbis_File *) malloc(sizeof (OggVorbis_File)); | |
| 176 BAIL_IF_MACRO(vf == NULL, ERR_OUT_OF_MEMORY, 0); | |
| 177 | |
| 178 rc = ov_open_callbacks(internal->rw, vf, NULL, 0, RWops_ogg_callbacks); | |
| 179 if (rc != 0) | |
| 180 { | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
181 SNDDBG(("OGG: can't grok data. reason: [%s].\n", ogg_error(rc))); |
| 24 | 182 free(vf); |
| 183 BAIL_MACRO("OGG: Not valid Ogg Vorbis data.", 0); | |
| 184 } /* if */ | |
| 185 | |
| 186 info = ov_info(vf, -1); | |
| 187 if (info == NULL) | |
| 188 { | |
| 189 ov_clear(vf); | |
| 190 free(vf); | |
| 191 BAIL_MACRO("OGG: failed to retrieve bitstream info", 0); | |
| 192 } /* if */ | |
| 193 | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
194 SNDDBG(("OGG: Accepting data stream.\n")); |
| 24 | 195 |
| 196 output_ogg_comments(vf); | |
|
59
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
197 SNDDBG(("OGG: bitstream version == (%d).\n", info->version)); |
|
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
198 SNDDBG(("OGG: bitstream channels == (%d).\n", info->channels)); |
|
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
199 SNDDBG(("OGG: bitstream sampling rate == (%ld).\n", info->rate)); |
|
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
200 SNDDBG(("OGG: seekable == {%s}.\n", ov_seekable(vf) ? "TRUE" : "FALSE")); |
|
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
201 SNDDBG(("OGG: number of logical bitstreams == (%ld).\n", ov_streams(vf))); |
|
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
202 SNDDBG(("OGG: serial number == (%ld).\n", ov_serialnumber(vf, -1))); |
|
cd91e1857b42
Changed _D macro to SNDDBG, and fixed a warning if compiling without debug
Ryan C. Gordon <icculus@icculus.org>
parents:
47
diff
changeset
|
203 SNDDBG(("OGG: total seconds of sample == (%f).\n", ov_time_total(vf, -1))); |
| 24 | 204 |
| 205 internal->decoder_private = vf; | |
| 206 sample->flags = SOUND_SAMPLEFLAG_NONE; | |
| 207 sample->actual.rate = (Uint32) info->rate; | |
| 208 sample->actual.channels = (Uint8) info->channels; | |
| 209 | |
| 210 /* | |
| 211 * Since we might have more than one logical bitstream in the OGG file, | |
| 212 * and these bitstreams may be in different formats, we might be | |
| 213 * converting two or three times: once in vorbisfile, once again in | |
| 214 * SDL_sound, and perhaps a third time to get it to the sound device's | |
| 215 * format. That's wickedly inefficient. | |
| 216 * | |
| 217 * To combat this a little, if the user specified a desired format, we | |
| 218 * claim that to be the "actual" format of the collection of logical | |
| 219 * bitstreams. This means that VorbisFile will do a conversion as | |
| 220 * necessary, and SDL_sound will not. If the user didn't specify a | |
| 221 * desired format, then we pretend the "actual" format is something that | |
| 222 * OGG files are apparently commonly encoded in. | |
| 223 */ | |
| 224 sample->actual.format = (sample->desired.format == 0) ? | |
| 225 AUDIO_S16LSB : sample->desired.format; | |
| 226 return(1); | |
| 227 } /* OGG_open */ | |
| 228 | |
| 229 | |
| 230 static void OGG_close(Sound_Sample *sample) | |
| 231 { | |
| 232 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque; | |
| 233 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private; | |
| 234 ov_clear(vf); | |
| 235 free(vf); | |
| 236 } /* OGG_close */ | |
| 237 | |
| 238 | |
| 239 static Uint32 OGG_read(Sound_Sample *sample) | |
| 240 { | |
| 241 int rc; | |
| 242 int bitstream; | |
| 243 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque; | |
| 244 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private; | |
| 245 | |
| 246 rc = ov_read(vf, internal->buffer, internal->buffer_size, | |
| 247 ((sample->actual.format & 0x1000) ? 1 : 0), /* bigendian? */ | |
| 248 ((sample->actual.format & 0xFF) / 8), /* bytes per sample point */ | |
| 249 ((sample->actual.format & 0x8000) ? 1 : 0), /* signed data? */ | |
| 250 &bitstream); | |
| 251 | |
| 252 /* Make sure the read went smoothly... */ | |
| 253 if (rc == 0) | |
| 254 sample->flags |= SOUND_SAMPLEFLAG_EOF; | |
| 255 | |
| 256 else if (rc < 0) | |
| 257 sample->flags |= SOUND_SAMPLEFLAG_ERROR; | |
| 258 | |
| 259 /* (next call this EAGAIN may turn into an EOF or error.) */ | |
| 260 else if ((Uint32) rc < internal->buffer_size) | |
| 261 sample->flags |= SOUND_SAMPLEFLAG_EAGAIN; | |
| 262 | |
| 263 return((Uint32) rc); | |
| 264 } /* OGG_read */ | |
| 265 | |
|
63
9669aa13d3e0
Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents:
59
diff
changeset
|
266 #endif /* SOUND_SUPPORTS_OGG */ |
|
9669aa13d3e0
Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents:
59
diff
changeset
|
267 |
|
9669aa13d3e0
Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents:
59
diff
changeset
|
268 |
| 24 | 269 /* end of ogg.c ... */ |
| 270 |