AudioBufferSourceNode: Use RefCell to encapsulate the loop state

Author: uklotzde

benches/my_benchmark.rs

@@ -168,7 +168,7 @@ pub fn bench_stereo_panning_automation() {
     panner.pan().set_value_at_time(-1., 0.);
     panner.pan().set_value_at_time(0.2, 0.5);
 
-    let mut src = ctx.create_buffer_source();
+    let src = ctx.create_buffer_source();
     src.connect(&panner);
     src.set_buffer(buffer);
     src.set_loop(true);
@@ -188,7 +188,7 @@ pub fn bench_analyser_node() {
     let analyser = ctx.create_analyser();
     analyser.connect(&ctx.destination());
 
-    let mut src = ctx.create_buffer_source();
+    let src = ctx.create_buffer_source();
     src.connect(&analyser);
     src.set_buffer(buffer);
     src.set_loop(true);

examples/audio_buffer.rs

@@ -43,7 +43,7 @@ fn main() {
     buffer.copy_to_channel(&sine, 0);
 
     // play the buffer in a loop
-    let mut src = context.create_buffer_source();
+    let src = context.create_buffer_source();
     src.set_buffer(buffer.clone());
     src.set_loop(true);
     src.connect(&context.destination());

examples/benchmarks.rs

@@ -95,7 +95,7 @@ fn main() {
         let name = "Simple source test without resampling (Mono)";
 
         let context = OfflineAudioContext::new(1, DURATION * sample_rate as usize, sample_rate);
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, sample_rate, 1);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -109,7 +109,7 @@ fn main() {
         let name = "Simple source test without resampling (Stereo)";
 
         let context = OfflineAudioContext::new(2, DURATION * sample_rate as usize, sample_rate);
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, sample_rate, 2);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -133,7 +133,7 @@ fn main() {
         panner.orientation_y().set_value(2.);
         panner.orientation_z().set_value(3.);
 
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         source.connect(&panner);
 
         let buf = get_buffer(&sources, sample_rate, 2);
@@ -148,7 +148,7 @@ fn main() {
         let name = "Simple source test with resampling (Mono)";
 
         let context = OfflineAudioContext::new(1, DURATION * sample_rate as usize, sample_rate);
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, 38000., 1);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -162,7 +162,7 @@ fn main() {
         let name = "Simple source test with resampling (Stereo)";
 
         let context = OfflineAudioContext::new(2, DURATION * sample_rate as usize, sample_rate);
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, 38000., 2);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -186,7 +186,7 @@ fn main() {
         panner.orientation_y().set_value(2.);
         panner.orientation_z().set_value(3.);
 
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         source.connect(&panner);
 
         let buf = get_buffer(&sources, 38000., 2);
@@ -201,7 +201,7 @@ fn main() {
         let name = "Upmix without resampling (Mono -> Stereo)";
 
         let context = OfflineAudioContext::new(2, DURATION * sample_rate as usize, sample_rate);
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, sample_rate, 1);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -215,7 +215,7 @@ fn main() {
         let name = "Downmix without resampling (Stereo -> Mono)";
 
         let context = OfflineAudioContext::new(1, DURATION * sample_rate as usize, sample_rate);
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, sample_rate, 2);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -233,7 +233,7 @@ fn main() {
             OfflineAudioContext::new(2, adjusted_duration * sample_rate as usize, sample_rate);
 
         for _ in 0..100 {
-            let mut source = context.create_buffer_source();
+            let source = context.create_buffer_source();
             let buf = get_buffer(&sources, 38000., 1);
             source.set_buffer(buf);
             source.set_loop(true);
@@ -257,7 +257,7 @@ fn main() {
             let mut buffer = context.create_buffer(1, reference.length(), 38000.);
             buffer.copy_to_channel(channel_data, 0);
 
-            let mut source = context.create_buffer_source();
+            let source = context.create_buffer_source();
             source.set_buffer(buffer);
             source.set_loop(true);
             source.connect(&context.destination());
@@ -288,7 +288,7 @@ fn main() {
         for _ in 0..2 {
             let buf = get_buffer(&sources, 38000., 1);
 
-            let mut source = context.create_buffer_source();
+            let source = context.create_buffer_source();
             source.set_buffer(buf);
             source.set_loop(true);
             source.start();
@@ -339,7 +339,7 @@ fn main() {
         convolver.set_buffer(buffer);
         convolver.connect(&context.destination());
 
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         source.set_buffer(buf);
         source.set_loop(true);
         source.start();
@@ -512,7 +512,7 @@ fn main() {
         panner.connect(&context.destination());
         panner.pan().set_value(0.1);
 
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         let buffer = get_buffer(&sources, sample_rate, 2);
         src.connect(&panner);
         src.set_buffer(buffer);
@@ -532,7 +532,7 @@ fn main() {
         panner.pan().set_value_at_time(-1., 0.);
         panner.pan().set_value_at_time(0.2, 0.5);
 
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         let buffer = get_buffer(&sources, sample_rate, 2);
         src.connect(&panner);
         src.set_buffer(buffer);
@@ -567,7 +567,7 @@ fn main() {
         delay.delay_time().set_value(1.);
         delay.connect(&context.destination());
 
-        let mut source = context.create_buffer_source();
+        let source = context.create_buffer_source();
         let buf = get_buffer(&sources, sample_rate, 2);
         source.set_buffer(buf);
         source.set_loop(true);
@@ -595,7 +595,7 @@ fn main() {
         let iir = context.create_iir_filter(feedforward, feedback);
         iir.connect(&context.destination());
 
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         let buffer = get_buffer(&sources, sample_rate, 2);
         src.connect(&iir);
         src.set_buffer(buffer);
@@ -615,7 +615,7 @@ fn main() {
         biquad.connect(&context.destination());
         biquad.frequency().set_value(200.);
 
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         let buffer = get_buffer(&sources, sample_rate, 2);
         src.connect(&biquad);
         src.set_buffer(buffer);

examples/biquad.rs

@@ -42,7 +42,7 @@ fn main() {
         .exponential_ramp_to_value_at_time(10000., now + 10.);
 
     // pipe the audio buffer source into the lowpass filter
-    let mut src = context.create_buffer_source();
+    let src = context.create_buffer_source();
     src.connect(&biquad);
     src.set_buffer(buffer);
     src.set_loop(true);

examples/doppler.rs

@@ -41,7 +41,7 @@ fn main() {
     let file = File::open("samples/siren.mp3").unwrap();
     let buffer = context.decode_audio_data_sync(file).unwrap();
 
-    let mut src = context.create_buffer_source();
+    let src = context.create_buffer_source();
     src.set_buffer(buffer);
     src.set_loop(true);
 

examples/iir.rs

@@ -43,7 +43,7 @@ fn main() {
     iir.connect(&context.destination());
 
     // Play buffer and pipe to filter
-    let mut src = context.create_buffer_source();
+    let src = context.create_buffer_source();
     src.connect(&iir);
     src.set_buffer(buffer);
     src.set_loop(true);

examples/spatial.rs

@@ -36,7 +36,7 @@ fn main() {
     // Create looping 'siren' sound
     let file = std::fs::File::open("samples/siren.mp3").unwrap();
     let buffer = context.decode_audio_data_sync(file).unwrap();
-    let mut tone = context.create_buffer_source();
+    let tone = context.create_buffer_source();
     tone.set_buffer(buffer);
     tone.set_loop(true);
     tone.start();

examples/trigger_soundfile.rs

@@ -103,7 +103,7 @@ fn main() {
 
     {
         println!("++ simple loop (x2)");
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         src.set_buffer(audio_buffer.clone());
         src.connect(&context.destination());
         src.set_loop(true);
@@ -115,7 +115,7 @@ fn main() {
 
     {
         println!("++ loop between 1 and 2 starting from 0");
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         src.set_buffer(audio_buffer.clone());
         src.connect(&context.destination());
         src.set_loop(true);
@@ -131,7 +131,7 @@ fn main() {
 
     {
         println!("++ loop backward between 1 and 2 starting from end");
-        let mut src = context.create_buffer_source();
+        let src = context.create_buffer_source();
         src.set_buffer(audio_buffer.clone());
         src.connect(&context.destination());
         src.playback_rate().set_value(-1.);

src/buffer.rs

@@ -53,7 +53,7 @@ pub struct AudioBufferOptions {
 /// buffer.copy_to_channel(&sine, 0);
 ///
 /// // play the buffer in a loop
-/// let mut src = context.create_buffer_source();
+/// let src = context.create_buffer_source();
 /// src.set_buffer(buffer.clone());
 /// src.set_loop(true);
 /// src.connect(&context.destination());

src/node/audio_buffer_source.rs

@@ -1,5 +1,5 @@
 use std::any::Any;
-use std::cell::OnceCell;
+use std::cell::{OnceCell, RefCell};
 use std::sync::atomic::{AtomicBool, Ordering};
 
 use crate::buffer::AudioBuffer;
@@ -102,7 +102,7 @@ pub struct AudioBufferSourceNode {
     channel_config: ChannelConfig,
     detune: AudioParam,        // has constraints, no a-rate
     playback_rate: AudioParam, // has constraints, no a-rate
-    loop_state: LoopState,
+    loop_state: RefCell<LoopState>,
     buffer: OnceCell<AudioBuffer>,
     source_started: AtomicBool,
 }
@@ -210,7 +210,7 @@ impl AudioBufferSourceNode {
                 channel_config: ChannelConfig::default(),
                 detune: d_param,
                 playback_rate: pr_param,
-                loop_state,
+                loop_state: RefCell::new(loop_state),
                 buffer: OnceCell::new(),
                 source_started: AtomicBool::new(false),
             };
@@ -287,32 +287,32 @@ impl AudioBufferSourceNode {
 
     /// Defines if the playback the [`AudioBuffer`] should be looped
     pub fn loop_(&self) -> bool {
-        self.loop_state.is_looping
+        self.loop_state.borrow().is_looping
     }
 
-    pub fn set_loop(&mut self, value: bool) {
-        self.loop_state.is_looping = value;
+    pub fn set_loop(&self, value: bool) {
+        self.loop_state.borrow_mut().is_looping = value;
         self.registration.post_message(ControlMessage::Loop(value));
     }
 
     /// Defines the loop start point, in the time reference of the [`AudioBuffer`]
     pub fn loop_start(&self) -> f64 {
-        self.loop_state.start
+        self.loop_state.borrow().start
     }
 
-    pub fn set_loop_start(&mut self, value: f64) {
-        self.loop_state.start = value;
+    pub fn set_loop_start(&self, value: f64) {
+        self.loop_state.borrow_mut().start = value;
         self.registration
             .post_message(ControlMessage::LoopStart(value));
     }
 
     /// Defines the loop end point, in the time reference of the [`AudioBuffer`]
     pub fn loop_end(&self) -> f64 {
-        self.loop_state.end
+        self.loop_state.borrow().end
     }
 
-    pub fn set_loop_end(&mut self, value: f64) {
-        self.loop_state.end = value;
+    pub fn set_loop_end(&self, value: f64) {
+        self.loop_state.borrow_mut().end = value;
         self.registration
             .post_message(ControlMessage::LoopEnd(value));
     }
@@ -1252,7 +1252,7 @@ mod tests {
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE / 2, sample_rate);
             dirac.copy_to_channel(&[1.], 0);
 
-            let mut src = context.create_buffer_source();
+            let src = context.create_buffer_source();
             src.connect(&context.destination());
             src.set_loop(true);
             src.set_buffer(dirac);
@@ -1279,7 +1279,7 @@ mod tests {
             let mut dirac = context.create_buffer(1, 129, sample_rate);
             dirac.copy_to_channel(&[1.], 0);
 
-            let mut src = context.create_buffer_source();
+            let src = context.create_buffer_source();
             src.connect(&context.destination());
             src.set_loop(true);
             src.set_buffer(dirac);
@@ -1307,7 +1307,7 @@ mod tests {
             dirac.copy_to_channel(&[1.], 0);
             dirac.copy_to_channel(&[0., 1.], 1);
 
-            let mut src = context.create_buffer_source();
+            let src = context.create_buffer_source();
             src.connect(&context.destination());
             src.set_loop(true);
             src.set_buffer(dirac);