Need help with vst-rs?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

RustAudio
689 Stars 70 Forks MIT License 400 Commits 32 Opened issues

Description

VST 2.4 API implementation in rust. Create plugins or hosts. Previously rust-vst on the RustDSP group.

Services available

!
?

Need anything else?

Contributors list

vst-rs

crates.io dependency status Discord Chat Discourse topics

vst-rs
is a library for creating VST2 plugins in the Rust programming language.

This library is a work in progress, and as such it does not yet implement all functionality. It can create basic VST plugins without an editor interface.

Note: If you are upgrading from a version prior to 0.2.0, you will need to update your plugin code to be compatible with the new, thread-safe plugin API. See the

transfer_and_smooth
example for a guide on how to port your plugin.

Library Documentation

Documentation for released versions can be found here.

Development documentation (current

master
branch) can be found here.

Crate

This crate is available on crates.io. If you prefer the bleeding-edge, you can also include the crate directly from the official Github repository.

# get from crates.io.
vst = "0.2.1"
# get directly from Github.  This might be unstable!
vst = { git = "https://github.com/rustaudio/vst-rs" }

Usage

To create a plugin, simply create a type which implements the

Plugin
trait. Then call the
plugin_main
macro, 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 vst;

use vst::plugin::{HostCallback, Info, Plugin};

struct BasicPlugin;

impl Plugin for BasicPlugin { fn new(_host: HostCallback) -> Self { 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 "]

[dependencies] vst = { git = "https://github.com/rustaudio/vst-rs" }

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

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

Special Thanks

Marko Mijalkovic for initiating this project

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.