2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // sound.h -- client sound i/o functions
25 #define DEFAULT_SOUND_PACKET_VOLUME 255
26 #define DEFAULT_SOUND_PACKET_ATTENUATION 1.0
32 } portable_samplepair_t;
38 qbyte data[4]; // variable sized
45 unsigned int channels;
49 #define SFXFLAG_SILENTLYMISSING (1 << 0) // if the sfx is missing and loaded with complain = false
50 #define SFXFLAG_USED (1 << 1)
52 typedef struct snd_fetcher_s snd_fetcher_t;
57 unsigned int flags; // cf SFXFLAG_* defines
61 const snd_fetcher_t *fetcher;
62 void *fetcher_data; // Per-sfx data for the sound fetching functions
68 int samples; // mono samples in buffer
69 int samplepos; // in mono samples
70 unsigned char *buffer;
71 int bufferlength; // used only by certain drivers
76 sfx_t *sfx; // sfx number
77 int forceloop; // force looping even if the sound is not looped
78 int leftvol; // 0-255 volume
79 int rightvol; // 0-255 volume
80 int end; // end time in global paintsamples
81 int pos; // sample position in sfx
82 int looping; // where to loop, -1 = no looping
83 int entnum; // to allow overriding a specific sound
85 vec3_t origin; // origin of sound effect
86 vec_t dist_mult; // distance multiplier (attenuation/clipK)
87 int master_vol; // 0-255 master volume
88 void *fetcher_data; // Per-channel data for the sound fetching function
91 typedef const sfxbuffer_t* (*snd_fetcher_getsb_t) (channel_t* ch, unsigned int start, unsigned int nbsamples);
92 typedef void (*snd_fetcher_end_t) (channel_t* ch);
95 snd_fetcher_getsb_t getsb;
96 snd_fetcher_end_t end;
106 int dataofs; // chunk starts this many bytes from file start
110 void S_Startup (void);
111 void S_Shutdown (void);
112 void S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation);
113 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation);
114 void S_StopSound (int entnum, int entchannel);
115 void S_StopAllSounds(qboolean clear);
116 void S_ClearBuffer (void);
117 void S_Update(vec3_t origin, vec3_t forward, vec3_t left, vec3_t up);
118 void S_ExtraUpdate (void);
120 sfx_t *S_GetCached(const char *name);
121 sfx_t *S_PrecacheSound (char *sample, int complain);
122 void S_TouchSound (char *sample);
123 void S_ClearUsed (void);
124 void S_PurgeUnused (void);
125 void S_PaintChannels(int endtime);
126 void S_InitPaintChannels (void);
128 // picks a channel based on priorities, empty slots, number of channels
129 channel_t *SND_PickChannel(int entnum, int entchannel);
131 // spatializes a channel
132 void SND_Spatialize(channel_t *ch, int isstatic);
134 // initializes cycling through a DMA buffer and returns information on it
135 qboolean SNDDMA_Init(void);
137 // gets the current DMA position
138 int SNDDMA_GetDMAPos(void);
140 // shutdown the DMA xfer.
141 void SNDDMA_Shutdown(void);
143 extern size_t ResampleSfx (const qbyte *in_data, size_t in_length, const snd_format_t* in_format, qbyte *out_data, const char* sfxname);
145 // ====================================================================
146 // User-setable variables
147 // ====================================================================
149 // LordHavoc: increased from 128 to 516 (4 for NUM_AMBIENTS)
150 #define MAX_CHANNELS 516
151 // LordHavoc: increased maximum sound channels from 8 to 128
152 #define MAX_DYNAMIC_CHANNELS 128
155 extern channel_t channels[MAX_CHANNELS];
156 // 0 to MAX_DYNAMIC_CHANNELS-1 = normal entity sounds
157 // MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
158 // MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
160 extern unsigned int total_channels;
163 // Fake dma is a synchronous faking of the DMA progress used for
164 // isolating performance in the renderer. The fakedma_updates is
165 // number of times S_Update() is called per second.
168 extern qboolean fakedma;
169 extern int fakedma_updates;
170 extern int paintedtime;
171 extern int soundtime;
172 extern vec3_t listener_vieworigin;
173 extern vec3_t listener_viewforward;
174 extern vec3_t listener_viewleft;
175 extern vec3_t listener_viewup;
176 extern volatile dma_t *shm;
177 extern volatile dma_t sn;
178 extern vec_t sound_nominal_clip_dist;
180 extern cvar_t loadas8bit;
181 extern cvar_t bgmvolume;
182 extern cvar_t volume;
183 extern cvar_t snd_swapstereo;
185 extern cvar_t cdaudioinitialized;
186 extern cvar_t snd_initialized;
187 extern cvar_t snd_streaming;
189 extern int snd_blocked;
191 void S_LocalSound (char *s);
192 qboolean S_LoadSound (sfx_t *s, int complain);
193 void S_UnloadSound(sfx_t *s);
195 void SND_InitScaletable (void);
196 void SNDDMA_Submit(void);
198 void S_AmbientOff (void);
199 void S_AmbientOn (void);
201 void *S_LockBuffer(void);
202 void S_UnlockBuffer(void);
204 // add some data to the tail of the rawsamples queue
205 void S_RawSamples_Enqueue(short *samples, unsigned int length);
206 // read and remove some data from the head of the rawsamples queue
207 void S_RawSamples_Dequeue(int *samples, unsigned int length);
208 // empty the rawsamples queue
209 void S_RawSamples_ClearQueue(void);
210 // returns how much more data the queue wants, or 0 if it is already full enough
211 int S_RawSamples_QueueWantsMore(void);
213 // resamples one sound buffer into another, while changing the length
214 void S_ResampleBuffer16Stereo(short *input, int inputlength, short *output, int outputlength);
216 // returns the rate that the rawsamples system is running at
217 int S_RawSamples_SampleRate(void);