Skip to main content

qualia_audio/features/loudness/
rms.rs

1//! Block RMS (root-mean-square) level, linear and in dBFS,
2//! delegated to [`etalon_signal::loudness`].
3
4/// Linear RMS of a mono block: `sqrt(mean(x^2))`.
5#[inline]
6pub fn rms(samples: &[f32]) -> f32 {
7    etalon_signal::loudness::rms_f32(samples)
8}
9
10/// RMS expressed in dBFS (`20*log10(rms)`), full-scale reference `1.0`.
11#[inline]
12pub fn rms_dbfs(samples: &[f32]) -> f32 {
13    etalon_signal::loudness::rms_dbfs(samples)
14}
15
16#[cfg(test)]
17mod tests {
18    use super::*;
19    use core::f32::consts::PI;
20
21    fn sine(freq: f32, sr: f32, n: usize, amp: f32) -> Vec<f32> {
22        (0..n)
23            .map(|i| amp * (2.0 * PI * freq * i as f32 / sr).sin())
24            .collect()
25    }
26
27    #[test]
28    fn rms_of_unit_sine_is_root_half() {
29        let s = sine(1_000.0, 48_000.0, 48_000, 1.0);
30        let r = rms(&s);
31        assert!((r - 0.7071067).abs() < 1e-3, "rms {r}");
32    }
33
34    #[test]
35    fn rms_dbfs_of_unit_sine_near_minus_3() {
36        let s = sine(1_000.0, 48_000.0, 48_000, 1.0);
37        let db = rms_dbfs(&s);
38        assert!((db - (-3.0103)).abs() < 0.05, "dbfs {db}");
39    }
40
41    #[test]
42    fn empty_is_zero_and_neg_inf() {
43        assert_eq!(rms(&[]), 0.0);
44        assert_eq!(rms_dbfs(&[]), f32::NEG_INFINITY);
45    }
46
47    #[test]
48    fn dc_block_rms_equals_level() {
49        let s = [0.5f32; 256];
50        assert!((rms(&s) - 0.5).abs() < 1e-6);
51    }
52}