Merge pull request #8756 from smoogipoo/fix-0-customsampleset

Fix 0 custom sample bank not falling back to user skin

osu.Game.Tests/Gameplay/TestSceneHitObjectSamples.cs

@@ -0,0 +1,346 @@
+// 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.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using NUnit.Framework;
+using osu.Framework.Allocation;
+using osu.Framework.Audio;
+using osu.Framework.IO.Stores;
+using osu.Framework.Testing;
+using osu.Framework.Timing;
+using osu.Game.Beatmaps;
+using osu.Game.Beatmaps.Formats;
+using osu.Game.IO;
+using osu.Game.Rulesets;
+using osu.Game.Rulesets.Osu;
+using osu.Game.Skinning;
+using osu.Game.Storyboards;
+using osu.Game.Tests.Resources;
+using osu.Game.Tests.Visual;
+using osu.Game.Users;
+
+namespace osu.Game.Tests.Gameplay
+{
+    [HeadlessTest]
+    public class TestSceneHitObjectSamples : PlayerTestScene
+    {
+        private readonly SkinInfo userSkinInfo = new SkinInfo();
+
+        private readonly BeatmapInfo beatmapInfo = new BeatmapInfo
+        {
+            BeatmapSet = new BeatmapSetInfo(),
+            Metadata = new BeatmapMetadata
+            {
+                Author = User.SYSTEM_USER
+            }
+        };
+
+        private readonly TestResourceStore userSkinResourceStore = new TestResourceStore();
+        private readonly TestResourceStore beatmapSkinResourceStore = new TestResourceStore();
+
+        protected override bool HasCustomSteps => true;
+
+        public TestSceneHitObjectSamples()
+            : base(new OsuRuleset())
+        {
+        }
+
+        private SkinSourceDependencyContainer dependencies;
+
+        protected override IReadOnlyDependencyContainer CreateChildDependencies(IReadOnlyDependencyContainer parent)
+            => new DependencyContainer(dependencies = new SkinSourceDependencyContainer(base.CreateChildDependencies(parent)));
+
+        /// <summary>
+        /// Tests that a hitobject which provides no custom sample set retrieves samples from the user skin.
+        /// </summary>
+        [Test]
+        public void TestDefaultSampleFromUserSkin()
+        {
+            const string expected_sample = "normal-hitnormal";
+
+            setupSkins(expected_sample, expected_sample);
+
+            createTestWithBeatmap("hitobject-skin-sample.osu");
+
+            assertUserLookup(expected_sample);
+        }
+
+        /// <summary>
+        /// Tests that a hitobject which provides a sample set of 1 retrieves samples from the beatmap skin.
+        /// </summary>
+        [Test]
+        public void TestDefaultSampleFromBeatmap()
+        {
+            const string expected_sample = "normal-hitnormal";
+
+            setupSkins(expected_sample, expected_sample);
+
+            createTestWithBeatmap("hitobject-beatmap-sample.osu");
+
+            assertBeatmapLookup(expected_sample);
+        }
+
+        /// <summary>
+        /// Tests that a hitobject which provides a sample set of 1 retrieves samples from the user skin when the beatmap does not contain the sample.
+        /// </summary>
+        [Test]
+        public void TestDefaultSampleFromUserSkinFallback()
+        {
+            const string expected_sample = "normal-hitnormal";
+
+            setupSkins(null, expected_sample);
+
+            createTestWithBeatmap("hitobject-beatmap-sample.osu");
+
+            assertUserLookup(expected_sample);
+        }
+
+        /// <summary>
+        /// Tests that a hitobject which provides a custom sample set of 2 retrieves the following samples from the beatmap skin:
+        /// normal-hitnormal2
+        /// normal-hitnormal
+        /// </summary>
+        [TestCase("normal-hitnormal2")]
+        [TestCase("normal-hitnormal")]
+        public void TestDefaultCustomSampleFromBeatmap(string expectedSample)
+        {
+            setupSkins(expectedSample, expectedSample);
+
+            createTestWithBeatmap("hitobject-beatmap-custom-sample.osu");
+
+            assertBeatmapLookup(expectedSample);
+        }
+
+        /// <summary>
+        /// Tests that a hitobject which provides a custom sample set of 2 retrieves the following samples from the user skin when the beatmap does not contain the sample:
+        /// normal-hitnormal2
+        /// normal-hitnormal
+        /// </summary>
+        [TestCase("normal-hitnormal2")]
+        [TestCase("normal-hitnormal")]
+        public void TestDefaultCustomSampleFromUserSkinFallback(string expectedSample)
+        {
+            setupSkins(string.Empty, expectedSample);
+
+            createTestWithBeatmap("hitobject-beatmap-custom-sample.osu");
+
+            assertUserLookup(expectedSample);
+        }
+
+        /// <summary>
+        /// Tests that a hitobject which provides a sample file retrieves the sample file from the beatmap skin.
+        /// </summary>
+        [Test]
+        public void TestFileSampleFromBeatmap()
+        {
+            const string expected_sample = "hit_1.wav";
+
+            setupSkins(expected_sample, expected_sample);
+
+            createTestWithBeatmap("file-beatmap-sample.osu");
+
+            assertBeatmapLookup(expected_sample);
+        }
+
+        /// <summary>
+        /// Tests that a default hitobject and control point causes <see cref="TestDefaultSampleFromUserSkin"/>.
+        /// </summary>
+        [Test]
+        public void TestControlPointSampleFromSkin()
+        {
+            const string expected_sample = "normal-hitnormal";
+
+            setupSkins(expected_sample, expected_sample);
+
+            createTestWithBeatmap("controlpoint-skin-sample.osu");
+
+            assertUserLookup(expected_sample);
+        }
+
+        /// <summary>
+        /// Tests that a control point that provides a custom sample set of 1 causes <see cref="TestDefaultSampleFromBeatmap"/>.
+        /// </summary>
+        [Test]
+        public void TestControlPointSampleFromBeatmap()
+        {
+            const string expected_sample = "normal-hitnormal";
+
+            setupSkins(expected_sample, expected_sample);
+
+            createTestWithBeatmap("controlpoint-beatmap-sample.osu");
+
+            assertBeatmapLookup(expected_sample);
+        }
+
+        /// <summary>
+        /// Tests that a control point that provides a custom sample of 2 causes <see cref="TestDefaultCustomSampleFromBeatmap"/>.
+        /// </summary>
+        [TestCase("normal-hitnormal2")]
+        [TestCase("normal-hitnormal")]
+        public void TestControlPointCustomSampleFromBeatmap(string sampleName)
+        {
+            setupSkins(sampleName, sampleName);
+
+            createTestWithBeatmap("controlpoint-beatmap-custom-sample.osu");
+
+            assertBeatmapLookup(sampleName);
+        }
+
+        /// <summary>
+        /// Tests that a hitobject's custom sample overrides the control point's.
+        /// </summary>
+        [Test]
+        public void TestHitObjectCustomSampleOverride()
+        {
+            const string expected_sample = "normal-hitnormal3";
+
+            setupSkins(expected_sample, expected_sample);
+
+            createTestWithBeatmap("hitobject-beatmap-custom-sample-override.osu");
+
+            assertBeatmapLookup(expected_sample);
+        }
+
+        protected override IBeatmap CreateBeatmap(RulesetInfo ruleset) => currentTestBeatmap;
+
+        protected override WorkingBeatmap CreateWorkingBeatmap(IBeatmap beatmap, Storyboard storyboard = null)
+            => new TestWorkingBeatmap(beatmapInfo, beatmapSkinResourceStore, beatmap, storyboard, Clock, Audio);
+
+        private IBeatmap currentTestBeatmap;
+
+        private void createTestWithBeatmap(string filename)
+        {
+            CreateTest(() =>
+            {
+                AddStep("clear performed lookups", () =>
+                {
+                    userSkinResourceStore.PerformedLookups.Clear();
+                    beatmapSkinResourceStore.PerformedLookups.Clear();
+                });
+
+                AddStep($"load {filename}", () =>
+                {
+                    using (var reader = new LineBufferedReader(TestResources.OpenResource($"SampleLookups/{filename}")))
+                        currentTestBeatmap = Decoder.GetDecoder<Beatmap>(reader).Decode(reader);
+                });
+            });
+        }
+
+        private void setupSkins(string beatmapFile, string userFile)
+        {
+            AddStep("setup skins", () =>
+            {
+                userSkinInfo.Files = new List<SkinFileInfo>
+                {
+                    new SkinFileInfo
+                    {
+                        Filename = userFile,
+                        FileInfo = new IO.FileInfo { Hash = userFile }
+                    }
+                };
+
+                beatmapInfo.BeatmapSet.Files = new List<BeatmapSetFileInfo>
+                {
+                    new BeatmapSetFileInfo
+                    {
+                        Filename = beatmapFile,
+                        FileInfo = new IO.FileInfo { Hash = beatmapFile }
+                    }
+                };
+
+                // Need to refresh the cached skin source to refresh the skin resource store.
+                dependencies.SkinSource = new SkinProvidingContainer(new LegacySkin(userSkinInfo, userSkinResourceStore, Audio));
+            });
+        }
+
+        private void assertBeatmapLookup(string name) => AddAssert($"\"{name}\" looked up from beatmap skin",
+            () => !userSkinResourceStore.PerformedLookups.Contains(name) && beatmapSkinResourceStore.PerformedLookups.Contains(name));
+
+        private void assertUserLookup(string name) => AddAssert($"\"{name}\" looked up from user skin",
+            () => !beatmapSkinResourceStore.PerformedLookups.Contains(name) && userSkinResourceStore.PerformedLookups.Contains(name));
+
+        private class SkinSourceDependencyContainer : IReadOnlyDependencyContainer
+        {
+            public ISkinSource SkinSource;
+
+            private readonly IReadOnlyDependencyContainer fallback;
+
+            public SkinSourceDependencyContainer(IReadOnlyDependencyContainer fallback)
+            {
+                this.fallback = fallback;
+            }
+
+            public object Get(Type type)
+            {
+                if (type == typeof(ISkinSource))
+                    return SkinSource;
+
+                return fallback.Get(type);
+            }
+
+            public object Get(Type type, CacheInfo info)
+            {
+                if (type == typeof(ISkinSource))
+                    return SkinSource;
+
+                return fallback.Get(type, info);
+            }
+
+            public void Inject<T>(T instance) where T : class
+            {
+                // Never used directly
+            }
+        }
+
+        private class TestResourceStore : IResourceStore<byte[]>
+        {
+            public readonly List<string> PerformedLookups = new List<string>();
+
+            public byte[] Get(string name)
+            {
+                markLookup(name);
+                return Array.Empty<byte>();
+            }
+
+            public Task<byte[]> GetAsync(string name)
+            {
+                markLookup(name);
+                return Task.FromResult(Array.Empty<byte>());
+            }
+
+            public Stream GetStream(string name)
+            {
+                markLookup(name);
+                return new MemoryStream();
+            }
+
+            private void markLookup(string name) => PerformedLookups.Add(name.Substring(name.LastIndexOf(Path.DirectorySeparatorChar) + 1));
+
+            public IEnumerable<string> GetAvailableResources() => Enumerable.Empty<string>();
+
+            public void Dispose()
+            {
+            }
+        }
+
+        private class TestWorkingBeatmap : ClockBackedTestWorkingBeatmap
+        {
+            private readonly BeatmapInfo skinBeatmapInfo;
+            private readonly IResourceStore<byte[]> resourceStore;
+
+            public TestWorkingBeatmap(BeatmapInfo skinBeatmapInfo, IResourceStore<byte[]> resourceStore, IBeatmap beatmap, Storyboard storyboard, IFrameBasedClock referenceClock, AudioManager audio,
+                                      double length = 60000)
+                : base(beatmap, storyboard, referenceClock, audio, length)
+            {
+                this.skinBeatmapInfo = skinBeatmapInfo;
+                this.resourceStore = resourceStore;
+            }
+
+            protected override ISkin GetSkin() => new LegacyBeatmapSkin(skinBeatmapInfo, resourceStore, AudioManager);
+        }
+    }
+}

osu.Game.Tests/Resources/SampleLookups/controlpoint-beatmap-custom-sample.osu

@@ -0,0 +1,7 @@
+osu file format v14
+
+[TimingPoints]
+0,300,4,0,2,100,1,0
+
+[HitObjects]
+444,320,1000,5,0,0:0:0:0:

osu.Game.Tests/Resources/SampleLookups/controlpoint-beatmap-sample.osu

@@ -0,0 +1,7 @@
+osu file format v14
+
+[TimingPoints]
+0,300,4,0,1,100,1,0
+
+[HitObjects]
+444,320,1000,5,0,0:0:0:0:

osu.Game.Tests/Resources/SampleLookups/controlpoint-skin-sample.osu

@@ -0,0 +1,7 @@
+osu file format v14
+
+[TimingPoints]
+0,300,4,0,0,100,1,0
+
+[HitObjects]
+444,320,1000,5,0,0:0:0:0:

osu.Game.Tests/Resources/SampleLookups/file-beatmap-sample.osu

@@ -0,0 +1,4 @@
+osu file format v14
+
+[HitObjects]
+255,193,2170,1,0,0:0:0:0:hit_1.wav

osu.Game.Tests/Resources/SampleLookups/hitobject-beatmap-custom-sample-override.osu

@@ -0,0 +1,7 @@
+osu file format v14
+
+[TimingPoints]
+0,300,4,0,2,100,1,0
+
+[HitObjects]
+444,320,1000,5,0,0:0:3:0:

osu.Game.Tests/Resources/SampleLookups/hitobject-beatmap-custom-sample.osu

@@ -0,0 +1,4 @@
+osu file format v14
+
+[HitObjects]
+444,320,1000,5,0,0:0:2:0:

osu.Game.Tests/Resources/SampleLookups/hitobject-beatmap-sample.osu

@@ -0,0 +1,4 @@
+osu file format v14
+
+[HitObjects]
+444,320,1000,5,0,0:0:1:0:

osu.Game.Tests/Resources/SampleLookups/hitobject-skin-sample.osu

@@ -0,0 +1,4 @@
+osu file format v14
+
+[HitObjects]
+444,320,1000,5,0,0:0:0:0:

osu.Game/Beatmaps/Formats/LegacyDecoder.cs

@@ -8,6 +8,7 @@ using osu.Framework.Logging;
 using osu.Game.Audio;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.IO;
+using osu.Game.Rulesets.Objects.Legacy;
 using osuTK.Graphics;
 
 namespace osu.Game.Beatmaps.Formats
@@ -168,8 +169,11 @@ namespace osu.Game.Beatmaps.Formats
             {
                 var baseInfo = base.ApplyTo(hitSampleInfo);
 
-                if (string.IsNullOrEmpty(baseInfo.Suffix) && CustomSampleBank > 1)
+                if (baseInfo is ConvertHitObjectParser.LegacyHitSampleInfo legacy
-                    baseInfo.Suffix = CustomSampleBank.ToString();
+                    && legacy.CustomSampleBank == 0)
+                {
+                    legacy.CustomSampleBank = CustomSampleBank;
+                }
 
                 return baseInfo;
             }

osu.Game/Rulesets/Objects/Legacy/ConvertHitObjectParser.cs

@@ -409,22 +409,34 @@ namespace osu.Game.Rulesets.Objects.Legacy
             public SampleBankInfo Clone() => (SampleBankInfo)MemberwiseClone();
         }
 
-        private class LegacyHitSampleInfo : HitSampleInfo
+        internal class LegacyHitSampleInfo : HitSampleInfo
         {
+            private int customSampleBank;
+
             public int CustomSampleBank
             {
+                get => customSampleBank;
                 set
                 {
-                    if (value > 1)
+                    customSampleBank = value;
+
+                    if (value >= 2)
                         Suffix = value.ToString();
                 }
             }
         }
 
-        private class FileHitSampleInfo : HitSampleInfo
+        private class FileHitSampleInfo : LegacyHitSampleInfo
         {
             public string Filename;
 
+            public FileHitSampleInfo()
+            {
+                // Make sure that the LegacyBeatmapSkin does not fall back to the user skin.
+                // Note that this does not change the lookup names, as they are overridden locally.
+                CustomSampleBank = 1;
+            }
+
             public override IEnumerable<string> LookupNames => new[]
             {
                 Filename,

osu.Game/Skinning/LegacyBeatmapSkin.cs

@@ -2,9 +2,12 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osu.Framework.Audio;
+using osu.Framework.Audio.Sample;
 using osu.Framework.Bindables;
 using osu.Framework.IO.Stores;
+using osu.Game.Audio;
 using osu.Game.Beatmaps;
+using osu.Game.Rulesets.Objects.Legacy;
 
 namespace osu.Game.Skinning
 {
@@ -33,6 +36,17 @@ namespace osu.Game.Skinning
             return base.GetConfig<TLookup, TValue>(lookup);
         }
 
+        public override SampleChannel GetSample(ISampleInfo sampleInfo)
+        {
+            if (sampleInfo is ConvertHitObjectParser.LegacyHitSampleInfo legacy && legacy.CustomSampleBank == 0)
+            {
+                // When no custom sample bank is provided, always fall-back to the default samples.
+                return null;
+            }
+
+            return base.GetSample(sampleInfo);
+        }
+
         private static SkinInfo createSkinInfo(BeatmapInfo beatmap) =>
             new SkinInfo { Name = beatmap.ToString(), Creator = beatmap.Metadata.Author.ToString() };
     }

osu.Game/Tests/Beatmaps/TestWorkingBeatmap.cs

@@ -1,6 +1,7 @@
 // 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.Framework.Audio;
 using osu.Framework.Audio.Track;
 using osu.Framework.Graphics.Textures;
 using osu.Game.Beatmaps;
@@ -18,8 +19,9 @@ namespace osu.Game.Tests.Beatmaps
         /// </summary>
         /// <param name="beatmap">The beatmap.</param>
         /// <param name="storyboard">An optional storyboard.</param>
-        public TestWorkingBeatmap(IBeatmap beatmap, Storyboard storyboard = null)
+        /// <param name="audioManager">The <see cref="AudioManager"/>.</param>
-            : base(beatmap.BeatmapInfo, null)
+        public TestWorkingBeatmap(IBeatmap beatmap, Storyboard storyboard = null, AudioManager audioManager = null)
+            : base(beatmap.BeatmapInfo, audioManager)
         {
             this.beatmap = beatmap;
             this.storyboard = storyboard;

osu.Game/Tests/Visual/OsuTestScene.cs

@@ -179,7 +179,7 @@ namespace osu.Game.Tests.Visual
             /// <param name="audio">Audio manager. Required if a reference clock isn't provided.</param>
             /// <param name="length">The length of the returned virtual track.</param>
             public ClockBackedTestWorkingBeatmap(IBeatmap beatmap, Storyboard storyboard, IFrameBasedClock referenceClock, AudioManager audio, double length = 60000)
-                : base(beatmap, storyboard)
+                : base(beatmap, storyboard, audio)
             {
                 if (referenceClock != null)
                 {