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
28 #define SND_MIN_SPEED 8000
29 #define SND_MAX_SPEED 48000
30 #define SND_MIN_WIDTH 1
31 #define SND_MAX_WIDTH 2
32 #define SND_MIN_CHANNELS 1
33 #define SND_MAX_CHANNELS 8
35 #if SND_LISTENERS != 8
36 # error this data only supports up to 8 channel, update it!
38 typedef struct listener_s
46 typedef struct speakerlayout_s
49 unsigned int channels;
50 listener_t listeners[SND_LISTENERS];
54 static speakerlayout_t snd_speakerlayout;
56 // Our speaker layouts are based on ALSA. They differ from those
57 // Win32 and Mac OS X APIs use when there's more than 4 channels.
58 // (rear left + rear right, and front center + LFE are swapped).
59 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
60 static const speakerlayout_t snd_speakerlayouts[] =
65 {45, 0.2, 0.2, 0.5}, // front left
66 {315, 0.2, 0.2, 0.5}, // front right
67 {135, 0.2, 0.2, 0.5}, // rear left
68 {225, 0.2, 0.2, 0.5}, // rear right
69 {0, 0.2, 0.2, 0.5}, // front center
70 {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)
71 {90, 0.2, 0.2, 0.5}, // side left
72 {180, 0.2, 0.2, 0.5}, // side right
78 {45, 0.2, 0.2, 0.5}, // front left
79 {315, 0.2, 0.2, 0.5}, // front right
80 {135, 0.2, 0.2, 0.5}, // rear left
81 {225, 0.2, 0.2, 0.5}, // rear right
82 {0, 0.2, 0.2, 0.5}, // front center
83 {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)
89 // these systems sometimes have a subwoofer as well, but it has no
93 {45, 0.3, 0.3, 0.8}, // front left
94 {315, 0.3, 0.3, 0.8}, // front right
95 {135, 0.3, 0.3, 0.8}, // rear left
96 {225, 0.3, 0.3, 0.8}, // rear right
104 // these systems sometimes have a subwoofer as well, but it has no
105 // channel of its own
108 {90, 0.5, 0.5, 1}, // side left
109 {270, 0.5, 0.5, 1}, // side right
121 {0, 0, 1, 1}, // center
134 // =======================================================================
135 // Internal sound data & structures
136 // =======================================================================
138 channel_t channels[MAX_CHANNELS];
139 unsigned int total_channels;
141 snd_ringbuffer_t *snd_renderbuffer = NULL;
142 unsigned int soundtime = 0;
143 static unsigned int oldpaintedtime = 0;
144 static unsigned int extrasoundtime = 0;
145 static double snd_starttime = 0.0;
147 vec3_t listener_origin;
148 matrix4x4_t listener_matrix[SND_LISTENERS];
149 mempool_t *snd_mempool;
151 // Linked list of known sfx
152 static sfx_t *known_sfx = NULL;
154 static qboolean sound_spatialized = false;
156 qboolean simsound = false;
158 static qboolean recording_sound = false;
161 static int current_swapstereo = false;
162 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
163 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
165 // Cvars declared in sound.h (part of the sound API)
166 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
167 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
168 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
169 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
170 cvar_t snd_soundradius = {0, "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)"};
172 // Cvars declared in snd_main.h (shared with other snd_*.c files)
173 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "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"};
181 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
182 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
183 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
184 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
185 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"};
186 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
188 // Default sound format is 48KHz, 16-bit, stereo
189 // (48KHz because a lot of onboard sound cards sucks at any other speed)
190 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
191 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
192 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)"};
195 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
196 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
199 // ====================================================================
201 // ====================================================================
203 void S_FreeSfx (sfx_t *sfx, qboolean force);
205 static void S_Play_Common (float fvol, float attenuation)
208 char name [MAX_QPATH];
212 while (i < Cmd_Argc ())
214 // Get the name, and appends ".wav" as an extension if there's none
215 strlcpy (name, Cmd_Argv (i), sizeof (name));
216 if (!strrchr (name, '.'))
217 strlcat (name, ".wav", sizeof (name));
220 // If we need to get the volume from the command line
223 fvol = atof (Cmd_Argv (i));
227 sfx = S_PrecacheSound (name, true, false);
230 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
232 // Free the sfx if the file didn't exist
234 S_FreeSfx (sfx, false);
236 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
241 static void S_Play_f(void)
243 S_Play_Common (1.0f, 1.0f);
246 static void S_Play2_f(void)
248 S_Play_Common (1.0f, 0.0f);
251 static void S_PlayVol_f(void)
253 S_Play_Common (-1.0f, 0.0f);
256 static void S_SoundList_f (void)
263 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
265 if (sfx->fetcher != NULL)
268 const snd_format_t* format;
271 format = sfx->fetcher->getfmt(sfx);
272 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
273 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
274 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
275 (sfx->locks > 0) ? 'K' : ' ',
276 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
278 (format->channels == 1) ? "mono" : "stereo",
284 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
286 Con_Printf("Total resident: %i\n", total);
290 void S_SoundInfo_f(void)
292 if (snd_renderbuffer == NULL)
294 Con_Print("sound system not started\n");
298 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
299 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
300 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
301 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
302 Con_Printf("%5u total_channels\n", total_channels);
306 int S_GetSoundRate(void)
308 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
312 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
314 static const snd_format_t thresholds [] =
316 // speed width channels
317 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
322 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
324 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
325 unsigned int speed_level, width_level, channels_level;
327 // If we have reached the minimum values, there's nothing more we can do
328 if ((format->speed == thresholds[0].speed || fixed_speed) &&
329 (format->width == thresholds[0].width || fixed_width) &&
330 (format->channels == thresholds[0].channels || fixed_channels))
333 // Check the min and max values
334 #define CHECK_BOUNDARIES(param) \
335 if (format->param < thresholds[0].param) \
337 format->param = thresholds[0].param; \
340 if (format->param > thresholds[nb_thresholds - 1].param) \
342 format->param = thresholds[nb_thresholds - 1].param; \
345 CHECK_BOUNDARIES(speed);
346 CHECK_BOUNDARIES(width);
347 CHECK_BOUNDARIES(channels);
348 #undef CHECK_BOUNDARIES
350 // Find the level of each parameter
351 #define FIND_LEVEL(param) \
353 while (param##_level < nb_thresholds - 1) \
355 if (format->param <= thresholds[param##_level].param) \
362 FIND_LEVEL(channels);
365 // Decrease the parameter with the highest level to the previous level
366 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
368 format->channels = thresholds[channels_level - 1].channels;
371 if (speed_level >= width_level && !fixed_speed)
373 format->speed = thresholds[speed_level - 1].speed;
377 format->width = thresholds[width_level - 1].width;
382 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
384 static void S_SetChannelLayout (void)
387 listener_t swaplistener;
388 listener_t *listeners;
391 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
392 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
394 if (i >= SND_SPEAKERLAYOUTS)
396 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
397 snd_renderbuffer->format.channels);
398 i = SND_SPEAKERLAYOUTS - 1;
401 snd_speakerlayout = snd_speakerlayouts[i];
402 listeners = snd_speakerlayout.listeners;
404 // Swap the left and right channels if snd_swapstereo is set
405 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
407 switch (snd_speakerlayout.channels)
410 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
414 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
417 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
428 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
429 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
430 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
432 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
434 // If we're in the sound engine initialization
435 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
437 layout = SND_CHANNELLAYOUT_STANDARD;
438 Cvar_SetValueQuick (&snd_channellayout, layout);
441 layout = current_channellayout_used;
444 layout = snd_channellayout.integer;
446 // Convert our layout (= ALSA) to the standard layout if necessary
447 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
449 if (layout == SND_CHANNELLAYOUT_STANDARD)
451 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
452 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
455 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
456 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
459 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
460 current_channellayout = snd_channellayout.integer;
461 current_channellayout_used = layout;
465 void S_Startup (void)
467 qboolean fixed_speed, fixed_width, fixed_channels;
468 snd_format_t chosen_fmt;
469 static snd_format_t prev_render_format = {0, 0, 0};
473 if (!snd_initialized.integer)
478 fixed_channels = false;
480 // Get the starting sound format from the cvars
481 chosen_fmt.speed = snd_speed.integer;
482 chosen_fmt.width = snd_width.integer;
483 chosen_fmt.channels = snd_channels.integer;
485 // Check the environment variables to see if the player wants a particular sound format
486 env = getenv("QUAKE_SOUND_CHANNELS");
489 chosen_fmt.channels = atoi (env);
490 fixed_channels = true;
492 env = getenv("QUAKE_SOUND_SPEED");
495 chosen_fmt.speed = atoi (env);
498 env = getenv("QUAKE_SOUND_SAMPLEBITS");
501 chosen_fmt.width = atoi (env) / 8;
505 // Parse the command line to see if the player wants a particular sound format
506 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
507 if (COM_CheckParm ("-sndquad") != 0)
509 chosen_fmt.channels = 4;
510 fixed_channels = true;
512 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
513 else if (COM_CheckParm ("-sndstereo") != 0)
515 chosen_fmt.channels = 2;
516 fixed_channels = true;
518 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
519 else if (COM_CheckParm ("-sndmono") != 0)
521 chosen_fmt.channels = 1;
522 fixed_channels = true;
524 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
525 i = COM_CheckParm ("-sndspeed");
526 if (0 < i && i < com_argc - 1)
528 chosen_fmt.speed = atoi (com_argv[i + 1]);
531 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
532 i = COM_CheckParm ("-sndbits");
533 if (0 < i && i < com_argc - 1)
535 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
539 // You can't change sound speed after start time (not yet supported)
540 if (prev_render_format.speed != 0)
543 if (chosen_fmt.speed != prev_render_format.speed)
545 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
546 prev_render_format.speed);
547 chosen_fmt.speed = prev_render_format.speed;
552 if (chosen_fmt.speed < SND_MIN_SPEED)
554 chosen_fmt.speed = SND_MIN_SPEED;
557 else if (chosen_fmt.speed > SND_MAX_SPEED)
559 chosen_fmt.speed = SND_MAX_SPEED;
563 if (chosen_fmt.width < SND_MIN_WIDTH)
565 chosen_fmt.width = SND_MIN_WIDTH;
568 else if (chosen_fmt.width > SND_MAX_WIDTH)
570 chosen_fmt.width = SND_MAX_WIDTH;
574 if (chosen_fmt.channels < SND_MIN_CHANNELS)
576 chosen_fmt.channels = SND_MIN_CHANNELS;
577 fixed_channels = false;
579 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
581 chosen_fmt.channels = SND_MAX_CHANNELS;
582 fixed_channels = false;
585 // create the sound buffer used for sumitting the samples to the plaform-dependent module
588 snd_format_t suggest_fmt;
594 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
595 chosen_fmt.speed, chosen_fmt.width * 8,
596 chosen_fmt.channels);
598 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
599 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
603 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
605 // If the module is suggesting another one
606 if (suggest_fmt.speed != 0)
608 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
609 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
610 suggest_fmt.speed, suggest_fmt.width * 8,
611 suggest_fmt.channels);
613 // Else, try to find a less resource-demanding format
614 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
619 // If we haven't found a suitable format
622 Con_Print("S_Startup: SndSys_Init failed.\n");
623 sound_spatialized = false;
629 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
630 Con_Print ("S_Startup: simulating sound output\n");
633 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
634 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
635 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
638 if (snd_speed.integer != (int)chosen_fmt.speed)
639 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
640 if (snd_width.integer != chosen_fmt.width)
641 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
642 if (snd_channels.integer != chosen_fmt.channels)
643 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
645 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
646 S_SetChannelLayout();
648 snd_starttime = realtime;
650 // If the sound module has already run, add an extra time to make sure
651 // the sound time doesn't decrease, to not confuse playing SFXs
652 if (oldpaintedtime != 0)
654 // The extra time must be a multiple of the render buffer size
655 // to avoid modifying the current position in the buffer,
656 // some modules write directly to a shared (DMA) buffer
657 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
658 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
659 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
661 soundtime = extrasoundtime;
665 snd_renderbuffer->startframe = soundtime;
666 snd_renderbuffer->endframe = soundtime;
667 recording_sound = false;
670 void S_Shutdown(void)
672 if (snd_renderbuffer == NULL)
675 oldpaintedtime = snd_renderbuffer->endframe;
679 Mem_Free(snd_renderbuffer->ring);
680 Mem_Free(snd_renderbuffer);
681 snd_renderbuffer = NULL;
686 sound_spatialized = false;
689 void S_Restart_f(void)
702 Con_DPrint("\nSound Initialization\n");
704 Cvar_RegisterVariable(&volume);
705 Cvar_RegisterVariable(&bgmvolume);
706 Cvar_RegisterVariable(&snd_staticvolume);
708 Cvar_RegisterVariable(&snd_speed);
709 Cvar_RegisterVariable(&snd_width);
710 Cvar_RegisterVariable(&snd_channels);
711 Cvar_RegisterVariable(&snd_mutewhenidle);
713 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
714 if (COM_CheckParm("-nosound"))
717 snd_mempool = Mem_AllocPool("sound", 0, NULL);
719 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
720 if (COM_CheckParm("-simsound"))
723 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
724 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
725 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
726 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
727 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
728 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
729 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
730 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
732 Cvar_RegisterVariable(&nosound);
733 Cvar_RegisterVariable(&snd_precache);
734 Cvar_RegisterVariable(&snd_initialized);
735 Cvar_RegisterVariable(&snd_streaming);
736 Cvar_RegisterVariable(&ambient_level);
737 Cvar_RegisterVariable(&ambient_fade);
738 Cvar_RegisterVariable(&snd_noextraupdate);
739 Cvar_RegisterVariable(&snd_show);
740 Cvar_RegisterVariable(&_snd_mixahead);
741 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
742 Cvar_RegisterVariable(&snd_channellayout);
743 Cvar_RegisterVariable(&snd_soundradius);
745 Cvar_SetValueQuick(&snd_initialized, true);
749 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
750 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
760 Shutdown and free all resources
763 void S_Terminate (void)
769 while (known_sfx != NULL)
770 S_FreeSfx (known_sfx, true);
772 Cvar_SetValueQuick (&snd_initialized, false);
773 Mem_FreePool (&snd_mempool);
782 void S_UnloadAllSounds_f (void)
786 // stop any active sounds
789 // because the ambient sounds will be freed, clear the pointers
790 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
791 ambient_sfxs[i] = NULL;
793 // now free all sounds
794 while (known_sfx != NULL)
795 S_FreeSfx (known_sfx, true);
804 sfx_t *S_FindName (const char *name)
808 if (!snd_initialized.integer)
811 if (strlen (name) >= sizeof (sfx->name))
813 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
817 // Look for this sound in the list of known sfx
818 // TODO: hash table search?
819 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
820 if(!strcmp (sfx->name, name))
823 // Add a sfx_t struct for this sound
824 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
825 memset (sfx, 0, sizeof(*sfx));
826 strlcpy (sfx->name, name, sizeof (sfx->name));
827 sfx->memsize = sizeof(*sfx);
828 sfx->next = known_sfx;
840 void S_FreeSfx (sfx_t *sfx, qboolean force)
844 // Never free a locked sfx unless forced
845 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
848 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
850 // Remove it from the list of known sfx
851 if (sfx == known_sfx)
852 known_sfx = known_sfx->next;
857 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
858 if (prev_sfx->next == sfx)
860 prev_sfx->next = sfx->next;
863 if (prev_sfx == NULL)
865 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
870 // Stop all channels using this sfx
871 for (i = 0; i < total_channels; i++)
872 if (channels[i].sfx == sfx)
876 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
877 sfx->fetcher->free (sfx->fetcher_data);
887 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
893 // Start the ambient sounds and make them loop
894 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
896 // Precache it if it's not done (request a lock to make sure it will never be freed)
897 if (ambient_sfxs[i] == NULL)
898 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
899 if (ambient_sfxs[i] != NULL)
901 // Add a lock to the SFX while playing. It will be
902 // removed by S_StopAllSounds at the end of the level
903 S_LockSfx (ambient_sfxs[i]);
905 channels[i].sfx = ambient_sfxs[i];
906 channels[i].flags |= CHANNELFLAG_FORCELOOP;
907 channels[i].master_vol = 0;
911 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
912 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
913 if (sfx->flags & SFXFLAG_SERVERSOUND)
916 sfx->flags &= ~SFXFLAG_SERVERSOUND;
919 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
920 for (i = 1; i < numsounds; i++)
922 sfx = S_FindName (serversound[i]);
925 // clear the FILEMISSING flag so that S_LoadSound will try again on a
926 // previously missing file
927 sfx->flags &= ~ SFXFLAG_FILEMISSING;
929 sfx->flags |= SFXFLAG_SERVERSOUND;
933 // Free all unlocked sfx
934 for (sfx = known_sfx;sfx;sfx = sfxnext)
937 S_FreeSfx (sfx, false);
947 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
951 if (!snd_initialized.integer)
954 if (name == NULL || name[0] == 0)
957 sfx = S_FindName (name);
962 // clear the FILEMISSING flag so that S_LoadSound will try again on a
963 // previously missing file
964 sfx->flags &= ~ SFXFLAG_FILEMISSING;
969 if (!nosound.integer && snd_precache.integer)
970 S_LoadSound(sfx, complain);
980 qboolean S_IsSoundPrecached (const sfx_t *sfx)
982 return (sfx != NULL && sfx->fetcher != NULL);
992 void S_LockSfx (sfx_t *sfx)
1001 Remove a lock from a SFX
1004 void S_UnlockSfx (sfx_t *sfx)
1015 void S_BlockSound (void)
1026 void S_UnblockSound (void)
1036 Picks a channel based on priorities, empty slots, number of channels
1039 channel_t *SND_PickChannel(int entnum, int entchannel)
1043 int first_life_left, life_left;
1046 // Check for replacement sound, or find the best one to replace
1048 first_life_left = 0x7fffffff;
1050 // entity channels try to replace the existing sound on the channel
1051 if (entchannel != 0)
1053 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1055 ch = &channels[ch_idx];
1056 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1058 // always override sound from same entity
1059 S_StopChannel (ch_idx);
1060 return &channels[ch_idx];
1065 // there was no channel to override, so look for the first empty one
1066 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1068 ch = &channels[ch_idx];
1071 // no sound on this channel
1072 first_to_die = ch_idx;
1076 // don't let monster sounds override player sounds
1077 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1080 // don't override looped sounds
1081 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1083 life_left = ch->sfx->total_length - ch->pos;
1085 if (life_left < first_life_left)
1087 first_life_left = life_left;
1088 first_to_die = ch_idx;
1092 if (first_to_die == -1)
1095 return &channels[first_to_die];
1102 Spatializes a channel
1105 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1106 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1109 vec_t dist, mastervol, intensity, vol;
1112 // update sound origin if we know about the entity
1113 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1115 if (ch->entnum >= 32768)
1117 // TODO: sounds that follow CSQC entities?
1119 else if (cl.entities[ch->entnum].state_current.active)
1121 //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]);
1122 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1123 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)
1124 VectorMAMAM(1.0f, ch->origin, 0.5f, cl.model_precache[cl.entities[ch->entnum].state_current.modelindex]->normalmins, 0.5f, cl.model_precache[cl.entities[ch->entnum].state_current.modelindex]->normalmaxs, ch->origin);
1128 mastervol = ch->master_vol;
1129 // Adjust volume of static sounds
1131 mastervol *= snd_staticvolume.value;
1133 // anything coming from the view entity will always be full volume
1134 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1135 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1137 for (i = 0;i < SND_LISTENERS;i++)
1139 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1140 ch->listener_volume[i] = (int)bound(0, vol, 255);
1145 // calculate stereo seperation and distance attenuation
1146 VectorSubtract(listener_origin, ch->origin, source_vec);
1147 dist = VectorLength(source_vec);
1148 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1151 for (i = 0;i < SND_LISTENERS;i++)
1153 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1154 VectorNormalize(source_vec);
1155 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1156 ch->listener_volume[i] = (int)bound(0, vol, 255);
1160 for (i = 0;i < SND_LISTENERS;i++)
1161 ch->listener_volume[i] = 0;
1166 // =======================================================================
1167 // Start a sound effect
1168 // =======================================================================
1170 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1172 // Initialize the channel
1173 memset (target_chan, 0, sizeof (*target_chan));
1174 VectorCopy (origin, target_chan->origin);
1175 target_chan->sfx = sfx;
1176 target_chan->flags = flags;
1177 target_chan->pos = 0; // start of the sound
1179 // If it's a static sound
1182 if (sfx->loopstart >= sfx->total_length)
1183 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1184 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1187 target_chan->dist_mult = attenuation / snd_soundradius.value;
1189 // Lock the SFX during play
1192 // and finally, apply the volume
1193 S_SetChannelVolume(target_chan - channels, fvol);
1197 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1199 channel_t *target_chan, *check;
1202 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1205 if (sfx->fetcher == NULL)
1208 // Pick a channel to play on
1209 target_chan = SND_PickChannel(entnum, entchannel);
1213 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1214 target_chan->entnum = entnum;
1215 target_chan->entchannel = entchannel;
1217 SND_Spatialize(target_chan, false);
1219 // if an identical sound has also been started this frame, offset the pos
1220 // a bit to keep it from just making the first one louder
1221 check = &channels[NUM_AMBIENTS];
1222 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1224 if (check == target_chan)
1226 if (check->sfx == sfx && !check->pos)
1228 // use negative pos offset to delay this sound effect
1229 target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1234 return (target_chan - channels);
1237 void S_StopChannel (unsigned int channel_ind)
1241 if (channel_ind >= total_channels)
1244 ch = &channels[channel_ind];
1245 if (ch->sfx != NULL)
1247 sfx_t *sfx = ch->sfx;
1249 if (sfx->fetcher != NULL)
1251 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1252 if (fetcher_endsb != NULL)
1253 fetcher_endsb (ch->fetcher_data);
1256 // Remove the lock it holds
1259 ch->fetcher_data = NULL;
1265 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1267 if (ch_ind >= total_channels)
1270 if (flag != CHANNELFLAG_FORCELOOP &&
1271 flag != CHANNELFLAG_PAUSED &&
1272 flag != CHANNELFLAG_FULLVOLUME)
1276 channels[ch_ind].flags |= flag;
1278 channels[ch_ind].flags &= ~flag;
1283 void S_StopSound(int entnum, int entchannel)
1287 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1288 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1295 extern void CDAudio_Stop(void);
1296 void S_StopAllSounds (void)
1300 // TOCHECK: is this test necessary?
1301 if (snd_renderbuffer == NULL)
1304 // stop CD audio because it may be using a faketrack
1307 for (i = 0; i < total_channels; i++)
1310 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1311 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1313 // Mute the contents of the submittion buffer
1314 if (simsound || SndSys_LockRenderBuffer ())
1319 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1320 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1321 memset(snd_renderbuffer->ring, clear, memsize);
1324 SndSys_UnlockRenderBuffer ();
1328 void S_PauseGameSounds (qboolean toggle)
1332 for (i = 0; i < total_channels; i++)
1337 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1338 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1342 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1344 sfx_t *sfx = channels[ch_ind].sfx;
1345 if(sfx->volume_peak > 0)
1347 // Replaygain support
1348 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1349 fvol *= sfx->volume_mult;
1350 if(fvol * sfx->volume_peak > 1)
1351 fvol = 1 / sfx->volume_peak;
1352 // Con_DPrintf("%f\n", fvol);
1354 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1363 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1365 channel_t *target_chan;
1367 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1371 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1375 if (total_channels == MAX_CHANNELS)
1377 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1381 target_chan = &channels[total_channels++];
1382 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1384 SND_Spatialize (target_chan, true);
1390 S_UpdateAmbientSounds
1393 void S_UpdateAmbientSounds (void)
1397 int ambient_channel;
1399 unsigned char ambientlevels[NUM_AMBIENTS];
1401 memset(ambientlevels, 0, sizeof(ambientlevels));
1402 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1403 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1405 // Calc ambient sound levels
1406 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1408 chan = &channels[ambient_channel];
1409 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1412 vol = (int)ambientlevels[ambient_channel];
1416 // Don't adjust volume too fast
1417 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1418 if (cl.time > cl.oldtime)
1420 if (chan->master_vol < vol)
1422 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1423 if (chan->master_vol > vol)
1424 chan->master_vol = vol;
1426 else if (chan->master_vol > vol)
1428 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1429 if (chan->master_vol < vol)
1430 chan->master_vol = vol;
1434 for (i = 0;i < SND_LISTENERS;i++)
1435 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1439 static void S_PaintAndSubmit (void)
1441 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1442 qboolean usesoundtimehack;
1443 static qboolean soundtimehack = true;
1445 if (snd_renderbuffer == NULL || nosound.integer)
1448 // Update sound time
1449 usesoundtimehack = true;
1450 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1451 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1452 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1453 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1455 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1458 newsoundtime = SndSys_GetSoundTime();
1459 usesoundtimehack = false;
1461 // if the soundtimehack state changes we need to reset the soundtime
1462 if (soundtimehack != usesoundtimehack)
1464 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1466 // Mute the contents of the submission buffer
1467 if (simsound || SndSys_LockRenderBuffer ())
1472 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1473 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1474 memset(snd_renderbuffer->ring, clear, memsize);
1477 SndSys_UnlockRenderBuffer ();
1480 soundtimehack = usesoundtimehack;
1482 if (!soundtimehack && snd_blocked > 0)
1485 newsoundtime += extrasoundtime;
1486 if (newsoundtime < soundtime)
1488 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1490 unsigned int additionaltime;
1492 // add some time to extrasoundtime make newsoundtime higher
1494 // The extra time must be a multiple of the render buffer size
1495 // to avoid modifying the current position in the buffer,
1496 // some modules write directly to a shared (DMA) buffer
1497 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1498 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1500 extrasoundtime += additionaltime;
1501 newsoundtime += additionaltime;
1502 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1505 else if (!soundtimehack)
1506 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1507 newsoundtime, soundtime);
1509 soundtime = newsoundtime;
1510 recording_sound = (cls.capturevideo.soundrate != 0);
1512 // Check to make sure that we haven't overshot
1513 paintedtime = snd_renderbuffer->endframe;
1514 if (paintedtime < soundtime)
1515 paintedtime = soundtime;
1517 // mix ahead of current position
1518 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1519 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1520 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1521 endtime = min(endtime, maxtime);
1523 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1526 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1535 Called once each time through the main loop
1538 void S_Update(const matrix4x4_t *listenermatrix)
1540 unsigned int i, j, total;
1541 channel_t *ch, *combine;
1542 matrix4x4_t basematrix, rotatematrix;
1544 if (snd_renderbuffer == NULL || nosound.integer)
1547 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1548 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1549 current_channellayout != snd_channellayout.integer)
1550 S_SetChannelLayout();
1552 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1553 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1555 // calculate the current matrices
1556 for (j = 0;j < SND_LISTENERS;j++)
1558 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1559 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1560 // I think this should now do this:
1561 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1562 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1563 // angle has to be taken negative)
1564 // 2. create a transform which first rotates and moves its argument
1565 // into the player's view coordinates (using basematrix which is
1566 // an inverted "absolute" listener matrix), then applies the
1567 // rotation matrix for the ear
1568 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1569 // does not actually refer to an entity?
1572 // update general area ambient sound sources
1573 S_UpdateAmbientSounds ();
1577 // update spatialization for static and dynamic sounds
1578 ch = channels+NUM_AMBIENTS;
1579 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1584 // respatialize channel
1585 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1587 // try to combine static sounds with a previous channel of the same
1588 // sound effect so we don't mix five torches every frame
1589 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1591 // no need to merge silent channels
1592 for (j = 0;j < SND_LISTENERS;j++)
1593 if (ch->listener_volume[j])
1595 if (j == SND_LISTENERS)
1597 // if the last combine chosen isn't suitable, find a new one
1598 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1602 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1604 if (channels[j].sfx == ch->sfx)
1606 combine = channels + j;
1611 if (combine && combine != ch && combine->sfx == ch->sfx)
1613 for (j = 0;j < SND_LISTENERS;j++)
1615 combine->listener_volume[j] += ch->listener_volume[j];
1616 ch->listener_volume[j] = 0;
1622 sound_spatialized = true;
1625 if (snd_show.integer)
1629 for (i=0 ; i<total_channels; i++, ch++)
1633 for (j = 0;j < SND_LISTENERS;j++)
1634 if (ch->listener_volume[j])
1636 if (j < SND_LISTENERS)
1641 Con_Printf("----(%u)----\n", total);
1647 void S_ExtraUpdate (void)
1649 if (snd_noextraupdate.integer || !sound_spatialized)
1655 qboolean S_LocalSound (const char *sound)
1660 if (!snd_initialized.integer || nosound.integer)
1663 sfx = S_PrecacheSound (sound, true, false);
1666 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1670 // Local sounds must not be freed
1671 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1673 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1677 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;