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"
30 #define SND_MIN_SPEED 8000
31 #define SND_MAX_SPEED 96000
32 #define SND_MIN_WIDTH 1
33 #define SND_MAX_WIDTH 2
34 #define SND_MIN_CHANNELS 1
35 #define SND_MAX_CHANNELS 8
37 #if SND_LISTENERS != 8
38 # error this data only supports up to 8 channel, update it!
40 typedef struct listener_s
48 typedef struct speakerlayout_s
51 unsigned int channels;
52 listener_t listeners[SND_LISTENERS];
56 static speakerlayout_t snd_speakerlayout;
58 // Our speaker layouts are based on ALSA. They differ from those
59 // Win32 and Mac OS X APIs use when there's more than 4 channels.
60 // (rear left + rear right, and front center + LFE are swapped).
61 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
62 static const speakerlayout_t snd_speakerlayouts[] =
67 {45, 0.2, 0.2, 0.5}, // front left
68 {315, 0.2, 0.2, 0.5}, // front right
69 {135, 0.2, 0.2, 0.5}, // rear left
70 {225, 0.2, 0.2, 0.5}, // rear right
71 {0, 0.2, 0.2, 0.5}, // front center
72 {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)
73 {90, 0.2, 0.2, 0.5}, // side left
74 {180, 0.2, 0.2, 0.5}, // side right
80 {45, 0.2, 0.2, 0.5}, // front left
81 {315, 0.2, 0.2, 0.5}, // front right
82 {135, 0.2, 0.2, 0.5}, // rear left
83 {225, 0.2, 0.2, 0.5}, // rear right
84 {0, 0.2, 0.2, 0.5}, // front center
85 {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)
91 // these systems sometimes have a subwoofer as well, but it has no
95 {45, 0.3, 0.3, 0.8}, // front left
96 {315, 0.3, 0.3, 0.8}, // front right
97 {135, 0.3, 0.3, 0.8}, // rear left
98 {225, 0.3, 0.3, 0.8}, // rear right
106 // these systems sometimes have a subwoofer as well, but it has no
107 // channel of its own
110 {90, 0.5, 0.5, 1}, // side left
111 {270, 0.5, 0.5, 1}, // side right
123 {0, 0, 1, 1}, // center
136 // =======================================================================
137 // Internal sound data & structures
138 // =======================================================================
140 channel_t channels[MAX_CHANNELS];
141 unsigned int total_channels;
143 snd_ringbuffer_t *snd_renderbuffer = NULL;
144 static unsigned int soundtime = 0;
145 static unsigned int oldpaintedtime = 0;
146 static unsigned int extrasoundtime = 0;
147 static double snd_starttime = 0.0;
148 qboolean snd_threaded = false;
149 qboolean snd_usethreadedmixing = false;
151 vec3_t listener_origin;
152 matrix4x4_t listener_matrix[SND_LISTENERS];
153 mempool_t *snd_mempool;
155 // Linked list of known sfx
156 static sfx_t *known_sfx = NULL;
158 static qboolean sound_spatialized = false;
160 qboolean simsound = false;
162 static qboolean recording_sound = false;
165 static int current_swapstereo = false;
166 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
167 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
169 static double spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
170 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
171 spatialmethod_t spatialmethod;
173 // Cvars declared in sound.h (part of the sound API)
174 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
175 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
176 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
177 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
178 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)"};
179 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
180 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
181 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
182 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
183 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
184 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
186 // Cvars declared in snd_main.h (shared with other snd_*.c files)
187 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
188 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)"};
189 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
190 extern cvar_t v_flipped;
191 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
192 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
193 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities"};
194 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities"};
195 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities"};
196 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities"};
197 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities"};
198 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities"};
199 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities"};
200 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities"};
201 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities"};
202 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities"};
203 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities"};
204 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities"};
205 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities"};
206 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities"};
207 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities"};
208 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities"};
209 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
210 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
211 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
212 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
213 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
214 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
215 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
216 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
217 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
218 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
219 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
220 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
221 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
222 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
223 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
224 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
227 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
228 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
229 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
230 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
231 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"};
232 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
234 // Default sound format is 48KHz, 16-bit, stereo
235 // (48KHz because a lot of onboard sound cards sucks at any other speed)
236 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
237 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
238 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)"};
241 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
242 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
245 // ====================================================================
247 // ====================================================================
249 void S_FreeSfx (sfx_t *sfx, qboolean force);
251 static void S_Play_Common (float fvol, float attenuation)
254 char name [MAX_QPATH];
258 while (i < Cmd_Argc ())
260 // Get the name, and appends ".wav" as an extension if there's none
261 strlcpy (name, Cmd_Argv (i), sizeof (name));
262 if (!strrchr (name, '.'))
263 strlcat (name, ".wav", sizeof (name));
266 // If we need to get the volume from the command line
269 fvol = atof (Cmd_Argv (i));
273 sfx = S_PrecacheSound (name, true, false);
276 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
278 // Free the sfx if the file didn't exist
280 S_FreeSfx (sfx, false);
282 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
287 static void S_Play_f(void)
289 S_Play_Common (1.0f, 1.0f);
292 static void S_Play2_f(void)
294 S_Play_Common (1.0f, 0.0f);
297 static void S_PlayVol_f(void)
299 S_Play_Common (-1.0f, 0.0f);
302 static void S_SoundList_f (void)
309 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
311 if (sfx->fetcher != NULL)
314 const snd_format_t* format;
317 format = sfx->fetcher->getfmt(sfx);
318 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
319 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
320 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
321 (sfx->locks > 0) ? 'K' : ' ',
322 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
324 (format->channels == 1) ? "mono" : "stereo",
330 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
332 Con_Printf("Total resident: %i\n", total);
336 void S_SoundInfo_f(void)
338 if (snd_renderbuffer == NULL)
340 Con_Print("sound system not started\n");
344 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
345 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
346 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
347 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
348 Con_Printf("%5u total_channels\n", total_channels);
352 int S_GetSoundRate(void)
354 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
357 int S_GetSoundChannels(void)
359 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
363 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
365 static const snd_format_t thresholds [] =
367 // speed width channels
368 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
374 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
376 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
377 unsigned int speed_level, width_level, channels_level;
379 // If we have reached the minimum values, there's nothing more we can do
380 if ((format->speed == thresholds[0].speed || fixed_speed) &&
381 (format->width == thresholds[0].width || fixed_width) &&
382 (format->channels == thresholds[0].channels || fixed_channels))
385 // Check the min and max values
386 #define CHECK_BOUNDARIES(param) \
387 if (format->param < thresholds[0].param) \
389 format->param = thresholds[0].param; \
392 if (format->param > thresholds[nb_thresholds - 1].param) \
394 format->param = thresholds[nb_thresholds - 1].param; \
397 CHECK_BOUNDARIES(speed);
398 CHECK_BOUNDARIES(width);
399 CHECK_BOUNDARIES(channels);
400 #undef CHECK_BOUNDARIES
402 // Find the level of each parameter
403 #define FIND_LEVEL(param) \
405 while (param##_level < nb_thresholds - 1) \
407 if (format->param <= thresholds[param##_level].param) \
414 FIND_LEVEL(channels);
417 // Decrease the parameter with the highest level to the previous level
418 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
420 format->channels = thresholds[channels_level - 1].channels;
423 if (speed_level >= width_level && !fixed_speed)
425 format->speed = thresholds[speed_level - 1].speed;
429 format->width = thresholds[width_level - 1].width;
434 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
436 static void S_SetChannelLayout (void)
439 listener_t swaplistener;
440 listener_t *listeners;
443 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
444 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
446 if (i >= SND_SPEAKERLAYOUTS)
448 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
449 snd_renderbuffer->format.channels);
450 i = SND_SPEAKERLAYOUTS - 1;
453 snd_speakerlayout = snd_speakerlayouts[i];
454 listeners = snd_speakerlayout.listeners;
456 // Swap the left and right channels if snd_swapstereo is set
457 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
459 switch (snd_speakerlayout.channels)
462 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
466 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
469 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
480 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
481 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
482 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
484 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
486 // If we're in the sound engine initialization
487 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
489 layout = SND_CHANNELLAYOUT_STANDARD;
490 Cvar_SetValueQuick (&snd_channellayout, layout);
493 layout = current_channellayout_used;
496 layout = snd_channellayout.integer;
498 // Convert our layout (= ALSA) to the standard layout if necessary
499 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
501 if (layout == SND_CHANNELLAYOUT_STANDARD)
503 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
504 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
507 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
508 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
511 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
512 current_channellayout = snd_channellayout.integer;
513 current_channellayout_used = layout;
517 void S_Startup (void)
519 qboolean fixed_speed, fixed_width, fixed_channels;
520 snd_format_t chosen_fmt;
521 static snd_format_t prev_render_format = {0, 0, 0};
528 if (!snd_initialized.integer)
533 fixed_channels = false;
535 // Get the starting sound format from the cvars
536 chosen_fmt.speed = snd_speed.integer;
537 chosen_fmt.width = snd_width.integer;
538 chosen_fmt.channels = snd_channels.integer;
540 // Check the environment variables to see if the player wants a particular sound format
542 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
544 env = getenv("QUAKE_SOUND_CHANNELS");
548 chosen_fmt.channels = atoi (env);
552 fixed_channels = true;
555 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
557 env = getenv("QUAKE_SOUND_SPEED");
561 chosen_fmt.speed = atoi (env);
568 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
570 env = getenv("QUAKE_SOUND_SAMPLEBITS");
574 chosen_fmt.width = atoi (env) / 8;
581 // Parse the command line to see if the player wants a particular sound format
582 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
583 if (COM_CheckParm ("-sndquad") != 0)
585 chosen_fmt.channels = 4;
586 fixed_channels = true;
588 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
589 else if (COM_CheckParm ("-sndstereo") != 0)
591 chosen_fmt.channels = 2;
592 fixed_channels = true;
594 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
595 else if (COM_CheckParm ("-sndmono") != 0)
597 chosen_fmt.channels = 1;
598 fixed_channels = true;
600 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
601 i = COM_CheckParm ("-sndspeed");
602 if (0 < i && i < com_argc - 1)
604 chosen_fmt.speed = atoi (com_argv[i + 1]);
607 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
608 i = COM_CheckParm ("-sndbits");
609 if (0 < i && i < com_argc - 1)
611 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
615 // You can't change sound speed after start time (not yet supported)
616 if (prev_render_format.speed != 0)
619 if (chosen_fmt.speed != prev_render_format.speed)
621 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
622 prev_render_format.speed);
623 chosen_fmt.speed = prev_render_format.speed;
628 if (chosen_fmt.speed < SND_MIN_SPEED)
630 chosen_fmt.speed = SND_MIN_SPEED;
633 else if (chosen_fmt.speed > SND_MAX_SPEED)
635 chosen_fmt.speed = SND_MAX_SPEED;
639 if (chosen_fmt.width < SND_MIN_WIDTH)
641 chosen_fmt.width = SND_MIN_WIDTH;
644 else if (chosen_fmt.width > SND_MAX_WIDTH)
646 chosen_fmt.width = SND_MAX_WIDTH;
650 if (chosen_fmt.channels < SND_MIN_CHANNELS)
652 chosen_fmt.channels = SND_MIN_CHANNELS;
653 fixed_channels = false;
655 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
657 chosen_fmt.channels = SND_MAX_CHANNELS;
658 fixed_channels = false;
661 // create the sound buffer used for sumitting the samples to the plaform-dependent module
664 snd_format_t suggest_fmt;
670 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
671 chosen_fmt.speed, chosen_fmt.width * 8,
672 chosen_fmt.channels);
674 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
675 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
679 Con_Printf("S_Startup: sound output initialization FAILED\n");
681 // If the module is suggesting another one
682 if (suggest_fmt.speed != 0)
684 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
685 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
686 suggest_fmt.speed, suggest_fmt.width * 8,
687 suggest_fmt.channels);
689 // Else, try to find a less resource-demanding format
690 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
695 // If we haven't found a suitable format
698 Con_Print("S_Startup: SndSys_Init failed.\n");
699 sound_spatialized = false;
705 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
706 Con_Print ("S_Startup: simulating sound output\n");
709 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
710 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
711 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
714 if (snd_speed.integer != (int)chosen_fmt.speed)
715 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
716 if (snd_width.integer != chosen_fmt.width)
717 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
718 if (snd_channels.integer != chosen_fmt.channels)
719 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
721 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
722 S_SetChannelLayout();
724 snd_starttime = realtime;
726 // If the sound module has already run, add an extra time to make sure
727 // the sound time doesn't decrease, to not confuse playing SFXs
728 if (oldpaintedtime != 0)
730 // The extra time must be a multiple of the render buffer size
731 // to avoid modifying the current position in the buffer,
732 // some modules write directly to a shared (DMA) buffer
733 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
734 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
735 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
737 soundtime = extrasoundtime;
741 snd_renderbuffer->startframe = soundtime;
742 snd_renderbuffer->endframe = soundtime;
743 recording_sound = false;
746 void S_Shutdown(void)
748 if (snd_renderbuffer == NULL)
751 oldpaintedtime = snd_renderbuffer->endframe;
755 Mem_Free(snd_renderbuffer->ring);
756 Mem_Free(snd_renderbuffer);
757 snd_renderbuffer = NULL;
762 sound_spatialized = false;
765 void S_Restart_f(void)
767 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
768 // So, refuse to do this if we are connected.
769 if(cls.state == ca_connected)
771 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
786 Cvar_RegisterVariable(&volume);
787 Cvar_RegisterVariable(&bgmvolume);
788 Cvar_RegisterVariable(&snd_staticvolume);
789 Cvar_RegisterVariable(&snd_entchannel0volume);
790 Cvar_RegisterVariable(&snd_entchannel1volume);
791 Cvar_RegisterVariable(&snd_entchannel2volume);
792 Cvar_RegisterVariable(&snd_entchannel3volume);
793 Cvar_RegisterVariable(&snd_entchannel4volume);
794 Cvar_RegisterVariable(&snd_entchannel5volume);
795 Cvar_RegisterVariable(&snd_entchannel6volume);
796 Cvar_RegisterVariable(&snd_entchannel7volume);
797 Cvar_RegisterVariable(&snd_worldchannel0volume);
798 Cvar_RegisterVariable(&snd_worldchannel1volume);
799 Cvar_RegisterVariable(&snd_worldchannel2volume);
800 Cvar_RegisterVariable(&snd_worldchannel3volume);
801 Cvar_RegisterVariable(&snd_worldchannel4volume);
802 Cvar_RegisterVariable(&snd_worldchannel5volume);
803 Cvar_RegisterVariable(&snd_worldchannel6volume);
804 Cvar_RegisterVariable(&snd_worldchannel7volume);
805 Cvar_RegisterVariable(&snd_playerchannel0volume);
806 Cvar_RegisterVariable(&snd_playerchannel1volume);
807 Cvar_RegisterVariable(&snd_playerchannel2volume);
808 Cvar_RegisterVariable(&snd_playerchannel3volume);
809 Cvar_RegisterVariable(&snd_playerchannel4volume);
810 Cvar_RegisterVariable(&snd_playerchannel5volume);
811 Cvar_RegisterVariable(&snd_playerchannel6volume);
812 Cvar_RegisterVariable(&snd_playerchannel7volume);
813 Cvar_RegisterVariable(&snd_csqcchannel0volume);
814 Cvar_RegisterVariable(&snd_csqcchannel1volume);
815 Cvar_RegisterVariable(&snd_csqcchannel2volume);
816 Cvar_RegisterVariable(&snd_csqcchannel3volume);
817 Cvar_RegisterVariable(&snd_csqcchannel4volume);
818 Cvar_RegisterVariable(&snd_csqcchannel5volume);
819 Cvar_RegisterVariable(&snd_csqcchannel6volume);
820 Cvar_RegisterVariable(&snd_csqcchannel7volume);
822 Cvar_RegisterVariable(&snd_spatialization_min_radius);
823 Cvar_RegisterVariable(&snd_spatialization_max_radius);
824 Cvar_RegisterVariable(&snd_spatialization_min);
825 Cvar_RegisterVariable(&snd_spatialization_max);
826 Cvar_RegisterVariable(&snd_spatialization_power);
827 Cvar_RegisterVariable(&snd_spatialization_control);
829 Cvar_RegisterVariable(&snd_speed);
830 Cvar_RegisterVariable(&snd_width);
831 Cvar_RegisterVariable(&snd_channels);
832 Cvar_RegisterVariable(&snd_mutewhenidle);
834 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
835 if (COM_CheckParm("-nosound"))
837 // dummy out Play and Play2 because mods stuffcmd that
838 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
839 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
843 snd_mempool = Mem_AllocPool("sound", 0, NULL);
845 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
846 if (COM_CheckParm("-simsound"))
849 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
850 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
851 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
852 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
853 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
854 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
855 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
856 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
858 Cvar_RegisterVariable(&nosound);
859 Cvar_RegisterVariable(&snd_precache);
860 Cvar_RegisterVariable(&snd_initialized);
861 Cvar_RegisterVariable(&snd_streaming);
862 Cvar_RegisterVariable(&ambient_level);
863 Cvar_RegisterVariable(&ambient_fade);
864 Cvar_RegisterVariable(&snd_noextraupdate);
865 Cvar_RegisterVariable(&snd_show);
866 Cvar_RegisterVariable(&_snd_mixahead);
867 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
868 Cvar_RegisterVariable(&snd_channellayout);
869 Cvar_RegisterVariable(&snd_soundradius);
871 Cvar_SetValueQuick(&snd_initialized, true);
875 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
876 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
879 ModPlug_OpenLibrary ();
887 Shutdown and free all resources
890 void S_Terminate (void)
893 ModPlug_CloseLibrary ();
897 while (known_sfx != NULL)
898 S_FreeSfx (known_sfx, true);
900 Cvar_SetValueQuick (&snd_initialized, false);
901 Mem_FreePool (&snd_mempool);
910 void S_UnloadAllSounds_f (void)
914 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
915 // So, refuse to do this if we are connected.
916 if(cls.state == ca_connected)
918 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
922 // stop any active sounds
925 // because the ambient sounds will be freed, clear the pointers
926 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
927 ambient_sfxs[i] = NULL;
929 // now free all sounds
930 while (known_sfx != NULL)
931 S_FreeSfx (known_sfx, true);
940 sfx_t *S_FindName (const char *name)
944 if (!snd_initialized.integer)
947 if (strlen (name) >= sizeof (sfx->name))
949 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
953 // Look for this sound in the list of known sfx
954 // TODO: hash table search?
955 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
956 if(!strcmp (sfx->name, name))
959 // Add a sfx_t struct for this sound
960 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
961 memset (sfx, 0, sizeof(*sfx));
962 strlcpy (sfx->name, name, sizeof (sfx->name));
963 sfx->memsize = sizeof(*sfx);
964 sfx->next = known_sfx;
976 void S_FreeSfx (sfx_t *sfx, qboolean force)
980 // Never free a locked sfx unless forced
981 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
984 if (developer_loading.integer)
985 Con_Printf ("unloading sound %s\n", sfx->name);
987 // Remove it from the list of known sfx
988 if (sfx == known_sfx)
989 known_sfx = known_sfx->next;
994 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
995 if (prev_sfx->next == sfx)
997 prev_sfx->next = sfx->next;
1000 if (prev_sfx == NULL)
1002 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
1007 // Stop all channels using this sfx
1008 for (i = 0; i < total_channels; i++)
1009 if (channels[i].sfx == sfx)
1010 S_StopChannel (i, true);
1013 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
1014 sfx->fetcher->free (sfx->fetcher_data);
1024 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
1030 // Start the ambient sounds and make them loop
1031 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1033 // Precache it if it's not done (request a lock to make sure it will never be freed)
1034 if (ambient_sfxs[i] == NULL)
1035 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
1036 if (ambient_sfxs[i] != NULL)
1038 // Add a lock to the SFX while playing. It will be
1039 // removed by S_StopAllSounds at the end of the level
1040 S_LockSfx (ambient_sfxs[i]);
1042 channels[i].sfx = ambient_sfxs[i];
1043 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1044 channels[i].master_vol = 0;
1048 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
1049 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1050 if (sfx->flags & SFXFLAG_SERVERSOUND)
1053 sfx->flags &= ~SFXFLAG_SERVERSOUND;
1056 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
1057 for (i = 1; i < numsounds; i++)
1059 sfx = S_FindName (serversound[i]);
1062 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1063 // previously missing file
1064 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1066 sfx->flags |= SFXFLAG_SERVERSOUND;
1070 // Free all unlocked sfx
1071 for (sfx = known_sfx;sfx;sfx = sfxnext)
1073 sfxnext = sfx->next;
1074 S_FreeSfx (sfx, false);
1084 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
1088 if (!snd_initialized.integer)
1091 if (name == NULL || name[0] == 0)
1094 sfx = S_FindName (name);
1099 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1100 // previously missing file
1101 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1106 if (!nosound.integer && snd_precache.integer)
1107 S_LoadSound(sfx, complain);
1117 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1119 return (sfx != NULL && sfx->fetcher != NULL);
1129 void S_LockSfx (sfx_t *sfx)
1138 Remove a lock from a SFX
1141 void S_UnlockSfx (sfx_t *sfx)
1152 void S_BlockSound (void)
1163 void S_UnblockSound (void)
1173 Picks a channel based on priorities, empty slots, number of channels
1176 channel_t *SND_PickChannel(int entnum, int entchannel)
1180 int first_life_left, life_left;
1183 // Check for replacement sound, or find the best one to replace
1185 first_life_left = 0x7fffffff;
1187 // entity channels try to replace the existing sound on the channel
1188 if (entchannel != 0)
1190 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1192 ch = &channels[ch_idx];
1193 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1195 // always override sound from same entity
1196 S_StopChannel (ch_idx, true);
1197 return &channels[ch_idx];
1202 // there was no channel to override, so look for the first empty one
1203 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1205 ch = &channels[ch_idx];
1208 // no sound on this channel
1209 first_to_die = ch_idx;
1213 // don't let monster sounds override player sounds
1214 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1217 // don't override looped sounds
1218 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1220 life_left = ch->sfx->total_length - ch->pos;
1222 if (life_left < first_life_left)
1224 first_life_left = life_left;
1225 first_to_die = ch_idx;
1229 if (first_to_die == -1)
1232 return &channels[first_to_die];
1239 Spatializes a channel
1242 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1243 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1247 vec_t dist, mastervol, intensity, vol;
1250 // update sound origin if we know about the entity
1251 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1253 if (ch->entnum >= 32768)
1255 //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]);
1257 if (ch->entnum > 32768)
1258 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1259 ch->entnum = 32768; // entity was removed, disown sound
1261 else if (cl.entities[ch->entnum].state_current.active)
1263 //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]);
1264 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1265 if (cl.entities[ch->entnum].state_current.modelindex && cl.model_precache[cl.entities[ch->entnum].state_current.modelindex] && cl.model_precache[cl.entities[ch->entnum].state_current.modelindex]->soundfromcenter)
1266 VectorMAMAM(1.0f, ch->origin, 0.5f, cl.model_precache[cl.entities[ch->entnum].state_current.modelindex]->normalmins, 0.5f, cl.model_precache[cl.entities[ch->entnum].state_current.modelindex]->normalmaxs, ch->origin);
1270 mastervol = ch->master_vol;
1272 // Adjust volume of static sounds
1274 mastervol *= snd_staticvolume.value;
1275 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1277 if(ch->entnum >= 32768)
1279 switch(ch->entchannel)
1281 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1282 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1283 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1284 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1285 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1286 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1287 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1288 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1292 else if(ch->entnum == 0)
1294 switch(ch->entchannel)
1296 case 0: mastervol *= snd_worldchannel0volume.value; break;
1297 case 1: mastervol *= snd_worldchannel1volume.value; break;
1298 case 2: mastervol *= snd_worldchannel2volume.value; break;
1299 case 3: mastervol *= snd_worldchannel3volume.value; break;
1300 case 4: mastervol *= snd_worldchannel4volume.value; break;
1301 case 5: mastervol *= snd_worldchannel5volume.value; break;
1302 case 6: mastervol *= snd_worldchannel6volume.value; break;
1303 case 7: mastervol *= snd_worldchannel7volume.value; break;
1307 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1309 switch(ch->entchannel)
1311 case 0: mastervol *= snd_playerchannel0volume.value; break;
1312 case 1: mastervol *= snd_playerchannel1volume.value; break;
1313 case 2: mastervol *= snd_playerchannel2volume.value; break;
1314 case 3: mastervol *= snd_playerchannel3volume.value; break;
1315 case 4: mastervol *= snd_playerchannel4volume.value; break;
1316 case 5: mastervol *= snd_playerchannel5volume.value; break;
1317 case 6: mastervol *= snd_playerchannel6volume.value; break;
1318 case 7: mastervol *= snd_playerchannel7volume.value; break;
1324 switch(ch->entchannel)
1326 case 0: mastervol *= snd_entchannel0volume.value; break;
1327 case 1: mastervol *= snd_entchannel1volume.value; break;
1328 case 2: mastervol *= snd_entchannel2volume.value; break;
1329 case 3: mastervol *= snd_entchannel3volume.value; break;
1330 case 4: mastervol *= snd_entchannel4volume.value; break;
1331 case 5: mastervol *= snd_entchannel5volume.value; break;
1332 case 6: mastervol *= snd_entchannel6volume.value; break;
1333 case 7: mastervol *= snd_entchannel7volume.value; break;
1339 // anything coming from the view entity will always be full volume
1340 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1341 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1343 for (i = 0;i < SND_LISTENERS;i++)
1345 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1346 ch->listener_volume[i] = (int)bound(0, vol, 255);
1351 // calculate stereo seperation and distance attenuation
1352 VectorSubtract(listener_origin, ch->origin, source_vec);
1353 dist = VectorLength(source_vec);
1354 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1357 for (i = 0;i < SND_LISTENERS;i++)
1359 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1360 VectorNormalize(source_vec);
1362 switch(spatialmethod)
1366 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1368 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1369 VectorScale(source_vec, f, source_vec);
1372 f = spatialmin + spatialdiff * bound(0, (pow(dist, spatialpower) - spatialoffset) * spatialfactor, 1);
1373 VectorScale(source_vec, f, source_vec);
1375 case SPATIAL_THRESH:
1376 f = spatialmin + spatialdiff * (dist < spatialoffset);
1377 VectorScale(source_vec, f, source_vec);
1384 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1385 ch->listener_volume[i] = (int)bound(0, vol, 255);
1389 for (i = 0;i < SND_LISTENERS;i++)
1390 ch->listener_volume[i] = 0;
1395 // =======================================================================
1396 // Start a sound effect
1397 // =======================================================================
1399 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1401 // Initialize the channel
1402 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1403 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1404 memset (target_chan, 0, sizeof (*target_chan));
1405 VectorCopy (origin, target_chan->origin);
1406 target_chan->flags = flags;
1407 target_chan->pos = 0; // start of the sound
1409 // If it's a static sound
1412 if (sfx->loopstart >= sfx->total_length)
1413 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1414 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1417 target_chan->dist_mult = attenuation / snd_soundradius.value;
1419 // Lock the SFX during play
1422 // finally, set the sfx pointer, so the channel becomes valid for playback
1423 // and will be noticed by the mixer
1424 target_chan->sfx = sfx;
1426 // we have to set the channel volume AFTER the sfx because the function
1427 // needs it for replaygain support
1428 S_SetChannelVolume(target_chan - channels, fvol);
1432 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1434 channel_t *target_chan, *check;
1437 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1440 if (sfx->fetcher == NULL)
1443 // Pick a channel to play on
1444 target_chan = SND_PickChannel(entnum, entchannel);
1448 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1449 target_chan->entnum = entnum;
1450 target_chan->entchannel = entchannel;
1452 SND_Spatialize(target_chan, false);
1454 // if an identical sound has also been started this frame, offset the pos
1455 // a bit to keep it from just making the first one louder
1456 check = &channels[NUM_AMBIENTS];
1457 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1459 if (check == target_chan)
1461 if (check->sfx == sfx && !check->pos)
1463 // use negative pos offset to delay this sound effect
1464 target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1469 return (target_chan - channels);
1472 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex)
1476 if (channel_ind >= total_channels)
1479 ch = &channels[channel_ind];
1480 if (ch->sfx != NULL)
1482 sfx_t *sfx = ch->sfx;
1484 // we have to lock an audio mutex to prevent crashes if an audio mixer
1485 // thread is currently mixing this channel
1486 // the SndSys_LockRenderBuffer function uses such a mutex in
1487 // threaded sound backends
1489 SndSys_LockRenderBuffer();
1490 if (sfx->fetcher != NULL)
1492 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1493 if (fetcher_endsb != NULL)
1494 fetcher_endsb (ch->fetcher_data);
1497 // Remove the lock it holds
1500 ch->fetcher_data = NULL;
1503 SndSys_UnlockRenderBuffer();
1508 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1510 if (ch_ind >= total_channels)
1513 if (flag != CHANNELFLAG_FORCELOOP &&
1514 flag != CHANNELFLAG_PAUSED &&
1515 flag != CHANNELFLAG_FULLVOLUME)
1519 channels[ch_ind].flags |= flag;
1521 channels[ch_ind].flags &= ~flag;
1526 void S_StopSound(int entnum, int entchannel)
1530 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1531 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1533 S_StopChannel (i, true);
1538 extern void CDAudio_Stop(void);
1539 void S_StopAllSounds (void)
1543 // TOCHECK: is this test necessary?
1544 if (snd_renderbuffer == NULL)
1547 // stop CD audio because it may be using a faketrack
1550 for (i = 0; i < total_channels; i++)
1551 S_StopChannel (i, true);
1553 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1554 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1556 // Mute the contents of the submittion buffer
1557 if (simsound || SndSys_LockRenderBuffer ())
1562 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1563 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1564 memset(snd_renderbuffer->ring, clear, memsize);
1567 SndSys_UnlockRenderBuffer ();
1571 void S_PauseGameSounds (qboolean toggle)
1575 for (i = 0; i < total_channels; i++)
1580 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1581 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1585 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1587 sfx_t *sfx = channels[ch_ind].sfx;
1588 if(sfx->volume_peak > 0)
1590 // Replaygain support
1591 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1592 fvol *= sfx->volume_mult;
1593 if(fvol * sfx->volume_peak > 1)
1594 fvol = 1 / sfx->volume_peak;
1595 // Con_DPrintf("%f\n", fvol);
1597 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1606 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1608 channel_t *target_chan;
1610 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1614 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1618 if (total_channels == MAX_CHANNELS)
1620 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1624 target_chan = &channels[total_channels++];
1625 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1627 SND_Spatialize (target_chan, true);
1633 S_UpdateAmbientSounds
1636 void S_UpdateAmbientSounds (void)
1640 int ambient_channel;
1642 unsigned char ambientlevels[NUM_AMBIENTS];
1644 memset(ambientlevels, 0, sizeof(ambientlevels));
1645 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1646 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1648 // Calc ambient sound levels
1649 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1651 chan = &channels[ambient_channel];
1652 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1655 vol = (int)ambientlevels[ambient_channel];
1659 // Don't adjust volume too fast
1660 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1661 if (cl.time > cl.oldtime)
1663 if (chan->master_vol < vol)
1665 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1666 if (chan->master_vol > vol)
1667 chan->master_vol = vol;
1669 else if (chan->master_vol > vol)
1671 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1672 if (chan->master_vol < vol)
1673 chan->master_vol = vol;
1677 for (i = 0;i < SND_LISTENERS;i++)
1678 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1682 static void S_PaintAndSubmit (void)
1684 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1685 int usesoundtimehack;
1686 static int soundtimehack = -1;
1687 static int oldsoundtime = 0;
1689 if (snd_renderbuffer == NULL || nosound.integer)
1692 // Update sound time
1693 snd_usethreadedmixing = false;
1694 usesoundtimehack = true;
1695 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1697 usesoundtimehack = 1;
1698 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1700 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1702 usesoundtimehack = 2;
1703 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1707 usesoundtimehack = 3;
1708 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1712 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1713 usesoundtimehack = 0;
1714 newsoundtime = SndSys_GetSoundTime();
1716 // if the soundtimehack state changes we need to reset the soundtime
1717 if (soundtimehack != usesoundtimehack)
1719 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1721 // Mute the contents of the submission buffer
1722 if (simsound || SndSys_LockRenderBuffer ())
1727 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1728 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1729 memset(snd_renderbuffer->ring, clear, memsize);
1732 SndSys_UnlockRenderBuffer ();
1735 soundtimehack = usesoundtimehack;
1737 if (!soundtimehack && snd_blocked > 0)
1740 if (snd_usethreadedmixing)
1741 return; // the audio thread will mix its own data
1743 newsoundtime += extrasoundtime;
1744 if (newsoundtime < soundtime)
1746 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1748 unsigned int additionaltime;
1750 // add some time to extrasoundtime make newsoundtime higher
1752 // The extra time must be a multiple of the render buffer size
1753 // to avoid modifying the current position in the buffer,
1754 // some modules write directly to a shared (DMA) buffer
1755 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1756 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1758 extrasoundtime += additionaltime;
1759 newsoundtime += additionaltime;
1760 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1763 else if (!soundtimehack)
1764 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1765 newsoundtime, soundtime);
1767 soundtime = newsoundtime;
1768 recording_sound = (cls.capturevideo.soundrate != 0);
1770 // Lock submitbuffer
1771 if (!simsound && !SndSys_LockRenderBuffer())
1773 // If the lock failed, stop here
1774 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
1778 // Check to make sure that we haven't overshot
1779 paintedtime = snd_renderbuffer->endframe;
1780 if (paintedtime < soundtime)
1781 paintedtime = soundtime;
1783 // mix ahead of current position
1785 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1787 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
1788 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1789 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1790 endtime = min(endtime, maxtime);
1792 while (paintedtime < endtime)
1794 unsigned int startoffset;
1795 unsigned int nbframes;
1797 // see how much we can fit in the paint buffer
1798 nbframes = endtime - paintedtime;
1799 // limit to the end of the ring buffer (in case of wrapping)
1800 startoffset = paintedtime % snd_renderbuffer->maxframes;
1801 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
1803 // mix into the buffer
1804 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
1806 paintedtime += nbframes;
1807 snd_renderbuffer->endframe = paintedtime;
1810 SndSys_UnlockRenderBuffer();
1812 // Remove outdated samples from the ring buffer, if any
1813 if (snd_renderbuffer->startframe < soundtime)
1814 snd_renderbuffer->startframe = soundtime;
1817 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1821 oldsoundtime = soundtime;
1823 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
1830 Called once each time through the main loop
1833 void S_Update(const matrix4x4_t *listenermatrix)
1835 unsigned int i, j, k;
1836 channel_t *ch, *combine;
1837 matrix4x4_t basematrix, rotatematrix;
1839 if (snd_renderbuffer == NULL || nosound.integer)
1843 double mindist_trans, maxdist_trans;
1845 spatialmin = snd_spatialization_min.value;
1846 spatialdiff = snd_spatialization_max.value - spatialmin;
1848 if(snd_spatialization_control.value)
1850 spatialpower = snd_spatialization_power.value;
1852 if(spatialpower == 0)
1854 spatialmethod = SPATIAL_LOG;
1855 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
1856 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
1860 spatialmethod = SPATIAL_POW;
1861 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
1862 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
1865 if(mindist_trans - maxdist_trans == 0)
1867 spatialmethod = SPATIAL_THRESH;
1868 mindist_trans = snd_spatialization_min_radius.value;
1872 spatialoffset = mindist_trans;
1873 spatialfactor = 1 / (maxdist_trans - mindist_trans);
1877 spatialmethod = SPATIAL_NONE;
1881 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1882 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1883 current_channellayout != snd_channellayout.integer)
1884 S_SetChannelLayout();
1886 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1887 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1889 // calculate the current matrices
1890 for (j = 0;j < SND_LISTENERS;j++)
1892 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1893 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1894 // I think this should now do this:
1895 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1896 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1897 // angle has to be taken negative)
1898 // 2. create a transform which first rotates and moves its argument
1899 // into the player's view coordinates (using basematrix which is
1900 // an inverted "absolute" listener matrix), then applies the
1901 // rotation matrix for the ear
1902 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1903 // does not actually refer to an entity?
1906 // update general area ambient sound sources
1907 S_UpdateAmbientSounds ();
1911 // update spatialization for static and dynamic sounds
1912 cls.soundstats.totalsounds = 0;
1913 cls.soundstats.mixedsounds = 0;
1914 ch = channels+NUM_AMBIENTS;
1915 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1919 cls.soundstats.totalsounds++;
1921 // respatialize channel
1922 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1924 // try to combine static sounds with a previous channel of the same
1925 // sound effect so we don't mix five torches every frame
1926 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1928 // no need to merge silent channels
1929 for (j = 0;j < SND_LISTENERS;j++)
1930 if (ch->listener_volume[j])
1932 if (j == SND_LISTENERS)
1934 // if the last combine chosen isn't suitable, find a new one
1935 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1939 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1941 if (channels[j].sfx == ch->sfx)
1943 combine = channels + j;
1948 if (combine && combine != ch && combine->sfx == ch->sfx)
1950 for (j = 0;j < SND_LISTENERS;j++)
1952 combine->listener_volume[j] += ch->listener_volume[j];
1953 ch->listener_volume[j] = 0;
1957 for (k = 0;k < SND_LISTENERS;k++)
1958 if (ch->listener_volume[k])
1960 if (k < SND_LISTENERS)
1961 cls.soundstats.mixedsounds++;
1964 sound_spatialized = true;
1967 if (snd_show.integer)
1968 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
1973 void S_ExtraUpdate (void)
1975 if (snd_noextraupdate.integer || !sound_spatialized)
1981 qboolean S_LocalSound (const char *sound)
1986 if (!snd_initialized.integer || nosound.integer)
1989 sfx = S_PrecacheSound (sound, true, false);
1992 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1996 // Local sounds must not be freed
1997 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1999 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2003 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;