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", false);
233 ambient_sfx[AMBIENT_SKY] = S_PrecacheSound ("ambience/wind2.wav", false);
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))
283 return &known_sfx[i];
285 if (num_sfx == MAX_SFX)
286 Sys_Error ("S_FindName: out of sfx_t");
289 strcpy (sfx->name, name);
303 void S_TouchSound (char *name)
310 sfx = S_FindName (name);
319 sfx_t *S_PrecacheSound (char *name, int complain)
323 if (!sound_started || nosound.integer)
326 sfx = S_FindName (name);
329 if (precache.integer)
330 S_LoadSound (sfx, complain);
336 //=============================================================================
343 channel_t *SND_PickChannel(int entnum, int entchannel)
349 // Check for replacement sound, or find the best one to replace
351 life_left = 0x7fffffff;
352 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
354 if (entchannel != 0 // channel 0 never overrides
355 && channels[ch_idx].entnum == entnum
356 && (channels[ch_idx].entchannel == entchannel || entchannel == -1) )
357 { // always override sound from same entity
358 first_to_die = ch_idx;
362 // don't let monster sounds override player sounds
363 if (channels[ch_idx].entnum == cl.viewentity && entnum != cl.viewentity && channels[ch_idx].sfx)
366 if (channels[ch_idx].end - paintedtime < life_left)
368 life_left = channels[ch_idx].end - paintedtime;
369 first_to_die = ch_idx;
373 if (first_to_die == -1)
376 if (channels[first_to_die].sfx)
377 channels[first_to_die].sfx = NULL;
379 return &channels[first_to_die];
387 void SND_Spatialize(channel_t *ch)
391 vec_t lscale, rscale, scale;
395 // anything coming from the view entity will always be full volume
396 // LordHavoc: make sounds with ATTN_NONE have no spatialization
397 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
399 ch->leftvol = ch->master_vol;
400 ch->rightvol = ch->master_vol;
404 // calculate stereo seperation and distance attenuation
407 VectorSubtract(ch->origin, listener_origin, source_vec);
409 dist = VectorNormalizeLength(source_vec) * ch->dist_mult;
411 dot = DotProduct(listener_right, source_vec);
413 if (shm->channels == 1)
424 // add in distance effect
425 scale = (1.0 - dist) * rscale;
426 ch->rightvol = (int) (ch->master_vol * scale);
427 if (ch->rightvol < 0)
430 scale = (1.0 - dist) * lscale;
431 ch->leftvol = (int) (ch->master_vol * scale);
437 // =======================================================================
438 // Start a sound effect
439 // =======================================================================
441 void S_StartSound(int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
443 channel_t *target_chan, *check;
460 // pick a channel to play on
461 target_chan = SND_PickChannel(entnum, entchannel);
466 memset (target_chan, 0, sizeof(*target_chan));
467 VectorCopy(origin, target_chan->origin);
468 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
469 target_chan->master_vol = vol;
470 target_chan->entnum = entnum;
471 target_chan->entchannel = entchannel;
472 SND_Spatialize(target_chan);
474 if (!target_chan->leftvol && !target_chan->rightvol)
475 return; // not audible at all
478 sc = S_LoadSound (sfx, true);
481 target_chan->sfx = NULL;
482 return; // couldn't load the sound's data
485 target_chan->sfx = sfx;
486 target_chan->pos = 0.0;
487 target_chan->end = paintedtime + sc->length;
489 // if an identical sound has also been started this frame, offset the pos
490 // a bit to keep it from just making the first one louder
491 check = &channels[NUM_AMBIENTS];
492 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
494 if (check == target_chan)
496 if (check->sfx == sfx && !check->pos)
498 // LordHavoc: fixed skip calculations
499 skip = 0.1 * shm->speed;
500 if (skip > sc->length)
503 skip = rand() % skip;
504 target_chan->pos += skip;
505 target_chan->end -= skip;
512 void S_StopSound(int entnum, int entchannel)
516 for (i=0 ; i<MAX_DYNAMIC_CHANNELS ; i++)
518 if (channels[i].entnum == entnum
519 && channels[i].entchannel == entchannel)
522 channels[i].sfx = NULL;
528 void S_StopAllSounds(qboolean clear)
535 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
537 for (i=0 ; i<MAX_CHANNELS ; i++)
539 channels[i].sfx = NULL;
541 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
547 void S_StopAllSoundsC (void)
549 S_StopAllSounds (true);
552 void S_ClearBuffer (void)
557 if (!sound_started || !shm || (!shm->buffer && !pDSBuf))
559 if (!sound_started || !shm || !shm->buffer)
563 if (shm->samplebits == 8)
578 while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &pData, &dwSize, NULL, NULL, 0)) != DS_OK)
580 if (hresult != DSERR_BUFFERLOST)
582 Con_Printf ("S_ClearBuffer: DS::Lock Sound Buffer Failed\n");
589 Con_Printf ("S_ClearBuffer: DS: couldn't restore buffer\n");
595 memset(pData, clear, shm->samples * shm->samplebits/8);
597 pDSBuf->lpVtbl->Unlock(pDSBuf, pData, dwSize, NULL, 0);
603 int setsize = shm->samples * shm->samplebits / 8;
604 char *buf = shm->buffer;
609 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
610 // reads the memory area before writing to it causing a seg fault
611 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
612 // memset(shm->buffer, clear, shm->samples * shm->samplebits/8);
622 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation)
630 if (total_channels == MAX_CHANNELS)
632 Con_Printf ("total_channels == MAX_CHANNELS\n");
636 ss = &channels[total_channels];
639 sc = S_LoadSound (sfx, true);
643 if (sc->loopstart == -1)
645 Con_Printf ("Sound %s not looped\n", sfx->name);
650 VectorCopy (origin, ss->origin);
651 ss->master_vol = vol;
652 ss->dist_mult = (attenuation/64) / sound_nominal_clip_dist;
653 ss->end = paintedtime + sc->length;
659 //=============================================================================
663 S_UpdateAmbientSounds
666 void S_UpdateAmbientSounds (void)
673 // LordHavoc: kill ambient sounds until proven otherwise
674 for (ambient_channel = 0 ; ambient_channel < NUM_AMBIENTS;ambient_channel++)
675 channels[ambient_channel].sfx = NULL;
677 if (!snd_ambient || !cl.worldmodel || ambient_level.value <= 0)
680 l = Mod_PointInLeaf (listener_origin, cl.worldmodel);
684 // calc ambient sound levels
685 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
687 chan = &channels[ambient_channel];
688 chan->sfx = ambient_sfx[ambient_channel];
690 vol = ambient_level.value * l->ambient_sound_level[ambient_channel];
694 // don't adjust volume too fast
695 if (chan->master_vol < vol)
697 chan->master_vol += host_realframetime * ambient_fade.value;
698 if (chan->master_vol > vol)
699 chan->master_vol = vol;
701 else if (chan->master_vol > vol)
703 chan->master_vol -= host_realframetime * ambient_fade.value;
704 if (chan->master_vol < vol)
705 chan->master_vol = vol;
708 chan->leftvol = chan->rightvol = chan->master_vol;
717 Called once each time through the main loop
720 void S_Update(vec3_t origin, vec3_t forward, vec3_t right, vec3_t up)
727 if (!sound_started || (snd_blocked > 0))
730 VectorCopy(origin, listener_origin);
731 VectorCopy(forward, listener_forward);
732 VectorCopy(right, listener_right);
733 VectorCopy(up, listener_up);
735 // update general area ambient sound sources
736 S_UpdateAmbientSounds ();
740 // update spatialization for static and dynamic sounds
741 ch = channels+NUM_AMBIENTS;
742 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
746 SND_Spatialize(ch); // respatialize channel
747 if (!ch->leftvol && !ch->rightvol)
750 // try to combine static sounds with a previous channel of the same
751 // sound effect so we don't mix five torches every frame
753 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
755 // see if it can just use the last one
756 if (combine && combine->sfx == ch->sfx)
758 combine->leftvol += ch->leftvol;
759 combine->rightvol += ch->rightvol;
760 ch->leftvol = ch->rightvol = 0;
764 combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
765 for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
766 if (combine->sfx == ch->sfx)
769 if (j == total_channels)
777 combine->leftvol += ch->leftvol;
778 combine->rightvol += ch->rightvol;
779 ch->leftvol = ch->rightvol = 0;
789 if (snd_show.integer)
793 for (i=0 ; i<total_channels; i++, ch++)
794 if (ch->sfx && (ch->leftvol || ch->rightvol) )
797 Con_Printf ("----(%i)----\n", total);
804 void GetSoundtime(void)
808 static int oldsamplepos;
811 fullsamples = shm->samples / shm->channels;
813 // it is possible to miscount buffers if it has wrapped twice between
814 // calls to S_Update. Oh well.
816 soundtime = SNDDMA_GetSamples();
818 samplepos = SNDDMA_GetDMAPos();
821 if (samplepos < oldsamplepos)
823 buffers++; // buffer wrapped
825 if (paintedtime > 0x40000000)
826 { // time to chop things off to avoid 32 bit limits
828 paintedtime = fullsamples;
829 S_StopAllSounds (true);
832 oldsamplepos = samplepos;
834 soundtime = buffers*fullsamples + samplepos/shm->channels;
838 void IN_Accumulate (void);
840 void S_ExtraUpdate (void)
847 if (snd_noextraupdate.integer)
848 return; // don't pollute timings
857 if (!sound_started || (snd_blocked > 0))
863 // check to make sure that we haven't overshot
864 if (paintedtime < soundtime)
865 paintedtime = soundtime;
867 // mix ahead of current position
868 endtime = soundtime + _snd_mixahead.value * shm->speed;
869 samps = shm->samples >> (shm->channels-1);
870 if (endtime - soundtime > samps)
871 endtime = soundtime + samps;
874 // if the buffer was lost or stopped, restore it and/or restart it
880 if (pDSBuf->lpVtbl->GetStatus (pDSBuf, &dwStatus) != DD_OK)
881 Con_Printf ("Couldn't get sound buffer status\n");
883 if (dwStatus & DSBSTATUS_BUFFERLOST)
884 pDSBuf->lpVtbl->Restore (pDSBuf);
886 if (!(dwStatus & DSBSTATUS_PLAYING))
887 pDSBuf->lpVtbl->Play(pDSBuf, 0, 0, DSBPLAY_LOOPING);
892 S_PaintChannels (endtime);
898 ===============================================================================
902 ===============================================================================
915 if (!strrchr(Cmd_Argv(i), '.'))
917 strcpy(name, Cmd_Argv(i));
918 strcat(name, ".wav");
921 strcpy(name, Cmd_Argv(i));
922 sfx = S_PrecacheSound(name, true);
923 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 1.0);
938 if (!strrchr(Cmd_Argv(i), '.'))
940 strcpy(name, Cmd_Argv(i));
941 strcat(name, ".wav");
944 strcpy(name, Cmd_Argv(i));
945 sfx = S_PrecacheSound(name, true);
946 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 0.0);
962 if (!strrchr(Cmd_Argv(i), '.'))
964 strcpy(name, Cmd_Argv(i));
965 strcat(name, ".wav");
968 strcpy(name, Cmd_Argv(i));
969 sfx = S_PrecacheSound(name, true);
970 vol = atof(Cmd_Argv(i+1));
971 S_StartSound(hash++, 0, sfx, listener_origin, vol, 1.0);
976 void S_SoundList(void)
984 for (sfx=known_sfx, i=0 ; i<num_sfx ; i++, sfx++)
989 size = sc->length*sc->width*(sc->stereo+1);
991 if (sc->loopstart >= 0)
995 Con_Printf("(%2db) %6i : %s\n",sc->width*8, size, sfx->name);
997 Con_Printf ("Total resident: %i\n", total);
1001 void S_LocalSound (char *sound)
1005 if (nosound.integer)
1010 sfx = S_PrecacheSound (sound, true);
1013 Con_Printf ("S_LocalSound: can't precache %s\n", sound);
1016 S_StartSound (cl.viewentity, -1, sfx, vec3_origin, 1, 1);
1020 void S_ClearPrecache (void)
1025 void S_BeginPrecaching (void)
1030 void S_EndPrecaching (void)