alex/nih-plug
1
0
Fork 0
Code Activity
fork of https://github.com/robbert-vdh/nih-plug
416 commits 1 branch 0 tags 4.3 MiB
Rust 99.7%
CSS 0.3%
Go to file
Robbert van der Helm 72c3e00510 Create plugin bundles in target/bundled 
It's going to get a bit crowded otherwise once we add more formats.
2022-02-26 20:04:41 +01:00
.cargo Compile the xtask target in release mode 2022-02-16 16:51:36 +01:00
.github/workflows Create plugin bundles in target/bundled 2022-02-26 20:04:41 +01:00
nih_plug_derive Add a derive macro for Enum parameters 2022-02-14 16:16:05 +01:00
nih_plug_egui Relicense under the ISC license 2022-02-12 16:04:46 +01:00
plugins Add nightly links that don't require a login 2022-02-16 16:02:41 +01:00
src Fix events not working in release builds 2022-02-15 23:11:50 +01:00
xtask Create plugin bundles in target/bundled 2022-02-26 20:04:41 +01:00
.gitignore Initial commit 2022-01-24 21:00:37 +01:00
bundler.toml Add slightly more info to the bundler config 2022-02-15 22:33:44 +01:00
Cargo.lock Add a bundler module for parsing exported symbols 2022-02-26 20:00:32 +01:00
Cargo.toml Move features section in main Cargo.toml 2022-02-15 18:13:47 +01:00
LICENSE Relicense under the ISC license 2022-02-12 16:04:46 +01:00
README.md Add nightly links that don't require a login 2022-02-16 16:02:41 +01:00

README.md

NIH-plug

Tests

This is a work in progress JUCE-lite-lite written in Rust to do some experiments with, as well as a small collection of plugins. 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.

Table of contents

Plugins

Check each plugin's readme for more details on what the plugin actually does and for download links.

  • Diopser is a totally original phase rotation plugin. Useful for oomphing up kickdrums and basses, transforming synths into their evil phase-y cousin, and making everything sound like a cheap Sci-Fi laser beam.

Framework

Current status

It actually works! There's still lots of small things to implement, but the core functionality and including basic GUI support are there. Currently the Windows version has only been tested under Wine with yabridge, and the macOS version hasn't been tested at all. Feel free to be the first one!

Building

NIH-plug 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

The framework, its libraries, and the example plugins in plugins/examples/ are all licensed under the ISC license. However, the VST3 bindings used by nih_export_vst3!() are licensed under the GPLv3 license. This means that unless you replace these bindings with your own bindings made from scratch, any VST3 plugins built with NIH-plug need to be able to comply with the terms of the GPLv3 license.

The other plugins in the plugins/ directory may be licensed under the GPLv3 license. Check the plugin's Cargo.toml file for more information.