2019-12-10 11:44:45 +00:00
// 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.
2020-04-21 05:47:12 +00:00
using System ;
2020-04-21 05:49:31 +00:00
using System.Collections ;
2019-12-13 10:00:28 +00:00
using System.Collections.Generic ;
2019-12-10 11:44:45 +00:00
using System.IO ;
using System.Linq ;
2020-05-11 07:37:08 +00:00
using System.Text ;
2019-12-10 11:44:45 +00:00
using NUnit.Framework ;
2020-04-21 05:47:12 +00:00
using osu.Framework.Audio.Track ;
using osu.Framework.Graphics.Textures ;
2020-08-12 04:38:05 +00:00
using osu.Framework.IO.Stores ;
2019-12-10 11:44:45 +00:00
using osu.Game.Beatmaps ;
2020-04-21 05:49:31 +00:00
using osu.Game.Beatmaps.ControlPoints ;
2019-12-10 11:44:45 +00:00
using osu.Game.Beatmaps.Formats ;
using osu.Game.IO ;
2019-12-13 10:00:28 +00:00
using osu.Game.IO.Serialization ;
2020-04-21 05:47:12 +00:00
using osu.Game.Rulesets.Catch ;
using osu.Game.Rulesets.Mania ;
using osu.Game.Rulesets.Osu ;
using osu.Game.Rulesets.Taiko ;
2020-08-12 04:38:05 +00:00
using osu.Game.Skinning ;
2019-12-10 11:44:45 +00:00
using osu.Game.Tests.Resources ;
namespace osu.Game.Tests.Beatmaps.Formats
{
[TestFixture]
public class LegacyBeatmapEncoderTest
{
2020-08-23 13:08:02 +00:00
private static readonly DllResourceStore beatmaps_resource_store = TestResources . GetStore ( ) ;
2020-08-15 20:03:24 +00:00
2020-08-23 13:08:02 +00:00
private static IEnumerable < string > allBeatmaps = beatmaps_resource_store . GetAvailableResources ( ) . Where ( res = > res . EndsWith ( ".osu" ) ) ;
2020-08-15 20:03:24 +00:00
2019-12-13 10:00:28 +00:00
[TestCaseSource(nameof(allBeatmaps))]
2020-05-11 07:30:54 +00:00
public void TestEncodeDecodeStability ( string name )
2019-12-10 11:44:45 +00:00
{
2020-08-30 14:08:13 +00:00
var decoded = decodeFromLegacy ( beatmaps_resource_store . GetStream ( name ) , name ) ;
2020-08-23 13:08:02 +00:00
var decodedAfterEncode = decodeFromLegacy ( encodeToLegacy ( decoded ) , name ) ;
2019-12-10 11:44:45 +00:00
2020-09-06 16:44:41 +00:00
sort ( decoded . beatmap ) ;
sort ( decodedAfterEncode . beatmap ) ;
2020-04-21 05:49:31 +00:00
2020-08-15 21:41:53 +00:00
Assert . That ( decodedAfterEncode . beatmap . Serialize ( ) , Is . EqualTo ( decoded . beatmap . Serialize ( ) ) ) ;
2020-08-31 15:24:24 +00:00
Assert . IsTrue ( areComboColoursEqual ( decodedAfterEncode . beatmapSkin . Configuration , decoded . beatmapSkin . Configuration ) ) ;
}
private bool areComboColoursEqual ( IHasComboColours a , IHasComboColours b )
{
// equal to null, no need to SequenceEqual
if ( a . ComboColours = = null & & b . ComboColours = = null )
return true ;
if ( a . ComboColours = = null | | b . ComboColours = = null )
return false ;
return a . ComboColours . SequenceEqual ( b . ComboColours ) ;
2019-12-10 11:44:45 +00:00
}
2020-09-06 16:44:41 +00:00
private void sort ( IBeatmap beatmap )
2020-04-21 05:49:31 +00:00
{
// Sort control points to ensure a sane ordering, as they may be parsed in different orders. This works because each group contains only uniquely-typed control points.
2020-09-06 16:44:41 +00:00
foreach ( var g in beatmap . ControlPointInfo . Groups )
2020-04-21 05:49:31 +00:00
{
ArrayList . Adapter ( ( IList ) g . ControlPoints ) . Sort (
Comparer < ControlPoint > . Create ( ( c1 , c2 ) = > string . Compare ( c1 . GetType ( ) . ToString ( ) , c2 . GetType ( ) . ToString ( ) , StringComparison . Ordinal ) ) ) ;
}
}
2020-08-30 14:08:52 +00:00
private ( IBeatmap beatmap , TestLegacySkin beatmapSkin ) decodeFromLegacy ( Stream stream , string name )
2019-12-10 11:44:45 +00:00
{
2020-05-11 07:30:54 +00:00
using ( var reader = new LineBufferedReader ( stream ) )
2020-08-15 21:41:53 +00:00
{
var beatmap = new LegacyBeatmapDecoder { ApplyOffsets = false } . Decode ( reader ) ;
2020-08-31 15:24:24 +00:00
var beatmapSkin = new TestLegacySkin ( beatmaps_resource_store , name ) ;
return ( convert ( beatmap ) , beatmapSkin ) ;
2020-08-30 19:13:06 +00:00
}
}
2020-09-01 16:15:46 +00:00
private class TestLegacySkin : LegacySkin
2020-08-30 14:08:52 +00:00
{
2020-08-31 15:24:24 +00:00
public TestLegacySkin ( IResourceStore < byte [ ] > storage , string fileName )
2020-08-30 14:23:00 +00:00
: base ( new SkinInfo { Name = "Test Skin" , Creator = "Craftplacer" } , storage , null , fileName )
2020-08-30 14:08:52 +00:00
{
}
}
2020-09-01 15:58:06 +00:00
private Stream encodeToLegacy ( ( IBeatmap beatmap , ISkin beatmapSkin ) fullBeatmap )
2020-05-11 07:30:54 +00:00
{
2020-08-15 21:41:53 +00:00
var ( beatmap , beatmapSkin ) = fullBeatmap ;
2020-05-11 07:30:54 +00:00
var stream = new MemoryStream ( ) ;
2019-12-10 11:44:45 +00:00
2020-05-11 08:26:11 +00:00
using ( var writer = new StreamWriter ( stream , Encoding . UTF8 , 1024 , true ) )
2020-08-15 20:06:26 +00:00
new LegacyBeatmapEncoder ( beatmap , beatmapSkin ) . Encode ( writer ) ;
2019-12-10 11:44:45 +00:00
2020-05-11 07:30:54 +00:00
stream . Position = 0 ;
2020-04-21 05:47:12 +00:00
2020-05-11 07:30:54 +00:00
return stream ;
2019-12-10 11:44:45 +00:00
}
2020-04-21 05:47:12 +00:00
private IBeatmap convert ( IBeatmap beatmap )
{
switch ( beatmap . BeatmapInfo . RulesetID )
{
case 0 :
beatmap . BeatmapInfo . Ruleset = new OsuRuleset ( ) . RulesetInfo ;
break ;
case 1 :
beatmap . BeatmapInfo . Ruleset = new TaikoRuleset ( ) . RulesetInfo ;
break ;
case 2 :
beatmap . BeatmapInfo . Ruleset = new CatchRuleset ( ) . RulesetInfo ;
break ;
case 3 :
beatmap . BeatmapInfo . Ruleset = new ManiaRuleset ( ) . RulesetInfo ;
break ;
}
return new TestWorkingBeatmap ( beatmap ) . GetPlayableBeatmap ( beatmap . BeatmapInfo . Ruleset ) ;
}
private class TestWorkingBeatmap : WorkingBeatmap
{
private readonly IBeatmap beatmap ;
public TestWorkingBeatmap ( IBeatmap beatmap )
: base ( beatmap . BeatmapInfo , null )
{
this . beatmap = beatmap ;
}
protected override IBeatmap GetBeatmap ( ) = > beatmap ;
protected override Texture GetBackground ( ) = > throw new NotImplementedException ( ) ;
2020-08-07 13:31:41 +00:00
protected override Track GetBeatmapTrack ( ) = > throw new NotImplementedException ( ) ;
2020-04-21 05:47:12 +00:00
}
2019-12-10 11:44:45 +00:00
}
}