NIH-plug

Safety Limiter is a utility designed to prevent ear damage by providing a non-subtle audio alert rather than traditional peak limiting.

Behavior:

• When an input peak exceeds 0 dBFS or a user-specified threshold, the plugin switches the output to play SOS in Morse code.
• The plugin also triggers this behavior if the input contains NaN or infinite values.
• The Morse code signal gradually fades out as the input returns to safe levels.

Unlike a brickwall limiter, this plugin does not alter the sound of your signal; it serves as an audible warning to prevent accidental exposure to high volumes during development or sound design.

This package provides an adapter to create GUIs based on egui for NIH-plug plugins. It achieves this through the use of egui-baseview.

Note: Before using this, consider whether nih_plug_iced or nih_plug_vizia might be better suited for your requirements.

To quickly get started with developing your own plugin using the NIH-plug framework, you can use the provided cookiecutter template.

https://github.com/robbert-vdh/nih-plug-template

To compile Spectral Compressor, ensure you have Rust installed, then use the cargo xtask command to bundle the plugin in release mode.

cargo xtask bundle spectral_compressor --release

To compile the Safety Limiter plugin, ensure you have Rust installed, then use the cargo xtask command to bundle the plugin in release mode.

cargo xtask bundle safety_limiter --release

To compile Buffr Glitch, ensure you have Rust installed, then use the cargo xtask command to bundle the plugin in release mode.

cargo xtask bundle buffr_glitch --release

NIH-plug provides a declarative parameter system using the #[derive(Params)] attribute.

To define parameters:

1. Add fields to your parameter struct using types like FloatParam, IntParam, BoolParam, or EnumParam<T>.
2. Assign stable IDs to each parameter using the #[id = "foobar"] attribute.
3. For discrete options, use a simple enum that derives the Enum trait with EnumParam<T>.
4. Group parameters using the #[nested(group = "...")] attribute.

To store non-parameter state that should be serialized (e.g., for presets), add fields to your Params object that implement Serde and annotate them with #[persist = "key"].

Crossover splits signals into two to five bands sent to auxiliary outputs. To access these bands in Bitwig Studio:

1. Click the 'Show plug-in multi-out chain selector' button.
2. Click 'Add missing chains' to enable the auxiliary outputs.

Note: The main output will not output any audio; all signal is routed to the auxiliary chains.

To avoid repeating this setup, right-click the device and save the configuration as a default preset. Alternatively, you can download a pre-configured Bitwig preset here and set it as the default for Crossover.

Since Cargo does not yet support running binaries directly from dependencies, you can use nih_plug_xtask as a library by creating a local xtask binary in your project. This allows you to use NIH-plug's bundling and utility commands without forking the repository.

Follow these steps to set it up:

1. Create an xtask binary: Run cargo new --bin xtask in your project root.
2. Add to Workspace: Add the xtask directory to your main Cargo.toml workspace members.
3. Add Dependency: Add nih_plug_xtask to your xtask/Cargo.toml dependencies.
4. Implement Main: Call nih_plug_xtask::main() from your new xtask/src/main.rs.
5. Configure Cargo Alias: Create a .cargo/config file to enable running the commands via cargo xtask.

Since cargo-nih-plug is not yet published to crates.io, you must install it directly from the GitHub repository using cargo install.

Note: If you are working within an NIH-plug project, it is recommended to use the built-in xtask integration instead of this standalone subcommand to ensure compatibility with your project version.

cargo install --git https://github.com/robbert-vdh/nih-plug.git cargo-nih-plug