implemented snd_mutewhenidle cvar, defaults to 1, to allow people to
[divverent/darkplaces.git] / snd_main.c
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20 // snd_main.c -- main control for any streaming sound output device
21
22 #include "quakedef.h"
23
24 #include "snd_main.h"
25 #include "snd_ogg.h"
26
27
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
34
35 #if SND_LISTENERS != 8
36 #       error this data only supports up to 8 channel, update it!
37 #endif
38 typedef struct listener_s
39 {
40         float yawangle;
41         float dotscale;
42         float dotbias;
43         float ambientvolume;
44 }
45 listener_t;
46 typedef struct speakerlayout_s
47 {
48         const char *name;
49         unsigned int channels;
50         listener_t listeners[SND_LISTENERS];
51 }
52 speakerlayout_t;
53
54 static speakerlayout_t snd_speakerlayout;
55
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[] =
61 {
62         {
63                 "surround71", 8,
64                 {
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
73                 }
74         },
75         {
76                 "surround51", 6,
77                 {
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)
84                         {0, 0, 0, 0},
85                         {0, 0, 0, 0},
86                 }
87         },
88         {
89                 // these systems sometimes have a subwoofer as well, but it has no
90                 // channel of its own
91                 "surround40", 4,
92                 {
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
97                         {0, 0, 0, 0},
98                         {0, 0, 0, 0},
99                         {0, 0, 0, 0},
100                         {0, 0, 0, 0},
101                 }
102         },
103         {
104                 // these systems sometimes have a subwoofer as well, but it has no
105                 // channel of its own
106                 "stereo", 2,
107                 {
108                         {90, 0.5, 0.5, 1}, // side left
109                         {270, 0.5, 0.5, 1}, // side right
110                         {0, 0, 0, 0},
111                         {0, 0, 0, 0},
112                         {0, 0, 0, 0},
113                         {0, 0, 0, 0},
114                         {0, 0, 0, 0},
115                         {0, 0, 0, 0},
116                 }
117         },
118         {
119                 "mono", 1,
120                 {
121                         {0, 0, 1, 1}, // center
122                         {0, 0, 0, 0},
123                         {0, 0, 0, 0},
124                         {0, 0, 0, 0},
125                         {0, 0, 0, 0},
126                         {0, 0, 0, 0},
127                         {0, 0, 0, 0},
128                         {0, 0, 0, 0},
129                 }
130         }
131 };
132
133
134 // =======================================================================
135 // Internal sound data & structures
136 // =======================================================================
137
138 channel_t channels[MAX_CHANNELS];
139 unsigned int total_channels;
140
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;
146
147 vec3_t listener_origin;
148 matrix4x4_t listener_matrix[SND_LISTENERS];
149 mempool_t *snd_mempool;
150
151 // Linked list of known sfx
152 static sfx_t *known_sfx = NULL;
153
154 static qboolean sound_spatialized = false;
155
156 qboolean simsound = false;
157
158 static qboolean recording_sound = false;
159
160 int snd_blocked = 0;
161 static int current_swapstereo = false;
162 static int current_channellayout = SND_CHANNELLAYOUT_AUTO;
163 static int current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
164
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)"};
171
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)"};
178 cvar_t snd_mutewhenidle = {CVAR_SAVE, "snd_mutewhenidle", "1", "whether to disable sound output when game window is inactive"};
179
180 // Local cvars
181 static cvar_t nosound = {0, "nosound", "0", "disables sound"};
182 static cvar_t snd_precache = {0, "snd_precache", "1", "loads sounds before they are used"};
183 static cvar_t ambient_level = {0, "ambient_level", "0.3", "volume of environment noises (water and wind)"};
184 static cvar_t ambient_fade = {0, "ambient_fade", "100", "rate of volume fading when moving from one environment to another"};
185 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"};
186 static cvar_t snd_show = {0, "snd_show", "0", "shows some statistics about sound mixing"};
187
188 // Default sound format is 48KHz, 16-bit, stereo
189 // (48KHz because a lot of onboard sound cards sucks at any other speed)
190 static cvar_t snd_speed = {CVAR_SAVE, "snd_speed", "48000", "sound output frequency, in hertz"};
191 static cvar_t snd_width = {CVAR_SAVE, "snd_width", "2", "sound output precision, in bytes (1 and 2 supported)"};
192 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
194 // Ambient sounds
195 static sfx_t* ambient_sfxs [2] = { NULL, NULL };
196 static const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
197
198
199 // ====================================================================
200 // Functions
201 // ====================================================================
202
203 void S_FreeSfx (sfx_t *sfx, qboolean force);
204
205 static void S_Play_Common (float fvol, float attenuation)
206 {
207         int i, ch_ind;
208         char name [MAX_QPATH];
209         sfx_t *sfx;
210
211         i = 1;
212         while (i < Cmd_Argc ())
213         {
214                 // Get the name, and appends ".wav" as an extension if there's none
215                 strlcpy (name, Cmd_Argv (i), sizeof (name));
216                 if (!strrchr (name, '.'))
217                         strlcat (name, ".wav", sizeof (name));
218                 i++;
219
220                 // If we need to get the volume from the command line
221                 if (fvol == -1.0f)
222                 {
223                         fvol = atof (Cmd_Argv (i));
224                         i++;
225                 }
226
227                 sfx = S_PrecacheSound (name, true, false);
228                 if (sfx)
229                 {
230                         ch_ind = S_StartSound (-1, 0, sfx, listener_origin, fvol, attenuation);
231
232                         // Free the sfx if the file didn't exist
233                         if (ch_ind < 0)
234                                 S_FreeSfx (sfx, false);
235                         else
236                                 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
237                 }
238         }
239 }
240
241 static void S_Play_f(void)
242 {
243         S_Play_Common (1.0f, 1.0f);
244 }
245
246 static void S_Play2_f(void)
247 {
248         S_Play_Common (1.0f, 0.0f);
249 }
250
251 static void S_PlayVol_f(void)
252 {
253         S_Play_Common (-1.0f, 0.0f);
254 }
255
256 static void S_SoundList_f (void)
257 {
258         unsigned int i;
259         sfx_t *sfx;
260         unsigned int total;
261
262         total = 0;
263         for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
264         {
265                 if (sfx->fetcher != NULL)
266                 {
267                         unsigned int size;
268                         const snd_format_t* format;
269
270                         size = sfx->memsize;
271                         format = sfx->fetcher->getfmt(sfx);
272                         Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
273                                                 (sfx->loopstart < sfx->total_length) ? 'L' : ' ',
274                                                 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
275                                                 (sfx->locks > 0) ? 'K' : ' ',
276                                                 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
277                                                 format->width * 8,
278                                                 (format->channels == 1) ? "mono" : "stereo",
279                                                 size,
280                                                 sfx->name);
281                         total += size;
282                 }
283                 else
284                         Con_Printf ("    (  unknown  ) unloaded : %s\n", sfx->name);
285         }
286         Con_Printf("Total resident: %i\n", total);
287 }
288
289
290 void S_SoundInfo_f(void)
291 {
292         if (snd_renderbuffer == NULL)
293         {
294                 Con_Print("sound system not started\n");
295                 return;
296         }
297
298         Con_Printf("%5d speakers\n", snd_renderbuffer->format.channels);
299         Con_Printf("%5d frames\n", snd_renderbuffer->maxframes);
300         Con_Printf("%5d samplebits\n", snd_renderbuffer->format.width * 8);
301         Con_Printf("%5d speed\n", snd_renderbuffer->format.speed);
302         Con_Printf("%5u total_channels\n", total_channels);
303 }
304
305
306 int S_GetSoundRate(void)
307 {
308         return snd_renderbuffer ? snd_renderbuffer->format.speed : 0;
309 }
310
311
312 static qboolean S_ChooseCheaperFormat (snd_format_t* format, qboolean fixed_speed, qboolean fixed_width, qboolean fixed_channels)
313 {
314         static const snd_format_t thresholds [] =
315         {
316                 // speed                        width                   channels
317                 { SND_MIN_SPEED,        SND_MIN_WIDTH,  SND_MIN_CHANNELS },
318                 { 11025,                        1,                              2 },
319                 { 22050,                        2,                              2 },
320                 { 44100,                        2,                              2 },
321                 { 48000,                        2,                              6 },
322                 { SND_MAX_SPEED,        SND_MAX_WIDTH,  SND_MAX_CHANNELS },
323         };
324         const unsigned int nb_thresholds = sizeof(thresholds) / sizeof(thresholds[0]);
325         unsigned int speed_level, width_level, channels_level;
326
327         // If we have reached the minimum values, there's nothing more we can do
328         if ((format->speed == thresholds[0].speed || fixed_speed) &&
329                 (format->width == thresholds[0].width || fixed_width) &&
330                 (format->channels == thresholds[0].channels || fixed_channels))
331                 return false;
332
333         // Check the min and max values
334         #define CHECK_BOUNDARIES(param)                                                         \
335         if (format->param < thresholds[0].param)                                        \
336         {                                                                                                                       \
337                 format->param = thresholds[0].param;                                    \
338                 return true;                                                                                    \
339         }                                                                                                                       \
340         if (format->param > thresholds[nb_thresholds - 1].param)        \
341         {                                                                                                                       \
342                 format->param = thresholds[nb_thresholds - 1].param;    \
343                 return true;                                                                                    \
344         }
345         CHECK_BOUNDARIES(speed);
346         CHECK_BOUNDARIES(width);
347         CHECK_BOUNDARIES(channels);
348         #undef CHECK_BOUNDARIES
349
350         // Find the level of each parameter
351         #define FIND_LEVEL(param)                                                                       \
352         param##_level = 0;                                                                                      \
353         while (param##_level < nb_thresholds - 1)                                       \
354         {                                                                                                                       \
355                 if (format->param <= thresholds[param##_level].param)   \
356                         break;                                                                                          \
357                                                                                                                                 \
358                 param##_level++;                                                                                \
359         }
360         FIND_LEVEL(speed);
361         FIND_LEVEL(width);
362         FIND_LEVEL(channels);
363         #undef FIND_LEVEL
364
365         // Decrease the parameter with the highest level to the previous level
366         if (channels_level >= speed_level && channels_level >= width_level && !fixed_channels)
367         {
368                 format->channels = thresholds[channels_level - 1].channels;
369                 return true;
370         }
371         if (speed_level >= width_level && !fixed_speed)
372         {
373                 format->speed = thresholds[speed_level - 1].speed;
374                 return true;
375         }
376
377         format->width = thresholds[width_level - 1].width;
378         return true;
379 }
380
381
382 #define SWAP_LISTENERS(l1, l2, tmpl) { tmpl = (l1); (l1) = (l2); (l2) = tmpl; }
383
384 static void S_SetChannelLayout (void)
385 {
386         unsigned int i;
387         listener_t swaplistener;
388         listener_t *listeners;
389         int layout;
390
391         for (i = 0; i < SND_SPEAKERLAYOUTS; i++)
392                 if (snd_speakerlayouts[i].channels == snd_renderbuffer->format.channels)
393                         break;
394         if (i >= SND_SPEAKERLAYOUTS)
395         {
396                 Con_Printf("S_SetChannelLayout: can't find the speaker layout for %hu channels. Defaulting to mono output\n",
397                                    snd_renderbuffer->format.channels);
398                 i = SND_SPEAKERLAYOUTS - 1;
399         }
400
401         snd_speakerlayout = snd_speakerlayouts[i];
402         listeners = snd_speakerlayout.listeners;
403
404         // Swap the left and right channels if snd_swapstereo is set
405         if (boolxor(snd_swapstereo.integer, v_flipped.integer))
406         {
407                 switch (snd_speakerlayout.channels)
408                 {
409                         case 8:
410                                 SWAP_LISTENERS(listeners[6], listeners[7], swaplistener);
411                                 // no break
412                         case 4:
413                         case 6:
414                                 SWAP_LISTENERS(listeners[2], listeners[3], swaplistener);
415                                 // no break
416                         case 2:
417                                 SWAP_LISTENERS(listeners[0], listeners[1], swaplistener);
418                                 break;
419
420                         default:
421                         case 1:
422                                 // Nothing to do
423                                 break;
424                 }
425         }
426
427         // Sanity check
428         if (snd_channellayout.integer < SND_CHANNELLAYOUT_AUTO ||
429                 snd_channellayout.integer > SND_CHANNELLAYOUT_ALSA)
430                 Cvar_SetValueQuick (&snd_channellayout, SND_CHANNELLAYOUT_STANDARD);
431
432         if (snd_channellayout.integer == SND_CHANNELLAYOUT_AUTO)
433         {
434                 // If we're in the sound engine initialization
435                 if (current_channellayout_used == SND_CHANNELLAYOUT_AUTO)
436                 {
437                         layout = SND_CHANNELLAYOUT_STANDARD;
438                         Cvar_SetValueQuick (&snd_channellayout, layout);
439                 }
440                 else
441                         layout = current_channellayout_used;
442         }
443         else
444                 layout = snd_channellayout.integer;
445
446         // Convert our layout (= ALSA) to the standard layout if necessary
447         if (snd_speakerlayout.channels == 6 || snd_speakerlayout.channels == 8)
448         {
449                 if (layout == SND_CHANNELLAYOUT_STANDARD)
450                 {
451                         SWAP_LISTENERS(listeners[2], listeners[4], swaplistener);
452                         SWAP_LISTENERS(listeners[3], listeners[5], swaplistener);
453                 }
454
455                 Con_Printf("S_SetChannelLayout: using %s speaker layout for 3D sound\n",
456                                    (layout == SND_CHANNELLAYOUT_ALSA) ? "ALSA" : "standard");
457         }
458
459         current_swapstereo = boolxor(snd_swapstereo.integer, v_flipped.integer);
460         current_channellayout = snd_channellayout.integer;
461         current_channellayout_used = layout;
462 }
463
464
465 void S_Startup (void)
466 {
467         qboolean fixed_speed, fixed_width, fixed_channels;
468         snd_format_t chosen_fmt;
469         static snd_format_t prev_render_format = {0, 0, 0};
470         const char* env;
471         int i;
472
473         if (!snd_initialized.integer)
474                 return;
475
476         fixed_speed = false;
477         fixed_width = false;
478         fixed_channels = false;
479
480         // Get the starting sound format from the cvars
481         chosen_fmt.speed = snd_speed.integer;
482         chosen_fmt.width = snd_width.integer;
483         chosen_fmt.channels = snd_channels.integer;
484
485         // Check the environment variables to see if the player wants a particular sound format
486         env = getenv("QUAKE_SOUND_CHANNELS");
487         if (env != NULL)
488         {
489                 chosen_fmt.channels = atoi (env);
490                 fixed_channels = true;
491         }
492         env = getenv("QUAKE_SOUND_SPEED");
493         if (env != NULL)
494         {
495                 chosen_fmt.speed = atoi (env);
496                 fixed_speed = true;
497         }
498         env = getenv("QUAKE_SOUND_SAMPLEBITS");
499         if (env != NULL)
500         {
501                 chosen_fmt.width = atoi (env) / 8;
502                 fixed_width = true;
503         }
504
505         // Parse the command line to see if the player wants a particular sound format
506 // COMMANDLINEOPTION: Sound: -sndquad sets sound output to 4 channel surround
507         if (COM_CheckParm ("-sndquad") != 0)
508         {
509                 chosen_fmt.channels = 4;
510                 fixed_channels = true;
511         }
512 // COMMANDLINEOPTION: Sound: -sndstereo sets sound output to stereo
513         else if (COM_CheckParm ("-sndstereo") != 0)
514         {
515                 chosen_fmt.channels = 2;
516                 fixed_channels = true;
517         }
518 // COMMANDLINEOPTION: Sound: -sndmono sets sound output to mono
519         else if (COM_CheckParm ("-sndmono") != 0)
520         {
521                 chosen_fmt.channels = 1;
522                 fixed_channels = true;
523         }
524 // COMMANDLINEOPTION: Sound: -sndspeed <hz> chooses sound output rate (supported values are 48000, 44100, 32000, 24000, 22050, 16000, 11025 (quake), 8000)
525         i = COM_CheckParm ("-sndspeed");
526         if (0 < i && i < com_argc - 1)
527         {
528                 chosen_fmt.speed = atoi (com_argv[i + 1]);
529                 fixed_speed = true;
530         }
531 // COMMANDLINEOPTION: Sound: -sndbits <bits> chooses 8 bit or 16 bit sound output
532         i = COM_CheckParm ("-sndbits");
533         if (0 < i && i < com_argc - 1)
534         {
535                 chosen_fmt.width = atoi (com_argv[i + 1]) / 8;
536                 fixed_width = true;
537         }
538
539         // You can't change sound speed after start time (not yet supported)
540         if (prev_render_format.speed != 0)
541         {
542                 fixed_speed = true;
543                 if (chosen_fmt.speed != prev_render_format.speed)
544                 {
545                         Con_Printf("S_Startup: sound speed has changed! This is NOT supported yet. Falling back to previous speed (%u Hz)\n",
546                                            prev_render_format.speed);
547                         chosen_fmt.speed = prev_render_format.speed;
548                 }
549         }
550
551         // Sanity checks
552         if (chosen_fmt.speed < SND_MIN_SPEED)
553         {
554                 chosen_fmt.speed = SND_MIN_SPEED;
555                 fixed_speed = false;
556         }
557         else if (chosen_fmt.speed > SND_MAX_SPEED)
558         {
559                 chosen_fmt.speed = SND_MAX_SPEED;
560                 fixed_speed = false;
561         }
562
563         if (chosen_fmt.width < SND_MIN_WIDTH)
564         {
565                 chosen_fmt.width = SND_MIN_WIDTH;
566                 fixed_width = false;
567         }
568         else if (chosen_fmt.width > SND_MAX_WIDTH)
569         {
570                 chosen_fmt.width = SND_MAX_WIDTH;
571                 fixed_width = false;
572         }
573
574         if (chosen_fmt.channels < SND_MIN_CHANNELS)
575         {
576                 chosen_fmt.channels = SND_MIN_CHANNELS;
577                 fixed_channels = false;
578         }
579         else if (chosen_fmt.channels > SND_MAX_CHANNELS)
580         {
581                 chosen_fmt.channels = SND_MAX_CHANNELS;
582                 fixed_channels = false;
583         }
584
585         // create the sound buffer used for sumitting the samples to the plaform-dependent module
586         if (!simsound)
587         {
588                 snd_format_t suggest_fmt;
589                 qboolean accepted;
590
591                 accepted = false;
592                 do
593                 {
594                         Con_DPrintf("S_Startup: initializing sound output format: %dHz, %d bit, %d channels...\n",
595                                                 chosen_fmt.speed, chosen_fmt.width * 8,
596                                                 chosen_fmt.channels);
597
598                         memset(&suggest_fmt, 0, sizeof(suggest_fmt));
599                         accepted = SndSys_Init(&chosen_fmt, &suggest_fmt);
600
601                         if (!accepted)
602                         {
603                                 Con_DPrintf("S_Startup: sound output initialization FAILED\n");
604
605                                 // If the module is suggesting another one
606                                 if (suggest_fmt.speed != 0)
607                                 {
608                                         memcpy(&chosen_fmt, &suggest_fmt, sizeof(chosen_fmt));
609                                         Con_Printf ("           Driver has suggested %dHz, %d bit, %d channels. Retrying...\n",
610                                                                 suggest_fmt.speed, suggest_fmt.width * 8,
611                                                                 suggest_fmt.channels);
612                                 }
613                                 // Else, try to find a less resource-demanding format
614                                 else if (!S_ChooseCheaperFormat (&chosen_fmt, fixed_speed, fixed_width, fixed_channels))
615                                         break;
616                         }
617                 } while (!accepted);
618
619                 // If we haven't found a suitable format
620                 if (!accepted)
621                 {
622                         Con_Print("S_Startup: SndSys_Init failed.\n");
623                         sound_spatialized = false;
624                         return;
625                 }
626         }
627         else
628         {
629                 snd_renderbuffer = Snd_CreateRingBuffer(&chosen_fmt, 0, NULL);
630                 Con_Print ("S_Startup: simulating sound output\n");
631         }
632
633         memcpy(&prev_render_format, &snd_renderbuffer->format, sizeof(prev_render_format));
634         Con_Printf("Sound format: %dHz, %d channels, %d bits per sample\n",
635                            chosen_fmt.speed, chosen_fmt.channels, chosen_fmt.width * 8);
636
637         // Update the cvars
638         if (snd_speed.integer != (int)chosen_fmt.speed)
639                 Cvar_SetValueQuick(&snd_speed, chosen_fmt.speed);
640         if (snd_width.integer != chosen_fmt.width)
641                 Cvar_SetValueQuick(&snd_width, chosen_fmt.width);
642         if (snd_channels.integer != chosen_fmt.channels)
643                 Cvar_SetValueQuick(&snd_channels, chosen_fmt.channels);
644
645         current_channellayout_used = SND_CHANNELLAYOUT_AUTO;
646         S_SetChannelLayout();
647
648         snd_starttime = realtime;
649
650         // If the sound module has already run, add an extra time to make sure
651         // the sound time doesn't decrease, to not confuse playing SFXs
652         if (oldpaintedtime != 0)
653         {
654                 // The extra time must be a multiple of the render buffer size
655                 // to avoid modifying the current position in the buffer,
656                 // some modules write directly to a shared (DMA) buffer
657                 extrasoundtime = oldpaintedtime + snd_renderbuffer->maxframes - 1;
658                 extrasoundtime -= extrasoundtime % snd_renderbuffer->maxframes;
659                 Con_DPrintf("S_Startup: extra sound time = %u\n", extrasoundtime);
660
661                 soundtime = extrasoundtime;
662         }
663         else
664                 extrasoundtime = 0;
665         snd_renderbuffer->startframe = soundtime;
666         snd_renderbuffer->endframe = soundtime;
667         recording_sound = false;
668 }
669
670 void S_Shutdown(void)
671 {
672         if (snd_renderbuffer == NULL)
673                 return;
674
675         oldpaintedtime = snd_renderbuffer->endframe;
676
677         if (simsound)
678         {
679                 Mem_Free(snd_renderbuffer->ring);
680                 Mem_Free(snd_renderbuffer);
681                 snd_renderbuffer = NULL;
682         }
683         else
684                 SndSys_Shutdown();
685
686         sound_spatialized = false;
687 }
688
689 void S_Restart_f(void)
690 {
691         S_Shutdown();
692         S_Startup();
693 }
694
695 /*
696 ================
697 S_Init
698 ================
699 */
700 void S_Init(void)
701 {
702         Con_DPrint("\nSound Initialization\n");
703
704         Cvar_RegisterVariable(&volume);
705         Cvar_RegisterVariable(&bgmvolume);
706         Cvar_RegisterVariable(&snd_staticvolume);
707
708         Cvar_RegisterVariable(&snd_speed);
709         Cvar_RegisterVariable(&snd_width);
710         Cvar_RegisterVariable(&snd_channels);
711         Cvar_RegisterVariable(&snd_mutewhenidle);
712
713 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
714         if (COM_CheckParm("-nosound"))
715                 return;
716
717         snd_mempool = Mem_AllocPool("sound", 0, NULL);
718
719 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
720         if (COM_CheckParm("-simsound"))
721                 simsound = true;
722
723         Cmd_AddCommand("play", S_Play_f, "play a sound at your current location (not heard by anyone else)");
724         Cmd_AddCommand("play2", S_Play2_f, "play a sound globally throughout the level (not heard by anyone else)");
725         Cmd_AddCommand("playvol", S_PlayVol_f, "play a sound at the specified volume level at your current location (not heard by anyone else)");
726         Cmd_AddCommand("stopsound", S_StopAllSounds, "silence");
727         Cmd_AddCommand("soundlist", S_SoundList_f, "list loaded sounds");
728         Cmd_AddCommand("soundinfo", S_SoundInfo_f, "print sound system information (such as channels and speed)");
729         Cmd_AddCommand("snd_restart", S_Restart_f, "restart sound system");
730         Cmd_AddCommand("snd_unloadallsounds", S_UnloadAllSounds_f, "unload all sound files");
731
732         Cvar_RegisterVariable(&nosound);
733         Cvar_RegisterVariable(&snd_precache);
734         Cvar_RegisterVariable(&snd_initialized);
735         Cvar_RegisterVariable(&snd_streaming);
736         Cvar_RegisterVariable(&ambient_level);
737         Cvar_RegisterVariable(&ambient_fade);
738         Cvar_RegisterVariable(&snd_noextraupdate);
739         Cvar_RegisterVariable(&snd_show);
740         Cvar_RegisterVariable(&_snd_mixahead);
741         Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
742         Cvar_RegisterVariable(&snd_channellayout);
743         Cvar_RegisterVariable(&snd_soundradius);
744
745         Cvar_SetValueQuick(&snd_initialized, true);
746
747         known_sfx = NULL;
748
749         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
750         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
751
752         OGG_OpenLibrary ();
753 }
754
755
756 /*
757 ================
758 S_Terminate
759
760 Shutdown and free all resources
761 ================
762 */
763 void S_Terminate (void)
764 {
765         S_Shutdown ();
766         OGG_CloseLibrary ();
767
768         // Free all SFXs
769         while (known_sfx != NULL)
770                 S_FreeSfx (known_sfx, true);
771
772         Cvar_SetValueQuick (&snd_initialized, false);
773         Mem_FreePool (&snd_mempool);
774 }
775
776
777 /*
778 ==================
779 S_UnloadAllSounds_f
780 ==================
781 */
782 void S_UnloadAllSounds_f (void)
783 {
784         int i;
785
786         // stop any active sounds
787         S_StopAllSounds();
788
789         // because the ambient sounds will be freed, clear the pointers
790         for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
791                 ambient_sfxs[i] = NULL;
792
793         // now free all sounds
794         while (known_sfx != NULL)
795                 S_FreeSfx (known_sfx, true);
796 }
797
798
799 /*
800 ==================
801 S_FindName
802 ==================
803 */
804 sfx_t *S_FindName (const char *name)
805 {
806         sfx_t *sfx;
807
808         if (!snd_initialized.integer)
809                 return NULL;
810
811         if (strlen (name) >= sizeof (sfx->name))
812         {
813                 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
814                 return NULL;
815         }
816
817         // Look for this sound in the list of known sfx
818         // TODO: hash table search?
819         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
820                 if(!strcmp (sfx->name, name))
821                         return sfx;
822
823         // Add a sfx_t struct for this sound
824         sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
825         memset (sfx, 0, sizeof(*sfx));
826         strlcpy (sfx->name, name, sizeof (sfx->name));
827         sfx->memsize = sizeof(*sfx);
828         sfx->next = known_sfx;
829         known_sfx = sfx;
830
831         return sfx;
832 }
833
834
835 /*
836 ==================
837 S_FreeSfx
838 ==================
839 */
840 void S_FreeSfx (sfx_t *sfx, qboolean force)
841 {
842         unsigned int i;
843
844         // Never free a locked sfx unless forced
845         if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
846                 return;
847
848         Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
849
850         // Remove it from the list of known sfx
851         if (sfx == known_sfx)
852                 known_sfx = known_sfx->next;
853         else
854         {
855                 sfx_t *prev_sfx;
856
857                 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
858                         if (prev_sfx->next == sfx)
859                         {
860                                 prev_sfx->next = sfx->next;
861                                 break;
862                         }
863                 if (prev_sfx == NULL)
864                 {
865                         Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
866                         return;
867                 }
868         }
869
870         // Stop all channels using this sfx
871         for (i = 0; i < total_channels; i++)
872                 if (channels[i].sfx == sfx)
873                         S_StopChannel (i);
874
875         // Free it
876         if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
877                 sfx->fetcher->free (sfx);
878         Mem_Free (sfx);
879 }
880
881
882 /*
883 ==================
884 S_ServerSounds
885 ==================
886 */
887 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
888 {
889         sfx_t *sfx;
890         sfx_t *sfxnext;
891         unsigned int i;
892
893         // Start the ambient sounds and make them loop
894         for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
895         {
896                 // Precache it if it's not done (request a lock to make sure it will never be freed)
897                 if (ambient_sfxs[i] == NULL)
898                         ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
899                 if (ambient_sfxs[i] != NULL)
900                 {
901                         // Add a lock to the SFX while playing. It will be
902                         // removed by S_StopAllSounds at the end of the level
903                         S_LockSfx (ambient_sfxs[i]);
904
905                         channels[i].sfx = ambient_sfxs[i];
906                         channels[i].flags |= CHANNELFLAG_FORCELOOP;
907                         channels[i].master_vol = 0;
908                 }
909         }
910
911         // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
912         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
913                 if (sfx->flags & SFXFLAG_SERVERSOUND)
914                 {
915                         S_UnlockSfx (sfx);
916                         sfx->flags &= ~SFXFLAG_SERVERSOUND;
917                 }
918
919         // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
920         for (i = 1; i < numsounds; i++)
921         {
922                 sfx = S_FindName (serversound[i]);
923                 if (sfx != NULL)
924                 {
925                         // clear the FILEMISSING flag so that S_LoadSound will try again on a
926                         // previously missing file
927                         sfx->flags &= ~ SFXFLAG_FILEMISSING;
928                         S_LockSfx (sfx);
929                         sfx->flags |= SFXFLAG_SERVERSOUND;
930                 }
931         }
932
933         // Free all unlocked sfx
934         for (sfx = known_sfx;sfx;sfx = sfxnext)
935         {
936                 sfxnext = sfx->next;
937                 S_FreeSfx (sfx, false);
938         }
939 }
940
941
942 /*
943 ==================
944 S_PrecacheSound
945 ==================
946 */
947 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
948 {
949         sfx_t *sfx;
950
951         if (!snd_initialized.integer)
952                 return NULL;
953
954         if (name == NULL || name[0] == 0)
955                 return NULL;
956
957         sfx = S_FindName (name);
958
959         if (sfx == NULL)
960                 return NULL;
961
962         // clear the FILEMISSING flag so that S_LoadSound will try again on a
963         // previously missing file
964         sfx->flags &= ~ SFXFLAG_FILEMISSING;
965
966         if (lock)
967                 S_LockSfx (sfx);
968
969         if (!nosound.integer && snd_precache.integer)
970                 S_LoadSound(sfx, complain);
971
972         return sfx;
973 }
974
975 /*
976 ==================
977 S_IsSoundPrecached
978 ==================
979 */
980 qboolean S_IsSoundPrecached (const sfx_t *sfx)
981 {
982         return (sfx != NULL && sfx->fetcher != NULL);
983 }
984
985 /*
986 ==================
987 S_LockSfx
988
989 Add a lock to a SFX
990 ==================
991 */
992 void S_LockSfx (sfx_t *sfx)
993 {
994         sfx->locks++;
995 }
996
997 /*
998 ==================
999 S_UnlockSfx
1000
1001 Remove a lock from a SFX
1002 ==================
1003 */
1004 void S_UnlockSfx (sfx_t *sfx)
1005 {
1006         sfx->locks--;
1007 }
1008
1009
1010 /*
1011 ==================
1012 S_BlockSound
1013 ==================
1014 */
1015 void S_BlockSound (void)
1016 {
1017         snd_blocked++;
1018 }
1019
1020
1021 /*
1022 ==================
1023 S_UnblockSound
1024 ==================
1025 */
1026 void S_UnblockSound (void)
1027 {
1028         snd_blocked--;
1029 }
1030
1031
1032 /*
1033 =================
1034 SND_PickChannel
1035
1036 Picks a channel based on priorities, empty slots, number of channels
1037 =================
1038 */
1039 channel_t *SND_PickChannel(int entnum, int entchannel)
1040 {
1041         int ch_idx;
1042         int first_to_die;
1043         int first_life_left, life_left;
1044         channel_t* ch;
1045
1046 // Check for replacement sound, or find the best one to replace
1047         first_to_die = -1;
1048         first_life_left = 0x7fffffff;
1049
1050         // entity channels try to replace the existing sound on the channel
1051         if (entchannel != 0)
1052         {
1053                 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1054                 {
1055                         ch = &channels[ch_idx];
1056                         if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1057                         {
1058                                 // always override sound from same entity
1059                                 S_StopChannel (ch_idx);
1060                                 return &channels[ch_idx];
1061                         }
1062                 }
1063         }
1064
1065         // there was no channel to override, so look for the first empty one
1066         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1067         {
1068                 ch = &channels[ch_idx];
1069                 if (!ch->sfx)
1070                 {
1071                         // no sound on this channel
1072                         first_to_die = ch_idx;
1073                         break;
1074                 }
1075
1076                 // don't let monster sounds override player sounds
1077                 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1078                         continue;
1079
1080                 // don't override looped sounds
1081                 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1082                         continue;
1083                 life_left = ch->sfx->total_length - ch->pos;
1084
1085                 if (life_left < first_life_left)
1086                 {
1087                         first_life_left = life_left;
1088                         first_to_die = ch_idx;
1089                 }
1090         }
1091
1092         if (first_to_die == -1)
1093                 return NULL;
1094
1095         return &channels[first_to_die];
1096 }
1097
1098 /*
1099 =================
1100 SND_Spatialize
1101
1102 Spatializes a channel
1103 =================
1104 */
1105 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1106 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1107 {
1108         int i;
1109         vec_t dist, mastervol, intensity, vol;
1110         vec3_t source_vec;
1111
1112         // update sound origin if we know about the entity
1113         if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1114         {
1115                 if (ch->entnum >= 32768)
1116                 {
1117                         // TODO: sounds that follow CSQC entities?
1118                 }
1119                 else if (cl.entities[ch->entnum].state_current.active)
1120                 {
1121                         //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]);
1122                         VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1123                         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)
1124                                 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);
1125                 }
1126         }
1127
1128         mastervol = ch->master_vol;
1129         // Adjust volume of static sounds
1130         if (isstatic)
1131                 mastervol *= snd_staticvolume.value;
1132
1133         // anything coming from the view entity will always be full volume
1134         // LordHavoc: make sounds with ATTN_NONE have no spatialization
1135         if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1136         {
1137                 for (i = 0;i < SND_LISTENERS;i++)
1138                 {
1139                         vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1140                         ch->listener_volume[i] = (int)bound(0, vol, 255);
1141                 }
1142         }
1143         else
1144         {
1145                 // calculate stereo seperation and distance attenuation
1146                 VectorSubtract(listener_origin, ch->origin, source_vec);
1147                 dist = VectorLength(source_vec);
1148                 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1149                 if (intensity > 0)
1150                 {
1151                         for (i = 0;i < SND_LISTENERS;i++)
1152                         {
1153                                 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1154                                 VectorNormalize(source_vec);
1155                                 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1156                                 ch->listener_volume[i] = (int)bound(0, vol, 255);
1157                         }
1158                 }
1159                 else
1160                         for (i = 0;i < SND_LISTENERS;i++)
1161                                 ch->listener_volume[i] = 0;
1162         }
1163 }
1164
1165
1166 // =======================================================================
1167 // Start a sound effect
1168 // =======================================================================
1169
1170 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1171 {
1172         // Initialize the channel
1173         memset (target_chan, 0, sizeof (*target_chan));
1174         VectorCopy (origin, target_chan->origin);
1175         target_chan->master_vol = (int)(fvol * 255);
1176         target_chan->sfx = sfx;
1177         target_chan->flags = flags;
1178         target_chan->pos = 0; // start of the sound
1179
1180         // If it's a static sound
1181         if (isstatic)
1182         {
1183                 if (sfx->loopstart >= sfx->total_length)
1184                         Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1185                 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1186         }
1187         else
1188                 target_chan->dist_mult = attenuation / snd_soundradius.value;
1189
1190         // Lock the SFX during play
1191         S_LockSfx (sfx);
1192 }
1193
1194
1195 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1196 {
1197         channel_t *target_chan, *check;
1198         int             ch_idx;
1199
1200         if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1201                 return -1;
1202
1203         if (sfx->fetcher == NULL)
1204                 return -1;
1205
1206         // Pick a channel to play on
1207         target_chan = SND_PickChannel(entnum, entchannel);
1208         if (!target_chan)
1209                 return -1;
1210
1211         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1212         target_chan->entnum = entnum;
1213         target_chan->entchannel = entchannel;
1214
1215         SND_Spatialize(target_chan, false);
1216
1217         // if an identical sound has also been started this frame, offset the pos
1218         // a bit to keep it from just making the first one louder
1219         check = &channels[NUM_AMBIENTS];
1220         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1221         {
1222                 if (check == target_chan)
1223                         continue;
1224                 if (check->sfx == sfx && !check->pos)
1225                 {
1226                         // use negative pos offset to delay this sound effect
1227                         target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1228                         break;
1229                 }
1230         }
1231
1232         return (target_chan - channels);
1233 }
1234
1235 void S_StopChannel (unsigned int channel_ind)
1236 {
1237         channel_t *ch;
1238
1239         if (channel_ind >= total_channels)
1240                 return;
1241
1242         ch = &channels[channel_ind];
1243         if (ch->sfx != NULL)
1244         {
1245                 sfx_t *sfx = ch->sfx;
1246
1247                 if (sfx->fetcher != NULL)
1248                 {
1249                         snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1250                         if (fetcher_endsb != NULL)
1251                                 fetcher_endsb (ch);
1252                 }
1253
1254                 // Remove the lock it holds
1255                 S_UnlockSfx (sfx);
1256
1257                 ch->sfx = NULL;
1258         }
1259 }
1260
1261
1262 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1263 {
1264         if (ch_ind >= total_channels)
1265                 return false;
1266
1267         if (flag != CHANNELFLAG_FORCELOOP &&
1268                 flag != CHANNELFLAG_PAUSED &&
1269                 flag != CHANNELFLAG_FULLVOLUME)
1270                 return false;
1271
1272         if (value)
1273                 channels[ch_ind].flags |= flag;
1274         else
1275                 channels[ch_ind].flags &= ~flag;
1276
1277         return true;
1278 }
1279
1280 void S_StopSound(int entnum, int entchannel)
1281 {
1282         unsigned int i;
1283
1284         for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1285                 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1286                 {
1287                         S_StopChannel (i);
1288                         return;
1289                 }
1290 }
1291
1292 extern void CDAudio_Stop(void);
1293 void S_StopAllSounds (void)
1294 {
1295         unsigned int i;
1296
1297         // TOCHECK: is this test necessary?
1298         if (snd_renderbuffer == NULL)
1299                 return;
1300
1301         // stop CD audio because it may be using a faketrack
1302         CDAudio_Stop();
1303
1304         for (i = 0; i < total_channels; i++)
1305                 S_StopChannel (i);
1306
1307         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
1308         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1309
1310         // Mute the contents of the submittion buffer
1311         if (simsound || SndSys_LockRenderBuffer ())
1312         {
1313                 int clear;
1314                 size_t memsize;
1315
1316                 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1317                 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1318                 memset(snd_renderbuffer->ring, clear, memsize);
1319
1320                 if (!simsound)
1321                         SndSys_UnlockRenderBuffer ();
1322         }
1323 }
1324
1325 void S_PauseGameSounds (qboolean toggle)
1326 {
1327         unsigned int i;
1328
1329         for (i = 0; i < total_channels; i++)
1330         {
1331                 channel_t *ch;
1332
1333                 ch = &channels[i];
1334                 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1335                         S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1336         }
1337 }
1338
1339 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1340 {
1341         channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1342 }
1343
1344
1345 /*
1346 =================
1347 S_StaticSound
1348 =================
1349 */
1350 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1351 {
1352         channel_t       *target_chan;
1353
1354         if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1355                 return;
1356         if (!sfx->fetcher)
1357         {
1358                 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1359                 return;
1360         }
1361
1362         if (total_channels == MAX_CHANNELS)
1363         {
1364                 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1365                 return;
1366         }
1367
1368         target_chan = &channels[total_channels++];
1369         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1370
1371         SND_Spatialize (target_chan, true);
1372 }
1373
1374
1375 /*
1376 ===================
1377 S_UpdateAmbientSounds
1378 ===================
1379 */
1380 void S_UpdateAmbientSounds (void)
1381 {
1382         int                     i;
1383         int                     vol;
1384         int                     ambient_channel;
1385         channel_t       *chan;
1386         unsigned char           ambientlevels[NUM_AMBIENTS];
1387
1388         memset(ambientlevels, 0, sizeof(ambientlevels));
1389         if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1390                 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1391
1392         // Calc ambient sound levels
1393         for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1394         {
1395                 chan = &channels[ambient_channel];
1396                 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1397                         continue;
1398
1399                 vol = (int)ambientlevels[ambient_channel];
1400                 if (vol < 8)
1401                         vol = 0;
1402
1403                 // Don't adjust volume too fast
1404                 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1405                 if (cl.time > cl.oldtime)
1406                 {
1407                         if (chan->master_vol < vol)
1408                         {
1409                                 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1410                                 if (chan->master_vol > vol)
1411                                         chan->master_vol = vol;
1412                         }
1413                         else if (chan->master_vol > vol)
1414                         {
1415                                 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1416                                 if (chan->master_vol < vol)
1417                                         chan->master_vol = vol;
1418                         }
1419                 }
1420
1421                 for (i = 0;i < SND_LISTENERS;i++)
1422                         chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1423         }
1424 }
1425
1426 static void S_PaintAndSubmit (void)
1427 {
1428         unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1429         qboolean usesoundtimehack;
1430         static qboolean soundtimehack = true;
1431
1432         if (snd_renderbuffer == NULL || nosound.integer)
1433                 return;
1434
1435         // Update sound time
1436         usesoundtimehack = true;
1437         if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1438                 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1439         else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1440                 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1441         else if (simsound)
1442                 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1443         else
1444         {
1445                 newsoundtime = SndSys_GetSoundTime();
1446                 usesoundtimehack = false;
1447         }
1448         // if the soundtimehack state changes we need to reset the soundtime
1449         if (soundtimehack != usesoundtimehack)
1450         {
1451                 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1452
1453                 // Mute the contents of the submission buffer
1454                 if (simsound || SndSys_LockRenderBuffer ())
1455                 {
1456                         int clear;
1457                         size_t memsize;
1458
1459                         clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1460                         memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1461                         memset(snd_renderbuffer->ring, clear, memsize);
1462
1463                         if (!simsound)
1464                                 SndSys_UnlockRenderBuffer ();
1465                 }
1466         }
1467         soundtimehack = usesoundtimehack;
1468
1469         if (!soundtimehack && snd_blocked > 0)
1470                 return;
1471
1472         newsoundtime += extrasoundtime;
1473         if (newsoundtime < soundtime)
1474         {
1475                 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1476                 {
1477                         unsigned int additionaltime;
1478
1479                         // add some time to extrasoundtime make newsoundtime higher
1480
1481                         // The extra time must be a multiple of the render buffer size
1482                         // to avoid modifying the current position in the buffer,
1483                         // some modules write directly to a shared (DMA) buffer
1484                         additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1485                         additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1486
1487                         extrasoundtime += additionaltime;
1488                         newsoundtime += additionaltime;
1489                         Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1490                                                 extrasoundtime);
1491                 }
1492                 else if (!soundtimehack)
1493                         Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1494                                            newsoundtime, soundtime);
1495         }
1496         soundtime = newsoundtime;
1497         recording_sound = (cls.capturevideo.soundrate != 0);
1498
1499         // Check to make sure that we haven't overshot
1500         paintedtime = snd_renderbuffer->endframe;
1501         if (paintedtime < soundtime)
1502                 paintedtime = soundtime;
1503
1504         // mix ahead of current position
1505         endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1506         usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1507         maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1508         endtime = min(endtime, maxtime);
1509
1510         S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1511
1512         if (simsound)
1513                 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1514         else
1515                 SndSys_Submit();
1516 }
1517
1518 /*
1519 ============
1520 S_Update
1521
1522 Called once each time through the main loop
1523 ============
1524 */
1525 void S_Update(const matrix4x4_t *listenermatrix)
1526 {
1527         unsigned int i, j, total;
1528         channel_t *ch, *combine;
1529         matrix4x4_t basematrix, rotatematrix;
1530
1531         if (snd_renderbuffer == NULL || nosound.integer)
1532                 return;
1533
1534         // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1535         if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1536                 current_channellayout != snd_channellayout.integer)
1537                 S_SetChannelLayout();
1538
1539         Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1540         Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1541
1542         // calculate the current matrices
1543         for (j = 0;j < SND_LISTENERS;j++)
1544         {
1545                 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1546                 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1547                 // I think this should now do this:
1548                 //   1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1549                 //      (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1550                 //       angle has to be taken negative)
1551                 //   2. create a transform which first rotates and moves its argument
1552                 //      into the player's view coordinates (using basematrix which is
1553                 //      an inverted "absolute" listener matrix), then applies the
1554                 //      rotation matrix for the ear
1555                 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1556                 // does not actually refer to an entity?
1557         }
1558
1559         // update general area ambient sound sources
1560         S_UpdateAmbientSounds ();
1561
1562         combine = NULL;
1563
1564         // update spatialization for static and dynamic sounds
1565         ch = channels+NUM_AMBIENTS;
1566         for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1567         {
1568                 if (!ch->sfx)
1569                         continue;
1570
1571                 // respatialize channel
1572                 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1573
1574                 // try to combine static sounds with a previous channel of the same
1575                 // sound effect so we don't mix five torches every frame
1576                 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1577                 {
1578                         // no need to merge silent channels
1579                         for (j = 0;j < SND_LISTENERS;j++)
1580                                 if (ch->listener_volume[j])
1581                                         break;
1582                         if (j == SND_LISTENERS)
1583                                 continue;
1584                         // if the last combine chosen isn't suitable, find a new one
1585                         if (!(combine && combine != ch && combine->sfx == ch->sfx))
1586                         {
1587                                 // search for one
1588                                 combine = NULL;
1589                                 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1590                                 {
1591                                         if (channels[j].sfx == ch->sfx)
1592                                         {
1593                                                 combine = channels + j;
1594                                                 break;
1595                                         }
1596                                 }
1597                         }
1598                         if (combine && combine != ch && combine->sfx == ch->sfx)
1599                         {
1600                                 for (j = 0;j < SND_LISTENERS;j++)
1601                                 {
1602                                         combine->listener_volume[j] += ch->listener_volume[j];
1603                                         ch->listener_volume[j] = 0;
1604                                 }
1605                         }
1606                 }
1607         }
1608
1609         sound_spatialized = true;
1610
1611         // debugging output
1612         if (snd_show.integer)
1613         {
1614                 total = 0;
1615                 ch = channels;
1616                 for (i=0 ; i<total_channels; i++, ch++)
1617                 {
1618                         if (ch->sfx)
1619                         {
1620                                 for (j = 0;j < SND_LISTENERS;j++)
1621                                         if (ch->listener_volume[j])
1622                                                 break;
1623                                 if (j < SND_LISTENERS)
1624                                         total++;
1625                         }
1626                 }
1627
1628                 Con_Printf("----(%u)----\n", total);
1629         }
1630
1631         S_PaintAndSubmit();
1632 }
1633
1634 void S_ExtraUpdate (void)
1635 {
1636         if (snd_noextraupdate.integer || !sound_spatialized)
1637                 return;
1638
1639         S_PaintAndSubmit();
1640 }
1641
1642 qboolean S_LocalSound (const char *sound)
1643 {
1644         sfx_t   *sfx;
1645         int             ch_ind;
1646
1647         if (!snd_initialized.integer || nosound.integer)
1648                 return true;
1649
1650         sfx = S_PrecacheSound (sound, true, false);
1651         if (!sfx)
1652         {
1653                 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1654                 return false;
1655         }
1656
1657         // Local sounds must not be freed
1658         sfx->flags |= SFXFLAG_PERMANENTLOCK;
1659
1660         ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1661         if (ch_ind < 0)
1662                 return false;
1663
1664         channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
1665         return true;
1666 }