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