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

Shelf Filter added #4352

Merged
merged 1 commit into from
Mar 29, 2023
Merged

Shelf Filter added #4352

merged 1 commit into from
Mar 29, 2023

Conversation

SteveDaulton
Copy link
Member

Resolves: Absence of a shelf filter in Audacity

Audacity has High-pass, Low-pass, and a Notch filter, but notable by its absence there is no shelf filter. This pull requests adds the missing filter. The filter can be set for High-shelf or Low-shelf.

  • [ x] I signed CLA
  • [ x] The title of the pull request describes an issue it addresses
  • [ x] If changes are extensive, then there is a sequence of easily reviewable commits
  • [ x] Each commit's message describes its purpose and effects
  • [ x] There are no behavior changes unnecessary for the stated purpose of the PR

Recommended:

  • [ x] Each commit compiles and runs on my machine without known undesirable changes of behavior

@petersampsonaudacity
Copy link

petersampsonaudacity commented Feb 23, 2023

Testing on W10 with @SteveDaulton 's branch build: audacity-win-3.3.0-alpha-20230223+9066b72-x64

The Shelf Filter appears in the Effects menu - BUT it appears in the below the line section and not in the EQ and Filters section of the Effect menu (which is where the High Pass and Low Pass filters properly reside):
image

@SteveDaulton
Copy link
Member Author

SteveDaulton commented Feb 23, 2023

BUT it appears in the below the line section and not in the EQ and Filters

In your EffectsMenuDefaults.xml file, you need to add <Effect>Shelf Filter</Effect> to whichever <Group> you want the effect to appear in.

When I built from source, the EffectsMenuDefaults.xml file was NOT copied into the build folder, so I'm guessing that menu sorting is a work in progress, probably with a view to making it user configurable. The EffectsMenuDefaults.xml file was recently moved from presets/EQDefaultCurves.xml to resources/EQDefaultCurves.xml, which may be why it wasn't copied using the build steps given in BUILDING.md, but I'm only guessing what the development team are intending.

I agree that the EQ and Filters group would be a logical place to put this effect in the default grouping.

@SteveDaulton
Copy link
Member Author

which may be why it wasn't copied using the build steps given in BUILDING.md,

I've asked Dmitry about this. He said: "I think it is only copied on install"

I've not set a default menu group - as it says in the pull request template: There are no behavior changes unnecessary for the stated purpose of the PR.

$name (_ "Shelf Filter")
$debugbutton disabled
$author (_ "Steve Daulton")
$release 2.4.0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this line correct?

Copy link
Member Author

@SteveDaulton SteveDaulton Mar 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure which line you are referring to, but lines 5 to 8 look fine.

The "release" version number refers to the plugin, not to the version of Audacity. It doesn't really matter what number is used so long as each subsequent update is higher than the previous. All of my plugins use the earliest Audacity version that I tested the plugin with as the initial "release" number, and then increments from that point. (I wrote Shelf Filter to be compatible with Audacity 2.4.0 and later). If there's any change to the plugin, the "release" number should be bumped.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant line 8 and this satisfies me.

@Paul-Licameli Paul-Licameli added the plugins Bugs with external plugins, such as VSTs, LV2, Vamp and Nyquist. label Mar 28, 2023
@Paul-Licameli Paul-Licameli added this to the Audacity 3.3 milestone Mar 28, 2023
@dozzzzer dozzzzer self-assigned this Mar 28, 2023
@dozzzzer
Copy link
Contributor

Tested on Windows and macOS

@petersampsonaudacity
Copy link

I have pre-prepared the documentation for this - including the zebra-table on the EGATs page in the Manual.

Once this gets pulled all I need to do is switch to the new Zebra-table

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
plugins Bugs with external plugins, such as VSTs, LV2, Vamp and Nyquist.
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

5 participants