annotate decoders/skeleton.c @ 216:07d0939d40e7

Support for .AU files added.
author Ryan C. Gordon <icculus@icculus.org>
date Sun, 13 Jan 2002 19:51:14 +0000
parents 47cc2de2ae36
children c9772a9f5271
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 *
184
47cc2de2ae36 Changed reference to "LICENSE" file to "COPYING".
Ryan C. Gordon <icculus@icculus.org>
parents: 149
diff changeset
27 * Please see the file COPYING in the source's root directory.
16
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
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
43 #include <stdio.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
44 #include <stdlib.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
45 #include <string.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
46 #include <assert.h>
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
55 static int FMT_open(Sound_Sample *sample, const char *ext);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
56 static void FMT_close(Sound_Sample *sample);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
57 static Uint32 FMT_read(Sound_Sample *sample);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
60 const Sound_DecoderFunctions __Sound_DecoderFunctions_FMT =
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
61 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
62 {
149
1df5c106504e Decoders can now list multiple file extensions.
Ryan C. Gordon <icculus@icculus.org>
parents: 106
diff changeset
63 extensions_fmt,
16
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
64 "FMT audio format description",
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
65 "Ryan C. Gordon <icculus@clutteredmind.org>",
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
66 "http://www.icculus.org/SDL_sound/"
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 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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
71 FMT_open, /* open() method */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
72 FMT_close, /* close() method */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
73 FMT_read /* read() method */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
74 };
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
75
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
91 static int FMT_open(Sound_Sample *sample, const char *ext)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
96 if (can NOT accept the data)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
97 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
98 Sound_SetError("FMT: expected X, got Y.");
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
99 return(0);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
100 } /* if */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
103 set up sample->actual;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
104 sample->flags = SOUND_SAMPLEFLAG_NONE;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
105 return(1); /* we'll handle this data. */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
106 } /* FMT_open */
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
109 static void FMT_close(Sound_Sample *sample)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
110 {
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 clean up anything you put into internal->decoder_private;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
113 } /* FMT_close */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
114
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
115
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
116 static Uint32 FMT_read(Sound_Sample *sample)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
117 {
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
118 Uint32 retval;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
119 Sound_SampleInternal *internal = (Sound_SampleInternal *) sample->opaque;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
120
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 * 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
123 * directly into the internal buffer...
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
124 */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
125 retval = SDL_RWread(internal->rw, internal->buffer,
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
126 1, internal->buffer_size);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
127
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
128 (or whatever. Do some decoding here...)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
129
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
130 /* Make sure the read went smoothly... */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
131 if (retval == 0)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
132 sample->flags |= SOUND_SAMPLEFLAG_EOF;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
133
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
134 else if (retval == -1)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
135 sample->flags |= SOUND_SAMPLEFLAG_ERROR;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
136
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
137 /* (next call this EAGAIN may turn into an EOF or error.) */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
138 else if (retval < internal->buffer_size)
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
139 sample->flags |= SOUND_SAMPLEFLAG_EAGAIN;
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
140
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
141 (or whatever. retval == number of bytes you put in internal->buffer).
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
142
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
143 return(retval);
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
144 } /* FMT_read */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
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
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
148
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
149 /* end of fmt.c ... */
3efbcaf36fec Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
150