Fix PlayState sounds, and resyncing

Author: Raltyro

source/funkin/play/PlayState.hx

@@ -1170,28 +1170,9 @@ class PlayState extends MusicBeatSubState
         Conductor.instance.formatOffset = 0.0;
       }
 
-      // Lime has some precision loss when getting the sound current position
-      // Since the notes scrolling is dependant on the sound time that caused it to appear "stuttery" for some people
-      // As a workaround for that, we lerp the conductor position to the music time to fill the gap in this lost precision making the scrolling smoother
-      // The previous method where it "guessed" the song position based on the elapsed time had some flaws
-      // Somtimes the songPosition would exceed the music length causing issues in other places
-      // And it was frame dependant which we don't like!!
       if (FlxG.sound.music.playing)
       {
-        final audioDiff:Float = Math.round(Math.abs(FlxG.sound.music.time - (Conductor.instance.songPosition - Conductor.instance.combinedOffset)));
-        if (audioDiff <= CONDUCTOR_DRIFT_THRESHOLD)
-        {
-          // Only do neat & smooth lerps as long as the lerp doesn't fuck up and go WAY behind the music time triggering false resyncs
-          final easeRatio:Float = 1.0 - Math.exp(-(MUSIC_EASE_RATIO * playbackRate) * elapsed);
-          Conductor.instance.update(FlxMath.lerp(Conductor.instance.songPosition, FlxG.sound.music.time + Conductor.instance.combinedOffset, easeRatio), false);
-        }
-        else
-        {
-          // Fallback to properly update the conductor incase the lerp messed up
-          // Shouldn't be fallen back to unless you're lagging alot
-          trace(' WARNING '.bg_yellow().bold() + ' Normal Conductor Update!! are you lagging?');
-          Conductor.instance.update();
-        }
+        Conductor.instance.update();
       }
     }
 
@@ -1551,31 +1532,19 @@ class PlayState extends MusicBeatSubState
           FlxG.sound.music.pause();
           musicPausedBySubState = true;
         }
+        vocals?.pause();
 
         // Pause any sounds that are playing and keep track of them.
         // Vocals are also paused here but are not included as they are handled separately.
         if (Std.isOfType(subState, PauseSubState))
         {
           FlxG.sound.list.forEachAlive(function(sound:FlxSound) {
-            if (!sound.active || sound == FlxG.sound.music) return;
-            // In case it's a scheduled sound
-            if (Std.isOfType(sound, FunkinSound))
-            {
-              var funkinSound:FunkinSound = cast sound;
-              if (funkinSound != null && !funkinSound.isPlaying) return;
-            }
-            if (!sound.playing && sound.time >= 0) return;
-            sound.pause();
+            if (!sound.playing || !sound.active || sound == FlxG.sound.music) return;
             soundsPausedBySubState.add(sound);
           });
+          vocals?.forEach(function(voice:FunkinSound) soundsPausedBySubState.remove(voice));
 
-          vocals?.forEach(function(voice:FunkinSound) {
-            soundsPausedBySubState.remove(voice);
-          });
-        }
-        else
-        {
-          vocals?.pause();
+          for (sound in soundsPausedBySubState) sound.pause();
         }
       }
 
@@ -1629,42 +1598,9 @@ class PlayState extends MusicBeatSubState
 
       if (event.eventCanceled) return;
 
-      // Pause any sounds that are playing and keep track of them.
-      // Vocals are also paused here but are not included as they are handled separately.
-      if (!isGameOverState)
-      {
-        FlxG.sound.list.forEachAlive(function(sound:FlxSound) {
-          if (!sound.active || sound == FlxG.sound.music) return;
-          // In case it's a scheduled sound
-          if (Std.isOfType(sound, FunkinSound))
-          {
-            var funkinSound:FunkinSound = cast sound;
-            if (funkinSound != null && !funkinSound.isPlaying) return;
-          }
-          if (!sound.playing && sound.time >= 0) return;
-          sound.pause();
-          soundsPausedBySubState.add(sound);
-        });
-
-        vocals?.forEach(function(voice:FunkinSound) {
-          soundsPausedBySubState.remove(voice);
-        });
-      }
-      else
-      {
-        vocals?.pause();
-      }
-
       // Resume vwooshTimer
       if (!vwooshTimer.finished) vwooshTimer.active = true;
 
-      // Resume music if we paused it.
-      if (musicPausedBySubState)
-      {
-        if (FlxG.sound.music != null) FlxG.sound.music.play();
-        musicPausedBySubState = false;
-      }
-
       // The logic here is that if this sound doesn't auto-destroy
       // then it's gonna be reused somewhere, so we just stop it instead.
       forEachPausedSound(s -> needsReset ? (s.autoDestroy ? s.destroy() : s.stop()) : s.resume());
@@ -1687,8 +1623,10 @@ class PlayState extends MusicBeatSubState
         currentConversation.resumeMusic();
       }
 
-      // Re-sync vocals.
-      if (FlxG.sound.music != null && !startingSong && !isInCutscene) resyncVocals();
+      // If we have started the song, resync it instead that plays the song, else resume music if we paused it.
+      if (FlxG.sound.music != null && !startingSong && !isInCutscene) resyncVocals(true);
+      else if (musicPausedBySubState) FlxG.sound.music?.play();
+      musicPausedBySubState = false;
 
       // Resume the countdown.
       Countdown.resumeCountdown();
@@ -1890,19 +1828,19 @@ class PlayState extends MusicBeatSubState
         @:privateAccess // todo: maybe make the groups public :thinking:
         {
           vocals.playerVoices?.forEachAlive(function(voice:FunkinSound) {
-            var currentRawVoiceTime:Float = voice.time + vocals.playerVoicesOffset;
-            if (Math.abs(currentRawVoiceTime - correctSync) > Math.abs(playerVoicesError)) playerVoicesError = currentRawVoiceTime - correctSync;
+            var currentRawVoiceTime:Float = voice.getActualTime() + vocals.playerVoicesOffset;
+            if (Math.abs(currentRawVoiceTime - correctSync) > Math.abs(playerVoicesError) && voice.playing) playerVoicesError = currentRawVoiceTime - correctSync;
           });
 
           vocals.opponentVoices?.forEachAlive(function(voice:FunkinSound) {
-            var currentRawVoiceTime:Float = voice.time + vocals.opponentVoicesOffset;
-            if (Math.abs(currentRawVoiceTime - correctSync) > Math.abs(opponentVoicesError)) opponentVoicesError = currentRawVoiceTime - correctSync;
+            var currentRawVoiceTime:Float = voice.getActualTime() + vocals.opponentVoicesOffset;
+            if (Math.abs(currentRawVoiceTime - correctSync) > Math.abs(opponentVoicesError) && voice.playing) opponentVoicesError = currentRawVoiceTime - correctSync;
           });
         }
       }
 
       if (!startingSong
-        && (Math.abs(FlxG.sound.music.time - correctSync) > RESYNC_THRESHOLD
+        && (Math.abs(FlxG.sound.music.getActualTime() - correctSync) > RESYNC_THRESHOLD
           || Math.abs(playerVoicesError) > RESYNC_THRESHOLD
           || Math.abs(opponentVoicesError) > RESYNC_THRESHOLD))
       {
@@ -1912,7 +1850,7 @@ class PlayState extends MusicBeatSubState
           trace(playerVoicesError);
           trace(opponentVoicesError);
         }
-        trace(FlxG.sound.music.time);
+        trace(FlxG.sound.music.getActualTime());
         trace(correctSync);
         resyncVocals();
       }
@@ -2588,7 +2526,7 @@ class PlayState extends MusicBeatSubState
 
     if (!overrideMusic && !isGamePaused && currentChart != null)
     {
-      currentChart?.playInst(1.0, currentInstrumental, false);
+      currentChart?.buildInst(1.0, currentInstrumental, false);
     }
 
     if (FlxG.sound.music == null)
@@ -2601,8 +2539,6 @@ class PlayState extends MusicBeatSubState
       if (mayPauseGame) endSong(skipEndingTransition);
     };
 
-    FlxG.sound.music.pause();
-    FlxG.sound.music.time = startTimestamp;
     FlxG.sound.music.pitch = playbackRate;
 
     if (Preferences.subtitles)
@@ -2624,7 +2560,6 @@ class PlayState extends MusicBeatSubState
       trace('Playing vocals...');
       add(vocals);
 
-      vocals.time = startTimestamp - Conductor.instance.instrumentalOffset;
       vocals.pitch = playbackRate;
       vocals.playerVolume = playerVocalsVolume;
       vocals.opponentVolume = opponentVocalsVolume;
@@ -2633,10 +2568,10 @@ class PlayState extends MusicBeatSubState
       // trace('${FlxG.sound.music.time}');
       // trace('${vocals.time}');
 
-      vocals.play();
+      vocals.play(true, startTimestamp - Conductor.instance.instrumentalOffset);
     }
 
-    FlxG.sound.music.play();
+    FlxG.sound.music.play(true, startTimestamp);
 
     #if FEATURE_DISCORD_RPC
     // Updating Discord Rich Presence (with Time Left)
@@ -2662,32 +2597,22 @@ class PlayState extends MusicBeatSubState
     #if FEATURE_NEWGROUNDS
     Events.logStartSong(currentSong.id, currentVariation);
     #end
-
-    resyncVocals();
   }
 
   /**
      * Resynchronize the vocal tracks if they have become offset from the instrumental.
      */
-  function resyncVocals():Void
+  function resyncVocals(force = false):Void
   {
-    if (vocals == null) return;
-
-    // Skip this if the music is paused (GameOver, Pause menu, start-of-song offset, etc.)
-    if (!(FlxG.sound.music?.playing ?? false)) return;
-
-    var timeToPlayAt:Float = Math.min(FlxG.sound.music.length,
-      Math.max(Math.min(Conductor.instance.combinedOffset, 0), Conductor.instance.songPosition) - Conductor.instance.combinedOffset);
-    trace('Resyncing vocals to ${timeToPlayAt}');
-
-    FlxG.sound.music.pause();
-    vocals.pause();
-
-    FlxG.sound.music.time = timeToPlayAt;
-    FlxG.sound.music.play(false, timeToPlayAt);
+    if (FlxG.sound.music != null && force || (vocals != null && FlxG.sound.music.playing))
+    {
+      var timeToPlayAt:Float = Math.min(FlxG.sound.music.length,
+        Math.max(Math.min(Conductor.instance.combinedOffset, 0), Conductor.instance.songPosition) - Conductor.instance.combinedOffset);
+      trace('Resyncing vocals to ${timeToPlayAt}');
 
-    vocals.time = timeToPlayAt;
-    vocals.play(false, timeToPlayAt);
+      FlxG.sound.music.play(true, timeToPlayAt);
+      vocals?.play(true, timeToPlayAt);
+    }
   }
 
   /**
@@ -3407,8 +3332,9 @@ class PlayState extends MusicBeatSubState
      */
   public function endSong(rightGoddamnNow:Bool = false):Void
   {
-    if (FlxG.sound.music != null) FlxG.sound.music.volume = 0;
-    if (vocals != null) vocals.volume = 0;
+    FlxG.sound.music?.stop();
+    vocals?.stop();
+
     mayPauseGame = false;
     isSongEnd = true;
 
@@ -3843,7 +3769,6 @@ class PlayState extends MusicBeatSubState
       }
 
     persistentUpdate = false;
-    vocals?.stop();
     camHUD.alpha = 1;
 
     var talliesToUse:Tallies = PlayStatePlaylist.isStoryMode ? Highscore.talliesLevel : Highscore.tallies;
@@ -4087,7 +4012,7 @@ class PlayState extends MusicBeatSubState
 
     handleSkippedNotes();
     SongEventRegistry.handleSkippedEvents(songEvents, Conductor.instance.songPosition);
-    if (FlxG.sound.music != null && FlxG.sound.music.playing && preventDeath) regenNoteData(FlxG.sound.music.time);
+    if (FlxG.sound.music != null && FlxG.sound.music.playing && preventDeath) regenNoteData(FlxG.sound.music.getActualTime());
 
     Conductor.instance.update(FlxG.sound?.music?.time ?? 0.0);
 

source/funkin/play/song/Song.hx

@@ -803,13 +803,18 @@ class SongDifficulty
   }
 
   public function playInst(volume:Float = 1.0, instId:String = '', looped:Bool = false):Void
+  {
+    buildInst(volume, instId, looped).play(true, 0);
+  }
+
+  public function buildInst(volume:Float = 1.0, instId:String = '', looped:Bool = false):FunkinSound
   {
     var suffix:String = (instId != '') ? '-$instId' : '';
 
-    FlxG.sound.music = FunkinSound.load(Paths.inst(this.song.id, suffix), volume, looped, false, true, false, null, null, true);
+    var snd = FunkinSound.load(Paths.inst(this.song.id, suffix), volume, looped, false, false, false, null, null);
+    FunkinSound.setMusic(snd);
 
-    // Workaround for a bug where FlxG.sound.music.update() was being called twice.
-    FlxG.sound.list.remove(FlxG.sound.music);
+    return snd;
   }
 
   /**
@@ -962,21 +967,16 @@ class SongDifficulty
     for (playerVoice in playerVoiceList)
     {
       if (!Assets.exists(playerVoice)) continue;
-      result.addPlayerVoice(FunkinSound.load(playerVoice, 1.0, false, false, false, false, null, null, true));
+      result.addPlayerVoice(FunkinSound.load(playerVoice, 1.0, false, false, false, false, null, null));
     }
 
     // Add opponent vocals.
     for (opponentVoice in opponentVoiceList)
     {
       if (!Assets.exists(opponentVoice)) continue;
-      result.addOpponentVoice(FunkinSound.load(opponentVoice, 1.0, false, false, false, false, null, null, true));
+      result.addOpponentVoice(FunkinSound.load(opponentVoice, 1.0, false, false, false, false, null, null));
     }
 
-    // Sometimes the sounds don't set their important value to true, so we have to do this manually.
-    result.forEach(function(snd:FunkinSound) {
-      snd.important = true;
-    });
-
     result.playerVoicesOffset = offsets.getVocalOffset(characters.player, instId);
     result.opponentVoicesOffset = offsets.getVocalOffset(characters.opponent, instId);