Refactor WorkingBeatmap

Gets ArchiveReader out of WorkingBeatmap and delegates extracting stuff
from it to subclasses. Should enable us to make an OnlineWorkingBeatmap
or so.

osu.Desktop.VisualTests/Beatmaps/TestWorkingBeatmap.cs

@@ -0,0 +1,32 @@
+using System;
+using osu.Framework.Audio.Track;
+using osu.Framework.Graphics.Textures;
+using osu.Game.Beatmaps;
+using osu.Game.Beatmaps.IO;
+
+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;
+        public override Beatmap Beatmap => beatmap;
+        public override Texture Background => null;
+        public override Track Track => null;
+        
+        public override void Dispose()
+        {
+            // This space intentionally left blank
+        }
+        
+        public override void TransferTo(WorkingBeatmap other)
+        {
+            // This space intentionally left blank
+        }
+    }
+}

osu.Desktop.VisualTests/Tests/TestCaseGamefield.cs

@@ -17,6 +17,8 @@ using osu.Game.Modes.Osu.Objects;
 using osu.Game.Modes.Osu.UI;
 using osu.Game.Modes.Taiko.UI;
 using System.Collections.Generic;
+using osu.Framework.Graphics.Textures;
+using osu.Desktop.VisualTests.Beatmaps;
 
 namespace osu.Desktop.VisualTests.Tests
 {
@@ -95,16 +97,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

@@ -15,6 +15,7 @@ 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
 {
@@ -97,16 +98,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,116 +37,13 @@ namespace osu.Game.Beatmaps
             WithStoryboard = withStoryboard;
         }
         
-        private Texture background;
+        public abstract Beatmap Beatmap { get; }
-        private object backgroundLock = new object();
+        public abstract Texture Background { get; }
-        public Texture Background
+        public abstract Track Track { get; }
-        {
-            get
-            {
-                lock (backgroundLock)
-                {
-                    if (background != null) return background;
 
-                    if (BeatmapInfo?.Metadata?.BackgroundFile == null) return null;
+        public abstract void TransferTo(WorkingBeatmap other);
+        public abstract void Dispose();
 
-                    try
+        public virtual bool TrackLoaded => Track != null;
-                    {
-                        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
-        {
-            get
-            {
-                lock (beatmapLock)
-                {
-                    if (beatmap != null) return beatmap;
-
-                    try
-                    {
-                        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);
-                        }
-                    }
-                    catch { }
-
-                    return beatmap;
-                }
-            }
-            set { lock (beatmapLock) beatmap = value; }
-        }
-
-        private ArchiveReader trackReader;
-        private Track track;
-        private object trackLock = new object();
-        public Track Track
-        {
-            get
-            {
-                lock (trackLock)
-                {
-                    if (track != null) return track;
-
-                    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;
-
-        protected virtual void Dispose(bool disposing)
-        {
-            if (!isDisposed)
-            {
-                track?.Dispose();
-                background?.Dispose();
-                isDisposed = true;
-            }
-        }
-
-        public void Dispose()
-        {
-            Dispose(true);
-            GC.SuppressFinalize(this);
-        }
-
-        public void TransferTo(WorkingBeatmap working)
-        {
-            if (track != null && BeatmapInfo.AudioEquals(working.BeatmapInfo))
-                working.track = track;
-        }
     }
 }

osu.Game/Database/BeatmapDatabase.cs

@@ -18,7 +18,7 @@ using SQLiteNetExtensions.Extensions;
 
 namespace osu.Game.Database
 {
-    public class BeatmapDatabase
+    public partial class BeatmapDatabase
     {
         private SQLiteConnection connection { get; }
         private Storage storage;
@@ -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,127 @@
+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
+{
+    public partial class BeatmapDatabase
+    {
+        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;
+            }
+
+            private ArchiveReader GetReader() => database?.GetReader(BeatmapSetInfo);
+
+            private Beatmap beatmap;
+            private object beatmapLock = new object();
+            public override Beatmap Beatmap
+            {
+                get
+                {
+                    lock (beatmapLock)
+                    {
+                        if (beatmap != null) return beatmap;
+    
+                        try
+                        {
+                            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);
+                            }
+                        }
+                        catch { return null; }
+    
+                        return beatmap;
+                    }
+                }
+            }
+
+            private object backgroundLock = new object();
+            private Texture background;
+            public override Texture Background
+            {
+                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 null; }
+    
+                        return background;
+                    }
+                }
+            }
+
+            private ArchiveReader trackReader;
+            private Track track;
+            private object trackLock = new object();
+            public override Track Track
+            {
+                get
+                {
+                    lock (trackLock)
+                    {
+                        if (track != null) return track;
+    
+                        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 null; }
+    
+                        return track;
+                    }
+                }
+            }
+            
+            public override bool TrackLoaded => track != null;
+
+            public override void TransferTo(WorkingBeatmap other)
+            {
+                var _other = (DatabaseWorkingBeatmap)other;
+                if (track != null && BeatmapInfo.AudioEquals(_other.BeatmapInfo))
+                    _other.track = track;
+            }
+            
+            public override void Dispose()
+            {
+                background?.Dispose();
+                background = null;
+            }
+        }
+    }
+}

osu.Game/osu.Game.csproj

@@ -363,6 +363,7 @@
     <Compile Include="Screens\Select\Leaderboards\DrawableRank.cs" />
     <Compile Include="Graphics\UserInterface\OsuTabControl.cs" />
     <Compile Include="Graphics\UserInterface\OsuTabItem.cs" />
+    <Compile Include="Database\DatabaseWorkingBeatmap.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="$(SolutionDir)\osu-framework\osu.Framework\osu.Framework.csproj">