From 1f78a4fadd36ebfd1145ea162d6b47826cec664c Mon Sep 17 00:00:00 2001
From: Jamie Taylor <me@nekodex.net>
Date: Fri, 17 Jun 2022 16:56:09 +0900
Subject: [PATCH] New audio feedback for metronome

---
 .../Screens/Edit/Timing/MetronomeDisplay.cs   | 39 +++++++++++++------
 1 file changed, 28 insertions(+), 11 deletions(-)

diff --git a/osu.Game/Screens/Edit/Timing/MetronomeDisplay.cs b/osu.Game/Screens/Edit/Timing/MetronomeDisplay.cs
index 2ecd66a05f..33325951e5 100644
--- a/osu.Game/Screens/Edit/Timing/MetronomeDisplay.cs
+++ b/osu.Game/Screens/Edit/Timing/MetronomeDisplay.cs
@@ -33,7 +33,9 @@ public class MetronomeDisplay : BeatSyncedContainer
 
         private IAdjustableClock metronomeClock;
 
-        private Sample clunk;
+        private Sample tick;
+        private Sample tickDownbeat;
+        private Sample latch;
 
         [Resolved]
         private OverlayColourProvider overlayColourProvider { get; set; }
@@ -43,7 +45,9 @@ public class MetronomeDisplay : BeatSyncedContainer
         [BackgroundDependencyLoader]
         private void load(AudioManager audio)
         {
-            clunk = audio.Samples.Get(@"Multiplayer/countdown-tick");
+            tick = audio.Samples.Get(@"UI/metronome-tick");
+            tickDownbeat = audio.Samples.Get(@"UI/metronome-tick-downbeat");
+            latch = audio.Samples.Get(@"UI/metronome-latch");
 
             const float taper = 25;
             const float swing_vertical_offset = -23;
@@ -248,14 +252,27 @@ protected override void Update()
             if (BeatSyncSource.Clock?.IsRunning != true && isSwinging)
             {
                 swing.ClearTransforms(true);
+                stick.FadeColour(overlayColourProvider.Colour2, 1000, Easing.OutQuint);
+                isSwinging = false;
+
+                // instantly latch if pendulum arm is close enough to center (to prevent awkward delayed playback of latch sound)
+                if (Precision.AlmostEquals(swing.Rotation, 0, 1))
+                {
+                    swing.RotateTo(0);
+                    latch?.Play();
+                    return;
+                }
 
                 using (swing.BeginDelayedSequence(350))
                 {
                     swing.RotateTo(0, 1000, Easing.OutQuint);
-                    stick.FadeColour(overlayColourProvider.Colour2, 1000, Easing.OutQuint);
+                    swing.Delay(250).Schedule(() =>
+                    {
+                        // prevent playing latch sound if metronome has started back up again
+                        if (!isSwinging)
+                            latch?.Play();
+                    });
                 }
-
-                isSwinging = false;
             }
         }
 
@@ -286,13 +303,13 @@ protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint,
                         if (!EnableClicking)
                             return;
 
-                        var channel = clunk?.GetChannel();
+                        var channel = beatIndex % timingPoint.TimeSignature.Numerator == 0 ? tickDownbeat?.GetChannel() : tick?.GetChannel();
 
-                        if (channel != null)
-                        {
-                            channel.Frequency.Value = RNG.NextDouble(0.98f, 1.02f);
-                            channel.Play();
-                        }
+                        if (channel == null)
+                            return;
+
+                        channel.Frequency.Value = RNG.NextDouble(0.98f, 1.02f);
+                        channel.Play();
                     });
                 }
             }