Merge pull request #6213 from bdach/waveform-lacklustre-error-checking

Check BASS error codes more diligently when retrieving waveform data
ppy · Mar 13, 2024 · 94f2e77 · 94f2e77
2 parents c17d3f8 + 95e5757
commit 94f2e77
Showing 1 changed file with 48 additions and 3 deletions.
diff --git a/osu.Framework/Audio/Track/Waveform.cs b/osu.Framework/Audio/Track/Waveform.cs
@@ -99,14 +99,30 @@ public Waveform(Stream? data)
 
                 int decodeStream = Bass.CreateStream(StreamSystem.NoBuffer, BassFlags.Decode | BassFlags.Float, fileCallbacks.Callbacks, fileCallbacks.Handle);
 
+                if (decodeStream == 0)
+                {
+                    logBassError("could not create stream");
+                    return;
+                }
+
                 float[]? sampleBuffer = null;
 
                 try
                 {
-                    Bass.ChannelGetInfo(decodeStream, out ChannelInfo info);
+                    if (!Bass.ChannelGetInfo(decodeStream, out ChannelInfo info))
+                    {
+                        logBassError("could not retrieve channel information");
+                        return;
+                    }
 
                     long length = Bass.ChannelGetLength(decodeStream);
 
+                    if (length < 0)
+                    {
+                        logBassError("could not retrieve channel length");
+                        return;
+                    }
+
                     // Each "point" is generated from a number of samples, each sample contains a number of channels
                     int samplesPerPoint = (int)(info.Frequency * resolution * info.Channels);
 
@@ -127,6 +143,13 @@ public Waveform(Stream? data)
                     while (length > 0)
                     {
                         length = Bass.ChannelGetData(decodeStream, sampleBuffer, bytesPerIteration);
+
+                        if (length < 0 && Bass.LastError != Errors.Ended)
+                        {
+                            logBassError("could not retrieve sample data");
+                            return;
+                        }
+
                         int samplesRead = (int)(length / bytes_per_sample);
 
                         // Each point is composed of multiple samples
@@ -157,9 +180,20 @@ public Waveform(Stream? data)
                         }
                     }
 
-                    Bass.ChannelSetPosition(decodeStream, 0);
+                    if (!Bass.ChannelSetPosition(decodeStream, 0))
+                    {
+                        logBassError("could not reset channel position");
+                        return;
+                    }
+
                     length = Bass.ChannelGetLength(decodeStream);
 
+                    if (length < 0)
+                    {
+                        logBassError("could not retrieve channel length");
+                        return;
+                    }
+
                     // Read FFT data
                     float[] bins = new float[fft_bins];
                     int currentPoint = 0;
@@ -168,6 +202,13 @@ public Waveform(Stream? data)
                     while (length > 0)
                     {
                         length = Bass.ChannelGetData(decodeStream, bins, (int)fft_samples);
+
+                        if (length < 0 && Bass.LastError != Errors.Ended)
+                        {
+                            logBassError("could not retrieve FFT data");
+                            return;
+                        }
+
                         currentByte += length;
 
                         float lowIntensity = computeIntensity(info, bins, low_min, mid_min);
@@ -191,7 +232,9 @@ public Waveform(Stream? data)
                 }
                 finally
                 {
-                    Bass.StreamFree(decodeStream);
+                    if (!Bass.StreamFree(decodeStream))
+                        logBassError("failed to free decode stream");
+
                     fileCallbacks.Dispose();
 
                     data.Dispose();
@@ -201,6 +244,8 @@ public Waveform(Stream? data)
                         ArrayPool<float>.Shared.Return(sampleBuffer);
                 }
             }, cancelSource.Token);
+
+            void logBassError(string reason) => Logger.Log($"BASS failure while reading waveform: {reason} ({Bass.LastError})");
         }
 
         private float computeIntensity(ChannelInfo info, float[] bins, float startFrequency, float endFrequency)