Determine SampleInfo defaults in DrawableHitObject

osu.Game.Rulesets.Catch/Objects/JuiceStream.cs

@@ -12,6 +12,7 @@ using osu.Game.Rulesets.Objects;
 using osu.Game.Rulesets.Objects.Types;
 using OpenTK;
 using osu.Framework.Lists;
+using osu.Framework.Extensions.IEnumerableExtensions;
 
 namespace osu.Game.Rulesets.Catch.Objects
 {
@@ -29,9 +30,14 @@ namespace osu.Game.Rulesets.Catch.Objects
         public double Velocity;
         public double TickDistance;
 
+        private ControlPointInfo controlPointInfo;
+        private BeatmapDifficulty difficulty;
+
         public override void ApplyDefaults(ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
         {
             base.ApplyDefaults(controlPointInfo, difficulty);
+            this.controlPointInfo = controlPointInfo;
+            this.difficulty = difficulty;
 
             TimingControlPoint timingPoint = controlPointInfo.TimingPointAt(StartTime);
             DifficultyControlPoint difficultyPoint = controlPointInfo.DifficultyPointAt(StartTime);
@@ -124,6 +130,8 @@ namespace osu.Game.Rulesets.Catch.Objects
                     });
                 }
 
+                ticks.ForEach(t => t.ApplyDefaults(controlPointInfo, difficulty));
+
                 return ticks;
             }
         }

osu.Game.Rulesets.Mania/Objects/HoldNote.cs

@@ -63,10 +63,16 @@ namespace osu.Game.Rulesets.Mania.Objects
         /// </summary>
         private double tickSpacing = 50;
 
+        private ControlPointInfo controlPointInfo;
+        private BeatmapDifficulty difficulty;
+
         public override void ApplyDefaults(ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
         {
             base.ApplyDefaults(controlPointInfo, difficulty);
 
+            this.controlPointInfo = controlPointInfo;
+            this.difficulty = difficulty;
+
             TimingControlPoint timingPoint = controlPointInfo.TimingPointAt(StartTime);
             tickSpacing = timingPoint.BeatLength / difficulty.SliderTickRate;
 
@@ -89,11 +95,15 @@ namespace osu.Game.Rulesets.Mania.Objects
 
             for (double t = StartTime + tickSpacing; t <= EndTime - tickSpacing; t += tickSpacing)
             {
-                ret.Add(new HoldNoteTick
+                var tick = new HoldNoteTick
                 {
                     StartTime = t,
                     Column = Column
-                });
+                };
+
+                tick.ApplyDefaults(controlPointInfo, difficulty);
+
+                ret.Add(tick);
             }
 
             return ret;

osu.Game.Rulesets.Osu/Objects/Drawables/DrawableSlider.cs

@@ -57,6 +57,7 @@ namespace osu.Game.Rulesets.Osu.Objects.Drawables
                     Scale = s.Scale,
                     ComboColour = s.ComboColour,
                     Samples = s.Samples,
+                    SoundControlPoint = s.SoundControlPoint
                 })
             };
 

osu.Game.Rulesets.Osu/Objects/Slider.cs

@@ -10,6 +10,7 @@ using System.Linq;
 using osu.Game.Audio;
 using osu.Game.Beatmaps;
 using osu.Game.Beatmaps.ControlPoints;
+using osu.Framework.Extensions.IEnumerableExtensions;
 
 namespace osu.Game.Rulesets.Osu.Objects
 {
@@ -74,10 +75,16 @@ namespace osu.Game.Rulesets.Osu.Objects
         public double Velocity;
         public double TickDistance;
 
+        private ControlPointInfo controlPointInfo;
+        private BeatmapDifficulty difficulty;
+
         public override void ApplyDefaults(ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
         {
             base.ApplyDefaults(controlPointInfo, difficulty);
 
+            this.controlPointInfo = controlPointInfo;
+            this.difficulty = difficulty;
+
             TimingControlPoint timingPoint = controlPointInfo.TimingPointAt(StartTime);
             DifficultyControlPoint difficultyPoint = controlPointInfo.DifficultyPointAt(StartTime);
 
@@ -124,7 +131,7 @@ namespace osu.Game.Rulesets.Osu.Objects
                         var distanceProgress = d / length;
                         var timeProgress = reversed ? 1 - distanceProgress : distanceProgress;
 
-                        yield return new SliderTick
+                        var ret = new SliderTick
                         {
                             RepeatIndex = repeat,
                             StartTime = repeatStartTime + timeProgress * repeatDuration,
@@ -139,6 +146,10 @@ namespace osu.Game.Rulesets.Osu.Objects
                                 Volume = s.Volume
                             }))
                         };
+
+                        ret.ApplyDefaults(controlPointInfo, difficulty);
+
+                        yield return ret;
                     }
                 }
             }
@@ -158,7 +169,7 @@ namespace osu.Game.Rulesets.Osu.Objects
                         var repeatStartTime = StartTime + repeat * repeatDuration;
                         var distanceProgress = d / length;
 
-                        yield return new RepeatPoint
+                        var ret = new RepeatPoint
                         {
                             RepeatIndex = repeat,
                             StartTime = repeatStartTime,
@@ -167,6 +178,10 @@ namespace osu.Game.Rulesets.Osu.Objects
                             Scale = Scale,
                             ComboColour = ComboColour,
                         };
+
+                        ret.ApplyDefaults(controlPointInfo, difficulty);
+
+                        yield return ret;
                     }
                 }
             }

osu.Game.Rulesets.Taiko/Objects/DrumRoll.cs

@@ -55,9 +55,14 @@ namespace osu.Game.Rulesets.Taiko.Objects
         /// </summary>
         private double tickSpacing = 100;
 
+        private ControlPointInfo controlPointInfo;
+        private BeatmapDifficulty difficulty;
+
         public override void ApplyDefaults(ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
         {
             base.ApplyDefaults(controlPointInfo, difficulty);
+            this.controlPointInfo = controlPointInfo;
+            this.difficulty = difficulty;
 
             TimingControlPoint timingPoint = controlPointInfo.TimingPointAt(StartTime);
 
@@ -77,7 +82,7 @@ namespace osu.Game.Rulesets.Taiko.Objects
             bool first = true;
             for (double t = StartTime; t < EndTime + tickSpacing / 2; t += tickSpacing)
             {
-                ret.Add(new DrumRollTick
+                var tick = new DrumRollTick
                 {
                     FirstTick = first,
                     TickSpacing = tickSpacing,
@@ -89,12 +94,15 @@ namespace osu.Game.Rulesets.Taiko.Objects
                         Name = @"slidertick",
                         Volume = s.Volume
                     }))
-                });
+                };
 
+                tick.ApplyDefaults(controlPointInfo, difficulty);
+
+                ret.Add(tick);
                 first = false;
             }
 
             return ret;
         }
     }
-}
+}

osu.Game/Audio/SampleInfo.cs

@@ -15,40 +15,19 @@ namespace osu.Game.Audio
         public const string HIT_NORMAL = @"hitnormal";
         public const string HIT_CLAP = @"hitclap";
 
-        /// <summary>
-        /// The <see cref="SoundControlPoint"/> that is used for <see cref="Bank"/> and <see cref="Volume"/>
-        /// if the values have not already been provided by the hitobject.
-        /// </summary>
-        [JsonIgnore]
-        public SoundControlPoint ControlPoint;
-
-        private string bank;
         /// <summary>
         /// The bank to load the sample from.
         /// </summary>
-        public string Bank
+        public string Bank;
-        {
-            get { return string.IsNullOrEmpty(bank) ? (ControlPoint?.SampleBank ?? "normal") : bank; }
-            set { bank = value; }
-        }
-
-        public bool ShouldSerializeBank() => Bank != ControlPoint.SampleBank;
 
         /// <summary>
         /// The name of the sample to load.
         /// </summary>
-        public string Name { get; set; }
+        public string Name;
 
-        private int volume;
         /// <summary>
         /// The sample volume.
         /// </summary>
-        public int Volume
+        public int Volume;
-        {
-            get { return volume == 0 ? (ControlPoint?.SampleVolume ?? 0) : volume; }
-            set { volume = value; }
-        }
-
-        public bool ShouldSerializeVolume() => Volume != ControlPoint.SampleVolume;
     }
 }

osu.Game/Beatmaps/ControlPoints/SoundControlPoint.cs

@@ -5,14 +5,16 @@ namespace osu.Game.Beatmaps.ControlPoints
 {
     public class SoundControlPoint : ControlPoint
     {
+        public const string DEFAULT_BANK = "normal";
+
         /// <summary>
         /// The default sample bank at this control point.
         /// </summary>
-        public string SampleBank;
+        public string SampleBank = DEFAULT_BANK;
 
         /// <summary>
         /// The default sample volume at this control point.
         /// </summary>
         public int SampleVolume;
     }
-}
+}

osu.Game/Rulesets/Objects/Drawables/DrawableHitObject.cs

@@ -86,12 +86,23 @@ namespace osu.Game.Rulesets.Objects.Drawables
         {
             foreach (SampleInfo sample in HitObject.Samples)
             {
-                SampleChannel channel = audio.Sample.Get($@"Gameplay/{sample.Bank}-{sample.Name}");
+                if (HitObject.SoundControlPoint == null)
+                    throw new ArgumentNullException(nameof(HitObject.SoundControlPoint), $"{nameof(HitObject)} must always have an attached {nameof(HitObject.SoundControlPoint)}.");
+
+                var bank = sample.Bank;
+                if (string.IsNullOrEmpty(bank))
+                    bank = HitObject.SoundControlPoint.SampleBank;
+
+                int volume = sample.Volume;
+                if (volume == 0)
+                    volume = HitObject.SoundControlPoint.SampleVolume;
+
+                SampleChannel channel = audio.Sample.Get($@"Gameplay/{bank}-{sample.Name}");
 
                 if (channel == null)
                     continue;
 
-                channel.Volume.Value = sample.Volume;
+                channel.Volume.Value = volume;
                 Samples.Add(channel);
             }
         }

osu.Game/Rulesets/Objects/HitObject.cs

@@ -31,6 +31,9 @@ namespace osu.Game.Rulesets.Objects
         /// </summary>
         public SampleInfoList Samples = new SampleInfoList();
 
+        [JsonIgnore]
+        public SoundControlPoint SoundControlPoint;
+
         /// <summary>
         /// Whether this <see cref="HitObject"/> is in Kiai time.
         /// </summary>
@@ -48,13 +51,7 @@ namespace osu.Game.Rulesets.Objects
             EffectControlPoint effectPoint = controlPointInfo.EffectPointAt(StartTime);
 
             Kiai = effectPoint.KiaiMode;
-
+            SoundControlPoint = soundPoint;
-            // Initialize first sample
-            Samples.ForEach(s => s.ControlPoint = soundPoint);
-
-            // Initialize any repeat samples
-            var repeatData = this as IHasRepeats;
-            repeatData?.RepeatSamples?.ForEach(r => r.ForEach(s => s.ControlPoint = soundPoint));
         }
     }
 }