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 loadas8bit = {0, "loadas8bit", "0"};
75 cvar_t bgmbuffer = {0, "bgmbuffer", "4096"};
76 cvar_t ambient_level = {0, "ambient_level", "0.3"};
77 cvar_t ambient_fade = {0, "ambient_fade", "100"};
78 cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0"};
79 cvar_t snd_show = {0, "snd_show", "0"};
80 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1"};
81 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0"};
84 // ====================================================================
85 // User-setable variables
86 // ====================================================================
90 // Fake dma is a synchronous faking of the DMA progress used for
91 // isolating performance in the renderer. The fakedma_updates is
92 // number of times S_Update() is called per second.
95 qboolean fakedma = false;
96 int fakedma_updates = 15;
99 void S_AmbientOff (void)
105 void S_AmbientOn (void)
111 void S_SoundInfo_f(void)
113 if (!sound_started || !shm)
115 Con_Printf ("sound system not started\n");
119 Con_Printf("%5d stereo\n", shm->channels - 1);
120 Con_Printf("%5d samples\n", shm->samples);
121 Con_Printf("%5d samplepos\n", shm->samplepos);
122 Con_Printf("%5d samplebits\n", shm->samplebits);
123 Con_Printf("%5d submission_chunk\n", shm->submission_chunk);
124 Con_Printf("%5d speed\n", shm->speed);
125 Con_Printf("0x%x dma buffer\n", shm->buffer);
126 Con_Printf("%5d total_channels\n", total_channels);
136 void S_Startup (void)
140 if (!snd_initialized)
149 Con_Printf("S_Startup: SNDDMA_Init failed.\n");
161 mempool_t *snd_mempool;
170 Con_Printf("\nSound Initialization\n");
172 Cvar_RegisterVariable(&volume);
173 Cvar_RegisterVariable(&bgmvolume);
175 if (COM_CheckParm("-nosound"))
178 snd_mempool = Mem_AllocPool("sound");
180 if (COM_CheckParm("-simsound"))
183 Cmd_AddCommand("play", S_Play);
184 Cmd_AddCommand("play2", S_Play2);
185 Cmd_AddCommand("playvol", S_PlayVol);
186 Cmd_AddCommand("stopsound", S_StopAllSoundsC);
187 Cmd_AddCommand("soundlist", S_SoundList);
188 Cmd_AddCommand("soundinfo", S_SoundInfo_f);
190 Cvar_RegisterVariable(&nosound);
191 Cvar_RegisterVariable(&precache);
192 // Cvar_RegisterVariable(&loadas8bit);
193 Cvar_RegisterVariable(&bgmbuffer);
194 Cvar_RegisterVariable(&ambient_level);
195 Cvar_RegisterVariable(&ambient_fade);
196 Cvar_RegisterVariable(&snd_noextraupdate);
197 Cvar_RegisterVariable(&snd_show);
198 Cvar_RegisterVariable(&_snd_mixahead);
199 Cvar_RegisterVariable(&snd_swapstereo); // LordHavoc: for people with backwards sound wiring
202 if (host_parms.memsize < 0x800000)
204 Cvar_Set ("loadas8bit", "1");
205 Con_Printf ("loading all sounds as 8bit\n");
211 snd_initialized = true;
213 known_sfx = Mem_Alloc(snd_mempool, MAX_SFX*sizeof(sfx_t));
218 SND_InitScaletable ();
220 // create a piece of DMA memory
224 shm = (void *) Mem_Alloc(snd_mempool, sizeof(*shm));
225 shm->splitbuffer = 0;
226 shm->samplebits = 16;
229 shm->samples = 32768;
231 shm->soundalive = true;
232 shm->gamealive = true;
233 shm->submission_chunk = 1;
234 shm->buffer = Mem_Alloc(snd_mempool, shm->channels * shm->samples * (shm->samplebits / 8));
240 Con_Printf ("Sound sampling rate: %i\n", shm->speed);
242 // provides a tick sound until washed clean
245 // shm->buffer[4] = shm->buffer[5] = 0x7f; // force a pop for debugging
247 ambient_sfx[AMBIENT_WATER] = S_PrecacheSound ("ambience/water1.wav");
248 ambient_sfx[AMBIENT_SKY] = S_PrecacheSound ("ambience/wind2.wav");
250 S_StopAllSounds (true);
254 // =======================================================================
255 // Shutdown sound engine
256 // =======================================================================
258 void S_Shutdown(void)
274 // =======================================================================
276 // =======================================================================
284 sfx_t *S_FindName (char *name)
290 Host_Error ("S_FindName: NULL\n");
292 if (strlen(name) >= MAX_QPATH)
293 Host_Error ("Sound name too long: %s", name);
295 // see if already loaded
296 for (i=0 ; i < num_sfx ; i++)
297 if (!strcmp(known_sfx[i].name, name))
299 return &known_sfx[i];
302 if (num_sfx == MAX_SFX)
303 Sys_Error ("S_FindName: out of sfx_t");
306 strcpy (sfx->name, name);
320 void S_TouchSound (char *name)
327 sfx = S_FindName (name);
336 sfx_t *S_PrecacheSound (char *name)
340 if (!sound_started || nosound.integer)
343 sfx = S_FindName (name);
346 if (precache.integer)
353 //=============================================================================
360 channel_t *SND_PickChannel(int entnum, int entchannel)
366 // Check for replacement sound, or find the best one to replace
368 life_left = 0x7fffffff;
369 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
371 if (entchannel != 0 // channel 0 never overrides
372 && channels[ch_idx].entnum == entnum
373 && (channels[ch_idx].entchannel == entchannel || entchannel == -1) )
374 { // always override sound from same entity
375 first_to_die = ch_idx;
379 // don't let monster sounds override player sounds
380 if (channels[ch_idx].entnum == cl.viewentity && entnum != cl.viewentity && channels[ch_idx].sfx)
383 if (channels[ch_idx].end - paintedtime < life_left)
385 life_left = channels[ch_idx].end - paintedtime;
386 first_to_die = ch_idx;
390 if (first_to_die == -1)
393 if (channels[first_to_die].sfx)
394 channels[first_to_die].sfx = NULL;
396 return &channels[first_to_die];
404 void SND_Spatialize(channel_t *ch)
408 vec_t lscale, rscale, scale;
412 // anything coming from the view entity will always be full volume
413 // LordHavoc: make sounds with ATTN_NONE have no spatialization
414 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
416 ch->leftvol = ch->master_vol;
417 ch->rightvol = ch->master_vol;
421 // calculate stereo seperation and distance attenuation
424 VectorSubtract(ch->origin, listener_origin, source_vec);
426 dist = VectorNormalizeLength(source_vec) * ch->dist_mult;
428 dot = DotProduct(listener_right, source_vec);
430 if (shm->channels == 1)
441 // add in distance effect
442 scale = (1.0 - dist) * rscale;
443 ch->rightvol = (int) (ch->master_vol * scale);
444 if (ch->rightvol < 0)
447 scale = (1.0 - dist) * lscale;
448 ch->leftvol = (int) (ch->master_vol * scale);
454 // =======================================================================
455 // Start a sound effect
456 // =======================================================================
458 void S_StartSound(int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
460 channel_t *target_chan, *check;
477 // pick a channel to play on
478 target_chan = SND_PickChannel(entnum, entchannel);
483 memset (target_chan, 0, sizeof(*target_chan));
484 VectorCopy(origin, target_chan->origin);
485 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
486 target_chan->master_vol = vol;
487 target_chan->entnum = entnum;
488 target_chan->entchannel = entchannel;
489 SND_Spatialize(target_chan);
491 if (!target_chan->leftvol && !target_chan->rightvol)
492 return; // not audible at all
495 sc = S_LoadSound (sfx);
498 target_chan->sfx = NULL;
499 return; // couldn't load the sound's data
502 target_chan->sfx = sfx;
503 target_chan->pos = 0.0;
504 target_chan->end = paintedtime + sc->length;
506 // if an identical sound has also been started this frame, offset the pos
507 // a bit to keep it from just making the first one louder
508 check = &channels[NUM_AMBIENTS];
509 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
511 if (check == target_chan)
513 if (check->sfx == sfx && !check->pos)
515 // LordHavoc: fixed skip calculations
516 skip = 0.1 * shm->speed;
517 if (skip > sc->length)
520 skip = rand() % skip;
521 target_chan->pos += skip;
522 target_chan->end -= skip;
529 void S_StopSound(int entnum, int entchannel)
533 for (i=0 ; i<MAX_DYNAMIC_CHANNELS ; i++)
535 if (channels[i].entnum == entnum
536 && channels[i].entchannel == entchannel)
539 channels[i].sfx = NULL;
545 void S_StopAllSounds(qboolean clear)
552 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
554 for (i=0 ; i<MAX_CHANNELS ; i++)
556 channels[i].sfx = NULL;
558 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
564 void S_StopAllSoundsC (void)
566 S_StopAllSounds (true);
569 void S_ClearBuffer (void)
574 if (!sound_started || !shm || (!shm->buffer && !pDSBuf))
576 if (!sound_started || !shm || !shm->buffer)
580 if (shm->samplebits == 8)
595 while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &pData, &dwSize, NULL, NULL, 0)) != DS_OK)
597 if (hresult != DSERR_BUFFERLOST)
599 Con_Printf ("S_ClearBuffer: DS::Lock Sound Buffer Failed\n");
606 Con_Printf ("S_ClearBuffer: DS: couldn't restore buffer\n");
612 memset(pData, clear, shm->samples * shm->samplebits/8);
614 pDSBuf->lpVtbl->Unlock(pDSBuf, pData, dwSize, NULL, 0);
620 int setsize = shm->samples * shm->samplebits / 8;
621 char *buf = shm->buffer;
626 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
627 // reads the memory area before writing to it causing a seg fault
628 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
629 // memset(shm->buffer, clear, shm->samples * shm->samplebits/8);
639 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation)
647 if (total_channels == MAX_CHANNELS)
649 Con_Printf ("total_channels == MAX_CHANNELS\n");
653 ss = &channels[total_channels];
656 sc = S_LoadSound (sfx);
660 if (sc->loopstart == -1)
662 Con_Printf ("Sound %s not looped\n", sfx->name);
667 VectorCopy (origin, ss->origin);
668 ss->master_vol = vol;
669 ss->dist_mult = (attenuation/64) / sound_nominal_clip_dist;
670 ss->end = paintedtime + sc->length;
676 //=============================================================================
680 S_UpdateAmbientSounds
683 void S_UpdateAmbientSounds (void)
690 // LordHavoc: kill ambient sounds until proven otherwise
691 for (ambient_channel = 0 ; ambient_channel < NUM_AMBIENTS;ambient_channel++)
692 channels[ambient_channel].sfx = NULL;
694 if (!snd_ambient || !cl.worldmodel || ambient_level.value <= 0)
697 l = Mod_PointInLeaf (listener_origin, cl.worldmodel);
701 // calc ambient sound levels
702 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
704 chan = &channels[ambient_channel];
705 chan->sfx = ambient_sfx[ambient_channel];
707 vol = ambient_level.value * l->ambient_sound_level[ambient_channel];
711 // don't adjust volume too fast
712 if (chan->master_vol < vol)
714 chan->master_vol += host_realframetime * ambient_fade.value;
715 if (chan->master_vol > vol)
716 chan->master_vol = vol;
718 else if (chan->master_vol > vol)
720 chan->master_vol -= host_realframetime * ambient_fade.value;
721 if (chan->master_vol < vol)
722 chan->master_vol = vol;
725 chan->leftvol = chan->rightvol = chan->master_vol;
734 Called once each time through the main loop
737 void S_Update(vec3_t origin, vec3_t forward, vec3_t right, vec3_t up)
744 if (!sound_started || (snd_blocked > 0))
747 VectorCopy(origin, listener_origin);
748 VectorCopy(forward, listener_forward);
749 VectorCopy(right, listener_right);
750 VectorCopy(up, listener_up);
752 // update general area ambient sound sources
753 S_UpdateAmbientSounds ();
757 // update spatialization for static and dynamic sounds
758 ch = channels+NUM_AMBIENTS;
759 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
763 SND_Spatialize(ch); // respatialize channel
764 if (!ch->leftvol && !ch->rightvol)
767 // try to combine static sounds with a previous channel of the same
768 // sound effect so we don't mix five torches every frame
770 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
772 // see if it can just use the last one
773 if (combine && combine->sfx == ch->sfx)
775 combine->leftvol += ch->leftvol;
776 combine->rightvol += ch->rightvol;
777 ch->leftvol = ch->rightvol = 0;
781 combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
782 for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
783 if (combine->sfx == ch->sfx)
786 if (j == total_channels)
794 combine->leftvol += ch->leftvol;
795 combine->rightvol += ch->rightvol;
796 ch->leftvol = ch->rightvol = 0;
808 if (snd_show.integer)
812 for (i=0 ; i<total_channels; i++, ch++)
813 if (ch->sfx && (ch->leftvol || ch->rightvol) )
815 //Con_Printf ("%3i %3i %s\n", ch->leftvol, ch->rightvol, ch->sfx->name);
819 Con_Printf ("----(%i)----\n", total);
826 void GetSoundtime(void)
830 static int oldsamplepos;
833 fullsamples = shm->samples / shm->channels;
835 // it is possible to miscount buffers if it has wrapped twice between
836 // calls to S_Update. Oh well.
838 soundtime = SNDDMA_GetSamples();
840 samplepos = SNDDMA_GetDMAPos();
843 if (samplepos < oldsamplepos)
845 buffers++; // buffer wrapped
847 if (paintedtime > 0x40000000)
848 { // time to chop things off to avoid 32 bit limits
850 paintedtime = fullsamples;
851 S_StopAllSounds (true);
854 oldsamplepos = samplepos;
856 soundtime = buffers*fullsamples + samplepos/shm->channels;
860 void IN_Accumulate (void);
862 void S_ExtraUpdate (void)
869 if (snd_noextraupdate.integer)
870 return; // don't pollute timings
879 if (!sound_started || (snd_blocked > 0))
885 // check to make sure that we haven't overshot
886 if (paintedtime < soundtime)
888 //Con_Printf ("S_Update_ : overflow\n");
889 paintedtime = soundtime;
892 // mix ahead of current position
893 endtime = soundtime + _snd_mixahead.value * shm->speed;
894 samps = shm->samples >> (shm->channels-1);
895 if (endtime - soundtime > samps)
896 endtime = soundtime + samps;
899 // if the buffer was lost or stopped, restore it and/or restart it
905 if (pDSBuf->lpVtbl->GetStatus (pDSBuf, &dwStatus) != DD_OK)
906 Con_Printf ("Couldn't get sound buffer status\n");
908 if (dwStatus & DSBSTATUS_BUFFERLOST)
909 pDSBuf->lpVtbl->Restore (pDSBuf);
911 if (!(dwStatus & DSBSTATUS_PLAYING))
912 pDSBuf->lpVtbl->Play(pDSBuf, 0, 0, DSBPLAY_LOOPING);
917 S_PaintChannels (endtime);
923 ===============================================================================
927 ===============================================================================
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, 1.0);
963 if (!strrchr(Cmd_Argv(i), '.'))
965 strcpy(name, Cmd_Argv(i));
966 strcat(name, ".wav");
969 strcpy(name, Cmd_Argv(i));
970 sfx = S_PrecacheSound(name);
971 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 0.0);
987 if (!strrchr(Cmd_Argv(i), '.'))
989 strcpy(name, Cmd_Argv(i));
990 strcat(name, ".wav");
993 strcpy(name, Cmd_Argv(i));
994 sfx = S_PrecacheSound(name);
995 vol = atof(Cmd_Argv(i+1));
996 S_StartSound(hash++, 0, sfx, listener_origin, vol, 1.0);
1001 void S_SoundList(void)
1009 for (sfx=known_sfx, i=0 ; i<num_sfx ; i++, sfx++)
1014 size = sc->length*sc->width*(sc->stereo+1);
1016 if (sc->loopstart >= 0)
1020 Con_Printf("(%2db) %6i : %s\n",sc->width*8, size, sfx->name);
1022 Con_Printf ("Total resident: %i\n", total);
1026 void S_LocalSound (char *sound)
1030 if (nosound.integer)
1035 sfx = S_PrecacheSound (sound);
1038 Con_Printf ("S_LocalSound: can't precache %s\n", sound);
1041 S_StartSound (cl.viewentity, -1, sfx, vec3_origin, 1, 1);
1045 void S_ClearPrecache (void)
1050 void S_BeginPrecaching (void)
1055 void S_EndPrecaching (void)