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