From ea50936d718bd21a78fea574811cc7b560a651f9 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 16 Aug 2022 15:26:29 +0900
Subject: [PATCH] Fix slider ticks playing back at infinite rate while making
 changes to a slider in the editor

---
 osu.Game/Screens/Edit/Editor.cs        | 19 ++++++-------------
 osu.Game/Screens/Edit/EditorBeatmap.cs | 25 +++++++++++++++++++++++++
 2 files changed, 31 insertions(+), 13 deletions(-)

diff --git a/osu.Game/Screens/Edit/Editor.cs b/osu.Game/Screens/Edit/Editor.cs
index 89f9aec5ee..90e912bd6d 100644
--- a/osu.Game/Screens/Edit/Editor.cs
+++ b/osu.Game/Screens/Edit/Editor.cs
@@ -225,8 +225,6 @@ namespace osu.Game.Screens.Edit
             dependencies.CacheAs(clock);
             AddInternal(clock);
 
-            clock.SeekingOrStopped.BindValueChanged(_ => updateSampleDisabledState());
-
             // todo: remove caching of this and consume via editorBeatmap?
             dependencies.Cache(beatDivisor);
 
@@ -428,7 +426,12 @@ namespace osu.Game.Screens.Edit
         protected override void Update()
         {
             base.Update();
+
             clock.ProcessFrame();
+
+            samplePlaybackDisabled.Value = clock.SeekingOrStopped.Value
+                                           || currentScreen is not ComposeScreen
+                                           || editorBeatmap.UpdateInProgress;
         }
 
         public bool OnPressed(KeyBindingPressEvent<PlatformAction> e)
@@ -822,16 +825,10 @@ namespace osu.Game.Screens.Edit
             }
             finally
             {
-                updateSampleDisabledState();
                 rebindClipboardBindables();
             }
         }
 
-        private void updateSampleDisabledState()
-        {
-            samplePlaybackDisabled.Value = clock.SeekingOrStopped.Value || !(currentScreen is ComposeScreen);
-        }
-
         private void seek(UIEvent e, int direction)
         {
             double amount = e.ShiftPressed ? 4 : 1;
@@ -936,11 +933,7 @@ namespace osu.Game.Screens.Edit
 
         protected void SwitchToDifficulty(BeatmapInfo nextBeatmap) => loader?.ScheduleSwitchToExistingDifficulty(nextBeatmap, GetState(nextBeatmap.Ruleset));
 
-        private void cancelExit()
-        {
-            updateSampleDisabledState();
-            loader?.CancelPendingDifficultySwitch();
-        }
+        private void cancelExit() => loader?.CancelPendingDifficultySwitch();
 
         public double SnapTime(double time, double? referenceTime) => editorBeatmap.SnapTime(time, referenceTime);
 
diff --git a/osu.Game/Screens/Edit/EditorBeatmap.cs b/osu.Game/Screens/Edit/EditorBeatmap.cs
index 96425e8bc8..b9b0879fa4 100644
--- a/osu.Game/Screens/Edit/EditorBeatmap.cs
+++ b/osu.Game/Screens/Edit/EditorBeatmap.cs
@@ -10,6 +10,7 @@ using System.Linq;
 using JetBrains.Annotations;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
+using osu.Framework.Threading;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.Beatmaps.Legacy;
@@ -22,6 +23,15 @@ namespace osu.Game.Screens.Edit
 {
     public class EditorBeatmap : TransactionalCommitComponent, IBeatmap, IBeatSnapProvider
     {
+        /// <summary>
+        /// While performing updates on hitobjects, this will momentarily become true.
+        /// </summary>
+        /// <remarks>
+        /// This is intended to be used to avoid performing operations (like playback of samples)
+        /// while mutating hitobjects.
+        /// </remarks>
+        public bool UpdateInProgress { get; private set; }
+
         /// <summary>
         /// Invoked when a <see cref="HitObject"/> is added to this <see cref="EditorBeatmap"/>.
         /// </summary>
@@ -225,8 +235,12 @@ namespace osu.Game.Screens.Edit
         {
             // updates are debounced regardless of whether a batch is active.
             batchPendingUpdates.Add(hitObject);
+
+            advertiseUpdateInProgress();
         }
 
+        private ScheduledDelegate updateCompleteDelegate;
+
         /// <summary>
         /// Update all hit objects with potentially changed difficulty or control point data.
         /// </summary>
@@ -234,6 +248,8 @@ namespace osu.Game.Screens.Edit
         {
             foreach (var h in HitObjects)
                 batchPendingUpdates.Add(h);
+
+            advertiseUpdateInProgress();
         }
 
         /// <summary>
@@ -333,6 +349,15 @@ namespace osu.Game.Screens.Edit
         /// </summary>
         public void Clear() => RemoveRange(HitObjects.ToArray());
 
+        private void advertiseUpdateInProgress()
+        {
+            UpdateInProgress = true;
+
+            // Debounce is arbitrarily high enough to avoid flip-flopping the value each other frame.
+            updateCompleteDelegate?.Cancel();
+            updateCompleteDelegate = Scheduler.AddDelayed(() => UpdateInProgress = false, 50);
+        }
+
         private void processHitObject(HitObject hitObject) => hitObject.ApplyDefaults(ControlPointInfo, PlayableBeatmap.Difficulty);
 
         private void trackStartTime(HitObject hitObject)