mirror of
https://github.com/ppy/osu.git
synced 2024-12-25 16:12:55 +08:00
509 lines
18 KiB
C#
509 lines
18 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 System.IO;
|
|
using System.Linq;
|
|
using osu.Framework.Extensions;
|
|
using osu.Framework.Extensions.EnumExtensions;
|
|
using osu.Framework.Logging;
|
|
using osu.Game.Beatmaps.ControlPoints;
|
|
using osu.Game.Beatmaps.Legacy;
|
|
using osu.Game.Beatmaps.Timing;
|
|
using osu.Game.IO;
|
|
using osu.Game.Rulesets;
|
|
using osu.Game.Rulesets.Objects.Legacy;
|
|
|
|
namespace osu.Game.Beatmaps.Formats
|
|
{
|
|
public class LegacyBeatmapDecoder : LegacyDecoder<Beatmap>
|
|
{
|
|
/// <summary>
|
|
/// An offset which needs to be applied to old beatmaps (v4 and lower) to correct timing changes that were applied at a game client level.
|
|
/// </summary>
|
|
public const int EARLY_VERSION_TIMING_OFFSET = 24;
|
|
|
|
internal static RulesetStore RulesetStore;
|
|
|
|
private Beatmap beatmap;
|
|
|
|
private ConvertHitObjectParser parser;
|
|
|
|
private LegacySampleBank defaultSampleBank;
|
|
private int defaultSampleVolume = 100;
|
|
|
|
public static void Register()
|
|
{
|
|
AddDecoder<Beatmap>(@"osu file format v", m => new LegacyBeatmapDecoder(Parsing.ParseInt(m.Split('v').Last())));
|
|
SetFallbackDecoder<Beatmap>(() => new LegacyBeatmapDecoder());
|
|
}
|
|
|
|
/// <summary>
|
|
/// Whether or not beatmap or runtime offsets should be applied. Defaults on; only disable for testing purposes.
|
|
/// </summary>
|
|
public bool ApplyOffsets = true;
|
|
|
|
private readonly int offset;
|
|
|
|
public LegacyBeatmapDecoder(int version = LATEST_VERSION)
|
|
: base(version)
|
|
{
|
|
if (RulesetStore == null)
|
|
{
|
|
Logger.Log($"A {nameof(RulesetStore)} was not provided via {nameof(Decoder)}.{nameof(RegisterDependencies)}; falling back to default {nameof(AssemblyRulesetStore)}.");
|
|
RulesetStore = new AssemblyRulesetStore();
|
|
}
|
|
|
|
offset = FormatVersion < 5 ? EARLY_VERSION_TIMING_OFFSET : 0;
|
|
}
|
|
|
|
protected override Beatmap CreateTemplateObject()
|
|
{
|
|
var templateBeatmap = base.CreateTemplateObject();
|
|
templateBeatmap.ControlPointInfo = new LegacyControlPointInfo();
|
|
return templateBeatmap;
|
|
}
|
|
|
|
protected override void ParseStreamInto(LineBufferedReader stream, Beatmap beatmap)
|
|
{
|
|
this.beatmap = beatmap;
|
|
this.beatmap.BeatmapInfo.BeatmapVersion = FormatVersion;
|
|
|
|
applyLegacyDefaults(this.beatmap.BeatmapInfo);
|
|
|
|
base.ParseStreamInto(stream, beatmap);
|
|
|
|
flushPendingPoints();
|
|
|
|
// Objects may be out of order *only* if a user has manually edited an .osu file.
|
|
// Unfortunately there are ranked maps in this state (example: https://osu.ppy.sh/s/594828).
|
|
// OrderBy is used to guarantee that the parsing order of hitobjects with equal start times is maintained (stably-sorted)
|
|
// The parsing order of hitobjects matters in mania difficulty calculation
|
|
this.beatmap.HitObjects = this.beatmap.HitObjects.OrderBy(h => h.StartTime).ToList();
|
|
|
|
foreach (var hitObject in this.beatmap.HitObjects)
|
|
hitObject.ApplyDefaults(this.beatmap.ControlPointInfo, this.beatmap.Difficulty);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Some `BeatmapInfo` members have default values that differ from the default values used by stable.
|
|
/// In addition, legacy beatmaps will sometimes not contain some configuration keys, in which case
|
|
/// the legacy default values should be used.
|
|
/// This method's intention is to restore those legacy defaults.
|
|
/// See also: https://osu.ppy.sh/wiki/en/Client/File_formats/Osu_%28file_format%29
|
|
/// </summary>
|
|
private void applyLegacyDefaults(BeatmapInfo beatmapInfo)
|
|
{
|
|
beatmapInfo.WidescreenStoryboard = false;
|
|
beatmapInfo.SamplesMatchPlaybackRate = false;
|
|
}
|
|
|
|
protected override bool ShouldSkipLine(string line) => base.ShouldSkipLine(line) || line.StartsWith(' ') || line.StartsWith('_');
|
|
|
|
protected override void ParseLine(Beatmap beatmap, Section section, string line)
|
|
{
|
|
switch (section)
|
|
{
|
|
case Section.General:
|
|
handleGeneral(line);
|
|
return;
|
|
|
|
case Section.Editor:
|
|
handleEditor(line);
|
|
return;
|
|
|
|
case Section.Metadata:
|
|
handleMetadata(line);
|
|
return;
|
|
|
|
case Section.Difficulty:
|
|
handleDifficulty(line);
|
|
return;
|
|
|
|
case Section.Events:
|
|
handleEvent(line);
|
|
return;
|
|
|
|
case Section.TimingPoints:
|
|
handleTimingPoint(line);
|
|
return;
|
|
|
|
case Section.HitObjects:
|
|
handleHitObject(line);
|
|
return;
|
|
}
|
|
|
|
base.ParseLine(beatmap, section, line);
|
|
}
|
|
|
|
private void handleGeneral(string line)
|
|
{
|
|
var pair = SplitKeyVal(line);
|
|
|
|
var metadata = beatmap.BeatmapInfo.Metadata;
|
|
|
|
switch (pair.Key)
|
|
{
|
|
case @"AudioFilename":
|
|
metadata.AudioFile = pair.Value.ToStandardisedPath();
|
|
break;
|
|
|
|
case @"AudioLeadIn":
|
|
beatmap.BeatmapInfo.AudioLeadIn = Parsing.ParseInt(pair.Value);
|
|
break;
|
|
|
|
case @"PreviewTime":
|
|
metadata.PreviewTime = getOffsetTime(Parsing.ParseInt(pair.Value));
|
|
break;
|
|
|
|
case @"SampleSet":
|
|
defaultSampleBank = (LegacySampleBank)Enum.Parse(typeof(LegacySampleBank), pair.Value);
|
|
break;
|
|
|
|
case @"SampleVolume":
|
|
defaultSampleVolume = Parsing.ParseInt(pair.Value);
|
|
break;
|
|
|
|
case @"StackLeniency":
|
|
beatmap.BeatmapInfo.StackLeniency = Parsing.ParseFloat(pair.Value);
|
|
break;
|
|
|
|
case @"Mode":
|
|
int rulesetID = Parsing.ParseInt(pair.Value);
|
|
|
|
beatmap.BeatmapInfo.Ruleset = RulesetStore.GetRuleset(rulesetID) ?? throw new ArgumentException("Ruleset is not available locally.");
|
|
|
|
switch (rulesetID)
|
|
{
|
|
case 0:
|
|
parser = new Rulesets.Objects.Legacy.Osu.ConvertHitObjectParser(getOffsetTime(), FormatVersion);
|
|
break;
|
|
|
|
case 1:
|
|
parser = new Rulesets.Objects.Legacy.Taiko.ConvertHitObjectParser(getOffsetTime(), FormatVersion);
|
|
break;
|
|
|
|
case 2:
|
|
parser = new Rulesets.Objects.Legacy.Catch.ConvertHitObjectParser(getOffsetTime(), FormatVersion);
|
|
break;
|
|
|
|
case 3:
|
|
parser = new Rulesets.Objects.Legacy.Mania.ConvertHitObjectParser(getOffsetTime(), FormatVersion);
|
|
break;
|
|
}
|
|
|
|
break;
|
|
|
|
case @"LetterboxInBreaks":
|
|
beatmap.BeatmapInfo.LetterboxInBreaks = Parsing.ParseInt(pair.Value) == 1;
|
|
break;
|
|
|
|
case @"SpecialStyle":
|
|
beatmap.BeatmapInfo.SpecialStyle = Parsing.ParseInt(pair.Value) == 1;
|
|
break;
|
|
|
|
case @"WidescreenStoryboard":
|
|
beatmap.BeatmapInfo.WidescreenStoryboard = Parsing.ParseInt(pair.Value) == 1;
|
|
break;
|
|
|
|
case @"EpilepsyWarning":
|
|
beatmap.BeatmapInfo.EpilepsyWarning = Parsing.ParseInt(pair.Value) == 1;
|
|
break;
|
|
|
|
case @"SamplesMatchPlaybackRate":
|
|
beatmap.BeatmapInfo.SamplesMatchPlaybackRate = Parsing.ParseInt(pair.Value) == 1;
|
|
break;
|
|
|
|
case @"Countdown":
|
|
beatmap.BeatmapInfo.Countdown = (CountdownType)Enum.Parse(typeof(CountdownType), pair.Value);
|
|
break;
|
|
|
|
case @"CountdownOffset":
|
|
beatmap.BeatmapInfo.CountdownOffset = Parsing.ParseInt(pair.Value);
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void handleEditor(string line)
|
|
{
|
|
var pair = SplitKeyVal(line);
|
|
|
|
switch (pair.Key)
|
|
{
|
|
case @"Bookmarks":
|
|
beatmap.BeatmapInfo.Bookmarks = pair.Value.Split(',').Select(v =>
|
|
{
|
|
bool result = int.TryParse(v, out int val);
|
|
return new { result, val };
|
|
}).Where(p => p.result).Select(p => p.val).ToArray();
|
|
break;
|
|
|
|
case @"DistanceSpacing":
|
|
beatmap.BeatmapInfo.DistanceSpacing = Math.Max(0, Parsing.ParseDouble(pair.Value));
|
|
break;
|
|
|
|
case @"BeatDivisor":
|
|
beatmap.BeatmapInfo.BeatDivisor = Parsing.ParseInt(pair.Value);
|
|
break;
|
|
|
|
case @"GridSize":
|
|
beatmap.BeatmapInfo.GridSize = Parsing.ParseInt(pair.Value);
|
|
break;
|
|
|
|
case @"TimelineZoom":
|
|
beatmap.BeatmapInfo.TimelineZoom = Math.Max(0, Parsing.ParseDouble(pair.Value));
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void handleMetadata(string line)
|
|
{
|
|
var pair = SplitKeyVal(line);
|
|
|
|
var metadata = beatmap.BeatmapInfo.Metadata;
|
|
|
|
switch (pair.Key)
|
|
{
|
|
case @"Title":
|
|
metadata.Title = pair.Value;
|
|
break;
|
|
|
|
case @"TitleUnicode":
|
|
metadata.TitleUnicode = pair.Value;
|
|
break;
|
|
|
|
case @"Artist":
|
|
metadata.Artist = pair.Value;
|
|
break;
|
|
|
|
case @"ArtistUnicode":
|
|
metadata.ArtistUnicode = pair.Value;
|
|
break;
|
|
|
|
case @"Creator":
|
|
metadata.Author.Username = pair.Value;
|
|
break;
|
|
|
|
case @"Version":
|
|
beatmap.BeatmapInfo.DifficultyName = pair.Value;
|
|
break;
|
|
|
|
case @"Source":
|
|
metadata.Source = pair.Value;
|
|
break;
|
|
|
|
case @"Tags":
|
|
metadata.Tags = pair.Value;
|
|
break;
|
|
|
|
case @"BeatmapID":
|
|
beatmap.BeatmapInfo.OnlineID = Parsing.ParseInt(pair.Value);
|
|
break;
|
|
|
|
case @"BeatmapSetID":
|
|
beatmap.BeatmapInfo.BeatmapSet = new BeatmapSetInfo { OnlineID = Parsing.ParseInt(pair.Value) };
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void handleDifficulty(string line)
|
|
{
|
|
var pair = SplitKeyVal(line);
|
|
|
|
var difficulty = beatmap.Difficulty;
|
|
|
|
switch (pair.Key)
|
|
{
|
|
case @"HPDrainRate":
|
|
difficulty.DrainRate = Parsing.ParseFloat(pair.Value);
|
|
break;
|
|
|
|
case @"CircleSize":
|
|
difficulty.CircleSize = Parsing.ParseFloat(pair.Value);
|
|
break;
|
|
|
|
case @"OverallDifficulty":
|
|
difficulty.OverallDifficulty = Parsing.ParseFloat(pair.Value);
|
|
if (!hasApproachRate)
|
|
difficulty.ApproachRate = difficulty.OverallDifficulty;
|
|
break;
|
|
|
|
case @"ApproachRate":
|
|
difficulty.ApproachRate = Parsing.ParseFloat(pair.Value);
|
|
hasApproachRate = true;
|
|
break;
|
|
|
|
case @"SliderMultiplier":
|
|
difficulty.SliderMultiplier = Parsing.ParseDouble(pair.Value);
|
|
break;
|
|
|
|
case @"SliderTickRate":
|
|
difficulty.SliderTickRate = Parsing.ParseDouble(pair.Value);
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void handleEvent(string line)
|
|
{
|
|
string[] split = line.Split(',');
|
|
|
|
if (!Enum.TryParse(split[0], out LegacyEventType type))
|
|
throw new InvalidDataException($@"Unknown event type: {split[0]}");
|
|
|
|
switch (type)
|
|
{
|
|
case LegacyEventType.Background:
|
|
beatmap.BeatmapInfo.Metadata.BackgroundFile = CleanFilename(split[2]);
|
|
break;
|
|
|
|
case LegacyEventType.Break:
|
|
double start = getOffsetTime(Parsing.ParseDouble(split[1]));
|
|
double end = Math.Max(start, getOffsetTime(Parsing.ParseDouble(split[2])));
|
|
|
|
beatmap.Breaks.Add(new BreakPeriod(start, end));
|
|
break;
|
|
}
|
|
}
|
|
|
|
private void handleTimingPoint(string line)
|
|
{
|
|
string[] split = line.Split(',');
|
|
|
|
double time = getOffsetTime(Parsing.ParseDouble(split[0].Trim()));
|
|
double beatLength = Parsing.ParseDouble(split[1].Trim());
|
|
double speedMultiplier = beatLength < 0 ? 100.0 / -beatLength : 1;
|
|
|
|
TimeSignature timeSignature = TimeSignature.SimpleQuadruple;
|
|
if (split.Length >= 3)
|
|
timeSignature = split[2][0] == '0' ? TimeSignature.SimpleQuadruple : new TimeSignature(Parsing.ParseInt(split[2]));
|
|
|
|
LegacySampleBank sampleSet = defaultSampleBank;
|
|
if (split.Length >= 4)
|
|
sampleSet = (LegacySampleBank)Parsing.ParseInt(split[3]);
|
|
|
|
int customSampleBank = 0;
|
|
if (split.Length >= 5)
|
|
customSampleBank = Parsing.ParseInt(split[4]);
|
|
|
|
int sampleVolume = defaultSampleVolume;
|
|
if (split.Length >= 6)
|
|
sampleVolume = Parsing.ParseInt(split[5]);
|
|
|
|
bool timingChange = true;
|
|
if (split.Length >= 7)
|
|
timingChange = split[6][0] == '1';
|
|
|
|
bool kiaiMode = false;
|
|
bool omitFirstBarSignature = false;
|
|
|
|
if (split.Length >= 8)
|
|
{
|
|
LegacyEffectFlags effectFlags = (LegacyEffectFlags)Parsing.ParseInt(split[7]);
|
|
kiaiMode = effectFlags.HasFlagFast(LegacyEffectFlags.Kiai);
|
|
omitFirstBarSignature = effectFlags.HasFlagFast(LegacyEffectFlags.OmitFirstBarLine);
|
|
}
|
|
|
|
string stringSampleSet = sampleSet.ToString().ToLowerInvariant();
|
|
if (stringSampleSet == @"none")
|
|
stringSampleSet = @"normal";
|
|
|
|
if (timingChange)
|
|
{
|
|
var controlPoint = CreateTimingControlPoint();
|
|
|
|
controlPoint.BeatLength = beatLength;
|
|
controlPoint.TimeSignature = timeSignature;
|
|
|
|
addControlPoint(time, controlPoint, true);
|
|
}
|
|
|
|
#pragma warning disable 618
|
|
addControlPoint(time, new LegacyDifficultyControlPoint(beatLength)
|
|
#pragma warning restore 618
|
|
{
|
|
SliderVelocity = speedMultiplier,
|
|
}, timingChange);
|
|
|
|
var effectPoint = new EffectControlPoint
|
|
{
|
|
KiaiMode = kiaiMode,
|
|
OmitFirstBarLine = omitFirstBarSignature,
|
|
};
|
|
|
|
int onlineRulesetID = beatmap.BeatmapInfo.Ruleset.OnlineID;
|
|
|
|
// osu!taiko and osu!mania use effect points rather than difficulty points for scroll speed adjustments.
|
|
if (onlineRulesetID == 1 || onlineRulesetID == 3)
|
|
effectPoint.ScrollSpeed = speedMultiplier;
|
|
|
|
addControlPoint(time, effectPoint, timingChange);
|
|
|
|
addControlPoint(time, new LegacySampleControlPoint
|
|
{
|
|
SampleBank = stringSampleSet,
|
|
SampleVolume = sampleVolume,
|
|
CustomSampleBank = customSampleBank,
|
|
}, timingChange);
|
|
}
|
|
|
|
private readonly List<ControlPoint> pendingControlPoints = new List<ControlPoint>();
|
|
private readonly HashSet<Type> pendingControlPointTypes = new HashSet<Type>();
|
|
private double pendingControlPointsTime;
|
|
private bool hasApproachRate;
|
|
|
|
private void addControlPoint(double time, ControlPoint point, bool timingChange)
|
|
{
|
|
if (time != pendingControlPointsTime)
|
|
flushPendingPoints();
|
|
|
|
if (timingChange)
|
|
pendingControlPoints.Insert(0, point);
|
|
else
|
|
pendingControlPoints.Add(point);
|
|
|
|
pendingControlPointsTime = time;
|
|
}
|
|
|
|
private void flushPendingPoints()
|
|
{
|
|
// Changes from non-timing-points are added to the end of the list (see addControlPoint()) and should override any changes from timing-points (added to the start of the list).
|
|
for (int i = pendingControlPoints.Count - 1; i >= 0; i--)
|
|
{
|
|
var type = pendingControlPoints[i].GetType();
|
|
if (pendingControlPointTypes.Contains(type))
|
|
continue;
|
|
|
|
pendingControlPointTypes.Add(type);
|
|
beatmap.ControlPointInfo.Add(pendingControlPointsTime, pendingControlPoints[i]);
|
|
}
|
|
|
|
pendingControlPoints.Clear();
|
|
pendingControlPointTypes.Clear();
|
|
}
|
|
|
|
private void handleHitObject(string line)
|
|
{
|
|
// If the ruleset wasn't specified, assume the osu!standard ruleset.
|
|
parser ??= new Rulesets.Objects.Legacy.Osu.ConvertHitObjectParser(getOffsetTime(), FormatVersion);
|
|
|
|
var obj = parser.Parse(line);
|
|
|
|
if (obj != null)
|
|
{
|
|
obj.ApplyDefaults(beatmap.ControlPointInfo, beatmap.Difficulty);
|
|
|
|
beatmap.HitObjects.Add(obj);
|
|
}
|
|
}
|
|
|
|
private int getOffsetTime(int time) => time + (ApplyOffsets ? offset : 0);
|
|
|
|
private double getOffsetTime() => ApplyOffsets ? offset : 0;
|
|
|
|
private double getOffsetTime(double time) => time + (ApplyOffsets ? offset : 0);
|
|
|
|
protected virtual TimingControlPoint CreateTimingControlPoint() => new TimingControlPoint();
|
|
}
|
|
}
|