1
0
Fork 0
Go to file
Robbert van der Helm b61d17fee9 Require all parameters to have a Display instance
So their value can be easily formatted in UIs.
2022-02-09 19:45:16 +01:00
.cargo Add an xtask binary target for running tasks 2022-01-29 17:31:51 +01:00
.github/workflows Add even more dependencies 2022-02-06 03:14:41 +01:00
nih_plug_derive Move parameter implementation details to a module 2022-02-01 21:01:28 +01:00
nih_plug_egui Move the main slider to a function 2022-02-09 19:17:46 +01:00
plugins/examples Drag very granularly with Shift+Drag 2022-02-09 12:24:01 +01:00
src Require all parameters to have a Display instance 2022-02-09 19:45:16 +01:00
xtask Fix the printed VST3 bundle path 2022-02-06 01:35:12 +01:00
.gitignore Initial commit 2022-01-24 21:00:37 +01:00
Cargo.lock Use a patched patched baseview fixing modifiers 2022-02-09 18:41:30 +01:00
Cargo.toml Use a patched {egui-,}baseview for X11 GL contexts 2022-02-07 21:58:59 +01:00
COPYING Initial commit 2022-01-24 21:00:37 +01:00
README.md Mention the current status in the readme 2022-02-06 18:31:49 +01:00

NIH-plug

Tests

This is a work in progress JUCE-lite-lite written in Rust to do some experiments with. The idea is to have a statefull but simple plugin API that gets rid of as much unnecessary ceremony wherever possible, while also keeping the amount of magic to minimum. Since this is not quite meant for general use just yet, the plugin API is limited to the functionality I needed and I'll expose more functionality as I need it. See the documentation comment in the Plugin trait for an incomplete list of missing functionality.

Current status

It actually mostly work! There's still lots of small things to implement, but the core functionality and including basic GUI support are there. That is, when using Linux. Currently the event loop has not yet been implemented for Windows and macOS.

Building

NIH-plug doesn't use any unstable features, and works with the latest stable Rust compiler.

After installing Rust you can compile any of the plugins in the plugins directory in the following way, replacing gain with the name of the plugin:

cargo xtask bundle gain --release --bundle-vst3

Example plugins

The best way to get an idea for what the API looks like is to look at the examples.

  • gain is a simple smoothed gain plugin that shows off a couple other parts of the API, like support for storing arbitrary serializable state.
  • gain-gui is the same plugin as gain, but with a GUI to control the parameter and a digital peak meter.
  • sine is a simple test tone generator plugin with frequency smoothing that can also make use of MIDI input instead of generating a static signal based on the plugin's parameters.

Licensing

Right now everything is licensed under the GPLv3+ license, partly because the VST3 bindings used are also GPL licensed. I may split off the VST3 wrapper into its own crate and relicense the core library under a more permissive license later.