Skip to main content

LFO

Struct LFO 

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

LFO (Low Frequency Oscillator)

Generates low-frequency signals for parameter modulation. Frequency range: 0.01 Hz - 100 Hz.

§Operating modes

  • Bipolar: output in range [-1, 1]
  • Unipolar: output in range [0, 1]

§Example

use rill_core::time::ClockTick;
use rill_core::traits::ActionContext;
use rill_core_dsp::generators::*;
use rill_core::traits::algorithm::Algorithm;

let tick = ClockTick::default();
let ctx = ActionContext::new(&tick);

// Create LFO for filter frequency modulation
let mut lfo = LFO::<f32>::new(
    5.0,              // 5 Hz
    Waveform::Sine,
    true              // bipolar mode (-1..1)
);
lfo.init(44100.0);

// Generate modulation signal
let mut output = [0.0_f32];
lfo.process(None, &mut output).unwrap();
let modulation = output[0];

Implementations§

Source§

impl<T: Transcendental> LFO<T>

Source

pub fn new(frequency: f32, waveform: Waveform, bipolar: bool) -> Self

Create a new LFO

§Arguments
  • frequency - frequency in Hz (0.01 - 100)
  • waveform - waveform shape
  • bipolar - true for bipolar (-1..1), false for unipolar (0..1)
Source

pub fn with_phase_offset(self, offset: T) -> Self

Create an LFO with phase offset

Source

pub fn set_bipolar(&mut self, bipolar: bool)

Set bipolar mode

§Arguments
  • bipolar - true: output in [-1, 1], false: output in [0, 1]
Source

pub fn set_phase_offset(&mut self, offset: T)

Set phase offset (0..1)

Shifts the LFO phase relative to the reference point. Useful for stereo effects or synchronizing multiple LFOs.

Source

pub fn phase_offset(&self) -> T

Get current phase offset

Source

pub fn is_bipolar(&self) -> bool

Check if LFO is in bipolar mode

Source

pub fn sync(&mut self, reset: bool)

Sync with external clock

§Arguments
  • reset - if true, reset phase to phase_offset value
Source

pub fn modulate(&mut self) -> T

Get modulation value (current sample)

Source

pub fn reset(&mut self)

Reset LFO to initial state

Trait Implementations§

Source§

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

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 process( &mut self, _input: Option<&[T]>, output: &mut [T], ) -> ProcessResult<()>

Process one block of signal. Read more
Source§

fn metadata(&self) -> AlgorithmMetadata

Descriptive metadata (defaults to empty).
Source§

fn apply_command(&mut self, _value: T)

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

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

Source§

fn clone(&self) -> LFO<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: Copy + Transcendental> Copy for LFO<T>

Source§

impl<T: Transcendental> Generator<T> for LFO<T>

Source§

fn phase(&self) -> T

Get current phase (0.0 - 1.0)
Source§

fn set_phase(&mut self, phase: T)

Set phase
Source§

fn frequency(&self) -> f32

Get frequency in Hz
Source§

fn set_frequency(&mut self, freq: f32)

Set frequency
Source§

fn amplitude(&self) -> T

Get amplitude
Source§

fn set_amplitude(&mut self, amp: T)

Set amplitude
Source§

fn reset_phase(&mut self)

Reset phase to 0
Source§

impl<T: Transcendental> SyncableGenerator<T> for LFO<T>

Source§

fn sync(&mut self, reset: bool)

Sync with external clock signal Read more
Source§

fn periods(&self) -> u32

Get number of periods since last reset

Auto Trait Implementations§

§

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

§

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

§

impl<T> Send for LFO<T>

§

impl<T> Sync for LFO<T>

§

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

§

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

§

impl<T> UnwindSafe for LFO<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