1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
// Emacs style mode select -*- C++ -*-
//-----------------------------------------------------------------------------
//
// Copyright(C) 1993-1996 Id Software, Inc.
// Copyright(C) 2005 Simon Howard
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
// 02111-1307, USA.
//
// DESCRIPTION:
// The not so system specific sound interface.
//
//-----------------------------------------------------------------------------
#ifndef __I_SOUND__
#define __I_SOUND__
#include "doomtype.h"
//
// SoundFX struct.
//
typedef struct sfxinfo_struct sfxinfo_t;
struct sfxinfo_struct
{
// up to 6-character name
char *name;
// Sfx priority
int priority;
// referenced sound if a link
sfxinfo_t *link;
// pitch if a link
int pitch;
// volume if a link
int volume;
// this is checked every second to see if sound
// can be thrown out (if 0, then decrement, if -1,
// then throw out, if > 0, then it is in use)
int usefulness;
// lump number of sfx
int lumpnum;
// Maximum number of channels that the sound can be played on
// (Heretic)
int numchannels;
// data used by the low level code
void *driver_data;
};
//
// MusicInfo struct.
//
typedef struct
{
// up to 6-character name
char *name;
// lump number of music
int lumpnum;
// music data
void *data;
// music handle once registered
void *handle;
} musicinfo_t;
typedef enum
{
SNDDEVICE_NONE = 0,
SNDDEVICE_PCSPEAKER = 1,
SNDDEVICE_ADLIB = 2,
SNDDEVICE_SB = 3,
SNDDEVICE_PAS = 4,
SNDDEVICE_GUS = 5,
SNDDEVICE_WAVEBLASTER = 6,
SNDDEVICE_SOUNDCANVAS = 7,
SNDDEVICE_GENMIDI = 8,
SNDDEVICE_AWE32 = 9,
} snddevice_t;
// Interface for sound modules
typedef struct
{
// List of sound devices that this sound module is used for.
snddevice_t *sound_devices;
int num_sound_devices;
// Initialise sound module
// Returns true if successfully initialised
boolean (*Init)(void);
// Shutdown sound module
void (*Shutdown)(void);
// Returns the lump index of the given sound.
int (*GetSfxLumpNum)(sfxinfo_t *sfxinfo);
// Called periodically to update the subsystem.
void (*Update)(void);
// Update the sound settings on the given channel.
void (*UpdateSoundParams)(int channel, int vol, int sep);
// Start a sound on a given channel. Returns the channel id
// or -1 on failure.
int (*StartSound)(sfxinfo_t *sfxinfo, int channel, int vol, int sep);
// Stop the sound playing on the given channel.
void (*StopSound)(int channel);
// Query if a sound is playing on the given channel
boolean (*SoundIsPlaying)(int channel);
// Called on startup to precache sound effects (if necessary)
void (*CacheSounds)(sfxinfo_t *sounds, int num_sounds);
} sound_module_t;
void I_InitSound(void);
void I_ShutdownSound(void);
int I_GetSfxLumpNum(sfxinfo_t *sfxinfo);
void I_UpdateSound(void);
void I_UpdateSoundParams(int channel, int vol, int sep);
int I_StartSound(sfxinfo_t *sfxinfo, int channel, int vol, int sep);
void I_StopSound(int channel);
boolean I_SoundIsPlaying(int channel);
void I_PrecacheSounds(sfxinfo_t *sounds, int num_sounds);
// Interface for music modules
typedef struct
{
// List of sound devices that this music module is used for.
snddevice_t *sound_devices;
int num_sound_devices;
// Initialise the music subsystem
boolean (*Init)(void);
// Shutdown the music subsystem
void (*Shutdown)(void);
// Set music volume - range 0-127
void (*SetMusicVolume)(int volume);
// Pause music
void (*PauseMusic)(void);
// Un-pause music
void (*ResumeMusic)(void);
// Register a song handle from data
// Returns a handle that can be used to play the song
void *(*RegisterSong)(void *data, int len);
// Un-register (free) song data
void (*UnRegisterSong)(void *handle);
// Play the song
void (*PlaySong)(void *handle, boolean looping);
// Stop playing the current song.
void (*StopSong)(void);
// Query if music is playing.
boolean (*MusicIsPlaying)(void);
} music_module_t;
void I_InitMusic(void);
void I_ShutdownMusic(void);
void I_SetMusicVolume(int volume);
void I_PauseSong(void);
void I_ResumeSong(void);
void *I_RegisterSong(void *data, int len);
void I_UnRegisterSong(void *handle);
void I_PlaySong(void *handle, boolean looping);
void I_StopSong(void);
boolean I_MusicIsPlaying(void);
extern int snd_sfxdevice;
extern int snd_musicdevice;
extern int snd_samplerate;
void I_BindSoundVariables(void);
#endif
|
