snd_main.c

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