Expose some internal BWE statistics in GoogleCcEstimator stats. (#2041)

jitsi · Aug 21, 2023 · 8bb3315 · 8bb3315
1 parent 1a86219
commit 8bb3315
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 2 deletions.
diff --git a/...main/java/org/jitsi_modified/impl/neomedia/rtp/remotebitrateestimator/BandwidthUsage.java b/...main/java/org/jitsi_modified/impl/neomedia/rtp/remotebitrateestimator/BandwidthUsage.java
@@ -20,7 +20,7 @@
  *
  * @author Lyubomir Marinov
  */
-enum BandwidthUsage
+public enum BandwidthUsage
 {
     kBwNormal(0), kBwUnderusing(-1), kBwOverusing(1);
 

diff --git a/...ain/java/org/jitsi_modified/impl/neomedia/rtp/remotebitrateestimator/OveruseDetector.java b/...ain/java/org/jitsi_modified/impl/neomedia/rtp/remotebitrateestimator/OveruseDetector.java
@@ -195,4 +195,9 @@ private void updateThreshold(double modifiedOffset, long nowMs)
 
         lastUpdateMs = nowMs;
     }
+
+    public double getThreshold()
+    {
+        return threshold;
+    }
 }
diff --git a/..._modified/impl/neomedia/rtp/remotebitrateestimator/RemoteBitrateEstimatorAbsSendTime.java b/..._modified/impl/neomedia/rtp/remotebitrateestimator/RemoteBitrateEstimatorAbsSendTime.java
@@ -389,6 +389,22 @@ public synchronized void setMinBitrate(int minBitrateBps)
         remoteRate.setMinBitrate(minBitrateBps);
     }
 
+    /**
+     * Get various statistics about the estimation process.  [Local addition, not in original C++.]
+     */
+    public synchronized @Nullable Statistics getStatistics()
+    {
+        if (detector == null)
+        {
+            return null;
+        }
+        return new Statistics(
+            detector.estimator.getOffset(),
+            detector.detector.getThreshold(),
+            detector.detector.getState()
+        );
+    }
+
     /**
      * Holds the {@link InterArrival}, {@link OveruseEstimator} and
      * {@link OveruseDetector} instances that estimate the remote bitrate of a
@@ -439,4 +455,20 @@ public static long convertMsTo24Bits(long timeMs)
     {
         return (((timeMs << kAbsSendTimeFraction) + 500) / 1000) & 0x00FFFFFF;
     }
+
+    /**
+     * Various statistics about the estimation process.  [Local addition, not in original C++.]
+     */
+    public static class Statistics {
+        public double offset;
+        public double threshold;
+        public BandwidthUsage hypothesis;
+
+        public Statistics(double o, double t, BandwidthUsage h)
+        {
+            offset = o;
+            threshold = t;
+            hypothesis = h;
+        }
+    }
 }
diff --git a/...edia-transform/src/main/kotlin/org/jitsi/nlj/rtp/bandwidthestimation/GoogleCcEstimator.kt b/...edia-transform/src/main/kotlin/org/jitsi/nlj/rtp/bandwidthestimation/GoogleCcEstimator.kt
@@ -111,7 +111,12 @@ class GoogleCcEstimator(diagnosticContext: DiagnosticContext, parentLogger: Logg
         getCurrentBw(now)
     ).apply {
         addNumber("incomingEstimateExpirations", bitrateEstimatorAbsSendTime.incomingEstimateExpirations)
-        addNumber("latestDelayEstimate", sendSideBandwidthEstimation.latestREMB)
+        bitrateEstimatorAbsSendTime.statistics?.run {
+            addNumber("delayBasedEstimatorOffset", offset)
+            addNumber("delayBasedEstimatorThreshold", threshold)
+            addNumber("delayBasedEstimatorHypothesis", hypothesis.value)
+        }
+        addNumber("latestDelayBasedEstimate", sendSideBandwidthEstimation.latestREMB)
         addNumber("latestLossFraction", sendSideBandwidthEstimation.latestFractionLoss / 256.0)
         with(sendSideBandwidthEstimation.statistics) {
             update(now.toEpochMilli())