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
30 #include "cl_collision.h"
34 #define SND_MIN_SPEED 8000
35 #define SND_MAX_SPEED 192000
36 #define SND_MIN_WIDTH 1
37 #define SND_MAX_WIDTH 2
38 #define SND_MIN_CHANNELS 1
39 #define SND_MAX_CHANNELS 8
40 #if SND_LISTENERS != 8
41 # error this data only supports up to 8 channel, update it!
44 speakerlayout_t snd_speakerlayout;
46 // Our speaker layouts are based on ALSA. They differ from those
47 // Win32 and Mac OS X APIs use when there's more than 4 channels.
48 // (rear left + rear right, and front center + LFE are swapped).
49 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
50 static const speakerlayout_t snd_speakerlayouts[] =
55 {0, 45, 0.2f, 0.2f, 0.5f}, // front left
56 {1, 315, 0.2f, 0.2f, 0.5f}, // front right
57 {2, 135, 0.2f, 0.2f, 0.5f}, // rear left
58 {3, 225, 0.2f, 0.2f, 0.5f}, // rear right
59 {4, 0, 0.2f, 0.2f, 0.5f}, // front center
60 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
61 {6, 90, 0.2f, 0.2f, 0.5f}, // side left
62 {7, 180, 0.2f, 0.2f, 0.5f}, // side right
68 {0, 45, 0.2f, 0.2f, 0.5f}, // front left
69 {1, 315, 0.2f, 0.2f, 0.5f}, // front right
70 {2, 135, 0.2f, 0.2f, 0.5f}, // rear left
71 {3, 225, 0.2f, 0.2f, 0.5f}, // rear right
72 {4, 0, 0.2f, 0.2f, 0.5f}, // front center
73 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
79 // these systems sometimes have a subwoofer as well, but it has no
83 {0, 45, 0.3f, 0.3f, 0.8f}, // front left
84 {1, 315, 0.3f, 0.3f, 0.8f}, // front right
85 {2, 135, 0.3f, 0.3f, 0.8f}, // rear left
86 {3, 225, 0.3f, 0.3f, 0.8f}, // rear right
94 // these systems sometimes have a subwoofer as well, but it has no
98 {0, 90, 0.5f, 0.5f, 1}, // side left
99 {1, 270, 0.5f, 0.5f, 1}, // side right
111 {0, 0, 0, 1, 1}, // center
124 // =======================================================================
125 // Internal sound data & structures
126 // =======================================================================
128 channel_t channels[MAX_CHANNELS];
129 unsigned int total_channels;
131 snd_ringbuffer_t *snd_renderbuffer = NULL;
132 static unsigned int soundtime = 0;
133 static unsigned int oldpaintedtime = 0;
134 static unsigned int extrasoundtime = 0;
135 static double snd_starttime = 0.0;
136 qbool snd_threaded = false;
137 qbool snd_usethreadedmixing = false;
139 vec3_t listener_origin;
140 matrix4x4_t listener_basematrix;
141 static unsigned char *listener_pvs = NULL;
142 static int listener_pvsbytes = 0;
143 matrix4x4_t listener_matrix[SND_LISTENERS];
144 mempool_t *snd_mempool;
146 // Linked list of known sfx
147 static sfx_t *known_sfx = NULL;
149 static qbool sound_spatialized = false;
151 qbool simsound = false;
153 #ifdef CONFIG_VIDEO_CAPTURE
154 static qbool recording_sound = false;
158 static int current_swapstereo = false;
159 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
160 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
162 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
163 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
164 spatialmethod_t spatialmethod;
166 // Cvars declared in sound.h (part of the sound API)
167 cvar_t bgmvolume = {CF_CLIENT | CF_ARCHIVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
168 cvar_t mastervolume = {CF_CLIENT | CF_ARCHIVE, "mastervolume", "0.7", "master volume"};
169 cvar_t volume = {CF_CLIENT | CF_ARCHIVE, "volume", "0.7", "volume of sound effects"};
170 cvar_t snd_initialized = {CF_CLIENT | CF_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
171 cvar_t snd_staticvolume = {CF_CLIENT | CF_ARCHIVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
172 cvar_t snd_soundradius = {CF_CLIENT | CF_ARCHIVE, "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)"};
173 cvar_t snd_attenuation_exponent = {CF_CLIENT | CF_ARCHIVE, "snd_attenuation_exponent", "1", "Exponent of (1-radius) in sound attenuation formula"};
174 cvar_t snd_attenuation_decibel = {CF_CLIENT | CF_ARCHIVE, "snd_attenuation_decibel", "0", "Decibel sound attenuation per sound radius distance"};
175 cvar_t snd_spatialization_min_radius = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
176 cvar_t snd_spatialization_max_radius = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
177 cvar_t snd_spatialization_min = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
178 cvar_t snd_spatialization_max = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
179 cvar_t snd_spatialization_power = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
180 cvar_t snd_spatialization_control = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
181 cvar_t snd_spatialization_prologic = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
182 cvar_t snd_spatialization_prologic_frontangle = {CF_CLIENT | CF_ARCHIVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
183 cvar_t snd_spatialization_occlusion = {CF_CLIENT | CF_ARCHIVE, "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"};
185 // Cvars declared in snd_main.h (shared with other snd_*.c files)
186 cvar_t _snd_mixahead = {CF_CLIENT | CF_ARCHIVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
187 cvar_t snd_streaming = {CF_CLIENT | CF_ARCHIVE, "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"};
188 cvar_t snd_streaming_length = {CF_CLIENT | CF_ARCHIVE, "snd_streaming_length", "1", "decompress sounds completely if they are less than this play time when snd_streaming is 1"};
189 cvar_t snd_swapstereo = {CF_CLIENT | CF_ARCHIVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
190 extern cvar_t v_flipped;
191 cvar_t snd_channellayout = {CF_CLIENT, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
192 cvar_t snd_mutewhenidle = {CF_CLIENT | CF_ARCHIVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
193 cvar_t snd_maxchannelvolume = {CF_CLIENT | CF_ARCHIVE, "snd_maxchannelvolume", "10", "maximum volume of a single sound"};
194 cvar_t snd_softclip = {CF_CLIENT | CF_ARCHIVE, "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."};
195 //cvar_t snd_softclip = {CF_CLIENT | CF_ARCHIVE, "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."};
196 cvar_t snd_entchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
197 cvar_t snd_entchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
198 cvar_t snd_entchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
199 cvar_t snd_entchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
200 cvar_t snd_entchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
201 cvar_t snd_entchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
202 cvar_t snd_entchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
203 cvar_t snd_entchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
204 cvar_t snd_playerchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
205 cvar_t snd_playerchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
206 cvar_t snd_playerchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
207 cvar_t snd_playerchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
208 cvar_t snd_playerchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
209 cvar_t snd_playerchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
210 cvar_t snd_playerchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
211 cvar_t snd_playerchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
212 cvar_t snd_worldchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
213 cvar_t snd_worldchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
214 cvar_t snd_worldchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
215 cvar_t snd_worldchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
216 cvar_t snd_worldchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
217 cvar_t snd_worldchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
218 cvar_t snd_worldchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
219 cvar_t snd_worldchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
220 cvar_t snd_csqcchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
221 cvar_t snd_csqcchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
222 cvar_t snd_csqcchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
223 cvar_t snd_csqcchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
224 cvar_t snd_csqcchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
225 cvar_t snd_csqcchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
226 cvar_t snd_csqcchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
227 cvar_t snd_csqcchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
228 cvar_t snd_channel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
229 cvar_t snd_channel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
230 cvar_t snd_channel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
231 cvar_t snd_channel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
232 cvar_t snd_channel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
233 cvar_t snd_channel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
234 cvar_t snd_channel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
235 cvar_t snd_channel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
238 static cvar_t nosound = {CF_CLIENT, "nosound", "0", "disables sound"};
239 static cvar_t snd_precache = {CF_CLIENT, "snd_precache", "1", "loads sounds before they are used"};
240 static cvar_t ambient_level = {CF_CLIENT, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
241 static cvar_t ambient_fade = {CF_CLIENT, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
242 static cvar_t snd_noextraupdate = {CF_CLIENT, "snd_noextraupdate", "0", "disables extra sound mixer calls that are meant to reduce the chance of sound breakup at very low framerates"};
243 static cvar_t snd_show = {CF_CLIENT, "snd_show", "0", "shows some statistics about sound mixing"};
245 // Default sound format is 48KHz, 32bit float, stereo
246 // (48KHz because a lot of onboard sound cards sucks at any other speed)
247 static cvar_t snd_speed = {CF_CLIENT | CF_ARCHIVE, "snd_speed", "48000", "sound output frequency, in hertz"};
248 static cvar_t snd_width = {CF_CLIENT | CF_ARCHIVE, "snd_width", "4", "sound output precision, in bytes - 1 = 8bit, 2 = 16bit, 4 = 32bit float"};
249 static cvar_t snd_channels = {CF_CLIENT | CF_ARCHIVE, "snd_channels", "2", "number of channels for the sound output (2 for stereo; up to 8 supported for 3D sound)"};
251 static cvar_t snd_startloopingsounds = {CF_CLIENT, "snd_startloopingsounds", "1", "whether to start sounds that would loop (you want this to be 1); existing sounds are not affected"};
252 static cvar_t snd_startnonloopingsounds = {CF_CLIENT, "snd_startnonloopingsounds", "1", "whether to start sounds that would not loop (you want this to be 1); existing sounds are not affected"};
255 static cvar_t snd_identicalsoundrandomization_time = {CF_CLIENT, "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"};
256 static cvar_t snd_identicalsoundrandomization_tics = {CF_CLIENT, "snd_identicalsoundrandomization_tics", "0", "if nonzero, how many tics to limit sound randomization as defined by snd_identicalsoundrandomization_time"};
259 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
260 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
263 // ====================================================================
265 // ====================================================================
267 void S_FreeSfx (sfx_t *sfx, qbool force);
269 static void S_Play_Common (cmd_state_t *cmd, float fvol, float attenuation)
272 char name [MAX_QPATH];
276 while (i < Cmd_Argc (cmd))
278 // Get the name, and appends ".wav" as an extension if there's none
279 dp_strlcpy (name, Cmd_Argv(cmd, i), sizeof (name));
280 if (!strrchr (name, '.'))
281 dp_strlcat (name, ".wav", sizeof (name));
284 // If we need to get the volume from the command line
287 fvol = atof (Cmd_Argv(cmd, i));
291 sfx = S_PrecacheSound (name, true, true);
294 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
296 // Free the sfx if the file didn't exist
298 S_FreeSfx (sfx, false);
300 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
305 static void S_Play_f(cmd_state_t *cmd)
307 S_Play_Common(cmd, 1.0f, 1.0f);
310 static void S_Play2_f(cmd_state_t *cmd)
312 S_Play_Common(cmd, 1.0f, 0.0f);
315 static void S_PlayVol_f(cmd_state_t *cmd)
317 S_Play_Common(cmd, -1.0f, 0.0f);
320 static void S_SoundList_f(cmd_state_t *cmd)
327 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
329 if (sfx->fetcher != NULL)
333 size = (unsigned int)sfx->memsize;
334 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
335 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
336 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
337 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
339 sfx->format.width * 8,
340 (sfx->format.channels == 1) ? "mono" : "stereo",
346 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
348 Con_Printf("Total resident: %i\n", total);
352 static void S_SoundInfo_f(cmd_state_t *cmd)
354 if (snd_renderbuffer == NULL)
356 Con_Print("sound system not started\n");
360 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
361 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
362 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
363 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
364 Con_Printf("%5u total_channels\n", total_channels);
367 static void S_PauseSound_f(cmd_state_t *cmd)
369 if( Cmd_Argc(cmd) != 2 ) {
370 Con_Print("pausesound <pause>\n");
373 S_PauseGameSounds(atoi( Cmd_Argv(cmd, 1 ) ) != 0);
376 int S_GetSoundRate(void)
378 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
381 int S_GetSoundChannels(void)
383 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
386 int S_GetSoundWidth(void)
388 return snd_renderbuffer ? snd_renderbuffer->format.width : 0;
392 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
394 static void S_SetChannelLayout (void)
397 listener_t swaplistener;
398 listener_t *listeners;
401 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
402 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
404 if (i >= SND_SPEAKERLAYOUTS)
406 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
407 snd_renderbuffer->format.channels);
408 i = SND_SPEAKERLAYOUTS - 1;
411 snd_speakerlayout = snd_speakerlayouts[i];
412 listeners = snd_speakerlayout.listeners;
414 // Swap the left and right channels if snd_swapstereo is set
415 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
417 switch (snd_speakerlayout.channels)
420 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
424 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
427 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
438 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
439 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
440 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
442 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
444 // If we're in the sound engine initialization
445 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
447 layout = SND_CHANNELLAYOUT_STANDARD;
448 Cvar_SetValueQuick (&snd_channellayout, layout);
451 layout = current_channellayout_used;
454 layout = snd_channellayout.integer;
456 // Convert our layout (= ALSA) to the standard layout if necessary
457 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
459 if (layout == SND_CHANNELLAYOUT_STANDARD)
461 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
462 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
465 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
466 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
469 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
470 current_channellayout = snd_channellayout.integer;
471 current_channellayout_used = layout;
475 void S_Startup (void)
477 snd_format_t chosen_fmt;
478 static snd_format_t prev_render_format = {0, 0, 0};
485 if (!snd_initialized.integer)
488 // Get the starting sound format from the cvars
489 chosen_fmt.speed = snd_speed.integer;
490 chosen_fmt.width = snd_width.integer;
491 chosen_fmt.channels = snd_channels.integer;
493 // Check the environment variables to see if the player wants a particular sound format
495 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
497 env = getenv("QUAKE_SOUND_CHANNELS");
501 chosen_fmt.channels = atoi (env);
507 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
509 env = getenv("QUAKE_SOUND_SPEED");
513 chosen_fmt.speed = atoi (env);
519 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
521 env = getenv("QUAKE_SOUND_SAMPLEBITS");
525 chosen_fmt.width = atoi (env) / 8;
531 // Parse the command line to see if the player wants a particular sound format
532 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
533 if (Sys_CheckParm ("-sndquad") != 0)
535 chosen_fmt.channels = 4;
537 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
538 else if (Sys_CheckParm ("-sndstereo") != 0)
540 chosen_fmt.channels = 2;
542 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
543 else if (Sys_CheckParm ("-sndmono") != 0)
545 chosen_fmt.channels = 1;
547 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
548 i = Sys_CheckParm ("-sndspeed");
549 if (0 < i && i < sys.argc - 1)
551 chosen_fmt.speed = atoi (sys.argv[i + 1]);
553 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit or 32bit float sound output
554 i = Sys_CheckParm ("-sndbits");
555 if (0 < i && i < sys.argc - 1)
557 chosen_fmt.width = atoi (sys.argv[i + 1]) / 8;
561 // LadyHavoc: now you can with the resampler...
562 // You can't change sound speed after start time (not yet supported)
563 if (prev_render_format.speed != 0)
565 if (chosen_fmt.speed != prev_render_format.speed)
567 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
568 prev_render_format.speed);
569 chosen_fmt.speed = prev_render_format.speed;
575 if (chosen_fmt.speed < SND_MIN_SPEED)
577 chosen_fmt.speed = SND_MIN_SPEED;
579 else if (chosen_fmt.speed > SND_MAX_SPEED)
581 chosen_fmt.speed = SND_MAX_SPEED;
584 if (chosen_fmt.width < SND_MIN_WIDTH)
586 chosen_fmt.width = SND_MIN_WIDTH;
588 else if (chosen_fmt.width == 3)
590 chosen_fmt.width = 4;
592 else if (chosen_fmt.width > SND_MAX_WIDTH)
594 chosen_fmt.width = SND_MAX_WIDTH;
597 if (chosen_fmt.channels < SND_MIN_CHANNELS)
599 chosen_fmt.channels = SND_MIN_CHANNELS;
601 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
603 chosen_fmt.channels = SND_MAX_CHANNELS;
606 // create the sound buffer used for sumitting the samples to the plaform-dependent module
609 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
612 chosen_fmt.channels);
614 if (!SndSys_Init(&chosen_fmt))
616 Con_Print("S_Startup: SndSys_Init failed.\n");
617 sound_spatialized = false;
623 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
624 Con_Print ("S_Startup: simulating sound output\n");
627 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
628 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
629 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
632 if (snd_speed.integer != (int)chosen_fmt.speed)
633 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
634 if (snd_width.integer != chosen_fmt.width)
635 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
636 if (snd_channels.integer != chosen_fmt.channels)
637 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
639 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
640 S_SetChannelLayout();
642 snd_starttime = host.realtime;
644 // If the sound module has already run, add an extra time to make sure
645 // the sound time doesn't decrease, to not confuse playing SFXs
646 if (oldpaintedtime != 0)
648 // The extra time must be a multiple of the render buffer size
649 // to avoid modifying the current position in the buffer,
650 // some modules write directly to a shared (DMA) buffer
651 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
652 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
653 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
655 soundtime = extrasoundtime;
659 snd_renderbuffer->startframe = soundtime;
660 snd_renderbuffer->endframe = soundtime;
661 #ifdef CONFIG_VIDEO_CAPTURE
662 recording_sound = false;
668 void S_Shutdown(void)
670 if (snd_renderbuffer == NULL)
675 oldpaintedtime = snd_renderbuffer->endframe;
679 Mem_Free(snd_renderbuffer->ring);
680 Mem_Free(snd_renderbuffer);
681 snd_renderbuffer = NULL;
686 sound_spatialized = false;
689 static void S_Restart_f(cmd_state_t *cmd)
691 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
692 // So, refuse to do this if we are connected.
693 if(cls.state == ca_connected)
695 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
710 Cvar_RegisterVariable(&volume);
711 Cvar_RegisterVariable(&bgmvolume);
712 Cvar_RegisterVariable(&mastervolume);
713 Cvar_RegisterVariable(&snd_staticvolume);
714 Cvar_RegisterVariable(&snd_entchannel0volume);
715 Cvar_RegisterVariable(&snd_entchannel1volume);
716 Cvar_RegisterVariable(&snd_entchannel2volume);
717 Cvar_RegisterVariable(&snd_entchannel3volume);
718 Cvar_RegisterVariable(&snd_entchannel4volume);
719 Cvar_RegisterVariable(&snd_entchannel5volume);
720 Cvar_RegisterVariable(&snd_entchannel6volume);
721 Cvar_RegisterVariable(&snd_entchannel7volume);
722 Cvar_RegisterVariable(&snd_worldchannel0volume);
723 Cvar_RegisterVariable(&snd_worldchannel1volume);
724 Cvar_RegisterVariable(&snd_worldchannel2volume);
725 Cvar_RegisterVariable(&snd_worldchannel3volume);
726 Cvar_RegisterVariable(&snd_worldchannel4volume);
727 Cvar_RegisterVariable(&snd_worldchannel5volume);
728 Cvar_RegisterVariable(&snd_worldchannel6volume);
729 Cvar_RegisterVariable(&snd_worldchannel7volume);
730 Cvar_RegisterVariable(&snd_playerchannel0volume);
731 Cvar_RegisterVariable(&snd_playerchannel1volume);
732 Cvar_RegisterVariable(&snd_playerchannel2volume);
733 Cvar_RegisterVariable(&snd_playerchannel3volume);
734 Cvar_RegisterVariable(&snd_playerchannel4volume);
735 Cvar_RegisterVariable(&snd_playerchannel5volume);
736 Cvar_RegisterVariable(&snd_playerchannel6volume);
737 Cvar_RegisterVariable(&snd_playerchannel7volume);
738 Cvar_RegisterVariable(&snd_csqcchannel0volume);
739 Cvar_RegisterVariable(&snd_csqcchannel1volume);
740 Cvar_RegisterVariable(&snd_csqcchannel2volume);
741 Cvar_RegisterVariable(&snd_csqcchannel3volume);
742 Cvar_RegisterVariable(&snd_csqcchannel4volume);
743 Cvar_RegisterVariable(&snd_csqcchannel5volume);
744 Cvar_RegisterVariable(&snd_csqcchannel6volume);
745 Cvar_RegisterVariable(&snd_csqcchannel7volume);
746 Cvar_RegisterVariable(&snd_channel0volume);
747 Cvar_RegisterVariable(&snd_channel1volume);
748 Cvar_RegisterVariable(&snd_channel2volume);
749 Cvar_RegisterVariable(&snd_channel3volume);
750 Cvar_RegisterVariable(&snd_channel4volume);
751 Cvar_RegisterVariable(&snd_channel5volume);
752 Cvar_RegisterVariable(&snd_channel6volume);
753 Cvar_RegisterVariable(&snd_channel7volume);
755 Cvar_RegisterVariable(&snd_attenuation_exponent);
756 Cvar_RegisterVariable(&snd_attenuation_decibel);
758 Cvar_RegisterVariable(&snd_spatialization_min_radius);
759 Cvar_RegisterVariable(&snd_spatialization_max_radius);
760 Cvar_RegisterVariable(&snd_spatialization_min);
761 Cvar_RegisterVariable(&snd_spatialization_max);
762 Cvar_RegisterVariable(&snd_spatialization_power);
763 Cvar_RegisterVariable(&snd_spatialization_control);
764 Cvar_RegisterVariable(&snd_spatialization_occlusion);
765 Cvar_RegisterVariable(&snd_spatialization_prologic);
766 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
768 Cvar_RegisterVariable(&snd_speed);
769 Cvar_RegisterVariable(&snd_width);
770 Cvar_RegisterVariable(&snd_channels);
771 Cvar_RegisterVariable(&snd_mutewhenidle);
772 Cvar_RegisterVariable(&snd_maxchannelvolume);
773 Cvar_RegisterVariable(&snd_softclip);
775 Cvar_RegisterVariable(&snd_startloopingsounds);
776 Cvar_RegisterVariable(&snd_startnonloopingsounds);
778 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
779 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
781 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
782 if (Sys_CheckParm("-nosound"))
784 // dummy out Play and Play2 because mods stuffcmd that
785 Cmd_AddCommand(CF_CLIENT, "play", Cmd_NoOperation_f, "does nothing because -nosound was specified");
786 Cmd_AddCommand(CF_CLIENT, "play2", Cmd_NoOperation_f, "does nothing because -nosound was specified");
790 snd_mempool = Mem_AllocPool("sound", 0, NULL);
792 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
793 if (Sys_CheckParm("-simsound"))
796 Cmd_AddCommand(CF_CLIENT, "play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
797 Cmd_AddCommand(CF_CLIENT, "play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
798 Cmd_AddCommand(CF_CLIENT, "playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
799 Cmd_AddCommand(CF_CLIENT, "stopsound", S_StopAllSounds_f, "silence");
800 Cmd_AddCommand(CF_CLIENT, "pausesound", S_PauseSound_f, "temporary silence");
801 Cmd_AddCommand(CF_CLIENT, "soundlist", S_SoundList_f, "list loaded sounds");
802 Cmd_AddCommand(CF_CLIENT, "soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
803 Cmd_AddCommand(CF_CLIENT, "snd_restart", S_Restart_f, "restart sound system");
804 Cmd_AddCommand(CF_CLIENT, "snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
806 Cvar_RegisterVariable(&nosound);
807 Cvar_RegisterVariable(&snd_precache);
808 Cvar_RegisterVariable(&snd_initialized);
809 Cvar_RegisterVariable(&snd_streaming);
810 Cvar_RegisterVariable(&snd_streaming_length);
811 Cvar_RegisterVariable(&ambient_level);
812 Cvar_RegisterVariable(&ambient_fade);
813 Cvar_RegisterVariable(&snd_noextraupdate);
814 Cvar_RegisterVariable(&snd_show);
815 Cvar_RegisterVariable(&_snd_mixahead);
816 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
817 Cvar_RegisterVariable(&snd_channellayout);
818 Cvar_RegisterVariable(&snd_soundradius);
820 Cvar_SetValueQuick(&snd_initialized, true);
824 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
825 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
840 Shutdown and free all resources
843 void S_Terminate (void)
852 while (known_sfx != NULL)
853 S_FreeSfx (known_sfx, true);
855 Cvar_SetValueQuick (&snd_initialized, false);
856 Mem_FreePool (&snd_mempool);
865 void S_UnloadAllSounds_f(cmd_state_t *cmd)
869 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
870 // So, refuse to do this if we are connected.
871 if(cls.state == ca_connected)
873 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
877 // stop any active sounds
880 // because the ambient sounds will be freed, clear the pointers
881 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
882 ambient_sfxs[i] = NULL;
884 // now free all sounds
885 while (known_sfx != NULL)
886 S_FreeSfx (known_sfx, true);
895 sfx_t changevolume_sfx = {""};
896 sfx_t *S_FindName (const char *name)
900 if (!snd_initialized.integer)
903 if(!strcmp(name, changevolume_sfx.name))
904 return &changevolume_sfx;
906 if (strlen (name) >= sizeof (sfx->name))
908 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
912 // Look for this sound in the list of known sfx
913 // TODO: hash table search?
914 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
915 if(!strcmp (sfx->name, name))
918 // check for # in the beginning, try lookup by soundindex
919 if (name[0] == '#' && name[1])
921 int soundindex = atoi(name + 1);
922 if (soundindex > 0 && soundindex < MAX_SOUNDS)
923 if (cl.sound_precache[soundindex]->name[0])
924 return cl.sound_precache[soundindex];
927 // Add a sfx_t struct for this sound
928 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
929 memset (sfx, 0, sizeof(*sfx));
930 dp_strlcpy (sfx->name, name, sizeof (sfx->name));
931 sfx->memsize = sizeof(*sfx);
932 sfx->next = known_sfx;
944 void S_FreeSfx (sfx_t *sfx, qbool force)
948 // Do not free a precached sound during purge
949 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
952 if (developer_loading.integer)
953 Con_Printf ("unloading sound %s\n", sfx->name);
955 // Remove it from the list of known sfx
956 if (sfx == known_sfx)
957 known_sfx = known_sfx->next;
962 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
963 if (prev_sfx->next == sfx)
965 prev_sfx->next = sfx->next;
968 if (prev_sfx == NULL)
970 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
975 // Stop all channels using this sfx
976 for (i = 0; i < total_channels; i++)
978 if (channels[i].sfx == sfx)
980 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
981 S_StopChannel (i, true, false);
986 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
987 sfx->fetcher->freesfx(sfx);
997 void S_ClearUsed (void)
1003 // Start the ambient sounds and make them loop
1004 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1006 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1007 if (ambient_sfxs[i] == NULL)
1008 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1009 if (ambient_sfxs[i] != NULL)
1011 channels[i].sfx = ambient_sfxs[i];
1012 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1013 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1014 channels[i].basevolume = 0.0f;
1015 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1019 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1020 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1021 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1029 void S_PurgeUnused(void)
1034 // Free all not-precached per-level sfx
1035 for (sfx = known_sfx;sfx;sfx = sfxnext)
1037 sfxnext = sfx->next;
1038 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1039 S_FreeSfx (sfx, false);
1049 sfx_t *S_PrecacheSound (const char *name, qbool complain, qbool levelsound)
1053 if (!snd_initialized.integer)
1056 if (name == NULL || name[0] == 0)
1059 sfx = S_FindName (name);
1064 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1065 // previously missing file
1066 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1068 // set a flag to indicate this has been precached for this level or permanently
1070 sfx->flags |= SFXFLAG_LEVELSOUND;
1072 sfx->flags |= SFXFLAG_MENUSOUND;
1074 if (!nosound.integer && snd_precache.integer)
1075 S_LoadSound(sfx, complain);
1086 float S_SoundLength(const char *name)
1090 if (!snd_initialized.integer)
1092 if (name == NULL || name[0] == 0)
1095 sfx = S_FindName(name);
1098 return sfx->total_length / (float) S_GetSoundRate();
1106 qbool S_IsSoundPrecached (const sfx_t *sfx)
1108 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1116 void S_BlockSound (void)
1127 void S_UnblockSound (void)
1137 Picks a channel based on priorities, empty slots, number of channels
1140 static channel_t *SND_PickChannel(int entnum, int entchannel)
1144 int first_life_left, life_left;
1146 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1148 // Check for replacement sound, or find the best one to replace
1150 first_life_left = 0x7fffffff;
1152 // entity channels try to replace the existing sound on the channel
1153 // channels <= 0 are autochannels
1154 if (IS_CHAN_SINGLE(entchannel))
1156 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1158 ch = &channels[ch_idx];
1159 if (ch->entnum == entnum && ch->entchannel == entchannel)
1161 // always override sound from same entity
1162 S_StopChannel (ch_idx, true, false);
1163 return &channels[ch_idx];
1168 // there was no channel to override, so look for the first empty one
1169 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1171 ch = &channels[ch_idx];
1172 sfx = ch->sfx; // fetch the volatile variable
1175 // no sound on this channel
1176 first_to_die = ch_idx;
1177 goto emptychan_found;
1180 // don't let monster sounds override player sounds
1181 if ((ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity()) && !(entnum == cl.viewentity || entnum == CL_VM_GetViewEntity()))
1184 // don't override looped sounds
1185 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1187 life_left = (int)((double)sfx->total_length - ch->position);
1189 if (life_left < first_life_left)
1191 first_life_left = life_left;
1192 first_to_die = ch_idx;
1196 if (first_to_die == -1)
1199 S_StopChannel (first_to_die, true, false);
1202 return &channels[first_to_die];
1209 Spatializes a channel
1212 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1213 static void SND_Spatialize_WithSfx(channel_t *ch, qbool isstatic, sfx_t *sfx)
1217 float angle_side, angle_front, angle_factor, mixspeed;
1218 vec_t dist, mastervol, intensity;
1222 // update sound origin if we know about the entity
1223 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1225 if (ch->entnum >= MAX_EDICTS)
1227 //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]);
1229 if (ch->entnum > MAX_EDICTS)
1230 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1231 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1233 else if (cl.entities[ch->entnum].state_current.active)
1236 //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]);
1237 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1238 if (model && model->soundfromcenter)
1239 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1241 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1243 else if (cl.csqc_server2csqcentitynumber[ch->entnum])
1245 //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]);
1247 if (!CL_VM_GetEntitySoundOrigin(cl.csqc_server2csqcentitynumber[ch->entnum] + MAX_EDICTS, ch->origin))
1248 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1252 mastervol = ch->basevolume;
1253 mixspeed = ch->basespeed;
1255 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1257 // Adjust volume of static sounds
1259 mastervol *= snd_staticvolume.value;
1260 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1262 // old legacy separated cvars
1263 if(ch->entnum >= MAX_EDICTS)
1265 switch(ch->entchannel)
1267 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1268 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1269 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1270 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1271 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1272 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1273 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1274 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1278 else if(ch->entnum == 0)
1280 switch(ch->entchannel)
1282 case 0: mastervol *= snd_worldchannel0volume.value; break;
1283 case 1: mastervol *= snd_worldchannel1volume.value; break;
1284 case 2: mastervol *= snd_worldchannel2volume.value; break;
1285 case 3: mastervol *= snd_worldchannel3volume.value; break;
1286 case 4: mastervol *= snd_worldchannel4volume.value; break;
1287 case 5: mastervol *= snd_worldchannel5volume.value; break;
1288 case 6: mastervol *= snd_worldchannel6volume.value; break;
1289 case 7: mastervol *= snd_worldchannel7volume.value; break;
1293 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1295 switch(ch->entchannel)
1297 case 0: mastervol *= snd_playerchannel0volume.value; break;
1298 case 1: mastervol *= snd_playerchannel1volume.value; break;
1299 case 2: mastervol *= snd_playerchannel2volume.value; break;
1300 case 3: mastervol *= snd_playerchannel3volume.value; break;
1301 case 4: mastervol *= snd_playerchannel4volume.value; break;
1302 case 5: mastervol *= snd_playerchannel5volume.value; break;
1303 case 6: mastervol *= snd_playerchannel6volume.value; break;
1304 case 7: mastervol *= snd_playerchannel7volume.value; break;
1310 switch(ch->entchannel)
1312 case 0: mastervol *= snd_entchannel0volume.value; break;
1313 case 1: mastervol *= snd_entchannel1volume.value; break;
1314 case 2: mastervol *= snd_entchannel2volume.value; break;
1315 case 3: mastervol *= snd_entchannel3volume.value; break;
1316 case 4: mastervol *= snd_entchannel4volume.value; break;
1317 case 5: mastervol *= snd_entchannel5volume.value; break;
1318 case 6: mastervol *= snd_entchannel6volume.value; break;
1319 case 7: mastervol *= snd_entchannel7volume.value; break;
1324 switch(ch->entchannel)
1326 case 0: mastervol *= snd_channel0volume.value; break;
1327 case 1: mastervol *= snd_channel1volume.value; break;
1328 case 2: mastervol *= snd_channel2volume.value; break;
1329 case 3: mastervol *= snd_channel3volume.value; break;
1330 case 4: mastervol *= snd_channel4volume.value; break;
1331 case 5: mastervol *= snd_channel5volume.value; break;
1332 case 6: mastervol *= snd_channel6volume.value; break;
1333 case 7: mastervol *= snd_channel7volume.value; break;
1334 default: mastervol *= Cvar_VariableValueOr(&cvars_all, va(vabuf, sizeof(vabuf), "snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0, ~0); break;
1338 // If this channel does not manage its own volume (like CD tracks)
1339 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1340 mastervol *= volume.value;
1342 if(snd_maxchannelvolume.value > 0)
1344 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1345 mastervol = bound(0.0f, mastervol, 10.0f * snd_maxchannelvolume.value);
1348 // always apply "master"
1349 mastervol *= mastervolume.value;
1351 // add in ReplayGain very late; prevent clipping when close
1353 if(sfx->volume_peak > 0)
1355 // Replaygain support
1356 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1357 mastervol *= sfx->volume_mult;
1358 if(snd_maxchannelvolume.value > 0)
1360 if(mastervol * sfx->volume_peak > snd_maxchannelvolume.value)
1361 mastervol = snd_maxchannelvolume.value / sfx->volume_peak;
1363 // Con_DPrintf("%f\n", fvol);
1366 if(snd_maxchannelvolume.value > 0)
1368 // clamp HERE to keep relative volumes of the channels correct
1369 mastervol = min(mastervol, snd_maxchannelvolume.value);
1372 mastervol = max(0.0f, mastervol);
1374 ch->mixspeed = mixspeed;
1376 // anything coming from the view entity will always be full volume
1377 // LadyHavoc: make sounds with ATTN_NONE have no spatialization
1378 if (ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity() || ch->distfade == 0)
1380 ch->prologic_invert = 1;
1381 if (snd_spatialization_prologic.integer != 0)
1383 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1384 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1385 for (i = 2;i < SND_LISTENERS;i++)
1390 for (i = 0;i < SND_LISTENERS;i++)
1391 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1396 // calculate stereo seperation and distance attenuation
1397 VectorSubtract(listener_origin, ch->origin, source_vec);
1398 dist = VectorLength(source_vec);
1399 f = dist * ch->distfade;
1402 ((snd_attenuation_exponent.value == 0) ? 1.0 : pow(1.0 - min(1.0, f), (double)snd_attenuation_exponent.value))
1404 ((snd_attenuation_decibel.value == 0) ? 1.0 : pow(0.1, 0.1 * snd_attenuation_decibel.value * f));
1406 intensity = mastervol * f;
1409 qbool occluded = false;
1410 if (snd_spatialization_occlusion.integer)
1412 if(snd_spatialization_occlusion.integer & 1)
1413 if(listener_pvs && cl.worldmodel)
1415 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1416 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1420 if(snd_spatialization_occlusion.integer & 2)
1422 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin, ch->origin, ch->origin))
1428 ch->prologic_invert = 1;
1429 if (snd_spatialization_prologic.integer != 0)
1432 angle_factor = 0.5f;
1435 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1436 VectorNormalize(source_vec);
1438 switch(spatialmethod)
1442 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1444 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1445 VectorScale(source_vec, f, source_vec);
1448 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1449 f = spatialmin + spatialdiff * bound(0, f, 1);
1450 VectorScale(source_vec, f, source_vec);
1452 case SPATIAL_THRESH:
1453 f = spatialmin + spatialdiff * (dist < spatialoffset);
1454 VectorScale(source_vec, f, source_vec);
1461 // 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
1463 VectorNormalize(source_vec);
1464 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1465 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1466 if (angle_side > snd_spatialization_prologic_frontangle.value)
1468 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1469 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1470 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1471 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1472 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1473 if (angle_front > 0)
1474 angle_factor = 1 - angle_factor;
1477 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1478 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1481 ch->volume[0] = intensity * sqrt(angle_factor);
1482 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1483 for (i = 2;i < SND_LISTENERS;i++)
1488 for (i = 0;i < SND_LISTENERS;i++)
1490 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1491 VectorNormalize(source_vec);
1493 switch(spatialmethod)
1497 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1499 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1500 VectorScale(source_vec, f, source_vec);
1503 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1504 f = spatialmin + spatialdiff * bound(0, f, 1);
1505 VectorScale(source_vec, f, source_vec);
1507 case SPATIAL_THRESH:
1508 f = spatialmin + spatialdiff * (dist < spatialoffset);
1509 VectorScale(source_vec, f, source_vec);
1516 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1521 for (i = 0;i < SND_LISTENERS;i++)
1525 static void SND_Spatialize(channel_t *ch, qbool isstatic)
1527 sfx_t *sfx = ch->sfx;
1528 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1532 // =======================================================================
1533 // Start a sound effect
1534 // =======================================================================
1536 static void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qbool isstatic, int entnum, int entchannel, int startpos, float fspeed)
1540 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1544 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1546 if(!snd_startloopingsounds.integer)
1551 if(!snd_startnonloopingsounds.integer)
1555 // Initialize the channel
1556 // a crash was reported on an in-use channel, so check here...
1557 if (target_chan->sfx)
1559 int channelindex = (int)(target_chan - channels);
1560 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1561 S_StopChannel (channelindex, true, false);
1563 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1564 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1565 memset (target_chan, 0, sizeof (*target_chan));
1566 VectorCopy (origin, target_chan->origin);
1567 target_chan->flags = flags;
1568 target_chan->position = startpos; // start of the sound
1569 target_chan->entnum = entnum;
1570 target_chan->entchannel = entchannel;
1572 // If it's a static sound
1575 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1576 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1577 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1580 target_chan->distfade = attenuation / snd_soundradius.value;
1582 // set the listener volumes
1583 S_SetChannelVolume(target_chan - channels, fvol);
1584 S_SetChannelSpeed(target_chan - channels, fspeed);
1585 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1587 // finally, set the sfx pointer, so the channel becomes valid for playback
1588 // and will be noticed by the mixer
1589 target_chan->sfx = sfx;
1593 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)
1595 channel_t *target_chan, *check, *ch;
1596 int ch_idx, startpos, i;
1598 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1601 if(sfx == &changevolume_sfx)
1603 if (!IS_CHAN_SINGLE(entchannel))
1605 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1607 ch = &channels[ch_idx];
1608 if (ch->entnum == entnum && ch->entchannel == entchannel)
1610 S_SetChannelVolume(ch_idx, fvol);
1611 S_SetChannelSpeed(ch_idx, fspeed);
1612 for(i = 1; i > 0 && (i <= flags || i <= (int) channels[ch_idx].flags); i <<= 1)
1613 if((flags ^ channels[ch_idx].flags) & i)
1614 S_SetChannelFlag(ch_idx, i, (flags & i) != 0);
1615 ch->distfade = attenuation / snd_soundradius.value;
1616 SND_Spatialize(ch, false);
1623 if (sfx->fetcher == NULL)
1626 // Pick a channel to play on
1627 target_chan = SND_PickChannel(entnum, entchannel);
1631 // if an identical sound has also been started this frame, offset the pos
1632 // a bit to keep it from just making the first one louder
1633 check = &channels[NUM_AMBIENTS];
1634 startpos = (int)(startposition * sfx->format.speed);
1637 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1639 if (check == target_chan)
1641 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1643 // calculate max offset
1644 float maxtime = snd_identicalsoundrandomization_time.value;
1645 float maxtics = snd_identicalsoundrandomization_tics.value;
1646 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1648 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1651 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1653 // use negative pos offset to delay this sound effect
1654 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1660 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1662 return (target_chan - channels);
1665 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1667 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, 0, CHANNELFLAG_NONE, 1.0f);
1670 void S_StopChannel (unsigned int channel_ind, qbool lockmutex, qbool freesfx)
1675 if (channel_ind >= total_channels)
1678 // we have to lock an audio mutex to prevent crashes if an audio mixer
1679 // thread is currently mixing this channel
1680 // the SndSys_LockRenderBuffer function uses such a mutex in
1681 // threaded sound backends
1682 if (lockmutex && !simsound)
1683 SndSys_LockRenderBuffer();
1685 ch = &channels[channel_ind];
1689 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1690 sfx->fetcher->stopchannel(ch);
1691 ch->fetcher_data = NULL;
1694 S_FreeSfx(sfx, true);
1696 if (lockmutex && !simsound)
1697 SndSys_UnlockRenderBuffer();
1701 qbool S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qbool value)
1703 if (ch_ind >= total_channels)
1706 if (flag != CHANNELFLAG_FORCELOOP &&
1707 flag != CHANNELFLAG_PAUSED &&
1708 flag != CHANNELFLAG_FULLVOLUME &&
1709 flag != CHANNELFLAG_LOCALSOUND)
1713 channels[ch_ind].flags |= flag;
1715 channels[ch_ind].flags &= ~flag;
1720 void S_StopSound(int entnum, int entchannel)
1724 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1725 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1727 S_StopChannel (i, true, false);
1732 void S_StopAllSounds(void)
1736 // TOCHECK: is this test necessary?
1737 if (snd_renderbuffer == NULL)
1740 // stop CD audio because it may be using a faketrack
1743 if (simsound || SndSys_LockRenderBuffer ())
1748 for (i = 0; i < total_channels; i++)
1749 if (channels[i].sfx)
1750 S_StopChannel (i, false, false);
1752 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1753 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1755 // Mute the contents of the submittion buffer
1756 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1757 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1758 memset(snd_renderbuffer->ring, clear, memsize);
1761 SndSys_UnlockRenderBuffer ();
1765 void S_StopAllSounds_f(cmd_state_t *cmd)
1771 void S_PauseGameSounds (qbool toggle)
1775 for (i = 0; i < total_channels; i++)
1780 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1781 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1785 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1787 channels[ch_ind].basevolume = fvol;
1790 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1792 channels[ch_ind].basespeed = fspeed;
1795 float S_GetChannelPosition (unsigned int ch_ind)
1797 // note: this is NOT accurate yet
1799 channel_t *ch = &channels[ch_ind];
1800 sfx_t *sfx = ch->sfx;
1804 s = ch->position / sfx->format.speed;
1806 if(!snd_usethreadedmixing)
1807 s += _snd_mixahead.value;
1812 float S_GetEntChannelPosition(int entnum, int entchannel)
1817 for (i = 0; i < total_channels; i++)
1820 if (ch->entnum == entnum && ch->entchannel == entchannel)
1821 return S_GetChannelPosition(i);
1823 return -1; // no playing sound in this channel
1831 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1833 channel_t *target_chan;
1835 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1839 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1843 if (total_channels == MAX_CHANNELS)
1845 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1849 target_chan = &channels[total_channels++];
1850 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1856 S_UpdateAmbientSounds
1859 static void S_UpdateAmbientSounds (void)
1863 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1864 int ambient_channel;
1866 unsigned char ambientlevels[NUM_AMBIENTS];
1869 memset(ambientlevels, 0, sizeof(ambientlevels));
1870 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1871 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1873 // Calc ambient sound levels
1874 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1876 chan = &channels[ambient_channel];
1877 sfx = chan->sfx; // fetch the volatile variable
1878 if (sfx == NULL || sfx->fetcher == NULL)
1881 i = ambientlevels[ambient_channel];
1884 vol = i * (1.0f / 256.0f);
1886 // Don't adjust volume too fast
1887 if (chan->basevolume < vol)
1889 chan->basevolume += fade;
1890 if (chan->basevolume > vol)
1891 chan->basevolume = vol;
1893 else if (chan->basevolume > vol)
1895 chan->basevolume -= fade;
1896 if (chan->basevolume < vol)
1897 chan->basevolume = vol;
1900 if (snd_spatialization_prologic.integer != 0)
1902 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1903 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1904 for (i = 2;i < SND_LISTENERS;i++)
1905 chan->volume[i] = 0.0f;
1909 for (i = 0;i < SND_LISTENERS;i++)
1910 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1915 static void S_PaintAndSubmit (void)
1917 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1918 int usesoundtimehack;
1919 static int soundtimehack = -1;
1920 static int oldsoundtime = 0;
1922 if (snd_renderbuffer == NULL || nosound.integer)
1925 // Update sound time
1926 snd_usethreadedmixing = false;
1927 usesoundtimehack = true;
1928 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1930 usesoundtimehack = 1;
1931 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1933 #ifdef CONFIG_VIDEO_CAPTURE
1934 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1936 usesoundtimehack = 2;
1937 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1942 usesoundtimehack = 3;
1943 newsoundtime = (unsigned int)((host.realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1947 #ifdef CONFIG_VIDEO_CAPTURE
1948 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1950 snd_usethreadedmixing = snd_threaded;
1952 usesoundtimehack = 0;
1953 newsoundtime = SndSys_GetSoundTime();
1955 // if the soundtimehack state changes we need to reset the soundtime
1956 if (soundtimehack != usesoundtimehack)
1958 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1960 // Mute the contents of the submission buffer
1961 if (simsound || SndSys_LockRenderBuffer ())
1966 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1967 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1968 memset(snd_renderbuffer->ring, clear, memsize);
1971 SndSys_UnlockRenderBuffer ();
1974 soundtimehack = usesoundtimehack;
1976 if (!soundtimehack && snd_blocked > 0)
1979 if (snd_usethreadedmixing)
1980 return; // the audio thread will mix its own data
1982 newsoundtime += extrasoundtime;
1983 if (newsoundtime < soundtime)
1985 #ifdef CONFIG_VIDEO_CAPTURE
1986 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1988 unsigned int additionaltime;
1990 // add some time to extrasoundtime make newsoundtime higher
1992 // The extra time must be a multiple of the render buffer size
1993 // to avoid modifying the current position in the buffer,
1994 // some modules write directly to a shared (DMA) buffer
1995 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1996 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1998 extrasoundtime += additionaltime;
1999 newsoundtime += additionaltime;
2000 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2003 else if (!soundtimehack)
2007 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2008 newsoundtime, soundtime);
2010 soundtime = newsoundtime;
2011 #ifdef CONFIG_VIDEO_CAPTURE
2012 recording_sound = (cls.capturevideo.soundrate != 0);
2015 // Lock submitbuffer
2016 if (!simsound && !SndSys_LockRenderBuffer())
2018 // If the lock failed, stop here
2019 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2023 // Check to make sure that we haven't overshot
2024 paintedtime = snd_renderbuffer->endframe;
2025 if (paintedtime < soundtime)
2026 paintedtime = soundtime;
2028 // mix ahead of current position
2030 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2032 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2033 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2034 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2035 endtime = min(endtime, maxtime);
2037 while (paintedtime < endtime)
2039 unsigned int startoffset;
2040 unsigned int nbframes;
2042 // see how much we can fit in the paint buffer
2043 nbframes = endtime - paintedtime;
2044 // limit to the end of the ring buffer (in case of wrapping)
2045 startoffset = paintedtime % snd_renderbuffer->maxframes;
2046 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2048 // mix into the buffer
2049 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2051 paintedtime += nbframes;
2052 snd_renderbuffer->endframe = paintedtime;
2055 SndSys_UnlockRenderBuffer();
2057 // Remove outdated samples from the ring buffer, if any
2058 if (snd_renderbuffer->startframe < soundtime)
2059 snd_renderbuffer->startframe = soundtime;
2062 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2066 oldsoundtime = soundtime;
2068 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2069 R_TimeReport("audiomix");
2076 Called once each time through the main loop
2079 void S_Update(const matrix4x4_t *listenermatrix)
2081 unsigned int i, j, k;
2082 channel_t *ch, *combine;
2083 matrix4x4_t rotatematrix;
2085 if (snd_renderbuffer == NULL || nosound.integer)
2089 double mindist_trans, maxdist_trans;
2091 spatialmin = snd_spatialization_min.value;
2092 spatialdiff = snd_spatialization_max.value - spatialmin;
2094 if(snd_spatialization_control.value)
2096 spatialpower = snd_spatialization_power.value;
2098 if(spatialpower == 0)
2100 spatialmethod = SPATIAL_LOG;
2101 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2102 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2106 spatialmethod = SPATIAL_POW;
2107 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2108 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2111 if(mindist_trans - maxdist_trans == 0)
2113 spatialmethod = SPATIAL_THRESH;
2114 mindist_trans = snd_spatialization_min_radius.value;
2118 spatialoffset = mindist_trans;
2119 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2123 spatialmethod = SPATIAL_NONE;
2127 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2128 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2129 current_channellayout != snd_channellayout.integer)
2130 S_SetChannelLayout();
2132 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2133 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2134 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2136 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2139 Mem_Free(listener_pvs);
2140 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2141 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2143 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2149 Mem_Free(listener_pvs);
2150 listener_pvs = NULL;
2152 listener_pvsbytes = 0;
2155 // calculate the current matrices
2156 for (j = 0;j < SND_LISTENERS;j++)
2158 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2159 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2160 // I think this should now do this:
2161 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2162 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2163 // angle has to be taken negative)
2164 // 2. create a transform which first rotates and moves its argument
2165 // into the player's view coordinates (using basematrix which is
2166 // an inverted "absolute" listener matrix), then applies the
2167 // rotation matrix for the ear
2168 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2169 // does not actually refer to an entity?
2172 // update general area ambient sound sources
2173 S_UpdateAmbientSounds ();
2176 R_TimeReport("audioprep");
2178 // update spatialization for static and dynamic sounds
2179 cls.soundstats.totalsounds = 0;
2180 cls.soundstats.mixedsounds = 0;
2181 ch = channels+NUM_AMBIENTS;
2182 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2186 cls.soundstats.totalsounds++;
2188 // respatialize channel
2189 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2191 // try to combine static sounds with a previous channel of the same
2192 // sound effect so we don't mix five torches every frame
2193 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2195 // no need to merge silent channels
2196 for (j = 0;j < SND_LISTENERS;j++)
2199 if (j == SND_LISTENERS)
2201 // if the last combine chosen isn't suitable, find a new one
2202 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2206 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2208 if (channels[j].sfx == ch->sfx)
2210 combine = channels + j;
2215 if (combine && combine != ch && combine->sfx == ch->sfx)
2217 for (j = 0;j < SND_LISTENERS;j++)
2219 combine->volume[j] += ch->volume[j];
2224 for (k = 0;k < SND_LISTENERS;k++)
2227 if (k < SND_LISTENERS)
2228 cls.soundstats.mixedsounds++;
2230 R_TimeReport("audiospatialize");
2232 sound_spatialized = true;
2235 if (snd_show.integer)
2236 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2241 void S_ExtraUpdate (void)
2243 if (snd_noextraupdate.integer || !sound_spatialized)
2249 qbool S_LocalSoundEx (const char *sound, int chan, float fvol)
2254 if (!snd_initialized.integer || nosound.integer)
2257 sfx = S_PrecacheSound (sound, true, false);
2260 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2264 // menu sounds must not be freed on level change
2265 sfx->flags |= SFXFLAG_MENUSOUND;
2267 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2268 // which we no longer support anyway
2269 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2270 ch_ind = S_StartSound (cl.viewentity, chan, sfx, vec3_origin, fvol, 0);
2274 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
2278 qbool S_LocalSound (const char *sound)
2280 return S_LocalSoundEx(sound, 0, 1);