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