Merge pull request #12352 from smoogipoo/multiplayer-spectator-leaderboard

Implement the multiplayer spectator leaderboard

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerGameplayLeaderboard.cs

@@ -11,6 +11,7 @@ using osu.Framework.Graphics;
 using osu.Framework.Graphics.Containers;
 using osu.Framework.Testing;
 using osu.Framework.Utils;
+using osu.Game.Configuration;
 using osu.Game.Database;
 using osu.Game.Online;
 using osu.Game.Online.API;
@@ -38,6 +39,8 @@ namespace osu.Game.Tests.Visual.Multiplayer
 
         protected override Container<Drawable> Content { get; } = new Container { RelativeSizeAxes = Axes.Both };
 
+        private OsuConfigManager config;
+
         public TestSceneMultiplayerGameplayLeaderboard()
         {
             base.Content.Children = new Drawable[]
@@ -48,6 +51,12 @@ namespace osu.Game.Tests.Visual.Multiplayer
             };
         }
 
+        [BackgroundDependencyLoader]
+        private void load()
+        {
+            Dependencies.Cache(config = new OsuConfigManager(LocalStorage));
+        }
+
         [SetUpSteps]
         public override void SetUpSteps()
         {
@@ -97,6 +106,14 @@ namespace osu.Game.Tests.Visual.Multiplayer
             AddRepeatStep("mark user quit", () => Client.CurrentMatchPlayingUserIds.RemoveAt(0), users);
         }
 
+        [Test]
+        public void TestChangeScoringMode()
+        {
+            AddRepeatStep("update state", () => streamingClient.RandomlyUpdateState(), 5);
+            AddStep("change to classic", () => config.SetValue(OsuSetting.ScoreDisplayMode, ScoringMode.Classic));
+            AddStep("change to standardised", () => config.SetValue(OsuSetting.ScoreDisplayMode, ScoringMode.Standardised));
+        }
+
         public class TestMultiplayerStreaming : SpectatorStreamingClient
         {
             public new BindableList<int> PlayingUsers => (BindableList<int>)base.PlayingUsers;
@@ -163,7 +180,7 @@ namespace osu.Game.Tests.Visual.Multiplayer
                             break;
                     }
 
-                    ((ISpectatorClient)this).UserSentFrames(userId, new FrameDataBundle(header, Array.Empty<LegacyReplayFrame>()));
+                    ((ISpectatorClient)this).UserSentFrames(userId, new FrameDataBundle(header, new[] { new LegacyReplayFrame(Time.Current, 0, 0, ReplayButtonState.None) }));
                 }
             }
         }

osu.Game.Tests/Visual/Multiplayer/TestSceneMultiplayerSpectatorLeaderboard.cs

@@ -0,0 +1,229 @@
+// 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 System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Testing;
+using osu.Framework.Timing;
+using osu.Framework.Utils;
+using osu.Game.Database;
+using osu.Game.Online;
+using osu.Game.Online.Spectator;
+using osu.Game.Replays.Legacy;
+using osu.Game.Rulesets.Osu.Scoring;
+using osu.Game.Scoring;
+using osu.Game.Screens.OnlinePlay.Multiplayer.Spectate;
+using osu.Game.Screens.Play.HUD;
+using osu.Game.Users;
+
+namespace osu.Game.Tests.Visual.Multiplayer
+{
+    public class TestSceneMultiplayerSpectatorLeaderboard : MultiplayerTestScene
+    {
+        [Cached(typeof(SpectatorStreamingClient))]
+        private TestSpectatorStreamingClient streamingClient = new TestSpectatorStreamingClient();
+
+        [Cached(typeof(UserLookupCache))]
+        private UserLookupCache lookupCache = new TestUserLookupCache();
+
+        protected override Container<Drawable> Content => content;
+        private readonly Container content;
+
+        private readonly Dictionary<int, ManualClock> clocks = new Dictionary<int, ManualClock>
+        {
+            { 55, new ManualClock() },
+            { 56, new ManualClock() }
+        };
+
+        public TestSceneMultiplayerSpectatorLeaderboard()
+        {
+            base.Content.AddRange(new Drawable[]
+            {
+                streamingClient,
+                lookupCache,
+                content = new Container { RelativeSizeAxes = Axes.Both }
+            });
+        }
+
+        [SetUpSteps]
+        public new void SetUpSteps()
+        {
+            MultiplayerSpectatorLeaderboard leaderboard = null;
+
+            AddStep("reset", () =>
+            {
+                Clear();
+
+                foreach (var (userId, clock) in clocks)
+                {
+                    streamingClient.EndPlay(userId, 0);
+                    clock.CurrentTime = 0;
+                }
+            });
+
+            AddStep("create leaderboard", () =>
+            {
+                foreach (var (userId, _) in clocks)
+                    streamingClient.StartPlay(userId, 0);
+
+                Beatmap.Value = CreateWorkingBeatmap(Ruleset.Value);
+
+                var playable = Beatmap.Value.GetPlayableBeatmap(Ruleset.Value);
+                var scoreProcessor = new OsuScoreProcessor();
+                scoreProcessor.ApplyBeatmap(playable);
+
+                LoadComponentAsync(leaderboard = new MultiplayerSpectatorLeaderboard(scoreProcessor, clocks.Keys.ToArray()) { Expanded = { Value = true } }, Add);
+            });
+
+            AddUntilStep("wait for load", () => leaderboard.IsLoaded);
+
+            AddStep("add clock sources", () =>
+            {
+                foreach (var (userId, clock) in clocks)
+                    leaderboard.AddClock(userId, clock);
+            });
+        }
+
+        [Test]
+        public void TestLeaderboardTracksCurrentTime()
+        {
+            AddStep("send frames", () =>
+            {
+                // For user 55, send frames in sets of 1.
+                // For user 56, send frames in sets of 10.
+                for (int i = 0; i < 100; i++)
+                {
+                    streamingClient.SendFrames(55, i, 1);
+
+                    if (i % 10 == 0)
+                        streamingClient.SendFrames(56, i, 10);
+                }
+            });
+
+            assertCombo(55, 1);
+            assertCombo(56, 10);
+
+            // Advance to a point where only user 55's frame changes.
+            setTime(500);
+            assertCombo(55, 5);
+            assertCombo(56, 10);
+
+            // Advance to a point where both user's frame changes.
+            setTime(1100);
+            assertCombo(55, 11);
+            assertCombo(56, 20);
+
+            // Advance user 56 only to a point where its frame changes.
+            setTime(56, 2100);
+            assertCombo(55, 11);
+            assertCombo(56, 30);
+
+            // Advance both users beyond their last frame
+            setTime(101 * 100);
+            assertCombo(55, 100);
+            assertCombo(56, 100);
+        }
+
+        [Test]
+        public void TestNoFrames()
+        {
+            assertCombo(55, 0);
+            assertCombo(56, 0);
+        }
+
+        private void setTime(double time) => AddStep($"set time {time}", () =>
+        {
+            foreach (var (_, clock) in clocks)
+                clock.CurrentTime = time;
+        });
+
+        private void setTime(int userId, double time)
+            => AddStep($"set user {userId} time {time}", () => clocks[userId].CurrentTime = time);
+
+        private void assertCombo(int userId, int expectedCombo)
+            => AddUntilStep($"player {userId} has {expectedCombo} combo", () => this.ChildrenOfType<GameplayLeaderboardScore>().Single(s => s.User?.Id == userId).Combo.Value == expectedCombo);
+
+        private class TestSpectatorStreamingClient : SpectatorStreamingClient
+        {
+            private readonly Dictionary<int, int> userBeatmapDictionary = new Dictionary<int, int>();
+            private readonly Dictionary<int, bool> userSentStateDictionary = new Dictionary<int, bool>();
+
+            public TestSpectatorStreamingClient()
+                : base(new DevelopmentEndpointConfiguration())
+            {
+            }
+
+            public void StartPlay(int userId, int beatmapId)
+            {
+                userBeatmapDictionary[userId] = beatmapId;
+                userSentStateDictionary[userId] = false;
+                sendState(userId, beatmapId);
+            }
+
+            public void EndPlay(int userId, int beatmapId)
+            {
+                ((ISpectatorClient)this).UserFinishedPlaying(userId, new SpectatorState
+                {
+                    BeatmapID = beatmapId,
+                    RulesetID = 0,
+                });
+                userSentStateDictionary[userId] = false;
+            }
+
+            public void SendFrames(int userId, int index, int count)
+            {
+                var frames = new List<LegacyReplayFrame>();
+
+                for (int i = index; i < index + count; i++)
+                {
+                    var buttonState = i == index + count - 1 ? ReplayButtonState.None : ReplayButtonState.Left1;
+                    frames.Add(new LegacyReplayFrame(i * 100, RNG.Next(0, 512), RNG.Next(0, 512), buttonState));
+                }
+
+                var bundle = new FrameDataBundle(new ScoreInfo { Combo = index + count }, frames);
+                ((ISpectatorClient)this).UserSentFrames(userId, bundle);
+                if (!userSentStateDictionary[userId])
+                    sendState(userId, userBeatmapDictionary[userId]);
+            }
+
+            public override void WatchUser(int userId)
+            {
+                if (userSentStateDictionary[userId])
+                {
+                    // usually the server would do this.
+                    sendState(userId, userBeatmapDictionary[userId]);
+                }
+
+                base.WatchUser(userId);
+            }
+
+            private void sendState(int userId, int beatmapId)
+            {
+                ((ISpectatorClient)this).UserBeganPlaying(userId, new SpectatorState
+                {
+                    BeatmapID = beatmapId,
+                    RulesetID = 0,
+                });
+                userSentStateDictionary[userId] = true;
+            }
+        }
+
+        private class TestUserLookupCache : UserLookupCache
+        {
+            protected override Task<User> ComputeValueAsync(int lookup, CancellationToken token = default)
+            {
+                return Task.FromResult(new User
+                {
+                    Id = lookup,
+                    Username = $"User {lookup}"
+                });
+            }
+        }
+    }
+}

osu.Game/Screens/OnlinePlay/Multiplayer/Spectate/MultiplayerSpectatorLeaderboard.cs

@@ -0,0 +1,72 @@
+// 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 System;
+using JetBrains.Annotations;
+using osu.Framework.Timing;
+using osu.Game.Rulesets.Scoring;
+using osu.Game.Screens.Play.HUD;
+
+namespace osu.Game.Screens.OnlinePlay.Multiplayer.Spectate
+{
+    public class MultiplayerSpectatorLeaderboard : MultiplayerGameplayLeaderboard
+    {
+        public MultiplayerSpectatorLeaderboard(ScoreProcessor scoreProcessor, int[] userIds)
+            : base(scoreProcessor, userIds)
+        {
+        }
+
+        public void AddClock(int userId, IClock clock)
+        {
+            if (!UserScores.TryGetValue(userId, out var data))
+                return;
+
+            ((SpectatingTrackedUserData)data).Clock = clock;
+        }
+
+        public void RemoveClock(int userId)
+        {
+            if (!UserScores.TryGetValue(userId, out var data))
+                return;
+
+            ((SpectatingTrackedUserData)data).Clock = null;
+        }
+
+        protected override TrackedUserData CreateUserData(int userId, ScoreProcessor scoreProcessor) => new SpectatingTrackedUserData(userId, scoreProcessor);
+
+        protected override void Update()
+        {
+            base.Update();
+
+            foreach (var (_, data) in UserScores)
+                data.UpdateScore();
+        }
+
+        private class SpectatingTrackedUserData : TrackedUserData
+        {
+            [CanBeNull]
+            public IClock Clock;
+
+            public SpectatingTrackedUserData(int userId, ScoreProcessor scoreProcessor)
+                : base(userId, scoreProcessor)
+            {
+            }
+
+            public override void UpdateScore()
+            {
+                if (Frames.Count == 0)
+                    return;
+
+                if (Clock == null)
+                    return;
+
+                int frameIndex = Frames.BinarySearch(new TimedFrame(Clock.CurrentTime));
+                if (frameIndex < 0)
+                    frameIndex = ~frameIndex;
+                frameIndex = Math.Clamp(frameIndex - 1, 0, Frames.Count - 1);
+
+                SetFrame(Frames[frameIndex]);
+            }
+        }
+    }
+}

osu.Game/Screens/Play/HUD/MultiplayerGameplayLeaderboard.cs

@@ -1,10 +1,10 @@
 // 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 System;
 using System.Collections.Generic;
 using System.Collections.Specialized;
 using System.Linq;
-using JetBrains.Annotations;
 using osu.Framework.Allocation;
 using osu.Framework.Bindables;
 using osu.Game.Configuration;
@@ -19,9 +19,7 @@ namespace osu.Game.Screens.Play.HUD
     [LongRunningLoad]
     public class MultiplayerGameplayLeaderboard : GameplayLeaderboard
     {
-        private readonly ScoreProcessor scoreProcessor;
+        protected readonly Dictionary<int, TrackedUserData> UserScores = new Dictionary<int, TrackedUserData>();
-
-        private readonly Dictionary<int, TrackedUserData> userScores = new Dictionary<int, TrackedUserData>();
 
         [Resolved]
         private SpectatorStreamingClient streamingClient { get; set; }
@@ -32,9 +30,9 @@ namespace osu.Game.Screens.Play.HUD
         [Resolved]
         private UserLookupCache userLookupCache { get; set; }
 
-        private Bindable<ScoringMode> scoringMode;
+        private readonly ScoreProcessor scoreProcessor;
-
         private readonly BindableList<int> playingUsers;
+        private Bindable<ScoringMode> scoringMode;
 
         /// <summary>
         /// Construct a new leaderboard.
@@ -53,6 +51,8 @@ namespace osu.Game.Screens.Play.HUD
         [BackgroundDependencyLoader]
         private void load(OsuConfigManager config, IAPIProvider api)
         {
+            scoringMode = config.GetBindable<ScoringMode>(OsuSetting.ScoreDisplayMode);
+
             foreach (var userId in playingUsers)
             {
                 streamingClient.WatchUser(userId);
@@ -60,19 +60,17 @@ namespace osu.Game.Screens.Play.HUD
                 // probably won't be required in the final implementation.
                 var resolvedUser = userLookupCache.GetUserAsync(userId).Result;
 
-                var trackedUser = new TrackedUserData();
+                var trackedUser = CreateUserData(userId, scoreProcessor);
+                trackedUser.ScoringMode.BindTo(scoringMode);
 
-                userScores[userId] = trackedUser;
                 var leaderboardScore = AddPlayer(resolvedUser, resolvedUser?.Id == api.LocalUser.Value.Id);
+                leaderboardScore.Accuracy.BindTo(trackedUser.Accuracy);
+                leaderboardScore.TotalScore.BindTo(trackedUser.Score);
+                leaderboardScore.Combo.BindTo(trackedUser.CurrentCombo);
+                leaderboardScore.HasQuit.BindTo(trackedUser.UserQuit);
 
-                ((IBindable<double>)leaderboardScore.Accuracy).BindTo(trackedUser.Accuracy);
+                UserScores[userId] = trackedUser;
-                ((IBindable<double>)leaderboardScore.TotalScore).BindTo(trackedUser.Score);
-                ((IBindable<int>)leaderboardScore.Combo).BindTo(trackedUser.CurrentCombo);
-                ((IBindable<bool>)leaderboardScore.HasQuit).BindTo(trackedUser.UserQuit);
             }
-
-            scoringMode = config.GetBindable<ScoringMode>(OsuSetting.ScoreDisplayMode);
-            scoringMode.BindValueChanged(updateAllScores, true);
         }
 
         protected override void LoadComplete()
@@ -102,7 +100,7 @@ namespace osu.Game.Screens.Play.HUD
                     {
                         streamingClient.StopWatchingUser(userId);
 
-                        if (userScores.TryGetValue(userId, out var trackedData))
+                        if (UserScores.TryGetValue(userId, out var trackedData))
                             trackedData.MarkUserQuit();
                     }
 
@@ -110,20 +108,16 @@ namespace osu.Game.Screens.Play.HUD
             }
         }
 
-        private void updateAllScores(ValueChangedEvent<ScoringMode> mode)
+        private void handleIncomingFrames(int userId, FrameDataBundle bundle) => Schedule(() =>
         {
-            foreach (var trackedData in userScores.Values)
+            if (!UserScores.TryGetValue(userId, out var trackedData))
-                trackedData.UpdateScore(scoreProcessor, mode.NewValue);
+                return;
-        }
 
-        private void handleIncomingFrames(int userId, FrameDataBundle bundle)
+            trackedData.Frames.Add(new TimedFrame(bundle.Frames.First().Time, bundle.Header));
-        {
+            trackedData.UpdateScore();
-            if (userScores.TryGetValue(userId, out var trackedData))
+        });
-            {
+
-                trackedData.LastHeader = bundle.Header;
+        protected virtual TrackedUserData CreateUserData(int userId, ScoreProcessor scoreProcessor) => new TrackedUserData(userId, scoreProcessor);
-                trackedData.UpdateScore(scoreProcessor, scoringMode.Value);
-            }
-        }
 
         protected override void Dispose(bool isDisposing)
         {
@@ -140,38 +134,65 @@ namespace osu.Game.Screens.Play.HUD
             }
         }
 
-        private class TrackedUserData
+        protected class TrackedUserData
         {
-            public IBindableNumber<double> Score => score;
+            public readonly int UserId;
+            public readonly ScoreProcessor ScoreProcessor;
 
-            private readonly BindableDouble score = new BindableDouble();
+            public readonly BindableDouble Score = new BindableDouble();
+            public readonly BindableDouble Accuracy = new BindableDouble(1);
+            public readonly BindableInt CurrentCombo = new BindableInt();
+            public readonly BindableBool UserQuit = new BindableBool();
 
-            public IBindableNumber<double> Accuracy => accuracy;
+            public readonly IBindable<ScoringMode> ScoringMode = new Bindable<ScoringMode>();
 
-            private readonly BindableDouble accuracy = new BindableDouble(1);
+            public readonly List<TimedFrame> Frames = new List<TimedFrame>();
 
-            public IBindableNumber<int> CurrentCombo => currentCombo;
+            public TrackedUserData(int userId, ScoreProcessor scoreProcessor)
-
-            private readonly BindableInt currentCombo = new BindableInt();
-
-            public IBindable<bool> UserQuit => userQuit;
-
-            private readonly BindableBool userQuit = new BindableBool();
-
-            [CanBeNull]
-            public FrameHeader LastHeader;
-
-            public void MarkUserQuit() => userQuit.Value = true;
-
-            public void UpdateScore(ScoreProcessor processor, ScoringMode mode)
             {
-                if (LastHeader == null)
+                UserId = userId;
+                ScoreProcessor = scoreProcessor;
+
+                ScoringMode.BindValueChanged(_ => UpdateScore());
+            }
+
+            public void MarkUserQuit() => UserQuit.Value = true;
+
+            public virtual void UpdateScore()
+            {
+                if (Frames.Count == 0)
                     return;
 
-                score.Value = processor.GetImmediateScore(mode, LastHeader.MaxCombo, LastHeader.Statistics);
+                SetFrame(Frames.Last());
-                accuracy.Value = LastHeader.Accuracy;
-                currentCombo.Value = LastHeader.Combo;
             }
+
+            protected void SetFrame(TimedFrame frame)
+            {
+                var header = frame.Header;
+
+                Score.Value = ScoreProcessor.GetImmediateScore(ScoringMode.Value, header.MaxCombo, header.Statistics);
+                Accuracy.Value = header.Accuracy;
+                CurrentCombo.Value = header.Combo;
+            }
+        }
+
+        protected class TimedFrame : IComparable<TimedFrame>
+        {
+            public readonly double Time;
+            public readonly FrameHeader Header;
+
+            public TimedFrame(double time)
+            {
+                Time = time;
+            }
+
+            public TimedFrame(double time, FrameHeader header)
+            {
+                Time = time;
+                Header = header;
+            }
+
+            public int CompareTo(TimedFrame other) => Time.CompareTo(other.Time);
         }
     }
 }