Merge pull request #316 from uklotzde/msrv-1.70

Update MSRV to 1.70 and remove lazy_static and once_cell

Author: orottier

.github/workflows/msrv.yaml

@@ -0,0 +1,43 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow
+
+name: msrv
+
+# read-only repo token, no access to secrets
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check-workspace:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install ALSA and Jack dependencies
+        run: |
+          sudo apt-get update && sudo apt-get install -y libasound2-dev libjack-jackd2-dev cmake
+
+      - name: Install Rust toolchain
+        # Aligned with `rust-version` in `Cargo.toml`
+        uses: dtolnay/[email protected]
+
+      - name: Check out repository
+        uses: actions/checkout@v3
+
+      - name: Generate Cargo.lock
+        run: cargo generate-lockfile
+
+      - name: Cache Rust toolchain and build artifacts
+        uses: Swatinem/rust-cache@v2
+        with:
+          # Distinguished by the action name to avoid sharing!
+          shared-key: "msrv"
+
+      - name: Check workspace
+        run: cargo check --locked --workspace --verbose --all-targets --all-features

.github/workflows/pre-commit.yaml

@@ -3,6 +3,7 @@
 # Same name as the file for consistent identification
 name: pre-commit
 
+# read-only repo token, no access to secrets
 permissions:
   contents: read
 

.github/workflows/rust.yaml

@@ -2,7 +2,10 @@
 
 name: Build
 
-# read-only repo token
+# read-only repo token, no access to secrets
+permissions:
+  contents: read
+
 # no access to secrets
 on:
   push:
@@ -35,6 +38,9 @@ jobs:
       # restore cargo cache from previous runs
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2
+        with:
+          # Distinguished by the action name to avoid sharing!
+          shared-key: "rust"
 
       # check it builds
       - name: Build

.pre-commit-config.yaml

@@ -42,12 +42,12 @@ repos:
       - id: codespell
         args: [--ignore-words=.codespellignore]
   - repo: https://github.com/sirosen/check-jsonschema
-    rev: 0.23.2
+    rev: 0.23.3
     hooks:
       - id: check-github-actions
       - id: check-github-workflows
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0-alpha.9-for-vscode
+    rev: v3.0.0
     hooks:
       - id: prettier
         types_or:

Cargo.toml

@@ -10,6 +10,7 @@ keywords = ["web-audio-api", "audio", "sound", "dsp"]
 license = "MIT"
 categories = ["multimedia::audio"]
 exclude = ["/samples", "/showcase", "/.github"]
+rust-version = "1.70"
 
 [dependencies]
 arc-swap = "1.6"
@@ -22,10 +23,8 @@ dasp_sample = "0.11"
 float_eq = "1.0"
 hound = "3.5"
 hrtf = "0.8"
-lazy_static = "1.4"
 log = "0.4"
 num-complex = "0.4"
-once_cell = "1.10"
 realfft = "3.0"
 rubato = "0.14"
 rustc-hash = "1.1"

src/node/audio_buffer_source.rs

@@ -1,4 +1,4 @@
-use once_cell::sync::OnceCell;
+use std::cell::OnceCell;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::Arc;
 

src/node/mod.rs

@@ -1,16 +1,14 @@
 //! The AudioNode interface and concrete types
 use std::f32::consts::PI;
 use std::sync::atomic::{AtomicU32, AtomicUsize, Ordering};
-use std::sync::Arc;
+use std::sync::{Arc, OnceLock};
 
 use crate::context::{AudioContextRegistration, ConcreteBaseAudioContext};
 use crate::events::{ErrorEvent, EventHandler, EventPayload, EventType};
 use crate::render::{AudioParamValues, AudioProcessor, AudioRenderQuantum, RenderScope};
 use crate::AudioBufferIter;
 use crate::Event;
 
-use lazy_static::lazy_static;
-
 mod analyser;
 pub use analyser::*;
 mod audio_buffer_source;
@@ -58,14 +56,15 @@ pub(crate) const TABLE_LENGTH_BY_4_USIZE: usize = TABLE_LENGTH_USIZE / 4;
 pub(crate) const TABLE_LENGTH_F32: f32 = TABLE_LENGTH_USIZE as f32;
 pub(crate) const TABLE_LENGTH_BY_4_F32: f32 = TABLE_LENGTH_BY_4_USIZE as f32;
 
-// Compute one period sine wavetable of size TABLE_LENGTH
-lazy_static! {
-    pub(crate) static ref SINETABLE: Vec<f32> = {
-        let table: Vec<f32> = (0..TABLE_LENGTH_USIZE)
+/// Precomputed sine table
+pub(crate) fn precomputed_sine_table() -> &'static [f32] {
+    static INSTANCE: OnceLock<Vec<f32>> = OnceLock::new();
+    INSTANCE.get_or_init(|| {
+        // Compute one period sine wavetable of size TABLE_LENGTH
+        (0..TABLE_LENGTH_USIZE)
             .map(|x| ((x as f32) * 2.0 * PI * (1. / (TABLE_LENGTH_F32))).sin())
-            .collect();
-        table
-    };
+            .collect()
+    })
 }
 
 /// How channels must be matched between the node's inputs and outputs.

src/node/oscillator.rs

@@ -9,8 +9,8 @@ use crate::render::{AudioParamValues, AudioProcessor, AudioRenderQuantum, Render
 use crate::RENDER_QUANTUM_SIZE;
 
 use super::{
-    AudioNode, AudioScheduledSourceNode, ChannelConfig, ChannelConfigOptions, SINETABLE,
-    TABLE_LENGTH_USIZE,
+    precomputed_sine_table, AudioNode, AudioScheduledSourceNode, ChannelConfig,
+    ChannelConfigOptions, TABLE_LENGTH_USIZE,
 };
 
 /// Options for constructing an [`OscillatorNode`]
@@ -222,6 +222,7 @@ impl OscillatorNode {
                 started: false,
                 periodic_wave: None,
                 ended_triggered: false,
+                sine_table: precomputed_sine_table(),
             };
 
             let node = Self {
@@ -327,6 +328,8 @@ struct OscillatorRenderer {
     periodic_wave: Option<PeriodicWave>,
     /// defines if the `ended` events was already dispatched
     ended_triggered: bool,
+    /// Precomputed sine table
+    sine_table: &'static [f32],
 }
 
 impl AudioProcessor for OscillatorRenderer {
@@ -467,7 +470,7 @@ impl OscillatorRenderer {
 
         // linear interpolation into lookup table
         let k = (position - floored) as f32;
-        SINETABLE[prev_index].mul_add(1. - k, SINETABLE[next_index] * k)
+        self.sine_table[prev_index].mul_add(1. - k, self.sine_table[next_index] * k)
     }
 
     #[inline]

src/node/stereo_panner.rs

@@ -4,8 +4,8 @@ use crate::param::{AudioParam, AudioParamDescriptor};
 use crate::render::{AudioParamValues, AudioProcessor, AudioRenderQuantum, RenderScope};
 
 use super::{
-    AudioNode, ChannelConfig, ChannelConfigOptions, ChannelCountMode, ChannelInterpretation,
-    SINETABLE, TABLE_LENGTH_BY_4_F32, TABLE_LENGTH_BY_4_USIZE,
+    precomputed_sine_table, AudioNode, ChannelConfig, ChannelConfigOptions, ChannelCountMode,
+    ChannelInterpretation, TABLE_LENGTH_BY_4_F32, TABLE_LENGTH_BY_4_USIZE,
 };
 
 /// Options for constructing a [`StereoPannerOptions`]
@@ -69,10 +69,11 @@ fn assert_valid_channel_count_mode(mode: ChannelCountMode) {
 /// - `gain_left = (x * PI / 2.).cos()`
 /// - `gain_right = (x * PI / 2.).sin()`
 #[inline(always)]
-fn get_stereo_gains(x: f32) -> [f32; 2] {
+fn get_stereo_gains(sine_table: &[f32], x: f32) -> [f32; 2] {
     let idx = (x * TABLE_LENGTH_BY_4_F32) as usize;
-    let gain_left = SINETABLE[idx + TABLE_LENGTH_BY_4_USIZE];
-    let gain_right = SINETABLE[idx];
+
+    let gain_left = sine_table[idx + TABLE_LENGTH_BY_4_USIZE];
+    let gain_right = sine_table[idx];
 
     [gain_left, gain_right]
 }
@@ -183,7 +184,7 @@ impl StereoPannerNode {
 
             pan_param.set_value(options.pan);
 
-            let renderer = StereoPannerRenderer { pan: pan_proc };
+            let renderer = StereoPannerRenderer::new(pan_proc);
 
             let node = Self {
                 registration,
@@ -207,6 +208,16 @@ struct StereoPannerRenderer {
     /// Position of the input in the output’s stereo image.
     /// -1 represents full left, +1 represents full right.
     pan: AudioParamId,
+    sine_table: &'static [f32],
+}
+
+impl StereoPannerRenderer {
+    fn new(pan: AudioParamId) -> Self {
+        Self {
+            pan,
+            sine_table: precomputed_sine_table(),
+        }
+    }
 }
 
 impl AudioProcessor for StereoPannerRenderer {
@@ -239,7 +250,7 @@ impl AudioProcessor for StereoPannerRenderer {
                 if pan_values.len() == 1 {
                     let pan = pan_values[0];
                     let x = (pan + 1.) * 0.5;
-                    let [gain_left, gain_right] = get_stereo_gains(x);
+                    let [gain_left, gain_right] = get_stereo_gains(self.sine_table, x);
 
                     left.iter_mut()
                         .zip(right.iter_mut())
@@ -255,7 +266,7 @@ impl AudioProcessor for StereoPannerRenderer {
                         .zip(input.channel_data(0).iter())
                         .for_each(|(((l, r), pan), input)| {
                             let x = (pan + 1.) * 0.5;
-                            let [gain_left, gain_right] = get_stereo_gains(x);
+                            let [gain_left, gain_right] = get_stereo_gains(self.sine_table, x);
 
                             *l = input * gain_left;
                             *r = input * gain_right;
@@ -266,7 +277,7 @@ impl AudioProcessor for StereoPannerRenderer {
                 if pan_values.len() == 1 {
                     let pan = pan_values[0];
                     let x = if pan <= 0. { pan + 1. } else { pan };
-                    let [gain_left, gain_right] = get_stereo_gains(x);
+                    let [gain_left, gain_right] = get_stereo_gains(self.sine_table, x);
 
                     left.iter_mut()
                         .zip(right.iter_mut())
@@ -290,13 +301,13 @@ impl AudioProcessor for StereoPannerRenderer {
                         .for_each(|((((l, r), &pan), &input_left), &input_right)| {
                             if pan <= 0. {
                                 let x = pan + 1.;
-                                let [gain_left, gain_right] = get_stereo_gains(x);
+                                let [gain_left, gain_right] = get_stereo_gains(self.sine_table, x);
 
                                 *l = input_right.mul_add(gain_left, input_left);
                                 *r = input_right * gain_right;
                             } else {
                                 let x = pan;
-                                let [gain_left, gain_right] = get_stereo_gains(x);
+                                let [gain_left, gain_right] = get_stereo_gains(self.sine_table, x);
 
                                 *l = input_left * gain_left;
                                 *r = input_left.mul_add(gain_right, input_right);
@@ -345,11 +356,13 @@ mod tests {
 
     #[test]
     fn test_get_stereo_gains() {
+        let sine_table = precomputed_sine_table();
+
         // check correctness of wavetable lookup
         for i in 0..1001 {
             let x = i as f32 / 1000.;
 
-            let [gain_left, gain_right] = get_stereo_gains(x);
+            let [gain_left, gain_right] = get_stereo_gains(sine_table, x);
 
             assert_float_eq!(
                 gain_left,

src/node/waveshaper.rs

@@ -1,10 +1,12 @@
-use std::sync::{
-    atomic::{AtomicU32, Ordering},
-    Arc,
+use std::{
+    cell::OnceCell,
+    sync::{
+        atomic::{AtomicU32, Ordering},
+        Arc,
+    },
 };
 
 use crossbeam_channel::{Receiver, Sender};
-use once_cell::sync::OnceCell;
 use rubato::{FftFixedInOut, Resampler as _};
 
 use crate::{