2 * Copyright (C) Volition, Inc. 1999. All rights reserved.
4 * All source code herein is the property of Volition, Inc. You may not sell
5 * or otherwise commercially exploit the source or things you created based on
10 * $Logfile: /Freespace2/code/Sound/ds.h $
15 * Header file for interface to DirectSound
18 * Revision 1.3 2002/06/09 04:41:12 relnev
19 * added copyright header
21 * Revision 1.2 2002/05/27 01:06:01 theoddone33
24 * Revision 1.1.1.1 2002/05/03 03:28:12 root
28 * 5 8/27/99 6:38p Alanl
29 * crush the blasted repeating messages bug
31 * 4 8/01/99 2:06p Alanl
32 * increase the rolloff for A3D
34 * 3 5/23/99 8:11p Alanl
35 * Added support for EAX
37 * 2 10/07/98 10:54a Dave
40 * 1 10/07/98 10:51a Dave
42 * 21 5/05/98 4:49p Lawrance
43 * Put in code to authenticate A3D, improve A3D support
45 * 20 4/20/98 12:03a Lawrance
46 * Allow prioritizing of CTRL3D buffers
48 * 19 4/18/98 9:12p Lawrance
49 * Added Aureal support.
51 * 18 4/13/98 5:04p Lawrance
52 * Write functions to determine how many milliseconds are left in a sound
54 * 17 3/23/98 10:32a Lawrance
55 * Add functions for extracting raw sound data
57 * 16 2/15/98 11:10p Lawrance
58 * more work on real-time voice system
60 * 15 2/15/98 4:43p Lawrance
61 * work on real-time voice
63 * 14 2/06/98 7:30p John
64 * Added code to monitor the number of channels of sound actually playing.
66 * 13 2/06/98 8:56a Allender
67 * fixed calling convention problem with DLL handles
69 * 12 2/04/98 6:08p Lawrance
70 * Read function pointers from dsound.dll, further work on
73 * 11 1/31/98 5:48p Lawrance
74 * Start on real-time voice recording
76 * 10 12/05/97 5:19p Lawrance
77 * re-do sound priorities to make more general and extensible
79 * 9 11/20/97 5:36p Dave
80 * Hooked in a bunch of main hall changes (including sound). Made it
81 * possible to reposition (rewind/ffwd)
82 * sound buffer pointers. Fixed animation direction change framerate
85 * 8 10/13/97 7:41p Lawrance
86 * store duration of sound
88 * 7 7/28/97 11:39a Lawrance
89 * allow individual volume scaling on 3D buffers
91 * 6 7/17/97 9:32a John
92 * made all directX header files name start with a v
94 * 5 7/15/97 11:15a Lawrance
95 * limit the max instances of simultaneous sound effects, implement
96 * priorities to force critical sounds
98 * 4 6/09/97 11:50p Lawrance
99 * integrating DirectSound3D
101 * 3 6/02/97 1:45p Lawrance
102 * implementing hardware mixing
104 * 2 5/29/97 12:04p Lawrance
105 * creation of file to hold DirectSound specific portions
120 #define DS_HARDWARE (1<<0)
122 #define DS_USE_DS3D (1<<2)
124 // Constants that DirectSound should assign, but doesn't
125 #define MAX_PAN 1500.0f
126 #define MIN_PITCH 100
127 #define MAX_PITCH 100000
130 // limits placed on how many concurrent sounds of the same type can play simultaneously
131 #define DS_MUST_PLAY 0
132 #define DS_LIMIT_ONE 1
133 #define DS_LIMIT_TWO 2
134 #define DS_LIMIT_THREE 3
136 #define DS_DUP_FAILED -99
138 typedef struct sound_info {
139 int format; // WAVE_FORMAT_* defines from mmreg.h
142 int avg_bytes_per_sec;
146 int duration; // time in ms for duration of sound
150 extern int ds_initialized;
152 extern LPDIRECTSOUNDBUFFER pPrimaryBuffer;
153 extern LPDIRECTSOUND pDirectSound;
155 extern HRESULT (__stdcall *pfn_DirectSoundCaptureCreate)(LPGUID lpGUID, LPDIRECTSOUNDCAPTURE *lplpDSC, LPUNKNOWN pUnkOuter);
158 int ds_init(int use_a3d, int use_eax);
160 void ds_get_primary_format(WAVEFORMATEX *wfx);
161 int ds_parse_wave(char *filename, ubyte **dest, uint *dest_size, WAVEFORMATEX **header);
162 int ds_load_buffer(int *sid, int *hid, int *final_size, void *header, sound_info *si, int flags);
163 void ds_unload_buffer(int sid, int hid);
164 int ds_play(int sid, int hid, int snd_id, int priority, int volume, int pan, int looping, bool is_voice_msg = false);
165 int ds_convert_volume(float volume); // Convert a volume from 0.0f->1.0f to -10000 -> 0
166 float ds_get_percentage_vol(int ds_vol); // Convert a volume from -10000 -> 0 to 0.0f->1.0f
167 int ds_get_channel(int sig);
168 int ds_is_channel_playing(int channel);
169 void ds_stop_channel(int channel);
170 void ds_stop_channel_all();
171 void ds_set_volume( int channel, int vol );
172 void ds_set_pan( int channel, int pan );
173 int ds_get_pitch(int channel);
174 void ds_set_pitch(int channel, int pitch);
175 void ds_chg_loop_status(int channel, int loop);
176 void ds_set_position(int channel, DWORD offset);
177 DWORD ds_get_play_position(int channel);
178 DWORD ds_get_write_position(int channel);
179 int ds_get_data(int sid, char *data);
180 int ds_get_size(int sid, int *size);
182 int ds_create_buffer(int frequency, int bits_per_sample, int nchannels, int nseconds);
183 int ds_lock_data(int sid, unsigned char *data, int size);
184 int ds_play_easy(int sid, int volume);
185 void ds_stop_easy(int sid);
186 int ds_get_channel_size(int channel);
187 int ds_is_3d_buffer(int sid);
191 unsigned int ds_get_primary_buffer_interface();
192 unsigned int ds_get_dsound_interface();
193 unsigned int ds_get_property_set_interface();
195 // Returns the number of channels that are actually playing
196 int ds_get_number_channels();
198 int ds3d_play( int sid, int hid, int snd_id, vector *pos, vector *vel, int min, int max, int looping, int max_volume, int estimated_vol, int priority=DS_MUST_PLAY );
200 // Get a character string for the error code
201 char *get_DSERR_text(int DSResult);
205 // --------------------
209 // --------------------
211 // EAX (listener) reverb property set {4a4e6fc1-c341-11d1-b73a-444553540000}
213 DEFINE_GUID(DSPROPSETID_EAX_ReverbProperties,
217 0xb7, 0x3a, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00);
222 DSPROPERTY_EAX_ALL, // all reverb properties
223 DSPROPERTY_EAX_ENVIRONMENT, // standard environment no.
224 DSPROPERTY_EAX_VOLUME, // loudness of the reverb
225 DSPROPERTY_EAX_DECAYTIME, // how long the reverb lasts
226 DSPROPERTY_EAX_DAMPING // the high frequencies decay faster
227 } DSPROPERTY_EAX_REVERBPROPERTY;
229 #define EAX_NUM_STANDARD_PROPERTIES (DSPROPERTY_EAX_DAMPING + 1)
231 // use this structure for get/set all properties...
234 unsigned long environment; // 0 to EAX_ENVIRONMENT_COUNT-1
235 float fVolume; // 0 to 1
236 float fDecayTime_sec; // seconds, 0.1 to 100
237 float fDamping; // 0 to 1
238 } EAX_REVERBPROPERTIES;
243 EAX_ENVIRONMENT_GENERIC,
244 EAX_ENVIRONMENT_PADDEDCELL,
245 EAX_ENVIRONMENT_ROOM,
246 EAX_ENVIRONMENT_BATHROOM,
247 EAX_ENVIRONMENT_LIVINGROOM,
248 EAX_ENVIRONMENT_STONEROOM,
249 EAX_ENVIRONMENT_AUDITORIUM,
250 EAX_ENVIRONMENT_CONCERTHALL,
251 EAX_ENVIRONMENT_CAVE,
252 EAX_ENVIRONMENT_ARENA,
253 EAX_ENVIRONMENT_HANGAR,
254 EAX_ENVIRONMENT_CARPETEDHALLWAY,
255 EAX_ENVIRONMENT_HALLWAY,
256 EAX_ENVIRONMENT_STONECORRIDOR,
257 EAX_ENVIRONMENT_ALLEY,
258 EAX_ENVIRONMENT_FOREST,
259 EAX_ENVIRONMENT_CITY,
260 EAX_ENVIRONMENT_MOUNTAINS,
261 EAX_ENVIRONMENT_QUARRY,
262 EAX_ENVIRONMENT_PLAIN,
263 EAX_ENVIRONMENT_PARKINGLOT,
264 EAX_ENVIRONMENT_SEWERPIPE,
265 EAX_ENVIRONMENT_UNDERWATER,
266 EAX_ENVIRONMENT_DRUGGED,
267 EAX_ENVIRONMENT_DIZZY,
268 EAX_ENVIRONMENT_PSYCHOTIC,
270 EAX_ENVIRONMENT_COUNT // total number of environments
273 #define EAX_MAX_ENVIRONMENT (EAX_ENVIRONMENT_COUNT - 1)
275 // EAX buffer reverb property set {4a4e6fc0-c341-11d1-b73a-444553540000}
277 DEFINE_GUID(DSPROPSETID_EAXBUFFER_ReverbProperties,
281 0xb7, 0x3a, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00);
286 DSPROPERTY_EAXBUFFER_ALL, // all reverb buffer properties
287 DSPROPERTY_EAXBUFFER_REVERBMIX // the wet source amount
288 } DSPROPERTY_EAXBUFFER_REVERBPROPERTY;
290 // use this structure for get/set all properties...
293 float fMix; // linear factor, 0.0F to 1.0F
294 } EAXBUFFER_REVERBPROPERTIES;
296 #define EAX_REVERBMIX_USEDISTANCE -1.0F // out of normal range
297 // signifies the reverb engine should
298 // calculate it's own reverb mix value
306 int ds_eax_set_preset(unsigned long envid);
308 int ds_eax_set_volume(float volume);
309 int ds_eax_set_decay_time(float seconds);
310 int ds_eax_set_damping(float damp);
311 int ds_eax_set_environment(unsigned long envid);
312 int ds_eax_set_all(unsigned long id, float volume, float damping, float decay);
313 int ds_eax_get_all(EAX_REVERBPROPERTIES *er);
314 int ds_eax_is_inited();
316 #endif /* __DS_H__ */