Merge pull request #21754 from Feodor0090/waveform-invalidate

Reload waveform on track replacement in editor

osu.Game/Beatmaps/WorkingBeatmap.cs

@@ -34,8 +34,6 @@ namespace osu.Game.Beatmaps
         // TODO: remove once the fallback lookup is not required (and access via `working.BeatmapInfo.Metadata` directly).
         public BeatmapMetadata Metadata => BeatmapInfo.Metadata;
 
-        public Waveform Waveform => waveform.Value;
-
         public Storyboard Storyboard => storyboard.Value;
 
         public Texture Background => GetBackground(); // Texture uses ref counting, so we want to return a new instance every usage.
@@ -48,10 +46,11 @@ namespace osu.Game.Beatmaps
 
         private readonly object beatmapFetchLock = new object();
 
-        private readonly Lazy<Waveform> waveform;
         private readonly Lazy<Storyboard> storyboard;
         private readonly Lazy<ISkin> skin;
+
         private Track track; // track is not Lazy as we allow transferring and loading multiple times.
+        private Waveform waveform; // waveform is also not Lazy as the track may change.
 
         protected WorkingBeatmap(BeatmapInfo beatmapInfo, AudioManager audioManager)
         {
@@ -60,7 +59,6 @@ namespace osu.Game.Beatmaps
             BeatmapInfo = beatmapInfo;
             BeatmapSetInfo = beatmapInfo.BeatmapSet ?? new BeatmapSetInfo();
 
-            waveform = new Lazy<Waveform>(GetWaveform);
             storyboard = new Lazy<Storyboard>(GetStoryboard);
             skin = new Lazy<ISkin>(GetSkin);
         }
@@ -108,7 +106,16 @@ namespace osu.Game.Beatmaps
 
         public virtual bool TrackLoaded => track != null;
 
-        public Track LoadTrack() => track = GetBeatmapTrack() ?? GetVirtualTrack(1000);
+        public Track LoadTrack()
+        {
+            track = GetBeatmapTrack() ?? GetVirtualTrack(1000);
+
+            // the track may have changed, recycle the current waveform.
+            waveform?.Dispose();
+            waveform = null;
+
+            return track;
+        }
 
         public void PrepareTrackForPreview(bool looping, double offsetFromPreviewPoint = 0)
         {
@@ -171,6 +178,12 @@ namespace osu.Game.Beatmaps
 
         #endregion
 
+        #region Waveform
+
+        public Waveform Waveform => waveform ??= GetWaveform();
+
+        #endregion
+
         #region Beatmap
 
         public virtual bool BeatmapLoaded => beatmapLoadTask?.IsCompleted ?? false;

osu.Game/Screens/Edit/Compose/Components/Timeline/Timeline.cs

@@ -5,6 +5,7 @@
 
 using System;
 using osu.Framework.Allocation;
+using osu.Framework.Audio.Track;
 using osu.Framework.Bindables;
 using osu.Framework.Extensions.Color4Extensions;
 using osu.Framework.Graphics;
@@ -35,8 +36,6 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
 
         public readonly Bindable<bool> TicksVisible = new Bindable<bool>();
 
-        public readonly IBindable<WorkingBeatmap> Beatmap = new Bindable<WorkingBeatmap>();
-
         [Resolved]
         private EditorClock editorClock { get; set; }
 
@@ -92,6 +91,8 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
 
         private double trackLengthForZoom;
 
+        private readonly IBindable<Track> track = new Bindable<Track>();
+
         [BackgroundDependencyLoader]
         private void load(IBindable<WorkingBeatmap> beatmap, OsuColour colours, OsuConfigManager config)
         {
@@ -139,11 +140,8 @@ namespace osu.Game.Screens.Edit.Compose.Components.Timeline
 
             waveformOpacity = config.GetBindable<float>(OsuSetting.EditorWaveformOpacity);
 
-            Beatmap.BindTo(beatmap);
-            Beatmap.BindValueChanged(b =>
-            {
-                waveform.Waveform = b.NewValue.Waveform;
-            }, true);
+            track.BindTo(editorClock.Track);
+            track.BindValueChanged(_ => waveform.Waveform = beatmap.Value.Waveform, true);
 
             Zoom = (float)(defaultTimelineZoom * editorBeatmap.BeatmapInfo.TimelineZoom);
         }

osu.Game/Screens/Edit/Timing/TapTimingControl.cs

@@ -88,7 +88,7 @@ namespace osu.Game.Screens.Edit.Timing
                                                     Anchor = Anchor.CentreLeft,
                                                     Origin = Anchor.CentreLeft,
                                                 },
-                                                new WaveformComparisonDisplay(),
+                                                new WaveformComparisonDisplay()
                                             }
                                         },
                                     }

osu.Game/Screens/Edit/Timing/WaveformComparisonDisplay.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Linq;
 using osu.Framework.Allocation;
+using osu.Framework.Audio.Track;
 using osu.Framework.Bindables;
 using osu.Framework.Graphics;
 using osu.Framework.Graphics.Audio;
@@ -294,13 +295,18 @@ namespace osu.Game.Screens.Edit.Timing
             [Resolved]
             private OverlayColourProvider colourProvider { get; set; } = null!;
 
+            [Resolved]
+            private IBindable<WorkingBeatmap> beatmap { get; set; } = null!;
+
+            private readonly IBindable<Track> track = new Bindable<Track>();
+
             public WaveformRow(bool isMainRow)
             {
                 this.isMainRow = isMainRow;
             }
 
             [BackgroundDependencyLoader]
-            private void load(IBindable<WorkingBeatmap> beatmap)
+            private void load(EditorClock clock)
             {
                 InternalChildren = new Drawable[]
                 {
@@ -330,6 +336,13 @@ namespace osu.Game.Screens.Edit.Timing
                         Colour = colourProvider.Content2
                     }
                 };
+
+                track.BindTo(clock.Track);
+            }
+
+            protected override void LoadComplete()
+            {
+                track.ValueChanged += _ => waveformGraph.Waveform = beatmap.Value.Waveform;
             }
 
             public int BeatIndex { set => beatIndexText.Text = value.ToString(); }