Merge pull request #405 from orottier/feature/offline-audio-context-start-rendering

OfflineAudioContext::start_rendering_sync now takes &mut instead of self

Author: orottier

benches/my_benchmark.rs

@@ -38,7 +38,7 @@ fn get_audio_buffer(ctx: &OfflineAudioContext) -> AudioBuffer {
 }
 
 pub fn bench_ctor() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     assert_eq!(ctx.start_rendering_sync().length(), SAMPLES);
 }
 
@@ -51,7 +51,7 @@ pub fn bench_audio_buffer_decode() {
 }
 
 pub fn bench_sine() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let mut osc = ctx.create_oscillator();
 
     osc.connect(&ctx.destination());
@@ -61,7 +61,7 @@ pub fn bench_sine() {
 }
 
 pub fn bench_sine_gain() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let mut osc = ctx.create_oscillator();
     let gain = ctx.create_gain();
     gain.gain().set_value(0.5); // avoid happy path
@@ -75,7 +75,7 @@ pub fn bench_sine_gain() {
 }
 
 pub fn bench_sine_gain_delay() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
 
     let mut osc = ctx.create_oscillator();
     let gain = ctx.create_gain();
@@ -93,7 +93,7 @@ pub fn bench_sine_gain_delay() {
 }
 
 pub fn bench_buffer_src() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     let mut src = ctx.create_buffer_source();
@@ -105,7 +105,7 @@ pub fn bench_buffer_src() {
 }
 
 pub fn bench_buffer_src_delay() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     let delay = ctx.create_delay(0.3);
@@ -122,7 +122,7 @@ pub fn bench_buffer_src_delay() {
 }
 
 pub fn bench_buffer_src_iir() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     // these values correspond to a lowpass filter at 200Hz (calculated from biquad)
@@ -148,7 +148,7 @@ pub fn bench_buffer_src_iir() {
 }
 
 pub fn bench_buffer_src_biquad() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     // Create an biquad filter node (defaults to low pass)
@@ -166,7 +166,7 @@ pub fn bench_buffer_src_biquad() {
 }
 
 pub fn bench_stereo_positional() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     // Create static panner node
@@ -189,7 +189,7 @@ pub fn bench_stereo_positional() {
 }
 
 pub fn bench_stereo_panning_automation() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     let panner = ctx.create_stereo_panner();
@@ -210,7 +210,7 @@ pub fn bench_stereo_panning_automation() {
 // We don't request freq/time data because that happens off thread and there is no sensible way to
 // benchmark this in deterministic way [citation needed].
 pub fn bench_analyser_node() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let buffer = get_audio_buffer(&ctx);
 
     let analyser = ctx.create_analyser();
@@ -226,7 +226,7 @@ pub fn bench_analyser_node() {
 }
 
 pub fn bench_hrtf_panners() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES_SHORT), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES_SHORT), SAMPLE_RATE);
 
     let mut panner1 = ctx.create_panner();
     panner1.set_panning_model(PanningModelType::HRTF);
@@ -247,7 +247,7 @@ pub fn bench_hrtf_panners() {
 }
 
 pub fn bench_sine_gain_with_worklet() {
-    let ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
+    let mut ctx = OfflineAudioContext::new(2, black_box(SAMPLES), SAMPLE_RATE);
     let mut osc = ctx.create_oscillator();
 
     let options = AudioWorkletNodeOptions::default();

examples/benchmarks.rs

@@ -45,7 +45,7 @@ fn get_buffer(sources: &[AudioBuffer], sample_rate: f32, number_of_channels: usi
     buffer.unwrap().clone()
 }
 
-fn benchmark(name: &'static str, context: OfflineAudioContext, results: &mut Vec<BenchResult>) {
+fn benchmark(name: &'static str, mut context: OfflineAudioContext, results: &mut Vec<BenchResult>) {
     print!("> Running benchmark: {:<70}\r", name);
     stdout().flush().unwrap();
 

src/context/offline.rs

@@ -17,7 +17,7 @@ pub struct OfflineAudioContext {
     /// the size of the buffer in sample-frames
     length: usize,
     /// the rendering 'thread', fully controlled by the offline context
-    renderer: RenderThread,
+    renderer: Option<RenderThread>,
 }
 
 impl BaseAudioContext for OfflineAudioContext {
@@ -74,16 +74,24 @@ impl OfflineAudioContext {
         Self {
             base,
             length,
-            renderer,
+            renderer: Some(renderer),
         }
     }
 
     /// Given the current connections and scheduled changes, starts rendering audio.
     ///
     /// This function will block the current thread and returns the rendered `AudioBuffer`
     /// synchronously. An async version is currently not implemented.
-    pub fn start_rendering_sync(self) -> AudioBuffer {
-        self.renderer.render_audiobuffer_sync(self.length)
+    ///
+    /// # Panics
+    ///
+    /// Panics if this method is called multiple times
+    pub fn start_rendering_sync(&mut self) -> AudioBuffer {
+        let renderer = match self.renderer.take() {
+            None => panic!("InvalidStateError: Cannot call `startRendering` twice"),
+            Some(v) => v,
+        };
+        renderer.render_audiobuffer_sync(self.length)
     }
 
     /// get the length of rendering audio buffer
@@ -102,12 +110,22 @@ mod tests {
 
     #[test]
     fn render_empty_graph() {
-        let context = OfflineAudioContext::new(2, 555, 44_100.);
+        let mut context = OfflineAudioContext::new(2, 555, 44_100.);
         let buffer = context.start_rendering_sync();
 
+        assert_eq!(context.length(), 555);
+
         assert_eq!(buffer.number_of_channels(), 2);
         assert_eq!(buffer.length(), 555);
         assert_float_eq!(buffer.get_channel_data(0), &[0.; 555][..], abs_all <= 0.);
         assert_float_eq!(buffer.get_channel_data(1), &[0.; 555][..], abs_all <= 0.);
     }
+
+    #[test]
+    #[should_panic]
+    fn render_twice_panics() {
+        let mut context = OfflineAudioContext::new(2, 555, 44_100.);
+        let _ = context.start_rendering_sync();
+        let _ = context.start_rendering_sync();
+    }
 }

src/node/audio_buffer_source.rs

@@ -796,7 +796,7 @@ mod tests {
     fn test_construct_with_options_and_run() {
         let sample_rate = 44100.;
         let length = RENDER_QUANTUM_SIZE;
-        let context = OfflineAudioContext::new(1, length, sample_rate);
+        let mut context = OfflineAudioContext::new(1, length, sample_rate);
 
         let buffer = AudioBuffer::from(vec![vec![1.; RENDER_QUANTUM_SIZE]], sample_rate);
         let options = AudioBufferSourceOptions {
@@ -836,7 +836,7 @@ mod tests {
 
             assert_eq!(audio_buffer.sample_rate(), *sr as f32);
 
-            let context = OfflineAudioContext::new(2, RENDER_QUANTUM_SIZE, 44_100.);
+            let mut context = OfflineAudioContext::new(2, RENDER_QUANTUM_SIZE, 44_100.);
 
             let mut src = context.create_buffer_source();
             src.set_buffer(audio_buffer);
@@ -873,7 +873,7 @@ mod tests {
     #[test]
     fn test_sub_quantum_start() {
         let sample_rate = 480000.;
-        let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+        let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
         let mut dirac = context.create_buffer(1, 1, sample_rate);
         dirac.copy_to_channel(&[1.], 0);
@@ -896,7 +896,7 @@ mod tests {
     fn test_sub_sample_start() {
         // sub sample
         let sample_rate = 480000.;
-        let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+        let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
         let mut dirac = context.create_buffer(1, 1, sample_rate);
         dirac.copy_to_channel(&[1.], 0);
@@ -920,7 +920,7 @@ mod tests {
         // fast track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
             dirac.copy_to_channel(&[0., 0., 0., 0., 1.], 0);
@@ -942,7 +942,7 @@ mod tests {
         // slow track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
             dirac.copy_to_channel(&[0., 0., 0., 0., 1.], 0);
@@ -967,7 +967,7 @@ mod tests {
         // fast track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
             dirac.copy_to_channel(&[0., 0., 0., 0., 1., 1.], 0);
@@ -991,7 +991,7 @@ mod tests {
         // slow track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
             dirac.copy_to_channel(&[0., 0., 0., 0., 1., 1.], 0);
@@ -1016,7 +1016,7 @@ mod tests {
     #[test]
     fn test_schedule_in_the_past() {
         let sample_rate = 48000.;
-        let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+        let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
         let mut dirac = context.create_buffer(1, 1, sample_rate);
         dirac.copy_to_channel(&[1.], 0);
@@ -1039,7 +1039,7 @@ mod tests {
     fn test_audio_buffer_resampling() {
         [22500, 38000, 48000, 96000].iter().for_each(|sr| {
             let base_sr = 44100;
-            let context = OfflineAudioContext::new(1, base_sr, base_sr as f32);
+            let mut context = OfflineAudioContext::new(1, base_sr, base_sr as f32);
 
             // 1Hz sine at different sample rates
             let buf_sr = *sr;
@@ -1080,7 +1080,7 @@ mod tests {
     #[test]
     fn test_playback_rate() {
         let sample_rate = 44100;
-        let context = OfflineAudioContext::new(1, sample_rate, sample_rate as f32);
+        let mut context = OfflineAudioContext::new(1, sample_rate, sample_rate as f32);
 
         let mut buffer = context.create_buffer(1, sample_rate, sample_rate as f32);
         let mut sine = vec![];
@@ -1118,7 +1118,7 @@ mod tests {
     #[test]
     fn test_detune() {
         let sample_rate = 44100;
-        let context = OfflineAudioContext::new(1, sample_rate, sample_rate as f32);
+        let mut context = OfflineAudioContext::new(1, sample_rate, sample_rate as f32);
 
         let mut buffer = context.create_buffer(1, sample_rate, sample_rate as f32);
         let mut sine = vec![];
@@ -1158,7 +1158,7 @@ mod tests {
         // fast track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE * 2, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE * 2, sample_rate);
 
             let mut buffer = context.create_buffer(1, 129, sample_rate);
             let mut data = vec![0.; 129];
@@ -1184,7 +1184,7 @@ mod tests {
         // slow track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE * 2, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE * 2, sample_rate);
 
             let mut buffer = context.create_buffer(1, 129, sample_rate);
             let mut data = vec![0.; 129];
@@ -1213,7 +1213,7 @@ mod tests {
         // fast track
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
             dirac.copy_to_channel(&[0., 0., 0., 0., 1., 1.], 0);
@@ -1235,7 +1235,7 @@ mod tests {
 
         {
             let sample_rate = 480000.;
-            let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+            let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
             let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
             dirac.copy_to_channel(&[0., 0., 0., 0., 1., 1.], 0);
@@ -1266,7 +1266,7 @@ mod tests {
     fn test_with_offset() {
         // offset always bypass slow track
         let sample_rate = 480000.;
-        let context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
+        let mut context = OfflineAudioContext::new(1, RENDER_QUANTUM_SIZE, sample_rate);
 
         let mut dirac = context.create_buffer(1, RENDER_QUANTUM_SIZE, sample_rate);
         dirac.copy_to_channel(&[0., 0., 0., 0., 1., 1.], 0);
@@ -1308,7 +1308,7 @@ mod tests {
             RENDER_QUANTUM_SIZE * 2,
             RENDER_QUANTUM_SIZE * 2 + 1,
         ] {
-            let context = OfflineAudioContext::new(1, len, sample_rate);
+            let mut context = OfflineAudioContext::new(1, len, sample_rate);
 
             let mut dirac = context.create_buffer(1, buffer_len, sample_rate);
             dirac.copy_to_channel(&[1.], 0);
@@ -1347,7 +1347,7 @@ mod tests {
             RENDER_QUANTUM_SIZE * 2,
             RENDER_QUANTUM_SIZE * 2 + 1,
         ] {
-            let context = OfflineAudioContext::new(2, len, sample_rate);
+            let mut context = OfflineAudioContext::new(2, len, sample_rate);
             let mut dirac = context.create_buffer(2, buffer_len, sample_rate);
             dirac.copy_to_channel(&[1.], 0);
             dirac.copy_to_channel(&[0., 1.], 1);

src/node/constant_source.rs

@@ -238,7 +238,7 @@ mod tests {
         let sample_rate = 48000.;
         let start_in_samples = (128 + 1) as f64; // start rendering in 2d block
         let stop_in_samples = (256 + 1) as f64; // stop rendering of 3rd block
-        let context = OfflineAudioContext::new(1, 128 * 4, sample_rate);
+        let mut context = OfflineAudioContext::new(1, 128 * 4, sample_rate);
 
         let mut src = context.create_constant_source();
         src.connect(&context.destination());
@@ -268,7 +268,7 @@ mod tests {
 
     #[test]
     fn test_start_in_the_past() {
-        let context = OfflineAudioContext::new(1, 128, 48000.);
+        let mut context = OfflineAudioContext::new(1, 128, 48000.);
 
         let mut src = context.create_constant_source();
         src.connect(&context.destination());

src/node/convolver.rs

@@ -464,7 +464,7 @@ mod tests {
     #[test]
     fn test_constructor_options_buffer() {
         let sample_rate = 44100.;
-        let context = OfflineAudioContext::new(1, 10, sample_rate);
+        let mut context = OfflineAudioContext::new(1, 10, sample_rate);
 
         let ir = vec![1.];
         let calibration = 0.00125;
@@ -493,7 +493,7 @@ mod tests {
 
     fn test_convolve(signal: &[f32], impulse_resp: Option<Vec<f32>>, length: usize) -> AudioBuffer {
         let sample_rate = 44100.;
-        let context = OfflineAudioContext::new(1, length, sample_rate);
+        let mut context = OfflineAudioContext::new(1, length, sample_rate);
 
         let input = AudioBuffer::from(vec![signal.to_vec()], sample_rate);
         let mut src = AudioBufferSourceNode::new(&context, AudioBufferSourceOptions::default());