Skip to main content

RmsWindow

Struct RmsWindow 

Source
pub struct RmsWindow { /* private fields */ }
Expand description

A moving-window RMS estimator over the most recent N samples.

Unlike AudioLevels’s per-block RMS (which resets every buffer), this gives a smooth level over a fixed time window regardless of block size — feed it samples or whole blocks and read rms. The window length in samples is window_secs · sample_rate.

use vst3_host::audio::RmsWindow;

let mut rms = RmsWindow::new(4);
for _ in 0..4 { rms.push_sample(0.5); }
assert!((rms.rms() - 0.5).abs() < 1e-6); // constant 0.5 → RMS 0.5

Implementations§

Source§

impl RmsWindow

Source

pub fn new(window_samples: usize) -> Self

Create a window holding the most recent window_samples samples (minimum 1).

Source

pub fn from_duration(window_secs: f32, sample_rate: f64) -> Self

Create a window sized for window_secs of audio at sample_rate Hz.

The sample count is clamped: a non-finite or absurd duration/rate would otherwise saturate to usize::MAX and panic in VecDeque::with_capacity.

Source

pub fn push_sample(&mut self, sample: f32)

Add one sample, evicting the oldest if the window is full.

Source

pub fn push_block(&mut self, block: &[f32])

Add a whole block of samples.

Source

pub fn rms(&self) -> f32

Current RMS over the samples in the window (0.0 when empty).

Source

pub fn len(&self) -> usize

Number of samples currently in the window.

Source

pub fn is_empty(&self) -> bool

Whether the window holds no samples yet.

Source

pub fn clear(&mut self)

Drop all samples.

Trait Implementations§

Source§

impl Clone for RmsWindow

Source§

fn clone(&self) -> RmsWindow

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 Debug for RmsWindow

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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<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<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> 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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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.