Merge pull request #1338 from smoogipoo/editor-waveform

Waveform display for use in the editor

osu-framework

@@ -1 +1 @@
-Subproject commit b43aecdce95f59912aa0b7211dde3aba1ed9afb1
+Subproject commit 255b94f5dde0188db1a5b37daf9649659e2b8366

osu.Game/Beatmaps/BeatmapManager.cs

@@ -573,6 +573,16 @@ namespace osu.Game.Beatmaps
                 }
                 catch { return new TrackVirtual(); }
             }
+
+            protected override Waveform GetWaveform()
+            {
+                try
+                {
+                    var trackData = store.GetStream(getPathForFile(Metadata.AudioFile));
+                    return trackData == null ? new Waveform() : new Waveform(trackData);
+                }
+                catch { return new Waveform(); }
+            }
         }
 
         /// <summary>

osu.Game/Beatmaps/WorkingBeatmap.cs

@@ -43,6 +43,7 @@ namespace osu.Game.Beatmaps
         protected abstract Beatmap GetBeatmap();
         protected abstract Texture GetBackground();
         protected abstract Track GetTrack();
+        protected virtual Waveform GetWaveform() => new Waveform();
 
         private Beatmap beatmap;
         private readonly object beatmapLock = new object();
@@ -96,6 +97,17 @@ namespace osu.Game.Beatmaps
             }
         }
 
+        private Waveform waveform;
+        private readonly object waveformLock = new object();
+        public Waveform Waveform
+        {
+            get
+            {
+                lock (waveformLock)
+                    return waveform ?? (waveform = GetWaveform());
+            }
+        }
+
         public bool TrackLoaded => track != null;
 
         public void TransferTo(WorkingBeatmap other)
@@ -114,6 +126,8 @@ namespace osu.Game.Beatmaps
         {
             background?.Dispose();
             background = null;
+
+            waveform?.Dispose();
         }
 
         public void DisposeTrack()

osu.Game/Screens/Edit/Screens/Compose/BeatmapWaveformGraph.cs

@@ -0,0 +1,33 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using osu.Framework.Configuration;
+using osu.Framework.Graphics;
+using osu.Framework.Graphics.Audio;
+using osu.Framework.Graphics.Containers;
+using osu.Game.Beatmaps;
+
+namespace osu.Game.Screens.Edit.Screens.Compose
+{
+    public class BeatmapWaveformGraph : CompositeDrawable
+    {
+        public readonly Bindable<WorkingBeatmap> Beatmap = new Bindable<WorkingBeatmap>();
+
+        private readonly WaveformGraph graph;
+
+        public BeatmapWaveformGraph()
+        {
+            InternalChild = graph = new WaveformGraph { RelativeSizeAxes = Axes.Both };
+            Beatmap.ValueChanged += b => graph.Waveform = b.Waveform;
+        }
+
+        /// <summary>
+        /// Gets or sets the <see cref="WaveformGraph.Resolution"/>.
+        /// </summary>
+        public float Resolution
+        {
+            get { return graph.Resolution; }
+            set { graph.Resolution = value; }
+        }
+    }
+}

osu.Game/Tests/Visual/TestCaseWaveform.cs

@@ -0,0 +1,88 @@
+// 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;
+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.Game.Beatmaps;
+using osu.Game.Graphics.Sprites;
+using osu.Game.Overlays;
+using osu.Game.Screens.Edit.Screens.Compose;
+
+namespace osu.Game.Tests.Visual
+{
+    internal class TestCaseWaveform : OsuTestCase
+    {
+        private readonly Bindable<WorkingBeatmap> beatmapBacking = new Bindable<WorkingBeatmap>();
+
+        public TestCaseWaveform()
+        {
+            FillFlowContainer flow;
+            Child = flow = new FillFlowContainer
+            {
+                RelativeSizeAxes = Axes.Both,
+                Direction = FillDirection.Vertical,
+                Spacing = new Vector2(0, 10),
+                Children = new Drawable[]
+                {
+                    new MusicController
+                    {
+                        Anchor = Anchor.TopCentre,
+                        Origin = Anchor.TopCentre,
+                        Y = 100,
+                        State = Visibility.Visible
+                    },
+                }
+            };
+
+            for (int i = 1; i <= 16; i *= 2)
+            {
+                var newDisplay = new BeatmapWaveformGraph
+                {
+                    RelativeSizeAxes = Axes.Both,
+                    Resolution = 1f / i
+                };
+
+                newDisplay.Beatmap.BindTo(beatmapBacking);
+
+                flow.Add(new Container
+                {
+                    RelativeSizeAxes = Axes.X,
+                    Height = 100,
+                    Children = new Drawable[]
+                    {
+                        newDisplay,
+                        new Container
+                        {
+                            Anchor = Anchor.Centre,
+                            Origin = Anchor.Centre,
+                            AutoSizeAxes = Axes.Both,
+                            Children = new Drawable[]
+                            {
+                                new Box
+                                {
+                                    RelativeSizeAxes = Axes.Both,
+                                    Colour = Color4.Black,
+                                    Alpha = 0.75f
+                                },
+                                new OsuSpriteText
+                                {
+                                    Anchor = Anchor.Centre,
+                                    Origin = Anchor.Centre,
+                                    Text = $"Resolution: {1f / i:0.00}"
+                                }
+                            }
+                        }
+                    }
+                });
+            }
+        }
+
+        [BackgroundDependencyLoader]
+        private void load(OsuGameBase osuGame) => beatmapBacking.BindTo(osuGame.Beatmap);
+    }
+}

osu.Game/osu.Game.csproj

@@ -263,6 +263,7 @@
     <Compile Include="Beatmaps\Drawables\BeatmapPanel.cs" />
     <Compile Include="Beatmaps\Drawables\BeatmapSetCover.cs" />
     <Compile Include="Beatmaps\Drawables\BeatmapSetHeader.cs" />
+    <Compile Include="Screens\Edit\Screens\Compose\BeatmapWaveformGraph.cs" />
     <Compile Include="Beatmaps\Drawables\DifficultyColouredContainer.cs" />
     <Compile Include="Beatmaps\Drawables\DifficultyIcon.cs" />
     <Compile Include="Beatmaps\Drawables\Panel.cs" />
@@ -784,6 +785,7 @@
     <Compile Include="Tests\Visual\TestCaseTwoLayerButton.cs" />
     <Compile Include="Tests\Visual\TestCaseUserPanel.cs" />
     <Compile Include="Tests\Visual\TestCaseUserProfile.cs" />
+    <Compile Include="Tests\Visual\TestCaseWaveform.cs" />
     <Compile Include="Users\Avatar.cs" />
     <Compile Include="Users\Country.cs" />
     <Compile Include="Users\Medal.cs" />