Struct envelope_detector::rms::Rms

pub struct Rms {
    // some fields omitted
}

Iteratively extracts the RMS (root mean square) envelope from a window over a signal of samples.

Methods

impl Rms

fn new(n_window_frames: usize) -> Self

Construct a new Rms.

fn reset(&mut self)

Zeroes the sum and the buffer of the window.

fn set_window_frames(&mut self, n_window_frames: usize)

Set the size of the window as a number of frames.

If the current window length is longer than the given length, the difference will be popped from the front of the window while adjusting the sum accordingly.

If the current window length is shorter than the given length, the difference will be pushed to the front of the window using an averaged frame in order to retain the current RMS.

If the length already is already correct, no re-sizing occurs.

fn window_frames(&self) -> usize

The length of the window as a number of frames.

fn next(&mut self, new_sample: f32) -> f32

The next RMS given the new sample in the sequence.

The Rms pops its front sample and adds the new sample to the back.

The yielded RMS is the RMS of all sample squares in the window after the new sample is added.

Returns 0.0 if the window is empty.

Trait Implementations

impl Mode for Rms

fn next_sample(&mut self, sample: f32) -> f32

Update state that is unique to the Mode.

impl Debug for Rms

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Rms

fn clone(&self) -> Rms

Returns a copy of the value.

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

Performs copy-assignment from source.