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 }
 763
 764
 765 /*
 766 ================
 767 S_Terminate
 768
 769 Shutdown and free all resources
 770 ================
 771 */
 772 void S_Terminate (void)
 773 {
 774         S_Shutdown ();
 775         OGG_CloseLibrary ();
 776
 777         // Free all SFXs
 778         while (known_sfx != NULL)
 779                 S_FreeSfx (known_sfx, true);
 780
 781         Cvar_SetValueQuick (&snd_initialized, false);
 782         Mem_FreePool (&snd_mempool);
 783 }
 784
 785
 786 /*
 787 ==================
 788 S_UnloadAllSounds_f
 789 ==================
 790 */
 791 void S_UnloadAllSounds_f (void)
 792 {
 793         int i;
 794
 795         // NOTE: we can't free all sounds if we are running a map (this frees sfx_t that are still referenced by precaches)
 796         // So, refuse to do this if we are connected.
 797         if(cls.state == ca_connected)
 798         {
 799                 Con_Printf("snd_unloadallsounds would wreak havoc if you do that while connected!\n");
 800                 return;
 801         }
 802
 803         // stop any active sounds
 804         S_StopAllSounds();
 805
 806         // because the ambient sounds will be freed, clear the pointers
 807         for (i = 0;i < (int)sizeof (ambient_sfxs) / (int)sizeof (ambient_sfxs[0]);i++)
 808                 ambient_sfxs[i] = NULL;
 809
 810         // now free all sounds
 811         while (known_sfx != NULL)
 812                 S_FreeSfx (known_sfx, true);
 813 }
 814
 815
 816 /*
 817 ==================
 818 S_FindName
 819 ==================
 820 */
 821 sfx_t *S_FindName (const char *name)
 822 {
 823         sfx_t *sfx;
 824
 825         if (!snd_initialized.integer)
 826                 return NULL;
 827
 828         if (strlen (name) >= sizeof (sfx->name))
 829         {
 830                 Con_Printf ("S_FindName: sound name too long (%s)\n", name);
 831                 return NULL;
 832         }
 833
 834         // Look for this sound in the list of known sfx
 835         // TODO: hash table search?
 836         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
 837                 if(!strcmp (sfx->name, name))
 838                         return sfx;
 839
 840         // Add a sfx_t struct for this sound
 841         sfx = (sfx_t *)Mem_Alloc (snd_mempool, sizeof (*sfx));
 842         memset (sfx, 0, sizeof(*sfx));
 843         strlcpy (sfx->name, name, sizeof (sfx->name));
 844         sfx->memsize = sizeof(*sfx);
 845         sfx->next = known_sfx;
 846         known_sfx = sfx;
 847
 848         return sfx;
 849 }
 850
 851
 852 /*
 853 ==================
 854 S_FreeSfx
 855 ==================
 856 */
 857 void S_FreeSfx (sfx_t *sfx, qboolean force)
 858 {
 859         unsigned int i;
 860
 861         // Never free a locked sfx unless forced
 862         if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
 863                 return;
 864
 865         Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
 866
 867         // Remove it from the list of known sfx
 868         if (sfx == known_sfx)
 869                 known_sfx = known_sfx->next;
 870         else
 871         {
 872                 sfx_t *prev_sfx;
 873
 874                 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
 875                         if (prev_sfx->next == sfx)
 876                         {
 877                                 prev_sfx->next = sfx->next;
 878                                 break;
 879                         }
 880                 if (prev_sfx == NULL)
 881                 {
 882                         Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
 883                         return;
 884                 }
 885         }
 886
 887         // Stop all channels using this sfx
 888         for (i = 0; i < total_channels; i++)
 889                 if (channels[i].sfx == sfx)
 890                         S_StopChannel (i);
 891
 892         // Free it
 893         if (sfx->fetcher != NULL && sfx->fetcher->free != NULL)
 894                 sfx->fetcher->free (sfx->fetcher_data);
 895         Mem_Free (sfx);
 896 }
 897
 898
 899 /*
 900 ==================
 901 S_ServerSounds
 902 ==================
 903 */
 904 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
 905 {
 906         sfx_t *sfx;
 907         sfx_t *sfxnext;
 908         unsigned int i;
 909
 910         // Start the ambient sounds and make them loop
 911         for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
 912         {
 913                 // Precache it if it's not done (request a lock to make sure it will never be freed)
 914                 if (ambient_sfxs[i] == NULL)
 915                         ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
 916                 if (ambient_sfxs[i] != NULL)
 917                 {
 918                         // Add a lock to the SFX while playing. It will be
 919                         // removed by S_StopAllSounds at the end of the level
 920                         S_LockSfx (ambient_sfxs[i]);
 921
 922                         channels[i].sfx = ambient_sfxs[i];
 923                         channels[i].flags |= CHANNELFLAG_FORCELOOP;
 924                         channels[i].master_vol = 0;
 925                 }
 926         }
 927
 928         // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
 929         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
 930                 if (sfx->flags & SFXFLAG_SERVERSOUND)
 931                 {
 932                         S_UnlockSfx (sfx);
 933                         sfx->flags &= ~SFXFLAG_SERVERSOUND;
 934                 }
 935
 936         // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
 937         for (i = 1; i < numsounds; i++)
 938         {
 939                 sfx = S_FindName (serversound[i]);
 940                 if (sfx != NULL)
 941                 {
 942                         // clear the FILEMISSING flag so that S_LoadSound will try again on a
 943                         // previously missing file
 944                         sfx->flags &= ~ SFXFLAG_FILEMISSING;
 945                         S_LockSfx (sfx);
 946                         sfx->flags |= SFXFLAG_SERVERSOUND;
 947                 }
 948         }
 949
 950         // Free all unlocked sfx
 951         for (sfx = known_sfx;sfx;sfx = sfxnext)
 952         {
 953                 sfxnext = sfx->next;
 954                 S_FreeSfx (sfx, false);
 955         }
 956 }
 957
 958
 959 /*
 960 ==================
 961 S_PrecacheSound
 962 ==================
 963 */
 964 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
 965 {
 966         sfx_t *sfx;
 967
 968         if (!snd_initialized.integer)
 969                 return NULL;
 970
 971         if (name == NULL || name[0] == 0)
 972                 return NULL;
 973
 974         sfx = S_FindName (name);
 975
 976         if (sfx == NULL)
 977                 return NULL;
 978
 979         // clear the FILEMISSING flag so that S_LoadSound will try again on a
 980         // previously missing file
 981         sfx->flags &= ~ SFXFLAG_FILEMISSING;
 982
 983         if (lock)
 984                 S_LockSfx (sfx);
 985
 986         if (!nosound.integer && snd_precache.integer)
 987                 S_LoadSound(sfx, complain);
 988
 989         return sfx;
 990 }
 991
 992 /*
 993 ==================
 994 S_IsSoundPrecached
 995 ==================
 996 */
 997 qboolean S_IsSoundPrecached (const sfx_t *sfx)
 998 {
 999         return (sfx != NULL && sfx->fetcher != NULL);
1000 }
1001
1002 /*
1003 ==================
1004 S_LockSfx
1005
1006 Add a lock to a SFX
1007 ==================
1008 */
1009 void S_LockSfx (sfx_t *sfx)
1010 {
1011         sfx->locks++;
1012 }
1013
1014 /*
1015 ==================
1016 S_UnlockSfx
1017
1018 Remove a lock from a SFX
1019 ==================
1020 */
1021 void S_UnlockSfx (sfx_t *sfx)
1022 {
1023         sfx->locks--;
1024 }
1025
1026
1027 /*
1028 ==================
1029 S_BlockSound
1030 ==================
1031 */
1032 void S_BlockSound (void)
1033 {
1034         snd_blocked++;
1035 }
1036
1037
1038 /*
1039 ==================
1040 S_UnblockSound
1041 ==================
1042 */
1043 void S_UnblockSound (void)
1044 {
1045         snd_blocked--;
1046 }
1047
1048
1049 /*
1050 =================
1051 SND_PickChannel
1052
1053 Picks a channel based on priorities, empty slots, number of channels
1054 =================
1055 */
1056 channel_t *SND_PickChannel(int entnum, int entchannel)
1057 {
1058         int ch_idx;
1059         int first_to_die;
1060         int first_life_left, life_left;
1061         channel_t* ch;
1062
1063 // Check for replacement sound, or find the best one to replace
1064         first_to_die = -1;
1065         first_life_left = 0x7fffffff;
1066
1067         // entity channels try to replace the existing sound on the channel
1068         if (entchannel != 0)
1069         {
1070                 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1071                 {
1072                         ch = &channels[ch_idx];
1073                         if (ch->entnum == entnum && (ch->entchannel == entchannel || entchannel == -1) )
1074                         {
1075                                 // always override sound from same entity
1076                                 S_StopChannel (ch_idx);
1077                                 return &channels[ch_idx];
1078                         }
1079                 }
1080         }
1081
1082         // there was no channel to override, so look for the first empty one
1083         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
1084         {
1085                 ch = &channels[ch_idx];
1086                 if (!ch->sfx)
1087                 {
1088                         // no sound on this channel
1089                         first_to_die = ch_idx;
1090                         break;
1091                 }
1092
1093                 // don't let monster sounds override player sounds
1094                 if (ch->entnum == cl.viewentity && entnum != cl.viewentity)
1095                         continue;
1096
1097                 // don't override looped sounds
1098                 if ((ch->flags & CHANNELFLAG_FORCELOOP) || ch->sfx->loopstart < ch->sfx->total_length)
1099                         continue;
1100                 life_left = ch->sfx->total_length - ch->pos;
1101
1102                 if (life_left < first_life_left)
1103                 {
1104                         first_life_left = life_left;
1105                         first_to_die = ch_idx;
1106                 }
1107         }
1108
1109         if (first_to_die == -1)
1110                 return NULL;
1111
1112         return &channels[first_to_die];
1113 }
1114
1115 /*
1116 =================
1117 SND_Spatialize
1118
1119 Spatializes a channel
1120 =================
1121 */
1122 extern cvar_t cl_gameplayfix_soundsmovewithentities;
1123 void SND_Spatialize(channel_t *ch, qboolean isstatic)
1124 {
1125         int i;
1126         vec_t dist, mastervol, intensity, vol;
1127         vec3_t source_vec;
1128
1129         // update sound origin if we know about the entity
1130         if (ch->entnum > 0 && cls.state == ca_connected && cl_gameplayfix_soundsmovewithentities.integer)
1131         {
1132                 if (ch->entnum >= 32768)
1133                 {
1134                         // TODO: sounds that follow CSQC entities?
1135                 }
1136                 else if (cl.entities[ch->entnum].state_current.active)
1137                 {
1138                         //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]);
1139                         VectorCopy(cl.entities[ch->entnum].state_current.origin, ch->origin);
1140                         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)
1141                                 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);
1142                 }
1143         }
1144
1145         mastervol = ch->master_vol;
1146         // Adjust volume of static sounds
1147         if (isstatic)
1148                 mastervol *= snd_staticvolume.value;
1149
1150         // anything coming from the view entity will always be full volume
1151         // LordHavoc: make sounds with ATTN_NONE have no spatialization
1152         if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
1153         {
1154                 for (i = 0;i < SND_LISTENERS;i++)
1155                 {
1156                         vol = mastervol * snd_speakerlayout.listeners[i].ambientvolume;
1157                         ch->listener_volume[i] = (int)bound(0, vol, 255);
1158                 }
1159         }
1160         else
1161         {
1162                 // calculate stereo seperation and distance attenuation
1163                 VectorSubtract(listener_origin, ch->origin, source_vec);
1164                 dist = VectorLength(source_vec);
1165                 intensity = mastervol * (1.0 - dist * ch->dist_mult);
1166                 if (intensity > 0)
1167                 {
1168                         for (i = 0;i < SND_LISTENERS;i++)
1169                         {
1170                                 Matrix4x4_Transform(&listener_matrix[i], ch->origin, source_vec);
1171                                 VectorNormalize(source_vec);
1172                                 vol = intensity * max(0, source_vec[0] * snd_speakerlayout.listeners[i].dotscale + snd_speakerlayout.listeners[i].dotbias);
1173                                 ch->listener_volume[i] = (int)bound(0, vol, 255);
1174                         }
1175                 }
1176                 else
1177                         for (i = 0;i < SND_LISTENERS;i++)
1178                                 ch->listener_volume[i] = 0;
1179         }
1180 }
1181
1182
1183 // =======================================================================
1184 // Start a sound effect
1185 // =======================================================================
1186
1187 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
1188 {
1189         // Initialize the channel
1190         memset (target_chan, 0, sizeof (*target_chan));
1191         VectorCopy (origin, target_chan->origin);
1192         target_chan->sfx = sfx;
1193         target_chan->flags = flags;
1194         target_chan->pos = 0; // start of the sound
1195
1196         // If it's a static sound
1197         if (isstatic)
1198         {
1199                 if (sfx->loopstart >= sfx->total_length)
1200                         Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
1201                 target_chan->dist_mult = attenuation / (64.0f * snd_soundradius.value);
1202         }
1203         else
1204                 target_chan->dist_mult = attenuation / snd_soundradius.value;
1205
1206         // Lock the SFX during play
1207         S_LockSfx (sfx);
1208
1209         // and finally, apply the volume
1210         S_SetChannelVolume(target_chan - channels, fvol);
1211 }
1212
1213
1214 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1215 {
1216         channel_t *target_chan, *check;
1217         int             ch_idx;
1218
1219         if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1220                 return -1;
1221
1222         if (sfx->fetcher == NULL)
1223                 return -1;
1224
1225         // Pick a channel to play on
1226         target_chan = SND_PickChannel(entnum, entchannel);
1227         if (!target_chan)
1228                 return -1;
1229
1230         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
1231         target_chan->entnum = entnum;
1232         target_chan->entchannel = entchannel;
1233
1234         SND_Spatialize(target_chan, false);
1235
1236         // if an identical sound has also been started this frame, offset the pos
1237         // a bit to keep it from just making the first one louder
1238         check = &channels[NUM_AMBIENTS];
1239         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
1240         {
1241                 if (check == target_chan)
1242                         continue;
1243                 if (check->sfx == sfx && !check->pos)
1244                 {
1245                         // use negative pos offset to delay this sound effect
1246                         target_chan->pos += (int)lhrandom(0, -0.1 * snd_renderbuffer->format.speed);
1247                         break;
1248                 }
1249         }
1250
1251         return (target_chan - channels);
1252 }
1253
1254 void S_StopChannel (unsigned int channel_ind)
1255 {
1256         channel_t *ch;
1257
1258         if (channel_ind >= total_channels)
1259                 return;
1260
1261         ch = &channels[channel_ind];
1262         if (ch->sfx != NULL)
1263         {
1264                 sfx_t *sfx = ch->sfx;
1265
1266                 if (sfx->fetcher != NULL)
1267                 {
1268                         snd_fetcher_endsb_t fetcher_endsb = sfx->fetcher->endsb;
1269                         if (fetcher_endsb != NULL)
1270                                 fetcher_endsb (ch->fetcher_data);
1271                 }
1272
1273                 // Remove the lock it holds
1274                 S_UnlockSfx (sfx);
1275
1276                 ch->fetcher_data = NULL;
1277                 ch->sfx = NULL;
1278         }
1279 }
1280
1281
1282 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
1283 {
1284         if (ch_ind >= total_channels)
1285                 return false;
1286
1287         if (flag != CHANNELFLAG_FORCELOOP &&
1288                 flag != CHANNELFLAG_PAUSED &&
1289                 flag != CHANNELFLAG_FULLVOLUME)
1290                 return false;
1291
1292         if (value)
1293                 channels[ch_ind].flags |= flag;
1294         else
1295                 channels[ch_ind].flags &= ~flag;
1296
1297         return true;
1298 }
1299
1300 void S_StopSound(int entnum, int entchannel)
1301 {
1302         unsigned int i;
1303
1304         for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
1305                 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
1306                 {
1307                         S_StopChannel (i);
1308                         return;
1309                 }
1310 }
1311
1312 extern void CDAudio_Stop(void);
1313 void S_StopAllSounds (void)
1314 {
1315         unsigned int i;
1316
1317         // TOCHECK: is this test necessary?
1318         if (snd_renderbuffer == NULL)
1319                 return;
1320
1321         // stop CD audio because it may be using a faketrack
1322         CDAudio_Stop();
1323
1324         for (i = 0; i < total_channels; i++)
1325                 S_StopChannel (i);
1326
1327         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
1328         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
1329
1330         // Mute the contents of the submittion buffer
1331         if (simsound || SndSys_LockRenderBuffer ())
1332         {
1333                 int clear;
1334                 size_t memsize;
1335
1336                 clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1337                 memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1338                 memset(snd_renderbuffer->ring, clear, memsize);
1339
1340                 if (!simsound)
1341                         SndSys_UnlockRenderBuffer ();
1342         }
1343 }
1344
1345 void S_PauseGameSounds (qboolean toggle)
1346 {
1347         unsigned int i;
1348
1349         for (i = 0; i < total_channels; i++)
1350         {
1351                 channel_t *ch;
1352
1353                 ch = &channels[i];
1354                 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
1355                         S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
1356         }
1357 }
1358
1359 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
1360 {
1361         sfx_t *sfx = channels[ch_ind].sfx;
1362         if(sfx->volume_peak > 0)
1363         {
1364                 // Replaygain support
1365                 // Con_DPrintf("Setting volume on ReplayGain-enabled track... %f -> ", fvol);
1366                 fvol *= sfx->volume_mult;
1367                 if(fvol * sfx->volume_peak > 1)
1368                         fvol = 1 / sfx->volume_peak;
1369                 // Con_DPrintf("%f\n", fvol);
1370         }
1371         channels[ch_ind].master_vol = (int)(fvol * 255.0f);
1372 }
1373
1374
1375 /*
1376 =================
1377 S_StaticSound
1378 =================
1379 */
1380 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
1381 {
1382         channel_t       *target_chan;
1383
1384         if (snd_renderbuffer == NULL || sfx == NULL || nosound.integer)
1385                 return;
1386         if (!sfx->fetcher)
1387         {
1388                 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
1389                 return;
1390         }
1391
1392         if (total_channels == MAX_CHANNELS)
1393         {
1394                 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
1395                 return;
1396         }
1397
1398         target_chan = &channels[total_channels++];
1399         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
1400
1401         SND_Spatialize (target_chan, true);
1402 }
1403
1404
1405 /*
1406 ===================
1407 S_UpdateAmbientSounds
1408 ===================
1409 */
1410 void S_UpdateAmbientSounds (void)
1411 {
1412         int                     i;
1413         int                     vol;
1414         int                     ambient_channel;
1415         channel_t       *chan;
1416         unsigned char           ambientlevels[NUM_AMBIENTS];
1417
1418         memset(ambientlevels, 0, sizeof(ambientlevels));
1419         if (cl.worldmodel && cl.worldmodel->brush.AmbientSoundLevelsForPoint)
1420                 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
1421
1422         // Calc ambient sound levels
1423         for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
1424         {
1425                 chan = &channels[ambient_channel];
1426                 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
1427                         continue;
1428
1429                 vol = (int)ambientlevels[ambient_channel];
1430                 if (vol < 8)
1431                         vol = 0;
1432
1433                 // Don't adjust volume too fast
1434                 // FIXME: this rounds off to an int each frame, meaning there is little to no fade at extremely high framerates!
1435                 if (cl.time > cl.oldtime)
1436                 {
1437                         if (chan->master_vol < vol)
1438                         {
1439                                 chan->master_vol += (int)((cl.time - cl.oldtime) * ambient_fade.value);
1440                                 if (chan->master_vol > vol)
1441                                         chan->master_vol = vol;
1442                         }
1443                         else if (chan->master_vol > vol)
1444                         {
1445                                 chan->master_vol -= (int)((cl.time - cl.oldtime) * ambient_fade.value);
1446                                 if (chan->master_vol < vol)
1447                                         chan->master_vol = vol;
1448                         }
1449                 }
1450
1451                 for (i = 0;i < SND_LISTENERS;i++)
1452                         chan->listener_volume[i] = (int)(chan->master_vol * ambient_level.value * snd_speakerlayout.listeners[i].ambientvolume);
1453         }
1454 }
1455
1456 static void S_PaintAndSubmit (void)
1457 {
1458         unsigned int newsoundtime, paintedtime, endtime, maxtime, usedframes;
1459         qboolean usesoundtimehack;
1460         static qboolean soundtimehack = true;
1461
1462         if (snd_renderbuffer == NULL || nosound.integer)
1463                 return;
1464
1465         // Update sound time
1466         usesoundtimehack = true;
1467         if (cls.timedemo) // SUPER NASTY HACK to mix non-realtime sound for more reliable benchmarking
1468                 newsoundtime = (unsigned int)((double)cl.mtime[0] * (double)snd_renderbuffer->format.speed);
1469         else if (cls.capturevideo.soundrate && !cls.capturevideo.realtime) // SUPER NASTY HACK to record non-realtime sound
1470                 newsoundtime = (unsigned int)((double)cls.capturevideo.frame * (double)snd_renderbuffer->format.speed / (double)cls.capturevideo.framerate);
1471         else if (simsound)
1472                 newsoundtime = (unsigned int)((realtime - snd_starttime) * (double)snd_renderbuffer->format.speed);
1473         else
1474         {
1475                 newsoundtime = SndSys_GetSoundTime();
1476                 usesoundtimehack = false;
1477         }
1478         // if the soundtimehack state changes we need to reset the soundtime
1479         if (soundtimehack != usesoundtimehack)
1480         {
1481                 snd_renderbuffer->startframe = snd_renderbuffer->endframe = soundtime = newsoundtime;
1482
1483                 // Mute the contents of the submission buffer
1484                 if (simsound || SndSys_LockRenderBuffer ())
1485                 {
1486                         int clear;
1487                         size_t memsize;
1488
1489                         clear = (snd_renderbuffer->format.width == 1) ? 0x80 : 0;
1490                         memsize = snd_renderbuffer->maxframes * snd_renderbuffer->format.width * snd_renderbuffer->format.channels;
1491                         memset(snd_renderbuffer->ring, clear, memsize);
1492
1493                         if (!simsound)
1494                                 SndSys_UnlockRenderBuffer ();
1495                 }
1496         }
1497         soundtimehack = usesoundtimehack;
1498
1499         if (!soundtimehack && snd_blocked > 0)
1500                 return;
1501
1502         newsoundtime += extrasoundtime;
1503         if (newsoundtime < soundtime)
1504         {
1505                 if ((cls.capturevideo.soundrate != 0) != recording_sound)
1506                 {
1507                         unsigned int additionaltime;
1508
1509                         // add some time to extrasoundtime make newsoundtime higher
1510
1511                         // The extra time must be a multiple of the render buffer size
1512                         // to avoid modifying the current position in the buffer,
1513                         // some modules write directly to a shared (DMA) buffer
1514                         additionaltime = (soundtime - newsoundtime) + snd_renderbuffer->maxframes - 1;
1515                         additionaltime -= additionaltime % snd_renderbuffer->maxframes;
1516
1517                         extrasoundtime += additionaltime;
1518                         newsoundtime += additionaltime;
1519                         Con_DPrintf("S_PaintAndSubmit: new extra sound time = %u\n",
1520                                                 extrasoundtime);
1521                 }
1522                 else if (!soundtimehack)
1523                         Con_Printf("S_PaintAndSubmit: WARNING: newsoundtime < soundtime (%u < %u)\n",
1524                                            newsoundtime, soundtime);
1525         }
1526         soundtime = newsoundtime;
1527         recording_sound = (cls.capturevideo.soundrate != 0);
1528
1529         // Check to make sure that we haven't overshot
1530         paintedtime = snd_renderbuffer->endframe;
1531         if (paintedtime < soundtime)
1532                 paintedtime = soundtime;
1533
1534         // mix ahead of current position
1535         endtime = soundtime + (unsigned int)(_snd_mixahead.value * (float)snd_renderbuffer->format.speed);
1536         usedframes = snd_renderbuffer->endframe - snd_renderbuffer->startframe;
1537         maxtime = paintedtime + snd_renderbuffer->maxframes - usedframes;
1538         endtime = min(endtime, maxtime);
1539
1540         S_PaintChannels(snd_renderbuffer, paintedtime, endtime);
1541
1542         if (simsound)
1543                 snd_renderbuffer->startframe = snd_renderbuffer->endframe;
1544         else
1545                 SndSys_Submit();
1546 }
1547
1548 /*
1549 ============
1550 S_Update
1551
1552 Called once each time through the main loop
1553 ============
1554 */
1555 void S_Update(const matrix4x4_t *listenermatrix)
1556 {
1557         unsigned int i, j, total;
1558         channel_t *ch, *combine;
1559         matrix4x4_t basematrix, rotatematrix;
1560
1561         if (snd_renderbuffer == NULL || nosound.integer)
1562                 return;
1563
1564         // If snd_swapstereo or snd_channellayout has changed, recompute the channel layout
1565         if (current_swapstereo != boolxor(snd_swapstereo.integer, v_flipped.integer) ||
1566                 current_channellayout != snd_channellayout.integer)
1567                 S_SetChannelLayout();
1568
1569         Matrix4x4_Invert_Simple(&basematrix, listenermatrix);
1570         Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
1571
1572         // calculate the current matrices
1573         for (j = 0;j < SND_LISTENERS;j++)
1574         {
1575                 Matrix4x4_CreateFromQuakeEntity(&rotatematrix, 0, 0, 0, 0, -snd_speakerlayout.listeners[j].yawangle, 0, 1);
1576                 Matrix4x4_Concat(&listener_matrix[j], &rotatematrix, &basematrix);
1577                 // I think this should now do this:
1578                 //   1. create a rotation matrix for rotating by e.g. -90 degrees CCW
1579                 //      (note: the matrix will rotate the OBJECT, not the VIEWER, so its
1580                 //       angle has to be taken negative)
1581                 //   2. create a transform which first rotates and moves its argument
1582                 //      into the player's view coordinates (using basematrix which is
1583                 //      an inverted "absolute" listener matrix), then applies the
1584                 //      rotation matrix for the ear
1585                 // Isn't Matrix4x4_CreateFromQuakeEntity a bit misleading because this
1586                 // does not actually refer to an entity?
1587         }
1588
1589         // update general area ambient sound sources
1590         S_UpdateAmbientSounds ();
1591
1592         combine = NULL;
1593
1594         // update spatialization for static and dynamic sounds
1595         ch = channels+NUM_AMBIENTS;
1596         for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
1597         {
1598                 if (!ch->sfx)
1599                         continue;
1600
1601                 // respatialize channel
1602                 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);
1603
1604                 // try to combine static sounds with a previous channel of the same
1605                 // sound effect so we don't mix five torches every frame
1606                 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
1607                 {
1608                         // no need to merge silent channels
1609                         for (j = 0;j < SND_LISTENERS;j++)
1610                                 if (ch->listener_volume[j])
1611                                         break;
1612                         if (j == SND_LISTENERS)
1613                                 continue;
1614                         // if the last combine chosen isn't suitable, find a new one
1615                         if (!(combine && combine != ch && combine->sfx == ch->sfx))
1616                         {
1617                                 // search for one
1618                                 combine = NULL;
1619                                 for (j = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;j < i;j++)
1620                                 {
1621                                         if (channels[j].sfx == ch->sfx)
1622                                         {
1623                                                 combine = channels + j;
1624                                                 break;
1625                                         }
1626                                 }
1627                         }
1628                         if (combine && combine != ch && combine->sfx == ch->sfx)
1629                         {
1630                                 for (j = 0;j < SND_LISTENERS;j++)
1631                                 {
1632                                         combine->listener_volume[j] += ch->listener_volume[j];
1633                                         ch->listener_volume[j] = 0;
1634                                 }
1635                         }
1636                 }
1637         }
1638
1639         sound_spatialized = true;
1640
1641         // debugging output
1642         if (snd_show.integer)
1643         {
1644                 total = 0;
1645                 ch = channels;
1646                 for (i=0 ; i<total_channels; i++, ch++)
1647                 {
1648                         if (ch->sfx)
1649                         {
1650                                 for (j = 0;j < SND_LISTENERS;j++)
1651                                         if (ch->listener_volume[j])
1652                                                 break;
1653                                 if (j < SND_LISTENERS)
1654                                         total++;
1655                         }
1656                 }
1657
1658                 Con_Printf("----(%u)----\n", total);
1659         }
1660
1661         S_PaintAndSubmit();
1662 }
1663
1664 void S_ExtraUpdate (void)
1665 {
1666         if (snd_noextraupdate.integer || !sound_spatialized)
1667                 return;
1668
1669         S_PaintAndSubmit();
1670 }
1671
1672 qboolean S_LocalSound (const char *sound)
1673 {
1674         sfx_t   *sfx;
1675         int             ch_ind;
1676
1677         if (!snd_initialized.integer || nosound.integer)
1678                 return true;
1679
1680         sfx = S_PrecacheSound (sound, true, false);
1681         if (!sfx)
1682         {
1683                 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1684                 return false;
1685         }
1686
1687         // Local sounds must not be freed
1688         sfx->flags |= SFXFLAG_PERMANENTLOCK;
1689
1690         ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1691         if (ch_ind < 0)
1692                 return false;
1693
1694         channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
1695         return true;
1696 }