From 2aa1ae4ecb96a4265bc01de166fc733474f0e14c Mon Sep 17 00:00:00 2001
From: 88hcsif <62969634+88hcsif@users.noreply.github.com>
Date: Thu, 25 Jun 2020 19:39:39 +0100
Subject: [PATCH] Add frame delay or frame rate stats to stat view. (#206)

Unfortunately Firefox does not expose frame delay stat.
Unfortunately Chrome and Safari do not expose frame rate stat.
---
 web/js/network/rtcp.js |  3 ++-
 web/js/stats/stats.js  | 56 ++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 56 insertions(+), 3 deletions(-)

diff --git a/web/js/network/rtcp.js b/web/js/network/rtcp.js
index fbda2f1e..710c9015 100644
--- a/web/js/network/rtcp.js
+++ b/web/js/network/rtcp.js
@@ -176,6 +176,7 @@ const rtcp = (() => {
         },
         input: (data) => inputChannel.send(data),
         isConnected: () => connected,
-        isInputReady: () => inputReady
+        isInputReady: () => inputReady,
+        getConnection: () => connection,
     }
 })(event, socket, env, log);
diff --git a/web/js/stats/stats.js b/web/js/stats/stats.js
index 069766ca..739ff4a5 100644
--- a/web/js/stats/stats.js
+++ b/web/js/stats/stats.js
@@ -262,6 +262,57 @@ const stats = (() => {
         return {get, enable, disable, render}
     })(moduleUi, performance, window);
 
+    /**
+     * User agent frame stats.
+     *
+     * ?Interface:
+     *  HTMLElement get()
+     *  void enable()
+     *  void disable()
+     *  void render()
+     *
+     * @version 1
+     */
+    const webRTCStats = (() => {
+        let value = 0;
+        let interval = null
+
+        let browser = env.getBrowser();
+        let label = 'FrameDelay'
+        if (browser === 'firefox') {
+            label = 'FramerateMean'
+        }
+        const ui = moduleUi(label, false, () => '');
+
+        const get = () => ui.el;
+
+        const enable = () => {
+            interval = window.setInterval(getStats, 1000);
+        }
+
+        const disable = () => {
+            window.clearInterval(interval);
+            value = 0;
+        }
+
+        const render = () => ui.update(value);
+
+        function getStats() {
+            if (!active || !rtcp.isConnected()) return;
+            rtcp.getConnection().getStats(null).then(stats => {
+                stats.forEach(report => {
+                    if (report["framesReceived"] !== undefined && report["framesDecoded"] !== undefined && report["framesDropped"] !== undefined) {
+                        value = report["framesReceived"] - report["framesDecoded"] - report["framesDropped"];
+                    } else if (report["framerateMean"] !== undefined) {
+                        value = Math.round(report["framerateMean"]*100)/100;
+                    }
+                });
+            });
+        }
+
+        return {get, enable, disable, render}
+    })(moduleUi, window);
+
     const enable = () => {
         active = true;
         modules.forEach(m => m.enable());
@@ -320,7 +371,8 @@ const stats = (() => {
     // add submodules
     modules.push(
         latency,
-        clientMemory
+        clientMemory,
+        webRTCStats
     );
     modules.forEach(m => statsOverlayEl.append(m.get()));
 
@@ -328,4 +380,4 @@ const stats = (() => {
     event.sub(HELP_OVERLAY_TOGGLED, onHelpOverlayToggle)
 
     return {enable, disable}
-})(document, event, log, window);
+})(document, env, event, log, window);