annotate decoders/skeleton.c @ 47:ea58bc3b15d7

Added init() and quit() methods.
author Ryan C. Gordon <icculus@icculus.org>
date Sat, 22 Sep 2001 14:41:38 +0000
parents d9b9d60cf9a9
children b13fafb976be
rev   line source
16
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
1 /*
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
2 * SDL_sound -- An abstract sound format decoding API.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
3 * Copyright (C) 2001 Ryan C. Gordon.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
4 *
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
5 * This library is free software; you can redistribute it and/or
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
6 * modify it under the terms of the GNU Lesser General Public
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
7 * License as published by the Free Software Foundation; either
3efbcaf36fec 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.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
9 *
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
10 * This library is distributed in the hope that it will be useful,
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
13 * Lesser General Public License for more details.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
14 *
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
15 * You should have received a copy of the GNU Lesser General Public
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
16 * License along with this library; if not, write to the Free Software
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
18 */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
19
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
20 /*
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
21 * FMT decoder for SDL_sound.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
22 *
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
23 * This driver handles FMT audio data. Blahblahblah... The author should
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
24 * have done a search and replace on "fmt" and "FMT" and changed this
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
25 * comment. This is the default comment in the skeleton decoder file...
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
26 *
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
27 * Please see the file LICENSE in the source's root directory.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
28 *
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
29 * This file written by Ryan C. Gordon. (icculus@clutteredmind.org)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
30 */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
31
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
32 #include <stdio.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
33 #include <stdlib.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
34 #include <string.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
35 #include <assert.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
36 #include "SDL_sound.h"
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
37
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
38 #define __SDL_SOUND_INTERNAL__
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
39 #include "SDL_sound_internal.h"
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
40
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
41 #if (!defined SOUND_SUPPORTS_FMT)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
42 #error SOUND_SUPPORTS_FMT must be defined.
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
43 #endif
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
44
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
45
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
46 static int FMT_init(void);
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
47 static void FMT_quit(void);
16
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
48 static int FMT_open(Sound_Sample *sample, const char *ext);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
49 static void FMT_close(Sound_Sample *sample);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
50 static Uint32 FMT_read(Sound_Sample *sample);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
51
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
52 const Sound_DecoderFunctions __Sound_DecoderFunctions_FMT =
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
53 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
54 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
55 "FMT",
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
56 "FMT audio format description",
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
57 "Ryan C. Gordon <icculus@clutteredmind.org>",
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
58 "http://www.icculus.org/SDL_sound/"
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
59 },
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
60
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
61 FMT_init, /* init() method */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
62 FMT_quit, /* quit() method */
16
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
63 FMT_open, /* open() method */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
64 FMT_close, /* close() method */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
65 FMT_read /* read() method */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
66 };
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
67
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
68
47
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
69 static int FMT_init(void)
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
70 {
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
71 /* do any global decoder/library initialization you need here. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
72
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
73 return(1); /* initialization successful. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
74 } /* FMT_init */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
75
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
76
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
77 static void FMT_quit(void)
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
78 {
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
79 /* do any global decoder/library cleanup you need here. */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
80 } /* FMT_quit */
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
81
ea58bc3b15d7 Added init() and quit() methods.
Ryan C. Gordon <icculus@icculus.org>
parents: 21
diff changeset
82
16
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
83 static int FMT_open(Sound_Sample *sample, const char *ext)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
84 {
21
d9b9d60cf9a9 Added some helpful info to FMT_open()...
Ryan C. Gordon <icculus@icculus.org>
parents: 16
diff changeset
85 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
d9b9d60cf9a9 Added some helpful info to FMT_open()...
Ryan C. Gordon <icculus@icculus.org>
parents: 16
diff changeset
86 SDL_RWops *rw = internal->rw;
d9b9d60cf9a9 Added some helpful info to FMT_open()...
Ryan C. Gordon <icculus@icculus.org>
parents: 16
diff changeset
87
16
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
88 if (can NOT accept the data)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
89 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
90 Sound_SetError("FMT: expected X, got Y.");
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
91 return(0);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
92 } /* if */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
93
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
94 _D(("FMT: Accepting data stream.\n"));
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
95 set up sample->actual;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
96 sample->flags = SOUND_SAMPLEFLAG_NONE;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
97 return(1); /* we'll handle this data. */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
98 } /* FMT_open */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
99
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
100
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
101 static void FMT_close(Sound_Sample *sample)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
102 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
103 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
104 clean up anything you put into internal->decoder_private;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
105 } /* FMT_close */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
106
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
107
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
108 static Uint32 FMT_read(Sound_Sample *sample)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
109 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
110 Uint32 retval;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
111 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
112
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
113 /*
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
114 * We don't actually do any decoding, so we read the fmt data
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
115 * directly into the internal buffer...
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
116 */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
117 retval = SDL_RWread(internal->rw, internal->buffer,
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
118 1, internal->buffer_size);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
119
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
120 (or whatever. Do some decoding here...)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
121
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
122 /* Make sure the read went smoothly... */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
123 if (retval == 0)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
124 sample->flags |= SOUND_SAMPLEFLAG_EOF;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
125
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
126 else if (retval == -1)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
127 sample->flags |= SOUND_SAMPLEFLAG_ERROR;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
128
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
129 /* (next call this EAGAIN may turn into an EOF or error.) */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
130 else if (retval < internal->buffer_size)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
131 sample->flags |= SOUND_SAMPLEFLAG_EAGAIN;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
132
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
133 (or whatever. retval == number of bytes you put in internal->buffer).
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
134
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
135 return(retval);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
136 } /* FMT_read */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
137
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
138
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
139 /* end of fmt.c ... */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
140