Restore EAX effects through OpenAL's EFX. #1000

Deledrius · 2021-10-08T00:24:33Z

This re-implements the supported EAX effects using OpenAL's EFX. Some features (such as occlusion effects) are currently unsupported by OpenAL and required conversion or local implementation.

Sources/Plasma/PubUtilLib/plAudio/plAudioSystem.cpp

Hoikas

These single byte string literals will be reinterpreted as UCS-2 on 3ds Max >= 2013, resulting in garbled UI strings.

Sources/Tools/MaxComponent/plAudioComponents.cpp

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

Hoikas · 2021-10-08T00:51:01Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

-    static int oldTime = timeGetTime();     // Get starting time
-    int newTime;
+    EFXEAXREVERBPROPERTIES  finalProps;
+    static auto oldTime = std::chrono::steady_clock::now();     // Get starting time


Should this be using something from hsTimer instead?

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

Hoikas · 2021-10-08T00:52:43Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

    // change due to opt out(caching) feature.
    if(bMorphing)
    {
-        newTime = timeGetTime();
+        auto newTime = std::chrono::steady_clock::now();


Hoikas · 2021-10-08T01:00:59Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.cpp

+    s->WriteLE32((uint32_t)eaxListenerProps->ulEnvironment);
+    s->WriteLEFloat(eaxListenerProps->flEnvironmentSize);
+    s->WriteLEFloat(eaxListenerProps->flEnvironmentDiffusion);
+    s->WriteLE32((int32_t)eaxListenerProps->lRoom);
+    s->WriteLE32((int32_t)eaxListenerProps->lRoomHF);
+    s->WriteLE32((int32_t)eaxListenerProps->lRoomLF);
+    s->WriteLEFloat(eaxListenerProps->flDecayTime);
+    s->WriteLEFloat(eaxListenerProps->flDecayHFRatio);
+    s->WriteLEFloat(eaxListenerProps->flDecayLFRatio);
+    s->WriteLE32((int32_t)eaxListenerProps->lReflections);
+    s->WriteLEFloat(eaxListenerProps->flReflectionsDelay);
+    //s->WriteLEFloat( eaxListenerProps->vReflectionsPan;     // early reflections panning vector
+    s->WriteLE32((int32_t)eaxListenerProps->lReverb);         // late reverberation level relative to room effect
+    s->WriteLEFloat(eaxListenerProps->flReverbDelay);
+    //s->WriteLEFloat( eaxListenerProps->vReverbPan;          // late reverberation panning vector
+    s->WriteLEFloat(eaxListenerProps->flEchoTime);
+    s->WriteLEFloat(eaxListenerProps->flEchoDepth);
+    s->WriteLEFloat(eaxListenerProps->flModulationTime);
+    s->WriteLEFloat(eaxListenerProps->flModulationDepth);
+    s->WriteLEFloat(eaxListenerProps->flAirAbsorptionHF);
+    s->WriteLEFloat(eaxListenerProps->flHFReference);
+    s->WriteLEFloat(eaxListenerProps->flLFReference);
+    s->WriteLEFloat(eaxListenerProps->flRoomRolloffFactor);
+    s->WriteLE32((uint32_t)eaxListenerProps->ulFlags);
+
+    delete eaxListenerProps;


Suggested change

s->WriteLE32((uint32_t)eaxListenerProps->ulEnvironment);

s->WriteLEFloat(eaxListenerProps->flEnvironmentSize);

s->WriteLEFloat(eaxListenerProps->flEnvironmentDiffusion);

s->WriteLE32((int32_t)eaxListenerProps->lRoom);

s->WriteLE32((int32_t)eaxListenerProps->lRoomHF);

s->WriteLE32((int32_t)eaxListenerProps->lRoomLF);

s->WriteLEFloat(eaxListenerProps->flDecayTime);

s->WriteLEFloat(eaxListenerProps->flDecayHFRatio);

s->WriteLEFloat(eaxListenerProps->flDecayLFRatio);

s->WriteLE32((int32_t)eaxListenerProps->lReflections);

s->WriteLEFloat(eaxListenerProps->flReflectionsDelay);

//s->WriteLEFloat( eaxListenerProps->vReflectionsPan; // early reflections panning vector

s->WriteLE32((int32_t)eaxListenerProps->lReverb); // late reverberation level relative to room effect

s->WriteLEFloat(eaxListenerProps->flReverbDelay);

//s->WriteLEFloat( eaxListenerProps->vReverbPan; // late reverberation panning vector

s->WriteLEFloat(eaxListenerProps->flEchoTime);

s->WriteLEFloat(eaxListenerProps->flEchoDepth);

s->WriteLEFloat(eaxListenerProps->flModulationTime);

s->WriteLEFloat(eaxListenerProps->flModulationDepth);

s->WriteLEFloat(eaxListenerProps->flAirAbsorptionHF);

s->WriteLEFloat(eaxListenerProps->flHFReference);

s->WriteLEFloat(eaxListenerProps->flLFReference);

s->WriteLEFloat(eaxListenerProps->flRoomRolloffFactor);

s->WriteLE32((uint32_t)eaxListenerProps->ulFlags);

delete eaxListenerProps;

s->WriteLE32((uint32_t)eaxListenerProps.ulEnvironment);

s->WriteLEFloat(eaxListenerProps.flEnvironmentSize);

s->WriteLEFloat(eaxListenerProps.flEnvironmentDiffusion);

s->WriteLE32((int32_t)eaxListenerProps.lRoom);

s->WriteLE32((int32_t)eaxListenerProps.lRoomHF);

s->WriteLE32((int32_t)eaxListenerProps.lRoomLF);

s->WriteLEFloat(eaxListenerProps.flDecayTime);

s->WriteLEFloat(eaxListenerProps.flDecayHFRatio);

s->WriteLEFloat(eaxListenerProps.flDecayLFRatio);

s->WriteLE32((int32_t)eaxListenerProps.lReflections);

s->WriteLEFloat(eaxListenerProps.flReflectionsDelay);

//s->WriteLEFloat( eaxListenerProps.vReflectionsPan; // early reflections panning vector

s->WriteLE32((int32_t)eaxListenerProps.lReverb); // late reverberation level relative to room effect

s->WriteLEFloat(eaxListenerProps.flReverbDelay);

//s->WriteLEFloat( eaxListenerProps.vReverbPan; // late reverberation panning vector

s->WriteLEFloat(eaxListenerProps.flEchoTime);

s->WriteLEFloat(eaxListenerProps.flEchoDepth);

s->WriteLEFloat(eaxListenerProps.flModulationTime);

s->WriteLEFloat(eaxListenerProps.flModulationDepth);

s->WriteLEFloat(eaxListenerProps.flAirAbsorptionHF);

s->WriteLEFloat(eaxListenerProps.flHFReference);

s->WriteLEFloat(eaxListenerProps.flLFReference);

s->WriteLEFloat(eaxListenerProps.flRoomRolloffFactor);

s->WriteLE32((uint32_t)eaxListenerProps.ulFlags);

Hoikas · 2021-10-08T01:01:42Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.cpp

 }

-
-void    plEAXListenerMod::SetFromPreset( uint32_t preset )
+void plEAXListenerMod::SetFromEFXPreset(EFXEAXREVERBPROPERTIES preset)


Suggested change

void plEAXListenerMod::SetFromEFXPreset(EFXEAXREVERBPROPERTIES preset)

void plEAXListenerMod::SetFromEFXPreset(const EFXEAXREVERBPROPERTIES& preset)

Hoikas · 2021-10-08T01:02:32Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.h

-    EAXREVERBPROPERTIES *   GetListenerProps() { return fListenerProps; }
-    void                    SetFromPreset( uint32_t preset );
+    EFXEAXREVERBPROPERTIES *GetListenerProps() { return fListenerProps; }
+    void                    SetFromEFXPreset(EFXEAXREVERBPROPERTIES preset);


Suggested change

void SetFromEFXPreset(EFXEAXREVERBPROPERTIES preset);

void SetFromEFXPreset(const EFXEAXREVERBPROPERTIES& preset);

Hoikas · 2021-10-08T01:03:35Z

Sources/Tools/MaxComponent/plAudioComponents.cpp

+        // Set params based on artist selections
+        EAXREVERBPROPERTIES *eaxProps = new EAXREVERBPROPERTIES;


Suggested change

// Set params based on artist selections

EAXREVERBPROPERTIES *eaxProps = new EAXREVERBPROPERTIES;

// Set params based on artist selections

EAXREVERBPROPERTIES eaxProps;

Hoikas · 2021-10-08T01:04:13Z

Sources/Tools/MaxComponent/plAudioComponents.cpp

+        eaxProps->flEnvironmentSize = fCompPB->GetFloat( (ParamID)kRefEnvironmentSize );
+        eaxProps->flEnvironmentDiffusion = fCompPB->GetFloat( (ParamID)kRefEnvironmentDiffusion );
+        eaxProps->lRoom = fCompPB->GetInt( (ParamID)kRefRoom );
+        eaxProps->lRoomHF = fCompPB->GetInt( (ParamID)kRefRoomHF );
+        eaxProps->lRoomLF = fCompPB->GetInt( (ParamID)kRefRoomLF );
+        eaxProps->flDecayTime = fCompPB->GetFloat( (ParamID)kRefDecayTime );
+        eaxProps->flDecayHFRatio = fCompPB->GetFloat( (ParamID)kRefDecayHFRatio );
+        eaxProps->flDecayLFRatio = fCompPB->GetFloat( (ParamID)kRefDecayLFRatio );
+        eaxProps->lReflections = fCompPB->GetInt( (ParamID)kRefReflections );
+        eaxProps->flReflectionsDelay = fCompPB->GetFloat( (ParamID)kRefReflectionsDelay );
+        //eaxProps->vReflectionsPan;                                                // early reflections panning vector
+        eaxProps->lReverb = fCompPB->GetInt( (ParamID)kRefReverb );                 // late reverberation level relative to room effect
+        eaxProps->flReverbDelay = fCompPB->GetFloat( (ParamID)kRefReverbDelay );
+        //eaxProps->vReverbPan;                                                     // late reverberation panning vector
+        eaxProps->flEchoTime = fCompPB->GetFloat( (ParamID)kRefEchoTime );
+        eaxProps->flEchoDepth = fCompPB->GetFloat( (ParamID)kRefEchoDepth );
+        eaxProps->flModulationTime = fCompPB->GetFloat( (ParamID)kRefModulationTime );
+        eaxProps->flModulationDepth = fCompPB->GetFloat( (ParamID)kRefModulationDepth );
+        eaxProps->flAirAbsorptionHF = fCompPB->GetFloat( (ParamID)kRefAirAbsorptionHF );
+        eaxProps->flHFReference = fCompPB->GetFloat( (ParamID)kRefHFReference );
+        eaxProps->flLFReference = fCompPB->GetFloat( (ParamID)kRefLFReference );
+        eaxProps->flRoomRolloffFactor = fCompPB->GetFloat( (ParamID)kRefRoomRolloffFactor );
+        eaxProps->ulFlags = fCompPB->GetInt( (ParamID)kRefFlags );
+
+        // Convert to EFX and store them
+        plEAXListenerMod::ConvertEAXToEFX(eaxProps, listener->GetListenerProps());
+        delete eaxProps;


Suggested change

eaxProps->flEnvironmentSize = fCompPB->GetFloat( (ParamID)kRefEnvironmentSize );

eaxProps->flEnvironmentDiffusion = fCompPB->GetFloat( (ParamID)kRefEnvironmentDiffusion );

eaxProps->lRoom = fCompPB->GetInt( (ParamID)kRefRoom );

eaxProps->lRoomHF = fCompPB->GetInt( (ParamID)kRefRoomHF );

eaxProps->lRoomLF = fCompPB->GetInt( (ParamID)kRefRoomLF );

eaxProps->flDecayTime = fCompPB->GetFloat( (ParamID)kRefDecayTime );

eaxProps->flDecayHFRatio = fCompPB->GetFloat( (ParamID)kRefDecayHFRatio );

eaxProps->flDecayLFRatio = fCompPB->GetFloat( (ParamID)kRefDecayLFRatio );

eaxProps->lReflections = fCompPB->GetInt( (ParamID)kRefReflections );

eaxProps->flReflectionsDelay = fCompPB->GetFloat( (ParamID)kRefReflectionsDelay );

//eaxProps->vReflectionsPan; // early reflections panning vector

eaxProps->lReverb = fCompPB->GetInt( (ParamID)kRefReverb ); // late reverberation level relative to room effect

eaxProps->flReverbDelay = fCompPB->GetFloat( (ParamID)kRefReverbDelay );

//eaxProps->vReverbPan; // late reverberation panning vector

eaxProps->flEchoTime = fCompPB->GetFloat( (ParamID)kRefEchoTime );

eaxProps->flEchoDepth = fCompPB->GetFloat( (ParamID)kRefEchoDepth );

eaxProps->flModulationTime = fCompPB->GetFloat( (ParamID)kRefModulationTime );

eaxProps->flModulationDepth = fCompPB->GetFloat( (ParamID)kRefModulationDepth );

eaxProps->flAirAbsorptionHF = fCompPB->GetFloat( (ParamID)kRefAirAbsorptionHF );

eaxProps->flHFReference = fCompPB->GetFloat( (ParamID)kRefHFReference );

eaxProps->flLFReference = fCompPB->GetFloat( (ParamID)kRefLFReference );

eaxProps->flRoomRolloffFactor = fCompPB->GetFloat( (ParamID)kRefRoomRolloffFactor );

eaxProps->ulFlags = fCompPB->GetInt( (ParamID)kRefFlags );

// Convert to EFX and store them

plEAXListenerMod::ConvertEAXToEFX(eaxProps, listener->GetListenerProps());

delete eaxProps;

eaxProps.flEnvironmentSize = fCompPB->GetFloat( (ParamID)kRefEnvironmentSize );

eaxProps.flEnvironmentDiffusion = fCompPB->GetFloat( (ParamID)kRefEnvironmentDiffusion );

eaxProps.lRoom = fCompPB->GetInt( (ParamID)kRefRoom );

eaxProps.lRoomHF = fCompPB->GetInt( (ParamID)kRefRoomHF );

eaxProps.lRoomLF = fCompPB->GetInt( (ParamID)kRefRoomLF );

eaxProps.flDecayTime = fCompPB->GetFloat( (ParamID)kRefDecayTime );

eaxProps.flDecayHFRatio = fCompPB->GetFloat( (ParamID)kRefDecayHFRatio );

eaxProps.flDecayLFRatio = fCompPB->GetFloat( (ParamID)kRefDecayLFRatio );

eaxProps.lReflections = fCompPB->GetInt( (ParamID)kRefReflections );

eaxProps.flReflectionsDelay = fCompPB->GetFloat( (ParamID)kRefReflectionsDelay );

//eaxProps.vReflectionsPan; // early reflections panning vector

eaxProps.lReverb = fCompPB->GetInt( (ParamID)kRefReverb ); // late reverberation level relative to room effect

eaxProps.flReverbDelay = fCompPB->GetFloat( (ParamID)kRefReverbDelay );

//eaxProps.vReverbPan; // late reverberation panning vector

eaxProps.flEchoTime = fCompPB->GetFloat( (ParamID)kRefEchoTime );

eaxProps.flEchoDepth = fCompPB->GetFloat( (ParamID)kRefEchoDepth );

eaxProps.flModulationTime = fCompPB->GetFloat( (ParamID)kRefModulationTime );

eaxProps.flModulationDepth = fCompPB->GetFloat( (ParamID)kRefModulationDepth );

eaxProps.flAirAbsorptionHF = fCompPB->GetFloat( (ParamID)kRefAirAbsorptionHF );

eaxProps.flHFReference = fCompPB->GetFloat( (ParamID)kRefHFReference );

eaxProps.flLFReference = fCompPB->GetFloat( (ParamID)kRefLFReference );

eaxProps.flRoomRolloffFactor = fCompPB->GetFloat( (ParamID)kRefRoomRolloffFactor );

eaxProps.ulFlags = fCompPB->GetInt( (ParamID)kRefFlags );

// Convert to EFX and store them

plEAXListenerMod::ConvertEAXToEFX(&eaxProps, listener->GetListenerProps());

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

patmauro · 2023-07-21T22:40:04Z

If there's any interest in dusting this one off again, I would love to help in any way I can, depending on what the current blockers may be. This feature in particular is very near and dear to me - URU has never quite felt like URU without it, and getting this functionality restored even partially would be a tremendously huge W. So again, please let me know if I can be of any assistance here; my C++ is a little rusty, but I'm certainly no stranger to reviewing scripts and running tests.

Here's a thought - on the front-end side, in addition to the simple change of "Enable EAX" to "Enable EFX" in the options menu (there doesn't really seem to be room in the GUI for a description more detailed than that, unfortunately), we'll probably want to replace that "EAX ADVANCED HD" graphic at the bottom of the audio menu with a more generic OpenAL one as well. This would require a modification to the xoptionsguicomponents texture contained inside GUI_District_OptionsMenuGUI.prp - we don't have a source for this one (the version of this we have in the source files is from CC and is quite different), so as usual, the trick here would be figuring out how to modify this texture without introducing any new compression artifacts to the rest of the texture sheet. (Granted - this wouldn't be covered by this PR and would require a separate PR to moul-assets, but it seemed relevant to mention here.) (Edit: addressed by H-uru/moul-assets#251)

Deledrius · 2023-07-21T22:43:14Z

No dusting off necessary, I've been actively working on this.

Updating the in-game text and graphics will definitely be something we'll need. I'll let you know when I get close to that stage!

patmauro · 2023-07-21T23:01:53Z

No dusting off necessary, I've been actively working on this.

Updating the in-game text and graphics will definitely be something we'll need. I'll let you know when I get close to that stage!

Sounds good. 🙂 In any case, the offer stands; happy to make myself available if you need an extra set of hands.

I may go ahead and look into a PR for that graphic in moul-assets unless there's any objection... seems like it might not be a bad idea to start ditching the user-facing EAX references anyway, regardless of the status of the EFX project. 🤔 (Edit: addressed by H-uru/moul-assets#251)

Deledrius · 2023-07-21T23:18:09Z

Sure, go ahead. We can replace that texture with a lossless one if it isn't already, so additional edits won't introduce any generational loss. I can't check on this at the moment, but feel free to start on a plan for it!

dpogue

Does it seem feasible to wrap this in USE_EFX conditionally, or is that going to turn into a mess of ifdefs everywhere? The AL_AUXILIARY_SEND_FILTER stuff seems like the worst in terms of wrapping, but maybe we can turn that into a conditional macro?

dpogue · 2025-02-21T03:16:19Z

Sources/Plasma/PubUtilLib/plAudio/plAudioSystem.cpp

-#ifdef USE_EFX
-#   include <efx.h>
-#endif


To slightly complicate things, there are some OpenAL implementations (Apple) that don't ship the EFX header, which is why this was conditionally detected.

All of our builds use vcpkg which uses openal-soft, which includes EFX, but it would be nice to still gracefully fall back to no effects if EFX can't be found

Ah, that's unfortunate. I did this assuming we'd be using the same library across the different platforms, where OpenAL-soft provides this for us without variability.

It does complicate things, but I can see about re-introducing proper conditional support.

If it turns out to be a mess, we're probably okay to mandate OpenAL-Soft.

It's just nice to fallback to system libraries on weird old systems where you don't feel like trying to compile extra dependencies 😛

Yeah, it's a good idea. I just assumed I could simplify that code a bit and took the opportunity to clean it out. ;)

patmauro · 2025-02-21T17:13:55Z

Loading in this latest draft and testing it out put an enormous smile on my face. You've done something important here, @Deledrius, and should feel very proud.

One note - since the Audio.UseEAX syntax has been changed to Audio.UseEFX, the app will throw an error if an existing audio.ini config file exists in local AppData with the old syntax - even if you "press OK to continue parsing files," it seemingly won't, and will launch in 800x600 with no sound - I had to purge the existing (username)/AppData/Local/Uru Live/ dir and let it regenerate to get it to cooperate. May not be a bad idea to gracefully handle the old ini syntax to account for this (even if it just specifically calls this out as something to ignore).

dpogue · 2025-02-21T17:17:15Z

One note - since the Audio.UseEAX syntax has been changed to Audio.UseEFX, the app will throw an error if an existing audio.ini config file exists in local AppData with the old syntax

I was thinking about this and almost left a comment when I reviewed the code last night, but thought "EAX hasn't worked for years, how likely is it that anyone even has MOULa config files with that option enabled?"

I guess it is a possibility, and maybe supporting both commands (or at least support parsing the UseEAX one with no implementation) might be best.

Deledrius · 2025-02-21T18:50:26Z

"EAX hasn't worked for years, how likely is it that anyone even has MOULa config files with that option enabled?"

That was my thinking, too, when I changed it; but I'm fairly certain I changed code that's been writing out the old settings (as false) all this time, so the answer is probably "everyone".

Sounds like the correct solution here is to figure out why we're not ignoring it gracefully and fix that. It should simply be able to ignore an unknown value and continue without nuking everything.

Thanks for catching this. These conceptual issues are useful at this stage of the WIP. :)

Hoikas · 2025-02-22T00:50:59Z

Given that we have lots of config files running around out there that use the command Audio.UseEAX, I think it's critical that the command remain named thusly. I realize that this is a someone inaccurate name, but sometimes we have to make concessions for ease of use. Further, we can't really control what client the user is running at all, so it's important that we don't start dumping Audio.UseEFX into files as well. If the user runs an old client, and the file contains that command, their old client will error. This will even happen on even slightly out of date H'uru clients. We don't want that.

We don't want to remove this error either. That error is coming from the pfConsole command parser. We want the console to tell us when it receives an invalid input. We don't want it to simply drop unknown commands on the floor. This is an indication that something is wrong. Like someone has edited the FNI file and misspelled something.

I think I would actually go a step farther than this and say since the classes are all still named plEAXWhatever, and we're leaving the console command as Audio.UseEAX, that we shouldn't change any of the engine's function or variable names at all to EFX from EAX. While this change does clarify the underlying backend for environmental audio effects, in practice it muddies the water significantly for anyone who wants to maintain something like a Python script for both TPotS and H'uru. However, we should definitely update the user facing strings to refer to EFX.

Hoikas

Some additional review items on top of the concerns from the PR comment about naming. Also, it would be nice if we could cull the no-op whitespace changes to make reviewing easier.

Hoikas · 2025-02-22T00:55:32Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp


+inline float lerp(float start, float finish, float ratio) {


Suggested change

inline float lerp(float start, float finish, float ratio) {

constexpr static float lerp(float start, float finish, float ratio) {

Hoikas · 2025-02-22T00:55:46Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp


-plEAXListener   &plEAXListener::GetInstance()
+bool ReverbPropsInterpolate(LPEFXEAXREVERBPROPERTIES lpStart, LPEFXEAXREVERBPROPERTIES lpFinish,


Suggested change

bool ReverbPropsInterpolate(LPEFXEAXREVERBPROPERTIES lpStart, LPEFXEAXREVERBPROPERTIES lpFinish,

static bool ReverbPropsInterpolate(LPEFXEAXREVERBPROPERTIES lpStart, LPEFXEAXREVERBPROPERTIES lpFinish,

Hoikas · 2025-02-22T00:57:58Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

+    lpResult->flDecayTime = (float)exp(lerp(log(lpStart->flDecayTime), log(lpFinish->flDecayTime), flRatio));
+    lpResult->flDecayHFRatio = (float)exp(lerp(log(lpStart->flDecayHFRatio), log(lpFinish->flDecayHFRatio), flRatio));
+    lpResult->flDecayLFRatio = (float)exp(lerp(log(lpStart->flDecayLFRatio), log(lpFinish->flDecayLFRatio), flRatio));
+    lpResult->flReflectionsGain = lerp(lpStart->flReflectionsGain, lpFinish->flReflectionsGain, flRatio);
+    lpResult->flReflectionsDelay = (float)exp(lerp(log(lpStart->flReflectionsDelay), log(lpFinish->flReflectionsDelay), flRatio));
+    lpResult->flLateReverbGain = lerp(lpStart->flLateReverbGain, lpFinish->flLateReverbGain, flRatio);
+    lpResult->flLateReverbDelay = (float)exp(lerp(log(lpStart->flLateReverbDelay), log(lpFinish->flLateReverbDelay), flRatio));
+    lpResult->flEchoTime = (float)exp(lerp(log(lpStart->flEchoTime), log(lpFinish->flEchoTime), flRatio));


Suggested change

lpResult->flDecayTime = (float)exp(lerp(log(lpStart->flDecayTime), log(lpFinish->flDecayTime), flRatio));

lpResult->flDecayHFRatio = (float)exp(lerp(log(lpStart->flDecayHFRatio), log(lpFinish->flDecayHFRatio), flRatio));

lpResult->flDecayLFRatio = (float)exp(lerp(log(lpStart->flDecayLFRatio), log(lpFinish->flDecayLFRatio), flRatio));

lpResult->flReflectionsGain = lerp(lpStart->flReflectionsGain, lpFinish->flReflectionsGain, flRatio);

lpResult->flReflectionsDelay = (float)exp(lerp(log(lpStart->flReflectionsDelay), log(lpFinish->flReflectionsDelay), flRatio));

lpResult->flLateReverbGain = lerp(lpStart->flLateReverbGain, lpFinish->flLateReverbGain, flRatio);

lpResult->flLateReverbDelay = (float)exp(lerp(log(lpStart->flLateReverbDelay), log(lpFinish->flLateReverbDelay), flRatio));

lpResult->flEchoTime = (float)exp(lerp(log(lpStart->flEchoTime), log(lpFinish->flEchoTime), flRatio));

lpResult->flDecayTime = expf(lerp(logf(lpStart->flDecayTime), logf(lpFinish->flDecayTime), flRatio));

lpResult->flDecayHFRatio = expf(lerp(logf(lpStart->flDecayHFRatio), logf(lpFinish->flDecayHFRatio), flRatio));

lpResult->flDecayLFRatio = expf(lerp(logf(lpStart->flDecayLFRatio), logf(lpFinish->flDecayLFRatio), flRatio));

lpResult->flReflectionsGain = lerp(lpStart->flReflectionsGain, lpFinish->flReflectionsGain, flRatio);

lpResult->flReflectionsDelay = expf(lerp(logf(lpStart->flReflectionsDelay), logf(lpFinish->flReflectionsDelay), flRatio));

lpResult->flLateReverbGain = lerp(lpStart->flLateReverbGain, lpFinish->flLateReverbGain, flRatio);

lpResult->flLateReverbDelay = expf(lerp(logf(lpStart->flLateReverbDelay), logf(lpFinish->flLateReverbDelay), flRatio));

lpResult->flEchoTime = expf(lerp(logf(lpStart->flEchoTime), logf(lpFinish->flEchoTime), flRatio));

Hoikas · 2025-02-22T00:59:16Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

+    lpResult->flLateReverbDelay = (float)exp(lerp(log(lpStart->flLateReverbDelay), log(lpFinish->flLateReverbDelay), flRatio));
+    lpResult->flEchoTime = (float)exp(lerp(log(lpStart->flEchoTime), log(lpFinish->flEchoTime), flRatio));
+    lpResult->flEchoDepth = lerp(lpStart->flEchoDepth, lpFinish->flEchoDepth, flRatio);
+    lpResult->flModulationTime = (float)exp(lerp(log(lpStart->flModulationTime), log(lpFinish->flModulationTime), flRatio));


Suggested change

lpResult->flModulationTime = (float)exp(lerp(log(lpStart->flModulationTime), log(lpFinish->flModulationTime), flRatio));

lpResult->flModulationTime = expf(lerp(log(lpStart->flModulationTime), logf(lpFinish->flModulationTime), flRatio));

Hoikas · 2025-02-22T00:59:38Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp

+    lpResult->flHFReference = (float)exp(lerp(log(lpStart->flHFReference), log(lpFinish->flHFReference), flRatio));
+    lpResult->flLFReference = (float)exp(lerp(log(lpStart->flLFReference), log(lpFinish->flLFReference), flRatio));


Suggested change

lpResult->flHFReference = (float)exp(lerp(log(lpStart->flHFReference), log(lpFinish->flHFReference), flRatio));

lpResult->flLFReference = (float)exp(lerp(log(lpStart->flLFReference), log(lpFinish->flLFReference), flRatio));

lpResult->flHFReference = expf(lerp(logf(lpStart->flHFReference), logf(lpFinish->flHFReference), flRatio));

lpResult->flLFReference = expf(lerp(logf(lpStart->flLFReference), logf(lpFinish->flLFReference), flRatio));

Hoikas · 2025-02-22T01:03:46Z

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.h

@@ -201,18 +189,16 @@ class plEAXSource
    friend class plEAXSourceSettings;
    friend class plEAXSourceSoftSettings;

-    plEAXSource();
-    virtual ~plEAXSource();
+    plEAXSource() : fInit(false) {}


Hoikas · 2025-02-22T01:04:44Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.cpp

+
+/* Helper functions for converting to EFX from deprecated EAX values */
+
+#include <math.h>


Let's move this include to the top of the file.

Hoikas · 2025-02-22T01:05:04Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.cpp

+    return 2000.0f * log10f(gain);
+}
+
+LPEFXEAXREVERBPROPERTIES ConvertEAXToEFX(const LPEAXLISTENERPROPERTIES eax)


Suggested change

LPEFXEAXREVERBPROPERTIES ConvertEAXToEFX(const LPEAXLISTENERPROPERTIES eax)

static LPEFXEAXREVERBPROPERTIES ConvertEAXToEFX(const LPEAXLISTENERPROPERTIES eax)

Hoikas · 2025-02-22T01:05:14Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.cpp

+    return efx;
+}
+
+LPEAXLISTENERPROPERTIES ConvertEFXToEAX(const LPEFXEAXREVERBPROPERTIES efx)


Suggested change

LPEAXLISTENERPROPERTIES ConvertEFXToEAX(const LPEFXEAXREVERBPROPERTIES efx)

static LPEAXLISTENERPROPERTIES ConvertEFXToEAX(const LPEFXEAXREVERBPROPERTIES efx)

Hoikas · 2025-02-22T01:06:02Z

Sources/Plasma/PubUtilLib/plAudio/plEAXListenerMod.h

+#include <efx.h>
+#include <efx-presets.h>


It would be nice to avoid including this library header in our headers. Are there any forward declarations we can use?

patmauro · 2025-02-22T01:51:24Z

Given that we have lots of config files running around out there that use the command Audio.UseEAX, I think it's critical that the command remain named thusly. I realize that this is a someone inaccurate name, but sometimes we have to make concessions for ease of use.

Just FYI, I noticed that the "old" ini I cleared out appeared to already have entries for both Audio.UseEAX and Audio.UseEFX - so it seems like this had already been happily working in parallel prior to this PR, and something about the specific changes here may have simply rendered the "EAX" syntax invalid - not to mention, it seems to suggest that the config file seems to have made it through the switchover to the "EFX" syntax with no issues, so long as the legacy term was still considered valid.

So it might be sufficient to revert whatever did that, but - to your point, maybe consistently using the legacy term (at least internally) would be best. In any case, just wanted to provide that additional context - I trust you guys will determine what makes the most sense here. 😄

Deledrius added Client Hacktoberfest Enhancement Non-critical feature addition labels Oct 8, 2021

Deledrius force-pushed the EFX branch from 939b9f4 to bba587e Compare October 8, 2021 00:30

dpogue reviewed Oct 8, 2021

View reviewed changes

Sources/Plasma/PubUtilLib/plAudio/plAudioSystem.cpp Outdated Show resolved Hide resolved

Hoikas reviewed Oct 8, 2021

View reviewed changes

Sources/Tools/MaxComponent/plAudioComponents.cpp Outdated Show resolved Hide resolved

Sources/Tools/MaxComponent/plAudioComponents.cpp Outdated Show resolved Hide resolved

Deledrius force-pushed the EFX branch from bba587e to 17388ef Compare October 8, 2021 00:47

Hoikas reviewed Oct 8, 2021

View reviewed changes

zrax added the hacktoberfest-accepted label Oct 8, 2021

dpogue reviewed Oct 10, 2021

View reviewed changes

Sources/Plasma/PubUtilLib/plAudio/plEAXEffects.cpp Outdated Show resolved Hide resolved

patmauro mentioned this pull request Jul 22, 2023

Remove references to EAX from player-facing UI H-uru/moul-assets#239

Closed

dpogue linked an issue Sep 9, 2023 that may be closed by this pull request

Cleanup sound to remove EAX dependencies #8

Open

patmauro mentioned this pull request Nov 14, 2023

Need to Remove EAX references from UI H-uru/moul-assets#247

Closed

Deledrius mentioned this pull request Mar 28, 2024

Fix plEAXListenerMod.h to be includable from outside libHSPlasma itself H-uru/libhsplasma#284

Merged

Deledrius force-pushed the EFX branch 2 times, most recently from 9ec7646 to 90a9fdf Compare February 21, 2025 02:25

dpogue reviewed Feb 21, 2025

View reviewed changes

Hoikas reviewed Feb 22, 2025

View reviewed changes

Restore EAX effects through OpenAL's EFX.

07ca251

Deledrius force-pushed the EFX branch from 90a9fdf to 8ab4b9e Compare February 22, 2025 21:40

Add suggestions from code review and style fixes.

2431e4f

Deledrius force-pushed the EFX branch from 8ab4b9e to 2431e4f Compare February 22, 2025 22:07

	void plEAXListenerMod::SetFromEFXPreset(EFXEAXREVERBPROPERTIES preset)
	void plEAXListenerMod::SetFromEFXPreset(const EFXEAXREVERBPROPERTIES& preset)

	void SetFromEFXPreset(EFXEAXREVERBPROPERTIES preset);
	void SetFromEFXPreset(const EFXEAXREVERBPROPERTIES& preset);

		// Set params based on artist selections
		EAXREVERBPROPERTIES *eaxProps = new EAXREVERBPROPERTIES;

	inline float lerp(float start, float finish, float ratio) {
	constexpr static float lerp(float start, float finish, float ratio) {


		plEAXListener &plEAXListener::GetInstance()
		bool ReverbPropsInterpolate(LPEFXEAXREVERBPROPERTIES lpStart, LPEFXEAXREVERBPROPERTIES lpFinish,

	bool ReverbPropsInterpolate(LPEFXEAXREVERBPROPERTIES lpStart, LPEFXEAXREVERBPROPERTIES lpFinish,
	static bool ReverbPropsInterpolate(LPEFXEAXREVERBPROPERTIES lpStart, LPEFXEAXREVERBPROPERTIES lpFinish,

	lpResult->flModulationTime = (float)exp(lerp(log(lpStart->flModulationTime), log(lpFinish->flModulationTime), flRatio));
	lpResult->flModulationTime = expf(lerp(log(lpStart->flModulationTime), logf(lpFinish->flModulationTime), flRatio));

		lpResult->flHFReference = (float)exp(lerp(log(lpStart->flHFReference), log(lpFinish->flHFReference), flRatio));
		lpResult->flLFReference = (float)exp(lerp(log(lpStart->flLFReference), log(lpFinish->flLFReference), flRatio));


		/* Helper functions for converting to EFX from deprecated EAX values */

		#include <math.h>

	LPEFXEAXREVERBPROPERTIES ConvertEAXToEFX(const LPEAXLISTENERPROPERTIES eax)
	static LPEFXEAXREVERBPROPERTIES ConvertEAXToEFX(const LPEAXLISTENERPROPERTIES eax)

	LPEAXLISTENERPROPERTIES ConvertEFXToEAX(const LPEFXEAXREVERBPROPERTIES efx)
	static LPEAXLISTENERPROPERTIES ConvertEFXToEAX(const LPEFXEAXREVERBPROPERTIES efx)

Restore EAX effects through OpenAL's EFX. #1000

Are you sure you want to change the base?

Restore EAX effects through OpenAL's EFX. #1000

Conversation

Deledrius commented Oct 8, 2021

Hoikas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmauro commented Jul 21, 2023 • edited Loading

Deledrius commented Jul 21, 2023 • edited Loading

patmauro commented Jul 21, 2023 • edited Loading

Deledrius commented Jul 21, 2023

dpogue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmauro commented Feb 21, 2025

dpogue commented Feb 21, 2025

Deledrius commented Feb 21, 2025 • edited Loading

Hoikas commented Feb 22, 2025

Hoikas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patmauro commented Feb 22, 2025

patmauro commented Jul 21, 2023 •

edited

Loading

Deledrius commented Jul 21, 2023 •

edited

Loading

patmauro commented Jul 21, 2023 •

edited

Loading

Deledrius commented Feb 21, 2025 •

edited

Loading