1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-16 06:52:55 +08:00
osu-lazer/osu.Game/Skinning/Skin.cs

176 lines
6.0 KiB
C#
Raw Normal View History

// 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.
2018-04-13 17:19:50 +08:00
using System;
2021-05-10 21:43:48 +08:00
using System.Collections.Generic;
using System.IO;
2021-05-10 21:43:48 +08:00
using System.Linq;
using System.Text;
using JetBrains.Annotations;
2021-05-10 21:43:48 +08:00
using Newtonsoft.Json;
2018-04-13 17:19:50 +08:00
using osu.Framework.Audio.Sample;
using osu.Framework.Bindables;
2018-04-13 17:19:50 +08:00
using osu.Framework.Graphics;
2020-07-17 15:54:30 +08:00
using osu.Framework.Graphics.OpenGL.Textures;
2018-04-13 17:19:50 +08:00
using osu.Framework.Graphics.Textures;
using osu.Framework.Logging;
2019-08-23 19:32:43 +08:00
using osu.Game.Audio;
2021-11-29 17:02:09 +08:00
using osu.Game.Database;
using osu.Game.Extensions;
2021-05-10 21:43:48 +08:00
using osu.Game.IO;
using osu.Game.Screens.Play.HUD;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Skinning
{
2019-04-25 16:36:17 +08:00
public abstract class Skin : IDisposable, ISkin
2018-04-13 17:19:50 +08:00
{
public readonly Live<SkinInfo> SkinInfo;
private readonly IStorageResourceProvider resources;
2018-04-13 17:19:50 +08:00
public SkinConfiguration Configuration { get; set; }
2018-04-13 17:19:50 +08:00
2021-05-10 21:43:48 +08:00
public IDictionary<SkinnableTarget, SkinnableInfo[]> DrawableComponentInfo => drawableComponentInfo;
private readonly Dictionary<SkinnableTarget, SkinnableInfo[]> drawableComponentInfo = new Dictionary<SkinnableTarget, SkinnableInfo[]>();
2018-04-13 17:19:50 +08:00
public abstract ISample GetSample(ISampleInfo sampleInfo);
2018-04-13 17:19:50 +08:00
2020-07-17 15:54:30 +08:00
public Texture GetTexture(string componentName) => GetTexture(componentName, default, default);
public abstract Texture GetTexture(string componentName, WrapMode wrapModeS, WrapMode wrapModeT);
2018-04-13 17:19:50 +08:00
public abstract IBindable<TValue> GetConfig<TLookup, TValue>(TLookup lookup);
2018-04-13 17:19:50 +08:00
protected Skin(SkinInfo skin, IStorageResourceProvider resources, [CanBeNull] Stream configurationStream = null)
2018-04-13 17:19:50 +08:00
{
SkinInfo = resources?.RealmAccess != null
? skin.ToLive(resources.RealmAccess)
// This path should only be used in some tests.
: skin.ToLiveUnmanaged();
this.resources = resources;
configurationStream ??= getConfigurationStream();
if (configurationStream != null)
2021-10-24 22:43:37 +08:00
// stream will be closed after use by LineBufferedReader.
ParseConfigurationStream(configurationStream);
else
Configuration = new SkinConfiguration();
2021-05-10 21:43:48 +08:00
2021-11-29 17:02:09 +08:00
// skininfo files may be null for default skin.
SkinInfo.PerformRead(s =>
{
2021-11-29 17:02:09 +08:00
// we may want to move this to some kind of async operation in the future.
foreach (SkinnableTarget skinnableTarget in Enum.GetValues(typeof(SkinnableTarget)))
{
string filename = $"{skinnableTarget}.json";
2021-11-29 17:02:09 +08:00
// skininfo files may be null for default skin.
var fileInfo = s.Files.FirstOrDefault(f => f.Filename == filename);
2021-11-29 17:02:09 +08:00
if (fileInfo == null)
continue;
2021-11-29 17:02:09 +08:00
byte[] bytes = resources?.Files.Get(fileInfo.File.GetStoragePath());
2021-11-29 17:02:09 +08:00
if (bytes == null)
continue;
2021-11-29 17:02:09 +08:00
try
{
string jsonContent = Encoding.UTF8.GetString(bytes);
var deserializedContent = JsonConvert.DeserializeObject<IEnumerable<SkinnableInfo>>(jsonContent);
2021-11-29 17:02:09 +08:00
if (deserializedContent == null)
continue;
2021-11-29 17:02:09 +08:00
DrawableComponentInfo[skinnableTarget] = deserializedContent.ToArray();
}
catch (Exception ex)
{
Logger.Error(ex, "Failed to load skin configuration.");
}
}
2021-11-29 17:02:09 +08:00
});
}
protected virtual void ParseConfigurationStream(Stream stream)
{
using (LineBufferedReader reader = new LineBufferedReader(stream, true))
Configuration = new LegacySkinDecoder().Decode(reader);
}
private Stream getConfigurationStream()
{
2021-11-29 17:02:09 +08:00
string path = SkinInfo.PerformRead(s => s.Files.SingleOrDefault(f => f.Filename.Equals(@"skin.ini", StringComparison.OrdinalIgnoreCase))?.File.GetStoragePath());
if (string.IsNullOrEmpty(path))
return null;
return resources?.Files.GetStream(path);
}
2021-05-13 12:09:33 +08:00
/// <summary>
/// Remove all stored customisations for the provided target.
/// </summary>
/// <param name="targetContainer">The target container to reset.</param>
public void ResetDrawableTarget(ISkinnableTarget targetContainer)
{
DrawableComponentInfo.Remove(targetContainer.Target);
2021-05-10 21:43:48 +08:00
}
2021-05-13 12:09:33 +08:00
/// <summary>
/// Update serialised information for the provided target.
/// </summary>
/// <param name="targetContainer">The target container to serialise to this skin.</param>
public void UpdateDrawableTarget(ISkinnableTarget targetContainer)
2021-05-10 21:43:48 +08:00
{
DrawableComponentInfo[targetContainer.Target] = targetContainer.CreateSkinnableInfo().ToArray();
2021-05-10 21:43:48 +08:00
}
public virtual Drawable GetDrawableComponent(ISkinComponent component)
{
switch (component)
{
case SkinnableTargetComponent target:
2021-05-13 12:09:33 +08:00
if (!DrawableComponentInfo.TryGetValue(target.Target, out var skinnableInfo))
2021-05-10 21:43:48 +08:00
return null;
return new SkinnableTargetComponentsContainer
2021-05-10 21:43:48 +08:00
{
ChildrenEnumerable = skinnableInfo.Select(i => i.CreateInstance())
};
}
return null;
2018-04-13 17:19:50 +08:00
}
#region Disposal
~Skin()
{
// required to potentially clean up sample store from audio hierarchy.
2018-04-13 17:19:50 +08:00
Dispose(false);
}
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
private bool isDisposed;
protected virtual void Dispose(bool isDisposing)
{
if (isDisposed)
return;
2019-02-28 12:31:40 +08:00
2018-04-13 17:19:50 +08:00
isDisposed = true;
}
#endregion
}
}