Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AudioEffectFilter description and functionality is incorrect #80391

Open
Tracked by #76797
nezvers opened this issue Aug 7, 2023 · 3 comments
Open
Tracked by #76797

AudioEffectFilter description and functionality is incorrect #80391

nezvers opened this issue Aug 7, 2023 · 3 comments

Comments

@nezvers
Copy link

nezvers commented Aug 7, 2023

Godot version

v4.1.1.stable.official [bd6af8e]

System information

Godot v4.1.1.stable - Windows 10.0.19045 - Vulkan (Mobile) - dedicated NVIDIA GeForce RTX 2070 SUPER (NVIDIA; 31.0.15.3203) - Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz (8 Threads)

Issue description

I have an audio engineering and audio forensic background and I'm making an ear training app, but run into problems:
AudioEffectFilter description: Allows frequencies other than the cutoff_hz to pass. is description of BandPassFilter functionality.
AudioEffectFilter functionality: It cuts everything above the cutoff_hz, making it a LowPassFilter.

Biggest frustration comes from the fact that there are all kinds of filters except the most essential ParametricEq (additive and subtractive frequency filtering with changeable frequency and resonance). And all hope fell on the AudioEffectFilter since it has gain property, but it doesn't function.

Steps to reproduce

  • add AudioStreamPlayer with music
  • add AudioEffectFilter to the master bus with cutoff_hz as 1000
  • high frequencies are inaudible

Minimal reproduction project

AudioEffectFilter.zip

@Calinou
Copy link
Member

Calinou commented Aug 8, 2023

Biggest frustration comes from the fact that there are all kinds of filters except the most essential ParametricEq (additive and subtractive frequency filtering with changeable frequency and resonance).

This is implemented by #30578, but it needs a rebase and further work before it can be merged.

@nezvers
Copy link
Author

nezvers commented Aug 8, 2023

Amazing news!
But what's going on with confusing description and functionality

@Calinou
Copy link
Member

Calinou commented Aug 8, 2023

But what's going on with confusing description and functionality

I think the expected behavior should remain to preserve compatibility with existing projects. We should only modify the class reference description to match the actual behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants