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