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 // snd_main.c -- main control for any streaming sound output device
27 #include "cl_collision.h"
33 #define SND_MIN_SPEED 8000
34 #define SND_MAX_SPEED 192000
35 #define SND_MIN_WIDTH 1
36 #define SND_MAX_WIDTH 2
37 #define SND_MIN_CHANNELS 1
38 #define SND_MAX_CHANNELS 8
39 #if SND_LISTENERS != 8
40 # error this data only supports up to 8 channel, update it!
43 speakerlayout_t snd_speakerlayout;
45 // Our speaker layouts are based on ALSA. They differ from those
46 // Win32 and Mac OS X APIs use when there's more than 4 channels.
47 // (rear left + rear right, and front center + LFE are swapped).
48 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
49 static const speakerlayout_t snd_speakerlayouts[] =
54 {0, 45, 0.2f, 0.2f, 0.5f}, // front left
55 {1, 315, 0.2f, 0.2f, 0.5f}, // front right
56 {2, 135, 0.2f, 0.2f, 0.5f}, // rear left
57 {3, 225, 0.2f, 0.2f, 0.5f}, // rear right
58 {4, 0, 0.2f, 0.2f, 0.5f}, // front center
59 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
60 {6, 90, 0.2f, 0.2f, 0.5f}, // side left
61 {7, 180, 0.2f, 0.2f, 0.5f}, // side right
67 {0, 45, 0.2f, 0.2f, 0.5f}, // front left
68 {1, 315, 0.2f, 0.2f, 0.5f}, // front right
69 {2, 135, 0.2f, 0.2f, 0.5f}, // rear left
70 {3, 225, 0.2f, 0.2f, 0.5f}, // rear right
71 {4, 0, 0.2f, 0.2f, 0.5f}, // front center
72 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
78 // these systems sometimes have a subwoofer as well, but it has no
82 {0, 45, 0.3f, 0.3f, 0.8f}, // front left
83 {1, 315, 0.3f, 0.3f, 0.8f}, // front right
84 {2, 135, 0.3f, 0.3f, 0.8f}, // rear left
85 {3, 225, 0.3f, 0.3f, 0.8f}, // rear right
93 // these systems sometimes have a subwoofer as well, but it has no
97 {0, 90, 0.5f, 0.5f, 1}, // side left
98 {1, 270, 0.5f, 0.5f, 1}, // side right
110 {0, 0, 0, 1, 1}, // center
123 // =======================================================================
124 // Internal sound data & structures
125 // =======================================================================
127 channel_t channels[MAX_CHANNELS];
128 unsigned int total_channels;
130 snd_ringbuffer_t *snd_renderbuffer = NULL;
131 static unsigned int soundtime = 0;
132 static unsigned int oldpaintedtime = 0;
133 static unsigned int extrasoundtime = 0;
134 static double snd_starttime = 0.0;
135 qboolean snd_threaded = false;
136 qboolean snd_usethreadedmixing = false;
138 vec3_t listener_origin;
139 matrix4x4_t listener_basematrix;
140 static unsigned char *listener_pvs = NULL;
141 static int listener_pvsbytes = 0;
142 matrix4x4_t listener_matrix[SND_LISTENERS];
143 mempool_t *snd_mempool;
145 // Linked list of known sfx
146 static sfx_t *known_sfx = NULL;
148 static qboolean sound_spatialized = false;
150 qboolean simsound = false;
152 static qboolean recording_sound = false;
155 static int current_swapstereo = false;
156 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
157 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
159 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
160 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
161 spatialmethod_t spatialmethod;
163 // Cvars declared in sound.h (part of the sound API)
164 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
165 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
166 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
167 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
168 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
169 cvar_t snd_soundradius = {CVAR_SAVE, "snd_soundradius", "1200", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
170 cvar_t snd_attenuation_exponent = {CVAR_SAVE, "snd_attenuation_exponent", "1", "Exponent of (1-radius) in sound attenuation formula"};
171 cvar_t snd_attenuation_decibel = {CVAR_SAVE, "snd_attenuation_decibel", "0", "Decibel sound attenuation per sound radius distance"};
172 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
173 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
174 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
175 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
176 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
177 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
178 cvar_t snd_spatialization_prologic = {CVAR_SAVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
179 cvar_t snd_spatialization_prologic_frontangle = {CVAR_SAVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
180 cvar_t snd_spatialization_occlusion = {CVAR_SAVE, "snd_spatialization_occlusion", "1", "enable occlusion testing on spatialized sounds, which simply quiets sounds that are blocked by the world; 1 enables PVS method, 2 enables LineOfSight method, 3 enables both"};
182 // Cvars declared in snd_main.h (shared with other snd_*.c files)
183 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
184 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory); when set to 2, streaming is performed even if this would waste memory"};
185 cvar_t snd_streaming_length = { CVAR_SAVE, "snd_streaming_length", "1", "decompress sounds completely if they are less than this play time when snd_streaming is 1"};
186 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
187 extern cvar_t v_flipped;
188 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
189 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
190 cvar_t snd_maxchannelvolume = {CVAR_SAVE, "snd_maxchannelvolume", "10", "maximum volume of a single sound"};
191 cvar_t snd_softclip = {CVAR_SAVE, "snd_softclip", "0", "Use soft-clipping. Soft-clipping can make the sound more smooth if very high volume levels are used. Enable this option if the dynamic range of the loudspeakers is very low. WARNING: This feature creates distortion and should be considered a last resort."};
192 //cvar_t snd_softclip = {CVAR_SAVE, "snd_softclip", "0", "Use soft-clipping (when set to 2, use it even if output is floating point). Soft-clipping can make the sound more smooth if very high volume levels are used. Enable this option if the dynamic range of the loudspeakers is very low. WARNING: This feature creates distortion and should be considered a last resort."};
193 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
194 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
195 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
196 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
197 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
198 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
199 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
200 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
201 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
202 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
203 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
204 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
205 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
206 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
207 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
208 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
209 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
210 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
211 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
212 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
213 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
214 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
215 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
216 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
217 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
218 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
219 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
220 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
221 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
222 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
223 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
224 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
225 cvar_t snd_channel0volume = {CVAR_SAVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
226 cvar_t snd_channel1volume = {CVAR_SAVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
227 cvar_t snd_channel2volume = {CVAR_SAVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
228 cvar_t snd_channel3volume = {CVAR_SAVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
229 cvar_t snd_channel4volume = {CVAR_SAVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
230 cvar_t snd_channel5volume = {CVAR_SAVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
231 cvar_t snd_channel6volume = {CVAR_SAVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
232 cvar_t snd_channel7volume = {CVAR_SAVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
235 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
236 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
237 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
238 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
239 static cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0", "disables extra sound mixer calls that are meant to reduce the chance of sound breakup at very low framerates"};
240 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
242 // Default sound format is 48KHz, 32bit float, stereo
243 // (48KHz because a lot of onboard sound cards sucks at any other speed)
244 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
245 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "4", "sound output precision, in bytes - 1 = 8bit, 2 = 16bit, 4 = 32bit float"};
246 static cvar_t snd_channels = {CVAR_SAVE, "snd_channels", "2", "number of channels for the sound output (2 for stereo; up to 8 supported for 3D sound)"};
248 static cvar_t snd_startloopingsounds = {0, "snd_startloopingsounds", "1", "whether to start sounds that would loop (you want this to be 1); existing sounds are not affected"};
249 static cvar_t snd_startnonloopingsounds = {0, "snd_startnonloopingsounds", "1", "whether to start sounds that would not loop (you want this to be 1); existing sounds are not affected"};
252 static cvar_t snd_identicalsoundrandomization_time = {0, "snd_identicalsoundrandomization_time", "0.1", "how much seconds to randomly skip (positive) or delay (negative) sounds when multiple identical sounds are started on the same frame"};
253 static cvar_t snd_identicalsoundrandomization_tics = {0, "snd_identicalsoundrandomization_tics", "0", "if nonzero, how many tics to limit sound randomization as defined by snd_identicalsoundrandomization_time"};
256 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
257 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
260 // ====================================================================
262 // ====================================================================
264 void S_FreeSfx (sfx_t *sfx, qboolean force);
266 static void S_Play_Common (float fvol, float attenuation)
269 char name [MAX_QPATH];
273 while (i < Cmd_Argc ())
275 // Get the name, and appends ".wav" as an extension if there's none
276 strlcpy (name, Cmd_Argv (i), sizeof (name));
277 if (!strrchr (name, '.'))
278 strlcat (name, ".wav", sizeof (name));
281 // If we need to get the volume from the command line
284 fvol = atof (Cmd_Argv (i));
288 sfx = S_PrecacheSound (name, true, true);
291 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
293 // Free the sfx if the file didn't exist
295 S_FreeSfx (sfx, false);
297 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
302 static void S_Play_f(void)
304 S_Play_Common (1.0f, 1.0f);
307 static void S_Play2_f(void)
309 S_Play_Common (1.0f, 0.0f);
312 static void S_PlayVol_f(void)
314 S_Play_Common (-1.0f, 0.0f);
317 static void S_SoundList_f (void)
324 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
326 if (sfx->fetcher != NULL)
330 size = (unsigned int)sfx->memsize;
331 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
332 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
333 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
334 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
336 sfx->format.width * 8,
337 (sfx->format.channels == 1) ? "mono" : "stereo",
343 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
345 Con_Printf("Total resident: %i\n", total);
349 static void S_SoundInfo_f(void)
351 if (snd_renderbuffer == NULL)
353 Con_Print("sound system not started\n");
357 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
358 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
359 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
360 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
361 Con_Printf("%5u total_channels\n", total_channels);
365 int S_GetSoundRate(void)
367 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
370 int S_GetSoundChannels(void)
372 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
376 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
378 static void S_SetChannelLayout (void)
381 listener_t swaplistener;
382 listener_t *listeners;
385 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
386 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
388 if (i >= SND_SPEAKERLAYOUTS)
390 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
391 snd_renderbuffer->format.channels);
392 i = SND_SPEAKERLAYOUTS - 1;
395 snd_speakerlayout = snd_speakerlayouts[i];
396 listeners = snd_speakerlayout.listeners;
398 // Swap the left and right channels if snd_swapstereo is set
399 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
401 switch (snd_speakerlayout.channels)
404 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
408 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
411 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
422 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
423 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
424 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
426 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
428 // If we're in the sound engine initialization
429 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
431 layout = SND_CHANNELLAYOUT_STANDARD;
432 Cvar_SetValueQuick (&snd_channellayout, layout);
435 layout = current_channellayout_used;
438 layout = snd_channellayout.integer;
440 // Convert our layout (= ALSA) to the standard layout if necessary
441 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
443 if (layout == SND_CHANNELLAYOUT_STANDARD)
445 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
446 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
449 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
450 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
453 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
454 current_channellayout = snd_channellayout.integer;
455 current_channellayout_used = layout;
459 void S_Startup (void)
461 qboolean fixed_speed, fixed_width, fixed_channels;
462 snd_format_t chosen_fmt;
463 static snd_format_t prev_render_format = {0, 0, 0};
470 if (!snd_initialized.integer)
475 fixed_channels = false;
477 // Get the starting sound format from the cvars
478 chosen_fmt.speed = snd_speed.integer;
479 chosen_fmt.width = snd_width.integer;
480 chosen_fmt.channels = snd_channels.integer;
482 // Check the environment variables to see if the player wants a particular sound format
484 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
486 env = getenv("QUAKE_SOUND_CHANNELS");
490 chosen_fmt.channels = atoi (env);
494 fixed_channels = true;
497 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
499 env = getenv("QUAKE_SOUND_SPEED");
503 chosen_fmt.speed = atoi (env);
510 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
512 env = getenv("QUAKE_SOUND_SAMPLEBITS");
516 chosen_fmt.width = atoi (env) / 8;
523 // Parse the command line to see if the player wants a particular sound format
524 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
525 if (COM_CheckParm ("-sndquad") != 0)
527 chosen_fmt.channels = 4;
528 fixed_channels = true;
530 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
531 else if (COM_CheckParm ("-sndstereo") != 0)
533 chosen_fmt.channels = 2;
534 fixed_channels = true;
536 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
537 else if (COM_CheckParm ("-sndmono") != 0)
539 chosen_fmt.channels = 1;
540 fixed_channels = true;
542 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
543 i = COM_CheckParm ("-sndspeed");
544 if (0 < i && i < com_argc - 1)
546 chosen_fmt.speed = atoi (com_argv[i + 1]);
549 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit or 32bit float sound output
550 i = COM_CheckParm ("-sndbits");
551 if (0 < i && i < com_argc - 1)
553 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
558 // LordHavoc: now you can with the resampler...
559 // You can't change sound speed after start time (not yet supported)
560 if (prev_render_format.speed != 0)
563 if (chosen_fmt.speed != prev_render_format.speed)
565 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
566 prev_render_format.speed);
567 chosen_fmt.speed = prev_render_format.speed;
573 if (chosen_fmt.speed < SND_MIN_SPEED)
575 chosen_fmt.speed = SND_MIN_SPEED;
578 else if (chosen_fmt.speed > SND_MAX_SPEED)
580 chosen_fmt.speed = SND_MAX_SPEED;
584 if (chosen_fmt.width < SND_MIN_WIDTH)
586 chosen_fmt.width = SND_MIN_WIDTH;
589 else if (chosen_fmt.width == 3)
591 chosen_fmt.width = 4;
594 else if (chosen_fmt.width > SND_MAX_WIDTH)
596 chosen_fmt.width = SND_MAX_WIDTH;
600 if (chosen_fmt.channels < SND_MIN_CHANNELS)
602 chosen_fmt.channels = SND_MIN_CHANNELS;
603 fixed_channels = false;
605 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
607 chosen_fmt.channels = SND_MAX_CHANNELS;
608 fixed_channels = false;
611 // create the sound buffer used for sumitting the samples to the plaform-dependent module
614 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
617 chosen_fmt.channels);
619 if (!SndSys_Init(&chosen_fmt))
621 Con_Print("S_Startup: SndSys_Init failed.\n");
622 sound_spatialized = false;
628 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
629 Con_Print ("S_Startup: simulating sound output\n");
632 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
633 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
634 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
637 if (snd_speed.integer != (int)chosen_fmt.speed)
638 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
639 if (snd_width.integer != chosen_fmt.width)
640 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
641 if (snd_channels.integer != chosen_fmt.channels)
642 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
644 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
645 S_SetChannelLayout();
647 snd_starttime = realtime;
649 // If the sound module has already run, add an extra time to make sure
650 // the sound time doesn't decrease, to not confuse playing SFXs
651 if (oldpaintedtime != 0)
653 // The extra time must be a multiple of the render buffer size
654 // to avoid modifying the current position in the buffer,
655 // some modules write directly to a shared (DMA) buffer
656 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
657 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
658 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
660 soundtime = extrasoundtime;
664 snd_renderbuffer->startframe = soundtime;
665 snd_renderbuffer->endframe = soundtime;
666 recording_sound = false;
669 void S_Shutdown(void)
671 if (snd_renderbuffer == NULL)
674 oldpaintedtime = snd_renderbuffer->endframe;
678 Mem_Free(snd_renderbuffer->ring);
679 Mem_Free(snd_renderbuffer);
680 snd_renderbuffer = NULL;
685 sound_spatialized = false;
688 static void S_Restart_f(void)
690 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
691 // So, refuse to do this if we are connected.
692 if(cls.state == ca_connected)
694 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
709 Cvar_RegisterVariable(&volume);
710 Cvar_RegisterVariable(&bgmvolume);
711 Cvar_RegisterVariable(&mastervolume);
712 Cvar_RegisterVariable(&snd_staticvolume);
713 Cvar_RegisterVariable(&snd_entchannel0volume);
714 Cvar_RegisterVariable(&snd_entchannel1volume);
715 Cvar_RegisterVariable(&snd_entchannel2volume);
716 Cvar_RegisterVariable(&snd_entchannel3volume);
717 Cvar_RegisterVariable(&snd_entchannel4volume);
718 Cvar_RegisterVariable(&snd_entchannel5volume);
719 Cvar_RegisterVariable(&snd_entchannel6volume);
720 Cvar_RegisterVariable(&snd_entchannel7volume);
721 Cvar_RegisterVariable(&snd_worldchannel0volume);
722 Cvar_RegisterVariable(&snd_worldchannel1volume);
723 Cvar_RegisterVariable(&snd_worldchannel2volume);
724 Cvar_RegisterVariable(&snd_worldchannel3volume);
725 Cvar_RegisterVariable(&snd_worldchannel4volume);
726 Cvar_RegisterVariable(&snd_worldchannel5volume);
727 Cvar_RegisterVariable(&snd_worldchannel6volume);
728 Cvar_RegisterVariable(&snd_worldchannel7volume);
729 Cvar_RegisterVariable(&snd_playerchannel0volume);
730 Cvar_RegisterVariable(&snd_playerchannel1volume);
731 Cvar_RegisterVariable(&snd_playerchannel2volume);
732 Cvar_RegisterVariable(&snd_playerchannel3volume);
733 Cvar_RegisterVariable(&snd_playerchannel4volume);
734 Cvar_RegisterVariable(&snd_playerchannel5volume);
735 Cvar_RegisterVariable(&snd_playerchannel6volume);
736 Cvar_RegisterVariable(&snd_playerchannel7volume);
737 Cvar_RegisterVariable(&snd_csqcchannel0volume);
738 Cvar_RegisterVariable(&snd_csqcchannel1volume);
739 Cvar_RegisterVariable(&snd_csqcchannel2volume);
740 Cvar_RegisterVariable(&snd_csqcchannel3volume);
741 Cvar_RegisterVariable(&snd_csqcchannel4volume);
742 Cvar_RegisterVariable(&snd_csqcchannel5volume);
743 Cvar_RegisterVariable(&snd_csqcchannel6volume);
744 Cvar_RegisterVariable(&snd_csqcchannel7volume);
745 Cvar_RegisterVariable(&snd_channel0volume);
746 Cvar_RegisterVariable(&snd_channel1volume);
747 Cvar_RegisterVariable(&snd_channel2volume);
748 Cvar_RegisterVariable(&snd_channel3volume);
749 Cvar_RegisterVariable(&snd_channel4volume);
750 Cvar_RegisterVariable(&snd_channel5volume);
751 Cvar_RegisterVariable(&snd_channel6volume);
752 Cvar_RegisterVariable(&snd_channel7volume);
754 Cvar_RegisterVariable(&snd_attenuation_exponent);
755 Cvar_RegisterVariable(&snd_attenuation_decibel);
757 Cvar_RegisterVariable(&snd_spatialization_min_radius);
758 Cvar_RegisterVariable(&snd_spatialization_max_radius);
759 Cvar_RegisterVariable(&snd_spatialization_min);
760 Cvar_RegisterVariable(&snd_spatialization_max);
761 Cvar_RegisterVariable(&snd_spatialization_power);
762 Cvar_RegisterVariable(&snd_spatialization_control);
763 Cvar_RegisterVariable(&snd_spatialization_occlusion);
764 Cvar_RegisterVariable(&snd_spatialization_prologic);
765 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
767 Cvar_RegisterVariable(&snd_speed);
768 Cvar_RegisterVariable(&snd_width);
769 Cvar_RegisterVariable(&snd_channels);
770 Cvar_RegisterVariable(&snd_mutewhenidle);
771 Cvar_RegisterVariable(&snd_maxchannelvolume);
772 Cvar_RegisterVariable(&snd_softclip);
774 Cvar_RegisterVariable(&snd_startloopingsounds);
775 Cvar_RegisterVariable(&snd_startnonloopingsounds);
777 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
778 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
780 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
781 if (COM_CheckParm("-nosound"))
783 // dummy out Play and Play2 because mods stuffcmd that
784 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
785 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
789 snd_mempool = Mem_AllocPool("sound", 0, NULL);
791 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
792 if (COM_CheckParm("-simsound"))
795 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
796 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
797 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
798 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
799 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
800 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
801 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
802 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
804 Cvar_RegisterVariable(&nosound);
805 Cvar_RegisterVariable(&snd_precache);
806 Cvar_RegisterVariable(&snd_initialized);
807 Cvar_RegisterVariable(&snd_streaming);
808 Cvar_RegisterVariable(&snd_streaming_length);
809 Cvar_RegisterVariable(&ambient_level);
810 Cvar_RegisterVariable(&ambient_fade);
811 Cvar_RegisterVariable(&snd_noextraupdate);
812 Cvar_RegisterVariable(&snd_show);
813 Cvar_RegisterVariable(&_snd_mixahead);
814 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
815 Cvar_RegisterVariable(&snd_channellayout);
816 Cvar_RegisterVariable(&snd_soundradius);
818 Cvar_SetValueQuick(&snd_initialized, true);
822 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
823 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
833 Shutdown and free all resources
836 void S_Terminate (void)
842 while (known_sfx != NULL)
843 S_FreeSfx (known_sfx, true);
845 Cvar_SetValueQuick (&snd_initialized, false);
846 Mem_FreePool (&snd_mempool);
855 void S_UnloadAllSounds_f (void)
859 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
860 // So, refuse to do this if we are connected.
861 if(cls.state == ca_connected)
863 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
867 // stop any active sounds
870 // because the ambient sounds will be freed, clear the pointers
871 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
872 ambient_sfxs[i] = NULL;
874 // now free all sounds
875 while (known_sfx != NULL)
876 S_FreeSfx (known_sfx, true);
885 sfx_t changevolume_sfx = {""};
886 sfx_t *S_FindName (const char *name)
890 if (!snd_initialized.integer)
893 if(!strcmp(name, changevolume_sfx.name))
894 return &changevolume_sfx;
896 if (strlen (name) >= sizeof (sfx->name))
898 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
902 // Look for this sound in the list of known sfx
903 // TODO: hash table search?
904 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
905 if(!strcmp (sfx->name, name))
908 // check for # in the beginning, try lookup by soundindex
909 if (name[0] == '#' && name[1])
911 int soundindex = atoi(name + 1);
912 if (soundindex > 0 && soundindex < MAX_SOUNDS)
913 if (cl.sound_precache[soundindex]->name[0])
914 return cl.sound_precache[soundindex];
917 // Add a sfx_t struct for this sound
918 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
919 memset (sfx, 0, sizeof(*sfx));
920 strlcpy (sfx->name, name, sizeof (sfx->name));
921 sfx->memsize = sizeof(*sfx);
922 sfx->next = known_sfx;
934 void S_FreeSfx (sfx_t *sfx, qboolean force)
938 // Do not free a precached sound during purge
939 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
942 if (developer_loading.integer)
943 Con_Printf ("unloading sound %s\n", sfx->name);
945 // Remove it from the list of known sfx
946 if (sfx == known_sfx)
947 known_sfx = known_sfx->next;
952 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
953 if (prev_sfx->next == sfx)
955 prev_sfx->next = sfx->next;
958 if (prev_sfx == NULL)
960 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
965 // Stop all channels using this sfx
966 for (i = 0; i < total_channels; i++)
968 if (channels[i].sfx == sfx)
970 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
971 S_StopChannel (i, true, false);
976 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
977 sfx->fetcher->freesfx(sfx);
987 void S_ClearUsed (void)
993 // Start the ambient sounds and make them loop
994 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
996 // Precache it if it's not done (and pass false for levelsound because these are permanent)
997 if (ambient_sfxs[i] == NULL)
998 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
999 if (ambient_sfxs[i] != NULL)
1001 channels[i].sfx = ambient_sfxs[i];
1002 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1003 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1004 channels[i].basevolume = 0.0f;
1005 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1009 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1010 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1011 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1019 void S_PurgeUnused(void)
1024 // Free all not-precached per-level sfx
1025 for (sfx = known_sfx;sfx;sfx = sfxnext)
1027 sfxnext = sfx->next;
1028 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1029 S_FreeSfx (sfx, false);
1039 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean levelsound)
1043 if (!snd_initialized.integer)
1046 if (name == NULL || name[0] == 0)
1049 sfx = S_FindName (name);
1054 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1055 // previously missing file
1056 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1058 // set a flag to indicate this has been precached for this level or permanently
1060 sfx->flags |= SFXFLAG_LEVELSOUND;
1062 sfx->flags |= SFXFLAG_MENUSOUND;
1064 if (!nosound.integer && snd_precache.integer)
1065 S_LoadSound(sfx, complain);
1076 float S_SoundLength(const char *name)
1080 if (!snd_initialized.integer)
1082 if (name == NULL || name[0] == 0)
1085 sfx = S_FindName(name);
1088 return sfx->total_length / (float) S_GetSoundRate();
1096 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1098 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1106 void S_BlockSound (void)
1117 void S_UnblockSound (void)
1127 Picks a channel based on priorities, empty slots, number of channels
1130 static channel_t *SND_PickChannel(int entnum, int entchannel)
1134 int first_life_left, life_left;
1136 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1138 // Check for replacement sound, or find the best one to replace
1140 first_life_left = 0x7fffffff;
1142 // entity channels try to replace the existing sound on the channel
1143 // channels <= 0 are autochannels
1144 if (IS_CHAN_SINGLE(entchannel))
1146 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1148 ch = &channels[ch_idx];
1149 if (ch->entnum == entnum && ch->entchannel == entchannel)
1151 // always override sound from same entity
1152 S_StopChannel (ch_idx, true, false);
1153 return &channels[ch_idx];
1158 // there was no channel to override, so look for the first empty one
1159 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1161 ch = &channels[ch_idx];
1162 sfx = ch->sfx; // fetch the volatile variable
1165 // no sound on this channel
1166 first_to_die = ch_idx;
1167 goto emptychan_found;
1170 // don't let monster sounds override player sounds
1171 if ((ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity()) && !(entnum == cl.viewentity || entnum == CL_VM_GetViewEntity()))
1174 // don't override looped sounds
1175 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1177 life_left = (int)((double)sfx->total_length - ch->position);
1179 if (life_left < first_life_left)
1181 first_life_left = life_left;
1182 first_to_die = ch_idx;
1186 if (first_to_die == -1)
1189 S_StopChannel (first_to_die, true, false);
1192 return &channels[first_to_die];
1199 Spatializes a channel
1202 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1203 static void SND_Spatialize_WithSfx(channel_t *ch, qboolean isstatic, sfx_t *sfx)
1207 float angle_side, angle_front, angle_factor, mixspeed;
1208 vec_t dist, mastervol, intensity;
1212 // update sound origin if we know about the entity
1213 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1215 if (ch->entnum >= MAX_EDICTS)
1217 //Con_Printf("-- entnum %i origin %f %f %f neworigin %f %f %f\n", ch->entnum, ch->origin[0], ch->origin[1], ch->origin[2], cl.entities[ch->entnum].state_current.origin[0], cl.entities[ch->entnum].state_current.origin[1], cl.entities[ch->entnum].state_current.origin[2]);
1219 if (ch->entnum > MAX_EDICTS)
1220 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1221 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1223 else if (cl.entities[ch->entnum].state_current.active)
1226 //Con_Printf("-- entnum %i origin %f %f %f neworigin %f %f %f\n", ch->entnum, ch->origin[0], ch->origin[1], ch->origin[2], cl.entities[ch->entnum].state_current.origin[0], cl.entities[ch->entnum].state_current.origin[1], cl.entities[ch->entnum].state_current.origin[2]);
1227 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1228 if (model && model->soundfromcenter)
1229 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1231 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1233 else if (cl.csqc_server2csqcentitynumber[ch->entnum])
1235 //Con_Printf("-- entnum %i (client %i) origin %f %f %f neworigin %f %f %f\n", ch->entnum, cl.csqc_server2csqcentitynumber[ch->entnum], ch->origin[0], ch->origin[1], ch->origin[2], cl.entities[ch->entnum].state_current.origin[0], cl.entities[ch->entnum].state_current.origin[1], cl.entities[ch->entnum].state_current.origin[2]);
1237 if (!CL_VM_GetEntitySoundOrigin(cl.csqc_server2csqcentitynumber[ch->entnum] + MAX_EDICTS, ch->origin))
1238 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1242 mastervol = ch->basevolume;
1243 mixspeed = ch->basespeed;
1245 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1247 // Adjust volume of static sounds
1249 mastervol *= snd_staticvolume.value;
1250 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1252 // old legacy separated cvars
1253 if(ch->entnum >= MAX_EDICTS)
1255 switch(ch->entchannel)
1257 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1258 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1259 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1260 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1261 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1262 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1263 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1264 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1268 else if(ch->entnum == 0)
1270 switch(ch->entchannel)
1272 case 0: mastervol *= snd_worldchannel0volume.value; break;
1273 case 1: mastervol *= snd_worldchannel1volume.value; break;
1274 case 2: mastervol *= snd_worldchannel2volume.value; break;
1275 case 3: mastervol *= snd_worldchannel3volume.value; break;
1276 case 4: mastervol *= snd_worldchannel4volume.value; break;
1277 case 5: mastervol *= snd_worldchannel5volume.value; break;
1278 case 6: mastervol *= snd_worldchannel6volume.value; break;
1279 case 7: mastervol *= snd_worldchannel7volume.value; break;
1283 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1285 switch(ch->entchannel)
1287 case 0: mastervol *= snd_playerchannel0volume.value; break;
1288 case 1: mastervol *= snd_playerchannel1volume.value; break;
1289 case 2: mastervol *= snd_playerchannel2volume.value; break;
1290 case 3: mastervol *= snd_playerchannel3volume.value; break;
1291 case 4: mastervol *= snd_playerchannel4volume.value; break;
1292 case 5: mastervol *= snd_playerchannel5volume.value; break;
1293 case 6: mastervol *= snd_playerchannel6volume.value; break;
1294 case 7: mastervol *= snd_playerchannel7volume.value; break;
1300 switch(ch->entchannel)
1302 case 0: mastervol *= snd_entchannel0volume.value; break;
1303 case 1: mastervol *= snd_entchannel1volume.value; break;
1304 case 2: mastervol *= snd_entchannel2volume.value; break;
1305 case 3: mastervol *= snd_entchannel3volume.value; break;
1306 case 4: mastervol *= snd_entchannel4volume.value; break;
1307 case 5: mastervol *= snd_entchannel5volume.value; break;
1308 case 6: mastervol *= snd_entchannel6volume.value; break;
1309 case 7: mastervol *= snd_entchannel7volume.value; break;
1314 switch(ch->entchannel)
1316 case 0: mastervol *= snd_channel0volume.value; break;
1317 case 1: mastervol *= snd_channel1volume.value; break;
1318 case 2: mastervol *= snd_channel2volume.value; break;
1319 case 3: mastervol *= snd_channel3volume.value; break;
1320 case 4: mastervol *= snd_channel4volume.value; break;
1321 case 5: mastervol *= snd_channel5volume.value; break;
1322 case 6: mastervol *= snd_channel6volume.value; break;
1323 case 7: mastervol *= snd_channel7volume.value; break;
1324 default: mastervol *= Cvar_VariableValueOr(va(vabuf, sizeof(vabuf), "snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0); break;
1328 // If this channel does not manage its own volume (like CD tracks)
1329 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1330 mastervol *= volume.value;
1332 if(snd_maxchannelvolume.value > 0)
1334 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1335 mastervol = bound(0.0f, mastervol, 10.0f * snd_maxchannelvolume.value);
1338 // always apply "master"
1339 mastervol *= mastervolume.value;
1341 // add in ReplayGain very late; prevent clipping when close
1343 if(sfx->volume_peak > 0)
1345 // Replaygain support
1346 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1347 mastervol *= sfx->volume_mult;
1348 if(snd_maxchannelvolume.value > 0)
1350 if(mastervol * sfx->volume_peak > snd_maxchannelvolume.value)
1351 mastervol = snd_maxchannelvolume.value / sfx->volume_peak;
1353 // Con_DPrintf("%f\n", fvol);
1356 if(snd_maxchannelvolume.value > 0)
1358 // clamp HERE to keep relative volumes of the channels correct
1359 mastervol = min(mastervol, snd_maxchannelvolume.value);
1362 mastervol = max(0.0f, mastervol);
1364 ch->mixspeed = mixspeed;
1366 // anything coming from the view entity will always be full volume
1367 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1368 if (ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity() || ch->distfade == 0)
1370 ch->prologic_invert = 1;
1371 if (snd_spatialization_prologic.integer != 0)
1373 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1374 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1375 for (i = 2;i < SND_LISTENERS;i++)
1380 for (i = 0;i < SND_LISTENERS;i++)
1381 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1386 // calculate stereo seperation and distance attenuation
1387 VectorSubtract(listener_origin, ch->origin, source_vec);
1388 dist = VectorLength(source_vec);
1389 f = dist * ch->distfade;
1392 ((snd_attenuation_exponent.value == 0) ? 1.0 : pow(1.0 - min(1.0, f), (double)snd_attenuation_exponent.value))
1394 ((snd_attenuation_decibel.value == 0) ? 1.0 : pow(0.1, 0.1 * snd_attenuation_decibel.value * f));
1396 intensity = mastervol * f;
1399 qboolean occluded = false;
1400 if (snd_spatialization_occlusion.integer)
1402 if(snd_spatialization_occlusion.integer & 1)
1403 if(listener_pvs && cl.worldmodel)
1405 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1406 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1410 if(snd_spatialization_occlusion.integer & 2)
1412 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin, ch->origin, ch->origin))
1418 ch->prologic_invert = 1;
1419 if (snd_spatialization_prologic.integer != 0)
1422 angle_factor = 0.5f;
1425 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1426 VectorNormalize(source_vec);
1428 switch(spatialmethod)
1432 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1434 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1435 VectorScale(source_vec, f, source_vec);
1438 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1439 f = spatialmin + spatialdiff * bound(0, f, 1);
1440 VectorScale(source_vec, f, source_vec);
1442 case SPATIAL_THRESH:
1443 f = spatialmin + spatialdiff * (dist < spatialoffset);
1444 VectorScale(source_vec, f, source_vec);
1451 // the z axis needs to be removed and normalized because otherwise the volume would get lower as the sound source goes higher or lower then normal
1453 VectorNormalize(source_vec);
1454 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1455 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1456 if (angle_side > snd_spatialization_prologic_frontangle.value)
1458 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1459 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1460 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1461 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1462 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1463 if (angle_front > 0)
1464 angle_factor = 1 - angle_factor;
1467 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1468 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1471 ch->volume[0] = intensity * sqrt(angle_factor);
1472 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1473 for (i = 2;i < SND_LISTENERS;i++)
1478 for (i = 0;i < SND_LISTENERS;i++)
1480 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1481 VectorNormalize(source_vec);
1483 switch(spatialmethod)
1487 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1489 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1490 VectorScale(source_vec, f, source_vec);
1493 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1494 f = spatialmin + spatialdiff * bound(0, f, 1);
1495 VectorScale(source_vec, f, source_vec);
1497 case SPATIAL_THRESH:
1498 f = spatialmin + spatialdiff * (dist < spatialoffset);
1499 VectorScale(source_vec, f, source_vec);
1506 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1511 for (i = 0;i < SND_LISTENERS;i++)
1515 static void SND_Spatialize(channel_t *ch, qboolean isstatic)
1517 sfx_t *sfx = ch->sfx;
1518 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1522 // =======================================================================
1523 // Start a sound effect
1524 // =======================================================================
1526 static void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic, int entnum, int entchannel, int startpos, float fspeed)
1530 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1534 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1536 if(!snd_startloopingsounds.integer)
1541 if(!snd_startnonloopingsounds.integer)
1545 // Initialize the channel
1546 // a crash was reported on an in-use channel, so check here...
1547 if (target_chan->sfx)
1549 int channelindex = (int)(target_chan - channels);
1550 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1551 S_StopChannel (channelindex, true, false);
1553 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1554 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1555 memset (target_chan, 0, sizeof (*target_chan));
1556 VectorCopy (origin, target_chan->origin);
1557 target_chan->flags = flags;
1558 target_chan->position = startpos; // start of the sound
1559 target_chan->entnum = entnum;
1560 target_chan->entchannel = entchannel;
1562 // If it's a static sound
1565 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1566 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1567 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1570 target_chan->distfade = attenuation / snd_soundradius.value;
1572 // set the listener volumes
1573 S_SetChannelVolume(target_chan - channels, fvol);
1574 S_SetChannelSpeed(target_chan - channels, fspeed);
1575 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1577 // finally, set the sfx pointer, so the channel becomes valid for playback
1578 // and will be noticed by the mixer
1579 target_chan->sfx = sfx;
1583 int S_StartSound_StartPosition_Flags (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation, float startposition, int flags, float fspeed)
1585 channel_t *target_chan, *check, *ch;
1586 int ch_idx, startpos, i;
1588 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1591 if(sfx == &changevolume_sfx)
1593 if (!IS_CHAN_SINGLE(entchannel))
1595 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1597 ch = &channels[ch_idx];
1598 if (ch->entnum == entnum && ch->entchannel == entchannel)
1600 S_SetChannelVolume(ch_idx, fvol);
1601 S_SetChannelSpeed(ch_idx, fspeed);
1602 for(i = 1; i > 0 && (i <= flags || i <= (int) channels[ch_idx].flags); i <<= 1)
1603 if((flags ^ channels[ch_idx].flags) & i)
1604 S_SetChannelFlag(ch_idx, i, (flags & i) != 0);
1605 ch->distfade = attenuation / snd_soundradius.value;
1606 SND_Spatialize(ch, false);
1613 if (sfx->fetcher == NULL)
1616 // Pick a channel to play on
1617 target_chan = SND_PickChannel(entnum, entchannel);
1621 // if an identical sound has also been started this frame, offset the pos
1622 // a bit to keep it from just making the first one louder
1623 check = &channels[NUM_AMBIENTS];
1624 startpos = (int)(startposition * sfx->format.speed);
1627 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1629 if (check == target_chan)
1631 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1633 // calculate max offset
1634 float maxtime = snd_identicalsoundrandomization_time.value;
1635 float maxtics = snd_identicalsoundrandomization_tics.value;
1636 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1638 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1641 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1643 // use negative pos offset to delay this sound effect
1644 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1650 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1652 return (target_chan - channels);
1655 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1657 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, 0, CHANNELFLAG_NONE, 1.0f);
1660 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex, qboolean freesfx)
1665 if (channel_ind >= total_channels)
1668 // we have to lock an audio mutex to prevent crashes if an audio mixer
1669 // thread is currently mixing this channel
1670 // the SndSys_LockRenderBuffer function uses such a mutex in
1671 // threaded sound backends
1672 if (lockmutex && !simsound)
1673 SndSys_LockRenderBuffer();
1675 ch = &channels[channel_ind];
1679 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1680 sfx->fetcher->stopchannel(ch);
1681 ch->fetcher_data = NULL;
1684 S_FreeSfx(sfx, true);
1686 if (lockmutex && !simsound)
1687 SndSys_UnlockRenderBuffer();
1691 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1693 if (ch_ind >= total_channels)
1696 if (flag != CHANNELFLAG_FORCELOOP &&
1697 flag != CHANNELFLAG_PAUSED &&
1698 flag != CHANNELFLAG_FULLVOLUME &&
1699 flag != CHANNELFLAG_LOCALSOUND)
1703 channels[ch_ind].flags |= flag;
1705 channels[ch_ind].flags &= ~flag;
1710 void S_StopSound(int entnum, int entchannel)
1714 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1715 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1717 S_StopChannel (i, true, false);
1722 void S_StopAllSounds (void)
1726 // TOCHECK: is this test necessary?
1727 if (snd_renderbuffer == NULL)
1731 // stop CD audio because it may be using a faketrack
1735 if (simsound || SndSys_LockRenderBuffer ())
1740 for (i = 0; i < total_channels; i++)
1741 if (channels[i].sfx)
1742 S_StopChannel (i, false, false);
1744 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1745 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1747 // Mute the contents of the submittion buffer
1748 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1749 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1750 memset(snd_renderbuffer->ring, clear, memsize);
1753 SndSys_UnlockRenderBuffer ();
1757 void S_PauseGameSounds (qboolean toggle)
1761 for (i = 0; i < total_channels; i++)
1766 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1767 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1771 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1773 channels[ch_ind].basevolume = fvol;
1776 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1778 channels[ch_ind].basespeed = fspeed;
1781 float S_GetChannelPosition (unsigned int ch_ind)
1783 // note: this is NOT accurate yet
1785 channel_t *ch = &channels[ch_ind];
1786 sfx_t *sfx = ch->sfx;
1790 s = ch->position / sfx->format.speed;
1792 if(!snd_usethreadedmixing)
1793 s += _snd_mixahead.value;
1798 float S_GetEntChannelPosition(int entnum, int entchannel)
1803 for (i = 0; i < total_channels; i++)
1806 if (ch->entnum == entnum && ch->entchannel == entchannel)
1807 return S_GetChannelPosition(i);
1809 return -1; // no playing sound in this channel
1817 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1819 channel_t *target_chan;
1821 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1825 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1829 if (total_channels == MAX_CHANNELS)
1831 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1835 target_chan = &channels[total_channels++];
1836 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1842 S_UpdateAmbientSounds
1845 static void S_UpdateAmbientSounds (void)
1849 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1850 int ambient_channel;
1852 unsigned char ambientlevels[NUM_AMBIENTS];
1855 memset(ambientlevels, 0, sizeof(ambientlevels));
1856 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1857 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1859 // Calc ambient sound levels
1860 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1862 chan = &channels[ambient_channel];
1863 sfx = chan->sfx; // fetch the volatile variable
1864 if (sfx == NULL || sfx->fetcher == NULL)
1867 i = ambientlevels[ambient_channel];
1870 vol = i * (1.0f / 256.0f);
1872 // Don't adjust volume too fast
1873 if (chan->basevolume < vol)
1875 chan->basevolume += fade;
1876 if (chan->basevolume > vol)
1877 chan->basevolume = vol;
1879 else if (chan->basevolume > vol)
1881 chan->basevolume -= fade;
1882 if (chan->basevolume < vol)
1883 chan->basevolume = vol;
1886 if (snd_spatialization_prologic.integer != 0)
1888 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1889 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1890 for (i = 2;i < SND_LISTENERS;i++)
1891 chan->volume[i] = 0.0f;
1895 for (i = 0;i < SND_LISTENERS;i++)
1896 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1901 static void S_PaintAndSubmit (void)
1903 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1904 int usesoundtimehack;
1905 static int soundtimehack = -1;
1906 static int oldsoundtime = 0;
1908 if (snd_renderbuffer == NULL || nosound.integer)
1911 // Update sound time
1912 snd_usethreadedmixing = false;
1913 usesoundtimehack = true;
1914 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1916 usesoundtimehack = 1;
1917 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1919 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1921 usesoundtimehack = 2;
1922 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1926 usesoundtimehack = 3;
1927 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1931 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1932 usesoundtimehack = 0;
1933 newsoundtime = SndSys_GetSoundTime();
1935 // if the soundtimehack state changes we need to reset the soundtime
1936 if (soundtimehack != usesoundtimehack)
1938 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1940 // Mute the contents of the submission buffer
1941 if (simsound || SndSys_LockRenderBuffer ())
1946 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1947 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1948 memset(snd_renderbuffer->ring, clear, memsize);
1951 SndSys_UnlockRenderBuffer ();
1954 soundtimehack = usesoundtimehack;
1956 if (!soundtimehack && snd_blocked > 0)
1959 if (snd_usethreadedmixing)
1960 return; // the audio thread will mix its own data
1962 newsoundtime += extrasoundtime;
1963 if (newsoundtime < soundtime)
1965 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1967 unsigned int additionaltime;
1969 // add some time to extrasoundtime make newsoundtime higher
1971 // The extra time must be a multiple of the render buffer size
1972 // to avoid modifying the current position in the buffer,
1973 // some modules write directly to a shared (DMA) buffer
1974 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1975 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1977 extrasoundtime += additionaltime;
1978 newsoundtime += additionaltime;
1979 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1982 else if (!soundtimehack)
1983 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1984 newsoundtime, soundtime);
1986 soundtime = newsoundtime;
1987 recording_sound = (cls.capturevideo.soundrate != 0);
1989 // Lock submitbuffer
1990 if (!simsound && !SndSys_LockRenderBuffer())
1992 // If the lock failed, stop here
1993 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
1997 // Check to make sure that we haven't overshot
1998 paintedtime = snd_renderbuffer->endframe;
1999 if (paintedtime < soundtime)
2000 paintedtime = soundtime;
2002 // mix ahead of current position
2004 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2006 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2007 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2008 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2009 endtime = min(endtime, maxtime);
2011 while (paintedtime < endtime)
2013 unsigned int startoffset;
2014 unsigned int nbframes;
2016 // see how much we can fit in the paint buffer
2017 nbframes = endtime - paintedtime;
2018 // limit to the end of the ring buffer (in case of wrapping)
2019 startoffset = paintedtime % snd_renderbuffer->maxframes;
2020 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2022 // mix into the buffer
2023 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2025 paintedtime += nbframes;
2026 snd_renderbuffer->endframe = paintedtime;
2029 SndSys_UnlockRenderBuffer();
2031 // Remove outdated samples from the ring buffer, if any
2032 if (snd_renderbuffer->startframe < soundtime)
2033 snd_renderbuffer->startframe = soundtime;
2036 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2040 oldsoundtime = soundtime;
2042 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2043 R_TimeReport("audiomix");
2050 Called once each time through the main loop
2053 void S_Update(const matrix4x4_t *listenermatrix)
2055 unsigned int i, j, k;
2056 channel_t *ch, *combine;
2057 matrix4x4_t rotatematrix;
2059 if (snd_renderbuffer == NULL || nosound.integer)
2063 double mindist_trans, maxdist_trans;
2065 spatialmin = snd_spatialization_min.value;
2066 spatialdiff = snd_spatialization_max.value - spatialmin;
2068 if(snd_spatialization_control.value)
2070 spatialpower = snd_spatialization_power.value;
2072 if(spatialpower == 0)
2074 spatialmethod = SPATIAL_LOG;
2075 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2076 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2080 spatialmethod = SPATIAL_POW;
2081 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2082 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2085 if(mindist_trans - maxdist_trans == 0)
2087 spatialmethod = SPATIAL_THRESH;
2088 mindist_trans = snd_spatialization_min_radius.value;
2092 spatialoffset = mindist_trans;
2093 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2097 spatialmethod = SPATIAL_NONE;
2101 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2102 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2103 current_channellayout != snd_channellayout.integer)
2104 S_SetChannelLayout();
2106 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2107 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2108 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2110 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2113 Mem_Free(listener_pvs);
2114 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2115 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2117 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2123 Mem_Free(listener_pvs);
2124 listener_pvs = NULL;
2126 listener_pvsbytes = 0;
2129 // calculate the current matrices
2130 for (j = 0;j < SND_LISTENERS;j++)
2132 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2133 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2134 // I think this should now do this:
2135 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2136 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2137 // angle has to be taken negative)
2138 // 2. create a transform which first rotates and moves its argument
2139 // into the player's view coordinates (using basematrix which is
2140 // an inverted "absolute" listener matrix), then applies the
2141 // rotation matrix for the ear
2142 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2143 // does not actually refer to an entity?
2146 // update general area ambient sound sources
2147 S_UpdateAmbientSounds ();
2150 R_TimeReport("audioprep");
2152 // update spatialization for static and dynamic sounds
2153 cls.soundstats.totalsounds = 0;
2154 cls.soundstats.mixedsounds = 0;
2155 ch = channels+NUM_AMBIENTS;
2156 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2160 cls.soundstats.totalsounds++;
2162 // respatialize channel
2163 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2165 // try to combine static sounds with a previous channel of the same
2166 // sound effect so we don't mix five torches every frame
2167 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2169 // no need to merge silent channels
2170 for (j = 0;j < SND_LISTENERS;j++)
2173 if (j == SND_LISTENERS)
2175 // if the last combine chosen isn't suitable, find a new one
2176 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2180 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2182 if (channels[j].sfx == ch->sfx)
2184 combine = channels + j;
2189 if (combine && combine != ch && combine->sfx == ch->sfx)
2191 for (j = 0;j < SND_LISTENERS;j++)
2193 combine->volume[j] += ch->volume[j];
2198 for (k = 0;k < SND_LISTENERS;k++)
2201 if (k < SND_LISTENERS)
2202 cls.soundstats.mixedsounds++;
2204 R_TimeReport("audiospatialize");
2206 sound_spatialized = true;
2209 if (snd_show.integer)
2210 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2215 void S_ExtraUpdate (void)
2217 if (snd_noextraupdate.integer || !sound_spatialized)
2223 qboolean S_LocalSound (const char *sound)
2228 if (!snd_initialized.integer || nosound.integer)
2231 sfx = S_PrecacheSound (sound, true, false);
2234 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2238 // menu sounds must not be freed on level change
2239 sfx->flags |= SFXFLAG_MENUSOUND;
2241 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2242 // which we no longer support anyway
2243 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2244 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2248 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;