Struct synfx_dsp::DelayBuffer

pub struct DelayBuffer<F: Flt> { /* private fields */ }

This is a delay buffer/line with linear and cubic interpolation.

It’s the basic building block underneath the all-pass filter, comb filters and delay effects. You can use linear and cubic and no interpolation to access samples in the past. Either by sample offset or time (millisecond) based.

Implementations

impl<F: Flt> DelayBuffer<F>

pub fn new() -> Self

Creates a delay buffer with about 5 seconds of capacity at 8*48000Hz sample rate.

pub fn new_with_size(size: usize) -> Self

Creates a delay buffer with the given amount of samples capacity.

pub fn set_sample_rate(&mut self, srate: F)

Sets the sample rate that is used for milliseconds => sample conversion.

pub fn reset(&mut self)

Reset the delay buffer contents and write position.

pub fn feed(&mut self, input: F)

Feed one sample into the delay line and increment the write pointer. Please note: For sample accurate feedback you need to retrieve the output of the delay line before feeding in a new signal.

pub fn next_cubic(&mut self, delay_time_ms: F, input: F) -> F

Combines DelayBuffer::cubic_interpolate_at and DelayBuffer::feed into one convenient function.

pub fn next_linear(&mut self, delay_time_ms: F, input: F) -> F

Combines DelayBuffer::linear_interpolate_at and DelayBuffer::feed into one convenient function.

pub fn next_nearest(&mut self, delay_time_ms: F, input: F) -> F

Combines DelayBuffer::nearest_at and DelayBuffer::feed into one convenient function.

pub fn tap_c(&self, delay_time_ms: F) -> F

Shorthand for DelayBuffer::cubic_interpolate_at.

pub fn tap_n(&self, delay_time_ms: F) -> F

Shorthand for DelayBuffer::cubic_interpolate_at.

pub fn tap_l(&self, delay_time_ms: F) -> F

Shorthand for DelayBuffer::cubic_interpolate_at.

pub fn linear_interpolate_at(&self, delay_time_ms: F) -> F

Fetch a sample from the delay buffer at the given tim with linear interpolation.

• delay_time_ms - Delay time in milliseconds.

pub fn linear_interpolate_at_s(&self, s_offs: F) -> F

Fetch a sample from the delay buffer at the given offset with linear interpolation.

• s_offs - Sample offset in samples.

pub fn cubic_interpolate_at(&self, delay_time_ms: F) -> F

Fetch a sample from the delay buffer at the given time with cubic interpolation.

• delay_time_ms - Delay time in milliseconds.

pub fn cubic_interpolate_at_s(&self, s_offs: F) -> F

Fetch a sample from the delay buffer at the given offset with cubic interpolation.

• s_offs - Sample offset in samples into the past of the DelayBuffer from the current write (or the “now”) position.

pub fn nearest_at(&self, delay_time_ms: F) -> F

Fetch a sample from the delay buffer at the given time without any interpolation.

• delay_time_ms - Delay time in milliseconds.

pub fn at(&self, delay_sample_count: usize) -> F

Fetch a sample from the delay buffer at the given number of samples in the past.

Trait Implementations

impl<F: Clone + Flt> Clone for DelayBuffer<F>

fn clone(&self) -> DelayBuffer<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug + Flt> Debug for DelayBuffer<F>

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

Formats the value using the given formatter.

impl<F: Default + Flt> Default for DelayBuffer<F>

fn default() -> DelayBuffer<F>

Returns the “default value” for a type.