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