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