annotate decoders/ogg.c @ 355:5dbf2f9cde00

Added docs stuff.
author Ryan C. Gordon <icculus@icculus.org>
date Fri, 07 Jun 2002 13:26:13 +0000
parents aa7f6a110971
children cbb15ecf423a
rev   line source
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
1 /*
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
2 * SDL_sound -- An abstract sound format decoding API.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3 * Copyright (C) 2001 Ryan C. Gordon.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
4 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5 * This library is free software; you can redistribute it and/or
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
6 * modify it under the terms of the GNU Lesser General Public
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
7 * License as published by the Free Software Foundation; either
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
8 * version 2.1 of the License, or (at your option) any later version.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
9 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
10 * This library is distributed in the hope that it will be useful,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
13 * Lesser General Public License for more details.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
15 * You should have received a copy of the GNU Lesser General Public
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
16 * License along with this library; if not, write to the Free Software
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
18 */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
19
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
20 /*
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
21 * Ogg Vorbis decoder for SDL_sound.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
22 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
23 * This driver handles .OGG audio files, and depends on libvorbisfile to
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
24 * do the actual decoding work. libvorbisfile is part of libvorbis, which
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
25 * is part of the Ogg Vorbis project.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
26 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
27 * Ogg Vorbis: http://www.xiph.org/ogg/vorbis/
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
28 * vorbisfile documentation: http://www.xiph.org/ogg/vorbis/doc/vorbisfile/
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
31 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
32 * This file written by Ryan C. Gordon. (icculus@clutteredmind.org)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
33 */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
41 #include <stdio.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
42 #include <stdlib.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
43 #include <string.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
44 #include <math.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
52 #include "vorbis/codec.h"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
53 #include "vorbis/vorbisfile.h"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
54
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
58 static int OGG_open(Sound_Sample *sample, const char *ext);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
59 static void OGG_close(Sound_Sample *sample);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
60 static Uint32 OGG_read(Sound_Sample *sample);
221
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
61 static int OGG_rewind(Sound_Sample *sample);
306
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
62 static int OGG_seek(Sound_Sample *sample, Uint32 ms);
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
63
149
1df5c106504e Decoders can now list multiple file extensions.
Ryan C. Gordon <icculus@icculus.org>
parents: 122
diff changeset
64 static const char *extensions_ogg[] = { "OGG", NULL };
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
65 const Sound_DecoderFunctions __Sound_DecoderFunctions_OGG =
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
66 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
67 {
149
1df5c106504e Decoders can now list multiple file extensions.
Ryan C. Gordon <icculus@icculus.org>
parents: 122
diff changeset
68 extensions_ogg,
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
69 "Ogg Vorbis audio through VorbisFile",
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
70 "Ryan C. Gordon <icculus@clutteredmind.org>",
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
71 "http://www.icculus.org/SDL_sound/"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
72 },
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
73
221
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
74 OGG_init, /* init() method */
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
75 OGG_quit, /* quit() method */
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
76 OGG_open, /* open() method */
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
77 OGG_close, /* close() method */
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
78 OGG_read, /* read() method */
306
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
79 OGG_rewind, /* rewind() method */
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
80 OGG_seek /* seek() method */
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
81 };
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
82
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
83
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
84 static int OGG_init(void)
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 return(1); /* always succeeds. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
87 } /* OGG_init */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
88
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
89
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
90 static void OGG_quit(void)
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 /* it's a no-op. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
93 } /* OGG_quit */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
94
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
95
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
96
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
97 /*
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
98 * These are callbacks from vorbisfile that let them read data from
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
99 * a RWops...
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
100 */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
101
63
9669aa13d3e0 Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents: 59
diff changeset
102 static size_t RWops_ogg_read(void *ptr, size_t size, size_t nmemb, void *datasource)
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
103 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
104 return((size_t) SDL_RWread((SDL_RWops *) datasource, ptr, size, nmemb));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
105 } /* RWops_ogg_read */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
106
122
095a066b2cd2 Portability fix.
Ryan C. Gordon <icculus@icculus.org>
parents: 106
diff changeset
107 static int RWops_ogg_seek(void *datasource, ogg_int64_t offset, int whence)
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
108 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
109 return(SDL_RWseek((SDL_RWops *) datasource, offset, whence));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
110 } /* RWops_ogg_seek */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
111
63
9669aa13d3e0 Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents: 59
diff changeset
112 static int RWops_ogg_close(void *datasource)
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
113 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
114 /* do nothing; SDL_sound will delete the RWops at a higher level. */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
115 return(0); /* this is success in fclose(), so I guess that's okay. */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
116 } /* RWops_ogg_close */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
117
63
9669aa13d3e0 Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents: 59
diff changeset
118 static long RWops_ogg_tell(void *datasource)
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
119 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
120 return((long) SDL_RWtell((SDL_RWops *) datasource));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
121 } /* RWops_ogg_tell */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
122
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
123 static const ov_callbacks RWops_ogg_callbacks =
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
124 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
125 RWops_ogg_read,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
126 RWops_ogg_seek,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
127 RWops_ogg_close,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
128 RWops_ogg_tell
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
129 };
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
130
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
131
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
132 /* 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
133 #if (defined DEBUG_CHATTER)
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
134 static const char *ogg_error(int errnum)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
135 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
136 switch(errnum)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
137 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
138 case OV_EREAD:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
139 return("i/o error");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
140 case OV_ENOTVORBIS:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
141 return("not a vorbis file");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
142 case OV_EVERSION:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
143 return("Vorbis version mismatch");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
144 case OV_EBADHEADER:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
145 return("invalid Vorbis bitstream header");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
146 case OV_EFAULT:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
147 return("internal logic fault in Vorbis library");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
148 } /* switch */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
149
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
150 return("unknown error");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
151 } /* 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
152 #endif
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
153
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
154 static __inline__ void output_ogg_comments(OggVorbis_File *vf)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
155 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
156 #if (defined DEBUG_CHATTER)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
157 int i;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
158 vorbis_comment *vc = ov_comment(vf, -1);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
159
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
160 if (vc == NULL)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
161 return;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
162
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
163 SNDDBG(("OGG: vendor == [%s].\n", vc->vendor));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
164 for (i = 0; i < vc->comments; i++)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
165 {
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
166 SNDDBG(("OGG: user comment [%s].\n", vc->user_comments[i]));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
167 } /* for */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
168 #endif
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
169 } /* output_ogg_comments */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
170
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
171
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
172 static int OGG_open(Sound_Sample *sample, const char *ext)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
173 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
174 int rc;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
175 OggVorbis_File *vf;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
176 vorbis_info *info;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
177 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
178
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
179 vf = (OggVorbis_File *) malloc(sizeof (OggVorbis_File));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
180 BAIL_IF_MACRO(vf == NULL, ERR_OUT_OF_MEMORY, 0);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
181
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
182 rc = ov_open_callbacks(internal->rw, vf, NULL, 0, RWops_ogg_callbacks);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
183 if (rc != 0)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
184 {
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
185 SNDDBG(("OGG: can't grok data. reason: [%s].\n", ogg_error(rc)));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
186 free(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
187 BAIL_MACRO("OGG: Not valid Ogg Vorbis data.", 0);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
188 } /* if */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
189
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
190 info = ov_info(vf, -1);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
191 if (info == NULL)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
192 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
193 ov_clear(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
194 free(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
195 BAIL_MACRO("OGG: failed to retrieve bitstream info", 0);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
196 } /* if */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
197
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
198 SNDDBG(("OGG: Accepting data stream.\n"));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
199
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
200 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
201 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
202 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
203 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
204 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
205 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
206 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
207 SNDDBG(("OGG: total seconds of sample == (%f).\n", ov_time_total(vf, -1)));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
208
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
209 internal->decoder_private = vf;
327
aa7f6a110971 Added seek implementation.
Ryan C. Gordon <icculus@icculus.org>
parents: 306
diff changeset
210 sample->flags = SOUND_SAMPLEFLAG_CANSEEK;
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
211 sample->actual.rate = (Uint32) info->rate;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
212 sample->actual.channels = (Uint8) info->channels;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
213
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
214 /*
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
215 * Since we might have more than one logical bitstream in the OGG file,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
216 * and these bitstreams may be in different formats, we might be
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
217 * converting two or three times: once in vorbisfile, once again in
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
218 * SDL_sound, and perhaps a third time to get it to the sound device's
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
219 * format. That's wickedly inefficient.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
220 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
221 * To combat this a little, if the user specified a desired format, we
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
222 * claim that to be the "actual" format of the collection of logical
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
223 * bitstreams. This means that VorbisFile will do a conversion as
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
224 * necessary, and SDL_sound will not. If the user didn't specify a
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
225 * desired format, then we pretend the "actual" format is something that
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
226 * OGG files are apparently commonly encoded in.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
227 */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
228 sample->actual.format = (sample->desired.format == 0) ?
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
229 AUDIO_S16LSB : sample->desired.format;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
230 return(1);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
231 } /* OGG_open */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
232
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
233
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
234 static void OGG_close(Sound_Sample *sample)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
235 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
236 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
237 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
238 ov_clear(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
239 free(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
240 } /* OGG_close */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
241
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
242
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
243 static Uint32 OGG_read(Sound_Sample *sample)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
244 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
245 int rc;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
246 int bitstream;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
247 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
248 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
249
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
250 rc = ov_read(vf, internal->buffer, internal->buffer_size,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
251 ((sample->actual.format & 0x1000) ? 1 : 0), /* bigendian? */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
252 ((sample->actual.format & 0xFF) / 8), /* bytes per sample point */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
253 ((sample->actual.format & 0x8000) ? 1 : 0), /* signed data? */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
254 &bitstream);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
255
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
256 /* Make sure the read went smoothly... */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
257 if (rc == 0)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
258 sample->flags |= SOUND_SAMPLEFLAG_EOF;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
259
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
260 else if (rc < 0)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
261 sample->flags |= SOUND_SAMPLEFLAG_ERROR;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
262
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
263 /* (next call this EAGAIN may turn into an EOF or error.) */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
264 else if ((Uint32) rc < internal->buffer_size)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
265 sample->flags |= SOUND_SAMPLEFLAG_EAGAIN;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
266
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
267 return((Uint32) rc);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
268 } /* OGG_read */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
269
221
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
270
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
271 static int OGG_rewind(Sound_Sample *sample)
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
272 {
231
d3dc34315ac7 Rewind method implemented by Torbj�rn.
Ryan C. Gordon <icculus@icculus.org>
parents: 221
diff changeset
273 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
d3dc34315ac7 Rewind method implemented by Torbj�rn.
Ryan C. Gordon <icculus@icculus.org>
parents: 221
diff changeset
274 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private;
d3dc34315ac7 Rewind method implemented by Torbj�rn.
Ryan C. Gordon <icculus@icculus.org>
parents: 221
diff changeset
275
d3dc34315ac7 Rewind method implemented by Torbj�rn.
Ryan C. Gordon <icculus@icculus.org>
parents: 221
diff changeset
276 BAIL_IF_MACRO(ov_raw_seek(vf, 0) < 0, ERR_IO_ERROR, 0);
d3dc34315ac7 Rewind method implemented by Torbj�rn.
Ryan C. Gordon <icculus@icculus.org>
parents: 221
diff changeset
277 return(1);
221
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
278 } /* OGG_rewind */
c9772a9f5271 Initial implementation or stubs for rewind method. Other cleanups.
Ryan C. Gordon <icculus@icculus.org>
parents: 184
diff changeset
279
306
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
280
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
281 static int OGG_seek(Sound_Sample *sample, Uint32 ms)
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
282 {
327
aa7f6a110971 Added seek implementation.
Ryan C. Gordon <icculus@icculus.org>
parents: 306
diff changeset
283 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
aa7f6a110971 Added seek implementation.
Ryan C. Gordon <icculus@icculus.org>
parents: 306
diff changeset
284 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private;
aa7f6a110971 Added seek implementation.
Ryan C. Gordon <icculus@icculus.org>
parents: 306
diff changeset
285 double timepos = (((double) ms) / 1000.0);
aa7f6a110971 Added seek implementation.
Ryan C. Gordon <icculus@icculus.org>
parents: 306
diff changeset
286 BAIL_IF_MACRO(ov_time_seek(vf, timepos) < 0, ERR_IO_ERROR, 0);
aa7f6a110971 Added seek implementation.
Ryan C. Gordon <icculus@icculus.org>
parents: 306
diff changeset
287 return(1);
306
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
288 } /* OGG_seek */
c97be6e1bd27 Added framework for Sound_Seek() support.
Ryan C. Gordon <icculus@icculus.org>
parents: 231
diff changeset
289
63
9669aa13d3e0 Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents: 59
diff changeset
290 #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
291
9669aa13d3e0 Changes in preparation for autoconf, and the RWops wrappers changed to
Ryan C. Gordon <icculus@icculus.org>
parents: 59
diff changeset
292
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
293 /* end of ogg.c ... */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
294