// Copyright (c) ppy Pty Ltd . 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 osu.Framework.Allocation; using osu.Framework.Audio; using osu.Framework.Audio.Sample; using osu.Framework.Bindables; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Sprites; using osu.Framework.Graphics.Textures; using osu.Framework.IO.Stores; using osu.Game.Database; using osu.Game.Graphics; using osu.Game.Graphics.Sprites; using osu.Game.Rulesets.Objects.Drawables; using osu.Game.Rulesets.Objects.Types; using osu.Game.Rulesets.UI; using osuTK; using osuTK.Graphics; namespace osu.Game.Skinning { public class LegacySkin : Skin { protected TextureStore Textures; protected IResourceStore Samples; /// /// On osu-stable, hitcircles have 5 pixels of transparent padding on each side to allow for shadows etc. /// Their hittable area is 128px, but the actual circle portion is 118px. /// We must account for some gameplay elements such as slider bodies, where this padding is not present. /// private const float legacy_circle_radius = 64 - 5; public LegacySkin(SkinInfo skin, IResourceStore storage, AudioManager audioManager) : this(skin, new LegacySkinResourceStore(skin, storage), audioManager, "skin.ini") { } private readonly bool hasHitCircle; protected LegacySkin(SkinInfo skin, IResourceStore storage, AudioManager audioManager, string filename) : base(skin) { Stream stream = storage.GetStream(filename); if (stream != null) using (StreamReader reader = new StreamReader(stream)) Configuration = new LegacySkinDecoder().Decode(reader); else Configuration = new SkinConfiguration(); Samples = audioManager.GetSampleStore(storage); Textures = new TextureStore(new TextureLoaderStore(storage)); using (var testStream = storage.GetStream("hitcircle")) hasHitCircle |= testStream != null; if (hasHitCircle) { Configuration.SliderPathRadius = legacy_circle_radius; } } protected override void Dispose(bool isDisposing) { base.Dispose(isDisposing); Textures?.Dispose(); Samples?.Dispose(); } public override Drawable GetDrawableComponent(string componentName) { switch (componentName) { case "Play/osu/cursor": if (GetTexture("cursor") != null) return new LegacyCursor(); return null; case "Play/osu/sliderball": if (GetTexture("sliderb") != null) return new LegacySliderBall(); return null; case "Play/osu/hitcircle": if (hasHitCircle) return new LegacyMainCirclePiece(); return null; case "Play/Miss": componentName = "hit0"; break; case "Play/Meh": componentName = "hit50"; break; case "Play/Good": componentName = "hit100"; break; case "Play/Great": componentName = "hit300"; break; case "Play/osu/number-text": return !hasFont(Configuration.HitCircleFont) ? null : new LegacySpriteText(Textures, Configuration.HitCircleFont) { Scale = new Vector2(0.96f), // Spacing value was reverse-engineered from the ratio of the rendered sprite size in the visual inspector vs the actual texture size Spacing = new Vector2(-Configuration.HitCircleOverlap * 0.89f, 0) }; } // temporary allowance is given for skins the fact that stable handles non-animatable items such as hitcircles (incorrectly) // by (incorrectly) displaying the first frame of animation rather than the non-animated version. // users have used this to "hide" certain elements like hit300. var texture = GetTexture($"{componentName}-0") ?? GetTexture(componentName); if (texture == null) return null; return new Sprite { Texture = texture }; } public class LegacySliderBall : Sprite { [BackgroundDependencyLoader] private void load(ISkinSource skin) { Texture = skin.GetTexture("sliderb"); Colour = skin.GetValue(s => s.CustomColours.ContainsKey("SliderBall") ? s.CustomColours["SliderBall"] : (Color4?)null) ?? Color4.White; } } public override Texture GetTexture(string componentName) { float ratio = 2; var texture = Textures.Get($"{componentName}@2x"); if (texture == null) { ratio = 1; texture = Textures.Get(componentName); } if (texture != null) texture.ScaleAdjust = ratio; return texture; } public override SampleChannel GetSample(string sampleName) => Samples.Get(sampleName); private bool hasFont(string fontName) => GetTexture($"{fontName}-0") != null; protected class LegacySkinResourceStore : IResourceStore where T : INamedFileInfo { private readonly IHasFiles source; private readonly IResourceStore underlyingStore; private string getPathForFile(string filename) { bool hasExtension = filename.Contains('.'); string lastPiece = filename.Split('/').Last(); var legacyName = filename.StartsWith("Gameplay/taiko/") ? "taiko-" + lastPiece : lastPiece; var file = source.Files.Find(f => string.Equals(hasExtension ? f.Filename : Path.ChangeExtension(f.Filename, null), legacyName, StringComparison.InvariantCultureIgnoreCase)); return file?.FileInfo.StoragePath; } public LegacySkinResourceStore(IHasFiles source, IResourceStore underlyingStore) { this.source = source; this.underlyingStore = underlyingStore; } public Stream GetStream(string name) { string path = getPathForFile(name); return path == null ? null : underlyingStore.GetStream(path); } public IEnumerable GetAvailableResources() => source.Files.Select(f => f.Filename); byte[] IResourceStore.Get(string name) => GetAsync(name).Result; public Task GetAsync(string name) { string path = getPathForFile(name); return path == null ? Task.FromResult(null) : underlyingStore.GetAsync(path); } #region IDisposable Support private bool isDisposed; protected virtual void Dispose(bool disposing) { if (!isDisposed) { isDisposed = true; } } ~LegacySkinResourceStore() { Dispose(false); } public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } #endregion } private class LegacySpriteText : OsuSpriteText { private readonly TextureStore textures; private readonly string font; public LegacySpriteText(TextureStore textures, string font) { this.textures = textures; this.font = font; Shadow = false; UseFullGlyphHeight = false; } protected override Texture GetTextureForCharacter(char c) { string textureName = $"{font}-{c}"; // Approximate value that brings character sizing roughly in-line with stable float ratio = 36; var texture = textures.Get($"{textureName}@2x"); if (texture == null) { ratio = 18; texture = textures.Get(textureName); } if (texture != null) texture.ScaleAdjust = ratio; return texture; } } public class LegacyCursor : CompositeDrawable { public LegacyCursor() { Size = new Vector2(50); Anchor = Anchor.Centre; Origin = Anchor.Centre; } [BackgroundDependencyLoader] private void load(ISkinSource skin) { InternalChildren = new Drawable[] { new NonPlayfieldSprite { Texture = skin.GetTexture("cursormiddle"), Anchor = Anchor.Centre, Origin = Anchor.Centre, }, new NonPlayfieldSprite { Texture = skin.GetTexture("cursor"), Anchor = Anchor.Centre, Origin = Anchor.Centre, } }; } } public class LegacyMainCirclePiece : CompositeDrawable { public LegacyMainCirclePiece() { Size = new Vector2(128); } private readonly IBindable state = new Bindable(); private readonly Bindable accentColour = new Bindable(); [BackgroundDependencyLoader] private void load(DrawableHitObject drawableObject, ISkinSource skin) { Sprite hitCircleSprite; InternalChildren = new Drawable[] { hitCircleSprite = new Sprite { Texture = skin.GetTexture("hitcircle"), Colour = drawableObject.AccentColour.Value, Anchor = Anchor.Centre, Origin = Anchor.Centre, }, new SkinnableSpriteText("Play/osu/number-text", _ => new OsuSpriteText { Font = OsuFont.Numeric.With(size: 40), UseFullGlyphHeight = false, }, confineMode: ConfineMode.NoScaling) { Text = (((IHasComboInformation)drawableObject.HitObject).IndexInCurrentCombo + 1).ToString() }, new Sprite { Texture = skin.GetTexture("hitcircleoverlay"), Anchor = Anchor.Centre, Origin = Anchor.Centre, } }; state.BindTo(drawableObject.State); state.BindValueChanged(updateState, true); accentColour.BindTo(drawableObject.AccentColour); accentColour.BindValueChanged(colour => hitCircleSprite.Colour = colour.NewValue, true); } private void updateState(ValueChangedEvent state) { const double legacy_fade_duration = 240; switch (state.NewValue) { case ArmedState.Hit: this.FadeOut(legacy_fade_duration, Easing.Out); this.ScaleTo(1.4f, legacy_fade_duration, Easing.Out); break; } } } /// /// A sprite which is displayed within the playfield, but historically was not considered part of the playfield. /// Performs scale adjustment to undo the scale applied by (osu! ruleset specifically). /// private class NonPlayfieldSprite : Sprite { public override Texture Texture { get => base.Texture; set { if (value != null) // stable "magic ratio". see OsuPlayfieldAdjustmentContainer for full explanation. value.ScaleAdjust *= 1.6f; base.Texture = value; } } } } }