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