2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
26 #include "snd_modplug.h"
29 #define SND_MIN_SPEED 8000
30 #define SND_MAX_SPEED 96000
31 #define SND_MIN_WIDTH 1
32 #define SND_MAX_WIDTH 2
33 #define SND_MIN_CHANNELS 1
34 #define SND_MAX_CHANNELS 8
36 #if SND_LISTENERS != 8
37 # error this data only supports up to 8 channel, update it!
39 typedef struct listener_s
47 typedef struct speakerlayout_s
50 unsigned int channels;
51 listener_t listeners[SND_LISTENERS];
55 static speakerlayout_t snd_speakerlayout;
57 // Our speaker layouts are based on ALSA. They differ from those
58 // Win32 and Mac OS X APIs use when there's more than 4 channels.
59 // (rear left + rear right, and front center + LFE are swapped).
60 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
61 static const speakerlayout_t snd_speakerlayouts[] =
66 {45, 0.2, 0.2, 0.5}, // front left
67 {315, 0.2, 0.2, 0.5}, // front right
68 {135, 0.2, 0.2, 0.5}, // rear left
69 {225, 0.2, 0.2, 0.5}, // rear right
70 {0, 0.2, 0.2, 0.5}, // front center
71 {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)
72 {90, 0.2, 0.2, 0.5}, // side left
73 {180, 0.2, 0.2, 0.5}, // side right
79 {45, 0.2, 0.2, 0.5}, // front left
80 {315, 0.2, 0.2, 0.5}, // front right
81 {135, 0.2, 0.2, 0.5}, // rear left
82 {225, 0.2, 0.2, 0.5}, // rear right
83 {0, 0.2, 0.2, 0.5}, // front center
84 {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)
90 // these systems sometimes have a subwoofer as well, but it has no
94 {45, 0.3, 0.3, 0.8}, // front left
95 {315, 0.3, 0.3, 0.8}, // front right
96 {135, 0.3, 0.3, 0.8}, // rear left
97 {225, 0.3, 0.3, 0.8}, // rear right
105 // these systems sometimes have a subwoofer as well, but it has no
106 // channel of its own
109 {90, 0.5, 0.5, 1}, // side left
110 {270, 0.5, 0.5, 1}, // side right
122 {0, 0, 1, 1}, // center
135 // =======================================================================
136 // Internal sound data & structures
137 // =======================================================================
139 channel_t channels[MAX_CHANNELS];
140 unsigned int total_channels;
142 snd_ringbuffer_t *snd_renderbuffer = NULL;
143 unsigned int soundtime = 0;
144 static unsigned int oldpaintedtime = 0;
145 static unsigned int extrasoundtime = 0;
146 static double snd_starttime = 0.0;
148 vec3_t listener_origin;
149 matrix4x4_t listener_matrix[SND_LISTENERS];
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)"};
171 cvar_t snd_soundradius = {0, "snd_soundradius", "2000", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
173 // Cvars declared in snd_main.h (shared with other snd_*.c files)
174 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
175 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)"};
176 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
177 extern cvar_t v_flipped;
178 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 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
182 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
183 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
184 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
185 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
186 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"};
187 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
189 // Default sound format is 48KHz, 16-bit, stereo
190 // (48KHz because a lot of onboard sound cards sucks at any other speed)
191 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
192 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
193 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)"};
196 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
197 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
200 // ====================================================================
202 // ====================================================================
204 void S_FreeSfx (sfx_t *sfx, qboolean force);
206 static void S_Play_Common (float fvol, float attenuation)
209 char name [MAX_QPATH];
213 while (i < Cmd_Argc ())
215 // Get the name, and appends ".wav" as an extension if there's none
216 strlcpy (name, Cmd_Argv (i), sizeof (name));
217 if (!strrchr (name, '.'))
218 strlcat (name, ".wav", sizeof (name));
221 // If we need to get the volume from the command line
224 fvol = atof (Cmd_Argv (i));
228 sfx = S_PrecacheSound (name, true, false);
231 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
233 // Free the sfx if the file didn't exist
235 S_FreeSfx (sfx, false);
237 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
242 static void S_Play_f(void)
244 S_Play_Common (1.0f, 1.0f);
247 static void S_Play2_f(void)
249 S_Play_Common (1.0f, 0.0f);
252 static void S_PlayVol_f(void)
254 S_Play_Common (-1.0f, 0.0f);
257 static void S_SoundList_f (void)
264 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
266 if (sfx->fetcher != NULL)
269 const snd_format_t* format;
272 format = sfx->fetcher->getfmt(sfx);
273 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
274 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
275 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
276 (sfx->locks > 0) ? 'K' : ' ',
277 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
279 (format->channels == 1) ? "mono" : "stereo",
285 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
287 Con_Printf("Total resident: %i\n", total);
291 void S_SoundInfo_f(void)
293 if (snd_renderbuffer == NULL)
295 Con_Print("sound system not started\n");
299 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
300 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
301 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
302 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
303 Con_Printf("%5u total_channels\n", total_channels);
307 int S_GetSoundRate(void)
309 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
313 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
315 static const snd_format_t thresholds [] =
317 // speed width channels
318 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
324 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
326 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
327 unsigned int speed_level, width_level, channels_level;
329 // If we have reached the minimum values, there's nothing more we can do
330 if ((format->speed == thresholds[0].speed || fixed_speed) &&
331 (format->width == thresholds[0].width || fixed_width) &&
332 (format->channels == thresholds[0].channels || fixed_channels))
335 // Check the min and max values
336 #define CHECK_BOUNDARIES(param) \
337 if (format->param < thresholds[0].param) \
339 format->param = thresholds[0].param; \
342 if (format->param > thresholds[nb_thresholds - 1].param) \
344 format->param = thresholds[nb_thresholds - 1].param; \
347 CHECK_BOUNDARIES(speed);
348 CHECK_BOUNDARIES(width);
349 CHECK_BOUNDARIES(channels);
350 #undef CHECK_BOUNDARIES
352 // Find the level of each parameter
353 #define FIND_LEVEL(param) \
355 while (param##_level < nb_thresholds - 1) \
357 if (format->param <= thresholds[param##_level].param) \
364 FIND_LEVEL(channels);
367 // Decrease the parameter with the highest level to the previous level
368 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
370 format->channels = thresholds[channels_level - 1].channels;
373 if (speed_level >= width_level && !fixed_speed)
375 format->speed = thresholds[speed_level - 1].speed;
379 format->width = thresholds[width_level - 1].width;
384 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
386 static void S_SetChannelLayout (void)
389 listener_t swaplistener;
390 listener_t *listeners;
393 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
394 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
396 if (i >= SND_SPEAKERLAYOUTS)
398 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
399 snd_renderbuffer->format.channels);
400 i = SND_SPEAKERLAYOUTS - 1;
403 snd_speakerlayout = snd_speakerlayouts[i];
404 listeners = snd_speakerlayout.listeners;
406 // Swap the left and right channels if snd_swapstereo is set
407 if (boolxor(snd_swapstereo.integer, v_flipped.integer))
409 switch (snd_speakerlayout.channels)
412 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
416 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
419 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
430 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
431 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
432 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
434 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
436 // If we're in the sound engine initialization
437 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
439 layout = SND_CHANNELLAYOUT_STANDARD;
440 Cvar_SetValueQuick (&snd_channellayout, layout);
443 layout = current_channellayout_used;
446 layout = snd_channellayout.integer;
448 // Convert our layout (= ALSA) to the standard layout if necessary
449 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
451 if (layout == SND_CHANNELLAYOUT_STANDARD)
453 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
454 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
457 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
458 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
461 current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
462 current_channellayout = snd_channellayout.integer;
463 current_channellayout_used = layout;
467 void S_Startup (void)
469 qboolean fixed_speed, fixed_width, fixed_channels;
470 snd_format_t chosen_fmt;
471 static snd_format_t prev_render_format = {0, 0, 0};
475 if (!snd_initialized.integer)
480 fixed_channels = false;
482 // Get the starting sound format from the cvars
483 chosen_fmt.speed = snd_speed.integer;
484 chosen_fmt.width = snd_width.integer;
485 chosen_fmt.channels = snd_channels.integer;
487 // Check the environment variables to see if the player wants a particular sound format
488 env = getenv("QUAKE_SOUND_CHANNELS");
491 chosen_fmt.channels = atoi (env);
492 fixed_channels = true;
494 env = getenv("QUAKE_SOUND_SPEED");
497 chosen_fmt.speed = atoi (env);
500 env = getenv("QUAKE_SOUND_SAMPLEBITS");
503 chosen_fmt.width = atoi (env) / 8;
507 // Parse the command line to see if the player wants a particular sound format
508 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
509 if (COM_CheckParm ("-sndquad") != 0)
511 chosen_fmt.channels = 4;
512 fixed_channels = true;
514 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
515 else if (COM_CheckParm ("-sndstereo") != 0)
517 chosen_fmt.channels = 2;
518 fixed_channels = true;
520 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
521 else if (COM_CheckParm ("-sndmono") != 0)
523 chosen_fmt.channels = 1;
524 fixed_channels = true;
526 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
527 i = COM_CheckParm ("-sndspeed");
528 if (0 < i && i < com_argc - 1)
530 chosen_fmt.speed = atoi (com_argv[i + 1]);
533 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
534 i = COM_CheckParm ("-sndbits");
535 if (0 < i && i < com_argc - 1)
537 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
541 // You can't change sound speed after start time (not yet supported)
542 if (prev_render_format.speed != 0)
545 if (chosen_fmt.speed != prev_render_format.speed)
547 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
548 prev_render_format.speed);
549 chosen_fmt.speed = prev_render_format.speed;
554 if (chosen_fmt.speed < SND_MIN_SPEED)
556 chosen_fmt.speed = SND_MIN_SPEED;
559 else if (chosen_fmt.speed > SND_MAX_SPEED)
561 chosen_fmt.speed = SND_MAX_SPEED;
565 if (chosen_fmt.width < SND_MIN_WIDTH)
567 chosen_fmt.width = SND_MIN_WIDTH;
570 else if (chosen_fmt.width > SND_MAX_WIDTH)
572 chosen_fmt.width = SND_MAX_WIDTH;
576 if (chosen_fmt.channels < SND_MIN_CHANNELS)
578 chosen_fmt.channels = SND_MIN_CHANNELS;
579 fixed_channels = false;
581 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
583 chosen_fmt.channels = SND_MAX_CHANNELS;
584 fixed_channels = false;
587 // create the sound buffer used for sumitting the samples to the plaform-dependent module
590 snd_format_t suggest_fmt;
596 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
597 chosen_fmt.speed, chosen_fmt.width * 8,
598 chosen_fmt.channels);
600 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
601 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
605 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
607 // If the module is suggesting another one
608 if (suggest_fmt.speed != 0)
610 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
611 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
612 suggest_fmt.speed, suggest_fmt.width * 8,
613 suggest_fmt.channels);
615 // Else, try to find a less resource-demanding format
616 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
621 // If we haven't found a suitable format
624 Con_Print("S_Startup: SndSys_Init failed.\n");
625 sound_spatialized = false;
631 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
632 Con_Print ("S_Startup: simulating sound output\n");
635 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
636 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
637 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
640 if (snd_speed.integer != (int)chosen_fmt.speed)
641 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
642 if (snd_width.integer != chosen_fmt.width)
643 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
644 if (snd_channels.integer != chosen_fmt.channels)
645 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
647 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
648 S_SetChannelLayout();
650 snd_starttime = realtime;
652 // If the sound module has already run, add an extra time to make sure
653 // the sound time doesn't decrease, to not confuse playing SFXs
654 if (oldpaintedtime != 0)
656 // The extra time must be a multiple of the render buffer size
657 // to avoid modifying the current position in the buffer,
658 // some modules write directly to a shared (DMA) buffer
659 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
660 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
661 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
663 soundtime = extrasoundtime;
667 snd_renderbuffer->startframe = soundtime;
668 snd_renderbuffer->endframe = soundtime;
669 recording_sound = false;
672 void S_Shutdown(void)
674 if (snd_renderbuffer == NULL)
677 oldpaintedtime = snd_renderbuffer->endframe;
681 Mem_Free(snd_renderbuffer->ring);
682 Mem_Free(snd_renderbuffer);
683 snd_renderbuffer = NULL;
688 sound_spatialized = false;
691 void S_Restart_f(void)
693 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
694 // So, refuse to do this if we are connected.
695 if(cls.state == ca_connected)
697 Con_Printf("snd_restart would wreak havoc if you do that while connected!\n");
712 Con_DPrint("\nSound Initialization\n");
714 Cvar_RegisterVariable(&volume);
715 Cvar_RegisterVariable(&bgmvolume);
716 Cvar_RegisterVariable(&snd_staticvolume);
718 Cvar_RegisterVariable(&snd_speed);
719 Cvar_RegisterVariable(&snd_width);
720 Cvar_RegisterVariable(&snd_channels);
721 Cvar_RegisterVariable(&snd_mutewhenidle);
723 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
724 if (COM_CheckParm("-nosound"))
726 // dummy out Play and Play2 because mods stuffcmd that
727 Cmd_AddCommand("play", Host_NoOperation_f, "does nothing because -nosound was specified");
728 Cmd_AddCommand("play2", Host_NoOperation_f, "does nothing because -nosound was specified");
732 snd_mempool = Mem_AllocPool("sound", 0, NULL);
734 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
735 if (COM_CheckParm("-simsound"))
738 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
739 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
740 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
741 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
742 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
743 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
744 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
745 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
747 Cvar_RegisterVariable(&nosound);
748 Cvar_RegisterVariable(&snd_precache);
749 Cvar_RegisterVariable(&snd_initialized);
750 Cvar_RegisterVariable(&snd_streaming);
751 Cvar_RegisterVariable(&ambient_level);
752 Cvar_RegisterVariable(&ambient_fade);
753 Cvar_RegisterVariable(&snd_noextraupdate);
754 Cvar_RegisterVariable(&snd_show);
755 Cvar_RegisterVariable(&_snd_mixahead);
756 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
757 Cvar_RegisterVariable(&snd_channellayout);
758 Cvar_RegisterVariable(&snd_soundradius);
760 Cvar_SetValueQuick(&snd_initialized, true);
764 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
765 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
768 ModPlug_OpenLibrary ();
776 Shutdown and free all resources
779 void S_Terminate (void)
782 ModPlug_CloseLibrary ();
786 while (known_sfx != NULL)
787 S_FreeSfx (known_sfx, true);
789 Cvar_SetValueQuick (&snd_initialized, false);
790 Mem_FreePool (&snd_mempool);
799 void S_UnloadAllSounds_f (void)
803 // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
804 // So, refuse to do this if we are connected.
805 if(cls.state == ca_connected)
807 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
811 // stop any active sounds
814 // because the ambient sounds will be freed, clear the pointers
815 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
816 ambient_sfxs[i] = NULL;
818 // now free all sounds
819 while (known_sfx != NULL)
820 S_FreeSfx (known_sfx, true);
829 sfx_t *S_FindName (const char *name)
833 if (!snd_initialized.integer)
836 if (strlen (name) >= sizeof (sfx->name))
838 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
842 // Look for this sound in the list of known sfx
843 // TODO: hash table search?
844 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
845 if(!strcmp (sfx->name, name))
848 // Add a sfx_t struct for this sound
849 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
850 memset (sfx, 0, sizeof(*sfx));
851 strlcpy (sfx->name, name, sizeof (sfx->name));
852 sfx->memsize = sizeof(*sfx);
853 sfx->next = known_sfx;
865 void S_FreeSfx (sfx_t *sfx, qboolean force)
869 // Never free a locked sfx unless forced
870 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
873 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
875 // Remove it from the list of known sfx
876 if (sfx == known_sfx)
877 known_sfx = known_sfx->next;
882 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
883 if (prev_sfx->next == sfx)
885 prev_sfx->next = sfx->next;
888 if (prev_sfx == NULL)
890 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
895 // Stop all channels using this sfx
896 for (i = 0; i < total_channels; i++)
897 if (channels[i].sfx == sfx)
901 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
902 sfx->fetcher->free (sfx->fetcher_data);
912 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
918 // Start the ambient sounds and make them loop
919 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
921 // Precache it if it's not done (request a lock to make sure it will never be freed)
922 if (ambient_sfxs[i] == NULL)
923 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
924 if (ambient_sfxs[i] != NULL)
926 // Add a lock to the SFX while playing. It will be
927 // removed by S_StopAllSounds at the end of the level
928 S_LockSfx (ambient_sfxs[i]);
930 channels[i].sfx = ambient_sfxs[i];
931 channels[i].flags |= CHANNELFLAG_FORCELOOP;
932 channels[i].master_vol = 0;
936 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
937 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
938 if (sfx->flags & SFXFLAG_SERVERSOUND)
941 sfx->flags &= ~SFXFLAG_SERVERSOUND;
944 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
945 for (i = 1; i < numsounds; i++)
947 sfx = S_FindName (serversound[i]);
950 // clear the FILEMISSING flag so that S_LoadSound will try again on a
951 // previously missing file
952 sfx->flags &= ~ SFXFLAG_FILEMISSING;
954 sfx->flags |= SFXFLAG_SERVERSOUND;
958 // Free all unlocked sfx
959 for (sfx = known_sfx;sfx;sfx = sfxnext)
962 S_FreeSfx (sfx, false);
972 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
976 if (!snd_initialized.integer)
979 if (name == NULL || name[0] == 0)
982 sfx = S_FindName (name);
987 // clear the FILEMISSING flag so that S_LoadSound will try again on a
988 // previously missing file
989 sfx->flags &= ~ SFXFLAG_FILEMISSING;
994 if (!nosound.integer && snd_precache.integer)
995 S_LoadSound(sfx, complain);
1005 qboolean S_IsSoundPrecached (const sfx_t *sfx)
1007 return (sfx != NULL && sfx->fetcher != NULL);
1017 void S_LockSfx (sfx_t *sfx)
1026 Remove a lock from a SFX
1029 void S_UnlockSfx (sfx_t *sfx)
1040 void S_BlockSound (void)
1051 void S_UnblockSound (void)
1061 Picks a channel based on priorities, empty slots, number of channels
1064 channel_t *SND_PickChannel(int entnum, int entchannel)
1068 int first_life_left, life_left;
1071 // Check for replacement sound, or find the best one to replace
1073 first_life_left = 0x7fffffff;
1075 // entity channels try to replace the existing sound on the channel
1076 if (entchannel != 0)
1078 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1080 ch = &channels[ch_idx];
1081 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1083 // always override sound from same entity
1084 S_StopChannel (ch_idx);
1085 return &channels[ch_idx];
1090 // there was no channel to override, so look for the first empty one
1091 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1093 ch = &channels[ch_idx];
1096 // no sound on this channel
1097 first_to_die = ch_idx;
1101 // don't let monster sounds override player sounds
1102 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1105 // don't override looped sounds
1106 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1108 life_left = ch->sfx->total_length - ch->pos;
1110 if (life_left < first_life_left)
1112 first_life_left = life_left;
1113 first_to_die = ch_idx;
1117 if (first_to_die == -1)
1120 return &channels[first_to_die];
1127 Spatializes a channel
1130 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1131 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1134 vec_t dist, mastervol, intensity, vol;
1137 // update sound origin if we know about the entity
1138 if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1140 if (ch->entnum >= 32768)
1142 // TODO: sounds that follow CSQC entities?
1144 else if (cl.entities[ch->entnum].state_current.active)
1146 //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]);
1147 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1148 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)
1149 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);
1153 mastervol = ch->master_vol;
1154 // Adjust volume of static sounds
1156 mastervol *= snd_staticvolume.value;
1158 // anything coming from the view entity will always be full volume
1159 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1160 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1162 for (i = 0;i < SND_LISTENERS;i++)
1164 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1165 ch->listener_volume[i] = (int)bound(0, vol, 255);
1170 // calculate stereo seperation and distance attenuation
1171 VectorSubtract(listener_origin, ch->origin, source_vec);
1172 dist = VectorLength(source_vec);
1173 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1176 for (i = 0;i < SND_LISTENERS;i++)
1178 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1179 VectorNormalize(source_vec);
1180 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1181 ch->listener_volume[i] = (int)bound(0, vol, 255);
1185 for (i = 0;i < SND_LISTENERS;i++)
1186 ch->listener_volume[i] = 0;
1191 // =======================================================================
1192 // Start a sound effect
1193 // =======================================================================
1195 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1197 // Initialize the channel
1198 memset (target_chan, 0, sizeof (*target_chan));
1199 VectorCopy (origin, target_chan->origin);
1200 target_chan->sfx = sfx;
1201 target_chan->flags = flags;
1202 target_chan->pos = 0; // start of the sound
1204 // If it's a static sound
1207 if (sfx->loopstart >= sfx->total_length)
1208 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1209 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1212 target_chan->dist_mult = attenuation / snd_soundradius.value;
1214 // Lock the SFX during play
1217 // and finally, apply the volume
1218 S_SetChannelVolume(target_chan - channels, fvol);
1222 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1224 channel_t *target_chan, *check;
1227 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1230 if (sfx->fetcher == NULL)
1233 // Pick a channel to play on
1234 target_chan = SND_PickChannel(entnum, entchannel);
1238 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1239 target_chan->entnum = entnum;
1240 target_chan->entchannel = entchannel;
1242 SND_Spatialize(target_chan, false);
1244 // if an identical sound has also been started this frame, offset the pos
1245 // a bit to keep it from just making the first one louder
1246 check = &channels[NUM_AMBIENTS];
1247 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1249 if (check == target_chan)
1251 if (check->sfx == sfx && !check->pos)
1253 // use negative pos offset to delay this sound effect
1254 target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1259 return (target_chan - channels);
1262 void S_StopChannel (unsigned int channel_ind)
1266 if (channel_ind >= total_channels)
1269 ch = &channels[channel_ind];
1270 if (ch->sfx != NULL)
1272 sfx_t *sfx = ch->sfx;
1274 if (sfx->fetcher != NULL)
1276 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1277 if (fetcher_endsb != NULL)
1278 fetcher_endsb (ch->fetcher_data);
1281 // Remove the lock it holds
1284 ch->fetcher_data = NULL;
1290 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1292 if (ch_ind >= total_channels)
1295 if (flag != CHANNELFLAG_FORCELOOP &&
1296 flag != CHANNELFLAG_PAUSED &&
1297 flag != CHANNELFLAG_FULLVOLUME)
1301 channels[ch_ind].flags |= flag;
1303 channels[ch_ind].flags &= ~flag;
1308 void S_StopSound(int entnum, int entchannel)
1312 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1313 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1320 extern void CDAudio_Stop(void);
1321 void S_StopAllSounds (void)
1325 // TOCHECK: is this test necessary?
1326 if (snd_renderbuffer == NULL)
1329 // stop CD audio because it may be using a faketrack
1332 for (i = 0; i < total_channels; i++)
1335 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1336 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1338 // Mute the contents of the submittion buffer
1339 if (simsound || SndSys_LockRenderBuffer ())
1344 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1345 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1346 memset(snd_renderbuffer->ring, clear, memsize);
1349 SndSys_UnlockRenderBuffer ();
1353 void S_PauseGameSounds (qboolean toggle)
1357 for (i = 0; i < total_channels; i++)
1362 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1363 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1367 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1369 sfx_t *sfx = channels[ch_ind].sfx;
1370 if(sfx->volume_peak > 0)
1372 // Replaygain support
1373 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1374 fvol *= sfx->volume_mult;
1375 if(fvol * sfx->volume_peak > 1)
1376 fvol = 1 / sfx->volume_peak;
1377 // Con_DPrintf("%f\n", fvol);
1379 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1388 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1390 channel_t *target_chan;
1392 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1396 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1400 if (total_channels == MAX_CHANNELS)
1402 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1406 target_chan = &channels[total_channels++];
1407 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1409 SND_Spatialize (target_chan, true);
1415 S_UpdateAmbientSounds
1418 void S_UpdateAmbientSounds (void)
1422 int ambient_channel;
1424 unsigned char ambientlevels[NUM_AMBIENTS];
1426 memset(ambientlevels, 0, sizeof(ambientlevels));
1427 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1428 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1430 // Calc ambient sound levels
1431 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1433 chan = &channels[ambient_channel];
1434 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1437 vol = (int)ambientlevels[ambient_channel];
1441 // Don't adjust volume too fast
1442 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1443 if (cl.time > cl.oldtime)
1445 if (chan->master_vol < vol)
1447 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1448 if (chan->master_vol > vol)
1449 chan->master_vol = vol;
1451 else if (chan->master_vol > vol)
1453 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1454 if (chan->master_vol < vol)
1455 chan->master_vol = vol;
1459 for (i = 0;i < SND_LISTENERS;i++)
1460 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1464 static void S_PaintAndSubmit (void)
1466 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1467 qboolean usesoundtimehack;
1468 static qboolean soundtimehack = true;
1470 if (snd_renderbuffer == NULL || nosound.integer)
1473 // Update sound time
1474 usesoundtimehack = true;
1475 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1476 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1477 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1478 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1480 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1483 newsoundtime = SndSys_GetSoundTime();
1484 usesoundtimehack = false;
1486 // if the soundtimehack state changes we need to reset the soundtime
1487 if (soundtimehack != usesoundtimehack)
1489 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1491 // Mute the contents of the submission buffer
1492 if (simsound || SndSys_LockRenderBuffer ())
1497 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1498 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1499 memset(snd_renderbuffer->ring, clear, memsize);
1502 SndSys_UnlockRenderBuffer ();
1505 soundtimehack = usesoundtimehack;
1507 if (!soundtimehack && snd_blocked > 0)
1510 newsoundtime += extrasoundtime;
1511 if (newsoundtime < soundtime)
1513 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1515 unsigned int additionaltime;
1517 // add some time to extrasoundtime make newsoundtime higher
1519 // The extra time must be a multiple of the render buffer size
1520 // to avoid modifying the current position in the buffer,
1521 // some modules write directly to a shared (DMA) buffer
1522 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1523 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1525 extrasoundtime += additionaltime;
1526 newsoundtime += additionaltime;
1527 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1530 else if (!soundtimehack)
1531 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1532 newsoundtime, soundtime);
1534 soundtime = newsoundtime;
1535 recording_sound = (cls.capturevideo.soundrate != 0);
1537 // Check to make sure that we haven't overshot
1538 paintedtime = snd_renderbuffer->endframe;
1539 if (paintedtime < soundtime)
1540 paintedtime = soundtime;
1542 // mix ahead of current position
1543 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1544 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1545 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1546 endtime = min(endtime, maxtime);
1548 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1551 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1560 Called once each time through the main loop
1563 void S_Update(const matrix4x4_t *listenermatrix)
1565 unsigned int i, j, total;
1566 channel_t *ch, *combine;
1567 matrix4x4_t basematrix, rotatematrix;
1569 if (snd_renderbuffer == NULL || nosound.integer)
1572 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1573 if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1574 current_channellayout != snd_channellayout.integer)
1575 S_SetChannelLayout();
1577 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1578 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1580 // calculate the current matrices
1581 for (j = 0;j < SND_LISTENERS;j++)
1583 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1584 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1585 // I think this should now do this:
1586 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1587 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1588 // angle has to be taken negative)
1589 // 2. create a transform which first rotates and moves its argument
1590 // into the player's view coordinates (using basematrix which is
1591 // an inverted "absolute" listener matrix), then applies the
1592 // rotation matrix for the ear
1593 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1594 // does not actually refer to an entity?
1597 // update general area ambient sound sources
1598 S_UpdateAmbientSounds ();
1602 // update spatialization for static and dynamic sounds
1603 ch = channels+NUM_AMBIENTS;
1604 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1609 // respatialize channel
1610 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1612 // try to combine static sounds with a previous channel of the same
1613 // sound effect so we don't mix five torches every frame
1614 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1616 // no need to merge silent channels
1617 for (j = 0;j < SND_LISTENERS;j++)
1618 if (ch->listener_volume[j])
1620 if (j == SND_LISTENERS)
1622 // if the last combine chosen isn't suitable, find a new one
1623 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1627 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1629 if (channels[j].sfx == ch->sfx)
1631 combine = channels + j;
1636 if (combine && combine != ch && combine->sfx == ch->sfx)
1638 for (j = 0;j < SND_LISTENERS;j++)
1640 combine->listener_volume[j] += ch->listener_volume[j];
1641 ch->listener_volume[j] = 0;
1647 sound_spatialized = true;
1650 if (snd_show.integer)
1654 for (i=0 ; i<total_channels; i++, ch++)
1658 for (j = 0;j < SND_LISTENERS;j++)
1659 if (ch->listener_volume[j])
1661 if (j < SND_LISTENERS)
1666 Con_Printf("----(%u)----\n", total);
1672 void S_ExtraUpdate (void)
1674 if (snd_noextraupdate.integer || !sound_spatialized)
1680 qboolean S_LocalSound (const char *sound)
1685 if (!snd_initialized.integer || nosound.integer)
1688 sfx = S_PrecacheSound (sound, true, false);
1691 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1695 // Local sounds must not be freed
1696 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1698 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1702 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;