Merge branch 'master' into text-builder-not-invalidated

karaoke-dev · Mar 4, 2021 · b5ec9aa · b5ec9aa
2 parents 8c1ce03 + dfe45e1
commit b5ec9aa
Show file tree

Hide file tree

Showing 51 changed files with 403 additions and 327 deletions.
diff --git a/...Templates/templates/template-empty/TemplateGame.Game.Tests/TemplateGame.Game.Tests.csproj b/...Templates/templates/template-empty/TemplateGame.Game.Tests/TemplateGame.Game.Tests.csproj
@@ -8,7 +8,7 @@
     <ProjectReference Include="..\TemplateGame.Game\TemplateGame.Game.csproj" />
   </ItemGroup>
   <ItemGroup Label="Package References">
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.1" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.15.1" />
   </ItemGroup>
 </Project>
diff --git a/osu.Framework.Templates/templates/template-empty/TemplateGame.Game/TemplateGame.Game.csproj b/osu.Framework.Templates/templates/template-empty/TemplateGame.Game/TemplateGame.Game.csproj
@@ -6,6 +6,6 @@
     <ProjectReference Include="..\TemplateGame.Resources\TemplateGame.Resources.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.osu.Framework" Version="2021.128.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2021.226.0" />
   </ItemGroup>
 </Project>
diff --git a/osu.Framework.Templates/templates/template-empty/TemplateGame.iOS/TemplateGame.iOS.csproj b/osu.Framework.Templates/templates/template-empty/TemplateGame.iOS/TemplateGame.iOS.csproj
@@ -150,10 +150,10 @@
     <Reference Include="System.Net.Http" />
   </ItemGroup>
   <ItemGroup Label="Package References">
-    <PackageReference Include="ppy.osu.Framework.iOS" Version="2021.128.0" />
+    <PackageReference Include="ppy.osu.Framework.iOS" Version="2021.226.0" />
   </ItemGroup>
   <ItemGroup Label="Transitive Dependencies">
-    <PackageReference Include="ppy.osu.Framework" Version="2021.128.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2021.226.0" />
     <PackageReference Include="ppy.osu.Framework.NativeLibs" Version="2019.1104.0" ExcludeAssets="all" />
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.iOS.CSharp.targets" />

diff --git a/...work.Templates/templates/template-flappy/FlappyDon.Game.Tests/FlappyDon.Game.Tests.csproj b/...work.Templates/templates/template-flappy/FlappyDon.Game.Tests/FlappyDon.Game.Tests.csproj
@@ -8,7 +8,7 @@
     <ProjectReference Include="..\FlappyDon.Game\FlappyDon.Game.csproj" />
   </ItemGroup>
   <ItemGroup Label="Package References">
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.1" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.15.1" />
   </ItemGroup>
 </Project>
diff --git a/osu.Framework.Templates/templates/template-flappy/FlappyDon.Game/FlappyDon.Game.csproj b/osu.Framework.Templates/templates/template-flappy/FlappyDon.Game/FlappyDon.Game.csproj
@@ -3,7 +3,7 @@
     <TargetFramework>netstandard2.1</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="ppy.osu.Framework" Version="2021.128.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2021.226.0" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\FlappyDon.Resources\FlappyDon.Resources.csproj" />

diff --git a/osu.Framework.Templates/templates/template-flappy/FlappyDon.iOS/FlappyDon.iOS.csproj b/osu.Framework.Templates/templates/template-flappy/FlappyDon.iOS/FlappyDon.iOS.csproj
@@ -162,10 +162,10 @@
     <Reference Include="System.Net.Http" />
   </ItemGroup>
   <ItemGroup Label="Package References">
-    <PackageReference Include="ppy.osu.Framework.iOS" Version="2021.128.0" />
+    <PackageReference Include="ppy.osu.Framework.iOS" Version="2021.226.0" />
   </ItemGroup>
   <ItemGroup Label="Transitive Dependencies">
-    <PackageReference Include="ppy.osu.Framework" Version="2021.128.0" />
+    <PackageReference Include="ppy.osu.Framework" Version="2021.226.0" />
     <PackageReference Include="ppy.osu.Framework.NativeLibs" Version="2019.1104.0" ExcludeAssets="all" />
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.iOS.CSharp.targets" />

diff --git a/osu.Framework.Tests/Audio/SampleBassTest.cs b/osu.Framework.Tests/Audio/SampleBassTest.cs
@@ -28,7 +28,7 @@ public void Setup()
 
             resources = new DllResourceStore(typeof(TrackBassTest).Assembly);
             sampleFactory = new SampleBassFactory(resources.Get("Resources.Tracks.sample-track.mp3"));
-            sample = new SampleBass(sampleFactory);
+            sample = sampleFactory.CreateSample();
 
             updateSample();
         }
@@ -86,11 +86,19 @@ public void TestStopBeforeLoadFinished()
             Assert.IsFalse(channel.Playing);
         }
 
-        private void updateSample() => runOnAudioThread(() =>
+        [Test]
+        public void TestStopsWhenFactoryDisposed()
         {
-            sampleFactory.Update();
-            channel?.Update();
-        });
+            channel = sample.Play();
+            updateSample();
+
+            sampleFactory.Dispose();
+            updateSample();
+
+            Assert.IsFalse(channel.Playing);
+        }
+
+        private void updateSample() => runOnAudioThread(() => sampleFactory.Update());
 
         /// <summary>
         /// Certain actions are invoked on the audio thread.

diff --git a/osu.Framework.Tests/osu.Framework.Tests.csproj b/osu.Framework.Tests/osu.Framework.Tests.csproj
@@ -10,7 +10,7 @@
     <ProjectReference Include="..\osu.Framework\osu.Framework.csproj" />
   </ItemGroup>
   <ItemGroup Label="Package References">
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.1" />
     <PackageReference Include="NUnit" Version="3.13.1" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.17.0" />
     <PackageReference Include="Appveyor.TestLogger" Version="2.0.0" />

diff --git a/osu.Framework.iOS.props b/osu.Framework.iOS.props
@@ -63,8 +63,8 @@
     <PackageReference Include="Markdig" Version="0.22.1" />
     <PackageReference Include="FFmpeg.AutoGen" Version="4.3.0.1" />
     <PackageReference Include="SharpFNT" Version="2.0.0" />
-    <PackageReference Include="SixLabors.ImageSharp" Version="1.0.2" />
-    <PackageReference Include="System.Drawing.Common" Version="5.0.0" />
+    <PackageReference Include="SixLabors.ImageSharp" Version="1.0.3" />
+    <PackageReference Include="System.Drawing.Common" Version="5.0.1" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0" />
     <PackageReference Include="ppy.osuTK.NS20" Version="1.0.173" />
     <PackageReference Include="System.Runtime.InteropServices" Version="4.3.0" />

diff --git a/osu.Framework.iOS/osu.Framework.iOS.csproj b/osu.Framework.iOS/osu.Framework.iOS.csproj
@@ -25,7 +25,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="ppy.osuTK.iOS" Version="1.0.173" />
-    <PackageReference Include="SixLabors.ImageSharp" Version="1.0.2" />
+    <PackageReference Include="SixLabors.ImageSharp" Version="1.0.3" />
   </ItemGroup>
   <ItemGroup>
     <NativeLibs Include="$(MSBuildThisFileDirectory)\*.a" />

diff --git a/osu.Framework/Allocation/TimedExpiryCache.cs b/osu.Framework/Allocation/TimedExpiryCache.cs
@@ -80,11 +80,6 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        ~TimedExpiryCache()
-        {
-            Dispose(false);
-        }
-
         public void Dispose()
         {
             Dispose(true);

diff --git a/osu.Framework/Audio/AudioComponent.cs b/osu.Framework/Audio/AudioComponent.cs
@@ -112,26 +112,21 @@ public void Update()
 
         #region IDisposable Support
 
-        ~AudioComponent()
-        {
-            Dispose(false);
-        }
-
         protected volatile bool IsDisposed;
 
-        protected virtual void Dispose(bool disposing)
-        {
-            IsDisposed = true;
-        }
-
-        public virtual void Dispose()
+        public void Dispose()
         {
             acceptingActions = false;
             PendingActions.Enqueue(new Task(() => Dispose(true)));
 
             GC.SuppressFinalize(this);
         }
 
+        protected virtual void Dispose(bool disposing)
+        {
+            IsDisposed = true;
+        }
+
         #endregion
     }
 }
diff --git a/osu.Framework/Audio/Sample/SampleBassFactory.cs b/osu.Framework/Audio/Sample/SampleBassFactory.cs
@@ -87,8 +87,16 @@ private void onPlay(Sample sample)
             AddItem(sample);
         }
 
+        ~SampleBassFactory()
+        {
+            Dispose(false);
+        }
+
         protected override void Dispose(bool disposing)
         {
+            if (IsDisposed)
+                return;
+
             if (IsLoaded)
             {
                 Bass.SampleFree(SampleId);

diff --git a/osu.Framework/Audio/Sample/SampleChannelBass.cs b/osu.Framework/Audio/Sample/SampleChannelBass.cs
@@ -181,9 +181,10 @@ private void ensureChannel() => EnqueueAction(() =>
             bassAmplitudeProcessor?.SetChannel(channel);
         });
 
-        public override void Dispose()
+        protected override void Dispose(bool disposing)
         {
-            base.Dispose();
+            if (IsDisposed)
+                return;
 
             if (hasChannel)
             {
@@ -192,6 +193,8 @@ public override void Dispose()
             }
 
             playing = false;
+
+            base.Dispose(disposing);
         }
     }
 }
diff --git a/osu.Framework/Audio/Track/TrackBass.cs b/osu.Framework/Audio/Track/TrackBass.cs
@@ -215,8 +215,16 @@ protected override void UpdateState()
             bassAmplitudeProcessor?.Update();
         }
 
+        ~TrackBass()
+        {
+            Dispose(false);
+        }
+
         protected override void Dispose(bool disposing)
         {
+            if (IsDisposed)
+                return;
+
             if (activeStream != 0)
             {
                 isRunning = false;

diff --git a/osu.Framework/Audio/Track/Waveform.cs b/osu.Framework/Audio/Track/Waveform.cs
@@ -295,11 +295,6 @@ public async Task<int> GetChannelsAsync()
 
         #region Disposal
 
-        ~Waveform()
-        {
-            Dispose(false);
-        }
-
         public void Dispose()
         {
             Dispose(true);

diff --git a/osu.Framework/Configuration/ConfigManager.cs b/osu.Framework/Configuration/ConfigManager.cs
@@ -223,11 +223,6 @@ protected virtual void Dispose(bool disposing)
             }
         }
 
-        ~ConfigManager()
-        {
-            Dispose(false);
-        }
-
         public void Dispose()
         {
             Dispose(true);

diff --git a/osu.Framework/Graphics/BufferedDrawNodeSharedData.cs b/osu.Framework/Graphics/BufferedDrawNodeSharedData.cs
@@ -96,11 +96,6 @@ public FrameBuffer GetNextEffectBuffer()
         /// </summary>
         internal void ResetCurrentEffectBuffer() => currentEffectBuffer = -1;
 
-        ~BufferedDrawNodeSharedData()
-        {
-            GLWrapper.ScheduleDisposal(() => Dispose(false));
-        }
-
         public void Dispose()
         {
             GLWrapper.ScheduleDisposal(() => Dispose(true));

diff --git a/osu.Framework/Graphics/Containers/CompositeDrawable.cs b/osu.Framework/Graphics/Containers/CompositeDrawable.cs
@@ -290,6 +290,9 @@ private void loadChild(Drawable child)
 
         protected override void Dispose(bool isDisposing)
         {
+            if (IsDisposed)
+                return;
+
             disposalCancellationSource?.Cancel();
             disposalCancellationSource?.Dispose();
 

diff --git a/osu.Framework/Graphics/DrawNode.cs b/osu.Framework/Graphics/DrawNode.cs
@@ -284,11 +284,6 @@ protected void DrawFrameBuffer(FrameBuffer frameBuffer, Quad vertexQuad, ColourI
         /// </remarks>
         internal void Reference() => referenceCount.Increment();
 
-        ~DrawNode()
-        {
-            GLWrapper.ScheduleDisposal(() => Dispose(false));
-        }
-
         protected internal bool IsDisposed { get; private set; }
 
         public void Dispose()

diff --git a/osu.Framework/Graphics/Drawable.cs b/osu.Framework/Graphics/Drawable.cs
@@ -66,14 +66,7 @@ protected Drawable()
             AddLayout(requiredParentSizeToFitBacking);
         }
 
-        ~Drawable()
-        {
-            dispose(false);
-            finalize_disposals.Value++;
-        }
-
-        private static readonly GlobalStatistic<int> total_count = GlobalStatistics.Get<int>(nameof(Drawable), $"Total {nameof(Drawable)}s");
-        private static readonly GlobalStatistic<int> finalize_disposals = GlobalStatistics.Get<int>(nameof(Drawable), "Finalizer disposals");
+        private static readonly GlobalStatistic<int> total_count = GlobalStatistics.Get<int>(nameof(Drawable), "Total constructed");
 
         internal bool IsLongRunning => GetType().GetCustomAttribute<LongRunningLoadAttribute>() != null;
 
@@ -82,7 +75,9 @@ protected Drawable()
         /// </summary>
         public void Dispose()
         {
-            dispose(true);
+            //we can't dispose if we are mid-load, else our children may get in a bad state.
+            lock (LoadLock) Dispose(true);
+
             GC.SuppressFinalize(this);
         }
 
@@ -93,36 +88,25 @@ public void Dispose()
         /// </summary>
         protected virtual void Dispose(bool isDisposing)
         {
-        }
-
-        private void dispose(bool isDisposing)
-        {
-            //we can't dispose if we are mid-load, else our children may get in a bad state.
-            lock (LoadLock)
-            {
-                if (IsDisposed)
-                    return;
-
-                total_count.Value--;
+            if (IsDisposed)
+                return;
 
-                Dispose(isDisposing);
-                UnbindAllBindables();
+            UnbindAllBindables();
 
-                // Bypass expensive operations as a result of setting the Parent property, by setting the field directly.
-                parent = null;
-                ChildID = 0;
+            // Bypass expensive operations as a result of setting the Parent property, by setting the field directly.
+            parent = null;
+            ChildID = 0;
 
-                OnUpdate = null;
-                Invalidated = null;
+            OnUpdate = null;
+            Invalidated = null;
 
-                OnDispose?.Invoke();
-                OnDispose = null;
+            OnDispose?.Invoke();
+            OnDispose = null;
 
-                for (int i = 0; i < drawNodes.Length; i++)
-                    drawNodes[i]?.Dispose();
+            for (int i = 0; i < drawNodes.Length; i++)
+                drawNodes[i]?.Dispose();
 
-                IsDisposed = true;
-            }
+            IsDisposed = true;
         }
 
         /// <summary>
@@ -430,7 +414,7 @@ public float Depth
         internal event Action<Drawable> Invalidated;
 
         /// <summary>
-        /// Fired after the <see cref="dispose(bool)"/> method is called.
+        /// Fired after the <see cref="Dispose(bool)"/> method is called.
         /// </summary>
         internal event Action OnDispose;
 

diff --git a/osu.Framework/Graphics/OpenGL/Textures/TextureGL.cs b/osu.Framework/Graphics/OpenGL/Textures/TextureGL.cs
@@ -32,11 +32,6 @@ protected TextureGL(WrapMode wrapModeS = WrapMode.None, WrapMode wrapModeT = Wra
 
         #region Disposal
 
-        ~TextureGL()
-        {
-            Dispose(false);
-        }
-
         internal virtual bool IsQueuedForUpload { get; set; }
 
         /// <summary>