Fix setinfo.
[xonotic/darkplaces.git] / snd_main.h
index 82c3472..527ce49 100644 (file)
@@ -53,9 +53,9 @@ typedef struct snd_ringbuffer_s
 // 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_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
@@ -64,17 +64,15 @@ struct sfx_s
        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 and S_ServerSounds.
-                                                                               // A SFX with no lock and no SFXFLAG_PERMANENTLOCK is
-                                                                               // freed at level change by S_ServerSounds.
-
+       snd_format_t            format;                 // format describing the audio data that fetcher->getsamplesfloat will return
        unsigned int            flags;                  // cf SFXFLAG_* defines
-       int                                     loopstart;              // in sample frames. -1 if not looped
+       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
+
+       float                           volume_mult;    // for replay gain (multiplier to apply)
+       float                           volume_peak;    // for replay gain (highest peak); if set to 0, ReplayGain isn't supported
 };
 
 // maximum supported speakers constant
@@ -82,49 +80,57 @@ 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
+       sfx_t                   *sfx;                   // pointer to sound sample being used
+       float                   basevolume;             // 0-1 master volume
        unsigned int    flags;                  // cf CHANNELFLAG_* defines
-       unsigned int    end;                    // end time in global paintsamples
-       unsigned int    lastptime;              // last time this channel was painted
-       unsigned int    pos;                    // sample position in sfx
-       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) (channel_t* ch, unsigned int *start, unsigned int nbsampleframes);
-typedef void (*snd_fetcher_endsb_t) (channel_t* ch);
-typedef void (*snd_fetcher_free_t) (sfx_t* sfx);
-typedef const snd_format_t* (*snd_fetcher_getfmt_t) (sfx_t* sfx);
+typedef void (*snd_fetcher_getsamplesfloat_t) (channel_t *ch, sfx_t *sfx, int firstsampleframe, int numsampleframes, float *outsamplesfloat);
+typedef void (*snd_fetcher_stopchannel_t) (channel_t *ch);
+typedef void (*snd_fetcher_freesfx_t) (sfx_t *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;
 };
 
-// 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    128
-#define        MAX_CHANNELS                    516
-
 extern unsigned int total_channels;
 extern channel_t channels[MAX_CHANNELS];
 
 extern snd_ringbuffer_t *snd_renderbuffer;
-extern unsigned int soundtime; // WARNING: sound modules must NOT use it
+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 cvar_t _snd_mixahead;
 extern cvar_t snd_swapstereo;
 extern cvar_t snd_streaming;
+extern cvar_t snd_streaming_length;
+
+#define SND_CHANNELLAYOUT_AUTO         0
+#define SND_CHANNELLAYOUT_STANDARD     1
+#define SND_CHANNELLAYOUT_ALSA         2
+extern cvar_t snd_channellayout;
 
 extern int snd_blocked;                // counter. When > 0, we stop submitting sound to the audio device
 
@@ -135,20 +141,18 @@ extern mempool_t *snd_mempool;
 // Used for isolating performance in the renderer.
 extern qboolean simsound;
 
-extern qboolean alsaspeakerlayout;
+
+#define STREAM_BUFFERSIZE 16384 // in sampleframes
 
 
 // ====================================================================
 //         Architecture-independent functions
 // ====================================================================
 
-void S_PaintChannels (snd_ringbuffer_t* rb, unsigned int starttime, unsigned int endtime);
+void S_MixToBuffer(void *stream, unsigned int frames);
 
 qboolean S_LoadSound (sfx_t *sfx, qboolean complain);
 
-void S_LockSfx (sfx_t *sfx);
-void S_UnlockSfx (sfx_t *sfx);
-
 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);
 
@@ -180,5 +184,30 @@ qboolean SndSys_LockRenderBuffer (void);
 // Release the exclusive lock on "snd_renderbuffer"
 void SndSys_UnlockRenderBuffer (void);
 
+// if the sound system can generate events, send them
+void SndSys_SendKeyEvents(void);
+
+// exported for capturevideo so ogg can see all channels
+typedef struct portable_samplepair_s
+{
+       float sample[SND_LISTENERS];
+} portable_sampleframe_t;
+
+typedef struct listener_s
+{
+       int channel_unswapped; // for un-swapping
+       float yawangle;
+       float dotscale;
+       float dotbias;
+       float ambientvolume;
+}
+listener_t;
+typedef struct speakerlayout_s
+{
+       const char *name;
+       unsigned int channels;
+       listener_t listeners[SND_LISTENERS];
+}
+speakerlayout_t;
 
 #endif