snd_main.c

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