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