annotate decoders/raw.c @ 7:29313c20963d

Updated a lot of comments, and changed read() method's return type.
author Ryan C. Gordon <icculus@icculus.org>
date Tue, 18 Sep 2001 10:52:48 +0000
parents 341cea3e13c6
children ea58bc3b15d7
rev   line source
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
1 /*
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
2 * SDL_sound -- An abstract sound format decoding API.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3 * Copyright (C) 2001 Ryan C. Gordon.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
4 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5 * This library is free software; you can redistribute it and/or
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
6 * modify it under the terms of the GNU Lesser General Public
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
7 * License as published by the Free Software Foundation; either
341cea3e13c6 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.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
9 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
10 * This library is distributed in the hope that it will be useful,
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
13 * Lesser General Public License for more details.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
15 * You should have received a copy of the GNU Lesser General Public
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
16 * License along with this library; if not, write to the Free Software
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
18 */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
19
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
20 /*
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
21 * RAW decoder for SDL_sound. This is as simple as it gets.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
22 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
23 * This driver handles raw audio data. You must, regardless of where the
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
24 * data is actually coming from, specify the string "RAW" in the extension
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
25 * parameter of Sound_NewSample() (or, alternately, open a file with the
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
26 * extension ".raw" in Sound_NewSampleFromFile()). The string is checked
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
27 * case-insensitive. We need this check, because raw data, being raw, has
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
28 * no headers or magic number we can use to determine if we should handle a
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
29 * given file, so we needed some way to have this "decoder" discriminate.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
30 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
31 * When calling Sound_NewSample*(), you must also specify a "desired"
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
32 * audio format. The "actual" format will always match what you specify, so
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
33 * there will be no conversion overhead, but these routines need to know how
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
34 * to treat the bits, since it's all random garbage otherwise.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
35 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
36 * Please see the file LICENSE in the source's root directory.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
37 *
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
38 * This file written by Ryan C. Gordon. (icculus@clutteredmind.org)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
39 */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
40
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
41 #include <stdio.h>
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
42 #include <stdlib.h>
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
43 #include <string.h>
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
44 #include <assert.h>
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
45 #include "SDL_sound.h"
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
46
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
47 #define __SDL_SOUND_INTERNAL__
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
48 #include "SDL_sound_internal.h"
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
49
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
50 #if (!defined SOUND_SUPPORTS_RAW)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
51 #error SOUND_SUPPORTS_RAW must be defined.
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
52 #endif
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
53
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
54
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
55 static int RAW_open(Sound_Sample *sample, const char *ext);
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
56 static void RAW_close(Sound_Sample *sample);
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
57 static Uint32 RAW_read(Sound_Sample *sample);
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
58
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
59 const Sound_DecoderFunctions __Sound_DecoderFunctions_RAW =
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
60 {
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
61 {
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
62 "RAW",
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
63 "Raw audio",
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
64 "Ryan C. Gordon <icculus@clutteredmind.org>",
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
65 "http://www.icculus.org/SDL_sound/"
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
66 },
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
67
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
68 RAW_open, /* open() method */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
69 RAW_close, /* close() method */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
70 RAW_read /* read() method */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
71 };
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
72
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
73
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
74 static int RAW_open(Sound_Sample *sample, const char *ext)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
75 {
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
76 /*
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
77 * We check this explicitly, since we have no other way to
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
78 * determine whether we should handle this data or not.
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
79 */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
80 if (__Sound_strcasecmp(ext, "RAW") != 0)
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
81 {
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
82 Sound_SetError("RAW: extension isn't explicitly \"RAW\".");
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
83 return(0);
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
84 } /* if */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
85
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
86 /*
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
87 * You must also specify a desired format, so we know how to
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
88 * treat the bits that are otherwise binary garbage.
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
89 */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
90 if ( (sample->desired.channels < 1) ||
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
91 (sample->desired.channels > 2) ||
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
92 (sample->desired.rate == 0) ||
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
93 (sample->desired.format == 0) )
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
94 {
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
95 Sound_SetError("RAW: invalid desired format.");
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
96 return(0);
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
97 } /* if */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
98
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
99 _D(("RAW: Accepting data stream.\n"));
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
100
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
101 /*
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
102 * We never convert raw samples; what you ask for is what you get.
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
103 */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
104 memcpy(&sample->actual, &sample->desired, sizeof (Sound_AudioInfo));
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
105 sample->flags = SOUND_SAMPLEFLAG_NONE;
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
106
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
107 return(1); /* we'll handle this data. */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
108 } /* RAW_open */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
109
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
110
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
111 static void RAW_close(Sound_Sample *sample)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
112 {
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
113 /* we don't allocate anything that we need to free. That's easy, eh? */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
114 } /* RAW_close */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
115
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
116
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
117 static Uint32 RAW_read(Sound_Sample *sample)
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
118 {
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
119 Uint32 retval;
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
120 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
121
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
122 /*
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
123 * We don't actually do any decoding, so we read the raw data
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
124 * directly into the internal buffer...
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
125 */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
126 retval = SDL_RWread(internal->rw, internal->buffer,
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
127 1, internal->buffer_size);
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
128
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
129 /* Make sure the read went smoothly... */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
130 if (retval == 0)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
131 sample->flags |= SOUND_SAMPLEFLAG_EOF;
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
132
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
133 else if (retval == -1)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
134 sample->flags |= SOUND_SAMPLEFLAG_ERROR;
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
135
7
29313c20963d Updated a lot of comments, and changed read() method's return type.
Ryan C. Gordon <icculus@icculus.org>
parents: 4
diff changeset
136 /* (next call this EAGAIN may turn into an EOF or error.) */
4
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
137 else if (retval < internal->buffer_size)
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
138 sample->flags |= SOUND_SAMPLEFLAG_EAGAIN;
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
139
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
140 return(retval);
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
141 } /* RAW_read */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
142
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
143
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
144 /* end of raw.c ... */
341cea3e13c6 Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
145