Compare commits

..

No commits in common. "main" and "v0.7.0" have entirely different histories.
main ... v0.7.0

5 changed files with 237 additions and 302 deletions

View File

@ -2,32 +2,6 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## Version 0.9.1 - 2025-01-07
### Miscellaneous Tasks
- Don't set position if values are NaN.
## Version 0.9.0 - 2024-12-06
### Miscellaneous Tasks
- Upgrade to Bevy 0.15.
## Version 0.8.0 - 2024-12-02
### Bug Fixes
- Clear generator when source is cleared, and improve handling for changing source types.
### Features
- Add `Sound.playback_position` to support initializing new buffers at non-zero playback position.
### Miscellaneous Tasks
- Clean up code.
## Version 0.7.0 - 2024-07-07 ## Version 0.7.0 - 2024-07-07
### Miscellaneous Tasks ### Miscellaneous Tasks

View File

@ -1,6 +1,6 @@
[package] [package]
name = "bevy_synthizer" name = "bevy_synthizer"
version = "0.9.1" version = "0.7.0"
authors = ["Nolan Darilek <nolan@thewordnerd.info>"] authors = ["Nolan Darilek <nolan@thewordnerd.info>"]
description = "A Bevy plugin for Synthizer, a library for 3D audio and synthesis with a focus on games and VR applications" description = "A Bevy plugin for Synthizer, a library for 3D audio and synthesis with a focus on games and VR applications"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
@ -10,12 +10,12 @@ repository = "https://labs.lightsout.games/projects/bevy_synthizer"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
bevy = { version = "0.15", default-features = false, features = ["bevy_asset"] } bevy = { version = "0.14", default-features = false, features = ["bevy_asset"] }
synthizer = "0.5.6" synthizer = "0.5.6"
thiserror = "1" thiserror = "1"
[dev-dependencies] [dev-dependencies]
bevy = { version = "0.15", default-features = true } bevy = { version = "0.14", default-features = true }
[package.metadata.release] [package.metadata.release]
publish = false publish = false

View File

@ -31,10 +31,14 @@ fn load_and_create(
if !listeners.is_empty() { if !listeners.is_empty() {
return; return;
} }
commands.spawn((Transform::default(), Listener, RotationTimer::default())); commands.spawn((
TransformBundle::default(),
Listener,
RotationTimer::default(),
));
let handle = asset_server.load("footstep.wav"); let handle = asset_server.load("footstep.wav");
commands.spawn(( commands.spawn((
Transform::from_translation(Vec3::new(10., 0., 0.)), TransformBundle::from(Transform::from_translation(Vec3::new(10., 0., 0.))),
Source::default(), Source::default(),
Sound { Sound {
audio: handle.into(), audio: handle.into(),

View File

@ -13,12 +13,16 @@ impl Default for RotationTimer {
} }
fn setup(mut commands: Commands, context: Res<Context>) { fn setup(mut commands: Commands, context: Res<Context>) {
commands.spawn((Transform::default(), Listener, RotationTimer::default())); commands.spawn((
TransformBundle::default(),
Listener,
RotationTimer::default(),
));
let generator: syz::Generator = syz::FastSineBankGenerator::new_sine(&context, 440.) let generator: syz::Generator = syz::FastSineBankGenerator::new_sine(&context, 440.)
.expect("Failed to create generator") .expect("Failed to create generator")
.into(); .into();
commands.spawn(( commands.spawn((
Transform::from_translation(Vec3::new(10., 0., 0.)), TransformBundle::from(Transform::from_translation(Vec3::new(10., 0., 0.))),
Source::default(), Source::default(),
Sound { Sound {
audio: generator.into(), audio: generator.into(),

View File

@ -2,8 +2,9 @@
use std::collections::HashMap; use std::collections::HashMap;
use bevy::{ use bevy::{
asset::{io::Reader, AssetLoader, LoadContext}, asset::{io::Reader, AssetLoader, AsyncReadExt, LoadContext},
prelude::*, prelude::*,
reflect::TypePath,
transform::TransformSystem, transform::TransformSystem,
}; };
pub use synthizer as syz; pub use synthizer as syz;
@ -29,11 +30,11 @@ impl AssetLoader for BufferAssetLoader {
type Settings = (); type Settings = ();
type Error = BufferAssetLoaderError; type Error = BufferAssetLoaderError;
async fn load( async fn load<'a>(
&self, &'a self,
reader: &mut dyn Reader, reader: &'a mut Reader<'_>,
_settings: &(), _settings: &'a (),
_load_context: &mut LoadContext<'_>, _load_context: &'a mut LoadContext<'_>,
) -> Result<Self::Asset, Self::Error> { ) -> Result<Self::Asset, Self::Error> {
let mut bytes = Vec::new(); let mut bytes = Vec::new();
reader.read_to_end(&mut bytes).await?; reader.read_to_end(&mut bytes).await?;
@ -155,7 +156,6 @@ pub struct Sound {
pub gain: f64, pub gain: f64,
pub pitch: f64, pub pitch: f64,
pub looping: bool, pub looping: bool,
pub playback_position: f64,
pub paused: bool, pub paused: bool,
pub generator: Option<syz::Generator>, pub generator: Option<syz::Generator>,
} }
@ -167,7 +167,6 @@ impl Default for Sound {
gain: 1., gain: 1.,
pitch: 1., pitch: 1.,
looping: false, looping: false,
playback_position: default(),
paused: false, paused: false,
generator: None, generator: None,
} }
@ -230,42 +229,41 @@ fn add_source_handle(
)>, )>,
) { ) {
for (mut source, panner_strategy, transform, angular_pan, scalar_pan) in &mut query { for (mut source, panner_strategy, transform, angular_pan, scalar_pan) in &mut query {
if source.handle.is_some() { if source.handle.is_none() {
continue; let panner_strategy = panner_strategy.cloned().unwrap_or_default();
let handle: syz::Source = if let Some(transform) = transform {
let translation = transform.translation();
syz::Source3D::new(
&context,
*panner_strategy,
(
translation.x as f64,
translation.y as f64,
translation.z as f64,
),
)
.expect("Failed to create source")
.into()
} else if let Some(scalar_pan) = scalar_pan {
syz::ScalarPannedSource::new(&context, *panner_strategy, **scalar_pan)
.expect("Failed to create source")
.into()
} else if let Some(angular_pan) = angular_pan {
syz::AngularPannedSource::new(
&context,
*panner_strategy,
angular_pan.azimuth,
angular_pan.elevation,
)
.expect("Failed to create source")
.into()
} else {
syz::DirectSource::new(&context)
.expect("Failed to create source")
.into()
};
source.handle = Some(handle);
} }
let panner_strategy = panner_strategy.cloned().unwrap_or_default();
let handle: syz::Source = if let Some(transform) = transform {
let translation = transform.translation();
syz::Source3D::new(
&context,
*panner_strategy,
(
translation.x as f64,
translation.y as f64,
translation.z as f64,
),
)
.expect("Failed to create source")
.into()
} else if let Some(scalar_pan) = scalar_pan {
syz::ScalarPannedSource::new(&context, *panner_strategy, **scalar_pan)
.expect("Failed to create source")
.into()
} else if let Some(angular_pan) = angular_pan {
syz::AngularPannedSource::new(
&context,
*panner_strategy,
angular_pan.azimuth,
angular_pan.elevation,
)
.expect("Failed to create source")
.into()
} else {
syz::DirectSource::new(&context)
.expect("Failed to create source")
.into()
};
source.handle = Some(handle);
} }
} }
@ -277,62 +275,55 @@ fn add_generator(
parents: Query<&Parent>, parents: Query<&Parent>,
) { ) {
for (entity, parent, mut sound) in &mut query { for (entity, parent, mut sound) in &mut query {
if sound.generator.is_some() { if sound.generator.is_none() {
continue; let mut source = if let Ok(s) = sources.get_mut(entity) {
} Some(s)
let mut source = if let Ok(s) = sources.get_mut(entity) { } else if parent.is_some() {
Some(s) let mut parent = parent;
} else if parent.is_some() { let mut target = None;
let mut parent = parent; while let Some(p) = parent {
let mut target = None; if sources.get(**p).is_ok() {
while let Some(p) = parent { target = Some(**p);
if sources.get(**p).is_ok() { break;
target = Some(**p);
break;
}
parent = parents.get(**p).ok();
}
target.map(|v| sources.get_mut(v).unwrap())
} else {
None
};
if let Some(source) = source.as_mut() {
if let Some(handle) = source.handle.as_mut() {
let generator: Option<syz::Generator> = match &sound.audio {
Audio::Buffer(buffer) => {
if let Some(b) = buffers.get(buffer) {
let generator = syz::BufferGenerator::new(&context)
.expect("Failed to create generator");
generator.buffer().set(&**b).expect("Unable to set buffer");
assert!(sound.playback_position >= 0.);
generator
.playback_position()
.set(sound.playback_position)
.expect("Failed to set playback position");
Some(generator.into())
} else {
None
}
} }
Audio::Generator(generator) => Some(generator.clone()), parent = parents.get(**p).ok();
}; }
let Some(generator) = generator else { target.map(|v| sources.get_mut(v).unwrap())
continue; } else {
}; None
assert!(sound.gain >= 0.); };
generator if let Some(source) = source.as_mut() {
.gain() if let Some(handle) = source.handle.as_mut() {
.set(sound.gain) let generator: Option<syz::Generator> = match &sound.audio {
.expect("Failed to set gain"); Audio::Buffer(buffer) => {
assert!(sound.pitch > 0. && sound.pitch <= 2.); if let Some(b) = buffers.get(buffer) {
generator let generator = syz::BufferGenerator::new(&context)
.pitch_bend() .expect("Failed to create generator");
.set(sound.pitch) generator.buffer().set(&**b).expect("Unable to set buffer");
.expect("Failed to set pitch"); Some(generator.into())
handle } else {
.add_generator(generator.handle()) None
.expect("Unable to add generator"); }
sound.generator = Some(generator); }
Audio::Generator(generator) => Some(generator.clone()),
};
if let Some(generator) = generator {
assert!(sound.gain >= 0.);
generator
.gain()
.set(sound.gain)
.expect("Failed to set gain");
assert!(sound.pitch > 0. && sound.pitch <= 2.);
generator
.pitch_bend()
.set(sound.pitch)
.expect("Failed to set pitch");
handle
.add_generator(generator.handle())
.expect("Unable to add generator");
sound.generator = Some(generator);
}
}
} }
} }
} }
@ -370,7 +361,6 @@ fn swap_buffers(
if let Some(l) = last_audio.get(&entity) { if let Some(l) = last_audio.get(&entity) {
if sound.generator.is_some() && sound.audio != *l { if sound.generator.is_some() && sound.audio != *l {
sound.generator = None; sound.generator = None;
sound.playback_position = 0.;
} }
} }
last_audio.insert(entity, sound.audio.clone()); last_audio.insert(entity, sound.audio.clone());
@ -392,11 +382,10 @@ fn change_panner_strategy(
check.push(entity); check.push(entity);
} }
for entity in check.iter() { for entity in check.iter() {
let Ok(mut source) = sources.get_mut(*entity) else { if let Ok(mut source) = sources.get_mut(*entity) {
continue; if source.handle.is_some() {
}; source.handle = None;
if source.handle.is_some() { }
source.handle = None;
} }
} }
} }
@ -414,7 +403,6 @@ fn update_source_properties(
Option<&AngularPan>, Option<&AngularPan>,
Option<&ScalarPan>, Option<&ScalarPan>,
Option<&GlobalTransform>, Option<&GlobalTransform>,
Option<&mut Sound>,
)>, )>,
) { ) {
for ( for (
@ -428,20 +416,16 @@ fn update_source_properties(
angular_pan, angular_pan,
scalar_pan, scalar_pan,
transform, transform,
sound,
) in &mut query ) in &mut query
{ {
let Source { gain, .. } = *source; let Source { gain, .. } = *source;
assert!(gain >= 0.); assert!(gain >= 0.);
let Some(handle) = source.handle.as_mut() else { if let Some(handle) = source.handle.as_mut() {
continue; handle.gain().set(gain).expect("Failed to set gain");
}; let mut clear_source = false;
handle.gain().set(gain).expect("Failed to set gain");
let mut clear_source = false;
if let Some(source) = handle.cast_to::<syz::Source3D>().expect("Failed to cast") {
if let Some(transform) = transform { if let Some(transform) = transform {
let translation = transform.translation(); if let Some(source) = handle.cast_to::<syz::Source3D>().expect("Failed to cast") {
if !translation.x.is_nan() && !translation.y.is_nan() && !translation.z.is_nan() { let translation = transform.translation();
source source
.position() .position()
.set(( .set((
@ -450,106 +434,92 @@ fn update_source_properties(
translation.z as f64, translation.z as f64,
)) ))
.expect("Failed to set position"); .expect("Failed to set position");
let distance_model = distance_model
.cloned()
.map(|v| *v)
.unwrap_or_else(|| context.default_distance_model().get().unwrap());
source
.distance_model()
.set(distance_model)
.expect("Failed to set distance_model");
let distance_ref = distance_ref
.map(|v| **v)
.unwrap_or_else(|| context.default_distance_ref().get().unwrap());
assert!(distance_ref >= 0.);
source
.distance_ref()
.set(distance_ref)
.expect("Failed to set distance_ref");
let distance_max = distance_max
.map(|v| **v)
.unwrap_or_else(|| context.default_distance_max().get().unwrap());
assert!(distance_max >= 0.);
source
.distance_max()
.set(distance_max)
.expect("Failed to set distance_max");
let rolloff = rolloff
.map(|v| **v)
.unwrap_or_else(|| context.default_rolloff().get().unwrap());
assert!(rolloff >= 0.);
source
.rolloff()
.set(rolloff)
.expect("Failed to set rolloff");
let closeness_boost = closeness_boost
.map(|v| **v)
.unwrap_or_else(|| context.default_closeness_boost().get().unwrap());
assert!(closeness_boost >= 0.);
source
.closeness_boost()
.set(closeness_boost)
.expect("Failed to set closeness_boost");
let closeness_boost_distance =
closeness_boost_distance.map(|v| **v).unwrap_or_else(|| {
context.default_closeness_boost_distance().get().unwrap()
});
assert!(closeness_boost_distance >= 0.);
source
.closeness_boost_distance()
.set(closeness_boost_distance)
.expect("Failed to set closeness_boost_distance");
} else {
clear_source = true;
}
} else if let Some(angular_pan) = angular_pan {
if let Some(source) = handle
.cast_to::<syz::AngularPannedSource>()
.expect("Failed to cast")
{
assert!(angular_pan.azimuth >= 0. && angular_pan.azimuth <= 360.);
source
.azimuth()
.set(angular_pan.azimuth)
.expect("Failed to set azimuth");
assert!(angular_pan.elevation >= -90. && angular_pan.elevation <= 90.);
source
.elevation()
.set(angular_pan.elevation)
.expect("Failed to set elevation");
} else {
clear_source = true;
}
} else if let Some(scalar_pan) = scalar_pan {
if let Some(source) = handle
.cast_to::<syz::ScalarPannedSource>()
.expect("Failed to cast")
{
assert!(**scalar_pan >= -1. && **scalar_pan <= 1.);
source
.panning_scalar()
.set(**scalar_pan)
.expect("Failed to set scalar panning");
} else {
clear_source = true;
} }
let distance_model = distance_model
.cloned()
.map(|v| *v)
.unwrap_or_else(|| context.default_distance_model().get().unwrap());
source
.distance_model()
.set(distance_model)
.expect("Failed to set distance_model");
let distance_ref = distance_ref
.map(|v| **v)
.unwrap_or_else(|| context.default_distance_ref().get().unwrap());
assert!(distance_ref >= 0.);
source
.distance_ref()
.set(distance_ref)
.expect("Failed to set distance_ref");
let distance_max = distance_max
.map(|v| **v)
.unwrap_or_else(|| context.default_distance_max().get().unwrap());
assert!(distance_max >= 0.);
source
.distance_max()
.set(distance_max)
.expect("Failed to set distance_max");
let rolloff = rolloff
.map(|v| **v)
.unwrap_or_else(|| context.default_rolloff().get().unwrap());
assert!(rolloff >= 0.);
assert!(rolloff >= 0.);
source
.rolloff()
.set(rolloff)
.expect("Failed to set rolloff");
let closeness_boost = closeness_boost
.map(|v| **v)
.unwrap_or_else(|| context.default_closeness_boost().get().unwrap());
assert!(closeness_boost >= 0.);
source
.closeness_boost()
.set(closeness_boost)
.expect("Failed to set closeness_boost");
let closeness_boost_distance = closeness_boost_distance
.map(|v| **v)
.unwrap_or_else(|| context.default_closeness_boost_distance().get().unwrap());
assert!(closeness_boost_distance >= 0.);
source
.closeness_boost_distance()
.set(closeness_boost_distance)
.expect("Failed to set closeness_boost_distance");
} else {
clear_source = true;
} }
} else if let Some(source) = handle if clear_source {
.cast_to::<syz::AngularPannedSource>() source.handle = None;
.expect("Failed to cast")
{
if let Some(angular_pan) = angular_pan {
assert!(angular_pan.azimuth >= 0. && angular_pan.azimuth <= 360.);
source
.azimuth()
.set(angular_pan.azimuth)
.expect("Failed to set azimuth");
assert!(angular_pan.elevation >= -90. && angular_pan.elevation <= 90.);
source
.elevation()
.set(angular_pan.elevation)
.expect("Failed to set elevation");
} else {
clear_source = true;
}
} else if let Some(source) = handle
.cast_to::<syz::ScalarPannedSource>()
.expect("Failed to cast")
{
if let Some(scalar_pan) = scalar_pan {
assert!(**scalar_pan >= -1. && **scalar_pan <= 1.);
source
.panning_scalar()
.set(**scalar_pan)
.expect("Failed to set scalar panning");
} else {
clear_source = true;
}
} else if handle
.cast_to::<syz::DirectSource>()
.expect("Failed to cast")
.is_some()
{
if transform.is_some() || angular_pan.is_some() || scalar_pan.is_some() {
clear_source = true;
}
} else if source.handle.is_some() {
clear_source = true;
}
if clear_source {
source.handle = None;
if let Some(mut sound) = sound {
sound.generator = None;
sound.playback_position = 0.;
} }
} }
} }
@ -565,60 +535,45 @@ fn update_sound_properties(mut query: Query<&mut Sound>) {
} = *sound; } = *sound;
assert!(gain >= 0.); assert!(gain >= 0.);
assert!(pitch > 0. && pitch <= 2.); assert!(pitch > 0. && pitch <= 2.);
let Some(generator) = &sound.generator else { if let Some(generator) = sound.generator.as_mut() {
continue; generator.gain().set(gain).expect("Failed to set gain");
};
if let Some(generator) = generator
.cast_to::<syz::BufferGenerator>()
.expect("Failed to cast")
{
sound.playback_position = generator
.playback_position()
.get()
.expect("Failed to getplayback position");
}
let Some(generator) = sound.generator.as_mut() else {
continue;
};
generator.gain().set(gain).expect("Failed to set gain");
generator
.pitch_bend()
.set(pitch)
.expect("Failed to set pitch");
if let Some(generator) = generator
.cast_to::<syz::BufferGenerator>()
.expect("Failed to cast")
{
generator generator
.looping() .pitch_bend()
.set(looping) .set(pitch)
.expect("Failed to set looping"); .expect("Failed to set pitch");
if let Some(generator) = generator
.cast_to::<syz::BufferGenerator>()
.expect("Failed to cast")
{
generator
.looping()
.set(looping)
.expect("Failed to set looping");
}
} }
} }
} }
fn update_source_playback_state(query: Query<&Source>) { fn update_source_playback_state(query: Query<&Source>) {
for source in &query { for source in &query {
let Some(handle) = &source.handle else { if let Some(handle) = &source.handle {
continue; if source.paused {
}; handle.pause().expect("Failed to pause");
if source.paused { } else {
handle.pause().expect("Failed to pause"); handle.play().expect("Failed to play");
} else { }
handle.play().expect("Failed to play");
} }
} }
} }
fn update_sound_playback_state(query: Query<&Sound>) { fn update_sound_playback_state(query: Query<&Sound>) {
for sound in &query { for sound in &query {
let Some(generator) = &sound.generator else { if let Some(generator) = &sound.generator {
continue; if sound.paused {
}; generator.pause().expect("Failed to pause");
if sound.paused { } else {
generator.pause().expect("Failed to pause"); generator.play().expect("Failed to play");
} else { }
generator.play().expect("Failed to play");
} }
} }
} }
@ -699,24 +654,22 @@ fn events(
mut output: EventWriter<SynthizerEvent>, mut output: EventWriter<SynthizerEvent>,
) { ) {
context.get_events().for_each(|event| { context.get_events().for_each(|event| {
let Ok(event) = event else { if let Ok(event) = event {
return; for (entity, sound) in &sounds {
}; if let Some(generator) = &sound.generator {
for (entity, sound) in &sounds { if *generator.handle() == event.source {
let Some(generator) = &sound.generator else { match event.r#type {
continue; syz::EventType::Finished => {
}; output.send(SynthizerEvent::Finished(entity));
if *generator.handle() == event.source { }
match event.r#type { syz::EventType::Looped => {
syz::EventType::Finished => { output.send(SynthizerEvent::Looped(entity));
output.send(SynthizerEvent::Finished(entity)); }
_ => {}
}
break;
} }
syz::EventType::Looped => {
output.send(SynthizerEvent::Looped(entity));
}
_ => {}
} }
break;
} }
} }
}); });