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
31 void S_SoundList(void);
33 void S_StopAllSounds(qboolean clear);
34 void S_StopAllSoundsC(void);
36 // =======================================================================
37 // Internal sound data & structures
38 // =======================================================================
40 channel_t channels[MAX_CHANNELS];
44 static qboolean snd_ambient = 1;
45 qboolean snd_initialized = false;
47 // pointer should go away
48 volatile dma_t *shm = 0;
51 vec3_t listener_origin;
52 vec3_t listener_forward;
53 vec3_t listener_right;
55 vec_t sound_nominal_clip_dist=1000.0;
56 mempool_t *snd_mempool;
63 //LordHavoc: increased the client sound limit from 512 to 4096 for the Nehahra movie
65 sfx_t *known_sfx; // allocated [MAX_SFX]
68 sfx_t *ambient_sfx[NUM_AMBIENTS];
70 int sound_started = 0;
72 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1"};
73 cvar_t volume = {CVAR_SAVE, "volume", "0.7"};
75 cvar_t nosound = {0, "nosound", "0"};
76 cvar_t precache = {0, "precache", "1"};
77 cvar_t bgmbuffer = {0, "bgmbuffer", "4096"};
78 cvar_t ambient_level = {0, "ambient_level", "0.3"};
79 cvar_t ambient_fade = {0, "ambient_fade", "100"};
80 cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0"};
81 cvar_t snd_show = {0, "snd_show", "0"};
82 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1"};
83 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0"};
86 // ====================================================================
87 // User-setable variables
88 // ====================================================================
92 // Fake dma is a synchronous faking of the DMA progress used for
93 // isolating performance in the renderer. The fakedma_updates is
94 // number of times S_Update() is called per second.
97 qboolean fakedma = false;
98 int fakedma_updates = 15;
101 void S_AmbientOff (void)
107 void S_AmbientOn (void)
113 void S_SoundInfo_f(void)
115 if (!sound_started || !shm)
117 Con_Printf ("sound system not started\n");
121 Con_Printf("%5d stereo\n", shm->channels - 1);
122 Con_Printf("%5d samples\n", shm->samples);
123 Con_Printf("%5d samplepos\n", shm->samplepos);
124 Con_Printf("%5d samplebits\n", shm->samplebits);
125 Con_Printf("%5d submission_chunk\n", shm->submission_chunk);
126 Con_Printf("%5d speed\n", shm->speed);
127 Con_Printf("0x%x dma buffer\n", shm->buffer);
128 Con_Printf("%5d total_channels\n", total_channels);
137 void S_Startup (void)
141 if (!snd_initialized)
150 Con_Printf("S_Startup: SNDDMA_Init failed.\n");
166 Con_Printf("\nSound Initialization\n");
168 S_RawSamples_ClearQueue();
170 Cvar_RegisterVariable(&volume);
171 Cvar_RegisterVariable(&bgmvolume);
173 if (COM_CheckParm("-nosound"))
176 snd_mempool = Mem_AllocPool("sound");
178 if (COM_CheckParm("-simsound"))
181 Cmd_AddCommand("play", S_Play);
182 Cmd_AddCommand("play2", S_Play2);
183 Cmd_AddCommand("playvol", S_PlayVol);
184 Cmd_AddCommand("stopsound", S_StopAllSoundsC);
185 Cmd_AddCommand("soundlist", S_SoundList);
186 Cmd_AddCommand("soundinfo", S_SoundInfo_f);
188 Cvar_RegisterVariable(&nosound);
189 Cvar_RegisterVariable(&precache);
190 Cvar_RegisterVariable(&bgmbuffer);
191 Cvar_RegisterVariable(&ambient_level);
192 Cvar_RegisterVariable(&ambient_fade);
193 Cvar_RegisterVariable(&snd_noextraupdate);
194 Cvar_RegisterVariable(&snd_show);
195 Cvar_RegisterVariable(&_snd_mixahead);
196 Cvar_RegisterVariable(&snd_swapstereo); // LordHavoc: for people with backwards sound wiring
198 snd_initialized = true;
200 known_sfx = Mem_Alloc(snd_mempool, MAX_SFX*sizeof(sfx_t));
205 SND_InitScaletable ();
207 // create a piece of DMA memory
211 shm = (void *) Mem_Alloc(snd_mempool, sizeof(*shm));
212 shm->splitbuffer = 0;
213 shm->samplebits = 16;
216 shm->samples = 32768;
218 shm->soundalive = true;
219 shm->gamealive = true;
220 shm->submission_chunk = 1;
221 shm->buffer = Mem_Alloc(snd_mempool, shm->channels * shm->samples * (shm->samplebits / 8));
227 Con_Printf ("Sound sampling rate: %i\n", shm->speed);
229 // provides a tick sound until washed clean
231 ambient_sfx[AMBIENT_WATER] = S_PrecacheSound ("ambience/water1.wav", false);
232 ambient_sfx[AMBIENT_SKY] = S_PrecacheSound ("ambience/wind2.wav", false);
234 S_StopAllSounds (true);
238 // =======================================================================
239 // Shutdown sound engine
240 // =======================================================================
242 void S_Shutdown(void)
258 // =======================================================================
260 // =======================================================================
268 sfx_t *S_FindName (char *name)
274 Host_Error ("S_FindName: NULL\n");
276 if (strlen(name) >= MAX_QPATH)
277 Host_Error ("Sound name too long: %s", name);
279 // see if already loaded
280 for (i = 0;i < num_sfx;i++)
281 if (!strcmp(known_sfx[i].name, name))
282 return &known_sfx[i];
284 if (num_sfx == MAX_SFX)
285 Sys_Error ("S_FindName: out of sfx_t");
288 strcpy (sfx->name, name);
302 void S_TouchSound (char *name)
309 sfx = S_FindName (name);
318 sfx_t *S_PrecacheSound (char *name, int complain)
322 if (!sound_started || nosound.integer)
325 sfx = S_FindName (name);
328 if (precache.integer)
329 S_LoadSound (sfx, complain);
335 //=============================================================================
342 channel_t *SND_PickChannel(int entnum, int entchannel)
348 // Check for replacement sound, or find the best one to replace
350 life_left = 0x7fffffff;
351 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
353 if (entchannel != 0 // channel 0 never overrides
354 && channels[ch_idx].entnum == entnum
355 && (channels[ch_idx].entchannel == entchannel || entchannel == -1) )
356 { // always override sound from same entity
357 first_to_die = ch_idx;
361 // don't let monster sounds override player sounds
362 if (channels[ch_idx].entnum == cl.viewentity && entnum != cl.viewentity && channels[ch_idx].sfx)
365 if (channels[ch_idx].end - paintedtime < life_left)
367 life_left = channels[ch_idx].end - paintedtime;
368 first_to_die = ch_idx;
372 if (first_to_die == -1)
375 if (channels[first_to_die].sfx)
376 channels[first_to_die].sfx = NULL;
378 return &channels[first_to_die];
386 void SND_Spatialize(channel_t *ch)
390 vec_t lscale, rscale, scale;
394 // anything coming from the view entity will always be full volume
395 // LordHavoc: make sounds with ATTN_NONE have no spatialization
396 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
398 ch->leftvol = ch->master_vol;
399 ch->rightvol = ch->master_vol;
403 // calculate stereo seperation and distance attenuation
406 VectorSubtract(ch->origin, listener_origin, source_vec);
408 dist = VectorNormalizeLength(source_vec) * ch->dist_mult;
410 dot = DotProduct(listener_right, source_vec);
412 if (shm->channels == 1)
423 // add in distance effect
424 scale = (1.0 - dist) * rscale;
425 ch->rightvol = (int) (ch->master_vol * scale);
426 if (ch->rightvol < 0)
429 scale = (1.0 - dist) * lscale;
430 ch->leftvol = (int) (ch->master_vol * scale);
436 // =======================================================================
437 // Start a sound effect
438 // =======================================================================
440 void S_StartSound(int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
442 channel_t *target_chan, *check;
459 // pick a channel to play on
460 target_chan = SND_PickChannel(entnum, entchannel);
465 memset (target_chan, 0, sizeof(*target_chan));
466 VectorCopy(origin, target_chan->origin);
467 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
468 target_chan->master_vol = vol;
469 target_chan->entnum = entnum;
470 target_chan->entchannel = entchannel;
471 SND_Spatialize(target_chan);
473 if (!target_chan->leftvol && !target_chan->rightvol)
474 return; // not audible at all
477 sc = S_LoadSound (sfx, true);
480 target_chan->sfx = NULL;
481 return; // couldn't load the sound's data
484 target_chan->sfx = sfx;
485 target_chan->pos = 0.0;
486 target_chan->end = paintedtime + sc->length;
488 // if an identical sound has also been started this frame, offset the pos
489 // a bit to keep it from just making the first one louder
490 check = &channels[NUM_AMBIENTS];
491 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
493 if (check == target_chan)
495 if (check->sfx == sfx && !check->pos)
497 // LordHavoc: fixed skip calculations
498 skip = 0.1 * shm->speed;
499 if (skip > sc->length)
502 skip = rand() % skip;
503 target_chan->pos += skip;
504 target_chan->end -= skip;
511 void S_StopSound(int entnum, int entchannel)
515 for (i=0 ; i<MAX_DYNAMIC_CHANNELS ; i++)
517 if (channels[i].entnum == entnum
518 && channels[i].entchannel == entchannel)
521 channels[i].sfx = NULL;
527 void S_StopAllSounds(qboolean clear)
534 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
536 for (i=0 ; i<MAX_CHANNELS ; i++)
538 channels[i].sfx = NULL;
540 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
546 void S_StopAllSoundsC (void)
548 S_StopAllSounds (true);
551 void S_ClearBuffer (void)
556 if (!sound_started || !shm || (!shm->buffer && !pDSBuf))
558 if (!sound_started || !shm || !shm->buffer)
562 if (shm->samplebits == 8)
577 while ((hresult = pDSBuf->lpVtbl->Lock(pDSBuf, 0, gSndBufSize, &pData, &dwSize, NULL, NULL, 0)) != DS_OK)
579 if (hresult != DSERR_BUFFERLOST)
581 Con_Printf ("S_ClearBuffer: DS::Lock Sound Buffer Failed\n");
588 Con_Printf ("S_ClearBuffer: DS: couldn't restore buffer\n");
594 memset(pData, clear, shm->samples * shm->samplebits/8);
596 pDSBuf->lpVtbl->Unlock(pDSBuf, pData, dwSize, NULL, 0);
602 int setsize = shm->samples * shm->samplebits / 8;
603 char *buf = shm->buffer;
608 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
609 // reads the memory area before writing to it causing a seg fault
610 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
611 // memset(shm->buffer, clear, shm->samples * shm->samplebits/8);
621 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation)
629 if (total_channels == MAX_CHANNELS)
631 Con_Printf ("total_channels == MAX_CHANNELS\n");
635 ss = &channels[total_channels];
638 sc = S_LoadSound (sfx, true);
642 if (sc->loopstart == -1)
644 Con_Printf ("Sound %s not looped\n", sfx->name);
649 VectorCopy (origin, ss->origin);
650 ss->master_vol = vol;
651 ss->dist_mult = (attenuation/64) / sound_nominal_clip_dist;
652 ss->end = paintedtime + sc->length;
658 //=============================================================================
662 S_UpdateAmbientSounds
665 void S_UpdateAmbientSounds (void)
672 // LordHavoc: kill ambient sounds until proven otherwise
673 for (ambient_channel = 0 ; ambient_channel < NUM_AMBIENTS;ambient_channel++)
674 channels[ambient_channel].sfx = NULL;
676 if (!snd_ambient || !cl.worldmodel || ambient_level.value <= 0)
679 l = Mod_PointInLeaf (listener_origin, cl.worldmodel);
683 // calc ambient sound levels
684 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
686 chan = &channels[ambient_channel];
687 chan->sfx = ambient_sfx[ambient_channel];
689 vol = ambient_level.value * l->ambient_sound_level[ambient_channel];
693 // don't adjust volume too fast
694 if (chan->master_vol < vol)
696 chan->master_vol += host_realframetime * ambient_fade.value;
697 if (chan->master_vol > vol)
698 chan->master_vol = vol;
700 else if (chan->master_vol > vol)
702 chan->master_vol -= host_realframetime * ambient_fade.value;
703 if (chan->master_vol < vol)
704 chan->master_vol = vol;
707 chan->leftvol = chan->rightvol = chan->master_vol;
716 Called once each time through the main loop
719 void S_Update(vec3_t origin, vec3_t forward, vec3_t right, vec3_t up)
726 if (!sound_started || (snd_blocked > 0))
729 VectorCopy(origin, listener_origin);
730 VectorCopy(forward, listener_forward);
731 VectorCopy(right, listener_right);
732 VectorCopy(up, listener_up);
734 // update general area ambient sound sources
735 S_UpdateAmbientSounds ();
739 // update spatialization for static and dynamic sounds
740 ch = channels+NUM_AMBIENTS;
741 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
745 SND_Spatialize(ch); // respatialize channel
746 if (!ch->leftvol && !ch->rightvol)
749 // try to combine static sounds with a previous channel of the same
750 // sound effect so we don't mix five torches every frame
752 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
754 // see if it can just use the last one
755 if (combine && combine->sfx == ch->sfx)
757 combine->leftvol += ch->leftvol;
758 combine->rightvol += ch->rightvol;
759 ch->leftvol = ch->rightvol = 0;
763 combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
764 for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
765 if (combine->sfx == ch->sfx)
768 if (j == total_channels)
776 combine->leftvol += ch->leftvol;
777 combine->rightvol += ch->rightvol;
778 ch->leftvol = ch->rightvol = 0;
788 if (snd_show.integer)
792 for (i=0 ; i<total_channels; i++, ch++)
793 if (ch->sfx && (ch->leftvol || ch->rightvol) )
796 Con_Printf ("----(%i)----\n", total);
803 void GetSoundtime(void)
807 static int oldsamplepos;
810 fullsamples = shm->samples / shm->channels;
812 // it is possible to miscount buffers if it has wrapped twice between
813 // calls to S_Update. Oh well.
815 soundtime = SNDDMA_GetSamples();
817 samplepos = SNDDMA_GetDMAPos();
820 if (samplepos < oldsamplepos)
822 buffers++; // buffer wrapped
824 if (paintedtime > 0x40000000)
825 { // time to chop things off to avoid 32 bit limits
827 paintedtime = fullsamples;
828 S_StopAllSounds (true);
831 oldsamplepos = samplepos;
833 soundtime = buffers*fullsamples + samplepos/shm->channels;
837 void IN_Accumulate (void);
839 void S_ExtraUpdate (void)
846 if (snd_noextraupdate.integer)
847 return; // don't pollute timings
856 if (!sound_started || (snd_blocked > 0))
862 // check to make sure that we haven't overshot
863 if (paintedtime < soundtime)
864 paintedtime = soundtime;
866 // mix ahead of current position
867 endtime = soundtime + _snd_mixahead.value * shm->speed;
868 samps = shm->samples >> (shm->channels-1);
869 if (endtime - soundtime > samps)
870 endtime = soundtime + samps;
873 // if the buffer was lost or stopped, restore it and/or restart it
879 if (pDSBuf->lpVtbl->GetStatus (pDSBuf, &dwStatus) != DD_OK)
880 Con_Printf ("Couldn't get sound buffer status\n");
882 if (dwStatus & DSBSTATUS_BUFFERLOST)
883 pDSBuf->lpVtbl->Restore (pDSBuf);
885 if (!(dwStatus & DSBSTATUS_PLAYING))
886 pDSBuf->lpVtbl->Play(pDSBuf, 0, 0, DSBPLAY_LOOPING);
891 S_PaintChannels (endtime);
897 ===============================================================================
901 ===============================================================================
914 if (!strrchr(Cmd_Argv(i), '.'))
916 strcpy(name, Cmd_Argv(i));
917 strcat(name, ".wav");
920 strcpy(name, Cmd_Argv(i));
921 sfx = S_PrecacheSound(name, true);
922 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 1.0);
937 if (!strrchr(Cmd_Argv(i), '.'))
939 strcpy(name, Cmd_Argv(i));
940 strcat(name, ".wav");
943 strcpy(name, Cmd_Argv(i));
944 sfx = S_PrecacheSound(name, true);
945 S_StartSound(hash++, 0, sfx, listener_origin, 1.0, 0.0);
961 if (!strrchr(Cmd_Argv(i), '.'))
963 strcpy(name, Cmd_Argv(i));
964 strcat(name, ".wav");
967 strcpy(name, Cmd_Argv(i));
968 sfx = S_PrecacheSound(name, true);
969 vol = atof(Cmd_Argv(i+1));
970 S_StartSound(hash++, 0, sfx, listener_origin, vol, 1.0);
975 void S_SoundList(void)
983 for (sfx=known_sfx, i=0 ; i<num_sfx ; i++, sfx++)
988 size = sc->length*sc->width*(sc->stereo+1);
990 if (sc->loopstart >= 0)
994 Con_Printf("(%2db) %6i : %s\n",sc->width*8, size, sfx->name);
996 Con_Printf ("Total resident: %i\n", total);
1000 void S_LocalSound (char *sound)
1004 if (nosound.integer)
1009 sfx = S_PrecacheSound (sound, true);
1012 Con_Printf ("S_LocalSound: can't precache %s\n", sound);
1015 S_StartSound (cl.viewentity, -1, sfx, vec3_origin, 1, 1);
1019 void S_ClearPrecache (void)
1024 void S_BeginPrecaching (void)
1029 void S_EndPrecaching (void)
1034 #define RAWSAMPLESBUFFER 32768
1035 short s_rawsamplesbuffer[RAWSAMPLESBUFFER * 2];
1036 int s_rawsamplesbuffer_start;
1037 int s_rawsamplesbuffer_count;
1039 void S_RawSamples_Enqueue(short *samples, unsigned int length)
1042 //Con_Printf("S_RawSamples_Enqueue: %i samples\n", length);
1043 if (s_rawsamplesbuffer_count + length > RAWSAMPLESBUFFER)
1045 b2 = (s_rawsamplesbuffer_start + s_rawsamplesbuffer_count) % RAWSAMPLESBUFFER;
1046 if (b2 + length > RAWSAMPLESBUFFER)
1048 b3 = (b2 + length) % RAWSAMPLESBUFFER;
1049 memcpy(s_rawsamplesbuffer + b2 * 2, samples, (RAWSAMPLESBUFFER - b2) * sizeof(short[2]));
1050 memcpy(s_rawsamplesbuffer, samples + (RAWSAMPLESBUFFER - b2) * 2, b3 * sizeof(short[2]));
1053 memcpy(s_rawsamplesbuffer + b2 * 2, samples, length * sizeof(short[2]));
1054 s_rawsamplesbuffer_count += length;
1057 void S_RawSamples_Dequeue(int *samples, unsigned int length)
1065 if (l > s_rawsamplesbuffer_count)
1066 l = s_rawsamplesbuffer_count;
1067 b1 = (s_rawsamplesbuffer_start) % RAWSAMPLESBUFFER;
1068 if (b1 + l > RAWSAMPLESBUFFER)
1070 b2 = (b1 + l) % RAWSAMPLESBUFFER;
1071 //memcpy(samples, s_rawsamplesbuffer + b1 * 2, (RAWSAMPLESBUFFER - b1) * sizeof(short[2]));
1072 //memcpy(samples + (RAWSAMPLESBUFFER - b1) * 2, s_rawsamplesbuffer, b2 * sizeof(short[2]));
1073 for (out = samples, in = s_rawsamplesbuffer + b1 * 2, count = (RAWSAMPLESBUFFER - b1) * 2, i = 0;i < count;i++)
1075 for (out = samples + (RAWSAMPLESBUFFER - b1) * 2, in = s_rawsamplesbuffer, count = b2 * 2, i = 0;i < count;i++)
1077 //Con_Printf("S_RawSamples_Dequeue: buffer wrap %i %i\n", (RAWSAMPLESBUFFER - b1), b2);
1081 //memcpy(samples, s_rawsamplesbuffer + b1 * 2, l * sizeof(short[2]));
1082 for (out = samples, in = s_rawsamplesbuffer + b1 * 2, count = l * 2, i = 0;i < count;i++)
1084 //Con_Printf("S_RawSamples_Dequeue: normal %i\n", l);
1088 memset(samples + l * 2, 0, (length - l) * sizeof(int[2]));
1089 //Con_Printf("S_RawSamples_Dequeue: padding with %i samples\n", length - l);
1091 s_rawsamplesbuffer_start = (s_rawsamplesbuffer_start + l) % RAWSAMPLESBUFFER;
1092 s_rawsamplesbuffer_count -= l;
1095 void S_RawSamples_ClearQueue(void)
1097 s_rawsamplesbuffer_count = 0;
1098 s_rawsamplesbuffer_start = 0;
1101 int S_RawSamples_QueueWantsMore(void)
1103 if (s_rawsamplesbuffer_count < min(shm->speed >> 1, RAWSAMPLESBUFFER >> 1))
1104 return RAWSAMPLESBUFFER - s_rawsamplesbuffer_count;
1109 void S_ResampleBuffer16Stereo(short *input, int inputlength, short *output, int outputlength)
1111 if (inputlength != outputlength)
1113 int i, position, stopposition, step;
1115 step = (float) inputlength * 256.0f / (float) outputlength;
1117 stopposition = (inputlength - 1) << 8;
1119 for (i = 0;i < outputlength && position < stopposition;i++, position += step)
1121 in = input + ((position >> 8) << 1);
1122 out[0] = (((in[1] - in[0]) * (position & 255)) >> 8) + in[0];
1123 out[1] = (((in[3] - in[2]) * (position & 255)) >> 8) + in[2];
1126 stopposition = inputlength << 8;
1127 for (i = 0;i < outputlength && position < stopposition;i++, position += step)
1129 in = input + ((position >> 8) << 1);
1136 memcpy(output, input, inputlength * sizeof(short[2]));