The first step towards a real CD volume setting (only the fake CD tracks volume are...
[divverent/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_NONE                    0
44 #define SFXFLAG_SILENTLYMISSING (1 << 0) // if the sfx is missing and loaded with complain = false
45 #define SFXFLAG_USED                    (1 << 1)
46 #define SFXFLAG_STREAMED                (1 << 2) // informative only. You shouldn't need to know that
47
48 typedef struct snd_fetcher_s snd_fetcher_t;
49 typedef struct sfx_s
50 {
51         char                            name[MAX_QPATH];
52         mempool_t                       *mempool;
53         unsigned int            flags;                  // cf SFXFLAG_* defines
54         snd_format_t            format;
55         int                                     loopstart;
56         size_t                          total_length;
57         const snd_fetcher_t     *fetcher;
58         void                            *fetcher_data;  // Per-sfx data for the sound fetching functions
59 } sfx_t;
60
61 typedef struct
62 {
63         snd_format_t    format;
64         int                             samples;                // mono samples in buffer
65         int                             samplepos;              // in mono samples
66         unsigned char   *buffer;
67         int                             bufferlength;   // used only by certain drivers
68 } dma_t;
69
70 // channel_t flags
71 #define CHANNELFLAG_NONE                0
72 #define CHANNELFLAG_FORCELOOP   (1 << 0) // force looping even if the sound is not looped
73 #define CHANNELFLAG_LOCALSOUND  (1 << 1) // non-game sound (ex: menu sound)
74 #define CHANNELFLAG_PAUSED              (1 << 2)
75
76 typedef struct
77 {
78         sfx_t                   *sfx;                   // sfx number
79         unsigned int    flags;                  // cf CHANNELFLAG_* defines
80         int                             leftvol;                // 0-255 volume
81         int                             rightvol;               // 0-255 volume
82         int                             end;                    // end time in global paintsamples
83         int                             lastptime;              // last time this channel was painted
84         int                             pos;                    // sample position in sfx
85         int                             looping;                // where to loop, -1 = no looping
86         int                             entnum;                 // to allow overriding a specific sound
87         int                             entchannel;
88         vec3_t                  origin;                 // origin of sound effect
89         vec_t                   dist_mult;              // distance multiplier (attenuation/clipK)
90         int                             master_vol;             // 0-255 master volume
91         void                    *fetcher_data;  // Per-channel data for the sound fetching function
92 } channel_t;
93
94 typedef const sfxbuffer_t* (*snd_fetcher_getsb_t) (channel_t* ch, unsigned int start, unsigned int nbsamples);
95 typedef void (*snd_fetcher_end_t) (channel_t* ch);
96 struct snd_fetcher_s
97 {
98         snd_fetcher_getsb_t     getsb;
99         snd_fetcher_end_t       end;
100 };
101
102 void S_Init (void);
103 void S_Startup (void);
104 void S_Shutdown (void);
105 // S_StartSound returns the channel index, or -1 if an error occurred
106 int S_StartSound (int entnum, int entchannel, sfx_t *sfx, vec3_t origin, float fvol,  float attenuation);
107 void S_StaticSound (sfx_t *sfx, vec3_t origin, float vol, float attenuation);
108 void S_StopChannel (unsigned int channel_ind);
109 void S_PauseChannel (unsigned int channel_ind, qboolean toggle);
110 void S_LoopChannel (unsigned int channel_ind, qboolean toggle);
111 void S_StopSound (int entnum, int entchannel);
112 void S_StopAllSounds(qboolean clear);
113 void S_PauseGameSounds (void);
114 void S_ResumeGameSounds (void);
115 void S_SetChannelVolume (unsigned int ch_ind, float fvol);
116 void S_ClearBuffer (void);
117 void S_Update(vec3_t origin, vec3_t forward, vec3_t left, vec3_t up);
118 void S_ExtraUpdate (void);
119
120 sfx_t *S_GetCached(const char *name);
121 sfx_t *S_PrecacheSound (char *sample, int complain);
122 void S_TouchSound (char *sample);
123 void S_ClearUsed (void);
124 void S_PurgeUnused (void);
125 void S_PaintChannels(int endtime);
126 void S_InitPaintChannels (void);
127
128 // initializes cycling through a DMA buffer and returns information on it
129 qboolean SNDDMA_Init(void);
130
131 // gets the current DMA position
132 int SNDDMA_GetDMAPos(void);
133
134 // shutdown the DMA xfer.
135 void SNDDMA_Shutdown(void);
136
137 extern size_t ResampleSfx (const qbyte *in_data, size_t in_length, const snd_format_t* in_format, qbyte *out_data, const char* sfxname);
138
139 // ====================================================================
140 // User-setable variables
141 // ====================================================================
142
143 // LordHavoc: increased from 128 to 516 (4 for NUM_AMBIENTS)
144 #define MAX_CHANNELS                    516
145 // LordHavoc: increased maximum sound channels from 8 to 128
146 #define MAX_DYNAMIC_CHANNELS    128
147
148
149 extern channel_t channels[MAX_CHANNELS];
150 // 0 to MAX_DYNAMIC_CHANNELS-1  = normal entity sounds
151 // MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
152 // MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
153
154 extern unsigned int total_channels;
155
156 //
157 // Fake dma is a synchronous faking of the DMA progress used for
158 // isolating performance in the renderer.  The fakedma_updates is
159 // number of times S_Update() is called per second.
160 //
161
162 extern qboolean fakedma;
163 extern int fakedma_updates;
164 extern int paintedtime;
165 extern int soundtime;
166 extern vec3_t listener_vieworigin;
167 extern vec3_t listener_viewforward;
168 extern vec3_t listener_viewleft;
169 extern vec3_t listener_viewup;
170 extern volatile dma_t *shm;
171 extern vec_t sound_nominal_clip_dist;
172
173 extern cvar_t bgmvolume;
174 extern cvar_t volume;
175 extern cvar_t snd_swapstereo;
176
177 extern cvar_t cdaudioinitialized;
178 extern cvar_t snd_initialized;
179 extern cvar_t snd_streaming;
180
181 extern int snd_blocked;
182
183 void S_LocalSound (char *s);
184 qboolean S_LoadSound (sfx_t *s, int complain);
185 void S_UnloadSound(sfx_t *s);
186
187 void SND_InitScaletable (void);
188 void SNDDMA_Submit(void);
189
190 void S_AmbientOff (void);
191 void S_AmbientOn (void);
192
193 void *S_LockBuffer(void);
194 void S_UnlockBuffer(void);
195
196 // add some data to the tail of the rawsamples queue
197 void S_RawSamples_Enqueue(short *samples, unsigned int length);
198 // read and remove some data from the head of the rawsamples queue
199 void S_RawSamples_Dequeue(int *samples, unsigned int length);
200 // empty the rawsamples queue
201 void S_RawSamples_ClearQueue(void);
202 // returns how much more data the queue wants, or 0 if it is already full enough
203 int S_RawSamples_QueueWantsMore(void);
204
205 // resamples one sound buffer into another, while changing the length
206 void S_ResampleBuffer16Stereo(short *input, int inputlength, short *output, int outputlength);
207
208 // returns the rate that the rawsamples system is running at
209 int S_RawSamples_SampleRate(void);
210
211 #endif
212