]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - snd_main.h
build: minor adjustments
[xonotic/darkplaces.git] / snd_main.h
index 771205ae2e1e56854d514b5f163354c9283570e7..1ce9e1693ebf1c5a4ef31d0be142ebce90e61ac6 100644 (file)
@@ -21,8 +21,11 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 #ifndef SND_MAIN_H
 #define SND_MAIN_H
 
-#include "sound.h"
-
+#include <stddef.h>
+#include "qtypes.h"
+#include "qdefs.h"
+struct mempool_s;
+struct sfx_s;
 
 typedef struct snd_format_s
 {
@@ -50,25 +53,21 @@ typedef struct snd_ringbuffer_s
                                                                        // may be smaller than startframe if the "ring" buffer has wrapped
 } snd_ringbuffer_t;
 
-// sfx_t flags
+// struct sfx_s 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_LEVELSOUND             (1 << 1) // the sfx is part of the server or client precache list for this level
 #define SFXFLAG_STREAMED               (1 << 2) // informative only. You shouldn't need to know that
-#define SFXFLAG_PERMANENTLOCK  (1 << 3) // can never be freed (ex: used by the client code)
+#define SFXFLAG_MENUSOUND              (1 << 3) // not freed during level change (menu sounds, music, etc)
 
 typedef struct snd_fetcher_s snd_fetcher_t;
 struct sfx_s
 {
        char                            name[MAX_QPATH];
-       sfx_t                           *next;
-       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.
-                                                                               // A SFX with no lock, no SFXFLAG_PERMANENTLOCK, and not precached after a level change is freed
+       struct sfx_s                            *next;
+       size_t                          memsize;                // total memory used (including struct sfx_s and fetcher data)
 
+       snd_format_t            format;                 // format describing the audio data that fetcher->getsamplesfloat will return
        unsigned int            flags;                  // cf SFXFLAG_* defines
        unsigned int            loopstart;              // in sample frames. equals total_length if not looped
        unsigned int            total_length;   // in sample frames
@@ -84,71 +83,81 @@ struct sfx_s
 
 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
+       // provided sound information
+       struct sfx_s                    *sfx;                   // pointer to sound sample being used
+       float                   basevolume;             // 0-1 master volume
        unsigned int    flags;                  // cf CHANNELFLAG_* defines
-       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;
+       int                             entnum;                 // makes sound follow entity origin (allows replacing interrupting existing sound on same id)
+       int                             entchannel;             // which channel id on the entity
        vec3_t                  origin;                 // origin of sound effect
-       vec_t                   dist_mult;              // distance multiplier (attenuation/clipK)
+       vec_t                   distfade;               // distance multiplier (attenuation/clipK)
        void                    *fetcher_data;  // Per-channel data for the sound fetching function
+       int                             prologic_invert;// whether a sound is played on the surround channels in prologic
+       float                   basespeed;              // playback rate multiplier for pitch variation
+
+       // these are often updated while mixer is running, glitching should be minimized (mismatched channel volumes from spatialization is okay)
+       // spatialized playback speed (speed * doppler ratio)
+       float                   mixspeed;
+       // spatialized volume per speaker (mastervol * distanceattenuation * channelvolume cvars)
+       float                   volume[SND_LISTENERS];
+
+       // updated ONLY by mixer
+       // position in sfx, starts at 0, loops or stops at sfx->total_length
+       double                  position;
 } channel_t;
 
 // 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 *chfetcherdata);
-typedef void (*snd_fetcher_free_t) (void *sfxfetcherdata);
-typedef const snd_format_t* (*snd_fetcher_getfmt_t) (sfx_t* sfx);
+typedef void (*snd_fetcher_getsamplesfloat_t) (channel_t *ch, struct sfx_s *sfx, int firstsampleframe, int numsampleframes, float *outsamplesfloat);
+typedef void (*snd_fetcher_stopchannel_t) (channel_t *ch);
+typedef void (*snd_fetcher_freesfx_t) (struct sfx_s *sfx);
 struct snd_fetcher_s
 {
-       snd_fetcher_getsb_t             getsb;
-       snd_fetcher_endsb_t             endsb;
-       snd_fetcher_free_t              free;
-       snd_fetcher_getfmt_t    getfmt;
+       snd_fetcher_getsamplesfloat_t           getsamplesfloat;
+       snd_fetcher_stopchannel_t               stopchannel;
+       snd_fetcher_freesfx_t           freesfx;
 };
 
 extern unsigned int total_channels;
 extern channel_t channels[MAX_CHANNELS];
 
 extern snd_ringbuffer_t *snd_renderbuffer;
-extern qboolean snd_threaded; // enables use of snd_usethreadedmixing, provided that no sound hacks are in effect (like timedemo)
-extern qboolean snd_usethreadedmixing; // if true, the main thread does not mix sound, soundtime does not advance, and neither does snd_renderbuffer->endframe, instead the audio thread will call S_MixToBuffer as needed
+extern qbool snd_threaded; // enables use of snd_usethreadedmixing, provided that no sound hacks are in effect (like timedemo)
+extern qbool snd_usethreadedmixing; // if true, the main thread does not mix sound, soundtime does not advance, and neither does snd_renderbuffer->endframe, instead the audio thread will call S_MixToBuffer as needed
 
-extern cvar_t _snd_mixahead;
-extern cvar_t snd_swapstereo;
-extern cvar_t snd_streaming;
+extern struct cvar_s snd_waterfx;
+extern struct cvar_s _snd_mixahead;
+extern struct cvar_s snd_swapstereo;
+extern struct cvar_s snd_streaming;
+extern struct cvar_s snd_streaming_length;
 
 #define SND_CHANNELLAYOUT_AUTO         0
 #define SND_CHANNELLAYOUT_STANDARD     1
 #define SND_CHANNELLAYOUT_ALSA         2
-extern cvar_t snd_channellayout;
+extern struct cvar_s snd_channellayout;
 
 extern int snd_blocked;                // counter. When > 0, we stop submitting sound to the audio device
 
-extern mempool_t *snd_mempool;
+extern struct mempool_s *snd_mempool;
 
 // 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 qbool simsound;
+
+
+#define STREAM_BUFFERSIZE 16384 // in sampleframes
 
 
 // ====================================================================
 //         Architecture-independent functions
 // ====================================================================
 
-void S_MixToBuffer(void *stream, unsigned int frames);
-
-qboolean S_LoadSound (sfx_t *sfx, qboolean complain);
+void S_SetUnderwaterIntensity(void);
 
-void S_LockSfx (sfx_t *sfx);
-void S_UnlockSfx (sfx_t *sfx);
+void S_MixToBuffer(void *stream, unsigned int frames);
 
-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);
+qbool S_LoadSound (struct sfx_s *sfx, qbool complain);
 
 // If "buffer" is NULL, the function allocates one buffer of "sampleframes" sample frames itself
 // (if "sampleframes" is 0, the function chooses the size).
@@ -159,9 +168,9 @@ snd_ringbuffer_t *Snd_CreateRingBuffer (const snd_format_t* format, unsigned int
 //         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);
+// Create "snd_renderbuffer", attempting to use the chosen sound format, but accepting if the driver wants to change it (e.g. 7.1 to stereo or lowering the speed)
+// Note: SDL automatically converts all formats, so this only fails if there is no audio
+qbool SndSys_Init (snd_format_t* fmt);
 
 // Stop the sound card, delete "snd_renderbuffer" and free its other resources
 void SndSys_Shutdown (void);
@@ -173,7 +182,7 @@ void SndSys_Submit (void);
 unsigned int SndSys_GetSoundTime (void);
 
 // Get the exclusive lock on "snd_renderbuffer"
-qboolean SndSys_LockRenderBuffer (void);
+qbool SndSys_LockRenderBuffer (void);
 
 // Release the exclusive lock on "snd_renderbuffer"
 void SndSys_UnlockRenderBuffer (void);
@@ -184,10 +193,8 @@ void SndSys_SendKeyEvents(void);
 // exported for capturevideo so ogg can see all channels
 typedef struct portable_samplepair_s
 {
-       int sample[SND_LISTENERS];
+       float sample[SND_LISTENERS];
 } portable_sampleframe_t;
-// LordHavoc: was 512, expanded to 2048
-#define        PAINTBUFFER_SIZE 2048
 
 typedef struct listener_s
 {