1 #ifndef EAX_API_INCLUDED
2 #define EAX_API_INCLUDED
8 // Based on headers `eax[2-5].h` included in Doom 3 source code:
9 // https://github.com/id-Software/DOOM-3/tree/master/neo/openal/include
29 std::uint8_t Data4
[8];
32 inline bool operator==(const GUID
& lhs
, const GUID
& rhs
) noexcept
34 return std::memcmp(&lhs
, &rhs
, sizeof(GUID
)) == 0;
37 inline bool operator!=(const GUID
& lhs
, const GUID
& rhs
) noexcept
41 #endif // GUID_DEFINED
44 extern const GUID DSPROPSETID_EAX_ReverbProperties
;
46 enum DSPROPERTY_EAX_REVERBPROPERTY
: unsigned int
49 DSPROPERTY_EAX_ENVIRONMENT
,
50 DSPROPERTY_EAX_VOLUME
,
51 DSPROPERTY_EAX_DECAYTIME
,
52 DSPROPERTY_EAX_DAMPING
,
53 }; // DSPROPERTY_EAX_REVERBPROPERTY
55 struct EAX_REVERBPROPERTIES
57 unsigned long environment
;
61 }; // EAX_REVERBPROPERTIES
63 inline bool operator==(const EAX_REVERBPROPERTIES
& lhs
, const EAX_REVERBPROPERTIES
& rhs
) noexcept
65 return std::memcmp(&lhs
, &rhs
, sizeof(EAX_REVERBPROPERTIES
)) == 0;
68 extern const GUID DSPROPSETID_EAXBUFFER_ReverbProperties
;
70 enum DSPROPERTY_EAXBUFFER_REVERBPROPERTY
: unsigned int
72 DSPROPERTY_EAXBUFFER_ALL
,
73 DSPROPERTY_EAXBUFFER_REVERBMIX
,
74 }; // DSPROPERTY_EAXBUFFER_REVERBPROPERTY
76 struct EAXBUFFER_REVERBPROPERTIES
81 inline bool operator==(const EAXBUFFER_REVERBPROPERTIES
& lhs
, const EAXBUFFER_REVERBPROPERTIES
& rhs
) noexcept
83 return lhs
.fMix
== rhs
.fMix
;
86 constexpr auto EAX_BUFFER_MINREVERBMIX
= 0.0F
;
87 constexpr auto EAX_BUFFER_MAXREVERBMIX
= 1.0F
;
88 constexpr auto EAX_REVERBMIX_USEDISTANCE
= -1.0F
;
91 extern const GUID DSPROPSETID_EAX20_ListenerProperties
;
93 enum DSPROPERTY_EAX20_LISTENERPROPERTY
:
96 DSPROPERTY_EAX20LISTENER_NONE
,
97 DSPROPERTY_EAX20LISTENER_ALLPARAMETERS
,
98 DSPROPERTY_EAX20LISTENER_ROOM
,
99 DSPROPERTY_EAX20LISTENER_ROOMHF
,
100 DSPROPERTY_EAX20LISTENER_ROOMROLLOFFFACTOR
,
101 DSPROPERTY_EAX20LISTENER_DECAYTIME
,
102 DSPROPERTY_EAX20LISTENER_DECAYHFRATIO
,
103 DSPROPERTY_EAX20LISTENER_REFLECTIONS
,
104 DSPROPERTY_EAX20LISTENER_REFLECTIONSDELAY
,
105 DSPROPERTY_EAX20LISTENER_REVERB
,
106 DSPROPERTY_EAX20LISTENER_REVERBDELAY
,
107 DSPROPERTY_EAX20LISTENER_ENVIRONMENT
,
108 DSPROPERTY_EAX20LISTENER_ENVIRONMENTSIZE
,
109 DSPROPERTY_EAX20LISTENER_ENVIRONMENTDIFFUSION
,
110 DSPROPERTY_EAX20LISTENER_AIRABSORPTIONHF
,
111 DSPROPERTY_EAX20LISTENER_FLAGS
112 }; // DSPROPERTY_EAX20_LISTENERPROPERTY
114 struct EAX20LISTENERPROPERTIES
116 long lRoom
; // room effect level at low frequencies
117 long lRoomHF
; // room effect high-frequency level re. low frequency level
118 float flRoomRolloffFactor
; // like DS3D flRolloffFactor but for room effect
119 float flDecayTime
; // reverberation decay time at low frequencies
120 float flDecayHFRatio
; // high-frequency to low-frequency decay time ratio
121 long lReflections
; // early reflections level relative to room effect
122 float flReflectionsDelay
; // initial reflection delay time
123 long lReverb
; // late reverberation level relative to room effect
124 float flReverbDelay
; // late reverberation delay time relative to initial reflection
125 unsigned long dwEnvironment
; // sets all listener properties
126 float flEnvironmentSize
; // environment size in meters
127 float flEnvironmentDiffusion
; // environment diffusion
128 float flAirAbsorptionHF
; // change in level per meter at 5 kHz
129 unsigned long dwFlags
; // modifies the behavior of properties
130 }; // EAX20LISTENERPROPERTIES
133 extern const GUID DSPROPSETID_EAX20_BufferProperties
;
136 enum DSPROPERTY_EAX20_BUFFERPROPERTY
:
139 DSPROPERTY_EAX20BUFFER_NONE
,
140 DSPROPERTY_EAX20BUFFER_ALLPARAMETERS
,
141 DSPROPERTY_EAX20BUFFER_DIRECT
,
142 DSPROPERTY_EAX20BUFFER_DIRECTHF
,
143 DSPROPERTY_EAX20BUFFER_ROOM
,
144 DSPROPERTY_EAX20BUFFER_ROOMHF
,
145 DSPROPERTY_EAX20BUFFER_ROOMROLLOFFFACTOR
,
146 DSPROPERTY_EAX20BUFFER_OBSTRUCTION
,
147 DSPROPERTY_EAX20BUFFER_OBSTRUCTIONLFRATIO
,
148 DSPROPERTY_EAX20BUFFER_OCCLUSION
,
149 DSPROPERTY_EAX20BUFFER_OCCLUSIONLFRATIO
,
150 DSPROPERTY_EAX20BUFFER_OCCLUSIONROOMRATIO
,
151 DSPROPERTY_EAX20BUFFER_OUTSIDEVOLUMEHF
,
152 DSPROPERTY_EAX20BUFFER_AIRABSORPTIONFACTOR
,
153 DSPROPERTY_EAX20BUFFER_FLAGS
154 }; // DSPROPERTY_EAX20_BUFFERPROPERTY
157 struct EAX20BUFFERPROPERTIES
159 long lDirect
; // direct path level
160 long lDirectHF
; // direct path level at high frequencies
161 long lRoom
; // room effect level
162 long lRoomHF
; // room effect level at high frequencies
163 float flRoomRolloffFactor
; // like DS3D flRolloffFactor but for room effect
164 long lObstruction
; // main obstruction control (attenuation at high frequencies)
165 float flObstructionLFRatio
; // obstruction low-frequency level re. main control
166 long lOcclusion
; // main occlusion control (attenuation at high frequencies)
167 float flOcclusionLFRatio
; // occlusion low-frequency level re. main control
168 float flOcclusionRoomRatio
; // occlusion room effect level re. main control
169 long lOutsideVolumeHF
; // outside sound cone level at high frequencies
170 float flAirAbsorptionFactor
; // multiplies DSPROPERTY_EAXLISTENER_AIRABSORPTIONHF
171 unsigned long dwFlags
; // modifies the behavior of properties
172 }; // EAX20BUFFERPROPERTIES
175 extern const GUID DSPROPSETID_EAX30_ListenerProperties
;
177 extern const GUID DSPROPSETID_EAX30_BufferProperties
;
180 constexpr auto EAX_MAX_FXSLOTS
= 4;
182 constexpr auto EAX40_MAX_ACTIVE_FXSLOTS
= 2;
183 constexpr auto EAX50_MAX_ACTIVE_FXSLOTS
= 4;
186 constexpr auto EAX_OK
= 0L;
187 constexpr auto EAXERR_INVALID_OPERATION
= -1L;
188 constexpr auto EAXERR_INVALID_VALUE
= -2L;
189 constexpr auto EAXERR_NO_EFFECT_LOADED
= -3L;
190 constexpr auto EAXERR_UNKNOWN_EFFECT
= -4L;
191 constexpr auto EAXERR_INCOMPATIBLE_SOURCE_TYPE
= -5L;
192 constexpr auto EAXERR_INCOMPATIBLE_EAX_VERSION
= -6L;
195 extern const GUID EAX_NULL_GUID
;
197 extern const GUID EAX_PrimaryFXSlotID
;
207 inline bool operator==(const EAXVECTOR
& lhs
, const EAXVECTOR
& rhs
) noexcept
208 { return std::memcmp(&lhs
, &rhs
, sizeof(EAXVECTOR
)) == 0; }
210 inline bool operator!=(const EAXVECTOR
& lhs
, const EAXVECTOR
& rhs
) noexcept
211 { return !(lhs
== rhs
); }
214 extern const GUID EAXPROPERTYID_EAX40_Context
;
216 extern const GUID EAXPROPERTYID_EAX50_Context
;
225 SPEAKERS_5
, // 5.1 speakers
226 SPEAKERS_6
, // 6.1 speakers
227 SPEAKERS_7
, // 7.1 speakers
234 EAX_40
= 5, // EAX 4.0
235 EAX_50
= 6, // EAX 5.0
238 constexpr auto EAXCONTEXT_MINEAXSESSION
= EAX_40
;
239 constexpr auto EAXCONTEXT_MAXEAXSESSION
= EAX_50
;
240 constexpr auto EAXCONTEXT_DEFAULTEAXSESSION
= EAX_40
;
242 constexpr auto EAXCONTEXT_MINMAXACTIVESENDS
= 2UL;
243 constexpr auto EAXCONTEXT_MAXMAXACTIVESENDS
= 4UL;
244 constexpr auto EAXCONTEXT_DEFAULTMAXACTIVESENDS
= 2UL;
247 struct EAXSESSIONPROPERTIES
249 unsigned long ulEAXVersion
;
250 unsigned long ulMaxActiveSends
;
251 }; // EAXSESSIONPROPERTIES
253 enum EAXCONTEXT_PROPERTY
:
257 EAXCONTEXT_ALLPARAMETERS
,
258 EAXCONTEXT_PRIMARYFXSLOTID
,
259 EAXCONTEXT_DISTANCEFACTOR
,
260 EAXCONTEXT_AIRABSORPTIONHF
,
261 EAXCONTEXT_HFREFERENCE
,
262 EAXCONTEXT_LASTERROR
,
265 EAXCONTEXT_SPEAKERCONFIG
,
266 EAXCONTEXT_EAXSESSION
,
267 EAXCONTEXT_MACROFXFACTOR
,
268 }; // EAXCONTEXT_PROPERTY
270 struct EAX40CONTEXTPROPERTIES
272 GUID guidPrimaryFXSlotID
;
273 float flDistanceFactor
;
274 float flAirAbsorptionHF
;
276 }; // EAX40CONTEXTPROPERTIES
278 struct EAX50CONTEXTPROPERTIES
:
279 public EAX40CONTEXTPROPERTIES
281 float flMacroFXFactor
;
282 }; // EAX40CONTEXTPROPERTIES
286 const EAX40CONTEXTPROPERTIES
& lhs
,
287 const EAX40CONTEXTPROPERTIES
& rhs
) noexcept
;
290 const EAX50CONTEXTPROPERTIES
& lhs
,
291 const EAX50CONTEXTPROPERTIES
& rhs
) noexcept
;
294 constexpr auto EAXCONTEXT_MINDISTANCEFACTOR
= FLT_MIN
;
295 constexpr auto EAXCONTEXT_MAXDISTANCEFACTOR
= FLT_MAX
;
296 constexpr auto EAXCONTEXT_DEFAULTDISTANCEFACTOR
= 1.0F
;
298 constexpr auto EAXCONTEXT_MINAIRABSORPTIONHF
= -100.0F
;
299 constexpr auto EAXCONTEXT_MAXAIRABSORPTIONHF
= 0.0F
;
300 constexpr auto EAXCONTEXT_DEFAULTAIRABSORPTIONHF
= -5.0F
;
302 constexpr auto EAXCONTEXT_MINHFREFERENCE
= 1000.0F
;
303 constexpr auto EAXCONTEXT_MAXHFREFERENCE
= 20000.0F
;
304 constexpr auto EAXCONTEXT_DEFAULTHFREFERENCE
= 5000.0F
;
306 constexpr auto EAXCONTEXT_MINMACROFXFACTOR
= 0.0F
;
307 constexpr auto EAXCONTEXT_MAXMACROFXFACTOR
= 1.0F
;
308 constexpr auto EAXCONTEXT_DEFAULTMACROFXFACTOR
= 0.0F
;
311 extern const GUID EAXPROPERTYID_EAX40_FXSlot0
;
313 extern const GUID EAXPROPERTYID_EAX50_FXSlot0
;
315 extern const GUID EAXPROPERTYID_EAX40_FXSlot1
;
317 extern const GUID EAXPROPERTYID_EAX50_FXSlot1
;
319 extern const GUID EAXPROPERTYID_EAX40_FXSlot2
;
321 extern const GUID EAXPROPERTYID_EAX50_FXSlot2
;
323 extern const GUID EAXPROPERTYID_EAX40_FXSlot3
;
325 extern const GUID EAXPROPERTYID_EAX50_FXSlot3
;
327 extern const GUID EAXCONTEXT_DEFAULTPRIMARYFXSLOTID
;
329 enum EAXFXSLOT_PROPERTY
:
332 EAXFXSLOT_PARAMETER
= 0,
334 EAXFXSLOT_NONE
= 0x10000,
335 EAXFXSLOT_ALLPARAMETERS
,
336 EAXFXSLOT_LOADEFFECT
,
343 EAXFXSLOT_OCCLUSIONLFRATIO
,
344 }; // EAXFXSLOT_PROPERTY
346 constexpr auto EAXFXSLOTFLAGS_ENVIRONMENT
= 0x00000001UL
;
348 constexpr auto EAXFXSLOTFLAGS_UPMIX
= 0x00000002UL
;
350 constexpr auto EAX40FXSLOTFLAGS_RESERVED
= 0xFFFFFFFEUL
; // reserved future use
351 constexpr auto EAX50FXSLOTFLAGS_RESERVED
= 0xFFFFFFFCUL
; // reserved future use
354 constexpr auto EAXFXSLOT_MINVOLUME
= -10'000L;
355 constexpr auto EAXFXSLOT_MAXVOLUME
= 0L;
356 constexpr auto EAXFXSLOT_DEFAULTVOLUME
= 0L;
358 constexpr auto EAXFXSLOT_MINLOCK
= 0L;
359 constexpr auto EAXFXSLOT_MAXLOCK
= 1L;
364 EAXFXSLOT_UNLOCKED
= 0,
368 constexpr auto EAXFXSLOT_MINOCCLUSION
= -10'000L;
369 constexpr auto EAXFXSLOT_MAXOCCLUSION
= 0L;
370 constexpr auto EAXFXSLOT_DEFAULTOCCLUSION
= 0L;
372 constexpr auto EAXFXSLOT_MINOCCLUSIONLFRATIO
= 0.0F
;
373 constexpr auto EAXFXSLOT_MAXOCCLUSIONLFRATIO
= 1.0F
;
374 constexpr auto EAXFXSLOT_DEFAULTOCCLUSIONLFRATIO
= 0.25F
;
376 constexpr auto EAX40FXSLOT_DEFAULTFLAGS
= EAXFXSLOTFLAGS_ENVIRONMENT
;
378 constexpr auto EAX50FXSLOT_DEFAULTFLAGS
=
379 EAXFXSLOTFLAGS_ENVIRONMENT
|
380 EAXFXSLOTFLAGS_UPMIX
; // ignored for reverb;
382 struct EAX40FXSLOTPROPERTIES
387 unsigned long ulFlags
;
388 }; // EAX40FXSLOTPROPERTIES
390 struct EAX50FXSLOTPROPERTIES
:
391 public EAX40FXSLOTPROPERTIES
394 float flOcclusionLFRatio
;
395 }; // EAX50FXSLOTPROPERTIES
398 const EAX40FXSLOTPROPERTIES
& lhs
,
399 const EAX40FXSLOTPROPERTIES
& rhs
) noexcept
;
402 const EAX50FXSLOTPROPERTIES
& lhs
,
403 const EAX50FXSLOTPROPERTIES
& rhs
) noexcept
;
405 extern const GUID EAXPROPERTYID_EAX40_Source
;
407 extern const GUID EAXPROPERTYID_EAX50_Source
;
409 // Source object properties
410 enum EAXSOURCE_PROPERTY
:
416 EAXSOURCE_ALLPARAMETERS
,
417 EAXSOURCE_OBSTRUCTIONPARAMETERS
,
418 EAXSOURCE_OCCLUSIONPARAMETERS
,
419 EAXSOURCE_EXCLUSIONPARAMETERS
,
424 EAXSOURCE_OBSTRUCTION
,
425 EAXSOURCE_OBSTRUCTIONLFRATIO
,
427 EAXSOURCE_OCCLUSIONLFRATIO
,
428 EAXSOURCE_OCCLUSIONROOMRATIO
,
429 EAXSOURCE_OCCLUSIONDIRECTRATIO
,
431 EAXSOURCE_EXCLUSIONLFRATIO
,
432 EAXSOURCE_OUTSIDEVOLUMEHF
,
433 EAXSOURCE_DOPPLERFACTOR
,
434 EAXSOURCE_ROLLOFFFACTOR
,
435 EAXSOURCE_ROOMROLLOFFFACTOR
,
436 EAXSOURCE_AIRABSORPTIONFACTOR
,
441 EAXSOURCE_SENDPARAMETERS
,
442 EAXSOURCE_ALLSENDPARAMETERS
,
443 EAXSOURCE_OCCLUSIONSENDPARAMETERS
,
444 EAXSOURCE_EXCLUSIONSENDPARAMETERS
,
445 EAXSOURCE_ACTIVEFXSLOTID
,
449 EAXSOURCE_MACROFXFACTOR
,
450 EAXSOURCE_SPEAKERLEVELS
,
451 EAXSOURCE_ALL2DPARAMETERS
,
452 }; // EAXSOURCE_PROPERTY
455 constexpr auto EAXSOURCEFLAGS_DIRECTHFAUTO
= 0x00000001UL
; // relates to EAXSOURCE_DIRECTHF
456 constexpr auto EAXSOURCEFLAGS_ROOMAUTO
= 0x00000002UL
; // relates to EAXSOURCE_ROOM
457 constexpr auto EAXSOURCEFLAGS_ROOMHFAUTO
= 0x00000004UL
; // relates to EAXSOURCE_ROOMHF
459 constexpr auto EAXSOURCEFLAGS_3DELEVATIONFILTER
= 0x00000008UL
;
461 constexpr auto EAXSOURCEFLAGS_UPMIX
= 0x00000010UL
;
463 constexpr auto EAXSOURCEFLAGS_APPLYSPEAKERLEVELS
= 0x00000020UL
;
465 constexpr auto EAX20SOURCEFLAGS_RESERVED
= 0xFFFFFFF8UL
; // reserved future use
466 constexpr auto EAX50SOURCEFLAGS_RESERVED
= 0xFFFFFFC0UL
; // reserved future use
469 constexpr auto EAXSOURCE_MINSEND
= -10'000L;
470 constexpr auto EAXSOURCE_MAXSEND
= 0L;
471 constexpr auto EAXSOURCE_DEFAULTSEND
= 0L;
473 constexpr auto EAXSOURCE_MINSENDHF
= -10'000L;
474 constexpr auto EAXSOURCE_MAXSENDHF
= 0L;
475 constexpr auto EAXSOURCE_DEFAULTSENDHF
= 0L;
477 constexpr auto EAXSOURCE_MINDIRECT
= -10'000L;
478 constexpr auto EAXSOURCE_MAXDIRECT
= 1'000L;
479 constexpr auto EAXSOURCE_DEFAULTDIRECT
= 0L;
481 constexpr auto EAXSOURCE_MINDIRECTHF
= -10'000L;
482 constexpr auto EAXSOURCE_MAXDIRECTHF
= 0L;
483 constexpr auto EAXSOURCE_DEFAULTDIRECTHF
= 0L;
485 constexpr auto EAXSOURCE_MINROOM
= -10'000L;
486 constexpr auto EAXSOURCE_MAXROOM
= 1'000L;
487 constexpr auto EAXSOURCE_DEFAULTROOM
= 0L;
489 constexpr auto EAXSOURCE_MINROOMHF
= -10'000L;
490 constexpr auto EAXSOURCE_MAXROOMHF
= 0L;
491 constexpr auto EAXSOURCE_DEFAULTROOMHF
= 0L;
493 constexpr auto EAXSOURCE_MINOBSTRUCTION
= -10'000L;
494 constexpr auto EAXSOURCE_MAXOBSTRUCTION
= 0L;
495 constexpr auto EAXSOURCE_DEFAULTOBSTRUCTION
= 0L;
497 constexpr auto EAXSOURCE_MINOBSTRUCTIONLFRATIO
= 0.0F
;
498 constexpr auto EAXSOURCE_MAXOBSTRUCTIONLFRATIO
= 1.0F
;
499 constexpr auto EAXSOURCE_DEFAULTOBSTRUCTIONLFRATIO
= 0.0F
;
501 constexpr auto EAXSOURCE_MINOCCLUSION
= -10'000L;
502 constexpr auto EAXSOURCE_MAXOCCLUSION
= 0L;
503 constexpr auto EAXSOURCE_DEFAULTOCCLUSION
= 0L;
505 constexpr auto EAXSOURCE_MINOCCLUSIONLFRATIO
= 0.0F
;
506 constexpr auto EAXSOURCE_MAXOCCLUSIONLFRATIO
= 1.0F
;
507 constexpr auto EAXSOURCE_DEFAULTOCCLUSIONLFRATIO
= 0.25F
;
509 constexpr auto EAXSOURCE_MINOCCLUSIONROOMRATIO
= 0.0F
;
510 constexpr auto EAXSOURCE_MAXOCCLUSIONROOMRATIO
= 10.0F
;
511 constexpr auto EAXSOURCE_DEFAULTOCCLUSIONROOMRATIO
= 1.5F
;
513 constexpr auto EAXSOURCE_MINOCCLUSIONDIRECTRATIO
= 0.0F
;
514 constexpr auto EAXSOURCE_MAXOCCLUSIONDIRECTRATIO
= 10.0F
;
515 constexpr auto EAXSOURCE_DEFAULTOCCLUSIONDIRECTRATIO
= 1.0F
;
517 constexpr auto EAXSOURCE_MINEXCLUSION
= -10'000L;
518 constexpr auto EAXSOURCE_MAXEXCLUSION
= 0L;
519 constexpr auto EAXSOURCE_DEFAULTEXCLUSION
= 0L;
521 constexpr auto EAXSOURCE_MINEXCLUSIONLFRATIO
= 0.0F
;
522 constexpr auto EAXSOURCE_MAXEXCLUSIONLFRATIO
= 1.0F
;
523 constexpr auto EAXSOURCE_DEFAULTEXCLUSIONLFRATIO
= 1.0F
;
525 constexpr auto EAXSOURCE_MINOUTSIDEVOLUMEHF
= -10'000L;
526 constexpr auto EAXSOURCE_MAXOUTSIDEVOLUMEHF
= 0L;
527 constexpr auto EAXSOURCE_DEFAULTOUTSIDEVOLUMEHF
= 0L;
529 constexpr auto EAXSOURCE_MINDOPPLERFACTOR
= 0.0F
;
530 constexpr auto EAXSOURCE_MAXDOPPLERFACTOR
= 10.0F
;
531 constexpr auto EAXSOURCE_DEFAULTDOPPLERFACTOR
= 1.0F
;
533 constexpr auto EAXSOURCE_MINROLLOFFFACTOR
= 0.0F
;
534 constexpr auto EAXSOURCE_MAXROLLOFFFACTOR
= 10.0F
;
535 constexpr auto EAXSOURCE_DEFAULTROLLOFFFACTOR
= 0.0F
;
537 constexpr auto EAXSOURCE_MINROOMROLLOFFFACTOR
= 0.0F
;
538 constexpr auto EAXSOURCE_MAXROOMROLLOFFFACTOR
= 10.0F
;
539 constexpr auto EAXSOURCE_DEFAULTROOMROLLOFFFACTOR
= 0.0F
;
541 constexpr auto EAXSOURCE_MINAIRABSORPTIONFACTOR
= 0.0F
;
542 constexpr auto EAXSOURCE_MAXAIRABSORPTIONFACTOR
= 10.0F
;
543 constexpr auto EAXSOURCE_DEFAULTAIRABSORPTIONFACTOR
= 0.0F
;
547 constexpr auto EAXSOURCE_MINMACROFXFACTOR
= 0.0F
;
548 constexpr auto EAXSOURCE_MAXMACROFXFACTOR
= 1.0F
;
549 constexpr auto EAXSOURCE_DEFAULTMACROFXFACTOR
= 1.0F
;
553 constexpr auto EAXSOURCE_MINSPEAKERLEVEL
= -10'000L;
554 constexpr auto EAXSOURCE_MAXSPEAKERLEVEL
= 0L;
555 constexpr auto EAXSOURCE_DEFAULTSPEAKERLEVEL
= -10'000L;
557 constexpr auto EAXSOURCE_DEFAULTFLAGS
=
558 EAXSOURCEFLAGS_DIRECTHFAUTO
|
559 EAXSOURCEFLAGS_ROOMAUTO
|
560 EAXSOURCEFLAGS_ROOMHFAUTO
;
565 EAXSPEAKER_FRONT_LEFT
= 1,
566 EAXSPEAKER_FRONT_CENTER
= 2,
567 EAXSPEAKER_FRONT_RIGHT
= 3,
568 EAXSPEAKER_SIDE_RIGHT
= 4,
569 EAXSPEAKER_REAR_RIGHT
= 5,
570 EAXSPEAKER_REAR_CENTER
= 6,
571 EAXSPEAKER_REAR_LEFT
= 7,
572 EAXSPEAKER_SIDE_LEFT
= 8,
573 EAXSPEAKER_LOW_FREQUENCY
= 9
576 // EAXSOURCEFLAGS_DIRECTHFAUTO, EAXSOURCEFLAGS_ROOMAUTO and EAXSOURCEFLAGS_ROOMHFAUTO are ignored for 2D sources
577 // EAXSOURCEFLAGS_UPMIX is ignored for 3D sources
578 constexpr auto EAX50SOURCE_DEFAULTFLAGS
=
579 EAXSOURCEFLAGS_DIRECTHFAUTO
|
580 EAXSOURCEFLAGS_ROOMAUTO
|
581 EAXSOURCEFLAGS_ROOMHFAUTO
|
582 EAXSOURCEFLAGS_UPMIX
;
584 struct EAX30SOURCEPROPERTIES
586 long lDirect
; // direct path level (at low and mid frequencies)
587 long lDirectHF
; // relative direct path level at high frequencies
588 long lRoom
; // room effect level (at low and mid frequencies)
589 long lRoomHF
; // relative room effect level at high frequencies
590 long lObstruction
; // main obstruction control (attenuation at high frequencies)
591 float flObstructionLFRatio
; // obstruction low-frequency level re. main control
592 long lOcclusion
; // main occlusion control (attenuation at high frequencies)
593 float flOcclusionLFRatio
; // occlusion low-frequency level re. main control
594 float flOcclusionRoomRatio
; // relative occlusion control for room effect
595 float flOcclusionDirectRatio
; // relative occlusion control for direct path
596 long lExclusion
; // main exlusion control (attenuation at high frequencies)
597 float flExclusionLFRatio
; // exclusion low-frequency level re. main control
598 long lOutsideVolumeHF
; // outside sound cone level at high frequencies
599 float flDopplerFactor
; // like DS3D flDopplerFactor but per source
600 float flRolloffFactor
; // like DS3D flRolloffFactor but per source
601 float flRoomRolloffFactor
; // like DS3D flRolloffFactor but for room effect
602 float flAirAbsorptionFactor
; // multiplies EAXREVERB_AIRABSORPTIONHF
603 unsigned long ulFlags
; // modifies the behavior of properties
604 }; // EAX30SOURCEPROPERTIES
606 struct EAX50SOURCEPROPERTIES
:
607 public EAX30SOURCEPROPERTIES
609 float flMacroFXFactor
;
610 }; // EAX50SOURCEPROPERTIES
612 struct EAXSOURCEALLSENDPROPERTIES
614 GUID guidReceivingFXSlotID
;
615 long lSend
; // send level (at low and mid frequencies)
616 long lSendHF
; // relative send level at high frequencies
618 float flOcclusionLFRatio
;
619 float flOcclusionRoomRatio
;
620 float flOcclusionDirectRatio
;
622 float flExclusionLFRatio
;
623 }; // EAXSOURCEALLSENDPROPERTIES
625 struct EAXSOURCE2DPROPERTIES
627 long lDirect
; // direct path level (at low and mid frequencies)
628 long lDirectHF
; // relative direct path level at high frequencies
629 long lRoom
; // room effect level (at low and mid frequencies)
630 long lRoomHF
; // relative room effect level at high frequencies
631 unsigned long ulFlags
; // modifies the behavior of properties
632 }; // EAXSOURCE2DPROPERTIES
634 struct EAXSPEAKERLEVELPROPERTIES
638 }; // EAXSPEAKERLEVELPROPERTIES
640 struct EAX40ACTIVEFXSLOTS
642 GUID guidActiveFXSlots
[EAX40_MAX_ACTIVE_FXSLOTS
];
643 }; // EAX40ACTIVEFXSLOTS
645 struct EAX50ACTIVEFXSLOTS
647 GUID guidActiveFXSlots
[EAX50_MAX_ACTIVE_FXSLOTS
];
648 }; // EAX50ACTIVEFXSLOTS
651 const EAX50ACTIVEFXSLOTS
& lhs
,
652 const EAX50ACTIVEFXSLOTS
& rhs
) noexcept
;
655 const EAX50ACTIVEFXSLOTS
& lhs
,
656 const EAX50ACTIVEFXSLOTS
& rhs
) noexcept
;
658 // Use this structure for EAXSOURCE_OBSTRUCTIONPARAMETERS property.
659 struct EAXOBSTRUCTIONPROPERTIES
662 float flObstructionLFRatio
;
663 }; // EAXOBSTRUCTIONPROPERTIES
665 // Use this structure for EAXSOURCE_OCCLUSIONPARAMETERS property.
666 struct EAXOCCLUSIONPROPERTIES
669 float flOcclusionLFRatio
;
670 float flOcclusionRoomRatio
;
671 float flOcclusionDirectRatio
;
672 }; // EAXOCCLUSIONPROPERTIES
674 // Use this structure for EAXSOURCE_EXCLUSIONPARAMETERS property.
675 struct EAXEXCLUSIONPROPERTIES
678 float flExclusionLFRatio
;
679 }; // EAXEXCLUSIONPROPERTIES
681 // Use this structure for EAXSOURCE_SENDPARAMETERS properties.
682 struct EAXSOURCESENDPROPERTIES
684 GUID guidReceivingFXSlotID
;
687 }; // EAXSOURCESENDPROPERTIES
689 // Use this structure for EAXSOURCE_OCCLUSIONSENDPARAMETERS
690 struct EAXSOURCEOCCLUSIONSENDPROPERTIES
692 GUID guidReceivingFXSlotID
;
694 float flOcclusionLFRatio
;
695 float flOcclusionRoomRatio
;
696 float flOcclusionDirectRatio
;
697 }; // EAXSOURCEOCCLUSIONSENDPROPERTIES
699 // Use this structure for EAXSOURCE_EXCLUSIONSENDPARAMETERS
700 struct EAXSOURCEEXCLUSIONSENDPROPERTIES
702 GUID guidReceivingFXSlotID
;
704 float flExclusionLFRatio
;
705 }; // EAXSOURCEEXCLUSIONSENDPROPERTIES
707 extern const EAX50ACTIVEFXSLOTS EAX40SOURCE_DEFAULTACTIVEFXSLOTID
;
709 extern const EAX50ACTIVEFXSLOTS EAX50SOURCE_3DDEFAULTACTIVEFXSLOTID
;
711 extern const EAX50ACTIVEFXSLOTS EAX50SOURCE_2DDEFAULTACTIVEFXSLOTID
;
716 extern const GUID EAX_REVERB_EFFECT
;
718 // Reverb effect properties
719 enum EAXREVERB_PROPERTY
:
723 EAXREVERB_ALLPARAMETERS
,
724 EAXREVERB_ENVIRONMENT
,
725 EAXREVERB_ENVIRONMENTSIZE
,
726 EAXREVERB_ENVIRONMENTDIFFUSION
,
731 EAXREVERB_DECAYHFRATIO
,
732 EAXREVERB_DECAYLFRATIO
,
733 EAXREVERB_REFLECTIONS
,
734 EAXREVERB_REFLECTIONSDELAY
,
735 EAXREVERB_REFLECTIONSPAN
,
737 EAXREVERB_REVERBDELAY
,
741 EAXREVERB_MODULATIONTIME
,
742 EAXREVERB_MODULATIONDEPTH
,
743 EAXREVERB_AIRABSORPTIONHF
,
744 EAXREVERB_HFREFERENCE
,
745 EAXREVERB_LFREFERENCE
,
746 EAXREVERB_ROOMROLLOFFFACTOR
,
748 }; // EAXREVERB_PROPERTY
750 // used by EAXREVERB_ENVIRONMENT
754 EAX_ENVIRONMENT_GENERIC
,
755 EAX_ENVIRONMENT_PADDEDCELL
,
756 EAX_ENVIRONMENT_ROOM
,
757 EAX_ENVIRONMENT_BATHROOM
,
758 EAX_ENVIRONMENT_LIVINGROOM
,
759 EAX_ENVIRONMENT_STONEROOM
,
760 EAX_ENVIRONMENT_AUDITORIUM
,
761 EAX_ENVIRONMENT_CONCERTHALL
,
762 EAX_ENVIRONMENT_CAVE
,
763 EAX_ENVIRONMENT_ARENA
,
764 EAX_ENVIRONMENT_HANGAR
,
765 EAX_ENVIRONMENT_CARPETEDHALLWAY
,
766 EAX_ENVIRONMENT_HALLWAY
,
767 EAX_ENVIRONMENT_STONECORRIDOR
,
768 EAX_ENVIRONMENT_ALLEY
,
769 EAX_ENVIRONMENT_FOREST
,
770 EAX_ENVIRONMENT_CITY
,
771 EAX_ENVIRONMENT_MOUNTAINS
,
772 EAX_ENVIRONMENT_QUARRY
,
773 EAX_ENVIRONMENT_PLAIN
,
774 EAX_ENVIRONMENT_PARKINGLOT
,
775 EAX_ENVIRONMENT_SEWERPIPE
,
776 EAX_ENVIRONMENT_UNDERWATER
,
777 EAX_ENVIRONMENT_DRUGGED
,
778 EAX_ENVIRONMENT_DIZZY
,
779 EAX_ENVIRONMENT_PSYCHOTIC
,
781 EAX1_ENVIRONMENT_COUNT
,
784 EAX_ENVIRONMENT_UNDEFINED
= EAX1_ENVIRONMENT_COUNT
,
786 EAX3_ENVIRONMENT_COUNT
,
790 // reverberation decay time
791 constexpr auto EAXREVERBFLAGS_DECAYTIMESCALE
= 0x00000001UL
;
794 constexpr auto EAXREVERBFLAGS_REFLECTIONSSCALE
= 0x00000002UL
;
796 // initial reflection delay time
797 constexpr auto EAXREVERBFLAGS_REFLECTIONSDELAYSCALE
= 0x00000004UL
;
800 constexpr auto EAXREVERBFLAGS_REVERBSCALE
= 0x00000008UL
;
802 // late reverberation delay time
803 constexpr auto EAXREVERBFLAGS_REVERBDELAYSCALE
= 0x00000010UL
;
807 constexpr auto EAXREVERBFLAGS_ECHOTIMESCALE
= 0x00000040UL
;
811 constexpr auto EAXREVERBFLAGS_MODULATIONTIMESCALE
= 0x00000080UL
;
813 // This flag limits high-frequency decay time according to air absorption.
814 constexpr auto EAXREVERBFLAGS_DECAYHFLIMIT
= 0x00000020UL
;
816 constexpr auto EAXREVERBFLAGS_RESERVED
= 0xFFFFFF00UL
; // reserved future use
819 struct EAXREVERBPROPERTIES
821 unsigned long ulEnvironment
; // sets all reverb properties
822 float flEnvironmentSize
; // environment size in meters
823 float flEnvironmentDiffusion
; // environment diffusion
824 long lRoom
; // room effect level (at mid frequencies)
825 long lRoomHF
; // relative room effect level at high frequencies
826 long lRoomLF
; // relative room effect level at low frequencies
827 float flDecayTime
; // reverberation decay time at mid frequencies
828 float flDecayHFRatio
; // high-frequency to mid-frequency decay time ratio
829 float flDecayLFRatio
; // low-frequency to mid-frequency decay time ratio
830 long lReflections
; // early reflections level relative to room effect
831 float flReflectionsDelay
; // initial reflection delay time
832 EAXVECTOR vReflectionsPan
; // early reflections panning vector
833 long lReverb
; // late reverberation level relative to room effect
834 float flReverbDelay
; // late reverberation delay time relative to initial reflection
835 EAXVECTOR vReverbPan
; // late reverberation panning vector
836 float flEchoTime
; // echo time
837 float flEchoDepth
; // echo depth
838 float flModulationTime
; // modulation time
839 float flModulationDepth
; // modulation depth
840 float flAirAbsorptionHF
; // change in level per meter at high frequencies
841 float flHFReference
; // reference high frequency
842 float flLFReference
; // reference low frequency
843 float flRoomRolloffFactor
; // like DS3D flRolloffFactor but for room effect
844 unsigned long ulFlags
; // modifies the behavior of properties
845 }; // EAXREVERBPROPERTIES
848 const EAXREVERBPROPERTIES
& lhs
,
849 const EAXREVERBPROPERTIES
& rhs
) noexcept
;
852 const EAXREVERBPROPERTIES
& lhs
,
853 const EAXREVERBPROPERTIES
& rhs
) noexcept
;
856 constexpr auto EAXREVERB_MINENVIRONMENT
= static_cast<unsigned long>(EAX_ENVIRONMENT_GENERIC
);
857 constexpr auto EAX1REVERB_MAXENVIRONMENT
= static_cast<unsigned long>(EAX_ENVIRONMENT_PSYCHOTIC
);
858 constexpr auto EAX30REVERB_MAXENVIRONMENT
= static_cast<unsigned long>(EAX_ENVIRONMENT_UNDEFINED
);
859 constexpr auto EAXREVERB_DEFAULTENVIRONMENT
= static_cast<unsigned long>(EAX_ENVIRONMENT_GENERIC
);
861 constexpr auto EAXREVERB_MINENVIRONMENTSIZE
= 1.0F
;
862 constexpr auto EAXREVERB_MAXENVIRONMENTSIZE
= 100.0F
;
863 constexpr auto EAXREVERB_DEFAULTENVIRONMENTSIZE
= 7.5F
;
865 constexpr auto EAXREVERB_MINENVIRONMENTDIFFUSION
= 0.0F
;
866 constexpr auto EAXREVERB_MAXENVIRONMENTDIFFUSION
= 1.0F
;
867 constexpr auto EAXREVERB_DEFAULTENVIRONMENTDIFFUSION
= 1.0F
;
869 constexpr auto EAXREVERB_MINROOM
= -10'000L;
870 constexpr auto EAXREVERB_MAXROOM
= 0L;
871 constexpr auto EAXREVERB_DEFAULTROOM
= -1'000L;
873 constexpr auto EAXREVERB_MINROOMHF
= -10'000L;
874 constexpr auto EAXREVERB_MAXROOMHF
= 0L;
875 constexpr auto EAXREVERB_DEFAULTROOMHF
= -100L;
877 constexpr auto EAXREVERB_MINROOMLF
= -10'000L;
878 constexpr auto EAXREVERB_MAXROOMLF
= 0L;
879 constexpr auto EAXREVERB_DEFAULTROOMLF
= 0L;
881 constexpr auto EAXREVERB_MINDECAYTIME
= 0.1F
;
882 constexpr auto EAXREVERB_MAXDECAYTIME
= 20.0F
;
883 constexpr auto EAXREVERB_DEFAULTDECAYTIME
= 1.49F
;
885 constexpr auto EAXREVERB_MINDECAYHFRATIO
= 0.1F
;
886 constexpr auto EAXREVERB_MAXDECAYHFRATIO
= 2.0F
;
887 constexpr auto EAXREVERB_DEFAULTDECAYHFRATIO
= 0.83F
;
889 constexpr auto EAXREVERB_MINDECAYLFRATIO
= 0.1F
;
890 constexpr auto EAXREVERB_MAXDECAYLFRATIO
= 2.0F
;
891 constexpr auto EAXREVERB_DEFAULTDECAYLFRATIO
= 1.0F
;
893 constexpr auto EAXREVERB_MINREFLECTIONS
= -10'000L;
894 constexpr auto EAXREVERB_MAXREFLECTIONS
= 1'000L;
895 constexpr auto EAXREVERB_DEFAULTREFLECTIONS
= -2'602L;
897 constexpr auto EAXREVERB_MINREFLECTIONSDELAY
= 0.0F
;
898 constexpr auto EAXREVERB_MAXREFLECTIONSDELAY
= 0.3F
;
899 constexpr auto EAXREVERB_DEFAULTREFLECTIONSDELAY
= 0.007F
;
901 constexpr auto EAXREVERB_DEFAULTREFLECTIONSPAN
= EAXVECTOR
{0.0F
, 0.0F
, 0.0F
};
903 constexpr auto EAXREVERB_MINREVERB
= -10'000L;
904 constexpr auto EAXREVERB_MAXREVERB
= 2'000L;
905 constexpr auto EAXREVERB_DEFAULTREVERB
= 200L;
907 constexpr auto EAXREVERB_MINREVERBDELAY
= 0.0F
;
908 constexpr auto EAXREVERB_MAXREVERBDELAY
= 0.1F
;
909 constexpr auto EAXREVERB_DEFAULTREVERBDELAY
= 0.011F
;
911 constexpr auto EAXREVERB_DEFAULTREVERBPAN
= EAXVECTOR
{0.0F
, 0.0F
, 0.0F
};
913 constexpr auto EAXREVERB_MINECHOTIME
= 0.075F
;
914 constexpr auto EAXREVERB_MAXECHOTIME
= 0.25F
;
915 constexpr auto EAXREVERB_DEFAULTECHOTIME
= 0.25F
;
917 constexpr auto EAXREVERB_MINECHODEPTH
= 0.0F
;
918 constexpr auto EAXREVERB_MAXECHODEPTH
= 1.0F
;
919 constexpr auto EAXREVERB_DEFAULTECHODEPTH
= 0.0F
;
921 constexpr auto EAXREVERB_MINMODULATIONTIME
= 0.04F
;
922 constexpr auto EAXREVERB_MAXMODULATIONTIME
= 4.0F
;
923 constexpr auto EAXREVERB_DEFAULTMODULATIONTIME
= 0.25F
;
925 constexpr auto EAXREVERB_MINMODULATIONDEPTH
= 0.0F
;
926 constexpr auto EAXREVERB_MAXMODULATIONDEPTH
= 1.0F
;
927 constexpr auto EAXREVERB_DEFAULTMODULATIONDEPTH
= 0.0F
;
929 constexpr auto EAXREVERB_MINAIRABSORPTIONHF
= -100.0F
;
930 constexpr auto EAXREVERB_MAXAIRABSORPTIONHF
= 0.0F
;
931 constexpr auto EAXREVERB_DEFAULTAIRABSORPTIONHF
= -5.0F
;
933 constexpr auto EAXREVERB_MINHFREFERENCE
= 1'000.0F
;
934 constexpr auto EAXREVERB_MAXHFREFERENCE
= 20'000.0F
;
935 constexpr auto EAXREVERB_DEFAULTHFREFERENCE
= 5'000.0F
;
937 constexpr auto EAXREVERB_MINLFREFERENCE
= 20.0F
;
938 constexpr auto EAXREVERB_MAXLFREFERENCE
= 1'000.0F
;
939 constexpr auto EAXREVERB_DEFAULTLFREFERENCE
= 250.0F
;
941 constexpr auto EAXREVERB_MINROOMROLLOFFFACTOR
= 0.0F
;
942 constexpr auto EAXREVERB_MAXROOMROLLOFFFACTOR
= 10.0F
;
943 constexpr auto EAXREVERB_DEFAULTROOMROLLOFFFACTOR
= 0.0F
;
945 constexpr auto EAX1REVERB_MINVOLUME
= 0.0F
;
946 constexpr auto EAX1REVERB_MAXVOLUME
= 1.0F
;
948 constexpr auto EAX1REVERB_MINDAMPING
= 0.0F
;
949 constexpr auto EAX1REVERB_MAXDAMPING
= 2.0F
;
951 constexpr auto EAXREVERB_DEFAULTFLAGS
=
952 EAXREVERBFLAGS_DECAYTIMESCALE
|
953 EAXREVERBFLAGS_REFLECTIONSSCALE
|
954 EAXREVERBFLAGS_REFLECTIONSDELAYSCALE
|
955 EAXREVERBFLAGS_REVERBSCALE
|
956 EAXREVERBFLAGS_REVERBDELAYSCALE
|
957 EAXREVERBFLAGS_DECAYHFLIMIT
;
960 using EaxReverbPresets
= std::array
<EAXREVERBPROPERTIES
, EAX1_ENVIRONMENT_COUNT
>;
961 extern const EaxReverbPresets EAXREVERB_PRESETS
;
964 using Eax1ReverbPresets
= std::array
<EAX_REVERBPROPERTIES
, EAX1_ENVIRONMENT_COUNT
>;
965 extern const Eax1ReverbPresets EAX1REVERB_PRESETS
;
968 // AGC Compressor Effect
970 extern const GUID EAX_AGCCOMPRESSOR_EFFECT
;
972 enum EAXAGCCOMPRESSOR_PROPERTY
:
975 EAXAGCCOMPRESSOR_NONE
,
976 EAXAGCCOMPRESSOR_ALLPARAMETERS
,
977 EAXAGCCOMPRESSOR_ONOFF
,
978 }; // EAXAGCCOMPRESSOR_PROPERTY
980 struct EAXAGCCOMPRESSORPROPERTIES
982 unsigned long ulOnOff
; // Switch Compressor on or off
983 }; // EAXAGCCOMPRESSORPROPERTIES
986 constexpr auto EAXAGCCOMPRESSOR_MINONOFF
= 0UL;
987 constexpr auto EAXAGCCOMPRESSOR_MAXONOFF
= 1UL;
988 constexpr auto EAXAGCCOMPRESSOR_DEFAULTONOFF
= EAXAGCCOMPRESSOR_MAXONOFF
;
993 extern const GUID EAX_AUTOWAH_EFFECT
;
995 enum EAXAUTOWAH_PROPERTY
:
999 EAXAUTOWAH_ALLPARAMETERS
,
1000 EAXAUTOWAH_ATTACKTIME
,
1001 EAXAUTOWAH_RELEASETIME
,
1002 EAXAUTOWAH_RESONANCE
,
1003 EAXAUTOWAH_PEAKLEVEL
,
1004 }; // EAXAUTOWAH_PROPERTY
1006 struct EAXAUTOWAHPROPERTIES
1008 float flAttackTime
; // Attack time (seconds)
1009 float flReleaseTime
; // Release time (seconds)
1010 long lResonance
; // Resonance (mB)
1011 long lPeakLevel
; // Peak level (mB)
1012 }; // EAXAUTOWAHPROPERTIES
1015 constexpr auto EAXAUTOWAH_MINATTACKTIME
= 0.0001F
;
1016 constexpr auto EAXAUTOWAH_MAXATTACKTIME
= 1.0F
;
1017 constexpr auto EAXAUTOWAH_DEFAULTATTACKTIME
= 0.06F
;
1019 constexpr auto EAXAUTOWAH_MINRELEASETIME
= 0.0001F
;
1020 constexpr auto EAXAUTOWAH_MAXRELEASETIME
= 1.0F
;
1021 constexpr auto EAXAUTOWAH_DEFAULTRELEASETIME
= 0.06F
;
1023 constexpr auto EAXAUTOWAH_MINRESONANCE
= 600L;
1024 constexpr auto EAXAUTOWAH_MAXRESONANCE
= 6000L;
1025 constexpr auto EAXAUTOWAH_DEFAULTRESONANCE
= 6000L;
1027 constexpr auto EAXAUTOWAH_MINPEAKLEVEL
= -9000L;
1028 constexpr auto EAXAUTOWAH_MAXPEAKLEVEL
= 9000L;
1029 constexpr auto EAXAUTOWAH_DEFAULTPEAKLEVEL
= 2100L;
1034 extern const GUID EAX_CHORUS_EFFECT
;
1037 enum EAXCHORUS_PROPERTY
:
1041 EAXCHORUS_ALLPARAMETERS
,
1048 }; // EAXCHORUS_PROPERTY
1053 EAX_CHORUS_SINUSOID
,
1054 EAX_CHORUS_TRIANGLE
,
1057 struct EAXCHORUSPROPERTIES
1059 unsigned long ulWaveform
; // Waveform selector - see enum above
1060 long lPhase
; // Phase (Degrees)
1061 float flRate
; // Rate (Hz)
1062 float flDepth
; // Depth (0 to 1)
1063 float flFeedback
; // Feedback (-1 to 1)
1064 float flDelay
; // Delay (seconds)
1065 }; // EAXCHORUSPROPERTIES
1068 constexpr auto EAXCHORUS_MINWAVEFORM
= 0UL;
1069 constexpr auto EAXCHORUS_MAXWAVEFORM
= 1UL;
1070 constexpr auto EAXCHORUS_DEFAULTWAVEFORM
= 1UL;
1072 constexpr auto EAXCHORUS_MINPHASE
= -180L;
1073 constexpr auto EAXCHORUS_MAXPHASE
= 180L;
1074 constexpr auto EAXCHORUS_DEFAULTPHASE
= 90L;
1076 constexpr auto EAXCHORUS_MINRATE
= 0.0F
;
1077 constexpr auto EAXCHORUS_MAXRATE
= 10.0F
;
1078 constexpr auto EAXCHORUS_DEFAULTRATE
= 1.1F
;
1080 constexpr auto EAXCHORUS_MINDEPTH
= 0.0F
;
1081 constexpr auto EAXCHORUS_MAXDEPTH
= 1.0F
;
1082 constexpr auto EAXCHORUS_DEFAULTDEPTH
= 0.1F
;
1084 constexpr auto EAXCHORUS_MINFEEDBACK
= -1.0F
;
1085 constexpr auto EAXCHORUS_MAXFEEDBACK
= 1.0F
;
1086 constexpr auto EAXCHORUS_DEFAULTFEEDBACK
= 0.25F
;
1088 constexpr auto EAXCHORUS_MINDELAY
= 0.0002F
;
1089 constexpr auto EAXCHORUS_MAXDELAY
= 0.016F
;
1090 constexpr auto EAXCHORUS_DEFAULTDELAY
= 0.016F
;
1093 // Distortion Effect
1095 extern const GUID EAX_DISTORTION_EFFECT
;
1097 enum EAXDISTORTION_PROPERTY
:
1101 EAXDISTORTION_ALLPARAMETERS
,
1104 EAXDISTORTION_LOWPASSCUTOFF
,
1105 EAXDISTORTION_EQCENTER
,
1106 EAXDISTORTION_EQBANDWIDTH
,
1107 }; // EAXDISTORTION_PROPERTY
1110 struct EAXDISTORTIONPROPERTIES
1112 float flEdge
; // Controls the shape of the distortion (0 to 1)
1113 long lGain
; // Controls the post distortion gain (mB)
1114 float flLowPassCutOff
; // Controls the cut-off of the filter pre-distortion (Hz)
1115 float flEQCenter
; // Controls the center frequency of the EQ post-distortion (Hz)
1116 float flEQBandwidth
; // Controls the bandwidth of the EQ post-distortion (Hz)
1117 }; // EAXDISTORTIONPROPERTIES
1120 constexpr auto EAXDISTORTION_MINEDGE
= 0.0F
;
1121 constexpr auto EAXDISTORTION_MAXEDGE
= 1.0F
;
1122 constexpr auto EAXDISTORTION_DEFAULTEDGE
= 0.2F
;
1124 constexpr auto EAXDISTORTION_MINGAIN
= -6000L;
1125 constexpr auto EAXDISTORTION_MAXGAIN
= 0L;
1126 constexpr auto EAXDISTORTION_DEFAULTGAIN
= -2600L;
1128 constexpr auto EAXDISTORTION_MINLOWPASSCUTOFF
= 80.0F
;
1129 constexpr auto EAXDISTORTION_MAXLOWPASSCUTOFF
= 24000.0F
;
1130 constexpr auto EAXDISTORTION_DEFAULTLOWPASSCUTOFF
= 8000.0F
;
1132 constexpr auto EAXDISTORTION_MINEQCENTER
= 80.0F
;
1133 constexpr auto EAXDISTORTION_MAXEQCENTER
= 24000.0F
;
1134 constexpr auto EAXDISTORTION_DEFAULTEQCENTER
= 3600.0F
;
1136 constexpr auto EAXDISTORTION_MINEQBANDWIDTH
= 80.0F
;
1137 constexpr auto EAXDISTORTION_MAXEQBANDWIDTH
= 24000.0F
;
1138 constexpr auto EAXDISTORTION_DEFAULTEQBANDWIDTH
= 3600.0F
;
1143 extern const GUID EAX_ECHO_EFFECT
;
1146 enum EAXECHO_PROPERTY
:
1150 EAXECHO_ALLPARAMETERS
,
1156 }; // EAXECHO_PROPERTY
1159 struct EAXECHOPROPERTIES
1161 float flDelay
; // Controls the initial delay time (seconds)
1162 float flLRDelay
; // Controls the delay time between the first and second taps (seconds)
1163 float flDamping
; // Controls a low-pass filter that dampens the echoes (0 to 1)
1164 float flFeedback
; // Controls the duration of echo repetition (0 to 1)
1165 float flSpread
; // Controls the left-right spread of the echoes
1166 }; // EAXECHOPROPERTIES
1169 constexpr auto EAXECHO_MINDAMPING
= 0.0F
;
1170 constexpr auto EAXECHO_MAXDAMPING
= 0.99F
;
1171 constexpr auto EAXECHO_DEFAULTDAMPING
= 0.5F
;
1173 constexpr auto EAXECHO_MINDELAY
= 0.002F
;
1174 constexpr auto EAXECHO_MAXDELAY
= 0.207F
;
1175 constexpr auto EAXECHO_DEFAULTDELAY
= 0.1F
;
1177 constexpr auto EAXECHO_MINLRDELAY
= 0.0F
;
1178 constexpr auto EAXECHO_MAXLRDELAY
= 0.404F
;
1179 constexpr auto EAXECHO_DEFAULTLRDELAY
= 0.1F
;
1181 constexpr auto EAXECHO_MINFEEDBACK
= 0.0F
;
1182 constexpr auto EAXECHO_MAXFEEDBACK
= 1.0F
;
1183 constexpr auto EAXECHO_DEFAULTFEEDBACK
= 0.5F
;
1185 constexpr auto EAXECHO_MINSPREAD
= -1.0F
;
1186 constexpr auto EAXECHO_MAXSPREAD
= 1.0F
;
1187 constexpr auto EAXECHO_DEFAULTSPREAD
= -1.0F
;
1192 extern const GUID EAX_EQUALIZER_EFFECT
;
1195 enum EAXEQUALIZER_PROPERTY
:
1199 EAXEQUALIZER_ALLPARAMETERS
,
1200 EAXEQUALIZER_LOWGAIN
,
1201 EAXEQUALIZER_LOWCUTOFF
,
1202 EAXEQUALIZER_MID1GAIN
,
1203 EAXEQUALIZER_MID1CENTER
,
1204 EAXEQUALIZER_MID1WIDTH
,
1205 EAXEQUALIZER_MID2GAIN
,
1206 EAXEQUALIZER_MID2CENTER
,
1207 EAXEQUALIZER_MID2WIDTH
,
1208 EAXEQUALIZER_HIGHGAIN
,
1209 EAXEQUALIZER_HIGHCUTOFF
,
1210 }; // EAXEQUALIZER_PROPERTY
1213 struct EAXEQUALIZERPROPERTIES
1215 long lLowGain
; // (mB)
1216 float flLowCutOff
; // (Hz)
1217 long lMid1Gain
; // (mB)
1218 float flMid1Center
; // (Hz)
1219 float flMid1Width
; // (octaves)
1220 long lMid2Gain
; // (mB)
1221 float flMid2Center
; // (Hz)
1222 float flMid2Width
; // (octaves)
1223 long lHighGain
; // (mB)
1224 float flHighCutOff
; // (Hz)
1225 }; // EAXEQUALIZERPROPERTIES
1228 constexpr auto EAXEQUALIZER_MINLOWGAIN
= -1800L;
1229 constexpr auto EAXEQUALIZER_MAXLOWGAIN
= 1800L;
1230 constexpr auto EAXEQUALIZER_DEFAULTLOWGAIN
= 0L;
1232 constexpr auto EAXEQUALIZER_MINLOWCUTOFF
= 50.0F
;
1233 constexpr auto EAXEQUALIZER_MAXLOWCUTOFF
= 800.0F
;
1234 constexpr auto EAXEQUALIZER_DEFAULTLOWCUTOFF
= 200.0F
;
1236 constexpr auto EAXEQUALIZER_MINMID1GAIN
= -1800L;
1237 constexpr auto EAXEQUALIZER_MAXMID1GAIN
= 1800L;
1238 constexpr auto EAXEQUALIZER_DEFAULTMID1GAIN
= 0L;
1240 constexpr auto EAXEQUALIZER_MINMID1CENTER
= 200.0F
;
1241 constexpr auto EAXEQUALIZER_MAXMID1CENTER
= 3000.0F
;
1242 constexpr auto EAXEQUALIZER_DEFAULTMID1CENTER
= 500.0F
;
1244 constexpr auto EAXEQUALIZER_MINMID1WIDTH
= 0.01F
;
1245 constexpr auto EAXEQUALIZER_MAXMID1WIDTH
= 1.0F
;
1246 constexpr auto EAXEQUALIZER_DEFAULTMID1WIDTH
= 1.0F
;
1248 constexpr auto EAXEQUALIZER_MINMID2GAIN
= -1800L;
1249 constexpr auto EAXEQUALIZER_MAXMID2GAIN
= 1800L;
1250 constexpr auto EAXEQUALIZER_DEFAULTMID2GAIN
= 0L;
1252 constexpr auto EAXEQUALIZER_MINMID2CENTER
= 1000.0F
;
1253 constexpr auto EAXEQUALIZER_MAXMID2CENTER
= 8000.0F
;
1254 constexpr auto EAXEQUALIZER_DEFAULTMID2CENTER
= 3000.0F
;
1256 constexpr auto EAXEQUALIZER_MINMID2WIDTH
= 0.01F
;
1257 constexpr auto EAXEQUALIZER_MAXMID2WIDTH
= 1.0F
;
1258 constexpr auto EAXEQUALIZER_DEFAULTMID2WIDTH
= 1.0F
;
1260 constexpr auto EAXEQUALIZER_MINHIGHGAIN
= -1800L;
1261 constexpr auto EAXEQUALIZER_MAXHIGHGAIN
= 1800L;
1262 constexpr auto EAXEQUALIZER_DEFAULTHIGHGAIN
= 0L;
1264 constexpr auto EAXEQUALIZER_MINHIGHCUTOFF
= 4000.0F
;
1265 constexpr auto EAXEQUALIZER_MAXHIGHCUTOFF
= 16000.0F
;
1266 constexpr auto EAXEQUALIZER_DEFAULTHIGHCUTOFF
= 6000.0F
;
1271 extern const GUID EAX_FLANGER_EFFECT
;
1273 enum EAXFLANGER_PROPERTY
:
1277 EAXFLANGER_ALLPARAMETERS
,
1278 EAXFLANGER_WAVEFORM
,
1282 EAXFLANGER_FEEDBACK
,
1284 }; // EAXFLANGER_PROPERTY
1289 EAX_FLANGER_SINUSOID
,
1290 EAX_FLANGER_TRIANGLE
,
1293 struct EAXFLANGERPROPERTIES
1295 unsigned long ulWaveform
; // Waveform selector - see enum above
1296 long lPhase
; // Phase (Degrees)
1297 float flRate
; // Rate (Hz)
1298 float flDepth
; // Depth (0 to 1)
1299 float flFeedback
; // Feedback (0 to 1)
1300 float flDelay
; // Delay (seconds)
1301 }; // EAXFLANGERPROPERTIES
1304 constexpr auto EAXFLANGER_MINWAVEFORM
= 0UL;
1305 constexpr auto EAXFLANGER_MAXWAVEFORM
= 1UL;
1306 constexpr auto EAXFLANGER_DEFAULTWAVEFORM
= 1UL;
1308 constexpr auto EAXFLANGER_MINPHASE
= -180L;
1309 constexpr auto EAXFLANGER_MAXPHASE
= 180L;
1310 constexpr auto EAXFLANGER_DEFAULTPHASE
= 0L;
1312 constexpr auto EAXFLANGER_MINRATE
= 0.0F
;
1313 constexpr auto EAXFLANGER_MAXRATE
= 10.0F
;
1314 constexpr auto EAXFLANGER_DEFAULTRATE
= 0.27F
;
1316 constexpr auto EAXFLANGER_MINDEPTH
= 0.0F
;
1317 constexpr auto EAXFLANGER_MAXDEPTH
= 1.0F
;
1318 constexpr auto EAXFLANGER_DEFAULTDEPTH
= 1.0F
;
1320 constexpr auto EAXFLANGER_MINFEEDBACK
= -1.0F
;
1321 constexpr auto EAXFLANGER_MAXFEEDBACK
= 1.0F
;
1322 constexpr auto EAXFLANGER_DEFAULTFEEDBACK
= -0.5F
;
1324 constexpr auto EAXFLANGER_MINDELAY
= 0.0002F
;
1325 constexpr auto EAXFLANGER_MAXDELAY
= 0.004F
;
1326 constexpr auto EAXFLANGER_DEFAULTDELAY
= 0.002F
;
1329 // Frequency Shifter Effect
1331 extern const GUID EAX_FREQUENCYSHIFTER_EFFECT
;
1333 enum EAXFREQUENCYSHIFTER_PROPERTY
:
1336 EAXFREQUENCYSHIFTER_NONE
,
1337 EAXFREQUENCYSHIFTER_ALLPARAMETERS
,
1338 EAXFREQUENCYSHIFTER_FREQUENCY
,
1339 EAXFREQUENCYSHIFTER_LEFTDIRECTION
,
1340 EAXFREQUENCYSHIFTER_RIGHTDIRECTION
,
1341 }; // EAXFREQUENCYSHIFTER_PROPERTY
1346 EAX_FREQUENCYSHIFTER_DOWN
,
1347 EAX_FREQUENCYSHIFTER_UP
,
1348 EAX_FREQUENCYSHIFTER_OFF
1351 struct EAXFREQUENCYSHIFTERPROPERTIES
1353 float flFrequency
; // (Hz)
1354 unsigned long ulLeftDirection
; // see enum above
1355 unsigned long ulRightDirection
; // see enum above
1356 }; // EAXFREQUENCYSHIFTERPROPERTIES
1359 constexpr auto EAXFREQUENCYSHIFTER_MINFREQUENCY
= 0.0F
;
1360 constexpr auto EAXFREQUENCYSHIFTER_MAXFREQUENCY
= 24000.0F
;
1361 constexpr auto EAXFREQUENCYSHIFTER_DEFAULTFREQUENCY
= EAXFREQUENCYSHIFTER_MINFREQUENCY
;
1363 constexpr auto EAXFREQUENCYSHIFTER_MINLEFTDIRECTION
= 0UL;
1364 constexpr auto EAXFREQUENCYSHIFTER_MAXLEFTDIRECTION
= 2UL;
1365 constexpr auto EAXFREQUENCYSHIFTER_DEFAULTLEFTDIRECTION
= EAXFREQUENCYSHIFTER_MINLEFTDIRECTION
;
1367 constexpr auto EAXFREQUENCYSHIFTER_MINRIGHTDIRECTION
= 0UL;
1368 constexpr auto EAXFREQUENCYSHIFTER_MAXRIGHTDIRECTION
= 2UL;
1369 constexpr auto EAXFREQUENCYSHIFTER_DEFAULTRIGHTDIRECTION
= EAXFREQUENCYSHIFTER_MINRIGHTDIRECTION
;
1372 // Vocal Morpher Effect
1374 extern const GUID EAX_VOCALMORPHER_EFFECT
;
1376 enum EAXVOCALMORPHER_PROPERTY
:
1379 EAXVOCALMORPHER_NONE
,
1380 EAXVOCALMORPHER_ALLPARAMETERS
,
1381 EAXVOCALMORPHER_PHONEMEA
,
1382 EAXVOCALMORPHER_PHONEMEACOARSETUNING
,
1383 EAXVOCALMORPHER_PHONEMEB
,
1384 EAXVOCALMORPHER_PHONEMEBCOARSETUNING
,
1385 EAXVOCALMORPHER_WAVEFORM
,
1386 EAXVOCALMORPHER_RATE
,
1387 }; // EAXVOCALMORPHER_PROPERTY
1427 EAX_VOCALMORPHER_SINUSOID
,
1428 EAX_VOCALMORPHER_TRIANGLE
,
1429 EAX_VOCALMORPHER_SAWTOOTH
1432 // Use this structure for EAXVOCALMORPHER_ALLPARAMETERS
1433 struct EAXVOCALMORPHERPROPERTIES
1435 unsigned long ulPhonemeA
; // see enum above
1436 long lPhonemeACoarseTuning
; // (semitones)
1437 unsigned long ulPhonemeB
; // see enum above
1438 long lPhonemeBCoarseTuning
; // (semitones)
1439 unsigned long ulWaveform
; // Waveform selector - see enum above
1440 float flRate
; // (Hz)
1441 }; // EAXVOCALMORPHERPROPERTIES
1444 constexpr auto EAXVOCALMORPHER_MINPHONEMEA
= 0UL;
1445 constexpr auto EAXVOCALMORPHER_MAXPHONEMEA
= 29UL;
1446 constexpr auto EAXVOCALMORPHER_DEFAULTPHONEMEA
= EAXVOCALMORPHER_MINPHONEMEA
;
1448 constexpr auto EAXVOCALMORPHER_MINPHONEMEACOARSETUNING
= -24L;
1449 constexpr auto EAXVOCALMORPHER_MAXPHONEMEACOARSETUNING
= 24L;
1450 constexpr auto EAXVOCALMORPHER_DEFAULTPHONEMEACOARSETUNING
= 0L;
1452 constexpr auto EAXVOCALMORPHER_MINPHONEMEB
= 0UL;
1453 constexpr auto EAXVOCALMORPHER_MAXPHONEMEB
= 29UL;
1454 constexpr auto EAXVOCALMORPHER_DEFAULTPHONEMEB
= 10UL;
1456 constexpr auto EAXVOCALMORPHER_MINPHONEMEBCOARSETUNING
= -24L;
1457 constexpr auto EAXVOCALMORPHER_MAXPHONEMEBCOARSETUNING
= 24L;
1458 constexpr auto EAXVOCALMORPHER_DEFAULTPHONEMEBCOARSETUNING
= 0L;
1460 constexpr auto EAXVOCALMORPHER_MINWAVEFORM
= 0UL;
1461 constexpr auto EAXVOCALMORPHER_MAXWAVEFORM
= 2UL;
1462 constexpr auto EAXVOCALMORPHER_DEFAULTWAVEFORM
= EAXVOCALMORPHER_MINWAVEFORM
;
1464 constexpr auto EAXVOCALMORPHER_MINRATE
= 0.0F
;
1465 constexpr auto EAXVOCALMORPHER_MAXRATE
= 10.0F
;
1466 constexpr auto EAXVOCALMORPHER_DEFAULTRATE
= 1.41F
;
1469 // Pitch Shifter Effect
1471 extern const GUID EAX_PITCHSHIFTER_EFFECT
;
1473 enum EAXPITCHSHIFTER_PROPERTY
:
1476 EAXPITCHSHIFTER_NONE
,
1477 EAXPITCHSHIFTER_ALLPARAMETERS
,
1478 EAXPITCHSHIFTER_COARSETUNE
,
1479 EAXPITCHSHIFTER_FINETUNE
,
1480 }; // EAXPITCHSHIFTER_PROPERTY
1482 struct EAXPITCHSHIFTERPROPERTIES
1484 long lCoarseTune
; // Amount of pitch shift (semitones)
1485 long lFineTune
; // Amount of pitch shift (cents)
1486 }; // EAXPITCHSHIFTERPROPERTIES
1489 constexpr auto EAXPITCHSHIFTER_MINCOARSETUNE
= -12L;
1490 constexpr auto EAXPITCHSHIFTER_MAXCOARSETUNE
= 12L;
1491 constexpr auto EAXPITCHSHIFTER_DEFAULTCOARSETUNE
= 12L;
1493 constexpr auto EAXPITCHSHIFTER_MINFINETUNE
= -50L;
1494 constexpr auto EAXPITCHSHIFTER_MAXFINETUNE
= 50L;
1495 constexpr auto EAXPITCHSHIFTER_DEFAULTFINETUNE
= 0L;
1498 // Ring Modulator Effect
1500 extern const GUID EAX_RINGMODULATOR_EFFECT
;
1502 enum EAXRINGMODULATOR_PROPERTY
:
1505 EAXRINGMODULATOR_NONE
,
1506 EAXRINGMODULATOR_ALLPARAMETERS
,
1507 EAXRINGMODULATOR_FREQUENCY
,
1508 EAXRINGMODULATOR_HIGHPASSCUTOFF
,
1509 EAXRINGMODULATOR_WAVEFORM
,
1510 }; // EAXRINGMODULATOR_PROPERTY
1515 EAX_RINGMODULATOR_SINUSOID
,
1516 EAX_RINGMODULATOR_SAWTOOTH
,
1517 EAX_RINGMODULATOR_SQUARE
,
1520 // Use this structure for EAXRINGMODULATOR_ALLPARAMETERS
1521 struct EAXRINGMODULATORPROPERTIES
1523 float flFrequency
; // Frequency of modulation (Hz)
1524 float flHighPassCutOff
; // Cut-off frequency of high-pass filter (Hz)
1525 unsigned long ulWaveform
; // Waveform selector - see enum above
1526 }; // EAXRINGMODULATORPROPERTIES
1529 constexpr auto EAXRINGMODULATOR_MINFREQUENCY
= 0.0F
;
1530 constexpr auto EAXRINGMODULATOR_MAXFREQUENCY
= 8000.0F
;
1531 constexpr auto EAXRINGMODULATOR_DEFAULTFREQUENCY
= 440.0F
;
1533 constexpr auto EAXRINGMODULATOR_MINHIGHPASSCUTOFF
= 0.0F
;
1534 constexpr auto EAXRINGMODULATOR_MAXHIGHPASSCUTOFF
= 24000.0F
;
1535 constexpr auto EAXRINGMODULATOR_DEFAULTHIGHPASSCUTOFF
= 800.0F
;
1537 constexpr auto EAXRINGMODULATOR_MINWAVEFORM
= 0UL;
1538 constexpr auto EAXRINGMODULATOR_MAXWAVEFORM
= 2UL;
1539 constexpr auto EAXRINGMODULATOR_DEFAULTWAVEFORM
= EAXRINGMODULATOR_MINWAVEFORM
;
1542 using LPEAXSET
= ALenum(AL_APIENTRY
*)(
1543 const GUID
* property_set_id
,
1545 ALuint property_source_id
,
1546 ALvoid
* property_buffer
,
1547 ALuint property_size
);
1549 using LPEAXGET
= ALenum(AL_APIENTRY
*)(
1550 const GUID
* property_set_id
,
1552 ALuint property_source_id
,
1553 ALvoid
* property_buffer
,
1554 ALuint property_size
);
1557 #endif // !EAX_API_INCLUDED