mirror of
https://github.com/ppy/osu.git
synced 2024-12-24 23:12:54 +08:00
241 lines
8.2 KiB
C#
241 lines
8.2 KiB
C#
// 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 osu.Framework.Extensions;
|
|
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
|
|
{
|
|
public abstract class LegacyDecoder<T> : Decoder<T>
|
|
where T : new()
|
|
{
|
|
public const int LATEST_VERSION = 14;
|
|
|
|
protected readonly int FormatVersion;
|
|
|
|
protected LegacyDecoder(int version)
|
|
{
|
|
FormatVersion = version;
|
|
}
|
|
|
|
protected override void ParseStreamInto(LineBufferedReader stream, T output)
|
|
{
|
|
Section section = Section.General;
|
|
|
|
string? line;
|
|
|
|
while ((line = stream.ReadLine()) != null)
|
|
{
|
|
if (ShouldSkipLine(line))
|
|
continue;
|
|
|
|
if (section != Section.Metadata)
|
|
{
|
|
// comments should not be stripped from metadata lines, as the song metadata may contain "//" as valid data.
|
|
line = StripComments(line);
|
|
}
|
|
|
|
line = line.TrimEnd();
|
|
|
|
if (line.StartsWith('[') && line.EndsWith(']'))
|
|
{
|
|
if (!Enum.TryParse(line[1..^1], out section))
|
|
Logger.Log($"Unknown section \"{line}\" in \"{output}\"");
|
|
|
|
OnBeginNewSection(section);
|
|
continue;
|
|
}
|
|
|
|
try
|
|
{
|
|
ParseLine(output, section, line);
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
Logger.Log($"Failed to process line \"{line}\" into \"{output}\": {e.Message}");
|
|
}
|
|
}
|
|
}
|
|
|
|
protected virtual bool ShouldSkipLine(string line) => string.IsNullOrWhiteSpace(line) || line.AsSpan().TrimStart().StartsWith("//".AsSpan(), StringComparison.Ordinal);
|
|
|
|
/// <summary>
|
|
/// Invoked when a new <see cref="Section"/> has been entered.
|
|
/// </summary>
|
|
/// <param name="section">The entered <see cref="Section"/>.</param>
|
|
protected virtual void OnBeginNewSection(Section section)
|
|
{
|
|
}
|
|
|
|
protected virtual void ParseLine(T output, Section section, string line)
|
|
{
|
|
switch (section)
|
|
{
|
|
case Section.Colours:
|
|
HandleColours(output, line);
|
|
return;
|
|
}
|
|
}
|
|
|
|
protected string StripComments(string line)
|
|
{
|
|
int index = line.AsSpan().IndexOf("//".AsSpan());
|
|
if (index > 0)
|
|
return line.Substring(0, index);
|
|
|
|
return line;
|
|
}
|
|
|
|
protected void HandleColours<TModel>(TModel output, string line)
|
|
{
|
|
var pair = SplitKeyVal(line);
|
|
|
|
bool isCombo = pair.Key.StartsWith(@"Combo", StringComparison.Ordinal);
|
|
|
|
string[] split = pair.Value.Split(',');
|
|
|
|
if (split.Length != 3 && split.Length != 4)
|
|
throw new InvalidOperationException($@"Color specified in incorrect format (should be R,G,B or R,G,B,A): {pair.Value}");
|
|
|
|
Color4 colour;
|
|
|
|
try
|
|
{
|
|
byte alpha = split.Length == 4 ? byte.Parse(split[3]) : (byte)255;
|
|
colour = new Color4(byte.Parse(split[0]), byte.Parse(split[1]), byte.Parse(split[2]), alpha);
|
|
}
|
|
catch
|
|
{
|
|
throw new InvalidOperationException(@"Color must be specified with 8-bit integer components");
|
|
}
|
|
|
|
if (isCombo)
|
|
{
|
|
if (!(output is IHasComboColours tHasComboColours)) return;
|
|
|
|
tHasComboColours.CustomComboColours.Add(colour);
|
|
}
|
|
else
|
|
{
|
|
if (!(output is IHasCustomColours tHasCustomColours)) return;
|
|
|
|
tHasCustomColours.CustomColours[pair.Key] = colour;
|
|
}
|
|
}
|
|
|
|
protected KeyValuePair<string, string> SplitKeyVal(string line, char separator = ':')
|
|
{
|
|
string[] split = line.Split(separator, 2);
|
|
|
|
return new KeyValuePair<string, string>
|
|
(
|
|
split[0].Trim(),
|
|
split.Length > 1 ? split[1].Trim() : string.Empty
|
|
);
|
|
}
|
|
|
|
protected string CleanFilename(string path) => path.Trim('"').ToStandardisedPath();
|
|
|
|
public enum Section
|
|
{
|
|
General,
|
|
Editor,
|
|
Metadata,
|
|
Difficulty,
|
|
Events,
|
|
TimingPoints,
|
|
Colours,
|
|
HitObjects,
|
|
Variables,
|
|
Fonts,
|
|
CatchTheBeat,
|
|
Mania,
|
|
}
|
|
|
|
[Obsolete("Do not use unless you're a legacy ruleset and 100% sure.")]
|
|
public class LegacyDifficultyControlPoint : DifficultyControlPoint, IEquatable<LegacyDifficultyControlPoint>
|
|
{
|
|
/// <summary>
|
|
/// Legacy BPM multiplier that introduces floating-point errors for rulesets that depend on it.
|
|
/// DO NOT USE THIS UNLESS 100% SURE.
|
|
/// </summary>
|
|
public double BpmMultiplier { get; private set; }
|
|
|
|
public LegacyDifficultyControlPoint(double beatLength)
|
|
: this()
|
|
{
|
|
// Note: In stable, the division occurs on floats, but with compiler optimisations turned on actually seems to occur on doubles via some .NET black magic (possibly inlining?).
|
|
BpmMultiplier = beatLength < 0 ? Math.Clamp((float)-beatLength, 10, 10000) / 100.0 : 1;
|
|
}
|
|
|
|
public LegacyDifficultyControlPoint()
|
|
{
|
|
SliderVelocityBindable.Precision = double.Epsilon;
|
|
}
|
|
|
|
public override void CopyFrom(ControlPoint other)
|
|
{
|
|
base.CopyFrom(other);
|
|
|
|
BpmMultiplier = ((LegacyDifficultyControlPoint)other).BpmMultiplier;
|
|
}
|
|
|
|
public override bool Equals(ControlPoint? other)
|
|
=> other is LegacyDifficultyControlPoint otherLegacyDifficultyControlPoint
|
|
&& Equals(otherLegacyDifficultyControlPoint);
|
|
|
|
public bool Equals(LegacyDifficultyControlPoint? other)
|
|
=> base.Equals(other)
|
|
&& BpmMultiplier == other.BpmMultiplier;
|
|
|
|
// ReSharper disable once NonReadonlyMemberInGetHashCode
|
|
public override int GetHashCode() => HashCode.Combine(base.GetHashCode(), BpmMultiplier);
|
|
}
|
|
|
|
internal class LegacySampleControlPoint : SampleControlPoint, IEquatable<LegacySampleControlPoint>
|
|
{
|
|
public int CustomSampleBank;
|
|
|
|
public override HitSampleInfo ApplyTo(HitSampleInfo hitSampleInfo)
|
|
{
|
|
var baseInfo = base.ApplyTo(hitSampleInfo);
|
|
|
|
if (baseInfo is ConvertHitObjectParser.LegacyHitSampleInfo legacy && legacy.CustomSampleBank == 0)
|
|
return legacy.With(newCustomSampleBank: CustomSampleBank);
|
|
|
|
return baseInfo;
|
|
}
|
|
|
|
public override bool IsRedundant(ControlPoint? existing)
|
|
=> base.IsRedundant(existing)
|
|
&& existing is LegacySampleControlPoint existingSample
|
|
&& CustomSampleBank == existingSample.CustomSampleBank;
|
|
|
|
public override void CopyFrom(ControlPoint other)
|
|
{
|
|
base.CopyFrom(other);
|
|
|
|
CustomSampleBank = ((LegacySampleControlPoint)other).CustomSampleBank;
|
|
}
|
|
|
|
public override bool Equals(ControlPoint? other)
|
|
=> other is LegacySampleControlPoint otherLegacySampleControlPoint
|
|
&& Equals(otherLegacySampleControlPoint);
|
|
|
|
public bool Equals(LegacySampleControlPoint? other)
|
|
=> base.Equals(other)
|
|
&& CustomSampleBank == other.CustomSampleBank;
|
|
|
|
// ReSharper disable once NonReadonlyMemberInGetHashCode
|
|
public override int GetHashCode() => HashCode.Combine(base.GetHashCode(), CustomSampleBank);
|
|
}
|
|
}
|
|
}
|