snd_main.c

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