2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
27 #include "cl_collision.h"
33 #define SND_MIN_SPEED 8000
34 #define SND_MAX_SPEED 192000
35 #define SND_MIN_WIDTH 1
36 #define SND_MAX_WIDTH 2
37 #define SND_MIN_CHANNELS 1
38 #define SND_MAX_CHANNELS 8
39 #if SND_LISTENERS != 8
40 # error this data only supports up to 8 channel, update it!
43 speakerlayout_t snd_speakerlayout;
45 // Our speaker layouts are based on ALSA. They differ from those
46 // Win32 and Mac OS X APIs use when there's more than 4 channels.
47 // (rear left + rear right, and front center + LFE are swapped).
48 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
49 static const speakerlayout_t snd_speakerlayouts[] =
54 {0, 45, 0.2f, 0.2f, 0.5f}, // front left
55 {1, 315, 0.2f, 0.2f, 0.5f}, // front right
56 {2, 135, 0.2f, 0.2f, 0.5f}, // rear left
57 {3, 225, 0.2f, 0.2f, 0.5f}, // rear right
58 {4, 0, 0.2f, 0.2f, 0.5f}, // front center
59 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
60 {6, 90, 0.2f, 0.2f, 0.5f}, // side left
61 {7, 180, 0.2f, 0.2f, 0.5f}, // side right
67 {0, 45, 0.2f, 0.2f, 0.5f}, // front left
68 {1, 315, 0.2f, 0.2f, 0.5f}, // front right
69 {2, 135, 0.2f, 0.2f, 0.5f}, // rear left
70 {3, 225, 0.2f, 0.2f, 0.5f}, // rear right
71 {4, 0, 0.2f, 0.2f, 0.5f}, // front center
72 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
78 // these systems sometimes have a subwoofer as well, but it has no
82 {0, 45, 0.3f, 0.3f, 0.8f}, // front left
83 {1, 315, 0.3f, 0.3f, 0.8f}, // front right
84 {2, 135, 0.3f, 0.3f, 0.8f}, // rear left
85 {3, 225, 0.3f, 0.3f, 0.8f}, // rear right
93 // these systems sometimes have a subwoofer as well, but it has no
97 {0, 90, 0.5f, 0.5f, 1}, // side left
98 {1, 270, 0.5f, 0.5f, 1}, // side right
110 {0, 0, 0, 1, 1}, // center
123 // =======================================================================
124 // Internal sound data & structures
125 // =======================================================================
127 channel_t channels[MAX_CHANNELS];
128 unsigned int total_channels;
130 snd_ringbuffer_t *snd_renderbuffer = NULL;
131 static unsigned int soundtime = 0;
132 static unsigned int oldpaintedtime = 0;
133 static unsigned int extrasoundtime = 0;
134 static double snd_starttime = 0.0;
135 qboolean snd_threaded = false;
136 qboolean snd_usethreadedmixing = false;
138 vec3_t listener_origin;
139 matrix4x4_t listener_basematrix;
140 static unsigned char *listener_pvs = NULL;
141 static int listener_pvsbytes = 0;
142 matrix4x4_t listener_matrix[SND_LISTENERS];
143 mempool_t *snd_mempool;
145 // Linked list of known sfx
146 static sfx_t *known_sfx = NULL;
148 static qboolean sound_spatialized = false;
150 qboolean simsound = false;
152 static qboolean recording_sound = false;
155 static int current_swapstereo = false;
156 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
157 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
159 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
160 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
161 spatialmethod_t spatialmethod;
163 // Cvars declared in sound.h (part of the sound API)
164 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
165 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
166 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
167 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
168 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
169 cvar_t snd_soundradius = {CVAR_SAVE, "snd_soundradius", "1200", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
170 cvar_t snd_attenuation_exponent = {CVAR_SAVE, "snd_attenuation_exponent", "1", "Exponent of (1-radius) in sound attenuation formula"};
171 cvar_t snd_attenuation_decibel = {CVAR_SAVE, "snd_attenuation_decibel", "0", "Decibel sound attenuation per sound radius distance"};
172 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
173 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
174 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
175 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
176 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
177 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
178 cvar_t snd_spatialization_prologic = {CVAR_SAVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
179 cvar_t snd_spatialization_prologic_frontangle = {CVAR_SAVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
180 cvar_t snd_spatialization_occlusion = {CVAR_SAVE, "snd_spatialization_occlusion", "1", "enable occlusion testing on spatialized sounds, which simply quiets sounds that are blocked by the world; 1 enables PVS method, 2 enables LineOfSight method, 3 enables both"};
182 // Cvars declared in snd_main.h (shared with other snd_*.c files)
183 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
184 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory); when set to 2, streaming is performed even if this would waste memory"};
185 cvar_t snd_streaming_length = { CVAR_SAVE, "snd_streaming_length", "1", "decompress sounds completely if they are less than this play time when snd_streaming is 1"};
186 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
187 extern cvar_t v_flipped;
188 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
189 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
190 cvar_t snd_maxchannelvolume = {CVAR_SAVE, "snd_maxchannelvolume", "10", "maximum volume of a single sound"};
191 cvar_t snd_softclip = {CVAR_SAVE, "snd_softclip", "0", "Use soft-clipping. Soft-clipping can make the sound more smooth if very high volume levels are used. Enable this option if the dynamic range of the loudspeakers is very low. WARNING: This feature creates distortion and should be considered a last resort."};
192 //cvar_t snd_softclip = {CVAR_SAVE, "snd_softclip", "0", "Use soft-clipping (when set to 2, use it even if output is floating point). Soft-clipping can make the sound more smooth if very high volume levels are used. Enable this option if the dynamic range of the loudspeakers is very low. WARNING: This feature creates distortion and should be considered a last resort."};
193 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
194 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
195 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
196 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
197 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
198 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
199 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
200 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
201 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
202 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
203 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
204 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
205 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
206 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
207 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
208 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
209 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
210 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
211 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
212 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
213 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
214 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
215 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
216 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
217 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
218 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
219 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
220 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
221 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
222 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
223 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
224 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
225 cvar_t snd_channel0volume = {CVAR_SAVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
226 cvar_t snd_channel1volume = {CVAR_SAVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
227 cvar_t snd_channel2volume = {CVAR_SAVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
228 cvar_t snd_channel3volume = {CVAR_SAVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
229 cvar_t snd_channel4volume = {CVAR_SAVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
230 cvar_t snd_channel5volume = {CVAR_SAVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
231 cvar_t snd_channel6volume = {CVAR_SAVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
232 cvar_t snd_channel7volume = {CVAR_SAVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
235 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
236 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
237 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
238 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
239 static cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0", "disables extra sound mixer calls that are meant to reduce the chance of sound breakup at very low framerates"};
240 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
242 // Default sound format is 48KHz, 16-bit, stereo
243 // (48KHz because a lot of onboard sound cards sucks at any other speed)
244 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
245 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
246 static cvar_t snd_channels = {CVAR_SAVE, "snd_channels", "2", "number of channels for the sound output (2 for stereo; up to 8 supported for 3D sound)"};
248 static cvar_t snd_startloopingsounds = {0, "snd_startloopingsounds", "1", "whether to start sounds that would loop (you want this to be 1); existing sounds are not affected"};
249 static cvar_t snd_startnonloopingsounds = {0, "snd_startnonloopingsounds", "1", "whether to start sounds that would not loop (you want this to be 1); existing sounds are not affected"};
252 static cvar_t snd_identicalsoundrandomization_time = {0, "snd_identicalsoundrandomization_time", "0.1", "how much seconds to randomly skip (positive) or delay (negative) sounds when multiple identical sounds are started on the same frame"};
253 static cvar_t snd_identicalsoundrandomization_tics = {0, "snd_identicalsoundrandomization_tics", "0", "if nonzero, how many tics to limit sound randomization as defined by snd_identicalsoundrandomization_time"};
256 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
257 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
260 // ====================================================================
262 // ====================================================================
264 void S_FreeSfx (sfx_t *sfx, qboolean force);
266 static void S_Play_Common (float fvol, float attenuation)
269 char name [MAX_QPATH];
273 while (i < Cmd_Argc ())
275 // Get the name, and appends ".wav" as an extension if there's none
276 strlcpy (name, Cmd_Argv (i), sizeof (name));
277 if (!strrchr (name, '.'))
278 strlcat (name, ".wav", sizeof (name));
281 // If we need to get the volume from the command line
284 fvol = atof (Cmd_Argv (i));
288 sfx = S_PrecacheSound (name, true, true);
291 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
293 // Free the sfx if the file didn't exist
295 S_FreeSfx (sfx, false);
297 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
302 static void S_Play_f(void)
304 S_Play_Common (1.0f, 1.0f);
307 static void S_Play2_f(void)
309 S_Play_Common (1.0f, 0.0f);
312 static void S_PlayVol_f(void)
314 S_Play_Common (-1.0f, 0.0f);
317 static void S_SoundList_f (void)
324 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
326 if (sfx->fetcher != NULL)
330 size = (unsigned int)sfx->memsize;
331 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
332 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
333 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
334 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
336 sfx->format.width * 8,
337 (sfx->format.channels == 1) ? "mono" : "stereo",
343 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
345 Con_Printf("Total resident: %i\n", total);
349 static void S_SoundInfo_f(void)
351 if (snd_renderbuffer == NULL)
353 Con_Print("sound system not started\n");
357 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
358 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
359 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
360 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
361 Con_Printf("%5u total_channels\n", total_channels);
365 int S_GetSoundRate(void)
367 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
370 int S_GetSoundChannels(void)
372 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
376 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
378 static const snd_format_t thresholds [] =
380 // speed width channels
381 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
387 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
389 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
390 unsigned int speed_level, width_level, channels_level;
392 // If we have reached the minimum values, there's nothing more we can do
393 if ((format->speed == thresholds[0].speed || fixed_speed) &&
394 (format->width == thresholds[0].width || fixed_width) &&
395 (format->channels == thresholds[0].channels || fixed_channels))
398 // Check the min and max values
399 #define CHECK_BOUNDARIES(param) \
400 if (format->param < thresholds[0].param) \
402 format->param = thresholds[0].param; \
405 if (format->param > thresholds[nb_thresholds - 1].param) \
407 format->param = thresholds[nb_thresholds - 1].param; \
410 CHECK_BOUNDARIES(speed);
411 CHECK_BOUNDARIES(width);
412 CHECK_BOUNDARIES(channels);
413 #undef CHECK_BOUNDARIES
415 // Find the level of each parameter
416 #define FIND_LEVEL(param) \
418 while (param##_level < nb_thresholds - 1) \
420 if (format->param <= thresholds[param##_level].param) \
427 FIND_LEVEL(channels);
430 // Decrease the parameter with the highest level to the previous level
431 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
433 format->channels = thresholds[channels_level - 1].channels;
436 if (speed_level >= width_level && !fixed_speed)
438 format->speed = thresholds[speed_level - 1].speed;
442 format->width = thresholds[width_level - 1].width;
447 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
449 static void S_SetChannelLayout (void)
452 listener_t swaplistener;
453 listener_t *listeners;
456 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
457 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
459 if (i >= SND_SPEAKERLAYOUTS)
461 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
462 snd_renderbuffer->format.channels);
463 i = SND_SPEAKERLAYOUTS - 1;
466 snd_speakerlayout = snd_speakerlayouts[i];
467 listeners = snd_speakerlayout.listeners;
469 // Swap the left and right channels if snd_swapstereo is set
470 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
472 switch (snd_speakerlayout.channels)
475 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
479 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
482 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
493 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
494 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
495 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
497 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
499 // If we're in the sound engine initialization
500 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
502 layout = SND_CHANNELLAYOUT_STANDARD;
503 Cvar_SetValueQuick (&snd_channellayout, layout);
506 layout = current_channellayout_used;
509 layout = snd_channellayout.integer;
511 // Convert our layout (= ALSA) to the standard layout if necessary
512 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
514 if (layout == SND_CHANNELLAYOUT_STANDARD)
516 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
517 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
520 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
521 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
524 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
525 current_channellayout = snd_channellayout.integer;
526 current_channellayout_used = layout;
530 void S_Startup (void)
532 qboolean fixed_speed, fixed_width, fixed_channels;
533 snd_format_t chosen_fmt;
534 static snd_format_t prev_render_format = {0, 0, 0};
541 if (!snd_initialized.integer)
546 fixed_channels = false;
548 // Get the starting sound format from the cvars
549 chosen_fmt.speed = snd_speed.integer;
550 chosen_fmt.width = snd_width.integer;
551 chosen_fmt.channels = snd_channels.integer;
553 // Check the environment variables to see if the player wants a particular sound format
555 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
557 env = getenv("QUAKE_SOUND_CHANNELS");
561 chosen_fmt.channels = atoi (env);
565 fixed_channels = true;
568 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
570 env = getenv("QUAKE_SOUND_SPEED");
574 chosen_fmt.speed = atoi (env);
581 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
583 env = getenv("QUAKE_SOUND_SAMPLEBITS");
587 chosen_fmt.width = atoi (env) / 8;
594 // Parse the command line to see if the player wants a particular sound format
595 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
596 if (COM_CheckParm ("-sndquad") != 0)
598 chosen_fmt.channels = 4;
599 fixed_channels = true;
601 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
602 else if (COM_CheckParm ("-sndstereo") != 0)
604 chosen_fmt.channels = 2;
605 fixed_channels = true;
607 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
608 else if (COM_CheckParm ("-sndmono") != 0)
610 chosen_fmt.channels = 1;
611 fixed_channels = true;
613 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
614 i = COM_CheckParm ("-sndspeed");
615 if (0 < i && i < com_argc - 1)
617 chosen_fmt.speed = atoi (com_argv[i + 1]);
620 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
621 i = COM_CheckParm ("-sndbits");
622 if (0 < i && i < com_argc - 1)
624 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
629 // LordHavoc: now you can with the resampler...
630 // You can't change sound speed after start time (not yet supported)
631 if (prev_render_format.speed != 0)
634 if (chosen_fmt.speed != prev_render_format.speed)
636 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
637 prev_render_format.speed);
638 chosen_fmt.speed = prev_render_format.speed;
644 if (chosen_fmt.speed < SND_MIN_SPEED)
646 chosen_fmt.speed = SND_MIN_SPEED;
649 else if (chosen_fmt.speed > SND_MAX_SPEED)
651 chosen_fmt.speed = SND_MAX_SPEED;
655 if (chosen_fmt.width < SND_MIN_WIDTH)
657 chosen_fmt.width = SND_MIN_WIDTH;
660 else if (chosen_fmt.width > SND_MAX_WIDTH)
662 chosen_fmt.width = SND_MAX_WIDTH;
666 if (chosen_fmt.channels < SND_MIN_CHANNELS)
668 chosen_fmt.channels = SND_MIN_CHANNELS;
669 fixed_channels = false;
671 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
673 chosen_fmt.channels = SND_MAX_CHANNELS;
674 fixed_channels = false;
677 // create the sound buffer used for sumitting the samples to the plaform-dependent module
680 snd_format_t suggest_fmt;
686 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
687 chosen_fmt.speed, chosen_fmt.width * 8,
688 chosen_fmt.channels);
690 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
691 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
695 Con_Printf("S_Startup: sound output initialization FAILED\n");
697 // If the module is suggesting another one
698 if (suggest_fmt.speed != 0)
700 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
701 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
702 suggest_fmt.speed, suggest_fmt.width * 8,
703 suggest_fmt.channels);
705 // Else, try to find a less resource-demanding format
706 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
711 // If we haven't found a suitable format
714 Con_Print("S_Startup: SndSys_Init failed.\n");
715 sound_spatialized = false;
721 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
722 Con_Print ("S_Startup: simulating sound output\n");
725 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
726 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
727 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
730 if (snd_speed.integer != (int)chosen_fmt.speed)
731 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
732 if (snd_width.integer != chosen_fmt.width)
733 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
734 if (snd_channels.integer != chosen_fmt.channels)
735 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
737 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
738 S_SetChannelLayout();
740 snd_starttime = realtime;
742 // If the sound module has already run, add an extra time to make sure
743 // the sound time doesn't decrease, to not confuse playing SFXs
744 if (oldpaintedtime != 0)
746 // The extra time must be a multiple of the render buffer size
747 // to avoid modifying the current position in the buffer,
748 // some modules write directly to a shared (DMA) buffer
749 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
750 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
751 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
753 soundtime = extrasoundtime;
757 snd_renderbuffer->startframe = soundtime;
758 snd_renderbuffer->endframe = soundtime;
759 recording_sound = false;
762 void S_Shutdown(void)
764 if (snd_renderbuffer == NULL)
767 oldpaintedtime = snd_renderbuffer->endframe;
771 Mem_Free(snd_renderbuffer->ring);
772 Mem_Free(snd_renderbuffer);
773 snd_renderbuffer = NULL;
778 sound_spatialized = false;
781 static void S_Restart_f(void)
783 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
784 // So, refuse to do this if we are connected.
785 if(cls.state == ca_connected)
787 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
802 Cvar_RegisterVariable(&volume);
803 Cvar_RegisterVariable(&bgmvolume);
804 Cvar_RegisterVariable(&mastervolume);
805 Cvar_RegisterVariable(&snd_staticvolume);
806 Cvar_RegisterVariable(&snd_entchannel0volume);
807 Cvar_RegisterVariable(&snd_entchannel1volume);
808 Cvar_RegisterVariable(&snd_entchannel2volume);
809 Cvar_RegisterVariable(&snd_entchannel3volume);
810 Cvar_RegisterVariable(&snd_entchannel4volume);
811 Cvar_RegisterVariable(&snd_entchannel5volume);
812 Cvar_RegisterVariable(&snd_entchannel6volume);
813 Cvar_RegisterVariable(&snd_entchannel7volume);
814 Cvar_RegisterVariable(&snd_worldchannel0volume);
815 Cvar_RegisterVariable(&snd_worldchannel1volume);
816 Cvar_RegisterVariable(&snd_worldchannel2volume);
817 Cvar_RegisterVariable(&snd_worldchannel3volume);
818 Cvar_RegisterVariable(&snd_worldchannel4volume);
819 Cvar_RegisterVariable(&snd_worldchannel5volume);
820 Cvar_RegisterVariable(&snd_worldchannel6volume);
821 Cvar_RegisterVariable(&snd_worldchannel7volume);
822 Cvar_RegisterVariable(&snd_playerchannel0volume);
823 Cvar_RegisterVariable(&snd_playerchannel1volume);
824 Cvar_RegisterVariable(&snd_playerchannel2volume);
825 Cvar_RegisterVariable(&snd_playerchannel3volume);
826 Cvar_RegisterVariable(&snd_playerchannel4volume);
827 Cvar_RegisterVariable(&snd_playerchannel5volume);
828 Cvar_RegisterVariable(&snd_playerchannel6volume);
829 Cvar_RegisterVariable(&snd_playerchannel7volume);
830 Cvar_RegisterVariable(&snd_csqcchannel0volume);
831 Cvar_RegisterVariable(&snd_csqcchannel1volume);
832 Cvar_RegisterVariable(&snd_csqcchannel2volume);
833 Cvar_RegisterVariable(&snd_csqcchannel3volume);
834 Cvar_RegisterVariable(&snd_csqcchannel4volume);
835 Cvar_RegisterVariable(&snd_csqcchannel5volume);
836 Cvar_RegisterVariable(&snd_csqcchannel6volume);
837 Cvar_RegisterVariable(&snd_csqcchannel7volume);
838 Cvar_RegisterVariable(&snd_channel0volume);
839 Cvar_RegisterVariable(&snd_channel1volume);
840 Cvar_RegisterVariable(&snd_channel2volume);
841 Cvar_RegisterVariable(&snd_channel3volume);
842 Cvar_RegisterVariable(&snd_channel4volume);
843 Cvar_RegisterVariable(&snd_channel5volume);
844 Cvar_RegisterVariable(&snd_channel6volume);
845 Cvar_RegisterVariable(&snd_channel7volume);
847 Cvar_RegisterVariable(&snd_attenuation_exponent);
848 Cvar_RegisterVariable(&snd_attenuation_decibel);
850 Cvar_RegisterVariable(&snd_spatialization_min_radius);
851 Cvar_RegisterVariable(&snd_spatialization_max_radius);
852 Cvar_RegisterVariable(&snd_spatialization_min);
853 Cvar_RegisterVariable(&snd_spatialization_max);
854 Cvar_RegisterVariable(&snd_spatialization_power);
855 Cvar_RegisterVariable(&snd_spatialization_control);
856 Cvar_RegisterVariable(&snd_spatialization_occlusion);
857 Cvar_RegisterVariable(&snd_spatialization_prologic);
858 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
860 Cvar_RegisterVariable(&snd_speed);
861 Cvar_RegisterVariable(&snd_width);
862 Cvar_RegisterVariable(&snd_channels);
863 Cvar_RegisterVariable(&snd_mutewhenidle);
864 Cvar_RegisterVariable(&snd_maxchannelvolume);
865 Cvar_RegisterVariable(&snd_softclip);
867 Cvar_RegisterVariable(&snd_startloopingsounds);
868 Cvar_RegisterVariable(&snd_startnonloopingsounds);
870 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
871 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
873 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
874 if (COM_CheckParm("-nosound"))
876 // dummy out Play and Play2 because mods stuffcmd that
877 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
878 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
882 snd_mempool = Mem_AllocPool("sound", 0, NULL);
884 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
885 if (COM_CheckParm("-simsound"))
888 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
889 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
890 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
891 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
892 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
893 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
894 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
895 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
897 Cvar_RegisterVariable(&nosound);
898 Cvar_RegisterVariable(&snd_precache);
899 Cvar_RegisterVariable(&snd_initialized);
900 Cvar_RegisterVariable(&snd_streaming);
901 Cvar_RegisterVariable(&snd_streaming_length);
902 Cvar_RegisterVariable(&ambient_level);
903 Cvar_RegisterVariable(&ambient_fade);
904 Cvar_RegisterVariable(&snd_noextraupdate);
905 Cvar_RegisterVariable(&snd_show);
906 Cvar_RegisterVariable(&_snd_mixahead);
907 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
908 Cvar_RegisterVariable(&snd_channellayout);
909 Cvar_RegisterVariable(&snd_soundradius);
911 Cvar_SetValueQuick(&snd_initialized, true);
915 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
916 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
926 Shutdown and free all resources
929 void S_Terminate (void)
935 while (known_sfx != NULL)
936 S_FreeSfx (known_sfx, true);
938 Cvar_SetValueQuick (&snd_initialized, false);
939 Mem_FreePool (&snd_mempool);
948 void S_UnloadAllSounds_f (void)
952 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
953 // So, refuse to do this if we are connected.
954 if(cls.state == ca_connected)
956 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
960 // stop any active sounds
963 // because the ambient sounds will be freed, clear the pointers
964 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
965 ambient_sfxs[i] = NULL;
967 // now free all sounds
968 while (known_sfx != NULL)
969 S_FreeSfx (known_sfx, true);
978 sfx_t changevolume_sfx = {""};
979 sfx_t *S_FindName (const char *name)
983 if (!snd_initialized.integer)
986 if(!strcmp(name, changevolume_sfx.name))
987 return &changevolume_sfx;
989 if (strlen (name) >= sizeof (sfx->name))
991 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
995 // Look for this sound in the list of known sfx
996 // TODO: hash table search?
997 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
998 if(!strcmp (sfx->name, name))
1001 // check for # in the beginning, try lookup by soundindex
1002 if (name[0] == '#' && name[1])
1004 int soundindex = atoi(name + 1);
1005 if (soundindex > 0 && soundindex < MAX_SOUNDS)
1006 if (cl.sound_precache[soundindex]->name[0])
1007 return cl.sound_precache[soundindex];
1010 // Add a sfx_t struct for this sound
1011 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
1012 memset (sfx, 0, sizeof(*sfx));
1013 strlcpy (sfx->name, name, sizeof (sfx->name));
1014 sfx->memsize = sizeof(*sfx);
1015 sfx->next = known_sfx;
1027 void S_FreeSfx (sfx_t *sfx, qboolean force)
1031 // Do not free a precached sound during purge
1032 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1035 if (developer_loading.integer)
1036 Con_Printf ("unloading sound %s\n", sfx->name);
1038 // Remove it from the list of known sfx
1039 if (sfx == known_sfx)
1040 known_sfx = known_sfx->next;
1045 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
1046 if (prev_sfx->next == sfx)
1048 prev_sfx->next = sfx->next;
1051 if (prev_sfx == NULL)
1053 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1058 // Stop all channels using this sfx
1059 for (i = 0; i < total_channels; i++)
1061 if (channels[i].sfx == sfx)
1063 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
1064 S_StopChannel (i, true, false);
1069 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
1070 sfx->fetcher->freesfx(sfx);
1080 void S_ClearUsed (void)
1086 // Start the ambient sounds and make them loop
1087 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1089 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1090 if (ambient_sfxs[i] == NULL)
1091 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1092 if (ambient_sfxs[i] != NULL)
1094 channels[i].sfx = ambient_sfxs[i];
1095 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1096 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1097 channels[i].basevolume = 0.0f;
1098 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1102 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1103 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1104 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1112 void S_PurgeUnused(void)
1117 // Free all not-precached per-level sfx
1118 for (sfx = known_sfx;sfx;sfx = sfxnext)
1120 sfxnext = sfx->next;
1121 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1122 S_FreeSfx (sfx, false);
1132 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean levelsound)
1136 if (!snd_initialized.integer)
1139 if (name == NULL || name[0] == 0)
1142 sfx = S_FindName (name);
1147 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1148 // previously missing file
1149 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1151 // set a flag to indicate this has been precached for this level or permanently
1153 sfx->flags |= SFXFLAG_LEVELSOUND;
1155 sfx->flags |= SFXFLAG_MENUSOUND;
1157 if (!nosound.integer && snd_precache.integer)
1158 S_LoadSound(sfx, complain);
1169 float S_SoundLength(const char *name)
1173 if (!snd_initialized.integer)
1175 if (name == NULL || name[0] == 0)
1178 sfx = S_FindName(name);
1181 return sfx->total_length / (float) S_GetSoundRate();
1189 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1191 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1199 void S_BlockSound (void)
1210 void S_UnblockSound (void)
1220 Picks a channel based on priorities, empty slots, number of channels
1223 static channel_t *SND_PickChannel(int entnum, int entchannel)
1227 int first_life_left, life_left;
1229 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1231 // Check for replacement sound, or find the best one to replace
1233 first_life_left = 0x7fffffff;
1235 // entity channels try to replace the existing sound on the channel
1236 // channels <= 0 are autochannels
1237 if (IS_CHAN_SINGLE(entchannel))
1239 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1241 ch = &channels[ch_idx];
1242 if (ch->entnum == entnum && ch->entchannel == entchannel)
1244 // always override sound from same entity
1245 S_StopChannel (ch_idx, true, false);
1246 return &channels[ch_idx];
1251 // there was no channel to override, so look for the first empty one
1252 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1254 ch = &channels[ch_idx];
1255 sfx = ch->sfx; // fetch the volatile variable
1258 // no sound on this channel
1259 first_to_die = ch_idx;
1260 goto emptychan_found;
1263 // don't let monster sounds override player sounds
1264 if ((ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity()) && !(entnum == cl.viewentity || entnum == CL_VM_GetViewEntity()))
1267 // don't override looped sounds
1268 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1270 life_left = (int)((double)sfx->total_length - ch->position);
1272 if (life_left < first_life_left)
1274 first_life_left = life_left;
1275 first_to_die = ch_idx;
1279 if (first_to_die == -1)
1282 S_StopChannel (first_to_die, true, false);
1285 return &channels[first_to_die];
1292 Spatializes a channel
1295 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1296 static void SND_Spatialize_WithSfx(channel_t *ch, qboolean isstatic, sfx_t *sfx)
1300 float angle_side, angle_front, angle_factor, mixspeed;
1301 vec_t dist, mastervol, intensity;
1305 // update sound origin if we know about the entity
1306 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1308 if (ch->entnum >= MAX_EDICTS)
1310 //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]);
1312 if (ch->entnum > MAX_EDICTS)
1313 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1314 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1316 else if (cl.entities[ch->entnum].state_current.active)
1319 //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]);
1320 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1321 if (model && model->soundfromcenter)
1322 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1324 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1326 else if (cl.csqc_server2csqcentitynumber[ch->entnum])
1328 //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]);
1330 if (!CL_VM_GetEntitySoundOrigin(cl.csqc_server2csqcentitynumber[ch->entnum] + MAX_EDICTS, ch->origin))
1331 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1335 mastervol = ch->basevolume;
1336 mixspeed = ch->basespeed;
1338 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1340 // Adjust volume of static sounds
1342 mastervol *= snd_staticvolume.value;
1343 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1345 // old legacy separated cvars
1346 if(ch->entnum >= MAX_EDICTS)
1348 switch(ch->entchannel)
1350 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1351 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1352 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1353 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1354 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1355 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1356 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1357 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1361 else if(ch->entnum == 0)
1363 switch(ch->entchannel)
1365 case 0: mastervol *= snd_worldchannel0volume.value; break;
1366 case 1: mastervol *= snd_worldchannel1volume.value; break;
1367 case 2: mastervol *= snd_worldchannel2volume.value; break;
1368 case 3: mastervol *= snd_worldchannel3volume.value; break;
1369 case 4: mastervol *= snd_worldchannel4volume.value; break;
1370 case 5: mastervol *= snd_worldchannel5volume.value; break;
1371 case 6: mastervol *= snd_worldchannel6volume.value; break;
1372 case 7: mastervol *= snd_worldchannel7volume.value; break;
1376 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1378 switch(ch->entchannel)
1380 case 0: mastervol *= snd_playerchannel0volume.value; break;
1381 case 1: mastervol *= snd_playerchannel1volume.value; break;
1382 case 2: mastervol *= snd_playerchannel2volume.value; break;
1383 case 3: mastervol *= snd_playerchannel3volume.value; break;
1384 case 4: mastervol *= snd_playerchannel4volume.value; break;
1385 case 5: mastervol *= snd_playerchannel5volume.value; break;
1386 case 6: mastervol *= snd_playerchannel6volume.value; break;
1387 case 7: mastervol *= snd_playerchannel7volume.value; break;
1393 switch(ch->entchannel)
1395 case 0: mastervol *= snd_entchannel0volume.value; break;
1396 case 1: mastervol *= snd_entchannel1volume.value; break;
1397 case 2: mastervol *= snd_entchannel2volume.value; break;
1398 case 3: mastervol *= snd_entchannel3volume.value; break;
1399 case 4: mastervol *= snd_entchannel4volume.value; break;
1400 case 5: mastervol *= snd_entchannel5volume.value; break;
1401 case 6: mastervol *= snd_entchannel6volume.value; break;
1402 case 7: mastervol *= snd_entchannel7volume.value; break;
1407 switch(ch->entchannel)
1409 case 0: mastervol *= snd_channel0volume.value; break;
1410 case 1: mastervol *= snd_channel1volume.value; break;
1411 case 2: mastervol *= snd_channel2volume.value; break;
1412 case 3: mastervol *= snd_channel3volume.value; break;
1413 case 4: mastervol *= snd_channel4volume.value; break;
1414 case 5: mastervol *= snd_channel5volume.value; break;
1415 case 6: mastervol *= snd_channel6volume.value; break;
1416 case 7: mastervol *= snd_channel7volume.value; break;
1417 default: mastervol *= Cvar_VariableValueOr(va(vabuf, sizeof(vabuf), "snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0); break;
1421 // If this channel does not manage its own volume (like CD tracks)
1422 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1423 mastervol *= volume.value;
1425 if(snd_maxchannelvolume.value > 0)
1427 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1428 mastervol = bound(0.0f, mastervol, 10.0f * snd_maxchannelvolume.value);
1431 // always apply "master"
1432 mastervol *= mastervolume.value;
1434 // add in ReplayGain very late; prevent clipping when close
1436 if(sfx->volume_peak > 0)
1438 // Replaygain support
1439 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1440 mastervol *= sfx->volume_mult;
1441 if(snd_maxchannelvolume.value > 0)
1443 if(mastervol * sfx->volume_peak > snd_maxchannelvolume.value)
1444 mastervol = snd_maxchannelvolume.value / sfx->volume_peak;
1446 // Con_DPrintf("%f\n", fvol);
1449 if(snd_maxchannelvolume.value > 0)
1451 // clamp HERE to keep relative volumes of the channels correct
1452 mastervol = min(mastervol, snd_maxchannelvolume.value);
1455 mastervol = max(0.0f, mastervol);
1457 ch->mixspeed = mixspeed;
1459 // anything coming from the view entity will always be full volume
1460 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1461 if (ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity() || ch->distfade == 0)
1463 ch->prologic_invert = 1;
1464 if (snd_spatialization_prologic.integer != 0)
1466 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1467 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1468 for (i = 2;i < SND_LISTENERS;i++)
1473 for (i = 0;i < SND_LISTENERS;i++)
1474 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1479 // calculate stereo seperation and distance attenuation
1480 VectorSubtract(listener_origin, ch->origin, source_vec);
1481 dist = VectorLength(source_vec);
1482 f = dist * ch->distfade;
1485 ((snd_attenuation_exponent.value == 0) ? 1.0 : pow(1.0 - min(1.0, f), (double)snd_attenuation_exponent.value))
1487 ((snd_attenuation_decibel.value == 0) ? 1.0 : pow(0.1, 0.1 * snd_attenuation_decibel.value * f));
1489 intensity = mastervol * f;
1492 qboolean occluded = false;
1493 if (snd_spatialization_occlusion.integer)
1495 if(snd_spatialization_occlusion.integer & 1)
1496 if(listener_pvs && cl.worldmodel)
1498 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1499 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1503 if(snd_spatialization_occlusion.integer & 2)
1505 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1511 ch->prologic_invert = 1;
1512 if (snd_spatialization_prologic.integer != 0)
1515 angle_factor = 0.5f;
1518 Matrix4x4_Transform(&listener_basematrix, 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 // 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
1546 VectorNormalize(source_vec);
1547 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1548 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1549 if (angle_side > snd_spatialization_prologic_frontangle.value)
1551 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1552 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1553 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1554 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1555 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1556 if (angle_front > 0)
1557 angle_factor = 1 - angle_factor;
1560 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1561 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1564 ch->volume[0] = intensity * sqrt(angle_factor);
1565 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1566 for (i = 2;i < SND_LISTENERS;i++)
1571 for (i = 0;i < SND_LISTENERS;i++)
1573 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1574 VectorNormalize(source_vec);
1576 switch(spatialmethod)
1580 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1582 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1583 VectorScale(source_vec, f, source_vec);
1586 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1587 f = spatialmin + spatialdiff * bound(0, f, 1);
1588 VectorScale(source_vec, f, source_vec);
1590 case SPATIAL_THRESH:
1591 f = spatialmin + spatialdiff * (dist < spatialoffset);
1592 VectorScale(source_vec, f, source_vec);
1599 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1604 for (i = 0;i < SND_LISTENERS;i++)
1608 static void SND_Spatialize(channel_t *ch, qboolean isstatic)
1610 sfx_t *sfx = ch->sfx;
1611 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1615 // =======================================================================
1616 // Start a sound effect
1617 // =======================================================================
1619 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)
1623 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1627 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1629 if(!snd_startloopingsounds.integer)
1634 if(!snd_startnonloopingsounds.integer)
1638 // Initialize the channel
1639 // a crash was reported on an in-use channel, so check here...
1640 if (target_chan->sfx)
1642 int channelindex = (int)(target_chan - channels);
1643 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1644 S_StopChannel (channelindex, true, false);
1646 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1647 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1648 memset (target_chan, 0, sizeof (*target_chan));
1649 VectorCopy (origin, target_chan->origin);
1650 target_chan->flags = flags;
1651 target_chan->position = startpos; // start of the sound
1652 target_chan->entnum = entnum;
1653 target_chan->entchannel = entchannel;
1655 // If it's a static sound
1658 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1659 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1660 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1663 target_chan->distfade = attenuation / snd_soundradius.value;
1665 // set the listener volumes
1666 S_SetChannelVolume(target_chan - channels, fvol);
1667 S_SetChannelSpeed(target_chan - channels, fspeed);
1668 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1670 // finally, set the sfx pointer, so the channel becomes valid for playback
1671 // and will be noticed by the mixer
1672 target_chan->sfx = sfx;
1676 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)
1678 channel_t *target_chan, *check, *ch;
1679 int ch_idx, startpos, i;
1681 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1684 if(sfx == &changevolume_sfx)
1686 if (!IS_CHAN_SINGLE(entchannel))
1688 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1690 ch = &channels[ch_idx];
1691 if (ch->entnum == entnum && ch->entchannel == entchannel)
1693 S_SetChannelVolume(ch_idx, fvol);
1694 S_SetChannelSpeed(ch_idx, fspeed);
1695 for(i = 1; i > 0 && (i <= flags || i <= (int) channels[ch_idx].flags); i <<= 1)
1696 if((flags ^ channels[ch_idx].flags) & i)
1697 S_SetChannelFlag(ch_idx, i, (flags & i) != 0);
1698 ch->distfade = attenuation / snd_soundradius.value;
1699 SND_Spatialize(ch, false);
1706 if (sfx->fetcher == NULL)
1709 // Pick a channel to play on
1710 target_chan = SND_PickChannel(entnum, entchannel);
1714 // if an identical sound has also been started this frame, offset the pos
1715 // a bit to keep it from just making the first one louder
1716 check = &channels[NUM_AMBIENTS];
1717 startpos = (int)(startposition * sfx->format.speed);
1720 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1722 if (check == target_chan)
1724 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1726 // calculate max offset
1727 float maxtime = snd_identicalsoundrandomization_time.value;
1728 float maxtics = snd_identicalsoundrandomization_tics.value;
1729 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1731 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1734 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1736 // use negative pos offset to delay this sound effect
1737 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1743 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1745 return (target_chan - channels);
1748 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1750 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, 0, CHANNELFLAG_NONE, 1.0f);
1753 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex, qboolean freesfx)
1758 if (channel_ind >= total_channels)
1761 // we have to lock an audio mutex to prevent crashes if an audio mixer
1762 // thread is currently mixing this channel
1763 // the SndSys_LockRenderBuffer function uses such a mutex in
1764 // threaded sound backends
1765 if (lockmutex && !simsound)
1766 SndSys_LockRenderBuffer();
1768 ch = &channels[channel_ind];
1772 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1773 sfx->fetcher->stopchannel(ch);
1774 ch->fetcher_data = NULL;
1777 S_FreeSfx(sfx, true);
1779 if (lockmutex && !simsound)
1780 SndSys_UnlockRenderBuffer();
1784 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1786 if (ch_ind >= total_channels)
1789 if (flag != CHANNELFLAG_FORCELOOP &&
1790 flag != CHANNELFLAG_PAUSED &&
1791 flag != CHANNELFLAG_FULLVOLUME &&
1792 flag != CHANNELFLAG_LOCALSOUND)
1796 channels[ch_ind].flags |= flag;
1798 channels[ch_ind].flags &= ~flag;
1803 void S_StopSound(int entnum, int entchannel)
1807 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1808 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1810 S_StopChannel (i, true, false);
1815 void S_StopAllSounds (void)
1819 // TOCHECK: is this test necessary?
1820 if (snd_renderbuffer == NULL)
1824 // stop CD audio because it may be using a faketrack
1828 if (simsound || SndSys_LockRenderBuffer ())
1833 for (i = 0; i < total_channels; i++)
1834 if (channels[i].sfx)
1835 S_StopChannel (i, false, false);
1837 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1838 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1840 // Mute the contents of the submittion buffer
1841 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1842 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1843 memset(snd_renderbuffer->ring, clear, memsize);
1846 SndSys_UnlockRenderBuffer ();
1850 void S_PauseGameSounds (qboolean toggle)
1854 for (i = 0; i < total_channels; i++)
1859 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1860 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1864 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1866 channels[ch_ind].basevolume = fvol;
1869 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1871 channels[ch_ind].basespeed = fspeed;
1874 float S_GetChannelPosition (unsigned int ch_ind)
1876 // note: this is NOT accurate yet
1878 channel_t *ch = &channels[ch_ind];
1879 sfx_t *sfx = ch->sfx;
1883 s = ch->position / sfx->format.speed;
1885 if(!snd_usethreadedmixing)
1886 s += _snd_mixahead.value;
1891 float S_GetEntChannelPosition(int entnum, int entchannel)
1896 for (i = 0; i < total_channels; i++)
1899 if (ch->entnum == entnum && ch->entchannel == entchannel)
1900 return S_GetChannelPosition(i);
1902 return -1; // no playing sound in this channel
1910 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1912 channel_t *target_chan;
1914 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1918 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1922 if (total_channels == MAX_CHANNELS)
1924 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1928 target_chan = &channels[total_channels++];
1929 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1935 S_UpdateAmbientSounds
1938 static void S_UpdateAmbientSounds (void)
1942 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1943 int ambient_channel;
1945 unsigned char ambientlevels[NUM_AMBIENTS];
1948 memset(ambientlevels, 0, sizeof(ambientlevels));
1949 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1950 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1952 // Calc ambient sound levels
1953 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1955 chan = &channels[ambient_channel];
1956 sfx = chan->sfx; // fetch the volatile variable
1957 if (sfx == NULL || sfx->fetcher == NULL)
1960 i = ambientlevels[ambient_channel];
1963 vol = i * (1.0f / 256.0f);
1965 // Don't adjust volume too fast
1966 if (chan->basevolume < vol)
1968 chan->basevolume += fade;
1969 if (chan->basevolume > vol)
1970 chan->basevolume = vol;
1972 else if (chan->basevolume > vol)
1974 chan->basevolume -= fade;
1975 if (chan->basevolume < vol)
1976 chan->basevolume = vol;
1979 if (snd_spatialization_prologic.integer != 0)
1981 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1982 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1983 for (i = 2;i < SND_LISTENERS;i++)
1984 chan->volume[i] = 0.0f;
1988 for (i = 0;i < SND_LISTENERS;i++)
1989 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1994 static void S_PaintAndSubmit (void)
1996 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1997 int usesoundtimehack;
1998 static int soundtimehack = -1;
1999 static int oldsoundtime = 0;
2001 if (snd_renderbuffer == NULL || nosound.integer)
2004 // Update sound time
2005 snd_usethreadedmixing = false;
2006 usesoundtimehack = true;
2007 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
2009 usesoundtimehack = 1;
2010 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
2012 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
2014 usesoundtimehack = 2;
2015 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
2019 usesoundtimehack = 3;
2020 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
2024 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
2025 usesoundtimehack = 0;
2026 newsoundtime = SndSys_GetSoundTime();
2028 // if the soundtimehack state changes we need to reset the soundtime
2029 if (soundtimehack != usesoundtimehack)
2031 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
2033 // Mute the contents of the submission buffer
2034 if (simsound || SndSys_LockRenderBuffer ())
2039 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
2040 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
2041 memset(snd_renderbuffer->ring, clear, memsize);
2044 SndSys_UnlockRenderBuffer ();
2047 soundtimehack = usesoundtimehack;
2049 if (!soundtimehack && snd_blocked > 0)
2052 if (snd_usethreadedmixing)
2053 return; // the audio thread will mix its own data
2055 newsoundtime += extrasoundtime;
2056 if (newsoundtime < soundtime)
2058 if ((cls.capturevideo.soundrate != 0) != recording_sound)
2060 unsigned int additionaltime;
2062 // add some time to extrasoundtime make newsoundtime higher
2064 // The extra time must be a multiple of the render buffer size
2065 // to avoid modifying the current position in the buffer,
2066 // some modules write directly to a shared (DMA) buffer
2067 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
2068 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
2070 extrasoundtime += additionaltime;
2071 newsoundtime += additionaltime;
2072 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2075 else if (!soundtimehack)
2076 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2077 newsoundtime, soundtime);
2079 soundtime = newsoundtime;
2080 recording_sound = (cls.capturevideo.soundrate != 0);
2082 // Lock submitbuffer
2083 if (!simsound && !SndSys_LockRenderBuffer())
2085 // If the lock failed, stop here
2086 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2090 // Check to make sure that we haven't overshot
2091 paintedtime = snd_renderbuffer->endframe;
2092 if (paintedtime < soundtime)
2093 paintedtime = soundtime;
2095 // mix ahead of current position
2097 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2099 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2100 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2101 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2102 endtime = min(endtime, maxtime);
2104 while (paintedtime < endtime)
2106 unsigned int startoffset;
2107 unsigned int nbframes;
2109 // see how much we can fit in the paint buffer
2110 nbframes = endtime - paintedtime;
2111 // limit to the end of the ring buffer (in case of wrapping)
2112 startoffset = paintedtime % snd_renderbuffer->maxframes;
2113 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2115 // mix into the buffer
2116 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2118 paintedtime += nbframes;
2119 snd_renderbuffer->endframe = paintedtime;
2122 SndSys_UnlockRenderBuffer();
2124 // Remove outdated samples from the ring buffer, if any
2125 if (snd_renderbuffer->startframe < soundtime)
2126 snd_renderbuffer->startframe = soundtime;
2129 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2133 oldsoundtime = soundtime;
2135 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2136 R_TimeReport("audiomix");
2143 Called once each time through the main loop
2146 void S_Update(const matrix4x4_t *listenermatrix)
2148 unsigned int i, j, k;
2149 channel_t *ch, *combine;
2150 matrix4x4_t rotatematrix;
2152 if (snd_renderbuffer == NULL || nosound.integer)
2156 double mindist_trans, maxdist_trans;
2158 spatialmin = snd_spatialization_min.value;
2159 spatialdiff = snd_spatialization_max.value - spatialmin;
2161 if(snd_spatialization_control.value)
2163 spatialpower = snd_spatialization_power.value;
2165 if(spatialpower == 0)
2167 spatialmethod = SPATIAL_LOG;
2168 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2169 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2173 spatialmethod = SPATIAL_POW;
2174 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2175 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2178 if(mindist_trans - maxdist_trans == 0)
2180 spatialmethod = SPATIAL_THRESH;
2181 mindist_trans = snd_spatialization_min_radius.value;
2185 spatialoffset = mindist_trans;
2186 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2190 spatialmethod = SPATIAL_NONE;
2194 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2195 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2196 current_channellayout != snd_channellayout.integer)
2197 S_SetChannelLayout();
2199 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2200 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2201 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2203 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2206 Mem_Free(listener_pvs);
2207 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2208 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2210 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2216 Mem_Free(listener_pvs);
2217 listener_pvs = NULL;
2219 listener_pvsbytes = 0;
2222 // calculate the current matrices
2223 for (j = 0;j < SND_LISTENERS;j++)
2225 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2226 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2227 // I think this should now do this:
2228 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2229 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2230 // angle has to be taken negative)
2231 // 2. create a transform which first rotates and moves its argument
2232 // into the player's view coordinates (using basematrix which is
2233 // an inverted "absolute" listener matrix), then applies the
2234 // rotation matrix for the ear
2235 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2236 // does not actually refer to an entity?
2239 // update general area ambient sound sources
2240 S_UpdateAmbientSounds ();
2243 R_TimeReport("audioprep");
2245 // update spatialization for static and dynamic sounds
2246 cls.soundstats.totalsounds = 0;
2247 cls.soundstats.mixedsounds = 0;
2248 ch = channels+NUM_AMBIENTS;
2249 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2253 cls.soundstats.totalsounds++;
2255 // respatialize channel
2256 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2258 // try to combine static sounds with a previous channel of the same
2259 // sound effect so we don't mix five torches every frame
2260 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2262 // no need to merge silent channels
2263 for (j = 0;j < SND_LISTENERS;j++)
2266 if (j == SND_LISTENERS)
2268 // if the last combine chosen isn't suitable, find a new one
2269 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2273 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2275 if (channels[j].sfx == ch->sfx)
2277 combine = channels + j;
2282 if (combine && combine != ch && combine->sfx == ch->sfx)
2284 for (j = 0;j < SND_LISTENERS;j++)
2286 combine->volume[j] += ch->volume[j];
2291 for (k = 0;k < SND_LISTENERS;k++)
2294 if (k < SND_LISTENERS)
2295 cls.soundstats.mixedsounds++;
2297 R_TimeReport("audiospatialize");
2299 sound_spatialized = true;
2302 if (snd_show.integer)
2303 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2308 void S_ExtraUpdate (void)
2310 if (snd_noextraupdate.integer || !sound_spatialized)
2316 qboolean S_LocalSound (const char *sound)
2321 if (!snd_initialized.integer || nosound.integer)
2324 sfx = S_PrecacheSound (sound, true, false);
2327 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2331 // menu sounds must not be freed on level change
2332 sfx->flags |= SFXFLAG_MENUSOUND;
2334 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2335 // which we no longer support anyway
2336 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2337 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2341 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;