snd_main.c

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