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