Struct Svf

pub struct Svf<F: Float> { /* private fields */ }

A State Variable Filter that is copied from Andrew Simper (Cytomic) https://cytomic.com/files/dsp/SvfLinearTrapOptimised2.pdf

Implementations

impl<F: Float + Default> Svf<F>

pub fn new( filter_type: FilterType, sample_rate: F, cutoff: F, q: F, gain: F, ) -> Result<Self, SvfError>

sets the filter to an inital response use Svf::default otherwise Parameters:

• filter_type: choose one of the filter types, like peak, lowpass or highpass
• sample_rate: the sample_rate of the audio buffer that the filter should be applied on
• frequency: the frequency in Hz where the cutoff of the filter should be
• q: the steepness of the filter
• gain: the gain boost or decrease of the filter

pub fn process(&mut self, input: &[F], output: &mut [F])

process helper function that calls Svf::tick on each sample

pub fn reset(&mut self)

Reset state of filter. Can be used when the audio callback is restarted.

pub fn set( &mut self, filter_type: FilterType, sample_rate: F, cutoff: F, q: F, gain: F, ) -> Result<(), SvfError>

The set function is setting the current parameters of the filter. Don’t call from a different thread than tick. Parameters:

• filter_type: choose one of the filter types, like peak, lowpass or highpass
• sample_rate: the sample_rate of the audio buffer that the filter should be applied on
• frequency: the frequency in Hz where the cutoff of the filter should be
• q: the steepness of the filter
• gain: the gain boost or decrease of the filter

pub fn set_coeffs(&mut self, coefficients: SvfCoefficients<F>)

Set new filter parameters from coefficients struct

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

The process that is applying the filter on a sample by sample basis process is a utility function to call tick on a full frame

pub fn coefficients(&self) -> &SvfCoefficients<F>

get a reference to the coefficients can be used to clone it to the UI thread, to plot the response

pub fn get_response(&self, frequency: f64) -> Result<Complex64, SvfError>

utility method to get the response should not be called from another thread than the set methods

Trait Implementations

impl<F: Default + Float> Default for Svf<F>

fn default() -> Svf<F>

Returns the “default value” for a type.