2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
26 #include "snd_modplug.h"
28 #include "cl_collision.h"
31 #define SND_MIN_SPEED 8000
32 #define SND_MAX_SPEED 192000
33 #define SND_MIN_WIDTH 1
34 #define SND_MAX_WIDTH 2
35 #define SND_MIN_CHANNELS 1
36 #define SND_MAX_CHANNELS 8
37 #if SND_LISTENERS != 8
38 # error this data only supports up to 8 channel, update it!
41 speakerlayout_t snd_speakerlayout;
43 // Our speaker layouts are based on ALSA. They differ from those
44 // Win32 and Mac OS X APIs use when there's more than 4 channels.
45 // (rear left + rear right, and front center + LFE are swapped).
46 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
47 static const speakerlayout_t snd_speakerlayouts[] =
52 {0, 45, 0.2, 0.2, 0.5}, // front left
53 {1, 315, 0.2, 0.2, 0.5}, // front right
54 {2, 135, 0.2, 0.2, 0.5}, // rear left
55 {3, 225, 0.2, 0.2, 0.5}, // rear right
56 {4, 0, 0.2, 0.2, 0.5}, // front center
57 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
58 {6, 90, 0.2, 0.2, 0.5}, // side left
59 {7, 180, 0.2, 0.2, 0.5}, // side right
65 {0, 45, 0.2, 0.2, 0.5}, // front left
66 {1, 315, 0.2, 0.2, 0.5}, // front right
67 {2, 135, 0.2, 0.2, 0.5}, // rear left
68 {3, 225, 0.2, 0.2, 0.5}, // rear right
69 {4, 0, 0.2, 0.2, 0.5}, // front center
70 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
76 // these systems sometimes have a subwoofer as well, but it has no
80 {0, 45, 0.3, 0.3, 0.8}, // front left
81 {1, 315, 0.3, 0.3, 0.8}, // front right
82 {2, 135, 0.3, 0.3, 0.8}, // rear left
83 {3, 225, 0.3, 0.3, 0.8}, // rear right
91 // these systems sometimes have a subwoofer as well, but it has no
95 {0, 90, 0.5, 0.5, 1}, // side left
96 {1, 270, 0.5, 0.5, 1}, // side right
108 {0, 0, 0, 1, 1}, // center
121 // =======================================================================
122 // Internal sound data & structures
123 // =======================================================================
125 channel_t channels[MAX_CHANNELS];
126 unsigned int total_channels;
128 snd_ringbuffer_t *snd_renderbuffer = NULL;
129 static unsigned int soundtime = 0;
130 static unsigned int oldpaintedtime = 0;
131 static unsigned int extrasoundtime = 0;
132 static double snd_starttime = 0.0;
133 qboolean snd_threaded = false;
134 qboolean snd_usethreadedmixing = false;
136 vec3_t listener_origin;
137 matrix4x4_t listener_basematrix;
138 static unsigned char *listener_pvs = NULL;
139 static int listener_pvsbytes = 0;
140 matrix4x4_t listener_matrix[SND_LISTENERS];
141 mempool_t *snd_mempool;
143 // Linked list of known sfx
144 static sfx_t *known_sfx = NULL;
146 static qboolean sound_spatialized = false;
148 qboolean simsound = false;
150 static qboolean recording_sound = false;
153 static int current_swapstereo = false;
154 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
155 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
157 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
158 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
159 spatialmethod_t spatialmethod;
161 // Cvars declared in sound.h (part of the sound API)
162 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
163 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
164 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
165 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
166 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
167 cvar_t snd_soundradius = {CVAR_SAVE, "snd_soundradius", "1200", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
168 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
169 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
170 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
171 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
172 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
173 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
174 cvar_t snd_spatialization_prologic = {CVAR_SAVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
175 cvar_t snd_spatialization_prologic_frontangle = {CVAR_SAVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
176 cvar_t snd_spatialization_occlusion = {CVAR_SAVE, "snd_spatialization_occlusion", "1", "enable occlusion testing on spatialized sounds, which simply quiets sounds that are blocked by the world; 1 enables PVS method, 2 enables LineOfSight method, 3 enables both"};
178 // Cvars declared in snd_main.h (shared with other snd_*.c files)
179 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
180 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory); when set to 2, streaming is performed even if this would waste memory"};
181 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"};
182 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
183 extern cvar_t v_flipped;
184 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
185 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
186 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
187 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
188 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
189 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
190 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
191 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
192 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
193 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
194 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
195 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
196 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
197 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
198 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
199 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
200 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
201 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
202 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
203 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
204 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
205 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
206 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
207 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
208 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
209 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
210 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
211 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
212 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
213 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
214 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
215 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
216 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
217 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
218 cvar_t snd_channel0volume = {CVAR_SAVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
219 cvar_t snd_channel1volume = {CVAR_SAVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
220 cvar_t snd_channel2volume = {CVAR_SAVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
221 cvar_t snd_channel3volume = {CVAR_SAVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
222 cvar_t snd_channel4volume = {CVAR_SAVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
223 cvar_t snd_channel5volume = {CVAR_SAVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
224 cvar_t snd_channel6volume = {CVAR_SAVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
225 cvar_t snd_channel7volume = {CVAR_SAVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
228 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
229 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
230 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
231 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
232 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"};
233 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
235 // Default sound format is 48KHz, 16-bit, stereo
236 // (48KHz because a lot of onboard sound cards sucks at any other speed)
237 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
238 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
239 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)"};
241 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"};
242 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"};
245 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"};
246 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"};
249 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
250 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
253 // ====================================================================
255 // ====================================================================
257 void S_FreeSfx (sfx_t *sfx, qboolean force);
259 static void S_Play_Common (float fvol, float attenuation)
262 char name [MAX_QPATH];
266 while (i < Cmd_Argc ())
268 // Get the name, and appends ".wav" as an extension if there's none
269 strlcpy (name, Cmd_Argv (i), sizeof (name));
270 if (!strrchr (name, '.'))
271 strlcat (name, ".wav", sizeof (name));
274 // If we need to get the volume from the command line
277 fvol = atof (Cmd_Argv (i));
281 sfx = S_PrecacheSound (name, true, true);
284 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
286 // Free the sfx if the file didn't exist
288 S_FreeSfx (sfx, false);
290 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
295 static void S_Play_f(void)
297 S_Play_Common (1.0f, 1.0f);
300 static void S_Play2_f(void)
302 S_Play_Common (1.0f, 0.0f);
305 static void S_PlayVol_f(void)
307 S_Play_Common (-1.0f, 0.0f);
310 static void S_SoundList_f (void)
317 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
319 if (sfx->fetcher != NULL)
324 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
325 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
326 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
327 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
329 sfx->format.width * 8,
330 (sfx->format.channels == 1) ? "mono" : "stereo",
336 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
338 Con_Printf("Total resident: %i\n", total);
342 void S_SoundInfo_f(void)
344 if (snd_renderbuffer == NULL)
346 Con_Print("sound system not started\n");
350 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
351 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
352 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
353 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
354 Con_Printf("%5u total_channels\n", total_channels);
358 int S_GetSoundRate(void)
360 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
363 int S_GetSoundChannels(void)
365 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
369 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
371 static const snd_format_t thresholds [] =
373 // speed width channels
374 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
380 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
382 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
383 unsigned int speed_level, width_level, channels_level;
385 // If we have reached the minimum values, there's nothing more we can do
386 if ((format->speed == thresholds[0].speed || fixed_speed) &&
387 (format->width == thresholds[0].width || fixed_width) &&
388 (format->channels == thresholds[0].channels || fixed_channels))
391 // Check the min and max values
392 #define CHECK_BOUNDARIES(param) \
393 if (format->param < thresholds[0].param) \
395 format->param = thresholds[0].param; \
398 if (format->param > thresholds[nb_thresholds - 1].param) \
400 format->param = thresholds[nb_thresholds - 1].param; \
403 CHECK_BOUNDARIES(speed);
404 CHECK_BOUNDARIES(width);
405 CHECK_BOUNDARIES(channels);
406 #undef CHECK_BOUNDARIES
408 // Find the level of each parameter
409 #define FIND_LEVEL(param) \
411 while (param##_level < nb_thresholds - 1) \
413 if (format->param <= thresholds[param##_level].param) \
420 FIND_LEVEL(channels);
423 // Decrease the parameter with the highest level to the previous level
424 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
426 format->channels = thresholds[channels_level - 1].channels;
429 if (speed_level >= width_level && !fixed_speed)
431 format->speed = thresholds[speed_level - 1].speed;
435 format->width = thresholds[width_level - 1].width;
440 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
442 static void S_SetChannelLayout (void)
445 listener_t swaplistener;
446 listener_t *listeners;
449 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
450 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
452 if (i >= SND_SPEAKERLAYOUTS)
454 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
455 snd_renderbuffer->format.channels);
456 i = SND_SPEAKERLAYOUTS - 1;
459 snd_speakerlayout = snd_speakerlayouts[i];
460 listeners = snd_speakerlayout.listeners;
462 // Swap the left and right channels if snd_swapstereo is set
463 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
465 switch (snd_speakerlayout.channels)
468 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
472 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
475 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
486 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
487 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
488 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
490 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
492 // If we're in the sound engine initialization
493 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
495 layout = SND_CHANNELLAYOUT_STANDARD;
496 Cvar_SetValueQuick (&snd_channellayout, layout);
499 layout = current_channellayout_used;
502 layout = snd_channellayout.integer;
504 // Convert our layout (= ALSA) to the standard layout if necessary
505 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
507 if (layout == SND_CHANNELLAYOUT_STANDARD)
509 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
510 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
513 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
514 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
517 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
518 current_channellayout = snd_channellayout.integer;
519 current_channellayout_used = layout;
523 void S_Startup (void)
525 qboolean fixed_speed, fixed_width, fixed_channels;
526 snd_format_t chosen_fmt;
527 static snd_format_t prev_render_format = {0, 0, 0};
534 if (!snd_initialized.integer)
539 fixed_channels = false;
541 // Get the starting sound format from the cvars
542 chosen_fmt.speed = snd_speed.integer;
543 chosen_fmt.width = snd_width.integer;
544 chosen_fmt.channels = snd_channels.integer;
546 // Check the environment variables to see if the player wants a particular sound format
548 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
550 env = getenv("QUAKE_SOUND_CHANNELS");
554 chosen_fmt.channels = atoi (env);
558 fixed_channels = true;
561 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
563 env = getenv("QUAKE_SOUND_SPEED");
567 chosen_fmt.speed = atoi (env);
574 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
576 env = getenv("QUAKE_SOUND_SAMPLEBITS");
580 chosen_fmt.width = atoi (env) / 8;
587 // Parse the command line to see if the player wants a particular sound format
588 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
589 if (COM_CheckParm ("-sndquad") != 0)
591 chosen_fmt.channels = 4;
592 fixed_channels = true;
594 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
595 else if (COM_CheckParm ("-sndstereo") != 0)
597 chosen_fmt.channels = 2;
598 fixed_channels = true;
600 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
601 else if (COM_CheckParm ("-sndmono") != 0)
603 chosen_fmt.channels = 1;
604 fixed_channels = true;
606 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
607 i = COM_CheckParm ("-sndspeed");
608 if (0 < i && i < com_argc - 1)
610 chosen_fmt.speed = atoi (com_argv[i + 1]);
613 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
614 i = COM_CheckParm ("-sndbits");
615 if (0 < i && i < com_argc - 1)
617 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
622 // LordHavoc: now you can with the resampler...
623 // You can't change sound speed after start time (not yet supported)
624 if (prev_render_format.speed != 0)
627 if (chosen_fmt.speed != prev_render_format.speed)
629 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
630 prev_render_format.speed);
631 chosen_fmt.speed = prev_render_format.speed;
637 if (chosen_fmt.speed < SND_MIN_SPEED)
639 chosen_fmt.speed = SND_MIN_SPEED;
642 else if (chosen_fmt.speed > SND_MAX_SPEED)
644 chosen_fmt.speed = SND_MAX_SPEED;
648 if (chosen_fmt.width < SND_MIN_WIDTH)
650 chosen_fmt.width = SND_MIN_WIDTH;
653 else if (chosen_fmt.width > SND_MAX_WIDTH)
655 chosen_fmt.width = SND_MAX_WIDTH;
659 if (chosen_fmt.channels < SND_MIN_CHANNELS)
661 chosen_fmt.channels = SND_MIN_CHANNELS;
662 fixed_channels = false;
664 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
666 chosen_fmt.channels = SND_MAX_CHANNELS;
667 fixed_channels = false;
670 // create the sound buffer used for sumitting the samples to the plaform-dependent module
673 snd_format_t suggest_fmt;
679 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
680 chosen_fmt.speed, chosen_fmt.width * 8,
681 chosen_fmt.channels);
683 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
684 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
688 Con_Printf("S_Startup: sound output initialization FAILED\n");
690 // If the module is suggesting another one
691 if (suggest_fmt.speed != 0)
693 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
694 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
695 suggest_fmt.speed, suggest_fmt.width * 8,
696 suggest_fmt.channels);
698 // Else, try to find a less resource-demanding format
699 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
704 // If we haven't found a suitable format
707 Con_Print("S_Startup: SndSys_Init failed.\n");
708 sound_spatialized = false;
714 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
715 Con_Print ("S_Startup: simulating sound output\n");
718 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
719 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
720 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
723 if (snd_speed.integer != (int)chosen_fmt.speed)
724 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
725 if (snd_width.integer != chosen_fmt.width)
726 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
727 if (snd_channels.integer != chosen_fmt.channels)
728 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
730 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
731 S_SetChannelLayout();
733 snd_starttime = realtime;
735 // If the sound module has already run, add an extra time to make sure
736 // the sound time doesn't decrease, to not confuse playing SFXs
737 if (oldpaintedtime != 0)
739 // The extra time must be a multiple of the render buffer size
740 // to avoid modifying the current position in the buffer,
741 // some modules write directly to a shared (DMA) buffer
742 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
743 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
744 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
746 soundtime = extrasoundtime;
750 snd_renderbuffer->startframe = soundtime;
751 snd_renderbuffer->endframe = soundtime;
752 recording_sound = false;
755 void S_Shutdown(void)
757 if (snd_renderbuffer == NULL)
760 oldpaintedtime = snd_renderbuffer->endframe;
764 Mem_Free(snd_renderbuffer->ring);
765 Mem_Free(snd_renderbuffer);
766 snd_renderbuffer = NULL;
771 sound_spatialized = false;
774 void S_Restart_f(void)
776 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
777 // So, refuse to do this if we are connected.
778 if(cls.state == ca_connected)
780 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
795 Cvar_RegisterVariable(&volume);
796 Cvar_RegisterVariable(&bgmvolume);
797 Cvar_RegisterVariable(&mastervolume);
798 Cvar_RegisterVariable(&snd_staticvolume);
799 Cvar_RegisterVariable(&snd_entchannel0volume);
800 Cvar_RegisterVariable(&snd_entchannel1volume);
801 Cvar_RegisterVariable(&snd_entchannel2volume);
802 Cvar_RegisterVariable(&snd_entchannel3volume);
803 Cvar_RegisterVariable(&snd_entchannel4volume);
804 Cvar_RegisterVariable(&snd_entchannel5volume);
805 Cvar_RegisterVariable(&snd_entchannel6volume);
806 Cvar_RegisterVariable(&snd_entchannel7volume);
807 Cvar_RegisterVariable(&snd_worldchannel0volume);
808 Cvar_RegisterVariable(&snd_worldchannel1volume);
809 Cvar_RegisterVariable(&snd_worldchannel2volume);
810 Cvar_RegisterVariable(&snd_worldchannel3volume);
811 Cvar_RegisterVariable(&snd_worldchannel4volume);
812 Cvar_RegisterVariable(&snd_worldchannel5volume);
813 Cvar_RegisterVariable(&snd_worldchannel6volume);
814 Cvar_RegisterVariable(&snd_worldchannel7volume);
815 Cvar_RegisterVariable(&snd_playerchannel0volume);
816 Cvar_RegisterVariable(&snd_playerchannel1volume);
817 Cvar_RegisterVariable(&snd_playerchannel2volume);
818 Cvar_RegisterVariable(&snd_playerchannel3volume);
819 Cvar_RegisterVariable(&snd_playerchannel4volume);
820 Cvar_RegisterVariable(&snd_playerchannel5volume);
821 Cvar_RegisterVariable(&snd_playerchannel6volume);
822 Cvar_RegisterVariable(&snd_playerchannel7volume);
823 Cvar_RegisterVariable(&snd_csqcchannel0volume);
824 Cvar_RegisterVariable(&snd_csqcchannel1volume);
825 Cvar_RegisterVariable(&snd_csqcchannel2volume);
826 Cvar_RegisterVariable(&snd_csqcchannel3volume);
827 Cvar_RegisterVariable(&snd_csqcchannel4volume);
828 Cvar_RegisterVariable(&snd_csqcchannel5volume);
829 Cvar_RegisterVariable(&snd_csqcchannel6volume);
830 Cvar_RegisterVariable(&snd_csqcchannel7volume);
831 Cvar_RegisterVariable(&snd_channel0volume);
832 Cvar_RegisterVariable(&snd_channel1volume);
833 Cvar_RegisterVariable(&snd_channel2volume);
834 Cvar_RegisterVariable(&snd_channel3volume);
835 Cvar_RegisterVariable(&snd_channel4volume);
836 Cvar_RegisterVariable(&snd_channel5volume);
837 Cvar_RegisterVariable(&snd_channel6volume);
838 Cvar_RegisterVariable(&snd_channel7volume);
840 Cvar_RegisterVariable(&snd_spatialization_min_radius);
841 Cvar_RegisterVariable(&snd_spatialization_max_radius);
842 Cvar_RegisterVariable(&snd_spatialization_min);
843 Cvar_RegisterVariable(&snd_spatialization_max);
844 Cvar_RegisterVariable(&snd_spatialization_power);
845 Cvar_RegisterVariable(&snd_spatialization_control);
846 Cvar_RegisterVariable(&snd_spatialization_occlusion);
847 Cvar_RegisterVariable(&snd_spatialization_prologic);
848 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
850 Cvar_RegisterVariable(&snd_speed);
851 Cvar_RegisterVariable(&snd_width);
852 Cvar_RegisterVariable(&snd_channels);
853 Cvar_RegisterVariable(&snd_mutewhenidle);
855 Cvar_RegisterVariable(&snd_startloopingsounds);
856 Cvar_RegisterVariable(&snd_startnonloopingsounds);
858 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
859 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
861 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
862 if (COM_CheckParm("-nosound"))
864 // dummy out Play and Play2 because mods stuffcmd that
865 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
866 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
870 snd_mempool = Mem_AllocPool("sound", 0, NULL);
872 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
873 if (COM_CheckParm("-simsound"))
876 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
877 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
878 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
879 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
880 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
881 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
882 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
883 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
885 Cvar_RegisterVariable(&nosound);
886 Cvar_RegisterVariable(&snd_precache);
887 Cvar_RegisterVariable(&snd_initialized);
888 Cvar_RegisterVariable(&snd_streaming);
889 Cvar_RegisterVariable(&snd_streaming_length);
890 Cvar_RegisterVariable(&ambient_level);
891 Cvar_RegisterVariable(&ambient_fade);
892 Cvar_RegisterVariable(&snd_noextraupdate);
893 Cvar_RegisterVariable(&snd_show);
894 Cvar_RegisterVariable(&_snd_mixahead);
895 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
896 Cvar_RegisterVariable(&snd_channellayout);
897 Cvar_RegisterVariable(&snd_soundradius);
899 Cvar_SetValueQuick(&snd_initialized, true);
903 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
904 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
907 ModPlug_OpenLibrary ();
915 Shutdown and free all resources
918 void S_Terminate (void)
921 ModPlug_CloseLibrary ();
925 while (known_sfx != NULL)
926 S_FreeSfx (known_sfx, true);
928 Cvar_SetValueQuick (&snd_initialized, false);
929 Mem_FreePool (&snd_mempool);
938 void S_UnloadAllSounds_f (void)
942 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
943 // So, refuse to do this if we are connected.
944 if(cls.state == ca_connected)
946 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
950 // stop any active sounds
953 // because the ambient sounds will be freed, clear the pointers
954 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
955 ambient_sfxs[i] = NULL;
957 // now free all sounds
958 while (known_sfx != NULL)
959 S_FreeSfx (known_sfx, true);
968 sfx_t changevolume_sfx = {""};
969 sfx_t *S_FindName (const char *name)
973 if (!snd_initialized.integer)
976 if(!strcmp(name, changevolume_sfx.name))
977 return &changevolume_sfx;
979 if (strlen (name) >= sizeof (sfx->name))
981 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
985 // Look for this sound in the list of known sfx
986 // TODO: hash table search?
987 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
988 if(!strcmp (sfx->name, name))
991 // check for # in the beginning, try lookup by soundindex
992 if (name[0] == '#' && name[1])
994 int soundindex = atoi(name + 1);
995 if (soundindex > 0 && soundindex < MAX_SOUNDS)
996 if (cl.sound_precache[soundindex]->name[0])
997 return cl.sound_precache[soundindex];
1000 // Add a sfx_t struct for this sound
1001 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
1002 memset (sfx, 0, sizeof(*sfx));
1003 strlcpy (sfx->name, name, sizeof (sfx->name));
1004 sfx->memsize = sizeof(*sfx);
1005 sfx->next = known_sfx;
1017 void S_FreeSfx (sfx_t *sfx, qboolean force)
1021 // Do not free a precached sound during purge
1022 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1025 if (developer_loading.integer)
1026 Con_Printf ("unloading sound %s\n", sfx->name);
1028 // Remove it from the list of known sfx
1029 if (sfx == known_sfx)
1030 known_sfx = known_sfx->next;
1035 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
1036 if (prev_sfx->next == sfx)
1038 prev_sfx->next = sfx->next;
1041 if (prev_sfx == NULL)
1043 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1048 // Stop all channels using this sfx
1049 for (i = 0; i < total_channels; i++)
1051 if (channels[i].sfx == sfx)
1053 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
1054 S_StopChannel (i, true, false);
1059 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
1060 sfx->fetcher->freesfx(sfx);
1070 void S_ClearUsed (void)
1076 // Start the ambient sounds and make them loop
1077 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1079 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1080 if (ambient_sfxs[i] == NULL)
1081 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1082 if (ambient_sfxs[i] != NULL)
1084 channels[i].sfx = ambient_sfxs[i];
1085 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1086 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1087 channels[i].basevolume = 0.0f;
1088 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1092 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1093 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1094 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1102 void S_PurgeUnused(void)
1107 // Free all not-precached per-level sfx
1108 for (sfx = known_sfx;sfx;sfx = sfxnext)
1110 sfxnext = sfx->next;
1111 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1112 S_FreeSfx (sfx, false);
1122 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean levelsound)
1126 if (!snd_initialized.integer)
1129 if (name == NULL || name[0] == 0)
1132 sfx = S_FindName (name);
1137 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1138 // previously missing file
1139 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1141 // set a flag to indicate this has been precached for this level or permanently
1143 sfx->flags |= SFXFLAG_LEVELSOUND;
1145 sfx->flags |= SFXFLAG_MENUSOUND;
1147 if (!nosound.integer && snd_precache.integer)
1148 S_LoadSound(sfx, complain);
1159 float S_SoundLength(const char *name)
1163 if (!snd_initialized.integer)
1165 if (name == NULL || name[0] == 0)
1168 sfx = S_FindName(name);
1171 return sfx->total_length / (float) S_GetSoundRate();
1179 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1181 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1189 void S_BlockSound (void)
1200 void S_UnblockSound (void)
1210 Picks a channel based on priorities, empty slots, number of channels
1213 channel_t *SND_PickChannel(int entnum, int entchannel)
1217 int first_life_left, life_left;
1219 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1221 // Check for replacement sound, or find the best one to replace
1223 first_life_left = 0x7fffffff;
1225 // entity channels try to replace the existing sound on the channel
1226 // channels <= 0 are autochannels
1227 if (IS_CHAN_SINGLE(entchannel))
1229 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1231 ch = &channels[ch_idx];
1232 if (ch->entnum == entnum && ch->entchannel == entchannel)
1234 // always override sound from same entity
1235 S_StopChannel (ch_idx, true, false);
1236 return &channels[ch_idx];
1241 // there was no channel to override, so look for the first empty one
1242 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1244 ch = &channels[ch_idx];
1245 sfx = ch->sfx; // fetch the volatile variable
1248 // no sound on this channel
1249 first_to_die = ch_idx;
1250 goto emptychan_found;
1253 // don't let monster sounds override player sounds
1254 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1257 // don't override looped sounds
1258 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1260 life_left = (int)((double)sfx->total_length - ch->position);
1262 if (life_left < first_life_left)
1264 first_life_left = life_left;
1265 first_to_die = ch_idx;
1269 if (first_to_die == -1)
1272 S_StopChannel (first_to_die, true, false);
1275 return &channels[first_to_die];
1282 Spatializes a channel
1285 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1286 void SND_Spatialize_WithSfx(channel_t *ch, qboolean isstatic, sfx_t *sfx)
1290 float angle_side, angle_front, angle_factor, mixspeed;
1291 vec_t dist, mastervol, intensity;
1294 // update sound origin if we know about the entity
1295 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1297 if (ch->entnum >= MAX_EDICTS)
1299 //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]);
1301 if (ch->entnum > MAX_EDICTS)
1302 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1303 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1305 else if (cl.entities[ch->entnum].state_current.active)
1308 //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]);
1309 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1310 if (model && model->soundfromcenter)
1311 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1313 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1317 mastervol = ch->basevolume;
1318 mixspeed = ch->basespeed;
1320 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1322 // Adjust volume of static sounds
1324 mastervol *= snd_staticvolume.value;
1325 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1327 // old legacy separated cvars
1328 if(ch->entnum >= MAX_EDICTS)
1330 switch(ch->entchannel)
1332 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1333 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1334 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1335 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1336 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1337 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1338 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1339 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1343 else if(ch->entnum == 0)
1345 switch(ch->entchannel)
1347 case 0: mastervol *= snd_worldchannel0volume.value; break;
1348 case 1: mastervol *= snd_worldchannel1volume.value; break;
1349 case 2: mastervol *= snd_worldchannel2volume.value; break;
1350 case 3: mastervol *= snd_worldchannel3volume.value; break;
1351 case 4: mastervol *= snd_worldchannel4volume.value; break;
1352 case 5: mastervol *= snd_worldchannel5volume.value; break;
1353 case 6: mastervol *= snd_worldchannel6volume.value; break;
1354 case 7: mastervol *= snd_worldchannel7volume.value; break;
1358 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1360 switch(ch->entchannel)
1362 case 0: mastervol *= snd_playerchannel0volume.value; break;
1363 case 1: mastervol *= snd_playerchannel1volume.value; break;
1364 case 2: mastervol *= snd_playerchannel2volume.value; break;
1365 case 3: mastervol *= snd_playerchannel3volume.value; break;
1366 case 4: mastervol *= snd_playerchannel4volume.value; break;
1367 case 5: mastervol *= snd_playerchannel5volume.value; break;
1368 case 6: mastervol *= snd_playerchannel6volume.value; break;
1369 case 7: mastervol *= snd_playerchannel7volume.value; break;
1375 switch(ch->entchannel)
1377 case 0: mastervol *= snd_entchannel0volume.value; break;
1378 case 1: mastervol *= snd_entchannel1volume.value; break;
1379 case 2: mastervol *= snd_entchannel2volume.value; break;
1380 case 3: mastervol *= snd_entchannel3volume.value; break;
1381 case 4: mastervol *= snd_entchannel4volume.value; break;
1382 case 5: mastervol *= snd_entchannel5volume.value; break;
1383 case 6: mastervol *= snd_entchannel6volume.value; break;
1384 case 7: mastervol *= snd_entchannel7volume.value; break;
1389 switch(ch->entchannel)
1391 case 0: mastervol *= snd_channel0volume.value; break;
1392 case 1: mastervol *= snd_channel1volume.value; break;
1393 case 2: mastervol *= snd_channel2volume.value; break;
1394 case 3: mastervol *= snd_channel3volume.value; break;
1395 case 4: mastervol *= snd_channel4volume.value; break;
1396 case 5: mastervol *= snd_channel5volume.value; break;
1397 case 6: mastervol *= snd_channel6volume.value; break;
1398 case 7: mastervol *= snd_channel7volume.value; break;
1399 default: mastervol *= Cvar_VariableValueOr(va("snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0); break;
1403 // If this channel does not manage its own volume (like CD tracks)
1404 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1405 mastervol *= volume.value;
1407 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1408 mastervol = bound(0.0f, mastervol, 10.0f);
1410 // always apply "master"
1411 mastervol *= mastervolume.value;
1413 // add in ReplayGain very late; prevent clipping when close
1415 if(sfx->volume_peak > 0)
1417 // Replaygain support
1418 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1419 mastervol *= sfx->volume_mult;
1420 if(mastervol * sfx->volume_peak > 1.0f)
1421 mastervol = 1.0f / sfx->volume_peak;
1422 // Con_DPrintf("%f\n", fvol);
1425 // clamp HERE to keep relative volumes of the channels correct
1426 mastervol = bound(0.0f, mastervol, 1.0f);
1428 ch->mixspeed = mixspeed;
1430 // anything coming from the view entity will always be full volume
1431 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1432 if (ch->entnum == cl.viewentity || ch->distfade == 0)
1434 ch->prologic_invert = 1;
1435 if (snd_spatialization_prologic.integer != 0)
1437 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1438 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1439 for (i = 2;i < SND_LISTENERS;i++)
1444 for (i = 0;i < SND_LISTENERS;i++)
1445 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1450 // calculate stereo seperation and distance attenuation
1451 VectorSubtract(listener_origin, ch->origin, source_vec);
1452 dist = VectorLength(source_vec);
1453 intensity = mastervol * (1.0f - dist * ch->distfade);
1456 qboolean occluded = false;
1457 if (snd_spatialization_occlusion.integer)
1459 if(snd_spatialization_occlusion.integer & 1)
1462 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1463 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1467 if(snd_spatialization_occlusion.integer & 2)
1469 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1475 ch->prologic_invert = 1;
1476 if (snd_spatialization_prologic.integer != 0)
1479 angle_factor = 0.5f;
1482 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1483 VectorNormalize(source_vec);
1485 switch(spatialmethod)
1489 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1491 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1492 VectorScale(source_vec, f, source_vec);
1495 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1496 f = spatialmin + spatialdiff * bound(0, f, 1);
1497 VectorScale(source_vec, f, source_vec);
1499 case SPATIAL_THRESH:
1500 f = spatialmin + spatialdiff * (dist < spatialoffset);
1501 VectorScale(source_vec, f, source_vec);
1508 // 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
1510 VectorNormalize(source_vec);
1511 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1512 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1513 if (angle_side > snd_spatialization_prologic_frontangle.value)
1515 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1516 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1517 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1518 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1519 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1520 if (angle_front > 0)
1521 angle_factor = 1 - angle_factor;
1524 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1525 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1528 ch->volume[0] = intensity * sqrt(angle_factor);
1529 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1530 for (i = 2;i < SND_LISTENERS;i++)
1535 for (i = 0;i < SND_LISTENERS;i++)
1537 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1538 VectorNormalize(source_vec);
1540 switch(spatialmethod)
1544 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1546 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1547 VectorScale(source_vec, f, source_vec);
1550 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1551 f = spatialmin + spatialdiff * bound(0, f, 1);
1552 VectorScale(source_vec, f, source_vec);
1554 case SPATIAL_THRESH:
1555 f = spatialmin + spatialdiff * (dist < spatialoffset);
1556 VectorScale(source_vec, f, source_vec);
1563 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1568 for (i = 0;i < SND_LISTENERS;i++)
1572 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1574 sfx_t *sfx = ch->sfx;
1575 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1579 // =======================================================================
1580 // Start a sound effect
1581 // =======================================================================
1583 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)
1587 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1591 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1593 if(!snd_startloopingsounds.integer)
1598 if(!snd_startnonloopingsounds.integer)
1602 // Initialize the channel
1603 // a crash was reported on an in-use channel, so check here...
1604 if (target_chan->sfx)
1606 int channelindex = (int)(target_chan - channels);
1607 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1608 S_StopChannel (channelindex, true, false);
1610 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1611 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1612 memset (target_chan, 0, sizeof (*target_chan));
1613 VectorCopy (origin, target_chan->origin);
1614 target_chan->flags = flags;
1615 target_chan->position = startpos; // start of the sound
1616 target_chan->entnum = entnum;
1617 target_chan->entchannel = entchannel;
1619 // If it's a static sound
1622 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1623 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1624 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1627 target_chan->distfade = attenuation / snd_soundradius.value;
1629 // set the listener volumes
1630 S_SetChannelVolume(target_chan - channels, fvol);
1631 S_SetChannelSpeed(target_chan - channels, fspeed);
1632 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1634 // finally, set the sfx pointer, so the channel becomes valid for playback
1635 // and will be noticed by the mixer
1636 target_chan->sfx = sfx;
1640 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)
1642 channel_t *target_chan, *check, *ch;
1643 int ch_idx, startpos;
1645 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1648 if(sfx == &changevolume_sfx)
1650 if (!IS_CHAN_SINGLE(entchannel))
1652 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1654 ch = &channels[ch_idx];
1655 if (ch->entnum == entnum && ch->entchannel == entchannel)
1657 S_SetChannelVolume(ch_idx, fvol);
1658 S_SetChannelSpeed(ch_idx, fspeed);
1659 ch->distfade = attenuation / snd_soundradius.value;
1660 SND_Spatialize(ch, false);
1667 if (sfx->fetcher == NULL)
1670 // Pick a channel to play on
1671 target_chan = SND_PickChannel(entnum, entchannel);
1675 // if an identical sound has also been started this frame, offset the pos
1676 // a bit to keep it from just making the first one louder
1677 check = &channels[NUM_AMBIENTS];
1678 startpos = (int)(startposition * sfx->format.speed);
1681 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1683 if (check == target_chan)
1685 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1687 // calculate max offset
1688 float maxtime = snd_identicalsoundrandomization_time.value;
1689 float maxtics = snd_identicalsoundrandomization_tics.value;
1690 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1692 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1695 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1697 // use negative pos offset to delay this sound effect
1698 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1704 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1706 return (target_chan - channels);
1709 int S_StartSound_StartPosition (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation, float startposition)
1711 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, startposition, CHANNELFLAG_NONE, 1.0f);
1714 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1716 return S_StartSound_StartPosition(entnum, entchannel, sfx, origin, fvol, attenuation, 0);
1719 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex, qboolean freesfx)
1724 if (channel_ind >= total_channels)
1727 // we have to lock an audio mutex to prevent crashes if an audio mixer
1728 // thread is currently mixing this channel
1729 // the SndSys_LockRenderBuffer function uses such a mutex in
1730 // threaded sound backends
1731 if (lockmutex && !simsound)
1732 SndSys_LockRenderBuffer();
1734 ch = &channels[channel_ind];
1736 if (ch->sfx != NULL)
1738 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1739 sfx->fetcher->stopchannel(ch);
1740 ch->fetcher_data = NULL;
1743 if (lockmutex && !simsound)
1744 SndSys_UnlockRenderBuffer();
1746 S_FreeSfx(sfx, true);
1750 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1752 if (ch_ind >= total_channels)
1755 if (flag != CHANNELFLAG_FORCELOOP &&
1756 flag != CHANNELFLAG_PAUSED &&
1757 flag != CHANNELFLAG_FULLVOLUME &&
1758 flag != CHANNELFLAG_LOCALSOUND)
1762 channels[ch_ind].flags |= flag;
1764 channels[ch_ind].flags &= ~flag;
1769 void S_StopSound(int entnum, int entchannel)
1773 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1774 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1776 S_StopChannel (i, true, false);
1781 extern void CDAudio_Stop(void);
1782 void S_StopAllSounds (void)
1786 // TOCHECK: is this test necessary?
1787 if (snd_renderbuffer == NULL)
1790 // stop CD audio because it may be using a faketrack
1793 if (simsound || SndSys_LockRenderBuffer ())
1798 for (i = 0; i < total_channels; i++)
1799 if (channels[i].sfx)
1800 S_StopChannel (i, false, false);
1802 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1803 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1805 // Mute the contents of the submittion buffer
1806 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1807 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1808 memset(snd_renderbuffer->ring, clear, memsize);
1811 SndSys_UnlockRenderBuffer ();
1815 void S_PauseGameSounds (qboolean toggle)
1819 for (i = 0; i < total_channels; i++)
1824 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1825 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1829 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1831 channels[ch_ind].basevolume = fvol;
1834 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1836 channels[ch_ind].basespeed = fspeed;
1839 float S_GetChannelPosition (unsigned int ch_ind)
1841 // note: this is NOT accurate yet
1843 channel_t *ch = &channels[ch_ind];
1844 sfx_t *sfx = ch->sfx;
1848 s = ch->position / sfx->format.speed;
1850 if(!snd_usethreadedmixing)
1851 s += _snd_mixahead.value;
1856 float S_GetEntChannelPosition(int entnum, int entchannel)
1861 for (i = 0; i < total_channels; i++)
1864 if (ch->entnum == entnum && ch->entchannel == entchannel)
1865 return S_GetChannelPosition(i);
1867 return -1; // no playing sound in this channel
1875 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1877 channel_t *target_chan;
1879 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1883 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1887 if (total_channels == MAX_CHANNELS)
1889 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1893 target_chan = &channels[total_channels++];
1894 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1900 S_UpdateAmbientSounds
1903 void S_UpdateAmbientSounds (void)
1907 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1908 int ambient_channel;
1910 unsigned char ambientlevels[NUM_AMBIENTS];
1913 memset(ambientlevels, 0, sizeof(ambientlevels));
1914 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1915 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1917 // Calc ambient sound levels
1918 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1920 chan = &channels[ambient_channel];
1921 sfx = chan->sfx; // fetch the volatile variable
1922 if (sfx == NULL || sfx->fetcher == NULL)
1925 i = ambientlevels[ambient_channel];
1928 vol = i * (1.0f / 256.0f);
1930 // Don't adjust volume too fast
1931 if (chan->basevolume < vol)
1933 chan->basevolume += fade;
1934 if (chan->basevolume > vol)
1935 chan->basevolume = vol;
1937 else if (chan->basevolume > vol)
1939 chan->basevolume -= fade;
1940 if (chan->basevolume < vol)
1941 chan->basevolume = vol;
1944 if (snd_spatialization_prologic.integer != 0)
1946 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1947 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1948 for (i = 2;i < SND_LISTENERS;i++)
1949 chan->volume[i] = 0.0f;
1953 for (i = 0;i < SND_LISTENERS;i++)
1954 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1959 static void S_PaintAndSubmit (void)
1961 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1962 int usesoundtimehack;
1963 static int soundtimehack = -1;
1964 static int oldsoundtime = 0;
1966 if (snd_renderbuffer == NULL || nosound.integer)
1969 // Update sound time
1970 snd_usethreadedmixing = false;
1971 usesoundtimehack = true;
1972 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1974 usesoundtimehack = 1;
1975 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1977 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1979 usesoundtimehack = 2;
1980 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1984 usesoundtimehack = 3;
1985 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1989 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1990 usesoundtimehack = 0;
1991 newsoundtime = SndSys_GetSoundTime();
1993 // if the soundtimehack state changes we need to reset the soundtime
1994 if (soundtimehack != usesoundtimehack)
1996 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1998 // Mute the contents of the submission buffer
1999 if (simsound || SndSys_LockRenderBuffer ())
2004 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
2005 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
2006 memset(snd_renderbuffer->ring, clear, memsize);
2009 SndSys_UnlockRenderBuffer ();
2012 soundtimehack = usesoundtimehack;
2014 if (!soundtimehack && snd_blocked > 0)
2017 if (snd_usethreadedmixing)
2018 return; // the audio thread will mix its own data
2020 newsoundtime += extrasoundtime;
2021 if (newsoundtime < soundtime)
2023 if ((cls.capturevideo.soundrate != 0) != recording_sound)
2025 unsigned int additionaltime;
2027 // add some time to extrasoundtime make newsoundtime higher
2029 // The extra time must be a multiple of the render buffer size
2030 // to avoid modifying the current position in the buffer,
2031 // some modules write directly to a shared (DMA) buffer
2032 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
2033 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
2035 extrasoundtime += additionaltime;
2036 newsoundtime += additionaltime;
2037 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2040 else if (!soundtimehack)
2041 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2042 newsoundtime, soundtime);
2044 soundtime = newsoundtime;
2045 recording_sound = (cls.capturevideo.soundrate != 0);
2047 // Lock submitbuffer
2048 if (!simsound && !SndSys_LockRenderBuffer())
2050 // If the lock failed, stop here
2051 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2055 // Check to make sure that we haven't overshot
2056 paintedtime = snd_renderbuffer->endframe;
2057 if (paintedtime < soundtime)
2058 paintedtime = soundtime;
2060 // mix ahead of current position
2062 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2064 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2065 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2066 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2067 endtime = min(endtime, maxtime);
2069 while (paintedtime < endtime)
2071 unsigned int startoffset;
2072 unsigned int nbframes;
2074 // see how much we can fit in the paint buffer
2075 nbframes = endtime - paintedtime;
2076 // limit to the end of the ring buffer (in case of wrapping)
2077 startoffset = paintedtime % snd_renderbuffer->maxframes;
2078 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2080 // mix into the buffer
2081 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2083 paintedtime += nbframes;
2084 snd_renderbuffer->endframe = paintedtime;
2087 SndSys_UnlockRenderBuffer();
2089 // Remove outdated samples from the ring buffer, if any
2090 if (snd_renderbuffer->startframe < soundtime)
2091 snd_renderbuffer->startframe = soundtime;
2094 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2098 oldsoundtime = soundtime;
2100 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2101 R_TimeReport("audiomix");
2108 Called once each time through the main loop
2111 void S_Update(const matrix4x4_t *listenermatrix)
2113 unsigned int i, j, k;
2114 channel_t *ch, *combine;
2115 matrix4x4_t rotatematrix;
2117 if (snd_renderbuffer == NULL || nosound.integer)
2121 double mindist_trans, maxdist_trans;
2123 spatialmin = snd_spatialization_min.value;
2124 spatialdiff = snd_spatialization_max.value - spatialmin;
2126 if(snd_spatialization_control.value)
2128 spatialpower = snd_spatialization_power.value;
2130 if(spatialpower == 0)
2132 spatialmethod = SPATIAL_LOG;
2133 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2134 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2138 spatialmethod = SPATIAL_POW;
2139 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2140 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2143 if(mindist_trans - maxdist_trans == 0)
2145 spatialmethod = SPATIAL_THRESH;
2146 mindist_trans = snd_spatialization_min_radius.value;
2150 spatialoffset = mindist_trans;
2151 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2155 spatialmethod = SPATIAL_NONE;
2159 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2160 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2161 current_channellayout != snd_channellayout.integer)
2162 S_SetChannelLayout();
2164 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2165 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2166 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2168 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2171 Mem_Free(listener_pvs);
2172 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2173 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2175 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2181 Mem_Free(listener_pvs);
2182 listener_pvs = NULL;
2184 listener_pvsbytes = 0;
2187 // calculate the current matrices
2188 for (j = 0;j < SND_LISTENERS;j++)
2190 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2191 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2192 // I think this should now do this:
2193 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2194 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2195 // angle has to be taken negative)
2196 // 2. create a transform which first rotates and moves its argument
2197 // into the player's view coordinates (using basematrix which is
2198 // an inverted "absolute" listener matrix), then applies the
2199 // rotation matrix for the ear
2200 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2201 // does not actually refer to an entity?
2204 // update general area ambient sound sources
2205 S_UpdateAmbientSounds ();
2208 R_TimeReport("audioprep");
2210 // update spatialization for static and dynamic sounds
2211 cls.soundstats.totalsounds = 0;
2212 cls.soundstats.mixedsounds = 0;
2213 ch = channels+NUM_AMBIENTS;
2214 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2218 cls.soundstats.totalsounds++;
2220 // respatialize channel
2221 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2223 // try to combine static sounds with a previous channel of the same
2224 // sound effect so we don't mix five torches every frame
2225 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2227 // no need to merge silent channels
2228 for (j = 0;j < SND_LISTENERS;j++)
2231 if (j == SND_LISTENERS)
2233 // if the last combine chosen isn't suitable, find a new one
2234 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2238 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2240 if (channels[j].sfx == ch->sfx)
2242 combine = channels + j;
2247 if (combine && combine != ch && combine->sfx == ch->sfx)
2249 for (j = 0;j < SND_LISTENERS;j++)
2251 combine->volume[j] += ch->volume[j];
2256 for (k = 0;k < SND_LISTENERS;k++)
2259 if (k < SND_LISTENERS)
2260 cls.soundstats.mixedsounds++;
2262 R_TimeReport("audiospatialize");
2264 sound_spatialized = true;
2267 if (snd_show.integer)
2268 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2273 void S_ExtraUpdate (void)
2275 if (snd_noextraupdate.integer || !sound_spatialized)
2281 qboolean S_LocalSound (const char *sound)
2286 if (!snd_initialized.integer || nosound.integer)
2289 sfx = S_PrecacheSound (sound, true, false);
2292 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2296 // menu sounds must not be freed on level change
2297 sfx->flags |= SFXFLAG_MENUSOUND;
2299 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2300 // which we no longer support anyway
2301 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2302 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2306 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;