#include "sound.h"
-typedef struct
-{
- size_t length;
- size_t offset;
- qbyte data[4]; // variable sized
-} sfxbuffer_t;
-
-typedef struct
+typedef struct snd_format_s
{
unsigned int speed;
- unsigned int width;
- unsigned int channels;
+ unsigned short width;
+ unsigned short channels;
} snd_format_t;
+typedef struct snd_buffer_s
+{
+ snd_format_t format;
+ unsigned int nbframes; // current size, in sample frames
+ unsigned int maxframes; // max size (buffer size), in sample frames
+ unsigned char samples[4]; // variable sized
+} snd_buffer_t;
+
+typedef struct snd_ringbuffer_s
+{
+ snd_format_t format;
+ unsigned char* ring;
+ unsigned int maxframes; // max size (buffer size), in sample frames
+ unsigned int startframe; // index of the first frame in the buffer
+ // if startframe == endframe, the bufffer is empty
+ unsigned int endframe; // index of the first EMPTY frame in the "ring" buffer
+ // may be smaller than startframe if the "ring" buffer has wrapped
+} snd_ringbuffer_t;
+
// sfx_t flags
#define SFXFLAG_NONE 0
#define SFXFLAG_FILEMISSING (1 << 0) // wasn't able to load the associated sound file
#define SFXFLAG_SERVERSOUND (1 << 1) // the sfx is part of the server precache list
#define SFXFLAG_STREAMED (1 << 2) // informative only. You shouldn't need to know that
-#define SFXFLAG_PERMANENT (1 << 3) // the sfx is used by the client code and should not be purged (even if it is also in the server precache list)
+#define SFXFLAG_PERMANENTLOCK (1 << 3) // can never be freed (ex: used by the client code)
typedef struct snd_fetcher_s snd_fetcher_t;
struct sfx_s
{
char name[MAX_QPATH];
sfx_t *next;
- mempool_t *mempool;
- unsigned int locks; // A locked sfx_t must not be freed.
- // Locks are added by S_PrecacheSound and S_ServerSounds.
- // SFX can be freed by S_UnlockSfx or S_ServerSounds.
+ size_t memsize; // total memory used (including sfx_t and fetcher data)
+
+ // One lock is automatically granted while the sfx is
+ // playing (and removed when stopped). Locks can also be
+ int locks; // added by S_PrecacheSound and S_ServerSounds.
+ // A SFX with no lock and no SFXFLAG_PERMANENTLOCK is
+ // freed at level change by S_ServerSounds.
+
unsigned int flags; // cf SFXFLAG_* defines
- snd_format_t format;
- int loopstart;
- size_t total_length;
+ unsigned int loopstart; // in sample frames. equals total_length if not looped
+ unsigned int total_length; // in sample frames
const snd_fetcher_t *fetcher;
void *fetcher_data; // Per-sfx data for the sound fetching functions
};
-typedef struct
-{
- 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;
-
-typedef struct
+// maximum supported speakers constant
+#define SND_LISTENERS 8
+
+typedef struct channel_s
{
+ short listener_volume [SND_LISTENERS]; // 0-255 volume per speaker
+ int master_vol; // 0-255 master volume
sfx_t *sfx; // sfx number
unsigned int flags; // cf CHANNELFLAG_* defines
- int master_vol; // 0-255 master volume
- 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 pos; // sample position in sfx, negative values delay the start of the sound playback
int entnum; // to allow overriding a specific sound
int entchannel;
vec3_t origin; // origin of sound effect
void *fetcher_data; // Per-channel data for the sound fetching function
} channel_t;
-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);
+// Sound fetching functions
+// "start" is both an input and output parameter: it returns the actual start time of the sound buffer
+typedef const snd_buffer_t* (*snd_fetcher_getsb_t) (void *sfxfetcher, void **chfetcherpointer, unsigned int *start, unsigned int nbsampleframes);
+typedef void (*snd_fetcher_endsb_t) (void **chfetcherpointer);
+typedef void (*snd_fetcher_free_t) (sfx_t* sfx);
+typedef const snd_format_t* (*snd_fetcher_getfmt_t) (sfx_t* sfx);
struct snd_fetcher_s
{
snd_fetcher_getsb_t getsb;
- snd_fetcher_end_t end;
+ snd_fetcher_endsb_t endsb;
+ snd_fetcher_free_t free;
+ snd_fetcher_getfmt_t getfmt;
};
-void S_PaintChannels(int endtime);
+// 0 to NUM_AMBIENTS - 1 = water, etc
+// NUM_AMBIENTS to NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS - 1 = normal entity sounds
+// NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS to total_channels = static sounds
+#define MAX_DYNAMIC_CHANNELS 512
+#define MAX_CHANNELS 1028
-// initializes cycling through a DMA buffer and returns information on it
-qboolean SNDDMA_Init(void);
+extern unsigned int total_channels;
+extern channel_t channels[MAX_CHANNELS];
-// gets the current DMA position
-int SNDDMA_GetDMAPos(void);
+extern snd_ringbuffer_t *snd_renderbuffer;
+extern unsigned int soundtime; // WARNING: sound modules must NOT use it
-void SNDDMA_Submit(void);
+extern cvar_t _snd_mixahead;
+extern cvar_t snd_swapstereo;
+extern cvar_t snd_streaming;
+
+#define SND_CHANNELLAYOUT_AUTO 0
+#define SND_CHANNELLAYOUT_STANDARD 1
+#define SND_CHANNELLAYOUT_ALSA 2
+extern cvar_t snd_channellayout;
-// shutdown the DMA xfer.
-void SNDDMA_Shutdown(void);
+extern int snd_blocked; // counter. When > 0, we stop submitting sound to the audio device
-qboolean S_LoadSound (sfx_t *s, qboolean complain);
-void S_UnloadSound(sfx_t *s);
+extern mempool_t *snd_mempool;
-void *S_LockBuffer(void);
-void S_UnlockBuffer(void);
+// If simsound is true, the sound card is not initialized and no sound is submitted to it.
+// More generally, all arch-dependent operations are skipped or emulated.
+// Used for isolating performance in the renderer.
+extern qboolean simsound;
-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
+// Architecture-independent functions
// ====================================================================
-// 0 to NUM_AMBIENTS - 1 = water, etc
-// NUM_AMBIENTS to NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS - 1 = normal entity sounds
-// NUM_AMBIENTS + MAX_DYNAMIC_CHANNELS to total_channels = static sounds
-#define MAX_CHANNELS 516
-#define MAX_DYNAMIC_CHANNELS 128
+void S_PaintChannels (snd_ringbuffer_t* rb, unsigned int starttime, unsigned int endtime);
-extern channel_t channels[MAX_CHANNELS];
+qboolean S_LoadSound (sfx_t *sfx, qboolean complain);
-extern unsigned int total_channels;
+void S_LockSfx (sfx_t *sfx);
+void S_UnlockSfx (sfx_t *sfx);
-extern int paintedtime;
-extern int soundtime;
-extern volatile dma_t *shm;
+snd_buffer_t *Snd_CreateSndBuffer (const unsigned char *samples, unsigned int sampleframes, const snd_format_t* in_format, unsigned int sb_speed);
+qboolean Snd_AppendToSndBuffer (snd_buffer_t* sb, const unsigned char *samples, unsigned int sampleframes, const snd_format_t* format);
-extern cvar_t snd_swapstereo;
-extern cvar_t snd_streaming;
+// If "buffer" is NULL, the function allocates one buffer of "sampleframes" sample frames itself
+// (if "sampleframes" is 0, the function chooses the size).
+snd_ringbuffer_t *Snd_CreateRingBuffer (const snd_format_t* format, unsigned int sampleframes, void* buffer);
+
+
+// ====================================================================
+// Architecture-dependent functions
+// ====================================================================
+
+// Create "snd_renderbuffer" with the proper sound format if the call is successful
+// May return a suggested format if the requested format isn't available
+qboolean SndSys_Init (const snd_format_t* requested, snd_format_t* suggested);
+
+// Stop the sound card, delete "snd_renderbuffer" and free its other resources
+void SndSys_Shutdown (void);
+
+// Submit the contents of "snd_renderbuffer" to the sound card
+void SndSys_Submit (void);
+
+// Returns the number of sample frames consumed since the sound started
+unsigned int SndSys_GetSoundTime (void);
+
+// Get the exclusive lock on "snd_renderbuffer"
+qboolean SndSys_LockRenderBuffer (void);
-extern int snd_blocked;
+// Release the exclusive lock on "snd_renderbuffer"
+void SndSys_UnlockRenderBuffer (void);
#endif
projects / xonotic / darkplaces.git / blobdiff