dhvani 1.0.0

Core audio engine — buffers, DSP, resampling, mixing, analysis, and capture for Rust
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
//! Lock-free audio metering — stereo peak levels via atomic operations.
//!
//! Designed for real-time audio: the RT thread writes peak levels via
//! `AtomicU32` (f32 bit patterns), and the UI thread reads them without
//! mutexes or blocking.

use std::sync::Arc;
use std::sync::atomic::{AtomicU32, AtomicUsize, Ordering};

/// A single stereo peak level stored as two atomic u32 (f32 bit patterns).
///
/// Lock-free: safe to write from the RT thread and read from the UI thread.
#[must_use]
#[derive(Debug)]
pub struct PeakMeter {
    left: AtomicU32,
    right: AtomicU32,
}

impl PeakMeter {
    /// Create a meter reading zero.
    pub fn new() -> Self {
        Self {
            left: AtomicU32::new(0.0f32.to_bits()),
            right: AtomicU32::new(0.0f32.to_bits()),
        }
    }

    /// Store a stereo peak level (call from RT thread).
    #[inline]
    pub fn store(&self, left: f32, right: f32) {
        self.left.store(left.to_bits(), Ordering::Relaxed);
        self.right.store(right.to_bits(), Ordering::Relaxed);
    }

    /// Load the current stereo peak level (call from UI thread).
    #[inline]
    pub fn load(&self) -> [f32; 2] {
        let l = f32::from_bits(self.left.load(Ordering::Relaxed));
        let r = f32::from_bits(self.right.load(Ordering::Relaxed));
        [l, r]
    }
}

impl Default for PeakMeter {
    fn default() -> Self {
        Self::new()
    }
}

/// A bank of stereo peak meters with dynamic slot activation.
///
/// Pre-allocates capacity at creation time. Slots can be activated
/// up to capacity without reallocation.
#[must_use]
pub struct MeterBank {
    slots: Vec<PeakMeter>,
    active: AtomicUsize,
}

impl MeterBank {
    /// Create a meter bank with the given capacity.
    pub fn new(capacity: usize) -> Self {
        Self {
            slots: (0..capacity).map(|_| PeakMeter::new()).collect(),
            active: AtomicUsize::new(capacity),
        }
    }

    /// Number of active slots.
    pub fn len(&self) -> usize {
        self.active.load(Ordering::Relaxed)
    }

    /// Whether the bank has no active slots.
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Total allocated capacity.
    pub fn capacity(&self) -> usize {
        self.slots.len()
    }

    /// Store a stereo peak level at the given slot index.
    ///
    /// No-op if index is out of bounds.
    pub fn store(&self, index: usize, left: f32, right: f32) {
        if let Some(slot) = self.slots.get(index) {
            slot.store(left, right);
        }
    }

    /// Load the stereo peak level at the given slot index.
    ///
    /// Returns `[0.0, 0.0]` if index is out of bounds.
    pub fn load(&self, index: usize) -> [f32; 2] {
        self.slots
            .get(index)
            .map(|s| s.load())
            .unwrap_or([0.0, 0.0])
    }

    /// Read all active slots into a Vec.
    pub fn read_all(&self) -> Vec<[f32; 2]> {
        let active = self.len();
        (0..active).map(|i| self.load(i)).collect()
    }

    /// Set the number of active slots (clamped to capacity).
    pub fn set_active(&self, count: usize) {
        self.active
            .store(count.min(self.slots.len()), Ordering::Relaxed);
    }
}

// SAFETY: PeakMeter uses only atomics, no interior mutability beyond that.
unsafe impl Sync for MeterBank {}
unsafe impl Send for MeterBank {}

impl std::fmt::Debug for MeterBank {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("MeterBank")
            .field("capacity", &self.capacity())
            .field("active", &self.len())
            .finish()
    }
}

/// Shared meter bank — `Arc`-wrapped for multi-thread sharing.
pub type SharedMeterBank = Arc<MeterBank>;

/// Create a shared meter bank with the given capacity.
pub fn shared_meter_bank(capacity: usize) -> SharedMeterBank {
    Arc::new(MeterBank::new(capacity))
}

// ── Block-accumulating level meter ────────────────────────────────

/// Floor value for dB conversion — represents silence.
const DB_FLOOR: f32 = -200.0;
/// Minimum linear amplitude treated as non-zero.
const LINEAR_FLOOR: f32 = 1e-10;
/// EBU R128 LUFS offset constant.
const LUFS_OFFSET: f64 = -0.691;
/// LUFS block duration in seconds (EBU R128: 400ms).
const LUFS_BLOCK_DURATION: f32 = 0.4;
/// Peak hold decay coefficient per sample.
const PEAK_DECAY_COEFFICIENT: f32 = 0.9995;
/// Maximum number of LUFS blocks retained (~10 minutes of 400ms blocks).
const MAX_LUFS_BLOCKS: usize = 1500;

/// Convert linear amplitude to dB.
fn linear_to_db(linear: f32) -> f32 {
    if linear < LINEAR_FLOOR {
        DB_FLOOR
    } else {
        20.0 * linear.log10()
    }
}

/// Block-accumulating audio level meter with peak, RMS, LUFS, and peak-hold.
///
/// Unlike [`PeakMeter`] (lock-free atomic for RT threads), this meter
/// accumulates statistics across multiple `process()` calls and computes
/// integrated LUFS using simplified EBU R128 gating.
///
/// Use for offline analysis, UI metering displays, and loudness monitoring.
#[must_use]
#[derive(Debug, Clone)]
pub struct LevelMeter {
    /// Current peak level per channel (linear).
    pub(crate) peak: Vec<f32>,
    /// Current RMS level per channel (linear).
    pub(crate) rms: Vec<f32>,
    /// Integrated LUFS value (mono/stereo).
    pub(crate) lufs: f32,
    channels: usize,
    rms_sum: Vec<f64>,
    rms_count: u64,
    lufs_blocks: Vec<f64>,
    lufs_buffer: Vec<f64>,
    lufs_buffer_pos: usize,
    /// Peak hold with decay.
    peak_hold: Vec<f32>,
    peak_decay: f32,
}

impl LevelMeter {
    /// Create a new level meter for the given channel count and sample rate.
    pub fn new(channels: usize, sample_rate: f32) -> Self {
        Self {
            peak: vec![0.0; channels],
            rms: vec![0.0; channels],
            lufs: DB_FLOOR,
            channels,
            rms_sum: vec![0.0; channels],
            rms_count: 0,
            lufs_blocks: Vec::new(),
            lufs_buffer: vec![0.0; (sample_rate * LUFS_BLOCK_DURATION) as usize],
            lufs_buffer_pos: 0,
            peak_hold: vec![0.0; channels],
            peak_decay: PEAK_DECAY_COEFFICIENT,
        }
    }

    /// Analyze an audio buffer and update all meter values.
    ///
    /// The buffer's channel count is clamped to the meter's channel count.
    /// Call repeatedly with successive buffers for continuous metering.
    pub fn process(&mut self, buf: &crate::buffer::AudioBuffer) {
        let frames = buf.frames;
        let buf_channels = buf.channels as usize;
        let active_channels = buf_channels.min(self.channels);

        // Reset per-block peak
        for ch_peak in &mut self.peak {
            *ch_peak = 0.0;
        }

        for frame in 0..frames {
            let mut channel_sq_sum: f64 = 0.0;

            for ch in 0..active_channels {
                let sample = buf.samples[frame * buf_channels + ch];
                let abs = sample.abs();

                if abs > self.peak[ch] {
                    self.peak[ch] = abs;
                }

                let sq = (sample as f64).powi(2);
                self.rms_sum[ch] += sq;
                channel_sq_sum += sq;
            }

            self.rms_count += 1;

            let mean_sq = if active_channels > 0 {
                channel_sq_sum / active_channels as f64
            } else {
                0.0
            };
            if self.lufs_buffer_pos < self.lufs_buffer.len() {
                self.lufs_buffer[self.lufs_buffer_pos] = mean_sq;
                self.lufs_buffer_pos += 1;
            }

            if self.lufs_buffer_pos >= self.lufs_buffer.len() {
                let block_power: f64 =
                    self.lufs_buffer.iter().sum::<f64>() / self.lufs_buffer.len() as f64;
                self.lufs_blocks.push(block_power);
                self.lufs_buffer_pos = 0;
                self.compute_lufs();
            }
        }

        // Update RMS
        if self.rms_count > 0 {
            for ch in 0..self.channels {
                self.rms[ch] = (self.rms_sum[ch] / self.rms_count as f64).sqrt() as f32;
            }
        }

        // Update peak hold with decay (scale by frame count for buffer-size-independent rate)
        let decay = self.peak_decay.powi(frames as i32);
        for ch in 0..self.channels {
            if self.peak[ch] > self.peak_hold[ch] {
                self.peak_hold[ch] = self.peak[ch];
            } else {
                self.peak_hold[ch] *= decay;
            }
        }
    }

    /// Compute integrated LUFS using simplified EBU R128 gating.
    fn compute_lufs(&mut self) {
        if self.lufs_blocks.is_empty() {
            self.lufs = DB_FLOOR;
            return;
        }
        if self.lufs_blocks.len() > MAX_LUFS_BLOCKS {
            let drain_count = self.lufs_blocks.len() - MAX_LUFS_BLOCKS;
            self.lufs_blocks.drain(..drain_count);
        }

        let abs_gate = 10.0_f64.powf(-70.0 / 10.0);

        let mut gated_count: usize = 0;
        let mut gated_sum: f64 = 0.0;
        for &p in &self.lufs_blocks {
            if p > abs_gate {
                gated_count += 1;
                gated_sum += p;
            }
        }

        if gated_count == 0 {
            self.lufs = DB_FLOOR;
            return;
        }

        let mean_power = gated_sum / gated_count as f64;
        let rel_gate = mean_power * 10.0_f64.powf(-10.0 / 10.0);

        let mut final_count: usize = 0;
        let mut final_sum: f64 = 0.0;
        for &p in &self.lufs_blocks {
            if p > abs_gate && p > rel_gate {
                final_count += 1;
                final_sum += p;
            }
        }

        if final_count == 0 {
            self.lufs = DB_FLOOR;
            return;
        }

        let integrated = final_sum / final_count as f64;
        self.lufs = (LUFS_OFFSET + 10.0 * integrated.log10()) as f32;
    }

    /// Peak levels per channel (linear).
    pub fn peak(&self) -> &[f32] {
        &self.peak
    }

    /// RMS levels per channel (linear).
    pub fn rms(&self) -> &[f32] {
        &self.rms
    }

    /// Integrated LUFS value.
    pub fn lufs(&self) -> f32 {
        self.lufs
    }

    /// Get peak level in dB for a channel.
    pub fn peak_db(&self, channel: usize) -> f32 {
        linear_to_db(self.peak.get(channel).copied().unwrap_or(0.0))
    }

    /// Get RMS level in dB for a channel.
    pub fn rms_db(&self, channel: usize) -> f32 {
        linear_to_db(self.rms.get(channel).copied().unwrap_or(0.0))
    }

    /// Get peak hold level in dB for a channel.
    pub fn peak_hold_db(&self, channel: usize) -> f32 {
        linear_to_db(self.peak_hold.get(channel).copied().unwrap_or(0.0))
    }

    /// Peak hold values per channel (linear).
    pub fn peak_hold(&self) -> &[f32] {
        &self.peak_hold
    }

    /// Number of channels this meter tracks.
    pub fn channels(&self) -> usize {
        self.channels
    }

    /// Reset all meter state.
    pub fn reset(&mut self) {
        self.peak.fill(0.0);
        self.rms.fill(0.0);
        self.lufs = DB_FLOOR;
        self.rms_sum.fill(0.0);
        self.rms_count = 0;
        self.lufs_blocks.clear();
        self.lufs_buffer.fill(0.0);
        self.lufs_buffer_pos = 0;
        self.peak_hold.fill(0.0);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn peak_meter_store_load() {
        let meter = PeakMeter::new();
        assert_eq!(meter.load(), [0.0, 0.0]);
        meter.store(0.8, 0.6);
        assert_eq!(meter.load(), [0.8, 0.6]);
    }

    #[test]
    fn meter_bank_basic() {
        let bank = MeterBank::new(4);
        assert_eq!(bank.len(), 4);
        assert_eq!(bank.capacity(), 4);

        bank.store(0, 0.9, 0.7);
        bank.store(1, 0.5, 0.3);
        assert_eq!(bank.load(0), [0.9, 0.7]);
        assert_eq!(bank.load(1), [0.5, 0.3]);
        assert_eq!(bank.load(99), [0.0, 0.0]); // out of bounds
    }

    #[test]
    fn meter_bank_read_all() {
        let bank = MeterBank::new(3);
        bank.store(0, 0.1, 0.2);
        bank.store(1, 0.3, 0.4);
        bank.store(2, 0.5, 0.6);
        let all = bank.read_all();
        assert_eq!(all.len(), 3);
        assert_eq!(all[0], [0.1, 0.2]);
        assert_eq!(all[2], [0.5, 0.6]);
    }

    #[test]
    fn meter_bank_set_active() {
        let bank = MeterBank::new(8);
        assert_eq!(bank.len(), 8);
        bank.set_active(3);
        assert_eq!(bank.len(), 3);
        let all = bank.read_all();
        assert_eq!(all.len(), 3);
    }

    #[test]
    fn shared_meter_bank_threaded() {
        let bank = shared_meter_bank(4);
        let bank2 = bank.clone();

        let handle = std::thread::spawn(move || {
            bank2.store(0, 0.99, 0.88);
        });
        handle.join().unwrap();

        let levels = bank.load(0);
        assert_eq!(levels, [0.99, 0.88]);
    }

    #[test]
    fn meter_bank_out_of_bounds_store_noop() {
        let bank = MeterBank::new(2);
        bank.store(999, 1.0, 1.0); // should not panic
        assert_eq!(bank.load(999), [0.0, 0.0]);
    }

    // ── LevelMeter tests ─────────────────────────────────────────

    #[test]
    fn level_meter_silence() {
        let buf = crate::buffer::AudioBuffer::silence(2, 256, 48000);
        let mut meter = LevelMeter::new(2, 48000.0);
        meter.process(&buf);
        assert_eq!(meter.peak[0], 0.0);
        assert_eq!(meter.peak[1], 0.0);
        assert_eq!(meter.rms[0], 0.0);
    }

    #[test]
    fn level_meter_peak_detection() {
        let mut data = vec![0.0f32; 256];
        data[100] = 0.75;
        data[200] = -0.9;
        let buf = crate::buffer::AudioBuffer::from_interleaved(data, 1, 48000).unwrap();
        let mut meter = LevelMeter::new(1, 48000.0);
        meter.process(&buf);
        assert!((meter.peak[0] - 0.9).abs() < 0.001);
    }

    #[test]
    fn level_meter_rms_constant() {
        let buf =
            crate::buffer::AudioBuffer::from_interleaved(vec![0.5f32; 1024], 1, 48000).unwrap();
        let mut meter = LevelMeter::new(1, 48000.0);
        meter.process(&buf);
        assert!((meter.rms[0] - 0.5).abs() < 0.001);
    }

    #[test]
    fn level_meter_rms_sine() {
        let frames = 48000;
        let data: Vec<f32> = (0..frames)
            .map(|i| (2.0 * std::f32::consts::PI * 1000.0 * i as f32 / 48000.0).sin())
            .collect();
        let buf = crate::buffer::AudioBuffer::from_interleaved(data, 1, 48000).unwrap();
        let mut meter = LevelMeter::new(1, 48000.0);
        meter.process(&buf);
        assert!(
            (meter.rms[0] - std::f32::consts::FRAC_1_SQRT_2).abs() < 0.01,
            "RMS of unit sine should be ~0.707, got {}",
            meter.rms[0]
        );
    }

    #[test]
    fn level_meter_db_conversion() {
        assert!(linear_to_db(1.0).abs() < 0.001);
        assert!((linear_to_db(0.5) - (-6.02)).abs() < 0.1);
        assert!(linear_to_db(0.0) < -100.0);
    }

    #[test]
    fn level_meter_reset() {
        let buf =
            crate::buffer::AudioBuffer::from_interleaved(vec![0.5f32; 512], 2, 48000).unwrap();
        let mut meter = LevelMeter::new(2, 48000.0);
        meter.process(&buf);
        meter.reset();
        assert_eq!(meter.peak[0], 0.0);
        assert_eq!(meter.rms[0], 0.0);
        assert_eq!(meter.lufs, DB_FLOOR);
    }

    #[test]
    fn level_meter_lufs_with_signal() {
        let frames = 96000; // 2 seconds
        let data: Vec<f32> = (0..frames)
            .map(|i| (2.0 * std::f32::consts::PI * 1000.0 * i as f32 / 48000.0).sin() * 0.5)
            .collect();
        let buf = crate::buffer::AudioBuffer::from_interleaved(data, 1, 48000).unwrap();
        let mut meter = LevelMeter::new(1, 48000.0);
        meter.process(&buf);
        assert!(
            meter.lufs > -200.0,
            "LUFS should be computed, got {}",
            meter.lufs
        );
        assert!(
            meter.lufs < 0.0,
            "LUFS should be negative, got {}",
            meter.lufs
        );
    }

    #[test]
    fn level_meter_peak_hold_decay() {
        let mut meter = LevelMeter::new(1, 48000.0);
        let mut data = vec![0.0f32; 256];
        data[50] = 0.8;
        let buf = crate::buffer::AudioBuffer::from_interleaved(data, 1, 48000).unwrap();
        meter.process(&buf);
        assert!((meter.peak_hold[0] - 0.8).abs() < 0.001);

        // Second quiet block — peak hold should decay
        let buf2 =
            crate::buffer::AudioBuffer::from_interleaved(vec![0.01f32; 256], 1, 48000).unwrap();
        meter.process(&buf2);
        assert!(meter.peak_hold[0] > 0.0);
        assert!(meter.peak_hold[0] < 0.8);
    }

    #[test]
    fn level_meter_multi_channel() {
        let frames = 256;
        let mut data = vec![0.0f32; frames * 2];
        for i in 0..frames {
            data[i * 2] = 0.6;
            data[i * 2 + 1] = 0.3;
        }
        let buf = crate::buffer::AudioBuffer::from_interleaved(data, 2, 48000).unwrap();
        let mut meter = LevelMeter::new(2, 48000.0);
        meter.process(&buf);
        assert!((meter.peak[0] - 0.6).abs() < 0.001);
        assert!((meter.peak[1] - 0.3).abs() < 0.001);
        assert!(meter.peak_db(0) > meter.peak_db(1));
    }

    #[test]
    fn level_meter_invalid_channel_db() {
        let meter = LevelMeter::new(1, 48000.0);
        assert!(meter.peak_db(5) < -100.0);
        assert!(meter.rms_db(5) < -100.0);
        assert!(meter.peak_hold_db(5) < -100.0);
    }

    #[test]
    fn level_meter_public_accessors() {
        let buf =
            crate::buffer::AudioBuffer::from_interleaved(vec![0.5f32; 512], 2, 48000).unwrap();
        let mut meter = LevelMeter::new(2, 48000.0);
        meter.process(&buf);
        assert_eq!(meter.peak().len(), 2);
        assert_eq!(meter.rms().len(), 2);
        assert!(meter.peak()[0] > 0.0);
        assert!(meter.rms()[0] > 0.0);
        assert_eq!(meter.channels(), 2);
        let _ = meter.lufs();
        assert_eq!(meter.peak_hold().len(), 2);
    }
}