Merge pull request #154 from andy840119/slave/micrphone-status

Implement microphone status preview.
karaoke-dev · Aug 2, 2020 · f50bae7 · f50bae7
2 parents ea1b1a2 + 577ce61
commit f50bae7
Show file tree

Hide file tree

Showing 13 changed files with 307 additions and 23 deletions.
diff --git a/osu.Game.Rulesets.Karaoke.Tests/Skinning/KaraokeSkinnableColumnTestScene.cs b/osu.Game.Rulesets.Karaoke.Tests/Skinning/KaraokeSkinnableColumnTestScene.cs
@@ -48,9 +48,12 @@ protected KaraokeSkinnableColumnTestScene()
         [BackgroundDependencyLoader]
         private void load(RulesetConfigCache configCache)
         {
-            // Cache ruleset config manager because karaoke input manager need it.
+            // Cache ruleset config manager and session because karaoke input manager need it.
             var config = (KaraokeRulesetConfigManager)configCache.GetConfigFor(Ruleset.Value.CreateInstance());
+            var session = new KaraokeSessionStatics(config, null);
+
             Dependencies.Cache(config);
+            Dependencies.Cache(session);
         }
 
         [Test]

diff --git a/osu.Game.Rulesets.Karaoke.Tests/Skinning/TestSceneNotePlayfield.cs b/osu.Game.Rulesets.Karaoke.Tests/Skinning/TestSceneNotePlayfield.cs
@@ -2,7 +2,6 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Allocation;
-using osu.Game.Rulesets.Karaoke.Configuration;
 using osu.Game.Rulesets.Karaoke.UI;
 
 namespace osu.Game.Rulesets.Karaoke.Tests.Skinning
@@ -12,9 +11,6 @@ public class TestSceneNotePlayfield : KaraokeSkinnableColumnTestScene
         [BackgroundDependencyLoader]
         private void load(RulesetConfigCache configCache)
         {
-            var config = (KaraokeRulesetConfigManager)configCache.GetConfigFor(Ruleset.Value.CreateInstance());
-            Dependencies.Cache(new KaraokeSessionStatics(config, null));
-
             SetContents(() => new KaraokeInputManager(new KaraokeRuleset().RulesetInfo)
             {
                 Child = new NotePlayfield(COLUMN_NUMBER)

diff --git a/osu.Game.Rulesets.Karaoke.Tests/UI/TestCaseSaitenStatus.cs b/osu.Game.Rulesets.Karaoke.Tests/UI/TestCaseSaitenStatus.cs
@@ -0,0 +1,39 @@
+// Copyright (c) andy840119 <[email protected]>. Licensed under the GPL Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using NUnit.Framework;
+using osu.Framework.Graphics;
+using osu.Game.Rulesets.Karaoke.UI.Components;
+using osu.Game.Tests.Visual;
+
+namespace osu.Game.Rulesets.Karaoke.Tests.UI
+{
+    [TestFixture]
+    public class TestCaseSaitenStatus : OsuTestScene
+    {
+        [TestCase(SaitenStatusMode.AndroidMicrophonePermissionDeclined)]
+        [TestCase(SaitenStatusMode.AndroidDoesNotSupported)]
+        [TestCase(SaitenStatusMode.IOSMicrophonePermissionDeclined)]
+        [TestCase(SaitenStatusMode.IOSDoesNotSupported)]
+        [TestCase(SaitenStatusMode.OSXMicrophonePermissionDeclined)]
+        [TestCase(SaitenStatusMode.OSXDoesNotSupported)]
+        [TestCase(SaitenStatusMode.WindowsMicrophonePermissionDeclined)]
+        [TestCase(SaitenStatusMode.NoMicrophoneDevice)]
+        [TestCase(SaitenStatusMode.NotSaitening)]
+        [TestCase(SaitenStatusMode.AutoPlay)]
+        [TestCase(SaitenStatusMode.Edit)]
+        [TestCase(SaitenStatusMode.Saitening)]
+        [TestCase(SaitenStatusMode.NotInitialized)]
+        public void TestMode(SaitenStatusMode mode)
+        {
+            AddStep("create mod display", () =>
+            {
+                Child = new SaitenStatus(mode)
+                {
+                    Anchor = Anchor.Centre,
+                    Origin = Anchor.Centre
+                };
+            });
+        }
+    }
+}
diff --git a/osu.Game.Rulesets.Karaoke/Configuration/KaraokeSessionStatics.cs b/osu.Game.Rulesets.Karaoke/Configuration/KaraokeSessionStatics.cs
@@ -6,6 +6,7 @@
 using osu.Game.Configuration;
 using osu.Game.Rulesets.Karaoke.Beatmaps;
 using osu.Game.Rulesets.Karaoke.Objects;
+using osu.Game.Rulesets.Karaoke.UI.Components;
 
 namespace osu.Game.Rulesets.Karaoke.Configuration
 {
@@ -50,6 +51,9 @@ public KaraokeSessionStatics(KaraokeRulesetConfigManager config, IBeatmap beatma
 
             // Practice
             Set<LyricLine>(KaraokeRulesetSession.NowLyric, null);
+
+            // Saiten stsus
+            Set(KaraokeRulesetSession.SaitenStatus, SaitenStatusMode.NotInitialized);
         }
 
         private T getValue<T>(KaraokeRulesetSetting setting) => rulesetConfigManager.GetBindable<T>(setting).Value;
@@ -75,5 +79,8 @@ public enum KaraokeRulesetSession
 
         // Practice
         NowLyric,
+
+        // Saiten status
+        SaitenStatus,
     }
 }
diff --git a/osu.Game.Rulesets.Karaoke/KaraokeInputManager.cs b/osu.Game.Rulesets.Karaoke/KaraokeInputManager.cs
@@ -12,11 +12,13 @@
 using osu.Framework.Input.Handlers.Microphone;
 using osu.Framework.Input.StateChanges.Events;
 using osu.Framework.Input.States;
+using osu.Framework.Logging;
 using osu.Game.Beatmaps;
 using osu.Game.Input.Handlers;
 using osu.Game.Rulesets.Karaoke.Beatmaps;
 using osu.Game.Rulesets.Karaoke.Configuration;
 using osu.Game.Rulesets.Karaoke.Mods;
+using osu.Game.Rulesets.Karaoke.UI.Components;
 using osu.Game.Rulesets.Mods;
 using osu.Game.Rulesets.UI;
 using osu.Game.Screens.Edit;
@@ -34,27 +36,49 @@ public KaraokeInputManager(RulesetInfo ruleset)
         private IBeatmap beatmap;
 
         [BackgroundDependencyLoader(true)]
-        private void load(KaraokeRulesetConfigManager config, IBindable<IReadOnlyList<Mod>> mods, IBindable<WorkingBeatmap> beatmap, EditorBeatmap editorBeatmap)
+        private void load(KaraokeRulesetConfigManager config, IBindable<IReadOnlyList<Mod>> mods, IBindable<WorkingBeatmap> beatmap, KaraokeSessionStatics session, EditorBeatmap editorBeatmap)
         {
             if (editorBeatmap != null)
+            {
+                session.Set(KaraokeRulesetSession.SaitenStatus, SaitenStatusMode.Edit);
                 return;
+            }
 
             this.beatmap = beatmap.Value.Beatmap;
 
             var disableMicrophoneDeviceByMod = mods.Value.OfType<IApplicableToMicrophone>().Any(x => !x.MicrophoneEnabled);
+
             if (disableMicrophoneDeviceByMod)
+            {
+                session.Set(KaraokeRulesetSession.SaitenStatus, SaitenStatusMode.AutoPlay);
                 return;
+            }
 
             var beatmapSaitenable = beatmap.Value.Beatmap.IsScorable();
+
             if (!beatmapSaitenable)
+            {
+                session.Set(KaraokeRulesetSession.SaitenStatus, SaitenStatusMode.NotSaitening);
                 return;
+            }
+
+            try
+            {
+                var selectedDevice = config.GetBindable<string>(KaraokeRulesetSetting.MicrophoneDevice).Value;
+                var microphoneList = new MicrophoneManager().MicrophoneDeviceNames.ToList();
 
-            var selectedDevice = config.GetBindable<string>(KaraokeRulesetSetting.MicrophoneDevice).Value;
-            var microphoneList = new MicrophoneManager().MicrophoneDeviceNames.ToList();
+                // Find index by selection id
+                var deviceIndex = microphoneList.IndexOf(selectedDevice);
+                AddHandler(new OsuTKMicrophoneHandler(deviceIndex));
 
-            // Find index by selection id
-            var deviceIndex = microphoneList.IndexOf(selectedDevice);
-            AddHandler(new OsuTKMicrophoneHandler(deviceIndex));
+                session.Set(KaraokeRulesetSession.SaitenStatus, SaitenStatusMode.Saitening);
+            }
+            catch (Exception ex)
+            {
+                Logger.Error(ex, "Microphone initialize error.");
+                // todo : set real error by exception
+                session.Set(KaraokeRulesetSession.SaitenStatus, SaitenStatusMode.WindowsMicrophonePermissionDeclined);
+            }
         }
 
         protected override InputState CreateInitialState()

diff --git a/osu.Game.Rulesets.Karaoke/KaraokeRuleset.cs b/osu.Game.Rulesets.Karaoke/KaraokeRuleset.cs
@@ -24,7 +24,6 @@
 using osu.Game.Rulesets.Karaoke.Mods;
 using osu.Game.Rulesets.Karaoke.Objects;
 using osu.Game.Rulesets.Karaoke.Replays;
-using osu.Game.Rulesets.Karaoke.Resources.Fonts;
 using osu.Game.Rulesets.Karaoke.Scoring;
 using osu.Game.Rulesets.Karaoke.Skinning;
 using osu.Game.Rulesets.Karaoke.UI;

diff --git a/osu.Game.Rulesets.Karaoke/Mods/KaraokeModDisableNote.cs b/osu.Game.Rulesets.Karaoke/Mods/KaraokeModDisableNote.cs
@@ -9,16 +9,14 @@
 
 namespace osu.Game.Rulesets.Karaoke.Mods
 {
-    public class KaraokeModDisableNote : Mod, IApplicableToHitObject, IApplicableToMicrophone
+    public class KaraokeModDisableNote : Mod, IApplicableToHitObject
     {
         public override string Name => "Disable note";
         public override string Acronym => "DN";
         public override double ScoreMultiplier => 0;
         public override IconUsage? Icon => KaraokeIcon.ModDisableNote;
         public override ModType Type => ModType.Fun;
 
-        public bool MicrophoneEnabled => false;
-
         public void ApplyToHitObject(HitObject hitObject)
         {
             if (hitObject is Note note)

diff --git a/osu.Game.Rulesets.Karaoke/Overlays/Changelog/ChangeLogMarkdownContainer.cs b/osu.Game.Rulesets.Karaoke/Overlays/Changelog/ChangeLogMarkdownContainer.cs
@@ -177,7 +177,7 @@ private void computeImageSize()
                 }
             }
 
-            private IDictionary<string, string> githubUrls = new Dictionary<string, string>
+            private readonly IDictionary<string, string> githubUrls = new Dictionary<string, string>
             {
                 { "karaoke", "https://github.com/karaoke-dev/karaoke/" },
                 { "edge", "https://github.com/karaoke-dev/karaoke" },
@@ -193,13 +193,14 @@ protected override void AddLinkText(string text, LinkInline linkInline)
                     var baseUri = new Uri(githubUrls[text]);
 
                     // Get hash tag with number
-                    var pattern = @"(\#[0-9]+\b)(?!;)";
+                    const string pattern = @"(\#[0-9]+\b)(?!;)";
                     var issueOrRequests = Regex.Matches(linkInline.Url, pattern, RegexOptions.IgnoreCase);
 
                     if (!issueOrRequests.Any())
                         return;
 
                     AddText("(");
+
                     foreach (var issue in issueOrRequests.Select(x=>x.Value))
                     {
                         AddDrawable(new MarkdownLinkText($"{text}{issue}", new LinkInline
@@ -210,10 +211,12 @@ protected override void AddLinkText(string text, LinkInline linkInline)
                         if(issue != issueOrRequests.LastOrDefault()?.Value)
                             AddText(", ");
                     }
+
                     AddText(")");
 
                     // add use name if has user
                     var user = linkInline.Url.Split('@').LastOrDefault();
+
                     if (!string.IsNullOrEmpty(user))
                     {
                         var textScale = new Vector2(0.7f);

diff --git a/osu.Game.Rulesets.Karaoke/Skinning/KaraokeInternalSkin.cs b/osu.Game.Rulesets.Karaoke/Skinning/KaraokeInternalSkin.cs
@@ -27,7 +27,7 @@ public abstract class KaraokeInternalSkin : ISkin
 
         protected abstract string ResourceName { get; }
 
-        public KaraokeInternalSkin()
+        protected KaraokeInternalSkin()
         {
             // TODO : need a better way to load resource
             var assembly = Assembly.GetExecutingAssembly();

diff --git a/osu.Game.Rulesets.Karaoke/Skinning/KaraokeLegacySkinTransformer.cs b/osu.Game.Rulesets.Karaoke/Skinning/KaraokeLegacySkinTransformer.cs
@@ -5,11 +5,8 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
-using osu.Framework.Audio.Sample;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
-using osu.Framework.Graphics.Textures;
-using osu.Game.Audio;
 using osu.Game.IO;
 using osu.Game.Rulesets.Karaoke.Beatmaps.Formats;
 using osu.Game.Rulesets.Karaoke.Skinning.Components;