include/ds.h

   1 /*
   2  * $Logfile: /Freespace2/code/Sound/ds.h $
   3  * $Revision$
   4  * $Date$
   5  * $Author$
   6  *
   7  * Header file for interface to DirectSound
   8  *
   9  * $Log$
  10  * Revision 1.1  2002/05/03 03:28:12  root
  11  * Initial revision
  12  *
  13  *
  14  * 5     8/27/99 6:38p Alanl
  15  * crush the blasted repeating messages bug
  16  *
  17  * 4     8/01/99 2:06p Alanl
  18  * increase the rolloff for A3D
  19  *
  20  * 3     5/23/99 8:11p Alanl
  21  * Added support for EAX
  22  *
  23  * 2     10/07/98 10:54a Dave
  24  * Initial checkin.
  25  *
  26  * 1     10/07/98 10:51a Dave
  27  *
  28  * 21    5/05/98 4:49p Lawrance
  29  * Put in code to authenticate A3D, improve A3D support
  30  *
  31  * 20    4/20/98 12:03a Lawrance
  32  * Allow prioritizing of CTRL3D buffers
  33  *
  34  * 19    4/18/98 9:12p Lawrance
  35  * Added Aureal support.
  36  *
  37  * 18    4/13/98 5:04p Lawrance
  38  * Write functions to determine how many milliseconds are left in a sound
  39  *
  40  * 17    3/23/98 10:32a Lawrance
  41  * Add functions for extracting raw sound data
  42  *
  43  * 16    2/15/98 11:10p Lawrance
  44  * more work on real-time voice system
  45  *
  46  * 15    2/15/98 4:43p Lawrance
  47  * work on real-time voice
  48  *
  49  * 14    2/06/98 7:30p John
  50  * Added code to monitor the number of channels of sound actually playing.
  51  *
  52  * 13    2/06/98 8:56a Allender
  53  * fixed calling convention problem with DLL handles
  54  *
  55  * 12    2/04/98 6:08p Lawrance
  56  * Read function pointers from dsound.dll, further work on
  57  * DirectSoundCapture.
  58  *
  59  * 11    1/31/98 5:48p Lawrance
  60  * Start on real-time voice recording
  61  *
  62  * 10    12/05/97 5:19p Lawrance
  63  * re-do sound priorities to make more general and extensible
  64  *
  65  * 9     11/20/97 5:36p Dave
  66  * Hooked in a bunch of main hall changes (including sound). Made it
  67  * possible to reposition (rewind/ffwd)
  68  * sound buffer pointers. Fixed animation direction change framerate
  69  * problem.
  70  *
  71  * 8     10/13/97 7:41p Lawrance
  72  * store duration of sound
  73  *
  74  * 7     7/28/97 11:39a Lawrance
  75  * allow individual volume scaling on 3D buffers
  76  *
  77  * 6     7/17/97 9:32a John
  78  * made all directX header files name start with a v
  79  *
  80  * 5     7/15/97 11:15a Lawrance
  81  * limit the max instances of simultaneous sound effects, implement
  82  * priorities to force critical sounds
  83  *
  84  * 4     6/09/97 11:50p Lawrance
  85  * integrating DirectSound3D
  86  *
  87  * 3     6/02/97 1:45p Lawrance
  88  * implementing hardware mixing
  89  *
  90  * 2     5/29/97 12:04p Lawrance
  91  * creation of file to hold DirectSound specific portions
  92  *
  93  * $NoKeywords: $
  94  */
  95
  96 #ifndef __DS_H__
  97 #define __DS_H__
  98
  99 #include <windows.h>
 100 #include <mmreg.h>
 101 #include "vdsound.h"
 102 #include "pstypes.h"
 103
 104 #define DS_HARDWARE     (1<<0)
 105 #define DS_3D                   (1<<1)
 106 #define DS_USE_DS3D     (1<<2)
 107
 108 // Constants that DirectSound should assign, but doesn't
 109 #define MAX_PAN         1500.0f
 110 #define MIN_PITCH               100
 111 #define MAX_PITCH               100000
 112
 113
 114 // limits placed on how many concurrent sounds of the same type can play simultaneously
 115 #define DS_MUST_PLAY                            0
 116 #define DS_LIMIT_ONE                            1
 117 #define DS_LIMIT_TWO                            2
 118 #define DS_LIMIT_THREE                  3
 119
 120 #define DS_DUP_FAILED                   -99
 121
 122 typedef struct sound_info {
 123         int     format;         // WAVE_FORMAT_* defines from mmreg.h
 124         uint    size;
 125         int     sample_rate;
 126         int     avg_bytes_per_sec;
 127         int     n_block_align;
 128         int     bits;
 129         int     n_channels;
 130         int     duration;       // time in ms for duration of sound
 131         ubyte   *data;
 132 } sound_info;
 133
 134 extern int                                                      ds_initialized;
 135 extern LPDIRECTSOUNDBUFFER              pPrimaryBuffer;
 136 extern LPDIRECTSOUND                            pDirectSound;
 137
 138 extern HRESULT (__stdcall *pfn_DirectSoundCaptureCreate)(LPGUID lpGUID, LPDIRECTSOUNDCAPTURE *lplpDSC, LPUNKNOWN pUnkOuter);
 139
 140 int     ds_init(int use_a3d, int use_eax);
 141 void    ds_close();
 142 void    ds_get_primary_format(WAVEFORMATEX *wfx);
 143 int     ds_parse_wave(char *filename, ubyte **dest, uint *dest_size, WAVEFORMATEX **header);
 144 int     ds_load_buffer(int *sid, int *hid, int *final_size, void *header, sound_info *si, int flags);
 145 void    ds_unload_buffer(int sid, int hid);
 146 int     ds_play(int sid, int hid, int snd_id, int priority, int volume, int pan, int looping, bool is_voice_msg = false);
 147 int     ds_convert_volume(float volume);                // Convert a volume from 0.0f->1.0f to -10000 -> 0
 148 float ds_get_percentage_vol(int ds_vol);        // Convert a volume from -10000 -> 0 to 0.0f->1.0f
 149 int     ds_get_channel(int sig);
 150 int     ds_is_channel_playing(int channel);
 151 void    ds_stop_channel(int channel);
 152 void    ds_stop_channel_all();
 153 void    ds_set_volume( int channel, int vol );
 154 void    ds_set_pan( int channel, int pan );
 155 int     ds_get_pitch(int channel);
 156 void    ds_set_pitch(int channel, int pitch);
 157 void    ds_chg_loop_status(int channel, int loop);
 158 void  ds_set_position(int channel, DWORD offset);
 159 DWORD ds_get_play_position(int channel);
 160 DWORD ds_get_write_position(int channel);
 161 int     ds_get_data(int sid, char *data);
 162 int     ds_get_size(int sid, int *size);
 163
 164 int     ds_create_buffer(int frequency, int bits_per_sample, int nchannels, int nseconds);
 165 int     ds_lock_data(int sid, unsigned char *data, int size);
 166 int     ds_play_easy(int sid, int volume);
 167 void    ds_stop_easy(int sid);
 168 int     ds_get_channel_size(int channel);
 169 int     ds_is_3d_buffer(int sid);
 170 int     ds_using_ds3d();
 171 bool    ds_using_a3d();
 172
 173 unsigned int ds_get_primary_buffer_interface();
 174 unsigned int ds_get_dsound_interface();
 175 unsigned int ds_get_property_set_interface();
 176
 177 // Returns the number of channels that are actually playing
 178 int ds_get_number_channels();
 179
 180 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 );
 181
 182 // Get a character string for the error code
 183 char    *get_DSERR_text(int DSResult);
 184
 185 void ds_do_frame();
 186
 187 // --------------------
 188 //
 189 // Creative eax.h
 190 //
 191 // --------------------
 192
 193 // EAX (listener) reverb property set {4a4e6fc1-c341-11d1-b73a-444553540000}
 194 DEFINE_GUID(DSPROPSETID_EAX_ReverbProperties,
 195     0x4a4e6fc1,
 196     0xc341,
 197     0x11d1,
 198     0xb7, 0x3a, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00);
 199
 200 typedef enum
 201 {
 202     DSPROPERTY_EAX_ALL,                // all reverb properties
 203     DSPROPERTY_EAX_ENVIRONMENT,        // standard environment no.
 204     DSPROPERTY_EAX_VOLUME,             // loudness of the reverb
 205     DSPROPERTY_EAX_DECAYTIME,          // how long the reverb lasts
 206     DSPROPERTY_EAX_DAMPING             // the high frequencies decay faster
 207 } DSPROPERTY_EAX_REVERBPROPERTY;
 208
 209 #define EAX_NUM_STANDARD_PROPERTIES (DSPROPERTY_EAX_DAMPING + 1)
 210
 211 // use this structure for get/set all properties...
 212 typedef struct
 213 {
 214     unsigned long environment;          // 0 to EAX_ENVIRONMENT_COUNT-1
 215     float fVolume;                      // 0 to 1
 216     float fDecayTime_sec;               // seconds, 0.1 to 100
 217     float fDamping;                     // 0 to 1
 218 } EAX_REVERBPROPERTIES;
 219
 220
 221 enum
 222 {
 223     EAX_ENVIRONMENT_GENERIC,
 224     EAX_ENVIRONMENT_PADDEDCELL,
 225     EAX_ENVIRONMENT_ROOM,
 226     EAX_ENVIRONMENT_BATHROOM,
 227     EAX_ENVIRONMENT_LIVINGROOM,
 228     EAX_ENVIRONMENT_STONEROOM,
 229     EAX_ENVIRONMENT_AUDITORIUM,
 230     EAX_ENVIRONMENT_CONCERTHALL,
 231     EAX_ENVIRONMENT_CAVE,
 232     EAX_ENVIRONMENT_ARENA,
 233     EAX_ENVIRONMENT_HANGAR,
 234     EAX_ENVIRONMENT_CARPETEDHALLWAY,
 235     EAX_ENVIRONMENT_HALLWAY,
 236     EAX_ENVIRONMENT_STONECORRIDOR,
 237     EAX_ENVIRONMENT_ALLEY,
 238     EAX_ENVIRONMENT_FOREST,
 239     EAX_ENVIRONMENT_CITY,
 240     EAX_ENVIRONMENT_MOUNTAINS,
 241     EAX_ENVIRONMENT_QUARRY,
 242     EAX_ENVIRONMENT_PLAIN,
 243     EAX_ENVIRONMENT_PARKINGLOT,
 244     EAX_ENVIRONMENT_SEWERPIPE,
 245     EAX_ENVIRONMENT_UNDERWATER,
 246     EAX_ENVIRONMENT_DRUGGED,
 247     EAX_ENVIRONMENT_DIZZY,
 248     EAX_ENVIRONMENT_PSYCHOTIC,
 249
 250     EAX_ENVIRONMENT_COUNT           // total number of environments
 251 };
 252
 253 #define EAX_MAX_ENVIRONMENT (EAX_ENVIRONMENT_COUNT - 1)
 254
 255 // EAX buffer reverb property set {4a4e6fc0-c341-11d1-b73a-444553540000}
 256 DEFINE_GUID(DSPROPSETID_EAXBUFFER_ReverbProperties,
 257     0x4a4e6fc0,
 258     0xc341,
 259     0x11d1,
 260     0xb7, 0x3a, 0x44, 0x45, 0x53, 0x54, 0x00, 0x00);
 261
 262 typedef enum
 263 {
 264     DSPROPERTY_EAXBUFFER_ALL,           // all reverb buffer properties
 265     DSPROPERTY_EAXBUFFER_REVERBMIX      // the wet source amount
 266 } DSPROPERTY_EAXBUFFER_REVERBPROPERTY;
 267
 268 // use this structure for get/set all properties...
 269 typedef struct
 270 {
 271     float fMix;                          // linear factor, 0.0F to 1.0F
 272 } EAXBUFFER_REVERBPROPERTIES;
 273
 274 #define EAX_REVERBMIX_USEDISTANCE -1.0F // out of normal range
 275                                          // signifies the reverb engine should
 276                                          // calculate it's own reverb mix value
 277                                          // based on distance
 278
 279 // prototypes
 280
 281 int ds_eax_init();
 282 void ds_eax_close();
 283
 284 int ds_eax_set_preset(unsigned long envid);
 285
 286 int ds_eax_set_volume(float volume);
 287 int ds_eax_set_decay_time(float seconds);
 288 int ds_eax_set_damping(float damp);
 289 int ds_eax_set_environment(unsigned long envid);
 290 int ds_eax_set_all(unsigned long id, float volume, float damping, float decay);
 291 int ds_eax_get_all(EAX_REVERBPROPERTIES *er);
 292 int ds_eax_is_inited();
 293
 294 #endif /* __DS_H__ */
 295