2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // snd_dma.c -- main control for any streaming sound output device
30 void S_SoundList(void);
32 void S_StopAllSounds(qboolean clear);
33 void S_StopAllSoundsC(void);
35 // =======================================================================
36 // Internal sound data & structures
37 // =======================================================================
39 channel_t channels[MAX_CHANNELS];
43 static qboolean snd_ambient = 1;
44 qboolean snd_initialized = false;
46 // pointer should go away
47 volatile dma_t *shm = 0;
50 vec3_t listener_origin;
51 vec3_t listener_forward;
52 vec3_t listener_right;
54 vec_t sound_nominal_clip_dist=1000.0;
56 int soundtime; // sample PAIRS
57 int paintedtime; // sample PAIRS
60 //LordHavoc: increased the client sound limit from 512 to 4096 for the Nehahra movie
62 sfx_t *known_sfx; // hunk allocated [MAX_SFX]
65 sfx_t *ambient_sfx[NUM_AMBIENTS];
67 int sound_started = 0;
69 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1"};
70 cvar_t volume = {CVAR_SAVE, "volume", "0.7"};
72 cvar_t nosound = {0, "nosound", "0"};
73 cvar_t precache = {0, "precache", "1"};
74 cvar_t bgmbuffer = {0, "bgmbuffer", "4096"};
75 cvar_t ambient_level = {0, "ambient_level", "0.3"};
76 cvar_t ambient_fade = {0, "ambient_fade", "100"};
77 cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0"};
78 cvar_t snd_show = {0, "snd_show", "0"};
79 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1"};
80 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0"};
83 // ====================================================================
84 // User-setable variables
85 // ====================================================================
89 // Fake dma is a synchronous faking of the DMA progress used for
90 // isolating performance in the renderer. The fakedma_updates is
91 // number of times S_Update() is called per second.
94 qboolean fakedma = false;
95 int fakedma_updates = 15;
98 void S_AmbientOff (void)
104 void S_AmbientOn (void)
110 void S_SoundInfo_f(void)
112 if (!sound_started || !shm)
114 Con_Printf ("sound system not started\n");
118 Con_Printf("%5d stereo\n", shm->channels - 1);
119 Con_Printf("%5d samples\n", shm->samples);
120 Con_Printf("%5d samplepos\n", shm->samplepos);
121 Con_Printf("%5d samplebits\n", shm->samplebits);
122 Con_Printf("%5d submission_chunk\n", shm->submission_chunk);
123 Con_Printf("%5d speed\n", shm->speed);
124 Con_Printf("0x%x dma buffer\n", shm->buffer);
125 Con_Printf("%5d total_channels\n", total_channels);
135 void S_Startup (void)
139 if (!snd_initialized)
148 Con_Printf("S_Startup: SNDDMA_Init failed.\n");
160 mempool_t *snd_mempool;
169 Con_Printf("\nSound Initialization\n");
171 Cvar_RegisterVariable(&volume);
172 Cvar_RegisterVariable(&bgmvolume);
174 if (COM_CheckParm("-nosound"))
177 snd_mempool = Mem_AllocPool("sound");
179 if (COM_CheckParm("-simsound"))
182 Cmd_AddCommand("play", S_Play);
183 Cmd_AddCommand("play2", S_Play2);
184 Cmd_AddCommand("playvol", S_PlayVol);
185 Cmd_AddCommand("stopsound", S_StopAllSoundsC);
186 Cmd_AddCommand("soundlist", S_SoundList);
187 Cmd_AddCommand("soundinfo", S_SoundInfo_f);
189 Cvar_RegisterVariable(&nosound);
190 Cvar_RegisterVariable(&precache);
191 Cvar_RegisterVariable(&bgmbuffer);
192 Cvar_RegisterVariable(&ambient_level);
193 Cvar_RegisterVariable(&ambient_fade);
194 Cvar_RegisterVariable(&snd_noextraupdate);
195 Cvar_RegisterVariable(&snd_show);
196 Cvar_RegisterVariable(&_snd_mixahead);
197 Cvar_RegisterVariable(&snd_swapstereo); // LordHavoc: for people with backwards sound wiring
199 snd_initialized = true;
201 known_sfx = Mem_Alloc(snd_mempool, MAX_SFX*sizeof(sfx_t));
206 SND_InitScaletable ();
208 // create a piece of DMA memory
212 shm = (void *) Mem_Alloc(snd_mempool, sizeof(*shm));
213 shm->splitbuffer = 0;
214 shm->samplebits = 16;
217 shm->samples = 32768;
219 shm->soundalive = true;
220 shm->gamealive = true;
221 shm->submission_chunk = 1;
222 shm->buffer = Mem_Alloc(snd_mempool, shm->channels * shm->samples * (shm->samplebits / 8));
228 Con_Printf ("Sound sampling rate: %i\n", shm->speed);
230 // provides a tick sound until washed clean
232 ambient_sfx[AMBIENT_WATER] = S_PrecacheSound ("ambience/water1.wav");
233 ambient_sfx[AMBIENT_SKY] = S_PrecacheSound ("ambience/wind2.wav");
235 S_StopAllSounds (true);
239 // =======================================================================
240 // Shutdown sound engine
241 // =======================================================================
243 void S_Shutdown(void)
259 // =======================================================================
261 // =======================================================================
269 sfx_t *S_FindName (char *name)
275 Host_Error ("S_FindName: NULL\n");
277 if (strlen(name) >= MAX_QPATH)
278 Host_Error ("Sound name too long: %s", name);
280 // see if already loaded
281 for (i=0 ; i < num_sfx ; i++)
282 if (!strcmp(known_sfx[i].name, name))
284 return &known_sfx[i];
287 if (num_sfx == MAX_SFX)
288 Sys_Error ("S_FindName: out of sfx_t");
291 strcpy (sfx->name, name);
305 void S_TouchSound (char *name)
312 sfx = S_FindName (name);
321 sfx_t *S_PrecacheSound (char *name)
325 if (!sound_started || nosound.integer)
328 sfx = S_FindName (name);
331 if (precache.integer)
338 //=============================================================================
345 channel_t *SND_PickChannel(int entnum, int entchannel)
351 // Check for replacement sound, or find the best one to replace
353 life_left = 0x7fffffff;
354 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
356 if (entchannel != 0 // channel 0 never overrides
357 && channels[ch_idx].entnum == entnum
358 && (channels[ch_idx].entchannel == entchannel || entchannel == -1) )
359 { // always override sound from same entity
360 first_to_die = ch_idx;
364 // don't let monster sounds override player sounds
365 if (channels[ch_idx].entnum == cl.viewentity && entnum != cl.viewentity && channels[ch_idx].sfx)
368 if (channels[ch_idx].end - paintedtime < life_left)
370 life_left = channels[ch_idx].end - paintedtime;
371 first_to_die = ch_idx;
375 if (first_to_die == -1)
378 if (channels[first_to_die].sfx)
379 channels[first_to_die].sfx = NULL;
381 return &channels[first_to_die];
389 void SND_Spatialize(channel_t *ch)
393 vec_t lscale, rscale, scale;
397 // anything coming from the view entity will always be full volume
398 // LordHavoc: make sounds with ATTN_NONE have no spatialization
399 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
401 ch->leftvol = ch->master_vol;
402 ch->rightvol = ch->master_vol;
406 // calculate stereo seperation and distance attenuation
409 VectorSubtract(ch->origin, listener_origin, source_vec);
411 dist = VectorNormalizeLength(source_vec) * ch->dist_mult;
413 dot = DotProduct(listener_right, source_vec);
415 if (shm->channels == 1)
426 // add in distance effect
427 scale = (1.0 - dist) * rscale;
428 ch->rightvol = (int) (ch->master_vol * scale);
429 if (ch->rightvol < 0)
432 scale = (1.0 - dist) * lscale;
433 ch->leftvol = (int) (ch->master_vol * scale);
439 // =======================================================================
440 // Start a sound effect
441 // =======================================================================
443 void S_StartSound(int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
445 channel_t *target_chan, *check;
462 // pick a channel to play on
463 target_chan = SND_PickChannel(entnum, entchannel);
468 memset (target_chan, 0, sizeof(*target_chan));
469 VectorCopy(origin, target_chan->origin);
470 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
471 target_chan->master_vol = vol;
472 target_chan->entnum = entnum;
473 target_chan->entchannel = entchannel;
474 SND_Spatialize(target_chan);
476 if (!target_chan->leftvol && !target_chan->rightvol)
477 return; // not audible at all
480 sc = S_LoadSound (sfx);
483 target_chan->sfx = NULL;
484 return; // couldn't load the sound's data
487 target_chan->sfx = sfx;
488 target_chan->pos = 0.0;
489 target_chan->end = paintedtime + sc->length;
491 // if an identical sound has also been started this frame, offset the pos
492 // a bit to keep it from just making the first one louder
493 check = &channels[NUM_AMBIENTS];
494 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
496 if (check == target_chan)
498 if (check->sfx == sfx && !check->pos)
500 // LordHavoc: fixed skip calculations
501 skip = 0.1 * shm->speed;
502 if (skip > sc->length)
505 skip = rand() % skip;
506 target_chan->pos += skip;
507 target_chan->end -= skip;
514 void S_StopSound(int entnum, int entchannel)
518 for (i=0 ; i<MAX_DYNAMIC_CHANNELS ; i++)
520 if (channels[i].entnum == entnum
521 && channels[i].entchannel == entchannel)
524 channels[i].sfx = NULL;
530 void S_StopAllSounds(qboolean clear)
537 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
539 for (i=0 ; i<MAX_CHANNELS ; i++)
541 channels[i].sfx = NULL;
543 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
549 void S_StopAllSoundsC (void)
551 S_StopAllSounds (true);
554 void S_ClearBuffer (void)
559 if (!sound_started || !shm || (!shm->buffer && !pDSBuf))
561 if (!sound_started || !shm || !shm->buffer)
565 if (shm->samplebits == 8)
580 while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &pData, &dwSize, NULL, NULL, 0)) != DS_OK)
582 if (hresult != DSERR_BUFFERLOST)
584 Con_Printf ("S_ClearBuffer: DS::Lock Sound Buffer Failed\n");
591 Con_Printf ("S_ClearBuffer: DS: couldn't restore buffer\n");
597 memset(pData, clear, shm->samples * shm->samplebits/8);
599 pDSBuf->lpVtbl->Unlock(pDSBuf, pData, dwSize, NULL, 0);
605 int setsize = shm->samples * shm->samplebits / 8;
606 char *buf = shm->buffer;
611 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
612 // reads the memory area before writing to it causing a seg fault
613 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
614 // memset(shm->buffer, clear, shm->samples * shm->samplebits/8);
624 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation)
632 if (total_channels == MAX_CHANNELS)
634 Con_Printf ("total_channels == MAX_CHANNELS\n");
638 ss = &channels[total_channels];
641 sc = S_LoadSound (sfx);
645 if (sc->loopstart == -1)
647 Con_Printf ("Sound %s not looped\n", sfx->name);
652 VectorCopy (origin, ss->origin);
653 ss->master_vol = vol;
654 ss->dist_mult = (attenuation/64) / sound_nominal_clip_dist;
655 ss->end = paintedtime + sc->length;
661 //=============================================================================
665 S_UpdateAmbientSounds
668 void S_UpdateAmbientSounds (void)
675 // LordHavoc: kill ambient sounds until proven otherwise
676 for (ambient_channel = 0 ; ambient_channel < NUM_AMBIENTS;ambient_channel++)
677 channels[ambient_channel].sfx = NULL;
679 if (!snd_ambient || !cl.worldmodel || ambient_level.value <= 0)
682 l = Mod_PointInLeaf (listener_origin, cl.worldmodel);
686 // calc ambient sound levels
687 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
689 chan = &channels[ambient_channel];
690 chan->sfx = ambient_sfx[ambient_channel];
692 vol = ambient_level.value * l->ambient_sound_level[ambient_channel];
696 // don't adjust volume too fast
697 if (chan->master_vol < vol)
699 chan->master_vol += host_realframetime * ambient_fade.value;
700 if (chan->master_vol > vol)
701 chan->master_vol = vol;
703 else if (chan->master_vol > vol)
705 chan->master_vol -= host_realframetime * ambient_fade.value;
706 if (chan->master_vol < vol)
707 chan->master_vol = vol;
710 chan->leftvol = chan->rightvol = chan->master_vol;
719 Called once each time through the main loop
722 void S_Update(vec3_t origin, vec3_t forward, vec3_t right, vec3_t up)
729 if (!sound_started || (snd_blocked > 0))
732 VectorCopy(origin, listener_origin);
733 VectorCopy(forward, listener_forward);
734 VectorCopy(right, listener_right);
735 VectorCopy(up, listener_up);
737 // update general area ambient sound sources
738 S_UpdateAmbientSounds ();
742 // update spatialization for static and dynamic sounds
743 ch = channels+NUM_AMBIENTS;
744 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
748 SND_Spatialize(ch); // respatialize channel
749 if (!ch->leftvol && !ch->rightvol)
752 // try to combine static sounds with a previous channel of the same
753 // sound effect so we don't mix five torches every frame
755 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
757 // see if it can just use the last one
758 if (combine && combine->sfx == ch->sfx)
760 combine->leftvol += ch->leftvol;
761 combine->rightvol += ch->rightvol;
762 ch->leftvol = ch->rightvol = 0;
766 combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
767 for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
768 if (combine->sfx == ch->sfx)
771 if (j == total_channels)
779 combine->leftvol += ch->leftvol;
780 combine->rightvol += ch->rightvol;
781 ch->leftvol = ch->rightvol = 0;
791 if (snd_show.integer)
795 for (i=0 ; i<total_channels; i++, ch++)
796 if (ch->sfx && (ch->leftvol || ch->rightvol) )
799 Con_Printf ("----(%i)----\n", total);
806 void GetSoundtime(void)
810 static int oldsamplepos;
813 fullsamples = shm->samples / shm->channels;
815 // it is possible to miscount buffers if it has wrapped twice between
816 // calls to S_Update. Oh well.
818 soundtime = SNDDMA_GetSamples();
820 samplepos = SNDDMA_GetDMAPos();
823 if (samplepos < oldsamplepos)
825 buffers++; // buffer wrapped
827 if (paintedtime > 0x40000000)
828 { // time to chop things off to avoid 32 bit limits
830 paintedtime = fullsamples;
831 S_StopAllSounds (true);
834 oldsamplepos = samplepos;
836 soundtime = buffers*fullsamples + samplepos/shm->channels;
840 void IN_Accumulate (void);
842 void S_ExtraUpdate (void)
849 if (snd_noextraupdate.integer)
850 return; // don't pollute timings
859 if (!sound_started || (snd_blocked > 0))
865 // check to make sure that we haven't overshot
866 if (paintedtime < soundtime)
867 paintedtime = soundtime;
869 // mix ahead of current position
870 endtime = soundtime + _snd_mixahead.value * shm->speed;
871 samps = shm->samples >> (shm->channels-1);
872 if (endtime - soundtime > samps)
873 endtime = soundtime + samps;
876 // if the buffer was lost or stopped, restore it and/or restart it
882 if (pDSBuf->lpVtbl->GetStatus (pDSBuf, &dwStatus) != DD_OK)
883 Con_Printf ("Couldn't get sound buffer status\n");
885 if (dwStatus & DSBSTATUS_BUFFERLOST)
886 pDSBuf->lpVtbl->Restore (pDSBuf);
888 if (!(dwStatus & DSBSTATUS_PLAYING))
889 pDSBuf->lpVtbl->Play(pDSBuf, 0, 0, DSBPLAY_LOOPING);
894 S_PaintChannels (endtime);
900 ===============================================================================
904 ===============================================================================
917 if (!strrchr(Cmd_Argv(i), '.'))
919 strcpy(name, Cmd_Argv(i));
920 strcat(name, ".wav");
923 strcpy(name, Cmd_Argv(i));
924 sfx = S_PrecacheSound(name);
925 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 1.0);
940 if (!strrchr(Cmd_Argv(i), '.'))
942 strcpy(name, Cmd_Argv(i));
943 strcat(name, ".wav");
946 strcpy(name, Cmd_Argv(i));
947 sfx = S_PrecacheSound(name);
948 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 0.0);
964 if (!strrchr(Cmd_Argv(i), '.'))
966 strcpy(name, Cmd_Argv(i));
967 strcat(name, ".wav");
970 strcpy(name, Cmd_Argv(i));
971 sfx = S_PrecacheSound(name);
972 vol = atof(Cmd_Argv(i+1));
973 S_StartSound(hash++, 0, sfx, listener_origin, vol, 1.0);
978 void S_SoundList(void)
986 for (sfx=known_sfx, i=0 ; i<num_sfx ; i++, sfx++)
991 size = sc->length*sc->width*(sc->stereo+1);
993 if (sc->loopstart >= 0)
997 Con_Printf("(%2db) %6i : %s\n",sc->width*8, size, sfx->name);
999 Con_Printf ("Total resident: %i\n", total);
1003 void S_LocalSound (char *sound)
1007 if (nosound.integer)
1012 sfx = S_PrecacheSound (sound);
1015 Con_Printf ("S_LocalSound: can't precache %s\n", sound);
1018 S_StartSound (cl.viewentity, -1, sfx, vec3_origin, 1, 1);
1022 void S_ClearPrecache (void)
1027 void S_BeginPrecaching (void)
1032 void S_EndPrecaching (void)