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 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;
160 static int current_swapstereo = false;
161 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
162 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
164 // Cvars declared in sound.h (part of the sound API)
165 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
166 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
167 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
168 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
170 // Cvars declared in snd_main.h (shared with other snd_*.c files)
171 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
172 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)"};
173 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
174 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
177 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
178 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
179 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
180 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
181 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"};
182 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
184 // Default sound format is 48KHz, 16-bit, stereo
185 // (48KHz because a lot of onboard sound cards sucks at any other speed)
186 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
187 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
188 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)"};
191 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
192 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
195 // ====================================================================
197 // ====================================================================
199 void S_FreeSfx (sfx_t *sfx, qboolean force);
201 static void S_Play_Common (float fvol, float attenuation)
204 char name [MAX_QPATH];
208 while (i < Cmd_Argc ())
210 // Get the name, and appends ".wav" as an extension if there's none
211 strlcpy (name, Cmd_Argv (i), sizeof (name));
212 if (!strrchr (name, '.'))
213 strlcat (name, ".wav", sizeof (name));
216 // If we need to get the volume from the command line
219 fvol = atof (Cmd_Argv (i));
223 sfx = S_PrecacheSound (name, true, false);
226 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
228 // Free the sfx if the file didn't exist
230 S_FreeSfx (sfx, false);
232 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
237 static void S_Play_f(void)
239 S_Play_Common (1.0f, 1.0f);
242 static void S_Play2_f(void)
244 S_Play_Common (1.0f, 0.0f);
247 static void S_PlayVol_f(void)
249 S_Play_Common (-1.0f, 0.0f);
252 static void S_SoundList_f (void)
259 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
261 if (sfx->fetcher != NULL)
264 const snd_format_t* format;
267 format = sfx->fetcher->getfmt(sfx);
268 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
269 (sfx->loopstart >= 0) ? 'L' : ' ',
270 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
271 (sfx->locks > 0) ? 'K' : ' ',
272 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
274 (format->channels == 1) ? "mono" : "stereo",
280 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
282 Con_Printf("Total resident: %i\n", total);
286 void S_SoundInfo_f(void)
288 if (snd_renderbuffer == NULL)
290 Con_Print("sound system not started\n");
294 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
295 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
296 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
297 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
298 Con_Printf("%5u total_channels\n", total_channels);
302 // TODO: make this function smarter...
303 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
305 // Can we decrease the number of channels?
306 if (!fixed_channels && format->channels > 1)
308 unsigned short channels = format->channels;
310 // If it has an odd number of channels(?!), make it even
315 // Remove 2 speakers, unless it's a stereo format
322 format->channels = channels;
326 // Can we decrease the speed?
329 unsigned int suggest_speeds [] = { 44100, 22050, 11025 };
332 for (i = 0; i < sizeof(suggest_speeds) / sizeof(suggest_speeds[0]); i++)
333 if (format->speed > suggest_speeds[i])
335 format->speed = suggest_speeds[i];
339 // the speed is already low
342 // Can we decrease the number of bits per sample?
343 if (!fixed_width && format->width > 1)
353 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
355 static void S_SetChannelLayout (void)
358 listener_t swaplistener;
359 listener_t *listeners;
362 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
363 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
365 if (i >= SND_SPEAKERLAYOUTS)
367 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
368 snd_renderbuffer->format.channels);
369 i = SND_SPEAKERLAYOUTS - 1;
372 snd_speakerlayout = snd_speakerlayouts[i];
373 listeners = snd_speakerlayout.listeners;
375 // Swap the left and right channels if snd_swapstereo is set
376 if (snd_swapstereo.integer)
378 switch (snd_speakerlayout.channels)
381 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
385 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
388 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
399 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
400 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
401 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
403 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
405 // If we're in the sound engine initialization
406 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
408 layout = SND_CHANNELLAYOUT_STANDARD;
409 Cvar_SetValueQuick (&snd_channellayout, layout);
412 layout = current_channellayout_used;
415 layout = snd_channellayout.integer;
417 // Convert our layout (= ALSA) to the standard layout if necessary
418 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
420 if (layout == SND_CHANNELLAYOUT_STANDARD)
422 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
423 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
426 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
427 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
430 current_swapstereo = snd_swapstereo.integer;
431 current_channellayout = snd_channellayout.integer;
432 current_channellayout_used = layout;
436 void S_Startup (void)
438 qboolean fixed_speed, fixed_width, fixed_channels;
439 snd_format_t chosen_fmt;
440 static snd_format_t prev_render_format = {0, 0, 0};
444 if (!snd_initialized.integer)
449 fixed_channels = false;
451 // Get the starting sound format from the cvars
452 chosen_fmt.speed = snd_speed.integer;
453 chosen_fmt.width = snd_width.integer;
454 chosen_fmt.channels = snd_channels.integer;
456 // Check the environment variables to see if the player wants a particular sound format
457 env = getenv("QUAKE_SOUND_CHANNELS");
460 chosen_fmt.channels = atoi (env);
461 fixed_channels = true;
463 env = getenv("QUAKE_SOUND_SPEED");
466 chosen_fmt.speed = atoi (env);
469 env = getenv("QUAKE_SOUND_SAMPLEBITS");
472 chosen_fmt.width = atoi (env) / 8;
476 // Parse the command line to see if the player wants a particular sound format
477 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
478 if (COM_CheckParm ("-sndquad") != 0)
480 chosen_fmt.channels = 4;
481 fixed_channels = true;
483 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
484 else if (COM_CheckParm ("-sndstereo") != 0)
486 chosen_fmt.channels = 2;
487 fixed_channels = true;
489 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
490 else if (COM_CheckParm ("-sndmono") != 0)
492 chosen_fmt.channels = 1;
493 fixed_channels = true;
495 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
496 i = COM_CheckParm ("-sndspeed");
497 if (0 < i && i < com_argc - 1)
499 chosen_fmt.speed = atoi (com_argv[i + 1]);
502 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
503 i = COM_CheckParm ("-sndbits");
504 if (0 < i && i < com_argc - 1)
506 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
510 // You can't change sound speed after start time (not yet supported)
511 if (prev_render_format.speed != 0)
514 if (chosen_fmt.speed != prev_render_format.speed)
516 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
517 prev_render_format.speed);
518 chosen_fmt.speed = prev_render_format.speed;
523 if (chosen_fmt.speed < SND_MIN_SPEED)
525 chosen_fmt.speed = SND_MIN_SPEED;
528 else if (chosen_fmt.speed > SND_MAX_SPEED)
530 chosen_fmt.speed = SND_MAX_SPEED;
534 if (chosen_fmt.width < SND_MIN_WIDTH)
536 chosen_fmt.width = SND_MIN_WIDTH;
539 else if (chosen_fmt.width > SND_MAX_WIDTH)
541 chosen_fmt.width = SND_MAX_WIDTH;
545 if (chosen_fmt.channels < SND_MIN_CHANNELS)
547 chosen_fmt.channels = SND_MIN_CHANNELS;
548 fixed_channels = false;
550 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
552 chosen_fmt.channels = SND_MAX_CHANNELS;
553 fixed_channels = false;
556 // create the sound buffer used for sumitting the samples to the plaform-dependent module
559 snd_format_t suggest_fmt;
565 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
566 chosen_fmt.speed, chosen_fmt.width * 8,
567 chosen_fmt.channels);
569 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
570 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
574 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
576 // If the module is suggesting another one
577 if (suggest_fmt.speed != 0)
579 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
580 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
581 suggest_fmt.speed, suggest_fmt.width * 8,
582 suggest_fmt.channels);
584 // Else, try to find a less resource-demanding format
585 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
590 // If we haven't found a suitable format
593 Con_Print("S_Startup: SndSys_Init failed.\n");
594 sound_spatialized = false;
600 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
601 Con_Print ("S_Startup: simulating sound output\n");
604 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
605 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
606 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
609 snd_speed.integer = chosen_fmt.speed;
610 snd_width.integer = chosen_fmt.width;
611 snd_channels.integer = chosen_fmt.channels;
613 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
614 S_SetChannelLayout();
616 snd_starttime = realtime;
618 // If the sound module has already run, add an extra time to make sure
619 // the sound time doesn't decrease, to not confuse playing SFXs
620 if (oldpaintedtime != 0)
622 // The extra time must be a multiple of the render buffer size
623 // to avoid modifying the current position in the buffer,
624 // some modules write directly to a shared (DMA) buffer
625 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
626 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
627 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
629 soundtime = extrasoundtime;
633 snd_renderbuffer->startframe = soundtime;
634 snd_renderbuffer->endframe = soundtime;
637 void S_Shutdown(void)
639 if (snd_renderbuffer == NULL)
642 oldpaintedtime = snd_renderbuffer->endframe;
646 Mem_Free(snd_renderbuffer->ring);
647 Mem_Free(snd_renderbuffer);
648 snd_renderbuffer = NULL;
653 sound_spatialized = false;
656 void S_Restart_f(void)
669 Con_DPrint("\nSound Initialization\n");
671 Cvar_RegisterVariable(&volume);
672 Cvar_RegisterVariable(&bgmvolume);
673 Cvar_RegisterVariable(&snd_staticvolume);
675 Cvar_RegisterVariable(&snd_speed);
676 Cvar_RegisterVariable(&snd_width);
677 Cvar_RegisterVariable(&snd_channels);
679 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
680 if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
683 snd_mempool = Mem_AllocPool("sound", 0, NULL);
685 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
686 if (COM_CheckParm("-simsound"))
689 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
690 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
691 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
692 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
693 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
694 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
695 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
697 Cvar_RegisterVariable(&nosound);
698 Cvar_RegisterVariable(&snd_precache);
699 Cvar_RegisterVariable(&snd_initialized);
700 Cvar_RegisterVariable(&snd_streaming);
701 Cvar_RegisterVariable(&ambient_level);
702 Cvar_RegisterVariable(&ambient_fade);
703 Cvar_RegisterVariable(&snd_noextraupdate);
704 Cvar_RegisterVariable(&snd_show);
705 Cvar_RegisterVariable(&_snd_mixahead);
706 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
707 Cvar_RegisterVariable(&snd_channellayout);
709 Cvar_SetValueQuick(&snd_initialized, true);
713 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
714 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
724 Shutdown and free all resources
727 void S_Terminate (void)
733 while (known_sfx != NULL)
734 S_FreeSfx (known_sfx, true);
736 Cvar_SetValueQuick (&snd_initialized, false);
737 Mem_FreePool (&snd_mempool);
746 sfx_t *S_FindName (const char *name)
750 if (!snd_initialized.integer)
753 if (strlen (name) >= sizeof (sfx->name))
755 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
759 // Look for this sound in the list of known sfx
760 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
761 if(!strcmp (sfx->name, name))
764 // Add a sfx_t struct for this sound
765 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
766 memset (sfx, 0, sizeof(*sfx));
767 strlcpy (sfx->name, name, sizeof (sfx->name));
768 sfx->memsize = sizeof(*sfx);
769 sfx->next = known_sfx;
781 void S_FreeSfx (sfx_t *sfx, qboolean force)
785 // Never free a locked sfx unless forced
786 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
789 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
791 // Remove it from the list of known sfx
792 if (sfx == known_sfx)
793 known_sfx = known_sfx->next;
798 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
799 if (prev_sfx->next == sfx)
801 prev_sfx->next = sfx->next;
804 if (prev_sfx == NULL)
806 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
811 // Stop all channels using this sfx
812 for (i = 0; i < total_channels; i++)
813 if (channels[i].sfx == sfx)
817 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
818 sfx->fetcher->free (sfx);
828 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
834 // Start the ambient sounds and make them loop
835 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
837 // Precache it if it's not done (request a lock to make sure it will never be freed)
838 if (ambient_sfxs[i] == NULL)
839 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
840 if (ambient_sfxs[i] != NULL)
842 // Add a lock to the SFX while playing. It will be
843 // removed by S_StopAllSounds at the end of the level
844 S_LockSfx (ambient_sfxs[i]);
846 channels[i].sfx = ambient_sfxs[i];
847 channels[i].flags |= CHANNELFLAG_FORCELOOP;
848 channels[i].master_vol = 0;
852 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
853 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
854 if (sfx->flags & SFXFLAG_SERVERSOUND)
857 sfx->flags &= ~SFXFLAG_SERVERSOUND;
860 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
861 for (i = 1; i < numsounds; i++)
863 sfx = S_FindName (serversound[i]);
867 sfx->flags |= SFXFLAG_SERVERSOUND;
871 // Free all unlocked sfx
872 for (sfx = known_sfx;sfx;sfx = sfxnext)
875 S_FreeSfx (sfx, false);
885 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
889 if (!snd_initialized.integer)
892 if (name == NULL || name[0] == 0)
895 sfx = S_FindName (name);
902 if (!nosound.integer && snd_precache.integer)
903 S_LoadSound(sfx, complain);
913 qboolean S_IsSoundPrecached (const sfx_t *sfx)
915 return (sfx != NULL && sfx->fetcher != NULL);
925 void S_LockSfx (sfx_t *sfx)
934 Remove a lock from a SFX
937 void S_UnlockSfx (sfx_t *sfx)
948 void S_BlockSound (void)
959 void S_UnblockSound (void)
969 Picks a channel based on priorities, empty slots, number of channels
972 channel_t *SND_PickChannel(int entnum, int entchannel)
976 int first_life_left, life_left;
979 // Check for replacement sound, or find the best one to replace
981 first_life_left = 0x7fffffff;
982 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
984 ch = &channels[ch_idx];
987 // try to override an existing channel
988 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
990 // always override sound from same entity
991 first_to_die = ch_idx;
999 // no sound on this channel
1000 first_to_die = ch_idx;
1007 // don't let monster sounds override player sounds
1008 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1011 // don't override looped sounds
1012 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart >= 0)
1016 life_left = (int)(ch->end - snd_renderbuffer->endframe);
1017 if (life_left < first_life_left)
1019 first_life_left = life_left;
1020 first_to_die = ch_idx;
1024 if (first_to_die == -1)
1027 S_StopChannel (first_to_die);
1029 return &channels[first_to_die];
1036 Spatializes a channel
1039 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1042 vec_t dist, mastervol, intensity, vol;
1045 // update sound origin if we know about the entity
1046 if (ch->entnum > 0 && cls.state == ca_connected && cl.entities[ch->entnum].state_current.active)
1048 //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]);
1049 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1050 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)
1051 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);
1054 mastervol = ch->master_vol;
1055 // Adjust volume of static sounds
1057 mastervol *= snd_staticvolume.value;
1059 // anything coming from the view entity will always be full volume
1060 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1061 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1063 for (i = 0;i < SND_LISTENERS;i++)
1065 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1066 ch->listener_volume[i] = (int)bound(0, vol, 255);
1071 // calculate stereo seperation and distance attenuation
1072 VectorSubtract(listener_origin, ch->origin, source_vec);
1073 dist = VectorLength(source_vec);
1074 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1077 for (i = 0;i < SND_LISTENERS;i++)
1079 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1080 VectorNormalize(source_vec);
1081 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1082 ch->listener_volume[i] = (int)bound(0, vol, 255);
1086 for (i = 0;i < SND_LISTENERS;i++)
1087 ch->listener_volume[i] = 0;
1092 // =======================================================================
1093 // Start a sound effect
1094 // =======================================================================
1096 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1098 // Initialize the channel
1099 memset (target_chan, 0, sizeof (*target_chan));
1100 VectorCopy (origin, target_chan->origin);
1101 target_chan->master_vol = (int)(fvol * 255);
1102 target_chan->sfx = sfx;
1103 target_chan->end = snd_renderbuffer->endframe + sfx->total_length;
1104 target_chan->lastptime = snd_renderbuffer->endframe;
1105 target_chan->flags = flags;
1107 // If it's a static sound
1110 if (sfx->loopstart == -1)
1111 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1112 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
1115 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
1117 // Lock the SFX during play
1122 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1124 channel_t *target_chan, *check;
1128 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1131 if (sfx->fetcher == NULL)
1134 if (entnum && entnum >= cl.max_entities)
1135 CL_ExpandEntities(entnum);
1137 // Pick a channel to play on
1138 target_chan = SND_PickChannel(entnum, entchannel);
1142 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1143 target_chan->entnum = entnum;
1144 target_chan->entchannel = entchannel;
1146 SND_Spatialize(target_chan, false);
1148 // if an identical sound has also been started this frame, offset the pos
1149 // a bit to keep it from just making the first one louder
1150 check = &channels[NUM_AMBIENTS];
1151 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1153 if (check == target_chan)
1155 if (check->sfx == sfx && !check->pos)
1157 skip = (int)(0.1 * snd_renderbuffer->format.speed);
1158 if (skip > (int)sfx->total_length)
1159 skip = (int)sfx->total_length;
1161 skip = rand() % skip;
1162 target_chan->pos += skip;
1163 target_chan->end -= skip;
1168 return (target_chan - channels);
1171 void S_StopChannel (unsigned int channel_ind)
1175 if (channel_ind >= total_channels)
1178 ch = &channels[channel_ind];
1179 if (ch->sfx != NULL)
1181 sfx_t *sfx = ch->sfx;
1183 if (sfx->fetcher != NULL)
1185 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1186 if (fetcher_endsb != NULL)
1190 // Remove the lock it holds
1199 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1201 if (ch_ind >= total_channels)
1204 if (flag != CHANNELFLAG_FORCELOOP &&
1205 flag != CHANNELFLAG_PAUSED &&
1206 flag != CHANNELFLAG_FULLVOLUME)
1210 channels[ch_ind].flags |= flag;
1212 channels[ch_ind].flags &= ~flag;
1217 void S_StopSound(int entnum, int entchannel)
1221 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1222 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1229 void S_StopAllSounds (void)
1233 // TOCHECK: is this test necessary?
1234 if (snd_renderbuffer == NULL)
1237 for (i = 0; i < total_channels; i++)
1240 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1241 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1243 // Mute the contents of the submittion buffer
1244 if (simsound || SndSys_LockRenderBuffer ())
1249 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1250 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1251 memset(snd_renderbuffer->ring, clear, memsize);
1254 SndSys_UnlockRenderBuffer ();
1258 void S_PauseGameSounds (qboolean toggle)
1262 for (i = 0; i < total_channels; i++)
1267 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1268 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1272 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1274 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1283 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1285 channel_t *target_chan;
1287 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1291 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1295 if (total_channels == MAX_CHANNELS)
1297 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1301 target_chan = &channels[total_channels++];
1302 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1304 SND_Spatialize (target_chan, true);
1310 S_UpdateAmbientSounds
1313 void S_UpdateAmbientSounds (void)
1317 int ambient_channel;
1319 unsigned char ambientlevels[NUM_AMBIENTS];
1321 memset(ambientlevels, 0, sizeof(ambientlevels));
1322 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1323 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1325 // Calc ambient sound levels
1326 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1328 chan = &channels[ambient_channel];
1329 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1332 vol = (int)ambientlevels[ambient_channel];
1336 // Don't adjust volume too fast
1337 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1338 if (chan->master_vol < vol)
1340 chan->master_vol += (int)(cl.realframetime * ambient_fade.value);
1341 if (chan->master_vol > vol)
1342 chan->master_vol = vol;
1344 else if (chan->master_vol > vol)
1346 chan->master_vol -= (int)(cl.realframetime * ambient_fade.value);
1347 if (chan->master_vol < vol)
1348 chan->master_vol = vol;
1351 for (i = 0;i < SND_LISTENERS;i++)
1352 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1356 static void S_PaintAndSubmit (void)
1358 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1360 if (snd_renderbuffer == NULL || nosound.integer)
1363 if (snd_blocked > 0 && !cls.capturevideo_soundfile)
1366 // Update sound time
1367 if (cls.capturevideo_soundfile) // SUPER NASTY HACK to record non-realtime sound
1368 newsoundtime = (unsigned int)((double)cls.capturevideo_frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo_framerate);
1370 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1372 newsoundtime = SndSys_GetSoundTime();
1374 newsoundtime += extrasoundtime;
1375 if (newsoundtime < soundtime)
1376 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1377 newsoundtime, soundtime);
1378 soundtime = newsoundtime;
1380 // Check to make sure that we haven't overshot
1381 paintedtime = snd_renderbuffer->endframe;
1382 if (paintedtime < soundtime)
1383 paintedtime = soundtime;
1385 // mix ahead of current position
1386 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1387 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1388 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1389 endtime = min(endtime, maxtime);
1391 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1394 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1403 Called once each time through the main loop
1406 void S_Update(const matrix4x4_t *listenermatrix)
1408 unsigned int i, j, total;
1409 channel_t *ch, *combine;
1410 matrix4x4_t basematrix, rotatematrix;
1412 if (snd_renderbuffer == NULL || nosound.integer)
1415 if (snd_blocked > 0 && !cls.capturevideo_soundfile)
1418 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1419 if (current_swapstereo != snd_swapstereo.integer ||
1420 current_channellayout != snd_channellayout.integer)
1421 S_SetChannelLayout();
1423 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1424 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1426 // calculate the current matrices
1427 for (j = 0;j < SND_LISTENERS;j++)
1429 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1430 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1431 // I think this should now do this:
1432 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1433 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1434 // angle has to be taken negative)
1435 // 2. create a transform which first rotates and moves its argument
1436 // into the player's view coordinates (using basematrix which is
1437 // an inverted "absolute" listener matrix), then applies the
1438 // rotation matrix for the ear
1439 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1440 // does not actually refer to an entity?
1443 // update general area ambient sound sources
1444 S_UpdateAmbientSounds ();
1448 // update spatialization for static and dynamic sounds
1449 ch = channels+NUM_AMBIENTS;
1450 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1455 // respatialize channel
1456 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1458 // try to combine static sounds with a previous channel of the same
1459 // sound effect so we don't mix five torches every frame
1460 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1462 // no need to merge silent channels
1463 for (j = 0;j < SND_LISTENERS;j++)
1464 if (ch->listener_volume[j])
1466 if (j == SND_LISTENERS)
1468 // if the last combine chosen isn't suitable, find a new one
1469 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1473 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1475 if (channels[j].sfx == ch->sfx)
1477 combine = channels + j;
1482 if (combine && combine != ch && combine->sfx == ch->sfx)
1484 for (j = 0;j < SND_LISTENERS;j++)
1486 combine->listener_volume[j] += ch->listener_volume[j];
1487 ch->listener_volume[j] = 0;
1493 sound_spatialized = true;
1496 if (snd_show.integer)
1500 for (i=0 ; i<total_channels; i++, ch++)
1504 for (j = 0;j < SND_LISTENERS;j++)
1505 if (ch->listener_volume[j])
1507 if (j < SND_LISTENERS)
1512 Con_Printf("----(%u)----\n", total);
1518 void S_ExtraUpdate (void)
1520 if (snd_noextraupdate.integer || !sound_spatialized)
1526 qboolean S_LocalSound (const char *sound)
1531 if (!snd_initialized.integer || nosound.integer)
1534 sfx = S_PrecacheSound (sound, true, false);
1537 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1541 // Local sounds must not be freed
1542 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1544 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1548 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;