AUDIO
Source snapshot · 12 October 2026

API reference / ravet_signal::ButterworthFilter

Struct ButterworthFilter 

pub struct ButterworthFilter { /* private fields */ }
Expand description

One-channel allocation-free processing using at most 16 fixed sections. Nonfinite audio propagates. There is no transition smoothing, anti-denormal, headroom or real-time deadline guarantee. Each channel needs its own owner.

use ravet_signal::{ButterworthDesign, ButterworthFilter, ButterworthResponse};
let design = ButterworthDesign::new(
    ButterworthResponse::LowPass { cutoff_hz: 4000. }, 48000., 7).unwrap();
let mut filter = ButterworthFilter::new(design);
let output = filter.process_sample(1.);
assert!(output.is_finite());

Implementations§

§

impl ButterworthFilter

pub fn new(design: ButterworthDesign) -> Self

Start with zero histories and the selected design.

pub fn set_design(&mut self, design: ButterworthDesign)

Replace the complete selected-order design and reset all histories. This policy differs from existing const-generic cascade replacement, which retains histories. Prepare the design on CONTROL first.

pub fn process_sample(&mut self, input: f64) -> f64

Process one sample; finite stable coefficients do not sanitize audio.

pub fn process_in_place(&mut self, samples: &mut [f64])

Process an arbitrary block, retaining history between blocks.

pub fn reset(&mut self)

Clear every history without allocation.

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.