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_waterfx = {CF_CLIENT | CF_ARCHIVE, "snd_waterfx", "1", "underwater sound filter strength"};
187 cvar_t _snd_mixahead = {CF_CLIENT | CF_ARCHIVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
188 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"};
189 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"};
190 cvar_t snd_swapstereo = {CF_CLIENT | CF_ARCHIVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
191 extern cvar_t v_flipped;
192 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)"};
193 cvar_t snd_mutewhenidle = {CF_CLIENT | CF_ARCHIVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
194 cvar_t snd_maxchannelvolume = {CF_CLIENT | CF_ARCHIVE, "snd_maxchannelvolume", "10", "maximum volume of a single sound"};
195 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."};
196 //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."};
197 cvar_t snd_entchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
198 cvar_t snd_entchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
199 cvar_t snd_entchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
200 cvar_t snd_entchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
201 cvar_t snd_entchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
202 cvar_t snd_entchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
203 cvar_t snd_entchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
204 cvar_t snd_entchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
205 cvar_t snd_playerchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
206 cvar_t snd_playerchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
207 cvar_t snd_playerchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
208 cvar_t snd_playerchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
209 cvar_t snd_playerchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
210 cvar_t snd_playerchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
211 cvar_t snd_playerchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
212 cvar_t snd_playerchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
213 cvar_t snd_worldchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
214 cvar_t snd_worldchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
215 cvar_t snd_worldchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
216 cvar_t snd_worldchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
217 cvar_t snd_worldchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
218 cvar_t snd_worldchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
219 cvar_t snd_worldchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
220 cvar_t snd_worldchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
221 cvar_t snd_csqcchannel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
222 cvar_t snd_csqcchannel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
223 cvar_t snd_csqcchannel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
224 cvar_t snd_csqcchannel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
225 cvar_t snd_csqcchannel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
226 cvar_t snd_csqcchannel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
227 cvar_t snd_csqcchannel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
228 cvar_t snd_csqcchannel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
229 cvar_t snd_channel0volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
230 cvar_t snd_channel1volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
231 cvar_t snd_channel2volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
232 cvar_t snd_channel3volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
233 cvar_t snd_channel4volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
234 cvar_t snd_channel5volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
235 cvar_t snd_channel6volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
236 cvar_t snd_channel7volume = {CF_CLIENT | CF_ARCHIVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
239 static cvar_t nosound = {CF_CLIENT, "nosound", "0", "disables sound"};
240 static cvar_t snd_precache = {CF_CLIENT, "snd_precache", "1", "loads sounds before they are used"};
241 static cvar_t ambient_level = {CF_CLIENT, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
242 static cvar_t ambient_fade = {CF_CLIENT, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
243 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"};
244 static cvar_t snd_show = {CF_CLIENT, "snd_show", "0", "shows some statistics about sound mixing"};
246 // Default sound format is 48KHz, 32bit float, stereo
247 // (48KHz because a lot of onboard sound cards sucks at any other speed)
248 static cvar_t snd_speed = {CF_CLIENT | CF_ARCHIVE, "snd_speed", "48000", "sound output frequency, in hertz"};
249 static cvar_t snd_width = {CF_CLIENT | CF_ARCHIVE, "snd_width", "4", "sound output precision, in bytes - 1 = 8bit, 2 = 16bit, 4 = 32bit float"};
250 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)"};
252 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"};
253 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"};
256 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"};
257 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"};
260 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
261 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
264 // ====================================================================
266 // ====================================================================
268 void S_FreeSfx (sfx_t *sfx, qbool force);
270 static void S_Play_Common (cmd_state_t *cmd, float fvol, float attenuation)
273 char name [MAX_QPATH];
277 while (i < Cmd_Argc (cmd))
279 // Get the name, and appends ".wav" as an extension if there's none
280 dp_strlcpy (name, Cmd_Argv(cmd, i), sizeof (name));
281 if (!strrchr (name, '.'))
282 dp_strlcat (name, ".wav", sizeof (name));
285 // If we need to get the volume from the command line
288 fvol = atof (Cmd_Argv(cmd, i));
292 sfx = S_PrecacheSound (name, true, true);
295 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
297 // Free the sfx if the file didn't exist
299 S_FreeSfx (sfx, false);
301 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
306 static void S_Play_f(cmd_state_t *cmd)
308 S_Play_Common(cmd, 1.0f, 1.0f);
311 static void S_Play2_f(cmd_state_t *cmd)
313 S_Play_Common(cmd, 1.0f, 0.0f);
316 static void S_PlayVol_f(cmd_state_t *cmd)
318 S_Play_Common(cmd, -1.0f, 0.0f);
321 static void S_SoundList_f(cmd_state_t *cmd)
328 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
330 if (sfx->fetcher != NULL)
334 size = (unsigned int)sfx->memsize;
335 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
336 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
337 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
338 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
340 sfx->format.width * 8,
341 (sfx->format.channels == 1) ? "mono" : "stereo",
347 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
349 Con_Printf("Total resident: %i\n", total);
353 static void S_SoundInfo_f(cmd_state_t *cmd)
355 if (snd_renderbuffer == NULL)
357 Con_Print("sound system not started\n");
361 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
362 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
363 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
364 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
365 Con_Printf("%5u total_channels\n", total_channels);
368 static void S_PauseSound_f(cmd_state_t *cmd)
370 if( Cmd_Argc(cmd) != 2 ) {
371 Con_Print("pausesound <pause>\n");
374 S_PauseGameSounds(atoi( Cmd_Argv(cmd, 1 ) ) != 0);
377 int S_GetSoundRate(void)
379 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
382 int S_GetSoundChannels(void)
384 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
387 int S_GetSoundWidth(void)
389 return snd_renderbuffer ? snd_renderbuffer->format.width : 0;
393 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
395 static void S_SetChannelLayout (void)
398 listener_t swaplistener;
399 listener_t *listeners;
402 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
403 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
405 if (i >= SND_SPEAKERLAYOUTS)
407 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
408 snd_renderbuffer->format.channels);
409 i = SND_SPEAKERLAYOUTS - 1;
412 snd_speakerlayout = snd_speakerlayouts[i];
413 listeners = snd_speakerlayout.listeners;
415 // Swap the left and right channels if snd_swapstereo is set
416 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
418 switch (snd_speakerlayout.channels)
421 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
425 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
428 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
439 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
440 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
441 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
443 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
445 // If we're in the sound engine initialization
446 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
448 layout = SND_CHANNELLAYOUT_STANDARD;
449 Cvar_SetValueQuick (&snd_channellayout, layout);
452 layout = current_channellayout_used;
455 layout = snd_channellayout.integer;
457 // Convert our layout (= ALSA) to the standard layout if necessary
458 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
460 if (layout == SND_CHANNELLAYOUT_STANDARD)
462 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
463 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
466 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
467 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
470 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
471 current_channellayout = snd_channellayout.integer;
472 current_channellayout_used = layout;
476 void S_Startup (void)
478 snd_format_t chosen_fmt;
479 static snd_format_t prev_render_format = {0, 0, 0};
486 if (!snd_initialized.integer)
489 // Get the starting sound format from the cvars
490 chosen_fmt.speed = snd_speed.integer;
491 chosen_fmt.width = snd_width.integer;
492 chosen_fmt.channels = snd_channels.integer;
494 // Check the environment variables to see if the player wants a particular sound format
496 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
498 env = getenv("QUAKE_SOUND_CHANNELS");
502 chosen_fmt.channels = atoi (env);
508 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
510 env = getenv("QUAKE_SOUND_SPEED");
514 chosen_fmt.speed = atoi (env);
520 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
522 env = getenv("QUAKE_SOUND_SAMPLEBITS");
526 chosen_fmt.width = atoi (env) / 8;
532 // Parse the command line to see if the player wants a particular sound format
533 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
534 if (Sys_CheckParm ("-sndquad") != 0)
536 chosen_fmt.channels = 4;
538 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
539 else if (Sys_CheckParm ("-sndstereo") != 0)
541 chosen_fmt.channels = 2;
543 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
544 else if (Sys_CheckParm ("-sndmono") != 0)
546 chosen_fmt.channels = 1;
548 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
549 i = Sys_CheckParm ("-sndspeed");
550 if (0 < i && i < sys.argc - 1)
552 chosen_fmt.speed = atoi (sys.argv[i + 1]);
554 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit or 32bit float sound output
555 i = Sys_CheckParm ("-sndbits");
556 if (0 < i && i < sys.argc - 1)
558 chosen_fmt.width = atoi (sys.argv[i + 1]) / 8;
562 // LadyHavoc: now you can with the resampler...
563 // You can't change sound speed after start time (not yet supported)
564 if (prev_render_format.speed != 0)
566 if (chosen_fmt.speed != prev_render_format.speed)
568 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
569 prev_render_format.speed);
570 chosen_fmt.speed = prev_render_format.speed;
576 if (chosen_fmt.speed < SND_MIN_SPEED)
578 chosen_fmt.speed = SND_MIN_SPEED;
580 else if (chosen_fmt.speed > SND_MAX_SPEED)
582 chosen_fmt.speed = SND_MAX_SPEED;
585 if (chosen_fmt.width < SND_MIN_WIDTH)
587 chosen_fmt.width = SND_MIN_WIDTH;
589 else if (chosen_fmt.width == 3)
591 chosen_fmt.width = 4;
593 else if (chosen_fmt.width > SND_MAX_WIDTH)
595 chosen_fmt.width = SND_MAX_WIDTH;
598 if (chosen_fmt.channels < SND_MIN_CHANNELS)
600 chosen_fmt.channels = SND_MIN_CHANNELS;
602 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
604 chosen_fmt.channels = SND_MAX_CHANNELS;
607 // create the sound buffer used for sumitting the samples to the plaform-dependent module
610 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
613 chosen_fmt.channels);
615 if (!SndSys_Init(&chosen_fmt))
617 Con_Print("S_Startup: SndSys_Init failed.\n");
618 sound_spatialized = false;
624 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
625 Con_Print ("S_Startup: simulating sound output\n");
628 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
629 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
630 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
633 if (snd_speed.integer != (int)chosen_fmt.speed)
634 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
635 if (snd_width.integer != chosen_fmt.width)
636 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
637 if (snd_channels.integer != chosen_fmt.channels)
638 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
640 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
641 S_SetChannelLayout();
643 snd_starttime = host.realtime;
645 // If the sound module has already run, add an extra time to make sure
646 // the sound time doesn't decrease, to not confuse playing SFXs
647 if (oldpaintedtime != 0)
649 // The extra time must be a multiple of the render buffer size
650 // to avoid modifying the current position in the buffer,
651 // some modules write directly to a shared (DMA) buffer
652 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
653 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
654 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
656 soundtime = extrasoundtime;
660 snd_renderbuffer->startframe = soundtime;
661 snd_renderbuffer->endframe = soundtime;
662 #ifdef CONFIG_VIDEO_CAPTURE
663 recording_sound = false;
669 void S_Shutdown(void)
671 if (snd_renderbuffer == NULL)
676 oldpaintedtime = snd_renderbuffer->endframe;
680 Mem_Free(snd_renderbuffer->ring);
681 Mem_Free(snd_renderbuffer);
682 snd_renderbuffer = NULL;
687 sound_spatialized = false;
690 static void S_Restart_f(cmd_state_t *cmd)
692 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
693 // So, refuse to do this if we are connected.
694 if(cls.state == ca_connected)
696 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
711 Cvar_RegisterVariable(&volume);
712 Cvar_RegisterVariable(&bgmvolume);
713 Cvar_RegisterVariable(&mastervolume);
714 Cvar_RegisterVariable(&snd_staticvolume);
715 Cvar_RegisterVariable(&snd_entchannel0volume);
716 Cvar_RegisterVariable(&snd_entchannel1volume);
717 Cvar_RegisterVariable(&snd_entchannel2volume);
718 Cvar_RegisterVariable(&snd_entchannel3volume);
719 Cvar_RegisterVariable(&snd_entchannel4volume);
720 Cvar_RegisterVariable(&snd_entchannel5volume);
721 Cvar_RegisterVariable(&snd_entchannel6volume);
722 Cvar_RegisterVariable(&snd_entchannel7volume);
723 Cvar_RegisterVariable(&snd_worldchannel0volume);
724 Cvar_RegisterVariable(&snd_worldchannel1volume);
725 Cvar_RegisterVariable(&snd_worldchannel2volume);
726 Cvar_RegisterVariable(&snd_worldchannel3volume);
727 Cvar_RegisterVariable(&snd_worldchannel4volume);
728 Cvar_RegisterVariable(&snd_worldchannel5volume);
729 Cvar_RegisterVariable(&snd_worldchannel6volume);
730 Cvar_RegisterVariable(&snd_worldchannel7volume);
731 Cvar_RegisterVariable(&snd_playerchannel0volume);
732 Cvar_RegisterVariable(&snd_playerchannel1volume);
733 Cvar_RegisterVariable(&snd_playerchannel2volume);
734 Cvar_RegisterVariable(&snd_playerchannel3volume);
735 Cvar_RegisterVariable(&snd_playerchannel4volume);
736 Cvar_RegisterVariable(&snd_playerchannel5volume);
737 Cvar_RegisterVariable(&snd_playerchannel6volume);
738 Cvar_RegisterVariable(&snd_playerchannel7volume);
739 Cvar_RegisterVariable(&snd_csqcchannel0volume);
740 Cvar_RegisterVariable(&snd_csqcchannel1volume);
741 Cvar_RegisterVariable(&snd_csqcchannel2volume);
742 Cvar_RegisterVariable(&snd_csqcchannel3volume);
743 Cvar_RegisterVariable(&snd_csqcchannel4volume);
744 Cvar_RegisterVariable(&snd_csqcchannel5volume);
745 Cvar_RegisterVariable(&snd_csqcchannel6volume);
746 Cvar_RegisterVariable(&snd_csqcchannel7volume);
747 Cvar_RegisterVariable(&snd_channel0volume);
748 Cvar_RegisterVariable(&snd_channel1volume);
749 Cvar_RegisterVariable(&snd_channel2volume);
750 Cvar_RegisterVariable(&snd_channel3volume);
751 Cvar_RegisterVariable(&snd_channel4volume);
752 Cvar_RegisterVariable(&snd_channel5volume);
753 Cvar_RegisterVariable(&snd_channel6volume);
754 Cvar_RegisterVariable(&snd_channel7volume);
756 Cvar_RegisterVariable(&snd_attenuation_exponent);
757 Cvar_RegisterVariable(&snd_attenuation_decibel);
759 Cvar_RegisterVariable(&snd_spatialization_min_radius);
760 Cvar_RegisterVariable(&snd_spatialization_max_radius);
761 Cvar_RegisterVariable(&snd_spatialization_min);
762 Cvar_RegisterVariable(&snd_spatialization_max);
763 Cvar_RegisterVariable(&snd_spatialization_power);
764 Cvar_RegisterVariable(&snd_spatialization_control);
765 Cvar_RegisterVariable(&snd_spatialization_occlusion);
766 Cvar_RegisterVariable(&snd_spatialization_prologic);
767 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
769 Cvar_RegisterVariable(&snd_speed);
770 Cvar_RegisterVariable(&snd_width);
771 Cvar_RegisterVariable(&snd_channels);
772 Cvar_RegisterVariable(&snd_mutewhenidle);
773 Cvar_RegisterVariable(&snd_maxchannelvolume);
774 Cvar_RegisterVariable(&snd_softclip);
776 Cvar_RegisterVariable(&snd_startloopingsounds);
777 Cvar_RegisterVariable(&snd_startnonloopingsounds);
779 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
780 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
782 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
783 if (Sys_CheckParm("-nosound"))
785 // dummy out Play and Play2 because mods stuffcmd that
786 Cmd_AddCommand(CF_CLIENT, "play", Cmd_NoOperation_f, "does nothing because -nosound was specified");
787 Cmd_AddCommand(CF_CLIENT, "play2", Cmd_NoOperation_f, "does nothing because -nosound was specified");
791 snd_mempool = Mem_AllocPool("sound", 0, NULL);
793 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
794 if (Sys_CheckParm("-simsound"))
797 Cmd_AddCommand(CF_CLIENT, "play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
798 Cmd_AddCommand(CF_CLIENT, "play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
799 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)");
800 Cmd_AddCommand(CF_CLIENT, "stopsound", S_StopAllSounds_f, "silence");
801 Cmd_AddCommand(CF_CLIENT, "pausesound", S_PauseSound_f, "temporary silence");
802 Cmd_AddCommand(CF_CLIENT, "soundlist", S_SoundList_f, "list loaded sounds");
803 Cmd_AddCommand(CF_CLIENT, "soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
804 Cmd_AddCommand(CF_CLIENT, "snd_restart", S_Restart_f, "restart sound system");
805 Cmd_AddCommand(CF_CLIENT, "snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
807 Cvar_RegisterVariable(&nosound);
808 Cvar_RegisterVariable(&snd_precache);
809 Cvar_RegisterVariable(&snd_initialized);
810 Cvar_RegisterVariable(&snd_streaming);
811 Cvar_RegisterVariable(&snd_streaming_length);
812 Cvar_RegisterVariable(&ambient_level);
813 Cvar_RegisterVariable(&ambient_fade);
814 Cvar_RegisterVariable(&snd_noextraupdate);
815 Cvar_RegisterVariable(&snd_show);
816 Cvar_RegisterVariable(&snd_waterfx);
817 Cvar_RegisterVariable(&_snd_mixahead);
818 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
819 Cvar_RegisterVariable(&snd_channellayout);
820 Cvar_RegisterVariable(&snd_soundradius);
822 Cvar_SetValueQuick(&snd_initialized, true);
826 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
827 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
842 Shutdown and free all resources
845 void S_Terminate (void)
854 while (known_sfx != NULL)
855 S_FreeSfx (known_sfx, true);
857 Cvar_SetValueQuick (&snd_initialized, false);
858 Mem_FreePool (&snd_mempool);
867 void S_UnloadAllSounds_f(cmd_state_t *cmd)
871 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
872 // So, refuse to do this if we are connected.
873 if(cls.state == ca_connected)
875 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
879 // stop any active sounds
882 // because the ambient sounds will be freed, clear the pointers
883 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
884 ambient_sfxs[i] = NULL;
886 // now free all sounds
887 while (known_sfx != NULL)
888 S_FreeSfx (known_sfx, true);
897 sfx_t changevolume_sfx = {""};
898 sfx_t *S_FindName (const char *name)
902 if (!snd_initialized.integer)
905 if(!strcmp(name, changevolume_sfx.name))
906 return &changevolume_sfx;
908 if (strlen (name) >= sizeof (sfx->name))
910 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
914 // Look for this sound in the list of known sfx
915 // TODO: hash table search?
916 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
917 if(!strcmp (sfx->name, name))
920 // check for # in the beginning, try lookup by soundindex
921 if (name[0] == '#' && name[1])
923 int soundindex = atoi(name + 1);
924 if (soundindex > 0 && soundindex < MAX_SOUNDS)
925 if (cl.sound_precache[soundindex]->name[0])
926 return cl.sound_precache[soundindex];
929 // Add a sfx_t struct for this sound
930 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
931 memset (sfx, 0, sizeof(*sfx));
932 dp_strlcpy (sfx->name, name, sizeof (sfx->name));
933 sfx->memsize = sizeof(*sfx);
934 sfx->next = known_sfx;
946 void S_FreeSfx (sfx_t *sfx, qbool force)
950 // Do not free a precached sound during purge
951 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
954 if (developer_loading.integer)
955 Con_Printf ("unloading sound %s\n", sfx->name);
957 // Remove it from the list of known sfx
958 if (sfx == known_sfx)
959 known_sfx = known_sfx->next;
964 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
965 if (prev_sfx->next == sfx)
967 prev_sfx->next = sfx->next;
970 if (prev_sfx == NULL)
972 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
977 // Stop all channels using this sfx
978 for (i = 0; i < total_channels; i++)
980 if (channels[i].sfx == sfx)
982 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
983 S_StopChannel (i, true, false);
988 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
989 sfx->fetcher->freesfx(sfx);
999 void S_ClearUsed (void)
1005 // Start the ambient sounds and make them loop
1006 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1008 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1009 if (ambient_sfxs[i] == NULL)
1010 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1011 if (ambient_sfxs[i] != NULL)
1013 channels[i].sfx = ambient_sfxs[i];
1014 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1015 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1016 channels[i].basevolume = 0.0f;
1017 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1021 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1022 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1023 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1031 void S_PurgeUnused(void)
1036 // Free all not-precached per-level sfx
1037 for (sfx = known_sfx;sfx;sfx = sfxnext)
1039 sfxnext = sfx->next;
1040 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1041 S_FreeSfx (sfx, false);
1051 sfx_t *S_PrecacheSound (const char *name, qbool complain, qbool levelsound)
1055 if (!snd_initialized.integer)
1058 if (name == NULL || name[0] == 0)
1061 sfx = S_FindName (name);
1066 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1067 // previously missing file
1068 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1070 // set a flag to indicate this has been precached for this level or permanently
1072 sfx->flags |= SFXFLAG_LEVELSOUND;
1074 sfx->flags |= SFXFLAG_MENUSOUND;
1076 if (!nosound.integer && snd_precache.integer)
1077 S_LoadSound(sfx, complain);
1088 float S_SoundLength(const char *name)
1092 if (!snd_initialized.integer)
1094 if (name == NULL || name[0] == 0)
1097 sfx = S_FindName(name);
1100 return sfx->total_length / (float) S_GetSoundRate();
1108 qbool S_IsSoundPrecached (const sfx_t *sfx)
1110 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1118 void S_BlockSound (void)
1129 void S_UnblockSound (void)
1139 Picks a channel based on priorities, empty slots, number of channels
1142 static channel_t *SND_PickChannel(int entnum, int entchannel)
1146 int first_life_left, life_left;
1148 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1150 // Check for replacement sound, or find the best one to replace
1152 first_life_left = 0x7fffffff;
1154 // entity channels try to replace the existing sound on the channel
1155 // channels <= 0 are autochannels
1156 if (IS_CHAN_SINGLE(entchannel))
1158 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1160 ch = &channels[ch_idx];
1161 if (ch->entnum == entnum && ch->entchannel == entchannel)
1163 // always override sound from same entity
1164 S_StopChannel (ch_idx, true, false);
1165 return &channels[ch_idx];
1170 // there was no channel to override, so look for the first empty one
1171 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1173 ch = &channels[ch_idx];
1174 sfx = ch->sfx; // fetch the volatile variable
1177 // no sound on this channel
1178 first_to_die = ch_idx;
1179 goto emptychan_found;
1182 // don't let monster sounds override player sounds
1183 if ((ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity()) && !(entnum == cl.viewentity || entnum == CL_VM_GetViewEntity()))
1186 // don't override looped sounds
1187 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1189 life_left = (int)((double)sfx->total_length - ch->position);
1191 if (life_left < first_life_left)
1193 first_life_left = life_left;
1194 first_to_die = ch_idx;
1198 if (first_to_die == -1)
1201 S_StopChannel (first_to_die, true, false);
1204 return &channels[first_to_die];
1211 Spatializes a channel
1214 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1215 static void SND_Spatialize_WithSfx(channel_t *ch, qbool isstatic, sfx_t *sfx)
1219 float angle_side, angle_front, angle_factor, mixspeed;
1220 vec_t dist, mastervol, intensity;
1224 // update sound origin if we know about the entity
1225 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1227 if (ch->entnum >= MAX_EDICTS)
1229 //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]);
1231 if (CLVM_prog->loaded && ch->entnum > MAX_EDICTS)
1232 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1233 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1235 else if (cl.entities[ch->entnum].state_current.active)
1238 //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]);
1239 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1240 if (model && model->soundfromcenter)
1241 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1243 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1245 else if (CLVM_prog->loaded && cl.csqc_server2csqcentitynumber[ch->entnum])
1247 //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]);
1249 if (!CL_VM_GetEntitySoundOrigin(cl.csqc_server2csqcentitynumber[ch->entnum] + MAX_EDICTS, ch->origin))
1250 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1254 mastervol = ch->basevolume;
1255 mixspeed = ch->basespeed;
1257 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1259 // Adjust volume of static sounds
1261 mastervol *= snd_staticvolume.value;
1262 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1264 // old legacy separated cvars
1265 if(ch->entnum >= MAX_EDICTS)
1267 switch(ch->entchannel)
1269 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1270 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1271 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1272 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1273 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1274 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1275 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1276 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1280 else if(ch->entnum == 0)
1282 switch(ch->entchannel)
1284 case 0: mastervol *= snd_worldchannel0volume.value; break;
1285 case 1: mastervol *= snd_worldchannel1volume.value; break;
1286 case 2: mastervol *= snd_worldchannel2volume.value; break;
1287 case 3: mastervol *= snd_worldchannel3volume.value; break;
1288 case 4: mastervol *= snd_worldchannel4volume.value; break;
1289 case 5: mastervol *= snd_worldchannel5volume.value; break;
1290 case 6: mastervol *= snd_worldchannel6volume.value; break;
1291 case 7: mastervol *= snd_worldchannel7volume.value; break;
1295 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1297 switch(ch->entchannel)
1299 case 0: mastervol *= snd_playerchannel0volume.value; break;
1300 case 1: mastervol *= snd_playerchannel1volume.value; break;
1301 case 2: mastervol *= snd_playerchannel2volume.value; break;
1302 case 3: mastervol *= snd_playerchannel3volume.value; break;
1303 case 4: mastervol *= snd_playerchannel4volume.value; break;
1304 case 5: mastervol *= snd_playerchannel5volume.value; break;
1305 case 6: mastervol *= snd_playerchannel6volume.value; break;
1306 case 7: mastervol *= snd_playerchannel7volume.value; break;
1312 switch(ch->entchannel)
1314 case 0: mastervol *= snd_entchannel0volume.value; break;
1315 case 1: mastervol *= snd_entchannel1volume.value; break;
1316 case 2: mastervol *= snd_entchannel2volume.value; break;
1317 case 3: mastervol *= snd_entchannel3volume.value; break;
1318 case 4: mastervol *= snd_entchannel4volume.value; break;
1319 case 5: mastervol *= snd_entchannel5volume.value; break;
1320 case 6: mastervol *= snd_entchannel6volume.value; break;
1321 case 7: mastervol *= snd_entchannel7volume.value; break;
1326 switch(ch->entchannel)
1328 case 0: mastervol *= snd_channel0volume.value; break;
1329 case 1: mastervol *= snd_channel1volume.value; break;
1330 case 2: mastervol *= snd_channel2volume.value; break;
1331 case 3: mastervol *= snd_channel3volume.value; break;
1332 case 4: mastervol *= snd_channel4volume.value; break;
1333 case 5: mastervol *= snd_channel5volume.value; break;
1334 case 6: mastervol *= snd_channel6volume.value; break;
1335 case 7: mastervol *= snd_channel7volume.value; break;
1336 default: mastervol *= Cvar_VariableValueOr(&cvars_all, va(vabuf, sizeof(vabuf), "snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0, ~0); break;
1340 // If this channel does not manage its own volume (like CD tracks)
1341 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1342 mastervol *= volume.value;
1344 if(snd_maxchannelvolume.value > 0)
1346 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1347 mastervol = bound(0.0f, mastervol, 10.0f * snd_maxchannelvolume.value);
1350 // always apply "master"
1351 mastervol *= mastervolume.value;
1353 // add in ReplayGain very late; prevent clipping when close
1355 if(sfx->volume_peak > 0)
1357 // Replaygain support
1358 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1359 mastervol *= sfx->volume_mult;
1360 if(snd_maxchannelvolume.value > 0)
1362 if(mastervol * sfx->volume_peak > snd_maxchannelvolume.value)
1363 mastervol = snd_maxchannelvolume.value / sfx->volume_peak;
1365 // Con_DPrintf("%f\n", fvol);
1368 if(snd_maxchannelvolume.value > 0)
1370 // clamp HERE to keep relative volumes of the channels correct
1371 mastervol = min(mastervol, snd_maxchannelvolume.value);
1374 mastervol = max(0.0f, mastervol);
1376 ch->mixspeed = mixspeed;
1378 // anything coming from the view entity will always be full volume
1379 // LadyHavoc: make sounds with ATTN_NONE have no spatialization
1380 if (ch->entnum == cl.viewentity || ch->entnum == CL_VM_GetViewEntity() || ch->distfade == 0)
1382 ch->prologic_invert = 1;
1383 if (snd_spatialization_prologic.integer != 0)
1385 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1386 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1387 for (i = 2;i < SND_LISTENERS;i++)
1392 for (i = 0;i < SND_LISTENERS;i++)
1393 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1398 // calculate stereo seperation and distance attenuation
1399 VectorSubtract(listener_origin, ch->origin, source_vec);
1400 dist = VectorLength(source_vec);
1401 f = dist * ch->distfade;
1404 ((snd_attenuation_exponent.value == 0) ? 1.0 : pow(1.0 - min(1.0, f), (double)snd_attenuation_exponent.value))
1406 ((snd_attenuation_decibel.value == 0) ? 1.0 : pow(0.1, 0.1 * snd_attenuation_decibel.value * f));
1408 intensity = mastervol * f;
1411 qbool occluded = false;
1412 if (snd_spatialization_occlusion.integer)
1414 if(snd_spatialization_occlusion.integer & 1)
1415 if(listener_pvs && cl.worldmodel)
1417 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1418 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1422 if(snd_spatialization_occlusion.integer & 2)
1424 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin, ch->origin, ch->origin))
1430 ch->prologic_invert = 1;
1431 if (snd_spatialization_prologic.integer != 0)
1434 angle_factor = 0.5f;
1437 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1438 VectorNormalize(source_vec);
1440 switch(spatialmethod)
1444 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1446 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1447 VectorScale(source_vec, f, source_vec);
1450 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1451 f = spatialmin + spatialdiff * bound(0, f, 1);
1452 VectorScale(source_vec, f, source_vec);
1454 case SPATIAL_THRESH:
1455 f = spatialmin + spatialdiff * (dist < spatialoffset);
1456 VectorScale(source_vec, f, source_vec);
1463 // 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
1465 VectorNormalize(source_vec);
1466 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1467 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1468 if (angle_side > snd_spatialization_prologic_frontangle.value)
1470 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1471 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1472 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1473 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1474 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1475 if (angle_front > 0)
1476 angle_factor = 1 - angle_factor;
1479 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1480 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1483 ch->volume[0] = intensity * sqrt(angle_factor);
1484 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1485 for (i = 2;i < SND_LISTENERS;i++)
1490 for (i = 0;i < SND_LISTENERS;i++)
1492 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1493 VectorNormalize(source_vec);
1495 switch(spatialmethod)
1499 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1501 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1502 VectorScale(source_vec, f, source_vec);
1505 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1506 f = spatialmin + spatialdiff * bound(0, f, 1);
1507 VectorScale(source_vec, f, source_vec);
1509 case SPATIAL_THRESH:
1510 f = spatialmin + spatialdiff * (dist < spatialoffset);
1511 VectorScale(source_vec, f, source_vec);
1518 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1523 for (i = 0;i < SND_LISTENERS;i++)
1527 static void SND_Spatialize(channel_t *ch, qbool isstatic)
1529 sfx_t *sfx = ch->sfx;
1530 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1534 // =======================================================================
1535 // Start a sound effect
1536 // =======================================================================
1538 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)
1542 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1546 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1548 if(!snd_startloopingsounds.integer)
1553 if(!snd_startnonloopingsounds.integer)
1557 // Initialize the channel
1558 // a crash was reported on an in-use channel, so check here...
1559 if (target_chan->sfx)
1561 int channelindex = (int)(target_chan - channels);
1562 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1563 S_StopChannel (channelindex, true, false);
1565 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1566 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1567 memset (target_chan, 0, sizeof (*target_chan));
1568 VectorCopy (origin, target_chan->origin);
1569 target_chan->flags = flags;
1570 target_chan->position = startpos; // start of the sound
1571 target_chan->entnum = entnum;
1572 target_chan->entchannel = entchannel;
1574 // If it's a static sound
1577 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1578 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1579 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1582 target_chan->distfade = attenuation / snd_soundradius.value;
1584 // set the listener volumes
1585 S_SetChannelVolume(target_chan - channels, fvol);
1586 S_SetChannelSpeed(target_chan - channels, fspeed);
1587 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1589 // finally, set the sfx pointer, so the channel becomes valid for playback
1590 // and will be noticed by the mixer
1591 target_chan->sfx = sfx;
1595 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)
1597 channel_t *target_chan, *check, *ch;
1598 int ch_idx, startpos, i;
1600 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1603 if(sfx == &changevolume_sfx)
1605 if (!IS_CHAN_SINGLE(entchannel))
1607 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1609 ch = &channels[ch_idx];
1610 if (ch->entnum == entnum && ch->entchannel == entchannel)
1612 S_SetChannelVolume(ch_idx, fvol);
1613 S_SetChannelSpeed(ch_idx, fspeed);
1614 for(i = 1; i > 0 && (i <= flags || i <= (int) channels[ch_idx].flags); i <<= 1)
1615 if((flags ^ channels[ch_idx].flags) & i)
1616 S_SetChannelFlag(ch_idx, i, (flags & i) != 0);
1617 ch->distfade = attenuation / snd_soundradius.value;
1618 SND_Spatialize(ch, false);
1625 if (sfx->fetcher == NULL)
1628 // Pick a channel to play on
1629 target_chan = SND_PickChannel(entnum, entchannel);
1633 // if an identical sound has also been started this frame, offset the pos
1634 // a bit to keep it from just making the first one louder
1635 check = &channels[NUM_AMBIENTS];
1636 startpos = (int)(startposition * sfx->format.speed);
1639 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1641 if (check == target_chan)
1643 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1645 // calculate max offset
1646 float maxtime = snd_identicalsoundrandomization_time.value;
1647 float maxtics = snd_identicalsoundrandomization_tics.value;
1648 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1650 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1653 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1655 // use negative pos offset to delay this sound effect
1656 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1662 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1664 return (target_chan - channels);
1667 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1669 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, 0, CHANNELFLAG_NONE, 1.0f);
1672 void S_StopChannel (unsigned int channel_ind, qbool lockmutex, qbool freesfx)
1677 if (channel_ind >= total_channels)
1680 // we have to lock an audio mutex to prevent crashes if an audio mixer
1681 // thread is currently mixing this channel
1682 // the SndSys_LockRenderBuffer function uses such a mutex in
1683 // threaded sound backends
1684 if (lockmutex && !simsound)
1685 SndSys_LockRenderBuffer();
1687 ch = &channels[channel_ind];
1691 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1692 sfx->fetcher->stopchannel(ch);
1693 ch->fetcher_data = NULL;
1696 S_FreeSfx(sfx, true);
1698 if (lockmutex && !simsound)
1699 SndSys_UnlockRenderBuffer();
1703 qbool S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qbool value)
1705 if (ch_ind >= total_channels)
1708 if (flag != CHANNELFLAG_FORCELOOP &&
1709 flag != CHANNELFLAG_PAUSED &&
1710 flag != CHANNELFLAG_FULLVOLUME &&
1711 flag != CHANNELFLAG_LOCALSOUND)
1715 channels[ch_ind].flags |= flag;
1717 channels[ch_ind].flags &= ~flag;
1722 void S_StopSound(int entnum, int entchannel)
1726 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1727 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1729 S_StopChannel (i, true, false);
1734 void S_StopAllSounds(void)
1738 // TOCHECK: is this test necessary?
1739 if (snd_renderbuffer == NULL)
1742 // stop CD audio because it may be using a faketrack
1745 if (simsound || SndSys_LockRenderBuffer ())
1750 for (i = 0; i < total_channels; i++)
1751 if (channels[i].sfx)
1752 S_StopChannel (i, false, false);
1754 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1755 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1757 // Mute the contents of the submittion buffer
1758 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1759 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1760 memset(snd_renderbuffer->ring, clear, memsize);
1763 SndSys_UnlockRenderBuffer ();
1767 void S_StopAllSounds_f(cmd_state_t *cmd)
1773 void S_PauseGameSounds (qbool toggle)
1777 for (i = 0; i < total_channels; i++)
1782 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1783 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1787 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1789 channels[ch_ind].basevolume = fvol;
1792 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1794 channels[ch_ind].basespeed = fspeed;
1797 float S_GetChannelPosition (unsigned int ch_ind)
1799 // note: this is NOT accurate yet
1801 channel_t *ch = &channels[ch_ind];
1802 sfx_t *sfx = ch->sfx;
1806 s = ch->position / sfx->format.speed;
1808 if(!snd_usethreadedmixing)
1809 s += _snd_mixahead.value;
1814 float S_GetEntChannelPosition(int entnum, int entchannel)
1819 for (i = 0; i < total_channels; i++)
1822 if (ch->entnum == entnum && ch->entchannel == entchannel)
1823 return S_GetChannelPosition(i);
1825 return -1; // no playing sound in this channel
1833 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1835 channel_t *target_chan;
1837 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1841 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1845 if (total_channels == MAX_CHANNELS)
1847 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1851 target_chan = &channels[total_channels++];
1852 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1857 S_UpdateAmbientSounds
1860 static void S_UpdateAmbientSounds (void)
1864 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1865 int ambient_channel;
1867 unsigned char ambientlevels[NUM_AMBIENTS];
1870 memset(ambientlevels, 0, sizeof(ambientlevels));
1871 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1872 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1875 // Calc ambient sound levels
1876 S_SetUnderwaterIntensity();
1878 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1880 chan = &channels[ambient_channel];
1881 sfx = chan->sfx; // fetch the volatile variable
1882 if (sfx == NULL || sfx->fetcher == NULL)
1885 i = ambientlevels[ambient_channel];
1888 vol = i * (1.0f / 256.0f);
1890 // Don't adjust volume too fast
1891 if (chan->basevolume < vol)
1893 chan->basevolume += fade;
1894 if (chan->basevolume > vol)
1895 chan->basevolume = vol;
1897 else if (chan->basevolume > vol)
1899 chan->basevolume -= fade;
1900 if (chan->basevolume < vol)
1901 chan->basevolume = vol;
1904 if (snd_spatialization_prologic.integer != 0)
1906 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1907 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1908 for (i = 2;i < SND_LISTENERS;i++)
1909 chan->volume[i] = 0.0f;
1913 for (i = 0;i < SND_LISTENERS;i++)
1914 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1919 static void S_PaintAndSubmit (void)
1921 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1922 int usesoundtimehack;
1923 static int soundtimehack = -1;
1924 static int oldsoundtime = 0;
1926 if (snd_renderbuffer == NULL || nosound.integer)
1929 // Update sound time
1930 snd_usethreadedmixing = false;
1931 usesoundtimehack = true;
1932 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1934 usesoundtimehack = 1;
1935 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1937 #ifdef CONFIG_VIDEO_CAPTURE
1938 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1940 usesoundtimehack = 2;
1941 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1946 usesoundtimehack = 3;
1947 newsoundtime = (unsigned int)((host.realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1951 #ifdef CONFIG_VIDEO_CAPTURE
1952 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1954 snd_usethreadedmixing = snd_threaded;
1956 usesoundtimehack = 0;
1957 newsoundtime = SndSys_GetSoundTime();
1959 // if the soundtimehack state changes we need to reset the soundtime
1960 if (soundtimehack != usesoundtimehack)
1962 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1964 // Mute the contents of the submission buffer
1965 if (simsound || SndSys_LockRenderBuffer ())
1970 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1971 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1972 memset(snd_renderbuffer->ring, clear, memsize);
1975 SndSys_UnlockRenderBuffer ();
1978 soundtimehack = usesoundtimehack;
1980 if (!soundtimehack && snd_blocked > 0)
1983 if (snd_usethreadedmixing)
1984 return; // the audio thread will mix its own data
1986 newsoundtime += extrasoundtime;
1987 if (newsoundtime < soundtime)
1989 #ifdef CONFIG_VIDEO_CAPTURE
1990 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1992 unsigned int additionaltime;
1994 // add some time to extrasoundtime make newsoundtime higher
1996 // The extra time must be a multiple of the render buffer size
1997 // to avoid modifying the current position in the buffer,
1998 // some modules write directly to a shared (DMA) buffer
1999 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
2000 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
2002 extrasoundtime += additionaltime;
2003 newsoundtime += additionaltime;
2004 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2007 else if (!soundtimehack)
2011 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2012 newsoundtime, soundtime);
2014 soundtime = newsoundtime;
2015 #ifdef CONFIG_VIDEO_CAPTURE
2016 recording_sound = (cls.capturevideo.soundrate != 0);
2019 // Lock submitbuffer
2020 if (!simsound && !SndSys_LockRenderBuffer())
2022 // If the lock failed, stop here
2023 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2027 // Check to make sure that we haven't overshot
2028 paintedtime = snd_renderbuffer->endframe;
2029 if (paintedtime < soundtime)
2030 paintedtime = soundtime;
2032 // mix ahead of current position
2034 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2036 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2037 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2038 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2039 endtime = min(endtime, maxtime);
2041 while (paintedtime < endtime)
2043 unsigned int startoffset;
2044 unsigned int nbframes;
2046 // see how much we can fit in the paint buffer
2047 nbframes = endtime - paintedtime;
2048 // limit to the end of the ring buffer (in case of wrapping)
2049 startoffset = paintedtime % snd_renderbuffer->maxframes;
2050 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2052 // mix into the buffer
2053 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2055 paintedtime += nbframes;
2056 snd_renderbuffer->endframe = paintedtime;
2059 SndSys_UnlockRenderBuffer();
2061 // Remove outdated samples from the ring buffer, if any
2062 if (snd_renderbuffer->startframe < soundtime)
2063 snd_renderbuffer->startframe = soundtime;
2066 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2070 oldsoundtime = soundtime;
2072 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2073 R_TimeReport("audiomix");
2080 Called once each time through the main loop
2083 void S_Update(const matrix4x4_t *listenermatrix)
2085 unsigned int i, j, k;
2086 channel_t *ch, *combine;
2087 matrix4x4_t rotatematrix;
2089 if (snd_renderbuffer == NULL || nosound.integer)
2093 double mindist_trans, maxdist_trans;
2095 spatialmin = snd_spatialization_min.value;
2096 spatialdiff = snd_spatialization_max.value - spatialmin;
2098 if(snd_spatialization_control.value)
2100 spatialpower = snd_spatialization_power.value;
2102 if(spatialpower == 0)
2104 spatialmethod = SPATIAL_LOG;
2105 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2106 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2110 spatialmethod = SPATIAL_POW;
2111 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2112 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2115 if(mindist_trans - maxdist_trans == 0)
2117 spatialmethod = SPATIAL_THRESH;
2118 mindist_trans = snd_spatialization_min_radius.value;
2122 spatialoffset = mindist_trans;
2123 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2127 spatialmethod = SPATIAL_NONE;
2131 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2132 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2133 current_channellayout != snd_channellayout.integer)
2134 S_SetChannelLayout();
2136 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2137 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2138 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2139 listener_pvsbytes = cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, &listener_pvs, snd_mempool, 0);
2144 Mem_Free(listener_pvs);
2145 listener_pvs = NULL;
2147 listener_pvsbytes = 0;
2150 // calculate the current matrices
2151 for (j = 0;j < SND_LISTENERS;j++)
2153 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2154 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2155 // I think this should now do this:
2156 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2157 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2158 // angle has to be taken negative)
2159 // 2. create a transform which first rotates and moves its argument
2160 // into the player's view coordinates (using basematrix which is
2161 // an inverted "absolute" listener matrix), then applies the
2162 // rotation matrix for the ear
2163 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2164 // does not actually refer to an entity?
2167 // update general area ambient sound sources
2168 S_UpdateAmbientSounds ();
2171 R_TimeReport("audioprep");
2173 // update spatialization for static and dynamic sounds
2174 cls.soundstats.totalsounds = 0;
2175 cls.soundstats.mixedsounds = 0;
2176 ch = channels+NUM_AMBIENTS;
2177 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2181 cls.soundstats.totalsounds++;
2183 // respatialize channel
2184 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2186 // try to combine static sounds with a previous channel of the same
2187 // sound effect so we don't mix five torches every frame
2188 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2190 // no need to merge silent channels
2191 for (j = 0;j < SND_LISTENERS;j++)
2194 if (j == SND_LISTENERS)
2196 // if the last combine chosen isn't suitable, find a new one
2197 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2201 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2203 if (channels[j].sfx == ch->sfx)
2205 combine = channels + j;
2210 if (combine && combine != ch && combine->sfx == ch->sfx)
2212 for (j = 0;j < SND_LISTENERS;j++)
2214 combine->volume[j] += ch->volume[j];
2219 for (k = 0;k < SND_LISTENERS;k++)
2222 if (k < SND_LISTENERS)
2223 cls.soundstats.mixedsounds++;
2225 R_TimeReport("audiospatialize");
2227 sound_spatialized = true;
2230 if (snd_show.integer)
2231 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2236 void S_ExtraUpdate (void)
2238 if (snd_noextraupdate.integer || !sound_spatialized)
2244 qbool S_LocalSoundEx (const char *sound, int chan, float fvol)
2249 if (!snd_initialized.integer || nosound.integer)
2252 sfx = S_PrecacheSound (sound, true, false);
2255 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2259 // menu sounds must not be freed on level change
2260 sfx->flags |= SFXFLAG_MENUSOUND;
2262 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2263 // which we no longer support anyway
2264 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2265 ch_ind = S_StartSound (cl.viewentity, chan, sfx, vec3_origin, fvol, 0);
2269 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
2273 qbool S_LocalSound (const char *sound)
2275 return S_LocalSoundEx(sound, 0, 1);