sounds now follow their owner (so riding a lift doesn't leave the sound at the start...
[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__
23 #define __SOUND__
24
25 #define DEFAULT_SOUND_PACKET_VOLUME 255
26 #define DEFAULT_SOUND_PACKET_ATTENUATION 1.0
27
28 typedef struct
29 {
30         int left;
31         int right;
32 } portable_samplepair_t;
33
34 typedef struct
35 {
36         int     length;
37         int     loopstart;
38         int     speed;
39         int     width;
40         int     stereo;
41         qbyte   data[1];                // variable sized
42 } sfxcache_t;
43
44 typedef struct sfx_s
45 {
46         char    name[MAX_QPATH];
47         mempool_t       *mempool;
48         sfxcache_t      *sfxcache;
49         int silentlymissing; // true if missing and loaded with complain = false
50 } sfx_t;
51
52 typedef struct
53 {
54         qboolean                gamealive;
55         qboolean                soundalive;
56         qboolean                splitbuffer;
57         int                             channels;
58         int                             samples;                                // mono samples in buffer
59         int                             submission_chunk;               // don't mix less than this #
60         int                             samplepos;                              // in mono samples
61         int                             samplebits;
62         int                             speed;
63         unsigned char   *buffer;
64 } dma_t;
65
66 typedef struct
67 {
68         sfx_t   *sfx;                   // sfx number
69         int             forceloop;              // force looping even if the sound is not looped
70         int             leftvol;                // 0-255 volume
71         int             rightvol;               // 0-255 volume
72         int             end;                    // end time in global paintsamples
73         int     pos;                    // sample position in sfx
74         int             looping;                // where to loop, -1 = no looping
75         int             entnum;                 // to allow overriding a specific sound
76         int             entchannel;             //
77         vec3_t  origin;                 // origin of sound effect
78         vec_t   dist_mult;              // distance multiplier (attenuation/clipK)
79         int             master_vol;             // 0-255 master volume
80 } channel_t;
81
82 typedef struct
83 {
84         int             rate;
85         int             width;
86         int             channels;
87         int             loopstart;
88         int             samples;
89         int             dataofs;                // chunk starts this many bytes from file start
90 } wavinfo_t;
91
92 void S_Init (void);
93 void S_Startup (void);
94 void S_Shutdown (void);
95 void S_Open (void);
96 void S_Close (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 v_forward, vec3_t v_right, vec3_t v_up);
103 void S_ExtraUpdate (void);
104
105 sfx_t *S_PrecacheSound (char *sample, int complain);
106 void S_TouchSound (char *sample);
107 void S_ClearPrecache (void);
108 void S_BeginPrecaching (void);
109 void S_EndPrecaching (void);
110 void S_PaintChannels(int endtime);
111 void S_InitPaintChannels (void);
112
113 // picks a channel based on priorities, empty slots, number of channels
114 channel_t *SND_PickChannel(int entnum, int entchannel);
115
116 // spatializes a channel
117 void SND_Spatialize(channel_t *ch, int isstatic);
118
119 // initializes cycling through a DMA buffer and returns information on it
120 qboolean SNDDMA_Init(void);
121
122 // gets the current DMA position
123 int SNDDMA_GetDMAPos(void);
124
125 // shutdown the DMA xfer.
126 void SNDDMA_Shutdown(void);
127
128 // ====================================================================
129 // User-setable variables
130 // ====================================================================
131
132 // LordHavoc: increased from 128 to 516 (4 for NUM_AMBIENTS)
133 #define MAX_CHANNELS                    516
134 // LordHavoc: increased maximum sound channels from 8 to 128
135 #define MAX_DYNAMIC_CHANNELS    128
136
137
138 extern channel_t channels[MAX_CHANNELS];
139 // 0 to MAX_DYNAMIC_CHANNELS-1  = normal entity sounds
140 // MAX_DYNAMIC_CHANNELS to MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS -1 = water, etc
141 // MAX_DYNAMIC_CHANNELS + NUM_AMBIENTS to total_channels = static sounds
142
143 extern int total_channels;
144
145 //
146 // Fake dma is a synchronous faking of the DMA progress used for
147 // isolating performance in the renderer.  The fakedma_updates is
148 // number of times S_Update() is called per second.
149 //
150
151 extern qboolean fakedma;
152 extern int fakedma_updates;
153 extern int paintedtime;
154 extern int soundtime;
155 extern vec3_t listener_origin;
156 extern vec3_t listener_forward;
157 extern vec3_t listener_right;
158 extern vec3_t listener_up;
159 extern volatile dma_t *shm;
160 extern volatile dma_t sn;
161 extern vec_t sound_nominal_clip_dist;
162
163 extern cvar_t loadas8bit;
164 extern cvar_t bgmvolume;
165 extern cvar_t volume;
166 extern cvar_t snd_swapstereo;
167
168 extern qboolean cdaudioinitialized;
169 extern qboolean snd_initialized;
170
171 extern int snd_blocked;
172
173 void S_LocalSound (char *s);
174 sfxcache_t *S_LoadSound (sfx_t *s, int complain);
175
176 wavinfo_t GetWavinfo (char *name, qbyte *wav, int wavlength);
177
178 void SND_InitScaletable (void);
179 void SNDDMA_Submit(void);
180
181 void S_AmbientOff (void);
182 void S_AmbientOn (void);
183
184 void *S_LockBuffer(void);
185 void S_UnlockBuffer(void);
186
187 // add some data to the tail of the rawsamples queue
188 void S_RawSamples_Enqueue(short *samples, unsigned int length);
189 // read and remove some data from the head of the rawsamples queue
190 void S_RawSamples_Dequeue(int *samples, unsigned int length);
191 // empty the rawsamples queue
192 void S_RawSamples_ClearQueue(void);
193 // returns how much more data the queue wants, or 0 if it is already full enough
194 int S_RawSamples_QueueWantsMore(void);
195
196 // resamples one sound buffer into another, while changing the length
197 void S_ResampleBuffer16Stereo(short *input, int inputlength, short *output, int outputlength);
198
199 // returns the rate that the rawsamples system is running at
200 int S_RawSamples_SampleRate(void);
201
202 #endif
203