improve sample rate metadata for audio files

Author: BillyDM

Cargo.toml

@@ -45,10 +45,16 @@ tracing = [
     "firewheel-graph/tracing",
     "firewheel-cpal?/tracing",
     "firewheel-rtaudio?/tracing",
+    "firewheel-symphonium?/tracing",
     "std",
 ]
 # Use the `log` crate for logging
-log = ["firewheel-graph/log", "firewheel-cpal?/log", "firewheel-rtaudio?/log"]
+log = [
+    "firewheel-graph/log",
+    "firewheel-cpal?/log",
+    "firewheel-rtaudio?/log",
+    "firewheel-symphonium?/log",
+]
 # Enables scheduling events for nodes
 scheduled_events = [
     "firewheel-core/scheduled_events",

crates/firewheel-core/src/sample_resource.rs

@@ -1,4 +1,7 @@
-use core::{num::NonZeroUsize, ops::Range};
+use core::{
+    num::{NonZeroU32, NonZeroUsize},
+    ops::Range,
+};
 
 #[cfg(not(feature = "std"))]
 use bevy_platform::prelude::Vec;
@@ -12,6 +15,13 @@ pub trait SampleResourceInfo: Send + Sync + 'static {
     ///
     /// Not to be confused with video frames.
     fn len_frames(&self) -> u64;
+
+    /// The sample rate of this resource.
+    ///
+    /// Returns `None` if the sample rate is unknown.
+    fn sample_rate(&self) -> Option<NonZeroU32> {
+        None
+    }
 }
 
 /// A resource of audio samples.
@@ -45,6 +55,7 @@ pub trait SampleResourceF32: SampleResourceInfo {
 pub struct InterleavedResourceI16 {
     pub data: Vec<i16>,
     pub channels: NonZeroUsize,
+    pub sample_rate: Option<NonZeroU32>,
 }
 
 impl SampleResourceInfo for InterleavedResourceI16 {
@@ -55,6 +66,10 @@ impl SampleResourceInfo for InterleavedResourceI16 {
     fn len_frames(&self) -> u64 {
         (self.data.len() / self.channels.get()) as u64
     }
+
+    fn sample_rate(&self) -> Option<NonZeroU32> {
+        self.sample_rate
+    }
 }
 
 impl SampleResource for InterleavedResourceI16 {
@@ -90,6 +105,7 @@ impl core::fmt::Debug for InterleavedResourceI16 {
 pub struct InterleavedResourceU16 {
     pub data: Vec<u16>,
     pub channels: NonZeroUsize,
+    pub sample_rate: Option<NonZeroU32>,
 }
 
 impl SampleResourceInfo for InterleavedResourceU16 {
@@ -100,6 +116,10 @@ impl SampleResourceInfo for InterleavedResourceU16 {
     fn len_frames(&self) -> u64 {
         (self.data.len() / self.channels.get()) as u64
     }
+
+    fn sample_rate(&self) -> Option<NonZeroU32> {
+        self.sample_rate
+    }
 }
 
 impl SampleResource for InterleavedResourceU16 {
@@ -135,6 +155,7 @@ impl core::fmt::Debug for InterleavedResourceU16 {
 pub struct InterleavedResourceF32 {
     pub data: Vec<f32>,
     pub channels: NonZeroUsize,
+    pub sample_rate: Option<NonZeroU32>,
 }
 
 impl SampleResourceInfo for InterleavedResourceF32 {
@@ -145,6 +166,10 @@ impl SampleResourceInfo for InterleavedResourceF32 {
     fn len_frames(&self) -> u64 {
         (self.data.len() / self.channels.get()) as u64
     }
+
+    fn sample_rate(&self) -> Option<NonZeroU32> {
+        self.sample_rate
+    }
 }
 
 impl SampleResource for InterleavedResourceF32 {

crates/firewheel-symphonium/Cargo.toml

@@ -10,6 +10,7 @@ exclude.workspace = true
 repository.workspace = true
 
 [features]
+default = ["tracing"]
 resample = [
     "dep:fixed-resample",
     "symphonium/resampler",
@@ -20,10 +21,14 @@ stretch = [
     "resample",
     "symphonium/stretch-sinc-resampler",
 ]
+# Use the `tracing` crate for logging. Currently requires `std`.
+tracing = ["symphonium/tracing"]
+# Use the `log` crate for logging
+log = ["symphonium/log"]
 
 [dependencies]
 firewheel-core = { path = "../firewheel-core", version = "0.10.0", default-features = false }
-symphonium = { version = "0.6.5", default-features = false }
+symphonium = { version = "0.7.0", default-features = false }
 fixed-resample = { version = "0.9.2", default-features = false, features = [
     "resampler",
     "fft-resampler",

crates/firewheel-symphonium/src/lib.rs

@@ -1,4 +1,7 @@
-use std::{num::NonZeroUsize, ops::Range};
+use std::{
+    num::{NonZeroU32, NonZeroUsize},
+    ops::Range,
+};
 
 use firewheel_core::{
     collector::ArcGc,
@@ -12,14 +15,24 @@ pub struct DecodedAudio(pub symphonium::DecodedAudio);
 
 impl DecodedAudio {
     pub fn duration_seconds(&self) -> f64 {
-        self.0.frames() as f64 / self.0.sample_rate() as f64
+        self.0.frames() as f64 / self.0.sample_rate().get() as f64
     }
 
     pub fn into_dyn_resource(self) -> ArcGc<dyn SampleResource> {
         ArcGc::new_unsized(|| {
             bevy_platform::sync::Arc::new(self) as bevy_platform::sync::Arc<dyn SampleResource>
         })
     }
+
+    /// The sample rate of this resource.
+    pub fn sample_rate(&self) -> NonZeroU32 {
+        self.0.sample_rate()
+    }
+
+    /// The sample rate of the audio resource before it was resampled (if it was resampled).
+    pub fn original_sample_rate(&self) -> NonZeroU32 {
+        self.0.original_sample_rate()
+    }
 }
 
 impl From<DecodedAudio> for ArcGc<dyn SampleResource> {
@@ -36,6 +49,10 @@ impl SampleResourceInfo for DecodedAudio {
     fn len_frames(&self) -> u64 {
         self.0.frames() as u64
     }
+
+    fn sample_rate(&self) -> Option<NonZeroU32> {
+        Some(self.0.sample_rate())
+    }
 }
 
 impl SampleResource for DecodedAudio {
@@ -77,8 +94,18 @@ impl From<symphonium::DecodedAudio> for DecodedAudio {
 pub struct DecodedAudioF32(pub symphonium::DecodedAudioF32);
 
 impl DecodedAudioF32 {
-    pub fn duration_seconds(&self, sample_rate: u32) -> f64 {
-        self.0.frames() as f64 / sample_rate as f64
+    pub fn duration_seconds(&self, sample_rate: NonZeroU32) -> f64 {
+        self.0.frames() as f64 / sample_rate.get() as f64
+    }
+
+    /// The sample rate of this resource.
+    pub fn sample_rate(&self) -> NonZeroU32 {
+        self.0.sample_rate
+    }
+
+    /// The sample rate of the audio resource before it was resampled (if it was resampled).
+    pub fn original_sample_rate(&self) -> NonZeroU32 {
+        self.0.original_sample_rate
     }
 }
 
@@ -90,6 +117,10 @@ impl SampleResourceInfo for DecodedAudioF32 {
     fn len_frames(&self) -> u64 {
         self.0.frames() as u64
     }
+
+    fn sample_rate(&self) -> Option<NonZeroU32> {
+        Some(self.0.sample_rate)
+    }
 }
 
 impl SampleResource for DecodedAudioF32 {
@@ -135,7 +166,7 @@ pub fn load_audio_file<P: AsRef<std::path::Path>>(
         .load(
             path,
             #[cfg(feature = "resample")]
-            target_sample_rate.map(|s| s.get()),
+            target_sample_rate,
             #[cfg(feature = "resample")]
             resample_quality,
             None,
@@ -169,7 +200,7 @@ pub fn load_audio_file_from_source(
             source,
             hint,
             #[cfg(feature = "resample")]
-            target_sample_rate.map(|s| s.get()),
+            target_sample_rate,
             #[cfg(feature = "resample")]
             resample_quality,
             None,
@@ -197,7 +228,7 @@ pub fn load_audio_file_stretched<P: AsRef<std::path::Path>>(
     stretch: f64,
 ) -> Result<DecodedAudio, symphonium::error::LoadError> {
     loader
-        .load_f32_stretched(path, stretch, target_sample_rate.map(|s| s.get()), None)
+        .load_stretched(path, stretch, target_sample_rate, None)
         .map(|d| DecodedAudio(d.into()))
 }
 
@@ -224,13 +255,7 @@ pub fn load_audio_file_from_source_stretched(
     stretch: f64,
 ) -> Result<DecodedAudio, symphonium::error::LoadError> {
     loader
-        .load_f32_from_source_stretched(
-            source,
-            hint,
-            stretch,
-            target_sample_rate.map(|s| s.get()),
-            None,
-        )
+        .load_from_source_stretched(source, hint, stretch, target_sample_rate, None)
         .map(|d| DecodedAudio(d.into()))
 }
 

examples/play_sample/Cargo.toml

@@ -8,5 +8,5 @@ publish = false
 firewheel = { path = "../../" }
 tracing.workspace = true
 tracing-subscriber.workspace = true
-symphonium = { version = "0.6.5", features = ["mp3", "flac"] }
+symphonium = { version = "0.7.0", features = ["mp3", "flac"] }
 clap = { version = "4", features = ["derive"] }

examples/sampler_pool/Cargo.toml

@@ -12,7 +12,7 @@ tracing.workspace = true
 tracing-subscriber.workspace = true
 egui.workspace = true
 eframe.workspace = true
-symphonium = { version = "0.6.5", features = ["mp3", "flac"] }
+symphonium = { version = "0.7.0", features = ["mp3", "flac"] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"

examples/sampler_test/Cargo.toml

@@ -10,7 +10,7 @@ tracing.workspace = true
 tracing-subscriber.workspace = true
 egui.workspace = true
 eframe.workspace = true
-symphonium = { version = "0.6.5", features = ["mp3", "flac"] }
+symphonium = { version = "0.7.0", features = ["mp3", "flac"] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"

examples/spatial_basic/Cargo.toml

@@ -10,7 +10,7 @@ tracing.workspace = true
 tracing-subscriber.workspace = true
 egui.workspace = true
 eframe.workspace = true
-symphonium = { version = "0.6.5", features = ["mp3", "flac"] }
+symphonium = { version = "0.7.0", features = ["mp3", "flac"] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"

examples/visual_node_graph/Cargo.toml

@@ -11,7 +11,7 @@ tracing-subscriber.workspace = true
 egui.workspace = true
 eframe.workspace = true
 egui-snarl = "0.9.0"
-symphonium = { version = "0.6.4", features = ["mp3", "flac"] }
+symphonium = { version = "0.7.0", features = ["mp3", "flac"] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 wasm-bindgen-futures = "0.4"

examples/visualizer/Cargo.toml

@@ -10,7 +10,7 @@ tracing.workspace = true
 tracing-subscriber.workspace = true
 egui.workspace = true
 eframe.workspace = true
-symphonium = { version = "0.6.5", features = ["mp3", "flac"] }
+symphonium = { version = "0.7.0", features = ["mp3", "flac"] }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
-wasm-bindgen-futures = "0.4"
+wasm-bindgen-futures = "0.4"