mirror of
https://codeberg.org/unspeaker/tek.git
synced 2025-12-06 11:46:41 +01:00
112 lines
4.5 KiB
Markdown
112 lines
4.5 KiB
Markdown
# vst-rs
|
||
[![crates.io][crates-img]][crates-url]
|
||
[](https://deps.rs/repo/github/rustaudio/vst-rs)
|
||
[![Discord Chat][discord-img]][discord-url]
|
||
[![Discourse topics][dc-img]][dc-url]
|
||
|
||
> **Notice**: `vst-rs` is deprecated.
|
||
>
|
||
> This crate is no longer actively developed or maintained. VST 2 has been [officially discontinued](http://web.archive.org/web/20210727141622/https://www.steinberg.net/en/newsandevents/news/newsdetail/article/vst-2-coming-to-an-end-4727.html) and it is [no longer possible](https://forum.juce.com/t/steinberg-closing-down-vst2-for-good/27722/25) to acquire a license to distribute VST 2 products. It is highly recommended that you make use of other libraries for developing audio plugins and plugin hosts in Rust.
|
||
>
|
||
> If you're looking for a high-level, multi-format framework for developing plugins in Rust, consider using [NIH-plug](https://github.com/robbert-vdh/nih-plug/) or [`baseplug`](https://github.com/wrl/baseplug/). If you're looking for bindings to specific plugin APIs, consider using [`vst3-sys`](https://github.com/RustAudio/vst3-sys/), [`clap-sys`](https://github.com/glowcoil/clap-sys), [`lv2(-sys)`](https://github.com/RustAudio/rust-lv2), or [`auv2-sys`](https://github.com/glowcoil/auv2-sys). If, despite the above warnings, you still have a need to use the VST 2 API from Rust, consider using [`vst2-sys`](https://github.com/RustAudio/vst2-sys) or generating bindings from the original VST 2 SDK using [`bindgen`](https://github.com/rust-lang/rust-bindgen).
|
||
|
||
`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`](examples/transfer_and_smooth.rs) example for a guide on how
|
||
to port your plugin.
|
||
|
||
## Library Documentation
|
||
|
||
Documentation for **released** versions can be found [here](https://docs.rs/vst/).
|
||
|
||
Development documentation (current `master` branch) can be found [here](https://rustaudio.github.io/vst-rs/vst/).
|
||
|
||
## Crate
|
||
This crate is available on [crates.io](https://crates.io/crates/vst). If you prefer the bleeding-edge, you can also
|
||
include the crate directly from the official [Github repository](https://github.com/rustaudio/vst-rs).
|
||
|
||
```toml
|
||
# get from crates.io.
|
||
vst = "0.3"
|
||
```
|
||
```toml
|
||
# 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`
|
||
|
||
```rust
|
||
#[macro_use]
|
||
extern crate vst;
|
||
|
||
use vst::prelude::*;
|
||
|
||
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`
|
||
|
||
```toml
|
||
[package]
|
||
name = "basic_vst"
|
||
version = "0.0.1"
|
||
authors = ["Author <author@example.com>"]
|
||
|
||
[dependencies]
|
||
vst = { git = "https://github.com/rustaudio/vst-rs" }
|
||
|
||
[lib]
|
||
name = "basicvst"
|
||
crate-type = ["cdylib"]
|
||
```
|
||
|
||
[crates-img]: https://img.shields.io/crates/v/vst.svg
|
||
[crates-url]: https://crates.io/crates/vst
|
||
[discord-img]: https://img.shields.io/discord/590254806208217089.svg?label=Discord&logo=discord&color=blue
|
||
[discord-url]: https://discord.gg/QPdhk2u
|
||
[dc-img]: https://img.shields.io/discourse/https/rust-audio.discourse.group/topics.svg?logo=discourse&color=blue
|
||
[dc-url]: https://rust-audio.discourse.group
|
||
|
||
#### Packaging on OS X
|
||
|
||
On OS X VST plugins are packaged inside 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](https://github.com/overdrivenpotato) for [initiating this project](https://github.com/overdrivenpotato/rust-vst2)
|