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