@flashphoner/websdk 2.0.238 → 2.0.240

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flashphoner/websdk",
-  "version": "2.0.238",
+  "version": "2.0.240",
   "description": "Official Flashphoner WebCallServer WebSDK package",
   "main": "./src/flashphoner-core.js",
   "types": "./src/flashphoner-core.d.ts",

package/src/flashphoner-core.js

@@ -1,35 +1,46 @@
 'use strict';
 
 const { v1: uuid_v1 } = require('uuid');
-var constants = require("./constants");
-var util = require('./util');
-var LoggerObject = require('./util').logger;
+const constants = require("./constants");
+const util = require('./util');
+const LoggerObject = require('./util').logger;
+const Promise = require('promise-polyfill');
+const KalmanFilter = require('kalmanjs');
+const browserDetails = require('webrtc-adapter').default.browserDetails;
+const LOG_PREFIX = "core";
 var coreLogger;
 var loggerConf = {push: false, severity: "INFO"};
-var Promise = require('promise-polyfill');
-var KalmanFilter = require('kalmanjs');
-var browserDetails = require('webrtc-adapter').default.browserDetails;
-var LOG_PREFIX = "core";
 var isUsingTemasysPlugin = false;
 
 /**
  * @namespace Flashphoner
  */
 
-var SESSION_STATUS = constants.SESSION_STATUS;
-var STREAM_EVENT = constants.STREAM_EVENT;
-var STREAM_EVENT_TYPE = constants.STREAM_EVENT_TYPE;
-var STREAM_STATUS = constants.STREAM_STATUS;
-var CALL_STATUS = constants.CALL_STATUS;
-var TRANSPORT_TYPE = constants.TRANSPORT_TYPE;
-var CONNECTION_QUALITY = constants.CONNECTION_QUALITY;
-var ERROR_INFO = constants.ERROR_INFO;
-var VIDEO_RATE_GOOD_QUALITY_PERCENT_DIFFERENCE = 20;
-var VIDEO_RATE_BAD_QUALITY_PERCENT_DIFFERENCE = 50;
-var LOW_VIDEO_RATE_THRESHOLD_BAD_PERFECT = 50000;
-var LOW_VIDEO_RATE_BAD_QUALITY_PERCENT_DIFFERENCE = 150;
-var OUTBOUND_VIDEO_RATE = "outboundVideoRate";
-var INBOUND_VIDEO_RATE = "inboundVideoRate";
+const SESSION_STATUS = constants.SESSION_STATUS;
+const STREAM_EVENT = constants.STREAM_EVENT;
+const STREAM_EVENT_TYPE = constants.STREAM_EVENT_TYPE;
+const STREAM_STATUS = constants.STREAM_STATUS;
+const CALL_STATUS = constants.CALL_STATUS;
+const CONNECTION_QUALITY = constants.CONNECTION_QUALITY;
+const ERROR_INFO = constants.ERROR_INFO;
+const VIDEO_RATE_GOOD_QUALITY_PERCENT_DIFFERENCE = 20;
+const VIDEO_RATE_BAD_QUALITY_PERCENT_DIFFERENCE = 50;
+const LOW_VIDEO_RATE_THRESHOLD_BAD_PERFECT = 50000;
+const LOW_VIDEO_RATE_BAD_QUALITY_PERCENT_DIFFERENCE = 150;
+const OUTBOUND_VIDEO_RATE = "outboundVideoRate";
+const INBOUND_VIDEO_RATE = "inboundVideoRate";
+const CONSTRAINT_AUDIO = "audio";
+const CONSTRAINT_AUDIO_STEREO = "stereo";
+const CONSTRAINT_AUDIO_BITRATE = "bitrate";
+const CONSTRAINT_AUDIO_FEC = "fec";
+const CONSTRAINT_AUDIO_OUTPUT_ID = "outputId";
+const CONSTRAINT_VIDEO = "video";
+const CONSTRAINT_VIDEO_BITRATE = "video.bitrate";
+const CONSTRAINT_VIDEO_MIN_BITRATE = "video.minBitrate";
+const CONSTRAINT_VIDEO_MAX_BITRATE = "video.maxBitrate";
+const CONSTRAINT_VIDEO_QUALITY = "video.quality";
+const CONSTRAINT_VIDEO_WIDTH = "video.width";
+const CONSTRAINT_VIDEO_HEIGHT = "video.height";
 var MediaProvider = {};
 var sessions = {};
 var initialized = false;
@@ -866,9 +877,9 @@ var createSession = function (options) {
         }
 
         var audioOutputId;
-        var audioProperty = getConstraintsProperty(constraints, "audio", undefined);
+        var audioProperty = getConstraintsProperty(constraints, CONSTRAINT_AUDIO, undefined);
         if (typeof audioProperty === 'object') {
-            audioOutputId = getConstraintsProperty(audioProperty, "outputId", 0);
+            audioOutputId = getConstraintsProperty(audioProperty, CONSTRAINT_AUDIO_OUTPUT_ID, 0);
         }
 
         var stripCodecs = options.stripCodecs || [];
@@ -885,6 +896,10 @@ var createSession = function (options) {
         var sipHeaders = options.sipHeaders;
         var videoContentHint = options.videoContentHint;
         var useControls = options.useControls;
+
+        var minBitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_MIN_BITRATE, 0);
+        var maxBitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_MAX_BITRATE, 0);
+
         /**
          * Represents sip call.
          *
@@ -921,8 +936,9 @@ var createSession = function (options) {
             //set remote sdp
             if (sdp && sdp !== '') {
                 sdp = sdpHookHandler(sdp, sdpHook);
-                mediaConnection.setRemoteSdp(sdp, hasTransferredCall, id_).then(function () {
-                });
+                // Adjust publishing bitrate #WCS-4013
+                sdp = util.setPublishingBitrate(sdp, mediaConnection, minBitrate, maxBitrate);
+                mediaConnection.setRemoteSdp(sdp, hasTransferredCall, id_).then(function () {});
                 return;
             }
             var event = callInfo.status;
@@ -1084,6 +1100,8 @@ var createSession = function (options) {
             status_ = CALL_STATUS.PENDING;
             var sdp;
             var sdpHook = answerOptions.sdpHook;
+            var minBitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_MIN_BITRATE, 0);
+            var maxBitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_MAX_BITRATE, 0);
             sipSDP = answerOptions.sipSDP;
             sipHeaders = answerOptions.sipHeaders;
             if (!remoteSdpCache[id_]) {
@@ -1091,6 +1109,8 @@ var createSession = function (options) {
                 throw new Error("No remote sdp available");
             } else {
                 sdp = sdpHookHandler(remoteSdpCache[id_], sdpHook);
+                // Adjust publishing bitrate #WCS-4013
+                sdp = util.setPublishingBitrate(sdp, null, minBitrate, maxBitrate);
                 delete remoteSdpCache[id_];
             }
             if (util.SDP.matchPrefix(sdp, "m=video").length == 0) {
@@ -1124,6 +1144,8 @@ var createSession = function (options) {
                     useControls: useControls
                 }).then(function (newConnection) {
                     mediaConnection = newConnection;
+                    // Set publishing bitrate via sender encodings if SDP feature is not supported
+                    mediaConnection.setPublishingBitrate(minBitrate, maxBitrate);
                     return mediaConnection.setRemoteSdp(sdp);
                 }).then(function () {
                     return mediaConnection.createAnswer({
@@ -1651,15 +1673,15 @@ var createSession = function (options) {
         // Receive media
         var receiveAudio;
         var audioOutputId;
-        var audioProperty = getConstraintsProperty(constraints, "audio", undefined);
+        var audioProperty = getConstraintsProperty(constraints, CONSTRAINT_AUDIO, undefined);
         if (typeof audioProperty === 'boolean') {
             receiveAudio = audioProperty;
         } else if (typeof audioProperty === 'object') {
             receiveAudio = true;
-            var _stereo = getConstraintsProperty(audioProperty, "stereo", 0);
-            var _bitrate = getConstraintsProperty(audioProperty, "bitrate", 0);
-            var _fec = getConstraintsProperty(audioProperty, "fec", 0);
-            audioOutputId = getConstraintsProperty(audioProperty, "outputId", 0);
+            var _stereo = getConstraintsProperty(audioProperty, CONSTRAINT_AUDIO_STEREO, 0);
+            var _bitrate = getConstraintsProperty(audioProperty, CONSTRAINT_AUDIO_BITRATE, 0);
+            var _fec = getConstraintsProperty(audioProperty, CONSTRAINT_AUDIO_FEC, 0);
+            audioOutputId = getConstraintsProperty(audioProperty, CONSTRAINT_AUDIO_OUTPUT_ID, 0);
             var _codecOptions = "";
             if (_bitrate) _codecOptions += "maxaveragebitrate=" + _bitrate + ";";
             if (_stereo) _codecOptions += "stereo=1;sprop-stereo=1;";
@@ -1668,7 +1690,7 @@ var createSession = function (options) {
             receiveAudio = (typeof options.receiveAudio !== 'undefined') ? options.receiveAudio : true;
         }
         var receiveVideo;
-        var videoProperty = getConstraintsProperty(constraints, "video", undefined);
+        var videoProperty = getConstraintsProperty(constraints, CONSTRAINT_VIDEO, undefined);
         if (typeof videoProperty === 'boolean') {
             receiveVideo = videoProperty;
         } else if (typeof videoProperty === 'object') {
@@ -1677,16 +1699,16 @@ var createSession = function (options) {
             receiveVideo = (typeof options.receiveVideo !== 'undefined') ? options.receiveVideo : true;
         }
         // Bitrate
-        var bitrate = getConstraintsProperty(constraints, "video.bitrate", 0);
-        var minBitrate = getConstraintsProperty(constraints, "video.minBitrate", 0);
-        var maxBitrate = getConstraintsProperty(constraints, "video.maxBitrate", 0);
+        var bitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_BITRATE, 0);
+        var minBitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_MIN_BITRATE, 0);
+        var maxBitrate = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_MAX_BITRATE, 0);
 
         // Quality
-        var quality = getConstraintsProperty(constraints, "video.quality", 0);
+        var quality = getConstraintsProperty(constraints, CONSTRAINT_VIDEO_QUALITY, 0);
         if (quality > 100) quality = 100;
         // Play resolution
-        var playWidth = (typeof options.playWidth !== 'undefined') ? options.playWidth : getConstraintsProperty(constraints, "video.width", 0);
-        var playHeight = (typeof options.playHeight !== 'undefined') ? options.playHeight : getConstraintsProperty(constraints, "video.height", 0);
+        var playWidth = (typeof options.playWidth !== 'undefined') ? options.playWidth : getConstraintsProperty(constraints, CONSTRAINT_VIDEO_WIDTH, 0);
+        var playHeight = (typeof options.playHeight !== 'undefined') ? options.playHeight : getConstraintsProperty(constraints, CONSTRAINT_VIDEO_HEIGHT, 0);
         var stripCodecs = options.stripCodecs || [];
         var resolution = {};
 
@@ -1747,8 +1769,9 @@ var createSession = function (options) {
                 var _sdp = sdp;
                 if (_codecOptions) _sdp = util.SDP.writeFmtp(sdp, _codecOptions, "opus");
                 _sdp = sdpHookHandler(_sdp, sdpHook);
-                mediaConnection.setRemoteSdp(_sdp).then(function () {
-                });
+                // Adjust publishing bitrate #WCS-4013
+                _sdp = util.setPublishingBitrate(_sdp, mediaConnection, minBitrate, maxBitrate);
+                mediaConnection.setRemoteSdp(_sdp).then(function () {});
                 return;
             }
 

package/src/util.js

@@ -173,6 +173,61 @@ const SDP = {
             }
         }
         return result;
+    },
+    setPublishingBitrate: function (sdp, minBitrate, maxBitrate) {
+        if(sdp && (minBitrate || maxBitrate)) {
+            let sdpArray = sdp.split("\n");
+            let i;
+            let rtpmap = -1, codec = "";
+            let matches;
+            let bitrateString = "";
+            for (i = 0; i < sdpArray.length; i++) {
+                if (sdpArray[i].startsWith("a=rtpmap")) {
+                    matches = sdpArray[i].match("a=rtpmap:(.+) (.+)/.*");
+                    if (matches && matches.length > 2) {
+                        rtpmap = parseInt(matches[1], 10);
+                        codec = matches[2];
+                    }
+                } else {
+                    if (codec === "H264" || codec === "VP8") {
+                        if (sdpArray[i].startsWith("a=fmtp:" + rtpmap)) {
+                            bitrateString = this.getBitrateString(sdpArray[i], minBitrate, maxBitrate);
+                            if (bitrateString) {
+                                sdpArray[i] += ";" + bitrateString;
+                            }
+                        } else {
+                            bitrateString = this.getBitrateString("", minBitrate, maxBitrate);
+                            if (bitrateString) {
+                                sdpArray[i] = "a=fmtp:" + rtpmap + " " + bitrateString + "\r\n" + sdpArray[i];
+                            }
+                        }
+                        codec = "";
+                        rtpmap = -1;
+                    }
+                }
+            }
+            let newSDP = "";
+            for (i = 0; i < sdpArray.length; i++) {
+                if (sdpArray[i] != "") {
+                    newSDP += sdpArray[i] + "\n";
+                }
+            }
+            return newSDP;
+        }
+        return sdp;
+    },
+    getBitrateString: function (string, minBitrate, maxBitrate) {
+        let bitrateString = "";
+        if (minBitrate && string.indexOf("x-google-min-bitrate") == -1) {
+            bitrateString += "x-google-min-bitrate=" + minBitrate;
+        }
+        if (maxBitrate && string.indexOf("x-google-max-bitrate") == -1) {
+            if (bitrateString) {
+                bitrateString += ";";
+            }
+            bitrateString += "x-google-max-bitrate=" + maxBitrate;
+        }
+        return bitrateString;
     }
 };
 
@@ -422,6 +477,19 @@ const isPromise = function(object) {
     return false;
 };
 
+const setPublishingBitrate = function(sdp, mediaConnection, minBitrate, maxBitrate) {
+    if (minBitrate || maxBitrate) {
+        if (sdp && Browser.isChrome() || Browser.isSafariWebRTC()) {
+            // Set publishing bitrate constraints via remote SDP
+            sdp = SDP.setPublishingBitrate(sdp, minBitrate, maxBitrate);
+        } else if (mediaConnection) {
+            // Set publishing bitrate via sender encodings if SDP feature is not supported
+            mediaConnection.setPublishingBitrate(minBitrate, maxBitrate);
+        }
+    }
+    return sdp;
+};
+
 module.exports = {
     isEmptyObject,
     copyObjectToArray,
@@ -432,5 +500,6 @@ module.exports = {
     logger,
     stripCodecs,
     getCurrentCodecAndSampleRate,
-    isPromise
+    isPromise,
+    setPublishingBitrate
 };

package/src/webrtc-media-provider.js

@@ -69,7 +69,7 @@ var createConnection = function (options) {
                 if (localVideo.srcObject) {
                     localVideo.id = id + "-local";
                     setContentHint(localVideo.srcObject, videoContentHint);
-                    connection.addStream(localVideo.srcObject);
+                    addStreamTracks(connection, localVideo.srcObject);
                 } else {
                     localVideo = null;
                 }
@@ -113,7 +113,7 @@ var createConnection = function (options) {
                     localVideo = cachedVideo;
                     localVideo.id = id;
                     setContentHint(localVideo.srcObject, videoContentHint);
-                    connection.addStream(localVideo.srcObject);
+                    addStreamTracks(connection, localVideo.srcObject);
                 }
             } else {
                 // There is a custom video element, get its id if set #WCS-3606
@@ -159,7 +159,12 @@ var createConnection = function (options) {
                     track.contentHint = hint;
                 }
             });
-        }      
+        }
+        function addStreamTracks(pc, stream) {
+            stream.getTracks().forEach((track) => {
+                pc.addTrack(track, stream);
+            });
+        }
         connection.ontrack = function (event) {
             if (remoteVideo) {
                 remoteVideo.srcObject = event.streams[0];
@@ -773,6 +778,21 @@ var createConnection = function (options) {
             screenShare = false;
         };
 
+        var setPublishingBitrate = function(minBitrate, maxBitrate) {
+            let senders = connection.getSenders();
+            senders.forEach((sender) => {
+                if (sender.track.kind == "video" && maxBitrate) {
+                    let parameters = sender.getParameters();
+                    for (let i = 0; i < parameters.encodings.length; i++) {
+                        if (!parameters.encodings[i].maxBitrate) {
+                            parameters.encodings[i].maxBitrate = maxBitrate * 1000;
+                        }
+                    }
+                    sender.setParameters(parameters).then(() => {});
+                }
+            });
+        };
+
         var exports = {};
         exports.state = state;
         exports.createOffer = createOffer;
@@ -799,6 +819,7 @@ var createConnection = function (options) {
         exports.switchMic = switchMic;
         exports.switchToScreen = switchToScreen;
         exports.switchToCam = switchToCam;
+        exports.setPublishingBitrate = setPublishingBitrate;
         connections[id] = exports;
         resolve(exports);
     });