*/
// sound.h -- client sound i/o functions
-#ifndef __SOUND__
-#define __SOUND__
+#ifndef SOUND_H
+#define SOUND_H
#define DEFAULT_SOUND_PACKET_VOLUME 255
#define DEFAULT_SOUND_PACKET_ATTENUATION 1.0
typedef struct
{
- int left;
- int right;
-} portable_samplepair_t;
+ size_t length;
+ size_t offset;
+ qbyte data[4]; // variable sized
+} sfxbuffer_t;
typedef struct
{
- int length;
- int loopstart;
- int speed;
- int width;
- int stereo;
- qbyte data[1]; // variable sized
-} sfxcache_t;
+ unsigned int speed;
+ unsigned int width;
+ unsigned int channels;
+} snd_format_t;
+// sfx_t flags
+#define SFXFLAG_NONE 0
+#define SFXFLAG_SILENTLYMISSING (1 << 0) // if the sfx is missing and loaded with complain = false
+#define SFXFLAG_USED (1 << 1)
+
+typedef struct snd_fetcher_s snd_fetcher_t;
typedef struct sfx_s
{
- char name[MAX_QPATH];
- mempool_t *mempool;
- sfxcache_t *sfxcache;
- int silentlymissing; // true if missing and loaded with complain = false
+ char name[MAX_QPATH];
+ mempool_t *mempool;
+ unsigned int flags; // cf SFXFLAG_* defines
+ snd_format_t format;
+ int loopstart;
+ size_t total_length;
+ const snd_fetcher_t *fetcher;
+ void *fetcher_data; // Per-sfx data for the sound fetching functions
} sfx_t;
typedef struct
{
- qboolean gamealive;
- qboolean soundalive;
- qboolean splitbuffer;
- int channels;
- int samples; // mono samples in buffer
- int submission_chunk; // don't mix less than this #
- int samplepos; // in mono samples
- int samplebits;
- int speed;
+ snd_format_t format;
+ int samples; // mono samples in buffer
+ int samplepos; // in mono samples
unsigned char *buffer;
+ int bufferlength; // used only by certain drivers
} dma_t;
+// channel_t flags
+#define CHANNELFLAG_NONE 0
+#define CHANNELFLAG_FORCELOOP (1 << 0) // force looping even if the sound is not looped
+#define CHANNELFLAG_LOCALSOUND (1 << 1) // non-game sound (ex: menu sound)
+#define CHANNELFLAG_PAUSED (1 << 2)
+
typedef struct
{
- sfx_t *sfx; // sfx number
- int leftvol; // 0-255 volume
- int rightvol; // 0-255 volume
- int end; // end time in global paintsamples
- int pos; // sample position in sfx
- int looping; // where to loop, -1 = no looping
- int entnum; // to allow overriding a specific sound
- int entchannel; //
- vec3_t origin; // origin of sound effect
- vec_t dist_mult; // distance multiplier (attenuation/clipK)
- int master_vol; // 0-255 master volume
+ sfx_t *sfx; // sfx number
+ unsigned int flags; // cf CHANNELFLAG_* defines
+ int leftvol; // 0-255 volume
+ int rightvol; // 0-255 volume
+ int end; // end time in global paintsamples
+ int lastptime; // last time this channel was painted
+ int pos; // sample position in sfx
+ int looping; // where to loop, -1 = no looping
+ int entnum; // to allow overriding a specific sound
+ int entchannel;
+ vec3_t origin; // origin of sound effect
+ vec_t dist_mult; // distance multiplier (attenuation/clipK)
+ int master_vol; // 0-255 master volume
+ void *fetcher_data; // Per-channel data for the sound fetching function
} channel_t;
-typedef struct
+typedef const sfxbuffer_t* (*snd_fetcher_getsb_t) (channel_t* ch, unsigned int start, unsigned int nbsamples);
+typedef void (*snd_fetcher_end_t) (channel_t* ch);
+struct snd_fetcher_s
{
- int rate;
- int width;
- int channels;
- int loopstart;
- int samples;
- int dataofs; // chunk starts this many bytes from file start
-} wavinfo_t;
+ snd_fetcher_getsb_t getsb;
+ snd_fetcher_end_t end;
+};
void S_Init (void);
void S_Startup (void);
void S_Shutdown (void);
-void S_Open (void);
-void S_Close (void);
-void S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation);
+// S_StartSound returns the channel index, or -1 if an error occurred
+int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol, float attenuation);
void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation);
+void S_StopChannel (unsigned int channel_ind);
+void S_PauseChannel (unsigned int channel_ind, qboolean toggle);
+void S_LoopChannel (unsigned int channel_ind, qboolean toggle);
void S_StopSound (int entnum, int entchannel);
void S_StopAllSounds(qboolean clear);
+void S_PauseGameSounds (void);
+void S_ResumeGameSounds (void);
void S_ClearBuffer (void);
-void S_Update (vec3_t origin, vec3_t v_forward, vec3_t v_right, vec3_t v_up);
+void S_Update(vec3_t origin, vec3_t forward, vec3_t left, vec3_t up);
void S_ExtraUpdate (void);
+sfx_t *S_GetCached(const char *name);
sfx_t *S_PrecacheSound (char *sample, int complain);
void S_TouchSound (char *sample);
-void S_ClearPrecache (void);
-void S_BeginPrecaching (void);
-void S_EndPrecaching (void);
+void S_ClearUsed (void);
+void S_PurgeUnused (void);
void S_PaintChannels(int endtime);
void S_InitPaintChannels (void);
-// picks a channel based on priorities, empty slots, number of channels
-channel_t *SND_PickChannel(int entnum, int entchannel);
-
-// spatializes a channel
-void SND_Spatialize(channel_t *ch, int isstatic);
-
// initializes cycling through a DMA buffer and returns information on it
qboolean SNDDMA_Init(void);
// shutdown the DMA xfer.
void SNDDMA_Shutdown(void);
+extern size_t ResampleSfx (const qbyte *in_data, size_t in_length, const snd_format_t* in_format, qbyte *out_data, const char* sfxname);
+
// ====================================================================
// User-setable variables
// ====================================================================
// MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
// MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
-extern int total_channels;
+extern unsigned int total_channels;
//
// Fake dma is a synchronous faking of the DMA progress used for
extern int fakedma_updates;
extern int paintedtime;
extern int soundtime;
-extern vec3_t listener_origin;
-extern vec3_t listener_forward;
-extern vec3_t listener_right;
-extern vec3_t listener_up;
+extern vec3_t listener_vieworigin;
+extern vec3_t listener_viewforward;
+extern vec3_t listener_viewleft;
+extern vec3_t listener_viewup;
extern volatile dma_t *shm;
extern volatile dma_t sn;
extern vec_t sound_nominal_clip_dist;
extern cvar_t volume;
extern cvar_t snd_swapstereo;
-extern qboolean cdaudioinitialized;
-extern qboolean snd_initialized;
+extern cvar_t cdaudioinitialized;
+extern cvar_t snd_initialized;
+extern cvar_t snd_streaming;
extern int snd_blocked;
void S_LocalSound (char *s);
-sfxcache_t *S_LoadSound (sfx_t *s, int complain);
-
-wavinfo_t GetWavinfo (char *name, qbyte *wav, int wavlength);
+qboolean S_LoadSound (sfx_t *s, int complain);
+void S_UnloadSound(sfx_t *s);
void SND_InitScaletable (void);
void SNDDMA_Submit(void);