rename symbols, bump version

Author: BillyDM

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "firewheel"
-version = "0.2.4-beta.0"
+version = "0.3.0"
 description = "Flexible, high-performance, and libre audio engine for games (WIP)"
 repository = "https://github.com/BillyDM/firewheel"
 edition.workspace = true
@@ -84,10 +84,10 @@ stream_nodes = ["firewheel-nodes/stream"]
 bevy = ["firewheel-nodes/bevy", "firewheel-core/bevy"]
 
 [dependencies]
-firewheel-core = { path = "crates/firewheel-core", version = "0.2.4-beta.0" }
-firewheel-graph = { path = "crates/firewheel-graph", version = "0.2.4-beta.0" }
-firewheel-cpal = { path = "crates/firewheel-cpal", version = "0.2.4-beta.0", default-features = false, optional = true }
-firewheel-nodes = { path = "crates/firewheel-nodes", version = "0.2.4-beta.0", default-features = false }
+firewheel-core = { path = "crates/firewheel-core", version = "0.3.0" }
+firewheel-graph = { path = "crates/firewheel-graph", version = "0.3.0" }
+firewheel-cpal = { path = "crates/firewheel-cpal", version = "0.3.0", default-features = false, optional = true }
+firewheel-nodes = { path = "crates/firewheel-nodes", version = "0.3.0", default-features = false }
 thunderdome = { workspace = true, optional = true }
 smallvec = { workspace = true, optional = true }
 

crates/firewheel-core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "firewheel-core"
-version = "0.2.4-beta.0"
+version = "0.3.0"
 description = "Shared types for Firewheel crates"
 homepage = "https://github.com/BillyDM/firewheel/blob/main/crates/firewheel-core"
 edition.workspace = true

crates/firewheel-core/src/node.rs

@@ -8,6 +8,8 @@ use crate::{
     SilenceMask, StreamInfo,
 };
 
+pub mod dummy;
+
 /// A globally unique identifier for a node.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct NodeID(pub thunderdome::Index);
@@ -107,7 +109,7 @@ impl Into<AudioNodeInfoInner> for AudioNodeInfo {
     }
 }
 
-pub trait AudioNodeConstructor {
+pub trait AudioNode: 'static {
     /// A type representing this constructor's configuration.
     ///
     /// This is intended as a one-time configuration to be used
@@ -132,26 +134,26 @@ pub trait AudioNodeConstructor {
 ///
 /// This should be preferred over `()` because it implements
 /// [`Component`][bevy_ecs::prelude::Component], making the
-/// [`AudioNodeConstructor`] implementor trivially Bevy-compatible.
+/// [`AudioNode`] implementor trivially Bevy-compatible.
 #[derive(Debug, Default, Clone, Copy)]
 #[cfg_attr(feature = "bevy", derive(bevy_ecs::prelude::Component))]
 pub struct EmptyConfig;
 
-/// A dyn-compatible [`AudioNodeConstructor`].
-pub trait AudioNode {
+/// A dyn-compatible [`AudioNode`].
+pub trait DynAudioNode: 'static {
     fn info(&self) -> AudioNodeInfo;
     fn processor(&self, stream_info: &StreamInfo) -> Box<dyn AudioNodeProcessor>;
 }
 
 /// Pairs constructors with their configurations.
 ///
-/// This is useful for type-erasing an [`AudioNodeConstructor`].
+/// This is useful for type-erasing an [`AudioNode`].
 pub struct Constructor<T, C> {
     constructor: T,
     configuration: C,
 }
 
-impl<T: AudioNodeConstructor> Constructor<T, T::Configuration> {
+impl<T: AudioNode> Constructor<T, T::Configuration> {
     pub fn new(constructor: T, configuration: Option<T::Configuration>) -> Self {
         Self {
             constructor,
@@ -160,7 +162,7 @@ impl<T: AudioNodeConstructor> Constructor<T, T::Configuration> {
     }
 }
 
-impl<T: AudioNodeConstructor> AudioNode for Constructor<T, T::Configuration> {
+impl<T: AudioNode> DynAudioNode for Constructor<T, T::Configuration> {
     fn info(&self) -> AudioNodeInfo {
         self.constructor.info(&self.configuration)
     }
@@ -334,44 +336,3 @@ impl ProcessStatus {
         Self::OutputsModified { out_silence_mask }
     }
 }
-
-/// The configuration for a "dummy" node, a node which does nothing.
-#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
-pub struct DummyConfig {
-    pub channel_config: ChannelConfig,
-}
-
-impl AudioNodeConstructor for DummyConfig {
-    type Configuration = ();
-
-    fn info(&self, _config: &Self::Configuration) -> AudioNodeInfo {
-        AudioNodeInfo {
-            debug_name: "dummy",
-            channel_config: self.channel_config,
-            uses_events: false,
-        }
-    }
-
-    fn processor(
-        &self,
-        _config: &Self::Configuration,
-        _stream_info: &StreamInfo,
-    ) -> impl AudioNodeProcessor {
-        DummyProcessor
-    }
-}
-
-pub struct DummyProcessor;
-
-impl AudioNodeProcessor for DummyProcessor {
-    fn process(
-        &mut self,
-        _inputs: &[&[f32]],
-        _outputs: &mut [&mut [f32]],
-        _events: NodeEventList,
-        _proc_info: &ProcInfo,
-        _scratch_buffers: ScratchBuffers,
-    ) -> ProcessStatus {
-        ProcessStatus::Bypass
-    }
-}

crates/firewheel-core/src/node/dummy.rs

@@ -0,0 +1,49 @@
+use crate::{channel_config::ChannelConfig, event::NodeEventList, StreamInfo};
+
+use super::{
+    AudioNode, AudioNodeInfo, AudioNodeProcessor, ProcInfo, ProcessStatus, ScratchBuffers,
+};
+
+/// A "dummy" [`AudioNode`], a node which does nothing.
+#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
+pub struct DummyNode;
+
+/// The configuration for a [`DummyNode`], a node which does nothing.
+#[derive(Default, Debug, Clone, Copy, PartialEq, Eq)]
+pub struct DummyNodeConfig {
+    pub channel_config: ChannelConfig,
+}
+
+impl AudioNode for DummyNode {
+    type Configuration = DummyNodeConfig;
+
+    fn info(&self, config: &Self::Configuration) -> AudioNodeInfo {
+        AudioNodeInfo::new()
+            .debug_name("dummy")
+            .channel_config(config.channel_config)
+            .uses_events(false)
+    }
+
+    fn processor(
+        &self,
+        _config: &Self::Configuration,
+        _stream_info: &StreamInfo,
+    ) -> impl AudioNodeProcessor {
+        DummyProcessor
+    }
+}
+
+struct DummyProcessor;
+
+impl AudioNodeProcessor for DummyProcessor {
+    fn process(
+        &mut self,
+        _inputs: &[&[f32]],
+        _outputs: &mut [&mut [f32]],
+        _events: NodeEventList,
+        _proc_info: &ProcInfo,
+        _scratch_buffers: ScratchBuffers,
+    ) -> ProcessStatus {
+        ProcessStatus::Bypass
+    }
+}

crates/firewheel-cpal/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "firewheel-cpal"
-version = "0.2.4-beta.0"
+version = "0.3.0"
 description = "cpal backend for Firewheel"
 homepage = "https://github.com/BillyDM/firewheel/blob/main/crates/firewheel-cpal"
 edition.workspace = true
@@ -19,8 +19,8 @@ input = ["dep:fixed-resample"]
 resample_inputs = ["input", "fixed-resample?/fft-resampler"]
 
 [dependencies]
-firewheel-core = { path = "../firewheel-core", version = "0.2.4-beta.0" }
-firewheel-graph = { path = "../firewheel-graph", version = "0.2.4-beta.0" }
+firewheel-core = { path = "../firewheel-core", version = "0.3.0" }
+firewheel-graph = { path = "../firewheel-graph", version = "0.3.0" }
 cpal = "0.15.3"
 log.workspace = true
 ringbuf.workspace = true

crates/firewheel-cpal/src/input.rs

@@ -11,8 +11,8 @@ use firewheel_core::{
     channel_config::{ChannelConfig, ChannelCount, NonZeroChannelCount},
     event::{NodeEventList, NodeEventType},
     node::{
-        AudioNodeConstructor, AudioNodeInfo, AudioNodeProcessor, EmptyConfig, ProcInfo,
-        ProcessStatus, ScratchBuffers,
+        AudioNode, AudioNodeInfo, AudioNodeProcessor, EmptyConfig, ProcInfo, ProcessStatus,
+        ScratchBuffers,
     },
     sync_wrapper::SyncWrapper,
     SilenceMask, StreamInfo,
@@ -112,14 +112,14 @@ impl Default for CpalInputConfig {
 }
 
 #[derive(Clone)]
-pub struct CpalInputNodeHandle {
+pub struct CpalInputNode {
     config: CpalInputNodeConfig,
     channels: NonZeroChannelCount,
     active_state: Option<ActiveHandleState>,
     shared_state: Arc<SharedState>,
 }
 
-impl CpalInputNodeHandle {
+impl CpalInputNode {
     pub fn new(config: CpalInputNodeConfig, channels: NonZeroChannelCount) -> Self {
         Self {
             config,
@@ -426,13 +426,13 @@ impl CpalInputNodeHandle {
     }
 }
 
-impl Drop for CpalInputNodeHandle {
+impl Drop for CpalInputNode {
     fn drop(&mut self) {
         self.stop_stream();
     }
 }
 
-impl AudioNodeConstructor for CpalInputNodeHandle {
+impl AudioNode for CpalInputNode {
     type Configuration = EmptyConfig;
 
     fn info(&self, _config: &Self::Configuration) -> AudioNodeInfo {

crates/firewheel-graph/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "firewheel-graph"
-version = "0.2.4-beta.0"
+version = "0.3.0"
 description = "Core audio graph algorithm and executor for Firewheel"
 homepage = "https://github.com/BillyDM/firewheel/blob/main/crates/firewheel-graph"
 edition.workspace = true
@@ -15,7 +15,7 @@ exclude.workspace = true
 all-features = true
 
 [dependencies]
-firewheel-core = { path = "../firewheel-core", version = "0.2.4-beta.0" }
+firewheel-core = { path = "../firewheel-core", version = "0.3.0" }
 log.workspace = true
 ringbuf.workspace = true
 smallvec.workspace = true

crates/firewheel-graph/src/context.rs

@@ -4,7 +4,7 @@ use firewheel_core::{
     clock::{ClockSamples, ClockSeconds, MusicalTime, MusicalTransport},
     dsp::declick::DeclickValues,
     event::{NodeEvent, NodeEventType},
-    node::{AudioNodeConstructor, NodeID},
+    node::{AudioNode, DynAudioNode, NodeID},
     StreamInfo,
 };
 use ringbuf::traits::{Consumer, Producer, Split};
@@ -459,21 +459,23 @@ impl<B: AudioBackend> FirewheelCtx<B> {
     }
 
     /// The ID of the graph input node
-    pub fn graph_in_node(&self) -> NodeID {
+    pub fn graph_in_node_id(&self) -> NodeID {
         self.graph.graph_in_node()
     }
 
     /// The ID of the graph output node
-    pub fn graph_out_node(&self) -> NodeID {
+    pub fn graph_out_node_id(&self) -> NodeID {
         self.graph.graph_out_node()
     }
 
     /// Add a node to the audio graph.
-    pub fn add_node<T>(&mut self, constructor: T, config: Option<T::Configuration>) -> NodeID
-    where
-        T: AudioNodeConstructor + 'static,
-    {
-        self.graph.add_node(constructor, config)
+    pub fn add_node<T: AudioNode>(&mut self, node: T, config: Option<T::Configuration>) -> NodeID {
+        self.graph.add_node(node, config)
+    }
+
+    /// Add a node to the audio graph which implements the type-erased [`DynAudioNode`] trait.
+    pub fn add_dyn_node<T: DynAudioNode>(&mut self, node: T) -> NodeID {
+        self.graph.add_dyn_node(node)
     }
 
     /// Remove the given node from the audio graph.