Struct PluginLoader 

pub struct PluginLoader { /* private fields */ }

Owner of all loaded plugin cdylibs.

See the module docs for the lifetime / RT-safety contract.

Implementations

impl PluginLoader

pub fn new() -> Self

Construct an empty loader.

pub fn load(&mut self, path: &Path) -> Result<PluginId>

Load and ABI-verify a plugin cdylib, returning its assigned id.

Steps

1. Validate the path (must be an existing, readable file).
2. dlopen the library.
3. Look up and call audio_plugin_abi_magic; require AUDIO_PLUGIN_ABI_MAGIC.
4. Look up and call audio_plugin_abi_version; require a major match (see is_abi_compatible).
5. Look up audio_plugin_metadata and copy out an owned PluginMetadata.
6. Look up audio_plugin_create (required) and audio_plugin_destroy (optional).
7. Register the plugin under a fresh PluginId.

Loading the same path twice is permitted: each call receives its own id and its own dlopen handle.

Errors

• PluginError::InvalidPath — missing file or non-UTF-8 path.
• PluginError::LibraryLoad — dlopen failed.
• PluginError::SymbolMissing — a required symbol is absent.
• PluginError::InvalidMetadata — magic mismatch or bad metadata.
• PluginError::AbiVersionMismatch — ABI major differs.

pub fn unload(&mut self, id: PluginId) -> Result<()>

Unload a plugin, dropping its library (dlclose).

The caller must ensure no AudioNode instantiated from this plugin is still alive — the adapter owns an opaque handle into the plugin’s memory and calling it after dlclose is undefined behaviour.

Errors

Returns PluginError::NotLoaded when id is not registered.

pub fn get(&self, id: PluginId) -> Result<&LoadedPlugin>

Borrow a loaded plugin by id.

Errors

Returns PluginError::NotLoaded when id is not registered.

pub fn get_mut(&mut self, id: PluginId) -> Result<&mut LoadedPlugin>

Mutably borrow a loaded plugin by id.

Errors

Returns PluginError::NotLoaded when id is not registered.

pub fn metadata(&self, id: PluginId) -> Result<&PluginMetadata>

Metadata for a loaded plugin.

Errors

Returns PluginError::NotLoaded when id is not registered.

pub fn instantiate(&mut self, id: PluginId) -> Result<Box<dyn AudioNode>>

Instantiate a fresh AudioNode from a loaded plugin.

Runs on the setup thread; the returned node is then moved onto the RT thread by the caller.

Errors

Returns PluginError::NotLoaded when id is not registered.

pub fn is_loaded(&self, id: PluginId) -> bool

true when id is currently loaded.

pub fn len(&self) -> usize

Number of plugins currently loaded.

pub fn is_empty(&self) -> bool

true when no plugins are loaded.

pub fn ids(&self) -> Vec<PluginId>

All currently-registered plugin ids.

The order is unspecified (iteration order of the internal map).

Trait Implementations

impl Default for PluginLoader

fn default() -> Self

Returns the “default value” for a type.