Initial implementation adding support for audio effects and filters using OpenAL #2772

rh101 · 2025-09-18T15:28:11Z

Describe your changes

Reverb effect is implemented, with preset reverb settings available that developers can use (in AudioEffects.h)

A simple test that loops through a few of the reverb effects is in the audio test section of cpp-tests.

@halx99 I wasn't sure what to name the files, so if you need anything changed, then let me know and I'll sort it out.

Issue ticket number and link

#2726

Checklist before requesting a review

For each PR

Add Copyright if it missed:
- "Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md)."
I have performed a self-review of my code.

Optional:
- I have checked readme and add important infos to this PR.
- I have added/adapted some tests too.

For core/new feature PR

I have checked readme and add important infos to this PR.
I have added thorough tests.

Axmol 3.x ------------------------------------------------------------

For each 3.x PR

Check the '#include "axmol.h"' and replace it with the needed headers.

Add reverb effect support with presets

rh101 · 2025-09-18T15:57:57Z

@halx99 For Apple and Wasm, does the alext.h not exist on those platforms? I can see this in the alconfig.h:

#if !defined(__APPLE__) && !defined(__EMSCRIPTEN__)
#    if !defined(AX_USE_ALSOFT)
#        define AX_USE_ALSOFT 1
#    endif
#endif

#if defined(__EMSCRIPTEN__)
    #import <AL/al.h>
    #import <AL/alc.h>
    #define MAX_AUDIOINSTANCES 128
#else
    #if !AX_USE_ALSOFT
    #    import <OpenAL/al.h>
    #    import <OpenAL/alc.h>
    #    define MAX_AUDIOINSTANCES 128
    #else
    #    define AL_ALEXT_PROTOTYPES 1
    #    include "AL/al.h"
    #    include "AL/alc.h"
    #    include "AL/alext.h"
    #    define MAX_AUDIOINSTANCES 128
    #endif
#endif

This reverts commit 22c88d0.

rh101 · 2025-09-18T16:18:31Z

Is ALC_EXT_EFX is not defined, and not equal to 1, then the effects code will no longer be compiled, and won't be supported for that build. Other than that, I'm not sure how else to deal with this at the moment.

Clear effect slots if effect is disabled.

halx99 · 2025-09-19T01:37:57Z

I think, the class AudioEffectsExtensionOpenAL should be rename to AudioEffectsExtension due to the audio engine only based on openal

halx99 · 2025-09-19T05:45:28Z

ALC_EXT_EFX

wasm alext.h exist, but no ALC_EXT_EFX in it: https://github.com/emscripten-core/emscripten/blob/main/system/include/AL/alext.h

rh101 · 2025-09-19T05:51:49Z

wasm alext.h exist, but no ALC_EXT_EFX in it: https://github.com/emscripten-core/emscripten/blob/main/system/include/AL/alext.h

That is unfortunate, so it means audio effects will not be supported on both WASM and iOS/MacOS. All other target platforms seem to work fine.

halx99 · 2025-09-19T05:58:03Z

Yes, you can just check whether AX_USE_ALSOFT defined in cmake and c++ files.

rh101 · 2025-09-19T06:31:03Z

Yes, you can just check whether AX_USE_ALSOFT defined in cmake and c++ files.

Will do.

core/audio/AudioEffects.h

halx99 · 2025-09-19T15:22:15Z

That is unfortunate, so it means audio effects will not be supported on both WASM and iOS/MacOS. All other target platforms seem to work fine.

On dev(v3), axmol can forcing AX_USE_ALSOFT=ON for all platforms include wasm (PR #2775) , macos, ios. in the future maybe v3, we can make openal-soft as default OpenAL vender for all platforms which is supported by axmol.

Rename setReverbSettings to more appropriate setReverbProperties

rh101 · 2025-09-19T23:06:09Z

On dev(v3), axmol can forcing AX_USE_ALSOFT=ON for all platforms include wasm (PR #2775) , macos, ios. in the future maybe v3, we can make openal-soft as default OpenAL vender for all platforms which is supported by axmol.

That would be good, keeping a consistent interface and feature set for developers on all platforms.

core/audio/alconstants.h

…gets where they do not exist.

halx99 · 2025-09-20T04:54:05Z

lgtm, will merge later

halx99 · 2025-09-20T07:55:01Z

I got error when merge to dev(v3), not sure does release/2.x works, will test later

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb hfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:47.975][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb lfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:47.977][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb hfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:50.974][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb lfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:50.976][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

halx99 · 2025-09-20T08:02:38Z

I got error when merge to dev(v3), not sure does release/2.x works, will test later

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb hfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:47.975][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb lfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:47.977][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb hfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:50.974][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

[ALSOFT] (WW) Error generated on context 0x2a2bfc32120, code 0xa003, "EAX Reverb lfreference out of range"
Exception thrown at 0x00007FFFF27A804A in cpp-tests.exe: Microsoft C++ exception: al::base_exception at memory location 0x000000FC68DFE990.
E/[2025-09-20 15:53:50.976][PID:74d4][TID:ba88]OpenAL error 0xA003 in D:\dev\simdsoft\axmol\axmol\audio\AudioEffectsExtension.cpp ax::AudioEffectsExtension::setEffectParamFloat 90

release/2.x same error

rh101 · 2025-09-20T08:03:01Z

I'll take a look

rh101 added 3 commits September 19, 2025 00:29

Add filter and effect support for OpenAL audio.

50ab795

Add reverb effect support with presets

Add reverb test

30c9154

Fix build issue

22c88d0

rh101 marked this pull request as draft September 18, 2025 15:52

rh101 added 3 commits September 19, 2025 02:07

Revert "Fix build issue"

6093b40

This reverts commit 22c88d0.

OpenAL effects API may not be supported on all platforms

74e032d

Fix build issue

2b4ce27

Do not generate new effect slot IDs if they already exist.

36bdd97

Clear effect slots if effect is disabled.

halx99 added this to the 2.9.0 milestone Sep 19, 2025

Rename AudioEffectsExtensionsOpenAL to AudioEffectsExtension

d2aa70a

rh101 marked this pull request as ready for review September 19, 2025 01:54

rh101 added 4 commits September 19, 2025 11:56

Rename EaxReverbSettings to ReverbSettings

722f9d2

Update formatting

f8615b0

Remove unused member

e3c6b53

Add comment. [skip ci]

4666e4f

Check for AX_USE_ALSOFT to enable support for audio effects

a076e60

halx99 reviewed Sep 19, 2025

View reviewed changes

core/audio/AudioEffects.h Show resolved Hide resolved

halx99 added the enhancement New feature or request label Sep 19, 2025

rh101 added 2 commits September 20, 2025 08:58

Update to use existing audio effect presets in OpenAL

8a5f990

Rename setReverbSettings to more appropriate setReverbProperties

Check for AX_USE_ALSOFT before including tests that depend on it

5eed460

rh101 marked this pull request as draft September 19, 2025 23:05

rh101 added 2 commits September 20, 2025 09:10

Add more checks for AX_USE_ALSOFT

26e4ec7

Fix build issue

c1deda2

halx99 previously approved these changes Sep 19, 2025

View reviewed changes

rh101 marked this pull request as ready for review September 19, 2025 23:40

halx99 reviewed Sep 20, 2025

View reviewed changes

core/audio/alconstants.h Outdated Show resolved Hide resolved

rh101 marked this pull request as draft September 20, 2025 02:23

Use existing constants from OpenAL and define dummy constants for tar…

68fdfbb

…gets where they do not exist.

rh101 dismissed halx99’s stale review via 68fdfbb September 20, 2025 02:55

Remove unnecessary include statement

9061aea

rh101 marked this pull request as ready for review September 20, 2025 03:26

halx99 approved these changes Sep 20, 2025

View reviewed changes

halx99 merged commit 862f3af into axmolengine:release/2.x Sep 20, 2025
15 checks passed

rh101 deleted the audio-reverb branch September 20, 2025 08:03

Uh oh!

Initial implementation adding support for audio effects and filters using OpenAL #2772

Initial implementation adding support for audio effects and filters using OpenAL #2772

Uh oh!

Conversation

rh101 commented Sep 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes

Issue ticket number and link

Checklist before requesting a review

For each PR

For core/new feature PR

Axmol 3.x ------------------------------------------------------------

For each 3.x PR

Uh oh!

rh101 commented Sep 18, 2025

Uh oh!

rh101 commented Sep 18, 2025

Uh oh!

halx99 commented Sep 19, 2025

Uh oh!

halx99 commented Sep 19, 2025

Uh oh!

rh101 commented Sep 19, 2025

Uh oh!

halx99 commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rh101 commented Sep 19, 2025

Uh oh!

Uh oh!

halx99 commented Sep 19, 2025

Uh oh!

rh101 commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

halx99 commented Sep 20, 2025

Uh oh!

Uh oh!

halx99 commented Sep 20, 2025

Uh oh!

halx99 commented Sep 20, 2025

Uh oh!

rh101 commented Sep 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rh101 commented Sep 18, 2025 •

edited

Loading

halx99 commented Sep 19, 2025 •

edited

Loading

rh101 commented Sep 19, 2025 •

edited

Loading