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