mirror of
https://github.com/ppy/osu
synced 2024-12-14 19:06:07 +00:00
Merge pull request #11561 from Mysfit/fix-storyboard-samples
Fix storyboard samples continuing to play when the beatmap is paused or intro is skipped
This commit is contained in:
commit
328bd191d4
@ -0,0 +1,74 @@
|
|||||||
|
// 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.Collections.Generic;
|
||||||
|
using System.Linq;
|
||||||
|
using NUnit.Framework;
|
||||||
|
using osu.Framework.Allocation;
|
||||||
|
using osu.Framework.Testing;
|
||||||
|
using osu.Game.Beatmaps;
|
||||||
|
using osu.Game.Configuration;
|
||||||
|
using osu.Game.Rulesets;
|
||||||
|
using osu.Game.Rulesets.Osu;
|
||||||
|
using osu.Game.Storyboards;
|
||||||
|
using osu.Game.Storyboards.Drawables;
|
||||||
|
|
||||||
|
namespace osu.Game.Tests.Visual.Gameplay
|
||||||
|
{
|
||||||
|
public class TestSceneStoryboardSamplePlayback : PlayerTestScene
|
||||||
|
{
|
||||||
|
private Storyboard storyboard;
|
||||||
|
|
||||||
|
[BackgroundDependencyLoader]
|
||||||
|
private void load(OsuConfigManager config)
|
||||||
|
{
|
||||||
|
config.Set(OsuSetting.ShowStoryboard, true);
|
||||||
|
|
||||||
|
storyboard = new Storyboard();
|
||||||
|
var backgroundLayer = storyboard.GetLayer("Background");
|
||||||
|
backgroundLayer.Add(new StoryboardSampleInfo("Intro/welcome.mp3", time: -7000, volume: 20));
|
||||||
|
backgroundLayer.Add(new StoryboardSampleInfo("Intro/welcome.mp3", time: -5000, volume: 20));
|
||||||
|
backgroundLayer.Add(new StoryboardSampleInfo("Intro/welcome.mp3", time: 0, volume: 20));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void TestStoryboardSamplesStopDuringPause()
|
||||||
|
{
|
||||||
|
checkForFirstSamplePlayback();
|
||||||
|
|
||||||
|
AddStep("player paused", () => Player.Pause());
|
||||||
|
AddAssert("player is currently paused", () => Player.GameplayClockContainer.IsPaused.Value);
|
||||||
|
AddAssert("all storyboard samples stopped immediately", () => allStoryboardSamples.All(sound => !sound.IsPlaying));
|
||||||
|
|
||||||
|
AddStep("player resume", () => Player.Resume());
|
||||||
|
AddUntilStep("any storyboard samples playing after resume", () => allStoryboardSamples.Any(sound => sound.IsPlaying));
|
||||||
|
}
|
||||||
|
|
||||||
|
[Test]
|
||||||
|
public void TestStoryboardSamplesStopOnSkip()
|
||||||
|
{
|
||||||
|
checkForFirstSamplePlayback();
|
||||||
|
|
||||||
|
AddStep("skip intro", () => InputManager.Key(osuTK.Input.Key.Space));
|
||||||
|
AddAssert("all storyboard samples stopped immediately", () => allStoryboardSamples.All(sound => !sound.IsPlaying));
|
||||||
|
|
||||||
|
AddUntilStep("any storyboard samples playing after skip", () => allStoryboardSamples.Any(sound => sound.IsPlaying));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void checkForFirstSamplePlayback()
|
||||||
|
{
|
||||||
|
AddUntilStep("storyboard loaded", () => Player.Beatmap.Value.StoryboardLoaded);
|
||||||
|
AddUntilStep("any storyboard samples playing", () => allStoryboardSamples.Any(sound => sound.IsPlaying));
|
||||||
|
}
|
||||||
|
|
||||||
|
private IEnumerable<DrawableStoryboardSample> allStoryboardSamples => Player.ChildrenOfType<DrawableStoryboardSample>();
|
||||||
|
|
||||||
|
protected override bool AllowFail => false;
|
||||||
|
|
||||||
|
protected override Ruleset CreatePlayerRuleset() => new OsuRuleset();
|
||||||
|
protected override TestPlayer CreatePlayer(Ruleset ruleset) => new TestPlayer(true, false);
|
||||||
|
|
||||||
|
protected override WorkingBeatmap CreateWorkingBeatmap(IBeatmap beatmap, Storyboard storyboard = null) =>
|
||||||
|
new ClockBackedTestWorkingBeatmap(beatmap, storyboard ?? this.storyboard, Clock, Audio);
|
||||||
|
}
|
||||||
|
}
|
@ -353,7 +353,7 @@ namespace osu.Game.Screens.Play
|
|||||||
},
|
},
|
||||||
skipOverlay = new SkipOverlay(DrawableRuleset.GameplayStartTime)
|
skipOverlay = new SkipOverlay(DrawableRuleset.GameplayStartTime)
|
||||||
{
|
{
|
||||||
RequestSkip = GameplayClockContainer.Skip
|
RequestSkip = performUserRequestedSkip
|
||||||
},
|
},
|
||||||
FailOverlay = new FailOverlay
|
FailOverlay = new FailOverlay
|
||||||
{
|
{
|
||||||
@ -488,6 +488,17 @@ namespace osu.Game.Screens.Play
|
|||||||
this.Exit();
|
this.Exit();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private void performUserRequestedSkip()
|
||||||
|
{
|
||||||
|
// user requested skip
|
||||||
|
// disable sample playback to stop currently playing samples and perform skip
|
||||||
|
samplePlaybackDisabled.Value = true;
|
||||||
|
GameplayClockContainer.Skip();
|
||||||
|
|
||||||
|
// return samplePlaybackDisabled.Value to what is defined by the beatmap's current state
|
||||||
|
updateSampleDisabledState();
|
||||||
|
}
|
||||||
|
|
||||||
private void performUserRequestedExit()
|
private void performUserRequestedExit()
|
||||||
{
|
{
|
||||||
if (ValidForResume && HasFailed && !FailOverlay.IsPresent)
|
if (ValidForResume && HasFailed && !FailOverlay.IsPresent)
|
||||||
|
@ -43,7 +43,11 @@ namespace osu.Game.Skinning
|
|||||||
if (samplePlaybackDisabler != null)
|
if (samplePlaybackDisabler != null)
|
||||||
{
|
{
|
||||||
samplePlaybackDisabled.BindTo(samplePlaybackDisabler.SamplePlaybackDisabled);
|
samplePlaybackDisabled.BindTo(samplePlaybackDisabler.SamplePlaybackDisabled);
|
||||||
samplePlaybackDisabled.BindValueChanged(disabled =>
|
samplePlaybackDisabled.BindValueChanged(SamplePlaybackDisabledChanged);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected virtual void SamplePlaybackDisabledChanged(ValueChangedEvent<bool> disabled)
|
||||||
{
|
{
|
||||||
if (!RequestedPlaying) return;
|
if (!RequestedPlaying) return;
|
||||||
|
|
||||||
@ -63,8 +67,6 @@ namespace osu.Game.Skinning
|
|||||||
base.Play();
|
base.Play();
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public override void Play(bool restart = true)
|
public override void Play(bool restart = true)
|
||||||
|
@ -42,6 +42,21 @@ namespace osu.Game.Storyboards.Drawables
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected override void SamplePlaybackDisabledChanged(ValueChangedEvent<bool> disabled)
|
||||||
|
{
|
||||||
|
if (!RequestedPlaying) return;
|
||||||
|
|
||||||
|
if (!Looping && disabled.NewValue)
|
||||||
|
{
|
||||||
|
// the default behaviour for sample disabling is to allow one-shot samples to play out.
|
||||||
|
// storyboards regularly have long running samples that can cause this behaviour to lead to unintended results.
|
||||||
|
// for this reason, we immediately stop such samples.
|
||||||
|
Stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
base.SamplePlaybackDisabledChanged(disabled);
|
||||||
|
}
|
||||||
|
|
||||||
protected override void Update()
|
protected override void Update()
|
||||||
{
|
{
|
||||||
base.Update();
|
base.Update();
|
||||||
|
Loading…
Reference in New Issue
Block a user