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 desired_speed = 11025;
68 int desired_bits = 16;
72 cvar_t bgmvolume = {"bgmvolume", "1", true};
73 cvar_t volume = {"volume", "0.7", true};
75 cvar_t nosound = {"nosound", "0"};
76 cvar_t precache = {"precache", "1"};
77 cvar_t loadas8bit = {"loadas8bit", "0"};
78 cvar_t bgmbuffer = {"bgmbuffer", "4096"};
79 cvar_t ambient_level = {"ambient_level", "0.3"};
80 cvar_t ambient_fade = {"ambient_fade", "100"};
81 cvar_t snd_noextraupdate = {"snd_noextraupdate", "0"};
82 cvar_t snd_show = {"snd_show", "0"};
83 cvar_t _snd_mixahead = {"_snd_mixahead", "0.1", true};
84 cvar_t snd_swapstereo = {"snd_swapstereo", "0", true};
87 // ====================================================================
88 // User-setable variables
89 // ====================================================================
93 // Fake dma is a synchronous faking of the DMA progress used for
94 // isolating performance in the renderer. The fakedma_updates is
95 // number of times S_Update() is called per second.
98 qboolean fakedma = false;
99 int fakedma_updates = 15;
102 void S_AmbientOff (void)
108 void S_AmbientOn (void)
114 void S_SoundInfo_f(void)
116 if (!sound_started || !shm)
118 Con_Printf ("sound system not started\n");
122 Con_Printf("%5d stereo\n", shm->channels - 1);
123 Con_Printf("%5d samples\n", shm->samples);
124 Con_Printf("%5d samplepos\n", shm->samplepos);
125 Con_Printf("%5d samplebits\n", shm->samplebits);
126 Con_Printf("%5d submission_chunk\n", shm->submission_chunk);
127 Con_Printf("%5d speed\n", shm->speed);
128 Con_Printf("0x%x dma buffer\n", shm->buffer);
129 Con_Printf("%5d total_channels\n", total_channels);
139 void S_Startup (void)
143 if (!snd_initialized)
153 Con_Printf("S_Startup: SNDDMA_Init failed.\n");
174 Con_Printf("\nSound Initialization\n");
176 if (COM_CheckParm("-nosound"))
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(&volume);
191 Cvar_RegisterVariable(&precache);
192 Cvar_RegisterVariable(&loadas8bit);
193 Cvar_RegisterVariable(&bgmvolume);
194 Cvar_RegisterVariable(&bgmbuffer);
195 Cvar_RegisterVariable(&ambient_level);
196 Cvar_RegisterVariable(&ambient_fade);
197 Cvar_RegisterVariable(&snd_noextraupdate);
198 Cvar_RegisterVariable(&snd_show);
199 Cvar_RegisterVariable(&_snd_mixahead);
200 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");
210 snd_initialized = true;
214 SND_InitScaletable ();
216 known_sfx = Hunk_AllocName (MAX_SFX*sizeof(sfx_t), "sfx_t");
219 // create a piece of DMA memory
223 shm = (void *) Hunk_AllocName(sizeof(*shm), "shm");
224 shm->splitbuffer = 0;
225 shm->samplebits = 16;
228 shm->samples = 32768;
230 shm->soundalive = true;
231 shm->gamealive = true;
232 shm->submission_chunk = 1;
233 shm->buffer = Hunk_AllocName(1<<16, "shmbuf");
236 Con_Printf ("Sound sampling rate: %i\n", shm->speed);
238 // provides a tick sound until washed clean
241 // shm->buffer[4] = shm->buffer[5] = 0x7f; // force a pop for debugging
243 ambient_sfx[AMBIENT_WATER] = S_PrecacheSound ("ambience/water1.wav");
244 ambient_sfx[AMBIENT_SKY] = S_PrecacheSound ("ambience/wind2.wav");
246 S_StopAllSounds (true);
250 // =======================================================================
251 // Shutdown sound engine
252 // =======================================================================
254 void S_Shutdown(void)
273 // =======================================================================
275 // =======================================================================
283 sfx_t *S_FindName (char *name)
289 Sys_Error ("S_FindName: NULL\n");
291 if (strlen(name) >= MAX_QPATH)
292 Sys_Error ("Sound name too long: %s", name);
294 // see if already loaded
295 for (i=0 ; i < num_sfx ; i++)
296 if (!strcmp(known_sfx[i].name, name))
298 return &known_sfx[i];
301 if (num_sfx == MAX_SFX)
302 Sys_Error ("S_FindName: out of sfx_t");
305 strcpy (sfx->name, name);
319 void S_TouchSound (char *name)
326 sfx = S_FindName (name);
327 Cache_Check (&sfx->cache);
336 sfx_t *S_PrecacheSound (char *name)
340 if (!sound_started || nosound.value)
343 sfx = S_FindName (name);
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 { // allways 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 allways 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 skip = rand () % (int)(0.1*shm->speed);
516 if (skip >= target_chan->end)
517 skip = target_chan->end - 1;
518 target_chan->pos += skip;
519 target_chan->end -= skip;
526 void S_StopSound(int entnum, int entchannel)
530 for (i=0 ; i<MAX_DYNAMIC_CHANNELS ; i++)
532 if (channels[i].entnum == entnum
533 && channels[i].entchannel == entchannel)
536 channels[i].sfx = NULL;
542 void S_StopAllSounds(qboolean clear)
549 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
551 for (i=0 ; i<MAX_CHANNELS ; i++)
553 channels[i].sfx = NULL;
555 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
561 void S_StopAllSoundsC (void)
563 S_StopAllSounds (true);
566 void S_ClearBuffer (void)
571 if (!sound_started || !shm || (!shm->buffer && !pDSBuf))
573 if (!sound_started || !shm || !shm->buffer)
577 if (shm->samplebits == 8)
592 while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &pData, &dwSize, NULL, NULL, 0)) != DS_OK)
594 if (hresult != DSERR_BUFFERLOST)
596 Con_Printf ("S_ClearBuffer: DS::Lock Sound Buffer Failed\n");
603 Con_Printf ("S_ClearBuffer: DS: couldn't restore buffer\n");
609 memset(pData, clear, shm->samples * shm->samplebits/8);
611 pDSBuf->lpVtbl->Unlock(pDSBuf, pData, dwSize, NULL, 0);
617 memset(shm->buffer, clear, shm->samples * shm->samplebits/8);
627 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation)
635 if (total_channels == MAX_CHANNELS)
637 Con_Printf ("total_channels == MAX_CHANNELS\n");
641 ss = &channels[total_channels];
644 sc = S_LoadSound (sfx);
648 if (sc->loopstart == -1)
650 Con_Printf ("Sound %s not looped\n", sfx->name);
655 VectorCopy (origin, ss->origin);
656 ss->master_vol = vol;
657 ss->dist_mult = (attenuation/64) / sound_nominal_clip_dist;
658 ss->end = paintedtime + sc->length;
664 //=============================================================================
668 S_UpdateAmbientSounds
671 void S_UpdateAmbientSounds (void)
681 // calc ambient sound levels
685 l = Mod_PointInLeaf (listener_origin, cl.worldmodel);
686 if (!l || !ambient_level.value)
688 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
689 channels[ambient_channel].sfx = NULL;
693 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
695 chan = &channels[ambient_channel];
696 chan->sfx = ambient_sfx[ambient_channel];
698 vol = ambient_level.value * l->ambient_sound_level[ambient_channel];
702 // don't adjust volume too fast
703 if (chan->master_vol < vol)
705 chan->master_vol += host_frametime * ambient_fade.value;
706 if (chan->master_vol > vol)
707 chan->master_vol = vol;
709 else if (chan->master_vol > vol)
711 chan->master_vol -= host_frametime * ambient_fade.value;
712 if (chan->master_vol < vol)
713 chan->master_vol = vol;
716 chan->leftvol = chan->rightvol = chan->master_vol;
725 Called once each time through the main loop
728 void S_Update(vec3_t origin, vec3_t forward, vec3_t right, vec3_t up)
735 if (!sound_started || (snd_blocked > 0))
738 VectorCopy(origin, listener_origin);
739 VectorCopy(forward, listener_forward);
740 VectorCopy(right, listener_right);
741 VectorCopy(up, listener_up);
743 // update general area ambient sound sources
744 S_UpdateAmbientSounds ();
748 // update spatialization for static and dynamic sounds
749 ch = channels+NUM_AMBIENTS;
750 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
754 SND_Spatialize(ch); // respatialize channel
755 if (!ch->leftvol && !ch->rightvol)
758 // try to combine static sounds with a previous channel of the same
759 // sound effect so we don't mix five torches every frame
761 if (i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
763 // see if it can just use the last one
764 if (combine && combine->sfx == ch->sfx)
766 combine->leftvol += ch->leftvol;
767 combine->rightvol += ch->rightvol;
768 ch->leftvol = ch->rightvol = 0;
772 combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
773 for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
774 if (combine->sfx == ch->sfx)
777 if (j == total_channels)
785 combine->leftvol += ch->leftvol;
786 combine->rightvol += ch->rightvol;
787 ch->leftvol = ch->rightvol = 0;
803 for (i=0 ; i<total_channels; i++, ch++)
804 if (ch->sfx && (ch->leftvol || ch->rightvol) )
806 //Con_Printf ("%3i %3i %s\n", ch->leftvol, ch->rightvol, ch->sfx->name);
810 Con_Printf ("----(%i)----\n", total);
817 void GetSoundtime(void)
821 static int oldsamplepos;
824 fullsamples = shm->samples / shm->channels;
826 // it is possible to miscount buffers if it has wrapped twice between
827 // calls to S_Update. Oh well.
829 soundtime = SNDDMA_GetSamples();
831 samplepos = SNDDMA_GetDMAPos();
834 if (samplepos < oldsamplepos)
836 buffers++; // buffer wrapped
838 if (paintedtime > 0x40000000)
839 { // time to chop things off to avoid 32 bit limits
841 paintedtime = fullsamples;
842 S_StopAllSounds (true);
845 oldsamplepos = samplepos;
847 soundtime = buffers*fullsamples + samplepos/shm->channels;
851 void IN_Accumulate (void);
853 void S_ExtraUpdate (void)
860 if (snd_noextraupdate.value)
861 return; // don't pollute timings
870 if (!sound_started || (snd_blocked > 0))
876 // check to make sure that we haven't overshot
877 if (paintedtime < soundtime)
879 //Con_Printf ("S_Update_ : overflow\n");
880 paintedtime = soundtime;
883 // mix ahead of current position
884 endtime = soundtime + _snd_mixahead.value * shm->speed;
885 samps = shm->samples >> (shm->channels-1);
886 if (endtime - soundtime > samps)
887 endtime = soundtime + samps;
890 // if the buffer was lost or stopped, restore it and/or restart it
896 if (pDSBuf->lpVtbl->GetStatus (pDSBuf, &dwStatus) != DD_OK)
897 Con_Printf ("Couldn't get sound buffer status\n");
899 if (dwStatus & DSBSTATUS_BUFFERLOST)
900 pDSBuf->lpVtbl->Restore (pDSBuf);
902 if (!(dwStatus & DSBSTATUS_PLAYING))
903 pDSBuf->lpVtbl->Play(pDSBuf, 0, 0, DSBPLAY_LOOPING);
908 S_PaintChannels (endtime);
914 ===============================================================================
918 ===============================================================================
931 if (!strrchr(Cmd_Argv(i), '.'))
933 strcpy(name, Cmd_Argv(i));
934 strcat(name, ".wav");
937 strcpy(name, Cmd_Argv(i));
938 sfx = S_PrecacheSound(name);
939 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 1.0);
954 if (!strrchr(Cmd_Argv(i), '.'))
956 strcpy(name, Cmd_Argv(i));
957 strcat(name, ".wav");
960 strcpy(name, Cmd_Argv(i));
961 sfx = S_PrecacheSound(name);
962 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 0.0);
978 if (!strrchr(Cmd_Argv(i), '.'))
980 strcpy(name, Cmd_Argv(i));
981 strcat(name, ".wav");
984 strcpy(name, Cmd_Argv(i));
985 sfx = S_PrecacheSound(name);
986 vol = atof(Cmd_Argv(i+1));
987 S_StartSound(hash++, 0, sfx, listener_origin, vol, 1.0);
992 void S_SoundList(void)
1000 for (sfx=known_sfx, i=0 ; i<num_sfx ; i++, sfx++)
1002 sc = Cache_Check (&sfx->cache);
1005 size = sc->length*sc->width*(sc->stereo+1);
1007 if (sc->loopstart >= 0)
1011 Con_Printf("(%2db) %6i : %s\n",sc->width*8, size, sfx->name);
1013 Con_Printf ("Total resident: %i\n", total);
1017 void S_LocalSound (char *sound)
1026 sfx = S_PrecacheSound (sound);
1029 Con_Printf ("S_LocalSound: can't cache %s\n", sound);
1032 S_StartSound (cl.viewentity, -1, sfx, vec3_origin, 1, 1);
1036 void S_ClearPrecache (void)
1041 void S_BeginPrecaching (void)
1046 void S_EndPrecaching (void)