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
36 #if SND_LISTENERS != 8
37 # error this data only supports up to 8 channel, update it!
40 speakerlayout_t snd_speakerlayout;
42 // Our speaker layouts are based on ALSA. They differ from those
43 // Win32 and Mac OS X APIs use when there's more than 4 channels.
44 // (rear left + rear right, and front center + LFE are swapped).
45 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
46 static const speakerlayout_t snd_speakerlayouts[] =
51 {0, 45, 0.2, 0.2, 0.5}, // front left
52 {1, 315, 0.2, 0.2, 0.5}, // front right
53 {2, 135, 0.2, 0.2, 0.5}, // rear left
54 {3, 225, 0.2, 0.2, 0.5}, // rear right
55 {4, 0, 0.2, 0.2, 0.5}, // front center
56 {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)
57 {6, 90, 0.2, 0.2, 0.5}, // side left
58 {7, 180, 0.2, 0.2, 0.5}, // side right
64 {0, 45, 0.2, 0.2, 0.5}, // front left
65 {1, 315, 0.2, 0.2, 0.5}, // front right
66 {2, 135, 0.2, 0.2, 0.5}, // rear left
67 {3, 225, 0.2, 0.2, 0.5}, // rear right
68 {4, 0, 0.2, 0.2, 0.5}, // front center
69 {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)
75 // these systems sometimes have a subwoofer as well, but it has no
79 {0, 45, 0.3, 0.3, 0.8}, // front left
80 {1, 315, 0.3, 0.3, 0.8}, // front right
81 {2, 135, 0.3, 0.3, 0.8}, // rear left
82 {3, 225, 0.3, 0.3, 0.8}, // rear right
90 // these systems sometimes have a subwoofer as well, but it has no
94 {0, 90, 0.5, 0.5, 1}, // side left
95 {1, 270, 0.5, 0.5, 1}, // side right
107 {0, 0, 0, 1, 1}, // center
120 // =======================================================================
121 // Internal sound data & structures
122 // =======================================================================
124 channel_t channels[MAX_CHANNELS];
125 unsigned int total_channels;
127 snd_ringbuffer_t *snd_renderbuffer = NULL;
128 static unsigned int soundtime = 0;
129 static unsigned int oldpaintedtime = 0;
130 static unsigned int extrasoundtime = 0;
131 static double snd_starttime = 0.0;
132 qboolean snd_threaded = false;
133 qboolean snd_usethreadedmixing = false;
135 vec3_t listener_origin;
136 matrix4x4_t listener_matrix[SND_LISTENERS];
137 mempool_t *snd_mempool;
139 // Linked list of known sfx
140 static sfx_t *known_sfx = NULL;
142 static qboolean sound_spatialized = false;
144 qboolean simsound = false;
146 static qboolean recording_sound = false;
149 static int current_swapstereo = false;
150 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
151 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
153 static float spatialpower, spatialmin, spatialdiff, spatialoffset, spatialfactor;
154 typedef enum { SPATIAL_NONE, SPATIAL_LOG, SPATIAL_POW, SPATIAL_THRESH } spatialmethod_t;
155 spatialmethod_t spatialmethod;
157 // Cvars declared in sound.h (part of the sound API)
158 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
159 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
160 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
161 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
162 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)"};
163 cvar_t snd_spatialization_min_radius = {CVAR_SAVE, "snd_spatialization_min_radius", "10000", "use minimum spatialization above to this radius"};
164 cvar_t snd_spatialization_max_radius = {CVAR_SAVE, "snd_spatialization_max_radius", "100", "use maximum spatialization below this radius"};
165 cvar_t snd_spatialization_min = {CVAR_SAVE, "snd_spatialization_min", "0.70", "minimum spatializazion of sounds"};
166 cvar_t snd_spatialization_max = {CVAR_SAVE, "snd_spatialization_max", "0.95", "maximum spatialization of sounds"};
167 cvar_t snd_spatialization_power = {CVAR_SAVE, "snd_spatialization_power", "0", "exponent of the spatialization falloff curve (0: logarithmic)"};
168 cvar_t snd_spatialization_control = {CVAR_SAVE, "snd_spatialization_control", "0", "enable spatialization control (headphone friendly mode)"};
169 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"};
171 // Cvars declared in snd_main.h (shared with other snd_*.c files)
172 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.11", "how much sound to mix ahead of time"};
173 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
174 extern cvar_t v_flipped;
175 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
176 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
177 cvar_t snd_entchannel0volume = {CVAR_SAVE, "snd_entchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of regular entities"};
178 cvar_t snd_entchannel1volume = {CVAR_SAVE, "snd_entchannel1volume", "1", "volume multiplier of the 1st entity channel of regular entities"};
179 cvar_t snd_entchannel2volume = {CVAR_SAVE, "snd_entchannel2volume", "1", "volume multiplier of the 2nd entity channel of regular entities"};
180 cvar_t snd_entchannel3volume = {CVAR_SAVE, "snd_entchannel3volume", "1", "volume multiplier of the 3rd entity channel of regular entities"};
181 cvar_t snd_entchannel4volume = {CVAR_SAVE, "snd_entchannel4volume", "1", "volume multiplier of the 4th entity channel of regular entities"};
182 cvar_t snd_entchannel5volume = {CVAR_SAVE, "snd_entchannel5volume", "1", "volume multiplier of the 5th entity channel of regular entities"};
183 cvar_t snd_entchannel6volume = {CVAR_SAVE, "snd_entchannel6volume", "1", "volume multiplier of the 6th entity channel of regular entities"};
184 cvar_t snd_entchannel7volume = {CVAR_SAVE, "snd_entchannel7volume", "1", "volume multiplier of the 7th entity channel of regular entities"};
185 cvar_t snd_playerchannel0volume = {CVAR_SAVE, "snd_playerchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of player entities"};
186 cvar_t snd_playerchannel1volume = {CVAR_SAVE, "snd_playerchannel1volume", "1", "volume multiplier of the 1st entity channel of player entities"};
187 cvar_t snd_playerchannel2volume = {CVAR_SAVE, "snd_playerchannel2volume", "1", "volume multiplier of the 2nd entity channel of player entities"};
188 cvar_t snd_playerchannel3volume = {CVAR_SAVE, "snd_playerchannel3volume", "1", "volume multiplier of the 3rd entity channel of player entities"};
189 cvar_t snd_playerchannel4volume = {CVAR_SAVE, "snd_playerchannel4volume", "1", "volume multiplier of the 4th entity channel of player entities"};
190 cvar_t snd_playerchannel5volume = {CVAR_SAVE, "snd_playerchannel5volume", "1", "volume multiplier of the 5th entity channel of player entities"};
191 cvar_t snd_playerchannel6volume = {CVAR_SAVE, "snd_playerchannel6volume", "1", "volume multiplier of the 6th entity channel of player entities"};
192 cvar_t snd_playerchannel7volume = {CVAR_SAVE, "snd_playerchannel7volume", "1", "volume multiplier of the 7th entity channel of player entities"};
193 cvar_t snd_worldchannel0volume = {CVAR_SAVE, "snd_worldchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
194 cvar_t snd_worldchannel1volume = {CVAR_SAVE, "snd_worldchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
195 cvar_t snd_worldchannel2volume = {CVAR_SAVE, "snd_worldchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
196 cvar_t snd_worldchannel3volume = {CVAR_SAVE, "snd_worldchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
197 cvar_t snd_worldchannel4volume = {CVAR_SAVE, "snd_worldchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
198 cvar_t snd_worldchannel5volume = {CVAR_SAVE, "snd_worldchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
199 cvar_t snd_worldchannel6volume = {CVAR_SAVE, "snd_worldchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
200 cvar_t snd_worldchannel7volume = {CVAR_SAVE, "snd_worldchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
201 cvar_t snd_csqcchannel0volume = {CVAR_SAVE, "snd_csqcchannel0volume", "1", "volume multiplier of the auto-allocate entity channel of the world entity"};
202 cvar_t snd_csqcchannel1volume = {CVAR_SAVE, "snd_csqcchannel1volume", "1", "volume multiplier of the 1st entity channel of the world entity"};
203 cvar_t snd_csqcchannel2volume = {CVAR_SAVE, "snd_csqcchannel2volume", "1", "volume multiplier of the 2nd entity channel of the world entity"};
204 cvar_t snd_csqcchannel3volume = {CVAR_SAVE, "snd_csqcchannel3volume", "1", "volume multiplier of the 3rd entity channel of the world entity"};
205 cvar_t snd_csqcchannel4volume = {CVAR_SAVE, "snd_csqcchannel4volume", "1", "volume multiplier of the 4th entity channel of the world entity"};
206 cvar_t snd_csqcchannel5volume = {CVAR_SAVE, "snd_csqcchannel5volume", "1", "volume multiplier of the 5th entity channel of the world entity"};
207 cvar_t snd_csqcchannel6volume = {CVAR_SAVE, "snd_csqcchannel6volume", "1", "volume multiplier of the 6th entity channel of the world entity"};
208 cvar_t snd_csqcchannel7volume = {CVAR_SAVE, "snd_csqcchannel7volume", "1", "volume multiplier of the 7th entity channel of the world entity"};
211 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
212 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
213 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
214 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
215 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"};
216 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
218 // Default sound format is 48KHz, 16-bit, stereo
219 // (48KHz because a lot of onboard sound cards sucks at any other speed)
220 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
221 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
222 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)"};
225 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
226 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
229 // ====================================================================
231 // ====================================================================
233 void S_FreeSfx (sfx_t *sfx, qboolean force);
235 static void S_Play_Common (float fvol, float attenuation)
238 char name [MAX_QPATH];
242 while (i < Cmd_Argc ())
244 // Get the name, and appends ".wav" as an extension if there's none
245 strlcpy (name, Cmd_Argv (i), sizeof (name));
246 if (!strrchr (name, '.'))
247 strlcat (name, ".wav", sizeof (name));
250 // If we need to get the volume from the command line
253 fvol = atof (Cmd_Argv (i));
257 sfx = S_PrecacheSound (name, true, true);
260 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
262 // Free the sfx if the file didn't exist
264 S_FreeSfx (sfx, false);
266 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
271 static void S_Play_f(void)
273 S_Play_Common (1.0f, 1.0f);
276 static void S_Play2_f(void)
278 S_Play_Common (1.0f, 0.0f);
281 static void S_PlayVol_f(void)
283 S_Play_Common (-1.0f, 0.0f);
286 static void S_SoundList_f (void)
293 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
295 if (sfx->fetcher != NULL)
298 const snd_format_t* format;
301 format = sfx->fetcher->getfmt(sfx);
302 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
303 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
304 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
305 (sfx->locks > 0) ? 'K' : ' ',
306 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
308 (format->channels == 1) ? "mono" : "stereo",
314 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
316 Con_Printf("Total resident: %i\n", total);
320 void S_SoundInfo_f(void)
322 if (snd_renderbuffer == NULL)
324 Con_Print("sound system not started\n");
328 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
329 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
330 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
331 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
332 Con_Printf("%5u total_channels\n", total_channels);
336 int S_GetSoundRate(void)
338 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
341 int S_GetSoundChannels(void)
343 return snd_renderbuffer ? snd_renderbuffer->format.channels : 0;
347 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
349 static const snd_format_t thresholds [] =
351 // speed width channels
352 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
358 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
360 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
361 unsigned int speed_level, width_level, channels_level;
363 // If we have reached the minimum values, there's nothing more we can do
364 if ((format->speed == thresholds[0].speed || fixed_speed) &&
365 (format->width == thresholds[0].width || fixed_width) &&
366 (format->channels == thresholds[0].channels || fixed_channels))
369 // Check the min and max values
370 #define CHECK_BOUNDARIES(param) \
371 if (format->param < thresholds[0].param) \
373 format->param = thresholds[0].param; \
376 if (format->param > thresholds[nb_thresholds - 1].param) \
378 format->param = thresholds[nb_thresholds - 1].param; \
381 CHECK_BOUNDARIES(speed);
382 CHECK_BOUNDARIES(width);
383 CHECK_BOUNDARIES(channels);
384 #undef CHECK_BOUNDARIES
386 // Find the level of each parameter
387 #define FIND_LEVEL(param) \
389 while (param##_level < nb_thresholds - 1) \
391 if (format->param <= thresholds[param##_level].param) \
398 FIND_LEVEL(channels);
401 // Decrease the parameter with the highest level to the previous level
402 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
404 format->channels = thresholds[channels_level - 1].channels;
407 if (speed_level >= width_level && !fixed_speed)
409 format->speed = thresholds[speed_level - 1].speed;
413 format->width = thresholds[width_level - 1].width;
418 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
420 static void S_SetChannelLayout (void)
423 listener_t swaplistener;
424 listener_t *listeners;
427 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
428 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
430 if (i >= SND_SPEAKERLAYOUTS)
432 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
433 snd_renderbuffer->format.channels);
434 i = SND_SPEAKERLAYOUTS - 1;
437 snd_speakerlayout = snd_speakerlayouts[i];
438 listeners = snd_speakerlayout.listeners;
440 // Swap the left and right channels if snd_swapstereo is set
441 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
443 switch (snd_speakerlayout.channels)
446 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
450 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
453 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
464 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
465 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
466 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
468 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
470 // If we're in the sound engine initialization
471 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
473 layout = SND_CHANNELLAYOUT_STANDARD;
474 Cvar_SetValueQuick (&snd_channellayout, layout);
477 layout = current_channellayout_used;
480 layout = snd_channellayout.integer;
482 // Convert our layout (= ALSA) to the standard layout if necessary
483 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
485 if (layout == SND_CHANNELLAYOUT_STANDARD)
487 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
488 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
491 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
492 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
495 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
496 current_channellayout = snd_channellayout.integer;
497 current_channellayout_used = layout;
501 void S_Startup (void)
503 qboolean fixed_speed, fixed_width, fixed_channels;
504 snd_format_t chosen_fmt;
505 static snd_format_t prev_render_format = {0, 0, 0};
512 if (!snd_initialized.integer)
517 fixed_channels = false;
519 // Get the starting sound format from the cvars
520 chosen_fmt.speed = snd_speed.integer;
521 chosen_fmt.width = snd_width.integer;
522 chosen_fmt.channels = snd_channels.integer;
524 // Check the environment variables to see if the player wants a particular sound format
526 _dupenv_s(&env, &envlen, "QUAKE_SOUND_CHANNELS");
528 env = getenv("QUAKE_SOUND_CHANNELS");
532 chosen_fmt.channels = atoi (env);
536 fixed_channels = true;
539 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SPEED");
541 env = getenv("QUAKE_SOUND_SPEED");
545 chosen_fmt.speed = atoi (env);
552 _dupenv_s(&env, &envlen, "QUAKE_SOUND_SAMPLEBITS");
554 env = getenv("QUAKE_SOUND_SAMPLEBITS");
558 chosen_fmt.width = atoi (env) / 8;
565 // Parse the command line to see if the player wants a particular sound format
566 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
567 if (COM_CheckParm ("-sndquad") != 0)
569 chosen_fmt.channels = 4;
570 fixed_channels = true;
572 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
573 else if (COM_CheckParm ("-sndstereo") != 0)
575 chosen_fmt.channels = 2;
576 fixed_channels = true;
578 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
579 else if (COM_CheckParm ("-sndmono") != 0)
581 chosen_fmt.channels = 1;
582 fixed_channels = true;
584 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
585 i = COM_CheckParm ("-sndspeed");
586 if (0 < i && i < com_argc - 1)
588 chosen_fmt.speed = atoi (com_argv[i + 1]);
591 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
592 i = COM_CheckParm ("-sndbits");
593 if (0 < i && i < com_argc - 1)
595 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
599 // You can't change sound speed after start time (not yet supported)
600 if (prev_render_format.speed != 0)
603 if (chosen_fmt.speed != prev_render_format.speed)
605 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
606 prev_render_format.speed);
607 chosen_fmt.speed = prev_render_format.speed;
612 if (chosen_fmt.speed < SND_MIN_SPEED)
614 chosen_fmt.speed = SND_MIN_SPEED;
617 else if (chosen_fmt.speed > SND_MAX_SPEED)
619 chosen_fmt.speed = SND_MAX_SPEED;
623 if (chosen_fmt.width < SND_MIN_WIDTH)
625 chosen_fmt.width = SND_MIN_WIDTH;
628 else if (chosen_fmt.width > SND_MAX_WIDTH)
630 chosen_fmt.width = SND_MAX_WIDTH;
634 if (chosen_fmt.channels < SND_MIN_CHANNELS)
636 chosen_fmt.channels = SND_MIN_CHANNELS;
637 fixed_channels = false;
639 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
641 chosen_fmt.channels = SND_MAX_CHANNELS;
642 fixed_channels = false;
645 // create the sound buffer used for sumitting the samples to the plaform-dependent module
648 snd_format_t suggest_fmt;
654 Con_Printf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
655 chosen_fmt.speed, chosen_fmt.width * 8,
656 chosen_fmt.channels);
658 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
659 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
663 Con_Printf("S_Startup: sound output initialization FAILED\n");
665 // If the module is suggesting another one
666 if (suggest_fmt.speed != 0)
668 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
669 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
670 suggest_fmt.speed, suggest_fmt.width * 8,
671 suggest_fmt.channels);
673 // Else, try to find a less resource-demanding format
674 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
679 // If we haven't found a suitable format
682 Con_Print("S_Startup: SndSys_Init failed.\n");
683 sound_spatialized = false;
689 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
690 Con_Print ("S_Startup: simulating sound output\n");
693 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
694 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
695 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
698 if (snd_speed.integer != (int)chosen_fmt.speed)
699 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
700 if (snd_width.integer != chosen_fmt.width)
701 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
702 if (snd_channels.integer != chosen_fmt.channels)
703 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
705 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
706 S_SetChannelLayout();
708 snd_starttime = realtime;
710 // If the sound module has already run, add an extra time to make sure
711 // the sound time doesn't decrease, to not confuse playing SFXs
712 if (oldpaintedtime != 0)
714 // The extra time must be a multiple of the render buffer size
715 // to avoid modifying the current position in the buffer,
716 // some modules write directly to a shared (DMA) buffer
717 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
718 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
719 Con_Printf("S_Startup: extra sound time = %u\n", extrasoundtime);
721 soundtime = extrasoundtime;
725 snd_renderbuffer->startframe = soundtime;
726 snd_renderbuffer->endframe = soundtime;
727 recording_sound = false;
730 void S_Shutdown(void)
732 if (snd_renderbuffer == NULL)
735 oldpaintedtime = snd_renderbuffer->endframe;
739 Mem_Free(snd_renderbuffer->ring);
740 Mem_Free(snd_renderbuffer);
741 snd_renderbuffer = NULL;
746 sound_spatialized = false;
749 void S_Restart_f(void)
751 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
752 // So, refuse to do this if we are connected.
753 if(cls.state == ca_connected)
755 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
770 Cvar_RegisterVariable(&volume);
771 Cvar_RegisterVariable(&bgmvolume);
772 Cvar_RegisterVariable(&snd_staticvolume);
773 Cvar_RegisterVariable(&snd_entchannel0volume);
774 Cvar_RegisterVariable(&snd_entchannel1volume);
775 Cvar_RegisterVariable(&snd_entchannel2volume);
776 Cvar_RegisterVariable(&snd_entchannel3volume);
777 Cvar_RegisterVariable(&snd_entchannel4volume);
778 Cvar_RegisterVariable(&snd_entchannel5volume);
779 Cvar_RegisterVariable(&snd_entchannel6volume);
780 Cvar_RegisterVariable(&snd_entchannel7volume);
781 Cvar_RegisterVariable(&snd_worldchannel0volume);
782 Cvar_RegisterVariable(&snd_worldchannel1volume);
783 Cvar_RegisterVariable(&snd_worldchannel2volume);
784 Cvar_RegisterVariable(&snd_worldchannel3volume);
785 Cvar_RegisterVariable(&snd_worldchannel4volume);
786 Cvar_RegisterVariable(&snd_worldchannel5volume);
787 Cvar_RegisterVariable(&snd_worldchannel6volume);
788 Cvar_RegisterVariable(&snd_worldchannel7volume);
789 Cvar_RegisterVariable(&snd_playerchannel0volume);
790 Cvar_RegisterVariable(&snd_playerchannel1volume);
791 Cvar_RegisterVariable(&snd_playerchannel2volume);
792 Cvar_RegisterVariable(&snd_playerchannel3volume);
793 Cvar_RegisterVariable(&snd_playerchannel4volume);
794 Cvar_RegisterVariable(&snd_playerchannel5volume);
795 Cvar_RegisterVariable(&snd_playerchannel6volume);
796 Cvar_RegisterVariable(&snd_playerchannel7volume);
797 Cvar_RegisterVariable(&snd_csqcchannel0volume);
798 Cvar_RegisterVariable(&snd_csqcchannel1volume);
799 Cvar_RegisterVariable(&snd_csqcchannel2volume);
800 Cvar_RegisterVariable(&snd_csqcchannel3volume);
801 Cvar_RegisterVariable(&snd_csqcchannel4volume);
802 Cvar_RegisterVariable(&snd_csqcchannel5volume);
803 Cvar_RegisterVariable(&snd_csqcchannel6volume);
804 Cvar_RegisterVariable(&snd_csqcchannel7volume);
806 Cvar_RegisterVariable(&snd_spatialization_min_radius);
807 Cvar_RegisterVariable(&snd_spatialization_max_radius);
808 Cvar_RegisterVariable(&snd_spatialization_min);
809 Cvar_RegisterVariable(&snd_spatialization_max);
810 Cvar_RegisterVariable(&snd_spatialization_power);
811 Cvar_RegisterVariable(&snd_spatialization_control);
812 Cvar_RegisterVariable(&snd_spatialization_occlusion);
814 Cvar_RegisterVariable(&snd_speed);
815 Cvar_RegisterVariable(&snd_width);
816 Cvar_RegisterVariable(&snd_channels);
817 Cvar_RegisterVariable(&snd_mutewhenidle);
819 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
820 if (COM_CheckParm("-nosound"))
822 // dummy out Play and Play2 because mods stuffcmd that
823 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
824 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
828 snd_mempool = Mem_AllocPool("sound", 0, NULL);
830 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
831 if (COM_CheckParm("-simsound"))
834 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
835 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
836 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
837 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
838 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
839 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
840 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
841 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
843 Cvar_RegisterVariable(&nosound);
844 Cvar_RegisterVariable(&snd_precache);
845 Cvar_RegisterVariable(&snd_initialized);
846 Cvar_RegisterVariable(&ambient_level);
847 Cvar_RegisterVariable(&ambient_fade);
848 Cvar_RegisterVariable(&snd_noextraupdate);
849 Cvar_RegisterVariable(&snd_show);
850 Cvar_RegisterVariable(&_snd_mixahead);
851 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
852 Cvar_RegisterVariable(&snd_channellayout);
853 Cvar_RegisterVariable(&snd_soundradius);
855 Cvar_SetValueQuick(&snd_initialized, true);
859 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
860 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
863 ModPlug_OpenLibrary ();
871 Shutdown and free all resources
874 void S_Terminate (void)
877 ModPlug_CloseLibrary ();
881 while (known_sfx != NULL)
882 S_FreeSfx (known_sfx, true);
884 Cvar_SetValueQuick (&snd_initialized, false);
885 Mem_FreePool (&snd_mempool);
894 void S_UnloadAllSounds_f (void)
898 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
899 // So, refuse to do this if we are connected.
900 if(cls.state == ca_connected)
902 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
906 // stop any active sounds
909 // because the ambient sounds will be freed, clear the pointers
910 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
911 ambient_sfxs[i] = NULL;
913 // now free all sounds
914 while (known_sfx != NULL)
915 S_FreeSfx (known_sfx, true);
924 sfx_t changevolume_sfx = {""};
925 sfx_t *S_FindName (const char *name)
929 if (!snd_initialized.integer)
932 if(!strcmp(name, changevolume_sfx.name))
933 return &changevolume_sfx;
935 if (strlen (name) >= sizeof (sfx->name))
937 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
941 // Look for this sound in the list of known sfx
942 // TODO: hash table search?
943 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
944 if(!strcmp (sfx->name, name))
947 // Add a sfx_t struct for this sound
948 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
949 memset (sfx, 0, sizeof(*sfx));
950 strlcpy (sfx->name, name, sizeof (sfx->name));
951 sfx->memsize = sizeof(*sfx);
952 sfx->next = known_sfx;
964 void S_FreeSfx (sfx_t *sfx, qboolean force)
968 // Never free a locked sfx unless forced
969 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
972 if (developer_loading.integer)
973 Con_Printf ("unloading sound %s\n", sfx->name);
975 // Remove it from the list of known sfx
976 if (sfx == known_sfx)
977 known_sfx = known_sfx->next;
982 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
983 if (prev_sfx->next == sfx)
985 prev_sfx->next = sfx->next;
988 if (prev_sfx == NULL)
990 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
995 // Stop all channels using this sfx
996 for (i = 0; i < total_channels; i++)
997 if (channels[i].sfx == sfx)
998 S_StopChannel (i, true);
1001 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
1002 sfx->fetcher->free (sfx->fetcher_data);
1012 void S_ClearUsed (void)
1018 // Start the ambient sounds and make them loop
1019 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
1021 // Precache it if it's not done (request a lock to make sure it will never be freed)
1022 if (ambient_sfxs[i] == NULL)
1023 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
1024 if (ambient_sfxs[i] != NULL)
1026 // Add a lock to the SFX while playing. It will be
1027 // removed by S_StopAllSounds at the end of the level
1028 S_LockSfx (ambient_sfxs[i]);
1030 channels[i].sfx = ambient_sfxs[i];
1031 channels[i].flags |= CHANNELFLAG_FORCELOOP;
1032 channels[i].master_vol = 0;
1036 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
1037 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
1038 if (sfx->flags & SFXFLAG_SERVERSOUND)
1041 sfx->flags &= ~SFXFLAG_SERVERSOUND;
1050 void S_PurgeUnused(void)
1055 // Free all unlocked sfx
1056 for (sfx = known_sfx;sfx;sfx = sfxnext)
1058 sfxnext = sfx->next;
1059 S_FreeSfx (sfx, false);
1069 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean serversound)
1073 if (!snd_initialized.integer)
1076 if (name == NULL || name[0] == 0)
1079 sfx = S_FindName (name);
1084 // clear the FILEMISSING flag so that S_LoadSound will try again on a
1085 // previously missing file
1086 sfx->flags &= ~ SFXFLAG_FILEMISSING;
1088 if (serversound && !(sfx->flags & SFXFLAG_SERVERSOUND))
1091 sfx->flags |= SFXFLAG_SERVERSOUND;
1094 if (!nosound.integer && snd_precache.integer)
1095 S_LoadSound(sfx, complain);
1105 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1107 return (sfx != NULL && sfx->fetcher != NULL) || (sfx == &changevolume_sfx);
1117 void S_LockSfx (sfx_t *sfx)
1126 Remove a lock from a SFX
1129 void S_UnlockSfx (sfx_t *sfx)
1140 void S_BlockSound (void)
1151 void S_UnblockSound (void)
1161 Picks a channel based on priorities, empty slots, number of channels
1164 channel_t *SND_PickChannel(int entnum, int entchannel)
1168 int first_life_left, life_left;
1171 // Check for replacement sound, or find the best one to replace
1173 first_life_left = 0x7fffffff;
1175 // entity channels try to replace the existing sound on the channel
1176 if (entchannel != 0)
1178 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1180 ch = &channels[ch_idx];
1181 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1183 // always override sound from same entity
1184 S_StopChannel (ch_idx, true);
1185 return &channels[ch_idx];
1190 // there was no channel to override, so look for the first empty one
1191 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1193 ch = &channels[ch_idx];
1196 // no sound on this channel
1197 first_to_die = ch_idx;
1198 goto emptychan_found;
1201 // don't let monster sounds override player sounds
1202 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1205 // don't override looped sounds
1206 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1208 life_left = ch->sfx->total_length - ch->pos;
1210 if (life_left < first_life_left)
1212 first_life_left = life_left;
1213 first_to_die = ch_idx;
1217 if (first_to_die == -1)
1220 S_StopChannel (first_to_die, true);
1223 return &channels[first_to_die];
1230 Spatializes a channel
1233 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1234 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1238 vec_t dist, mastervol, intensity, vol;
1241 // update sound origin if we know about the entity
1242 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1244 if (ch->entnum >= MAX_EDICTS)
1246 //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]);
1248 if (ch->entnum > MAX_EDICTS)
1249 if (!CL_VM_GetEntitySoundOrigin(ch->entnum, ch->origin))
1250 ch->entnum = MAX_EDICTS; // entity was removed, disown sound
1252 else if (cl.entities[ch->entnum].state_current.active)
1254 //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]);
1255 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)
1256 VectorMAM(0.5f, cl.entities[ch->entnum].render.mins, 0.5f, cl.entities[ch->entnum].render.maxs, ch->origin);
1258 Matrix4x4_OriginFromMatrix(&cl.entities[ch->entnum].render.matrix, ch->origin);
1262 mastervol = ch->master_vol;
1264 // Adjust volume of static sounds
1266 mastervol *= snd_staticvolume.value;
1267 else if(!(ch->flags & CHANNELFLAG_FULLVOLUME)) // same as SND_PaintChannel uses
1269 if(ch->entnum >= MAX_EDICTS)
1271 switch(ch->entchannel)
1273 case 0: mastervol *= snd_csqcchannel0volume.value; break;
1274 case 1: mastervol *= snd_csqcchannel1volume.value; break;
1275 case 2: mastervol *= snd_csqcchannel2volume.value; break;
1276 case 3: mastervol *= snd_csqcchannel3volume.value; break;
1277 case 4: mastervol *= snd_csqcchannel4volume.value; break;
1278 case 5: mastervol *= snd_csqcchannel5volume.value; break;
1279 case 6: mastervol *= snd_csqcchannel6volume.value; break;
1280 case 7: mastervol *= snd_csqcchannel7volume.value; break;
1284 else if(ch->entnum == 0)
1286 switch(ch->entchannel)
1288 case 0: mastervol *= snd_worldchannel0volume.value; break;
1289 case 1: mastervol *= snd_worldchannel1volume.value; break;
1290 case 2: mastervol *= snd_worldchannel2volume.value; break;
1291 case 3: mastervol *= snd_worldchannel3volume.value; break;
1292 case 4: mastervol *= snd_worldchannel4volume.value; break;
1293 case 5: mastervol *= snd_worldchannel5volume.value; break;
1294 case 6: mastervol *= snd_worldchannel6volume.value; break;
1295 case 7: mastervol *= snd_worldchannel7volume.value; break;
1299 else if(ch->entnum > 0 && ch->entnum <= cl.maxclients)
1301 switch(ch->entchannel)
1303 case 0: mastervol *= snd_playerchannel0volume.value; break;
1304 case 1: mastervol *= snd_playerchannel1volume.value; break;
1305 case 2: mastervol *= snd_playerchannel2volume.value; break;
1306 case 3: mastervol *= snd_playerchannel3volume.value; break;
1307 case 4: mastervol *= snd_playerchannel4volume.value; break;
1308 case 5: mastervol *= snd_playerchannel5volume.value; break;
1309 case 6: mastervol *= snd_playerchannel6volume.value; break;
1310 case 7: mastervol *= snd_playerchannel7volume.value; break;
1316 switch(ch->entchannel)
1318 case 0: mastervol *= snd_entchannel0volume.value; break;
1319 case 1: mastervol *= snd_entchannel1volume.value; break;
1320 case 2: mastervol *= snd_entchannel2volume.value; break;
1321 case 3: mastervol *= snd_entchannel3volume.value; break;
1322 case 4: mastervol *= snd_entchannel4volume.value; break;
1323 case 5: mastervol *= snd_entchannel5volume.value; break;
1324 case 6: mastervol *= snd_entchannel6volume.value; break;
1325 case 7: mastervol *= snd_entchannel7volume.value; break;
1331 // anything coming from the view entity will always be full volume
1332 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1333 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1335 for (i = 0;i < SND_LISTENERS;i++)
1337 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1338 ch->listener_volume[i] = (int)bound(0, vol, 255);
1343 // calculate stereo seperation and distance attenuation
1344 VectorSubtract(listener_origin, ch->origin, source_vec);
1345 dist = VectorLength(source_vec);
1346 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1349 for (i = 0;i < SND_LISTENERS;i++)
1351 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1352 VectorNormalize(source_vec);
1354 switch(spatialmethod)
1358 f = spatialmin + spatialdiff * (spatialfactor < 0); // avoid log(0), but do the right thing
1360 f = spatialmin + spatialdiff * bound(0, (log(dist) - spatialoffset) * spatialfactor, 1);
1361 VectorScale(source_vec, f, source_vec);
1364 f = (pow(dist, spatialpower) - spatialoffset) * spatialfactor;
1365 f = spatialmin + spatialdiff * bound(0, f, 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);
1379 if (snd_spatialization_occlusion.integer)
1382 && cl.worldmodel->brush.TraceLineOfSight
1383 && !cl.worldmodel->brush.TraceLineOfSight(cl.worldmodel, listener_origin, ch->origin))
1389 ch->listener_volume[i] = (int)bound(0, vol, 255);
1393 for (i = 0;i < SND_LISTENERS;i++)
1394 ch->listener_volume[i] = 0;
1399 // =======================================================================
1400 // Start a sound effect
1401 // =======================================================================
1403 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1407 Con_Printf("S_PlaySfxOnChannel called with NULL??\n");
1410 // Initialize the channel
1411 // a crash was reported on an in-use channel, so check here...
1412 if (target_chan->sfx)
1414 int channelindex = (int)(target_chan - channels);
1415 Con_Printf("S_PlaySfxOnChannel(%s): channel %i already in use?? Clearing.\n", sfx->name, channelindex);
1416 S_StopChannel (channelindex, true);
1418 // We MUST set sfx LAST because otherwise we could crash a threaded mixer
1419 // (otherwise we'd have to call SndSys_LockRenderBuffer here)
1420 memset (target_chan, 0, sizeof (*target_chan));
1421 VectorCopy (origin, target_chan->origin);
1422 target_chan->flags = flags;
1423 target_chan->pos = 0; // start of the sound
1425 // If it's a static sound
1428 if (sfx->loopstart >= sfx->total_length)
1429 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1430 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1433 target_chan->dist_mult = attenuation / snd_soundradius.value;
1435 // Lock the SFX during play
1438 // finally, set the sfx pointer, so the channel becomes valid for playback
1439 // and will be noticed by the mixer
1440 target_chan->sfx = sfx;
1442 // we have to set the channel volume AFTER the sfx because the function
1443 // needs it for replaygain support
1444 S_SetChannelVolume(target_chan - channels, fvol);
1448 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1450 channel_t *target_chan, *check, *ch;
1453 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1456 if(sfx == &changevolume_sfx)
1460 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1462 ch = &channels[ch_idx];
1463 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1465 S_SetChannelVolume(ch_idx, fvol);
1466 ch->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1473 if (sfx->fetcher == NULL)
1476 // Pick a channel to play on
1477 target_chan = SND_PickChannel(entnum, entchannel);
1481 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1482 target_chan->entnum = entnum;
1483 target_chan->entchannel = entchannel;
1485 SND_Spatialize(target_chan, false);
1487 // if an identical sound has also been started this frame, offset the pos
1488 // a bit to keep it from just making the first one louder
1489 check = &channels[NUM_AMBIENTS];
1490 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1492 if (check == target_chan)
1494 if (check->sfx == sfx && !check->pos)
1496 // use negative pos offset to delay this sound effect
1497 target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1502 return (target_chan - channels);
1505 void S_StopChannel (unsigned int channel_ind, qboolean lockmutex)
1509 if (channel_ind >= total_channels)
1512 // we have to lock an audio mutex to prevent crashes if an audio mixer
1513 // thread is currently mixing this channel
1514 // the SndSys_LockRenderBuffer function uses such a mutex in
1515 // threaded sound backends
1516 if (lockmutex && !simsound)
1517 SndSys_LockRenderBuffer();
1519 ch = &channels[channel_ind];
1520 if (ch->sfx != NULL)
1522 sfx_t *sfx = ch->sfx;
1524 if (sfx->fetcher != NULL)
1526 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1527 if (fetcher_endsb != NULL)
1528 fetcher_endsb (ch->fetcher_data);
1531 // Remove the lock it holds
1534 ch->fetcher_data = NULL;
1537 if (lockmutex && !simsound)
1538 SndSys_UnlockRenderBuffer();
1542 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1544 if (ch_ind >= total_channels)
1547 if (flag != CHANNELFLAG_FORCELOOP &&
1548 flag != CHANNELFLAG_PAUSED &&
1549 flag != CHANNELFLAG_FULLVOLUME &&
1550 flag != CHANNELFLAG_LOCALSOUND)
1554 channels[ch_ind].flags |= flag;
1556 channels[ch_ind].flags &= ~flag;
1561 void S_StopSound(int entnum, int entchannel)
1565 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1566 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1568 S_StopChannel (i, true);
1573 extern void CDAudio_Stop(void);
1574 void S_StopAllSounds (void)
1578 // TOCHECK: is this test necessary?
1579 if (snd_renderbuffer == NULL)
1582 // stop CD audio because it may be using a faketrack
1585 if (simsound || SndSys_LockRenderBuffer ())
1590 for (i = 0; i < total_channels; i++)
1591 S_StopChannel (i, false);
1593 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1594 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1596 // Mute the contents of the submittion buffer
1597 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1598 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1599 memset(snd_renderbuffer->ring, clear, memsize);
1602 SndSys_UnlockRenderBuffer ();
1606 void S_PauseGameSounds (qboolean toggle)
1610 for (i = 0; i < total_channels; i++)
1615 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1616 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1620 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1622 sfx_t *sfx = channels[ch_ind].sfx;
1623 if(sfx->volume_peak > 0)
1625 // Replaygain support
1626 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1627 fvol *= sfx->volume_mult;
1628 if(fvol * sfx->volume_peak > 1)
1629 fvol = 1 / sfx->volume_peak;
1630 // Con_DPrintf("%f\n", fvol);
1632 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1635 float S_GetChannelPosition (unsigned int ch_ind)
1637 // note: this is NOT accurate yet
1639 channel_t *ch = &channels[ch_ind];
1640 sfx_t *sfx = ch->sfx;
1644 if(!snd_usethreadedmixing)
1645 s += _snd_mixahead.value * S_GetSoundRate();
1647 return (s % sfx->total_length) / (float) S_GetSoundRate();
1657 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1659 channel_t *target_chan;
1661 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1665 Con_Printf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1669 if (total_channels == MAX_CHANNELS)
1671 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1675 target_chan = &channels[total_channels++];
1676 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1678 SND_Spatialize (target_chan, true);
1684 S_UpdateAmbientSounds
1687 void S_UpdateAmbientSounds (void)
1691 int ambient_channel;
1693 unsigned char ambientlevels[NUM_AMBIENTS];
1695 memset(ambientlevels, 0, sizeof(ambientlevels));
1696 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1697 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1699 // Calc ambient sound levels
1700 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1702 chan = &channels[ambient_channel];
1703 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1706 vol = (int)ambientlevels[ambient_channel];
1710 // Don't adjust volume too fast
1711 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1712 if (cl.time > cl.oldtime)
1714 if (chan->master_vol < vol)
1716 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1717 if (chan->master_vol > vol)
1718 chan->master_vol = vol;
1720 else if (chan->master_vol > vol)
1722 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1723 if (chan->master_vol < vol)
1724 chan->master_vol = vol;
1728 for (i = 0;i < SND_LISTENERS;i++)
1729 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1733 static void S_PaintAndSubmit (void)
1735 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1736 int usesoundtimehack;
1737 static int soundtimehack = -1;
1738 static int oldsoundtime = 0;
1740 if (snd_renderbuffer == NULL || nosound.integer)
1743 // Update sound time
1744 snd_usethreadedmixing = false;
1745 usesoundtimehack = true;
1746 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1748 usesoundtimehack = 1;
1749 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1751 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1753 usesoundtimehack = 2;
1754 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1758 usesoundtimehack = 3;
1759 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1763 snd_usethreadedmixing = snd_threaded && !cls.capturevideo.soundrate;
1764 usesoundtimehack = 0;
1765 newsoundtime = SndSys_GetSoundTime();
1767 // if the soundtimehack state changes we need to reset the soundtime
1768 if (soundtimehack != usesoundtimehack)
1770 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1772 // Mute the contents of the submission buffer
1773 if (simsound || SndSys_LockRenderBuffer ())
1778 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1779 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1780 memset(snd_renderbuffer->ring, clear, memsize);
1783 SndSys_UnlockRenderBuffer ();
1786 soundtimehack = usesoundtimehack;
1788 if (!soundtimehack && snd_blocked > 0)
1791 if (snd_usethreadedmixing)
1792 return; // the audio thread will mix its own data
1794 newsoundtime += extrasoundtime;
1795 if (newsoundtime < soundtime)
1797 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1799 unsigned int additionaltime;
1801 // add some time to extrasoundtime make newsoundtime higher
1803 // The extra time must be a multiple of the render buffer size
1804 // to avoid modifying the current position in the buffer,
1805 // some modules write directly to a shared (DMA) buffer
1806 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1807 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1809 extrasoundtime += additionaltime;
1810 newsoundtime += additionaltime;
1811 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1814 else if (!soundtimehack)
1815 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1816 newsoundtime, soundtime);
1818 soundtime = newsoundtime;
1819 recording_sound = (cls.capturevideo.soundrate != 0);
1821 // Lock submitbuffer
1822 if (!simsound && !SndSys_LockRenderBuffer())
1824 // If the lock failed, stop here
1825 Con_DPrint(">> S_PaintAndSubmit: SndSys_LockRenderBuffer() failed\n");
1829 // Check to make sure that we haven't overshot
1830 paintedtime = snd_renderbuffer->endframe;
1831 if (paintedtime < soundtime)
1832 paintedtime = soundtime;
1834 // mix ahead of current position
1836 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1838 endtime = soundtime + (unsigned int)(max(_snd_mixahead.value * (float)snd_renderbuffer->format.speed, min(3 * (soundtime - oldsoundtime), 0.3 * (float)snd_renderbuffer->format.speed)));
1839 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1840 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1841 endtime = min(endtime, maxtime);
1843 while (paintedtime < endtime)
1845 unsigned int startoffset;
1846 unsigned int nbframes;
1848 // see how much we can fit in the paint buffer
1849 nbframes = endtime - paintedtime;
1850 // limit to the end of the ring buffer (in case of wrapping)
1851 startoffset = paintedtime % snd_renderbuffer->maxframes;
1852 nbframes = min(nbframes, snd_renderbuffer->maxframes - startoffset);
1854 // mix into the buffer
1855 S_MixToBuffer(&snd_renderbuffer->ring[startoffset * snd_renderbuffer->format.width * snd_renderbuffer->format.channels], nbframes);
1857 paintedtime += nbframes;
1858 snd_renderbuffer->endframe = paintedtime;
1861 SndSys_UnlockRenderBuffer();
1863 // Remove outdated samples from the ring buffer, if any
1864 if (snd_renderbuffer->startframe < soundtime)
1865 snd_renderbuffer->startframe = soundtime;
1868 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1872 oldsoundtime = soundtime;
1874 cls.soundstats.latency_milliseconds = (snd_renderbuffer->endframe - snd_renderbuffer->startframe) * 1000 / snd_renderbuffer->format.speed;
1881 Called once each time through the main loop
1884 void S_Update(const matrix4x4_t *listenermatrix)
1886 unsigned int i, j, k;
1887 channel_t *ch, *combine;
1888 matrix4x4_t basematrix, rotatematrix;
1890 if (snd_renderbuffer == NULL || nosound.integer)
1894 double mindist_trans, maxdist_trans;
1896 spatialmin = snd_spatialization_min.value;
1897 spatialdiff = snd_spatialization_max.value - spatialmin;
1899 if(snd_spatialization_control.value)
1901 spatialpower = snd_spatialization_power.value;
1903 if(spatialpower == 0)
1905 spatialmethod = SPATIAL_LOG;
1906 mindist_trans = log(max(1, snd_spatialization_min_radius.value));
1907 maxdist_trans = log(max(1, snd_spatialization_max_radius.value));
1911 spatialmethod = SPATIAL_POW;
1912 mindist_trans = pow(snd_spatialization_min_radius.value, spatialpower);
1913 maxdist_trans = pow(snd_spatialization_max_radius.value, spatialpower);
1916 if(mindist_trans - maxdist_trans == 0)
1918 spatialmethod = SPATIAL_THRESH;
1919 mindist_trans = snd_spatialization_min_radius.value;
1923 spatialoffset = mindist_trans;
1924 spatialfactor = 1 / (maxdist_trans - mindist_trans);
1928 spatialmethod = SPATIAL_NONE;
1932 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1933 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1934 current_channellayout != snd_channellayout.integer)
1935 S_SetChannelLayout();
1937 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1938 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1940 // calculate the current matrices
1941 for (j = 0;j < SND_LISTENERS;j++)
1943 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1944 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1945 // I think this should now do this:
1946 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1947 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1948 // angle has to be taken negative)
1949 // 2. create a transform which first rotates and moves its argument
1950 // into the player's view coordinates (using basematrix which is
1951 // an inverted "absolute" listener matrix), then applies the
1952 // rotation matrix for the ear
1953 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1954 // does not actually refer to an entity?
1957 // update general area ambient sound sources
1958 S_UpdateAmbientSounds ();
1962 // update spatialization for static and dynamic sounds
1963 cls.soundstats.totalsounds = 0;
1964 cls.soundstats.mixedsounds = 0;
1965 ch = channels+NUM_AMBIENTS;
1966 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1970 cls.soundstats.totalsounds++;
1972 // respatialize channel
1973 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1975 // try to combine static sounds with a previous channel of the same
1976 // sound effect so we don't mix five torches every frame
1977 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1979 // no need to merge silent channels
1980 for (j = 0;j < SND_LISTENERS;j++)
1981 if (ch->listener_volume[j])
1983 if (j == SND_LISTENERS)
1985 // if the last combine chosen isn't suitable, find a new one
1986 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1990 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1992 if (channels[j].sfx == ch->sfx)
1994 combine = channels + j;
1999 if (combine && combine != ch && combine->sfx == ch->sfx)
2001 for (j = 0;j < SND_LISTENERS;j++)
2003 combine->listener_volume[j] += ch->listener_volume[j];
2004 ch->listener_volume[j] = 0;
2008 for (k = 0;k < SND_LISTENERS;k++)
2009 if (ch->listener_volume[k])
2011 if (k < SND_LISTENERS)
2012 cls.soundstats.mixedsounds++;
2015 sound_spatialized = true;
2018 if (snd_show.integer)
2019 Con_Printf("----(%u)----\n", cls.soundstats.mixedsounds);
2024 void S_ExtraUpdate (void)
2026 if (snd_noextraupdate.integer || !sound_spatialized)
2032 qboolean S_LocalSound (const char *sound)
2037 if (!snd_initialized.integer || nosound.integer)
2040 sfx = S_PrecacheSound (sound, true, false);
2043 Con_Printf("S_LocalSound: can't precache %s\n", sound);
2047 // Local sounds must not be freed
2048 sfx->flags |= SFXFLAG_PERMANENTLOCK;
2050 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
2054 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;