rill-core-dsp 0.3.0

Core DSP abstractions and algorithms for Rill
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

//! Re-exports `rill_core::Algorithm` and provides DSP-specific extensions.
//!
//! The base `Algorithm` trait lives in `rill_core`. This module re-exports it
//! together with the DSP-specific `ParameterizedAlgorithm` abstraction.

pub use rill_core::traits::algorithm::{
    ActionContext, Algorithm, AlgorithmCategory, AlgorithmMetadata,
};
pub use rill_core::traits::ProcessResult;

use rill_core::traits::ParamValue;
use rill_core::Transcendental;

/// An `Algorithm` with typed, settable parameters.
///
/// Extends the base `Algorithm` trait with the ability to get and set
/// a typed parameter struct (`Params`) and to update individual parameters
/// by name (for automation integration).
pub trait ParameterizedAlgorithm<T: Transcendental>: Algorithm<T> {
    /// The concrete parameter type for this algorithm.
    type Params: Clone + Send + Sync;

    /// Get a reference to the current parameters.
    fn params(&self) -> &Self::Params;

    /// Replace all parameters atomically.
    ///
    /// The implementation should recompute any derived coefficients.
    fn set_params(&mut self, params: Self::Params);

    /// Set a single parameter by name (for automation / scripting).
    ///
    /// Default: returns an error for any unrecognised name.
    fn set_parameter(&mut self, name: &str, value: ParamValue) -> Result<(), &'static str> {
        Err(format!("Parameter '{}' not supported", name).leak())
    }
}