sim-lib-plugin-core 0.1.0-rc.1

Common plugin descriptors, state, and graph adapters.
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

#![forbid(unsafe_code)]
#![deny(missing_docs)]
//! Common plugin descriptors, state, and graph adapters.
//!
//! ```rust
//! use sim_lib_plugin_core::{
//!     ParameterDescriptor, PluginDescriptor, PluginFormat, PluginState,
//! };
//!
//! let descriptor = PluginDescriptor::audio_effect(
//!     PluginFormat::Sim,
//!     "org.sim.doc-gain",
//!     "Doc Gain",
//!     2,
//! )
//! .unwrap()
//! .with_parameter(ParameterDescriptor::new(0, "gain", "Gain", 0.0, 2.0, 1.0).unwrap());
//!
//! assert_eq!(descriptor.parameter(0).unwrap().plain_to_normalized(1.0), 0.5);
//!
//! let mut state = PluginState::new();
//! state.set_param(0, 1.0);
//! let rebuilt = PluginState::from_expr(&state.to_expr()).unwrap();
//! assert_eq!(rebuilt.param(0), Some(1.0));
//! ```

mod adapter;
mod capability;
mod citizen;
mod descriptor;
mod runtime;
mod state;

pub use adapter::{HostedPluginProcessor, PluginInstance, ProcessorPlugin};
pub use capability::{AudioPluginCapability, CapabilitySet};
pub use citizen::{PluginDescriptorRecord, plugin_descriptor_class_symbol};
pub use descriptor::{
    ParameterDescriptor, ParameterKind, PluginDescriptor, PluginFormat, PluginId, PluginLoadSpec,
};
pub use runtime::{install_plugin_core_lib, plugin_core_symbols};
pub use state::PluginState;

#[cfg(test)]
mod tests;