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