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 vec_t sound_nominal_clip_dist=1000.0;
150 mempool_t *snd_mempool;
152 // Linked list of known sfx
153 static sfx_t *known_sfx = NULL;
155 static qboolean sound_spatialized = false;
157 qboolean simsound = false;
159 static qboolean recording_sound = false;
162 static int current_swapstereo = false;
163 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
164 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
166 // Cvars declared in sound.h (part of the sound API)
167 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1", "volume of background music (such as CD music or replacement files such as sound/cdtracks/track002.ogg)"};
168 cvar_t volume = {CVAR_SAVE, "volume", "0.7", "volume of sound effects"};
169 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0", "indicates the sound subsystem is active"};
170 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1", "volume of ambient sound effects (such as swampy sounds at the start of e1m2)"};
172 // Cvars declared in snd_main.h (shared with other snd_*.c files)
173 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1", "how much sound to mix ahead of time"};
174 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1", "enables keeping compressed ogg sound files compressed, decompressing them only as needed, otherwise they will be decompressed completely at load (may use a lot of memory)"};
175 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0", "swaps left/right speakers for old ISA soundblaster cards"};
176 cvar_t snd_channellayout = {0, "snd_channellayout", "0", "channel layout. Can be 0 (auto - snd_restart needed), 1 (standard layout), or 2 (ALSA layout)"};
179 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
180 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
181 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
182 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
183 static cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0", "disables extra sound mixer calls that are meant to reduce the chance of sound breakup at very low framerates"};
184 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
186 // Default sound format is 48KHz, 16-bit, stereo
187 // (48KHz because a lot of onboard sound cards sucks at any other speed)
188 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
189 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
190 static cvar_t snd_channels = {CVAR_SAVE, "snd_channels", "2", "number of channels for the sound ouput (2 for stereo; up to 8 supported for 3D sound)"};
193 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
194 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
197 // ====================================================================
199 // ====================================================================
201 void S_FreeSfx (sfx_t *sfx, qboolean force);
203 static void S_Play_Common (float fvol, float attenuation)
206 char name [MAX_QPATH];
210 while (i < Cmd_Argc ())
212 // Get the name, and appends ".wav" as an extension if there's none
213 strlcpy (name, Cmd_Argv (i), sizeof (name));
214 if (!strrchr (name, '.'))
215 strlcat (name, ".wav", sizeof (name));
218 // If we need to get the volume from the command line
221 fvol = atof (Cmd_Argv (i));
225 sfx = S_PrecacheSound (name, true, false);
228 ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
230 // Free the sfx if the file didn't exist
232 S_FreeSfx (sfx, false);
234 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
239 static void S_Play_f(void)
241 S_Play_Common (1.0f, 1.0f);
244 static void S_Play2_f(void)
246 S_Play_Common (1.0f, 0.0f);
249 static void S_PlayVol_f(void)
251 S_Play_Common (-1.0f, 0.0f);
254 static void S_SoundList_f (void)
261 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
263 if (sfx->fetcher != NULL)
266 const snd_format_t* format;
269 format = sfx->fetcher->getfmt(sfx);
270 Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
271 (sfx->loopstart >= 0) ? 'L' : ' ',
272 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
273 (sfx->locks > 0) ? 'K' : ' ',
274 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
276 (format->channels == 1) ? "mono" : "stereo",
282 Con_Printf (" ( unknown ) unloaded : %s\n", sfx->name);
284 Con_Printf("Total resident: %i\n", total);
288 void S_SoundInfo_f(void)
290 if (snd_renderbuffer == NULL)
292 Con_Print("sound system not started\n");
296 Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
297 Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
298 Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
299 Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
300 Con_Printf("%5u total_channels\n", total_channels);
304 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
306 static const snd_format_t thresholds [] =
308 // speed width channels
309 { SND_MIN_SPEED, SND_MIN_WIDTH, SND_MIN_CHANNELS },
314 { SND_MAX_SPEED, SND_MAX_WIDTH, SND_MAX_CHANNELS },
316 const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
317 unsigned int speed_level, width_level, channels_level;
319 // If we have reached the minimum values, there's nothing more we can do
320 if ((format->speed == thresholds[0].speed || fixed_speed) &&
321 (format->width == thresholds[0].width || fixed_width) &&
322 (format->channels == thresholds[0].channels || fixed_channels))
325 // Check the min and max values
326 #define CHECK_BOUNDARIES(param) \
327 if (format->param < thresholds[0].param) \
329 format->param = thresholds[0].param; \
332 if (format->param > thresholds[nb_thresholds - 1].param) \
334 format->param = thresholds[nb_thresholds - 1].param; \
337 CHECK_BOUNDARIES(speed);
338 CHECK_BOUNDARIES(width);
339 CHECK_BOUNDARIES(channels);
340 #undef CHECK_BOUNDARIES
342 // Find the level of each parameter
343 #define FIND_LEVEL(param) \
345 while (param##_level < nb_thresholds - 1) \
347 if (format->param <= thresholds[param##_level].param) \
354 FIND_LEVEL(channels);
357 // Decrease the parameter with the highest level to the previous level
358 if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
360 format->channels = thresholds[channels_level - 1].channels;
363 if (speed_level >= width_level && !fixed_speed)
365 format->speed = thresholds[speed_level - 1].speed;
369 format->width = thresholds[width_level - 1].width;
374 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
376 static void S_SetChannelLayout (void)
379 listener_t swaplistener;
380 listener_t *listeners;
383 for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
384 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
386 if (i >= SND_SPEAKERLAYOUTS)
388 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
389 snd_renderbuffer->format.channels);
390 i = SND_SPEAKERLAYOUTS - 1;
393 snd_speakerlayout = snd_speakerlayouts[i];
394 listeners = snd_speakerlayout.listeners;
396 // Swap the left and right channels if snd_swapstereo is set
397 if (snd_swapstereo.integer)
399 switch (snd_speakerlayout.channels)
402 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
406 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
409 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
420 if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
421 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
422 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
424 if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
426 // If we're in the sound engine initialization
427 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
429 layout = SND_CHANNELLAYOUT_STANDARD;
430 Cvar_SetValueQuick (&snd_channellayout, layout);
433 layout = current_channellayout_used;
436 layout = snd_channellayout.integer;
438 // Convert our layout (= ALSA) to the standard layout if necessary
439 if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
441 if (layout == SND_CHANNELLAYOUT_STANDARD)
443 SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
444 SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
447 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
448 (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
451 current_swapstereo = snd_swapstereo.integer;
452 current_channellayout = snd_channellayout.integer;
453 current_channellayout_used = layout;
457 void S_Startup (void)
459 qboolean fixed_speed, fixed_width, fixed_channels;
460 snd_format_t chosen_fmt;
461 static snd_format_t prev_render_format = {0, 0, 0};
465 if (!snd_initialized.integer)
470 fixed_channels = false;
472 // Get the starting sound format from the cvars
473 chosen_fmt.speed = snd_speed.integer;
474 chosen_fmt.width = snd_width.integer;
475 chosen_fmt.channels = snd_channels.integer;
477 // Check the environment variables to see if the player wants a particular sound format
478 env = getenv("QUAKE_SOUND_CHANNELS");
481 chosen_fmt.channels = atoi (env);
482 fixed_channels = true;
484 env = getenv("QUAKE_SOUND_SPEED");
487 chosen_fmt.speed = atoi (env);
490 env = getenv("QUAKE_SOUND_SAMPLEBITS");
493 chosen_fmt.width = atoi (env) / 8;
497 // Parse the command line to see if the player wants a particular sound format
498 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
499 if (COM_CheckParm ("-sndquad") != 0)
501 chosen_fmt.channels = 4;
502 fixed_channels = true;
504 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
505 else if (COM_CheckParm ("-sndstereo") != 0)
507 chosen_fmt.channels = 2;
508 fixed_channels = true;
510 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
511 else if (COM_CheckParm ("-sndmono") != 0)
513 chosen_fmt.channels = 1;
514 fixed_channels = true;
516 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
517 i = COM_CheckParm ("-sndspeed");
518 if (0 < i && i < com_argc - 1)
520 chosen_fmt.speed = atoi (com_argv[i + 1]);
523 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
524 i = COM_CheckParm ("-sndbits");
525 if (0 < i && i < com_argc - 1)
527 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
531 // You can't change sound speed after start time (not yet supported)
532 if (prev_render_format.speed != 0)
535 if (chosen_fmt.speed != prev_render_format.speed)
537 Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
538 prev_render_format.speed);
539 chosen_fmt.speed = prev_render_format.speed;
544 if (chosen_fmt.speed < SND_MIN_SPEED)
546 chosen_fmt.speed = SND_MIN_SPEED;
549 else if (chosen_fmt.speed > SND_MAX_SPEED)
551 chosen_fmt.speed = SND_MAX_SPEED;
555 if (chosen_fmt.width < SND_MIN_WIDTH)
557 chosen_fmt.width = SND_MIN_WIDTH;
560 else if (chosen_fmt.width > SND_MAX_WIDTH)
562 chosen_fmt.width = SND_MAX_WIDTH;
566 if (chosen_fmt.channels < SND_MIN_CHANNELS)
568 chosen_fmt.channels = SND_MIN_CHANNELS;
569 fixed_channels = false;
571 else if (chosen_fmt.channels > SND_MAX_CHANNELS)
573 chosen_fmt.channels = SND_MAX_CHANNELS;
574 fixed_channels = false;
577 // create the sound buffer used for sumitting the samples to the plaform-dependent module
580 snd_format_t suggest_fmt;
586 Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
587 chosen_fmt.speed, chosen_fmt.width * 8,
588 chosen_fmt.channels);
590 memset(&suggest_fmt, 0, sizeof(suggest_fmt));
591 accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
595 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
597 // If the module is suggesting another one
598 if (suggest_fmt.speed != 0)
600 memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
601 Con_Printf (" Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
602 suggest_fmt.speed, suggest_fmt.width * 8,
603 suggest_fmt.channels);
605 // Else, try to find a less resource-demanding format
606 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
611 // If we haven't found a suitable format
614 Con_Print("S_Startup: SndSys_Init failed.\n");
615 sound_spatialized = false;
621 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
622 Con_Print ("S_Startup: simulating sound output\n");
625 memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
626 Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
627 chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
630 if (snd_speed.integer != (int)chosen_fmt.speed)
631 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
632 if (snd_width.integer != chosen_fmt.width)
633 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
634 if (snd_channels.integer != chosen_fmt.channels)
635 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
637 current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
638 S_SetChannelLayout();
640 snd_starttime = realtime;
642 // If the sound module has already run, add an extra time to make sure
643 // the sound time doesn't decrease, to not confuse playing SFXs
644 if (oldpaintedtime != 0)
646 // The extra time must be a multiple of the render buffer size
647 // to avoid modifying the current position in the buffer,
648 // some modules write directly to a shared (DMA) buffer
649 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
650 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
651 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
653 soundtime = extrasoundtime;
657 snd_renderbuffer->startframe = soundtime;
658 snd_renderbuffer->endframe = soundtime;
659 recording_sound = false;
662 void S_Shutdown(void)
664 if (snd_renderbuffer == NULL)
667 oldpaintedtime = snd_renderbuffer->endframe;
671 Mem_Free(snd_renderbuffer->ring);
672 Mem_Free(snd_renderbuffer);
673 snd_renderbuffer = NULL;
678 sound_spatialized = false;
681 void S_Restart_f(void)
694 Con_DPrint("\nSound Initialization\n");
696 Cvar_RegisterVariable(&volume);
697 Cvar_RegisterVariable(&bgmvolume);
698 Cvar_RegisterVariable(&snd_staticvolume);
700 Cvar_RegisterVariable(&snd_speed);
701 Cvar_RegisterVariable(&snd_width);
702 Cvar_RegisterVariable(&snd_channels);
704 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
705 if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
708 snd_mempool = Mem_AllocPool("sound", 0, NULL);
710 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
711 if (COM_CheckParm("-simsound"))
714 Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
715 Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
716 Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
717 Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
718 Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
719 Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
720 Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
722 Cvar_RegisterVariable(&nosound);
723 Cvar_RegisterVariable(&snd_precache);
724 Cvar_RegisterVariable(&snd_initialized);
725 Cvar_RegisterVariable(&snd_streaming);
726 Cvar_RegisterVariable(&ambient_level);
727 Cvar_RegisterVariable(&ambient_fade);
728 Cvar_RegisterVariable(&snd_noextraupdate);
729 Cvar_RegisterVariable(&snd_show);
730 Cvar_RegisterVariable(&_snd_mixahead);
731 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
732 Cvar_RegisterVariable(&snd_channellayout);
734 Cvar_SetValueQuick(&snd_initialized, true);
738 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
739 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
749 Shutdown and free all resources
752 void S_Terminate (void)
758 while (known_sfx != NULL)
759 S_FreeSfx (known_sfx, true);
761 Cvar_SetValueQuick (&snd_initialized, false);
762 Mem_FreePool (&snd_mempool);
771 sfx_t *S_FindName (const char *name)
775 if (!snd_initialized.integer)
778 if (strlen (name) >= sizeof (sfx->name))
780 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
784 // Look for this sound in the list of known sfx
785 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
786 if(!strcmp (sfx->name, name))
789 // Add a sfx_t struct for this sound
790 sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
791 memset (sfx, 0, sizeof(*sfx));
792 strlcpy (sfx->name, name, sizeof (sfx->name));
793 sfx->memsize = sizeof(*sfx);
794 sfx->next = known_sfx;
806 void S_FreeSfx (sfx_t *sfx, qboolean force)
810 // Never free a locked sfx unless forced
811 if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
814 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
816 // Remove it from the list of known sfx
817 if (sfx == known_sfx)
818 known_sfx = known_sfx->next;
823 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
824 if (prev_sfx->next == sfx)
826 prev_sfx->next = sfx->next;
829 if (prev_sfx == NULL)
831 Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
836 // Stop all channels using this sfx
837 for (i = 0; i < total_channels; i++)
838 if (channels[i].sfx == sfx)
842 if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
843 sfx->fetcher->free (sfx);
853 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
859 // Start the ambient sounds and make them loop
860 for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
862 // Precache it if it's not done (request a lock to make sure it will never be freed)
863 if (ambient_sfxs[i] == NULL)
864 ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
865 if (ambient_sfxs[i] != NULL)
867 // Add a lock to the SFX while playing. It will be
868 // removed by S_StopAllSounds at the end of the level
869 S_LockSfx (ambient_sfxs[i]);
871 channels[i].sfx = ambient_sfxs[i];
872 channels[i].flags |= CHANNELFLAG_FORCELOOP;
873 channels[i].master_vol = 0;
877 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
878 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
879 if (sfx->flags & SFXFLAG_SERVERSOUND)
882 sfx->flags &= ~SFXFLAG_SERVERSOUND;
885 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
886 for (i = 1; i < numsounds; i++)
888 sfx = S_FindName (serversound[i]);
892 sfx->flags |= SFXFLAG_SERVERSOUND;
896 // Free all unlocked sfx
897 for (sfx = known_sfx;sfx;sfx = sfxnext)
900 S_FreeSfx (sfx, false);
910 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
914 if (!snd_initialized.integer)
917 if (name == NULL || name[0] == 0)
920 sfx = S_FindName (name);
927 if (!nosound.integer && snd_precache.integer)
928 S_LoadSound(sfx, complain);
938 qboolean S_IsSoundPrecached (const sfx_t *sfx)
940 return (sfx != NULL && sfx->fetcher != NULL);
950 void S_LockSfx (sfx_t *sfx)
959 Remove a lock from a SFX
962 void S_UnlockSfx (sfx_t *sfx)
973 void S_BlockSound (void)
984 void S_UnblockSound (void)
994 Picks a channel based on priorities, empty slots, number of channels
997 channel_t *SND_PickChannel(int entnum, int entchannel)
1001 int first_life_left, life_left;
1004 // Check for replacement sound, or find the best one to replace
1006 first_life_left = 0x7fffffff;
1007 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1009 ch = &channels[ch_idx];
1010 if (entchannel != 0)
1012 // try to override an existing channel
1013 if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1015 // always override sound from same entity
1016 first_to_die = ch_idx;
1024 // no sound on this channel
1025 first_to_die = ch_idx;
1032 // don't let monster sounds override player sounds
1033 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1036 // don't override looped sounds
1037 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart >= 0)
1041 life_left = (int)(ch->end - snd_renderbuffer->endframe);
1042 if (life_left < first_life_left)
1044 first_life_left = life_left;
1045 first_to_die = ch_idx;
1049 if (first_to_die == -1)
1052 S_StopChannel (first_to_die);
1054 return &channels[first_to_die];
1061 Spatializes a channel
1064 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1067 vec_t dist, mastervol, intensity, vol;
1070 // update sound origin if we know about the entity
1071 if (ch->entnum > 0 && cls.state == ca_connected && cl.entities[ch->entnum].state_current.active)
1073 //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]);
1074 VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1075 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)
1076 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);
1079 mastervol = ch->master_vol;
1080 // Adjust volume of static sounds
1082 mastervol *= snd_staticvolume.value;
1084 // anything coming from the view entity will always be full volume
1085 // LordHavoc: make sounds with ATTN_NONE have no spatialization
1086 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1088 for (i = 0;i < SND_LISTENERS;i++)
1090 vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1091 ch->listener_volume[i] = (int)bound(0, vol, 255);
1096 // calculate stereo seperation and distance attenuation
1097 VectorSubtract(listener_origin, ch->origin, source_vec);
1098 dist = VectorLength(source_vec);
1099 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1102 for (i = 0;i < SND_LISTENERS;i++)
1104 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1105 VectorNormalize(source_vec);
1106 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1107 ch->listener_volume[i] = (int)bound(0, vol, 255);
1111 for (i = 0;i < SND_LISTENERS;i++)
1112 ch->listener_volume[i] = 0;
1117 // =======================================================================
1118 // Start a sound effect
1119 // =======================================================================
1121 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1123 // Initialize the channel
1124 memset (target_chan, 0, sizeof (*target_chan));
1125 VectorCopy (origin, target_chan->origin);
1126 target_chan->master_vol = (int)(fvol * 255);
1127 target_chan->sfx = sfx;
1128 target_chan->end = snd_renderbuffer->endframe + sfx->total_length;
1129 target_chan->lastptime = snd_renderbuffer->endframe;
1130 target_chan->flags = flags;
1132 // If it's a static sound
1135 if (sfx->loopstart == -1)
1136 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1137 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
1140 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
1142 // Lock the SFX during play
1147 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1149 channel_t *target_chan, *check;
1153 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1156 if (sfx->fetcher == NULL)
1159 if (entnum && entnum >= cl.max_entities)
1160 CL_ExpandEntities(entnum);
1162 // Pick a channel to play on
1163 target_chan = SND_PickChannel(entnum, entchannel);
1167 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1168 target_chan->entnum = entnum;
1169 target_chan->entchannel = entchannel;
1171 SND_Spatialize(target_chan, false);
1173 // if an identical sound has also been started this frame, offset the pos
1174 // a bit to keep it from just making the first one louder
1175 check = &channels[NUM_AMBIENTS];
1176 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1178 if (check == target_chan)
1180 if (check->sfx == sfx && !check->pos)
1182 skip = (int)(0.1 * snd_renderbuffer->format.speed);
1183 if (skip > (int)sfx->total_length)
1184 skip = (int)sfx->total_length;
1186 skip = rand() % skip;
1187 target_chan->pos += skip;
1188 target_chan->end -= skip;
1193 return (target_chan - channels);
1196 void S_StopChannel (unsigned int channel_ind)
1200 if (channel_ind >= total_channels)
1203 ch = &channels[channel_ind];
1204 if (ch->sfx != NULL)
1206 sfx_t *sfx = ch->sfx;
1208 if (sfx->fetcher != NULL)
1210 snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1211 if (fetcher_endsb != NULL)
1215 // Remove the lock it holds
1224 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1226 if (ch_ind >= total_channels)
1229 if (flag != CHANNELFLAG_FORCELOOP &&
1230 flag != CHANNELFLAG_PAUSED &&
1231 flag != CHANNELFLAG_FULLVOLUME)
1235 channels[ch_ind].flags |= flag;
1237 channels[ch_ind].flags &= ~flag;
1242 void S_StopSound(int entnum, int entchannel)
1246 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1247 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1254 void S_StopAllSounds (void)
1258 // TOCHECK: is this test necessary?
1259 if (snd_renderbuffer == NULL)
1262 for (i = 0; i < total_channels; i++)
1265 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
1266 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1268 // Mute the contents of the submittion buffer
1269 if (simsound || SndSys_LockRenderBuffer ())
1274 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1275 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1276 memset(snd_renderbuffer->ring, clear, memsize);
1279 SndSys_UnlockRenderBuffer ();
1283 void S_PauseGameSounds (qboolean toggle)
1287 for (i = 0; i < total_channels; i++)
1292 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1293 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1297 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1299 channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1308 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1310 channel_t *target_chan;
1312 if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1316 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1320 if (total_channels == MAX_CHANNELS)
1322 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1326 target_chan = &channels[total_channels++];
1327 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1329 SND_Spatialize (target_chan, true);
1335 S_UpdateAmbientSounds
1338 void S_UpdateAmbientSounds (void)
1342 int ambient_channel;
1344 unsigned char ambientlevels[NUM_AMBIENTS];
1346 memset(ambientlevels, 0, sizeof(ambientlevels));
1347 if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1348 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1350 // Calc ambient sound levels
1351 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1353 chan = &channels[ambient_channel];
1354 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1357 vol = (int)ambientlevels[ambient_channel];
1361 // Don't adjust volume too fast
1362 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1363 if (chan->master_vol < vol)
1365 chan->master_vol += (int)(cl.realframetime * ambient_fade.value);
1366 if (chan->master_vol > vol)
1367 chan->master_vol = vol;
1369 else if (chan->master_vol > vol)
1371 chan->master_vol -= (int)(cl.realframetime * ambient_fade.value);
1372 if (chan->master_vol < vol)
1373 chan->master_vol = vol;
1376 for (i = 0;i < SND_LISTENERS;i++)
1377 chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1381 static void S_PaintAndSubmit (void)
1383 unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1385 if (snd_renderbuffer == NULL || nosound.integer)
1388 if (snd_blocked > 0 && !cls.capturevideo_soundfile)
1391 // Update sound time
1392 if (cls.capturevideo_soundfile) // SUPER NASTY HACK to record non-realtime sound
1393 newsoundtime = (unsigned int)((double)cls.capturevideo_frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo_framerate);
1395 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1397 newsoundtime = SndSys_GetSoundTime();
1399 newsoundtime += extrasoundtime;
1400 if (newsoundtime < soundtime)
1402 if ((cls.capturevideo_soundfile != NULL) != recording_sound)
1404 unsigned int additionaltime;
1406 // add some time to extrasoundtime make newsoundtime higher
1408 // The extra time must be a multiple of the render buffer size
1409 // to avoid modifying the current position in the buffer,
1410 // some modules write directly to a shared (DMA) buffer
1411 additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1412 additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1414 extrasoundtime += additionaltime;
1415 newsoundtime += additionaltime;
1416 Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1420 Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1421 newsoundtime, soundtime);
1423 soundtime = newsoundtime;
1424 recording_sound = (cls.capturevideo_soundfile != NULL);
1426 // Check to make sure that we haven't overshot
1427 paintedtime = snd_renderbuffer->endframe;
1428 if (paintedtime < soundtime)
1429 paintedtime = soundtime;
1431 // mix ahead of current position
1432 endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1433 usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1434 maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1435 endtime = min(endtime, maxtime);
1437 S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1440 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1449 Called once each time through the main loop
1452 void S_Update(const matrix4x4_t *listenermatrix)
1454 unsigned int i, j, total;
1455 channel_t *ch, *combine;
1456 matrix4x4_t basematrix, rotatematrix;
1458 if (snd_renderbuffer == NULL || nosound.integer)
1461 if (snd_blocked > 0 && !cls.capturevideo_soundfile)
1464 // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1465 if (current_swapstereo != snd_swapstereo.integer ||
1466 current_channellayout != snd_channellayout.integer)
1467 S_SetChannelLayout();
1469 Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1470 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1472 // calculate the current matrices
1473 for (j = 0;j < SND_LISTENERS;j++)
1475 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1476 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1477 // I think this should now do this:
1478 // 1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1479 // (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1480 // angle has to be taken negative)
1481 // 2. create a transform which first rotates and moves its argument
1482 // into the player's view coordinates (using basematrix which is
1483 // an inverted "absolute" listener matrix), then applies the
1484 // rotation matrix for the ear
1485 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1486 // does not actually refer to an entity?
1489 // update general area ambient sound sources
1490 S_UpdateAmbientSounds ();
1494 // update spatialization for static and dynamic sounds
1495 ch = channels+NUM_AMBIENTS;
1496 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1501 // respatialize channel
1502 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1504 // try to combine static sounds with a previous channel of the same
1505 // sound effect so we don't mix five torches every frame
1506 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1508 // no need to merge silent channels
1509 for (j = 0;j < SND_LISTENERS;j++)
1510 if (ch->listener_volume[j])
1512 if (j == SND_LISTENERS)
1514 // if the last combine chosen isn't suitable, find a new one
1515 if (!(combine && combine != ch && combine->sfx == ch->sfx))
1519 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1521 if (channels[j].sfx == ch->sfx)
1523 combine = channels + j;
1528 if (combine && combine != ch && combine->sfx == ch->sfx)
1530 for (j = 0;j < SND_LISTENERS;j++)
1532 combine->listener_volume[j] += ch->listener_volume[j];
1533 ch->listener_volume[j] = 0;
1539 sound_spatialized = true;
1542 if (snd_show.integer)
1546 for (i=0 ; i<total_channels; i++, ch++)
1550 for (j = 0;j < SND_LISTENERS;j++)
1551 if (ch->listener_volume[j])
1553 if (j < SND_LISTENERS)
1558 Con_Printf("----(%u)----\n", total);
1564 void S_ExtraUpdate (void)
1566 if (snd_noextraupdate.integer || !sound_spatialized)
1572 qboolean S_LocalSound (const char *sound)
1577 if (!snd_initialized.integer || nosound.integer)
1580 sfx = S_PrecacheSound (sound, true, false);
1583 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1587 // Local sounds must not be freed
1588 sfx->flags |= SFXFLAG_PERMANENTLOCK;
1590 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1594 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;