2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
26 #include "snd_modplug.h"
28 #include "cl_collision.h"
31 #define SND_MIN_SPEED 8000
32 #define SND_MAX_SPEED 96000
33 #define SND_MIN_WIDTH 1
34 #define SND_MAX_WIDTH 2
35 #define SND_MIN_CHANNELS 1
36 #define SND_MAX_CHANNELS 8
37 #if SND_LISTENERS != 8
38 # error this data only supports up to 8 channel, update it!
41 speakerlayout_t snd_speakerlayout;
43 // Our speaker layouts are based on ALSA. They differ from those
44 // Win32 and Mac OS X APIs use when there's more than 4 channels.
45 // (rear left + rear right, and front center + LFE are swapped).
46 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
47 static const speakerlayout_t snd_speakerlayouts[] =
52 {0, 45, 0.2, 0.2, 0.5}, // front left
53 {1, 315, 0.2, 0.2, 0.5}, // front right
54 {2, 135, 0.2, 0.2, 0.5}, // rear left
55 {3, 225, 0.2, 0.2, 0.5}, // rear right
56 {4, 0, 0.2, 0.2, 0.5}, // front center
57 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
58 {6, 90, 0.2, 0.2, 0.5}, // side left
59 {7, 180, 0.2, 0.2, 0.5}, // side right
65 {0, 45, 0.2, 0.2, 0.5}, // front left
66 {1, 315, 0.2, 0.2, 0.5}, // front right
67 {2, 135, 0.2, 0.2, 0.5}, // rear left
68 {3, 225, 0.2, 0.2, 0.5}, // rear right
69 {4, 0, 0.2, 0.2, 0.5}, // front center
70 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
76 // these systems sometimes have a subwoofer as well, but it has no
80 {0, 45, 0.3, 0.3, 0.8}, // front left
81 {1, 315, 0.3, 0.3, 0.8}, // front right
82 {2, 135, 0.3, 0.3, 0.8}, // rear left
83 {3, 225, 0.3, 0.3, 0.8}, // rear right
91 // these systems sometimes have a subwoofer as well, but it has no
95 {0, 90, 0.5, 0.5, 1}, // side left
96 {1, 270, 0.5, 0.5, 1}, // side right
108 {0, 0, 0, 1, 1}, // center
121 // =======================================================================
122 // Internal sound data & structures
123 // =======================================================================
125 channel_t channels[MAX_CHANNELS];
126 unsigned int total_channels;
128 snd_ringbuffer_t *snd_renderbuffer = NULL;
129 static unsigned int soundtime = 0;
130 static unsigned int oldpaintedtime = 0;
131 static unsigned int extrasoundtime = 0;
132 static double snd_starttime = 0.0;
133 qboolean snd_threaded = false;
134 qboolean snd_usethreadedmixing = false;
136 vec3_t listener_origin;
137 static unsigned char *listener_pvs = NULL;
138 static int listener_pvsbytes = 0;
139 matrix4x4_t listener_matrix[SND_LISTENERS];
140 mempool_t *snd_mempool;
142 // Linked list of known sfx
143 static sfx_t *known_sfx = NULL;
145 static qboolean sound_spatialized = false;
147 qboolean simsound = false;
149 static qboolean recording_sound = false;
152 static int current_swapstereo = false;
153 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
154 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
156 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
157 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
158 spatialmethod_t spatialmethod;
160 // Cvars declared in sound.h (part of the sound API)
161 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
162 cvar_t mastervolume = {CVAR_SAVE, "mastervolume", "0.7", "master volume"};
163 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
164 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
165 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
166 cvar_t snd_soundradius = {CVAR_SAVE, "snd_soundradius", "2000", "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)"};
167 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
168 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
169 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
170 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
171 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
172 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
173 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"};
175 // Cvars declared in snd_main.h (shared with other snd_*.c files)
176 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
177 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)"};
178 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
179 extern cvar_t v_flipped;
180 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
181 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
182 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities"};
183 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities"};
184 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities"};
185 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities"};
186 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities"};
187 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities"};
188 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities"};
189 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities"};
190 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities"};
191 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities"};
192 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities"};
193 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities"};
194 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities"};
195 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities"};
196 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities"};
197 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities"};
198 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
199 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
200 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
201 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
202 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
203 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
204 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
205 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
206 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
207 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
208 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
209 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
210 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
211 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
212 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
213 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
216 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
217 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
218 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
219 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
220 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"};
221 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
223 // Default sound format is 48KHz, 16-bit, stereo
224 // (48KHz because a lot of onboard sound cards sucks at any other speed)
225 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
226 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
227 static cvar_t snd_channels = {CVAR_SAVE, "snd_channels", "2", "number of channels for the sound ouput (2 for stereo; up to 8 supported for 3D sound)"};
230 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
231 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
234 // ====================================================================
236 // ====================================================================
238 void S_FreeSfx (sfx_t *sfx, qboolean force);
240 static void S_Play_Common (float fvol, float attenuation)
243 char name [MAX_QPATH];
247 while (i < Cmd_Argc ())
249 // Get the name, and appends ".wav" as an extension if there's none
250 strlcpy (name, Cmd_Argv (i), sizeof (name));
251 if (!strrchr (name, '.'))
252 strlcat (name, ".wav", sizeof (name));
255 // If we need to get the volume from the command line
258 fvol = atof (Cmd_Argv (i));
262 sfx = S_PrecacheSound (name, true, true);
265 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
267 // Free the sfx if the file didn't exist
269 S_FreeSfx (sfx, false);
271 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
276 static void S_Play_f(void)
278 S_Play_Common (1.0f, 1.0f);
281 static void S_Play2_f(void)
283 S_Play_Common (1.0f, 0.0f);
286 static void S_PlayVol_f(void)
288 S_Play_Common (-1.0f, 0.0f);
291 static void S_SoundList_f (void)
298 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
300 if (sfx->fetcher != NULL)
303 const snd_format_t* format;
306 format = sfx->fetcher->getfmt(sfx);
307 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
308 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
309 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
310 (sfx->locks > 0) ? 'K' : ' ',
311 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
313 (format->channels == 1) ? "mono" : "stereo",
319 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
321 Con_Printf("Total resident: %i\n", total);
325 void S_SoundInfo_f(void)
327 if (snd_renderbuffer == NULL)
329 Con_Print("sound system not started\n");
333 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
334 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
335 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
336 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
337 Con_Printf("%5u total_channels\n", total_channels);
341 int S_GetSoundRate(void)
343 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
346 int S_GetSoundChannels(void)
348 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
352 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
354 static const snd_format_t thresholds [] =
356 // speed width channels
357 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
363 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
365 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
366 unsigned int speed_level, width_level, channels_level;
368 // If we have reached the minimum values, there's nothing more we can do
369 if ((format->speed == thresholds[0].speed || fixed_speed) &&
370 (format->width == thresholds[0].width || fixed_width) &&
371 (format->channels == thresholds[0].channels || fixed_channels))
374 // Check the min and max values
375 #define CHECK_BOUNDARIES(param) \
376 if (format->param < thresholds[0].param) \
378 format->param = thresholds[0].param; \
381 if (format->param > thresholds[nb_thresholds - 1].param) \
383 format->param = thresholds[nb_thresholds - 1].param; \
386 CHECK_BOUNDARIES(speed);
387 CHECK_BOUNDARIES(width);
388 CHECK_BOUNDARIES(channels);
389 #undef CHECK_BOUNDARIES
391 // Find the level of each parameter
392 #define FIND_LEVEL(param) \
394 while (param##_level < nb_thresholds - 1) \
396 if (format->param <= thresholds[param##_level].param) \
403 FIND_LEVEL(channels);
406 // Decrease the parameter with the highest level to the previous level
407 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
409 format->channels = thresholds[channels_level - 1].channels;
412 if (speed_level >= width_level && !fixed_speed)
414 format->speed = thresholds[speed_level - 1].speed;
418 format->width = thresholds[width_level - 1].width;
423 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
425 static void S_SetChannelLayout (void)
428 listener_t swaplistener;
429 listener_t *listeners;
432 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
433 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
435 if (i >= SND_SPEAKERLAYOUTS)
437 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
438 snd_renderbuffer->format.channels);
439 i = SND_SPEAKERLAYOUTS - 1;
442 snd_speakerlayout = snd_speakerlayouts[i];
443 listeners = snd_speakerlayout.listeners;
445 // Swap the left and right channels if snd_swapstereo is set
446 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
448 switch (snd_speakerlayout.channels)
451 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
455 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
458 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
469 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
470 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
471 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
473 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
475 // If we're in the sound engine initialization
476 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
478 layout = SND_CHANNELLAYOUT_STANDARD;
479 Cvar_SetValueQuick (&snd_channellayout, layout);
482 layout = current_channellayout_used;
485 layout = snd_channellayout.integer;
487 // Convert our layout (= ALSA) to the standard layout if necessary
488 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
490 if (layout == SND_CHANNELLAYOUT_STANDARD)
492 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
493 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
496 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
497 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
500 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
501 current_channellayout = snd_channellayout.integer;
502 current_channellayout_used = layout;
506 void S_Startup (void)
508 qboolean fixed_speed, fixed_width, fixed_channels;
509 snd_format_t chosen_fmt;
510 static snd_format_t prev_render_format = {0, 0, 0};
517 if (!snd_initialized.integer)
522 fixed_channels = false;
524 // Get the starting sound format from the cvars
525 chosen_fmt.speed = snd_speed.integer;
526 chosen_fmt.width = snd_width.integer;
527 chosen_fmt.channels = snd_channels.integer;
529 // Check the environment variables to see if the player wants a particular sound format
531 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
533 env = getenv("QUAKE_SOUND_CHANNELS");
537 chosen_fmt.channels = atoi (env);
541 fixed_channels = true;
544 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
546 env = getenv("QUAKE_SOUND_SPEED");
550 chosen_fmt.speed = atoi (env);
557 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
559 env = getenv("QUAKE_SOUND_SAMPLEBITS");
563 chosen_fmt.width = atoi (env) / 8;
570 // Parse the command line to see if the player wants a particular sound format
571 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
572 if (COM_CheckParm ("-sndquad") != 0)
574 chosen_fmt.channels = 4;
575 fixed_channels = true;
577 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
578 else if (COM_CheckParm ("-sndstereo") != 0)
580 chosen_fmt.channels = 2;
581 fixed_channels = true;
583 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
584 else if (COM_CheckParm ("-sndmono") != 0)
586 chosen_fmt.channels = 1;
587 fixed_channels = true;
589 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
590 i = COM_CheckParm ("-sndspeed");
591 if (0 < i && i < com_argc - 1)
593 chosen_fmt.speed = atoi (com_argv[i + 1]);
596 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
597 i = COM_CheckParm ("-sndbits");
598 if (0 < i && i < com_argc - 1)
600 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
604 // You can't change sound speed after start time (not yet supported)
605 if (prev_render_format.speed != 0)
608 if (chosen_fmt.speed != prev_render_format.speed)
610 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
611 prev_render_format.speed);
612 chosen_fmt.speed = prev_render_format.speed;
617 if (chosen_fmt.speed < SND_MIN_SPEED)
619 chosen_fmt.speed = SND_MIN_SPEED;
622 else if (chosen_fmt.speed > SND_MAX_SPEED)
624 chosen_fmt.speed = SND_MAX_SPEED;
628 if (chosen_fmt.width < SND_MIN_WIDTH)
630 chosen_fmt.width = SND_MIN_WIDTH;
633 else if (chosen_fmt.width > SND_MAX_WIDTH)
635 chosen_fmt.width = SND_MAX_WIDTH;
639 if (chosen_fmt.channels < SND_MIN_CHANNELS)
641 chosen_fmt.channels = SND_MIN_CHANNELS;
642 fixed_channels = false;
644 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
646 chosen_fmt.channels = SND_MAX_CHANNELS;
647 fixed_channels = false;
650 // create the sound buffer used for sumitting the samples to the plaform-dependent module
653 snd_format_t suggest_fmt;
659 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
660 chosen_fmt.speed, chosen_fmt.width * 8,
661 chosen_fmt.channels);
663 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
664 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
668 Con_Printf("S_Startup: sound output initialization FAILED\n");
670 // If the module is suggesting another one
671 if (suggest_fmt.speed != 0)
673 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
674 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
675 suggest_fmt.speed, suggest_fmt.width * 8,
676 suggest_fmt.channels);
678 // Else, try to find a less resource-demanding format
679 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
684 // If we haven't found a suitable format
687 Con_Print("S_Startup: SndSys_Init failed.\n");
688 sound_spatialized = false;
694 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
695 Con_Print ("S_Startup: simulating sound output\n");
698 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
699 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
700 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
703 if (snd_speed.integer != (int)chosen_fmt.speed)
704 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
705 if (snd_width.integer != chosen_fmt.width)
706 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
707 if (snd_channels.integer != chosen_fmt.channels)
708 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
710 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
711 S_SetChannelLayout();
713 snd_starttime = realtime;
715 // If the sound module has already run, add an extra time to make sure
716 // the sound time doesn't decrease, to not confuse playing SFXs
717 if (oldpaintedtime != 0)
719 // The extra time must be a multiple of the render buffer size
720 // to avoid modifying the current position in the buffer,
721 // some modules write directly to a shared (DMA) buffer
722 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
723 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
724 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
726 soundtime = extrasoundtime;
730 snd_renderbuffer->startframe = soundtime;
731 snd_renderbuffer->endframe = soundtime;
732 recording_sound = false;
735 void S_Shutdown(void)
737 if (snd_renderbuffer == NULL)
740 oldpaintedtime = snd_renderbuffer->endframe;
744 Mem_Free(snd_renderbuffer->ring);
745 Mem_Free(snd_renderbuffer);
746 snd_renderbuffer = NULL;
751 sound_spatialized = false;
754 void S_Restart_f(void)
756 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
757 // So, refuse to do this if we are connected.
758 if(cls.state == ca_connected)
760 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
775 Cvar_RegisterVariable(&volume);
776 Cvar_RegisterVariable(&bgmvolume);
777 Cvar_RegisterVariable(&mastervolume);
778 Cvar_RegisterVariable(&snd_staticvolume);
779 Cvar_RegisterVariable(&snd_entchannel0volume);
780 Cvar_RegisterVariable(&snd_entchannel1volume);
781 Cvar_RegisterVariable(&snd_entchannel2volume);
782 Cvar_RegisterVariable(&snd_entchannel3volume);
783 Cvar_RegisterVariable(&snd_entchannel4volume);
784 Cvar_RegisterVariable(&snd_entchannel5volume);
785 Cvar_RegisterVariable(&snd_entchannel6volume);
786 Cvar_RegisterVariable(&snd_entchannel7volume);
787 Cvar_RegisterVariable(&snd_worldchannel0volume);
788 Cvar_RegisterVariable(&snd_worldchannel1volume);
789 Cvar_RegisterVariable(&snd_worldchannel2volume);
790 Cvar_RegisterVariable(&snd_worldchannel3volume);
791 Cvar_RegisterVariable(&snd_worldchannel4volume);
792 Cvar_RegisterVariable(&snd_worldchannel5volume);
793 Cvar_RegisterVariable(&snd_worldchannel6volume);
794 Cvar_RegisterVariable(&snd_worldchannel7volume);
795 Cvar_RegisterVariable(&snd_playerchannel0volume);
796 Cvar_RegisterVariable(&snd_playerchannel1volume);
797 Cvar_RegisterVariable(&snd_playerchannel2volume);
798 Cvar_RegisterVariable(&snd_playerchannel3volume);
799 Cvar_RegisterVariable(&snd_playerchannel4volume);
800 Cvar_RegisterVariable(&snd_playerchannel5volume);
801 Cvar_RegisterVariable(&snd_playerchannel6volume);
802 Cvar_RegisterVariable(&snd_playerchannel7volume);
803 Cvar_RegisterVariable(&snd_csqcchannel0volume);
804 Cvar_RegisterVariable(&snd_csqcchannel1volume);
805 Cvar_RegisterVariable(&snd_csqcchannel2volume);
806 Cvar_RegisterVariable(&snd_csqcchannel3volume);
807 Cvar_RegisterVariable(&snd_csqcchannel4volume);
808 Cvar_RegisterVariable(&snd_csqcchannel5volume);
809 Cvar_RegisterVariable(&snd_csqcchannel6volume);
810 Cvar_RegisterVariable(&snd_csqcchannel7volume);
812 Cvar_RegisterVariable(&snd_spatialization_min_radius);
813 Cvar_RegisterVariable(&snd_spatialization_max_radius);
814 Cvar_RegisterVariable(&snd_spatialization_min);
815 Cvar_RegisterVariable(&snd_spatialization_max);
816 Cvar_RegisterVariable(&snd_spatialization_power);
817 Cvar_RegisterVariable(&snd_spatialization_control);
818 Cvar_RegisterVariable(&snd_spatialization_occlusion);
820 Cvar_RegisterVariable(&snd_speed);
821 Cvar_RegisterVariable(&snd_width);
822 Cvar_RegisterVariable(&snd_channels);
823 Cvar_RegisterVariable(&snd_mutewhenidle);
825 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
826 if (COM_CheckParm("-nosound"))
828 // dummy out Play and Play2 because mods stuffcmd that
829 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
830 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
834 snd_mempool = Mem_AllocPool("sound", 0, NULL);
836 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
837 if (COM_CheckParm("-simsound"))
840 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
841 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
842 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
843 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
844 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
845 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
846 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
847 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
849 Cvar_RegisterVariable(&nosound);
850 Cvar_RegisterVariable(&snd_precache);
851 Cvar_RegisterVariable(&snd_initialized);
852 Cvar_RegisterVariable(&snd_streaming);
853 Cvar_RegisterVariable(&ambient_level);
854 Cvar_RegisterVariable(&ambient_fade);
855 Cvar_RegisterVariable(&snd_noextraupdate);
856 Cvar_RegisterVariable(&snd_show);
857 Cvar_RegisterVariable(&_snd_mixahead);
858 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
859 Cvar_RegisterVariable(&snd_channellayout);
860 Cvar_RegisterVariable(&snd_soundradius);
862 Cvar_SetValueQuick(&snd_initialized, true);
866 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
867 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
870 ModPlug_OpenLibrary ();
878 Shutdown and free all resources
881 void S_Terminate (void)
884 ModPlug_CloseLibrary ();
888 while (known_sfx != NULL)
889 S_FreeSfx (known_sfx, true);
891 Cvar_SetValueQuick (&snd_initialized, false);
892 Mem_FreePool (&snd_mempool);
901 void S_UnloadAllSounds_f (void)
905 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
906 // So, refuse to do this if we are connected.
907 if(cls.state == ca_connected)
909 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
913 // stop any active sounds
916 // because the ambient sounds will be freed, clear the pointers
917 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
918 ambient_sfxs[i] = NULL;
920 // now free all sounds
921 while (known_sfx != NULL)
922 S_FreeSfx (known_sfx, true);
931 sfx_t changevolume_sfx = {""};
932 sfx_t *S_FindName (const char *name)
936 if (!snd_initialized.integer)
939 if(!strcmp(name, changevolume_sfx.name))
940 return &changevolume_sfx;
942 if (strlen (name) >= sizeof (sfx->name))
944 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
948 // Look for this sound in the list of known sfx
949 // TODO: hash table search?
950 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
951 if(!strcmp (sfx->name, name))
954 // Add a sfx_t struct for this sound
955 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
956 memset (sfx, 0, sizeof(*sfx));
957 strlcpy (sfx->name, name, sizeof (sfx->name));
958 sfx->memsize = sizeof(*sfx);
959 sfx->next = known_sfx;
971 void S_FreeSfx (sfx_t *sfx, qboolean force)
975 // Never free a locked sfx unless forced
976 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
979 if (developer_loading.integer)
980 Con_Printf ("unloading sound %s\n", sfx->name);
982 // Remove it from the list of known sfx
983 if (sfx == known_sfx)
984 known_sfx = known_sfx->next;
989 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
990 if (prev_sfx->next == sfx)
992 prev_sfx->next = sfx->next;
995 if (prev_sfx == NULL)
997 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1002 // Stop all channels using this sfx
1003 for (i = 0; i < total_channels; i++)
1004 if (channels[i].sfx == sfx)
1005 S_StopChannel (i, true);
1008 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
1009 sfx->fetcher->free (sfx->fetcher_data);
1019 void S_ClearUsed (void)
1025 // Start the ambient sounds and make them loop
1026 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1028 // Precache it if it's not done (request a lock to make sure it will never be freed)
1029 if (ambient_sfxs[i] == NULL)
1030 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
1031 if (ambient_sfxs[i] != NULL)
1033 // Add a lock to the SFX while playing. It will be
1034 // removed by S_StopAllSounds at the end of the level
1035 S_LockSfx (ambient_sfxs[i]);
1037 channels[i].sfx = ambient_sfxs[i];
1038 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1039 channels[i].master_vol = 0;
1043 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
1044 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1045 if (sfx->flags & SFXFLAG_SERVERSOUND)
1048 sfx->flags &= ~SFXFLAG_SERVERSOUND;
1057 void S_PurgeUnused(void)
1062 // Free all unlocked sfx
1063 for (sfx = known_sfx;sfx;sfx = sfxnext)
1065 sfxnext = sfx->next;
1066 S_FreeSfx (sfx, false);
1076 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean serversound)
1080 if (!snd_initialized.integer)
1083 if (name == NULL || name[0] == 0)
1086 sfx = S_FindName (name);
1091 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1092 // previously missing file
1093 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1095 if (serversound && !(sfx->flags & SFXFLAG_SERVERSOUND))
1098 sfx->flags |= SFXFLAG_SERVERSOUND;
1101 if (!nosound.integer && snd_precache.integer)
1102 S_LoadSound(sfx, complain);
1113 float S_SoundLength(const char *name)
1117 if (!snd_initialized.integer)
1119 if (name == NULL || name[0] == 0)
1122 sfx = S_FindName(name);
1125 return sfx->total_length / (float) S_GetSoundRate();
1133 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1135 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1145 void S_LockSfx (sfx_t *sfx)
1154 Remove a lock from a SFX
1157 void S_UnlockSfx (sfx_t *sfx)
1168 void S_BlockSound (void)
1179 void S_UnblockSound (void)
1189 Picks a channel based on priorities, empty slots, number of channels
1192 channel_t *SND_PickChannel(int entnum, int entchannel)
1196 int first_life_left, life_left;
1199 // Check for replacement sound, or find the best one to replace
1201 first_life_left = 0x7fffffff;
1203 // entity channels try to replace the existing sound on the channel
1204 if (entchannel != 0)
1206 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1208 ch = &channels[ch_idx];
1209 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1211 // always override sound from same entity
1212 S_StopChannel (ch_idx, true);
1213 return &channels[ch_idx];
1218 // there was no channel to override, so look for the first empty one
1219 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1221 ch = &channels[ch_idx];
1224 // no sound on this channel
1225 first_to_die = ch_idx;
1226 goto emptychan_found;
1229 // don't let monster sounds override player sounds
1230 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1233 // don't override looped sounds
1234 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1236 life_left = ch->sfx->total_length - ch->pos;
1238 if (life_left < first_life_left)
1240 first_life_left = life_left;
1241 first_to_die = ch_idx;
1245 if (first_to_die == -1)
1248 S_StopChannel (first_to_die, true);
1251 return &channels[first_to_die];
1258 Spatializes a channel
1261 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1262 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1266 vec_t dist, mastervol, intensity, vol;
1269 // update sound origin if we know about the entity
1270 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1272 if (ch->entnum >= MAX_EDICTS)
1274 //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]);
1276 if (ch->entnum > MAX_EDICTS)
1277 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1278 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1280 else if (cl.entities[ch->entnum].state_current.active)
1283 //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]);
1284 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1285 if (model && model->soundfromcenter)
1286 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1288 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1292 mastervol = ch->master_vol;
1294 // Adjust volume of static sounds
1296 mastervol *= snd_staticvolume.value;
1297 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1299 if(ch->entnum >= MAX_EDICTS)
1301 switch(ch->entchannel)
1303 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1304 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1305 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1306 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1307 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1308 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1309 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1310 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1314 else if(ch->entnum == 0)
1316 switch(ch->entchannel)
1318 case 0: mastervol *= snd_worldchannel0volume.value; break;
1319 case 1: mastervol *= snd_worldchannel1volume.value; break;
1320 case 2: mastervol *= snd_worldchannel2volume.value; break;
1321 case 3: mastervol *= snd_worldchannel3volume.value; break;
1322 case 4: mastervol *= snd_worldchannel4volume.value; break;
1323 case 5: mastervol *= snd_worldchannel5volume.value; break;
1324 case 6: mastervol *= snd_worldchannel6volume.value; break;
1325 case 7: mastervol *= snd_worldchannel7volume.value; break;
1329 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1331 switch(ch->entchannel)
1333 case 0: mastervol *= snd_playerchannel0volume.value; break;
1334 case 1: mastervol *= snd_playerchannel1volume.value; break;
1335 case 2: mastervol *= snd_playerchannel2volume.value; break;
1336 case 3: mastervol *= snd_playerchannel3volume.value; break;
1337 case 4: mastervol *= snd_playerchannel4volume.value; break;
1338 case 5: mastervol *= snd_playerchannel5volume.value; break;
1339 case 6: mastervol *= snd_playerchannel6volume.value; break;
1340 case 7: mastervol *= snd_playerchannel7volume.value; break;
1346 switch(ch->entchannel)
1348 case 0: mastervol *= snd_entchannel0volume.value; break;
1349 case 1: mastervol *= snd_entchannel1volume.value; break;
1350 case 2: mastervol *= snd_entchannel2volume.value; break;
1351 case 3: mastervol *= snd_entchannel3volume.value; break;
1352 case 4: mastervol *= snd_entchannel4volume.value; break;
1353 case 5: mastervol *= snd_entchannel5volume.value; break;
1354 case 6: mastervol *= snd_entchannel6volume.value; break;
1355 case 7: mastervol *= snd_entchannel7volume.value; break;
1361 // anything coming from the view entity will always be full volume
1362 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1363 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1365 for (i = 0;i < SND_LISTENERS;i++)
1367 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1368 ch->listener_volume[i] = (int)bound(0, vol, 255);
1373 // calculate stereo seperation and distance attenuation
1374 VectorSubtract(listener_origin, ch->origin, source_vec);
1375 dist = VectorLength(source_vec);
1376 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1379 qboolean occluded = false;
1380 if (snd_spatialization_occlusion.integer)
1382 if(snd_spatialization_occlusion.integer & 1)
1385 int cluster = cl.worldmodel->brush.PointInLeaf(cl.worldmodel, ch->origin)->clusterindex;
1386 if(cluster >= 0 && cluster < 8 * listener_pvsbytes && !CHECKPVSBIT(listener_pvs, cluster))
1390 if(snd_spatialization_occlusion.integer & 2)
1392 if(cl.worldmodel && cl.worldmodel->brush.TraceLineOfSight && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1398 for (i = 0;i < SND_LISTENERS;i++)
1400 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1401 VectorNormalize(source_vec);
1403 switch(spatialmethod)
1407 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1409 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1410 VectorScale(source_vec, f, source_vec);
1413 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1414 f = spatialmin + spatialdiff * bound(0, f, 1);
1415 VectorScale(source_vec, f, source_vec);
1417 case SPATIAL_THRESH:
1418 f = spatialmin + spatialdiff * (dist < spatialoffset);
1419 VectorScale(source_vec, f, source_vec);
1426 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1428 ch->listener_volume[i] = (int)bound(0, vol, 255);
1432 for (i = 0;i < SND_LISTENERS;i++)
1433 ch->listener_volume[i] = 0;
1438 // =======================================================================
1439 // Start a sound effect
1440 // =======================================================================
1442 static void S_SetChannelVolume_WithSfx (unsigned int ch_ind, float fvol, sfx_t *sfx);
1443 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)
1447 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1450 // Initialize the channel
1451 // a crash was reported on an in-use channel, so check here...
1452 if (target_chan->sfx)
1454 int channelindex = (int)(target_chan - channels);
1455 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1456 S_StopChannel (channelindex, true);
1458 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1459 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1460 memset (target_chan, 0, sizeof (*target_chan));
1461 VectorCopy (origin, target_chan->origin);
1462 target_chan->flags = flags;
1463 target_chan->pos = startpos; // start of the sound
1464 target_chan->entnum = entnum;
1465 target_chan->entchannel = entchannel;
1467 // If it's a static sound
1470 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1471 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1472 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1475 target_chan->dist_mult = attenuation / snd_soundradius.value;
1477 // we have to set the channel volume AFTER the sfx because the function
1478 // needs it for replaygain support
1479 S_SetChannelVolume_WithSfx(target_chan - channels, fvol, sfx);
1481 // set the listener volumes
1482 SND_Spatialize (target_chan, isstatic);
1484 // Lock the SFX during play
1487 // finally, set the sfx pointer, so the channel becomes valid for playback
1488 // and will be noticed by the mixer
1489 target_chan->sfx = sfx;
1493 int S_StartSound_StartPosition (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation, float startposition)
1495 channel_t *target_chan, *check, *ch;
1496 int ch_idx, startpos;
1498 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1501 if(sfx == &changevolume_sfx)
1505 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1507 ch = &channels[ch_idx];
1508 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1510 S_SetChannelVolume(ch_idx, fvol);
1511 ch->dist_mult = attenuation / snd_soundradius.value;
1512 SND_Spatialize(ch, false);
1519 if (sfx->fetcher == NULL)
1522 // Pick a channel to play on
1523 target_chan = SND_PickChannel(entnum, entchannel);
1527 // if an identical sound has also been started this frame, offset the pos
1528 // a bit to keep it from just making the first one louder
1529 check = &channels[NUM_AMBIENTS];
1530 startpos = (int)(startposition * S_GetSoundRate());
1533 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1535 if (check == target_chan)
1537 if (check->sfx == sfx && check->pos == 0)
1539 // use negative pos offset to delay this sound effect
1540 startpos = (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1546 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false, entnum, entchannel, startpos);
1548 return (target_chan - channels);
1551 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1553 return S_StartSound_StartPosition(entnum, entchannel, sfx, origin, fvol, attenuation, 0);
1556 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex)
1560 if (channel_ind >= total_channels)
1563 // we have to lock an audio mutex to prevent crashes if an audio mixer
1564 // thread is currently mixing this channel
1565 // the SndSys_LockRenderBuffer function uses such a mutex in
1566 // threaded sound backends
1567 if (lockmutex && !simsound)
1568 SndSys_LockRenderBuffer();
1570 ch = &channels[channel_ind];
1571 if (ch->sfx != NULL)
1573 sfx_t *sfx = ch->sfx;
1575 if (sfx->fetcher != NULL)
1577 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1578 if (fetcher_endsb != NULL)
1579 fetcher_endsb (ch->fetcher_data);
1582 // Remove the lock it holds
1585 ch->fetcher_data = NULL;
1588 if (lockmutex && !simsound)
1589 SndSys_UnlockRenderBuffer();
1593 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1595 if (ch_ind >= total_channels)
1598 if (flag != CHANNELFLAG_FORCELOOP &&
1599 flag != CHANNELFLAG_PAUSED &&
1600 flag != CHANNELFLAG_FULLVOLUME &&
1601 flag != CHANNELFLAG_LOCALSOUND)
1605 channels[ch_ind].flags |= flag;
1607 channels[ch_ind].flags &= ~flag;
1612 void S_StopSound(int entnum, int entchannel)
1616 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1617 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1619 S_StopChannel (i, true);
1624 extern void CDAudio_Stop(void);
1625 void S_StopAllSounds (void)
1629 // TOCHECK: is this test necessary?
1630 if (snd_renderbuffer == NULL)
1633 // stop CD audio because it may be using a faketrack
1636 if (simsound || SndSys_LockRenderBuffer ())
1641 for (i = 0; i < total_channels; i++)
1642 S_StopChannel (i, false);
1644 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1645 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1647 // Mute the contents of the submittion buffer
1648 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1649 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1650 memset(snd_renderbuffer->ring, clear, memsize);
1653 SndSys_UnlockRenderBuffer ();
1657 void S_PauseGameSounds (qboolean toggle)
1661 for (i = 0; i < total_channels; i++)
1666 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1667 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1671 static void S_SetChannelVolume_WithSfx (unsigned int ch_ind, float fvol, sfx_t *sfx)
1673 if(sfx->volume_peak > 0)
1675 // Replaygain support
1676 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1677 fvol *= sfx->volume_mult;
1678 if(fvol * sfx->volume_peak > 1)
1679 fvol = 1 / sfx->volume_peak;
1680 // Con_DPrintf("%f\n", fvol);
1682 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1685 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1687 sfx_t *sfx = channels[ch_ind].sfx;
1689 S_SetChannelVolume_WithSfx(ch_ind, fvol, sfx);
1692 float S_GetChannelPosition (unsigned int ch_ind)
1694 // note: this is NOT accurate yet
1696 channel_t *ch = &channels[ch_ind];
1697 sfx_t *sfx = ch->sfx;
1703 if(!snd_usethreadedmixing)
1704 s += _snd_mixahead.value * S_GetSoundRate();
1706 return (s % sfx->total_length) / (float) S_GetSoundRate();
1709 float S_GetEntChannelPosition(int entnum, int entchannel)
1714 for (i = 0; i < total_channels; i++)
1717 if (ch->entnum == entnum && ch->entchannel == entchannel)
1718 return S_GetChannelPosition(i);
1720 return -1; // no playing sound in this channel
1728 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1730 channel_t *target_chan;
1732 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1736 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1740 if (total_channels == MAX_CHANNELS)
1742 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1746 target_chan = &channels[total_channels++];
1747 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0);
1753 S_UpdateAmbientSounds
1756 void S_UpdateAmbientSounds (void)
1760 int ambient_channel;
1762 unsigned char ambientlevels[NUM_AMBIENTS];
1764 memset(ambientlevels, 0, sizeof(ambientlevels));
1765 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1766 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1768 // Calc ambient sound levels
1769 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1771 chan = &channels[ambient_channel];
1772 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1775 vol = (int)ambientlevels[ambient_channel];
1779 // Don't adjust volume too fast
1780 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1781 if (cl.time > cl.oldtime)
1783 if (chan->master_vol < vol)
1785 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1786 if (chan->master_vol > vol)
1787 chan->master_vol = vol;
1789 else if (chan->master_vol > vol)
1791 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1792 if (chan->master_vol < vol)
1793 chan->master_vol = vol;
1797 for (i = 0;i < SND_LISTENERS;i++)
1798 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1802 static void S_PaintAndSubmit (void)
1804 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1805 int usesoundtimehack;
1806 static int soundtimehack = -1;
1807 static int oldsoundtime = 0;
1809 if (snd_renderbuffer == NULL || nosound.integer)
1812 // Update sound time
1813 snd_usethreadedmixing = false;
1814 usesoundtimehack = true;
1815 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1817 usesoundtimehack = 1;
1818 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1820 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1822 usesoundtimehack = 2;
1823 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1827 usesoundtimehack = 3;
1828 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1832 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1833 usesoundtimehack = 0;
1834 newsoundtime = SndSys_GetSoundTime();
1836 // if the soundtimehack state changes we need to reset the soundtime
1837 if (soundtimehack != usesoundtimehack)
1839 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1841 // Mute the contents of the submission buffer
1842 if (simsound || SndSys_LockRenderBuffer ())
1847 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1848 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1849 memset(snd_renderbuffer->ring, clear, memsize);
1852 SndSys_UnlockRenderBuffer ();
1855 soundtimehack = usesoundtimehack;
1857 if (!soundtimehack && snd_blocked > 0)
1860 if (snd_usethreadedmixing)
1861 return; // the audio thread will mix its own data
1863 newsoundtime += extrasoundtime;
1864 if (newsoundtime < soundtime)
1866 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1868 unsigned int additionaltime;
1870 // add some time to extrasoundtime make newsoundtime higher
1872 // The extra time must be a multiple of the render buffer size
1873 // to avoid modifying the current position in the buffer,
1874 // some modules write directly to a shared (DMA) buffer
1875 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1876 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1878 extrasoundtime += additionaltime;
1879 newsoundtime += additionaltime;
1880 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1883 else if (!soundtimehack)
1884 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1885 newsoundtime, soundtime);
1887 soundtime = newsoundtime;
1888 recording_sound = (cls.capturevideo.soundrate != 0);
1890 // Lock submitbuffer
1891 if (!simsound && !SndSys_LockRenderBuffer())
1893 // If the lock failed, stop here
1894 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
1898 // Check to make sure that we haven't overshot
1899 paintedtime = snd_renderbuffer->endframe;
1900 if (paintedtime < soundtime)
1901 paintedtime = soundtime;
1903 // mix ahead of current position
1905 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1907 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
1908 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1909 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1910 endtime = min(endtime, maxtime);
1912 while (paintedtime < endtime)
1914 unsigned int startoffset;
1915 unsigned int nbframes;
1917 // see how much we can fit in the paint buffer
1918 nbframes = endtime - paintedtime;
1919 // limit to the end of the ring buffer (in case of wrapping)
1920 startoffset = paintedtime % snd_renderbuffer->maxframes;
1921 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
1923 // mix into the buffer
1924 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
1926 paintedtime += nbframes;
1927 snd_renderbuffer->endframe = paintedtime;
1930 SndSys_UnlockRenderBuffer();
1932 // Remove outdated samples from the ring buffer, if any
1933 if (snd_renderbuffer->startframe < soundtime)
1934 snd_renderbuffer->startframe = soundtime;
1937 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1941 oldsoundtime = soundtime;
1943 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
1944 R_TimeReport("audiomix");
1951 Called once each time through the main loop
1954 void S_Update(const matrix4x4_t *listenermatrix)
1956 unsigned int i, j, k;
1957 channel_t *ch, *combine;
1958 matrix4x4_t basematrix, rotatematrix;
1960 if (snd_renderbuffer == NULL || nosound.integer)
1964 double mindist_trans, maxdist_trans;
1966 spatialmin = snd_spatialization_min.value;
1967 spatialdiff = snd_spatialization_max.value - spatialmin;
1969 if(snd_spatialization_control.value)
1971 spatialpower = snd_spatialization_power.value;
1973 if(spatialpower == 0)
1975 spatialmethod = SPATIAL_LOG;
1976 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
1977 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
1981 spatialmethod = SPATIAL_POW;
1982 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
1983 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
1986 if(mindist_trans - maxdist_trans == 0)
1988 spatialmethod = SPATIAL_THRESH;
1989 mindist_trans = snd_spatialization_min_radius.value;
1993 spatialoffset = mindist_trans;
1994 spatialfactor = 1 / (maxdist_trans - mindist_trans);
1998 spatialmethod = SPATIAL_NONE;
2002 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
2003 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
2004 current_channellayout != snd_channellayout.integer)
2005 S_SetChannelLayout();
2007 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
2008 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
2009 if (cl.worldmodel && cl.worldmodel->brush.FatPVS && cl.worldmodel->brush.num_pvsclusterbytes && cl.worldmodel->brush.PointInLeaf)
2011 if(cl.worldmodel->brush.num_pvsclusterbytes != listener_pvsbytes)
2014 Mem_Free(listener_pvs);
2015 listener_pvsbytes = cl.worldmodel->brush.num_pvsclusterbytes;
2016 listener_pvs = (unsigned char *) Mem_Alloc(snd_mempool, listener_pvsbytes);
2018 cl.worldmodel->brush.FatPVS(cl.worldmodel, listener_origin, 2, listener_pvs, listener_pvsbytes, 0);
2024 Mem_Free(listener_pvs);
2025 listener_pvs = NULL;
2027 listener_pvsbytes = 0;
2030 // calculate the current matrices
2031 for (j = 0;j < SND_LISTENERS;j++)
2033 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2034 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
2035 // I think this should now do this:
2036 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2037 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2038 // angle has to be taken negative)
2039 // 2. create a transform which first rotates and moves its argument
2040 // into the player's view coordinates (using basematrix which is
2041 // an inverted "absolute" listener matrix), then applies the
2042 // rotation matrix for the ear
2043 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2044 // does not actually refer to an entity?
2047 // update general area ambient sound sources
2048 S_UpdateAmbientSounds ();
2051 R_TimeReport("audioprep");
2053 // update spatialization for static and dynamic sounds
2054 cls.soundstats.totalsounds = 0;
2055 cls.soundstats.mixedsounds = 0;
2056 ch = channels+NUM_AMBIENTS;
2057 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2061 cls.soundstats.totalsounds++;
2063 // respatialize channel
2064 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2066 // try to combine static sounds with a previous channel of the same
2067 // sound effect so we don't mix five torches every frame
2068 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2070 // no need to merge silent channels
2071 for (j = 0;j < SND_LISTENERS;j++)
2072 if (ch->listener_volume[j])
2074 if (j == SND_LISTENERS)
2076 // if the last combine chosen isn't suitable, find a new one
2077 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2081 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2083 if (channels[j].sfx == ch->sfx)
2085 combine = channels + j;
2090 if (combine && combine != ch && combine->sfx == ch->sfx)
2092 for (j = 0;j < SND_LISTENERS;j++)
2094 combine->listener_volume[j] += ch->listener_volume[j];
2095 ch->listener_volume[j] = 0;
2099 for (k = 0;k < SND_LISTENERS;k++)
2100 if (ch->listener_volume[k])
2102 if (k < SND_LISTENERS)
2103 cls.soundstats.mixedsounds++;
2105 R_TimeReport("audiospatialize");
2107 sound_spatialized = true;
2110 if (snd_show.integer)
2111 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2116 void S_ExtraUpdate (void)
2118 if (snd_noextraupdate.integer || !sound_spatialized)
2124 qboolean S_LocalSound (const char *sound)
2129 if (!snd_initialized.integer || nosound.integer)
2132 sfx = S_PrecacheSound (sound, true, false);
2135 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2139 // Local sounds must not be freed
2140 sfx->flags |= SFXFLAG_PERMANENTLOCK;
2142 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2146 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;