Storyboards implementation.

osu.Desktop.Tests/Visual/TestCaseStoryboard.cs

@@ -0,0 +1,90 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using OpenTK.Graphics;
+using osu.Framework.Allocation;
+using osu.Framework.Configuration;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Containers;
+using osu.Framework.Graphics.Shapes;
+using osu.Framework.Timing;
+using osu.Game;
+using osu.Game.Beatmaps;
+using osu.Game.Overlays;
+using osu.Game.Storyboards.Drawables;
+
+namespace osu.Desktop.Tests.Visual
+{
+    internal class TestCaseStoryboard : OsuTestCase
+    {
+        public override string Description => @"Tests storyboards.";
+
+        private readonly Bindable<WorkingBeatmap> beatmapBacking = new Bindable<WorkingBeatmap>();
+
+        private readonly Container<DrawableStoryboard> storyboardContainer;
+        private DrawableStoryboard storyboard;
+
+        public TestCaseStoryboard()
+        {
+            Clock = new FramedClock();
+
+            Add(new Container
+            {
+                RelativeSizeAxes = Axes.Both,
+                Children = new Drawable[]
+                {
+                    new Box
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                        Colour = Color4.Black,
+                    },
+                    storyboardContainer = new Container<DrawableStoryboard>
+                    {
+                        RelativeSizeAxes = Axes.Both,
+                    },
+                },
+            });
+            Add(new MusicController
+            {
+                Origin = Anchor.TopRight,
+                Anchor = Anchor.TopRight,
+                State = Visibility.Visible,
+            });
+
+            AddStep("Restart", restart);
+            AddToggleStep("Passing", passing => { if (storyboard != null) storyboard.Passing = passing; });
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuGameBase game)
+        {
+            beatmapBacking.BindTo(game.Beatmap);
+            beatmapBacking.ValueChanged += beatmapChanged;
+        }
+
+        private void beatmapChanged(WorkingBeatmap working)
+            => loadStoryboard(working);
+
+        private void restart()
+        {
+            var track = beatmapBacking.Value.Track;
+
+            track.Reset();
+            loadStoryboard(beatmapBacking.Value);
+            track.Start();
+        }
+
+        private void loadStoryboard(WorkingBeatmap working)
+        {
+            if (storyboard != null)
+                storyboardContainer.Remove(storyboard);
+
+            var decoupledClock = new DecoupleableInterpolatingFramedClock { IsCoupled = true };
+            decoupledClock.ChangeSource(working.Track);
+            storyboardContainer.Clock = decoupledClock;
+
+            storyboardContainer.Add(storyboard = working.Beatmap.Storyboard.CreateDrawable());
+            storyboard.Passing = false;
+        }
+    }
+}

osu.Desktop.Tests/osu.Desktop.Tests.csproj

@@ -92,6 +92,7 @@
     <Compile Include="Visual\TestCaseMenuButtonSystem.cs" />
     <Compile Include="Visual\TestCaseMenuOverlays.cs" />
     <Compile Include="Visual\TestCaseMods.cs" />
+    <Compile Include="Visual\TestCaseStoryboard.cs" />
     <Compile Include="Visual\TestCaseMusicController.cs" />
     <Compile Include="Visual\TestCaseNotificationOverlay.cs" />
     <Compile Include="Visual\TestCaseOnScreenDisplay.cs" />

osu.Game/Beatmaps/Beatmap.cs

@@ -8,6 +8,7 @@
 using System.Linq;
 using osu.Game.Beatmaps.ControlPoints;
 using osu.Game.IO.Serialization;
+using osu.Game.Storyboards;
 
 namespace osu.Game.Beatmaps
 {
@@ -40,6 +41,11 @@ public class Beatmap<T>
         /// </summary>
         public double TotalBreakTime => Breaks.Sum(b => b.Duration);
 
+        /// <summary>
+        /// The Beatmap's Storyboard.
+        /// </summary>
+        public Storyboard Storyboard = new Storyboard();
+
         /// <summary>
         /// Constructs a new beatmap.
         /// </summary>
@@ -51,6 +57,7 @@ public Beatmap(Beatmap<T> original = null)
             Breaks = original?.Breaks ?? Breaks;
             ComboColors = original?.ComboColors ?? ComboColors;
             HitObjects = original?.HitObjects ?? HitObjects;
+            Storyboard = original?.Storyboard ?? Storyboard;
         }
     }