2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 // snd_main.c -- main control for any streaming sound output device
28 #define SND_MIN_SPEED 8000
29 #define SND_MAX_SPEED 48000
30 #define SND_MIN_WIDTH 1
31 #define SND_MAX_WIDTH 2
32 #define SND_MIN_CHANNELS 1
33 #define SND_MAX_CHANNELS 8
35 #if SND_LISTENERS != 8
36 # error this data only supports up to 8 channel, update it!
38 typedef struct listener_s
46 typedef struct speakerlayout_s
49 unsigned int channels;
50 listener_t listeners[SND_LISTENERS];
54 static speakerlayout_t snd_speakerlayout;
56 // Our speaker layouts are based on ALSA. They differ from those
57 // Win32 and Mac OS X APIs use when there's more than 4 channels.
58 // (rear left + rear right, and front center + LFE are swapped).
59 #define SND_SPEAKERLAYOUTS (sizeof(snd_speakerlayouts) / sizeof(snd_speakerlayouts[0]))
60 static const speakerlayout_t snd_speakerlayouts[] =
65 {45, 0.2, 0.2, 0.5}, // front left
66 {315, 0.2, 0.2, 0.5}, // front right
67 {135, 0.2, 0.2, 0.5}, // rear left
68 {225, 0.2, 0.2, 0.5}, // rear right
69 {0, 0.2, 0.2, 0.5}, // front center
70 {0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
71 {90, 0.2, 0.2, 0.5}, // side left
72 {180, 0.2, 0.2, 0.5}, // side right
78 {45, 0.2, 0.2, 0.5}, // front left
79 {315, 0.2, 0.2, 0.5}, // front right
80 {135, 0.2, 0.2, 0.5}, // rear left
81 {225, 0.2, 0.2, 0.5}, // rear right
82 {0, 0.2, 0.2, 0.5}, // front center
83 {0, 0, 0, 0}, // lfe (we don't have any good lfe sound sources and it would take some filtering work to generate them (and they'd probably still be wrong), so... no lfe)
89 // these systems sometimes have a subwoofer as well, but it has no
93 {45, 0.3, 0.3, 0.8}, // front left
94 {315, 0.3, 0.3, 0.8}, // front right
95 {135, 0.3, 0.3, 0.8}, // rear left
96 {225, 0.3, 0.3, 0.8}, // rear right
104 // these systems sometimes have a subwoofer as well, but it has no
105 // channel of its own
108 {90, 0.5, 0.5, 1}, // side left
109 {270, 0.5, 0.5, 1}, // side right
121 {0, 0, 1, 1}, // center
134 // =======================================================================
135 // Internal sound data & structures
136 // =======================================================================
138 channel_t channels[MAX_CHANNELS];
139 unsigned int total_channels;
141 snd_ringbuffer_t *snd_renderbuffer = NULL;
142 unsigned int soundtime = 0;
143 static unsigned int oldpaintedtime = 0;
144 static unsigned int extrasoundtime = 0;
145 static double snd_starttime = 0.0;
147 vec3_t listener_origin;
148 matrix4x4_t listener_matrix[SND_LISTENERS];
149 mempool_t *snd_mempool;
151 // Linked list of known sfx
152 static sfx_t *known_sfx = NULL;
154 static qboolean sound_spatialized = false;
156 qboolean simsound = false;
158 static qboolean recording_sound = false;
161 static int current_swapstereo = false;
162 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
163 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
165 // Cvars declared in sound.h (part of the sound API)
166 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
167 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
168 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
169 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
170 cvar_t snd_soundradius = {0, "snd_soundradius", "2000", "radius of weapon sounds and other standard sound effects (monster idle noises are half this radius and flickering light noises are one third of this radius)"};
172 // Cvars declared in snd_main.h (shared with other snd_*.c files)
173 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
174 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory)"};
175 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
176 extern cvar_t v_flipped;
177 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
180 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
181 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
182 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
183 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
184 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"};
185 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
187 // Default sound format is 48KHz, 16-bit, stereo
188 // (48KHz because a lot of onboard sound cards sucks at any other speed)
189 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
190 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
191 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)"};
194 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
195 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
198 // ====================================================================
200 // ====================================================================
202 void S_FreeSfx (sfx_t *sfx, qboolean force);
204 static void S_Play_Common (float fvol, float attenuation)
207 char name [MAX_QPATH];
211 while (i < Cmd_Argc ())
213 // Get the name, and appends ".wav" as an extension if there's none
214 strlcpy (name, Cmd_Argv (i), sizeof (name));
215 if (!strrchr (name, '.'))
216 strlcat (name, ".wav", sizeof (name));
219 // If we need to get the volume from the command line
222 fvol = atof (Cmd_Argv (i));
226 sfx = S_PrecacheSound (name, true, false);
229 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
231 // Free the sfx if the file didn't exist
233 S_FreeSfx (sfx, false);
235 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
240 static void S_Play_f(void)
242 S_Play_Common (1.0f, 1.0f);
245 static void S_Play2_f(void)
247 S_Play_Common (1.0f, 0.0f);
250 static void S_PlayVol_f(void)
252 S_Play_Common (-1.0f, 0.0f);
255 static void S_SoundList_f (void)
262 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
264 if (sfx->fetcher != NULL)
267 const snd_format_t* format;
270 format = sfx->fetcher->getfmt(sfx);
271 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
272 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
273 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
274 (sfx->locks > 0) ? 'K' : ' ',
275 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
277 (format->channels == 1) ? "mono" : "stereo",
283 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
285 Con_Printf("Total resident: %i\n", total);
289 void S_SoundInfo_f(void)
291 if (snd_renderbuffer == NULL)
293 Con_Print("sound system not started\n");
297 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
298 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
299 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
300 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
301 Con_Printf("%5u total_channels\n", total_channels);
305 int S_GetSoundRate(void)
307 return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
311 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
313 static const snd_format_t thresholds [] =
315 // speed width channels
316 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
321 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
323 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
324 unsigned int speed_level, width_level, channels_level;
326 // If we have reached the minimum values, there's nothing more we can do
327 if ((format->speed == thresholds[0].speed || fixed_speed) &&
328 (format->width == thresholds[0].width || fixed_width) &&
329 (format->channels == thresholds[0].channels || fixed_channels))
332 // Check the min and max values
333 #define CHECK_BOUNDARIES(param) \
334 if (format->param < thresholds[0].param) \
336 format->param = thresholds[0].param; \
339 if (format->param > thresholds[nb_thresholds - 1].param) \
341 format->param = thresholds[nb_thresholds - 1].param; \
344 CHECK_BOUNDARIES(speed);
345 CHECK_BOUNDARIES(width);
346 CHECK_BOUNDARIES(channels);
347 #undef CHECK_BOUNDARIES
349 // Find the level of each parameter
350 #define FIND_LEVEL(param) \
352 while (param##_level < nb_thresholds - 1) \
354 if (format->param <= thresholds[param##_level].param) \
361 FIND_LEVEL(channels);
364 // Decrease the parameter with the highest level to the previous level
365 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
367 format->channels = thresholds[channels_level - 1].channels;
370 if (speed_level >= width_level && !fixed_speed)
372 format->speed = thresholds[speed_level - 1].speed;
376 format->width = thresholds[width_level - 1].width;
381 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
383 static void S_SetChannelLayout (void)
386 listener_t swaplistener;
387 listener_t *listeners;
390 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
391 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
393 if (i >= SND_SPEAKERLAYOUTS)
395 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
396 snd_renderbuffer->format.channels);
397 i = SND_SPEAKERLAYOUTS - 1;
400 snd_speakerlayout = snd_speakerlayouts[i];
401 listeners = snd_speakerlayout.listeners;
403 // Swap the left and right channels if snd_swapstereo is set
404 if (!!snd_swapstereo.integer ^ !!v_flipped.integer)
406 switch (snd_speakerlayout.channels)
409 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
413 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
416 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
427 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
428 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
429 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
431 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
433 // If we're in the sound engine initialization
434 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
436 layout = SND_CHANNELLAYOUT_STANDARD;
437 Cvar_SetValueQuick (&snd_channellayout, layout);
440 layout = current_channellayout_used;
443 layout = snd_channellayout.integer;
445 // Convert our layout (= ALSA) to the standard layout if necessary
446 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
448 if (layout == SND_CHANNELLAYOUT_STANDARD)
450 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
451 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
454 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
455 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
458 current_swapstereo = !!snd_swapstereo.integer ^ !!v_flipped.integer;
459 current_channellayout = snd_channellayout.integer;
460 current_channellayout_used = layout;
464 void S_Startup (void)
466 qboolean fixed_speed, fixed_width, fixed_channels;
467 snd_format_t chosen_fmt;
468 static snd_format_t prev_render_format = {0, 0, 0};
472 if (!snd_initialized.integer)
477 fixed_channels = false;
479 // Get the starting sound format from the cvars
480 chosen_fmt.speed = snd_speed.integer;
481 chosen_fmt.width = snd_width.integer;
482 chosen_fmt.channels = snd_channels.integer;
484 // Check the environment variables to see if the player wants a particular sound format
485 env = getenv("QUAKE_SOUND_CHANNELS");
488 chosen_fmt.channels = atoi (env);
489 fixed_channels = true;
491 env = getenv("QUAKE_SOUND_SPEED");
494 chosen_fmt.speed = atoi (env);
497 env = getenv("QUAKE_SOUND_SAMPLEBITS");
500 chosen_fmt.width = atoi (env) / 8;
504 // Parse the command line to see if the player wants a particular sound format
505 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
506 if (COM_CheckParm ("-sndquad") != 0)
508 chosen_fmt.channels = 4;
509 fixed_channels = true;
511 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
512 else if (COM_CheckParm ("-sndstereo") != 0)
514 chosen_fmt.channels = 2;
515 fixed_channels = true;
517 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
518 else if (COM_CheckParm ("-sndmono") != 0)
520 chosen_fmt.channels = 1;
521 fixed_channels = true;
523 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
524 i = COM_CheckParm ("-sndspeed");
525 if (0 < i && i < com_argc - 1)
527 chosen_fmt.speed = atoi (com_argv[i + 1]);
530 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
531 i = COM_CheckParm ("-sndbits");
532 if (0 < i && i < com_argc - 1)
534 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
538 // You can't change sound speed after start time (not yet supported)
539 if (prev_render_format.speed != 0)
542 if (chosen_fmt.speed != prev_render_format.speed)
544 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
545 prev_render_format.speed);
546 chosen_fmt.speed = prev_render_format.speed;
551 if (chosen_fmt.speed < SND_MIN_SPEED)
553 chosen_fmt.speed = SND_MIN_SPEED;
556 else if (chosen_fmt.speed > SND_MAX_SPEED)
558 chosen_fmt.speed = SND_MAX_SPEED;
562 if (chosen_fmt.width < SND_MIN_WIDTH)
564 chosen_fmt.width = SND_MIN_WIDTH;
567 else if (chosen_fmt.width > SND_MAX_WIDTH)
569 chosen_fmt.width = SND_MAX_WIDTH;
573 if (chosen_fmt.channels < SND_MIN_CHANNELS)
575 chosen_fmt.channels = SND_MIN_CHANNELS;
576 fixed_channels = false;
578 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
580 chosen_fmt.channels = SND_MAX_CHANNELS;
581 fixed_channels = false;
584 // create the sound buffer used for sumitting the samples to the plaform-dependent module
587 snd_format_t suggest_fmt;
593 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
594 chosen_fmt.speed, chosen_fmt.width * 8,
595 chosen_fmt.channels);
597 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
598 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
602 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
604 // If the module is suggesting another one
605 if (suggest_fmt.speed != 0)
607 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
608 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
609 suggest_fmt.speed, suggest_fmt.width * 8,
610 suggest_fmt.channels);
612 // Else, try to find a less resource-demanding format
613 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
618 // If we haven't found a suitable format
621 Con_Print("S_Startup: SndSys_Init failed.\n");
622 sound_spatialized = false;
628 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
629 Con_Print ("S_Startup: simulating sound output\n");
632 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
633 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
634 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
637 if (snd_speed.integer != (int)chosen_fmt.speed)
638 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
639 if (snd_width.integer != chosen_fmt.width)
640 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
641 if (snd_channels.integer != chosen_fmt.channels)
642 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
644 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
645 S_SetChannelLayout();
647 snd_starttime = realtime;
649 // If the sound module has already run, add an extra time to make sure
650 // the sound time doesn't decrease, to not confuse playing SFXs
651 if (oldpaintedtime != 0)
653 // The extra time must be a multiple of the render buffer size
654 // to avoid modifying the current position in the buffer,
655 // some modules write directly to a shared (DMA) buffer
656 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
657 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
658 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
660 soundtime = extrasoundtime;
664 snd_renderbuffer->startframe = soundtime;
665 snd_renderbuffer->endframe = soundtime;
666 recording_sound = false;
669 void S_Shutdown(void)
671 if (snd_renderbuffer == NULL)
674 oldpaintedtime = snd_renderbuffer->endframe;
678 Mem_Free(snd_renderbuffer->ring);
679 Mem_Free(snd_renderbuffer);
680 snd_renderbuffer = NULL;
685 sound_spatialized = false;
688 void S_Restart_f(void)
701 Con_DPrint("\nSound Initialization\n");
703 Cvar_RegisterVariable(&volume);
704 Cvar_RegisterVariable(&bgmvolume);
705 Cvar_RegisterVariable(&snd_staticvolume);
707 Cvar_RegisterVariable(&snd_speed);
708 Cvar_RegisterVariable(&snd_width);
709 Cvar_RegisterVariable(&snd_channels);
711 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
712 if (COM_CheckParm("-nosound"))
715 snd_mempool = Mem_AllocPool("sound", 0, NULL);
717 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
718 if (COM_CheckParm("-simsound"))
721 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
722 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
723 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
724 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
725 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
726 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
727 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
728 Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
730 Cvar_RegisterVariable(&nosound);
731 Cvar_RegisterVariable(&snd_precache);
732 Cvar_RegisterVariable(&snd_initialized);
733 Cvar_RegisterVariable(&snd_streaming);
734 Cvar_RegisterVariable(&ambient_level);
735 Cvar_RegisterVariable(&ambient_fade);
736 Cvar_RegisterVariable(&snd_noextraupdate);
737 Cvar_RegisterVariable(&snd_show);
738 Cvar_RegisterVariable(&_snd_mixahead);
739 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
740 Cvar_RegisterVariable(&snd_channellayout);
741 Cvar_RegisterVariable(&snd_soundradius);
743 Cvar_SetValueQuick(&snd_initialized, true);
747 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
748 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
758 Shutdown and free all resources
761 void S_Terminate (void)
767 while (known_sfx != NULL)
768 S_FreeSfx (known_sfx, true);
770 Cvar_SetValueQuick (&snd_initialized, false);
771 Mem_FreePool (&snd_mempool);
780 void S_UnloadAllSounds_f (void)
784 // stop any active sounds
787 // because the ambient sounds will be freed, clear the pointers
788 for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
789 ambient_sfxs[i] = NULL;
791 // now free all sounds
792 while (known_sfx != NULL)
793 S_FreeSfx (known_sfx, true);
802 sfx_t *S_FindName (const char *name)
806 if (!snd_initialized.integer)
809 if (strlen (name) >= sizeof (sfx->name))
811 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
815 // Look for this sound in the list of known sfx
816 // TODO: hash table search?
817 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
818 if(!strcmp (sfx->name, name))
821 // Add a sfx_t struct for this sound
822 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
823 memset (sfx, 0, sizeof(*sfx));
824 strlcpy (sfx->name, name, sizeof (sfx->name));
825 sfx->memsize = sizeof(*sfx);
826 sfx->next = known_sfx;
838 void S_FreeSfx (sfx_t *sfx, qboolean force)
842 // Never free a locked sfx unless forced
843 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
846 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
848 // Remove it from the list of known sfx
849 if (sfx == known_sfx)
850 known_sfx = known_sfx->next;
855 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
856 if (prev_sfx->next == sfx)
858 prev_sfx->next = sfx->next;
861 if (prev_sfx == NULL)
863 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
868 // Stop all channels using this sfx
869 for (i = 0; i < total_channels; i++)
870 if (channels[i].sfx == sfx)
874 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
875 sfx->fetcher->free (sfx);
885 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
891 // Start the ambient sounds and make them loop
892 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
894 // Precache it if it's not done (request a lock to make sure it will never be freed)
895 if (ambient_sfxs[i] == NULL)
896 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
897 if (ambient_sfxs[i] != NULL)
899 // Add a lock to the SFX while playing. It will be
900 // removed by S_StopAllSounds at the end of the level
901 S_LockSfx (ambient_sfxs[i]);
903 channels[i].sfx = ambient_sfxs[i];
904 channels[i].flags |= CHANNELFLAG_FORCELOOP;
905 channels[i].master_vol = 0;
909 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
910 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
911 if (sfx->flags & SFXFLAG_SERVERSOUND)
914 sfx->flags &= ~SFXFLAG_SERVERSOUND;
917 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
918 for (i = 1; i < numsounds; i++)
920 sfx = S_FindName (serversound[i]);
923 // clear the FILEMISSING flag so that S_LoadSound will try again on a
924 // previously missing file
925 sfx->flags &= ~ SFXFLAG_FILEMISSING;
927 sfx->flags |= SFXFLAG_SERVERSOUND;
931 // Free all unlocked sfx
932 for (sfx = known_sfx;sfx;sfx = sfxnext)
935 S_FreeSfx (sfx, false);
945 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
949 if (!snd_initialized.integer)
952 if (name == NULL || name[0] == 0)
955 sfx = S_FindName (name);
960 // clear the FILEMISSING flag so that S_LoadSound will try again on a
961 // previously missing file
962 sfx->flags &= ~ SFXFLAG_FILEMISSING;
967 if (!nosound.integer && snd_precache.integer)
968 S_LoadSound(sfx, complain);
978 qboolean S_IsSoundPrecached (const sfx_t *sfx)
980 return (sfx != NULL && sfx->fetcher != NULL);
990 void S_LockSfx (sfx_t *sfx)
999 Remove a lock from a SFX
1002 void S_UnlockSfx (sfx_t *sfx)
1013 void S_BlockSound (void)
1024 void S_UnblockSound (void)
1034 Picks a channel based on priorities, empty slots, number of channels
1037 channel_t *SND_PickChannel(int entnum, int entchannel)
1041 int first_life_left, life_left;
1044 // Check for replacement sound, or find the best one to replace
1046 first_life_left = 0x7fffffff;
1048 // entity channels try to replace the existing sound on the channel
1049 if (entchannel != 0)
1051 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1053 ch = &channels[ch_idx];
1054 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1056 // always override sound from same entity
1057 S_StopChannel (ch_idx);
1058 return &channels[ch_idx];
1063 // there was no channel to override, so look for the first empty one
1064 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1066 ch = &channels[ch_idx];
1069 // no sound on this channel
1070 first_to_die = ch_idx;
1074 // don't let monster sounds override player sounds
1075 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1078 // don't override looped sounds
1079 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1081 life_left = ch->sfx->total_length - ch->pos;
1083 if (life_left < first_life_left)
1085 first_life_left = life_left;
1086 first_to_die = ch_idx;
1090 if (first_to_die == -1)
1093 return &channels[first_to_die];
1100 Spatializes a channel
1103 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1106 vec_t dist, mastervol, intensity, vol;
1109 // update sound origin if we know about the entity
1110 if (ch->entnum > 0 && cls.state == ca_connected && cl.entities[ch->entnum].state_current.active)
1112 //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]);
1113 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1114 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)
1115 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);
1118 mastervol = ch->master_vol;
1119 // Adjust volume of static sounds
1121 mastervol *= snd_staticvolume.value;
1123 // anything coming from the view entity will always be full volume
1124 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1125 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1127 for (i = 0;i < SND_LISTENERS;i++)
1129 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1130 ch->listener_volume[i] = (int)bound(0, vol, 255);
1135 // calculate stereo seperation and distance attenuation
1136 VectorSubtract(listener_origin, ch->origin, source_vec);
1137 dist = VectorLength(source_vec);
1138 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1141 for (i = 0;i < SND_LISTENERS;i++)
1143 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1144 VectorNormalize(source_vec);
1145 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1146 ch->listener_volume[i] = (int)bound(0, vol, 255);
1150 for (i = 0;i < SND_LISTENERS;i++)
1151 ch->listener_volume[i] = 0;
1156 // =======================================================================
1157 // Start a sound effect
1158 // =======================================================================
1160 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1162 // Initialize the channel
1163 memset (target_chan, 0, sizeof (*target_chan));
1164 VectorCopy (origin, target_chan->origin);
1165 target_chan->master_vol = (int)(fvol * 255);
1166 target_chan->sfx = sfx;
1167 target_chan->flags = flags;
1168 target_chan->pos = 0; // start of the sound
1170 // If it's a static sound
1173 if (sfx->loopstart >= sfx->total_length)
1174 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1175 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1178 target_chan->dist_mult = attenuation / snd_soundradius.value;
1180 // Lock the SFX during play
1185 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1187 channel_t *target_chan, *check;
1190 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1193 if (sfx->fetcher == NULL)
1196 if (entnum && entnum >= cl.max_entities)
1197 CL_ExpandEntities(entnum);
1199 // Pick a channel to play on
1200 target_chan = SND_PickChannel(entnum, entchannel);
1204 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1205 target_chan->entnum = entnum;
1206 target_chan->entchannel = entchannel;
1208 SND_Spatialize(target_chan, false);
1210 // if an identical sound has also been started this frame, offset the pos
1211 // a bit to keep it from just making the first one louder
1212 check = &channels[NUM_AMBIENTS];
1213 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1215 if (check == target_chan)
1217 if (check->sfx == sfx && !check->pos)
1219 // use negative pos offset to delay this sound effect
1220 target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1225 return (target_chan - channels);
1228 void S_StopChannel (unsigned int channel_ind)
1232 if (channel_ind >= total_channels)
1235 ch = &channels[channel_ind];
1236 if (ch->sfx != NULL)
1238 sfx_t *sfx = ch->sfx;
1240 if (sfx->fetcher != NULL)
1242 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1243 if (fetcher_endsb != NULL)
1247 // Remove the lock it holds
1255 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1257 if (ch_ind >= total_channels)
1260 if (flag != CHANNELFLAG_FORCELOOP &&
1261 flag != CHANNELFLAG_PAUSED &&
1262 flag != CHANNELFLAG_FULLVOLUME)
1266 channels[ch_ind].flags |= flag;
1268 channels[ch_ind].flags &= ~flag;
1273 void S_StopSound(int entnum, int entchannel)
1277 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1278 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1285 extern void CDAudio_Stop(void);
1286 void S_StopAllSounds (void)
1290 // TOCHECK: is this test necessary?
1291 if (snd_renderbuffer == NULL)
1294 // stop CD audio because it may be using a faketrack
1297 for (i = 0; i < total_channels; i++)
1300 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1301 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1303 // Mute the contents of the submittion buffer
1304 if (simsound || SndSys_LockRenderBuffer ())
1309 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1310 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1311 memset(snd_renderbuffer->ring, clear, memsize);
1314 SndSys_UnlockRenderBuffer ();
1318 void S_PauseGameSounds (qboolean toggle)
1322 for (i = 0; i < total_channels; i++)
1327 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1328 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1332 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1334 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1343 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1345 channel_t *target_chan;
1347 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1351 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1355 if (total_channels == MAX_CHANNELS)
1357 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1361 target_chan = &channels[total_channels++];
1362 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1364 SND_Spatialize (target_chan, true);
1370 S_UpdateAmbientSounds
1373 void S_UpdateAmbientSounds (void)
1377 int ambient_channel;
1379 unsigned char ambientlevels[NUM_AMBIENTS];
1381 memset(ambientlevels, 0, sizeof(ambientlevels));
1382 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1383 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1385 // Calc ambient sound levels
1386 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1388 chan = &channels[ambient_channel];
1389 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1392 vol = (int)ambientlevels[ambient_channel];
1396 // Don't adjust volume too fast
1397 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1398 if (cl.time > cl.oldtime)
1400 if (chan->master_vol < vol)
1402 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1403 if (chan->master_vol > vol)
1404 chan->master_vol = vol;
1406 else if (chan->master_vol > vol)
1408 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1409 if (chan->master_vol < vol)
1410 chan->master_vol = vol;
1414 for (i = 0;i < SND_LISTENERS;i++)
1415 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1419 static void S_PaintAndSubmit (void)
1421 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1422 qboolean usesoundtimehack;
1423 static qboolean soundtimehack = true;
1425 if (snd_renderbuffer == NULL || nosound.integer)
1428 // Update sound time
1429 usesoundtimehack = true;
1430 if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1431 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1432 else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1433 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1435 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1438 newsoundtime = SndSys_GetSoundTime();
1439 usesoundtimehack = false;
1441 // if the soundtimehack state changes we need to reset the soundtime
1442 if (soundtimehack != usesoundtimehack)
1444 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1446 // Mute the contents of the submission buffer
1447 if (simsound || SndSys_LockRenderBuffer ())
1452 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1453 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1454 memset(snd_renderbuffer->ring, clear, memsize);
1457 SndSys_UnlockRenderBuffer ();
1460 soundtimehack = usesoundtimehack;
1462 if (!soundtimehack && snd_blocked > 0)
1465 newsoundtime += extrasoundtime;
1466 if (newsoundtime < soundtime)
1468 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1470 unsigned int additionaltime;
1472 // add some time to extrasoundtime make newsoundtime higher
1474 // The extra time must be a multiple of the render buffer size
1475 // to avoid modifying the current position in the buffer,
1476 // some modules write directly to a shared (DMA) buffer
1477 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1478 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1480 extrasoundtime += additionaltime;
1481 newsoundtime += additionaltime;
1482 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1485 else if (!soundtimehack)
1486 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1487 newsoundtime, soundtime);
1489 soundtime = newsoundtime;
1490 recording_sound = (cls.capturevideo.soundrate != 0);
1492 // Check to make sure that we haven't overshot
1493 paintedtime = snd_renderbuffer->endframe;
1494 if (paintedtime < soundtime)
1495 paintedtime = soundtime;
1497 // mix ahead of current position
1498 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1499 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1500 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1501 endtime = min(endtime, maxtime);
1503 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1506 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1515 Called once each time through the main loop
1518 void S_Update(const matrix4x4_t *listenermatrix)
1520 unsigned int i, j, total;
1521 channel_t *ch, *combine;
1522 matrix4x4_t basematrix, rotatematrix;
1524 if (snd_renderbuffer == NULL || nosound.integer)
1527 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1528 if (current_swapstereo != (!!snd_swapstereo.integer ^ !!v_flipped.integer) ||
1529 current_channellayout != snd_channellayout.integer)
1530 S_SetChannelLayout();
1532 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1533 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1535 // calculate the current matrices
1536 for (j = 0;j < SND_LISTENERS;j++)
1538 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1539 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1540 // I think this should now do this:
1541 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1542 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1543 // angle has to be taken negative)
1544 // 2. create a transform which first rotates and moves its argument
1545 // into the player's view coordinates (using basematrix which is
1546 // an inverted "absolute" listener matrix), then applies the
1547 // rotation matrix for the ear
1548 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1549 // does not actually refer to an entity?
1552 // update general area ambient sound sources
1553 S_UpdateAmbientSounds ();
1557 // update spatialization for static and dynamic sounds
1558 ch = channels+NUM_AMBIENTS;
1559 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1564 // respatialize channel
1565 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1567 // try to combine static sounds with a previous channel of the same
1568 // sound effect so we don't mix five torches every frame
1569 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1571 // no need to merge silent channels
1572 for (j = 0;j < SND_LISTENERS;j++)
1573 if (ch->listener_volume[j])
1575 if (j == SND_LISTENERS)
1577 // if the last combine chosen isn't suitable, find a new one
1578 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1582 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1584 if (channels[j].sfx == ch->sfx)
1586 combine = channels + j;
1591 if (combine && combine != ch && combine->sfx == ch->sfx)
1593 for (j = 0;j < SND_LISTENERS;j++)
1595 combine->listener_volume[j] += ch->listener_volume[j];
1596 ch->listener_volume[j] = 0;
1602 sound_spatialized = true;
1605 if (snd_show.integer)
1609 for (i=0 ; i<total_channels; i++, ch++)
1613 for (j = 0;j < SND_LISTENERS;j++)
1614 if (ch->listener_volume[j])
1616 if (j < SND_LISTENERS)
1621 Con_Printf("----(%u)----\n", total);
1627 void S_ExtraUpdate (void)
1629 if (snd_noextraupdate.integer || !sound_spatialized)
1635 qboolean S_LocalSound (const char *sound)
1640 if (!snd_initialized.integer || nosound.integer)
1643 sfx = S_PrecacheSound (sound, true, false);
1646 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1650 // Local sounds must not be freed
1651 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1653 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1657 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;