UI: RPC: Value Formatter V3

- Allows the ability to bind a single PlayReportGameSpec to multiple title IDs, like for MK8D
- Allows the ability for the value formatters to tell the caller of the analyzer that they should reset the value, and also added the ability to explicitly not handle a value format.

src/Ryujinx.Common/Helpers/PlayReportAnalyzer.cs

@@ -1,80 +0,0 @@
-using Gommon;
-using MsgPack;
-using System;
-using System.Collections.Generic;
-using System.Linq;
-
-namespace Ryujinx.Common.Helper
-{
-    public class PlayReportAnalyzer
-    {
-        private readonly List<PlayReportGameSpec> _specs = [];
-
-        public PlayReportAnalyzer AddSpec(string titleId, Func<PlayReportGameSpec, PlayReportGameSpec> transform)
-        {
-            _specs.Add(transform(new PlayReportGameSpec { TitleIdStr = titleId }));
-            return this;
-        }
-        
-        public PlayReportAnalyzer AddSpec(string titleId, Action<PlayReportGameSpec> transform)
-        {
-            _specs.Add(new PlayReportGameSpec { TitleIdStr = titleId }.Apply(transform));
-            return this;
-        }
-
-        public Optional<string> Run(string runningGameId, MessagePackObject playReport)
-        {
-            if (!playReport.IsDictionary) 
-                return Optional<string>.None;
-
-            if (!_specs.TryGetFirst(s => s.TitleIdStr.EqualsIgnoreCase(runningGameId), out PlayReportGameSpec spec))
-                return Optional<string>.None;
-
-            foreach (PlayReportValueFormatterSpec formatSpec in spec.Analyses.OrderBy(x => x.Priority))
-            {
-                if (!playReport.AsDictionary().TryGetValue(formatSpec.ReportKey, out MessagePackObject valuePackObject))
-                    continue;
-
-                return formatSpec.ValueFormatter(valuePackObject.ToObject());
-            }
-            
-            return Optional<string>.None;
-        }
-        
-    }
-
-    public class PlayReportGameSpec
-    {
-        public required string TitleIdStr { get; init; }
-        public List<PlayReportValueFormatterSpec> Analyses { get; } = [];
-
-        public PlayReportGameSpec AddValueFormatter(string reportKey, Func<object, string> valueFormatter)
-        {
-            Analyses.Add(new PlayReportValueFormatterSpec
-            {
-                Priority = Analyses.Count,
-                ReportKey = reportKey, 
-                ValueFormatter = valueFormatter
-            });
-            return this;
-        }
-        
-        public PlayReportGameSpec AddValueFormatter(int priority, string reportKey, Func<object, string> valueFormatter)
-        {
-            Analyses.Add(new PlayReportValueFormatterSpec
-            {
-                Priority = priority,
-                ReportKey = reportKey, 
-                ValueFormatter = valueFormatter
-            });
-            return this;
-        }
-    }
-
-    public struct PlayReportValueFormatterSpec
-    {
-        public required int Priority { get; init; }
-        public required string ReportKey { get; init; }
-        public required Func<object, string> ValueFormatter { get; init; }
-    }
-}

src/Ryujinx/DiscordIntegrationModule.cs

@@ -39,6 +39,7 @@ namespace Ryujinx.Ava
         private static DiscordRpcClient _discordClient;
         private static RichPresence _discordPresenceMain;
         private static RichPresence _discordPresencePlaying;
+        private static ApplicationMetadata _currentApp;
 
         public static void Initialize()
         {
@@ -82,36 +83,6 @@ namespace Ryujinx.Ava
             }
         }
 
-        public static string MarioKart8(object obj)
-        {
-            return obj switch
-            {
-                // Single Player
-                "Single" => "Single Player",
-                // Multiplayer
-                "Multi-2players" => "Multiplayer 2 Players",
-                "Multi-3players" => "Multiplayer 3 Players",
-                "Multi-4players" => "Multiplayer 4 Players",
-                // Wireless/LAN Play
-                "Local-Single" => "Wireless/LAN Play",
-                "Local-2players" => "Wireless/LAN Play 2 Players",
-                // CC Classes
-                "50cc" => "50cc",
-                "100cc" => "100cc",
-                "150cc" => "150cc",
-                "Mirror" => "Mirror (150cc)",
-                "200cc" => "200cc",
-                // Modes
-                "GrandPrix" => "Grand Prix",
-                "TimeAttack" => "Time Trials",
-                "VS" => "VS Races",
-                "Battle" => "Battle Mode",
-                "RaceStart" => "Selecting a Course",
-                "Race" => "Racing",
-                _ => "Playing Mario Kart 8 Deluxe"
-            };
-        }
-
         public static void Use(Optional<string> titleId)
         {
             if (titleId.TryGet(out string tid))
@@ -143,6 +114,7 @@ namespace Ryujinx.Ava
         private static void SwitchToPlayingState(ApplicationMetadata appMeta, ProcessResult procRes)
         {
             _discordClient?.SetPresence(_discordPresencePlaying ??= CreatePlayingState(appMeta, procRes));
+            _currentApp = appMeta;
         }
 
         private static void UpdatePlayingState()
@@ -154,52 +126,29 @@ namespace Ryujinx.Ava
         {
             _discordClient?.SetPresence(_discordPresenceMain);
             _discordPresencePlaying = null;
+            _currentApp = null;
         }
-        
-        private static readonly PlayReportAnalyzer _playReportAnalyzer = new PlayReportAnalyzer()
-            .AddSpec( // Breath of the Wild
-                "01007ef00011e000",
-                gameSpec =>
-                    gameSpec.AddValueFormatter("IsHardMode", val => val is 1 ? "Playing Master Mode" : "Playing Normal Mode")
-            )
-            .AddSpec( // Super Mario Odyssey
-                "0100000000010000",
-                gameSpec =>
-                    gameSpec.AddValueFormatter("is_kids_mode", val => val is 1 ? "Playing in Assist Mode" : "Playing in Regular Mode")
-            )
-            .AddSpec( // Super Mario Odyssey (China)
-                "010075000ECBE000",
-                gameSpec =>
-                    gameSpec.AddValueFormatter("is_kids_mode", val => val is 1 ? "Playing in 帮助模式" : "Playing in 普通模式")
-            )
-            .AddSpec( // Super Mario 3D World + Bowser's Fury
-                "010028600EBDA000",
-                gameSpec =>
-                    gameSpec.AddValueFormatter("mode", val => val is 0 ? "Playing Super Mario 3D World" : "Playing Bowser's Fury")
-            )
-            .AddSpec( // Mario Kart 8 Deluxe
-                "0100152000022000",
-                gameSpec =>
-                    gameSpec.AddValueFormatter("To", MarioKart8)
-            )
-            .AddSpec( // Mario Kart 8 Deluxe (China)
-                "010075100E8EC000",
-                gameSpec =>
-                    gameSpec.AddValueFormatter("To", MarioKart8)
-            );
 
         private static void HandlePlayReport(MessagePackObject playReport)
         {
             if (!TitleIDs.CurrentApplication.Value.HasValue) return;
             if (_discordPresencePlaying is null) return;
 
-            Optional<string> details = _playReportAnalyzer.Run(TitleIDs.CurrentApplication.Value, playReport);
+            PlayReportFormattedValue value = PlayReport.Analyzer.Run(TitleIDs.CurrentApplication.Value, _currentApp, playReport);
 
-            if (!details.HasValue) return;
-            
-            _discordPresencePlaying.Details = details;
+            if (!value.Handled) return;
+
+            if (value.Reset)
+            {
+                _discordPresencePlaying.Details = $"Playing {_currentApp.Title}";
+                Logger.Info?.Print(LogClass.UI, "Reset Discord RPC based on a supported play report value formatter.");
+            }
+            else
+            {
+                _discordPresencePlaying.Details = value.FormattedString;
+                Logger.Info?.Print(LogClass.UI, "Updated Discord RPC based on a supported play report.");
+            }
             UpdatePlayingState();
-            Logger.Info?.Print(LogClass.UI, "Updated Discord RPC based on a supported play report.");
         }
 
         private static string TruncateToByteLength(string input)

src/Ryujinx/Utilities/PlayReport.cs

@@ -0,0 +1,198 @@
+using Gommon;
+using MsgPack;
+using Ryujinx.Ava.Utilities.AppLibrary;
+using Ryujinx.Common.Helper;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Ryujinx.Ava.Utilities
+{
+    public static class PlayReport
+    {
+        public static PlayReportAnalyzer Analyzer { get; } = new PlayReportAnalyzer()
+            .AddSpec(
+                "01007ef00011e000",
+                spec => spec.AddValueFormatter("IsHardMode", BreathOfTheWild_MasterMode)
+            )
+            .AddSpec( // Super Mario Odyssey
+                "0100000000010000",
+                spec =>
+                    spec.AddValueFormatter("is_kids_mode", SuperMarioOdyssey_AssistMode)
+            )
+            .AddSpec( // Super Mario Odyssey (China)
+                "010075000ECBE000",
+                spec =>
+                    spec.AddValueFormatter("is_kids_mode", SuperMarioOdysseyChina_AssistMode)
+            )
+            .AddSpec( // Super Mario 3D World + Bowser's Fury
+                "010028600EBDA000",
+                spec => spec.AddValueFormatter("mode", SuperMario3DWorldOrBowsersFury)
+            )
+            .AddSpec( // Mario Kart 8 Deluxe, Mario Kart 8 Deluxe (China)
+                ["0100152000022000", "010075100E8EC000"],
+                spec => spec.AddValueFormatter("To", MarioKart8Deluxe_Mode)
+            );
+
+        private static PlayReportFormattedValue BreathOfTheWild_MasterMode(ref PlayReportValue value)
+            => value.BoxedValue is 1 ? "Playing Master Mode" : PlayReportFormattedValue.ForceReset;
+
+        private static PlayReportFormattedValue SuperMarioOdyssey_AssistMode(ref PlayReportValue value)
+            => value.BoxedValue is 1 ? "Playing in Assist Mode" : "Playing in Regular Mode";
+
+        private static PlayReportFormattedValue SuperMarioOdysseyChina_AssistMode(ref PlayReportValue value)
+            => value.BoxedValue is 1 ? "Playing in 帮助模式" : "Playing in 普通模式";
+
+        private static PlayReportFormattedValue SuperMario3DWorldOrBowsersFury(ref PlayReportValue value)
+            => value.BoxedValue is 0 ? "Playing Super Mario 3D World" : "Playing Bowser's Fury";
+        
+        private static PlayReportFormattedValue MarioKart8Deluxe_Mode(ref PlayReportValue value) 
+            => value.BoxedValue switch
+            {
+                // Single Player
+                "Single" => "Single Player",
+                // Multiplayer
+                "Multi-2players" => "Multiplayer 2 Players",
+                "Multi-3players" => "Multiplayer 3 Players",
+                "Multi-4players" => "Multiplayer 4 Players",
+                // Wireless/LAN Play
+                "Local-Single" => "Wireless/LAN Play",
+                "Local-2players" => "Wireless/LAN Play 2 Players",
+                // CC Classes
+                "50cc" => "50cc",
+                "100cc" => "100cc",
+                "150cc" => "150cc",
+                "Mirror" => "Mirror (150cc)",
+                "200cc" => "200cc",
+                // Modes
+                "GrandPrix" => "Grand Prix",
+                "TimeAttack" => "Time Trials",
+                "VS" => "VS Races",
+                "Battle" => "Battle Mode",
+                "RaceStart" => "Selecting a Course",
+                "Race" => "Racing",
+                _ => PlayReportFormattedValue.ForceReset
+            };
+    }
+
+    #region Analyzer implementation
+    
+    public class PlayReportAnalyzer
+    {
+        private readonly List<PlayReportGameSpec> _specs = [];
+
+        public PlayReportAnalyzer AddSpec(string titleId, Func<PlayReportGameSpec, PlayReportGameSpec> transform)
+        {
+            _specs.Add(transform(new PlayReportGameSpec { TitleIds = [titleId] }));
+            return this;
+        }
+        
+        public PlayReportAnalyzer AddSpec(string titleId, Action<PlayReportGameSpec> transform)
+        {
+            _specs.Add(new PlayReportGameSpec { TitleIds = [titleId] }.Apply(transform));
+            return this;
+        }
+        
+        public PlayReportAnalyzer AddSpec(IEnumerable<string> titleIds, Func<PlayReportGameSpec, PlayReportGameSpec> transform)
+        {
+            _specs.Add(transform(new PlayReportGameSpec { TitleIds = [..titleIds] }));
+            return this;
+        }
+        
+        public PlayReportAnalyzer AddSpec(IEnumerable<string> titleIds, Action<PlayReportGameSpec> transform)
+        {
+            _specs.Add(new PlayReportGameSpec { TitleIds = [..titleIds] }.Apply(transform));
+            return this;
+        }
+
+        public PlayReportFormattedValue Run(string runningGameId, ApplicationMetadata appMeta, MessagePackObject playReport)
+        {
+            if (!playReport.IsDictionary) 
+                return PlayReportFormattedValue.Unhandled;
+
+            if (!_specs.TryGetFirst(s => runningGameId.EqualsAnyIgnoreCase(s.TitleIds), out PlayReportGameSpec spec))
+                return PlayReportFormattedValue.Unhandled;
+
+            foreach (PlayReportValueFormatterSpec formatSpec in spec.Analyses.OrderBy(x => x.Priority))
+            {
+                if (!playReport.AsDictionary().TryGetValue(formatSpec.ReportKey, out MessagePackObject valuePackObject))
+                    continue;
+
+                PlayReportValue value = new()
+                {
+                    Application = appMeta, 
+                    BoxedValue = valuePackObject.ToObject()
+                };
+
+                return formatSpec.ValueFormatter(ref value);
+            }
+            
+            return PlayReportFormattedValue.Unhandled;
+        }
+        
+    }
+
+    public class PlayReportGameSpec
+    {
+        public required string[] TitleIds { get; init; }
+        public List<PlayReportValueFormatterSpec> Analyses { get; } = [];
+
+        public PlayReportGameSpec AddValueFormatter(string reportKey, PlayReportValueFormatter valueFormatter)
+        {
+            Analyses.Add(new PlayReportValueFormatterSpec
+            {
+                Priority = Analyses.Count,
+                ReportKey = reportKey, 
+                ValueFormatter = valueFormatter
+            });
+            return this;
+        }
+        
+        public PlayReportGameSpec AddValueFormatter(int priority, string reportKey, PlayReportValueFormatter valueFormatter)
+        {
+            Analyses.Add(new PlayReportValueFormatterSpec
+            {
+                Priority = priority,
+                ReportKey = reportKey, 
+                ValueFormatter = valueFormatter
+            });
+            return this;
+        }
+    }
+
+    public struct PlayReportValue
+    {
+        public ApplicationMetadata Application { get; init; }
+        public object BoxedValue { get; init; }
+    }
+
+    public struct PlayReportFormattedValue
+    {
+        public bool Handled { get; private init; }
+        
+        public bool Reset { get; private init; }
+        
+        public string FormattedString { get; private init; }
+
+        public static implicit operator PlayReportFormattedValue(string formattedValue)
+            => new() { Handled = true, FormattedString = formattedValue };
+
+        public static PlayReportFormattedValue Unhandled => default;
+        public static PlayReportFormattedValue ForceReset => new() { Handled = true, Reset = true };
+
+        public static PlayReportValueFormatter AlwaysResets = AlwaysResetsImpl;
+        
+        private static PlayReportFormattedValue AlwaysResetsImpl(ref PlayReportValue _) => ForceReset;
+    }
+
+    public struct PlayReportValueFormatterSpec
+    {
+        public required int Priority { get; init; }
+        public required string ReportKey { get; init; }
+        public PlayReportValueFormatter ValueFormatter { get; init; }
+    }
+
+    public delegate PlayReportFormattedValue PlayReportValueFormatter(ref PlayReportValue value);
+
+    #endregion
+}