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