Skip to content
VST 2.4 API implementation in rust. Create plugins or hosts.
Rust PowerShell Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples sine_synth now reports correctly that it can receive midi events. als… Jun 6, 2017
src Add proper docs to function Jun 13, 2017
.appveyor.yml Update appveyor build config Apr 12, 2016
.gitignore Add dimension expander example Dec 7, 2016
.travis.yml Fix doc redirect Apr 24, 2015
Cargo.toml Update libraries to their latest minor version. May 20, 2017
LICENSE
README.md
appveyor_rust_install.ps1
osx_vst_bundler.sh Fixed a naming error in the MacOS build script. Mar 26, 2017

README.md

rust-vst2

Travis Build Appveyor Build crates.io

A library to help facilitate creating VST plugins in rust.

This library is a work in progress and as such does not yet implement all opcodes. It is enough to create basic VST plugins without an editor interface.

Please note: This api may be subject to rapid changes and the current state of this library is not final.

Library Documentation

TODO

  • Implement all opcodes
  • Proper editor support (possibly conrod + sdl2?)
  • Write more tests
  • Provide better examples

Usage

To create a plugin, simply create a type which implements plugin::Plugin and std::default::Default. Then call the macro plugin_main!, which will export the necessary functions and handle dealing with the rest of the API.

Example Plugin

A simple plugin that bears no functionality. The provided Cargo.toml has a crate-type directive which builds a dynamic library, usable by any VST host.

src/lib.rs

#[macro_use]
extern crate vst2;

use vst2::plugin::{Info, Plugin};

#[derive(Default)]
struct BasicPlugin;

impl Plugin for BasicPlugin {
    fn get_info(&self) -> Info {
        Info {
            name: "Basic Plugin".to_string(),
            unique_id: 1357, // Used by hosts to differentiate between plugins.

            ..Default::default()
        }
    }
}

plugin_main!(BasicPlugin); // Important!

Cargo.toml

[package]
name = "basic_vst"
version = "0.0.1"
authors = ["Author <author@example.com>"]

[dependencies]
vst2 = "0.0.1"

[lib]
name = "basicvst"
crate-type = ["dylib"]

Packaging on OS X

On OS X VST plugins are packaged inside of loadable bundles. To package your VST as a loadable bundle you may use the osx_vst_bundler.sh script this library provides. 

Example: 

./osx_vst_bundler.sh Plugin target/release/plugin.dylib
Creates a Plugin.vst bundle
You can’t perform that action at this time.