snd_main.c

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