Voice announcement: added heart rate info to voice announcements

Also added setting to toggle announcement of heart rate

Defaults to off to preserve current behavior

src/main/java/de/dennisguse/opentracks/stats/TrackStatistics.java

@@ -25,6 +25,7 @@ import java.time.Instant;
 
 import de.dennisguse.opentracks.data.models.Altitude;
 import de.dennisguse.opentracks.data.models.Distance;
+import de.dennisguse.opentracks.data.models.HeartRate;
 import de.dennisguse.opentracks.data.models.Speed;
 import de.dennisguse.opentracks.data.models.Track;
 import de.dennisguse.opentracks.data.models.TrackPoint;
@@ -56,6 +57,8 @@ public class TrackStatistics {
     private Speed maxSpeed;
     private Float totalAltitudeGain_m = null;
     private Float totalAltitudeLoss_m = null;
+    // The average heart rate seen on this track
+    private HeartRate avgHeartRate = null;
 
     public TrackStatistics() {
         reset();
@@ -76,6 +79,7 @@ public class TrackStatistics {
         altitudeExtremities.set(other.altitudeExtremities.getMin(), other.altitudeExtremities.getMax());
         totalAltitudeGain_m = other.totalAltitudeGain_m;
         totalAltitudeLoss_m = other.totalAltitudeLoss_m;
+        avgHeartRate = other.avgHeartRate;
     }
 
     @VisibleForTesting
@@ -108,6 +112,19 @@ public class TrackStatistics {
             stopTime = stopTime.isAfter(other.stopTime) ? stopTime : other.stopTime;
         }
 
+        if (avgHeartRate == null) {
+            avgHeartRate = other.avgHeartRate;
+        } else {
+            if (other.avgHeartRate != null) {
+                // Using total time as weights for the averaging.
+                // Important to do this before total time is updated
+                avgHeartRate = HeartRate.of(
+                        (totalTime.getSeconds() * avgHeartRate.getBPM() + other.totalTime.getSeconds() * other.avgHeartRate.getBPM())
+                                / (totalTime.getSeconds() + other.totalTime.getSeconds())
+                );
+            }
+        }
+
         totalDistance = totalDistance.plus(other.totalDistance);
         totalTime = totalTime.plus(other.totalTime);
         movingTime = movingTime.plus(other.movingTime);
@@ -230,6 +247,15 @@ public class TrackStatistics {
         return totalTime.minus(movingTime);
     }
 
+    public boolean hasAverageHeartRate() {
+        return avgHeartRate != null;
+    }
+
+    @Nullable
+    public HeartRate getAverageHeartRate() {
+        return avgHeartRate;
+    }
+
     /**
      * Gets the average speed.
      * This calculation only takes into account the displacement until the last point that was accounted for in statistics.
@@ -287,6 +313,12 @@ public class TrackStatistics {
         }
     }
 
+    public void setAverageHeartRate(HeartRate heartRate) {
+        if (heartRate != null) {
+            avgHeartRate = heartRate;
+        }
+    }
+
     public boolean hasTotalAltitudeGain() {
         return totalAltitudeGain_m != null;
     }

src/main/java/de/dennisguse/opentracks/stats/TrackStatisticsUpdater.java

@@ -26,6 +26,7 @@ import java.util.List;
 
 import de.dennisguse.opentracks.data.models.Altitude;
 import de.dennisguse.opentracks.data.models.Distance;
+import de.dennisguse.opentracks.data.models.HeartRate;
 import de.dennisguse.opentracks.data.models.Speed;
 import de.dennisguse.opentracks.data.models.TrackPoint;
 
@@ -64,6 +65,8 @@ public class TrackStatisticsUpdater {
 
     private final AltitudeRingBuffer altitudeBuffer;
     private final SpeedRingBuffer speedBuffer;
+    private float averageHeartRateBPM;
+    private Duration totalHeartRateDuration = Duration.ZERO;
 
     // The current segment's statistics
     private final TrackStatistics currentSegment;
@@ -85,6 +88,7 @@ public class TrackStatisticsUpdater {
 
         altitudeBuffer = new AltitudeRingBuffer(ALTITUDE_SMOOTHING_FACTOR);
         speedBuffer = new SpeedRingBuffer(SPEED_SMOOTHING_FACTOR);
+        resetAverageHeartRate();
     }
 
     public TrackStatisticsUpdater(TrackStatisticsUpdater toCopy) {
@@ -95,6 +99,7 @@ public class TrackStatisticsUpdater {
         this.speedBuffer = new SpeedRingBuffer(toCopy.speedBuffer);
 
         this.lastTrackPoint = toCopy.lastTrackPoint;
+        resetAverageHeartRate();
     }
 
     public TrackStatistics getTrackStatistics() {
@@ -142,6 +147,17 @@ public class TrackStatisticsUpdater {
             currentSegment.updateAltitudeExtremities(newAverage);
         }
 
+        // Update heart rate
+        if (trackPoint.hasHeartRate() && lastTrackPoint != null) {
+            Duration trackPointDuration = Duration.between(lastTrackPoint.getTime(), trackPoint.getTime());
+            Duration newTotalDuration = totalHeartRateDuration.plus(trackPointDuration);
+
+            averageHeartRateBPM = (totalHeartRateDuration.toMillis() * averageHeartRateBPM + trackPointDuration.toMillis() * trackPoint.getHeartRate().getBPM()) / newTotalDuration.toMillis();
+            totalHeartRateDuration = newTotalDuration;
+
+            currentSegment.setAverageHeartRate(HeartRate.of(averageHeartRateBPM));
+        }
+
         // Update total distance
         if (trackPoint.hasSensorDistance()) {
             // Sensor-based distance/speed
@@ -184,6 +200,12 @@ public class TrackStatisticsUpdater {
         lastTrackPoint = null;
         altitudeBuffer.reset();
         speedBuffer.reset();
+        resetAverageHeartRate();
+    }
+
+    private void resetAverageHeartRate() {
+        averageHeartRateBPM = 0.0f;
+        totalHeartRateDuration = Duration.ZERO;
     }
 
     /**