snd_main.c

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