Merge pull request 'Added the ability to switch soundfont after initialization' (#3) from wip into master

Reviewed-on: #3

.gitignore

@@ -1,3 +1,4 @@
 /target
 .vscode
 .cargo
+Cargo.lock

Cargo.toml

@@ -1,16 +1,17 @@
 [package]
 name = "bevy_rustysynth"
 description = "A plugin which adds MIDI file and soundfont audio support to the bevy engine via rustysynth."
-version = "0.4.0"
+version = "0.5.0"
 edition = "2021"
 license = "0BSD OR MIT OR Apache-2.0"
-repository = "https://git.soaos.dev/bevy_rustysynth"
+repository = "https://git.soaos.dev/soaos/bevy_rustysynth"
 
 [dependencies]
 rustysynth = "1.3"
 itertools = "0.14"
 async-channel = "2.3"
 rodio = "0.20"
+lazy_static = "1.5"
 
 [dependencies.bevy]
 version = "0.15"

README.md

@@ -2,8 +2,6 @@
 
 ![Crates](https://img.shields.io/crates/v/bevy_rustysynth)
 ![License](https://img.shields.io/badge/license-0BSD%2FMIT%2FApache-blue.svg)
-![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_rustysynth)
-![Build](https://img.shields.io/github/actions/workflow/status/exvacuum/bevy_rustysynth/rust.yml)
 
 A plugin which adds MIDI file and soundfont audio support to the bevy engine via rustysynth.
 
@@ -12,22 +10,22 @@ From version 0.4, the crate has undergone significant rewrites, and now works wi
 ## Compatibility
 
 | Crate Version | Bevy Version |
-|---            |---           |
+| ------------- | ------------ |
-| 0.3-0.4       | 0.15         |
+| 0.5           | 0.15         |
-| 0.1-0.2       | 0.14         |
+| 0.2           | 0.14         |
 
 ## Installation
 
 ### crates.io
 ```toml
 [dependencies]
-bevy_rustysynth = "0.4"
+bevy_rustysynth = "0.5"
 ```
 
 ### Using git URL in Cargo.toml
 ```toml
 [dependencies.bevy_rustysynth]
-git = "https://git.soaos.dev/bevy_rustysynth.git"
+git = "https://git.soaos.dev/soaos/bevy_rustysynth.git"
 ```
 
 ## Usage

src/assets.rs

@@ -1,13 +1,15 @@
-use std::{
+use bevy::asset::{io::Reader, AssetLoader, LoadContext};
-    io::{self, Cursor}, sync::Arc, time::Duration
-};
-#[cfg(feature = "kira")]
-use std::future::Future;
 #[cfg(feature = "bevy_audio")]
 use bevy::prelude::*;
-use bevy::asset::{io::Reader, AssetLoader, LoadContext};
 use itertools::Itertools;
 use rustysynth::{MidiFile, MidiFileSequencer, SoundFont, Synthesizer, SynthesizerSettings};
+#[cfg(feature = "kira")]
+use std::future::Future;
+use std::{
+    io::{self, Cursor},
+    sync::Arc,
+    time::Duration,
+};
 
 use crate::SOUNDFONT;
 
@@ -41,7 +43,6 @@ impl Default for MidiNote {
     }
 }
 
-
 /// AssetLoader for MIDI files (.mid/.midi)
 #[derive(Default, Debug)]
 pub struct MidiAssetLoader;
@@ -56,7 +57,7 @@ pub struct MidiFileDecoder {
 
 impl MidiFileDecoder {
     /// Construct and render a MIDI sequence with the given MIDI data and soundfont.
-    pub async fn new(midi_data: Vec<u8>, soundfont: Arc<SoundFont>) -> Self {
+    pub fn new(midi_data: Vec<u8>, soundfont: Arc<SoundFont>) -> Self {
         let sample_rate = 44100_usize;
         let settings = SynthesizerSettings::new(sample_rate as i32);
         let synthesizer =
@@ -161,7 +162,10 @@ mod bevy_audio {
         type DecoderItem = <MidiFileDecoder as Iterator>::Item;
 
         fn decoder(&self) -> Self::Decoder {
-            bevy::tasks::block_on(MidiFileDecoder::new(self.0.clone(), SOUNDFONT.get().unwrap().clone()))
+            MidiFileDecoder::new(
+                self.0.clone(),
+                SOUNDFONT.lock().unwrap().as_ref().unwrap().clone(),
+            )
         }
     }
 
@@ -241,7 +245,8 @@ mod kira {
 
     impl MidiAudioExtensions for AudioSource {
         async fn from_midi_file(data: Vec<u8>) -> Self {
-            let decoder = MidiFileDecoder::new(data, SOUNDFONT.get().unwrap().clone()).await;
+            let decoder =
+                MidiFileDecoder::new(data, SOUNDFONT.lock().unwrap().as_ref().unwrap().clone());
             let frames = decoder
                 .data
                 .chunks(2)
@@ -262,7 +267,10 @@ mod kira {
         }
 
         async fn from_midi_sequence(sequence: Vec<MidiNote>) -> Self {
-            let decoder = MidiFileDecoder::new_sequence(sequence, SOUNDFONT.get().unwrap().clone());
+            let decoder = MidiFileDecoder::new_sequence(
+                sequence,
+                SOUNDFONT.lock().unwrap().as_ref().unwrap().clone(),
+            );
             let frames = decoder
                 .data
                 .chunks(2)

src/lib.rs

@@ -4,17 +4,19 @@
 #[cfg(all(feature = "bevy_audio", feature = "kira"))]
 compile_error!("Cannot compile with both bevy_audio and kira features enabled simultaneously. Please disable one of these features");
 
-use bevy::prelude::*;
-use rustysynth::SoundFont;
-use std::{
-    io::Read,
-    sync::{Arc, OnceLock},
-};
-#[cfg(feature = "hl4mgm")]
-use std::io::Cursor;
 #[cfg(feature = "bevy_audio")]
 use bevy::audio::AddAudioSource;
-
+use bevy::prelude::*;
+use lazy_static::lazy_static;
+use rustysynth::SoundFont;
+#[cfg(feature = "hl4mgm")]
+use std::io::Cursor;
+use std::{
+    fs::{self, File},
+    io::Read,
+    path::PathBuf,
+    sync::{Arc, Mutex},
+};
 
 mod assets;
 pub use assets::*;
@@ -22,11 +24,22 @@ pub use assets::*;
 #[cfg(feature = "hl4mgm")]
 pub(crate) static HL4MGM: &[u8] = include_bytes!("./embedded_assets/hl4mgm.sf2");
 
-pub(crate) static SOUNDFONT: OnceLock<Arc<SoundFont>> = OnceLock::new();
+lazy_static! {
+    pub(crate) static ref DEFAULT_SOUNDFONT: Arc<Mutex<Option<Arc<SoundFont>>>> =
+        Arc::new(Mutex::new(None));
+    pub(crate) static ref SOUNDFONT: Arc<Mutex<Option<Arc<SoundFont>>>> =
+        Arc::new(Mutex::new(None));
+}
+
+#[derive(SystemSet, Hash, Clone, PartialEq, Eq, Debug)]
+pub enum RustySynthSet {
+    Setup,
+    Update,
+}
 
 /// This plugin configures the soundfont used for playback and registers MIDI assets.
 #[derive(Debug)]
-pub struct RustySynthPlugin<R: Read + Send + Sync + Clone + 'static> {
+pub struct RustySynthPlugin<R: Read + Clone + 'static> {
     /// Reader for soundfont data.
     pub soundfont: R,
 }
@@ -42,11 +55,50 @@ impl Default for RustySynthPlugin<Cursor<&[u8]>> {
 
 impl<R: Read + Send + Sync + Clone + 'static> Plugin for RustySynthPlugin<R> {
     fn build(&self, app: &mut App) {
-        let _ = SOUNDFONT.set(Arc::new(
+        *DEFAULT_SOUNDFONT.lock().unwrap() = Some(Arc::new(
             SoundFont::new(&mut self.soundfont.clone()).unwrap(),
         ));
-        app.init_asset_loader::<MidiAssetLoader>();
+        info!("Setting Soundfont Initially");
+        *SOUNDFONT.lock().unwrap() = DEFAULT_SOUNDFONT.lock().unwrap().clone();
+        app.init_asset_loader::<MidiAssetLoader>()
+            .add_event::<SetSoundfontEvent>()
+            .add_systems(Startup, handle_set_soundfont.in_set(RustySynthSet::Setup))
+            .add_systems(Update, handle_set_soundfont.in_set(RustySynthSet::Update));
         #[cfg(feature = "bevy_audio")]
-        app.init_asset::<MidiAudio>().add_audio_source::<MidiAudio>();
+        app.init_asset::<MidiAudio>()
+            .add_audio_source::<MidiAudio>();
+    }
+}
+
+pub(crate) fn set_soundfont<R: Read + 'static>(mut reader: R) {
+    info!("Setting Soundfont");
+    *SOUNDFONT.lock().unwrap() = Some(Arc::new(SoundFont::new(&mut reader).unwrap()));
+}
+
+/// Event for setting the soundfont after initialization
+/// This will not affect sounds which have already been rendered
+#[derive(Event)]
+pub enum SetSoundfontEvent {
+    /// Load soundfont from bytes
+    Bytes(Vec<u8>),
+    /// Load soundfont at path
+    Path(PathBuf),
+    /// Load default soundfont
+    Default,
+}
+
+fn handle_set_soundfont(mut event_reader: EventReader<SetSoundfontEvent>) {
+    for event in event_reader.read() {
+        match event {
+            SetSoundfontEvent::Bytes(items) => {
+                set_soundfont(Cursor::new(items.clone()));
+            }
+            SetSoundfontEvent::Path(path_buf) => {
+                set_soundfont(File::open(path_buf).unwrap());
+            }
+            SetSoundfontEvent::Default => {
+                *SOUNDFONT.lock().unwrap() = DEFAULT_SOUNDFONT.lock().unwrap().clone();
+            }
+        }
     }
 }