Adds frame rate statistics.

JitsiConferenceEventManager.js

@@ -31,6 +31,76 @@ function JitsiConferenceEventManager(conference) {
         });
 }
 
+/**
+ * Groups resolutions by user id, skip incorrect resolutions.
+ * @param conference {JitsiConference} the conference
+ * @param resolutions map of resolutions by ssrc
+ */
+function mapResolutionsByUserId(conference, resolutions) {
+
+    const id2resolution = {};
+
+    // preprocess resolutions: group by user id, skip incorrect
+    // resolutions etc.
+    Object.keys(resolutions).forEach(ssrc => {
+        const resolution = resolutions[ssrc];
+
+        if (!resolution.width || !resolution.height
+            || resolution.width === -1 || resolution.height === -1) {
+            return;
+        }
+
+        const id = conference.rtc.getResourceBySSRC(ssrc);
+
+        if (!id) {
+            return;
+        }
+
+        // ssrc to resolution map for user id
+        const idResolutions = id2resolution[id] || {};
+
+        idResolutions[ssrc] = resolution;
+
+        id2resolution[id] = idResolutions;
+    });
+
+    return id2resolution;
+}
+
+/**
+ * Groups framerates by user id, skip framerates with value of 0.
+ * @param conference {JitsiConference} the conference
+ * @param framerates map of framerates by ssrc
+ */
+function mapFrameratesByUserId(conference, framerates) {
+
+    const id2framerate = {};
+
+    // preprocess framerates: group by user id
+    Object.keys(framerates).forEach(ssrc => {
+        const framerate = framerates[ssrc];
+
+        if (framerate === 0) {
+            return;
+        }
+
+        const id = conference.rtc.getResourceBySSRC(ssrc);
+
+        if (!id) {
+            return;
+        }
+
+        // ssrc to framerate map for user id
+        const id2framerates = id2framerate[id] || {};
+
+        id2framerates[ssrc] = framerate;
+
+        id2framerate[id] = id2framerates;
+    });
+
+    return id2framerate;
+}
+
 /**
  * Setups event listeners related to conference.chatRoom
  */
@@ -569,35 +639,9 @@ JitsiConferenceEventManager.prototype.setupStatisticsListeners = function() {
             JitsiConferenceEvents.BEFORE_STATISTICS_DISPOSED);
     });
     conference.statistics.addConnectionStatsListener(stats => {
-        const ssrc2resolution = stats.resolution;
-
-        const id2resolution = {};
-
-        // preprocess resolutions: group by user id, skip incorrect
-        // resolutions etc.
-        Object.keys(ssrc2resolution).forEach(ssrc => {
-            const resolution = ssrc2resolution[ssrc];
-
-            if (!resolution.width || !resolution.height
-                || resolution.width === -1 || resolution.height === -1) {
-                return;
-            }
-
-            const id = conference.rtc.getResourceBySSRC(ssrc);
-
-            if (!id) {
-                return;
-            }
-
-            // ssrc to resolution map for user id
-            const idResolutions = id2resolution[id] || {};
-
-            idResolutions[ssrc] = resolution;
-
-            id2resolution[id] = idResolutions;
-        });
 
-        stats.resolution = id2resolution;
+        stats.resolution = mapResolutionsByUserId(conference, stats.resolution);
+        stats.framerate = mapFrameratesByUserId(conference, stats.framerate);
 
         conference.eventEmitter.emit(
             JitsiConferenceEvents.CONNECTION_STATS, stats);

modules/connectivity/ConnectionQuality.js

@@ -396,7 +396,8 @@ export default class ConnectionQuality {
         const data = {
             bitrate: this._localStats.bitrate,
             packetLoss: this._localStats.packetLoss,
-            connectionQuality: this._localStats.connectionQuality
+            connectionQuality: this._localStats.connectionQuality,
+            framerate: this._localStats.framerate
         };
 
         // TODO: It looks like the remote participants don't really "care"
@@ -477,7 +478,8 @@ export default class ConnectionQuality {
         this._remoteStats[id] = {
             bitrate: data.bitrate,
             packetLoss: data.packetLoss,
-            connectionQuality: data.connectionQuality
+            connectionQuality: data.connectionQuality,
+            framerate: data.framerate
         };
 
         this.eventEmitter.emit(

modules/statistics/RTPStatsCollector.js

@@ -23,7 +23,8 @@ KEYS_BY_BROWSER_TYPE[RTCBrowserType.RTC_BROWSER_FIREFOX] = {
     'packetsLost': 'packetsLost',
     'packetsSent': 'packetsSent',
     'bytesReceived': 'bytesReceived',
-    'bytesSent': 'bytesSent'
+    'bytesSent': 'bytesSent',
+    'framerateMean': 'framerateMean'
 };
 KEYS_BY_BROWSER_TYPE[RTCBrowserType.RTC_BROWSER_CHROME] = {
     'receiveBandwidth': 'googAvailableReceiveBandwidth',
@@ -42,6 +43,8 @@ KEYS_BY_BROWSER_TYPE[RTCBrowserType.RTC_BROWSER_CHROME] = {
     'googFrameWidthReceived': 'googFrameWidthReceived',
     'googFrameHeightSent': 'googFrameHeightSent',
     'googFrameWidthSent': 'googFrameWidthSent',
+    'googFrameRateReceived': 'googFrameRateReceived',
+    'googFrameRateSent': 'googFrameRateSent',
     'audioInputLevel': 'audioInputLevel',
     'audioOutputLevel': 'audioOutputLevel'
 };
@@ -85,6 +88,7 @@ function SsrcStats() {
         upload: 0
     };
     this.resolution = {};
+    this.framerate = 0;
 }
 
 /**
@@ -122,6 +126,14 @@ SsrcStats.prototype.resetBitrate = function() {
     this.bitrate.upload = 0;
 };
 
+/**
+ * Sets the "framerate".
+ * @param framerate the value to set.
+ */
+SsrcStats.prototype.setFramerate = function(framerate) {
+    this.framerate = framerate || 0;
+};
+
 /**
  *
  */
@@ -587,6 +599,21 @@ StatsCollector.prototype.processStatsReport = function() {
             }
         } catch (e) { /* not supported*/ }
 
+        // Tries to get frame rate
+        try {
+            ssrcStats.setFramerate(
+                getStatValue(now, 'googFrameRateReceived')
+                || getStatValue(now, 'googFrameRateSent')
+                || 0);
+        } catch (e) {
+            // if it fails with previous properties(chrome),
+            // let's try with another one (FF)
+            try {
+                ssrcStats.setFramerate(Math.round(
+                    getNonNegativeStat(now, 'framerateMean')));
+            } catch (err) { /* not supported*/ }
+        }
+
         if (resolution.height && resolution.width) {
             ssrcStats.setResolution(resolution);
         } else {
@@ -606,6 +633,7 @@ StatsCollector.prototype.processStatsReport = function() {
     let bitrateDownload = 0;
     let bitrateUpload = 0;
     const resolutions = {};
+    const framerates = {};
 
     Object.keys(this.ssrc2stats).forEach(
         function(ssrc) {
@@ -626,6 +654,9 @@ StatsCollector.prototype.processStatsReport = function() {
 
             // collect resolutions
             resolutions[ssrc] = ssrcStats.resolution;
+
+            // collect framerates
+            framerates[ssrc] = ssrcStats.framerate;
         },
         this
     );
@@ -650,6 +681,7 @@ StatsCollector.prototype.processStatsReport = function() {
         'bitrate': this.conferenceStats.bitrate,
         'packetLoss': this.conferenceStats.packetLoss,
         'resolution': resolutions,
+        'framerate': framerates,
         'transport': this.conferenceStats.transport
     });
     this.conferenceStats.transport = [];