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"
34 #define SND_MIN_SPEED 8000
35 #define SND_MAX_SPEED 192000
36 #define SND_MIN_WIDTH 1
37 #define SND_MAX_WIDTH 2
38 #define SND_MIN_CHANNELS 1
39 #define SND_MAX_CHANNELS 8
40 #if SND_LISTENERS != 8
41 # error this data only supports up to 8 channel, update it!
44 speakerlayout_t snd_speakerlayout;
46 // Our speaker layouts are based on ALSA. They differ from those
47 // Win32 and Mac OS X APIs use when there's more than 4 channels.
48 // (rear left + rear right, and front center + LFE are swapped).
49 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
50 static const speakerlayout_t snd_speakerlayouts[] =
55 {0, 45, 0.2, 0.2, 0.5}, // front left
56 {1, 315, 0.2, 0.2, 0.5}, // front right
57 {2, 135, 0.2, 0.2, 0.5}, // rear left
58 {3, 225, 0.2, 0.2, 0.5}, // rear right
59 {4, 0, 0.2, 0.2, 0.5}, // front center
60 {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)
61 {6, 90, 0.2, 0.2, 0.5}, // side left
62 {7, 180, 0.2, 0.2, 0.5}, // side right
68 {0, 45, 0.2, 0.2, 0.5}, // front left
69 {1, 315, 0.2, 0.2, 0.5}, // front right
70 {2, 135, 0.2, 0.2, 0.5}, // rear left
71 {3, 225, 0.2, 0.2, 0.5}, // rear right
72 {4, 0, 0.2, 0.2, 0.5}, // front center
73 {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)
79 // these systems sometimes have a subwoofer as well, but it has no
83 {0, 45, 0.3, 0.3, 0.8}, // front left
84 {1, 315, 0.3, 0.3, 0.8}, // front right
85 {2, 135, 0.3, 0.3, 0.8}, // rear left
86 {3, 225, 0.3, 0.3, 0.8}, // rear right
94 // these systems sometimes have a subwoofer as well, but it has no
98 {0, 90, 0.5, 0.5, 1}, // side left
99 {1, 270, 0.5, 0.5, 1}, // side right
111 {0, 0, 0, 1, 1}, // center
124 // =======================================================================
125 // Internal sound data & structures
126 // =======================================================================
128 channel_t channels[MAX_CHANNELS];
129 unsigned int total_channels;
131 snd_ringbuffer_t *snd_renderbuffer = NULL;
132 static unsigned int soundtime = 0;
133 static unsigned int oldpaintedtime = 0;
134 static unsigned int extrasoundtime = 0;
135 static double snd_starttime = 0.0;
136 qboolean snd_threaded = false;
137 qboolean snd_usethreadedmixing = false;
139 vec3_t listener_origin;
140 matrix4x4_t listener_basematrix;
141 static unsigned char *listener_pvs = NULL;
142 static int listener_pvsbytes = 0;
143 matrix4x4_t listener_matrix[SND_LISTENERS];
144 mempool_t *snd_mempool;
146 // Linked list of known sfx
147 static sfx_t *known_sfx = NULL;
149 static qboolean sound_spatialized = false;
151 qboolean simsound = false;
153 static qboolean recording_sound = false;
156 static int current_swapstereo = false;
157 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
158 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
160 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
161 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
162 spatialmethod_t spatialmethod;
164 // Cvars declared in sound.h (part of the sound API)
165 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
166 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
167 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
168 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
169 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
170 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)"};
171 cvar_t snd_attenuation_exponent = {CVAR_SAVE, "snd_attenuation_exponent", "1", "Exponent of (1-radius) in sound attenuation formula"};
172 cvar_t snd_attenuation_decibel = {CVAR_SAVE, "snd_attenuation_decibel", "0", "Decibel sound attenuation per sound radius distance"};
173 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
174 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
175 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
176 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
177 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
178 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
179 cvar_t snd_spatialization_prologic = {CVAR_SAVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
180 cvar_t snd_spatialization_prologic_frontangle = {CVAR_SAVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
181 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"};
183 // Cvars declared in snd_main.h (shared with other snd_*.c files)
184 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
185 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"};
186 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"};
187 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
188 extern cvar_t v_flipped;
189 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
190 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
191 cvar_t snd_maxchannelvolume = {CVAR_SAVE, "snd_maxchannelvolume", "10", "maximum volume of a single sound"};
192 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."};
193 //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."};
194 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
195 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
196 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
197 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
198 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
199 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
200 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
201 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
202 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
203 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
204 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
205 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
206 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
207 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
208 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
209 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
210 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
211 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
212 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
213 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
214 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
215 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
216 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
217 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
218 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
219 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
220 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
221 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
222 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
223 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
224 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
225 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
226 cvar_t snd_channel0volume = {CVAR_SAVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
227 cvar_t snd_channel1volume = {CVAR_SAVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
228 cvar_t snd_channel2volume = {CVAR_SAVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
229 cvar_t snd_channel3volume = {CVAR_SAVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
230 cvar_t snd_channel4volume = {CVAR_SAVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
231 cvar_t snd_channel5volume = {CVAR_SAVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
232 cvar_t snd_channel6volume = {CVAR_SAVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
233 cvar_t snd_channel7volume = {CVAR_SAVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
236 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
237 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
238 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
239 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
240 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"};
241 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
243 // Default sound format is 48KHz, 16-bit, stereo
244 // (48KHz because a lot of onboard sound cards sucks at any other speed)
245 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
246 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
247 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)"};
249 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"};
250 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"};
253 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"};
254 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"};
257 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
258 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
261 // ====================================================================
263 // ====================================================================
265 void S_FreeSfx (sfx_t *sfx, qboolean force);
267 static void S_Play_Common (float fvol, float attenuation)
270 char name [MAX_QPATH];
274 while (i < Cmd_Argc ())
276 // Get the name, and appends ".wav" as an extension if there's none
277 strlcpy (name, Cmd_Argv (i), sizeof (name));
278 if (!strrchr (name, '.'))
279 strlcat (name, ".wav", sizeof (name));
282 // If we need to get the volume from the command line
285 fvol = atof (Cmd_Argv (i));
289 sfx = S_PrecacheSound (name, true, true);
292 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
294 // Free the sfx if the file didn't exist
296 S_FreeSfx (sfx, false);
298 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
303 static void S_Play_f(void)
305 S_Play_Common (1.0f, 1.0f);
308 static void S_Play2_f(void)
310 S_Play_Common (1.0f, 0.0f);
313 static void S_PlayVol_f(void)
315 S_Play_Common (-1.0f, 0.0f);
318 static void S_SoundList_f (void)
325 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
327 if (sfx->fetcher != NULL)
332 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
333 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
334 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
335 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
337 sfx->format.width * 8,
338 (sfx->format.channels == 1) ? "mono" : "stereo",
344 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
346 Con_Printf("Total resident: %i\n", total);
350 static void S_SoundInfo_f(void)
352 if (snd_renderbuffer == NULL)
354 Con_Print("sound system not started\n");
358 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
359 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
360 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
361 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
362 Con_Printf("%5u total_channels\n", total_channels);
366 int S_GetSoundRate(void)
368 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
371 int S_GetSoundChannels(void)
373 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
377 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
379 static const snd_format_t thresholds [] =
381 // speed width channels
382 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
388 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
390 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
391 unsigned int speed_level, width_level, channels_level;
393 // If we have reached the minimum values, there's nothing more we can do
394 if ((format->speed == thresholds[0].speed || fixed_speed) &&
395 (format->width == thresholds[0].width || fixed_width) &&
396 (format->channels == thresholds[0].channels || fixed_channels))
399 // Check the min and max values
400 #define CHECK_BOUNDARIES(param) \
401 if (format->param < thresholds[0].param) \
403 format->param = thresholds[0].param; \
406 if (format->param > thresholds[nb_thresholds - 1].param) \
408 format->param = thresholds[nb_thresholds - 1].param; \
411 CHECK_BOUNDARIES(speed);
412 CHECK_BOUNDARIES(width);
413 CHECK_BOUNDARIES(channels);
414 #undef CHECK_BOUNDARIES
416 // Find the level of each parameter
417 #define FIND_LEVEL(param) \
419 while (param##_level < nb_thresholds - 1) \
421 if (format->param <= thresholds[param##_level].param) \
428 FIND_LEVEL(channels);
431 // Decrease the parameter with the highest level to the previous level
432 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
434 format->channels = thresholds[channels_level - 1].channels;
437 if (speed_level >= width_level && !fixed_speed)
439 format->speed = thresholds[speed_level - 1].speed;
443 format->width = thresholds[width_level - 1].width;
448 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
450 static void S_SetChannelLayout (void)
453 listener_t swaplistener;
454 listener_t *listeners;
457 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
458 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
460 if (i >= SND_SPEAKERLAYOUTS)
462 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
463 snd_renderbuffer->format.channels);
464 i = SND_SPEAKERLAYOUTS - 1;
467 snd_speakerlayout = snd_speakerlayouts[i];
468 listeners = snd_speakerlayout.listeners;
470 // Swap the left and right channels if snd_swapstereo is set
471 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
473 switch (snd_speakerlayout.channels)
476 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
480 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
483 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
494 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
495 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
496 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
498 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
500 // If we're in the sound engine initialization
501 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
503 layout = SND_CHANNELLAYOUT_STANDARD;
504 Cvar_SetValueQuick (&snd_channellayout, layout);
507 layout = current_channellayout_used;
510 layout = snd_channellayout.integer;
512 // Convert our layout (= ALSA) to the standard layout if necessary
513 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
515 if (layout == SND_CHANNELLAYOUT_STANDARD)
517 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
518 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
521 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
522 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
525 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
526 current_channellayout = snd_channellayout.integer;
527 current_channellayout_used = layout;
531 void S_Startup (void)
533 qboolean fixed_speed, fixed_width, fixed_channels;
534 snd_format_t chosen_fmt;
535 static snd_format_t prev_render_format = {0, 0, 0};
542 if (!snd_initialized.integer)
547 fixed_channels = false;
549 // Get the starting sound format from the cvars
550 chosen_fmt.speed = snd_speed.integer;
551 chosen_fmt.width = snd_width.integer;
552 chosen_fmt.channels = snd_channels.integer;
554 // Check the environment variables to see if the player wants a particular sound format
556 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
558 env = getenv("QUAKE_SOUND_CHANNELS");
562 chosen_fmt.channels = atoi (env);
566 fixed_channels = true;
569 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
571 env = getenv("QUAKE_SOUND_SPEED");
575 chosen_fmt.speed = atoi (env);
582 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
584 env = getenv("QUAKE_SOUND_SAMPLEBITS");
588 chosen_fmt.width = atoi (env) / 8;
595 // Parse the command line to see if the player wants a particular sound format
596 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
597 if (COM_CheckParm ("-sndquad") != 0)
599 chosen_fmt.channels = 4;
600 fixed_channels = true;
602 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
603 else if (COM_CheckParm ("-sndstereo") != 0)
605 chosen_fmt.channels = 2;
606 fixed_channels = true;
608 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
609 else if (COM_CheckParm ("-sndmono") != 0)
611 chosen_fmt.channels = 1;
612 fixed_channels = true;
614 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
615 i = COM_CheckParm ("-sndspeed");
616 if (0 < i && i < com_argc - 1)
618 chosen_fmt.speed = atoi (com_argv[i + 1]);
621 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
622 i = COM_CheckParm ("-sndbits");
623 if (0 < i && i < com_argc - 1)
625 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
630 // LordHavoc: now you can with the resampler...
631 // You can't change sound speed after start time (not yet supported)
632 if (prev_render_format.speed != 0)
635 if (chosen_fmt.speed != prev_render_format.speed)
637 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
638 prev_render_format.speed);
639 chosen_fmt.speed = prev_render_format.speed;
645 if (chosen_fmt.speed < SND_MIN_SPEED)
647 chosen_fmt.speed = SND_MIN_SPEED;
650 else if (chosen_fmt.speed > SND_MAX_SPEED)
652 chosen_fmt.speed = SND_MAX_SPEED;
656 if (chosen_fmt.width < SND_MIN_WIDTH)
658 chosen_fmt.width = SND_MIN_WIDTH;
661 else if (chosen_fmt.width > SND_MAX_WIDTH)
663 chosen_fmt.width = SND_MAX_WIDTH;
667 if (chosen_fmt.channels < SND_MIN_CHANNELS)
669 chosen_fmt.channels = SND_MIN_CHANNELS;
670 fixed_channels = false;
672 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
674 chosen_fmt.channels = SND_MAX_CHANNELS;
675 fixed_channels = false;
678 // create the sound buffer used for sumitting the samples to the plaform-dependent module
681 snd_format_t suggest_fmt;
687 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
688 chosen_fmt.speed, chosen_fmt.width * 8,
689 chosen_fmt.channels);
691 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
692 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
696 Con_Printf("S_Startup: sound output initialization FAILED\n");
698 // If the module is suggesting another one
699 if (suggest_fmt.speed != 0)
701 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
702 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
703 suggest_fmt.speed, suggest_fmt.width * 8,
704 suggest_fmt.channels);
706 // Else, try to find a less resource-demanding format
707 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
712 // If we haven't found a suitable format
715 Con_Print("S_Startup: SndSys_Init failed.\n");
716 sound_spatialized = false;
722 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
723 Con_Print ("S_Startup: simulating sound output\n");
726 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
727 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
728 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
731 if (snd_speed.integer != (int)chosen_fmt.speed)
732 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
733 if (snd_width.integer != chosen_fmt.width)
734 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
735 if (snd_channels.integer != chosen_fmt.channels)
736 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
738 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
739 S_SetChannelLayout();
741 snd_starttime = realtime;
743 // If the sound module has already run, add an extra time to make sure
744 // the sound time doesn't decrease, to not confuse playing SFXs
745 if (oldpaintedtime != 0)
747 // The extra time must be a multiple of the render buffer size
748 // to avoid modifying the current position in the buffer,
749 // some modules write directly to a shared (DMA) buffer
750 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
751 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
752 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
754 soundtime = extrasoundtime;
758 snd_renderbuffer->startframe = soundtime;
759 snd_renderbuffer->endframe = soundtime;
760 recording_sound = false;
763 void S_Shutdown(void)
765 if (snd_renderbuffer == NULL)
768 oldpaintedtime = snd_renderbuffer->endframe;
772 Mem_Free(snd_renderbuffer->ring);
773 Mem_Free(snd_renderbuffer);
774 snd_renderbuffer = NULL;
779 sound_spatialized = false;
782 static void S_Restart_f(void)
784 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
785 // So, refuse to do this if we are connected.
786 if(cls.state == ca_connected)
788 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
803 Cvar_RegisterVariable(&volume);
804 Cvar_RegisterVariable(&bgmvolume);
805 Cvar_RegisterVariable(&mastervolume);
806 Cvar_RegisterVariable(&snd_staticvolume);
807 Cvar_RegisterVariable(&snd_entchannel0volume);
808 Cvar_RegisterVariable(&snd_entchannel1volume);
809 Cvar_RegisterVariable(&snd_entchannel2volume);
810 Cvar_RegisterVariable(&snd_entchannel3volume);
811 Cvar_RegisterVariable(&snd_entchannel4volume);
812 Cvar_RegisterVariable(&snd_entchannel5volume);
813 Cvar_RegisterVariable(&snd_entchannel6volume);
814 Cvar_RegisterVariable(&snd_entchannel7volume);
815 Cvar_RegisterVariable(&snd_worldchannel0volume);
816 Cvar_RegisterVariable(&snd_worldchannel1volume);
817 Cvar_RegisterVariable(&snd_worldchannel2volume);
818 Cvar_RegisterVariable(&snd_worldchannel3volume);
819 Cvar_RegisterVariable(&snd_worldchannel4volume);
820 Cvar_RegisterVariable(&snd_worldchannel5volume);
821 Cvar_RegisterVariable(&snd_worldchannel6volume);
822 Cvar_RegisterVariable(&snd_worldchannel7volume);
823 Cvar_RegisterVariable(&snd_playerchannel0volume);
824 Cvar_RegisterVariable(&snd_playerchannel1volume);
825 Cvar_RegisterVariable(&snd_playerchannel2volume);
826 Cvar_RegisterVariable(&snd_playerchannel3volume);
827 Cvar_RegisterVariable(&snd_playerchannel4volume);
828 Cvar_RegisterVariable(&snd_playerchannel5volume);
829 Cvar_RegisterVariable(&snd_playerchannel6volume);
830 Cvar_RegisterVariable(&snd_playerchannel7volume);
831 Cvar_RegisterVariable(&snd_csqcchannel0volume);
832 Cvar_RegisterVariable(&snd_csqcchannel1volume);
833 Cvar_RegisterVariable(&snd_csqcchannel2volume);
834 Cvar_RegisterVariable(&snd_csqcchannel3volume);
835 Cvar_RegisterVariable(&snd_csqcchannel4volume);
836 Cvar_RegisterVariable(&snd_csqcchannel5volume);
837 Cvar_RegisterVariable(&snd_csqcchannel6volume);
838 Cvar_RegisterVariable(&snd_csqcchannel7volume);
839 Cvar_RegisterVariable(&snd_channel0volume);
840 Cvar_RegisterVariable(&snd_channel1volume);
841 Cvar_RegisterVariable(&snd_channel2volume);
842 Cvar_RegisterVariable(&snd_channel3volume);
843 Cvar_RegisterVariable(&snd_channel4volume);
844 Cvar_RegisterVariable(&snd_channel5volume);
845 Cvar_RegisterVariable(&snd_channel6volume);
846 Cvar_RegisterVariable(&snd_channel7volume);
848 Cvar_RegisterVariable(&snd_attenuation_exponent);
849 Cvar_RegisterVariable(&snd_attenuation_decibel);
851 Cvar_RegisterVariable(&snd_spatialization_min_radius);
852 Cvar_RegisterVariable(&snd_spatialization_max_radius);
853 Cvar_RegisterVariable(&snd_spatialization_min);
854 Cvar_RegisterVariable(&snd_spatialization_max);
855 Cvar_RegisterVariable(&snd_spatialization_power);
856 Cvar_RegisterVariable(&snd_spatialization_control);
857 Cvar_RegisterVariable(&snd_spatialization_occlusion);
858 Cvar_RegisterVariable(&snd_spatialization_prologic);
859 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
861 Cvar_RegisterVariable(&snd_speed);
862 Cvar_RegisterVariable(&snd_width);
863 Cvar_RegisterVariable(&snd_channels);
864 Cvar_RegisterVariable(&snd_mutewhenidle);
865 Cvar_RegisterVariable(&snd_maxchannelvolume);
866 Cvar_RegisterVariable(&snd_softclip);
868 Cvar_RegisterVariable(&snd_startloopingsounds);
869 Cvar_RegisterVariable(&snd_startnonloopingsounds);
871 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
872 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
874 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
875 if (COM_CheckParm("-nosound"))
877 // dummy out Play and Play2 because mods stuffcmd that
878 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
879 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
883 snd_mempool = Mem_AllocPool("sound", 0, NULL);
885 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
886 if (COM_CheckParm("-simsound"))
889 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
890 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
891 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
892 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
893 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
894 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
895 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
896 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
898 Cvar_RegisterVariable(&nosound);
899 Cvar_RegisterVariable(&snd_precache);
900 Cvar_RegisterVariable(&snd_initialized);
901 Cvar_RegisterVariable(&snd_streaming);
902 Cvar_RegisterVariable(&snd_streaming_length);
903 Cvar_RegisterVariable(&ambient_level);
904 Cvar_RegisterVariable(&ambient_fade);
905 Cvar_RegisterVariable(&snd_noextraupdate);
906 Cvar_RegisterVariable(&snd_show);
907 Cvar_RegisterVariable(&_snd_mixahead);
908 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
909 Cvar_RegisterVariable(&snd_channellayout);
910 Cvar_RegisterVariable(&snd_soundradius);
912 Cvar_SetValueQuick(&snd_initialized, true);
916 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
917 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
920 ModPlug_OpenLibrary ();
928 Shutdown and free all resources
931 void S_Terminate (void)
934 ModPlug_CloseLibrary ();
938 while (known_sfx != NULL)
939 S_FreeSfx (known_sfx, true);
941 Cvar_SetValueQuick (&snd_initialized, false);
942 Mem_FreePool (&snd_mempool);
951 void S_UnloadAllSounds_f (void)
955 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
956 // So, refuse to do this if we are connected.
957 if(cls.state == ca_connected)
959 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
963 // stop any active sounds
966 // because the ambient sounds will be freed, clear the pointers
967 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
968 ambient_sfxs[i] = NULL;
970 // now free all sounds
971 while (known_sfx != NULL)
972 S_FreeSfx (known_sfx, true);
981 sfx_t changevolume_sfx = {""};
982 sfx_t *S_FindName (const char *name)
986 if (!snd_initialized.integer)
989 if(!strcmp(name, changevolume_sfx.name))
990 return &changevolume_sfx;
992 if (strlen (name) >= sizeof (sfx->name))
994 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
998 // Look for this sound in the list of known sfx
999 // TODO: hash table search?
1000 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1001 if(!strcmp (sfx->name, name))
1004 // check for # in the beginning, try lookup by soundindex
1005 if (name[0] == '#' && name[1])
1007 int soundindex = atoi(name + 1);
1008 if (soundindex > 0 && soundindex < MAX_SOUNDS)
1009 if (cl.sound_precache[soundindex]->name[0])
1010 return cl.sound_precache[soundindex];
1013 // Add a sfx_t struct for this sound
1014 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
1015 memset (sfx, 0, sizeof(*sfx));
1016 strlcpy (sfx->name, name, sizeof (sfx->name));
1017 sfx->memsize = sizeof(*sfx);
1018 sfx->next = known_sfx;
1030 void S_FreeSfx (sfx_t *sfx, qboolean force)
1034 // Do not free a precached sound during purge
1035 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1038 if (developer_loading.integer)
1039 Con_Printf ("unloading sound %s\n", sfx->name);
1041 // Remove it from the list of known sfx
1042 if (sfx == known_sfx)
1043 known_sfx = known_sfx->next;
1048 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
1049 if (prev_sfx->next == sfx)
1051 prev_sfx->next = sfx->next;
1054 if (prev_sfx == NULL)
1056 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1061 // Stop all channels using this sfx
1062 for (i = 0; i < total_channels; i++)
1064 if (channels[i].sfx == sfx)
1066 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
1067 S_StopChannel (i, true, false);
1072 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
1073 sfx->fetcher->freesfx(sfx);
1083 void S_ClearUsed (void)
1089 // Start the ambient sounds and make them loop
1090 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1092 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1093 if (ambient_sfxs[i] == NULL)
1094 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1095 if (ambient_sfxs[i] != NULL)
1097 channels[i].sfx = ambient_sfxs[i];
1098 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1099 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1100 channels[i].basevolume = 0.0f;
1101 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1105 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1106 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1107 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1115 void S_PurgeUnused(void)
1120 // Free all not-precached per-level sfx
1121 for (sfx = known_sfx;sfx;sfx = sfxnext)
1123 sfxnext = sfx->next;
1124 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1125 S_FreeSfx (sfx, false);
1135 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean levelsound)
1139 if (!snd_initialized.integer)
1142 if (name == NULL || name[0] == 0)
1145 sfx = S_FindName (name);
1150 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1151 // previously missing file
1152 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1154 // set a flag to indicate this has been precached for this level or permanently
1156 sfx->flags |= SFXFLAG_LEVELSOUND;
1158 sfx->flags |= SFXFLAG_MENUSOUND;
1160 if (!nosound.integer && snd_precache.integer)
1161 S_LoadSound(sfx, complain);
1172 float S_SoundLength(const char *name)
1176 if (!snd_initialized.integer)
1178 if (name == NULL || name[0] == 0)
1181 sfx = S_FindName(name);
1184 return sfx->total_length / (float) S_GetSoundRate();
1192 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1194 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1202 void S_BlockSound (void)
1213 void S_UnblockSound (void)
1223 Picks a channel based on priorities, empty slots, number of channels
1226 static channel_t *SND_PickChannel(int entnum, int entchannel)
1230 int first_life_left, life_left;
1232 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1234 // Check for replacement sound, or find the best one to replace
1236 first_life_left = 0x7fffffff;
1238 // entity channels try to replace the existing sound on the channel
1239 // channels <= 0 are autochannels
1240 if (IS_CHAN_SINGLE(entchannel))
1242 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1244 ch = &channels[ch_idx];
1245 if (ch->entnum == entnum && ch->entchannel == entchannel)
1247 // always override sound from same entity
1248 S_StopChannel (ch_idx, true, false);
1249 return &channels[ch_idx];
1254 // there was no channel to override, so look for the first empty one
1255 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1257 ch = &channels[ch_idx];
1258 sfx = ch->sfx; // fetch the volatile variable
1261 // no sound on this channel
1262 first_to_die = ch_idx;
1263 goto emptychan_found;
1266 // don't let monster sounds override player sounds
1267 if ((ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity()) && !(entnum == cl.viewentity || entnum == CL_VM_GetViewEntity()))
1270 // don't override looped sounds
1271 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1273 life_left = (int)((double)sfx->total_length - ch->position);
1275 if (life_left < first_life_left)
1277 first_life_left = life_left;
1278 first_to_die = ch_idx;
1282 if (first_to_die == -1)
1285 S_StopChannel (first_to_die, true, false);
1288 return &channels[first_to_die];
1295 Spatializes a channel
1298 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1299 static void SND_Spatialize_WithSfx(channel_t *ch, qboolean isstatic, sfx_t *sfx)
1303 float angle_side, angle_front, angle_factor, mixspeed;
1304 vec_t dist, mastervol, intensity;
1308 // update sound origin if we know about the entity
1309 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1311 if (ch->entnum >= MAX_EDICTS)
1313 //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]);
1315 if (ch->entnum > MAX_EDICTS)
1316 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1317 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1319 else if (cl.entities[ch->entnum].state_current.active)
1322 //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]);
1323 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1324 if (model && model->soundfromcenter)
1325 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1327 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1329 else if (cl.csqc_server2csqcentitynumber[ch->entnum])
1331 //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]);
1333 if (!CL_VM_GetEntitySoundOrigin(cl.csqc_server2csqcentitynumber[ch->entnum] + MAX_EDICTS, ch->origin))
1334 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1338 mastervol = ch->basevolume;
1339 mixspeed = ch->basespeed;
1341 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1343 // Adjust volume of static sounds
1345 mastervol *= snd_staticvolume.value;
1346 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1348 // old legacy separated cvars
1349 if(ch->entnum >= MAX_EDICTS)
1351 switch(ch->entchannel)
1353 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1354 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1355 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1356 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1357 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1358 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1359 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1360 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1364 else if(ch->entnum == 0)
1366 switch(ch->entchannel)
1368 case 0: mastervol *= snd_worldchannel0volume.value; break;
1369 case 1: mastervol *= snd_worldchannel1volume.value; break;
1370 case 2: mastervol *= snd_worldchannel2volume.value; break;
1371 case 3: mastervol *= snd_worldchannel3volume.value; break;
1372 case 4: mastervol *= snd_worldchannel4volume.value; break;
1373 case 5: mastervol *= snd_worldchannel5volume.value; break;
1374 case 6: mastervol *= snd_worldchannel6volume.value; break;
1375 case 7: mastervol *= snd_worldchannel7volume.value; break;
1379 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1381 switch(ch->entchannel)
1383 case 0: mastervol *= snd_playerchannel0volume.value; break;
1384 case 1: mastervol *= snd_playerchannel1volume.value; break;
1385 case 2: mastervol *= snd_playerchannel2volume.value; break;
1386 case 3: mastervol *= snd_playerchannel3volume.value; break;
1387 case 4: mastervol *= snd_playerchannel4volume.value; break;
1388 case 5: mastervol *= snd_playerchannel5volume.value; break;
1389 case 6: mastervol *= snd_playerchannel6volume.value; break;
1390 case 7: mastervol *= snd_playerchannel7volume.value; break;
1396 switch(ch->entchannel)
1398 case 0: mastervol *= snd_entchannel0volume.value; break;
1399 case 1: mastervol *= snd_entchannel1volume.value; break;
1400 case 2: mastervol *= snd_entchannel2volume.value; break;
1401 case 3: mastervol *= snd_entchannel3volume.value; break;
1402 case 4: mastervol *= snd_entchannel4volume.value; break;
1403 case 5: mastervol *= snd_entchannel5volume.value; break;
1404 case 6: mastervol *= snd_entchannel6volume.value; break;
1405 case 7: mastervol *= snd_entchannel7volume.value; break;
1410 switch(ch->entchannel)
1412 case 0: mastervol *= snd_channel0volume.value; break;
1413 case 1: mastervol *= snd_channel1volume.value; break;
1414 case 2: mastervol *= snd_channel2volume.value; break;
1415 case 3: mastervol *= snd_channel3volume.value; break;
1416 case 4: mastervol *= snd_channel4volume.value; break;
1417 case 5: mastervol *= snd_channel5volume.value; break;
1418 case 6: mastervol *= snd_channel6volume.value; break;
1419 case 7: mastervol *= snd_channel7volume.value; break;
1420 default: mastervol *= Cvar_VariableValueOr(va(vabuf, sizeof(vabuf), "snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0); break;
1424 // If this channel does not manage its own volume (like CD tracks)
1425 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1426 mastervol *= volume.value;
1428 if(snd_maxchannelvolume.value > 0)
1430 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1431 mastervol = bound(0.0f, mastervol, 10.0f * snd_maxchannelvolume.value);
1434 // always apply "master"
1435 mastervol *= mastervolume.value;
1437 // add in ReplayGain very late; prevent clipping when close
1439 if(sfx->volume_peak > 0)
1441 // Replaygain support
1442 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1443 mastervol *= sfx->volume_mult;
1444 if(snd_maxchannelvolume.value > 0)
1446 if(mastervol * sfx->volume_peak > snd_maxchannelvolume.value)
1447 mastervol = snd_maxchannelvolume.value / sfx->volume_peak;
1449 // Con_DPrintf("%f\n", fvol);
1452 if(snd_maxchannelvolume.value > 0)
1454 // clamp HERE to keep relative volumes of the channels correct
1455 mastervol = min(mastervol, snd_maxchannelvolume.value);
1458 mastervol = max(0.0f, mastervol);
1460 ch->mixspeed = mixspeed;
1462 // anything coming from the view entity will always be full volume
1463 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1464 if (ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity() || ch->distfade == 0)
1466 ch->prologic_invert = 1;
1467 if (snd_spatialization_prologic.integer != 0)
1469 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1470 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1471 for (i = 2;i < SND_LISTENERS;i++)
1476 for (i = 0;i < SND_LISTENERS;i++)
1477 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1482 // calculate stereo seperation and distance attenuation
1483 VectorSubtract(listener_origin, ch->origin, source_vec);
1484 dist = VectorLength(source_vec);
1485 f = dist * ch->distfade;
1488 ((snd_attenuation_exponent.value == 0) ? 1.0 : pow(1.0 - min(1.0, f), (double)snd_attenuation_exponent.value))
1490 ((snd_attenuation_decibel.value == 0) ? 1.0 : pow(0.1, 0.1 * snd_attenuation_decibel.value * f));
1492 intensity = mastervol * f;
1495 qboolean occluded = false;
1496 if (snd_spatialization_occlusion.integer)
1498 if(snd_spatialization_occlusion.integer & 1)
1501 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1502 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1506 if(snd_spatialization_occlusion.integer & 2)
1508 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1514 ch->prologic_invert = 1;
1515 if (snd_spatialization_prologic.integer != 0)
1518 angle_factor = 0.5f;
1521 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1522 VectorNormalize(source_vec);
1524 switch(spatialmethod)
1528 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1530 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1531 VectorScale(source_vec, f, source_vec);
1534 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1535 f = spatialmin + spatialdiff * bound(0, f, 1);
1536 VectorScale(source_vec, f, source_vec);
1538 case SPATIAL_THRESH:
1539 f = spatialmin + spatialdiff * (dist < spatialoffset);
1540 VectorScale(source_vec, f, source_vec);
1547 // 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
1549 VectorNormalize(source_vec);
1550 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1551 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1552 if (angle_side > snd_spatialization_prologic_frontangle.value)
1554 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1555 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1556 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1557 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1558 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1559 if (angle_front > 0)
1560 angle_factor = 1 - angle_factor;
1563 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1564 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1567 ch->volume[0] = intensity * sqrt(angle_factor);
1568 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1569 for (i = 2;i < SND_LISTENERS;i++)
1574 for (i = 0;i < SND_LISTENERS;i++)
1576 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1577 VectorNormalize(source_vec);
1579 switch(spatialmethod)
1583 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1585 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1586 VectorScale(source_vec, f, source_vec);
1589 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1590 f = spatialmin + spatialdiff * bound(0, f, 1);
1591 VectorScale(source_vec, f, source_vec);
1593 case SPATIAL_THRESH:
1594 f = spatialmin + spatialdiff * (dist < spatialoffset);
1595 VectorScale(source_vec, f, source_vec);
1602 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1607 for (i = 0;i < SND_LISTENERS;i++)
1611 static void SND_Spatialize(channel_t *ch, qboolean isstatic)
1613 sfx_t *sfx = ch->sfx;
1614 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1618 // =======================================================================
1619 // Start a sound effect
1620 // =======================================================================
1622 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)
1626 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1630 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1632 if(!snd_startloopingsounds.integer)
1637 if(!snd_startnonloopingsounds.integer)
1641 // Initialize the channel
1642 // a crash was reported on an in-use channel, so check here...
1643 if (target_chan->sfx)
1645 int channelindex = (int)(target_chan - channels);
1646 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1647 S_StopChannel (channelindex, true, false);
1649 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1650 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1651 memset (target_chan, 0, sizeof (*target_chan));
1652 VectorCopy (origin, target_chan->origin);
1653 target_chan->flags = flags;
1654 target_chan->position = startpos; // start of the sound
1655 target_chan->entnum = entnum;
1656 target_chan->entchannel = entchannel;
1658 // If it's a static sound
1661 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1662 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1663 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1666 target_chan->distfade = attenuation / snd_soundradius.value;
1668 // set the listener volumes
1669 S_SetChannelVolume(target_chan - channels, fvol);
1670 S_SetChannelSpeed(target_chan - channels, fspeed);
1671 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1673 // finally, set the sfx pointer, so the channel becomes valid for playback
1674 // and will be noticed by the mixer
1675 target_chan->sfx = sfx;
1679 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)
1681 channel_t *target_chan, *check, *ch;
1682 int ch_idx, startpos, i;
1684 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1687 if(sfx == &changevolume_sfx)
1689 if (!IS_CHAN_SINGLE(entchannel))
1691 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1693 ch = &channels[ch_idx];
1694 if (ch->entnum == entnum && ch->entchannel == entchannel)
1696 S_SetChannelVolume(ch_idx, fvol);
1697 S_SetChannelSpeed(ch_idx, fspeed);
1698 for(i = 1; i > 0 && (i <= flags || i <= (int) channels[ch_idx].flags); i <<= 1)
1699 if((flags ^ channels[ch_idx].flags) & i)
1700 S_SetChannelFlag(ch_idx, i, (flags & i) != 0);
1701 ch->distfade = attenuation / snd_soundradius.value;
1702 SND_Spatialize(ch, false);
1709 if (sfx->fetcher == NULL)
1712 // Pick a channel to play on
1713 target_chan = SND_PickChannel(entnum, entchannel);
1717 // if an identical sound has also been started this frame, offset the pos
1718 // a bit to keep it from just making the first one louder
1719 check = &channels[NUM_AMBIENTS];
1720 startpos = (int)(startposition * sfx->format.speed);
1723 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1725 if (check == target_chan)
1727 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1729 // calculate max offset
1730 float maxtime = snd_identicalsoundrandomization_time.value;
1731 float maxtics = snd_identicalsoundrandomization_tics.value;
1732 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1734 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1737 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1739 // use negative pos offset to delay this sound effect
1740 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1746 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1748 return (target_chan - channels);
1751 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1753 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, 0, CHANNELFLAG_NONE, 1.0f);
1756 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex, qboolean freesfx)
1761 if (channel_ind >= total_channels)
1764 // we have to lock an audio mutex to prevent crashes if an audio mixer
1765 // thread is currently mixing this channel
1766 // the SndSys_LockRenderBuffer function uses such a mutex in
1767 // threaded sound backends
1768 if (lockmutex && !simsound)
1769 SndSys_LockRenderBuffer();
1771 ch = &channels[channel_ind];
1775 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1776 sfx->fetcher->stopchannel(ch);
1777 ch->fetcher_data = NULL;
1780 S_FreeSfx(sfx, true);
1782 if (lockmutex && !simsound)
1783 SndSys_UnlockRenderBuffer();
1787 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1789 if (ch_ind >= total_channels)
1792 if (flag != CHANNELFLAG_FORCELOOP &&
1793 flag != CHANNELFLAG_PAUSED &&
1794 flag != CHANNELFLAG_FULLVOLUME &&
1795 flag != CHANNELFLAG_LOCALSOUND)
1799 channels[ch_ind].flags |= flag;
1801 channels[ch_ind].flags &= ~flag;
1806 void S_StopSound(int entnum, int entchannel)
1810 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1811 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1813 S_StopChannel (i, true, false);
1818 void S_StopAllSounds (void)
1822 // TOCHECK: is this test necessary?
1823 if (snd_renderbuffer == NULL)
1827 // stop CD audio because it may be using a faketrack
1831 if (simsound || SndSys_LockRenderBuffer ())
1836 for (i = 0; i < total_channels; i++)
1837 if (channels[i].sfx)
1838 S_StopChannel (i, false, false);
1840 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1841 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1843 // Mute the contents of the submittion buffer
1844 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1845 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1846 memset(snd_renderbuffer->ring, clear, memsize);
1849 SndSys_UnlockRenderBuffer ();
1853 void S_PauseGameSounds (qboolean toggle)
1857 for (i = 0; i < total_channels; i++)
1862 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1863 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1867 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1869 channels[ch_ind].basevolume = fvol;
1872 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1874 channels[ch_ind].basespeed = fspeed;
1877 float S_GetChannelPosition (unsigned int ch_ind)
1879 // note: this is NOT accurate yet
1881 channel_t *ch = &channels[ch_ind];
1882 sfx_t *sfx = ch->sfx;
1886 s = ch->position / sfx->format.speed;
1888 if(!snd_usethreadedmixing)
1889 s += _snd_mixahead.value;
1894 float S_GetEntChannelPosition(int entnum, int entchannel)
1899 for (i = 0; i < total_channels; i++)
1902 if (ch->entnum == entnum && ch->entchannel == entchannel)
1903 return S_GetChannelPosition(i);
1905 return -1; // no playing sound in this channel
1913 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1915 channel_t *target_chan;
1917 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1921 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1925 if (total_channels == MAX_CHANNELS)
1927 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1931 target_chan = &channels[total_channels++];
1932 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1938 S_UpdateAmbientSounds
1941 static void S_UpdateAmbientSounds (void)
1945 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1946 int ambient_channel;
1948 unsigned char ambientlevels[NUM_AMBIENTS];
1951 memset(ambientlevels, 0, sizeof(ambientlevels));
1952 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1953 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1955 // Calc ambient sound levels
1956 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1958 chan = &channels[ambient_channel];
1959 sfx = chan->sfx; // fetch the volatile variable
1960 if (sfx == NULL || sfx->fetcher == NULL)
1963 i = ambientlevels[ambient_channel];
1966 vol = i * (1.0f / 256.0f);
1968 // Don't adjust volume too fast
1969 if (chan->basevolume < vol)
1971 chan->basevolume += fade;
1972 if (chan->basevolume > vol)
1973 chan->basevolume = vol;
1975 else if (chan->basevolume > vol)
1977 chan->basevolume -= fade;
1978 if (chan->basevolume < vol)
1979 chan->basevolume = vol;
1982 if (snd_spatialization_prologic.integer != 0)
1984 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1985 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1986 for (i = 2;i < SND_LISTENERS;i++)
1987 chan->volume[i] = 0.0f;
1991 for (i = 0;i < SND_LISTENERS;i++)
1992 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1997 static void S_PaintAndSubmit (void)
1999 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
2000 int usesoundtimehack;
2001 static int soundtimehack = -1;
2002 static int oldsoundtime = 0;
2004 if (snd_renderbuffer == NULL || nosound.integer)
2007 // Update sound time
2008 snd_usethreadedmixing = false;
2009 usesoundtimehack = true;
2010 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
2012 usesoundtimehack = 1;
2013 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
2015 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
2017 usesoundtimehack = 2;
2018 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
2022 usesoundtimehack = 3;
2023 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
2027 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
2028 usesoundtimehack = 0;
2029 newsoundtime = SndSys_GetSoundTime();
2031 // if the soundtimehack state changes we need to reset the soundtime
2032 if (soundtimehack != usesoundtimehack)
2034 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
2036 // Mute the contents of the submission buffer
2037 if (simsound || SndSys_LockRenderBuffer ())
2042 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
2043 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
2044 memset(snd_renderbuffer->ring, clear, memsize);
2047 SndSys_UnlockRenderBuffer ();
2050 soundtimehack = usesoundtimehack;
2052 if (!soundtimehack && snd_blocked > 0)
2055 if (snd_usethreadedmixing)
2056 return; // the audio thread will mix its own data
2058 newsoundtime += extrasoundtime;
2059 if (newsoundtime < soundtime)
2061 if ((cls.capturevideo.soundrate != 0) != recording_sound)
2063 unsigned int additionaltime;
2065 // add some time to extrasoundtime make newsoundtime higher
2067 // The extra time must be a multiple of the render buffer size
2068 // to avoid modifying the current position in the buffer,
2069 // some modules write directly to a shared (DMA) buffer
2070 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
2071 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
2073 extrasoundtime += additionaltime;
2074 newsoundtime += additionaltime;
2075 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2078 else if (!soundtimehack)
2079 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2080 newsoundtime, soundtime);
2082 soundtime = newsoundtime;
2083 recording_sound = (cls.capturevideo.soundrate != 0);
2085 // Lock submitbuffer
2086 if (!simsound && !SndSys_LockRenderBuffer())
2088 // If the lock failed, stop here
2089 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2093 // Check to make sure that we haven't overshot
2094 paintedtime = snd_renderbuffer->endframe;
2095 if (paintedtime < soundtime)
2096 paintedtime = soundtime;
2098 // mix ahead of current position
2100 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2102 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2103 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2104 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2105 endtime = min(endtime, maxtime);
2107 while (paintedtime < endtime)
2109 unsigned int startoffset;
2110 unsigned int nbframes;
2112 // see how much we can fit in the paint buffer
2113 nbframes = endtime - paintedtime;
2114 // limit to the end of the ring buffer (in case of wrapping)
2115 startoffset = paintedtime % snd_renderbuffer->maxframes;
2116 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2118 // mix into the buffer
2119 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2121 paintedtime += nbframes;
2122 snd_renderbuffer->endframe = paintedtime;
2125 SndSys_UnlockRenderBuffer();
2127 // Remove outdated samples from the ring buffer, if any
2128 if (snd_renderbuffer->startframe < soundtime)
2129 snd_renderbuffer->startframe = soundtime;
2132 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2136 oldsoundtime = soundtime;
2138 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2139 R_TimeReport("audiomix");
2146 Called once each time through the main loop
2149 void S_Update(const matrix4x4_t *listenermatrix)
2151 unsigned int i, j, k;
2152 channel_t *ch, *combine;
2153 matrix4x4_t rotatematrix;
2155 if (snd_renderbuffer == NULL || nosound.integer)
2159 double mindist_trans, maxdist_trans;
2161 spatialmin = snd_spatialization_min.value;
2162 spatialdiff = snd_spatialization_max.value - spatialmin;
2164 if(snd_spatialization_control.value)
2166 spatialpower = snd_spatialization_power.value;
2168 if(spatialpower == 0)
2170 spatialmethod = SPATIAL_LOG;
2171 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2172 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2176 spatialmethod = SPATIAL_POW;
2177 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2178 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2181 if(mindist_trans - maxdist_trans == 0)
2183 spatialmethod = SPATIAL_THRESH;
2184 mindist_trans = snd_spatialization_min_radius.value;
2188 spatialoffset = mindist_trans;
2189 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2193 spatialmethod = SPATIAL_NONE;
2197 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2198 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2199 current_channellayout != snd_channellayout.integer)
2200 S_SetChannelLayout();
2202 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2203 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2204 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2206 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2209 Mem_Free(listener_pvs);
2210 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2211 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2213 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2219 Mem_Free(listener_pvs);
2220 listener_pvs = NULL;
2222 listener_pvsbytes = 0;
2225 // calculate the current matrices
2226 for (j = 0;j < SND_LISTENERS;j++)
2228 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2229 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2230 // I think this should now do this:
2231 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2232 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2233 // angle has to be taken negative)
2234 // 2. create a transform which first rotates and moves its argument
2235 // into the player's view coordinates (using basematrix which is
2236 // an inverted "absolute" listener matrix), then applies the
2237 // rotation matrix for the ear
2238 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2239 // does not actually refer to an entity?
2242 // update general area ambient sound sources
2243 S_UpdateAmbientSounds ();
2246 R_TimeReport("audioprep");
2248 // update spatialization for static and dynamic sounds
2249 cls.soundstats.totalsounds = 0;
2250 cls.soundstats.mixedsounds = 0;
2251 ch = channels+NUM_AMBIENTS;
2252 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2256 cls.soundstats.totalsounds++;
2258 // respatialize channel
2259 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2261 // try to combine static sounds with a previous channel of the same
2262 // sound effect so we don't mix five torches every frame
2263 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2265 // no need to merge silent channels
2266 for (j = 0;j < SND_LISTENERS;j++)
2269 if (j == SND_LISTENERS)
2271 // if the last combine chosen isn't suitable, find a new one
2272 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2276 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2278 if (channels[j].sfx == ch->sfx)
2280 combine = channels + j;
2285 if (combine && combine != ch && combine->sfx == ch->sfx)
2287 for (j = 0;j < SND_LISTENERS;j++)
2289 combine->volume[j] += ch->volume[j];
2294 for (k = 0;k < SND_LISTENERS;k++)
2297 if (k < SND_LISTENERS)
2298 cls.soundstats.mixedsounds++;
2300 R_TimeReport("audiospatialize");
2302 sound_spatialized = true;
2305 if (snd_show.integer)
2306 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2311 void S_ExtraUpdate (void)
2313 if (snd_noextraupdate.integer || !sound_spatialized)
2319 qboolean S_LocalSound (const char *sound)
2324 if (!snd_initialized.integer || nosound.integer)
2327 sfx = S_PrecacheSound (sound, true, false);
2330 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2334 // menu sounds must not be freed on level change
2335 sfx->flags |= SFXFLAG_MENUSOUND;
2337 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2338 // which we no longer support anyway
2339 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2340 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2344 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;