1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-17 19:02:56 +08:00
osu-lazer/osu.Game/Screens/Play/PlayerLoader.cs

550 lines
18 KiB
C#
Raw Normal View History

// 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.
2018-04-13 17:19:50 +08:00
2018-12-26 21:16:35 +08:00
using System;
using System.Diagnostics;
2018-04-13 17:19:50 +08:00
using System.Threading.Tasks;
2020-10-20 06:08:05 +08:00
using JetBrains.Annotations;
2018-04-13 17:19:50 +08:00
using osu.Framework.Allocation;
using osu.Framework.Audio;
2019-10-01 23:39:01 +08:00
using osu.Framework.Bindables;
2018-04-13 17:19:50 +08:00
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Sprites;
2020-10-20 06:22:30 +08:00
using osu.Framework.Graphics.Transforms;
2019-03-20 18:35:40 +08:00
using osu.Framework.Input;
2018-04-13 17:19:50 +08:00
using osu.Framework.Screens;
using osu.Framework.Threading;
2021-10-07 13:15:16 +08:00
using osu.Game.Audio.Effects;
2019-10-01 23:39:01 +08:00
using osu.Game.Configuration;
2018-04-13 17:19:50 +08:00
using osu.Game.Graphics;
2019-03-22 18:01:32 +08:00
using osu.Game.Graphics.Containers;
using osu.Game.Input;
using osu.Game.Overlays;
using osu.Game.Overlays.Notifications;
2018-04-13 17:19:50 +08:00
using osu.Game.Screens.Menu;
using osu.Game.Screens.Play.PlayerSettings;
using osu.Game.Users;
using osu.Game.Utils;
2018-11-20 15:51:59 +08:00
using osuTK;
using osuTK.Graphics;
2018-04-13 17:19:50 +08:00
namespace osu.Game.Screens.Play
{
public class PlayerLoader : ScreenWithBeatmapBackground
{
protected const float BACKGROUND_BLUR = 15;
private const double content_out_duration = 300;
2020-02-14 17:22:57 +08:00
public override bool HideOverlaysOnEnter => hideOverlays;
2018-04-13 17:19:50 +08:00
2020-02-14 17:22:57 +08:00
public override bool DisallowExternalBeatmapRulesetChanges => true;
2019-01-24 18:55:42 +08:00
2020-02-14 17:22:57 +08:00
// Here because IsHovered will not update unless we do so.
public override bool HandlePositionalInput => true;
2018-04-13 17:19:50 +08:00
2020-02-14 17:22:57 +08:00
// We show the previous screen status
protected override UserActivity InitialActivity => null;
2018-04-13 17:19:50 +08:00
2020-02-14 17:22:57 +08:00
protected override bool PlayResumeSound => false;
2021-08-17 12:44:21 +08:00
protected BeatmapMetadataDisplay MetadataInfo { get; private set; }
2019-02-01 14:42:15 +08:00
/// <summary>
/// A fill flow containing the player settings groups, exposed for the ability to hide it from inheritors of the player loader.
/// </summary>
2021-08-17 12:44:21 +08:00
protected FillFlowContainer<PlayerSettingsGroup> PlayerSettings { get; private set; }
2021-08-17 12:44:21 +08:00
protected VisualSettings VisualSettings { get; private set; }
2019-12-08 02:16:41 +08:00
protected Task LoadTask { get; private set; }
2019-12-06 12:47:34 +08:00
2019-12-08 02:16:41 +08:00
protected Task DisposalTask { get; private set; }
2018-04-13 17:19:50 +08:00
2020-02-14 17:22:57 +08:00
private bool backgroundBrightnessReduction;
2020-10-25 19:33:35 +08:00
private readonly BindableDouble volumeAdjustment = new BindableDouble(1);
private AudioFilter lowPassFilter;
2021-10-07 13:15:16 +08:00
2020-02-14 17:22:57 +08:00
protected bool BackgroundBrightnessReduction
{
set
{
if (value == backgroundBrightnessReduction)
return;
backgroundBrightnessReduction = value;
ApplyToBackground(b => b.FadeColour(OsuColour.Gray(backgroundBrightnessReduction ? 0.8f : 1), 200));
2020-02-14 17:22:57 +08:00
}
}
private bool readyForPush =>
!playerConsumed
// don't push unless the player is completely loaded
&& player?.LoadState == LoadState.Ready
// don't push if the user is hovering one of the panes, unless they are idle.
&& (IsHovered || idleTracker.IsIdle.Value)
// don't push if the user is dragging a slider or otherwise.
&& inputManager?.DraggedDrawable == null
// don't push if a focused overlay is visible, like settings.
&& inputManager?.FocusedDrawable == null;
2020-02-14 17:22:57 +08:00
private readonly Func<Player> createPlayer;
private Player player;
/// <summary>
/// Whether the curent player instance has been consumed via <see cref="consumePlayer"/>.
/// </summary>
private bool playerConsumed;
2020-02-14 17:22:57 +08:00
private LogoTrackingContainer content;
private bool hideOverlays;
2019-03-20 18:35:40 +08:00
private InputManager inputManager;
2020-02-14 17:22:57 +08:00
private IdleTracker idleTracker;
2020-02-14 17:22:57 +08:00
private ScheduledDelegate scheduledPushPlayer;
2020-10-20 06:08:05 +08:00
[CanBeNull]
private EpilepsyWarning epilepsyWarning;
2019-10-03 18:16:31 +08:00
[Resolved(CanBeNull = true)]
private NotificationOverlay notificationOverlay { get; set; }
[Resolved(CanBeNull = true)]
private VolumeOverlay volumeOverlay { get; set; }
[Resolved]
private AudioManager audioManager { get; set; }
[Resolved(CanBeNull = true)]
private BatteryInfo batteryInfo { get; set; }
2018-12-26 21:16:35 +08:00
public PlayerLoader(Func<Player> createPlayer)
2018-04-13 17:19:50 +08:00
{
2018-12-26 21:16:35 +08:00
this.createPlayer = createPlayer;
}
2018-04-13 17:19:50 +08:00
[BackgroundDependencyLoader]
2021-10-07 13:15:16 +08:00
private void load(SessionStatics sessionStatics, AudioManager audio)
2018-04-13 17:19:50 +08:00
{
2019-10-01 23:39:01 +08:00
muteWarningShownOnce = sessionStatics.GetBindable<bool>(Static.MutedAudioNotificationShownOnce);
batteryWarningShownOnce = sessionStatics.GetBindable<bool>(Static.LowBatteryNotificationShownOnce);
2019-10-01 23:39:01 +08:00
InternalChildren = new Drawable[]
2019-03-27 17:11:12 +08:00
{
(content = new LogoTrackingContainer
{
2019-03-27 17:11:12 +08:00
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
RelativeSizeAxes = Axes.Both,
}).WithChildren(new Drawable[]
2019-03-27 17:11:12 +08:00
{
MetadataInfo = new BeatmapMetadataDisplay(Beatmap.Value, Mods, content.LogoFacade)
2019-01-24 18:55:42 +08:00
{
Alpha = 0,
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
},
PlayerSettings = new FillFlowContainer<PlayerSettingsGroup>
{
Anchor = Anchor.TopRight,
Origin = Anchor.TopRight,
AutoSizeAxes = Axes.Both,
Direction = FillDirection.Vertical,
Spacing = new Vector2(0, 20),
Margin = new MarginPadding(25),
Children = new PlayerSettingsGroup[]
{
VisualSettings = new VisualSettings(),
new InputSettings()
}
},
idleTracker = new IdleTracker(750),
}),
lowPassFilter = new AudioFilter(audio.TrackMixer)
};
2020-10-20 06:08:05 +08:00
if (Beatmap.Value.BeatmapInfo.EpilepsyWarning)
{
AddInternal(epilepsyWarning = new EpilepsyWarning
{
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
});
}
2018-04-13 17:19:50 +08:00
}
2019-10-03 18:16:31 +08:00
protected override void LoadComplete()
{
base.LoadComplete();
inputManager = GetContainingInputManager();
}
2020-02-14 17:28:58 +08:00
#region Screen handling
public override void OnEntering(IScreen last)
{
base.OnEntering(last);
ApplyToBackground(b =>
{
if (epilepsyWarning != null)
epilepsyWarning.DimmableBackground = b;
});
2020-10-25 19:33:35 +08:00
Beatmap.Value.Track.AddAdjustment(AdjustableProperty.Volume, volumeAdjustment);
content.ScaleTo(0.7f);
contentIn();
MetadataInfo.Delay(750).FadeIn(500);
// after an initial delay, start the debounced load check.
// this will continue to execute even after resuming back on restart.
Scheduler.Add(new ScheduledDelegate(pushWhenLoaded, Clock.CurrentTime + 1800, 0));
2019-10-03 18:16:31 +08:00
2020-02-14 17:28:58 +08:00
showMuteWarningIfNeeded();
showBatteryWarningIfNeeded();
2019-10-03 18:16:31 +08:00
}
2019-01-23 19:52:00 +08:00
public override void OnResuming(IScreen last)
2018-04-13 17:19:50 +08:00
{
base.OnResuming(last);
// prepare for a retry.
player = null;
playerConsumed = false;
cancelLoad();
2018-04-13 17:19:50 +08:00
contentIn();
}
2020-02-14 17:22:57 +08:00
public override void OnSuspending(IScreen next)
2018-12-26 21:16:35 +08:00
{
2020-02-14 17:22:57 +08:00
base.OnSuspending(next);
2018-12-26 21:16:35 +08:00
2020-02-14 17:22:57 +08:00
BackgroundBrightnessReduction = false;
2020-10-25 19:33:35 +08:00
// we're moving to player, so a period of silence is upcoming.
// stop the track before removing adjustment to avoid a volume spike.
Beatmap.Value.Track.Stop();
Beatmap.Value.Track.RemoveAdjustment(AdjustableProperty.Volume, volumeAdjustment);
lowPassFilter.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF);
2018-12-26 21:16:35 +08:00
}
2020-02-14 17:22:57 +08:00
public override bool OnExiting(IScreen next)
2018-04-13 17:19:50 +08:00
{
2020-02-14 17:22:57 +08:00
cancelLoad();
contentOut();
2018-04-13 17:19:50 +08:00
// If the load sequence was interrupted, the epilepsy warning may already be displayed (or in the process of being displayed).
epilepsyWarning?.Hide();
// Ensure the screen doesn't expire until all the outwards fade operations have completed.
this.Delay(content_out_duration).FadeOut();
ApplyToBackground(b => b.IgnoreUserSettings.Value = true);
2020-02-14 17:22:57 +08:00
BackgroundBrightnessReduction = false;
2020-10-25 19:33:35 +08:00
Beatmap.Value.Track.RemoveAdjustment(AdjustableProperty.Volume, volumeAdjustment);
2020-02-14 17:22:57 +08:00
return base.OnExiting(next);
2018-04-13 17:19:50 +08:00
}
protected override void LogoArriving(OsuLogo logo, bool resuming)
{
base.LogoArriving(logo, resuming);
2019-03-22 19:01:58 +08:00
const double duration = 300;
2018-04-13 17:19:50 +08:00
2020-02-14 17:22:57 +08:00
if (!resuming) logo.MoveTo(new Vector2(0.5f), duration, Easing.In);
2019-03-22 19:01:58 +08:00
logo.ScaleTo(new Vector2(0.15f), duration, Easing.In);
2018-04-13 17:19:50 +08:00
logo.FadeIn(350);
Scheduler.AddDelayed(() =>
{
if (this.IsCurrentScreen())
content.StartTracking(logo, resuming ? 0 : 500, Easing.InOutExpo);
}, resuming ? 0 : 500);
2019-03-26 16:18:35 +08:00
}
protected override void LogoExiting(OsuLogo logo)
{
base.LogoExiting(logo);
2019-04-08 14:24:09 +08:00
content.StopTracking();
2018-04-13 17:19:50 +08:00
}
2020-02-14 17:28:58 +08:00
#endregion
2020-02-14 17:22:57 +08:00
protected override void Update()
{
base.Update();
2018-04-13 17:19:50 +08:00
2020-02-14 17:22:57 +08:00
if (!this.IsCurrentScreen())
return;
// We need to perform this check here rather than in OnHover as any number of children of VisualSettings
// may also be handling the hover events.
if (inputManager.HoveredDrawables.Contains(VisualSettings))
{
// Preview user-defined background dim and blur when hovered on the visual settings panel.
ApplyToBackground(b =>
{
b.IgnoreUserSettings.Value = false;
b.BlurAmount.Value = 0;
});
2020-02-14 17:22:57 +08:00
BackgroundBrightnessReduction = false;
}
else
{
ApplyToBackground(b =>
{
// Returns background dim and blur to the values specified by PlayerLoader.
b.IgnoreUserSettings.Value = true;
b.BlurAmount.Value = BACKGROUND_BLUR;
});
2020-02-14 17:22:57 +08:00
BackgroundBrightnessReduction = true;
}
}
private Player consumePlayer()
{
Debug.Assert(!playerConsumed);
playerConsumed = true;
return player;
}
2020-02-14 17:22:57 +08:00
private void prepareNewPlayer()
{
if (!this.IsCurrentScreen())
return;
2020-02-14 17:22:57 +08:00
player = createPlayer();
2021-03-31 13:09:38 +08:00
player.RestartCount = restartCount++;
2020-02-14 17:22:57 +08:00
player.RestartRequested = restartRequested;
2020-02-14 17:22:57 +08:00
LoadTask = LoadComponentAsync(player, _ => MetadataInfo.Loading = false);
}
private void restartRequested()
{
hideOverlays = true;
ValidForResume = true;
}
private void contentIn()
{
MetadataInfo.Loading = true;
2020-02-14 17:22:57 +08:00
content.FadeInFromZero(400);
content.ScaleTo(1, 650, Easing.OutQuint).Then().Schedule(prepareNewPlayer);
lowPassFilter.CutoffTo(1000, 650, Easing.OutQuint);
ApplyToBackground(b => b?.FadeColour(Color4.White, 800, Easing.OutQuint));
2020-02-14 17:22:57 +08:00
}
private void contentOut()
{
// Ensure the logo is no longer tracking before we scale the content
content.StopTracking();
content.ScaleTo(0.7f, content_out_duration * 2, Easing.OutQuint);
content.FadeOut(content_out_duration, Easing.OutQuint);
lowPassFilter.CutoffTo(AudioFilter.MAX_LOWPASS_CUTOFF, content_out_duration);
2020-02-14 17:22:57 +08:00
}
2018-04-13 17:19:50 +08:00
private void pushWhenLoaded()
{
2019-01-23 19:52:00 +08:00
if (!this.IsCurrentScreen()) return;
2018-04-13 17:19:50 +08:00
if (!readyForPush)
2018-04-13 17:19:50 +08:00
{
// as the pushDebounce below has a delay, we need to keep checking and cancel a future debounce
// if we become unready for push during the delay.
cancelLoad();
return;
}
2018-04-13 17:19:50 +08:00
// if a push has already been scheduled, no further action is required.
// this value is reset via cancelLoad() to allow a second usage of the same PlayerLoader screen.
if (scheduledPushPlayer != null)
return;
2018-04-13 17:19:50 +08:00
scheduledPushPlayer = Scheduler.AddDelayed(() =>
{
// ensure that once we have reached this "point of no return", readyForPush will be false for all future checks (until a new player instance is prepared).
var consumedPlayer = consumePlayer();
2018-04-13 17:19:50 +08:00
contentOut();
2020-10-20 06:22:30 +08:00
TransformSequence<PlayerLoader> pushSequence = this.Delay(content_out_duration);
// only show if the warning was created (i.e. the beatmap needs it)
// and this is not a restart of the map (the warning expires after first load).
if (epilepsyWarning?.IsAlive == true)
{
const double epilepsy_display_length = 3000;
pushSequence
.Schedule(() => epilepsyWarning.State.Value = Visibility.Visible)
.TransformBindableTo(volumeAdjustment, 0.25, EpilepsyWarning.FADE_DURATION, Easing.OutQuint)
.Delay(epilepsy_display_length)
.Schedule(() =>
{
epilepsyWarning.Hide();
epilepsyWarning.Expire();
})
.Delay(EpilepsyWarning.FADE_DURATION);
}
else
{
// This goes hand-in-hand with the restoration of low pass filter in contentOut().
this.TransformBindableTo(volumeAdjustment, 0, content_out_duration, Easing.OutCubic);
}
2018-04-13 17:19:50 +08:00
pushSequence.Schedule(() =>
{
if (!this.IsCurrentScreen()) return;
2018-04-13 17:19:50 +08:00
LoadTask = null;
// By default, we want to load the player and never be returned to.
// Note that this may change if the player we load requested a re-run.
ValidForResume = false;
if (consumedPlayer.LoadedBeatmapSuccessfully)
this.Push(consumedPlayer);
else
this.Exit();
});
}, 500);
2018-04-13 17:19:50 +08:00
}
private void cancelLoad()
{
2020-02-14 17:22:57 +08:00
scheduledPushPlayer?.Cancel();
scheduledPushPlayer = null;
2018-04-13 17:19:50 +08:00
}
2020-02-14 17:22:57 +08:00
#region Disposal
2018-04-13 17:19:50 +08:00
protected override void Dispose(bool isDisposing)
{
base.Dispose(isDisposing);
if (isDisposing)
{
// if the player never got pushed, we should explicitly dispose it.
DisposalTask = LoadTask?.ContinueWith(_ => player?.Dispose());
}
2018-04-13 17:19:50 +08:00
}
2020-02-14 17:22:57 +08:00
#endregion
2020-02-14 17:28:58 +08:00
#region Mute warning
private Bindable<bool> muteWarningShownOnce;
private int restartCount;
2020-02-14 17:28:58 +08:00
private void showMuteWarningIfNeeded()
{
if (!muteWarningShownOnce.Value)
{
2020-05-05 09:31:11 +08:00
// Checks if the notification has not been shown yet and also if master volume is muted, track/music volume is muted or if the whole game is muted.
2020-02-14 17:28:58 +08:00
if (volumeOverlay?.IsMuted.Value == true || audioManager.Volume.Value <= audioManager.Volume.MinValue || audioManager.VolumeTrack.Value <= audioManager.VolumeTrack.MinValue)
{
notificationOverlay?.Post(new MutedNotification());
muteWarningShownOnce.Value = true;
}
}
}
private class MutedNotification : SimpleNotification
{
2020-02-14 17:22:57 +08:00
public override bool IsImportant => true;
public MutedNotification()
{
Text = "Your music volume is set to 0%! Click here to restore it.";
}
[BackgroundDependencyLoader]
private void load(OsuColour colours, AudioManager audioManager, NotificationOverlay notificationOverlay, VolumeOverlay volumeOverlay)
{
Icon = FontAwesome.Solid.VolumeMute;
IconBackgound.Colour = colours.RedDark;
Activated = delegate
{
notificationOverlay.Hide();
2019-09-15 22:50:01 +08:00
volumeOverlay.IsMuted.Value = false;
audioManager.Volume.SetDefault();
audioManager.VolumeTrack.SetDefault();
return true;
};
}
}
2020-02-14 17:28:58 +08:00
#endregion
#region Low battery warning
2021-04-09 08:28:23 +08:00
private Bindable<bool> batteryWarningShownOnce;
private void showBatteryWarningIfNeeded()
{
if (batteryInfo == null) return;
if (!batteryWarningShownOnce.Value)
{
2021-04-12 23:11:22 +08:00
if (!batteryInfo.IsCharging && batteryInfo.ChargeLevel <= 0.25)
{
notificationOverlay?.Post(new BatteryWarningNotification());
batteryWarningShownOnce.Value = true;
}
}
}
private class BatteryWarningNotification : SimpleNotification
{
public override bool IsImportant => true;
public BatteryWarningNotification()
{
Text = "Your battery level is low! Charge your device to prevent interruptions during gameplay.";
}
[BackgroundDependencyLoader]
private void load(OsuColour colours, NotificationOverlay notificationOverlay)
{
Icon = FontAwesome.Solid.BatteryQuarter;
IconBackgound.Colour = colours.RedDark;
Activated = delegate
{
notificationOverlay.Hide();
return true;
};
}
}
#endregion
2018-04-13 17:19:50 +08:00
}
}