Merge pull request #6635 from peppy/bindable-control-point-properties

Bindable control point properties

osu.Game.Tests/Beatmaps/Formats/LegacyBeatmapDecoderTest.cs

@@ -362,6 +362,23 @@ namespace osu.Game.Tests.Beatmaps.Formats
             }
         }
 
+        [Test]
+        public void TestDecodeControlPointDifficultyChange()
+        {
+            var decoder = new LegacyBeatmapDecoder { ApplyOffsets = false };
+
+            using (var resStream = TestResources.OpenResource("controlpoint-difficulty-multiplier.osu"))
+            using (var stream = new LineBufferedReader(resStream))
+            {
+                var controlPointInfo = decoder.Decode(stream).ControlPointInfo;
+
+                Assert.That(controlPointInfo.DifficultyPointAt(5).SpeedMultiplier, Is.EqualTo(1));
+                Assert.That(controlPointInfo.DifficultyPointAt(1000).SpeedMultiplier, Is.EqualTo(10));
+                Assert.That(controlPointInfo.DifficultyPointAt(2000).SpeedMultiplier, Is.EqualTo(1.8518518518518519d));
+                Assert.That(controlPointInfo.DifficultyPointAt(3000).SpeedMultiplier, Is.EqualTo(0.5));
+            }
+        }
+
         [Test]
         public void TestDecodeControlPointCustomSampleBank()
         {

osu.Game.Tests/Resources/controlpoint-difficulty-multiplier.osu

@@ -0,0 +1,8 @@
+osu file format v7
+
+[TimingPoints]
+0,100,4,2,0,100,1,0
+12,500,4,2,0,100,1,0
+1000,-10,4,2,0,100,0,0
+2000,-54,4,2,0,100,0,0
+3000,-200,4,2,0,100,0,0

osu.Game/Beatmaps/ControlPoints/DifficultyControlPoint.cs

@@ -1,24 +1,33 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-using osuTK;
+using osu.Framework.Bindables;
 
 namespace osu.Game.Beatmaps.ControlPoints
 {
     public class DifficultyControlPoint : ControlPoint
     {
+        /// <summary>
+        /// The speed multiplier at this control point.
+        /// </summary>
+        public readonly BindableDouble SpeedMultiplierBindable = new BindableDouble(1)
+        {
+            Precision = 0.1,
+            Default = 1,
+            MinValue = 0.1,
+            MaxValue = 10
+        };
+
         /// <summary>
         /// The speed multiplier at this control point.
         /// </summary>
         public double SpeedMultiplier
         {
-            get => speedMultiplier;
+            get => SpeedMultiplierBindable.Value;
-            set => speedMultiplier = MathHelper.Clamp(value, 0.1, 10);
+            set => SpeedMultiplierBindable.Value = value;
         }
 
-        private double speedMultiplier = 1;
-
         public override bool EquivalentTo(ControlPoint other) =>
-            other is DifficultyControlPoint otherTyped && otherTyped.SpeedMultiplier.Equals(speedMultiplier);
+            other is DifficultyControlPoint otherTyped && otherTyped.SpeedMultiplier.Equals(SpeedMultiplier);
     }
 }

osu.Game/Beatmaps/ControlPoints/EffectControlPoint.cs

@@ -1,19 +1,39 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using osu.Framework.Bindables;
+
 namespace osu.Game.Beatmaps.ControlPoints
 {
     public class EffectControlPoint : ControlPoint
     {
         /// <summary>
-        /// Whether this control point enables Kiai mode.
+        /// Whether the first bar line of this control point is ignored.
         /// </summary>
-        public bool KiaiMode;
+        public readonly BindableBool OmitFirstBarLineBindable = new BindableBool();
 
         /// <summary>
         /// Whether the first bar line of this control point is ignored.
         /// </summary>
-        public bool OmitFirstBarLine;
+        public bool OmitFirstBarLine
+        {
+            get => OmitFirstBarLineBindable.Value;
+            set => OmitFirstBarLineBindable.Value = value;
+        }
+
+        /// <summary>
+        /// Whether this control point enables Kiai mode.
+        /// </summary>
+        public readonly BindableBool KiaiModeBindable = new BindableBool();
+
+        /// <summary>
+        /// Whether this control point enables Kiai mode.
+        /// </summary>
+        public bool KiaiMode
+        {
+            get => KiaiModeBindable.Value;
+            set => KiaiModeBindable.Value = value;
+        }
 
         public override bool EquivalentTo(ControlPoint other) =>
             other is EffectControlPoint otherTyped &&

osu.Game/Beatmaps/ControlPoints/SampleControlPoint.cs

@@ -1,6 +1,7 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using osu.Framework.Bindables;
 using osu.Game.Audio;
 
 namespace osu.Game.Beatmaps.ControlPoints
@@ -12,12 +13,35 @@ namespace osu.Game.Beatmaps.ControlPoints
         /// <summary>
         /// The default sample bank at this control point.
         /// </summary>
-        public string SampleBank = DEFAULT_BANK;
+        public readonly Bindable<string> SampleBankBindable = new Bindable<string>(DEFAULT_BANK) { Default = DEFAULT_BANK };
+
+        /// <summary>
+        /// The speed multiplier at this control point.
+        /// </summary>
+        public string SampleBank
+        {
+            get => SampleBankBindable.Value;
+            set => SampleBankBindable.Value = value;
+        }
+
+        /// <summary>
+        /// The default sample bank at this control point.
+        /// </summary>
+        public readonly BindableInt SampleVolumeBindable = new BindableInt(100)
+        {
+            MinValue = 0,
+            MaxValue = 100,
+            Default = 100
+        };
 
         /// <summary>
         /// The default sample volume at this control point.
         /// </summary>
-        public int SampleVolume = 100;
+        public int SampleVolume
+        {
+            get => SampleVolumeBindable.Value;
+            set => SampleVolumeBindable.Value = value;
+        }
 
         /// <summary>
         /// Create a SampleInfo based on the sample settings in this control point.

osu.Game/Beatmaps/ControlPoints/TimingControlPoint.cs

@@ -1,7 +1,7 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
-using osuTK;
+using osu.Framework.Bindables;
 using osu.Game.Beatmaps.Timing;
 
 namespace osu.Game.Beatmaps.ControlPoints
@@ -11,23 +11,40 @@ namespace osu.Game.Beatmaps.ControlPoints
         /// <summary>
         /// The time signature at this control point.
         /// </summary>
-        public TimeSignatures TimeSignature = TimeSignatures.SimpleQuadruple;
+        public readonly Bindable<TimeSignatures> TimeSignatureBindable = new Bindable<TimeSignatures>(TimeSignatures.SimpleQuadruple) { Default = TimeSignatures.SimpleQuadruple };
+
+        /// <summary>
+        /// The time signature at this control point.
+        /// </summary>
+        public TimeSignatures TimeSignature
+        {
+            get => TimeSignatureBindable.Value;
+            set => TimeSignatureBindable.Value = value;
+        }
 
         public const double DEFAULT_BEAT_LENGTH = 1000;
 
         /// <summary>
         /// The beat length at this control point.
         /// </summary>
-        public virtual double BeatLength
+        public readonly BindableDouble BeatLengthBindable = new BindableDouble(DEFAULT_BEAT_LENGTH)
         {
-            get => beatLength;
+            Default = DEFAULT_BEAT_LENGTH,
-            set => beatLength = MathHelper.Clamp(value, 6, 60000);
+            MinValue = 6,
-        }
+            MaxValue = 60000
+        };
 
-        private double beatLength = DEFAULT_BEAT_LENGTH;
+        /// <summary>
+        /// The beat length at this control point.
+        /// </summary>
+        public double BeatLength
+        {
+            get => BeatLengthBindable.Value;
+            set => BeatLengthBindable.Value = value;
+        }
 
         public override bool EquivalentTo(ControlPoint other) =>
             other is TimingControlPoint otherTyped
-            && TimeSignature == otherTyped.TimeSignature && beatLength.Equals(otherTyped.beatLength);
+            && TimeSignature == otherTyped.TimeSignature && BeatLength.Equals(otherTyped.BeatLength);
     }
 }

osu.Game/Beatmaps/Formats/LegacyBeatmapDecoder.cs

@@ -376,7 +376,7 @@ namespace osu.Game.Beatmaps.Formats
                 handleTimingControlPoint(controlPoint);
             }
 
-            handleDifficultyControlPoint(new DifficultyControlPoint
+            handleDifficultyControlPoint(new LegacyDifficultyControlPoint
             {
                 Time = time,
                 SpeedMultiplier = speedMultiplier,

osu.Game/Beatmaps/Formats/LegacyDecoder.cs

@@ -189,6 +189,14 @@ namespace osu.Game.Beatmaps.Formats
             Foreground = 3
         }
 
+        internal class LegacyDifficultyControlPoint : DifficultyControlPoint
+        {
+            public LegacyDifficultyControlPoint()
+            {
+                SpeedMultiplierBindable.Precision = double.Epsilon;
+            }
+        }
+
         internal class LegacySampleControlPoint : SampleControlPoint
         {
             public int CustomSampleBank;

osu.Game/Beatmaps/Formats/LegacyDifficultyCalculatorBeatmapDecoder.cs

@@ -28,11 +28,15 @@ namespace osu.Game.Beatmaps.Formats
         }
 
         protected override TimingControlPoint CreateTimingControlPoint()
-            => new LegacyDifficultyCalculatorControlPoint();
+            => new LegacyDifficultyCalculatorTimingControlPoint();
 
-        private class LegacyDifficultyCalculatorControlPoint : TimingControlPoint
+        private class LegacyDifficultyCalculatorTimingControlPoint : TimingControlPoint
         {
-            public override double BeatLength { get; set; } = DEFAULT_BEAT_LENGTH;
+            public LegacyDifficultyCalculatorTimingControlPoint()
+            {
+                BeatLengthBindable.MinValue = double.MinValue;
+                BeatLengthBindable.MaxValue = double.MaxValue;
+            }
         }
     }
 }