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