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 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
57 static const speakerlayout_t snd_speakerlayouts[] =
62 {45, 0.2, 0.2, 0.5}, // front left
63 {315, 0.2, 0.2, 0.5}, // front right
64 {135, 0.2, 0.2, 0.5}, // rear left
65 {225, 0.2, 0.2, 0.5}, // rear right
66 {0, 0.2, 0.2, 0.5}, // front center
67 {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)
68 {90, 0.2, 0.2, 0.5}, // side left
69 {180, 0.2, 0.2, 0.5}, // side right
75 {45, 0.2, 0.2, 0.5}, // front left
76 {315, 0.2, 0.2, 0.5}, // front right
77 {135, 0.2, 0.2, 0.5}, // rear left
78 {225, 0.2, 0.2, 0.5}, // rear right
79 {0, 0.2, 0.2, 0.5}, // front center
80 {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)
86 // these systems sometimes have a subwoofer as well, but it has no
90 {45, 0.3, 0.3, 0.8}, // front left
91 {315, 0.3, 0.3, 0.8}, // front right
92 {135, 0.3, 0.3, 0.8}, // rear left
93 {225, 0.3, 0.3, 0.8}, // rear right
101 // these systems sometimes have a subwoofer as well, but it has no
102 // channel of its own
105 {90, 0.5, 0.5, 1}, // side left
106 {270, 0.5, 0.5, 1}, // side right
118 {0, 0, 1, 1}, // center
131 // =======================================================================
132 // Internal sound data & structures
133 // =======================================================================
135 channel_t channels[MAX_CHANNELS];
136 unsigned int total_channels;
138 snd_ringbuffer_t *snd_renderbuffer = NULL;
139 unsigned int soundtime = 0;
140 static unsigned int oldpaintedtime = 0;
141 unsigned int extrasoundtime = 0;
142 static double snd_starttime = 0.0;
144 vec3_t listener_origin;
145 matrix4x4_t listener_matrix[SND_LISTENERS];
146 vec_t sound_nominal_clip_dist=1000.0;
147 mempool_t *snd_mempool;
149 // Linked list of known sfx
150 static sfx_t *known_sfx = NULL;
152 static qboolean sound_spatialized = false;
154 qboolean simsound = false;
158 // Cvars declared in sound.h (part of the sound API)
159 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
160 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
161 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
162 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
164 // Cvars declared in snd_main.h (shared with other snd_*.c files)
165 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
166 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)"};
167 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
170 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
171 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
172 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
173 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
174 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"};
175 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
177 // Default sound format is 48KHz, 16-bit, stereo
178 // (48KHz because a lot of onboard sound cards sucks at any other speed)
179 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
180 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
181 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)"};
184 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
185 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
188 // ====================================================================
190 // ====================================================================
192 void S_FreeSfx (sfx_t *sfx, qboolean force);
194 static void S_Play_Common (float fvol, float attenuation)
197 char name [MAX_QPATH];
201 while (i < Cmd_Argc ())
203 // Get the name, and appends ".wav" as an extension if there's none
204 strlcpy (name, Cmd_Argv (i), sizeof (name));
205 if (!strrchr (name, '.'))
206 strlcat (name, ".wav", sizeof (name));
209 // If we need to get the volume from the command line
212 fvol = atof (Cmd_Argv (i));
216 sfx = S_PrecacheSound (name, true, false);
219 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
221 // Free the sfx if the file didn't exist
223 S_FreeSfx (sfx, false);
225 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
230 static void S_Play_f(void)
232 S_Play_Common (1.0f, 1.0f);
235 static void S_Play2_f(void)
237 S_Play_Common (1.0f, 0.0f);
240 static void S_PlayVol_f(void)
242 S_Play_Common (-1.0f, 0.0f);
245 static void S_SoundList_f (void)
252 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
254 if (sfx->fetcher != NULL)
257 const snd_format_t* format;
260 format = sfx->fetcher->getfmt(sfx);
261 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
262 (sfx->loopstart >= 0) ? 'L' : ' ',
263 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
264 (sfx->locks > 0) ? 'K' : ' ',
265 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
267 (format->channels == 1) ? "mono" : "stereo",
273 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
275 Con_Printf("Total resident: %i\n", total);
279 void S_SoundInfo_f(void)
281 if (snd_renderbuffer == NULL)
283 Con_Print("sound system not started\n");
287 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
288 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
289 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
290 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
291 Con_Printf("%5u total_channels\n", total_channels);
295 // TODO: make this function smarter...
296 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
298 // Can we decrease the number of channels?
299 if (!fixed_channels && format->channels > 1)
301 unsigned short channels = format->channels;
303 // If it has an odd number of channels(?!), make it even
308 // Remove 2 speakers, unless it's a stereo format
315 format->channels = channels;
319 // Can we decrease the speed?
322 unsigned int suggest_speeds [] = { 44100, 22050, 11025 };
325 for (i = 0; i < sizeof(suggest_speeds) / sizeof(suggest_speeds[0]); i++)
326 if (format->speed > suggest_speeds[i])
328 format->speed = suggest_speeds[i];
332 // the speed is already low
335 // Can we decrease the number of bits per sample?
336 if (!fixed_width && format->width > 1)
346 void S_Startup (void)
348 qboolean fixed_speed, fixed_width, fixed_channels;
349 snd_format_t chosen_fmt;
350 static snd_format_t prev_render_format = {0, 0, 0};
353 unsigned int layout_id;
355 if (!snd_initialized.integer)
360 fixed_channels = false;
362 // Get the starting sound format from the cvars
363 chosen_fmt.speed = snd_speed.integer;
364 chosen_fmt.width = snd_width.integer;
365 chosen_fmt.channels = snd_channels.integer;
367 // Check the environment variables to see if the player wants a particular sound format
368 env = getenv("QUAKE_SOUND_CHANNELS");
371 chosen_fmt.channels = atoi (env);
372 fixed_channels = true;
374 env = getenv("QUAKE_SOUND_SPEED");
377 chosen_fmt.speed = atoi (env);
380 env = getenv("QUAKE_SOUND_SAMPLEBITS");
383 chosen_fmt.width = atoi (env) / 8;
387 // Parse the command line to see if the player wants a particular sound format
388 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
389 if (COM_CheckParm ("-sndquad") != 0)
391 chosen_fmt.channels = 4;
392 fixed_channels = true;
394 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
395 else if (COM_CheckParm ("-sndstereo") != 0)
397 chosen_fmt.channels = 2;
398 fixed_channels = true;
400 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
401 else if (COM_CheckParm ("-sndmono") != 0)
403 chosen_fmt.channels = 1;
404 fixed_channels = true;
406 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
407 i = COM_CheckParm ("-sndspeed");
408 if (0 < i && i < com_argc - 1)
410 chosen_fmt.speed = atoi (com_argv[i + 1]);
413 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
414 i = COM_CheckParm ("-sndbits");
415 if (0 < i && i < com_argc - 1)
417 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
421 // You can't change sound speed after start time (not yet supported)
422 if (prev_render_format.speed != 0)
425 if (chosen_fmt.speed != prev_render_format.speed)
427 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
428 prev_render_format.speed);
429 chosen_fmt.speed = prev_render_format.speed;
434 if (chosen_fmt.speed < SND_MIN_SPEED)
436 chosen_fmt.speed = SND_MIN_SPEED;
439 else if (chosen_fmt.speed > SND_MAX_SPEED)
441 chosen_fmt.speed = SND_MAX_SPEED;
445 if (chosen_fmt.width < SND_MIN_WIDTH)
447 chosen_fmt.width = SND_MIN_WIDTH;
450 else if (chosen_fmt.width > SND_MAX_WIDTH)
452 chosen_fmt.width = SND_MAX_WIDTH;
456 if (chosen_fmt.channels < SND_MIN_CHANNELS)
458 chosen_fmt.channels = SND_MIN_CHANNELS;
459 fixed_channels = false;
461 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
463 chosen_fmt.channels = SND_MAX_CHANNELS;
464 fixed_channels = false;
467 // create the sound buffer used for sumitting the samples to the plaform-dependent module
470 snd_format_t suggest_fmt;
476 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
477 chosen_fmt.speed, chosen_fmt.width * 8,
478 chosen_fmt.channels);
480 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
481 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
485 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
487 // If the module is suggesting another one
488 if (suggest_fmt.speed != 0)
490 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
491 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
492 suggest_fmt.speed, suggest_fmt.width * 8,
493 suggest_fmt.channels);
495 // Else, try to find a less resource-demanding format
496 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
501 // If we haven't found a suitable format
504 Con_Print("S_Startup: SndSys_Init failed.\n");
505 sound_spatialized = false;
511 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
512 Con_Print ("S_Startup: simulating sound output\n");
515 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
516 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
517 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
520 snd_speed.integer = chosen_fmt.speed;
521 snd_width.integer = chosen_fmt.width;
522 snd_channels.integer = chosen_fmt.channels;
524 snd_starttime = realtime;
526 // If the sound module has already run, add an extra time to make sure
527 // the sound time doesn't decrease, to not confuse playing SFXs
528 if (oldpaintedtime != 0)
530 // The extra time must be a multiple of the render buffer size
531 // to avoid modifying the current position in the buffer,
532 // some modules write directly to a shared (DMA) buffer
533 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
534 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
535 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
537 soundtime = extrasoundtime;
541 snd_renderbuffer->startframe = soundtime;
542 snd_renderbuffer->endframe = soundtime;
544 // select speaker layout
545 for (layout_id = 0; layout_id < SND_SPEAKERLAYOUTS; layout_id++)
546 if (snd_speakerlayouts[layout_id].channels == snd_renderbuffer->format.channels)
548 if (layout_id >= SND_SPEAKERLAYOUTS)
550 Con_Printf("S_Startup: invalid number of channels (%hu). Can't find the corresponding speaker layout.\n"
551 "Defaulting to mono output\n",
552 snd_renderbuffer->format.channels);
553 layout_id = SND_SPEAKERLAYOUTS - 1;
555 snd_speakerlayout = snd_speakerlayouts[layout_id];
558 void S_Shutdown(void)
560 if (snd_renderbuffer == NULL)
563 oldpaintedtime = snd_renderbuffer->endframe;
567 Mem_Free(snd_renderbuffer->ring);
568 Mem_Free(snd_renderbuffer);
569 snd_renderbuffer = NULL;
574 sound_spatialized = false;
577 void S_Restart_f(void)
590 Con_DPrint("\nSound Initialization\n");
592 Cvar_RegisterVariable(&volume);
593 Cvar_RegisterVariable(&bgmvolume);
594 Cvar_RegisterVariable(&snd_staticvolume);
596 Cvar_RegisterVariable(&snd_speed);
597 Cvar_RegisterVariable(&snd_width);
598 Cvar_RegisterVariable(&snd_channels);
600 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
601 if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
604 snd_mempool = Mem_AllocPool("sound", 0, NULL);
606 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
607 if (COM_CheckParm("-simsound"))
610 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
611 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
612 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
613 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
614 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
615 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
616 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
618 Cvar_RegisterVariable(&nosound);
619 Cvar_RegisterVariable(&snd_precache);
620 Cvar_RegisterVariable(&snd_initialized);
621 Cvar_RegisterVariable(&snd_streaming);
622 Cvar_RegisterVariable(&ambient_level);
623 Cvar_RegisterVariable(&ambient_fade);
624 Cvar_RegisterVariable(&snd_noextraupdate);
625 Cvar_RegisterVariable(&snd_show);
626 Cvar_RegisterVariable(&_snd_mixahead);
627 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
629 Cvar_SetValueQuick(&snd_initialized, true);
633 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
634 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
644 Shutdown and free all resources
647 void S_Terminate (void)
653 while (known_sfx != NULL)
654 S_FreeSfx (known_sfx, true);
656 Cvar_SetValueQuick (&snd_initialized, false);
657 Mem_FreePool (&snd_mempool);
666 sfx_t *S_FindName (const char *name)
670 if (!snd_initialized.integer)
673 if (strlen (name) >= sizeof (sfx->name))
675 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
679 // Look for this sound in the list of known sfx
680 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
681 if(!strcmp (sfx->name, name))
684 // Add a sfx_t struct for this sound
685 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
686 memset (sfx, 0, sizeof(*sfx));
687 strlcpy (sfx->name, name, sizeof (sfx->name));
688 sfx->memsize = sizeof(*sfx);
689 sfx->next = known_sfx;
701 void S_FreeSfx (sfx_t *sfx, qboolean force)
705 // Never free a locked sfx unless forced
706 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
709 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
711 // Remove it from the list of known sfx
712 if (sfx == known_sfx)
713 known_sfx = known_sfx->next;
718 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
719 if (prev_sfx->next == sfx)
721 prev_sfx->next = sfx->next;
724 if (prev_sfx == NULL)
726 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
731 // Stop all channels using this sfx
732 for (i = 0; i < total_channels; i++)
733 if (channels[i].sfx == sfx)
737 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
738 sfx->fetcher->free (sfx);
748 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
754 // Start the ambient sounds and make them loop
755 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
757 // Precache it if it's not done (request a lock to make sure it will never be freed)
758 if (ambient_sfxs[i] == NULL)
759 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
760 if (ambient_sfxs[i] != NULL)
762 // Add a lock to the SFX while playing. It will be
763 // removed by S_StopAllSounds at the end of the level
764 S_LockSfx (ambient_sfxs[i]);
766 channels[i].sfx = ambient_sfxs[i];
767 channels[i].flags |= CHANNELFLAG_FORCELOOP;
768 channels[i].master_vol = 0;
772 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
773 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
774 if (sfx->flags & SFXFLAG_SERVERSOUND)
777 sfx->flags &= ~SFXFLAG_SERVERSOUND;
780 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
781 for (i = 1; i < numsounds; i++)
783 sfx = S_FindName (serversound[i]);
787 sfx->flags |= SFXFLAG_SERVERSOUND;
791 // Free all unlocked sfx
792 for (sfx = known_sfx;sfx;sfx = sfxnext)
795 S_FreeSfx (sfx, false);
805 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
809 if (!snd_initialized.integer)
812 if (name == NULL || name[0] == 0)
815 sfx = S_FindName (name);
822 if (!nosound.integer && snd_precache.integer)
823 S_LoadSound(sfx, complain);
833 qboolean S_IsSoundPrecached (const sfx_t *sfx)
835 return (sfx != NULL && sfx->fetcher != NULL);
845 void S_LockSfx (sfx_t *sfx)
854 Remove a lock from a SFX
857 void S_UnlockSfx (sfx_t *sfx)
868 void S_BlockSound (void)
879 void S_UnblockSound (void)
889 Picks a channel based on priorities, empty slots, number of channels
892 channel_t *SND_PickChannel(int entnum, int entchannel)
896 int first_life_left, life_left;
899 // Check for replacement sound, or find the best one to replace
901 first_life_left = 0x7fffffff;
902 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
904 ch = &channels[ch_idx];
907 // try to override an existing channel
908 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
910 // always override sound from same entity
911 first_to_die = ch_idx;
919 // no sound on this channel
920 first_to_die = ch_idx;
927 // don't let monster sounds override player sounds
928 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
931 // don't override looped sounds
932 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart >= 0)
936 life_left = (int)(ch->end - snd_renderbuffer->endframe);
937 if (life_left < first_life_left)
939 first_life_left = life_left;
940 first_to_die = ch_idx;
944 if (first_to_die == -1)
947 S_StopChannel (first_to_die);
949 return &channels[first_to_die];
956 Spatializes a channel
959 void SND_Spatialize(channel_t *ch, qboolean isstatic)
962 vec_t dist, mastervol, intensity, vol;
965 // update sound origin if we know about the entity
966 if (ch->entnum > 0 && cls.state == ca_connected && cl.entities[ch->entnum].state_current.active)
968 //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]);
969 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
970 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)
971 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);
974 mastervol = ch->master_vol;
975 // Adjust volume of static sounds
977 mastervol *= snd_staticvolume.value;
979 // anything coming from the view entity will always be full volume
980 // LordHavoc: make sounds with ATTN_NONE have no spatialization
981 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
983 for (i = 0;i < SND_LISTENERS;i++)
985 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
986 ch->listener_volume[i] = (int)bound(0, vol, 255);
991 // calculate stereo seperation and distance attenuation
992 VectorSubtract(listener_origin, ch->origin, source_vec);
993 dist = VectorLength(source_vec);
994 intensity = mastervol * (1.0 - dist * ch->dist_mult);
997 for (i = 0;i < SND_LISTENERS;i++)
999 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1000 VectorNormalize(source_vec);
1001 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1002 ch->listener_volume[i] = (int)bound(0, vol, 255);
1006 for (i = 0;i < SND_LISTENERS;i++)
1007 ch->listener_volume[i] = 0;
1012 // =======================================================================
1013 // Start a sound effect
1014 // =======================================================================
1016 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1018 // Initialize the channel
1019 memset (target_chan, 0, sizeof (*target_chan));
1020 VectorCopy (origin, target_chan->origin);
1021 target_chan->master_vol = (int)(fvol * 255);
1022 target_chan->sfx = sfx;
1023 target_chan->end = snd_renderbuffer->endframe + sfx->total_length;
1024 target_chan->lastptime = snd_renderbuffer->endframe;
1025 target_chan->flags = flags;
1027 // If it's a static sound
1030 if (sfx->loopstart == -1)
1031 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1032 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
1035 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
1037 // Lock the SFX during play
1042 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1044 channel_t *target_chan, *check;
1048 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1052 Con_DPrintf ("S_StartSound: \"%s\" hasn't been precached\n", sfx->name);
1056 if (entnum && entnum >= cl.max_entities)
1057 CL_ExpandEntities(entnum);
1059 // Pick a channel to play on
1060 target_chan = SND_PickChannel(entnum, entchannel);
1064 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1065 target_chan->entnum = entnum;
1066 target_chan->entchannel = entchannel;
1068 SND_Spatialize(target_chan, false);
1070 // if an identical sound has also been started this frame, offset the pos
1071 // a bit to keep it from just making the first one louder
1072 check = &channels[NUM_AMBIENTS];
1073 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1075 if (check == target_chan)
1077 if (check->sfx == sfx && !check->pos)
1079 skip = (int)(0.1 * snd_renderbuffer->format.speed);
1080 if (skip > (int)sfx->total_length)
1081 skip = (int)sfx->total_length;
1083 skip = rand() % skip;
1084 target_chan->pos += skip;
1085 target_chan->end -= skip;
1090 return (target_chan - channels);
1093 void S_StopChannel (unsigned int channel_ind)
1097 if (channel_ind >= total_channels)
1100 ch = &channels[channel_ind];
1101 if (ch->sfx != NULL)
1103 sfx_t *sfx = ch->sfx;
1105 if (sfx->fetcher != NULL)
1107 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1108 if (fetcher_endsb != NULL)
1112 // Remove the lock it holds
1121 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1123 if (ch_ind >= total_channels)
1126 if (flag != CHANNELFLAG_FORCELOOP &&
1127 flag != CHANNELFLAG_PAUSED &&
1128 flag != CHANNELFLAG_FULLVOLUME)
1132 channels[ch_ind].flags |= flag;
1134 channels[ch_ind].flags &= ~flag;
1139 void S_StopSound(int entnum, int entchannel)
1143 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1144 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1151 void S_StopAllSounds (void)
1155 // TOCHECK: is this test necessary?
1156 if (snd_renderbuffer == NULL)
1159 for (i = 0; i < total_channels; i++)
1162 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1163 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1165 // Mute the contents of the submittion buffer
1166 if (simsound || SndSys_LockRenderBuffer ())
1171 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1172 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1173 memset(snd_renderbuffer->ring, clear, memsize);
1176 SndSys_UnlockRenderBuffer ();
1180 void S_PauseGameSounds (qboolean toggle)
1184 for (i = 0; i < total_channels; i++)
1189 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1190 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1194 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1196 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1205 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1207 channel_t *target_chan;
1209 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1213 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1217 if (total_channels == MAX_CHANNELS)
1219 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1223 target_chan = &channels[total_channels++];
1224 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1226 SND_Spatialize (target_chan, true);
1232 S_UpdateAmbientSounds
1235 void S_UpdateAmbientSounds (void)
1239 int ambient_channel;
1241 unsigned char ambientlevels[NUM_AMBIENTS];
1243 memset(ambientlevels, 0, sizeof(ambientlevels));
1244 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1245 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1247 // Calc ambient sound levels
1248 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1250 chan = &channels[ambient_channel];
1251 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1254 vol = (int)ambientlevels[ambient_channel];
1258 // Don't adjust volume too fast
1259 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1260 if (chan->master_vol < vol)
1262 chan->master_vol += (int)(cl.realframetime * ambient_fade.value);
1263 if (chan->master_vol > vol)
1264 chan->master_vol = vol;
1266 else if (chan->master_vol > vol)
1268 chan->master_vol -= (int)(cl.realframetime * ambient_fade.value);
1269 if (chan->master_vol < vol)
1270 chan->master_vol = vol;
1273 for (i = 0;i < SND_LISTENERS;i++)
1274 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1278 static void S_PaintAndSubmit (void)
1280 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1282 if (snd_renderbuffer == NULL || snd_blocked > 0)
1285 // Update sound time
1286 if (cls.capturevideo_soundfile) // SUPER NASTY HACK to record non-realtime sound
1287 newsoundtime = (unsigned int)((double)cls.capturevideo_frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo_framerate);
1289 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1291 newsoundtime = SndSys_GetSoundTime();
1293 newsoundtime += extrasoundtime;
1294 if (newsoundtime < soundtime)
1295 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1296 newsoundtime, soundtime);
1297 soundtime = newsoundtime;
1299 // Check to make sure that we haven't overshot
1300 paintedtime = snd_renderbuffer->endframe;
1301 if (paintedtime < soundtime)
1302 paintedtime = soundtime;
1304 // mix ahead of current position
1305 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1306 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1307 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1308 endtime = min(endtime, maxtime);
1310 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1313 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1322 Called once each time through the main loop
1325 void S_Update(const matrix4x4_t *listenermatrix)
1327 unsigned int i, j, total;
1328 channel_t *ch, *combine;
1329 matrix4x4_t basematrix, rotatematrix;
1331 if (!snd_initialized.integer || snd_blocked > 0 || snd_renderbuffer == NULL)
1334 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1335 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1337 // calculate the current matrices
1338 for (j = 0;j < SND_LISTENERS;j++)
1340 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1341 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1342 // I think this should now do this:
1343 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1344 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1345 // angle has to be taken negative)
1346 // 2. create a transform which first rotates and moves its argument
1347 // into the player's view coordinates (using basematrix which is
1348 // an inverted "absolute" listener matrix), then applies the
1349 // rotation matrix for the ear
1350 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1351 // does not actually refer to an entity?
1354 // update general area ambient sound sources
1355 S_UpdateAmbientSounds ();
1359 // update spatialization for static and dynamic sounds
1360 ch = channels+NUM_AMBIENTS;
1361 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1366 // respatialize channel
1367 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1369 // try to combine static sounds with a previous channel of the same
1370 // sound effect so we don't mix five torches every frame
1371 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1373 // no need to merge silent channels
1374 for (j = 0;j < SND_LISTENERS;j++)
1375 if (ch->listener_volume[j])
1377 if (j == SND_LISTENERS)
1379 // if the last combine chosen isn't suitable, find a new one
1380 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1384 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1386 if (channels[j].sfx == ch->sfx)
1388 combine = channels + j;
1393 if (combine && combine != ch && combine->sfx == ch->sfx)
1395 for (j = 0;j < SND_LISTENERS;j++)
1397 combine->listener_volume[j] += ch->listener_volume[j];
1398 ch->listener_volume[j] = 0;
1404 sound_spatialized = true;
1407 if (snd_show.integer)
1411 for (i=0 ; i<total_channels; i++, ch++)
1415 for (j = 0;j < SND_LISTENERS;j++)
1416 if (ch->listener_volume[j])
1418 if (j < SND_LISTENERS)
1423 Con_Printf("----(%u)----\n", total);
1429 void S_ExtraUpdate (void)
1431 if (snd_noextraupdate.integer || !sound_spatialized)
1437 qboolean S_LocalSound (const char *sound)
1442 if (!snd_initialized.integer || nosound.integer)
1445 sfx = S_PrecacheSound (sound, true, false);
1448 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1452 // Local sounds must not be freed
1453 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1455 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1459 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;