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