WaveshaperNode: don't use OnceLock and Atomics for interior mutability

Author: b-ma

examples/waveshaper.rs

@@ -52,7 +52,7 @@ fn main() {
     post_gain.connect(&context.destination());
     post_gain.gain().set_value(0.);
 
-    let shaper = context.create_wave_shaper();
+    let mut shaper = context.create_wave_shaper();
     shaper.set_oversample(OverSampleType::None);
     // shaper.set_oversample(OverSampleType::X2);
     // shaper.set_oversample(OverSampleType::X4);

showcase/mic_playback/src/main.rs

@@ -237,7 +237,10 @@ fn poll_frequency_graph(
 
         // todo, check BaseAudioContext.state if it is still running
 
-        analyser.lock().unwrap().get_float_frequency_data(&mut freq_buffer);
+        analyser
+            .lock()
+            .unwrap()
+            .get_float_frequency_data(&mut freq_buffer);
 
         let points: Vec<_> = freq_buffer
             .iter()

src/node/waveshaper.rs

@@ -1,6 +1,4 @@
 use std::any::Any;
-use std::sync::atomic::{AtomicU32, Ordering};
-use std::sync::OnceLock;
 
 use rubato::{FftFixedInOut, Resampler as _};
 
@@ -102,7 +100,7 @@ impl Default for WaveShaperOptions {
 /// post_gain.connect(&context.destination());
 /// post_gain.gain().set_value(1. / drive);
 ///
-/// let shaper = context.create_wave_shaper();
+/// let mut shaper = context.create_wave_shaper();
 /// shaper.connect(&post_gain);
 /// shaper.set_curve(curve);
 ///
@@ -126,9 +124,9 @@ pub struct WaveShaperNode {
     /// Infos about audio node channel configuration
     channel_config: ChannelConfig,
     /// distortion curve
-    curve: OnceLock<Vec<f32>>,
+    curve: Option<Vec<f32>>,
     /// oversample type
-    oversample: AtomicU32,
+    oversample: OverSampleType,
 }
 
 impl AudioNode for WaveShaperNode {
@@ -163,7 +161,7 @@ impl WaveShaperNode {
             channel_config,
         } = options;
 
-        let node = context.register(move |registration| {
+        let mut node = context.register(move |registration| {
             let sample_rate = context.sample_rate() as usize;
 
             let renderer = WaveShaperRenderer::new(RendererConfig {
@@ -174,8 +172,8 @@ impl WaveShaperNode {
             let node = Self {
                 registration,
                 channel_config: channel_config.into(),
-                curve: OnceLock::new(),
-                oversample: AtomicU32::new(oversample as u32),
+                curve: None,
+                oversample,
             };
 
             (node, Box::new(renderer))
@@ -192,7 +190,7 @@ impl WaveShaperNode {
     /// Returns the distortion curve
     #[must_use]
     pub fn curve(&self) -> Option<&[f32]> {
-        self.curve.get().map(Vec::as_slice)
+        self.curve.as_deref()
     }
 
     /// Set the distortion `curve` of this node
@@ -205,29 +203,30 @@ impl WaveShaperNode {
     ///
     /// Panics if a curve has already been given to the source (though `new` or through
     /// `set_curve`)
-    pub fn set_curve(&self, curve: Vec<f32>) {
-        let clone = curve.clone();
-
-        if self.curve.set(curve).is_err() {
+    pub fn set_curve(&mut self, curve: Vec<f32>) {
+        if self.curve.is_some() {
             panic!("InvalidStateError - cannot assign curve twice");
         }
 
+        let clone = curve.clone();
+
+        self.curve = Some(curve);
         self.registration.post_message(Some(clone));
     }
 
     /// Returns the `oversample` faactor of this node
     #[must_use]
     pub fn oversample(&self) -> OverSampleType {
-        self.oversample.load(Ordering::Acquire).into()
+        self.oversample
     }
 
     /// set the `oversample` factor of this node
     ///
     /// # Arguments
     ///
     /// * `oversample` - the desired `OversampleType` variant
-    pub fn set_oversample(&self, oversample: OverSampleType) {
-        self.oversample.store(oversample as u32, Ordering::Release);
+    pub fn set_oversample(&mut self, oversample: OverSampleType) {
+        self.oversample = oversample;
         self.registration.post_message(oversample);
     }
 }
@@ -618,7 +617,7 @@ mod tests {
             ..Default::default()
         };
 
-        let shaper = WaveShaperNode::new(&context, options);
+        let mut shaper = WaveShaperNode::new(&context, options);
         assert_eq!(shaper.curve(), Some(&[1.0][..]));
         assert_eq!(shaper.oversample(), OverSampleType::X2);
 
@@ -641,7 +640,7 @@ mod tests {
             ..Default::default()
         };
 
-        let shaper = WaveShaperNode::new(&context, options);
+        let mut shaper = WaveShaperNode::new(&context, options);
         assert_eq!(shaper.curve(), None);
         assert_eq!(shaper.oversample(), OverSampleType::X2);
 
@@ -659,7 +658,7 @@ mod tests {
         let sample_rate = 44100.;
         let context = OfflineAudioContext::new(1, 3 * RENDER_QUANTUM_SIZE, sample_rate);
 
-        let shaper = context.create_wave_shaper();
+        let mut shaper = context.create_wave_shaper();
         let curve = vec![-0.5, 0., 0.5];
         shaper.set_curve(curve);
         shaper.connect(&context.destination());
@@ -697,7 +696,7 @@ mod tests {
         let sample_rate = 44100.;
         let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
-        let shaper = context.create_wave_shaper();
+        let mut shaper = context.create_wave_shaper();
         let curve = vec![-0.5, 0., 0.5];
         shaper.set_curve(curve);
         shaper.connect(&context.destination());