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
26 #include "snd_modplug.h"
28 #include "cl_collision.h"
31 #define SND_MIN_SPEED 8000
32 #define SND_MAX_SPEED 96000
33 #define SND_MIN_WIDTH 1
34 #define SND_MAX_WIDTH 2
35 #define SND_MIN_CHANNELS 1
36 #define SND_MAX_CHANNELS 8
37 #if SND_LISTENERS != 8
38 # error this data only supports up to 8 channel, update it!
41 speakerlayout_t snd_speakerlayout;
43 // Our speaker layouts are based on ALSA. They differ from those
44 // Win32 and Mac OS X APIs use when there's more than 4 channels.
45 // (rear left + rear right, and front center + LFE are swapped).
46 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
47 static const speakerlayout_t snd_speakerlayouts[] =
52 {0, 45, 0.2, 0.2, 0.5}, // front left
53 {1, 315, 0.2, 0.2, 0.5}, // front right
54 {2, 135, 0.2, 0.2, 0.5}, // rear left
55 {3, 225, 0.2, 0.2, 0.5}, // rear right
56 {4, 0, 0.2, 0.2, 0.5}, // front center
57 {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)
58 {6, 90, 0.2, 0.2, 0.5}, // side left
59 {7, 180, 0.2, 0.2, 0.5}, // side right
65 {0, 45, 0.2, 0.2, 0.5}, // front left
66 {1, 315, 0.2, 0.2, 0.5}, // front right
67 {2, 135, 0.2, 0.2, 0.5}, // rear left
68 {3, 225, 0.2, 0.2, 0.5}, // rear right
69 {4, 0, 0.2, 0.2, 0.5}, // front center
70 {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)
76 // these systems sometimes have a subwoofer as well, but it has no
80 {0, 45, 0.3, 0.3, 0.8}, // front left
81 {1, 315, 0.3, 0.3, 0.8}, // front right
82 {2, 135, 0.3, 0.3, 0.8}, // rear left
83 {3, 225, 0.3, 0.3, 0.8}, // rear right
91 // these systems sometimes have a subwoofer as well, but it has no
95 {0, 90, 0.5, 0.5, 1}, // side left
96 {1, 270, 0.5, 0.5, 1}, // side right
108 {0, 0, 0, 1, 1}, // center
121 // =======================================================================
122 // Internal sound data & structures
123 // =======================================================================
125 channel_t channels[MAX_CHANNELS];
126 unsigned int total_channels;
128 snd_ringbuffer_t *snd_renderbuffer = NULL;
129 static unsigned int soundtime = 0;
130 static unsigned int oldpaintedtime = 0;
131 static unsigned int extrasoundtime = 0;
132 static double snd_starttime = 0.0;
133 qboolean snd_threaded = false;
134 qboolean snd_usethreadedmixing = false;
136 vec3_t listener_origin;
137 matrix4x4_t listener_basematrix;
138 static unsigned char *listener_pvs = NULL;
139 static int listener_pvsbytes = 0;
140 matrix4x4_t listener_matrix[SND_LISTENERS];
141 mempool_t *snd_mempool;
143 // Linked list of known sfx
144 static sfx_t *known_sfx = NULL;
146 static qboolean sound_spatialized = false;
148 qboolean simsound = false;
150 static qboolean recording_sound = false;
153 static int current_swapstereo = false;
154 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
155 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
157 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
158 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
159 spatialmethod_t spatialmethod;
161 // Cvars declared in sound.h (part of the sound API)
162 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
163 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
164 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
165 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
166 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
167 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)"};
168 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
169 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
170 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
171 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
172 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
173 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
174 cvar_t snd_spatialization_prologic = {CVAR_SAVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
175 cvar_t snd_spatialization_prologic_frontangle = {CVAR_SAVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
176 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"};
178 // Cvars declared in snd_main.h (shared with other snd_*.c files)
179 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
180 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)"};
181 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
182 extern cvar_t v_flipped;
183 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
184 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
185 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
186 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
187 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
188 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
189 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
190 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
191 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
192 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
193 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
194 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
195 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
196 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
197 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
198 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
199 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
200 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
201 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
202 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
203 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
204 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
205 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
206 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
207 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
208 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
209 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
210 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
211 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
212 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
213 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
214 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
215 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
216 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
217 cvar_t snd_channel0volume = {CVAR_SAVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
218 cvar_t snd_channel1volume = {CVAR_SAVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
219 cvar_t snd_channel2volume = {CVAR_SAVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
220 cvar_t snd_channel3volume = {CVAR_SAVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
221 cvar_t snd_channel4volume = {CVAR_SAVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
222 cvar_t snd_channel5volume = {CVAR_SAVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
223 cvar_t snd_channel6volume = {CVAR_SAVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
224 cvar_t snd_channel7volume = {CVAR_SAVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
227 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
228 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
229 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
230 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
231 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"};
232 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
234 // Default sound format is 48KHz, 16-bit, stereo
235 // (48KHz because a lot of onboard sound cards sucks at any other speed)
236 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
237 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
238 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)"};
240 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"};
241 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"};
244 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
245 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
248 // ====================================================================
250 // ====================================================================
252 void S_FreeSfx (sfx_t *sfx, qboolean force);
254 static void S_Play_Common (float fvol, float attenuation)
257 char name [MAX_QPATH];
261 while (i < Cmd_Argc ())
263 // Get the name, and appends ".wav" as an extension if there's none
264 strlcpy (name, Cmd_Argv (i), sizeof (name));
265 if (!strrchr (name, '.'))
266 strlcat (name, ".wav", sizeof (name));
269 // If we need to get the volume from the command line
272 fvol = atof (Cmd_Argv (i));
276 sfx = S_PrecacheSound (name, true, true);
279 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
281 // Free the sfx if the file didn't exist
283 S_FreeSfx (sfx, false);
285 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
290 static void S_Play_f(void)
292 S_Play_Common (1.0f, 1.0f);
295 static void S_Play2_f(void)
297 S_Play_Common (1.0f, 0.0f);
300 static void S_PlayVol_f(void)
302 S_Play_Common (-1.0f, 0.0f);
305 static void S_SoundList_f (void)
312 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
314 if (sfx->fetcher != NULL)
317 const snd_format_t* format;
320 format = sfx->fetcher->getfmt(sfx);
321 Con_Printf ("%c%c%c(%2db, %6s) %8i : %s\n",
322 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
323 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
324 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
326 (format->channels == 1) ? "mono" : "stereo",
332 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
334 Con_Printf("Total resident: %i\n", total);
338 void S_SoundInfo_f(void)
340 if (snd_renderbuffer == NULL)
342 Con_Print("sound system not started\n");
346 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
347 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
348 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
349 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
350 Con_Printf("%5u total_channels\n", total_channels);
354 int S_GetSoundRate(void)
356 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
359 int S_GetSoundChannels(void)
361 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
365 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
367 static const snd_format_t thresholds [] =
369 // speed width channels
370 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
376 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
378 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
379 unsigned int speed_level, width_level, channels_level;
381 // If we have reached the minimum values, there's nothing more we can do
382 if ((format->speed == thresholds[0].speed || fixed_speed) &&
383 (format->width == thresholds[0].width || fixed_width) &&
384 (format->channels == thresholds[0].channels || fixed_channels))
387 // Check the min and max values
388 #define CHECK_BOUNDARIES(param) \
389 if (format->param < thresholds[0].param) \
391 format->param = thresholds[0].param; \
394 if (format->param > thresholds[nb_thresholds - 1].param) \
396 format->param = thresholds[nb_thresholds - 1].param; \
399 CHECK_BOUNDARIES(speed);
400 CHECK_BOUNDARIES(width);
401 CHECK_BOUNDARIES(channels);
402 #undef CHECK_BOUNDARIES
404 // Find the level of each parameter
405 #define FIND_LEVEL(param) \
407 while (param##_level < nb_thresholds - 1) \
409 if (format->param <= thresholds[param##_level].param) \
416 FIND_LEVEL(channels);
419 // Decrease the parameter with the highest level to the previous level
420 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
422 format->channels = thresholds[channels_level - 1].channels;
425 if (speed_level >= width_level && !fixed_speed)
427 format->speed = thresholds[speed_level - 1].speed;
431 format->width = thresholds[width_level - 1].width;
436 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
438 static void S_SetChannelLayout (void)
441 listener_t swaplistener;
442 listener_t *listeners;
445 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
446 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
448 if (i >= SND_SPEAKERLAYOUTS)
450 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
451 snd_renderbuffer->format.channels);
452 i = SND_SPEAKERLAYOUTS - 1;
455 snd_speakerlayout = snd_speakerlayouts[i];
456 listeners = snd_speakerlayout.listeners;
458 // Swap the left and right channels if snd_swapstereo is set
459 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
461 switch (snd_speakerlayout.channels)
464 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
468 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
471 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
482 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
483 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
484 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
486 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
488 // If we're in the sound engine initialization
489 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
491 layout = SND_CHANNELLAYOUT_STANDARD;
492 Cvar_SetValueQuick (&snd_channellayout, layout);
495 layout = current_channellayout_used;
498 layout = snd_channellayout.integer;
500 // Convert our layout (= ALSA) to the standard layout if necessary
501 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
503 if (layout == SND_CHANNELLAYOUT_STANDARD)
505 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
506 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
509 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
510 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
513 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
514 current_channellayout = snd_channellayout.integer;
515 current_channellayout_used = layout;
519 void S_Startup (void)
521 qboolean fixed_speed, fixed_width, fixed_channels;
522 snd_format_t chosen_fmt;
523 static snd_format_t prev_render_format = {0, 0, 0};
530 if (!snd_initialized.integer)
535 fixed_channels = false;
537 // Get the starting sound format from the cvars
538 chosen_fmt.speed = snd_speed.integer;
539 chosen_fmt.width = snd_width.integer;
540 chosen_fmt.channels = snd_channels.integer;
542 // Check the environment variables to see if the player wants a particular sound format
544 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
546 env = getenv("QUAKE_SOUND_CHANNELS");
550 chosen_fmt.channels = atoi (env);
554 fixed_channels = true;
557 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
559 env = getenv("QUAKE_SOUND_SPEED");
563 chosen_fmt.speed = atoi (env);
570 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
572 env = getenv("QUAKE_SOUND_SAMPLEBITS");
576 chosen_fmt.width = atoi (env) / 8;
583 // Parse the command line to see if the player wants a particular sound format
584 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
585 if (COM_CheckParm ("-sndquad") != 0)
587 chosen_fmt.channels = 4;
588 fixed_channels = true;
590 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
591 else if (COM_CheckParm ("-sndstereo") != 0)
593 chosen_fmt.channels = 2;
594 fixed_channels = true;
596 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
597 else if (COM_CheckParm ("-sndmono") != 0)
599 chosen_fmt.channels = 1;
600 fixed_channels = true;
602 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
603 i = COM_CheckParm ("-sndspeed");
604 if (0 < i && i < com_argc - 1)
606 chosen_fmt.speed = atoi (com_argv[i + 1]);
609 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
610 i = COM_CheckParm ("-sndbits");
611 if (0 < i && i < com_argc - 1)
613 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
617 // You can't change sound speed after start time (not yet supported)
618 if (prev_render_format.speed != 0)
621 if (chosen_fmt.speed != prev_render_format.speed)
623 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
624 prev_render_format.speed);
625 chosen_fmt.speed = prev_render_format.speed;
630 if (chosen_fmt.speed < SND_MIN_SPEED)
632 chosen_fmt.speed = SND_MIN_SPEED;
635 else if (chosen_fmt.speed > SND_MAX_SPEED)
637 chosen_fmt.speed = SND_MAX_SPEED;
641 if (chosen_fmt.width < SND_MIN_WIDTH)
643 chosen_fmt.width = SND_MIN_WIDTH;
646 else if (chosen_fmt.width > SND_MAX_WIDTH)
648 chosen_fmt.width = SND_MAX_WIDTH;
652 if (chosen_fmt.channels < SND_MIN_CHANNELS)
654 chosen_fmt.channels = SND_MIN_CHANNELS;
655 fixed_channels = false;
657 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
659 chosen_fmt.channels = SND_MAX_CHANNELS;
660 fixed_channels = false;
663 // create the sound buffer used for sumitting the samples to the plaform-dependent module
666 snd_format_t suggest_fmt;
672 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
673 chosen_fmt.speed, chosen_fmt.width * 8,
674 chosen_fmt.channels);
676 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
677 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
681 Con_Printf("S_Startup: sound output initialization FAILED\n");
683 // If the module is suggesting another one
684 if (suggest_fmt.speed != 0)
686 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
687 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
688 suggest_fmt.speed, suggest_fmt.width * 8,
689 suggest_fmt.channels);
691 // Else, try to find a less resource-demanding format
692 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
697 // If we haven't found a suitable format
700 Con_Print("S_Startup: SndSys_Init failed.\n");
701 sound_spatialized = false;
707 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
708 Con_Print ("S_Startup: simulating sound output\n");
711 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
712 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
713 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
716 if (snd_speed.integer != (int)chosen_fmt.speed)
717 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
718 if (snd_width.integer != chosen_fmt.width)
719 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
720 if (snd_channels.integer != chosen_fmt.channels)
721 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
723 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
724 S_SetChannelLayout();
726 snd_starttime = realtime;
728 // If the sound module has already run, add an extra time to make sure
729 // the sound time doesn't decrease, to not confuse playing SFXs
730 if (oldpaintedtime != 0)
732 // The extra time must be a multiple of the render buffer size
733 // to avoid modifying the current position in the buffer,
734 // some modules write directly to a shared (DMA) buffer
735 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
736 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
737 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
739 soundtime = extrasoundtime;
743 snd_renderbuffer->startframe = soundtime;
744 snd_renderbuffer->endframe = soundtime;
745 recording_sound = false;
748 void S_Shutdown(void)
750 if (snd_renderbuffer == NULL)
753 oldpaintedtime = snd_renderbuffer->endframe;
757 Mem_Free(snd_renderbuffer->ring);
758 Mem_Free(snd_renderbuffer);
759 snd_renderbuffer = NULL;
764 sound_spatialized = false;
767 void S_Restart_f(void)
769 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
770 // So, refuse to do this if we are connected.
771 if(cls.state == ca_connected)
773 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
788 Cvar_RegisterVariable(&volume);
789 Cvar_RegisterVariable(&bgmvolume);
790 Cvar_RegisterVariable(&mastervolume);
791 Cvar_RegisterVariable(&snd_staticvolume);
792 Cvar_RegisterVariable(&snd_entchannel0volume);
793 Cvar_RegisterVariable(&snd_entchannel1volume);
794 Cvar_RegisterVariable(&snd_entchannel2volume);
795 Cvar_RegisterVariable(&snd_entchannel3volume);
796 Cvar_RegisterVariable(&snd_entchannel4volume);
797 Cvar_RegisterVariable(&snd_entchannel5volume);
798 Cvar_RegisterVariable(&snd_entchannel6volume);
799 Cvar_RegisterVariable(&snd_entchannel7volume);
800 Cvar_RegisterVariable(&snd_worldchannel0volume);
801 Cvar_RegisterVariable(&snd_worldchannel1volume);
802 Cvar_RegisterVariable(&snd_worldchannel2volume);
803 Cvar_RegisterVariable(&snd_worldchannel3volume);
804 Cvar_RegisterVariable(&snd_worldchannel4volume);
805 Cvar_RegisterVariable(&snd_worldchannel5volume);
806 Cvar_RegisterVariable(&snd_worldchannel6volume);
807 Cvar_RegisterVariable(&snd_worldchannel7volume);
808 Cvar_RegisterVariable(&snd_playerchannel0volume);
809 Cvar_RegisterVariable(&snd_playerchannel1volume);
810 Cvar_RegisterVariable(&snd_playerchannel2volume);
811 Cvar_RegisterVariable(&snd_playerchannel3volume);
812 Cvar_RegisterVariable(&snd_playerchannel4volume);
813 Cvar_RegisterVariable(&snd_playerchannel5volume);
814 Cvar_RegisterVariable(&snd_playerchannel6volume);
815 Cvar_RegisterVariable(&snd_playerchannel7volume);
816 Cvar_RegisterVariable(&snd_csqcchannel0volume);
817 Cvar_RegisterVariable(&snd_csqcchannel1volume);
818 Cvar_RegisterVariable(&snd_csqcchannel2volume);
819 Cvar_RegisterVariable(&snd_csqcchannel3volume);
820 Cvar_RegisterVariable(&snd_csqcchannel4volume);
821 Cvar_RegisterVariable(&snd_csqcchannel5volume);
822 Cvar_RegisterVariable(&snd_csqcchannel6volume);
823 Cvar_RegisterVariable(&snd_csqcchannel7volume);
824 Cvar_RegisterVariable(&snd_channel0volume);
825 Cvar_RegisterVariable(&snd_channel1volume);
826 Cvar_RegisterVariable(&snd_channel2volume);
827 Cvar_RegisterVariable(&snd_channel3volume);
828 Cvar_RegisterVariable(&snd_channel4volume);
829 Cvar_RegisterVariable(&snd_channel5volume);
830 Cvar_RegisterVariable(&snd_channel6volume);
831 Cvar_RegisterVariable(&snd_channel7volume);
833 Cvar_RegisterVariable(&snd_spatialization_min_radius);
834 Cvar_RegisterVariable(&snd_spatialization_max_radius);
835 Cvar_RegisterVariable(&snd_spatialization_min);
836 Cvar_RegisterVariable(&snd_spatialization_max);
837 Cvar_RegisterVariable(&snd_spatialization_power);
838 Cvar_RegisterVariable(&snd_spatialization_control);
839 Cvar_RegisterVariable(&snd_spatialization_occlusion);
840 Cvar_RegisterVariable(&snd_spatialization_prologic);
841 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
843 Cvar_RegisterVariable(&snd_speed);
844 Cvar_RegisterVariable(&snd_width);
845 Cvar_RegisterVariable(&snd_channels);
846 Cvar_RegisterVariable(&snd_mutewhenidle);
848 Cvar_RegisterVariable(&snd_startloopingsounds);
849 Cvar_RegisterVariable(&snd_startnonloopingsounds);
851 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
852 if (COM_CheckParm("-nosound"))
854 // dummy out Play and Play2 because mods stuffcmd that
855 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
856 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
860 snd_mempool = Mem_AllocPool("sound", 0, NULL);
862 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
863 if (COM_CheckParm("-simsound"))
866 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
867 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
868 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
869 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
870 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
871 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
872 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
873 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
875 Cvar_RegisterVariable(&nosound);
876 Cvar_RegisterVariable(&snd_precache);
877 Cvar_RegisterVariable(&snd_initialized);
878 Cvar_RegisterVariable(&snd_streaming);
879 Cvar_RegisterVariable(&ambient_level);
880 Cvar_RegisterVariable(&ambient_fade);
881 Cvar_RegisterVariable(&snd_noextraupdate);
882 Cvar_RegisterVariable(&snd_show);
883 Cvar_RegisterVariable(&_snd_mixahead);
884 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
885 Cvar_RegisterVariable(&snd_channellayout);
886 Cvar_RegisterVariable(&snd_soundradius);
888 Cvar_SetValueQuick(&snd_initialized, true);
892 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
893 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
896 ModPlug_OpenLibrary ();
904 Shutdown and free all resources
907 void S_Terminate (void)
910 ModPlug_CloseLibrary ();
914 while (known_sfx != NULL)
915 S_FreeSfx (known_sfx, true);
917 Cvar_SetValueQuick (&snd_initialized, false);
918 Mem_FreePool (&snd_mempool);
927 void S_UnloadAllSounds_f (void)
931 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
932 // So, refuse to do this if we are connected.
933 if(cls.state == ca_connected)
935 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
939 // stop any active sounds
942 // because the ambient sounds will be freed, clear the pointers
943 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
944 ambient_sfxs[i] = NULL;
946 // now free all sounds
947 while (known_sfx != NULL)
948 S_FreeSfx (known_sfx, true);
957 sfx_t changevolume_sfx = {""};
958 sfx_t *S_FindName (const char *name)
962 if (!snd_initialized.integer)
965 if(!strcmp(name, changevolume_sfx.name))
966 return &changevolume_sfx;
968 if (strlen (name) >= sizeof (sfx->name))
970 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
974 // Look for this sound in the list of known sfx
975 // TODO: hash table search?
976 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
977 if(!strcmp (sfx->name, name))
980 // Add a sfx_t struct for this sound
981 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
982 memset (sfx, 0, sizeof(*sfx));
983 strlcpy (sfx->name, name, sizeof (sfx->name));
984 sfx->memsize = sizeof(*sfx);
985 sfx->next = known_sfx;
997 void S_FreeSfx (sfx_t *sfx, qboolean force)
1001 // Do not free a precached sound during purge
1002 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1005 if (developer_loading.integer)
1006 Con_Printf ("unloading sound %s\n", sfx->name);
1008 // Remove it from the list of known sfx
1009 if (sfx == known_sfx)
1010 known_sfx = known_sfx->next;
1015 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
1016 if (prev_sfx->next == sfx)
1018 prev_sfx->next = sfx->next;
1021 if (prev_sfx == NULL)
1023 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1028 // Stop all channels using this sfx
1029 for (i = 0; i < total_channels; i++)
1031 if (channels[i].sfx == sfx)
1033 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
1034 S_StopChannel (i, true, false);
1039 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
1040 sfx->fetcher->free (sfx->fetcher_data);
1050 void S_ClearUsed (void)
1056 // Start the ambient sounds and make them loop
1057 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1059 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1060 if (ambient_sfxs[i] == NULL)
1061 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1062 if (ambient_sfxs[i] != NULL)
1064 channels[i].sfx = ambient_sfxs[i];
1065 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1066 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1067 channels[i].master_vol = 0;
1071 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1072 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1073 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1081 void S_PurgeUnused(void)
1086 // Free all not-precached per-level sfx
1087 for (sfx = known_sfx;sfx;sfx = sfxnext)
1089 sfxnext = sfx->next;
1090 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1091 S_FreeSfx (sfx, false);
1101 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean levelsound)
1105 if (!snd_initialized.integer)
1108 if (name == NULL || name[0] == 0)
1111 sfx = S_FindName (name);
1116 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1117 // previously missing file
1118 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1120 // set a flag to indicate this has been precached for this level or permanently
1122 sfx->flags |= SFXFLAG_LEVELSOUND;
1124 sfx->flags |= SFXFLAG_MENUSOUND;
1126 if (!nosound.integer && snd_precache.integer)
1127 S_LoadSound(sfx, complain);
1138 float S_SoundLength(const char *name)
1142 if (!snd_initialized.integer)
1144 if (name == NULL || name[0] == 0)
1147 sfx = S_FindName(name);
1150 return sfx->total_length / (float) S_GetSoundRate();
1158 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1160 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1168 void S_BlockSound (void)
1179 void S_UnblockSound (void)
1189 Picks a channel based on priorities, empty slots, number of channels
1192 channel_t *SND_PickChannel(int entnum, int entchannel)
1196 int first_life_left, life_left;
1198 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1200 // Check for replacement sound, or find the best one to replace
1202 first_life_left = 0x7fffffff;
1204 // entity channels try to replace the existing sound on the channel
1205 // channels <= 0 are autochannels
1206 if (IS_CHAN_SINGLE(entchannel))
1208 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1210 ch = &channels[ch_idx];
1211 if (ch->entnum == entnum && ch->entchannel == entchannel)
1213 // always override sound from same entity
1214 S_StopChannel (ch_idx, true, false);
1215 return &channels[ch_idx];
1220 // there was no channel to override, so look for the first empty one
1221 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1223 ch = &channels[ch_idx];
1224 sfx = ch->sfx; // fetch the volatile variable
1227 // no sound on this channel
1228 first_to_die = ch_idx;
1229 goto emptychan_found;
1232 // don't let monster sounds override player sounds
1233 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1236 // don't override looped sounds
1237 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1239 life_left = sfx->total_length - ch->pos;
1241 if (life_left < first_life_left)
1243 first_life_left = life_left;
1244 first_to_die = ch_idx;
1248 if (first_to_die == -1)
1251 S_StopChannel (first_to_die, true, false);
1254 return &channels[first_to_die];
1261 Spatializes a channel
1264 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1265 void SND_Spatialize_WithSfx(channel_t *ch, qboolean isstatic, sfx_t *sfx)
1269 float angle_side, angle_front, angle_factor;
1270 vec_t dist, mastervol, intensity, vol;
1273 // update sound origin if we know about the entity
1274 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1276 if (ch->entnum >= MAX_EDICTS)
1278 //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]);
1280 if (ch->entnum > MAX_EDICTS)
1281 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1282 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1284 else if (cl.entities[ch->entnum].state_current.active)
1287 //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]);
1288 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1289 if (model && model->soundfromcenter)
1290 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1292 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1296 mastervol = ch->master_vol;
1298 // Adjust volume of static sounds
1300 mastervol *= snd_staticvolume.value;
1301 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1303 // old legacy separated cvars
1304 if(ch->entnum >= MAX_EDICTS)
1306 switch(ch->entchannel)
1308 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1309 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1310 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1311 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1312 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1313 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1314 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1315 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1319 else if(ch->entnum == 0)
1321 switch(ch->entchannel)
1323 case 0: mastervol *= snd_worldchannel0volume.value; break;
1324 case 1: mastervol *= snd_worldchannel1volume.value; break;
1325 case 2: mastervol *= snd_worldchannel2volume.value; break;
1326 case 3: mastervol *= snd_worldchannel3volume.value; break;
1327 case 4: mastervol *= snd_worldchannel4volume.value; break;
1328 case 5: mastervol *= snd_worldchannel5volume.value; break;
1329 case 6: mastervol *= snd_worldchannel6volume.value; break;
1330 case 7: mastervol *= snd_worldchannel7volume.value; break;
1334 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1336 switch(ch->entchannel)
1338 case 0: mastervol *= snd_playerchannel0volume.value; break;
1339 case 1: mastervol *= snd_playerchannel1volume.value; break;
1340 case 2: mastervol *= snd_playerchannel2volume.value; break;
1341 case 3: mastervol *= snd_playerchannel3volume.value; break;
1342 case 4: mastervol *= snd_playerchannel4volume.value; break;
1343 case 5: mastervol *= snd_playerchannel5volume.value; break;
1344 case 6: mastervol *= snd_playerchannel6volume.value; break;
1345 case 7: mastervol *= snd_playerchannel7volume.value; break;
1351 switch(ch->entchannel)
1353 case 0: mastervol *= snd_entchannel0volume.value; break;
1354 case 1: mastervol *= snd_entchannel1volume.value; break;
1355 case 2: mastervol *= snd_entchannel2volume.value; break;
1356 case 3: mastervol *= snd_entchannel3volume.value; break;
1357 case 4: mastervol *= snd_entchannel4volume.value; break;
1358 case 5: mastervol *= snd_entchannel5volume.value; break;
1359 case 6: mastervol *= snd_entchannel6volume.value; break;
1360 case 7: mastervol *= snd_entchannel7volume.value; break;
1365 switch(ch->entchannel)
1367 case 0: mastervol *= snd_channel0volume.value; break;
1368 case 1: mastervol *= snd_channel1volume.value; break;
1369 case 2: mastervol *= snd_channel2volume.value; break;
1370 case 3: mastervol *= snd_channel3volume.value; break;
1371 case 4: mastervol *= snd_channel4volume.value; break;
1372 case 5: mastervol *= snd_channel5volume.value; break;
1373 case 6: mastervol *= snd_channel6volume.value; break;
1374 case 7: mastervol *= snd_channel7volume.value; break;
1375 default: mastervol *= Cvar_VariableValueOr(va("snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0); break;
1379 // If this channel does not manage its own volume (like CD tracks)
1380 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1381 mastervol *= volume.value;
1383 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1384 mastervol = bound(0, mastervol, 655360);
1386 // always apply "master"
1387 mastervol *= mastervolume.value;
1389 // add in ReplayGain very late; prevent clipping when close
1391 if(sfx->volume_peak > 0)
1393 // Replaygain support
1394 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1395 mastervol *= sfx->volume_mult;
1396 if(mastervol * sfx->volume_peak > 65536)
1397 mastervol = 65536 / sfx->volume_peak;
1398 // Con_DPrintf("%f\n", fvol);
1401 // clamp HERE to keep relative volumes of the channels correct
1402 mastervol = bound(0, mastervol, 65536);
1404 // anything coming from the view entity will always be full volume
1405 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1406 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1408 ch->prologic_invert = 1;
1409 if (snd_spatialization_prologic.integer != 0)
1411 vol = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1412 ch->listener_volume[0] = (int)bound(0, vol, 65536);
1413 vol = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1414 ch->listener_volume[1] = (int)bound(0, vol, 65536);
1415 for (i = 2;i < SND_LISTENERS;i++)
1416 ch->listener_volume[i] = 0;
1420 for (i = 0;i < SND_LISTENERS;i++)
1422 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1423 ch->listener_volume[i] = (int)bound(0, vol, 65536);
1429 // calculate stereo seperation and distance attenuation
1430 VectorSubtract(listener_origin, ch->origin, source_vec);
1431 dist = VectorLength(source_vec);
1432 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1435 qboolean occluded = false;
1436 if (snd_spatialization_occlusion.integer)
1438 if(snd_spatialization_occlusion.integer & 1)
1441 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1442 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1446 if(snd_spatialization_occlusion.integer & 2)
1448 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1454 ch->prologic_invert = 1;
1455 if (snd_spatialization_prologic.integer != 0)
1461 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1462 VectorNormalize(source_vec);
1464 switch(spatialmethod)
1468 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1470 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1471 VectorScale(source_vec, f, source_vec);
1474 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1475 f = spatialmin + spatialdiff * bound(0, f, 1);
1476 VectorScale(source_vec, f, source_vec);
1478 case SPATIAL_THRESH:
1479 f = spatialmin + spatialdiff * (dist < spatialoffset);
1480 VectorScale(source_vec, f, source_vec);
1487 // 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
1489 VectorNormalize(source_vec);
1490 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1491 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1492 if (angle_side > snd_spatialization_prologic_frontangle.value)
1494 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1495 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1496 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1497 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1498 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1499 if (angle_front > 0)
1500 angle_factor = 1 - angle_factor;
1503 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1504 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1507 vol = intensity * sqrt(angle_factor);
1508 ch->listener_volume[0] = (int)bound(0, vol, 65536);
1509 vol = intensity * sqrt(1 - angle_factor);
1510 ch->listener_volume[1] = (int)bound(0, vol, 65536);
1511 for (i = 2;i < SND_LISTENERS;i++)
1512 ch->listener_volume[i] = 0;
1516 for (i = 0;i < SND_LISTENERS;i++)
1518 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1519 VectorNormalize(source_vec);
1521 switch(spatialmethod)
1525 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1527 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1528 VectorScale(source_vec, f, source_vec);
1531 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1532 f = spatialmin + spatialdiff * bound(0, f, 1);
1533 VectorScale(source_vec, f, source_vec);
1535 case SPATIAL_THRESH:
1536 f = spatialmin + spatialdiff * (dist < spatialoffset);
1537 VectorScale(source_vec, f, source_vec);
1544 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1546 ch->listener_volume[i] = (int)bound(0, vol, 65536);
1551 for (i = 0;i < SND_LISTENERS;i++)
1552 ch->listener_volume[i] = 0;
1555 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1557 sfx_t *sfx = ch->sfx;
1558 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1562 // =======================================================================
1563 // Start a sound effect
1564 // =======================================================================
1566 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)
1570 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1574 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1576 if(!snd_startloopingsounds.integer)
1581 if(!snd_startnonloopingsounds.integer)
1585 // Initialize the channel
1586 // a crash was reported on an in-use channel, so check here...
1587 if (target_chan->sfx)
1589 int channelindex = (int)(target_chan - channels);
1590 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1591 S_StopChannel (channelindex, true, false);
1593 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1594 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1595 memset (target_chan, 0, sizeof (*target_chan));
1596 VectorCopy (origin, target_chan->origin);
1597 target_chan->flags = flags;
1598 target_chan->pos = startpos; // start of the sound
1599 target_chan->entnum = entnum;
1600 target_chan->entchannel = entchannel;
1602 // If it's a static sound
1605 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1606 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1607 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1610 target_chan->dist_mult = attenuation / snd_soundradius.value;
1612 // set the listener volumes
1613 S_SetChannelVolume(target_chan - channels, fvol);
1614 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1616 // finally, set the sfx pointer, so the channel becomes valid for playback
1617 // and will be noticed by the mixer
1618 target_chan->sfx = sfx;
1622 int S_StartSound_StartPosition_Flags (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation, float startposition, int flags)
1624 channel_t *target_chan, *check, *ch;
1625 int ch_idx, startpos;
1627 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1630 if(sfx == &changevolume_sfx)
1632 if (!IS_CHAN_SINGLE(entchannel))
1634 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1636 ch = &channels[ch_idx];
1637 if (ch->entnum == entnum && ch->entchannel == entchannel)
1639 S_SetChannelVolume(ch_idx, fvol);
1640 ch->dist_mult = attenuation / snd_soundradius.value;
1641 SND_Spatialize(ch, false);
1648 if (sfx->fetcher == NULL)
1651 // Pick a channel to play on
1652 target_chan = SND_PickChannel(entnum, entchannel);
1656 // if an identical sound has also been started this frame, offset the pos
1657 // a bit to keep it from just making the first one louder
1658 check = &channels[NUM_AMBIENTS];
1659 startpos = (int)(startposition * S_GetSoundRate());
1662 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1664 if (check == target_chan)
1666 if (check->sfx == sfx && check->pos == 0)
1668 // use negative pos offset to delay this sound effect
1669 startpos = (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1675 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos);
1677 return (target_chan - channels);
1680 int S_StartSound_StartPosition (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation, float startposition)
1682 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, startposition, CHANNELFLAG_NONE);
1685 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1687 return S_StartSound_StartPosition(entnum, entchannel, sfx, origin, fvol, attenuation, 0);
1690 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex, qboolean freesfx)
1695 if (channel_ind >= total_channels)
1698 // we have to lock an audio mutex to prevent crashes if an audio mixer
1699 // thread is currently mixing this channel
1700 // the SndSys_LockRenderBuffer function uses such a mutex in
1701 // threaded sound backends
1702 if (lockmutex && !simsound)
1703 SndSys_LockRenderBuffer();
1705 ch = &channels[channel_ind];
1707 if (ch->sfx != NULL)
1709 if (sfx->fetcher != NULL)
1711 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1712 if (fetcher_endsb != NULL)
1713 fetcher_endsb (ch->fetcher_data);
1716 ch->fetcher_data = NULL;
1719 if (lockmutex && !simsound)
1720 SndSys_UnlockRenderBuffer();
1722 S_FreeSfx(sfx, true);
1726 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1728 if (ch_ind >= total_channels)
1731 if (flag != CHANNELFLAG_FORCELOOP &&
1732 flag != CHANNELFLAG_PAUSED &&
1733 flag != CHANNELFLAG_FULLVOLUME &&
1734 flag != CHANNELFLAG_LOCALSOUND)
1738 channels[ch_ind].flags |= flag;
1740 channels[ch_ind].flags &= ~flag;
1745 void S_StopSound(int entnum, int entchannel)
1749 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1750 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1752 S_StopChannel (i, true, false);
1757 extern void CDAudio_Stop(void);
1758 void S_StopAllSounds (void)
1762 // TOCHECK: is this test necessary?
1763 if (snd_renderbuffer == NULL)
1766 // stop CD audio because it may be using a faketrack
1769 if (simsound || SndSys_LockRenderBuffer ())
1774 for (i = 0; i < total_channels; i++)
1775 if (channels[i].sfx)
1776 S_StopChannel (i, false, false);
1778 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1779 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1781 // Mute the contents of the submittion buffer
1782 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1783 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1784 memset(snd_renderbuffer->ring, clear, memsize);
1787 SndSys_UnlockRenderBuffer ();
1791 void S_PauseGameSounds (qboolean toggle)
1795 for (i = 0; i < total_channels; i++)
1800 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1801 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1805 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1807 channels[ch_ind].master_vol = (int)(fvol * 65536.0f);
1810 float S_GetChannelPosition (unsigned int ch_ind)
1812 // note: this is NOT accurate yet
1814 channel_t *ch = &channels[ch_ind];
1815 sfx_t *sfx = ch->sfx;
1821 if(!snd_usethreadedmixing)
1822 s += _snd_mixahead.value * S_GetSoundRate();
1824 return (s % sfx->total_length) / (float) S_GetSoundRate();
1827 float S_GetEntChannelPosition(int entnum, int entchannel)
1832 for (i = 0; i < total_channels; i++)
1835 if (ch->entnum == entnum && ch->entchannel == entchannel)
1836 return S_GetChannelPosition(i);
1838 return -1; // no playing sound in this channel
1846 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1848 channel_t *target_chan;
1850 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1854 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1858 if (total_channels == MAX_CHANNELS)
1860 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1864 target_chan = &channels[total_channels++];
1865 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0);
1871 S_UpdateAmbientSounds
1874 void S_UpdateAmbientSounds (void)
1878 int ambient_channel;
1880 unsigned char ambientlevels[NUM_AMBIENTS];
1883 memset(ambientlevels, 0, sizeof(ambientlevels));
1884 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1885 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1887 // Calc ambient sound levels
1888 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1890 chan = &channels[ambient_channel];
1891 sfx = chan->sfx; // fetch the volatile variable
1892 if (sfx == NULL || sfx->fetcher == NULL)
1895 vol = (int)ambientlevels[ambient_channel];
1900 // Don't adjust volume too fast
1901 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1902 if (cl.time > cl.oldtime)
1904 if (chan->master_vol < vol)
1906 chan->master_vol += (int)((cl.time - cl.oldtime) * 256.0 * ambient_fade.value);
1907 if (chan->master_vol > vol)
1908 chan->master_vol = vol;
1910 else if (chan->master_vol > vol)
1912 chan->master_vol -= (int)((cl.time - cl.oldtime) * 256.0 * ambient_fade.value);
1913 if (chan->master_vol < vol)
1914 chan->master_vol = vol;
1918 if (snd_spatialization_prologic.integer != 0)
1920 chan->listener_volume[0] = (int)bound(0, chan->master_vol * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5), 65536);
1921 chan->listener_volume[1] = (int)bound(0, chan->master_vol * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5), 65536);
1922 for (i = 2;i < SND_LISTENERS;i++)
1923 chan->listener_volume[i] = 0;
1927 for (i = 0;i < SND_LISTENERS;i++)
1928 chan->listener_volume[i] = (int)bound(0, chan->master_vol * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume, 65536);
1933 static void S_PaintAndSubmit (void)
1935 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1936 int usesoundtimehack;
1937 static int soundtimehack = -1;
1938 static int oldsoundtime = 0;
1940 if (snd_renderbuffer == NULL || nosound.integer)
1943 // Update sound time
1944 snd_usethreadedmixing = false;
1945 usesoundtimehack = true;
1946 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1948 usesoundtimehack = 1;
1949 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1951 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1953 usesoundtimehack = 2;
1954 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1958 usesoundtimehack = 3;
1959 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1963 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1964 usesoundtimehack = 0;
1965 newsoundtime = SndSys_GetSoundTime();
1967 // if the soundtimehack state changes we need to reset the soundtime
1968 if (soundtimehack != usesoundtimehack)
1970 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1972 // Mute the contents of the submission buffer
1973 if (simsound || SndSys_LockRenderBuffer ())
1978 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1979 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1980 memset(snd_renderbuffer->ring, clear, memsize);
1983 SndSys_UnlockRenderBuffer ();
1986 soundtimehack = usesoundtimehack;
1988 if (!soundtimehack && snd_blocked > 0)
1991 if (snd_usethreadedmixing)
1992 return; // the audio thread will mix its own data
1994 newsoundtime += extrasoundtime;
1995 if (newsoundtime < soundtime)
1997 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1999 unsigned int additionaltime;
2001 // add some time to extrasoundtime make newsoundtime higher
2003 // The extra time must be a multiple of the render buffer size
2004 // to avoid modifying the current position in the buffer,
2005 // some modules write directly to a shared (DMA) buffer
2006 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
2007 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
2009 extrasoundtime += additionaltime;
2010 newsoundtime += additionaltime;
2011 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2014 else if (!soundtimehack)
2015 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2016 newsoundtime, soundtime);
2018 soundtime = newsoundtime;
2019 recording_sound = (cls.capturevideo.soundrate != 0);
2021 // Lock submitbuffer
2022 if (!simsound && !SndSys_LockRenderBuffer())
2024 // If the lock failed, stop here
2025 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2029 // Check to make sure that we haven't overshot
2030 paintedtime = snd_renderbuffer->endframe;
2031 if (paintedtime < soundtime)
2032 paintedtime = soundtime;
2034 // mix ahead of current position
2036 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2038 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2039 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2040 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2041 endtime = min(endtime, maxtime);
2043 while (paintedtime < endtime)
2045 unsigned int startoffset;
2046 unsigned int nbframes;
2048 // see how much we can fit in the paint buffer
2049 nbframes = endtime - paintedtime;
2050 // limit to the end of the ring buffer (in case of wrapping)
2051 startoffset = paintedtime % snd_renderbuffer->maxframes;
2052 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2054 // mix into the buffer
2055 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2057 paintedtime += nbframes;
2058 snd_renderbuffer->endframe = paintedtime;
2061 SndSys_UnlockRenderBuffer();
2063 // Remove outdated samples from the ring buffer, if any
2064 if (snd_renderbuffer->startframe < soundtime)
2065 snd_renderbuffer->startframe = soundtime;
2068 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2072 oldsoundtime = soundtime;
2074 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2075 R_TimeReport("audiomix");
2082 Called once each time through the main loop
2085 void S_Update(const matrix4x4_t *listenermatrix)
2087 unsigned int i, j, k;
2088 channel_t *ch, *combine;
2089 matrix4x4_t rotatematrix;
2091 if (snd_renderbuffer == NULL || nosound.integer)
2095 double mindist_trans, maxdist_trans;
2097 spatialmin = snd_spatialization_min.value;
2098 spatialdiff = snd_spatialization_max.value - spatialmin;
2100 if(snd_spatialization_control.value)
2102 spatialpower = snd_spatialization_power.value;
2104 if(spatialpower == 0)
2106 spatialmethod = SPATIAL_LOG;
2107 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2108 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2112 spatialmethod = SPATIAL_POW;
2113 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2114 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2117 if(mindist_trans - maxdist_trans == 0)
2119 spatialmethod = SPATIAL_THRESH;
2120 mindist_trans = snd_spatialization_min_radius.value;
2124 spatialoffset = mindist_trans;
2125 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2129 spatialmethod = SPATIAL_NONE;
2133 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2134 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2135 current_channellayout != snd_channellayout.integer)
2136 S_SetChannelLayout();
2138 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2139 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2140 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2142 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2145 Mem_Free(listener_pvs);
2146 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2147 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2149 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2155 Mem_Free(listener_pvs);
2156 listener_pvs = NULL;
2158 listener_pvsbytes = 0;
2161 // calculate the current matrices
2162 for (j = 0;j < SND_LISTENERS;j++)
2164 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2165 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2166 // I think this should now do this:
2167 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2168 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2169 // angle has to be taken negative)
2170 // 2. create a transform which first rotates and moves its argument
2171 // into the player's view coordinates (using basematrix which is
2172 // an inverted "absolute" listener matrix), then applies the
2173 // rotation matrix for the ear
2174 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2175 // does not actually refer to an entity?
2178 // update general area ambient sound sources
2179 S_UpdateAmbientSounds ();
2182 R_TimeReport("audioprep");
2184 // update spatialization for static and dynamic sounds
2185 cls.soundstats.totalsounds = 0;
2186 cls.soundstats.mixedsounds = 0;
2187 ch = channels+NUM_AMBIENTS;
2188 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2192 cls.soundstats.totalsounds++;
2194 // respatialize channel
2195 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2197 // try to combine static sounds with a previous channel of the same
2198 // sound effect so we don't mix five torches every frame
2199 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2201 // no need to merge silent channels
2202 for (j = 0;j < SND_LISTENERS;j++)
2203 if (ch->listener_volume[j])
2205 if (j == SND_LISTENERS)
2207 // if the last combine chosen isn't suitable, find a new one
2208 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2212 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2214 if (channels[j].sfx == ch->sfx)
2216 combine = channels + j;
2221 if (combine && combine != ch && combine->sfx == ch->sfx)
2223 for (j = 0;j < SND_LISTENERS;j++)
2225 combine->listener_volume[j] = bound(0, combine->listener_volume[j] + ch->listener_volume[j], 65536);
2226 ch->listener_volume[j] = 0;
2230 for (k = 0;k < SND_LISTENERS;k++)
2231 if (ch->listener_volume[k])
2233 if (k < SND_LISTENERS)
2234 cls.soundstats.mixedsounds++;
2236 R_TimeReport("audiospatialize");
2238 sound_spatialized = true;
2241 if (snd_show.integer)
2242 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2247 void S_ExtraUpdate (void)
2249 if (snd_noextraupdate.integer || !sound_spatialized)
2255 qboolean S_LocalSound (const char *sound)
2260 if (!snd_initialized.integer || nosound.integer)
2263 sfx = S_PrecacheSound (sound, true, false);
2266 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2270 // menu sounds must not be freed on level change
2271 sfx->flags |= SFXFLAG_MENUSOUND;
2273 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2274 // which we no longer support anyway
2275 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2276 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2280 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;