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