Merge pull request #151 from jitsi/audio_problem_detection

Implements audio problems detection

JitsiConference.js

@@ -68,6 +68,7 @@ function JitsiConference(options) {
         video: undefined
     };
     this.isMutedByFocus = false;
+    this.reportedAudioSSRCs = {};
 }
 
 /**
@@ -944,6 +945,63 @@ JitsiConference.prototype.isCallstatsEnabled = function () {
     return this.statistics.isCallstatsEnabled();
 }
 
+/**
+ * Reports detected audio problem with the media stream related to the passed
+ * ssrc.
+ * @param ssrc {string} the ssrc
+ */
+JitsiConference.prototype._reportAudioProblem = function (ssrc) {
+    if(this.reportedAudioSSRCs[ssrc])
+        return;
+    var track = this.rtc.getRemoteTrackBySSRC(ssrc);
+    if(!track || !track.isAudioTrack())
+        return;
+
+    this.reportedAudioSSRCs[ssrc] = true;
+    var errorContent = {
+        errMsg: "The audio is received but not played",
+        ssrc: ssrc
+    };
+
+    var mstream = track.stream, mtrack = track.track;
+    if(mstream) {
+        errorContent.MediaStream = {
+            active: mstream.active,
+            id: mstream.id
+        }
+    }
+
+    if(mtrack) {
+        errorContent.MediaStreamTrack = {
+            enabled: mtrack.enabled,
+            id: mtrack.id,
+            label: mtrack.label,
+            muted: mtrack.muted
+        }
+    }
+
+    if(track.containers) {
+        errorContent.containers = [];
+        track.containers.forEach(function (container) {
+            errorContent.containers.push({
+                autoplay: container.autoplay,
+                muted: container.muted,
+                src: container.src,
+                volume: container.volume,
+                id: container.id,
+                ended: container.ended,
+                paused: container.paused,
+                readyState: container.readyState
+            });
+        });
+    }
+
+    this.statistics.sendDetectedAudioProblem(
+        new Error(JSON.stringify(errorContent)));
+    logger.error("Audio problem detected. The audio is received but not played",
+        errorContent);
+}
+
 /**
  * Setups the listeners needed for the conference.
  * @param conference the conference
@@ -1309,6 +1367,11 @@ function setupListeners(conference) {
 
             conference.rtc.setAudioLevel(resource, level);
         });
+
+        conference.statistics.addAudioProblemListener(function (ssrc) {
+            conference._reportAudioProblem(ssrc)
+        });
+
         conference.statistics.addConnectionStatsListener(function (stats) {
             var ssrc2resolution = stats.resolution;
 

modules/RTC/RTC.js

@@ -460,19 +460,26 @@ RTC.prototype.getResourceBySSRC = function (ssrc) {
         return Strophe.getResourceFromJid(this.room.myroomjid);
     }
 
-    var self = this;
-    var resultResource = null;
-    Object.keys(this.remoteTracks).some(function (resource) {
-        var audioTrack = self.getRemoteAudioTrack(resource);
-        var videoTrack = self.getRemoteVideoTrack(resource);
-        if((audioTrack && audioTrack.getSSRC() == ssrc) ||
-            (videoTrack && videoTrack.getSSRC() == ssrc)) {
-            resultResource = resource;
-            return true;
-        }
-    });
+    var track = this.getRemoteTrackBySSRC(ssrc);
+    return track? track.getParticipantId() : null;
+};
 
-    return resultResource;
+/**
+ * Searches in remoteTracks for the ssrc and returns the corresponding track.
+ * @param ssrc the ssrc to check.
+ */
+RTC.prototype.getRemoteTrackBySSRC = function (ssrc) {
+    for (var resource in this.remoteTracks) {
+        var track = this.getRemoteAudioTrack(resource);
+        if(track && track.getSSRC() == ssrc) {
+            return track;
+        }
+        track = this.getRemoteVideoTrack(resource);
+        if(track && track.getSSRC() == ssrc) {
+            return track;
+        }
+    }
+    return null;
 };
 
 module.exports = RTC;

modules/statistics/CallStats.js

@@ -330,6 +330,18 @@ CallStats.prototype.sendTerminateEvent = _try_catch(function () {
         callStats.fabricEvent.fabricTerminated, this.confID);
 });
 
+/**
+ * Notifies CallStats that audio problems are detected.
+ *
+ * @param {Error} e error to send
+ * @param {CallStats} cs callstats instance related to the error (optional)
+ */
+CallStats.prototype.sendDetectedAudioProblem = _try_catch(function (e) {
+    CallStats._reportError.call(this, wrtcFuncNames.signalingError, e,
+        this.peerconnection);
+});
+
+
 /**
  * Notifies CallStats for ice connection failed
  * @param {RTCPeerConnection} pc connection on which failure occured.

modules/statistics/RTPStatsCollector.js

@@ -639,6 +639,11 @@ StatsCollector.prototype.processStatsReport = function () {
             bytesSent = Math.round(((bytesSent * 8) / time) / 1000);
         }
 
+        //detect audio issues (receiving data but audioLevel == 0)
+        if(bytesReceived > 10 && ssrcStats.ssrc2AudioLevel === 0) {
+            this.eventEmitter.emit(StatisticsEvents.AUDIO_NOT_WORKING, ssrc);
+        }
+
         ssrcStats.setSsrcBitrate({
             "download": bytesReceived,
             "upload": bytesSent

modules/statistics/statistics.js

@@ -139,6 +139,14 @@ Statistics.prototype.addConnectionStatsListener = function (listener) {
     this.eventEmitter.on(StatisticsEvents.CONNECTION_STATS, listener);
 };
 
+/**
+ * Adds listener for detected audio problems.
+ * @param listener the listener.
+ */
+Statistics.prototype.addAudioProblemListener = function (listener) {
+    this.eventEmitter.on(StatisticsEvents.AUDIO_NOT_WORKING, listener);
+};
+
 Statistics.prototype.removeConnectionStatsListener = function (listener) {
     this.eventEmitter.removeListener(StatisticsEvents.CONNECTION_STATS, listener);
 };
@@ -364,6 +372,16 @@ Statistics.prototype.sendAddIceCandidateFailed = function (e, pc) {
         CallStats.sendAddIceCandidateFailed(e, pc, this.callstats);
 };
 
+/**
+ * Notifies CallStats that audio problems are detected.
+ *
+ * @param {Error} e error to send
+ */
+Statistics.prototype.sendDetectedAudioProblem = function (e) {
+    if(this.callstats)
+        this.callstats.sendDetectedAudioProblem(e);
+};
+
 /**
  * Adds to CallStats an application log.
  *

service/statistics/Events.js

@@ -7,4 +7,8 @@ module.exports = {
      * FIXME: needs documentation.
      */
     AUDIO_LEVEL: "statistics.audioLevel",
+    /**
+     * Notifies about audio problem with remote participant.
+     */
+    AUDIO_NOT_WORKING: "statistics.audio_not_working"
 };