2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
26 #include "snd_modplug.h"
28 #include "cl_collision.h"
31 #define SND_MIN_SPEED 8000
32 #define SND_MAX_SPEED 96000
33 #define SND_MIN_WIDTH 1
34 #define SND_MAX_WIDTH 2
35 #define SND_MIN_CHANNELS 1
36 #define SND_MAX_CHANNELS 8
37 #if SND_LISTENERS != 8
38 # error this data only supports up to 8 channel, update it!
41 speakerlayout_t snd_speakerlayout;
43 // Our speaker layouts are based on ALSA. They differ from those
44 // Win32 and Mac OS X APIs use when there's more than 4 channels.
45 // (rear left + rear right, and front center + LFE are swapped).
46 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
47 static const speakerlayout_t snd_speakerlayouts[] =
52 {0, 45, 0.2, 0.2, 0.5}, // front left
53 {1, 315, 0.2, 0.2, 0.5}, // front right
54 {2, 135, 0.2, 0.2, 0.5}, // rear left
55 {3, 225, 0.2, 0.2, 0.5}, // rear right
56 {4, 0, 0.2, 0.2, 0.5}, // front center
57 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
58 {6, 90, 0.2, 0.2, 0.5}, // side left
59 {7, 180, 0.2, 0.2, 0.5}, // side right
65 {0, 45, 0.2, 0.2, 0.5}, // front left
66 {1, 315, 0.2, 0.2, 0.5}, // front right
67 {2, 135, 0.2, 0.2, 0.5}, // rear left
68 {3, 225, 0.2, 0.2, 0.5}, // rear right
69 {4, 0, 0.2, 0.2, 0.5}, // front center
70 {5, 0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
76 // these systems sometimes have a subwoofer as well, but it has no
80 {0, 45, 0.3, 0.3, 0.8}, // front left
81 {1, 315, 0.3, 0.3, 0.8}, // front right
82 {2, 135, 0.3, 0.3, 0.8}, // rear left
83 {3, 225, 0.3, 0.3, 0.8}, // rear right
91 // these systems sometimes have a subwoofer as well, but it has no
95 {0, 90, 0.5, 0.5, 1}, // side left
96 {1, 270, 0.5, 0.5, 1}, // side right
108 {0, 0, 0, 1, 1}, // center
121 // =======================================================================
122 // Internal sound data & structures
123 // =======================================================================
125 channel_t channels[MAX_CHANNELS];
126 unsigned int total_channels;
128 snd_ringbuffer_t *snd_renderbuffer = NULL;
129 static unsigned int soundtime = 0;
130 static unsigned int oldpaintedtime = 0;
131 static unsigned int extrasoundtime = 0;
132 static double snd_starttime = 0.0;
133 qboolean snd_threaded = false;
134 qboolean snd_usethreadedmixing = false;
136 vec3_t listener_origin;
137 matrix4x4_t listener_matrix[SND_LISTENERS];
138 mempool_t *snd_mempool;
140 // Linked list of known sfx
141 static sfx_t *known_sfx = NULL;
143 static qboolean sound_spatialized = false;
145 qboolean simsound = false;
147 static qboolean recording_sound = false;
150 static int current_swapstereo = false;
151 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
152 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
154 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
155 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
156 spatialmethod_t spatialmethod;
158 // Cvars declared in sound.h (part of the sound API)
159 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
160 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
161 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
162 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
163 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)"};
164 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
165 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
166 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
167 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
168 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
169 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
170 cvar_t snd_spatialization_occlusion = {CVAR_SAVE, "snd_spatialization_occlusion", "1", "enable occlusion testing on spatialized sounds, which simply quiets sounds that are blocked by the world"};
172 // Cvars declared in snd_main.h (shared with other snd_*.c files)
173 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.15", "how much sound to mix ahead of time"};
174 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)"};
175 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
176 extern cvar_t v_flipped;
177 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
178 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
179 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities"};
180 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities"};
181 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities"};
182 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities"};
183 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities"};
184 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities"};
185 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities"};
186 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities"};
187 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities"};
188 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities"};
189 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities"};
190 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities"};
191 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities"};
192 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities"};
193 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities"};
194 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities"};
195 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
196 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
197 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
198 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
199 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
200 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
201 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
202 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
203 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
204 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
205 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
206 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
207 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
208 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
209 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
210 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
213 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
214 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
215 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
216 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
217 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"};
218 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
220 // Default sound format is 48KHz, 16-bit, stereo
221 // (48KHz because a lot of onboard sound cards sucks at any other speed)
222 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
223 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
224 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)"};
227 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
228 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
231 // ====================================================================
233 // ====================================================================
235 void S_FreeSfx (sfx_t *sfx, qboolean force);
237 static void S_Play_Common (float fvol, float attenuation)
240 char name [MAX_QPATH];
244 while (i < Cmd_Argc ())
246 // Get the name, and appends ".wav" as an extension if there's none
247 strlcpy (name, Cmd_Argv (i), sizeof (name));
248 if (!strrchr (name, '.'))
249 strlcat (name, ".wav", sizeof (name));
252 // If we need to get the volume from the command line
255 fvol = atof (Cmd_Argv (i));
259 sfx = S_PrecacheSound (name, true, true);
262 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
264 // Free the sfx if the file didn't exist
266 S_FreeSfx (sfx, false);
268 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
273 static void S_Play_f(void)
275 S_Play_Common (1.0f, 1.0f);
278 static void S_Play2_f(void)
280 S_Play_Common (1.0f, 0.0f);
283 static void S_PlayVol_f(void)
285 S_Play_Common (-1.0f, 0.0f);
288 static void S_SoundList_f (void)
295 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
297 if (sfx->fetcher != NULL)
300 const snd_format_t* format;
303 format = sfx->fetcher->getfmt(sfx);
304 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
305 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
306 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
307 (sfx->locks > 0) ? 'K' : ' ',
308 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
310 (format->channels == 1) ? "mono" : "stereo",
316 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
318 Con_Printf("Total resident: %i\n", total);
322 void S_SoundInfo_f(void)
324 if (snd_renderbuffer == NULL)
326 Con_Print("sound system not started\n");
330 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
331 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
332 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
333 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
334 Con_Printf("%5u total_channels\n", total_channels);
338 int S_GetSoundRate(void)
340 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
343 int S_GetSoundChannels(void)
345 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
349 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
351 static const snd_format_t thresholds [] =
353 // speed width channels
354 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
360 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
362 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
363 unsigned int speed_level, width_level, channels_level;
365 // If we have reached the minimum values, there's nothing more we can do
366 if ((format->speed == thresholds[0].speed || fixed_speed) &&
367 (format->width == thresholds[0].width || fixed_width) &&
368 (format->channels == thresholds[0].channels || fixed_channels))
371 // Check the min and max values
372 #define CHECK_BOUNDARIES(param) \
373 if (format->param < thresholds[0].param) \
375 format->param = thresholds[0].param; \
378 if (format->param > thresholds[nb_thresholds - 1].param) \
380 format->param = thresholds[nb_thresholds - 1].param; \
383 CHECK_BOUNDARIES(speed);
384 CHECK_BOUNDARIES(width);
385 CHECK_BOUNDARIES(channels);
386 #undef CHECK_BOUNDARIES
388 // Find the level of each parameter
389 #define FIND_LEVEL(param) \
391 while (param##_level < nb_thresholds - 1) \
393 if (format->param <= thresholds[param##_level].param) \
400 FIND_LEVEL(channels);
403 // Decrease the parameter with the highest level to the previous level
404 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
406 format->channels = thresholds[channels_level - 1].channels;
409 if (speed_level >= width_level && !fixed_speed)
411 format->speed = thresholds[speed_level - 1].speed;
415 format->width = thresholds[width_level - 1].width;
420 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
422 static void S_SetChannelLayout (void)
425 listener_t swaplistener;
426 listener_t *listeners;
429 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
430 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
432 if (i >= SND_SPEAKERLAYOUTS)
434 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
435 snd_renderbuffer->format.channels);
436 i = SND_SPEAKERLAYOUTS - 1;
439 snd_speakerlayout = snd_speakerlayouts[i];
440 listeners = snd_speakerlayout.listeners;
442 // Swap the left and right channels if snd_swapstereo is set
443 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
445 switch (snd_speakerlayout.channels)
448 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
452 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
455 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
466 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
467 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
468 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
470 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
472 // If we're in the sound engine initialization
473 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
475 layout = SND_CHANNELLAYOUT_STANDARD;
476 Cvar_SetValueQuick (&snd_channellayout, layout);
479 layout = current_channellayout_used;
482 layout = snd_channellayout.integer;
484 // Convert our layout (= ALSA) to the standard layout if necessary
485 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
487 if (layout == SND_CHANNELLAYOUT_STANDARD)
489 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
490 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
493 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
494 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
497 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
498 current_channellayout = snd_channellayout.integer;
499 current_channellayout_used = layout;
503 void S_Startup (void)
505 qboolean fixed_speed, fixed_width, fixed_channels;
506 snd_format_t chosen_fmt;
507 static snd_format_t prev_render_format = {0, 0, 0};
514 if (!snd_initialized.integer)
519 fixed_channels = false;
521 // Get the starting sound format from the cvars
522 chosen_fmt.speed = snd_speed.integer;
523 chosen_fmt.width = snd_width.integer;
524 chosen_fmt.channels = snd_channels.integer;
526 // Check the environment variables to see if the player wants a particular sound format
528 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
530 env = getenv("QUAKE_SOUND_CHANNELS");
534 chosen_fmt.channels = atoi (env);
538 fixed_channels = true;
541 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
543 env = getenv("QUAKE_SOUND_SPEED");
547 chosen_fmt.speed = atoi (env);
554 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
556 env = getenv("QUAKE_SOUND_SAMPLEBITS");
560 chosen_fmt.width = atoi (env) / 8;
567 // Parse the command line to see if the player wants a particular sound format
568 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
569 if (COM_CheckParm ("-sndquad") != 0)
571 chosen_fmt.channels = 4;
572 fixed_channels = true;
574 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
575 else if (COM_CheckParm ("-sndstereo") != 0)
577 chosen_fmt.channels = 2;
578 fixed_channels = true;
580 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
581 else if (COM_CheckParm ("-sndmono") != 0)
583 chosen_fmt.channels = 1;
584 fixed_channels = true;
586 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
587 i = COM_CheckParm ("-sndspeed");
588 if (0 < i && i < com_argc - 1)
590 chosen_fmt.speed = atoi (com_argv[i + 1]);
593 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
594 i = COM_CheckParm ("-sndbits");
595 if (0 < i && i < com_argc - 1)
597 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
601 // You can't change sound speed after start time (not yet supported)
602 if (prev_render_format.speed != 0)
605 if (chosen_fmt.speed != prev_render_format.speed)
607 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
608 prev_render_format.speed);
609 chosen_fmt.speed = prev_render_format.speed;
614 if (chosen_fmt.speed < SND_MIN_SPEED)
616 chosen_fmt.speed = SND_MIN_SPEED;
619 else if (chosen_fmt.speed > SND_MAX_SPEED)
621 chosen_fmt.speed = SND_MAX_SPEED;
625 if (chosen_fmt.width < SND_MIN_WIDTH)
627 chosen_fmt.width = SND_MIN_WIDTH;
630 else if (chosen_fmt.width > SND_MAX_WIDTH)
632 chosen_fmt.width = SND_MAX_WIDTH;
636 if (chosen_fmt.channels < SND_MIN_CHANNELS)
638 chosen_fmt.channels = SND_MIN_CHANNELS;
639 fixed_channels = false;
641 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
643 chosen_fmt.channels = SND_MAX_CHANNELS;
644 fixed_channels = false;
647 // create the sound buffer used for sumitting the samples to the plaform-dependent module
650 snd_format_t suggest_fmt;
656 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
657 chosen_fmt.speed, chosen_fmt.width * 8,
658 chosen_fmt.channels);
660 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
661 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
665 Con_Printf("S_Startup: sound output initialization FAILED\n");
667 // If the module is suggesting another one
668 if (suggest_fmt.speed != 0)
670 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
671 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
672 suggest_fmt.speed, suggest_fmt.width * 8,
673 suggest_fmt.channels);
675 // Else, try to find a less resource-demanding format
676 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
681 // If we haven't found a suitable format
684 Con_Print("S_Startup: SndSys_Init failed.\n");
685 sound_spatialized = false;
691 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
692 Con_Print ("S_Startup: simulating sound output\n");
695 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
696 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
697 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
700 if (snd_speed.integer != (int)chosen_fmt.speed)
701 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
702 if (snd_width.integer != chosen_fmt.width)
703 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
704 if (snd_channels.integer != chosen_fmt.channels)
705 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
707 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
708 S_SetChannelLayout();
710 snd_starttime = realtime;
712 // If the sound module has already run, add an extra time to make sure
713 // the sound time doesn't decrease, to not confuse playing SFXs
714 if (oldpaintedtime != 0)
716 // The extra time must be a multiple of the render buffer size
717 // to avoid modifying the current position in the buffer,
718 // some modules write directly to a shared (DMA) buffer
719 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
720 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
721 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
723 soundtime = extrasoundtime;
727 snd_renderbuffer->startframe = soundtime;
728 snd_renderbuffer->endframe = soundtime;
729 recording_sound = false;
732 void S_Shutdown(void)
734 if (snd_renderbuffer == NULL)
737 oldpaintedtime = snd_renderbuffer->endframe;
741 Mem_Free(snd_renderbuffer->ring);
742 Mem_Free(snd_renderbuffer);
743 snd_renderbuffer = NULL;
748 sound_spatialized = false;
751 void S_Restart_f(void)
753 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
754 // So, refuse to do this if we are connected.
755 if(cls.state == ca_connected)
757 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
772 Cvar_RegisterVariable(&volume);
773 Cvar_RegisterVariable(&bgmvolume);
774 Cvar_RegisterVariable(&snd_staticvolume);
775 Cvar_RegisterVariable(&snd_entchannel0volume);
776 Cvar_RegisterVariable(&snd_entchannel1volume);
777 Cvar_RegisterVariable(&snd_entchannel2volume);
778 Cvar_RegisterVariable(&snd_entchannel3volume);
779 Cvar_RegisterVariable(&snd_entchannel4volume);
780 Cvar_RegisterVariable(&snd_entchannel5volume);
781 Cvar_RegisterVariable(&snd_entchannel6volume);
782 Cvar_RegisterVariable(&snd_entchannel7volume);
783 Cvar_RegisterVariable(&snd_worldchannel0volume);
784 Cvar_RegisterVariable(&snd_worldchannel1volume);
785 Cvar_RegisterVariable(&snd_worldchannel2volume);
786 Cvar_RegisterVariable(&snd_worldchannel3volume);
787 Cvar_RegisterVariable(&snd_worldchannel4volume);
788 Cvar_RegisterVariable(&snd_worldchannel5volume);
789 Cvar_RegisterVariable(&snd_worldchannel6volume);
790 Cvar_RegisterVariable(&snd_worldchannel7volume);
791 Cvar_RegisterVariable(&snd_playerchannel0volume);
792 Cvar_RegisterVariable(&snd_playerchannel1volume);
793 Cvar_RegisterVariable(&snd_playerchannel2volume);
794 Cvar_RegisterVariable(&snd_playerchannel3volume);
795 Cvar_RegisterVariable(&snd_playerchannel4volume);
796 Cvar_RegisterVariable(&snd_playerchannel5volume);
797 Cvar_RegisterVariable(&snd_playerchannel6volume);
798 Cvar_RegisterVariable(&snd_playerchannel7volume);
799 Cvar_RegisterVariable(&snd_csqcchannel0volume);
800 Cvar_RegisterVariable(&snd_csqcchannel1volume);
801 Cvar_RegisterVariable(&snd_csqcchannel2volume);
802 Cvar_RegisterVariable(&snd_csqcchannel3volume);
803 Cvar_RegisterVariable(&snd_csqcchannel4volume);
804 Cvar_RegisterVariable(&snd_csqcchannel5volume);
805 Cvar_RegisterVariable(&snd_csqcchannel6volume);
806 Cvar_RegisterVariable(&snd_csqcchannel7volume);
808 Cvar_RegisterVariable(&snd_spatialization_min_radius);
809 Cvar_RegisterVariable(&snd_spatialization_max_radius);
810 Cvar_RegisterVariable(&snd_spatialization_min);
811 Cvar_RegisterVariable(&snd_spatialization_max);
812 Cvar_RegisterVariable(&snd_spatialization_power);
813 Cvar_RegisterVariable(&snd_spatialization_control);
814 Cvar_RegisterVariable(&snd_spatialization_occlusion);
816 Cvar_RegisterVariable(&snd_speed);
817 Cvar_RegisterVariable(&snd_width);
818 Cvar_RegisterVariable(&snd_channels);
819 Cvar_RegisterVariable(&snd_mutewhenidle);
821 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
822 if (COM_CheckParm("-nosound"))
824 // dummy out Play and Play2 because mods stuffcmd that
825 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
826 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
830 snd_mempool = Mem_AllocPool("sound", 0, NULL);
832 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
833 if (COM_CheckParm("-simsound"))
836 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
837 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
838 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
839 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
840 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
841 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
842 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
843 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
845 Cvar_RegisterVariable(&nosound);
846 Cvar_RegisterVariable(&snd_precache);
847 Cvar_RegisterVariable(&snd_initialized);
848 Cvar_RegisterVariable(&snd_streaming);
849 Cvar_RegisterVariable(&ambient_level);
850 Cvar_RegisterVariable(&ambient_fade);
851 Cvar_RegisterVariable(&snd_noextraupdate);
852 Cvar_RegisterVariable(&snd_show);
853 Cvar_RegisterVariable(&_snd_mixahead);
854 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
855 Cvar_RegisterVariable(&snd_channellayout);
856 Cvar_RegisterVariable(&snd_soundradius);
858 Cvar_SetValueQuick(&snd_initialized, true);
862 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
863 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
866 ModPlug_OpenLibrary ();
874 Shutdown and free all resources
877 void S_Terminate (void)
880 ModPlug_CloseLibrary ();
884 while (known_sfx != NULL)
885 S_FreeSfx (known_sfx, true);
887 Cvar_SetValueQuick (&snd_initialized, false);
888 Mem_FreePool (&snd_mempool);
897 void S_UnloadAllSounds_f (void)
901 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
902 // So, refuse to do this if we are connected.
903 if(cls.state == ca_connected)
905 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
909 // stop any active sounds
912 // because the ambient sounds will be freed, clear the pointers
913 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
914 ambient_sfxs[i] = NULL;
916 // now free all sounds
917 while (known_sfx != NULL)
918 S_FreeSfx (known_sfx, true);
927 sfx_t changevolume_sfx = {""};
928 sfx_t *S_FindName (const char *name)
932 if (!snd_initialized.integer)
935 if(!strcmp(name, changevolume_sfx.name))
936 return &changevolume_sfx;
938 if (strlen (name) >= sizeof (sfx->name))
940 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
944 // Look for this sound in the list of known sfx
945 // TODO: hash table search?
946 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
947 if(!strcmp (sfx->name, name))
950 // Add a sfx_t struct for this sound
951 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
952 memset (sfx, 0, sizeof(*sfx));
953 strlcpy (sfx->name, name, sizeof (sfx->name));
954 sfx->memsize = sizeof(*sfx);
955 sfx->next = known_sfx;
967 void S_FreeSfx (sfx_t *sfx, qboolean force)
971 // Never free a locked sfx unless forced
972 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
975 if (developer_loading.integer)
976 Con_Printf ("unloading sound %s\n", sfx->name);
978 // Remove it from the list of known sfx
979 if (sfx == known_sfx)
980 known_sfx = known_sfx->next;
985 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
986 if (prev_sfx->next == sfx)
988 prev_sfx->next = sfx->next;
991 if (prev_sfx == NULL)
993 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
998 // Stop all channels using this sfx
999 for (i = 0; i < total_channels; i++)
1000 if (channels[i].sfx == sfx)
1001 S_StopChannel (i, true);
1004 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
1005 sfx->fetcher->free (sfx->fetcher_data);
1015 void S_ClearUsed (void)
1021 // Start the ambient sounds and make them loop
1022 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1024 // Precache it if it's not done (request a lock to make sure it will never be freed)
1025 if (ambient_sfxs[i] == NULL)
1026 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
1027 if (ambient_sfxs[i] != NULL)
1029 // Add a lock to the SFX while playing. It will be
1030 // removed by S_StopAllSounds at the end of the level
1031 S_LockSfx (ambient_sfxs[i]);
1033 channels[i].sfx = ambient_sfxs[i];
1034 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1035 channels[i].master_vol = 0;
1039 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
1040 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1041 if (sfx->flags & SFXFLAG_SERVERSOUND)
1044 sfx->flags &= ~SFXFLAG_SERVERSOUND;
1053 void S_PurgeUnused(void)
1058 // Free all unlocked sfx
1059 for (sfx = known_sfx;sfx;sfx = sfxnext)
1061 sfxnext = sfx->next;
1062 S_FreeSfx (sfx, false);
1072 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean serversound)
1076 if (!snd_initialized.integer)
1079 if (name == NULL || name[0] == 0)
1082 sfx = S_FindName (name);
1087 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1088 // previously missing file
1089 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1091 if (serversound && !(sfx->flags & SFXFLAG_SERVERSOUND))
1094 sfx->flags |= SFXFLAG_SERVERSOUND;
1097 if (!nosound.integer && snd_precache.integer)
1098 S_LoadSound(sfx, complain);
1109 float S_SoundLength(const char *name)
1113 if (!snd_initialized.integer)
1115 if (name == NULL || name[0] == 0)
1118 sfx = S_FindName(name);
1121 return sfx->total_length / (float) S_GetSoundRate();
1129 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1131 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1141 void S_LockSfx (sfx_t *sfx)
1150 Remove a lock from a SFX
1153 void S_UnlockSfx (sfx_t *sfx)
1164 void S_BlockSound (void)
1175 void S_UnblockSound (void)
1185 Picks a channel based on priorities, empty slots, number of channels
1188 channel_t *SND_PickChannel(int entnum, int entchannel)
1192 int first_life_left, life_left;
1195 // Check for replacement sound, or find the best one to replace
1197 first_life_left = 0x7fffffff;
1199 // entity channels try to replace the existing sound on the channel
1200 if (entchannel != 0)
1202 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1204 ch = &channels[ch_idx];
1205 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1207 // always override sound from same entity
1208 S_StopChannel (ch_idx, true);
1209 return &channels[ch_idx];
1214 // there was no channel to override, so look for the first empty one
1215 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1217 ch = &channels[ch_idx];
1220 // no sound on this channel
1221 first_to_die = ch_idx;
1222 goto emptychan_found;
1225 // don't let monster sounds override player sounds
1226 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1229 // don't override looped sounds
1230 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1232 life_left = ch->sfx->total_length - ch->pos;
1234 if (life_left < first_life_left)
1236 first_life_left = life_left;
1237 first_to_die = ch_idx;
1241 if (first_to_die == -1)
1244 S_StopChannel (first_to_die, true);
1247 return &channels[first_to_die];
1254 Spatializes a channel
1257 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1258 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1262 vec_t dist, mastervol, intensity, vol;
1265 // update sound origin if we know about the entity
1266 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1268 if (ch->entnum >= MAX_EDICTS)
1270 //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]);
1272 if (ch->entnum > MAX_EDICTS)
1273 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1274 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1276 else if (cl.entities[ch->entnum].state_current.active)
1279 //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]);
1280 model = CL_GetModelByIndex(cl.entities[ch->entnum].state_current.modelindex);
1281 if (model && model->soundfromcenter)
1282 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1284 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1288 mastervol = ch->master_vol;
1290 // Adjust volume of static sounds
1292 mastervol *= snd_staticvolume.value;
1293 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1295 if(ch->entnum >= MAX_EDICTS)
1297 switch(ch->entchannel)
1299 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1300 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1301 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1302 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1303 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1304 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1305 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1306 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1310 else if(ch->entnum == 0)
1312 switch(ch->entchannel)
1314 case 0: mastervol *= snd_worldchannel0volume.value; break;
1315 case 1: mastervol *= snd_worldchannel1volume.value; break;
1316 case 2: mastervol *= snd_worldchannel2volume.value; break;
1317 case 3: mastervol *= snd_worldchannel3volume.value; break;
1318 case 4: mastervol *= snd_worldchannel4volume.value; break;
1319 case 5: mastervol *= snd_worldchannel5volume.value; break;
1320 case 6: mastervol *= snd_worldchannel6volume.value; break;
1321 case 7: mastervol *= snd_worldchannel7volume.value; break;
1325 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1327 switch(ch->entchannel)
1329 case 0: mastervol *= snd_playerchannel0volume.value; break;
1330 case 1: mastervol *= snd_playerchannel1volume.value; break;
1331 case 2: mastervol *= snd_playerchannel2volume.value; break;
1332 case 3: mastervol *= snd_playerchannel3volume.value; break;
1333 case 4: mastervol *= snd_playerchannel4volume.value; break;
1334 case 5: mastervol *= snd_playerchannel5volume.value; break;
1335 case 6: mastervol *= snd_playerchannel6volume.value; break;
1336 case 7: mastervol *= snd_playerchannel7volume.value; break;
1342 switch(ch->entchannel)
1344 case 0: mastervol *= snd_entchannel0volume.value; break;
1345 case 1: mastervol *= snd_entchannel1volume.value; break;
1346 case 2: mastervol *= snd_entchannel2volume.value; break;
1347 case 3: mastervol *= snd_entchannel3volume.value; break;
1348 case 4: mastervol *= snd_entchannel4volume.value; break;
1349 case 5: mastervol *= snd_entchannel5volume.value; break;
1350 case 6: mastervol *= snd_entchannel6volume.value; break;
1351 case 7: mastervol *= snd_entchannel7volume.value; break;
1357 // anything coming from the view entity will always be full volume
1358 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1359 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1361 for (i = 0;i < SND_LISTENERS;i++)
1363 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1364 ch->listener_volume[i] = (int)bound(0, vol, 255);
1369 // calculate stereo seperation and distance attenuation
1370 VectorSubtract(listener_origin, ch->origin, source_vec);
1371 dist = VectorLength(source_vec);
1372 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1375 for (i = 0;i < SND_LISTENERS;i++)
1377 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1378 VectorNormalize(source_vec);
1380 switch(spatialmethod)
1384 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1386 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1387 VectorScale(source_vec, f, source_vec);
1390 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1391 f = spatialmin + spatialdiff * bound(0, f, 1);
1392 VectorScale(source_vec, f, source_vec);
1394 case SPATIAL_THRESH:
1395 f = spatialmin + spatialdiff * (dist < spatialoffset);
1396 VectorScale(source_vec, f, source_vec);
1403 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1405 if (snd_spatialization_occlusion.integer)
1408 && cl.worldmodel->brush.TraceLineOfSight
1409 && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1415 ch->listener_volume[i] = (int)bound(0, vol, 255);
1419 for (i = 0;i < SND_LISTENERS;i++)
1420 ch->listener_volume[i] = 0;
1425 // =======================================================================
1426 // Start a sound effect
1427 // =======================================================================
1429 static void S_SetChannelVolume_WithSfx (unsigned int ch_ind, float fvol, sfx_t *sfx);
1430 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic, int entnum, int entchannel, int startpos)
1434 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1437 // Initialize the channel
1438 // a crash was reported on an in-use channel, so check here...
1439 if (target_chan->sfx)
1441 int channelindex = (int)(target_chan - channels);
1442 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1443 S_StopChannel (channelindex, true);
1445 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1446 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1447 memset (target_chan, 0, sizeof (*target_chan));
1448 VectorCopy (origin, target_chan->origin);
1449 target_chan->flags = flags;
1450 target_chan->pos = startpos; // start of the sound
1451 target_chan->entnum = entnum;
1452 target_chan->entchannel = entchannel;
1454 // If it's a static sound
1457 if (sfx->loopstart >= sfx->total_length && (cls.protocol == PROTOCOL_QUAKE || cls.protocol == PROTOCOL_QUAKEWORLD))
1458 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1459 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1462 target_chan->dist_mult = attenuation / snd_soundradius.value;
1464 // we have to set the channel volume AFTER the sfx because the function
1465 // needs it for replaygain support
1466 S_SetChannelVolume_WithSfx(target_chan - channels, fvol, sfx);
1468 // set the listener volumes
1469 SND_Spatialize (target_chan, isstatic);
1471 // Lock the SFX during play
1474 // finally, set the sfx pointer, so the channel becomes valid for playback
1475 // and will be noticed by the mixer
1476 target_chan->sfx = sfx;
1480 int S_StartSound_StartPosition (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation, float startposition)
1482 channel_t *target_chan, *check, *ch;
1483 int ch_idx, startpos;
1485 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1488 if(sfx == &changevolume_sfx)
1492 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1494 ch = &channels[ch_idx];
1495 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1497 S_SetChannelVolume(ch_idx, fvol);
1498 ch->dist_mult = attenuation / snd_soundradius.value;
1499 SND_Spatialize(ch, false);
1506 if (sfx->fetcher == NULL)
1509 // Pick a channel to play on
1510 target_chan = SND_PickChannel(entnum, entchannel);
1514 // if an identical sound has also been started this frame, offset the pos
1515 // a bit to keep it from just making the first one louder
1516 check = &channels[NUM_AMBIENTS];
1517 startpos = (int)(startposition * S_GetSoundRate());
1520 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1522 if (check == target_chan)
1524 if (check->sfx == sfx && check->pos == 0)
1526 // use negative pos offset to delay this sound effect
1527 startpos = (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1533 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false, entnum, entchannel, startpos);
1535 return (target_chan - channels);
1538 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1540 return S_StartSound_StartPosition(entnum, entchannel, sfx, origin, fvol, attenuation, 0);
1543 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex)
1547 if (channel_ind >= total_channels)
1550 // we have to lock an audio mutex to prevent crashes if an audio mixer
1551 // thread is currently mixing this channel
1552 // the SndSys_LockRenderBuffer function uses such a mutex in
1553 // threaded sound backends
1554 if (lockmutex && !simsound)
1555 SndSys_LockRenderBuffer();
1557 ch = &channels[channel_ind];
1558 if (ch->sfx != NULL)
1560 sfx_t *sfx = ch->sfx;
1562 if (sfx->fetcher != NULL)
1564 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1565 if (fetcher_endsb != NULL)
1566 fetcher_endsb (ch->fetcher_data);
1569 // Remove the lock it holds
1572 ch->fetcher_data = NULL;
1575 if (lockmutex && !simsound)
1576 SndSys_UnlockRenderBuffer();
1580 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1582 if (ch_ind >= total_channels)
1585 if (flag != CHANNELFLAG_FORCELOOP &&
1586 flag != CHANNELFLAG_PAUSED &&
1587 flag != CHANNELFLAG_FULLVOLUME &&
1588 flag != CHANNELFLAG_LOCALSOUND)
1592 channels[ch_ind].flags |= flag;
1594 channels[ch_ind].flags &= ~flag;
1599 void S_StopSound(int entnum, int entchannel)
1603 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1604 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1606 S_StopChannel (i, true);
1611 extern void CDAudio_Stop(void);
1612 void S_StopAllSounds (void)
1616 // TOCHECK: is this test necessary?
1617 if (snd_renderbuffer == NULL)
1620 // stop CD audio because it may be using a faketrack
1623 if (simsound || SndSys_LockRenderBuffer ())
1628 for (i = 0; i < total_channels; i++)
1629 S_StopChannel (i, false);
1631 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1632 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1634 // Mute the contents of the submittion buffer
1635 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1636 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1637 memset(snd_renderbuffer->ring, clear, memsize);
1640 SndSys_UnlockRenderBuffer ();
1644 void S_PauseGameSounds (qboolean toggle)
1648 for (i = 0; i < total_channels; i++)
1653 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1654 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1658 static void S_SetChannelVolume_WithSfx (unsigned int ch_ind, float fvol, sfx_t *sfx)
1660 if(sfx->volume_peak > 0)
1662 // Replaygain support
1663 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1664 fvol *= sfx->volume_mult;
1665 if(fvol * sfx->volume_peak > 1)
1666 fvol = 1 / sfx->volume_peak;
1667 // Con_DPrintf("%f\n", fvol);
1669 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1672 void S_SetChannelVolume(unsigned int ch_ind, float fvol)
1674 sfx_t *sfx = channels[ch_ind].sfx;
1675 S_SetChannelVolume_WithSfx(ch_ind, fvol, sfx);
1678 float S_GetChannelPosition (unsigned int ch_ind)
1680 // note: this is NOT accurate yet
1682 channel_t *ch = &channels[ch_ind];
1683 sfx_t *sfx = ch->sfx;
1689 if(!snd_usethreadedmixing)
1690 s += _snd_mixahead.value * S_GetSoundRate();
1692 return (s % sfx->total_length) / (float) S_GetSoundRate();
1695 float S_GetEntChannelPosition(int entnum, int entchannel)
1700 for (i = 0; i < total_channels; i++)
1703 if (ch->entnum == entnum && ch->entchannel == entchannel)
1704 return S_GetChannelPosition(i);
1706 return -1; // no playing sound in this channel
1714 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1716 channel_t *target_chan;
1718 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1722 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1726 if (total_channels == MAX_CHANNELS)
1728 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1732 target_chan = &channels[total_channels++];
1733 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true, 0, 0, 0);
1739 S_UpdateAmbientSounds
1742 void S_UpdateAmbientSounds (void)
1746 int ambient_channel;
1748 unsigned char ambientlevels[NUM_AMBIENTS];
1750 memset(ambientlevels, 0, sizeof(ambientlevels));
1751 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1752 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1754 // Calc ambient sound levels
1755 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1757 chan = &channels[ambient_channel];
1758 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1761 vol = (int)ambientlevels[ambient_channel];
1765 // Don't adjust volume too fast
1766 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1767 if (cl.time > cl.oldtime)
1769 if (chan->master_vol < vol)
1771 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1772 if (chan->master_vol > vol)
1773 chan->master_vol = vol;
1775 else if (chan->master_vol > vol)
1777 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1778 if (chan->master_vol < vol)
1779 chan->master_vol = vol;
1783 for (i = 0;i < SND_LISTENERS;i++)
1784 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1788 static void S_PaintAndSubmit (void)
1790 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1791 int usesoundtimehack;
1792 static int soundtimehack = -1;
1793 static int oldsoundtime = 0;
1795 if (snd_renderbuffer == NULL || nosound.integer)
1798 // Update sound time
1799 snd_usethreadedmixing = false;
1800 usesoundtimehack = true;
1801 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1803 usesoundtimehack = 1;
1804 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1806 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1808 usesoundtimehack = 2;
1809 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1813 usesoundtimehack = 3;
1814 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1818 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1819 usesoundtimehack = 0;
1820 newsoundtime = SndSys_GetSoundTime();
1822 // if the soundtimehack state changes we need to reset the soundtime
1823 if (soundtimehack != usesoundtimehack)
1825 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1827 // Mute the contents of the submission buffer
1828 if (simsound || SndSys_LockRenderBuffer ())
1833 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1834 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1835 memset(snd_renderbuffer->ring, clear, memsize);
1838 SndSys_UnlockRenderBuffer ();
1841 soundtimehack = usesoundtimehack;
1843 if (!soundtimehack && snd_blocked > 0)
1846 if (snd_usethreadedmixing)
1847 return; // the audio thread will mix its own data
1849 newsoundtime += extrasoundtime;
1850 if (newsoundtime < soundtime)
1852 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1854 unsigned int additionaltime;
1856 // add some time to extrasoundtime make newsoundtime higher
1858 // The extra time must be a multiple of the render buffer size
1859 // to avoid modifying the current position in the buffer,
1860 // some modules write directly to a shared (DMA) buffer
1861 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1862 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1864 extrasoundtime += additionaltime;
1865 newsoundtime += additionaltime;
1866 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1869 else if (!soundtimehack)
1870 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1871 newsoundtime, soundtime);
1873 soundtime = newsoundtime;
1874 recording_sound = (cls.capturevideo.soundrate != 0);
1876 // Lock submitbuffer
1877 if (!simsound && !SndSys_LockRenderBuffer())
1879 // If the lock failed, stop here
1880 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
1884 // Check to make sure that we haven't overshot
1885 paintedtime = snd_renderbuffer->endframe;
1886 if (paintedtime < soundtime)
1887 paintedtime = soundtime;
1889 // mix ahead of current position
1891 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1893 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
1894 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1895 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1896 endtime = min(endtime, maxtime);
1898 while (paintedtime < endtime)
1900 unsigned int startoffset;
1901 unsigned int nbframes;
1903 // see how much we can fit in the paint buffer
1904 nbframes = endtime - paintedtime;
1905 // limit to the end of the ring buffer (in case of wrapping)
1906 startoffset = paintedtime % snd_renderbuffer->maxframes;
1907 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
1909 // mix into the buffer
1910 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
1912 paintedtime += nbframes;
1913 snd_renderbuffer->endframe = paintedtime;
1916 SndSys_UnlockRenderBuffer();
1918 // Remove outdated samples from the ring buffer, if any
1919 if (snd_renderbuffer->startframe < soundtime)
1920 snd_renderbuffer->startframe = soundtime;
1923 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1927 oldsoundtime = soundtime;
1929 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
1930 R_TimeReport("audiomix");
1937 Called once each time through the main loop
1940 void S_Update(const matrix4x4_t *listenermatrix)
1942 unsigned int i, j, k;
1943 channel_t *ch, *combine;
1944 matrix4x4_t basematrix, rotatematrix;
1946 if (snd_renderbuffer == NULL || nosound.integer)
1950 double mindist_trans, maxdist_trans;
1952 spatialmin = snd_spatialization_min.value;
1953 spatialdiff = snd_spatialization_max.value - spatialmin;
1955 if(snd_spatialization_control.value)
1957 spatialpower = snd_spatialization_power.value;
1959 if(spatialpower == 0)
1961 spatialmethod = SPATIAL_LOG;
1962 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
1963 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
1967 spatialmethod = SPATIAL_POW;
1968 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
1969 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
1972 if(mindist_trans - maxdist_trans == 0)
1974 spatialmethod = SPATIAL_THRESH;
1975 mindist_trans = snd_spatialization_min_radius.value;
1979 spatialoffset = mindist_trans;
1980 spatialfactor = 1 / (maxdist_trans - mindist_trans);
1984 spatialmethod = SPATIAL_NONE;
1988 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1989 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1990 current_channellayout != snd_channellayout.integer)
1991 S_SetChannelLayout();
1993 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1994 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1996 // calculate the current matrices
1997 for (j = 0;j < SND_LISTENERS;j++)
1999 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
2000 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
2001 // I think this should now do this:
2002 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
2003 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
2004 // angle has to be taken negative)
2005 // 2. create a transform which first rotates and moves its argument
2006 // into the player's view coordinates (using basematrix which is
2007 // an inverted "absolute" listener matrix), then applies the
2008 // rotation matrix for the ear
2009 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
2010 // does not actually refer to an entity?
2013 // update general area ambient sound sources
2014 S_UpdateAmbientSounds ();
2017 R_TimeReport("audioprep");
2019 // update spatialization for static and dynamic sounds
2020 cls.soundstats.totalsounds = 0;
2021 cls.soundstats.mixedsounds = 0;
2022 ch = channels+NUM_AMBIENTS;
2023 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
2027 cls.soundstats.totalsounds++;
2029 // respatialize channel
2030 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
2032 // try to combine static sounds with a previous channel of the same
2033 // sound effect so we don't mix five torches every frame
2034 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
2036 // no need to merge silent channels
2037 for (j = 0;j < SND_LISTENERS;j++)
2038 if (ch->listener_volume[j])
2040 if (j == SND_LISTENERS)
2042 // if the last combine chosen isn't suitable, find a new one
2043 if (!(combine && combine != ch && combine->sfx == ch->sfx))
2047 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
2049 if (channels[j].sfx == ch->sfx)
2051 combine = channels + j;
2056 if (combine && combine != ch && combine->sfx == ch->sfx)
2058 for (j = 0;j < SND_LISTENERS;j++)
2060 combine->listener_volume[j] += ch->listener_volume[j];
2061 ch->listener_volume[j] = 0;
2065 for (k = 0;k < SND_LISTENERS;k++)
2066 if (ch->listener_volume[k])
2068 if (k < SND_LISTENERS)
2069 cls.soundstats.mixedsounds++;
2071 R_TimeReport("audiospatialize");
2073 sound_spatialized = true;
2076 if (snd_show.integer)
2077 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2082 void S_ExtraUpdate (void)
2084 if (snd_noextraupdate.integer || !sound_spatialized)
2090 qboolean S_LocalSound (const char *sound)
2095 if (!snd_initialized.integer || nosound.integer)
2098 sfx = S_PrecacheSound (sound, true, false);
2101 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2105 // Local sounds must not be freed
2106 sfx->flags |= SFXFLAG_PERMANENTLOCK;
2108 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2112 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;