Merge pull request #527 from SirCmpwn/working-beatmap

Refactor WorkingBeatmap

osu.Desktop.VisualTests/Beatmaps/TestWorkingBeatmap.cs

@@ -0,0 +1,24 @@
+// 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.Audio.Track;
+using osu.Framework.Graphics.Textures;
+using osu.Game.Beatmaps;
+
+namespace osu.Desktop.VisualTests.Beatmaps
+{
+    public class TestWorkingBeatmap : WorkingBeatmap
+    {
+        public TestWorkingBeatmap(Beatmap beatmap)
+            : base(beatmap.BeatmapInfo, beatmap.BeatmapInfo.BeatmapSet)
+        {
+            this.beatmap = beatmap;
+        }
+
+        private Beatmap beatmap;
+        
+        protected override Beatmap GetBeatmap() => beatmap;
+        protected override Texture GetBackground() => null;
+        protected override Track GetTrack() => null;
+    }
+}

osu.Desktop.VisualTests/Tests/TestCaseGamefield.cs

@@ -8,7 +8,6 @@ using osu.Framework.MathUtils;
 using osu.Framework.Screens.Testing;
 using osu.Framework.Timing;
 using osu.Game.Beatmaps;
-using osu.Game.Beatmaps.IO;
 using osu.Game.Database;
 using osu.Game.Modes.Catch.UI;
 using osu.Game.Modes.Mania.UI;
@@ -17,6 +16,7 @@ using osu.Game.Modes.Osu.Objects;
 using osu.Game.Modes.Osu.UI;
 using osu.Game.Modes.Taiko.UI;
 using System.Collections.Generic;
+using osu.Desktop.VisualTests.Beatmaps;
 
 namespace osu.Desktop.VisualTests.Tests
 {
@@ -95,16 +95,5 @@ namespace osu.Desktop.VisualTests.Tests
                 }
             });
         }
-
-        private class TestWorkingBeatmap : WorkingBeatmap
-        {
-            public TestWorkingBeatmap(Beatmap beatmap)
-                : base(beatmap.BeatmapInfo, beatmap.BeatmapInfo.BeatmapSet)
-            {
-                Beatmap = beatmap;
-            }
-
-            protected override ArchiveReader GetReader() => null;
-        }
     }
 }

osu.Desktop.VisualTests/Tests/TestCasePlayer.cs

@@ -8,13 +8,13 @@ using osu.Framework.Screens.Testing;
 using osu.Game.Beatmaps;
 using OpenTK;
 using osu.Framework.Graphics.Sprites;
-using osu.Game.Beatmaps.IO;
 using osu.Game.Database;
 using osu.Game.Modes;
 using osu.Game.Modes.Objects;
 using osu.Game.Modes.Osu.Objects;
 using osu.Game.Screens.Play;
 using OpenTK.Graphics;
+using osu.Desktop.VisualTests.Beatmaps;
 
 namespace osu.Desktop.VisualTests.Tests
 {
@@ -23,7 +23,6 @@ namespace osu.Desktop.VisualTests.Tests
         protected Player Player;
         private BeatmapDatabase db;
 
-
         public override string Description => @"Showing everything to play the game.";
 
         [BackgroundDependencyLoader]
@@ -97,16 +96,5 @@ namespace osu.Desktop.VisualTests.Tests
                 Beatmap = beatmap
             };
         }
-
-        private class TestWorkingBeatmap : WorkingBeatmap
-        {
-            public TestWorkingBeatmap(Beatmap beatmap)
-                : base(beatmap.BeatmapInfo, beatmap.BeatmapInfo.BeatmapSet)
-            {
-                Beatmap = beatmap;
-            }
-
-            protected override ArchiveReader GetReader() => null;
-        }
     }
 }

osu.Desktop.VisualTests/osu.Desktop.VisualTests.csproj

@@ -205,9 +205,13 @@
     <Compile Include="Tests\TestCaseDialogOverlay.cs" />
     <Compile Include="Tests\TestCaseBeatmapOptionsOverlay.cs" />
     <Compile Include="Tests\TestCaseLeaderboard.cs" />
+    <Compile Include="Beatmaps\TestWorkingBeatmap.cs" />
   </ItemGroup>
   <ItemGroup />
   <ItemGroup />
+  <ItemGroup>
+    <Folder Include="Beatmaps\" />
+  </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it.
        Other similar extension points exist, see Microsoft.Common.targets.

osu.Game/Beatmaps/WorkingBeatmap.cs

@@ -4,14 +4,11 @@
 using osu.Framework.Audio.Track;
 using osu.Framework.Configuration;
 using osu.Framework.Graphics.Textures;
-using osu.Game.Beatmaps.Formats;
-using osu.Game.Beatmaps.IO;
 using osu.Game.Database;
 using osu.Game.Modes;
 using osu.Game.Modes.Mods;
 using System;
 using System.Collections.Generic;
-using System.IO;
 
 namespace osu.Game.Beatmaps
 {
@@ -27,14 +24,12 @@ namespace osu.Game.Beatmaps
         /// </summary>
         public PlayMode? PreferredPlayMode;
 
-        public PlayMode PlayMode => beatmap?.BeatmapInfo?.Mode > PlayMode.Osu ? beatmap.BeatmapInfo.Mode : PreferredPlayMode ?? PlayMode.Osu;
+        public PlayMode PlayMode => Beatmap?.BeatmapInfo?.Mode > PlayMode.Osu ? Beatmap.BeatmapInfo.Mode : PreferredPlayMode ?? PlayMode.Osu;
 
         public readonly Bindable<IEnumerable<Mod>> Mods = new Bindable<IEnumerable<Mod>>();
 
         public readonly bool WithStoryboard;
 
-        protected abstract ArchiveReader GetReader();
-
         protected WorkingBeatmap(BeatmapInfo beatmapInfo, BeatmapSetInfo beatmapSetInfo, bool withStoryboard = false)
         {
             BeatmapInfo = beatmapInfo;
@@ -42,31 +37,10 @@ namespace osu.Game.Beatmaps
             WithStoryboard = withStoryboard;
         }
 
-        private Texture background;
+        protected abstract Beatmap GetBeatmap();
-        private object backgroundLock = new object();
+        protected abstract Texture GetBackground();
-        public Texture Background
+        protected abstract Track GetTrack();
-        {
+        
-            get
-            {
-                lock (backgroundLock)
-                {
-                    if (background != null) return background;
-
-                    if (BeatmapInfo?.Metadata?.BackgroundFile == null) return null;
-
-                    try
-                    {
-                        using (var reader = GetReader())
-                            background = new TextureStore(new RawTextureLoaderStore(reader), false).Get(BeatmapInfo.Metadata.BackgroundFile);
-                    }
-                    catch { }
-
-                    return background;
-                }
-            }
-            set { lock (backgroundLock) background = value; }
-        }
-
         private Beatmap beatmap;
         private object beatmapLock = new object();
         public Beatmap Beatmap
@@ -75,33 +49,24 @@ namespace osu.Game.Beatmaps
             {
                 lock (beatmapLock)
                 {
-                    if (beatmap != null) return beatmap;
+                    return beatmap ?? (beatmap = GetBeatmap());
-
+                }
-                    try
+            }
-                    {
+        }
-                        using (var reader = GetReader())
+        
-                        {
+        private object backgroundLock = new object();
-                            BeatmapDecoder decoder;
+        private Texture background;
-                            using (var stream = new StreamReader(reader.GetStream(BeatmapInfo.Path)))
+        public Texture Background
-                            {
+        {
-                                decoder = BeatmapDecoder.GetDecoder(stream);
+            get
-                                beatmap = decoder?.Decode(stream);
+            {
-                            }
+                lock (backgroundLock)
-
+                {
-                            if (WithStoryboard && beatmap != null && BeatmapSetInfo.StoryboardFile != null)
+                    return background ?? (background = GetBackground());
-                                using (var stream = new StreamReader(reader.GetStream(BeatmapSetInfo.StoryboardFile)))
-                                    decoder?.Decode(stream, beatmap);
-                        }
-                    }
-                    catch { }
-
-                    return beatmap;
                 }
             }
-            set { lock (beatmapLock) beatmap = value; }
         }
 
-        private ArchiveReader trackReader;
         private Track track;
         private object trackLock = new object();
         public Track Track
@@ -110,48 +75,25 @@ namespace osu.Game.Beatmaps
             {
                 lock (trackLock)
                 {
-                    if (track != null) return track;
+                    return track ?? (track = GetTrack());
-
-                    try
-                    {
-                        //store a reference to the reader as we may continue accessing the stream in the background.
-                        trackReader = GetReader();
-                        var trackData = trackReader?.GetStream(BeatmapInfo.Metadata.AudioFile);
-                        if (trackData != null)
-                            track = new TrackBass(trackData);
-                    }
-                    catch { }
-
-                    return track;
                 }
             }
-            set { lock (trackLock) track = value; }
         }
 
         public bool TrackLoaded => track != null;
 
-        private bool isDisposed;
+        public void TransferTo(WorkingBeatmap other)
-
-        protected virtual void Dispose(bool disposing)
         {
-            if (!isDisposed)
+            if (track != null && BeatmapInfo.AudioEquals(other.BeatmapInfo))
-            {
+                other.track = track;
-                track?.Dispose();
-                background?.Dispose();
-                isDisposed = true;
-            }
         }
-
+        
-        public void Dispose()
+        public virtual void Dispose()
         {
-            Dispose(true);
+            track?.Dispose();
-            GC.SuppressFinalize(this);
+            track = null;
-        }
+            background?.Dispose();
-
+            background = null;
-        public void TransferTo(WorkingBeatmap working)
-        {
-            if (track != null && BeatmapInfo.AudioEquals(working.BeatmapInfo))
-                working.track = track;
         }
     }
 }

osu.Game/Database/BeatmapDatabase.cs

@@ -342,18 +342,5 @@ namespace osu.Game.Database
         }
 
         public bool Exists(BeatmapSetInfo beatmapSet) => storage.Exists(beatmapSet.Path);
-
-        private class DatabaseWorkingBeatmap : WorkingBeatmap
-        {
-            private readonly BeatmapDatabase database;
-
-            public DatabaseWorkingBeatmap(BeatmapDatabase database, BeatmapInfo beatmapInfo, BeatmapSetInfo beatmapSetInfo, bool withStoryboard = false)
-                : base(beatmapInfo, beatmapSetInfo, withStoryboard)
-            {
-                this.database = database;
-            }
-
-            protected override ArchiveReader GetReader() => database?.GetReader(BeatmapSetInfo);
-        }
     }
 }

osu.Game/Database/DatabaseWorkingBeatmap.cs

@@ -0,0 +1,73 @@
+// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
+// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
+
+using System.IO;
+using osu.Framework.Audio.Track;
+using osu.Framework.Graphics.Textures;
+using osu.Game.Beatmaps;
+using osu.Game.Beatmaps.Formats;
+using osu.Game.Beatmaps.IO;
+
+namespace osu.Game.Database
+{
+    internal class DatabaseWorkingBeatmap : WorkingBeatmap
+    {
+        private readonly BeatmapDatabase database;
+
+        public DatabaseWorkingBeatmap(BeatmapDatabase database, BeatmapInfo beatmapInfo, BeatmapSetInfo beatmapSetInfo, bool withStoryboard = false)
+            : base(beatmapInfo, beatmapSetInfo, withStoryboard)
+        {
+            this.database = database;
+        }
+
+        private ArchiveReader getReader() => database?.GetReader(BeatmapSetInfo);
+
+        protected override Beatmap GetBeatmap()
+        {
+            try
+            {
+                Beatmap beatmap;
+
+                using (var reader = getReader())
+                {
+                    BeatmapDecoder decoder;
+                    using (var stream = new StreamReader(reader.GetStream(BeatmapInfo.Path)))
+                    {
+                        decoder = BeatmapDecoder.GetDecoder(stream);
+                        beatmap = decoder?.Decode(stream);
+                    }
+
+                    if (WithStoryboard && beatmap != null && BeatmapSetInfo.StoryboardFile != null)
+                        using (var stream = new StreamReader(reader.GetStream(BeatmapSetInfo.StoryboardFile)))
+                            decoder.Decode(stream, beatmap);
+                }
+
+                return beatmap;
+            }
+            catch { return null; }
+        }
+
+        protected override Texture GetBackground()
+        {
+            if (BeatmapInfo?.Metadata?.BackgroundFile == null)
+                return null;
+
+            try
+            {
+                using (var reader = getReader())
+                    return new TextureStore(new RawTextureLoaderStore(reader), false).Get(BeatmapInfo.Metadata.BackgroundFile);
+            }
+            catch { return null; }
+        }
+
+        protected override Track GetTrack()
+        {
+            try
+            {
+                var trackData = getReader()?.GetStream(BeatmapInfo.Metadata.AudioFile);
+                return trackData == null ? null : new TrackBass(trackData);
+            }
+            catch { return null; }
+        }
+    }
+}

osu.Game/osu.Game.csproj

@@ -279,6 +279,7 @@
     <Compile Include="Database\BeatmapMetadata.cs" />
     <Compile Include="Database\BeatmapInfo.cs" />
     <Compile Include="Database\BaseDifficulty.cs" />
+    <Compile Include="Database\DatabaseWorkingBeatmap.cs" />
     <Compile Include="Graphics\UserInterface\OsuButton.cs" />
     <Compile Include="Overlays\Options\Sections\MaintenanceSection.cs" />
     <Compile Include="Overlays\Options\OptionsSection.cs" />