ferraus-plugins 0.1.0

CLAP and VST3 plugin scanning, the out-of-process plugin host protocol, and the installable sounds registry for ferraus
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

//! # ferraus-plugins
//!
//! Headless CLAP and VST3 plugin hosting for ferraus, always out of process, plus the
//! installable sounds registry.
//!
//! * [`protocol`] — the wire protocol spoken with `ferraus-plughost` (CLAP) and
//!   `ferraus-plughost-vst3` (VST3); see `PROTOCOL.md`.
//! * [`host_rt`] — the host-process side of the protocol, shared by both host binaries.
//!
//! With the default `ops` feature:
//!
//! * [`client`] — spawns a host process per plugin instance, with a watchdog.
//! * [`api`] — [`api::render_instrument`] and [`api::process_effect`], the entry points used
//!   by `ferraus-synth` and other crates.
//! * [`scan`] — plugin discovery and the scan cache; [`resolve`] — the sound resolver
//!   (aliases, installed sounds, `--sound-path` folders).
//! * [`sounds`] — the signed sounds registry and `sounds ...` commands.

pub mod host_rt;
pub mod protocol;

#[cfg(feature = "ops")]
pub mod api;
#[cfg(feature = "ops")]
pub mod client;
#[cfg(feature = "ops")]
mod ops;
#[cfg(feature = "ops")]
pub mod resolve;
#[cfg(feature = "ops")]
pub mod scan;
#[cfg(feature = "ops")]
pub mod sounds;

#[cfg(feature = "ops")]
pub use api::{
    process_effect, process_effect_with, render_instrument, render_instrument_with, MidiEvent, MidiEventKind,
    PluginFormat, PluginOptions, PluginRef, PluginRun,
};

/// Ops this crate contributes to the command registry.
#[cfg(feature = "ops")]
pub fn ops() -> Vec<ferraus_core::OpSpec> {
    ops::ops()
}