]> de.git.xonotic.org Git - xonotic/darkplaces.git/blob - sound.h
bf8b5191566883de40dd6c289a5cb2feaf991918
[xonotic/darkplaces.git] / sound.h
1 /*
2 Copyright (C) 1996-1997 Id Software, Inc.
3
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.
8
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.
12
13 See the GNU General Public License for more details.
14
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.
18
19 */
20 // sound.h -- client sound i/o functions
21
22 #ifndef SOUND_H
23 #define SOUND_H
24
25 #define DEFAULT_SOUND_PACKET_VOLUME 255
26 #define DEFAULT_SOUND_PACKET_ATTENUATION 1.0
27
28 typedef struct
29 {
30         size_t  length;
31         size_t  offset;
32         qbyte   data[4];        // variable sized
33 } sfxbuffer_t;
34
35 typedef struct
36 {
37         unsigned int    speed;
38         unsigned int    width;
39         unsigned int    channels;
40 } snd_format_t;
41
42 // sfx_t flags
43 #define SFXFLAG_SILENTLYMISSING (1 << 0) // if the sfx is missing and loaded with complain = false
44 #define SFXFLAG_USED                    (1 << 1)
45
46 typedef struct snd_fetcher_s snd_fetcher_t;
47 typedef struct sfx_s
48 {
49         char                            name[MAX_QPATH];
50         mempool_t                       *mempool;
51         unsigned int            flags;                  // cf SFXFLAG_* defines
52         snd_format_t            format;
53         int                                     loopstart;
54         size_t                          total_length;
55         const snd_fetcher_t     *fetcher;
56         void                            *fetcher_data;  // Per-sfx data for the sound fetching functions
57 } sfx_t;
58
59 typedef struct
60 {
61         snd_format_t    format;
62         int                             samples;                // mono samples in buffer
63         int                             samplepos;              // in mono samples
64         unsigned char   *buffer;
65         int                             bufferlength;   // used only by certain drivers
66 } dma_t;
67
68 typedef struct
69 {
70         sfx_t   *sfx;                   // sfx number
71         int             forceloop;              // force looping even if the sound is not looped
72         int             leftvol;                // 0-255 volume
73         int             rightvol;               // 0-255 volume
74         int             end;                    // end time in global paintsamples
75         int             lastptime;              // last time this channel was painted
76         int             pos;                    // sample position in sfx
77         int             looping;                // where to loop, -1 = no looping
78         int             entnum;                 // to allow overriding a specific sound
79         int             entchannel;
80         vec3_t  origin;                 // origin of sound effect
81         vec_t   dist_mult;              // distance multiplier (attenuation/clipK)
82         int             master_vol;             // 0-255 master volume
83         void    *fetcher_data;  // Per-channel data for the sound fetching function
84 } channel_t;
85
86 typedef const sfxbuffer_t* (*snd_fetcher_getsb_t) (channel_t* ch, unsigned int start, unsigned int nbsamples);
87 typedef void (*snd_fetcher_end_t) (channel_t* ch);
88 struct snd_fetcher_s
89 {
90         snd_fetcher_getsb_t     getsb;
91         snd_fetcher_end_t       end;
92 };
93
94 void S_Init (void);
95 void S_Startup (void);
96 void S_Shutdown (void);
97 void S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol,  float attenuation);
98 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation);
99 void S_StopSound (int entnum, int entchannel);
100 void S_StopAllSounds(qboolean clear);
101 void S_ClearBuffer (void);
102 void S_Update(vec3_t origin, vec3_t forward, vec3_t left, vec3_t up);
103 void S_ExtraUpdate (void);
104
105 sfx_t *S_GetCached(const char *name);
106 sfx_t *S_PrecacheSound (char *sample, int complain);
107 void S_TouchSound (char *sample);
108 void S_ClearUsed (void);
109 void S_PurgeUnused (void);
110 void S_PaintChannels(int endtime);
111 void S_InitPaintChannels (void);
112
113 // initializes cycling through a DMA buffer and returns information on it
114 qboolean SNDDMA_Init(void);
115
116 // gets the current DMA position
117 int SNDDMA_GetDMAPos(void);
118
119 // shutdown the DMA xfer.
120 void SNDDMA_Shutdown(void);
121
122 extern size_t ResampleSfx (const qbyte *in_data, size_t in_length, const snd_format_t* in_format, qbyte *out_data, const char* sfxname);
123
124 // ====================================================================
125 // User-setable variables
126 // ====================================================================
127
128 // LordHavoc: increased from 128 to 516 (4 for NUM_AMBIENTS)
129 #define MAX_CHANNELS                    516
130 // LordHavoc: increased maximum sound channels from 8 to 128
131 #define MAX_DYNAMIC_CHANNELS    128
132
133
134 extern channel_t channels[MAX_CHANNELS];
135 // 0 to MAX_DYNAMIC_CHANNELS-1  = normal entity sounds
136 // MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
137 // MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
138
139 extern unsigned int total_channels;
140
141 //
142 // Fake dma is a synchronous faking of the DMA progress used for
143 // isolating performance in the renderer.  The fakedma_updates is
144 // number of times S_Update() is called per second.
145 //
146
147 extern qboolean fakedma;
148 extern int fakedma_updates;
149 extern int paintedtime;
150 extern int soundtime;
151 extern vec3_t listener_vieworigin;
152 extern vec3_t listener_viewforward;
153 extern vec3_t listener_viewleft;
154 extern vec3_t listener_viewup;
155 extern volatile dma_t *shm;
156 extern volatile dma_t sn;
157 extern vec_t sound_nominal_clip_dist;
158
159 extern cvar_t loadas8bit;
160 extern cvar_t bgmvolume;
161 extern cvar_t volume;
162 extern cvar_t snd_swapstereo;
163
164 extern cvar_t cdaudioinitialized;
165 extern cvar_t snd_initialized;
166 extern cvar_t snd_streaming;
167
168 extern int snd_blocked;
169
170 void S_LocalSound (char *s);
171 qboolean S_LoadSound (sfx_t *s, int complain);
172 void S_UnloadSound(sfx_t *s);
173
174 void SND_InitScaletable (void);
175 void SNDDMA_Submit(void);
176
177 void S_AmbientOff (void);
178 void S_AmbientOn (void);
179
180 void *S_LockBuffer(void);
181 void S_UnlockBuffer(void);
182
183 // add some data to the tail of the rawsamples queue
184 void S_RawSamples_Enqueue(short *samples, unsigned int length);
185 // read and remove some data from the head of the rawsamples queue
186 void S_RawSamples_Dequeue(int *samples, unsigned int length);
187 // empty the rawsamples queue
188 void S_RawSamples_ClearQueue(void);
189 // returns how much more data the queue wants, or 0 if it is already full enough
190 int S_RawSamples_QueueWantsMore(void);
191
192 // resamples one sound buffer into another, while changing the length
193 void S_ResampleBuffer16Stereo(short *input, int inputlength, short *output, int outputlength);
194
195 // returns the rate that the rawsamples system is running at
196 int S_RawSamples_SampleRate(void);
197
198 #endif
199