@flashphoner/websdk 2.0.244 → 2.0.246

package/package.json

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

package/src/client-info.js

@@ -0,0 +1,237 @@
+'use strict';
+
+function getClientHints(navigator) {
+    let {userAgent} = navigator;
+    let mobile, platform = '', platformVersion = '', architecture = '', bitness = '', model = '', uaFullVersion = '', fullVersionList = [];
+    let platformInfo = userAgent;
+    let found = false;
+    let versionInfo = userAgent.replace(/\(([^)]+)\)?/g, ($0, $1) => {
+        if (!found) {
+            platformInfo = $1;
+            found = true;
+        }
+        return '';
+    });
+    let items = versionInfo.match(/(\S+)\/(\S+)/g);
+    let webview = false;
+    // detect mobile
+    mobile = userAgent.indexOf('Mobile') !== -1;
+    let m;
+    let m2;
+    // detect platform
+    if ((m = /Windows NT (\d+(\.\d+)*)/.exec(platformInfo)) !== null) {
+        platform = 'Windows';
+        // see https://docs.microsoft.com/en-us/microsoft-edge/web-platform/how-to-detect-win11
+        let nt2win = {
+            '6.1': '0.1', // win-7
+            '6.2': '0.2', // win-8
+            '6.3': '0.3', // win-8.1
+            '10.0': '10.0', // win-10
+            '11.0': '13.0', // win-11
+        };
+        let ver = nt2win[m[1]];
+        if (ver)
+            platformVersion = padVersion(ver, 3);
+        if ((m2 = /\b(WOW64|Win64|x64)\b/.exec(platformInfo)) !== null) {
+            architecture = 'x86';
+            bitness = '64';
+        }
+    } else if ((m = /Android (\d+(\.\d+)*)/.exec(platformInfo)) !== null) {
+        platform = 'Android';
+        platformVersion = padVersion(m[1]);
+        if ((m2 = /Linux (\w+)/.exec(navigator.platform)) !== null) {
+            if (m2[1]) {
+                m2 = parseArch(m2[1]);
+                architecture = m2[0];
+                bitness = m2[1];
+            }
+        }
+    } else if ((m = /(iPhone|iPod touch); CPU iPhone OS (\d+(_\d+)*)/.exec(platformInfo)) !== null) {
+        // see special notes at https://www.whatismybrowser.com/guides/the-latest-user-agent/safari
+        platform = 'iOS';
+        platformVersion = padVersion(m[2].replace(/_/g, '.'));
+    } else if ((m = /(iPad); CPU OS (\d+(_\d+)*)/.exec(platformInfo)) !== null) {
+        platform = 'iOS';
+        platformVersion = padVersion(m[2].replace(/_/g, '.'));
+    } else if ((m = /Macintosh; (Intel|\w+) Mac OS X (\d+([_.]\d+)*)/.exec(platformInfo)) !== null) {
+        platform = 'macOS';
+        platformVersion = padVersion(m[2].replace(/_/g, '.'));
+    } else if ((m = /Linux/.exec(platformInfo)) !== null) {
+        platform = 'Linux';
+        platformVersion = '';
+        // TODO
+    } else if ((m = /CrOS (\w+) (\d+(\.\d+)*)/.exec(platformInfo)) !== null) {
+        platform = 'Chrome OS';
+        platformVersion = padVersion(m[2]);
+        m2 = parseArch(m[1]);
+        architecture = m2[0];
+        bitness = m2[1];
+    }
+    if (!platform) {
+        platform = 'Unknown';
+    }
+    // detect fullVersionList / brands
+    let notABrand = {brand: ' Not;A Brand', version: '99.0.0.0'};
+    if ((m = /Chrome\/(\d+(\.\d+)*)/.exec(versionInfo)) !== null && navigator.vendor === 'Google Inc.') {
+        fullVersionList.push({brand: 'Chromium', version: padVersion(m[1], 4)});
+        if ((m2 = /(Edge?)\/(\d+(\.\d+)*)/.exec(versionInfo)) !== null) {
+            let identBrandMap = {
+                'Edge': 'Microsoft Edge',
+                'Edg': 'Microsoft Edge',
+            };
+            let brand = identBrandMap[m[1]];
+            fullVersionList.push({brand: brand, version: padVersion(m2[2], 4)});
+        } else {
+            fullVersionList.push({brand: 'Google Chrome', version: padVersion(m[1], 4)});
+        }
+        if (/\bwv\b/.exec(platformInfo)) {
+            webview = true;
+        }
+    } else if ((m = /AppleWebKit\/(\d+(\.\d+)*)/.exec(versionInfo)) !== null && navigator.vendor === 'Apple Computer, Inc.') {
+        fullVersionList.push({brand: 'WebKit', version: padVersion(m[1])});
+        if (platform === 'iOS' && (m2 = /(CriOS|EdgiOS|FxiOS|Version)\/(\d+(\.\d+)*)/.exec(versionInfo)) != null) {
+            let identBrandMap = { // no
+                'CriOS': 'Google Chrome',
+                'EdgiOS': 'Microsoft Edge',
+                'FxiOS': 'Mozilla Firefox',
+                'Version': 'Apple Safari',
+            };
+            let brand = identBrandMap[m2[1]];
+            fullVersionList.push({brand, version: padVersion(m2[2])});
+            if (items.findIndex((s) => s.startsWith('Safari/')) === -1) {
+                webview = true;
+            }
+        }
+    } else if ((m = /Firefox\/(\d+(\.\d+)*)/.exec(versionInfo)) !== null) {
+        fullVersionList.push({brand: 'Firefox', version: padVersion(m[1])});
+    } else {
+        fullVersionList.push(notABrand);
+    }
+    uaFullVersion = fullVersionList.length > 0 ? fullVersionList[fullVersionList.length - 1] : '';
+    let brands = fullVersionList.map((b) => {
+        let pos = b.version.indexOf('.');
+        let version = pos === -1 ? b.version : b.version.slice(0, pos);
+        return {brand: b.brand, version};
+    });
+    // TODO detect architecture, bitness and model
+    return {
+        mobile,
+        platform,
+        brands,
+        platformVersion,
+        architecture,
+        bitness,
+        model,
+        uaFullVersion,
+        fullVersionList,
+        webview
+    };
+}
+
+function parseArch(arch) {
+    switch (arch) {
+        case 'x86_64':
+        case 'x64':
+            return ['x86', '64'];
+        case 'x86_32':
+        case 'x86':
+            return ['x86', ''];
+        case 'armv6l':
+        case 'armv7l':
+        case 'armv8l':
+            return [arch, ''];
+        case 'aarch64':
+            return ['arm', '64'];
+        default:
+            return ['', ''];
+    }
+}
+function padVersion(ver, minSegs = 3) {
+    let parts = ver.split('.');
+    let len = parts.length;
+    if (len < minSegs) {
+        for (let i = 0, lenToPad = minSegs - len; i < lenToPad; i += 1) {
+            parts.push('0');
+        }
+        return parts.join('.');
+    }
+    return ver;
+}
+
+class NavigatorUAData {
+    constructor(navigator) {
+        this._ch = getClientHints(navigator);
+        Object.defineProperties(this, {
+            _ch: {enumerable: false},
+        });
+    }
+    get mobile() {
+        return this._ch.mobile;
+    }
+    get platform() {
+        return this._ch.platform;
+    }
+    get brands() {
+        return this._ch.brands;
+    }
+    getHighEntropyValues(hints) {
+        return new Promise((resolve, reject) => {
+            if (!Array.isArray(hints)) {
+                throw new TypeError('argument hints is not an array');
+            }
+            let hintSet = new Set(hints);
+            let data = this._ch;
+            let obj = {
+                mobile: data.mobile,
+                platform: data.platform,
+                brands: data.brands,
+            };
+            if (hintSet.has('architecture'))
+                obj.architecture = data.architecture;
+            if (hintSet.has('bitness'))
+                obj.bitness = data.bitness;
+            if (hintSet.has('model'))
+                obj.model = data.model;
+            if (hintSet.has('platformVersion'))
+                obj.platformVersion = data.platformVersion;
+            if (hintSet.has('uaFullVersion'))
+                obj.uaFullVersion = data.uaFullVersion;
+            if (hintSet.has('fullVersionList'))
+                obj.fullVersionList = data.fullVersionList;
+            resolve(obj);
+        });
+    }
+    toJSON() {
+        let data = this._ch;
+        return {
+            mobile: data.mobile,
+            brands: data.brands,
+        };
+    }
+}
+Object.defineProperty(NavigatorUAData.prototype, Symbol.toStringTag, {
+    enumerable: false,
+    configurable: true,
+    writable: false,
+    value: 'NavigatorUAData'
+});
+
+async function getClientInfo(navigator, keys) {
+    let info = {};
+    if (location.protocol === 'https:') {
+        if (!keys) {
+            keys = ['brands', 'mobile', 'platform', 'platformVersion', 'architecture', 'bitness', 'model', 'fullVersionList'];
+        }
+        if (!navigator.userAgentData) {
+            let customUAData = new NavigatorUAData(navigator);
+            info = await customUAData.getHighEntropyValues(keys);
+        } else {
+            info = await navigator.userAgentData.getHighEntropyValues(keys);
+        }
+    }
+    return info;
+}
+
+module.exports = {
+    getClientInfo
+};

package/src/flashphoner-core.js

@@ -4,6 +4,7 @@ const { v1: uuid_v1 } = require('uuid');
 const constants = require("./constants");
 const util = require('./util');
 const LoggerObject = require('./util').logger;
+const clientInfo = require('./client-info');
 const Promise = require('promise-polyfill');
 const KalmanFilter = require('kalmanjs');
 const browserDetails = require('webrtc-adapter').default.browserDetails;
@@ -11,6 +12,7 @@ const LOG_PREFIX = "core";
 var coreLogger;
 var loggerConf = {push: false, severity: "INFO"};
 var isUsingTemasysPlugin = false;
+var clientUAData;
 
 /**
  * @namespace Flashphoner
@@ -62,7 +64,7 @@ var disableConnectionQualityCalculation;
  * @throws {Error} Error if none of MediaProviders available
  * @memberof Flashphoner
  */
-var init = function (options) {
+var init = async function (options) {
     if (!initialized) {
         if (!options) {
             options = {};
@@ -190,8 +192,12 @@ var init = function (options) {
         if (!waitingTemasys && options.mediaProvidersReadyCallback) {
             options.mediaProvidersReadyCallback(Object.keys(MediaProvider));
         }
+
         coreLogger.info(LOG_PREFIX, "Initialized");
         initialized = true;
+
+        clientUAData = await clientInfo.getClientInfo(window.navigator);
+        coreLogger.info(LOG_PREFIX, "Client system data: " + JSON.stringify(clientUAData));
     }
 };
 
@@ -572,13 +578,16 @@ var createSession = function (options) {
                 appKey: appKey,
                 mediaProviders: Object.keys(MediaProvider),
                 keepAlive: keepAlive,
-                authToken:authToken,
+                authToken: authToken,
                 clientVersion: "2.0",
                 clientOSVersion: window.navigator.appVersion,
                 clientBrowserVersion: window.navigator.userAgent,
                 msePacketizationVersion: 2,
                 custom: options.custom
             };
+            if (clientUAData) {
+                cConfig.clientInfo = clientUAData;
+            }
             if (sipConfig) {
                 util.copyObjectPropsToAnotherObject(sipConfig, cConfig);
             }
@@ -1009,6 +1018,8 @@ var createSession = function (options) {
                         stripCodecs: stripCodecs
                     });
                 }).then(function (offer) {
+                    // Get local media info to send in publishStream message
+                    let localMediaInfo = collectLocalMediaInfo(MediaProvider[mediaProvider], localDisplay);
                     send("call", {
                         callId: id_,
                         incoming: false,
@@ -1021,7 +1032,8 @@ var createSession = function (options) {
                         caller: login,
                         callee: callee_,
                         custom: options.custom,
-                        visibleName: visibleName_
+                        visibleName: visibleName_,
+                        localMediaInfo: localMediaInfo
                     });
                 });
             }).catch(function (error) {
@@ -1155,6 +1167,8 @@ var createSession = function (options) {
                     });
                 }).then(function (sdp) {
                     if (status_ != CALL_STATUS.FINISH && status_ != CALL_STATUS.FAILED) {
+                        // Get local media info to send in publishStream message
+                        let localMediaInfo = collectLocalMediaInfo(MediaProvider[mediaProvider], localDisplay);
                         send("answer", {
                             callId: id_,
                             incoming: true,
@@ -1166,7 +1180,8 @@ var createSession = function (options) {
                             sipSDP: sipSDP,
                             caller: cConfig.login,
                             callee: callee_,
-                            custom: options.custom
+                            custom: options.custom,
+                            localMediaInfo: localMediaInfo
                         });
                     } else {
                         hangup();
@@ -2006,6 +2021,7 @@ var createSession = function (options) {
                     }
                     return;
                 }
+
                 //create mediaProvider connection
                 MediaProvider[mediaProvider].createConnection({
                     id: id_,
@@ -2028,6 +2044,8 @@ var createSession = function (options) {
                     });
                 }).then(function (offer) {
                     logger.debug(LOG_PREFIX, "Offer SDP:\n" + offer.sdp);
+                    // Get local media info to send in publishStream message
+                    let localMediaInfo = collectLocalMediaInfo(MediaProvider[mediaProvider], display);
                     //publish stream with offer sdp to server
                     send("publishStream", {
                         mediaSessionId: id_,
@@ -2046,7 +2064,8 @@ var createSession = function (options) {
                         rtmpUrl: rtmpUrl,
                         constraints: constraints,
                         transport: transportType,
-                        cvoExtension: cvoExtension
+                        cvoExtension: cvoExtension,
+                        localMediaInfo: localMediaInfo
                     });
                 });
             }).catch(function (error) {
@@ -2856,6 +2875,65 @@ var createSession = function (options) {
         return sessionLogger;
     };
 
+    const collectLocalMediaInfo = function (mediaProvider, display) {
+        // Get devices available
+        let videoCams = mediaProvider.videoCams || [];
+        let mics = mediaProvider.mics || [];
+
+        if (videoCams.length) {
+            logger.info(LOG_PREFIX, "Video inputs available: " + JSON.stringify(videoCams));
+        }
+        if (mics.length) {
+            logger.info(LOG_PREFIX, "Audio inputs available: " + JSON.stringify(mics));
+        }
+
+        // Get track labels to identify publishing device
+        let audioTracks = [];
+        let videoTracks = [];
+        let localVideo;
+        if (mediaProvider.getCacheInstance) {
+            localVideo = mediaProvider.getCacheInstance(display);
+        }
+        if (!localVideo && mediaProvider.getVideoElement) {
+            localVideo = mediaProvider.getVideoElement(display);
+        }
+        if (localVideo) {
+            localVideo.srcObject.getAudioTracks().forEach((track) => {
+                let device = track.label;
+                if (device === "MediaStreamAudioDestinationNode" && mediaProvider.getAudioSourceDevice) {
+                    device = mediaProvider.getAudioSourceDevice();
+                }
+                audioTracks.push({
+                    trackId: track.id,
+                    device: device
+                });
+            });
+            localVideo.srcObject.getVideoTracks().forEach((track) => {
+                videoTracks.push({
+                    trackId: track.id,
+                    device: track.label
+                });
+            });
+        }
+        if (videoTracks.length) {
+            logger.info(LOG_PREFIX, "Video tracks captured: " + JSON.stringify(videoTracks));
+        }
+        if (audioTracks.length) {
+            logger.info(LOG_PREFIX, "Audio tracks captured: " + JSON.stringify(audioTracks));
+        }
+
+        return {
+            devices: {
+                video: videoCams,
+                audio: mics
+            },
+            tracks: {
+                video: videoTracks,
+                audio: audioTracks
+            }
+        };
+    }
+
     //export Session
     session.id = id;
     session.status = status;

package/src/webrtc-media-provider.js

@@ -19,6 +19,8 @@ var validBrowsers = ["firefox", "chrome", "safari"];
 var videoCams = [];
 // list of presented audio input devices
 var mics = [];
+// current audio source device label
+let audioSourceDevice = "";
 
 var createConnection = function (options) {
     return new Promise(function (resolve, reject) {
@@ -955,10 +957,14 @@ var getMediaAccess = function (constraints, display, disableConstraintsNormaliza
                 // WCS-2933, fix mobile streaming issues, gather info about available devices before streaming, but not during
                 listDevices(false).then((devices) => {
                     devices.video.forEach(function (device) {
-                        videoCams.push(device);
+                        if (!videoCams.find((cam) => device.id === cam.id)) {
+                            videoCams.push(device);
+                        }
                     })
                     devices.audio.forEach(function (device) {
-                        mics.push(device);
+                        if (!mics.find((mic) => device.id === mic.id)) {
+                            mics.push(device);
+                        }
                     })
                     navigator.getUserMedia(constraints, function (stream) {
                         loadVideo(display, stream, screenShare, requestAudioConstraints, resolve, constraints, useCanvas);
@@ -1188,6 +1194,7 @@ var createGainNode = function (stream) {
     source.connect(gainNode);
     gainNode.connect(destination);
     var sourceAudioTrack = stream.getAudioTracks()[0];
+    audioSourceDevice = sourceAudioTrack.label;
     gainNode.sourceAudioTrack = sourceAudioTrack;
     gainNode.release = function () {
         this.sourceAudioTrack.stop();
@@ -1198,6 +1205,10 @@ var createGainNode = function (stream) {
     return gainNode;
 };
 
+const getAudioSourceDevice = function () {
+    return audioSourceDevice;
+}
+
 //Fix to set screen resolution for screen sharing in Firefox
 var setScreenResolution = function (video, stream, constraints) {
     var newHeight;
@@ -1314,6 +1325,22 @@ function getCacheInstance(display) {
     }
 }
 
+function getVideoElement(display) {
+    if (display) {
+        for (const child of display.children) {
+            if (child.tagName.toLowerCase() === "video") {
+                return child;
+            } else {
+                let grandchild = getVideoElement(child);
+                if (grandchild) {
+                    return grandchild;
+                }
+            }
+        }
+    }
+    return null;
+}
+
 function createVideoElement(useControls = false) {
     let video = document.createElement('video');
     // Prepare video tag to auto play and add specific Safari tweaks #WCS-2425
@@ -1440,8 +1467,8 @@ var listDevices = function (labels, kind, deviceConstraints) {
                     return;
                 }
                 navigator.getUserMedia(constraints, function (stream) {
-                    navigator.mediaDevices.enumerateDevices().then(function (devicesWithLabales) {
-                        resolve(getList(devicesWithLabales));
+                    navigator.mediaDevices.enumerateDevices().then(function (devicesWithLabels) {
+                        resolve(getList(devicesWithLabels));
                         stream.getTracks().forEach(function (track) {
                             track.stop();
                         });
@@ -1581,5 +1608,10 @@ module.exports = {
         logger = configuration.logger;
         createMicGainNode = (typeof configuration.createMicGainNode !== 'undefined') ? configuration.createMicGainNode : true;
         logger.info(LOG_PREFIX, "Initialized");
-    }
+    },
+    videoCams: videoCams,
+    mics: mics,
+    getAudioSourceDevice: getAudioSourceDevice,
+    getCacheInstance: getCacheInstance,
+    getVideoElement: getVideoElement
 };