Merge pull request #379 from HEnquist/ringbuf_in_delay_and_dither

Replace circularqueue in delay and dither with ringbuf

Author: HEnquist

Cargo.toml

@@ -71,7 +71,6 @@ cpal = { version = "0.13.3", optional = true }
 #rawsample = { path = "../../rust/rawsample" }
 #rawsample = { git = "https://github.com/HEnquist/rawsample", branch = "main" }
 rawsample = "0.2.0"
-circular-queue = "0.2.6"
 parking_lot = { version = "0.12.1", features = ["hardware-lock-elision"] }
 crossbeam-channel = "0.5"
 rayon = "1.10.0"

src/basicfilters.rs

@@ -1,6 +1,8 @@
 use std::sync::Arc;
 
-use circular_queue::CircularQueue;
+use ringbuf::storage::Heap;
+use ringbuf::traits::*;
+use ringbuf::LocalRb;
 
 use crate::audiodevice::AudioChunk;
 use crate::biquad::{Biquad, BiquadCoefficients};
@@ -21,7 +23,7 @@ pub struct Gain {
 pub struct Delay {
     pub name: String,
     samplerate: usize,
-    queue: CircularQueue<PrcFmt>,
+    queue: LocalRb<Heap<PrcFmt>>,
     biquad: Option<Biquad>,
 }
 
@@ -347,9 +349,9 @@ impl Delay {
 
         // for super-small delays, store at least a single sample
         let integerdelay = integerdelay.max(1);
-        let mut queue = CircularQueue::with_capacity(integerdelay);
+        let mut queue = LocalRb::new(integerdelay);
         for _ in 0..integerdelay {
-            queue.push(0.0);
+            let _ = queue.try_push(0.0);
         }
 
         Self {
@@ -379,7 +381,7 @@ impl Filter for Delay {
     fn process_waveform(&mut self, waveform: &mut [PrcFmt]) -> Res<()> {
         for item in waveform.iter_mut() {
             // this returns the item that was popped while pushing
-            *item = self.queue.push(*item).unwrap();
+            *item = self.queue.push_overwrite(*item).unwrap();
         }
         if let Some(bq) = &mut self.biquad {
             bq.process_waveform(waveform)?;

src/dither.rs

@@ -1,6 +1,8 @@
-use circular_queue::CircularQueue;
 use rand::{rngs::SmallRng, SeedableRng};
 use rand_distr::{Distribution, Triangular, Uniform};
+use ringbuf::storage::Heap;
+use ringbuf::traits::*;
+use ringbuf::LocalRb;
 
 use crate::{config, filters::Filter, NewValue, PrcFmt, Res};
 
@@ -14,17 +16,16 @@ pub struct Dither<'a> {
     shaper: Option<NoiseShaper<'a>>,
 }
 
-#[derive(Clone, Debug)]
 pub struct NoiseShaper<'a> {
     // optimization: lifetime allows taking coefficients
     // from an array instead of allocating a `Vec`.
     filter: &'a [PrcFmt],
-    buffer: CircularQueue<PrcFmt>,
+    buffer: LocalRb<Heap<PrcFmt>>,
 }
 
 impl<'a> NoiseShaper<'a> {
     pub fn new(filter: &'a [PrcFmt]) -> Self {
-        let buffer = CircularQueue::with_capacity(filter.len());
+        let buffer = LocalRb::new(filter.len());
         Self { filter, buffer }
     }
 
@@ -438,15 +439,15 @@ impl<'a> NoiseShaper<'a> {
 
     pub fn process(&mut self, scaled: PrcFmt, dither: PrcFmt) -> PrcFmt {
         let mut filt_buf = 0.0;
-        for (item, coeff) in self.buffer.iter().zip(self.filter) {
+        for (item, coeff) in self.buffer.iter().zip(self.filter.iter().rev()) {
             filt_buf += coeff * item;
         }
 
         let scaled_plus_err = scaled + filt_buf;
         let result = scaled_plus_err + dither;
         let result_r = result.round(); // away from zero
 
-        self.buffer.push(scaled_plus_err - result_r);
+        self.buffer.push_overwrite(scaled_plus_err - result_r);
 
         result_r
     }