Crate livi

source ·
Expand description

livi is a library for hosting LV2 plugins in Rust.

let world = livi::World::new();
const SAMPLE_RATE: f64 = 44100.0;
let features = world.build_features(livi::FeaturesBuilder::default());
let plugin = world
    // This is the URI for mda EPiano. You can use the `lv2ls` command line
    // utility to see all available LV2 plugins.
    .plugin_by_uri("http://drobilla.net/plugins/mda/EPiano")
    .expect("Plugin not found.");
let mut instance = unsafe {
    plugin
        .instantiate(features.clone(), SAMPLE_RATE)
        .expect("Could not instantiate plugin.")
};

// Where midi events will be read from.
let input = {
    let mut s = livi::event::LV2AtomSequence::new(&features, 1024);
    let play_note_data = [0x90, 0x40, 0x7f];
    s.push_midi_event::<3>(1, features.midi_urid(), &play_note_data)
        .unwrap();
    s
};

// This is where the audio data will be stored.
let mut outputs = [
    vec![0.0; features.max_block_length()], // For mda EPiano, this is the left channel.
    vec![0.0; features.max_block_length()], // For mda EPiano, this is the right channel.
];

// Set up the port configuration and run the plugin!
// The results will be stored in `outputs`.
let ports = livi::EmptyPortConnections::new()
    .with_atom_sequence_inputs(std::iter::once(&input))
    .with_audio_outputs(outputs.iter_mut().map(|output| output.as_mut_slice()));
unsafe { instance.run(features.max_block_length(), ports).unwrap() };

Re-exports

Modules

  • error
    Contains all the error types for the livi crate.
  • event
    Contains utility for dealing with LV2 events.

Structs

  • Features
    Features are used to provide functionality to plugins.
  • FeaturesBuilder
    A builder for Features objects.
  • Instance
    An instance of a plugin that can process inputs and outputs.
  • Plugin
    A plugin that can be used to instantiate plugin instances.
  • Port
    A port represents a connection (either input or output) to a plugin.
  • PortConnections
    All the inputs and outputs for an instance.
  • PortCounts
    The number of ports by type.
  • PortIndex
    The index of the port within a plugin.
  • Worker
    A plugin instance delegates non-realtime-safe work to a Worker, which performs the work asynchronously in another thread before sending the results back to the plugin.
  • WorkerManager
    Use a WorkerManager to own and run Workers. The WorkerManager will drop workers automatically once their associated plugin Instance has been dropped.
  • World
    Contains all plugins.

Enums

Type Aliases