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