a4717f43521314d5c7ace491a928db9b28c2a391
[xonotic/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
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_DPrintf("Sound sampling rate: %i\n", shm->format.speed);
144 }
145
146 void S_Shutdown(void)
147 {
148         if (!sound_started)
149                 return;
150
151         if (fakedma)
152                 Mem_Free(shm->buffer);
153         else
154                 SNDDMA_Shutdown();
155
156         shm = NULL;
157         sound_started = false;
158         sound_spatialized = false;
159 }
160
161 void S_Restart_f(void)
162 {
163         S_Shutdown();
164         S_Startup();
165 }
166
167 /*
168 ================
169 S_Init
170 ================
171 */
172 void S_Init(void)
173 {
174         Con_DPrint("\nSound Initialization\n");
175
176         Cvar_RegisterVariable(&volume);
177         Cvar_RegisterVariable(&bgmvolume);
178         Cvar_RegisterVariable(&snd_staticvolume);
179
180 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
181         if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
182                 return;
183
184         snd_mempool = Mem_AllocPool("sound", 0, NULL);
185
186 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
187         if (COM_CheckParm("-simsound"))
188                 fakedma = true;
189
190         Cmd_AddCommand("play", S_Play);
191         Cmd_AddCommand("play2", S_Play2);
192         Cmd_AddCommand("playvol", S_PlayVol);
193         Cmd_AddCommand("stopsound", S_StopAllSounds);
194         Cmd_AddCommand("soundlist", S_SoundList);
195         Cmd_AddCommand("soundinfo", S_SoundInfo_f);
196         Cmd_AddCommand("snd_restart", S_Restart_f);
197
198         Cvar_RegisterVariable(&nosound);
199         Cvar_RegisterVariable(&snd_precache);
200         Cvar_RegisterVariable(&snd_initialized);
201         Cvar_RegisterVariable(&snd_streaming);
202         Cvar_RegisterVariable(&bgmbuffer);
203         Cvar_RegisterVariable(&ambient_level);
204         Cvar_RegisterVariable(&ambient_fade);
205         Cvar_RegisterVariable(&snd_noextraupdate);
206         Cvar_RegisterVariable(&snd_show);
207         Cvar_RegisterVariable(&_snd_mixahead);
208         Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
209
210         Cvar_SetValueQuick(&snd_initialized, true);
211
212         known_sfx = NULL;
213
214         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
215         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
216
217         OGG_OpenLibrary ();
218 }
219
220
221 /*
222 ================
223 S_Terminate
224
225 Shutdown and free all resources
226 ================
227 */
228 void S_Terminate (void)
229 {
230         S_Shutdown ();
231         OGG_CloseLibrary ();
232
233         // Free all SFXs
234         while (known_sfx != NULL)
235                 S_FreeSfx (known_sfx, true);
236
237         Cvar_SetValueQuick (&snd_initialized, false);
238         Mem_FreePool (&snd_mempool);
239 }
240
241
242 // =======================================================================
243 // Load a sound
244 // =======================================================================
245
246 /*
247 ==================
248 S_FindName
249
250 ==================
251 */
252 sfx_t *S_FindName (const char *name)
253 {
254         sfx_t *sfx;
255
256         if (!snd_initialized.integer)
257                 return NULL;
258
259         if (strlen (name) >= sizeof (sfx->name))
260                 Host_Error ("S_FindName: sound name too long (%s)", name);
261
262         // Look for this sound in the list of known sfx
263         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
264                 if(!strcmp (sfx->name, name))
265                         return sfx;
266
267         // Add a sfx_t struct for this sound
268         sfx = Mem_Alloc (snd_mempool, sizeof (*sfx));
269         memset (sfx, 0, sizeof(*sfx));
270         strlcpy (sfx->name, name, sizeof (sfx->name));
271         sfx->next = known_sfx;
272         known_sfx = sfx;
273
274         return sfx;
275 }
276
277
278 /*
279 ==================
280 S_FreeSfx
281
282 ==================
283 */
284 void S_FreeSfx (sfx_t *sfx, qboolean force)
285 {
286         // Never free a locked sfx unless forced
287         if (!force && (sfx->locks > 0 || (sfx->flags & SFXFLAG_PERMANENTLOCK)))
288                 return;
289
290         Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
291
292         // Remove it from the list of known sfx
293         if (sfx == known_sfx)
294                 known_sfx = known_sfx->next;
295         else
296         {
297                 sfx_t *prev_sfx;
298
299                 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
300                         if (prev_sfx->next == sfx)
301                         {
302                                 prev_sfx->next = sfx->next;
303                                 break;
304                         }
305                 if (prev_sfx == NULL)
306                         Sys_Error ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
307         }
308
309         // Free it
310         Mem_FreePool (&sfx->mempool);
311         Mem_Free (sfx);
312 }
313
314
315 /*
316 ==================
317 S_ServerSounds
318
319 ==================
320 */
321 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
322 {
323         sfx_t *sfx;
324         sfx_t *sfxnext;
325         unsigned int i;
326
327         // Start the ambient sounds and make them loop
328         for (i = 0; i < sizeof (ambient_sfxs) / sizeof (ambient_sfxs[0]); i++)
329         {
330                 // Precache it if it's not done (request a lock to make sure it will never be freed)
331                 if (ambient_sfxs[i] == NULL)
332                         ambient_sfxs[i] = S_PrecacheSound (ambient_names[i], false, true);
333                 if (ambient_sfxs[i] != NULL)
334                 {
335                         // Add a lock to the SFX while playing. It will be
336                         // removed by S_StopAllSounds at the end of the level
337                         S_LockSfx (ambient_sfxs[i]);
338
339                         channels[i].sfx = ambient_sfxs[i];
340                         channels[i].flags |= CHANNELFLAG_FORCELOOP;
341                         channels[i].master_vol = 0;
342                 }
343         }
344
345         // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
346         for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
347                 if (sfx->flags & SFXFLAG_SERVERSOUND)
348                 {
349                         S_UnlockSfx (sfx);
350                         sfx->flags &= ~SFXFLAG_SERVERSOUND;
351                 }
352
353         // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
354         for (i = 1; i < numsounds; i++)
355         {
356                 sfx = S_FindName (serversound[i]);
357                 if (sfx != NULL)
358                 {
359                         S_LockSfx (sfx);
360                         sfx->flags |= SFXFLAG_SERVERSOUND;
361                 }
362         }
363
364         // Free all unlocked sfx
365         for (sfx = known_sfx;sfx;sfx = sfxnext)
366         {
367                 sfxnext = sfx->next;
368                 S_FreeSfx (sfx, false);
369         }
370 }
371
372
373 /*
374 ==================
375 S_PrecacheSound
376
377 ==================
378 */
379 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean lock)
380 {
381         sfx_t *sfx;
382
383         if (!snd_initialized.integer)
384                 return NULL;
385
386         sfx = S_FindName (name);
387         if (sfx == NULL)
388                 return NULL;
389
390         if (lock)
391                 S_LockSfx (sfx);
392
393         if (!nosound.integer && snd_precache.integer)
394                 S_LoadSound(sfx, complain);
395
396         return sfx;
397 }
398
399 /*
400 ==================
401 S_LockSfx
402
403 Add a lock to a SFX
404 ==================
405 */
406 void S_LockSfx (sfx_t *sfx)
407 {
408         sfx->locks++;
409 }
410
411 /*
412 ==================
413 S_UnlockSfx
414
415 Remove a lock from a SFX
416 ==================
417 */
418 void S_UnlockSfx (sfx_t *sfx)
419 {
420         sfx->locks--;
421 }
422
423
424 //=============================================================================
425
426 /*
427 =================
428 SND_PickChannel
429
430 Picks a channel based on priorities, empty slots, number of channels
431 =================
432 */
433 channel_t *SND_PickChannel(int entnum, int entchannel)
434 {
435         int ch_idx;
436         int first_to_die;
437         int life_left;
438         channel_t* ch;
439
440 // Check for replacement sound, or find the best one to replace
441         first_to_die = -1;
442         life_left = 0x7fffffff;
443         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
444         {
445                 ch = &channels[ch_idx];
446                 if (entchannel != 0             // channel 0 never overrides
447                 && ch->entnum == entnum
448                 && (ch->entchannel == entchannel || entchannel == -1) )
449                 {       // always override sound from same entity
450                         first_to_die = ch_idx;
451                         break;
452                 }
453
454                 // don't let monster sounds override player sounds
455                 if (ch->entnum == cl.viewentity && entnum != cl.viewentity && ch->sfx)
456                         continue;
457
458                 // don't override looped sounds
459                 if ((ch->flags & CHANNELFLAG_FORCELOOP) != 0 ||
460                         (ch->sfx != NULL && ch->sfx->loopstart >= 0))
461                         continue;
462
463                 if (ch->end - paintedtime < life_left)
464                 {
465                         life_left = ch->end - paintedtime;
466                         first_to_die = ch_idx;
467                 }
468         }
469
470         if (first_to_die == -1)
471                 return NULL;
472
473         S_StopChannel (first_to_die);
474
475         return &channels[first_to_die];
476 }
477
478 /*
479 =================
480 SND_Spatialize
481
482 Spatializes a channel
483 =================
484 */
485 void SND_Spatialize(channel_t *ch, qboolean isstatic)
486 {
487         vec_t dist, scale, pan;
488         vec3_t source_vec;
489
490         // anything coming from the view entity will always be full volume
491         // LordHavoc: make sounds with ATTN_NONE have no spatialization
492         if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
493         {
494                 ch->leftvol = ch->master_vol;
495                 ch->rightvol = ch->master_vol;
496         }
497         else
498         {
499                 // update sound origin if we know about the entity
500                 if (ch->entnum > 0 && cls.state == ca_connected && cl_entities[ch->entnum].render.model)
501                 {
502                         //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]);
503                         VectorCopy(cl_entities[ch->entnum].persistent.trail_origin, ch->origin);
504                 }
505
506                 // calculate stereo seperation and distance attenuation
507                 Matrix4x4_Transform(&listener_matrix, ch->origin, source_vec);
508                 dist = VectorNormalizeLength(source_vec);
509                 // distance
510                 scale = ch->master_vol * (1.0 - (dist * ch->dist_mult));
511                 // panning
512                 pan = scale * source_vec[1];
513                 // calculate the volumes
514                 ch->leftvol = (int) (scale + pan);
515                 ch->rightvol = (int) (scale - pan);
516                 //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);
517         }
518
519         // Adjust volume of static sounds
520         if (isstatic)
521         {
522                 ch->leftvol *= snd_staticvolume.value;
523                 ch->rightvol *= snd_staticvolume.value;
524         }
525
526         // clamp volumes
527         ch->leftvol = bound(0, ch->leftvol, 255);
528         ch->rightvol = bound(0, ch->rightvol, 255);
529 }
530
531
532 // =======================================================================
533 // Start a sound effect
534 // =======================================================================
535
536 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
537 {
538         // Initialize the channel
539         memset (target_chan, 0, sizeof (*target_chan));
540         VectorCopy (origin, target_chan->origin);
541         target_chan->master_vol = fvol * 255;
542         target_chan->sfx = sfx;
543         target_chan->end = paintedtime + sfx->total_length;
544         target_chan->lastptime = paintedtime;
545         target_chan->flags = flags;
546
547         // If it's a static sound
548         if (isstatic)
549         {
550                 if (sfx->loopstart == -1)
551                         Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
552                 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
553         }
554         else
555                 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
556
557         // Lock the SFX during play
558         S_LockSfx (sfx);
559 }
560
561
562 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
563 {
564         channel_t *target_chan, *check;
565         int             ch_idx;
566         size_t  skip;
567
568         if (!sound_started || !sfx || nosound.integer)
569                 return -1;
570         if (!sfx->fetcher)
571         {
572                 Con_DPrintf ("S_StartSound: \"%s\" hasn't been precached\n", sfx->name);
573                 return -1;
574         }
575
576         if (entnum && entnum >= cl_max_entities)
577                 CL_ExpandEntities(entnum);
578
579         // Pick a channel to play on
580         target_chan = SND_PickChannel(entnum, entchannel);
581         if (!target_chan)
582                 return -1;
583
584         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
585         target_chan->entnum = entnum;
586         target_chan->entchannel = entchannel;
587
588         SND_Spatialize(target_chan, false);
589
590         // if an identical sound has also been started this frame, offset the pos
591         // a bit to keep it from just making the first one louder
592         check = &channels[NUM_AMBIENTS];
593         for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
594         {
595                 if (check == target_chan)
596                         continue;
597                 if (check->sfx == sfx && !check->pos)
598                 {
599                         skip = 0.1 * sfx->format.speed;
600                         if (skip > sfx->total_length)
601                                 skip = sfx->total_length;
602                         if (skip > 0)
603                                 skip = rand() % skip;
604                         target_chan->pos += skip;
605                         target_chan->end -= skip;
606                         break;
607                 }
608         }
609
610         return (target_chan - channels);
611 }
612
613 void S_StopChannel (unsigned int channel_ind)
614 {
615         channel_t *ch;
616
617         if (channel_ind >= total_channels)
618                 return;
619
620         ch = &channels[channel_ind];
621         if (ch->sfx != NULL)
622         {
623                 sfx_t *sfx = ch->sfx;
624
625                 if (sfx->fetcher != NULL)
626                 {
627                         snd_fetcher_end_t fetcher_end = sfx->fetcher->end;
628                         if (fetcher_end != NULL)
629                                 fetcher_end (ch);
630                 }
631
632                 // Remove the lock it holds
633                 S_UnlockSfx (sfx);
634
635                 ch->sfx = NULL;
636         }
637         ch->end = 0;
638 }
639
640
641 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
642 {
643         if (ch_ind >= total_channels)
644                 return false;
645
646         if (flag != CHANNELFLAG_FORCELOOP &&
647                 flag != CHANNELFLAG_PAUSED &&
648                 flag != CHANNELFLAG_FULLVOLUME)
649                 return false;
650
651         if (value)
652                 channels[ch_ind].flags |= flag;
653         else
654                 channels[ch_ind].flags &= ~flag;
655
656         return true;
657 }
658
659 void S_StopSound(int entnum, int entchannel)
660 {
661         unsigned int i;
662
663         for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
664                 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
665                 {
666                         S_StopChannel (i);
667                         return;
668                 }
669 }
670
671 void S_StopAllSounds (void)
672 {
673         unsigned int i;
674         unsigned char *pbuf;
675
676         if (!sound_started)
677                 return;
678
679         for (i = 0; i < total_channels; i++)
680                 S_StopChannel (i);
681
682         total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;   // no statics
683         memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
684
685         // Clear sound buffer
686         pbuf = S_LockBuffer();
687         if (pbuf != NULL)
688         {
689                 int setsize = shm->samples * shm->format.width;
690                 int     clear = (shm->format.width == 1) ? 0x80 : 0;
691
692                 // FIXME: is it (still) true? (check with OSS and ALSA)
693                 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
694                 // reads the memory area before writing to it causing a seg fault
695                 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
696                 //memset(shm->buffer, clear, shm->samples * shm->format.width);
697                 while (setsize--)
698                         *pbuf++ = clear;
699
700                 S_UnlockBuffer ();
701         }
702 }
703
704 void S_PauseGameSounds (qboolean toggle)
705 {
706         unsigned int i;
707
708         for (i = 0; i < total_channels; i++)
709         {
710                 channel_t *ch;
711
712                 ch = &channels[i];
713                 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
714                         S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
715         }
716 }
717
718 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
719 {
720         channels[ch_ind].master_vol = fvol * 255;
721 }
722
723
724 /*
725 =================
726 S_StaticSound
727 =================
728 */
729 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
730 {
731         channel_t       *target_chan;
732
733         if (!sound_started || !sfx || nosound.integer)
734                 return;
735         if (!sfx->fetcher)
736         {
737                 Con_DPrintf ("S_StaticSound: \"%s\" hasn't been precached\n", sfx->name);
738                 return;
739         }
740
741         if (total_channels == MAX_CHANNELS)
742         {
743                 Con_Print("S_StaticSound: total_channels == MAX_CHANNELS\n");
744                 return;
745         }
746
747         target_chan = &channels[total_channels++];
748         S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
749
750         SND_Spatialize (target_chan, true);
751 }
752
753
754 //=============================================================================
755
756 /*
757 ===================
758 S_UpdateAmbientSounds
759
760 ===================
761 */
762 void S_UpdateAmbientSounds (void)
763 {
764         float           vol;
765         int                     ambient_channel;
766         channel_t       *chan;
767         qbyte           ambientlevels[NUM_AMBIENTS];
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->fetcher == NULL)
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, false);
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, 0);
1058         if (ch_ind < 0)
1059                 return false;
1060
1061         channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
1062         return true;
1063 }