resonators 0.1.1

Rust implementation of the Resonate algorithm for low-latency spectral analysis.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

/// Parameters for a single resonator.
///
/// - `freq`: resonant frequency, in Hz.
/// - `alpha`: EWMA coefficient in `(0, 1]`. Smaller `alpha` means a longer
///   time constant; `1.0` is no smoothing.
/// - `beta`: coefficient of a second EWMA on the resonator's output, in
///   `(0, 1]`. Typically equal to `alpha`; smaller `beta` gives a smoother
///   output at the cost of additional latency.
///
/// See [`heuristic_alpha`](crate::heuristic_alpha) for a reasonable
/// per-frequency default.
#[derive(Debug, Clone, Copy)]
pub struct ResonatorConfig {
    pub freq: f32,
    pub alpha: f32,
    pub beta: f32,
}

impl ResonatorConfig {
    /// Creates a new config with the given frequency, alpha, and beta.
    pub fn new(freq: f32, alpha: f32, beta: f32) -> Self {
        debug_assert!(freq.is_finite() && freq > 0.0, "freq must be positive");
        debug_assert!(
            alpha.is_finite() && alpha > 0.0 && alpha <= 1.0,
            "alpha must be in (0, 1]"
        );
        debug_assert!(
            beta.is_finite() && beta > 0.0 && beta <= 1.0,
            "beta must be in (0, 1]"
        );
        Self { freq, alpha, beta }
    }
}