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