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 void S_Play(void);
  29 void S_PlayVol(void);
  30 void S_Play2(void);
  31 void S_SoundList(void);
  32 void S_Update_();
  33
  34
  35 // =======================================================================
  36 // Internal sound data & structures
  37 // =======================================================================
  38
  39 channel_t channels[MAX_CHANNELS];
  40 unsigned int total_channels;
  41
  42 int snd_blocked = 0;
  43 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0"};
  44 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1"};
  45
  46 volatile dma_t *shm = 0;
  47 volatile dma_t sn;
  48
  49 vec3_t listener_origin;
  50 matrix4x4_t listener_matrix;
  51 vec_t sound_nominal_clip_dist=1000.0;
  52 mempool_t *snd_mempool;
  53
  54 int soundtime;
  55 int paintedtime;
  56
  57 // Linked list of known sfx
  58 sfx_t *known_sfx = NULL;
  59
  60 qboolean sound_started = false;
  61 qboolean sound_spatialized = false;
  62
  63 // Fake dma is a synchronous faking of the DMA progress used for
  64 // isolating performance in the renderer.
  65 qboolean fakedma = false;
  66
  67 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1"};
  68 cvar_t volume = {CVAR_SAVE, "volume", "0.7"};
  69 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1"};
  70
  71 cvar_t nosound = {0, "nosound", "0"};
  72 cvar_t snd_precache = {0, "snd_precache", "1"};
  73 cvar_t bgmbuffer = {0, "bgmbuffer", "4096"};
  74 cvar_t ambient_level = {0, "ambient_level", "0.3"};
  75 cvar_t ambient_fade = {0, "ambient_fade", "100"};
  76 cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0"};
  77 cvar_t snd_show = {0, "snd_show", "0"};
  78 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1"};
  79 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0"};
  80
  81 // Ambient sounds
  82 sfx_t* ambient_sfxs [2] = { NULL, NULL };
  83 const char* ambient_names [2] = { "sound/ambience/water1.wav", "sound/ambience/wind2.wav" };
  84
  85
  86 // ====================================================================
  87 // Functions
  88 // ====================================================================
  89
  90 void S_FreeSfx (sfx_t *sfx, qboolean force);
  91
  92
  93 void S_SoundInfo_f(void)
  94 {
  95         if (!sound_started)
  96         {
  97                 Con_Print("sound system not started\n");
  98                 return;
  99         }
 100
 101         Con_Printf("%5d stereo\n", shm->format.channels - 1);
 102         Con_Printf("%5d samples\n", shm->samples);
 103         Con_Printf("%5d samplepos\n", shm->samplepos);
 104         Con_Printf("%5d samplebits\n", shm->format.width * 8);
 105         Con_Printf("%5d speed\n", shm->format.speed);
 106         Con_Printf("%p dma buffer\n", shm->buffer);
 107         Con_Printf("%5u total_channels\n", total_channels);
 108 }
 109
 110
 111 void S_Startup(void)
 112 {
 113         if (!snd_initialized.integer)
 114                 return;
 115
 116         shm = &sn;
 117         memset((void *)shm, 0, sizeof(*shm));
 118
 119         // create a piece of DMA memory
 120         if (fakedma)
 121         {
 122                 shm->format.width = 2;
 123                 shm->format.speed = 22050;
 124                 shm->format.channels = 2;
 125                 shm->samples = 32768;
 126                 shm->samplepos = 0;
 127                 shm->buffer = Mem_Alloc(snd_mempool, shm->format.channels * shm->samples * shm->format.width);
 128         }
 129         else
 130         {
 131                 if (!SNDDMA_Init())
 132                 {
 133                         Con_Print("S_Startup: SNDDMA_Init failed.\n");
 134                         shm = NULL;
 135                         sound_started = false;
 136                         sound_spatialized = false;
 137                         return;
 138                 }
 139         }
 140
 141         sound_started = true;
 142
 143         Con_Printf("Sound format: %dHz, %d bit, %d channels\n", shm->format.speed,
 144                            shm->format.width * 8, shm->format.channels);
 145 }
 146
 147 void S_Shutdown(void)
 148 {
 149         if (!sound_started)
 150                 return;
 151
 152         if (fakedma)
 153                 Mem_Free(shm->buffer);
 154         else
 155                 SNDDMA_Shutdown();
 156
 157         shm = NULL;
 158         sound_started = false;
 159         sound_spatialized = false;
 160 }
 161
 162 void S_Restart_f(void)
 163 {
 164         S_Shutdown();
 165         S_Startup();
 166 }
 167
 168 /*
 169 ================
 170 S_Init
 171 ================
 172 */
 173 void S_Init(void)
 174 {
 175         Con_DPrint("\nSound Initialization\n");
 176
 177         Cvar_RegisterVariable(&volume);
 178         Cvar_RegisterVariable(&bgmvolume);
 179         Cvar_RegisterVariable(&snd_staticvolume);
 180
 181 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
 182         if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
 183                 return;
 184
 185         snd_mempool = Mem_AllocPool("sound", 0, NULL);
 186
 187 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
 188         if (COM_CheckParm("-simsound"))
 189                 fakedma = true;
 190
 191         Cmd_AddCommand("play", S_Play);
 192         Cmd_AddCommand("play2", S_Play2);
 193         Cmd_AddCommand("playvol", S_PlayVol);
 194         Cmd_AddCommand("stopsound", S_StopAllSounds);
 195         Cmd_AddCommand("soundlist", S_SoundList);
 196         Cmd_AddCommand("soundinfo", S_SoundInfo_f);
 197         Cmd_AddCommand("snd_restart", S_Restart_f);
 198
 199         Cvar_RegisterVariable(&nosound);
 200         Cvar_RegisterVariable(&snd_precache);
 201         Cvar_RegisterVariable(&snd_initialized);
 202         Cvar_RegisterVariable(&snd_streaming);
 203         Cvar_RegisterVariable(&bgmbuffer);
 204         Cvar_RegisterVariable(&ambient_level);
 205         Cvar_RegisterVariable(&ambient_fade);
 206         Cvar_RegisterVariable(&snd_noextraupdate);
 207         Cvar_RegisterVariable(&snd_show);
 208         Cvar_RegisterVariable(&_snd_mixahead);
 209         Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
 210
 211         Cvar_SetValueQuick(&snd_initialized, true);
 212
 213         known_sfx = NULL;
 214
 215         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
 216         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
 217
 218         OGG_OpenLibrary ();
 219 }
 220
 221
 222 /*
 223 ================
 224 S_Terminate
 225
 226 Shutdown and free all resources
 227 ================
 228 */
 229 void S_Terminate (void)
 230 {
 231         S_Shutdown ();
 232         OGG_CloseLibrary ();
 233
 234         // Free all SFXs
 235         while (known_sfx != NULL)
 236                 S_FreeSfx (known_sfx, true);
 237
 238         Cvar_SetValueQuick (&snd_initialized, false);
 239         Mem_FreePool (&snd_mempool);
 240 }
 241
 242
 243 // =======================================================================
 244 // Load a sound
 245 // =======================================================================
 246
 247 /*
 248 ==================
 249 S_FindName
 250
 251 ==================
 252 */
 253 sfx_t *S_FindName (const char *name)
 254 {
 255         sfx_t *sfx;
 256
 257         if (!snd_initialized.integer)
 258                 return NULL;
 259
 260         if (strlen (name) >= sizeof (sfx->name))
 261         {
 262                 Con_Printf ("S_FindName: sound name too long (%s)", name);
 263                 return NULL;
 264         }
 265
 266         // Look for this sound in the list of known sfx
 267         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
 268                 if(!strcmp (sfx->name, name))
 269                         return sfx;
 270
 271         // Add a sfx_t struct for this sound
 272         sfx = Mem_Alloc (snd_mempool, sizeof (*sfx));
 273         memset (sfx, 0, sizeof(*sfx));
 274         strlcpy (sfx->name, name, sizeof (sfx->name));
 275         sfx->next = known_sfx;
 276         known_sfx = sfx;
 277
 278         return sfx;
 279 }
 280
 281
 282 /*
 283 ==================
 284 S_FreeSfx
 285
 286 ==================
 287 */
 288 void S_FreeSfx (sfx_t *sfx, qboolean force)
 289 {
 290         // Never free a locked sfx unless forced
 291         if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
 292                 return;
 293
 294         Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
 295
 296         // Remove it from the list of known sfx
 297         if (sfx == known_sfx)
 298                 known_sfx = known_sfx->next;
 299         else
 300         {
 301                 sfx_t *prev_sfx;
 302
 303                 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
 304                         if (prev_sfx->next == sfx)
 305                         {
 306                                 prev_sfx->next = sfx->next;
 307                                 break;
 308                         }
 309                 if (prev_sfx == NULL)
 310                 {
 311                         Con_Printf ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
 312                         return;
 313                 }
 314         }
 315
 316         // Free it
 317         Mem_FreePool (&sfx->mempool);
 318         Mem_Free (sfx);
 319 }
 320
 321
 322 /*
 323 ==================
 324 S_ServerSounds
 325
 326 ==================
 327 */
 328 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
 329 {
 330         sfx_t *sfx;
 331         sfx_t *sfxnext;
 332         unsigned int i;
 333
 334         // Start the ambient sounds and make them loop
 335         for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
 336         {
 337                 // Precache it if it's not done (request a lock to make sure it will never be freed)
 338                 if (ambient_sfxs[i] == NULL)
 339                         ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
 340                 if (ambient_sfxs[i] != NULL)
 341                 {
 342                         // Add a lock to the SFX while playing. It will be
 343                         // removed by S_StopAllSounds at the end of the level
 344                         S_LockSfx (ambient_sfxs[i]);
 345
 346                         channels[i].sfx = ambient_sfxs[i];
 347                         channels[i].flags |= CHANNELFLAG_FORCELOOP;
 348                         channels[i].master_vol = 0;
 349                 }
 350         }
 351
 352         // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
 353         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
 354                 if (sfx->flags & SFXFLAG_SERVERSOUND)
 355                 {
 356                         S_UnlockSfx (sfx);
 357                         sfx->flags &= ~SFXFLAG_SERVERSOUND;
 358                 }
 359
 360         // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
 361         for (i = 1; i < numsounds; i++)
 362         {
 363                 sfx = S_FindName (serversound[i]);
 364                 if (sfx != NULL)
 365                 {
 366                         S_LockSfx (sfx);
 367                         sfx->flags |= SFXFLAG_SERVERSOUND;
 368                 }
 369         }
 370
 371         // Free all unlocked sfx
 372         for (sfx = known_sfx;sfx;sfx = sfxnext)
 373         {
 374                 sfxnext = sfx->next;
 375                 S_FreeSfx (sfx, false);
 376         }
 377 }
 378
 379
 380 /*
 381 ==================
 382 S_PrecacheSound
 383
 384 ==================
 385 */
 386 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
 387 {
 388         sfx_t *sfx;
 389
 390         if (!snd_initialized.integer)
 391                 return NULL;
 392
 393         sfx = S_FindName (name);
 394         if (sfx == NULL)
 395                 return NULL;
 396
 397         if (lock)
 398                 S_LockSfx (sfx);
 399
 400         if (!nosound.integer && snd_precache.integer)
 401                 S_LoadSound(sfx, complain);
 402
 403         return sfx;
 404 }
 405
 406 /*
 407 ==================
 408 S_LockSfx
 409
 410 Add a lock to a SFX
 411 ==================
 412 */
 413 void S_LockSfx (sfx_t *sfx)
 414 {
 415         sfx->locks++;
 416 }
 417
 418 /*
 419 ==================
 420 S_UnlockSfx
 421
 422 Remove a lock from a SFX
 423 ==================
 424 */
 425 void S_UnlockSfx (sfx_t *sfx)
 426 {
 427         sfx->locks--;
 428 }
 429
 430
 431 //=============================================================================
 432
 433 /*
 434 =================
 435 SND_PickChannel
 436
 437 Picks a channel based on priorities, empty slots, number of channels
 438 =================
 439 */
 440 channel_t *SND_PickChannel(int entnum, int entchannel)
 441 {
 442         int ch_idx;
 443         int first_to_die;
 444         int life_left;
 445         channel_t* ch;
 446
 447 // Check for replacement sound, or find the best one to replace
 448         first_to_die = -1;
 449         life_left = 0x7fffffff;
 450         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
 451         {
 452                 ch = &channels[ch_idx];
 453                 if (entchannel != 0             // channel 0 never overrides
 454                 && ch->entnum == entnum
 455                 && (ch->entchannel == entchannel || entchannel == -1) )
 456                 {       // always override sound from same entity
 457                         first_to_die = ch_idx;
 458                         break;
 459                 }
 460
 461                 // don't let monster sounds override player sounds
 462                 if (ch->entnum == cl.viewentity && entnum != cl.viewentity && ch->sfx)
 463                         continue;
 464
 465                 // don't override looped sounds
 466                 if ((ch->flags & CHANNELFLAG_FORCELOOP) != 0 ||
 467                         (ch->sfx != NULL && ch->sfx->loopstart >= 0))
 468                         continue;
 469
 470                 if (ch->end - paintedtime < life_left)
 471                 {
 472                         life_left = ch->end - paintedtime;
 473                         first_to_die = ch_idx;
 474                 }
 475         }
 476
 477         if (first_to_die == -1)
 478                 return NULL;
 479
 480         S_StopChannel (first_to_die);
 481
 482         return &channels[first_to_die];
 483 }
 484
 485 /*
 486 =================
 487 SND_Spatialize
 488
 489 Spatializes a channel
 490 =================
 491 */
 492 void SND_Spatialize(channel_t *ch, qboolean isstatic)
 493 {
 494         vec_t dist, scale, pan;
 495         vec3_t source_vec;
 496
 497         // anything coming from the view entity will always be full volume
 498         // LordHavoc: make sounds with ATTN_NONE have no spatialization
 499         if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
 500         {
 501                 ch->leftvol = ch->master_vol;
 502                 ch->rightvol = ch->master_vol;
 503         }
 504         else
 505         {
 506                 // update sound origin if we know about the entity
 507                 if (ch->entnum > 0 && cls.state == ca_connected && cl_entities[ch->entnum].render.model)
 508                 {
 509                         //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].persistent.trail_origin[0], cl_entities[ch->entnum].persistent.trail_origin[1], cl_entities[ch->entnum].persistent.trail_origin[2]);
 510                         VectorCopy(cl_entities[ch->entnum].persistent.trail_origin, ch->origin);
 511                 }
 512
 513                 // calculate stereo seperation and distance attenuation
 514                 Matrix4x4_Transform(&listener_matrix, ch->origin, source_vec);
 515                 dist = VectorNormalizeLength(source_vec);
 516                 // distance
 517                 scale = ch->master_vol * (1.0 - (dist * ch->dist_mult));
 518                 // panning
 519                 pan = scale * source_vec[1];
 520                 // calculate the volumes
 521                 ch->leftvol = (int) (scale + pan);
 522                 ch->rightvol = (int) (scale - pan);
 523                 //Con_Printf("%f %f %f:%f %f %f:%f %f:%d %d\n", ch->origin[0], ch->origin[1], ch->origin[2], source_vec[0], source_vec[1], source_vec[2], scale, pan, ch->leftvol, ch->rightvol);
 524         }
 525
 526         // Adjust volume of static sounds
 527         if (isstatic)
 528         {
 529                 ch->leftvol *= snd_staticvolume.value;
 530                 ch->rightvol *= snd_staticvolume.value;
 531         }
 532
 533         // clamp volumes
 534         ch->leftvol = bound(0, ch->leftvol, 255);
 535         ch->rightvol = bound(0, ch->rightvol, 255);
 536 }
 537
 538
 539 // =======================================================================
 540 // Start a sound effect
 541 // =======================================================================
 542
 543 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
 544 {
 545         // Initialize the channel
 546         memset (target_chan, 0, sizeof (*target_chan));
 547         VectorCopy (origin, target_chan->origin);
 548         target_chan->master_vol = fvol * 255;
 549         target_chan->sfx = sfx;
 550         target_chan->end = paintedtime + sfx->total_length;
 551         target_chan->lastptime = paintedtime;
 552         target_chan->flags = flags;
 553
 554         // If it's a static sound
 555         if (isstatic)
 556         {
 557                 if (sfx->loopstart == -1)
 558                         Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
 559                 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
 560         }
 561         else
 562                 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
 563
 564         // Lock the SFX during play
 565         S_LockSfx (sfx);
 566 }
 567
 568
 569 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
 570 {
 571         channel_t *target_chan, *check;
 572         int             ch_idx;
 573         int             skip;
 574
 575         if (!sound_started || !sfx || nosound.integer)
 576                 return -1;
 577         if (!sfx->fetcher)
 578         {
 579                 Con_DPrintf ("S_StartSound: \"%s\" hasn't been precached\n", sfx->name);
 580                 return -1;
 581         }
 582
 583         if (entnum && entnum >= cl_max_entities)
 584                 CL_ExpandEntities(entnum);
 585
 586         // Pick a channel to play on
 587         target_chan = SND_PickChannel(entnum, entchannel);
 588         if (!target_chan)
 589                 return -1;
 590
 591         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
 592         target_chan->entnum = entnum;
 593         target_chan->entchannel = entchannel;
 594
 595         SND_Spatialize(target_chan, false);
 596
 597         // if an identical sound has also been started this frame, offset the pos
 598         // a bit to keep it from just making the first one louder
 599         check = &channels[NUM_AMBIENTS];
 600         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
 601         {
 602                 if (check == target_chan)
 603                         continue;
 604                 if (check->sfx == sfx && !check->pos)
 605                 {
 606                         skip = 0.1 * sfx->format.speed;
 607                         if (skip > (int)sfx->total_length)
 608                                 skip = (int)sfx->total_length;
 609                         if (skip > 0)
 610                                 skip = rand() % skip;
 611                         target_chan->pos += skip;
 612                         target_chan->end -= skip;
 613                         break;
 614                 }
 615         }
 616
 617         return (target_chan - channels);
 618 }
 619
 620 void S_StopChannel (unsigned int channel_ind)
 621 {
 622         channel_t *ch;
 623
 624         if (channel_ind >= total_channels)
 625                 return;
 626
 627         ch = &channels[channel_ind];
 628         if (ch->sfx != NULL)
 629         {
 630                 sfx_t *sfx = ch->sfx;
 631
 632                 if (sfx->fetcher != NULL)
 633                 {
 634                         snd_fetcher_end_t fetcher_end = sfx->fetcher->end;
 635                         if (fetcher_end != NULL)
 636                                 fetcher_end (ch);
 637                 }
 638
 639                 // Remove the lock it holds
 640                 S_UnlockSfx (sfx);
 641
 642                 ch->sfx = NULL;
 643         }
 644         ch->end = 0;
 645 }
 646
 647
 648 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
 649 {
 650         if (ch_ind >= total_channels)
 651                 return false;
 652
 653         if (flag != CHANNELFLAG_FORCELOOP &&
 654                 flag != CHANNELFLAG_PAUSED &&
 655                 flag != CHANNELFLAG_FULLVOLUME)
 656                 return false;
 657
 658         if (value)
 659                 channels[ch_ind].flags |= flag;
 660         else
 661                 channels[ch_ind].flags &= ~flag;
 662
 663         return true;
 664 }
 665
 666 void S_StopSound(int entnum, int entchannel)
 667 {
 668         unsigned int i;
 669
 670         for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
 671                 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
 672                 {
 673                         S_StopChannel (i);
 674                         return;
 675                 }
 676 }
 677
 678 void S_StopAllSounds (void)
 679 {
 680         unsigned int i;
 681         unsigned char *pbuf;
 682
 683         if (!sound_started)
 684                 return;
 685
 686         for (i = 0; i < total_channels; i++)
 687                 S_StopChannel (i);
 688
 689         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
 690         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
 691
 692         // Clear sound buffer
 693         pbuf = S_LockBuffer();
 694         if (pbuf != NULL)
 695         {
 696                 int setsize = shm->samples * shm->format.width;
 697                 int     clear = (shm->format.width == 1) ? 0x80 : 0;
 698
 699                 // FIXME: is it (still) true? (check with OSS and ALSA)
 700                 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
 701                 // reads the memory area before writing to it causing a seg fault
 702                 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
 703                 //memset(shm->buffer, clear, shm->samples * shm->format.width);
 704                 while (setsize--)
 705                         *pbuf++ = clear;
 706
 707                 S_UnlockBuffer ();
 708         }
 709 }
 710
 711 void S_PauseGameSounds (qboolean toggle)
 712 {
 713         unsigned int i;
 714
 715         for (i = 0; i < total_channels; i++)
 716         {
 717                 channel_t *ch;
 718
 719                 ch = &channels[i];
 720                 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
 721                         S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
 722         }
 723 }
 724
 725 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
 726 {
 727         channels[ch_ind].master_vol = fvol * 255;
 728 }
 729
 730
 731 /*
 732 =================
 733 S_StaticSound
 734 =================
 735 */
 736 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
 737 {
 738         channel_t       *target_chan;
 739
 740         if (!sound_started || !sfx || nosound.integer)
 741                 return;
 742         if (!sfx->fetcher)
 743         {
 744                 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
 745                 return;
 746         }
 747
 748         if (total_channels == MAX_CHANNELS)
 749         {
 750                 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
 751                 return;
 752         }
 753
 754         target_chan = &channels[total_channels++];
 755         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
 756
 757         SND_Spatialize (target_chan, true);
 758 }
 759
 760
 761 //=============================================================================
 762
 763 /*
 764 ===================
 765 S_UpdateAmbientSounds
 766
 767 ===================
 768 */
 769 void S_UpdateAmbientSounds (void)
 770 {
 771         float           vol;
 772         int                     ambient_channel;
 773         channel_t       *chan;
 774         qbyte           ambientlevels[NUM_AMBIENTS];
 775
 776         if (ambient_level.value <= 0 || !cl.worldmodel || !cl.worldmodel->brush.AmbientSoundLevelsForPoint)
 777                 return;
 778
 779         cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
 780
 781         // Calc ambient sound levels
 782         for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
 783         {
 784                 chan = &channels[ambient_channel];
 785                 if (chan->sfx == NULL || chan->sfx->fetcher == NULL)
 786                         continue;
 787
 788                 vol = ambient_level.value * ambientlevels[ambient_channel];
 789                 if (vol < 8)
 790                         vol = 0;
 791
 792                 // Don't adjust volume too fast
 793                 if (chan->master_vol < vol)
 794                 {
 795                         chan->master_vol += host_realframetime * ambient_fade.value;
 796                         if (chan->master_vol > vol)
 797                                 chan->master_vol = vol;
 798                 }
 799                 else if (chan->master_vol > vol)
 800                 {
 801                         chan->master_vol -= host_realframetime * ambient_fade.value;
 802                         if (chan->master_vol < vol)
 803                                 chan->master_vol = vol;
 804                 }
 805
 806                 chan->leftvol = chan->rightvol = chan->master_vol;
 807         }
 808 }
 809
 810
 811 /*
 812 ============
 813 S_Update
 814
 815 Called once each time through the main loop
 816 ============
 817 */
 818 void S_Update(const matrix4x4_t *listenermatrix)
 819 {
 820         unsigned int i, j, total;
 821         channel_t *ch, *combine;
 822
 823         if (!snd_initialized.integer || (snd_blocked > 0))
 824                 return;
 825
 826         Matrix4x4_Invert_Simple(&listener_matrix, listenermatrix);
 827         Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
 828
 829         // update general area ambient sound sources
 830         S_UpdateAmbientSounds ();
 831
 832         combine = NULL;
 833
 834         // update spatialization for static and dynamic sounds
 835         ch = channels+NUM_AMBIENTS;
 836         for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
 837         {
 838                 if (!ch->sfx)
 839                         continue;
 840                 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS);         // respatialize channel
 841                 if (!ch->leftvol && !ch->rightvol)
 842                         continue;
 843
 844                 // try to combine static sounds with a previous channel of the same
 845                 // sound effect so we don't mix five torches every frame
 846                 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
 847                 {
 848                         // see if it can just use the last one
 849                         if (combine && combine->sfx == ch->sfx)
 850                         {
 851                                 combine->leftvol += ch->leftvol;
 852                                 combine->rightvol += ch->rightvol;
 853                                 ch->leftvol = ch->rightvol = 0;
 854                                 continue;
 855                         }
 856                         // search for one
 857                         combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
 858                         for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
 859                                 if (combine->sfx == ch->sfx)
 860                                         break;
 861
 862                         if (j == total_channels)
 863                                 combine = NULL;
 864                         else
 865                         {
 866                                 if (combine != ch)
 867                                 {
 868                                         combine->leftvol += ch->leftvol;
 869                                         combine->rightvol += ch->rightvol;
 870                                         ch->leftvol = ch->rightvol = 0;
 871                                 }
 872                                 continue;
 873                         }
 874                 }
 875         }
 876
 877         sound_spatialized = true;
 878
 879         // debugging output
 880         if (snd_show.integer)
 881         {
 882                 total = 0;
 883                 ch = channels;
 884                 for (i=0 ; i<total_channels; i++, ch++)
 885                         if (ch->sfx && (ch->leftvol || ch->rightvol) )
 886                                 total++;
 887
 888                 Con_Printf("----(%u)----\n", total);
 889         }
 890
 891         S_Update_();
 892 }
 893
 894 void GetSoundtime(void)
 895 {
 896         int             samplepos;
 897         static  int             buffers;
 898         static  int             oldsamplepos;
 899         int             fullsamples;
 900
 901         fullsamples = shm->samples / shm->format.channels;
 902
 903         // it is possible to miscount buffers if it has wrapped twice between
 904         // calls to S_Update.  Oh well.
 905         samplepos = SNDDMA_GetDMAPos();
 906
 907         if (samplepos < oldsamplepos)
 908         {
 909                 buffers++;                                      // buffer wrapped
 910
 911                 if (paintedtime > 0x40000000)
 912                 {       // time to chop things off to avoid 32 bit limits
 913                         buffers = 0;
 914                         paintedtime = fullsamples;
 915                         S_StopAllSounds ();
 916                 }
 917         }
 918         oldsamplepos = samplepos;
 919
 920         soundtime = buffers * fullsamples + samplepos / shm->format.channels;
 921 }
 922
 923 void S_ExtraUpdate (void)
 924 {
 925         if (snd_noextraupdate.integer || !sound_spatialized)
 926                 return;
 927
 928         S_Update_();
 929 }
 930
 931 void S_Update_(void)
 932 {
 933         unsigned        endtime;
 934         int                             samps;
 935
 936         if (!sound_started || (snd_blocked > 0))
 937                 return;
 938
 939         // Updates DMA time
 940         GetSoundtime();
 941
 942         // check to make sure that we haven't overshot
 943         if (paintedtime < soundtime)
 944                 paintedtime = soundtime;
 945
 946         // mix ahead of current position
 947         endtime = soundtime + _snd_mixahead.value * shm->format.speed;
 948         samps = shm->samples >> (shm->format.channels - 1);
 949         if (endtime > (unsigned int)(soundtime + samps))
 950                 endtime = soundtime + samps;
 951
 952         S_PaintChannels (endtime);
 953
 954         SNDDMA_Submit ();
 955 }
 956
 957 /*
 958 ===============================================================================
 959
 960 console functions
 961
 962 ===============================================================================
 963 */
 964
 965 static void S_Play_Common(float fvol, float attenuation)
 966 {
 967         int     i, ch_ind;
 968         char name[256];
 969         sfx_t   *sfx;
 970
 971         i = 1;
 972         while (i<Cmd_Argc())
 973         {
 974                 // Get the name
 975                 strlcpy(name, Cmd_Argv(i), sizeof(name));
 976                 if (!strrchr(name, '.'))
 977                         strlcat(name, ".wav", sizeof(name));
 978                 i++;
 979
 980                 // If we need to get the volume from the command line
 981                 if (fvol == -1.0f)
 982                 {
 983                         fvol = atof(Cmd_Argv(i));
 984                         i++;
 985                 }
 986
 987                 sfx = S_PrecacheSound (name, true, false);
 988                 if (sfx)
 989                 {
 990                         ch_ind = S_StartSound(-1, 0, sfx, listener_origin, fvol, attenuation);
 991
 992                         // Free the sfx if the file didn't exist
 993                         if (ch_ind < 0)
 994                                 S_FreeSfx (sfx, false);
 995                         else
 996                                 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
 997                 }
 998         }
 999 }
1000
1001 void S_Play(void)
1002 {
1003         S_Play_Common (1.0f, 1.0f);
1004 }
1005
1006 void S_Play2(void)
1007 {
1008         S_Play_Common (1.0f, 0.0f);
1009 }
1010
1011 void S_PlayVol(void)
1012 {
1013         S_Play_Common (-1.0f, 0.0f);
1014 }
1015
1016 void S_SoundList(void)
1017 {
1018         unsigned int i;
1019         sfx_t   *sfx;
1020         int             size, total;
1021
1022         total = 0;
1023         for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
1024         {
1025                 if (sfx->fetcher != NULL)
1026                 {
1027                         size = (int)sfx->mempool->totalsize;
1028                         total += size;
1029                         Con_Printf ("%c%c%c%c(%2db, %6s) %8i : %s\n",
1030                                                 (sfx->loopstart >= 0) ? 'L' : ' ',
1031                                                 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
1032                                                 (sfx->locks > 0) ? 'K' : ' ',
1033                                                 (sfx->flags & SFXFLAG_PERMANENTLOCK) ? 'P' : ' ',
1034                                                 sfx->format.width * 8,
1035                                                 (sfx->format.channels == 1) ? "mono" : "stereo",
1036                                                 size,
1037                                                 sfx->name);
1038                 }
1039                 else
1040                         Con_Printf ("    (  unknown  ) unloaded : %s\n", sfx->name);
1041         }
1042         Con_Printf("Total resident: %i\n", total);
1043 }
1044
1045
1046 qboolean S_LocalSound (const char *sound)
1047 {
1048         sfx_t   *sfx;
1049         int             ch_ind;
1050
1051         if (!snd_initialized.integer || nosound.integer)
1052                 return true;
1053
1054         sfx = S_PrecacheSound (sound, true, false);
1055         if (!sfx)
1056         {
1057                 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1058                 return false;
1059         }
1060
1061         // Local sounds must not be freed
1062         sfx->flags |= SFXFLAG_PERMANENTLOCK;
1063
1064         ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 0);
1065         if (ch_ind < 0)
1066                 return false;
1067
1068         channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
1069         return true;
1070 }