snd_main.c

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