Merge branch 'master' into editor-song-end

osu.Game/Screens/Edit/EditorClock.cs

@@ -3,8 +3,12 @@
 
 using System;
 using System.Linq;
-using osu.Framework.Utils;
+using osu.Framework.Audio.Track;
+using osu.Framework.Bindables;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Transforms;
 using osu.Framework.Timing;
+using osu.Framework.Utils;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
 
@@ -13,22 +17,34 @@ 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 : DecoupleableInterpolatingFramedClock
+    public class EditorClock : Component, IFrameBasedClock, IAdjustableClock, ISourceChangeableClock
     {
-        public readonly double TrackLength;
+        public IBindable<Track> Track => track;
+
+        private readonly Bindable<Track> track = new Bindable<Track>();
+
+        public double TrackLength => track.Value?.Length ?? 60000;
 
         public ControlPointInfo ControlPointInfo;
 
         private readonly BindableBeatDivisor beatDivisor;
 
+        private readonly DecoupleableInterpolatingFramedClock underlyingClock;
+
         private bool playbackFinished;
 
-        public EditorClock(WorkingBeatmap beatmap, BindableBeatDivisor beatDivisor)
-        {
-            this.beatDivisor = beatDivisor;
+        public IBindable<bool> SeekingOrStopped => seekingOrStopped;
 
-            ControlPointInfo = beatmap.Beatmap.ControlPointInfo;
-            TrackLength = beatmap.Track.Length;
+        private readonly Bindable<bool> seekingOrStopped = new Bindable<bool>(true);
+
+        /// <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)
+        {
         }
 
         public EditorClock(ControlPointInfo controlPointInfo, double trackLength, BindableBeatDivisor beatDivisor)
@@ -36,29 +52,13 @@ namespace osu.Game.Screens.Edit
             this.beatDivisor = beatDivisor;
 
             ControlPointInfo = controlPointInfo;
-            TrackLength = trackLength;
+
+            underlyingClock = new DecoupleableInterpolatingFramedClock();
         }
 
-        public override void ProcessFrame()
+        public EditorClock()
+            : this(new ControlPointInfo(), 1000, new BindableBeatDivisor())
         {
-            base.ProcessFrame();
-
-            if (IsRunning)
-            {
-                var playbackAlreadyStopped = playbackFinished;
-                playbackFinished = CurrentTime >= TrackLength;
-
-                if (playbackFinished)
-                {
-                    if (!playbackAlreadyStopped)
-                    {
-                        Stop();
-                        Seek(TrackLength);
-                    }
-                    else
-                        Seek(0);
-                }
-            }
         }
 
         /// <summary>
@@ -92,7 +92,7 @@ namespace osu.Game.Screens.Edit
         /// </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);
+        public void SeekBackward(bool snapped = false, double amount = 1) => seek(-1, snapped, amount + (IsRunning ? 1.5 : 0));
 
         /// <summary>
         /// Seeks forwards by one beat length.
@@ -103,20 +103,22 @@ namespace osu.Game.Screens.Edit
 
         private void seek(int direction, bool snapped, double amount = 1)
         {
+            double current = CurrentTimeAccurate;
+
             if (amount <= 0) throw new ArgumentException("Value should be greater than zero", nameof(amount));
 
-            var timingPoint = ControlPointInfo.TimingPointAt(CurrentTime);
+            var timingPoint = ControlPointInfo.TimingPointAt(current);
 
-            if (direction < 0 && timingPoint.Time == CurrentTime)
+            if (direction < 0 && timingPoint.Time == current)
                 // 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(CurrentTime - 1);
+                timingPoint = ControlPointInfo.TimingPointAt(current - 1);
 
             double seekAmount = timingPoint.BeatLength / beatDivisor.Value * amount;
-            double seekTime = CurrentTime + seekAmount * direction;
+            double seekTime = current + seekAmount * direction;
 
             if (!snapped || ControlPointInfo.TimingPoints.Count == 0)
             {
-                Seek(seekTime);
+                SeekSmoothlyTo(seekTime);
                 return;
             }
 
@@ -132,9 +134,14 @@ namespace osu.Game.Screens.Edit
 
             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;
+
             // 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(CurrentTime, seekTime))
+            if (Precision.AlmostEquals(current, seekTime, 0.5f))
             {
                 closestBeat += direction > 0 ? 1 : -1;
                 seekTime = timingPoint.Time + closestBeat * seekAmount;
@@ -143,13 +150,169 @@ namespace osu.Game.Screens.Edit
             if (seekTime < timingPoint.Time && timingPoint != ControlPointInfo.TimingPoints.First())
                 seekTime = timingPoint.Time;
 
-            var nextTimingPoint = ControlPointInfo.TimingPoints.FirstOrDefault(t => t.Time > timingPoint.Time);
-            if (seekTime > nextTimingPoint?.Time)
-                seekTime = nextTimingPoint.Time;
-
             // Ensure the sought point is within the boundaries
             seekTime = Math.Clamp(seekTime, 0, TrackLength);
-            Seek(seekTime);
+            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();
+            underlyingClock.Start();
+        }
+
+        public void Stop()
+        {
+            seekingOrStopped.Value = true;
+            underlyingClock.Stop();
+        }
+
+        public bool Seek(double position)
+        {
+            seekingOrStopped.Value = IsSeeking = true;
+
+            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();
+
+            if (IsRunning)
+            {
+                var playbackAlreadyStopped = playbackFinished;
+                playbackFinished = CurrentTime >= TrackLength;
+
+                if (playbackFinished)
+                {
+                    if (!playbackAlreadyStopped)
+                    {
+                        underlyingClock.Stop();
+                        underlyingClock.Seek(TrackLength);
+                    }
+                    else
+                        underlyingClock.Seek(0);
+                }
+            }
+        }
+
+        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();
+
+            updateSeekingState();
+        }
+
+        private void updateSeekingState()
+        {
+            if (seekingOrStopped.Value)
+            {
+                IsSeeking &= Transforms.Any();
+
+                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;
+                }
+
+                // 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;
         }
     }
 }