osu/osu.Game/Screens/Edit/EditorClock.cs

317 lines
11 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 09:19:50 +00:00
using System;
using System.Linq;
using osu.Framework.Audio.Track;
using osu.Framework.Bindables;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Transforms;
2018-04-13 09:19:50 +00:00
using osu.Framework.Timing;
using osu.Framework.Utils;
using osu.Game.Beatmaps;
2018-04-13 09:19:50 +00:00
using osu.Game.Beatmaps.ControlPoints;
namespace osu.Game.Screens.Edit
{
/// <summary>
/// A decoupled clock which adds editor-specific functionality, such as snapping to a user-defined beat divisor.
/// </summary>
public class EditorClock : Component, IFrameBasedClock, IAdjustableClock, ISourceChangeableClock
2018-04-13 09:19:50 +00:00
{
public IBindable<Track> Track => track;
private readonly Bindable<Track> track = new Bindable<Track>();
public double TrackLength => track.Value?.Length ?? 60000;
2018-04-13 09:19:50 +00:00
public ControlPointInfo ControlPointInfo;
private readonly BindableBeatDivisor beatDivisor;
private readonly DecoupleableInterpolatingFramedClock underlyingClock;
2020-03-13 23:42:05 +00:00
private bool playbackFinished;
public IBindable<bool> SeekingOrStopped => seekingOrStopped;
2020-09-29 03:45:20 +00:00
private readonly Bindable<bool> seekingOrStopped = new Bindable<bool>(true);
2020-09-29 03:45:20 +00:00
/// <summary>
/// Whether a seek is currently in progress. True for the duration of a seek performed via <see cref="SeekSmoothlyTo"/>.
/// </summary>
public bool IsSeeking { get; private set; }
public EditorClock(WorkingBeatmap beatmap, BindableBeatDivisor beatDivisor)
: this(beatmap.Beatmap.ControlPointInfo, beatmap.Track.Length, beatDivisor)
{
}
2018-05-21 10:23:39 +00:00
2018-05-08 13:37:06 +00:00
public EditorClock(ControlPointInfo controlPointInfo, double trackLength, BindableBeatDivisor beatDivisor)
2018-04-13 09:19:50 +00:00
{
this.beatDivisor = beatDivisor;
ControlPointInfo = controlPointInfo;
underlyingClock = new DecoupleableInterpolatingFramedClock();
2018-04-13 09:19:50 +00:00
}
2020-05-22 09:23:24 +00:00
public EditorClock()
: this(new ControlPointInfo(), 1000, new BindableBeatDivisor())
{
}
2018-04-13 09:19:50 +00:00
/// <summary>
/// Seek to the closest snappable beat from a time.
/// </summary>
/// <param name="position">The raw position which should be seeked around.</param>
/// <returns>Whether the seek could be performed.</returns>
public bool SeekSnapped(double position)
{
var timingPoint = ControlPointInfo.TimingPointAt(position);
2019-02-21 09:56:34 +00:00
double beatSnapLength = timingPoint.BeatLength / beatDivisor.Value;
2018-04-13 09:19:50 +00:00
// We will be snapping to beats within the timing point
position -= timingPoint.Time;
// Determine the index from the current timing point of the closest beat to position
int closestBeat = (int)Math.Round(position / beatSnapLength);
position = timingPoint.Time + closestBeat * beatSnapLength;
// Depending on beatSnapLength, we may snap to a beat that is beyond timingPoint's end time, but we want to instead snap to
// the next timing point's start time
2019-10-25 10:48:01 +00:00
var nextTimingPoint = ControlPointInfo.TimingPoints.FirstOrDefault(t => t.Time > timingPoint.Time);
2018-04-13 09:19:50 +00:00
if (position > nextTimingPoint?.Time)
position = nextTimingPoint.Time;
return Seek(position);
}
/// <summary>
/// Seeks backwards by one beat length.
/// </summary>
/// <param name="snapped">Whether to snap to the closest beat after seeking.</param>
/// <param name="amount">The relative amount (magnitude) which should be seeked.</param>
public void SeekBackward(bool snapped = false, double amount = 1) => seek(-1, snapped, amount + (IsRunning ? 1.5 : 0));
2018-04-13 09:19:50 +00:00
/// <summary>
/// Seeks forwards by one beat length.
/// </summary>
/// <param name="snapped">Whether to snap to the closest beat after seeking.</param>
/// <param name="amount">The relative amount (magnitude) which should be seeked.</param>
public void SeekForward(bool snapped = false, double amount = 1) => seek(1, snapped, amount);
2018-04-13 09:19:50 +00:00
private void seek(int direction, bool snapped, double amount = 1)
2018-04-13 09:19:50 +00:00
{
2020-05-22 13:11:55 +00:00
double current = CurrentTimeAccurate;
if (amount <= 0) throw new ArgumentException("Value should be greater than zero", nameof(amount));
var timingPoint = ControlPointInfo.TimingPointAt(current);
2019-04-01 03:16:05 +00:00
if (direction < 0 && timingPoint.Time == current)
2018-04-13 09:19:50 +00:00
// When going backwards and we're at the boundary of two timing points, we compute the seek distance with the timing point which we are seeking into
timingPoint = ControlPointInfo.TimingPointAt(current - 1);
2018-04-13 09:19:50 +00:00
2019-02-21 09:56:34 +00:00
double seekAmount = timingPoint.BeatLength / beatDivisor.Value * amount;
double seekTime = current + seekAmount * direction;
2018-04-13 09:19:50 +00:00
if (!snapped || ControlPointInfo.TimingPoints.Count == 0)
{
SeekSmoothlyTo(seekTime);
2018-04-13 09:19:50 +00:00
return;
}
// We will be snapping to beats within timingPoint
seekTime -= timingPoint.Time;
// Determine the index from timingPoint of the closest beat to seekTime, accounting for scrolling direction
int closestBeat;
if (direction > 0)
closestBeat = (int)Math.Floor(seekTime / seekAmount);
else
closestBeat = (int)Math.Ceiling(seekTime / seekAmount);
seekTime = timingPoint.Time + closestBeat * seekAmount;
// limit forward seeking to only up to the next timing point's start time.
var nextTimingPoint = ControlPointInfo.TimingPoints.FirstOrDefault(t => t.Time > timingPoint.Time);
if (seekTime > nextTimingPoint?.Time)
seekTime = nextTimingPoint.Time;
2018-04-13 09:19:50 +00:00
// Due to the rounding above, we may end up on the current beat. This will effectively cause 0 seeking to happen, but we don't want this.
// Instead, we'll go to the next beat in the direction when this is the case
if (Precision.AlmostEquals(current, seekTime, 0.5f))
2018-04-13 09:19:50 +00:00
{
closestBeat += direction > 0 ? 1 : -1;
seekTime = timingPoint.Time + closestBeat * seekAmount;
}
if (seekTime < timingPoint.Time && timingPoint != ControlPointInfo.TimingPoints.First())
seekTime = timingPoint.Time;
2018-05-08 13:37:06 +00:00
// Ensure the sought point is within the boundaries
seekTime = Math.Clamp(seekTime, 0, TrackLength);
SeekSmoothlyTo(seekTime);
}
/// <summary>
/// The current time of this clock, include any active transform seeks performed via <see cref="SeekSmoothlyTo"/>.
/// </summary>
public double CurrentTimeAccurate =>
Transforms.OfType<TransformSeek>().FirstOrDefault()?.EndValue ?? CurrentTime;
public double CurrentTime => underlyingClock.CurrentTime;
public void Reset()
{
ClearTransforms();
underlyingClock.Reset();
}
public void Start()
{
ClearTransforms();
if (playbackFinished)
underlyingClock.Seek(0);
underlyingClock.Start();
}
public void Stop()
{
seekingOrStopped.Value = true;
underlyingClock.Stop();
}
public bool Seek(double position)
{
seekingOrStopped.Value = IsSeeking = true;
2020-09-29 03:45:20 +00:00
ClearTransforms();
return underlyingClock.Seek(position);
}
/// <summary>
/// Seek smoothly to the provided destination.
/// Use <see cref="Seek"/> to perform an immediate seek.
/// </summary>
/// <param name="seekDestination"></param>
public void SeekSmoothlyTo(double seekDestination)
{
seekingOrStopped.Value = true;
if (IsRunning)
Seek(seekDestination);
else
{
transformSeekTo(seekDestination, transform_time, Easing.OutQuint);
}
}
public void ResetSpeedAdjustments() => underlyingClock.ResetSpeedAdjustments();
double IAdjustableClock.Rate
{
get => underlyingClock.Rate;
set => underlyingClock.Rate = value;
}
double IClock.Rate => underlyingClock.Rate;
public bool IsRunning => underlyingClock.IsRunning;
public void ProcessFrame()
{
underlyingClock.ProcessFrame();
playbackFinished = CurrentTime >= TrackLength;
2021-03-18 23:20:31 +00:00
if (playbackFinished)
{
if (IsRunning)
underlyingClock.Stop();
2021-03-18 23:20:31 +00:00
if (CurrentTime > TrackLength)
underlyingClock.Seek(TrackLength);
}
}
public double ElapsedFrameTime => underlyingClock.ElapsedFrameTime;
public double FramesPerSecond => underlyingClock.FramesPerSecond;
public FrameTimeInfo TimeInfo => underlyingClock.TimeInfo;
public void ChangeSource(IClock source)
{
track.Value = source as Track;
underlyingClock.ChangeSource(source);
}
public IClock Source => underlyingClock.Source;
public bool IsCoupled
{
get => underlyingClock.IsCoupled;
set => underlyingClock.IsCoupled = value;
}
private const double transform_time = 300;
protected override void Update()
{
base.Update();
2020-09-29 03:45:20 +00:00
updateSeekingState();
}
private void updateSeekingState()
{
if (seekingOrStopped.Value)
{
IsSeeking &= Transforms.Any();
2020-09-29 03:45:20 +00:00
if (track.Value?.IsRunning != true)
{
// seeking in the editor can happen while the track isn't running.
// in this case we always want to expose ourselves as seeking (to avoid sample playback).
return;
}
2020-09-29 03:17:38 +00:00
// we are either running a seek tween or doing an immediate seek.
// in the case of an immediate seek the seeking bool will be set to false after one update.
// this allows for silencing hit sounds and the likes.
seekingOrStopped.Value = IsSeeking;
}
}
private void transformSeekTo(double seek, double duration = 0, Easing easing = Easing.None)
=> this.TransformTo(this.PopulateTransform(new TransformSeek(), seek, duration, easing));
private double currentTime
{
get => underlyingClock.CurrentTime;
set => underlyingClock.Seek(value);
}
private class TransformSeek : Transform<double, EditorClock>
{
public override string TargetMember => nameof(currentTime);
protected override void Apply(EditorClock clock, double time) => clock.currentTime = valueAt(time);
private double valueAt(double time)
{
if (time < StartTime) return StartValue;
if (time >= EndTime) return EndValue;
return Interpolation.ValueAt(time, StartValue, EndValue, StartTime, EndTime, Easing);
}
protected override void ReadIntoStartValue(EditorClock clock) => StartValue = clock.currentTime;
2018-04-13 09:19:50 +00:00
}
}
}