From 8f52a83b297d277bf07bbda9e9e2efd2d0684092 Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Thu, 7 Jan 2021 18:47:20 +0900
Subject: [PATCH] Share hover sound debounce across all instances via
 SessionStatics

---
 osu.Game/Configuration/SessionStatics.cs      |  9 ++++++
 .../Graphics/UserInterface/HoverSounds.cs     | 29 +++++++++++--------
 2 files changed, 26 insertions(+), 12 deletions(-)

diff --git a/osu.Game/Configuration/SessionStatics.cs b/osu.Game/Configuration/SessionStatics.cs
index 03bc434aac..f28ee707b9 100644
--- a/osu.Game/Configuration/SessionStatics.cs
+++ b/osu.Game/Configuration/SessionStatics.cs
@@ -1,7 +1,9 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using osu.Game.Graphics.UserInterface;
 using osu.Game.Online.API.Requests.Responses;
+using osu.Game.Overlays;
 
 namespace osu.Game.Configuration
 {
@@ -14,6 +16,7 @@ namespace osu.Game.Configuration
         {
             Set(Static.LoginOverlayDisplayed, false);
             Set(Static.MutedAudioNotificationShownOnce, false);
+            Set(Static.LastHoverSoundPlaybackTime, 0.0);
             Set<APISeasonalBackgrounds>(Static.SeasonalBackgrounds, null);
         }
     }
@@ -28,5 +31,11 @@ namespace osu.Game.Configuration
         /// Value under this lookup can be <c>null</c> if there are no backgrounds available (or API is not reachable).
         /// </summary>
         SeasonalBackgrounds,
+
+        /// <summary>
+        /// The last playback time in milliseconds of a hover sample (from <see cref="HoverSounds"/>).
+        /// Used to debounce hover sounds game-wide to avoid volume saturation, especially in scrolling views with many UI controls like <see cref="SettingsOverlay"/>.
+        /// </summary>
+        LastHoverSoundPlaybackTime
     }
 }
diff --git a/osu.Game/Graphics/UserInterface/HoverSounds.cs b/osu.Game/Graphics/UserInterface/HoverSounds.cs
index 22d59e70f7..efd55c892c 100644
--- a/osu.Game/Graphics/UserInterface/HoverSounds.cs
+++ b/osu.Game/Graphics/UserInterface/HoverSounds.cs
@@ -5,11 +5,12 @@ using System.ComponentModel;
 using osu.Framework.Allocation;
 using osu.Framework.Audio;
 using osu.Framework.Audio.Sample;
+using osu.Framework.Bindables;
 using osu.Framework.Extensions;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Input.Events;
-using osu.Framework.Threading;
+using osu.Game.Configuration;
 
 namespace osu.Game.Graphics.UserInterface
 {
@@ -28,31 +29,35 @@ namespace osu.Game.Graphics.UserInterface
 
         protected readonly HoverSampleSet SampleSet;
 
+        private Bindable<double> lastPlaybackTime;
+
         public HoverSounds(HoverSampleSet sampleSet = HoverSampleSet.Normal)
         {
             SampleSet = sampleSet;
             RelativeSizeAxes = Axes.Both;
         }
 
-        private ScheduledDelegate playDelegate;
+        [BackgroundDependencyLoader]
+        private void load(AudioManager audio, SessionStatics statics)
+        {
+            lastPlaybackTime = statics.GetBindable<double>(Static.LastHoverSoundPlaybackTime);
+
+            sampleHover = audio.Samples.Get($@"UI/generic-hover{SampleSet.GetDescription()}");
+        }
 
         protected override bool OnHover(HoverEvent e)
         {
-            playDelegate?.Cancel();
+            bool requiresDebounce = HoverDebounceTime <= 0;
+            bool enoughTimePassedSinceLastPlayback = lastPlaybackTime.Value == 0 || Time.Current - lastPlaybackTime.Value > HoverDebounceTime;
 
-            if (HoverDebounceTime <= 0)
+            if (!requiresDebounce || enoughTimePassedSinceLastPlayback)
+            {
                 sampleHover?.Play();
-            else
-                playDelegate = Scheduler.AddDelayed(() => sampleHover?.Play(), HoverDebounceTime);
+                lastPlaybackTime.Value = Time.Current;
+            }
 
             return base.OnHover(e);
         }
-
-        [BackgroundDependencyLoader]
-        private void load(AudioManager audio)
-        {
-            sampleHover = audio.Samples.Get($@"UI/generic-hover{SampleSet.GetDescription()}");
-        }
     }
 
     public enum HoverSampleSet