Patches for Audio Rework

Author: Raltyro

source/funkin/Conductor.hx

@@ -112,9 +112,6 @@ class Conductor
    */
   var songPositionDelta(default, null):Float = 0;
 
-  var prevTimestamp:Float = 0;
-  var prevTime:Float = 0;
-
   /**
    * Beats per minute of the current song at the current time.
    */
@@ -421,16 +418,7 @@ class Conductor
    */
   public function update(?songPos:Float, applyOffsets:Bool = true, forceDispatch:Bool = false):Void
   {
-    var currentTime:Float = (FlxG.sound.music != null) ? FlxG.sound.music.time : 0.0;
-    var currentLength:Float = (FlxG.sound.music != null) ? FlxG.sound.music.length : 0.0;
-
-    if (songPos == null)
-    {
-      songPos = currentTime;
-    }
-
-    // Take into account instrumental and file format song offsets.
-    songPos += applyOffsets ? (combinedOffset) : 0;
+    if (songPos == null) songPos = (FlxG.sound.music != null) ? FlxG.sound.music.time : 0.0;
 
     var oldMeasure:Float = this.currentMeasure;
     var oldBeat:Float = this.currentBeat;
@@ -439,11 +427,16 @@ class Conductor
     // If the song is playing, limit the song position to the length of the song or beginning of the song.
     if (FlxG.sound.music != null && FlxG.sound.music.playing)
     {
-      this.songPosition = Math.min(this.combinedOffset, 0).clamp(songPos, currentLength);
-      this.songPositionDelta += FlxG.elapsed * 1000 * FlxG.sound.music.pitch;
+      // Take into account instrumental and file format song offsets.
+      songPos += applyOffsets ? (combinedOffset * FlxG.sound.music.pitch) : 0;
+
+      this.songPosition = Math.min(this.combinedOffset, 0).clamp(songPos, FlxG.sound.music.length);
     }
     else
     {
+      // Take into account instrumental and file format song offsets.
+      songPos += applyOffsets ? (combinedOffset) : 0;
+
       this.songPosition = songPos;
     }
 
@@ -502,17 +495,6 @@ class Conductor
       this.onMeasureHit.dispatch();
     }
 
-    // only update the timestamp if songPosition actually changed
-    // which it doesn't do every frame!
-    if (prevTime != this.songPosition)
-    {
-      this.songPositionDelta = 0;
-
-      // Update the timestamp for use in-between frames
-      prevTime = this.songPosition;
-      prevTimestamp = Std.int(Timer.stamp() * 1000);
-    }
-
     if (this == Conductor.instance) @:privateAccess SongSequence.update.dispatch();
   }
 
@@ -522,7 +504,7 @@ class Conductor
    */
   public function getTimeWithDelta():Float
   {
-    return this.songPosition + this.songPositionDelta;
+    return this.songPosition;
   }
 
   /**
@@ -536,10 +518,10 @@ class Conductor
   public function getTimeWithDiff(?soundToCheck:FlxSound):Float
   {
     if (soundToCheck == null) soundToCheck = FlxG.sound.music;
-
-    @:privateAccess
-    this.songPosition = soundToCheck._channel.position;
-    return this.songPosition;
+    return soundToCheck.getActualTime();
+    //@:privateAccess
+    //this.songPosition = soundToCheck.getActualTime();
+    //return this.songPosition;
   }
 
   /**

source/funkin/FunkinMemory.hx

@@ -21,10 +21,6 @@ class FunkinMemory
   static var currentCachedTextures:Map<String, FlxGraphic> = [];
   static var previousCachedTextures:Map<String, FlxGraphic> = [];
 
-  static var permanentCachedSounds:Map<String, Sound> = [];
-  static var currentCachedSounds:Map<String, Sound> = [];
-  static var previousCachedSounds:Map<String, Sound> = [];
-
   static var purgeFilter:Array<String> = ["/week", "/characters", "/charSelect", "/results"];
 
   /**
@@ -102,8 +98,6 @@ class FunkinMemory
   {
     preparePurgeTextureCache();
     purgeTextureCache();
-    preparePurgeSoundCache();
-    purgeSoundCache();
     #if (cpp || neko || hl)
     if (callGarbageCollector) funkin.util.MemoryUtil.collect(true);
     #end
@@ -331,21 +325,7 @@ class FunkinMemory
    */
   public static function cacheSound(key:String):Void
   {
-    if (currentCachedSounds.exists(key)) return;
-
-    if (previousCachedSounds.exists(key))
-    {
-      // Move the texture from the previous cache to the current cache.
-      var sound:Null<Sound> = previousCachedSounds.get(key);
-      previousCachedSounds.remove(key);
-      if (sound != null) currentCachedSounds.set(key, sound);
-      return;
-    }
-
-    var sound:Null<Sound> = Assets.getSound(key, true);
-    if (sound == null) return;
-    else
-      currentCachedSounds.set(key, sound);
+    flixel.sound.FlxSoundData.fromAssetKey(key);
   }
 
   /**
@@ -354,64 +334,8 @@ class FunkinMemory
    */
   public static function permanentCacheSound(key:String):Void
   {
-    if (permanentCachedSounds.exists(key)) return;
-
-    var sound:Null<Sound> = Assets.getSound(key, true);
-    if (sound == null) return;
-    else
-      permanentCachedSounds.set(key, sound);
-
-    if (sound != null) currentCachedSounds.set(key, sound);
-  }
-
-  /**
-   * Prepares the cache for purging unused sounds.
-   */
-  public static function preparePurgeSoundCache():Void
-  {
-    previousCachedSounds = currentCachedSounds.copy();
-
-    for (key in previousCachedSounds.keys())
-    {
-      if (permanentCachedSounds.exists(key))
-      {
-        previousCachedSounds.remove(key);
-      }
-    }
-
-    currentCachedSounds = permanentCachedSounds.copy();
-  }
-
-  /**
-   * Purges unused sounds from the cache.
-   */
-  public static inline function purgeSoundCache():Void
-  {
-    for (key in previousCachedSounds.keys())
-    {
-      if (permanentCachedSounds.exists(key))
-      {
-        previousCachedSounds.remove(key);
-        continue;
-      }
-
-      var sound:Null<Sound> = previousCachedSounds.get(key);
-      if (sound != null)
-      {
-        Assets.cache.removeSound(key);
-        previousCachedSounds.remove(key);
-      }
-    }
-    Assets.cache.clear("songs");
-    Assets.cache.clear("music");
-    // Felt lazy.
-    var key = Paths.music("freakyMenu/freakyMenu");
-    var sound:Null<Sound> = Assets.getSound(key, true);
-    if (sound != null)
-    {
-      permanentCachedSounds.set(key, sound);
-      currentCachedSounds.set(key, sound);
-    }
+    var soundData = flixel.sound.FlxSoundData.fromAssetKey(key);
+    if (soundData != null) soundData.persist = true;
   }
 
   ///// MISC /////
@@ -445,9 +369,6 @@ class FunkinMemory
       if (currentCachedTextures.exists(key)) currentCachedTextures.remove(key);
       Assets.cache.clear(key);
     }
-
-    preparePurgeSoundCache();
-    purgeSoundCache();
   }
 
   /**

source/funkin/Preferences.hx

@@ -416,6 +416,55 @@ class Preferences
     return value;
   }
 
+  #if desktop
+  /**
+   * What audio device should it playback sounds to.
+   * @default Default
+   */
+  public static var audioDevice(get, set):String;
+
+  static function get_audioDevice():String
+  {
+    return Save?.instance?.options?.audioDevice ?? "Default";
+  }
+
+  static function set_audioDevice(value:String):String
+  {
+    var save:Save = Save.instance;
+    if (value == save.options.audioDevice) return value;
+
+    FlxG.sound.automaticDefaultDevice = value == "Default" || (FlxG.sound.deviceName = value) != value;
+
+    save.options.audioDevice = FlxG.sound.automaticDefaultDevice ? "Default" : value;
+    Save.system.flush();
+
+    return value;
+  }
+  #end
+
+  #if native
+  /**
+   * Should the musics be loaded as streamable instead of static.
+   * @default `true`
+   */
+  public static var streamedMusic(get, set):Bool;
+
+  static function get_streamedMusic():Bool
+  {
+    return Save?.instance?.options?.streamedMusic ?? true;
+  }
+
+  static function set_streamedMusic(value:Bool):Bool
+  {
+    flixel.sound.FlxSoundData.allowStreaming = value;
+
+    var save:Save = Save.instance;
+    save.options.streamedMusic = value;
+    Save.system.flush();
+    return value;
+  }
+  #end
+
   /**
    * If enabled, the game will hide the mouse when taking a screenshot.
    * @default `true`
@@ -485,6 +534,24 @@ class Preferences
     setDebugDisplayMode(Preferences.debugDisplay);
     setDebugDisplayBGOpacity(Preferences.debugDisplayBGOpacity / 100);
 
+    #if desktop
+    // Apply audio device preference, if failed, fallback to Default.
+    FlxG.sound.deviceName = Preferences.audioDevice;
+    if (FlxG.sound.deviceName == Preferences.audioDevice)
+    {
+      FlxG.sound.automaticDefaultDevice = false;
+    }
+    else
+    {
+      Preferences.audioDevice = "Default";
+      FlxG.sound.automaticDefaultDevice = true;
+    }
+    #end
+
+    #if native
+    flixel.sound.FlxSoundData.allowStreaming = Preferences.streamedMusic;
+    #end
+
     #if web
     toggleFramerateCap(Preferences.unlockedFramerate);
     #end

source/funkin/audio/FlxStreamSound.hx

@@ -1,14 +1,15 @@
 package funkin.audio;
 
-import flash.media.Sound;
-import flixel.sound.FlxSound;
-import flixel.system.FlxAssets.FlxSoundAsset;
+import lime.media.AudioBuffer;
 import openfl.Assets;
-#if (openfl >= "8.0.0")
+import openfl.media.Sound;
 import openfl.utils.AssetType;
-#end
+import flixel.sound.FlxSound;
+import flixel.system.FlxAssets.FlxSoundAsset;
 
 /**
+ * USE flixel.sound.FlxSoundData or FlxSound.loadStreamed instead!
+ * 
  * a FlxSound that just overrides loadEmbedded to allow for "streamed" sounds to load with better performance!
  */
 @:nullSafety
@@ -19,29 +20,16 @@ class FlxStreamSound extends FlxSound
     super();
   }
 
-  override public function loadEmbedded(EmbeddedSound:Null<FlxSoundAsset>, Looped:Bool = false, AutoDestroy:Bool = false, ?OnComplete:Void->Void):FlxSound
+  override public function loadEmbedded(asset:FlxSoundAsset, ?looped:Bool, ?loopTime:Float, ?endTime:Float, autoDestroy = false, ?onComplete:Void->Void):FlxStreamSound
   {
-    if (EmbeddedSound == null) return this;
-
-    cleanup(true);
-
-    if ((EmbeddedSound is Sound))
-    {
-      _sound = EmbeddedSound;
-    }
-    else if ((EmbeddedSound is Class))
+    if ((asset is String))
     {
-      _sound = Type.createInstance(EmbeddedSound, []);
+      super.loadStreamed(asset, looped, loopTime, endTime, autoDestroy, onComplete);
     }
-    else if ((EmbeddedSound is String))
+    else
     {
-      if (Assets.exists(EmbeddedSound, AssetType.SOUND)
-        || Assets.exists(EmbeddedSound, AssetType.MUSIC)) _sound = Assets.getMusic(EmbeddedSound);
-      else
-        FlxG.log.error('Could not find a Sound asset with an ID of \'$EmbeddedSound\'.');
+      super.loadEmbedded(asset, looped, loopTime, endTime, autoDestroy, onComplete);
     }
-
-    // NOTE: can't pull ID3 info from embedded sound currently
-    return init(Looped, AutoDestroy, OnComplete);
+    return this;
   }
 }