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

Modeled CLAP-shaped plugin adapters for SIM audio graph processors (no native CLAP hosting).
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

use sim_kernel::Result;
use sim_lib_audio_graph_core::{PortDecl, PortDir, PortMedia};
use sim_lib_plugin_core::{
    ParameterDescriptor, ParameterKind, PluginDescriptor, PluginFormat, PluginId,
};

/// Builds a CLAP-format audio-effect [`PluginDescriptor`].
///
/// Delegates to `PluginDescriptor::audio_effect` with `PluginFormat::Clap`,
/// producing a symmetric `channels`-wide audio in/out effect identified by
/// `stable_id` and presented as `name`.
pub fn clap_audio_effect_descriptor(
    stable_id: impl Into<String>,
    name: impl Into<String>,
    channels: u16,
) -> Result<PluginDescriptor> {
    PluginDescriptor::audio_effect(PluginFormat::Clap, stable_id, name, channels)
}

/// Builds the CLAP gain fixture descriptor.
///
/// A stereo audio effect (`org.sim.gain`, "SIM Gain") carrying a single
/// floating-point "gain" parameter ranging 0.0 to 2.0 with a default of 1.0.
pub fn clap_gain_descriptor() -> Result<PluginDescriptor> {
    Ok(
        clap_audio_effect_descriptor("org.sim.gain", "SIM Gain", 2)?.with_parameter(
            ParameterDescriptor::new(0, "gain", "Gain", 0.0, 2.0, 1.0)?
                .with_kind(ParameterKind::Float),
        ),
    )
}

/// Builds the CLAP subtractive-synth fixture descriptor.
///
/// An instrument (`org.sim.subtractive-synth`) with one event input port, a
/// stereo audio output port, and an "output-gain" parameter ranging 0.0 to 1.0
/// with a default of 0.25.
pub fn clap_synth_descriptor() -> Result<PluginDescriptor> {
    let mut descriptor = PluginDescriptor::new(
        PluginId::new(PluginFormat::Clap, "org.sim.subtractive-synth")?,
        "SIM Subtractive Synth",
        "sim",
        env!("CARGO_PKG_VERSION"),
    )?;
    descriptor
        .ports
        .push(PortDecl::new("events-in", PortMedia::Event, PortDir::In, 1));
    descriptor.ports.push(PortDecl::new(
        "audio-out",
        PortMedia::Audio,
        PortDir::Out,
        2,
    ));
    descriptor.parameters.push(ParameterDescriptor::new(
        0,
        "output-gain",
        "Output Gain",
        0.0,
        1.0,
        0.25,
    )?);
    Ok(descriptor)
}