From 30e6d823c5db6c89be3d30eaa8c938a38e6930ce Mon Sep 17 00:00:00 2001
From: Alfonso Grillo <alfogrillo@gmail.com>
Date: Mon, 23 Oct 2023 16:42:56 +0200
Subject: [PATCH] Fix EstimatedWaveform amplitudes (#1939)

* Fix range

* Add data range & cleanup

* Fix preview tests
---
 .../VoiceMessages/EstimatedWaveformView.swift | 35 ++++++++++---------
 .../test_estimatedWaveformView.1.png          |  3 ++
 .../test_voiceMessagePreviewComposer.1.png    |  4 +--
 .../test_voiceMessageRoomPlaybackView.1.png   |  4 +--
 ...st_voiceMessageRoomTimelineView.Bubble.png |  4 +--
 ...est_voiceMessageRoomTimelineView.Plain.png |  4 +--
 6 files changed, 30 insertions(+), 24 deletions(-)
 create mode 100644 UnitTests/__Snapshots__/PreviewTests/test_estimatedWaveformView.1.png

diff --git a/ElementX/Sources/Services/Timeline/TimelineItems/Items/Messages/VoiceMessages/EstimatedWaveformView.swift b/ElementX/Sources/Services/Timeline/TimelineItems/Items/Messages/VoiceMessages/EstimatedWaveformView.swift
index dd4da8c53..4ae87feab 100644
--- a/ElementX/Sources/Services/Timeline/TimelineItems/Items/Messages/VoiceMessages/EstimatedWaveformView.swift
+++ b/ElementX/Sources/Services/Timeline/TimelineItems/Items/Messages/VoiceMessages/EstimatedWaveformView.swift
@@ -17,29 +17,32 @@
 import SwiftUI
 
 struct EstimatedWaveform: Equatable, Hashable {
+    static let dataRange: ClosedRange<UInt16> = 0...1024
     let data: [UInt16]
 }
 
 extension EstimatedWaveform {
-    func normalisedData(keepSamplesCount: Int) -> [Float] {
-        guard keepSamplesCount > 0 else {
+    /// Maps the `data` array to Float values in the range 0...1 respecting the `Self.dataRange` limits.
+    /// Up to `maxSamplesCount` will be returned in the output array
+    func normalisedData(maxSamplesCount: Int) -> [Float] {
+        guard maxSamplesCount > 0 else {
             return []
         }
+
         // Filter the data to keep only the expected number of samples
-        let originalCount = Double(data.count)
-        let expectedCount = Double(keepSamplesCount)
-        var filteredData: [UInt16] = []
-        if expectedCount < originalCount {
-            for index in 0..<keepSamplesCount {
-                let targetIndex = (Double(index) * (originalCount / expectedCount)).rounded()
-                filteredData.append(UInt16(data[Int(targetIndex)]))
-            }
+        let result: [UInt16]
+        if data.count > maxSamplesCount {
+            result = (0..<maxSamplesCount)
+                .map { index in
+                    let targetIndex = Int((Double(index) * (Double(data.count) / Double(maxSamplesCount))).rounded())
+                    return UInt16(data[targetIndex])
+                }
         } else {
-            filteredData = data
+            result = data
         }
-        // Normalize the sample
-        let max = max(1.0, filteredData.max().flatMap { Float($0) } ?? 1.0)
-        return filteredData.map { Float($0) / max }
+
+        // Normalize the sample in the allowed range
+        return result.map { Float($0) / Float(Self.dataRange.upperBound) }
     }
 }
 
@@ -79,7 +82,7 @@ struct EstimatedWaveformView: View {
         if normalizedWaveformData.count == count {
             return
         }
-        normalizedWaveformData = waveform.normalisedData(keepSamplesCount: count)
+        normalizedWaveformData = waveform.normalisedData(maxSamplesCount: count)
     }
 }
 
@@ -118,7 +121,7 @@ private struct WaveformShape: Shape {
     }
 }
 
-struct WaveformView_Previews: PreviewProvider, TestablePreview {
+struct EstimatedWaveformView_Previews: PreviewProvider, TestablePreview {
     static var previews: some View {
         // Wrap the WaveformView in a VStack otherwise the preview test will fail (because of Prefire / GeometryReader)
         VStack {
diff --git a/UnitTests/__Snapshots__/PreviewTests/test_estimatedWaveformView.1.png b/UnitTests/__Snapshots__/PreviewTests/test_estimatedWaveformView.1.png
new file mode 100644
index 000000000..1c5bcb647
--- /dev/null
+++ b/UnitTests/__Snapshots__/PreviewTests/test_estimatedWaveformView.1.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1433dd84c473727cd6ecda8a37ad12e73e9c8a137503a22586d66328a9798d84
+size 59769
diff --git a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessagePreviewComposer.1.png b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessagePreviewComposer.1.png
index 0afe573fe..3205ca2bf 100644
--- a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessagePreviewComposer.1.png
+++ b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessagePreviewComposer.1.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:2fe33a68b975f2483b8879f813f69c6b8565ea92cc512e1b469361dca5b30334
-size 69043
+oid sha256:1a14094723fbe08e8ebf64f6a7f567e57e8835533fcb3c2f03f806acded2af54
+size 65817
diff --git a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomPlaybackView.1.png b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomPlaybackView.1.png
index 2fddc18bb..9f2384708 100644
--- a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomPlaybackView.1.png
+++ b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomPlaybackView.1.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:5d32a87762fc4db710b3c698d5447dd9357a1f6cebe269df986a6bd5928aba4d
-size 64543
+oid sha256:f08e9a60a5e93a67714b869c77e16abd6252e96515aec9951c2fac8a206950e1
+size 61376
diff --git a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Bubble.png b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Bubble.png
index 23eef6254..656c34191 100644
--- a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Bubble.png
+++ b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Bubble.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:2f9bd66934c88ce2d6bb0b392389b38b9ef24ebff2f78e7a53c9f1618c0f40fe
-size 73049
+oid sha256:cced4619918ea4c66bddbc0c3b957b6239c2b11a4b40b41c08a0f4d84da1d944
+size 70256
diff --git a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Plain.png b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Plain.png
index 5ed8e2989..8fd801a80 100644
--- a/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Plain.png
+++ b/UnitTests/__Snapshots__/PreviewTests/test_voiceMessageRoomTimelineView.Plain.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:90039cc5805d8f0bbfbb9d48e52831dff02f86e38c573c6a616fa80ce94f22e8
-size 69596
+oid sha256:6086d159d868c2e0e9d80e19453c24fca783384864b9e6660c785cd4fd7c0986
+size 66757