2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
26 #include "snd_modplug.h"
28 #include "cl_collision.h"
32 #define SND_MIN_SPEED 8000
33 #define SND_MAX_SPEED 192000
34 #define SND_MIN_WIDTH 1
35 #define SND_MAX_WIDTH 2
36 #define SND_MIN_CHANNELS 1
37 #define SND_MAX_CHANNELS 8
38 #if SND_LISTENERS != 8
39 # error this data only supports up to 8 channel, update it!
42 speakerlayout_t snd_speakerlayout;
44 // Our speaker layouts are based on ALSA. They differ from those
45 // Win32 and Mac OS X APIs use when there's more than 4 channels.
46 // (rear left + rear right, and front center + LFE are swapped).
47 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
48 static const speakerlayout_t snd_speakerlayouts[] =
53 {0, 45, 0.2, 0.2, 0.5}, // front left
54 {1, 315, 0.2, 0.2, 0.5}, // front right
55 {2, 135, 0.2, 0.2, 0.5}, // rear left
56 {3, 225, 0.2, 0.2, 0.5}, // rear right
57 {4, 0, 0.2, 0.2, 0.5}, // front center
58 {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)
59 {6, 90, 0.2, 0.2, 0.5}, // side left
60 {7, 180, 0.2, 0.2, 0.5}, // side right
66 {0, 45, 0.2, 0.2, 0.5}, // front left
67 {1, 315, 0.2, 0.2, 0.5}, // front right
68 {2, 135, 0.2, 0.2, 0.5}, // rear left
69 {3, 225, 0.2, 0.2, 0.5}, // rear right
70 {4, 0, 0.2, 0.2, 0.5}, // front center
71 {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)
77 // these systems sometimes have a subwoofer as well, but it has no
81 {0, 45, 0.3, 0.3, 0.8}, // front left
82 {1, 315, 0.3, 0.3, 0.8}, // front right
83 {2, 135, 0.3, 0.3, 0.8}, // rear left
84 {3, 225, 0.3, 0.3, 0.8}, // rear right
92 // these systems sometimes have a subwoofer as well, but it has no
96 {0, 90, 0.5, 0.5, 1}, // side left
97 {1, 270, 0.5, 0.5, 1}, // side right
109 {0, 0, 0, 1, 1}, // center
122 // =======================================================================
123 // Internal sound data & structures
124 // =======================================================================
126 channel_t channels[MAX_CHANNELS];
127 unsigned int total_channels;
129 snd_ringbuffer_t *snd_renderbuffer = NULL;
130 static unsigned int soundtime = 0;
131 static unsigned int oldpaintedtime = 0;
132 static unsigned int extrasoundtime = 0;
133 static double snd_starttime = 0.0;
134 qboolean snd_threaded = false;
135 qboolean snd_usethreadedmixing = false;
137 vec3_t listener_origin;
138 matrix4x4_t listener_basematrix;
139 static unsigned char *listener_pvs = NULL;
140 static int listener_pvsbytes = 0;
141 matrix4x4_t listener_matrix[SND_LISTENERS];
142 mempool_t *snd_mempool;
144 // Linked list of known sfx
145 static sfx_t *known_sfx = NULL;
147 static qboolean sound_spatialized = false;
149 qboolean simsound = false;
151 static qboolean recording_sound = false;
154 static int current_swapstereo = false;
155 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
156 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
158 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
159 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
160 spatialmethod_t spatialmethod;
162 // Cvars declared in sound.h (part of the sound API)
163 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
164 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
165 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
166 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
167 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
168 cvar_t snd_soundradius = {CVAR_SAVE, "snd_soundradius", "1200", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
169 cvar_t snd_attenuation_exponent = {CVAR_SAVE, "snd_attenuation_exponent", "1", "Exponent of (1-radius) in sound attenuation formula"};
170 cvar_t snd_attenuation_decibel = {CVAR_SAVE, "snd_attenuation_decibel", "0", "Decibel sound attenuation per sound radius distance"};
171 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
172 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
173 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
174 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
175 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
176 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
177 cvar_t snd_spatialization_prologic = {CVAR_SAVE, "snd_spatialization_prologic", "0", "use dolby prologic (I, II or IIx) encoding (snd_channels must be 2)"};
178 cvar_t snd_spatialization_prologic_frontangle = {CVAR_SAVE, "snd_spatialization_prologic_frontangle", "30", "the angle between the front speakers and the center speaker"};
179 cvar_t snd_spatialization_occlusion = {CVAR_SAVE, "snd_spatialization_occlusion", "1", "enable occlusion testing on spatialized sounds, which simply quiets sounds that are blocked by the world; 1 enables PVS method, 2 enables LineOfSight method, 3 enables both"};
181 // Cvars declared in snd_main.h (shared with other snd_*.c files)
182 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
183 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory); when set to 2, streaming is performed even if this would waste memory"};
184 cvar_t snd_streaming_length = { CVAR_SAVE, "snd_streaming_length", "1", "decompress sounds completely if they are less than this play time when snd_streaming is 1"};
185 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
186 extern cvar_t v_flipped;
187 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
188 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
189 cvar_t snd_maxchannelvolume = {CVAR_SAVE, "snd_maxchannelvolume", "10", "maximum volume of a single sound"};
190 cvar_t snd_softclip = {CVAR_SAVE, "snd_softclip", "0", "Use soft-clipping. Soft-clipping can make the sound more smooth if very high volume levels are used. Enable this option if the dynamic range of the loudspeakers is very low. WARNING: This feature creates distortion and should be considered a last resort."};
191 //cvar_t snd_softclip = {CVAR_SAVE, "snd_softclip", "0", "Use soft-clipping (when set to 2, use it even if output is floating point). Soft-clipping can make the sound more smooth if very high volume levels are used. Enable this option if the dynamic range of the loudspeakers is very low. WARNING: This feature creates distortion and should be considered a last resort."};
192 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities (DEPRECATED)"};
193 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities (DEPRECATED)"};
194 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities (DEPRECATED)"};
195 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities (DEPRECATED)"};
196 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities (DEPRECATED)"};
197 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities (DEPRECATED)"};
198 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities (DEPRECATED)"};
199 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities (DEPRECATED)"};
200 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities (DEPRECATED)"};
201 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities (DEPRECATED)"};
202 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities (DEPRECATED)"};
203 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities (DEPRECATED)"};
204 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities (DEPRECATED)"};
205 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities (DEPRECATED)"};
206 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities (DEPRECATED)"};
207 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities (DEPRECATED)"};
208 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity (DEPRECATED)"};
209 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity (DEPRECATED)"};
210 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity (DEPRECATED)"};
211 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity (DEPRECATED)"};
212 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity (DEPRECATED)"};
213 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity (DEPRECATED)"};
214 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity (DEPRECATED)"};
215 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity (DEPRECATED)"};
216 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel CSQC entities (DEPRECATED)"};
217 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of CSQC entities (DEPRECATED)"};
218 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of CSQC entities (DEPRECATED)"};
219 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of CSQC entities (DEPRECATED)"};
220 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of CSQC entities (DEPRECATED)"};
221 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of CSQC entities (DEPRECATED)"};
222 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of CSQC entities (DEPRECATED)"};
223 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of CSQC entities (DEPRECATED)"};
224 cvar_t snd_channel0volume = {CVAR_SAVE, "snd_channel0volume", "1", "volume multiplier of the auto-allocate entity channel"};
225 cvar_t snd_channel1volume = {CVAR_SAVE, "snd_channel1volume", "1", "volume multiplier of the 1st entity channel"};
226 cvar_t snd_channel2volume = {CVAR_SAVE, "snd_channel2volume", "1", "volume multiplier of the 2nd entity channel"};
227 cvar_t snd_channel3volume = {CVAR_SAVE, "snd_channel3volume", "1", "volume multiplier of the 3rd entity channel"};
228 cvar_t snd_channel4volume = {CVAR_SAVE, "snd_channel4volume", "1", "volume multiplier of the 4th entity channel"};
229 cvar_t snd_channel5volume = {CVAR_SAVE, "snd_channel5volume", "1", "volume multiplier of the 5th entity channel"};
230 cvar_t snd_channel6volume = {CVAR_SAVE, "snd_channel6volume", "1", "volume multiplier of the 6th entity channel"};
231 cvar_t snd_channel7volume = {CVAR_SAVE, "snd_channel7volume", "1", "volume multiplier of the 7th entity channel"};
234 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
235 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
236 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
237 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
238 static cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0", "disables extra sound mixer calls that are meant to reduce the chance of sound breakup at very low framerates"};
239 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
241 // Default sound format is 48KHz, 16-bit, stereo
242 // (48KHz because a lot of onboard sound cards sucks at any other speed)
243 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
244 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
245 static cvar_t snd_channels = {CVAR_SAVE, "snd_channels", "2", "number of channels for the sound output (2 for stereo; up to 8 supported for 3D sound)"};
247 static cvar_t snd_startloopingsounds = {0, "snd_startloopingsounds", "1", "whether to start sounds that would loop (you want this to be 1); existing sounds are not affected"};
248 static cvar_t snd_startnonloopingsounds = {0, "snd_startnonloopingsounds", "1", "whether to start sounds that would not loop (you want this to be 1); existing sounds are not affected"};
251 static cvar_t snd_identicalsoundrandomization_time = {0, "snd_identicalsoundrandomization_time", "0.1", "how much seconds to randomly skip (positive) or delay (negative) sounds when multiple identical sounds are started on the same frame"};
252 static cvar_t snd_identicalsoundrandomization_tics = {0, "snd_identicalsoundrandomization_tics", "0", "if nonzero, how many tics to limit sound randomization as defined by snd_identicalsoundrandomization_time"};
255 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
256 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
259 // ====================================================================
261 // ====================================================================
263 void S_FreeSfx (sfx_t *sfx, qboolean force);
265 static void S_Play_Common (float fvol, float attenuation)
268 char name [MAX_QPATH];
272 while (i < Cmd_Argc ())
274 // Get the name, and appends ".wav" as an extension if there's none
275 strlcpy (name, Cmd_Argv (i), sizeof (name));
276 if (!strrchr (name, '.'))
277 strlcat (name, ".wav", sizeof (name));
280 // If we need to get the volume from the command line
283 fvol = atof (Cmd_Argv (i));
287 sfx = S_PrecacheSound (name, true, true);
290 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
292 // Free the sfx if the file didn't exist
294 S_FreeSfx (sfx, false);
296 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
301 static void S_Play_f(void)
303 S_Play_Common (1.0f, 1.0f);
306 static void S_Play2_f(void)
308 S_Play_Common (1.0f, 0.0f);
311 static void S_PlayVol_f(void)
313 S_Play_Common (-1.0f, 0.0f);
316 static void S_SoundList_f (void)
323 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
325 if (sfx->fetcher != NULL)
330 Con_Printf ("%c%c%c(%5iHz %2db %6s) %8i : %s\n",
331 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
332 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
333 (sfx->flags & SFXFLAG_MENUSOUND) ? 'P' : ' ',
335 sfx->format.width * 8,
336 (sfx->format.channels == 1) ? "mono" : "stereo",
342 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
344 Con_Printf("Total resident: %i\n", total);
348 static void S_SoundInfo_f(void)
350 if (snd_renderbuffer == NULL)
352 Con_Print("sound system not started\n");
356 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
357 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
358 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
359 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
360 Con_Printf("%5u total_channels\n", total_channels);
364 int S_GetSoundRate(void)
366 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
369 int S_GetSoundChannels(void)
371 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
375 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
377 static const snd_format_t thresholds [] =
379 // speed width channels
380 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
386 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
388 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
389 unsigned int speed_level, width_level, channels_level;
391 // If we have reached the minimum values, there's nothing more we can do
392 if ((format->speed == thresholds[0].speed || fixed_speed) &&
393 (format->width == thresholds[0].width || fixed_width) &&
394 (format->channels == thresholds[0].channels || fixed_channels))
397 // Check the min and max values
398 #define CHECK_BOUNDARIES(param) \
399 if (format->param < thresholds[0].param) \
401 format->param = thresholds[0].param; \
404 if (format->param > thresholds[nb_thresholds - 1].param) \
406 format->param = thresholds[nb_thresholds - 1].param; \
409 CHECK_BOUNDARIES(speed);
410 CHECK_BOUNDARIES(width);
411 CHECK_BOUNDARIES(channels);
412 #undef CHECK_BOUNDARIES
414 // Find the level of each parameter
415 #define FIND_LEVEL(param) \
417 while (param##_level < nb_thresholds - 1) \
419 if (format->param <= thresholds[param##_level].param) \
426 FIND_LEVEL(channels);
429 // Decrease the parameter with the highest level to the previous level
430 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
432 format->channels = thresholds[channels_level - 1].channels;
435 if (speed_level >= width_level && !fixed_speed)
437 format->speed = thresholds[speed_level - 1].speed;
441 format->width = thresholds[width_level - 1].width;
446 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
448 static void S_SetChannelLayout (void)
451 listener_t swaplistener;
452 listener_t *listeners;
455 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
456 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
458 if (i >= SND_SPEAKERLAYOUTS)
460 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
461 snd_renderbuffer->format.channels);
462 i = SND_SPEAKERLAYOUTS - 1;
465 snd_speakerlayout = snd_speakerlayouts[i];
466 listeners = snd_speakerlayout.listeners;
468 // Swap the left and right channels if snd_swapstereo is set
469 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
471 switch (snd_speakerlayout.channels)
474 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
478 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
481 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
492 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
493 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
494 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
496 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
498 // If we're in the sound engine initialization
499 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
501 layout = SND_CHANNELLAYOUT_STANDARD;
502 Cvar_SetValueQuick (&snd_channellayout, layout);
505 layout = current_channellayout_used;
508 layout = snd_channellayout.integer;
510 // Convert our layout (= ALSA) to the standard layout if necessary
511 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
513 if (layout == SND_CHANNELLAYOUT_STANDARD)
515 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
516 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
519 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
520 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
523 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
524 current_channellayout = snd_channellayout.integer;
525 current_channellayout_used = layout;
529 void S_Startup (void)
531 qboolean fixed_speed, fixed_width, fixed_channels;
532 snd_format_t chosen_fmt;
533 static snd_format_t prev_render_format = {0, 0, 0};
540 if (!snd_initialized.integer)
545 fixed_channels = false;
547 // Get the starting sound format from the cvars
548 chosen_fmt.speed = snd_speed.integer;
549 chosen_fmt.width = snd_width.integer;
550 chosen_fmt.channels = snd_channels.integer;
552 // Check the environment variables to see if the player wants a particular sound format
554 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
556 env = getenv("QUAKE_SOUND_CHANNELS");
560 chosen_fmt.channels = atoi (env);
564 fixed_channels = true;
567 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
569 env = getenv("QUAKE_SOUND_SPEED");
573 chosen_fmt.speed = atoi (env);
580 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
582 env = getenv("QUAKE_SOUND_SAMPLEBITS");
586 chosen_fmt.width = atoi (env) / 8;
593 // Parse the command line to see if the player wants a particular sound format
594 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
595 if (COM_CheckParm ("-sndquad") != 0)
597 chosen_fmt.channels = 4;
598 fixed_channels = true;
600 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
601 else if (COM_CheckParm ("-sndstereo") != 0)
603 chosen_fmt.channels = 2;
604 fixed_channels = true;
606 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
607 else if (COM_CheckParm ("-sndmono") != 0)
609 chosen_fmt.channels = 1;
610 fixed_channels = true;
612 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
613 i = COM_CheckParm ("-sndspeed");
614 if (0 < i && i < com_argc - 1)
616 chosen_fmt.speed = atoi (com_argv[i + 1]);
619 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
620 i = COM_CheckParm ("-sndbits");
621 if (0 < i && i < com_argc - 1)
623 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
628 // LordHavoc: now you can with the resampler...
629 // You can't change sound speed after start time (not yet supported)
630 if (prev_render_format.speed != 0)
633 if (chosen_fmt.speed != prev_render_format.speed)
635 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
636 prev_render_format.speed);
637 chosen_fmt.speed = prev_render_format.speed;
643 if (chosen_fmt.speed < SND_MIN_SPEED)
645 chosen_fmt.speed = SND_MIN_SPEED;
648 else if (chosen_fmt.speed > SND_MAX_SPEED)
650 chosen_fmt.speed = SND_MAX_SPEED;
654 if (chosen_fmt.width < SND_MIN_WIDTH)
656 chosen_fmt.width = SND_MIN_WIDTH;
659 else if (chosen_fmt.width > SND_MAX_WIDTH)
661 chosen_fmt.width = SND_MAX_WIDTH;
665 if (chosen_fmt.channels < SND_MIN_CHANNELS)
667 chosen_fmt.channels = SND_MIN_CHANNELS;
668 fixed_channels = false;
670 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
672 chosen_fmt.channels = SND_MAX_CHANNELS;
673 fixed_channels = false;
676 // create the sound buffer used for sumitting the samples to the plaform-dependent module
679 snd_format_t suggest_fmt;
685 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
686 chosen_fmt.speed, chosen_fmt.width * 8,
687 chosen_fmt.channels);
689 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
690 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
694 Con_Printf("S_Startup: sound output initialization FAILED\n");
696 // If the module is suggesting another one
697 if (suggest_fmt.speed != 0)
699 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
700 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
701 suggest_fmt.speed, suggest_fmt.width * 8,
702 suggest_fmt.channels);
704 // Else, try to find a less resource-demanding format
705 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
710 // If we haven't found a suitable format
713 Con_Print("S_Startup: SndSys_Init failed.\n");
714 sound_spatialized = false;
720 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
721 Con_Print ("S_Startup: simulating sound output\n");
724 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
725 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
726 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
729 if (snd_speed.integer != (int)chosen_fmt.speed)
730 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
731 if (snd_width.integer != chosen_fmt.width)
732 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
733 if (snd_channels.integer != chosen_fmt.channels)
734 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
736 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
737 S_SetChannelLayout();
739 snd_starttime = realtime;
741 // If the sound module has already run, add an extra time to make sure
742 // the sound time doesn't decrease, to not confuse playing SFXs
743 if (oldpaintedtime != 0)
745 // The extra time must be a multiple of the render buffer size
746 // to avoid modifying the current position in the buffer,
747 // some modules write directly to a shared (DMA) buffer
748 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
749 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
750 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
752 soundtime = extrasoundtime;
756 snd_renderbuffer->startframe = soundtime;
757 snd_renderbuffer->endframe = soundtime;
758 recording_sound = false;
761 void S_Shutdown(void)
763 if (snd_renderbuffer == NULL)
766 oldpaintedtime = snd_renderbuffer->endframe;
770 Mem_Free(snd_renderbuffer->ring);
771 Mem_Free(snd_renderbuffer);
772 snd_renderbuffer = NULL;
777 sound_spatialized = false;
780 static void S_Restart_f(void)
782 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
783 // So, refuse to do this if we are connected.
784 if(cls.state == ca_connected)
786 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
801 Cvar_RegisterVariable(&volume);
802 Cvar_RegisterVariable(&bgmvolume);
803 Cvar_RegisterVariable(&mastervolume);
804 Cvar_RegisterVariable(&snd_staticvolume);
805 Cvar_RegisterVariable(&snd_entchannel0volume);
806 Cvar_RegisterVariable(&snd_entchannel1volume);
807 Cvar_RegisterVariable(&snd_entchannel2volume);
808 Cvar_RegisterVariable(&snd_entchannel3volume);
809 Cvar_RegisterVariable(&snd_entchannel4volume);
810 Cvar_RegisterVariable(&snd_entchannel5volume);
811 Cvar_RegisterVariable(&snd_entchannel6volume);
812 Cvar_RegisterVariable(&snd_entchannel7volume);
813 Cvar_RegisterVariable(&snd_worldchannel0volume);
814 Cvar_RegisterVariable(&snd_worldchannel1volume);
815 Cvar_RegisterVariable(&snd_worldchannel2volume);
816 Cvar_RegisterVariable(&snd_worldchannel3volume);
817 Cvar_RegisterVariable(&snd_worldchannel4volume);
818 Cvar_RegisterVariable(&snd_worldchannel5volume);
819 Cvar_RegisterVariable(&snd_worldchannel6volume);
820 Cvar_RegisterVariable(&snd_worldchannel7volume);
821 Cvar_RegisterVariable(&snd_playerchannel0volume);
822 Cvar_RegisterVariable(&snd_playerchannel1volume);
823 Cvar_RegisterVariable(&snd_playerchannel2volume);
824 Cvar_RegisterVariable(&snd_playerchannel3volume);
825 Cvar_RegisterVariable(&snd_playerchannel4volume);
826 Cvar_RegisterVariable(&snd_playerchannel5volume);
827 Cvar_RegisterVariable(&snd_playerchannel6volume);
828 Cvar_RegisterVariable(&snd_playerchannel7volume);
829 Cvar_RegisterVariable(&snd_csqcchannel0volume);
830 Cvar_RegisterVariable(&snd_csqcchannel1volume);
831 Cvar_RegisterVariable(&snd_csqcchannel2volume);
832 Cvar_RegisterVariable(&snd_csqcchannel3volume);
833 Cvar_RegisterVariable(&snd_csqcchannel4volume);
834 Cvar_RegisterVariable(&snd_csqcchannel5volume);
835 Cvar_RegisterVariable(&snd_csqcchannel6volume);
836 Cvar_RegisterVariable(&snd_csqcchannel7volume);
837 Cvar_RegisterVariable(&snd_channel0volume);
838 Cvar_RegisterVariable(&snd_channel1volume);
839 Cvar_RegisterVariable(&snd_channel2volume);
840 Cvar_RegisterVariable(&snd_channel3volume);
841 Cvar_RegisterVariable(&snd_channel4volume);
842 Cvar_RegisterVariable(&snd_channel5volume);
843 Cvar_RegisterVariable(&snd_channel6volume);
844 Cvar_RegisterVariable(&snd_channel7volume);
846 Cvar_RegisterVariable(&snd_attenuation_exponent);
847 Cvar_RegisterVariable(&snd_attenuation_decibel);
849 Cvar_RegisterVariable(&snd_spatialization_min_radius);
850 Cvar_RegisterVariable(&snd_spatialization_max_radius);
851 Cvar_RegisterVariable(&snd_spatialization_min);
852 Cvar_RegisterVariable(&snd_spatialization_max);
853 Cvar_RegisterVariable(&snd_spatialization_power);
854 Cvar_RegisterVariable(&snd_spatialization_control);
855 Cvar_RegisterVariable(&snd_spatialization_occlusion);
856 Cvar_RegisterVariable(&snd_spatialization_prologic);
857 Cvar_RegisterVariable(&snd_spatialization_prologic_frontangle);
859 Cvar_RegisterVariable(&snd_speed);
860 Cvar_RegisterVariable(&snd_width);
861 Cvar_RegisterVariable(&snd_channels);
862 Cvar_RegisterVariable(&snd_mutewhenidle);
863 Cvar_RegisterVariable(&snd_maxchannelvolume);
864 Cvar_RegisterVariable(&snd_softclip);
866 Cvar_RegisterVariable(&snd_startloopingsounds);
867 Cvar_RegisterVariable(&snd_startnonloopingsounds);
869 Cvar_RegisterVariable(&snd_identicalsoundrandomization_time);
870 Cvar_RegisterVariable(&snd_identicalsoundrandomization_tics);
872 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
873 if (COM_CheckParm("-nosound"))
875 // dummy out Play and Play2 because mods stuffcmd that
876 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
877 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
881 snd_mempool = Mem_AllocPool("sound", 0, NULL);
883 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
884 if (COM_CheckParm("-simsound"))
887 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
888 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
889 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
890 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
891 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
892 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
893 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
894 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
896 Cvar_RegisterVariable(&nosound);
897 Cvar_RegisterVariable(&snd_precache);
898 Cvar_RegisterVariable(&snd_initialized);
899 Cvar_RegisterVariable(&snd_streaming);
900 Cvar_RegisterVariable(&snd_streaming_length);
901 Cvar_RegisterVariable(&ambient_level);
902 Cvar_RegisterVariable(&ambient_fade);
903 Cvar_RegisterVariable(&snd_noextraupdate);
904 Cvar_RegisterVariable(&snd_show);
905 Cvar_RegisterVariable(&_snd_mixahead);
906 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
907 Cvar_RegisterVariable(&snd_channellayout);
908 Cvar_RegisterVariable(&snd_soundradius);
910 Cvar_SetValueQuick(&snd_initialized, true);
914 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
915 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
918 ModPlug_OpenLibrary ();
926 Shutdown and free all resources
929 void S_Terminate (void)
932 ModPlug_CloseLibrary ();
936 while (known_sfx != NULL)
937 S_FreeSfx (known_sfx, true);
939 Cvar_SetValueQuick (&snd_initialized, false);
940 Mem_FreePool (&snd_mempool);
949 void S_UnloadAllSounds_f (void)
953 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
954 // So, refuse to do this if we are connected.
955 if(cls.state == ca_connected)
957 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
961 // stop any active sounds
964 // because the ambient sounds will be freed, clear the pointers
965 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
966 ambient_sfxs[i] = NULL;
968 // now free all sounds
969 while (known_sfx != NULL)
970 S_FreeSfx (known_sfx, true);
979 sfx_t changevolume_sfx = {""};
980 sfx_t *S_FindName (const char *name)
984 if (!snd_initialized.integer)
987 if(!strcmp(name, changevolume_sfx.name))
988 return &changevolume_sfx;
990 if (strlen (name) >= sizeof (sfx->name))
992 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
996 // Look for this sound in the list of known sfx
997 // TODO: hash table search?
998 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
999 if(!strcmp (sfx->name, name))
1002 // check for # in the beginning, try lookup by soundindex
1003 if (name[0] == '#' && name[1])
1005 int soundindex = atoi(name + 1);
1006 if (soundindex > 0 && soundindex < MAX_SOUNDS)
1007 if (cl.sound_precache[soundindex]->name[0])
1008 return cl.sound_precache[soundindex];
1011 // Add a sfx_t struct for this sound
1012 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
1013 memset (sfx, 0, sizeof(*sfx));
1014 strlcpy (sfx->name, name, sizeof (sfx->name));
1015 sfx->memsize = sizeof(*sfx);
1016 sfx->next = known_sfx;
1028 void S_FreeSfx (sfx_t *sfx, qboolean force)
1032 // Do not free a precached sound during purge
1033 if (!force && (sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1036 if (developer_loading.integer)
1037 Con_Printf ("unloading sound %s\n", sfx->name);
1039 // Remove it from the list of known sfx
1040 if (sfx == known_sfx)
1041 known_sfx = known_sfx->next;
1046 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
1047 if (prev_sfx->next == sfx)
1049 prev_sfx->next = sfx->next;
1052 if (prev_sfx == NULL)
1054 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1059 // Stop all channels using this sfx
1060 for (i = 0; i < total_channels; i++)
1062 if (channels[i].sfx == sfx)
1064 Con_Printf("S_FreeSfx: stopping channel %i for sfx \"%s\"\n", i, sfx->name);
1065 S_StopChannel (i, true, false);
1070 if (sfx->fetcher != NULL && sfx->fetcher->freesfx != NULL)
1071 sfx->fetcher->freesfx(sfx);
1081 void S_ClearUsed (void)
1087 // Start the ambient sounds and make them loop
1088 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1090 // Precache it if it's not done (and pass false for levelsound because these are permanent)
1091 if (ambient_sfxs[i] == NULL)
1092 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, false);
1093 if (ambient_sfxs[i] != NULL)
1095 channels[i].sfx = ambient_sfxs[i];
1096 channels[i].sfx->flags |= SFXFLAG_MENUSOUND;
1097 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1098 channels[i].basevolume = 0.0f;
1099 channels[i].basespeed = channels[i].mixspeed = 1.0f;
1103 // Clear SFXFLAG_LEVELSOUND flag so that sounds not precached this level will be purged
1104 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1105 sfx->flags &= ~SFXFLAG_LEVELSOUND;
1113 void S_PurgeUnused(void)
1118 // Free all not-precached per-level sfx
1119 for (sfx = known_sfx;sfx;sfx = sfxnext)
1121 sfxnext = sfx->next;
1122 if (!(sfx->flags & (SFXFLAG_LEVELSOUND | SFXFLAG_MENUSOUND)))
1123 S_FreeSfx (sfx, false);
1133 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean levelsound)
1137 if (!snd_initialized.integer)
1140 if (name == NULL || name[0] == 0)
1143 sfx = S_FindName (name);
1148 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1149 // previously missing file
1150 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1152 // set a flag to indicate this has been precached for this level or permanently
1154 sfx->flags |= SFXFLAG_LEVELSOUND;
1156 sfx->flags |= SFXFLAG_MENUSOUND;
1158 if (!nosound.integer && snd_precache.integer)
1159 S_LoadSound(sfx, complain);
1170 float S_SoundLength(const char *name)
1174 if (!snd_initialized.integer)
1176 if (name == NULL || name[0] == 0)
1179 sfx = S_FindName(name);
1182 return sfx->total_length / (float) S_GetSoundRate();
1190 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1192 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1200 void S_BlockSound (void)
1211 void S_UnblockSound (void)
1221 Picks a channel based on priorities, empty slots, number of channels
1224 static channel_t *SND_PickChannel(int entnum, int entchannel)
1228 int first_life_left, life_left;
1230 sfx_t *sfx; // use this instead of ch->sfx->, because that is volatile.
1232 // Check for replacement sound, or find the best one to replace
1234 first_life_left = 0x7fffffff;
1236 // entity channels try to replace the existing sound on the channel
1237 // channels <= 0 are autochannels
1238 if (IS_CHAN_SINGLE(entchannel))
1240 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1242 ch = &channels[ch_idx];
1243 if (ch->entnum == entnum && ch->entchannel == entchannel)
1245 // always override sound from same entity
1246 S_StopChannel (ch_idx, true, false);
1247 return &channels[ch_idx];
1252 // there was no channel to override, so look for the first empty one
1253 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1255 ch = &channels[ch_idx];
1256 sfx = ch->sfx; // fetch the volatile variable
1259 // no sound on this channel
1260 first_to_die = ch_idx;
1261 goto emptychan_found;
1264 // don't let monster sounds override player sounds
1265 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1268 // don't override looped sounds
1269 if ((ch->flags & CHANNELFLAG_FORCELOOP) || sfx->loopstart < sfx->total_length)
1271 life_left = (int)((double)sfx->total_length - ch->position);
1273 if (life_left < first_life_left)
1275 first_life_left = life_left;
1276 first_to_die = ch_idx;
1280 if (first_to_die == -1)
1283 S_StopChannel (first_to_die, true, false);
1286 return &channels[first_to_die];
1293 Spatializes a channel
1296 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1297 static void SND_Spatialize_WithSfx(channel_t *ch, qboolean isstatic, sfx_t *sfx)
1301 float angle_side, angle_front, angle_factor, mixspeed;
1302 vec_t dist, mastervol, intensity;
1306 // update sound origin if we know about the entity
1307 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1309 if (ch->entnum >= MAX_EDICTS)
1311 //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]);
1313 if (ch->entnum > MAX_EDICTS)
1314 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1315 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1317 else if (cl.entities[ch->entnum].state_current.active)
1320 //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]);
1321 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1322 if (model && model->soundfromcenter)
1323 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1325 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1329 mastervol = ch->basevolume;
1330 mixspeed = ch->basespeed;
1332 // TODO: implement doppler based on origin change relative to viewer and time of recent origin changes
1334 // Adjust volume of static sounds
1336 mastervol *= snd_staticvolume.value;
1337 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1339 // old legacy separated cvars
1340 if(ch->entnum >= MAX_EDICTS)
1342 switch(ch->entchannel)
1344 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1345 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1346 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1347 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1348 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1349 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1350 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1351 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1355 else if(ch->entnum == 0)
1357 switch(ch->entchannel)
1359 case 0: mastervol *= snd_worldchannel0volume.value; break;
1360 case 1: mastervol *= snd_worldchannel1volume.value; break;
1361 case 2: mastervol *= snd_worldchannel2volume.value; break;
1362 case 3: mastervol *= snd_worldchannel3volume.value; break;
1363 case 4: mastervol *= snd_worldchannel4volume.value; break;
1364 case 5: mastervol *= snd_worldchannel5volume.value; break;
1365 case 6: mastervol *= snd_worldchannel6volume.value; break;
1366 case 7: mastervol *= snd_worldchannel7volume.value; break;
1370 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1372 switch(ch->entchannel)
1374 case 0: mastervol *= snd_playerchannel0volume.value; break;
1375 case 1: mastervol *= snd_playerchannel1volume.value; break;
1376 case 2: mastervol *= snd_playerchannel2volume.value; break;
1377 case 3: mastervol *= snd_playerchannel3volume.value; break;
1378 case 4: mastervol *= snd_playerchannel4volume.value; break;
1379 case 5: mastervol *= snd_playerchannel5volume.value; break;
1380 case 6: mastervol *= snd_playerchannel6volume.value; break;
1381 case 7: mastervol *= snd_playerchannel7volume.value; break;
1387 switch(ch->entchannel)
1389 case 0: mastervol *= snd_entchannel0volume.value; break;
1390 case 1: mastervol *= snd_entchannel1volume.value; break;
1391 case 2: mastervol *= snd_entchannel2volume.value; break;
1392 case 3: mastervol *= snd_entchannel3volume.value; break;
1393 case 4: mastervol *= snd_entchannel4volume.value; break;
1394 case 5: mastervol *= snd_entchannel5volume.value; break;
1395 case 6: mastervol *= snd_entchannel6volume.value; break;
1396 case 7: mastervol *= snd_entchannel7volume.value; break;
1401 switch(ch->entchannel)
1403 case 0: mastervol *= snd_channel0volume.value; break;
1404 case 1: mastervol *= snd_channel1volume.value; break;
1405 case 2: mastervol *= snd_channel2volume.value; break;
1406 case 3: mastervol *= snd_channel3volume.value; break;
1407 case 4: mastervol *= snd_channel4volume.value; break;
1408 case 5: mastervol *= snd_channel5volume.value; break;
1409 case 6: mastervol *= snd_channel6volume.value; break;
1410 case 7: mastervol *= snd_channel7volume.value; break;
1411 default: mastervol *= Cvar_VariableValueOr(va(vabuf, sizeof(vabuf), "snd_channel%dvolume", CHAN_ENGINE2CVAR(ch->entchannel)), 1.0); break;
1415 // If this channel does not manage its own volume (like CD tracks)
1416 if (!(ch->flags & CHANNELFLAG_FULLVOLUME))
1417 mastervol *= volume.value;
1419 if(snd_maxchannelvolume.value > 0)
1421 // clamp HERE to allow to go at most 10dB past mastervolume (before clamping), when mastervolume < -10dB (so relative volumes don't get too messy)
1422 mastervol = bound(0.0f, mastervol, 10.0f * snd_maxchannelvolume.value);
1425 // always apply "master"
1426 mastervol *= mastervolume.value;
1428 // add in ReplayGain very late; prevent clipping when close
1430 if(sfx->volume_peak > 0)
1432 // Replaygain support
1433 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1434 mastervol *= sfx->volume_mult;
1435 if(snd_maxchannelvolume.value > 0)
1437 if(mastervol * sfx->volume_peak > snd_maxchannelvolume.value)
1438 mastervol = snd_maxchannelvolume.value / sfx->volume_peak;
1440 // Con_DPrintf("%f\n", fvol);
1443 if(snd_maxchannelvolume.value > 0)
1445 // clamp HERE to keep relative volumes of the channels correct
1446 mastervol = min(mastervol, snd_maxchannelvolume.value);
1449 mastervol = max(0.0f, mastervol);
1451 ch->mixspeed = mixspeed;
1453 // anything coming from the view entity will always be full volume
1454 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1455 if (ch->entnum == cl.viewentity || ch->distfade == 0)
1457 ch->prologic_invert = 1;
1458 if (snd_spatialization_prologic.integer != 0)
1460 ch->volume[0] = mastervol * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1461 ch->volume[1] = mastervol * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1462 for (i = 2;i < SND_LISTENERS;i++)
1467 for (i = 0;i < SND_LISTENERS;i++)
1468 ch->volume[i] = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1473 // calculate stereo seperation and distance attenuation
1474 VectorSubtract(listener_origin, ch->origin, source_vec);
1475 dist = VectorLength(source_vec);
1476 f = dist * ch->distfade;
1479 ((snd_attenuation_exponent.value == 0) ? 1.0 : pow(1.0 - min(1.0, f), (double)snd_attenuation_exponent.value))
1481 ((snd_attenuation_decibel.value == 0) ? 1.0 : pow(0.1, 0.1 * snd_attenuation_decibel.value * f));
1483 intensity = mastervol * f;
1486 qboolean occluded = false;
1487 if (snd_spatialization_occlusion.integer)
1489 if(snd_spatialization_occlusion.integer & 1)
1492 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1493 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1497 if(snd_spatialization_occlusion.integer & 2)
1499 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1505 ch->prologic_invert = 1;
1506 if (snd_spatialization_prologic.integer != 0)
1509 angle_factor = 0.5f;
1512 Matrix4x4_Transform(&listener_basematrix, ch->origin, source_vec);
1513 VectorNormalize(source_vec);
1515 switch(spatialmethod)
1519 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1521 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1522 VectorScale(source_vec, f, source_vec);
1525 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1526 f = spatialmin + spatialdiff * bound(0, f, 1);
1527 VectorScale(source_vec, f, source_vec);
1529 case SPATIAL_THRESH:
1530 f = spatialmin + spatialdiff * (dist < spatialoffset);
1531 VectorScale(source_vec, f, source_vec);
1538 // 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
1540 VectorNormalize(source_vec);
1541 angle_side = acos(source_vec[0]) / M_PI * 180; // angle between 0 and 180 degrees
1542 angle_front = asin(source_vec[1]) / M_PI * 180; // angle between -90 and 90 degrees
1543 if (angle_side > snd_spatialization_prologic_frontangle.value)
1545 ch->prologic_invert = -1; // this will cause the right channel to do a 180 degrees phase shift (turning the sound wave upside down),
1546 // but the best would be 90 degrees phase shift left and a -90 degrees phase shift right.
1547 angle_factor = (angle_side - snd_spatialization_prologic_frontangle.value) / (360 - 2 * snd_spatialization_prologic_frontangle.value);
1548 // angle_factor is between 0 and 1 and represents the angle range from the front left, to all the surround speakers (amount may vary,
1549 // 1 in prologic I 2 in prologic II and 3 or 4 in prologic IIx) to the front right speaker.
1550 if (angle_front > 0)
1551 angle_factor = 1 - angle_factor;
1554 angle_factor = angle_front / snd_spatialization_prologic_frontangle.value / 2.0 + 0.5;
1555 //angle_factor is between 0 and 1 and represents the angle range from the front left to the center to the front right speaker
1558 ch->volume[0] = intensity * sqrt(angle_factor);
1559 ch->volume[1] = intensity * sqrt(1 - angle_factor);
1560 for (i = 2;i < SND_LISTENERS;i++)
1565 for (i = 0;i < SND_LISTENERS;i++)
1567 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1568 VectorNormalize(source_vec);
1570 switch(spatialmethod)
1574 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1576 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1577 VectorScale(source_vec, f, source_vec);
1580 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1581 f = spatialmin + spatialdiff * bound(0, f, 1);
1582 VectorScale(source_vec, f, source_vec);
1584 case SPATIAL_THRESH:
1585 f = spatialmin + spatialdiff * (dist < spatialoffset);
1586 VectorScale(source_vec, f, source_vec);
1593 ch->volume[i] = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1598 for (i = 0;i < SND_LISTENERS;i++)
1602 static void SND_Spatialize(channel_t *ch, qboolean isstatic)
1604 sfx_t *sfx = ch->sfx;
1605 SND_Spatialize_WithSfx(ch, isstatic, sfx);
1609 // =======================================================================
1610 // Start a sound effect
1611 // =======================================================================
1613 static void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic, int entnum, int entchannel, int startpos, float fspeed)
1617 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1621 if ((sfx->loopstart < sfx->total_length) || (flags & CHANNELFLAG_FORCELOOP))
1623 if(!snd_startloopingsounds.integer)
1628 if(!snd_startnonloopingsounds.integer)
1632 // Initialize the channel
1633 // a crash was reported on an in-use channel, so check here...
1634 if (target_chan->sfx)
1636 int channelindex = (int)(target_chan - channels);
1637 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1638 S_StopChannel (channelindex, true, false);
1640 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1641 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1642 memset (target_chan, 0, sizeof (*target_chan));
1643 VectorCopy (origin, target_chan->origin);
1644 target_chan->flags = flags;
1645 target_chan->position = startpos; // start of the sound
1646 target_chan->entnum = entnum;
1647 target_chan->entchannel = entchannel;
1649 // If it's a static sound
1652 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1653 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1654 target_chan->distfade = attenuation / (64.0f * snd_soundradius.value);
1657 target_chan->distfade = attenuation / snd_soundradius.value;
1659 // set the listener volumes
1660 S_SetChannelVolume(target_chan - channels, fvol);
1661 S_SetChannelSpeed(target_chan - channels, fspeed);
1662 SND_Spatialize_WithSfx (target_chan, isstatic, sfx);
1664 // finally, set the sfx pointer, so the channel becomes valid for playback
1665 // and will be noticed by the mixer
1666 target_chan->sfx = sfx;
1670 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)
1672 channel_t *target_chan, *check, *ch;
1673 int ch_idx, startpos;
1675 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1678 if(sfx == &changevolume_sfx)
1680 if (!IS_CHAN_SINGLE(entchannel))
1682 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1684 ch = &channels[ch_idx];
1685 if (ch->entnum == entnum && ch->entchannel == entchannel)
1687 S_SetChannelVolume(ch_idx, fvol);
1688 S_SetChannelSpeed(ch_idx, fspeed);
1689 ch->distfade = attenuation / snd_soundradius.value;
1690 SND_Spatialize(ch, false);
1697 if (sfx->fetcher == NULL)
1700 // Pick a channel to play on
1701 target_chan = SND_PickChannel(entnum, entchannel);
1705 // if an identical sound has also been started this frame, offset the pos
1706 // a bit to keep it from just making the first one louder
1707 check = &channels[NUM_AMBIENTS];
1708 startpos = (int)(startposition * sfx->format.speed);
1711 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1713 if (check == target_chan)
1715 if (check->sfx == sfx && check->position == 0 && check->basespeed == fspeed)
1717 // calculate max offset
1718 float maxtime = snd_identicalsoundrandomization_time.value;
1719 float maxtics = snd_identicalsoundrandomization_tics.value;
1720 float maxticsdelta = ((cls.state == ca_connected) ? (maxtics * (cl.mtime[0] - cl.mtime[1])) : 0);
1722 if(maxticsdelta == 0 || fabs(maxticsdelta) > fabs(maxtime))
1725 maxdelta = fabs(maxticsdelta) * ((maxtime > 0) ? 1 : -1);
1727 // use negative pos offset to delay this sound effect
1728 startpos = lhrandom(0, maxdelta * sfx->format.speed);
1734 S_PlaySfxOnChannel (sfx, target_chan, flags, origin, fvol, attenuation, false, entnum, entchannel, startpos, fspeed);
1736 return (target_chan - channels);
1739 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1741 return S_StartSound_StartPosition_Flags(entnum, entchannel, sfx, origin, fvol, attenuation, 0, CHANNELFLAG_NONE, 1.0f);
1744 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex, qboolean freesfx)
1749 if (channel_ind >= total_channels)
1752 // we have to lock an audio mutex to prevent crashes if an audio mixer
1753 // thread is currently mixing this channel
1754 // the SndSys_LockRenderBuffer function uses such a mutex in
1755 // threaded sound backends
1756 if (lockmutex && !simsound)
1757 SndSys_LockRenderBuffer();
1759 ch = &channels[channel_ind];
1761 if (ch->sfx != NULL)
1763 if (sfx->fetcher != NULL && sfx->fetcher->stopchannel != NULL)
1764 sfx->fetcher->stopchannel(ch);
1765 ch->fetcher_data = NULL;
1768 if (lockmutex && !simsound)
1769 SndSys_UnlockRenderBuffer();
1771 S_FreeSfx(sfx, true);
1775 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1777 if (ch_ind >= total_channels)
1780 if (flag != CHANNELFLAG_FORCELOOP &&
1781 flag != CHANNELFLAG_PAUSED &&
1782 flag != CHANNELFLAG_FULLVOLUME &&
1783 flag != CHANNELFLAG_LOCALSOUND)
1787 channels[ch_ind].flags |= flag;
1789 channels[ch_ind].flags &= ~flag;
1794 void S_StopSound(int entnum, int entchannel)
1798 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1799 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1801 S_StopChannel (i, true, false);
1806 void S_StopAllSounds (void)
1810 // TOCHECK: is this test necessary?
1811 if (snd_renderbuffer == NULL)
1814 // stop CD audio because it may be using a faketrack
1817 if (simsound || SndSys_LockRenderBuffer ())
1822 for (i = 0; i < total_channels; i++)
1823 if (channels[i].sfx)
1824 S_StopChannel (i, false, false);
1826 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1827 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1829 // Mute the contents of the submittion buffer
1830 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1831 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1832 memset(snd_renderbuffer->ring, clear, memsize);
1835 SndSys_UnlockRenderBuffer ();
1839 void S_PauseGameSounds (qboolean toggle)
1843 for (i = 0; i < total_channels; i++)
1848 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1849 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1853 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1855 channels[ch_ind].basevolume = fvol;
1858 void S_SetChannelSpeed(unsigned int ch_ind, float fspeed)
1860 channels[ch_ind].basespeed = fspeed;
1863 float S_GetChannelPosition (unsigned int ch_ind)
1865 // note: this is NOT accurate yet
1867 channel_t *ch = &channels[ch_ind];
1868 sfx_t *sfx = ch->sfx;
1872 s = ch->position / sfx->format.speed;
1874 if(!snd_usethreadedmixing)
1875 s += _snd_mixahead.value;
1880 float S_GetEntChannelPosition(int entnum, int entchannel)
1885 for (i = 0; i < total_channels; i++)
1888 if (ch->entnum == entnum && ch->entchannel == entchannel)
1889 return S_GetChannelPosition(i);
1891 return -1; // no playing sound in this channel
1899 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1901 channel_t *target_chan;
1903 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1907 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1911 if (total_channels == MAX_CHANNELS)
1913 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1917 target_chan = &channels[total_channels++];
1918 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0, 1.0f);
1924 S_UpdateAmbientSounds
1927 static void S_UpdateAmbientSounds (void)
1931 float fade = (float)max(0.0, cl.time - cl.oldtime) * ambient_fade.value / 256.0f;
1932 int ambient_channel;
1934 unsigned char ambientlevels[NUM_AMBIENTS];
1937 memset(ambientlevels, 0, sizeof(ambientlevels));
1938 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1939 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1941 // Calc ambient sound levels
1942 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1944 chan = &channels[ambient_channel];
1945 sfx = chan->sfx; // fetch the volatile variable
1946 if (sfx == NULL || sfx->fetcher == NULL)
1949 i = ambientlevels[ambient_channel];
1952 vol = i * (1.0f / 256.0f);
1954 // Don't adjust volume too fast
1955 if (chan->basevolume < vol)
1957 chan->basevolume += fade;
1958 if (chan->basevolume > vol)
1959 chan->basevolume = vol;
1961 else if (chan->basevolume > vol)
1963 chan->basevolume -= fade;
1964 if (chan->basevolume < vol)
1965 chan->basevolume = vol;
1968 if (snd_spatialization_prologic.integer != 0)
1970 chan->volume[0] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[0].ambientvolume * sqrt(0.5);
1971 chan->volume[1] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[1].ambientvolume * sqrt(0.5);
1972 for (i = 2;i < SND_LISTENERS;i++)
1973 chan->volume[i] = 0.0f;
1977 for (i = 0;i < SND_LISTENERS;i++)
1978 chan->volume[i] = chan->basevolume * ambient_level.value * volume.value * mastervolume.value * snd_speakerlayout.listeners[i].ambientvolume;
1983 static void S_PaintAndSubmit (void)
1985 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1986 int usesoundtimehack;
1987 static int soundtimehack = -1;
1988 static int oldsoundtime = 0;
1990 if (snd_renderbuffer == NULL || nosound.integer)
1993 // Update sound time
1994 snd_usethreadedmixing = false;
1995 usesoundtimehack = true;
1996 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1998 usesoundtimehack = 1;
1999 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
2001 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
2003 usesoundtimehack = 2;
2004 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
2008 usesoundtimehack = 3;
2009 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
2013 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
2014 usesoundtimehack = 0;
2015 newsoundtime = SndSys_GetSoundTime();
2017 // if the soundtimehack state changes we need to reset the soundtime
2018 if (soundtimehack != usesoundtimehack)
2020 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
2022 // Mute the contents of the submission buffer
2023 if (simsound || SndSys_LockRenderBuffer ())
2028 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
2029 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
2030 memset(snd_renderbuffer->ring, clear, memsize);
2033 SndSys_UnlockRenderBuffer ();
2036 soundtimehack = usesoundtimehack;
2038 if (!soundtimehack && snd_blocked > 0)
2041 if (snd_usethreadedmixing)
2042 return; // the audio thread will mix its own data
2044 newsoundtime += extrasoundtime;
2045 if (newsoundtime < soundtime)
2047 if ((cls.capturevideo.soundrate != 0) != recording_sound)
2049 unsigned int additionaltime;
2051 // add some time to extrasoundtime make newsoundtime higher
2053 // The extra time must be a multiple of the render buffer size
2054 // to avoid modifying the current position in the buffer,
2055 // some modules write directly to a shared (DMA) buffer
2056 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
2057 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
2059 extrasoundtime += additionaltime;
2060 newsoundtime += additionaltime;
2061 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
2064 else if (!soundtimehack)
2065 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
2066 newsoundtime, soundtime);
2068 soundtime = newsoundtime;
2069 recording_sound = (cls.capturevideo.soundrate != 0);
2071 // Lock submitbuffer
2072 if (!simsound && !SndSys_LockRenderBuffer())
2074 // If the lock failed, stop here
2075 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
2079 // Check to make sure that we haven't overshot
2080 paintedtime = snd_renderbuffer->endframe;
2081 if (paintedtime < soundtime)
2082 paintedtime = soundtime;
2084 // mix ahead of current position
2086 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
2088 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
2089 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
2090 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
2091 endtime = min(endtime, maxtime);
2093 while (paintedtime < endtime)
2095 unsigned int startoffset;
2096 unsigned int nbframes;
2098 // see how much we can fit in the paint buffer
2099 nbframes = endtime - paintedtime;
2100 // limit to the end of the ring buffer (in case of wrapping)
2101 startoffset = paintedtime % snd_renderbuffer->maxframes;
2102 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
2104 // mix into the buffer
2105 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
2107 paintedtime += nbframes;
2108 snd_renderbuffer->endframe = paintedtime;
2111 SndSys_UnlockRenderBuffer();
2113 // Remove outdated samples from the ring buffer, if any
2114 if (snd_renderbuffer->startframe < soundtime)
2115 snd_renderbuffer->startframe = soundtime;
2118 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
2122 oldsoundtime = soundtime;
2124 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
2125 R_TimeReport("audiomix");
2132 Called once each time through the main loop
2135 void S_Update(const matrix4x4_t *listenermatrix)
2137 unsigned int i, j, k;
2138 channel_t *ch, *combine;
2139 matrix4x4_t rotatematrix;
2141 if (snd_renderbuffer == NULL || nosound.integer)
2145 double mindist_trans, maxdist_trans;
2147 spatialmin = snd_spatialization_min.value;
2148 spatialdiff = snd_spatialization_max.value - spatialmin;
2150 if(snd_spatialization_control.value)
2152 spatialpower = snd_spatialization_power.value;
2154 if(spatialpower == 0)
2156 spatialmethod = SPATIAL_LOG;
2157 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
2158 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
2162 spatialmethod = SPATIAL_POW;
2163 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
2164 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
2167 if(mindist_trans - maxdist_trans == 0)
2169 spatialmethod = SPATIAL_THRESH;
2170 mindist_trans = snd_spatialization_min_radius.value;
2174 spatialoffset = mindist_trans;
2175 spatialfactor = 1 / (maxdist_trans - mindist_trans);
2179 spatialmethod = SPATIAL_NONE;
2183 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2184 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2185 current_channellayout != snd_channellayout.integer)
2186 S_SetChannelLayout();
2188 Matrix4x4_Invert_Simple(&listener_basematrix, listenermatrix);
2189 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2190 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2192 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2195 Mem_Free(listener_pvs);
2196 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2197 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2199 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2205 Mem_Free(listener_pvs);
2206 listener_pvs = NULL;
2208 listener_pvsbytes = 0;
2211 // calculate the current matrices
2212 for (j = 0;j < SND_LISTENERS;j++)
2214 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2215 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &listener_basematrix);
2216 // I think this should now do this:
2217 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2218 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2219 // angle has to be taken negative)
2220 // 2. create a transform which first rotates and moves its argument
2221 // into the player's view coordinates (using basematrix which is
2222 // an inverted "absolute" listener matrix), then applies the
2223 // rotation matrix for the ear
2224 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2225 // does not actually refer to an entity?
2228 // update general area ambient sound sources
2229 S_UpdateAmbientSounds ();
2232 R_TimeReport("audioprep");
2234 // update spatialization for static and dynamic sounds
2235 cls.soundstats.totalsounds = 0;
2236 cls.soundstats.mixedsounds = 0;
2237 ch = channels+NUM_AMBIENTS;
2238 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2242 cls.soundstats.totalsounds++;
2244 // respatialize channel
2245 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2247 // try to combine static sounds with a previous channel of the same
2248 // sound effect so we don't mix five torches every frame
2249 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2251 // no need to merge silent channels
2252 for (j = 0;j < SND_LISTENERS;j++)
2255 if (j == SND_LISTENERS)
2257 // if the last combine chosen isn't suitable, find a new one
2258 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2262 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2264 if (channels[j].sfx == ch->sfx)
2266 combine = channels + j;
2271 if (combine && combine != ch && combine->sfx == ch->sfx)
2273 for (j = 0;j < SND_LISTENERS;j++)
2275 combine->volume[j] += ch->volume[j];
2280 for (k = 0;k < SND_LISTENERS;k++)
2283 if (k < SND_LISTENERS)
2284 cls.soundstats.mixedsounds++;
2286 R_TimeReport("audiospatialize");
2288 sound_spatialized = true;
2291 if (snd_show.integer)
2292 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2297 void S_ExtraUpdate (void)
2299 if (snd_noextraupdate.integer || !sound_spatialized)
2305 qboolean S_LocalSound (const char *sound)
2310 if (!snd_initialized.integer || nosound.integer)
2313 sfx = S_PrecacheSound (sound, true, false);
2316 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2320 // menu sounds must not be freed on level change
2321 sfx->flags |= SFXFLAG_MENUSOUND;
2323 // fun fact: in Quake 1, this used -1 "replace any entity channel",
2324 // which we no longer support anyway
2325 // changed by Black in r4297 "Changed S_LocalSound to play multiple sounds at a time."
2326 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2330 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;