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