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;
358 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
360 static const snd_format_t thresholds [] =
362 // speed width channels
363 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
369 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
371 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
372 unsigned int speed_level, width_level, channels_level;
374 // If we have reached the minimum values, there's nothing more we can do
375 if ((format->speed == thresholds[0].speed || fixed_speed) &&
376 (format->width == thresholds[0].width || fixed_width) &&
377 (format->channels == thresholds[0].channels || fixed_channels))
380 // Check the min and max values
381 #define CHECK_BOUNDARIES(param) \
382 if (format->param < thresholds[0].param) \
384 format->param = thresholds[0].param; \
387 if (format->param > thresholds[nb_thresholds - 1].param) \
389 format->param = thresholds[nb_thresholds - 1].param; \
392 CHECK_BOUNDARIES(speed);
393 CHECK_BOUNDARIES(width);
394 CHECK_BOUNDARIES(channels);
395 #undef CHECK_BOUNDARIES
397 // Find the level of each parameter
398 #define FIND_LEVEL(param) \
400 while (param##_level < nb_thresholds - 1) \
402 if (format->param <= thresholds[param##_level].param) \
409 FIND_LEVEL(channels);
412 // Decrease the parameter with the highest level to the previous level
413 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
415 format->channels = thresholds[channels_level - 1].channels;
418 if (speed_level >= width_level && !fixed_speed)
420 format->speed = thresholds[speed_level - 1].speed;
424 format->width = thresholds[width_level - 1].width;
429 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
431 static void S_SetChannelLayout (void)
434 listener_t swaplistener;
435 listener_t *listeners;
438 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
439 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
441 if (i >= SND_SPEAKERLAYOUTS)
443 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
444 snd_renderbuffer->format.channels);
445 i = SND_SPEAKERLAYOUTS - 1;
448 snd_speakerlayout = snd_speakerlayouts[i];
449 listeners = snd_speakerlayout.listeners;
451 // Swap the left and right channels if snd_swapstereo is set
452 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
454 switch (snd_speakerlayout.channels)
457 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
461 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
464 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
475 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
476 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
477 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
479 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
481 // If we're in the sound engine initialization
482 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
484 layout = SND_CHANNELLAYOUT_STANDARD;
485 Cvar_SetValueQuick (&snd_channellayout, layout);
488 layout = current_channellayout_used;
491 layout = snd_channellayout.integer;
493 // Convert our layout (= ALSA) to the standard layout if necessary
494 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
496 if (layout == SND_CHANNELLAYOUT_STANDARD)
498 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
499 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
502 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
503 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
506 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
507 current_channellayout = snd_channellayout.integer;
508 current_channellayout_used = layout;
512 void S_Startup (void)
514 qboolean fixed_speed, fixed_width, fixed_channels;
515 snd_format_t chosen_fmt;
516 static snd_format_t prev_render_format = {0, 0, 0};
523 if (!snd_initialized.integer)
528 fixed_channels = false;
530 // Get the starting sound format from the cvars
531 chosen_fmt.speed = snd_speed.integer;
532 chosen_fmt.width = snd_width.integer;
533 chosen_fmt.channels = snd_channels.integer;
535 // Check the environment variables to see if the player wants a particular sound format
537 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
539 env = getenv("QUAKE_SOUND_CHANNELS");
543 chosen_fmt.channels = atoi (env);
547 fixed_channels = true;
550 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
552 env = getenv("QUAKE_SOUND_SPEED");
556 chosen_fmt.speed = atoi (env);
563 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
565 env = getenv("QUAKE_SOUND_SAMPLEBITS");
569 chosen_fmt.width = atoi (env) / 8;
576 // Parse the command line to see if the player wants a particular sound format
577 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
578 if (COM_CheckParm ("-sndquad") != 0)
580 chosen_fmt.channels = 4;
581 fixed_channels = true;
583 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
584 else if (COM_CheckParm ("-sndstereo") != 0)
586 chosen_fmt.channels = 2;
587 fixed_channels = true;
589 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
590 else if (COM_CheckParm ("-sndmono") != 0)
592 chosen_fmt.channels = 1;
593 fixed_channels = true;
595 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
596 i = COM_CheckParm ("-sndspeed");
597 if (0 < i && i < com_argc - 1)
599 chosen_fmt.speed = atoi (com_argv[i + 1]);
602 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
603 i = COM_CheckParm ("-sndbits");
604 if (0 < i && i < com_argc - 1)
606 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
610 // You can't change sound speed after start time (not yet supported)
611 if (prev_render_format.speed != 0)
614 if (chosen_fmt.speed != prev_render_format.speed)
616 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
617 prev_render_format.speed);
618 chosen_fmt.speed = prev_render_format.speed;
623 if (chosen_fmt.speed < SND_MIN_SPEED)
625 chosen_fmt.speed = SND_MIN_SPEED;
628 else if (chosen_fmt.speed > SND_MAX_SPEED)
630 chosen_fmt.speed = SND_MAX_SPEED;
634 if (chosen_fmt.width < SND_MIN_WIDTH)
636 chosen_fmt.width = SND_MIN_WIDTH;
639 else if (chosen_fmt.width > SND_MAX_WIDTH)
641 chosen_fmt.width = SND_MAX_WIDTH;
645 if (chosen_fmt.channels < SND_MIN_CHANNELS)
647 chosen_fmt.channels = SND_MIN_CHANNELS;
648 fixed_channels = false;
650 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
652 chosen_fmt.channels = SND_MAX_CHANNELS;
653 fixed_channels = false;
656 // create the sound buffer used for sumitting the samples to the plaform-dependent module
659 snd_format_t suggest_fmt;
665 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
666 chosen_fmt.speed, chosen_fmt.width * 8,
667 chosen_fmt.channels);
669 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
670 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
674 Con_Printf("S_Startup: sound output initialization FAILED\n");
676 // If the module is suggesting another one
677 if (suggest_fmt.speed != 0)
679 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
680 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
681 suggest_fmt.speed, suggest_fmt.width * 8,
682 suggest_fmt.channels);
684 // Else, try to find a less resource-demanding format
685 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
690 // If we haven't found a suitable format
693 Con_Print("S_Startup: SndSys_Init failed.\n");
694 sound_spatialized = false;
700 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
701 Con_Print ("S_Startup: simulating sound output\n");
704 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
705 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
706 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
709 if (snd_speed.integer != (int)chosen_fmt.speed)
710 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
711 if (snd_width.integer != chosen_fmt.width)
712 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
713 if (snd_channels.integer != chosen_fmt.channels)
714 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
716 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
717 S_SetChannelLayout();
719 snd_starttime = realtime;
721 // If the sound module has already run, add an extra time to make sure
722 // the sound time doesn't decrease, to not confuse playing SFXs
723 if (oldpaintedtime != 0)
725 // The extra time must be a multiple of the render buffer size
726 // to avoid modifying the current position in the buffer,
727 // some modules write directly to a shared (DMA) buffer
728 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
729 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
730 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
732 soundtime = extrasoundtime;
736 snd_renderbuffer->startframe = soundtime;
737 snd_renderbuffer->endframe = soundtime;
738 recording_sound = false;
741 void S_Shutdown(void)
743 if (snd_renderbuffer == NULL)
746 oldpaintedtime = snd_renderbuffer->endframe;
750 Mem_Free(snd_renderbuffer->ring);
751 Mem_Free(snd_renderbuffer);
752 snd_renderbuffer = NULL;
757 sound_spatialized = false;
760 void S_Restart_f(void)
762 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
763 // So, refuse to do this if we are connected.
764 if(cls.state == ca_connected)
766 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
781 Cvar_RegisterVariable(&volume);
782 Cvar_RegisterVariable(&bgmvolume);
783 Cvar_RegisterVariable(&snd_staticvolume);
784 Cvar_RegisterVariable(&snd_entchannel0volume);
785 Cvar_RegisterVariable(&snd_entchannel1volume);
786 Cvar_RegisterVariable(&snd_entchannel2volume);
787 Cvar_RegisterVariable(&snd_entchannel3volume);
788 Cvar_RegisterVariable(&snd_entchannel4volume);
789 Cvar_RegisterVariable(&snd_entchannel5volume);
790 Cvar_RegisterVariable(&snd_entchannel6volume);
791 Cvar_RegisterVariable(&snd_entchannel7volume);
792 Cvar_RegisterVariable(&snd_worldchannel0volume);
793 Cvar_RegisterVariable(&snd_worldchannel1volume);
794 Cvar_RegisterVariable(&snd_worldchannel2volume);
795 Cvar_RegisterVariable(&snd_worldchannel3volume);
796 Cvar_RegisterVariable(&snd_worldchannel4volume);
797 Cvar_RegisterVariable(&snd_worldchannel5volume);
798 Cvar_RegisterVariable(&snd_worldchannel6volume);
799 Cvar_RegisterVariable(&snd_worldchannel7volume);
800 Cvar_RegisterVariable(&snd_playerchannel0volume);
801 Cvar_RegisterVariable(&snd_playerchannel1volume);
802 Cvar_RegisterVariable(&snd_playerchannel2volume);
803 Cvar_RegisterVariable(&snd_playerchannel3volume);
804 Cvar_RegisterVariable(&snd_playerchannel4volume);
805 Cvar_RegisterVariable(&snd_playerchannel5volume);
806 Cvar_RegisterVariable(&snd_playerchannel6volume);
807 Cvar_RegisterVariable(&snd_playerchannel7volume);
808 Cvar_RegisterVariable(&snd_csqcchannel0volume);
809 Cvar_RegisterVariable(&snd_csqcchannel1volume);
810 Cvar_RegisterVariable(&snd_csqcchannel2volume);
811 Cvar_RegisterVariable(&snd_csqcchannel3volume);
812 Cvar_RegisterVariable(&snd_csqcchannel4volume);
813 Cvar_RegisterVariable(&snd_csqcchannel5volume);
814 Cvar_RegisterVariable(&snd_csqcchannel6volume);
815 Cvar_RegisterVariable(&snd_csqcchannel7volume);
817 Cvar_RegisterVariable(&snd_spatialization_min_radius);
818 Cvar_RegisterVariable(&snd_spatialization_max_radius);
819 Cvar_RegisterVariable(&snd_spatialization_min);
820 Cvar_RegisterVariable(&snd_spatialization_max);
821 Cvar_RegisterVariable(&snd_spatialization_power);
822 Cvar_RegisterVariable(&snd_spatialization_control);
824 Cvar_RegisterVariable(&snd_speed);
825 Cvar_RegisterVariable(&snd_width);
826 Cvar_RegisterVariable(&snd_channels);
827 Cvar_RegisterVariable(&snd_mutewhenidle);
829 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
830 if (COM_CheckParm("-nosound"))
832 // dummy out Play and Play2 because mods stuffcmd that
833 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
834 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
838 snd_mempool = Mem_AllocPool("sound", 0, NULL);
840 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
841 if (COM_CheckParm("-simsound"))
844 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
845 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
846 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
847 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
848 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
849 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
850 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
851 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
853 Cvar_RegisterVariable(&nosound);
854 Cvar_RegisterVariable(&snd_precache);
855 Cvar_RegisterVariable(&snd_initialized);
856 Cvar_RegisterVariable(&snd_streaming);
857 Cvar_RegisterVariable(&ambient_level);
858 Cvar_RegisterVariable(&ambient_fade);
859 Cvar_RegisterVariable(&snd_noextraupdate);
860 Cvar_RegisterVariable(&snd_show);
861 Cvar_RegisterVariable(&_snd_mixahead);
862 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
863 Cvar_RegisterVariable(&snd_channellayout);
864 Cvar_RegisterVariable(&snd_soundradius);
866 Cvar_SetValueQuick(&snd_initialized, true);
870 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
871 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
874 ModPlug_OpenLibrary ();
882 Shutdown and free all resources
885 void S_Terminate (void)
888 ModPlug_CloseLibrary ();
892 while (known_sfx != NULL)
893 S_FreeSfx (known_sfx, true);
895 Cvar_SetValueQuick (&snd_initialized, false);
896 Mem_FreePool (&snd_mempool);
905 void S_UnloadAllSounds_f (void)
909 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
910 // So, refuse to do this if we are connected.
911 if(cls.state == ca_connected)
913 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
917 // stop any active sounds
920 // because the ambient sounds will be freed, clear the pointers
921 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
922 ambient_sfxs[i] = NULL;
924 // now free all sounds
925 while (known_sfx != NULL)
926 S_FreeSfx (known_sfx, true);
935 sfx_t *S_FindName (const char *name)
939 if (!snd_initialized.integer)
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_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
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;
1051 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
1052 for (i = 1; i < numsounds; i++)
1054 sfx = S_FindName (serversound[i]);
1057 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1058 // previously missing file
1059 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1061 sfx->flags |= SFXFLAG_SERVERSOUND;
1065 // Free all unlocked sfx
1066 for (sfx = known_sfx;sfx;sfx = sfxnext)
1068 sfxnext = sfx->next;
1069 S_FreeSfx (sfx, false);
1079 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
1083 if (!snd_initialized.integer)
1086 if (name == NULL || name[0] == 0)
1089 sfx = S_FindName (name);
1094 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1095 // previously missing file
1096 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1101 if (!nosound.integer && snd_precache.integer)
1102 S_LoadSound(sfx, complain);
1112 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1114 return (sfx != NULL && sfx->fetcher != NULL);
1124 void S_LockSfx (sfx_t *sfx)
1133 Remove a lock from a SFX
1136 void S_UnlockSfx (sfx_t *sfx)
1147 void S_BlockSound (void)
1158 void S_UnblockSound (void)
1168 Picks a channel based on priorities, empty slots, number of channels
1171 channel_t *SND_PickChannel(int entnum, int entchannel)
1175 int first_life_left, life_left;
1178 // Check for replacement sound, or find the best one to replace
1180 first_life_left = 0x7fffffff;
1182 // entity channels try to replace the existing sound on the channel
1183 if (entchannel != 0)
1185 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1187 ch = &channels[ch_idx];
1188 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1190 // always override sound from same entity
1191 S_StopChannel (ch_idx, true);
1192 return &channels[ch_idx];
1197 // there was no channel to override, so look for the first empty one
1198 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1200 ch = &channels[ch_idx];
1203 // no sound on this channel
1204 first_to_die = ch_idx;
1208 // don't let monster sounds override player sounds
1209 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1212 // don't override looped sounds
1213 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1215 life_left = ch->sfx->total_length - ch->pos;
1217 if (life_left < first_life_left)
1219 first_life_left = life_left;
1220 first_to_die = ch_idx;
1224 if (first_to_die == -1)
1227 return &channels[first_to_die];
1234 Spatializes a channel
1237 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1238 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1242 vec_t dist, mastervol, intensity, vol;
1245 // update sound origin if we know about the entity
1246 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1248 if (ch->entnum >= 32768)
1250 //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]);
1252 CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin);
1254 else if (cl.entities[ch->entnum].state_current.active)
1256 //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 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1258 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)
1259 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);
1263 mastervol = ch->master_vol;
1265 // Adjust volume of static sounds
1267 mastervol *= snd_staticvolume.value;
1268 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1270 if(ch->entnum >= 32768)
1272 switch(ch->entchannel)
1274 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1275 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1276 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1277 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1278 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1279 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1280 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1281 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1285 else if(ch->entnum == 0)
1287 switch(ch->entchannel)
1289 case 0: mastervol *= snd_worldchannel0volume.value; break;
1290 case 1: mastervol *= snd_worldchannel1volume.value; break;
1291 case 2: mastervol *= snd_worldchannel2volume.value; break;
1292 case 3: mastervol *= snd_worldchannel3volume.value; break;
1293 case 4: mastervol *= snd_worldchannel4volume.value; break;
1294 case 5: mastervol *= snd_worldchannel5volume.value; break;
1295 case 6: mastervol *= snd_worldchannel6volume.value; break;
1296 case 7: mastervol *= snd_worldchannel7volume.value; break;
1300 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1302 switch(ch->entchannel)
1304 case 0: mastervol *= snd_playerchannel0volume.value; break;
1305 case 1: mastervol *= snd_playerchannel1volume.value; break;
1306 case 2: mastervol *= snd_playerchannel2volume.value; break;
1307 case 3: mastervol *= snd_playerchannel3volume.value; break;
1308 case 4: mastervol *= snd_playerchannel4volume.value; break;
1309 case 5: mastervol *= snd_playerchannel5volume.value; break;
1310 case 6: mastervol *= snd_playerchannel6volume.value; break;
1311 case 7: mastervol *= snd_playerchannel7volume.value; break;
1317 switch(ch->entchannel)
1319 case 0: mastervol *= snd_entchannel0volume.value; break;
1320 case 1: mastervol *= snd_entchannel1volume.value; break;
1321 case 2: mastervol *= snd_entchannel2volume.value; break;
1322 case 3: mastervol *= snd_entchannel3volume.value; break;
1323 case 4: mastervol *= snd_entchannel4volume.value; break;
1324 case 5: mastervol *= snd_entchannel5volume.value; break;
1325 case 6: mastervol *= snd_entchannel6volume.value; break;
1326 case 7: mastervol *= snd_entchannel7volume.value; break;
1332 // anything coming from the view entity will always be full volume
1333 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1334 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1336 for (i = 0;i < SND_LISTENERS;i++)
1338 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1339 ch->listener_volume[i] = (int)bound(0, vol, 255);
1344 // calculate stereo seperation and distance attenuation
1345 VectorSubtract(listener_origin, ch->origin, source_vec);
1346 dist = VectorLength(source_vec);
1347 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1350 for (i = 0;i < SND_LISTENERS;i++)
1352 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1353 VectorNormalize(source_vec);
1355 switch(spatialmethod)
1359 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1361 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1362 VectorScale(source_vec, f, source_vec);
1365 f = spatialmin + spatialdiff * bound(0, (pow(dist, spatialpower) - spatialoffset) * spatialfactor, 1);
1366 VectorScale(source_vec, f, source_vec);
1368 case SPATIAL_THRESH:
1369 f = spatialmin + spatialdiff * (dist < spatialoffset);
1370 VectorScale(source_vec, f, source_vec);
1377 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1378 ch->listener_volume[i] = (int)bound(0, vol, 255);
1382 for (i = 0;i < SND_LISTENERS;i++)
1383 ch->listener_volume[i] = 0;
1388 // =======================================================================
1389 // Start a sound effect
1390 // =======================================================================
1392 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1394 // Initialize the channel
1395 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1396 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1397 memset (target_chan, 0, sizeof (*target_chan));
1398 VectorCopy (origin, target_chan->origin);
1399 target_chan->flags = flags;
1400 target_chan->pos = 0; // start of the sound
1402 // If it's a static sound
1405 if (sfx->loopstart >= sfx->total_length)
1406 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1407 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1410 target_chan->dist_mult = attenuation / snd_soundradius.value;
1412 // Lock the SFX during play
1415 // finally, set the sfx pointer, so the channel becomes valid for playback
1416 // and will be noticed by the mixer
1417 target_chan->sfx = sfx;
1419 // we have to set the channel volume AFTER the sfx because the function
1420 // needs it for replaygain support
1421 S_SetChannelVolume(target_chan - channels, fvol);
1425 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1427 channel_t *target_chan, *check;
1430 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1433 if (sfx->fetcher == NULL)
1436 // Pick a channel to play on
1437 target_chan = SND_PickChannel(entnum, entchannel);
1441 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1442 target_chan->entnum = entnum;
1443 target_chan->entchannel = entchannel;
1445 SND_Spatialize(target_chan, false);
1447 // if an identical sound has also been started this frame, offset the pos
1448 // a bit to keep it from just making the first one louder
1449 check = &channels[NUM_AMBIENTS];
1450 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1452 if (check == target_chan)
1454 if (check->sfx == sfx && !check->pos)
1456 // use negative pos offset to delay this sound effect
1457 target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1462 return (target_chan - channels);
1465 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex)
1469 if (channel_ind >= total_channels)
1472 ch = &channels[channel_ind];
1473 if (ch->sfx != NULL)
1475 sfx_t *sfx = ch->sfx;
1477 // we have to lock an audio mutex to prevent crashes if an audio mixer
1478 // thread is currently mixing this channel
1479 // the SndSys_LockRenderBuffer function uses such a mutex in
1480 // threaded sound backends
1482 SndSys_LockRenderBuffer();
1483 if (sfx->fetcher != NULL)
1485 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1486 if (fetcher_endsb != NULL)
1487 fetcher_endsb (ch->fetcher_data);
1490 // Remove the lock it holds
1493 ch->fetcher_data = NULL;
1496 SndSys_UnlockRenderBuffer();
1501 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1503 if (ch_ind >= total_channels)
1506 if (flag != CHANNELFLAG_FORCELOOP &&
1507 flag != CHANNELFLAG_PAUSED &&
1508 flag != CHANNELFLAG_FULLVOLUME)
1512 channels[ch_ind].flags |= flag;
1514 channels[ch_ind].flags &= ~flag;
1519 void S_StopSound(int entnum, int entchannel)
1523 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1524 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1526 S_StopChannel (i, true);
1531 extern void CDAudio_Stop(void);
1532 void S_StopAllSounds (void)
1536 // TOCHECK: is this test necessary?
1537 if (snd_renderbuffer == NULL)
1540 // stop CD audio because it may be using a faketrack
1543 for (i = 0; i < total_channels; i++)
1544 S_StopChannel (i, true);
1546 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1547 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1549 // Mute the contents of the submittion buffer
1550 if (simsound || SndSys_LockRenderBuffer ())
1555 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1556 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1557 memset(snd_renderbuffer->ring, clear, memsize);
1560 SndSys_UnlockRenderBuffer ();
1564 void S_PauseGameSounds (qboolean toggle)
1568 for (i = 0; i < total_channels; i++)
1573 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1574 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1578 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1580 sfx_t *sfx = channels[ch_ind].sfx;
1581 if(sfx->volume_peak > 0)
1583 // Replaygain support
1584 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1585 fvol *= sfx->volume_mult;
1586 if(fvol * sfx->volume_peak > 1)
1587 fvol = 1 / sfx->volume_peak;
1588 // Con_DPrintf("%f\n", fvol);
1590 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1599 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1601 channel_t *target_chan;
1603 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1607 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1611 if (total_channels == MAX_CHANNELS)
1613 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1617 target_chan = &channels[total_channels++];
1618 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1620 SND_Spatialize (target_chan, true);
1626 S_UpdateAmbientSounds
1629 void S_UpdateAmbientSounds (void)
1633 int ambient_channel;
1635 unsigned char ambientlevels[NUM_AMBIENTS];
1637 memset(ambientlevels, 0, sizeof(ambientlevels));
1638 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1639 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1641 // Calc ambient sound levels
1642 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1644 chan = &channels[ambient_channel];
1645 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1648 vol = (int)ambientlevels[ambient_channel];
1652 // Don't adjust volume too fast
1653 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1654 if (cl.time > cl.oldtime)
1656 if (chan->master_vol < vol)
1658 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1659 if (chan->master_vol > vol)
1660 chan->master_vol = vol;
1662 else if (chan->master_vol > vol)
1664 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1665 if (chan->master_vol < vol)
1666 chan->master_vol = vol;
1670 for (i = 0;i < SND_LISTENERS;i++)
1671 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1675 static void S_PaintAndSubmit (void)
1677 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1678 int usesoundtimehack;
1679 static int soundtimehack = -1;
1680 static int oldsoundtime = 0;
1682 if (snd_renderbuffer == NULL || nosound.integer)
1685 // Update sound time
1686 snd_usethreadedmixing = false;
1687 usesoundtimehack = true;
1688 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1690 usesoundtimehack = 1;
1691 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1693 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1695 usesoundtimehack = 2;
1696 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1700 usesoundtimehack = 3;
1701 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1705 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1706 usesoundtimehack = 0;
1707 newsoundtime = SndSys_GetSoundTime();
1709 // if the soundtimehack state changes we need to reset the soundtime
1710 if (soundtimehack != usesoundtimehack)
1712 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1714 // Mute the contents of the submission buffer
1715 if (simsound || SndSys_LockRenderBuffer ())
1720 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1721 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1722 memset(snd_renderbuffer->ring, clear, memsize);
1725 SndSys_UnlockRenderBuffer ();
1728 soundtimehack = usesoundtimehack;
1730 if (!soundtimehack && snd_blocked > 0)
1733 if (snd_usethreadedmixing)
1734 return; // the audio thread will mix its own data
1736 newsoundtime += extrasoundtime;
1737 if (newsoundtime < soundtime)
1739 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1741 unsigned int additionaltime;
1743 // add some time to extrasoundtime make newsoundtime higher
1745 // The extra time must be a multiple of the render buffer size
1746 // to avoid modifying the current position in the buffer,
1747 // some modules write directly to a shared (DMA) buffer
1748 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1749 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1751 extrasoundtime += additionaltime;
1752 newsoundtime += additionaltime;
1753 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1756 else if (!soundtimehack)
1757 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1758 newsoundtime, soundtime);
1760 soundtime = newsoundtime;
1761 recording_sound = (cls.capturevideo.soundrate != 0);
1763 // Lock submitbuffer
1764 if (!simsound && !SndSys_LockRenderBuffer())
1766 // If the lock failed, stop here
1767 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
1771 // Check to make sure that we haven't overshot
1772 paintedtime = snd_renderbuffer->endframe;
1773 if (paintedtime < soundtime)
1774 paintedtime = soundtime;
1776 // mix ahead of current position
1778 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1780 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
1781 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1782 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1783 endtime = min(endtime, maxtime);
1785 while (paintedtime < endtime)
1787 unsigned int startoffset;
1788 unsigned int nbframes;
1790 // see how much we can fit in the paint buffer
1791 nbframes = endtime - paintedtime;
1792 // limit to the end of the ring buffer (in case of wrapping)
1793 startoffset = paintedtime % snd_renderbuffer->maxframes;
1794 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
1796 // mix into the buffer
1797 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
1799 paintedtime += nbframes;
1800 snd_renderbuffer->endframe = paintedtime;
1803 SndSys_UnlockRenderBuffer();
1805 // Remove outdated samples from the ring buffer, if any
1806 if (snd_renderbuffer->startframe < soundtime)
1807 snd_renderbuffer->startframe = soundtime;
1810 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1814 oldsoundtime = soundtime;
1816 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
1823 Called once each time through the main loop
1826 void S_Update(const matrix4x4_t *listenermatrix)
1828 unsigned int i, j, k;
1829 channel_t *ch, *combine;
1830 matrix4x4_t basematrix, rotatematrix;
1832 if (snd_renderbuffer == NULL || nosound.integer)
1836 double mindist_trans, maxdist_trans;
1838 spatialmin = snd_spatialization_min.value;
1839 spatialdiff = snd_spatialization_max.value - spatialmin;
1841 if(snd_spatialization_control.value)
1843 spatialpower = snd_spatialization_power.value;
1845 if(spatialpower == 0)
1847 spatialmethod = SPATIAL_LOG;
1848 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
1849 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
1853 spatialmethod = SPATIAL_POW;
1854 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
1855 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
1858 if(mindist_trans - maxdist_trans == 0)
1860 spatialmethod = SPATIAL_THRESH;
1861 mindist_trans = snd_spatialization_min_radius.value;
1865 spatialoffset = mindist_trans;
1866 spatialfactor = 1 / (maxdist_trans - mindist_trans);
1870 spatialmethod = SPATIAL_NONE;
1874 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1875 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1876 current_channellayout != snd_channellayout.integer)
1877 S_SetChannelLayout();
1879 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1880 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1882 // calculate the current matrices
1883 for (j = 0;j < SND_LISTENERS;j++)
1885 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1886 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1887 // I think this should now do this:
1888 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1889 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1890 // angle has to be taken negative)
1891 // 2. create a transform which first rotates and moves its argument
1892 // into the player's view coordinates (using basematrix which is
1893 // an inverted "absolute" listener matrix), then applies the
1894 // rotation matrix for the ear
1895 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1896 // does not actually refer to an entity?
1899 // update general area ambient sound sources
1900 S_UpdateAmbientSounds ();
1904 // update spatialization for static and dynamic sounds
1905 cls.soundstats.totalsounds = 0;
1906 cls.soundstats.mixedsounds = 0;
1907 ch = channels+NUM_AMBIENTS;
1908 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1912 cls.soundstats.totalsounds++;
1914 // respatialize channel
1915 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1917 // try to combine static sounds with a previous channel of the same
1918 // sound effect so we don't mix five torches every frame
1919 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1921 // no need to merge silent channels
1922 for (j = 0;j < SND_LISTENERS;j++)
1923 if (ch->listener_volume[j])
1925 if (j == SND_LISTENERS)
1927 // if the last combine chosen isn't suitable, find a new one
1928 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1932 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1934 if (channels[j].sfx == ch->sfx)
1936 combine = channels + j;
1941 if (combine && combine != ch && combine->sfx == ch->sfx)
1943 for (j = 0;j < SND_LISTENERS;j++)
1945 combine->listener_volume[j] += ch->listener_volume[j];
1946 ch->listener_volume[j] = 0;
1950 for (k = 0;k < SND_LISTENERS;k++)
1951 if (ch->listener_volume[k])
1953 if (k < SND_LISTENERS)
1954 cls.soundstats.mixedsounds++;
1957 sound_spatialized = true;
1960 if (snd_show.integer)
1961 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
1966 void S_ExtraUpdate (void)
1968 if (snd_noextraupdate.integer || !sound_spatialized)
1974 qboolean S_LocalSound (const char *sound)
1979 if (!snd_initialized.integer || nosound.integer)
1982 sfx = S_PrecacheSound (sound, true, false);
1985 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1989 // Local sounds must not be freed
1990 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1992 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1996 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;