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