Make Beatmaps decodable as Skins

osu.Game.Rulesets.Catch/Beatmaps/CatchBeatmapProcessor.cs

@@ -16,11 +16,7 @@ public class CatchBeatmapProcessor : BeatmapProcessor<CatchHitObject>
     {
         public override void PostProcess(Beatmap<CatchHitObject> beatmap)
         {
-            if (beatmap.ComboColours.Count == 0)
-                return;
-
             int index = 0;
-            int colourIndex = 0;
 
             CatchHitObject lastObj = null;
 
@@ -31,11 +27,9 @@ public override void PostProcess(Beatmap<CatchHitObject> beatmap)
                 if (obj.NewCombo)
                 {
                     if (lastObj != null) lastObj.LastInCombo = true;
-                    colourIndex = (colourIndex + 1) % beatmap.ComboColours.Count;
                 }
 
                 obj.IndexInBeatmap = index++;
-                obj.ComboColour = beatmap.ComboColours[colourIndex];
 
                 lastObj = obj;
             }

osu.Game.Rulesets.Osu/Beatmaps/OsuBeatmapProcessor.cs

@@ -14,22 +14,16 @@ public override void PostProcess(Beatmap<OsuHitObject> beatmap)
         {
             applyStacking(beatmap);
 
-            if (beatmap.ComboColours.Count == 0)
-                return;
-
             int comboIndex = 0;
-            int colourIndex = 0;
 
             foreach (var obj in beatmap.HitObjects)
             {
                 if (obj.NewCombo)
                 {
                     comboIndex = 0;
-                    colourIndex = (colourIndex + 1) % beatmap.ComboColours.Count;
                 }
 
                 obj.IndexInCurrentCombo = comboIndex++;
-                obj.ComboColour = beatmap.ComboColours[colourIndex];
             }
         }
 

osu.Game.Tests/Beatmaps/Formats/LegacyBeatmapDecoderTest.cs

@@ -11,6 +11,7 @@
 using osu.Game.Rulesets.Objects.Types;
 using osu.Game.Beatmaps.Formats;
 using osu.Game.Beatmaps.Timing;
+using osu.Game.Skinning;
 
 namespace osu.Game.Tests.Beatmaps.Formats
 {
@@ -163,7 +164,7 @@ public void TestDecodeBeatmapTimingPoints()
         [Test]
         public void TestDecodeBeatmapColors()
         {
-            var decoder = new LegacyBeatmapDecoder();
+            var decoder = new LegacySkinDecoder();
             using (var resStream = Resource.OpenResource("Soleily - Renatus (Gamu) [Insane].osu"))
             using (var stream = new StreamReader(resStream))
             {

osu.Game.Tests/Beatmaps/Formats/OsuJsonDecoderTest.cs

@@ -12,7 +12,6 @@
 using osu.Game.Rulesets.Objects.Types;
 using osu.Game.Tests.Resources;
 using OpenTK;
-using OpenTK.Graphics;
 
 namespace osu.Game.Tests.Beatmaps.Formats
 {
@@ -89,24 +88,6 @@ public void TestDecodeDifficulty()
             Assert.AreEqual(2, difficulty.SliderTickRate);
         }
 
-        [Test]
-        public void TestDecodeColors()
-        {
-            var beatmap = decodeAsJson(normal);
-            Color4[] expected =
-            {
-                new Color4(142, 199, 255, 255),
-                new Color4(255, 128, 128, 255),
-                new Color4(128, 255, 255, 255),
-                new Color4(128, 255, 128, 255),
-                new Color4(255, 187, 255, 255),
-                new Color4(255, 177, 140, 255),
-            };
-            Assert.AreEqual(expected.Length, beatmap.ComboColours.Count);
-            for (int i = 0; i < expected.Length; i++)
-                Assert.AreEqual(expected[i], beatmap.ComboColours[i]);
-        }
-
         [Test]
         public void TestDecodeHitObjects()
         {

osu.Game.Tests/Visual/TestCasePlaySongSelect.cs

@@ -68,7 +68,7 @@ private void load(OsuGameBase game)
             IDatabaseContextFactory factory = new SingletonContextFactory(new OsuDbContext());
 
             dependencies.Cache(rulesets = new RulesetStore(factory));
-            dependencies.Cache(manager = new BeatmapManager(storage, factory, rulesets, null)
+            dependencies.Cache(manager = new BeatmapManager(storage, factory, rulesets, null, null)
             {
                 DefaultBeatmap = defaultBeatmap = game.Beatmap.Default
             });

osu.Game/Beatmaps/Beatmap.cs

@@ -1,37 +1,27 @@
 // Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
 // Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
 
-using OpenTK.Graphics;
 using osu.Game.Beatmaps.Timing;
 using osu.Game.Rulesets.Objects;
 using System.Collections.Generic;
 using System.Linq;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.IO.Serialization;
 using Newtonsoft.Json;
-using osu.Game.Beatmaps.Formats;
 using osu.Game.IO.Serialization.Converters;
 
 namespace osu.Game.Beatmaps
 {
     /// <summary>
     /// A Beatmap containing converted HitObjects.
     /// </summary>
-    public class Beatmap<T> : IJsonSerializable, IHasComboColours
+    public class Beatmap<T> : IJsonSerializable
         where T : HitObject
     {
         public BeatmapInfo BeatmapInfo = new BeatmapInfo();
         public ControlPointInfo ControlPointInfo = new ControlPointInfo();
         public List<BreakPeriod> Breaks = new List<BreakPeriod>();
 
-        public List<Color4> ComboColours { get; set; } = new List<Color4>
-        {
-            new Color4(17, 136, 170, 255),
-            new Color4(102, 136, 0, 255),
-            new Color4(204, 102, 0, 255),
-            new Color4(121, 9, 13, 255)
-        };
-
         [JsonIgnore]
         public BeatmapMetadata Metadata => BeatmapInfo?.Metadata ?? BeatmapInfo?.BeatmapSet?.Metadata;
 
@@ -56,7 +46,6 @@ public Beatmap(Beatmap<T> original = null)
             BeatmapInfo = original?.BeatmapInfo.DeepClone() ?? BeatmapInfo;
             ControlPointInfo = original?.ControlPointInfo ?? ControlPointInfo;
             Breaks = original?.Breaks ?? Breaks;
-            ComboColours = original?.ComboColours ?? ComboColours;
             HitObjects = original?.HitObjects ?? HitObjects;
 
             if (original == null && Metadata == null)

osu.Game/Beatmaps/BeatmapConverter.cs

@@ -57,7 +57,6 @@ protected virtual Beatmap<T> ConvertBeatmap(Beatmap original)
             beatmap.ControlPointInfo = original.ControlPointInfo;
             beatmap.HitObjects = original.HitObjects.SelectMany(h => convert(h, original)).ToList();
             beatmap.Breaks = original.Breaks;
-            beatmap.ComboColours = original.ComboColours;
 
             return beatmap;
         }

osu.Game/Beatmaps/BeatmapManager.cs

@@ -8,6 +8,7 @@
 using System.Linq.Expressions;
 using System.Threading.Tasks;
 using Microsoft.EntityFrameworkCore;
+using osu.Framework.Audio;
 using osu.Framework.Extensions;
 using osu.Framework.Logging;
 using osu.Framework.Platform;
@@ -55,14 +56,16 @@ public partial class BeatmapManager : ArchiveModelManager<BeatmapSetInfo, Beatma
 
         private readonly APIAccess api;
 
+        private readonly AudioManager audioManager;
+
         private readonly List<DownloadBeatmapSetRequest> currentDownloads = new List<DownloadBeatmapSetRequest>();
 
         /// <summary>
         /// Set a storage with access to an osu-stable install for import purposes.
         /// </summary>
         public Func<Storage> GetStableStorage { private get; set; }
 
-        public BeatmapManager(Storage storage, IDatabaseContextFactory contextFactory, RulesetStore rulesets, APIAccess api, IIpcHost importHost = null)
+        public BeatmapManager(Storage storage, IDatabaseContextFactory contextFactory, RulesetStore rulesets, APIAccess api, AudioManager audioManager, IIpcHost importHost = null)
             : base(storage, contextFactory, new BeatmapStore(contextFactory), importHost)
         {
             beatmaps = (BeatmapStore)ModelStore;
@@ -71,6 +74,7 @@ public BeatmapManager(Storage storage, IDatabaseContextFactory contextFactory, R
 
             this.rulesets = rulesets;
             this.api = api;
+            this.audioManager = audioManager;
         }
 
         protected override void Populate(BeatmapSetInfo model, ArchiveReader archive)
@@ -217,7 +221,7 @@ public WorkingBeatmap GetWorkingBeatmap(BeatmapInfo beatmapInfo, WorkingBeatmap
             if (beatmapInfo.Metadata == null)
                 beatmapInfo.Metadata = beatmapInfo.BeatmapSet.Metadata;
 
-            WorkingBeatmap working = new BeatmapManagerWorkingBeatmap(Files.Store, beatmapInfo);
+            WorkingBeatmap working = new BeatmapManagerWorkingBeatmap(Files.Store, beatmapInfo, audioManager);
 
             previous?.TransferTo(working);
 

osu.Game/Beatmaps/BeatmapManager_WorkingBeatmap.cs

@@ -4,12 +4,14 @@
 using System;
 using System.IO;
 using System.Linq;
+using osu.Framework.Audio;
 using osu.Framework.Audio.Track;
 using osu.Framework.Graphics.Textures;
 using osu.Framework.IO.Stores;
 using osu.Framework.Logging;
 using osu.Game.Beatmaps.Formats;
 using osu.Game.Graphics.Textures;
+using osu.Game.Skinning;
 using osu.Game.Storyboards;
 
 namespace osu.Game.Beatmaps
@@ -19,11 +21,13 @@ public partial class BeatmapManager
         protected class BeatmapManagerWorkingBeatmap : WorkingBeatmap
         {
             private readonly IResourceStore<byte[]> store;
+            private readonly AudioManager audioManager;
 
-            public BeatmapManagerWorkingBeatmap(IResourceStore<byte[]> store, BeatmapInfo beatmapInfo)
+            public BeatmapManagerWorkingBeatmap(IResourceStore<byte[]> store, BeatmapInfo beatmapInfo, AudioManager audioManager)
                 : base(beatmapInfo)
             {
                 this.store = store;
+                this.audioManager = audioManager;
             }
 
             protected override Beatmap GetBeatmap()
@@ -100,6 +104,22 @@ protected override Storyboard GetStoryboard()
 
                 return storyboard;
             }
+
+            protected override Skin GetSkin()
+            {
+                Skin skin;
+                try
+                {
+                    skin = new LegacyBeatmapSkin(BeatmapInfo, store, audioManager);
+                }
+                catch (Exception e)
+                {
+                    Logger.Error(e, "Skin failed to load");
+                    skin = new DefaultSkin();
+                }
+
+                return skin;
+            }
         }
     }
 }

osu.Game/Beatmaps/WorkingBeatmap.cs

@@ -14,6 +14,7 @@
 using System.IO;
 using osu.Game.IO.Serialization;
 using System.Diagnostics;
+using osu.Game.Skinning;
 
 namespace osu.Game.Beatmaps
 {
@@ -40,6 +41,7 @@ protected WorkingBeatmap(BeatmapInfo beatmapInfo)
             track = new AsyncLazy<Track>(populateTrack);
             waveform = new AsyncLazy<Waveform>(populateWaveform);
             storyboard = new AsyncLazy<Storyboard>(populateStoryboard);
+            skin = new AsyncLazy<Skin>(populateSkin);
         }
 
         /// <summary>
@@ -56,6 +58,7 @@ public void Save()
         protected abstract Beatmap GetBeatmap();
         protected abstract Texture GetBackground();
         protected abstract Track GetTrack();
+        protected virtual Skin GetSkin() => new DefaultSkin();
         protected virtual Waveform GetWaveform() => new Waveform();
         protected virtual Storyboard GetStoryboard() => new Storyboard { BeatmapInfo = BeatmapInfo };
 
@@ -109,6 +112,13 @@ private Track populateTrack()
 
         private Storyboard populateStoryboard() => GetStoryboard();
 
+        public bool SkinLoaded => skin.IsResultAvailable;
+        public Skin Skin => skin.Value.Result;
+        public async Task<Skin> GetSkinAsync() => await skin.Value;
+        private readonly AsyncLazy<Skin> skin;
+
+        private Skin populateSkin() => GetSkin();
+
         public void TransferTo(WorkingBeatmap other)
         {
             if (track.IsResultAvailable && Track != null && BeatmapInfo.AudioEquals(other.BeatmapInfo))
@@ -123,6 +133,7 @@ public virtual void Dispose()
             if (BackgroundLoaded) Background?.Dispose();
             if (WaveformLoaded) Waveform?.Dispose();
             if (StoryboardLoaded) Storyboard?.Dispose();
+            if (SkinLoaded) Skin?.Dispose();
         }
 
         /// <summary>

osu.Game/Database/IHasFiles.cs

@@ -10,6 +10,8 @@ namespace osu.Game.Database
     /// </summary>
     /// <typeparam name="TFile">The model representing a file.</typeparam>
     public interface IHasFiles<TFile>
+        where TFile : INamedFileInfo
+
     {
         List<TFile> Files { get; set; }
     }

osu.Game/OsuGameBase.cs

@@ -113,7 +113,7 @@ private void load()
 
             dependencies.Cache(RulesetStore = new RulesetStore(contextFactory));
             dependencies.Cache(FileStore = new FileStore(contextFactory, Host.Storage));
-            dependencies.Cache(BeatmapManager = new BeatmapManager(Host.Storage, contextFactory, RulesetStore, api, Host));
+            dependencies.Cache(BeatmapManager = new BeatmapManager(Host.Storage, contextFactory, RulesetStore, api, Audio, Host));
             dependencies.Cache(ScoreStore = new ScoreStore(Host.Storage, contextFactory, Host, BeatmapManager, RulesetStore));
             dependencies.Cache(KeyBindingStore = new KeyBindingStore(contextFactory, RulesetStore));
             dependencies.Cache(SettingsStore = new SettingsStore(contextFactory));

osu.Game/Skinning/LegacyBeatmapSkin.cs

@@ -0,0 +1,20 @@
+// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Audio;
+using osu.Framework.IO.Stores;
+using osu.Game.Beatmaps;
+
+namespace osu.Game.Skinning
+{
+    public class LegacyBeatmapSkin : LegacySkin
+    {
+        public LegacyBeatmapSkin(BeatmapInfo beatmap, IResourceStore<byte[]> storage, AudioManager audioManager)
+            : base(createSkinInfo(beatmap), new LegacySkinResourceStore<BeatmapSetFileInfo>(beatmap.BeatmapSet, storage), audioManager, beatmap.Path)
+        {
+        }
+
+        private static SkinInfo createSkinInfo(BeatmapInfo beatmap) =>
+            new SkinInfo { Name = beatmap.ToString(), Creator = beatmap.Metadata.Author.ToString() };
+    }
+}