annotate decoders/ogg.c @ 59:cd91e1857b42

Changed _D macro to SNDDBG, and fixed a warning if compiling without debug chatter enabled.
author Ryan C. Gordon <icculus@icculus.org>
date Mon, 24 Sep 2001 15:29:27 +0000
parents ea58bc3b15d7
children 9669aa13d3e0
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 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
30 * Please see the file LICENSE in the source's root directory.
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
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
35 #include <stdio.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
36 #include <stdlib.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
37 #include <string.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
38 #include <math.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
39 #include <assert.h>
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
40 #include "vorbis/codec.h"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
41 #include "vorbis/vorbisfile.h"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
42
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
43 #include "SDL_sound.h"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
44
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
45 #define __SDL_SOUND_INTERNAL__
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
46 #include "SDL_sound_internal.h"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
47
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
48 #if (!defined SOUND_SUPPORTS_OGG)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
49 #error SOUND_SUPPORTS_OGG must be defined.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
50 #endif
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
51
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
52 static int OGG_init(void);
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
53 static void OGG_quit(void);
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
54 static int OGG_open(Sound_Sample *sample, const char *ext);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
55 static void OGG_close(Sound_Sample *sample);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
56 static Uint32 OGG_read(Sound_Sample *sample);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
57
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
58 const Sound_DecoderFunctions __Sound_DecoderFunctions_OGG =
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
59 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
60 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
61 "OGG",
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
62 "Ogg Vorbis audio through VorbisFile",
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
63 "Ryan C. Gordon <icculus@clutteredmind.org>",
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
64 "http://www.icculus.org/SDL_sound/"
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
65 },
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
66
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
67 OGG_init, /* init() method */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
68 OGG_quit, /* quit() method */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
69 OGG_open, /* open() method */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
70 OGG_close, /* close() method */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
71 OGG_read /* read() method */
24
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
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
74
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
75 static int OGG_init(void)
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
76 {
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
77 return(1); /* always succeeds. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
78 } /* OGG_init */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
79
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
80
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
81 static void OGG_quit(void)
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
82 {
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
83 /* it's a no-op. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
84 } /* OGG_quit */
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
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 24
diff changeset
87
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
88 /*
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
89 * These are callbacks from vorbisfile that let them read data from
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
90 * a RWops...
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
91 */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
92
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
93 size_t RWops_ogg_read(void *ptr, size_t size, size_t nmemb, void *datasource)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
94 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
95 return((size_t) SDL_RWread((SDL_RWops *) datasource, ptr, size, nmemb));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
96 } /* RWops_ogg_read */
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 int RWops_ogg_seek(void *datasource, int64_t offset, int whence)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
99 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
100 return(SDL_RWseek((SDL_RWops *) datasource, offset, whence));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
101 } /* RWops_ogg_seek */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
102
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
103 int RWops_ogg_close(void *datasource)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
104 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
105 /* do nothing; SDL_sound will delete the RWops at a higher level. */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
106 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
107 } /* RWops_ogg_close */
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 long RWops_ogg_tell(void *datasource)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
110 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
111 return((long) SDL_RWtell((SDL_RWops *) datasource));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
112 } /* RWops_ogg_tell */
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 static const ov_callbacks RWops_ogg_callbacks =
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
115 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
116 RWops_ogg_read,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
117 RWops_ogg_seek,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
118 RWops_ogg_close,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
119 RWops_ogg_tell
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
120 };
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
121
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 /* 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
124 #if (defined DEBUG_CHATTER)
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
125 static const char *ogg_error(int errnum)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
126 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
127 switch(errnum)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
128 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
129 case OV_EREAD:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
130 return("i/o error");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
131 case OV_ENOTVORBIS:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
132 return("not a vorbis file");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
133 case OV_EVERSION:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
134 return("Vorbis version mismatch");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
135 case OV_EBADHEADER:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
136 return("invalid Vorbis bitstream header");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
137 case OV_EFAULT:
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
138 return("internal logic fault in Vorbis library");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
139 } /* switch */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
140
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
141 return("unknown error");
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
142 } /* 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
143 #endif
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
144
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
145 static __inline__ void output_ogg_comments(OggVorbis_File *vf)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
146 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
147 #if (defined DEBUG_CHATTER)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
148 int i;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
149 vorbis_comment *vc = ov_comment(vf, -1);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
150
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
151 if (vc == NULL)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
152 return;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
153
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
154 SNDDBG(("OGG: vendor == [%s].\n", vc->vendor));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
155 for (i = 0; i < vc->comments; i++)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
156 {
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
157 SNDDBG(("OGG: user comment [%s].\n", vc->user_comments[i]));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
158 } /* for */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
159 #endif
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
160 } /* output_ogg_comments */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
161
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
162
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
163 static int OGG_open(Sound_Sample *sample, const char *ext)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
164 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
165 int rc;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
166 OggVorbis_File *vf;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
167 vorbis_info *info;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
168 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
169
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
170 vf = (OggVorbis_File *) malloc(sizeof (OggVorbis_File));
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
171 BAIL_IF_MACRO(vf == NULL, ERR_OUT_OF_MEMORY, 0);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
172
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
173 rc = ov_open_callbacks(internal->rw, vf, NULL, 0, RWops_ogg_callbacks);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
174 if (rc != 0)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
175 {
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
176 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
177 free(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
178 BAIL_MACRO("OGG: Not valid Ogg Vorbis data.", 0);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
179 } /* if */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
180
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
181 info = ov_info(vf, -1);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
182 if (info == NULL)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
183 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
184 ov_clear(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
185 free(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
186 BAIL_MACRO("OGG: failed to retrieve bitstream info", 0);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
187 } /* if */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
188
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
189 SNDDBG(("OGG: Accepting data stream.\n"));
24
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
190
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
191 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
192 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
193 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
194 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
195 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
196 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
197 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
198 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
199
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
200 internal->decoder_private = vf;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
201 sample->flags = SOUND_SAMPLEFLAG_NONE;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
202 sample->actual.rate = (Uint32) info->rate;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
203 sample->actual.channels = (Uint8) info->channels;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
204
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
205 /*
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
206 * 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
207 * and these bitstreams may be in different formats, we might be
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
208 * converting two or three times: once in vorbisfile, once again in
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
209 * 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
210 * format. That's wickedly inefficient.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
211 *
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
212 * 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
213 * claim that to be the "actual" format of the collection of logical
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
214 * bitstreams. This means that VorbisFile will do a conversion as
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
215 * 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
216 * desired format, then we pretend the "actual" format is something that
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
217 * OGG files are apparently commonly encoded in.
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
218 */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
219 sample->actual.format = (sample->desired.format == 0) ?
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
220 AUDIO_S16LSB : sample->desired.format;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
221 return(1);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
222 } /* OGG_open */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
223
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
224
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
225 static void OGG_close(Sound_Sample *sample)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
226 {
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
227 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
228 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
229 ov_clear(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
230 free(vf);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
231 } /* OGG_close */
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 Uint32 OGG_read(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 int rc;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
237 int bitstream;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
238 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
239 OggVorbis_File *vf = (OggVorbis_File *) internal->decoder_private;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
240
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
241 rc = ov_read(vf, internal->buffer, internal->buffer_size,
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
242 ((sample->actual.format & 0x1000) ? 1 : 0), /* bigendian? */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
243 ((sample->actual.format & 0xFF) / 8), /* bytes per sample point */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
244 ((sample->actual.format & 0x8000) ? 1 : 0), /* signed data? */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
245 &bitstream);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
246
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
247 /* Make sure the read went smoothly... */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
248 if (rc == 0)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
249 sample->flags |= SOUND_SAMPLEFLAG_EOF;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
250
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
251 else if (rc < 0)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
252 sample->flags |= SOUND_SAMPLEFLAG_ERROR;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
253
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
254 /* (next call this EAGAIN may turn into an EOF or error.) */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
255 else if ((Uint32) rc < internal->buffer_size)
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
256 sample->flags |= SOUND_SAMPLEFLAG_EAGAIN;
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
257
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
258 return((Uint32) rc);
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
259 } /* OGG_read */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
260
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
261 /* end of ogg.c ... */
0fc0f91b1b84 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
262