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 96000
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 vec_t sound_nominal_clip_dist=1000.0;
150 mempool_t *snd_mempool;
152 // Linked list of known sfx
153 static sfx_t *known_sfx = NULL;
155 static qboolean sound_spatialized = false;
157 qboolean simsound = false;
159 static qboolean recording_sound = false;
162 static int current_swapstereo = false;
163 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
164 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
166 // Cvars declared in sound.h (part of the sound API)
167 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
168 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
169 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
170 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
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 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
179 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
180 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
181 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
182 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
183 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"};
184 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
186 // Default sound format is 48KHz, 16-bit, stereo
187 // (48KHz because a lot of onboard sound cards sucks at any other speed)
188 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
189 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
190 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)"};
193 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
194 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
197 // ====================================================================
199 // ====================================================================
201 void S_FreeSfx (sfx_t *sfx, qboolean force);
203 static void S_Play_Common (float fvol, float attenuation)
206 char name [MAX_QPATH];
210 while (i < Cmd_Argc ())
212 // Get the name, and appends ".wav" as an extension if there's none
213 strlcpy (name, Cmd_Argv (i), sizeof (name));
214 if (!strrchr (name, '.'))
215 strlcat (name, ".wav", sizeof (name));
218 // If we need to get the volume from the command line
221 fvol = atof (Cmd_Argv (i));
225 sfx = S_PrecacheSound (name, true, false);
228 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
230 // Free the sfx if the file didn't exist
232 S_FreeSfx (sfx, false);
234 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
239 static void S_Play_f(void)
241 S_Play_Common (1.0f, 1.0f);
244 static void S_Play2_f(void)
246 S_Play_Common (1.0f, 0.0f);
249 static void S_PlayVol_f(void)
251 S_Play_Common (-1.0f, 0.0f);
254 static void S_SoundList_f (void)
261 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
263 if (sfx->fetcher != NULL)
266 const snd_format_t* format;
269 format = sfx->fetcher->getfmt(sfx);
270 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
271 (sfx->loopstart >= 0) ? 'L' : ' ',
272 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
273 (sfx->locks > 0) ? 'K' : ' ',
274 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
276 (format->channels == 1) ? "mono" : "stereo",
282 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
284 Con_Printf("Total resident: %i\n", total);
288 void S_SoundInfo_f(void)
290 if (snd_renderbuffer == NULL)
292 Con_Print("sound system not started\n");
296 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
297 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
298 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
299 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
300 Con_Printf("%5u total_channels\n", total_channels);
304 // TODO: make this function smarter...
305 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
307 // Can we decrease the number of channels?
308 if (!fixed_channels && format->channels > 1)
310 unsigned short channels = format->channels;
312 // If it has an odd number of channels(?!), make it even
317 // Remove 2 speakers, unless it's a stereo format
324 format->channels = channels;
328 // Can we decrease the speed?
331 unsigned int suggest_speeds [] = { 44100, 22050, 11025 };
334 for (i = 0; i < sizeof(suggest_speeds) / sizeof(suggest_speeds[0]); i++)
335 if (format->speed > suggest_speeds[i])
337 format->speed = suggest_speeds[i];
341 // the speed is already low
344 // Can we decrease the number of bits per sample?
345 if (!fixed_width && format->width > 1)
355 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
357 static void S_SetChannelLayout (void)
360 listener_t swaplistener;
361 listener_t *listeners;
364 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
365 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
367 if (i >= SND_SPEAKERLAYOUTS)
369 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
370 snd_renderbuffer->format.channels);
371 i = SND_SPEAKERLAYOUTS - 1;
374 snd_speakerlayout = snd_speakerlayouts[i];
375 listeners = snd_speakerlayout.listeners;
377 // Swap the left and right channels if snd_swapstereo is set
378 if (snd_swapstereo.integer)
380 switch (snd_speakerlayout.channels)
383 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
387 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
390 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
401 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
402 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
403 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
405 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
407 // If we're in the sound engine initialization
408 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
410 layout = SND_CHANNELLAYOUT_STANDARD;
411 Cvar_SetValueQuick (&snd_channellayout, layout);
414 layout = current_channellayout_used;
417 layout = snd_channellayout.integer;
419 // Convert our layout (= ALSA) to the standard layout if necessary
420 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
422 if (layout == SND_CHANNELLAYOUT_STANDARD)
424 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
425 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
428 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
429 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
432 current_swapstereo = snd_swapstereo.integer;
433 current_channellayout = snd_channellayout.integer;
434 current_channellayout_used = layout;
438 void S_Startup (void)
440 qboolean fixed_speed, fixed_width, fixed_channels;
441 snd_format_t chosen_fmt;
442 static snd_format_t prev_render_format = {0, 0, 0};
446 if (!snd_initialized.integer)
451 fixed_channels = false;
453 // Get the starting sound format from the cvars
454 chosen_fmt.speed = snd_speed.integer;
455 chosen_fmt.width = snd_width.integer;
456 chosen_fmt.channels = snd_channels.integer;
458 // Check the environment variables to see if the player wants a particular sound format
459 env = getenv("QUAKE_SOUND_CHANNELS");
462 chosen_fmt.channels = atoi (env);
463 fixed_channels = true;
465 env = getenv("QUAKE_SOUND_SPEED");
468 chosen_fmt.speed = atoi (env);
471 env = getenv("QUAKE_SOUND_SAMPLEBITS");
474 chosen_fmt.width = atoi (env) / 8;
478 // Parse the command line to see if the player wants a particular sound format
479 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
480 if (COM_CheckParm ("-sndquad") != 0)
482 chosen_fmt.channels = 4;
483 fixed_channels = true;
485 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
486 else if (COM_CheckParm ("-sndstereo") != 0)
488 chosen_fmt.channels = 2;
489 fixed_channels = true;
491 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
492 else if (COM_CheckParm ("-sndmono") != 0)
494 chosen_fmt.channels = 1;
495 fixed_channels = true;
497 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
498 i = COM_CheckParm ("-sndspeed");
499 if (0 < i && i < com_argc - 1)
501 chosen_fmt.speed = atoi (com_argv[i + 1]);
504 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
505 i = COM_CheckParm ("-sndbits");
506 if (0 < i && i < com_argc - 1)
508 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
512 // You can't change sound speed after start time (not yet supported)
513 if (prev_render_format.speed != 0)
516 if (chosen_fmt.speed != prev_render_format.speed)
518 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
519 prev_render_format.speed);
520 chosen_fmt.speed = prev_render_format.speed;
525 if (chosen_fmt.speed < SND_MIN_SPEED)
527 chosen_fmt.speed = SND_MIN_SPEED;
530 else if (chosen_fmt.speed > SND_MAX_SPEED)
532 chosen_fmt.speed = SND_MAX_SPEED;
536 if (chosen_fmt.width < SND_MIN_WIDTH)
538 chosen_fmt.width = SND_MIN_WIDTH;
541 else if (chosen_fmt.width > SND_MAX_WIDTH)
543 chosen_fmt.width = SND_MAX_WIDTH;
547 if (chosen_fmt.channels < SND_MIN_CHANNELS)
549 chosen_fmt.channels = SND_MIN_CHANNELS;
550 fixed_channels = false;
552 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
554 chosen_fmt.channels = SND_MAX_CHANNELS;
555 fixed_channels = false;
558 // create the sound buffer used for sumitting the samples to the plaform-dependent module
561 snd_format_t suggest_fmt;
567 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
568 chosen_fmt.speed, chosen_fmt.width * 8,
569 chosen_fmt.channels);
571 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
572 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
576 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
578 // If the module is suggesting another one
579 if (suggest_fmt.speed != 0)
581 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
582 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
583 suggest_fmt.speed, suggest_fmt.width * 8,
584 suggest_fmt.channels);
586 // Else, try to find a less resource-demanding format
587 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
592 // If we haven't found a suitable format
595 Con_Print("S_Startup: SndSys_Init failed.\n");
596 sound_spatialized = false;
602 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
603 Con_Print ("S_Startup: simulating sound output\n");
606 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
607 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
608 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
611 snd_speed.integer = chosen_fmt.speed;
612 snd_width.integer = chosen_fmt.width;
613 snd_channels.integer = chosen_fmt.channels;
615 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
616 S_SetChannelLayout();
618 snd_starttime = realtime;
620 // If the sound module has already run, add an extra time to make sure
621 // the sound time doesn't decrease, to not confuse playing SFXs
622 if (oldpaintedtime != 0)
624 // The extra time must be a multiple of the render buffer size
625 // to avoid modifying the current position in the buffer,
626 // some modules write directly to a shared (DMA) buffer
627 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
628 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
629 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
631 soundtime = extrasoundtime;
635 snd_renderbuffer->startframe = soundtime;
636 snd_renderbuffer->endframe = soundtime;
637 recording_sound = false;
640 void S_Shutdown(void)
642 if (snd_renderbuffer == NULL)
645 oldpaintedtime = snd_renderbuffer->endframe;
649 Mem_Free(snd_renderbuffer->ring);
650 Mem_Free(snd_renderbuffer);
651 snd_renderbuffer = NULL;
656 sound_spatialized = false;
659 void S_Restart_f(void)
672 Con_DPrint("\nSound Initialization\n");
674 Cvar_RegisterVariable(&volume);
675 Cvar_RegisterVariable(&bgmvolume);
676 Cvar_RegisterVariable(&snd_staticvolume);
678 Cvar_RegisterVariable(&snd_speed);
679 Cvar_RegisterVariable(&snd_width);
680 Cvar_RegisterVariable(&snd_channels);
682 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
683 if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
686 snd_mempool = Mem_AllocPool("sound", 0, NULL);
688 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
689 if (COM_CheckParm("-simsound"))
692 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
693 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
694 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
695 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
696 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
697 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
698 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
700 Cvar_RegisterVariable(&nosound);
701 Cvar_RegisterVariable(&snd_precache);
702 Cvar_RegisterVariable(&snd_initialized);
703 Cvar_RegisterVariable(&snd_streaming);
704 Cvar_RegisterVariable(&ambient_level);
705 Cvar_RegisterVariable(&ambient_fade);
706 Cvar_RegisterVariable(&snd_noextraupdate);
707 Cvar_RegisterVariable(&snd_show);
708 Cvar_RegisterVariable(&_snd_mixahead);
709 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
710 Cvar_RegisterVariable(&snd_channellayout);
712 Cvar_SetValueQuick(&snd_initialized, true);
716 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
717 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
727 Shutdown and free all resources
730 void S_Terminate (void)
736 while (known_sfx != NULL)
737 S_FreeSfx (known_sfx, true);
739 Cvar_SetValueQuick (&snd_initialized, false);
740 Mem_FreePool (&snd_mempool);
749 sfx_t *S_FindName (const char *name)
753 if (!snd_initialized.integer)
756 if (strlen (name) >= sizeof (sfx->name))
758 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
762 // Look for this sound in the list of known sfx
763 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
764 if(!strcmp (sfx->name, name))
767 // Add a sfx_t struct for this sound
768 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
769 memset (sfx, 0, sizeof(*sfx));
770 strlcpy (sfx->name, name, sizeof (sfx->name));
771 sfx->memsize = sizeof(*sfx);
772 sfx->next = known_sfx;
784 void S_FreeSfx (sfx_t *sfx, qboolean force)
788 // Never free a locked sfx unless forced
789 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
792 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
794 // Remove it from the list of known sfx
795 if (sfx == known_sfx)
796 known_sfx = known_sfx->next;
801 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
802 if (prev_sfx->next == sfx)
804 prev_sfx->next = sfx->next;
807 if (prev_sfx == NULL)
809 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
814 // Stop all channels using this sfx
815 for (i = 0; i < total_channels; i++)
816 if (channels[i].sfx == sfx)
820 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
821 sfx->fetcher->free (sfx);
831 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
837 // Start the ambient sounds and make them loop
838 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
840 // Precache it if it's not done (request a lock to make sure it will never be freed)
841 if (ambient_sfxs[i] == NULL)
842 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
843 if (ambient_sfxs[i] != NULL)
845 // Add a lock to the SFX while playing. It will be
846 // removed by S_StopAllSounds at the end of the level
847 S_LockSfx (ambient_sfxs[i]);
849 channels[i].sfx = ambient_sfxs[i];
850 channels[i].flags |= CHANNELFLAG_FORCELOOP;
851 channels[i].master_vol = 0;
855 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
856 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
857 if (sfx->flags & SFXFLAG_SERVERSOUND)
860 sfx->flags &= ~SFXFLAG_SERVERSOUND;
863 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
864 for (i = 1; i < numsounds; i++)
866 sfx = S_FindName (serversound[i]);
870 sfx->flags |= SFXFLAG_SERVERSOUND;
874 // Free all unlocked sfx
875 for (sfx = known_sfx;sfx;sfx = sfxnext)
878 S_FreeSfx (sfx, false);
888 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
892 if (!snd_initialized.integer)
895 if (name == NULL || name[0] == 0)
898 sfx = S_FindName (name);
905 if (!nosound.integer && snd_precache.integer)
906 S_LoadSound(sfx, complain);
916 qboolean S_IsSoundPrecached (const sfx_t *sfx)
918 return (sfx != NULL && sfx->fetcher != NULL);
928 void S_LockSfx (sfx_t *sfx)
937 Remove a lock from a SFX
940 void S_UnlockSfx (sfx_t *sfx)
951 void S_BlockSound (void)
962 void S_UnblockSound (void)
972 Picks a channel based on priorities, empty slots, number of channels
975 channel_t *SND_PickChannel(int entnum, int entchannel)
979 int first_life_left, life_left;
982 // Check for replacement sound, or find the best one to replace
984 first_life_left = 0x7fffffff;
985 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
987 ch = &channels[ch_idx];
990 // try to override an existing channel
991 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
993 // always override sound from same entity
994 first_to_die = ch_idx;
1002 // no sound on this channel
1003 first_to_die = ch_idx;
1010 // don't let monster sounds override player sounds
1011 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1014 // don't override looped sounds
1015 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart >= 0)
1019 life_left = (int)(ch->end - snd_renderbuffer->endframe);
1020 if (life_left < first_life_left)
1022 first_life_left = life_left;
1023 first_to_die = ch_idx;
1027 if (first_to_die == -1)
1030 S_StopChannel (first_to_die);
1032 return &channels[first_to_die];
1039 Spatializes a channel
1042 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1045 vec_t dist, mastervol, intensity, vol;
1048 // update sound origin if we know about the entity
1049 if (ch->entnum > 0 && cls.state == ca_connected && cl.entities[ch->entnum].state_current.active)
1051 //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]);
1052 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1053 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)
1054 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);
1057 mastervol = ch->master_vol;
1058 // Adjust volume of static sounds
1060 mastervol *= snd_staticvolume.value;
1062 // anything coming from the view entity will always be full volume
1063 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1064 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1066 for (i = 0;i < SND_LISTENERS;i++)
1068 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1069 ch->listener_volume[i] = (int)bound(0, vol, 255);
1074 // calculate stereo seperation and distance attenuation
1075 VectorSubtract(listener_origin, ch->origin, source_vec);
1076 dist = VectorLength(source_vec);
1077 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1080 for (i = 0;i < SND_LISTENERS;i++)
1082 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1083 VectorNormalize(source_vec);
1084 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1085 ch->listener_volume[i] = (int)bound(0, vol, 255);
1089 for (i = 0;i < SND_LISTENERS;i++)
1090 ch->listener_volume[i] = 0;
1095 // =======================================================================
1096 // Start a sound effect
1097 // =======================================================================
1099 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1101 // Initialize the channel
1102 memset (target_chan, 0, sizeof (*target_chan));
1103 VectorCopy (origin, target_chan->origin);
1104 target_chan->master_vol = (int)(fvol * 255);
1105 target_chan->sfx = sfx;
1106 target_chan->end = snd_renderbuffer->endframe + sfx->total_length;
1107 target_chan->lastptime = snd_renderbuffer->endframe;
1108 target_chan->flags = flags;
1110 // If it's a static sound
1113 if (sfx->loopstart == -1)
1114 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1115 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
1118 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
1120 // Lock the SFX during play
1125 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1127 channel_t *target_chan, *check;
1131 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1134 if (sfx->fetcher == NULL)
1137 if (entnum && entnum >= cl.max_entities)
1138 CL_ExpandEntities(entnum);
1140 // Pick a channel to play on
1141 target_chan = SND_PickChannel(entnum, entchannel);
1145 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1146 target_chan->entnum = entnum;
1147 target_chan->entchannel = entchannel;
1149 SND_Spatialize(target_chan, false);
1151 // if an identical sound has also been started this frame, offset the pos
1152 // a bit to keep it from just making the first one louder
1153 check = &channels[NUM_AMBIENTS];
1154 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1156 if (check == target_chan)
1158 if (check->sfx == sfx && !check->pos)
1160 skip = (int)(0.1 * snd_renderbuffer->format.speed);
1161 if (skip > (int)sfx->total_length)
1162 skip = (int)sfx->total_length;
1164 skip = rand() % skip;
1165 target_chan->pos += skip;
1166 target_chan->end -= skip;
1171 return (target_chan - channels);
1174 void S_StopChannel (unsigned int channel_ind)
1178 if (channel_ind >= total_channels)
1181 ch = &channels[channel_ind];
1182 if (ch->sfx != NULL)
1184 sfx_t *sfx = ch->sfx;
1186 if (sfx->fetcher != NULL)
1188 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1189 if (fetcher_endsb != NULL)
1193 // Remove the lock it holds
1202 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1204 if (ch_ind >= total_channels)
1207 if (flag != CHANNELFLAG_FORCELOOP &&
1208 flag != CHANNELFLAG_PAUSED &&
1209 flag != CHANNELFLAG_FULLVOLUME)
1213 channels[ch_ind].flags |= flag;
1215 channels[ch_ind].flags &= ~flag;
1220 void S_StopSound(int entnum, int entchannel)
1224 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1225 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1232 void S_StopAllSounds (void)
1236 // TOCHECK: is this test necessary?
1237 if (snd_renderbuffer == NULL)
1240 for (i = 0; i < total_channels; i++)
1243 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1244 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1246 // Mute the contents of the submittion buffer
1247 if (simsound || SndSys_LockRenderBuffer ())
1252 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1253 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1254 memset(snd_renderbuffer->ring, clear, memsize);
1257 SndSys_UnlockRenderBuffer ();
1261 void S_PauseGameSounds (qboolean toggle)
1265 for (i = 0; i < total_channels; i++)
1270 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1271 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1275 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1277 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1286 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1288 channel_t *target_chan;
1290 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1294 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1298 if (total_channels == MAX_CHANNELS)
1300 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1304 target_chan = &channels[total_channels++];
1305 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1307 SND_Spatialize (target_chan, true);
1313 S_UpdateAmbientSounds
1316 void S_UpdateAmbientSounds (void)
1320 int ambient_channel;
1322 unsigned char ambientlevels[NUM_AMBIENTS];
1324 memset(ambientlevels, 0, sizeof(ambientlevels));
1325 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1326 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1328 // Calc ambient sound levels
1329 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1331 chan = &channels[ambient_channel];
1332 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1335 vol = (int)ambientlevels[ambient_channel];
1339 // Don't adjust volume too fast
1340 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1341 if (chan->master_vol < vol)
1343 chan->master_vol += (int)(cl.realframetime * ambient_fade.value);
1344 if (chan->master_vol > vol)
1345 chan->master_vol = vol;
1347 else if (chan->master_vol > vol)
1349 chan->master_vol -= (int)(cl.realframetime * ambient_fade.value);
1350 if (chan->master_vol < vol)
1351 chan->master_vol = vol;
1354 for (i = 0;i < SND_LISTENERS;i++)
1355 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1359 static void S_PaintAndSubmit (void)
1361 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1363 if (snd_renderbuffer == NULL || nosound.integer)
1366 if (snd_blocked > 0 && !cls.capturevideo_soundfile)
1369 // Update sound time
1370 if (cls.capturevideo_soundfile) // SUPER NASTY HACK to record non-realtime sound
1371 newsoundtime = (unsigned int)((double)cls.capturevideo_frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo_framerate);
1373 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1375 newsoundtime = SndSys_GetSoundTime();
1377 newsoundtime += extrasoundtime;
1378 if (newsoundtime < soundtime)
1380 if ((cls.capturevideo_soundfile != NULL) != recording_sound)
1382 unsigned int additionaltime;
1384 // add some time to extrasoundtime make newsoundtime higher
1386 // The extra time must be a multiple of the render buffer size
1387 // to avoid modifying the current position in the buffer,
1388 // some modules write directly to a shared (DMA) buffer
1389 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1390 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1392 extrasoundtime += additionaltime;
1393 newsoundtime += additionaltime;
1394 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1398 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1399 newsoundtime, soundtime);
1401 soundtime = newsoundtime;
1402 recording_sound = (cls.capturevideo_soundfile != NULL);
1404 // Check to make sure that we haven't overshot
1405 paintedtime = snd_renderbuffer->endframe;
1406 if (paintedtime < soundtime)
1407 paintedtime = soundtime;
1409 // mix ahead of current position
1410 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1411 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1412 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1413 endtime = min(endtime, maxtime);
1415 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1418 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1427 Called once each time through the main loop
1430 void S_Update(const matrix4x4_t *listenermatrix)
1432 unsigned int i, j, total;
1433 channel_t *ch, *combine;
1434 matrix4x4_t basematrix, rotatematrix;
1436 if (snd_renderbuffer == NULL || nosound.integer)
1439 if (snd_blocked > 0 && !cls.capturevideo_soundfile)
1442 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1443 if (current_swapstereo != snd_swapstereo.integer ||
1444 current_channellayout != snd_channellayout.integer)
1445 S_SetChannelLayout();
1447 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1448 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1450 // calculate the current matrices
1451 for (j = 0;j < SND_LISTENERS;j++)
1453 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1454 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1455 // I think this should now do this:
1456 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1457 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1458 // angle has to be taken negative)
1459 // 2. create a transform which first rotates and moves its argument
1460 // into the player's view coordinates (using basematrix which is
1461 // an inverted "absolute" listener matrix), then applies the
1462 // rotation matrix for the ear
1463 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1464 // does not actually refer to an entity?
1467 // update general area ambient sound sources
1468 S_UpdateAmbientSounds ();
1472 // update spatialization for static and dynamic sounds
1473 ch = channels+NUM_AMBIENTS;
1474 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1479 // respatialize channel
1480 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1482 // try to combine static sounds with a previous channel of the same
1483 // sound effect so we don't mix five torches every frame
1484 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1486 // no need to merge silent channels
1487 for (j = 0;j < SND_LISTENERS;j++)
1488 if (ch->listener_volume[j])
1490 if (j == SND_LISTENERS)
1492 // if the last combine chosen isn't suitable, find a new one
1493 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1497 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1499 if (channels[j].sfx == ch->sfx)
1501 combine = channels + j;
1506 if (combine && combine != ch && combine->sfx == ch->sfx)
1508 for (j = 0;j < SND_LISTENERS;j++)
1510 combine->listener_volume[j] += ch->listener_volume[j];
1511 ch->listener_volume[j] = 0;
1517 sound_spatialized = true;
1520 if (snd_show.integer)
1524 for (i=0 ; i<total_channels; i++, ch++)
1528 for (j = 0;j < SND_LISTENERS;j++)
1529 if (ch->listener_volume[j])
1531 if (j < SND_LISTENERS)
1536 Con_Printf("----(%u)----\n", total);
1542 void S_ExtraUpdate (void)
1544 if (snd_noextraupdate.integer || !sound_spatialized)
1550 qboolean S_LocalSound (const char *sound)
1555 if (!snd_initialized.integer || nosound.integer)
1558 sfx = S_PrecacheSound (sound, true, false);
1561 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1565 // Local sounds must not be freed
1566 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1568 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1572 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;