h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-12-15 11:22:57 +08:00
Code Issues Releases Wiki Activity

Merge pull request #10619 from peppy/sample-lookup-improvements

Browse Source 
Change sample lookup structure to allow specifications outside of "Gameplay" prefix
This commit is contained in:
Dan Balasescu 2020-11-02 13:36:07 +09:00 committed by GitHub
commit db7f8a7322
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 65 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
osu.Game.Rulesets.Mania/Resources/Testing/Beatmaps/convert-samples-expected-conversion.json
View File

@ -6,20 +6,20 @@
"EndTime": 2750.0,
"Column": 1,
"NodeSamples": [
["normal-hitnormal"],
["soft-hitnormal"],
["drum-hitnormal"]
["Gameplay/normal-hitnormal"],
["Gameplay/soft-hitnormal"],
["Gameplay/drum-hitnormal"]
],
"Samples": ["-hitnormal"]
"Samples": ["Gameplay/-hitnormal"]
}, {
"StartTime": 1875.0,
"EndTime": 2750.0,
"Column": 0,
"NodeSamples": [
["soft-hitnormal"],
["drum-hitnormal"]
["Gameplay/soft-hitnormal"],
["Gameplay/drum-hitnormal"]
],
"Samples": ["-hitnormal"]
"Samples": ["Gameplay/-hitnormal"]
}]
}, {
"StartTime": 3750.0,
@ -27,7 +27,7 @@
"StartTime": 3750.0,
"EndTime": 3750.0,
"Column": 3,
"Samples": ["normal-hitnormal"]
"Samples": ["Gameplay/normal-hitnormal"]
}]
}]
}

8
osu.Game.Rulesets.Mania/Resources/Testing/Beatmaps/mania-samples-expected-conversion.json
View File

@ -6,10 +6,10 @@
"EndTime": 1500.0,
"Column": 0,
"NodeSamples": [
["normal-hitnormal"],
["Gameplay/normal-hitnormal"],
[]
],
"Samples": ["normal-hitnormal"]
"Samples": ["Gameplay/normal-hitnormal"]
}]
}, {
"StartTime": 2000.0,
@ -18,10 +18,10 @@
"EndTime": 3000.0,
"Column": 2,
"NodeSamples": [
["drum-hitnormal"],
["Gameplay/drum-hitnormal"],
[]
],
"Samples": ["drum-hitnormal"]
"Samples": ["Gameplay/drum-hitnormal"]
}]
}]
}

6
osu.Game.Rulesets.Mania/Resources/Testing/Beatmaps/slider-convert-samples-expected-conversion.json
View File

@ -5,17 +5,17 @@
"StartTime": 8470.0,
"EndTime": 8470.0,
"Column": 0,
"Samples": ["normal-hitnormal", "normal-hitclap"]
"Samples": ["Gameplay/normal-hitnormal", "Gameplay/normal-hitclap"]
}, {
"StartTime": 8626.470587768974,
"EndTime": 8626.470587768974,
"Column": 1,
"Samples": ["normal-hitnormal"]
"Samples": ["Gameplay/normal-hitnormal"]
}, {
"StartTime": 8782.941175537948,
"EndTime": 8782.941175537948,
"Column": 2,
"Samples": ["normal-hitnormal", "normal-hitclap"]
"Samples": ["Gameplay/normal-hitnormal", "Gameplay/normal-hitclap"]
}]
}]
}

2
osu.Game.Rulesets.Taiko/Skinning/TaikoLegacySkinTransformer.cs
View File

@ -162,7 +162,7 @@ namespace osu.Game.Rulesets.Taiko.Skinning
get
{
foreach (var name in source.LookupNames)
yield return $"taiko-{name}";
yield return name.Insert(name.LastIndexOf('/') + 1, "taiko-");
foreach (var name in source.LookupNames)
yield return name;

18
osu.Game.Tests/Beatmaps/Formats/LegacyBeatmapDecoderTest.cs
View File

@ -410,13 +410,13 @@ namespace osu.Game.Tests.Beatmaps.Formats
{
var hitObjects = decoder.Decode(stream).HitObjects;
Assert.AreEqual("normal-hitnormal", getTestableSampleInfo(hitObjects[0]).LookupNames.First());
Assert.AreEqual("normal-hitnormal", getTestableSampleInfo(hitObjects[1]).LookupNames.First());
Assert.AreEqual("normal-hitnormal2", getTestableSampleInfo(hitObjects[2]).LookupNames.First());
Assert.AreEqual("normal-hitnormal", getTestableSampleInfo(hitObjects[3]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal", getTestableSampleInfo(hitObjects[0]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal", getTestableSampleInfo(hitObjects[1]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal2", getTestableSampleInfo(hitObjects[2]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal", getTestableSampleInfo(hitObjects[3]).LookupNames.First());
// The control point at the end time of the slider should be applied
Assert.AreEqual("soft-hitnormal8", getTestableSampleInfo(hitObjects[4]).LookupNames.First());
Assert.AreEqual("Gameplay/soft-hitnormal8", getTestableSampleInfo(hitObjects[4]).LookupNames.First());
}
static HitSampleInfo getTestableSampleInfo(HitObject hitObject) => hitObject.SampleControlPoint.ApplyTo(hitObject.Samples[0]);
@ -432,9 +432,9 @@ namespace osu.Game.Tests.Beatmaps.Formats
{
var hitObjects = decoder.Decode(stream).HitObjects;
Assert.AreEqual("normal-hitnormal", getTestableSampleInfo(hitObjects[0]).LookupNames.First());
Assert.AreEqual("normal-hitnormal2", getTestableSampleInfo(hitObjects[1]).LookupNames.First());
Assert.AreEqual("normal-hitnormal3", getTestableSampleInfo(hitObjects[2]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal", getTestableSampleInfo(hitObjects[0]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal2", getTestableSampleInfo(hitObjects[1]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal3", getTestableSampleInfo(hitObjects[2]).LookupNames.First());
}
static HitSampleInfo getTestableSampleInfo(HitObject hitObject) => hitObject.SampleControlPoint.ApplyTo(hitObject.Samples[0]);
@ -452,7 +452,7 @@ namespace osu.Game.Tests.Beatmaps.Formats
Assert.AreEqual("hit_1.wav", getTestableSampleInfo(hitObjects[0]).LookupNames.First());
Assert.AreEqual("hit_2.wav", getTestableSampleInfo(hitObjects[1]).LookupNames.First());
Assert.AreEqual("normal-hitnormal2", getTestableSampleInfo(hitObjects[2]).LookupNames.First());
Assert.AreEqual("Gameplay/normal-hitnormal2", getTestableSampleInfo(hitObjects[2]).LookupNames.First());
Assert.AreEqual("hit_1.wav", getTestableSampleInfo(hitObjects[3]).LookupNames.First());
Assert.AreEqual(70, getTestableSampleInfo(hitObjects[3]).Volume);
}

2
osu.Game.Tests/Visual/Gameplay/TestSceneSkinnableSound.cs
View File

@ -34,7 +34,7 @@ namespace osu.Game.Tests.Visual.Gameplay
skinSource = new TestSkinSourceContainer
{
RelativeSizeAxes = Axes.Both,
Child = skinnableSound = new PausableSkinnableSound(new SampleInfo("normal-sliderslide"))
Child = skinnableSound = new PausableSkinnableSound(new SampleInfo("Gameplay/normal-sliderslide"))
},
};
});

4
osu.Game/Audio/HitSampleInfo.cs
View File

@ -50,9 +50,9 @@ namespace osu.Game.Audio
get
{
if (!string.IsNullOrEmpty(Suffix))
yield return $"{Bank}-{Name}{Suffix}";
yield return $"Gameplay/{Bank}-{Name}{Suffix}";
yield return $"{Bank}-{Name}";
yield return $"Gameplay/{Bank}-{Name}";
}
}

8
osu.Game/Audio/SampleInfo.cs
View File

@ -10,14 +10,14 @@ namespace osu.Game.Audio
/// </summary>
public class SampleInfo : ISampleInfo
{
private readonly string sampleName;
private readonly string[] sampleNames;
public SampleInfo(string sampleName)
public SampleInfo(params string[] sampleNames)
{
this.sampleName = sampleName;
this.sampleNames = sampleNames;
}
public IEnumerable<string> LookupNames => new[] { sampleName };
public IEnumerable<string> LookupNames => sampleNames;
public int Volume { get; } = 100;
}

8
osu.Game/Rulesets/Mods/ModNightcore.cs
View File

@ -69,10 +69,10 @@ namespace osu.Game.Rulesets.Mods
{
InternalChildren = new Drawable[]
{
hatSample = new PausableSkinnableSound(new SampleInfo("nightcore-hat")),
clapSample = new PausableSkinnableSound(new SampleInfo("nightcore-clap")),
kickSample = new PausableSkinnableSound(new SampleInfo("nightcore-kick")),
finishSample = new PausableSkinnableSound(new SampleInfo("nightcore-finish")),
hatSample = new PausableSkinnableSound(new SampleInfo("Gameplay/nightcore-hat")),
clapSample = new PausableSkinnableSound(new SampleInfo("Gameplay/nightcore-clap")),
kickSample = new PausableSkinnableSound(new SampleInfo("Gameplay/nightcore-kick")),
finishSample = new PausableSkinnableSound(new SampleInfo("Gameplay/nightcore-finish")),
};
}

2
osu.Game/Screens/Play/ComboEffects.cs
View File

@ -28,7 +28,7 @@ namespace osu.Game.Screens.Play
[BackgroundDependencyLoader]
private void load(OsuConfigManager config)
{
InternalChild = comboBreakSample = new SkinnableSound(new SampleInfo("combobreak"));
InternalChild = comboBreakSample = new SkinnableSound(new SampleInfo("Gameplay/combobreak"));
alwaysPlay = config.GetBindable<bool>(OsuSetting.AlwaysPlayFirstComboBreak);
}

2
osu.Game/Screens/Play/PauseOverlay.cs
View File

@ -33,7 +33,7 @@ namespace osu.Game.Screens.Play
AddButton("Retry", colours.YellowDark, () => OnRetry?.Invoke());
AddButton("Quit", new Color4(170, 27, 39, 255), () => OnQuit?.Invoke());
AddInternal(pauseLoop = new SkinnableSound(new SampleInfo("pause-loop"))
AddInternal(pauseLoop = new SkinnableSound(new SampleInfo("Gameplay/pause-loop"))
{
Looping = true,
Volume = { Value = 0 }

45
osu.Game/Skinning/LegacySkin.cs
View File

@ -417,10 +417,14 @@ namespace osu.Game.Skinning
public override SampleChannel GetSample(ISampleInfo sampleInfo)
{
var lookupNames = sampleInfo.LookupNames;
IEnumerable<string> lookupNames;
if (sampleInfo is HitSampleInfo hitSample)
lookupNames = getLegacyLookupNames(hitSample);
else
{
lookupNames = sampleInfo.LookupNames.SelectMany(getFallbackNames);
}
foreach (var lookup in lookupNames)
{
@ -433,6 +437,27 @@ namespace osu.Game.Skinning
return null;
}
private IEnumerable<string> getLegacyLookupNames(HitSampleInfo hitSample)
{
var lookupNames = hitSample.LookupNames.SelectMany(getFallbackNames);
if (!UseCustomSampleBanks && !string.IsNullOrEmpty(hitSample.Suffix))
{
// for compatibility with stable, exclude the lookup names with the custom sample bank suffix, if they are not valid for use in this skin.
// using .EndsWith() is intentional as it ensures parity in all edge cases
// (see LegacyTaikoSampleInfo for an example of one - prioritising the taiko prefix should still apply, but the sample bank should not).
lookupNames = lookupNames.Where(name => !name.EndsWith(hitSample.Suffix, StringComparison.Ordinal));
}
foreach (var l in lookupNames)
yield return l;
// also for compatibility, try falling back to non-bank samples (so-called "universal" samples) as the last resort.
// going forward specifying banks shall always be required, even for elements that wouldn't require it on stable,
// which is why this is done locally here.
yield return hitSample.Name;
}
private IEnumerable<string> getFallbackNames(string componentName)
{
// May be something like "Gameplay/osu/approachcircle" from lazer, or "Arrows/note1" from a user skin.
@ -442,23 +467,5 @@ namespace osu.Game.Skinning
string lastPiece = componentName.Split('/').Last();
yield return componentName.StartsWith("Gameplay/taiko/", StringComparison.Ordinal) ? "taiko-" + lastPiece : lastPiece;
}
private IEnumerable<string> getLegacyLookupNames(HitSampleInfo hitSample)
{
var lookupNames = hitSample.LookupNames;
if (!UseCustomSampleBanks && !string.IsNullOrEmpty(hitSample.Suffix))
// for compatibility with stable, exclude the lookup names with the custom sample bank suffix, if they are not valid for use in this skin.
// using .EndsWith() is intentional as it ensures parity in all edge cases
// (see LegacyTaikoSampleInfo for an example of one - prioritising the taiko prefix should still apply, but the sample bank should not).
lookupNames = hitSample.LookupNames.Where(name => !name.EndsWith(hitSample.Suffix, StringComparison.Ordinal));
// also for compatibility, try falling back to non-bank samples (so-called "universal" samples) as the last resort.
// going forward specifying banks shall always be required, even for elements that wouldn't require it on stable,
// which is why this is done locally here.
lookupNames = lookupNames.Append(hitSample.Name);
return lookupNames;
}
}
}

2
osu.Game/Skinning/SkinnableSound.cs
View File

@ -88,7 +88,7 @@ namespace osu.Game.Skinning
{
foreach (var lookup in s.LookupNames)
{
if ((ch = samples.Get($"Gameplay/{lookup}")) != null)
if ((ch = samples.Get(lookup)) != null)
break;
}
}