Struct PluginRegistry 

pub struct PluginRegistry { /* private fields */ }

Central registry for all loaded codec plugins.

The registry maintains a list of registered plugins ordered by priority (descending) and provides methods to discover codecs, create decoders/encoders, and manage the plugin lifecycle.

Thread Safety

The registry uses interior mutability (RwLock) so it can be shared across threads. Multiple readers can query the registry concurrently; writes (registration) acquire an exclusive lock.

Priority

Higher priority values take precedence when multiple plugins provide the same codec. Use register_with_priority to supply a custom priority (default is 0).

Example

use oximedia_plugin::{PluginRegistry, StaticPlugin, CodecPluginInfo, PluginCapability};
use std::sync::Arc;
use std::collections::HashMap;

let registry = PluginRegistry::new();

let info = CodecPluginInfo {
    name: "example".to_string(),
    version: "0.1.0".to_string(),
    author: "Test".to_string(),
    description: "Example plugin".to_string(),
    api_version: oximedia_plugin::PLUGIN_API_VERSION,
    license: "MIT".to_string(),
    patent_encumbered: false,
};

let plugin = StaticPlugin::new(info)
    .add_capability(PluginCapability {
        codec_name: "test".to_string(),
        can_decode: true,
        can_encode: false,
        pixel_formats: vec![],
        properties: HashMap::new(),
    });

registry.register(Arc::new(plugin)).expect("should register");
assert!(registry.has_codec("test"));

Implementations

impl PluginRegistry

pub fn new() -> Self

Create a new empty plugin registry with default search paths.

pub fn empty() -> Self

Create a registry with no search paths (for testing).

pub fn add_search_path(&mut self, path: PathBuf)

Add a directory to search for plugins.

pub fn search_paths(&self) -> &[PathBuf]

Get the list of search paths.

pub fn default_search_paths() -> Vec<PathBuf>

Compute default search paths for plugin discovery.

The following paths are checked (in order):

1. $OXIMEDIA_PLUGIN_PATH (colon-separated on Unix, semicolon on Windows)
2. ~/.oximedia/plugins/
3. /usr/lib/oximedia/plugins/ (Unix only)
4. /usr/local/lib/oximedia/plugins/ (Unix only)

pub fn register(&self, plugin: Arc<dyn CodecPlugin>) -> PluginResult<()>

Register a static plugin instance with default priority (0).

The plugin is validated (API version check, duplicate name check) before being added to the registry.

Errors

Returns PluginError::ApiIncompatible if the API version does not match, or PluginError::AlreadyRegistered if a plugin with the same name is already loaded.

pub fn register_with_priority( &self, plugin: Arc<dyn CodecPlugin>, priority: i32, ) -> PluginResult<()>

Register a plugin with an explicit priority.

Plugins with a higher priority value are preferred when multiple plugins provide the same codec. Negative priorities are allowed.

Errors

Same as register.

pub fn unregister(&self, name: &str) -> PluginResult<()>

Unregister a plugin by name.

Errors

Returns PluginError::NotFound if no plugin with that name is registered.

pub fn load_plugin(&self, _path: &Path) -> PluginResult<()>

Load a plugin from a shared library file.

This is a stub that returns an error when the dynamic-loading feature is not enabled.

pub fn discover_plugins(&self) -> PluginResult<Vec<CodecPluginInfo>>

Discover plugins stub when dynamic loading is disabled.

pub fn list_plugins(&self) -> Vec<CodecPluginInfo>

List all registered plugins (in priority order, highest first).

pub fn list_codecs(&self) -> Vec<PluginCapability>

List all available codecs across all plugins.

pub fn find_decoder( &self, codec_name: &str, ) -> CodecResult<Box<dyn VideoDecoder>>

Find and create a decoder for a given codec name.

Searches all registered plugins (in priority order) for one that can decode the requested codec, and creates a new decoder instance.

Uses the capability cache for O(1) plugin lookup.

Errors

Returns error if no plugin supports decoding the given codec.

pub fn find_encoder( &self, codec_name: &str, config: EncoderConfig, ) -> CodecResult<Box<dyn VideoEncoder>>

Find and create an encoder for a given codec name.

Searches all registered plugins (in priority order) for one that can encode the requested codec, and creates a new encoder instance.

Uses the capability cache for O(1) plugin lookup.

Errors

Returns error if no plugin supports encoding the given codec.

pub fn has_codec(&self, codec_name: &str) -> bool

Check if any plugin provides a given codec (decode or encode).

pub fn has_decoder(&self, codec_name: &str) -> bool

Check if any plugin can decode a given codec.

pub fn has_encoder(&self, codec_name: &str) -> bool

Check if any plugin can encode a given codec.

pub fn plugin_count(&self) -> usize

Get the number of registered plugins.

pub fn clear(&self)

Unload all registered plugins and clear the cache.

pub fn find_plugin_for_codec(&self, codec_name: &str) -> Option<CodecPluginInfo>

Find the plugin that provides a given codec (respects priority ordering).

pub fn plugin_priority(&self, name: &str) -> Option<i32>

Get the priority of a registered plugin by name.

Returns None if no plugin with that name is registered.

Trait Implementations

impl Default for PluginRegistry

fn default() -> Self

Returns the “default value” for a type.