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_main.c -- main control for any streaming sound output device
31 void S_SoundList(void);
34 void S_ClearBuffer (void);
37 // =======================================================================
38 // Internal sound data & structures
39 // =======================================================================
41 channel_t channels[MAX_CHANNELS];
42 unsigned int total_channels;
45 cvar_t snd_initialized = { CVAR_READONLY, "snd_initialized", "0"};
46 cvar_t snd_streaming = { CVAR_SAVE, "snd_streaming", "1"};
48 volatile dma_t *shm = 0;
51 vec3_t listener_origin;
52 matrix4x4_t listener_matrix;
53 vec_t sound_nominal_clip_dist=1000.0;
54 mempool_t *snd_mempool;
61 // Linked list of known sfx
62 sfx_t *known_sfx = NULL;
64 int sound_started = 0;
66 cvar_t bgmvolume = {CVAR_SAVE, "bgmvolume", "1"};
67 cvar_t volume = {CVAR_SAVE, "volume", "0.7"};
68 cvar_t snd_staticvolume = {CVAR_SAVE, "snd_staticvolume", "1"};
70 cvar_t nosound = {0, "nosound", "0"};
71 cvar_t snd_precache = {0, "snd_precache", "1"};
72 cvar_t bgmbuffer = {0, "bgmbuffer", "4096"};
73 cvar_t ambient_level = {0, "ambient_level", "0.3"};
74 cvar_t ambient_fade = {0, "ambient_fade", "100"};
75 cvar_t snd_noextraupdate = {0, "snd_noextraupdate", "0"};
76 cvar_t snd_show = {0, "snd_show", "0"};
77 cvar_t _snd_mixahead = {CVAR_SAVE, "_snd_mixahead", "0.1"};
78 cvar_t snd_swapstereo = {CVAR_SAVE, "snd_swapstereo", "0"};
81 // ====================================================================
82 // User-setable variables
83 // ====================================================================
87 // Fake dma is a synchronous faking of the DMA progress used for
88 // isolating performance in the renderer.
91 qboolean fakedma = false;
94 void S_SoundInfo_f(void)
96 if (!sound_started || !shm)
98 Con_Print("sound system not started\n");
102 Con_Printf("%5d stereo\n", shm->format.channels - 1);
103 Con_Printf("%5d samples\n", shm->samples);
104 Con_Printf("%5d samplepos\n", shm->samplepos);
105 Con_Printf("%5d samplebits\n", shm->format.width * 8);
106 Con_Printf("%5d speed\n", shm->format.speed);
107 Con_Printf("%p dma buffer\n", shm->buffer);
108 Con_Printf("%5u total_channels\n", total_channels);
114 if (!snd_initialized.integer)
118 memset((void *)shm, 0, sizeof(*shm));
120 // create a piece of DMA memory
123 shm->format.width = 2;
124 shm->format.speed = 22050;
125 shm->format.channels = 2;
126 shm->samples = 32768;
128 shm->buffer = Mem_Alloc(snd_mempool, shm->format.channels * shm->samples * shm->format.width);
134 Con_Print("S_Startup: SNDDMA_Init failed.\n");
143 Con_DPrintf("Sound sampling rate: %i\n", shm->format.speed);
148 void S_Shutdown(void)
154 Mem_Free(shm->buffer);
162 void S_Restart_f(void)
175 Con_DPrint("\nSound Initialization\n");
177 Cvar_RegisterVariable(&volume);
178 Cvar_RegisterVariable(&bgmvolume);
179 Cvar_RegisterVariable(&snd_staticvolume);
181 // COMMANDLINEOPTION: Sound: -nosound disables sound (including CD audio)
182 if (COM_CheckParm("-nosound") || COM_CheckParm("-safe"))
185 snd_mempool = Mem_AllocPool("sound", 0, NULL);
187 // COMMANDLINEOPTION: Sound: -simsound runs sound mixing but with no output
188 if (COM_CheckParm("-simsound"))
191 Cmd_AddCommand("play", S_Play);
192 Cmd_AddCommand("play2", S_Play2);
193 Cmd_AddCommand("playvol", S_PlayVol);
194 Cmd_AddCommand("stopsound", S_StopAllSounds);
195 Cmd_AddCommand("soundlist", S_SoundList);
196 Cmd_AddCommand("soundinfo", S_SoundInfo_f);
197 Cmd_AddCommand("snd_restart", S_Restart_f);
199 Cvar_RegisterVariable(&nosound);
200 Cvar_RegisterVariable(&snd_precache);
201 Cvar_RegisterVariable(&snd_initialized);
202 Cvar_RegisterVariable(&snd_streaming);
203 Cvar_RegisterVariable(&bgmbuffer);
204 Cvar_RegisterVariable(&ambient_level);
205 Cvar_RegisterVariable(&ambient_fade);
206 Cvar_RegisterVariable(&snd_noextraupdate);
207 Cvar_RegisterVariable(&snd_show);
208 Cvar_RegisterVariable(&_snd_mixahead);
209 Cvar_RegisterVariable(&snd_swapstereo); // for people with backwards sound wiring
211 Cvar_SetValueQuick(&snd_initialized, true);
215 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
216 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
222 // =======================================================================
224 // =======================================================================
232 sfx_t *S_FindName (const char *name, qboolean stdpath)
236 char namebuffer [MAX_QPATH];
238 if (!snd_initialized.integer)
241 // Add the default sound directory to the path
242 len = snprintf (namebuffer, sizeof (namebuffer), stdpath ? "sound/%s" : "%s", name);
243 if (len >= sizeof (namebuffer))
244 Host_Error ("S_FindName: sound name too long (%s)", name);
246 // Look for this sound in the list of known sfx
247 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
248 if(!strcmp (sfx->name, namebuffer))
251 // Add a sfx_t struct for this sound
252 sfx = Mem_Alloc (snd_mempool, sizeof (*sfx));
253 memset (sfx, 0, sizeof(*sfx));
254 strlcpy (sfx->name, namebuffer, sizeof (sfx->name));
255 sfx->next = known_sfx;
268 void S_FreeSfx (sfx_t *sfx)
270 // Never free a locked sfx
274 Con_DPrintf ("S_FreeSfx: freeing %s\n", sfx->name);
276 // Remove it from the list of known sfx
277 if (sfx == known_sfx)
278 known_sfx = known_sfx->next;
283 for (prev_sfx = known_sfx; prev_sfx != NULL; prev_sfx = prev_sfx->next)
284 if (prev_sfx->next == sfx)
286 prev_sfx->next = sfx->next;
289 if (prev_sfx == NULL)
290 Sys_Error ("S_FreeSfx: Can't find SFX %s in the list!\n", sfx->name);
294 Mem_FreePool (&sfx->mempool);
305 void S_ServerSounds (char serversound [][MAX_QPATH], unsigned int numsounds)
310 // Start the ambient sounds and make them loop
311 channels[AMBIENT_WATER].sfx = S_PrecacheSound ("ambience/water1.wav", false, true, true);
312 channels[AMBIENT_SKY].sfx = S_PrecacheSound ("ambience/wind2.wav", false, true, true);
313 for (i = 0; i < NUM_AMBIENTS; i++)
314 channels[i].flags |= CHANNELFLAG_FORCELOOP;
316 // Remove 1 lock from all sfx with the SFXFLAG_SERVERSOUND flag, and remove the flag
317 for (sfx = known_sfx; sfx != NULL; sfx = sfx->next)
318 if (sfx->flags & SFXFLAG_SERVERSOUND)
321 sfx->flags &= ~SFXFLAG_SERVERSOUND;
324 // Add 1 lock and the SFXFLAG_SERVERSOUND flag to each sfx in "serversound"
325 for (i = 1; i < numsounds; i++)
327 sfx = S_FindName (serversound[i], true);
331 sfx->flags |= SFXFLAG_SERVERSOUND;
335 // Free all unlocked sfx
341 // We may lose the "next" pointer after S_FreeSfx
356 sfx_t *S_PrecacheSound (const char *name, qboolean complain, qboolean stdpath, qboolean lock)
360 if (!snd_initialized.integer)
363 sfx = S_FindName (name, stdpath);
370 if (!nosound.integer && snd_precache.integer)
371 S_LoadSound(sfx, complain);
380 Remove a lock from a SFX and freed it if possible
383 void S_UnlockSfx (sfx_t *sfx)
390 //=============================================================================
396 Picks a channel based on priorities, empty slots, number of channels
399 channel_t *SND_PickChannel(int entnum, int entchannel)
406 // Check for replacement sound, or find the best one to replace
408 life_left = 0x7fffffff;
409 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++)
411 ch = &channels[ch_idx];
412 if (entchannel != 0 // channel 0 never overrides
413 && ch->entnum == entnum
414 && (ch->entchannel == entchannel || entchannel == -1) )
415 { // always override sound from same entity
416 first_to_die = ch_idx;
420 // don't let monster sounds override player sounds
421 if (ch->entnum == cl.viewentity && entnum != cl.viewentity && ch->sfx)
424 // don't override looped sounds
425 if ((ch->flags & CHANNELFLAG_FORCELOOP) != 0 ||
426 (ch->sfx != NULL && ch->sfx->loopstart >= 0))
429 if (ch->end - paintedtime < life_left)
431 life_left = ch->end - paintedtime;
432 first_to_die = ch_idx;
436 if (first_to_die == -1)
439 S_StopChannel (first_to_die);
441 return &channels[first_to_die];
448 Spatializes a channel
451 void SND_Spatialize(channel_t *ch, qboolean isstatic)
453 vec_t dist, scale, pan;
456 // anything coming from the view entity will always be full volume
457 // LordHavoc: make sounds with ATTN_NONE have no spatialization
458 if (ch->entnum == cl.viewentity || ch->dist_mult == 0)
460 ch->leftvol = ch->master_vol;
461 ch->rightvol = ch->master_vol;
465 // update sound origin if we know about the entity
466 if (ch->entnum > 0 && cls.state == ca_connected && cl_entities[ch->entnum].state_current.active)
468 //Con_Printf("-- entnum %i origin %f %f %f neworigin %f %f %f\n", ch->entnum, ch->origin[0], ch->origin[1], ch->origin[2], cl_entities[ch->entnum].state_current.origin[0], cl_entities[ch->entnum].state_current.origin[1], cl_entities[ch->entnum].state_current.origin[2]);
469 VectorCopy(cl_entities[ch->entnum].state_current.origin, ch->origin);
470 if (cl_entities[ch->entnum].state_current.modelindex && cl.model_precache[cl_entities[ch->entnum].state_current.modelindex]->soundfromcenter)
471 VectorMAMAM(1.0f, ch->origin, 0.5f, cl.model_precache[cl_entities[ch->entnum].state_current.modelindex]->normalmins, 0.5f, cl.model_precache[cl_entities[ch->entnum].state_current.modelindex]->normalmaxs, ch->origin);
474 // calculate stereo seperation and distance attenuation
475 Matrix4x4_Transform(&listener_matrix, ch->origin, source_vec);
476 dist = VectorNormalizeLength(source_vec);
478 scale = ch->master_vol * (1.0 - (dist * ch->dist_mult));
480 pan = scale * source_vec[1];
481 // calculate the volumes
482 ch->leftvol = (int) (scale + pan);
483 ch->rightvol = (int) (scale - pan);
486 // Adjust volume of static sounds
489 ch->leftvol *= snd_staticvolume.value;
490 ch->rightvol *= snd_staticvolume.value;
494 ch->leftvol = bound(0, ch->leftvol, 255);
495 ch->rightvol = bound(0, ch->rightvol, 255);
499 // =======================================================================
500 // Start a sound effect
501 // =======================================================================
503 void S_PlaySfxOnChannel (sfx_t *sfx, channel_t *target_chan, unsigned int flags, vec3_t origin, float fvol, float attenuation, qboolean isstatic)
505 // Initialize the channel
506 memset (target_chan, 0, sizeof (*target_chan));
507 VectorCopy (origin, target_chan->origin);
508 target_chan->master_vol = fvol * 255;
509 target_chan->sfx = sfx;
510 target_chan->end = paintedtime + sfx->total_length;
511 target_chan->lastptime = paintedtime;
512 target_chan->flags = flags;
514 // If it's a static sound
517 if (sfx->loopstart == -1)
518 Con_DPrintf("Quake compatibility warning: Static sound \"%s\" is not looped\n", sfx->name);
519 target_chan->dist_mult = attenuation / (64.0f * sound_nominal_clip_dist);
522 target_chan->dist_mult = attenuation / sound_nominal_clip_dist;
524 // Lock the SFX during play
529 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
531 channel_t *target_chan, *check;
535 if (!sound_started || !sfx || !sfx->fetcher || nosound.integer)
538 // Pick a channel to play on
539 target_chan = SND_PickChannel(entnum, entchannel);
543 if (!S_LoadSound (sfx, true))
544 return -1; // couldn't load the sound's data
546 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_NONE, origin, fvol, attenuation, false);
547 target_chan->entnum = entnum;
548 target_chan->entchannel = entchannel;
550 SND_Spatialize(target_chan, false);
552 // if an identical sound has also been started this frame, offset the pos
553 // a bit to keep it from just making the first one louder
554 check = &channels[NUM_AMBIENTS];
555 for (ch_idx=NUM_AMBIENTS ; ch_idx < NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS ; ch_idx++, check++)
557 if (check == target_chan)
559 if (check->sfx == sfx && !check->pos)
561 skip = 0.1 * sfx->format.speed;
562 if (skip > sfx->total_length)
563 skip = sfx->total_length;
565 skip = rand() % skip;
566 target_chan->pos += skip;
567 target_chan->end -= skip;
572 return (target_chan - channels);
575 void S_StopChannel (unsigned int channel_ind)
579 if (channel_ind >= total_channels)
582 ch = &channels[channel_ind];
585 sfx_t *sfx = ch->sfx;
587 if (sfx->fetcher != NULL)
589 snd_fetcher_end_t fetcher_end = sfx->fetcher->end;
590 if (fetcher_end != NULL)
594 // Remove the lock it holds
603 qboolean S_SetChannelFlag (unsigned int ch_ind, unsigned int flag, qboolean value)
605 if (ch_ind >= total_channels)
608 if (flag != CHANNELFLAG_FORCELOOP &&
609 flag != CHANNELFLAG_PAUSED &&
610 flag != CHANNELFLAG_FULLVOLUME)
614 channels[ch_ind].flags |= flag;
616 channels[ch_ind].flags &= ~flag;
621 void S_StopSound(int entnum, int entchannel)
625 for (i = 0; i < MAX_DYNAMIC_CHANNELS; i++)
626 if (channels[i].entnum == entnum && channels[i].entchannel == entchannel)
633 void S_StopAllSounds (void)
637 for (i = 0; i < total_channels; i++)
640 total_channels = MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS; // no statics
641 memset(channels, 0, MAX_CHANNELS * sizeof(channel_t));
646 void S_PauseGameSounds (qboolean toggle)
650 for (i = 0; i < total_channels; i++)
655 if (ch->sfx != NULL && ! (ch->flags & CHANNELFLAG_LOCALSOUND))
656 S_SetChannelFlag (i, CHANNELFLAG_PAUSED, toggle);
660 void S_SetChannelVolume (unsigned int ch_ind, float fvol)
662 channels[ch_ind].master_vol = fvol * 255;
666 void S_ClearBuffer(void)
671 if (!sound_started || !shm)
674 if (shm->format.width == 1)
675 clear = 0x80; // 8 bit sound (unsigned)
677 clear = 0; // 16 bit sound (signed)
679 pbuf = S_LockBuffer();
682 int setsize = shm->samples * shm->format.width;
687 // on i586/i686 optimized versions of glibc, glibc *wrongly* IMO,
688 // reads the memory area before writing to it causing a seg fault
689 // since the memory is PROT_WRITE only and not PROT_READ|PROT_WRITE
690 //memset(shm->buffer, clear, shm->samples * shm->format.width);
702 void S_StaticSound (sfx_t *sfx, vec3_t origin, float fvol, float attenuation)
704 channel_t *target_chan;
709 if (total_channels == MAX_CHANNELS)
711 Con_Print("total_channels == MAX_CHANNELS\n");
715 if (!S_LoadSound (sfx, true))
718 target_chan = &channels[total_channels++];
719 S_PlaySfxOnChannel (sfx, target_chan, CHANNELFLAG_FORCELOOP, origin, fvol, attenuation, true);
721 SND_Spatialize (target_chan, true);
725 //=============================================================================
729 S_UpdateAmbientSounds
733 void S_UpdateAmbientSounds (void)
738 qbyte ambientlevels[NUM_AMBIENTS];
740 // Mute ambient sounds until proven otherwise
741 for (ambient_channel = 0 ; ambient_channel < NUM_AMBIENTS;ambient_channel++)
742 channels[ambient_channel].master_vol = 0;
744 if (ambient_level.value <= 0 || !cl.worldmodel || !cl.worldmodel->brush.AmbientSoundLevelsForPoint)
747 cl.worldmodel->brush.AmbientSoundLevelsForPoint(cl.worldmodel, listener_origin, ambientlevels, sizeof(ambientlevels));
749 // Calc ambient sound levels
750 for (ambient_channel = 0 ; ambient_channel< NUM_AMBIENTS ; ambient_channel++)
752 chan = &channels[ambient_channel];
753 if (chan->sfx == NULL || (chan->sfx->flags & SFXFLAG_FILEMISSING))
756 vol = ambient_level.value * ambientlevels[ambient_channel];
760 // Don't adjust volume too fast
761 if (chan->master_vol < vol)
763 chan->master_vol += host_realframetime * ambient_fade.value;
764 if (chan->master_vol > vol)
765 chan->master_vol = vol;
767 else if (chan->master_vol > vol)
769 chan->master_vol -= host_realframetime * ambient_fade.value;
770 if (chan->master_vol < vol)
771 chan->master_vol = vol;
774 chan->leftvol = chan->rightvol = chan->master_vol;
783 Called once each time through the main loop
786 void S_Update(const matrix4x4_t *listenermatrix)
788 unsigned int i, j, total;
789 channel_t *ch, *combine;
791 if (!snd_initialized.integer || (snd_blocked > 0))
794 Matrix4x4_Invert_Simple(&listener_matrix, listenermatrix);
795 Matrix4x4_OriginFromMatrix(listenermatrix, listener_origin);
797 // update general area ambient sound sources
798 S_UpdateAmbientSounds ();
802 // update spatialization for static and dynamic sounds
803 ch = channels+NUM_AMBIENTS;
804 for (i=NUM_AMBIENTS ; i<total_channels; i++, ch++)
808 SND_Spatialize(ch, i >= MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS); // respatialize channel
809 if (!ch->leftvol && !ch->rightvol)
812 // try to combine static sounds with a previous channel of the same
813 // sound effect so we don't mix five torches every frame
815 if (i > MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS)
817 // see if it can just use the last one
818 if (combine && combine->sfx == ch->sfx)
820 combine->leftvol += ch->leftvol;
821 combine->rightvol += ch->rightvol;
822 ch->leftvol = ch->rightvol = 0;
826 combine = channels+MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS;
827 for (j=MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS ; j<i; j++, combine++)
828 if (combine->sfx == ch->sfx)
831 if (j == total_channels)
837 combine->leftvol += ch->leftvol;
838 combine->rightvol += ch->rightvol;
839 ch->leftvol = ch->rightvol = 0;
849 if (snd_show.integer)
853 for (i=0 ; i<total_channels; i++, ch++)
854 if (ch->sfx && (ch->leftvol || ch->rightvol) )
857 Con_Printf("----(%u)----\n", total);
864 void GetSoundtime(void)
868 static int oldsamplepos;
871 fullsamples = shm->samples / shm->format.channels;
873 // it is possible to miscount buffers if it has wrapped twice between
874 // calls to S_Update. Oh well.
875 samplepos = SNDDMA_GetDMAPos();
877 if (samplepos < oldsamplepos)
879 buffers++; // buffer wrapped
881 if (paintedtime > 0x40000000)
882 { // time to chop things off to avoid 32 bit limits
884 paintedtime = fullsamples;
888 oldsamplepos = samplepos;
890 soundtime = buffers * fullsamples + samplepos / shm->format.channels;
893 void S_ExtraUpdate (void)
895 if (snd_noextraupdate.integer)
896 return; // don't pollute timings
905 if (!sound_started || (snd_blocked > 0))
911 // check to make sure that we haven't overshot
912 if (paintedtime < soundtime)
913 paintedtime = soundtime;
915 // mix ahead of current position
916 endtime = soundtime + _snd_mixahead.value * shm->format.speed;
917 samps = shm->samples >> (shm->format.channels - 1);
918 if (endtime > (unsigned int)(soundtime + samps))
919 endtime = soundtime + samps;
921 S_PaintChannels (endtime);
927 ===============================================================================
931 ===============================================================================
934 static void S_Play_Common(float fvol, float attenuation)
943 if (!strrchr(Cmd_Argv(i), '.'))
944 snprintf(name, sizeof(name), "%s.wav", Cmd_Argv(i));
946 strlcpy(name, Cmd_Argv(i), sizeof(name));
947 sfx = S_PrecacheSound(name, true, true, false);
949 // If we need to get the volume from the command line
952 fvol = atof(Cmd_Argv(i+1));
958 ch_ind = S_StartSound(-1, 0, sfx, listener_origin, fvol, attenuation);
960 // Free the sfx if the file didn't exist
964 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;
970 S_Play_Common (1.0f, 1.0f);
975 S_Play_Common (1.0f, 0.0f);
980 S_Play_Common (-1.0f, 0.0f);
983 void S_SoundList(void)
990 for (sfx = known_sfx, i = 0; sfx != NULL; sfx = sfx->next, i++)
992 if (sfx->fetcher != NULL)
994 size = sfx->mempool->totalsize;
996 Con_Printf ("%c%c(%2db, %6s) %8i : %s\n",
997 (sfx->loopstart >= 0) ? 'L' : ' ',
998 (sfx->flags & SFXFLAG_STREAMED) ? 'S' : ' ',
999 sfx->format.width * 8,
1000 (sfx->format.channels == 1) ? "mono" : "stereo",
1005 Con_Printf("Total resident: %i\n", total);
1009 qboolean S_LocalSound (const char *sound, qboolean stdpath)
1014 if (!snd_initialized.integer || nosound.integer)
1017 sfx = S_PrecacheSound (sound, true, stdpath, false);
1020 Con_Printf("S_LocalSound: can't precache %s\n", sound);
1024 ch_ind = S_StartSound (cl.viewentity, 0, sfx, vec3_origin, 1, 1);
1028 channels[ch_ind].flags |= CHANNELFLAG_LOCALSOUND;