osu-lazer/osu.Game/Skinning/Skin.cs

// 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.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading;
using Newtonsoft.Json;
using osu.Framework.Audio.Sample;
using osu.Framework.Bindables;
using osu.Framework.Extensions.TypeExtensions;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Textures;
using osu.Framework.IO.Stores;
using osu.Framework.Logging;
using osu.Game.Audio;
using osu.Game.Database;
using osu.Game.IO;
using osu.Game.Rulesets;
using osu.Game.Screens.Play.HUD;

namespace osu.Game.Skinning
{
    public abstract class Skin : IDisposable, ISkin
    {
        private readonly IStorageResourceProvider? resources;

        /// <summary>
        /// A texture store which can be used to perform user file lookups for this skin.
        /// </summary>
        protected TextureStore? Textures { get; }

        /// <summary>
        /// A sample store which can be used to perform user file lookups for this skin.
        /// </summary>
        protected internal ISampleStore? Samples { get; private set; }

        public readonly Live<SkinInfo> SkinInfo;

        public SkinConfiguration Configuration { get; set; }

        public IDictionary<GlobalSkinnableContainers, SkinLayoutInfo> LayoutInfos => layoutInfos;

        private readonly Dictionary<GlobalSkinnableContainers, SkinLayoutInfo> layoutInfos =
            new Dictionary<GlobalSkinnableContainers, SkinLayoutInfo>();

        public abstract ISample? GetSample(ISampleInfo sampleInfo);

        public Texture? GetTexture(string componentName) => GetTexture(componentName, default, default);

        public abstract Texture? GetTexture(string componentName, WrapMode wrapModeS, WrapMode wrapModeT);

        public abstract IBindable<TValue>? GetConfig<TLookup, TValue>(TLookup lookup)
            where TLookup : notnull
            where TValue : notnull;

        private readonly ResourceStore<byte[]> store = new ResourceStore<byte[]>();

        public string Name { get; }

        protected IResourceStore<byte[]>? FallbackStore { get; }

        /// <summary>
        /// Construct a new skin.
        /// </summary>
        /// <param name="skin">The skin's metadata. Usually a live realm object.</param>
        /// <param name="resources">Access to game-wide resources.</param>
        /// <param name="fallbackStore">An optional fallback store which will be used for file lookups that are not serviced by realm user storage.</param>
        /// <param name="configurationFilename">An optional filename to read the skin configuration from. If not provided, the configuration will be retrieved from the storage using "skin.ini".</param>
        protected Skin(SkinInfo skin, IStorageResourceProvider? resources, IResourceStore<byte[]>? fallbackStore = null, string configurationFilename = @"skin.ini")
        {
            this.resources = resources;

            Name = skin.Name;

            if (resources != null)
            {
                SkinInfo = skin.ToLive(resources.RealmAccess);

                store.AddStore(new RealmBackedResourceStore<SkinInfo>(SkinInfo, resources.Files, resources.RealmAccess));

                RecycleSamples();
                Textures = new TextureStore(resources.Renderer, CreateTextureLoaderStore(resources, store));
            }
            else
            {
                // Generally only used for tests.
                SkinInfo = skin.ToLiveUnmanaged();
            }

            FallbackStore = fallbackStore;
            if (fallbackStore != null)
                store.AddStore(fallbackStore);

            var configurationStream = store.GetStream(configurationFilename);

            if (configurationStream != null)
            {
                // stream will be closed after use by LineBufferedReader.
                ParseConfigurationStream(configurationStream);
                Debug.Assert(Configuration != null);
            }
            else
            {
                Configuration = new SkinConfiguration
                {
                    // generally won't be hit as we always write a `skin.ini` on import, but best be safe than sorry.
                    // see https://github.com/peppy/osu-stable-reference/blob/1531237b63392e82c003c712faa028406073aa8f/osu!/Graphics/Skinning/SkinManager.cs#L297-L298
                    LegacyVersion = SkinConfiguration.LATEST_VERSION,
                };
            }

            // skininfo files may be null for default skin.
            foreach (GlobalSkinnableContainers skinnableTarget in Enum.GetValues<GlobalSkinnableContainers>())
            {
                string filename = $"{skinnableTarget}.json";

                byte[]? bytes = store?.Get(filename);

                if (bytes == null)
                    continue;

                try
                {
                    string jsonContent = Encoding.UTF8.GetString(bytes);

                    var layoutInfo = parseLayoutInfo(jsonContent, skinnableTarget);
                    if (layoutInfo == null)
                        continue;

                    LayoutInfos[skinnableTarget] = layoutInfo;
                }
                catch (Exception ex)
                {
                    Logger.Error(ex, "Failed to load skin configuration.");
                }
            }
        }

        /// <summary>
        /// Recreates <see cref="Samples"/>.
        /// All users of samples from the skin are expected to manually re-retrieve their samples from this skin after this is called.
        /// Exposed as public for the purpose of e.g. editing flows where the skin's set of available samples changes.
        /// In such a scenario a full recycle of the store is required to avoid accidentally retrieving stale samples that don't exist in the skin anymore.
        /// </summary>
        public void RecycleSamples()
        {
            Samples?.Dispose();

            var samples = resources?.AudioManager?.GetSampleStore(store);

            if (samples != null)
            {
                samples.PlaybackConcurrency = OsuGameBase.SAMPLE_CONCURRENCY;

                // osu-stable performs audio lookups in order of wav -> mp3 -> ogg.
                // The GetSampleStore() call above internally adds wav and mp3, so ogg is added at the end to ensure expected ordering.
                samples.AddExtension(@"ogg");
            }

            Samples = samples;
        }

        protected virtual IResourceStore<TextureUpload> CreateTextureLoaderStore(IStorageResourceProvider resources, IResourceStore<byte[]> storage)
            => new MaxDimensionLimitedTextureLoaderStore(resources.CreateTextureLoaderStore(storage));

        protected virtual void ParseConfigurationStream(Stream stream)
        {
            using (LineBufferedReader reader = new LineBufferedReader(stream, true))
                Configuration = new LegacySkinDecoder().Decode(reader);
        }

        /// <summary>
        /// Remove all stored customisations for the provided target.
        /// </summary>
        /// <param name="targetContainer">The target container to reset.</param>
        public void ResetDrawableTarget(SkinnableContainer targetContainer)
        {
            LayoutInfos.Remove(targetContainer.Lookup.Lookup);
        }

        /// <summary>
        /// Update serialised information for the provided target.
        /// </summary>
        /// <param name="targetContainer">The target container to serialise to this skin.</param>
        public void UpdateDrawableTarget(SkinnableContainer targetContainer)
        {
            if (!LayoutInfos.TryGetValue(targetContainer.Lookup.Lookup, out var layoutInfo))
                layoutInfos[targetContainer.Lookup.Lookup] = layoutInfo = new SkinLayoutInfo();

            layoutInfo.Update(targetContainer.Lookup.Ruleset, ((ISerialisableDrawableContainer)targetContainer).CreateSerialisedInfo().ToArray());
        }

        public virtual Drawable? GetDrawableComponent(ISkinComponentLookup lookup)
        {
            switch (lookup)
            {
                // This fallback is important for user skins which use SkinnableSprites.
                case SkinnableSprite.SpriteComponentLookup sprite:
                    return this.GetAnimation(sprite.LookupName, false, false, maxSize: sprite.MaxSize);

                case UserSkinComponentLookup userLookup:
                    switch (userLookup.Component)
                    {
                        case GlobalSkinnableContainerLookup containerLookup:
                            // It is important to return null if the user has not configured this yet.
                            // This allows skin transformers the opportunity to provide default components.
                            if (!LayoutInfos.TryGetValue(containerLookup.Lookup, out var layoutInfo)) return null;
                            if (!layoutInfo.TryGetDrawableInfo(containerLookup.Ruleset, out var drawableInfos)) return null;

                            return new Container
                            {
                                RelativeSizeAxes = Axes.Both,
                                ChildrenEnumerable = drawableInfos.Select(i => i.CreateInstance())
                            };
                    }

                    break;
            }

            return null;
        }

        #region Deserialisation & Migration

        private SkinLayoutInfo? parseLayoutInfo(string jsonContent, GlobalSkinnableContainers target)
        {
            SkinLayoutInfo? layout = null;

            // handle namespace changes...
            jsonContent = jsonContent.Replace(@"osu.Game.Screens.Play.SongProgress", @"osu.Game.Screens.Play.HUD.DefaultSongProgress");
            jsonContent = jsonContent.Replace(@"osu.Game.Screens.Play.HUD.LegacyComboCounter", @"osu.Game.Skinning.LegacyComboCounter");
            jsonContent = jsonContent.Replace(@"osu.Game.Skinning.LegacyComboCounter", @"osu.Game.Skinning.LegacyDefaultComboCounter");
            jsonContent = jsonContent.Replace(@"osu.Game.Screens.Play.HUD.PerformancePointsCounter", @"osu.Game.Skinning.Triangles.TrianglesPerformancePointsCounter");
            jsonContent = jsonContent.Replace(@"osu.Game.Screens.Play.HUD.UnstableRateCounter", @"osu.Game.Skinning.Triangles.TrianglesUnstableRateCounter");

            try
            {
                // First attempt to deserialise using the new SkinLayoutInfo format
                layout = JsonConvert.DeserializeObject<SkinLayoutInfo>(jsonContent);
            }
            catch (Exception ex)
            {
                Logger.Log($"Deserialising skin layout to {nameof(SkinLayoutInfo)} failed. Falling back to {nameof(SerialisedDrawableInfo)}[].\nDetails: {ex}");
            }

            // If deserialisation using SkinLayoutInfo fails, attempt to deserialise using the old naked list.
            if (layout == null)
            {
                var deserializedContent = JsonConvert.DeserializeObject<IEnumerable<SerialisedDrawableInfo>>(jsonContent);
                if (deserializedContent == null)
                    return null;

                layout = new SkinLayoutInfo { Version = 0 };
                layout.Update(null, deserializedContent.ToArray());

                Logger.Log($"Ferrying {deserializedContent.Count()} components in {target} to global section of new {nameof(SkinLayoutInfo)} format");
            }

            for (int i = layout.Version + 1; i <= SkinLayoutInfo.LATEST_VERSION; i++)
                applyMigration(layout, target, i);

            layout.Version = SkinLayoutInfo.LATEST_VERSION;

            foreach (var kvp in layout.DrawableInfo.ToArray())
            {
                foreach (var di in kvp.Value)
                {
                    if (!isValidDrawable(di))
                        layout.DrawableInfo[kvp.Key] = kvp.Value.Where(i => i.Type != di.Type).ToArray();
                }
            }

            return layout;
        }

        private bool isValidDrawable(SerialisedDrawableInfo di)
        {
            if (!typeof(ISerialisableDrawable).IsAssignableFrom(di.Type))
                return false;

            foreach (var child in di.Children)
            {
                if (!isValidDrawable(child))
                    return false;
            }

            return true;
        }

        private void applyMigration(SkinLayoutInfo layout, GlobalSkinnableContainers target, int version)
        {
            switch (version)
            {
                case 1:
                {
                    // Combo counters were moved out of the global HUD components into per-ruleset.
                    // This is to allow some rulesets to customise further (ie. mania and catch moving the combo to within their play area).
                    if (target != GlobalSkinnableContainers.MainHUDComponents ||
                        !layout.TryGetDrawableInfo(null, out var globalHUDComponents) ||
                        resources == null)
                        break;

                    var comboCounters = globalHUDComponents.Where(c =>
                        c.Type.Name == nameof(LegacyDefaultComboCounter) ||
                        c.Type.Name == nameof(DefaultComboCounter) ||
                        c.Type.Name == nameof(ArgonComboCounter)).ToArray();

                    layout.Update(null, globalHUDComponents.Except(comboCounters).ToArray());

                    resources.RealmAccess.Run(r =>
                    {
                        foreach (var ruleset in r.All<RulesetInfo>())
                        {
                            layout.Update(ruleset, layout.TryGetDrawableInfo(ruleset, out var rulesetHUDComponents)
                                ? rulesetHUDComponents.Concat(comboCounters).ToArray()
                                : comboCounters);
                        }
                    });

                    break;
                }
            }
        }

        #endregion

        #region Disposal

        ~Skin()
        {
            // required to potentially clean up sample store from audio hierarchy.
            Dispose(false);
        }

        public void Dispose()
        {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

        private bool isDisposed;

        protected virtual void Dispose(bool isDisposing)
        {
            if (isDisposed)
                return;

            isDisposed = true;

            Textures?.Dispose();
            Samples?.Dispose();
            FallbackStore?.Dispose();

            store.Dispose();
        }

        #endregion

        public override string ToString() => $"{GetType().ReadableName()} {{ Name: {Name} }}";

        private static readonly ThreadLocal<int> nested_level = new ThreadLocal<int>(() => 0);

        [Conditional("SKIN_LOOKUP_DEBUG")]
        internal static void LogLookupDebug(object callingClass, object lookup, LookupDebugType type, [CallerMemberName] string callerMethod = "")
        {
            string icon = string.Empty;
            int level = nested_level.Value;

            switch (type)
            {
                case LookupDebugType.Hit:
                    icon = "🟢 hit";
                    break;

                case LookupDebugType.Miss:
                    icon = "🔴 miss";
                    break;

                case LookupDebugType.Enter:
                    nested_level.Value++;
                    break;

                case LookupDebugType.Exit:
                    nested_level.Value--;
                    if (nested_level.Value == 0)
                        Logger.Log(string.Empty);
                    return;
            }

            string lookupString = lookup.ToString() ?? string.Empty;
            string callingClassString = callingClass.ToString() ?? string.Empty;

            Logger.Log($"{string.Join(null, Enumerable.Repeat("|-", level))}{callingClassString}.{callerMethod}(lookup: {lookupString}) {icon}");
        }

        internal enum LookupDebugType
        {
            Hit,
            Miss,
            Enter,
            Exit
        }
    }
}