Skip to main content

ControlMapper

Struct ControlMapper 

Source
pub struct ControlMapper<T: Transcendental> { /* private fields */ }
Expand description

Maps an incoming normalized control value [0, 1] to a parameter range using a MappingStrategy.

Implements Algorithm<T>. The input (if present) is treated as the normalized value; when input is None (source mode), the value received via apply_command() is used instead.

§Example

use rill_core_dsp::mapping::{ControlMapper, MappingStrategy};
use rill_core::traits::Algorithm;
use rill_core::time::ClockTick;
use rill_core::traits::ActionContext;

let mut mapper = ControlMapper::new(20.0, 20000.0, MappingStrategy::Exponential { exponent: 2.0 });
let tick = ClockTick::default();
let ctx = ActionContext::new(&tick);

// Use apply_command to set the incoming value
mapper.apply_command(0.5);    // halfway in normalized range
let mut output = [0.0f32; 1];
mapper.process(None, &mut output).unwrap();
// output maps 0.5 exponentially between 20..20000

Implementations§

Source§

impl<T: Transcendental> ControlMapper<T>

Source

pub fn new(min: T, max: T, strategy: MappingStrategy) -> Self

Create a new ControlMapper.

Source

pub fn set_range(&mut self, min: T, max: T)

Update the mapping range.

Source

pub fn set_strategy(&mut self, strategy: MappingStrategy)

Update the mapping strategy.

Source

pub fn current_mapped(&self) -> T

Get the current mapped value (without processing).

Trait Implementations§

Source§

impl<T: Transcendental> Algorithm<T> for ControlMapper<T>

Source§

fn process( &mut self, input: Option<&[T]>, output: &mut [T], ) -> ProcessResult<()>

Process one block of signal. Read more
Source§

fn apply_command(&mut self, value: T)

Receive a real-time command value from the control path. Read more
Source§

fn init(&mut self, _sample_rate: f32)

Initialise the algorithm with a sample rate. Read more
Source§

fn reset(&mut self)

Reset the algorithm to its initial state. Read more
Source§

fn metadata(&self) -> AlgorithmMetadata

Descriptive metadata (defaults to empty).
Source§

impl<T: Clone + Transcendental> Clone for ControlMapper<T>

Source§

fn clone(&self) -> ControlMapper<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Transcendental> Debug for ControlMapper<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ControlMapper<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ControlMapper<T>
where T: RefUnwindSafe,

§

impl<T> Send for ControlMapper<T>

§

impl<T> Sync for ControlMapper<T>

§

impl<T> Unpin for ControlMapper<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for ControlMapper<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for ControlMapper<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V