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