3 * Copyright 2018 Chris Robinson
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #ifndef EAXVECTOR_DEFINED
24 #define EAXVECTOR_DEFINED
25 typedef struct _EAXVECTOR
{
30 /* EAX 4.0 seems to support 4 FXSlots (auxiliary effect slots), while each
31 * buffer/source supports 2 Active FXSlots (auxiliary sends).
33 #define EAX_MAX_FXSLOTS 4
34 #define EAX_MAX_ACTIVE_FXSLOTS 2
36 /* Used by EAXFXSLOT_LOADEFFECT, EAXCONTEXT_PRIMARYFXSLOTID, and EAXSOURCE_ACTIVEFXSLOTID */
37 DEFINE_GUID(EAX_NULL_GUID
, 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00);
40 DEFINE_GUID(EAXPROPERTYID_EAX40_Context
, 0x1d4870ad, 0xdef, 0x43c0, 0xa4, 0xc, 0x52, 0x36, 0x32, 0x29, 0x63, 0x42);
43 EAXCONTEXT_ALLPARAMETERS
,
44 EAXCONTEXT_PRIMARYFXSLOTID
,
45 EAXCONTEXT_DISTANCEFACTOR
,
46 EAXCONTEXT_AIRABSORPTIONHF
,
47 EAXCONTEXT_HFREFERENCE
,
48 EAXCONTEXT_LASTERROR
/* query only, auto-reset? */
49 } EAXCONTEXT_PROPERTY
;
51 #define EAXCONTEXT_PARAMETER_IMMEDIATE 0x00000000
52 #define EAXCONTEXT_PARAMETER_DEFER 0x80000000
53 #define EAXCONTEXT_PARAMETER_COMMITDEFERREDSETTINGS (EAXCONTEXT_NONE | EAXCONTEXT_PARAMETER_IMMEDIATE)
55 /* EAXCONTEXT_ALLPARAMETERS */
56 typedef struct _EAXCONTEXTPROPERTIES
{
57 GUID guidPrimaryFXSlotID
;
58 /* TODO: Does this affect EAX properties only (e.g. initial reverb decay,
59 * air absorption)? Or is it an alias for DS3D's setting?
61 float flDistanceFactor
;
62 /* NOTE: Not directly supported by OpenAL, but can be applied to each
63 * source's air absorption factor as:
64 * air_absorption_factor *= flAirAbsorptionHF / -5.0f
66 float flAirAbsorptionHF
;
67 /* NOTE: Not supported by OpenAL. */
69 } EAXCONTEXTPROPERTIES
, *LPEAXCONTEXTPROPERTIES
;
71 /* EAXCONTEXT_LASTERROR */
73 #define EAXERR_INVALID_OPERATION (-1)
74 #define EAXERR_INVALID_VALUE (-2)
75 #define EAXERR_NO_EFFECT_LOADED (-3)
76 #define EAXERR_UNKNOWN_EFFECT (-4)
79 /* Also used by EAXSOURCE_ACTIVEFXSLOTID and EAXCONTEXT_PRIMARYFXSLOTID */
80 DEFINE_GUID(EAXPROPERTYID_EAX40_FXSlot0
, 0xc4d79f1e, 0xf1ac, 0x436b, 0xa8, 0x1d, 0xa7, 0x38, 0xe7, 0x04, 0x54, 0x69);
81 DEFINE_GUID(EAXPROPERTYID_EAX40_FXSlot1
, 0x08c00e96, 0x74be, 0x4491, 0x93, 0xaa, 0xe8, 0xad, 0x35, 0xa4, 0x91, 0x17);
82 DEFINE_GUID(EAXPROPERTYID_EAX40_FXSlot2
, 0x1d433b88, 0xf0f6, 0x4637, 0x91, 0x9f, 0x60, 0xe7, 0xe0, 0x6b, 0x5e, 0xdd);
83 DEFINE_GUID(EAXPROPERTYID_EAX40_FXSlot3
, 0xefff08ea, 0xc7d8, 0x44ab, 0x93, 0xad, 0x6d, 0xbd, 0x5f, 0x91, 0x00, 0x64);
85 EAXFXSLOT_PARAMETER
= 0, /* 0x00...0x40 reserved for effect parameters */
86 EAXFXSLOT_NONE
= 0x10000,
87 EAXFXSLOT_ALLPARAMETERS
,
94 /* EAXFXSLOT_ALLPARAMETERS */
95 typedef struct _EAXFXSLOTPROPERTIES
{
100 } EAXFXSLOTPROPERTIES
, *LPEAXFXSLOTPROPERTIES
;
102 /* EAXFXSLOT_LOADEFFECT */
103 DEFINE_GUID(EAX_REVERB_EFFECT
, 0x0cf95c8f, 0xa3cc, 0x4849, 0xb0, 0xb6, 0x83, 0x2e, 0xcc, 0x18, 0x22, 0xdf);
104 DEFINE_GUID(EAX_AGCCOMPRESSOR_EFFECT
, 0xbfb7a01e, 0x7825, 0x4039, 0x92, 0x7f, 0x03, 0xaa, 0xbd, 0xa0, 0xc5, 0x60);
105 DEFINE_GUID(EAX_AUTOWAH_EFFECT
, 0xec3130c0, 0xac7a, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
106 DEFINE_GUID(EAX_CHORUS_EFFECT
, 0xde6d6fe0, 0xac79, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
107 DEFINE_GUID(EAX_DISTORTION_EFFECT
, 0x975a4ce0, 0xac7e, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
108 DEFINE_GUID(EAX_ECHO_EFFECT
, 0x0e9f1bc0, 0xac82, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
109 DEFINE_GUID(EAX_EQUALIZER_EFFECT
, 0x65f94ce0, 0x9793, 0x11d3, 0x93, 0x9d, 0x00, 0xc0, 0xf0, 0x2d, 0xd6, 0xf0);
110 DEFINE_GUID(EAX_FLANGER_EFFECT
, 0xa70007c0, 0x07d2, 0x11d3, 0x9b, 0x1e, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
111 DEFINE_GUID(EAX_FREQUENCYSHIFTER_EFFECT
, 0xdc3e1880, 0x9212, 0x11d3, 0x93, 0x9d, 0x00, 0xc0, 0xf0, 0x2d, 0xd6, 0xf0);
112 DEFINE_GUID(EAX_VOCALMORPHER_EFFECT
, 0xe41cf10c, 0x3383, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
113 DEFINE_GUID(EAX_PITCHSHIFTER_EFFECT
, 0xe7905100, 0xafb2, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
114 DEFINE_GUID(EAX_RINGMODULATOR_EFFECT
, 0x0b89fe60, 0xafb5, 0x11d2, 0x88, 0xdd, 0x00, 0xa0, 0x24, 0xd1, 0x3c, 0xe1);
118 EAXFXSLOT_UNLOCKED
= 0,
122 /* EAXFXSLOT_FLAGS */
123 #define EAXFXSLOTFLAGS_ENVIRONMENT 0x00000001
126 DEFINE_GUID(EAXPROPERTYID_EAX40_Source
, 0x1b86b823, 0x22df, 0x4eae, 0x8b, 0x3c, 0x12, 0x78, 0xce, 0x54, 0x42, 0x27);
129 EAXSOURCE_ALLPARAMETERS
,
130 EAXSOURCE_OBSTRUCTIONPARAMETERS
,
131 EAXSOURCE_OCCLUSIONPARAMETERS
,
132 EAXSOURCE_EXCLUSIONPARAMETERS
,
137 EAXSOURCE_OBSTRUCTION
,
138 EAXSOURCE_OBSTRUCTIONLFRATIO
,
140 EAXSOURCE_OCCLUSIONLFRATIO
,
141 EAXSOURCE_OCCLUSIONROOMRATIO
,
142 EAXSOURCE_OCCLUSIONDIRECTRATIO
,
144 EAXSOURCE_EXCLUSIONLFRATIO
,
145 EAXSOURCE_OUTSIDEVOLUMEHF
,
146 EAXSOURCE_DOPPLERFACTOR
,
147 EAXSOURCE_ROLLOFFFACTOR
,
148 EAXSOURCE_ROOMROLLOFFFACTOR
,
149 EAXSOURCE_AIRABSORPTIONFACTOR
,
151 EAXSOURCE_SENDPARAMETERS
,
152 EAXSOURCE_ALLSENDPARAMETERS
,
153 EAXSOURCE_OCCLUSIONSENDPARAMETERS
,
154 EAXSOURCE_EXCLUSIONSENDPARAMETERS
,
155 EAXSOURCE_ACTIVEFXSLOTID
,
156 } EAXSOURCE_PROPERTY
;
158 #define EAXSOURCE_PARAMETER_IMMEDIATE 0x00000000
159 #define EAXSOURCE_PARAMETER_DEFERRED 0x80000000
160 #define EAXSOURCE_PARAMETER_COMMITDEFERREDSETTINGS (EAXSOURCE_NONE | EAXSOURCE_PARAMETER_IMMEDIATE)
162 /* EAXSOURCE_ALLPARAMETERS */
163 typedef struct _EAXSOURCEPROPERTIES
{
166 /* TODO: Do these act as offets for individual sends? Or overwrite them all
167 * when set? Or only apply to sends using the context's primary FXSlot?
172 float flObstructionLFRatio
;
174 float flOcclusionLFRatio
;
175 float flOcclusionRoomRatio
;
176 float flOcclusionDirectRatio
;
178 float flExclusionLFRatio
;
179 long lOutsideVolumeHF
;
180 float flDopplerFactor
;
181 /* NOTE: Added, not multiplied, with the listener's value. */
182 float flRolloffFactor
;
183 float flRoomRolloffFactor
;
184 float flAirAbsorptionFactor
;
186 } EAXSOURCEPROPERTIES
, *LPEAXSOURCEPROPERTIES
;
188 /* EAXSOURCE_OBSTRUCTIONPARAMETERS */
189 #ifndef EAX_OBSTRUCTIONPROPERTIES_DEFINED
190 #define EAX_OBSTRUCTIONPROPERTIES_DEFINED
191 typedef struct _EAXOBSTRUCTIONPROPERTIES
{
193 float flObstructionLFRatio
;
194 } EAXOBSTRUCTIONPROPERTIES
, *LPEAXOBSTRUCTIONPROPERTIES
;
197 /* EAXSOURCE_OCCLUSIONPARAMETERS */
198 #ifndef EAX_OCCLUSIONPROPERTIES_DEFINED
199 #define EAX_OCCLUSIONPROPERTIES_DEFINED
200 typedef struct _EAXOCCLUSIONPROPERTIES
{
202 float flOcclusionLFRatio
;
203 float flOcclusionRoomRatio
;
204 float flOcclusionDirectRatio
;
205 } EAXOCCLUSIONPROPERTIES
, *LPEAXOCCLUSIONPROPERTIES
;
208 /* EAXSOURCE_EXCLUSIONPARAMETERS */
209 #ifndef EAX_EXCLUSIONPROPERTIES_DEFINED
210 #define EAX_EXCLUSIONPROPERTIES_DEFINED
211 typedef struct _EAXEXCLUSIONPROPERTIES
{
213 float flExclusionLFRatio
;
214 } EAXEXCLUSIONPROPERTIES
, *LPEAXEXCLUSIONPROPERTIES
;
217 /* EAXSOURCE_FLAGS */
218 #define EAXSOURCEFLAGS_DIRECTHFAUTO 0x00000001
219 #define EAXSOURCEFLAGS_ROOMAUTO 0x00000002
220 #define EAXSOURCEFLAGS_ROOMHFAUTO 0x00000004
222 /* EAXSOURCE_SENDPARAMETERS */
223 typedef struct _EAXSOURCESENDPROPERTIES
{
224 /* TODO: Check if sources maintain send parameters for each potential
225 * effect slot, or if this needs to match a currently active effect slot to
226 * match a send (and gets reset when the active effect slot GUID changes).
227 * Also need to check how EAX_PrimaryFXSlotID is treated (as itself, or if
228 * it looks at the context's primary FXSlot).
230 GUID guidReceivingFXSlotID
;
233 } EAXSOURCESENDPROPERTIES
, *LPEAXSOURCESENDPROPERTIES
;
235 /* EAXSOURCE_ALLSENDPARAMETERS */
236 typedef struct _EAXSOURCEALLSENDPROPERTIES
{
237 GUID guidReceivingFXSlotID
;
241 float flOcclusionLFRatio
;
242 float flOcclusionRoomRatio
;
243 float flOcclusionDirectRatio
;
245 float flExclusionLFRatio
;
246 } EAXSOURCEALLSENDPROPERTIES
, *LPEAXSOURCEALLSENDPROPERTIES
;
248 /* EAXSOURCE_OCCLUSIONSENDPARAMETERS */
249 typedef struct _EAXSOURCEOCCLUSIONSENDPROPERTIES
{
250 GUID guidReceivingFXSlotID
;
252 float flOcclusionLFRatio
;
253 float flOcclusionRoomRatio
;
254 float flOcclusionDirectRatio
;
255 } EAXSOURCEOCCLUSIONSENDPROPERTIES
, *LPEAXSOURCEOCCLUSIONSENDPROPERTIES
;
257 /* EAXSOURCE_EXCLUSIONSENDPARAMETERS */
258 typedef struct _EAXSOURCEEXCLUSIONSENDPROPERTIES
{
259 GUID guidReceivingFXSlotID
;
261 float flExclusionLFRatio
;
262 } EAXSOURCEEXCLUSIONSENDPROPERTIES
, *LPEAXSOURCEEXCLUSIONSENDPROPERTIES
;
264 /* EAXSOURCE_ACTIVEFXSLOTID */
265 typedef struct _EAXACTIVEFXSLOTS
{
266 GUID guidActiveFXSlots
[EAX_MAX_ACTIVE_FXSLOTS
];
267 } EAXACTIVEFXSLOTS
, *LPEAXACTIVEFXSLOTS
;
269 DEFINE_GUID(EAX_PrimaryFXSlotID
, 0xf317866d, 0x924c, 0x450c, 0x86, 0x1b, 0xe6, 0xda, 0xa2, 0x5e, 0x7c, 0x20);
272 /* EAX_REVERB_EFFECT properties. */
275 EAXREVERB_ALLPARAMETERS
,
276 EAXREVERB_ENVIRONMENT
,
277 EAXREVERB_ENVIRONMENTSIZE
,
278 EAXREVERB_ENVIRONMENTDIFFUSION
,
283 EAXREVERB_DECAYHFRATIO
,
284 EAXREVERB_DECAYLFRATIO
,
285 EAXREVERB_REFLECTIONS
,
286 EAXREVERB_REFLECTIONSDELAY
,
287 EAXREVERB_REFLECTIONSPAN
,
289 EAXREVERB_REVERBDELAY
,
293 EAXREVERB_MODULATIONTIME
,
294 EAXREVERB_MODULATIONDEPTH
,
295 EAXREVERB_AIRABSORPTIONHF
,
296 EAXREVERB_HFREFERENCE
,
297 EAXREVERB_LFREFERENCE
,
298 EAXREVERB_ROOMROLLOFFFACTOR
,
300 } EAXREVERB_PROPERTY
;
302 #define EAXREVERB_IMMEDIATE 0x00000000
303 #define EAXREVERB_DEFERRED 0x80000000
304 #define EAXREVERB_COMMITDEFERREDSETTINGS (EAXREVERB_NONE | EAXREVERB_IMMEDIATE)
306 /* EAXREVERB_ALLPARAMETERS */
307 typedef struct _EAXREVERBPROPERTIES
{
309 float flEnvironmentSize
;
310 float flEnvironmentDiffusion
;
315 float flDecayHFRatio
;
316 float flDecayLFRatio
;
318 float flReflectionsDelay
;
319 EAXVECTOR vReflectionsPan
;
322 EAXVECTOR vReverbPan
;
325 float flModulationTime
;
326 float flModulationDepth
;
327 float flAirAbsorptionHF
;
330 float flRoomRolloffFactor
;
332 } EAXREVERBPROPERTIES
, *LPEAXREVERBPROPERTIES
;
334 /* EAXREVERB_FLAGS */
335 /* These flags determine what properties are modified when the environment size
338 #define EAXREVERBFLAGS_DECAYTIMESCALE 0x00000001
339 #define EAXREVERBFLAGS_REFLECTIONSSCALE 0x00000002
340 #define EAXREVERBFLAGS_REFLECTIONSDELAYSCALE 0x00000004
341 #define EAXREVERBFLAGS_REVERBSCALE 0x00000008
342 #define EAXREVERBFLAGS_REVERBDELAYSCALE 0x00000010
343 #define EAXREVERBFLAGS_ECHOTIMESCALE 0x00000040
344 #define EAXREVERBFLAGS_MODULATIONTIMESCALE 0x00000080
345 /* This flag limits the high frequency decay according to air absorption */
346 #define EAXREVERBFLAGS_DECAYHFLIMIT 0x00000020
349 /* EAX_CHORUS_EFFECT properties */
352 EAXCHORUS_ALLPARAMETERS
,
359 } EAXCHORUS_PROPERTY
;
361 #define EAXCHORUS_IMMEDIATE 0x00000000
362 #define EAXCHORUS_DEFERRED 0x80000000
363 #define EAXCHORUS_COMMITDEFERREDSETTINGS (EAXCHORUS_NONE | EAXCHORUS_IMMEDIATE)
365 /* EAXCHORUS_ALLPARAMETERS */
366 typedef struct _EAXCHORUSPROPERTIES
{
373 } EAXCHORUSPROPERTIES
, *LPEAXCHORUSPROPERTIES
;
375 /* EAXCHORUS_WAVEFORM */
382 /* TODO: Other effects. */