@reactoo/watchtogether-sdk-js 2.7.7 → 2.7.9

package/src/modules/wt-room.js

@@ -181,17 +181,39 @@ class RoomSession {
 		this.userId = null;
 		this.sessiontype = type;
 		this.initialBitrate = 0;
-		this.simulcast = false;
 		this.enableDtx = false;
-		this.simulcastMode = 'controlled'; // controlled, manual, browserControlled
-		this.simulcastDefaultManualSubstream = 0; // 0 = maximum quality
-
-		// ordered from low to high
-		this.simulcastBitrates = [
-			{ rid: 'l', active: true, maxBitrate: 180000, maxFramerate: 20, scaleResolutionDownBy: 3.3333333333333335, priority: "low" },
-			{ rid: 'm', active: true, maxBitrate: 500000, maxFramerate: 25, scaleResolutionDownBy: 1.3333333333333335, priority: "low" },
-			{ rid: 'h', active: true, maxBitrate: 2000000, maxFramerate: 30, priority: "low" },
-		];
+		this.simulcast = false;
+		this.defaultSimulcastSettings = {
+			"default" : {
+				mode: "controlled", // controlled, manual, browserController
+				defaultSubstream: 0, // 2 lowest quality, 0 highest quality
+				bitrates: [
+					{
+						"rid": "l",
+						"active": true,
+						"maxBitrate": 180000,
+						"maxFramerate": 20,
+						"scaleResolutionDownBy": 3.3333333333333335,
+						"priority": "low"
+					},
+					{
+						"rid": "m",
+						"active": true,
+						"maxBitrate": 500000,
+						"maxFramerate": 25,
+						"scaleResolutionDownBy": 1.3333333333333335,
+						"priority": "low"
+					},
+					{
+						"rid": "h",
+						"active": true,
+						"maxBitrate": 2000000,
+						"maxFramerate": 30,
+						"priority": "low"
+					}
+				]
+			},
+		};
 		this.recordingFilename = null;
 		this.pluginName = RoomSession.sessionTypes[type];
 		this.id = null;
@@ -217,6 +239,8 @@ class RoomSession {
 		this._statsTimeoutId = null;
 		this._statsInterval = 1000;
 		this._aqInterval = 2500;
+		this._aqIntervalCounter = 0;
+		this._aqIntervalDivisor = 4;
 		this._aqTimeoutId = null;
 		this._sendMessageTimeout = 5000;
 		this._retries = 0;
@@ -995,7 +1019,7 @@ class RoomSession {
 					stats: {},
 					selectedSubstream: {},
 					initialSimulcastSubstreamBeenSet: {},
-					forcedBrowserControlledMode:{},
+					overriddenSimulcastMode: {},
 				};
 
 				if (handleId === this.handleId) {
@@ -1052,7 +1076,7 @@ class RoomSession {
 					stats: {},
 					selectedSubstream: {},
 					initialSimulcastSubstreamBeenSet: {},
-					forcedBrowserControlledMode:{},
+					overriddenSimulcastMode: {},
 				}
 			};
 			this._participants.push(handle);
@@ -1288,9 +1312,7 @@ class RoomSession {
 		initialBitrate = 0,
 		recordingFilename,
 		simulcast = false,
-		simulcastBitrates = this.simulcastBitrates,
-		simulcastMode = this.simulcastMode,
-		simulcastDefaultManualSubstream = this.simulcastDefaultManualSubstream,
+		simulcastSettings = this.defaultSimulcastSettings,
 		enableDtx = false
 	) {
 
@@ -1318,16 +1340,20 @@ class RoomSession {
 		this.isConnecting = true;
 		this.enableDtx = enableDtx;
 		this.simulcast = simulcast;
-		this.simulcastMode = simulcastMode;
-		this.simulcastDefaultManualSubstream = simulcastDefaultManualSubstream;
-		if(simulcastBitrates !== null) {
-			this.simulcastBitrates = structuredClone(simulcastBitrates).sort((a, b) => {
-				if(a.maxBitrate === b.maxBitrate) {
-					return a.maxFramerate - b.maxFramerate;
-				}
-				return a.maxBitrate - b.maxBitrate;
+		this.simulcastSettings = structuredClone(simulcastSettings);
+
+		// sort simulcast bitrates
+		if(this.simulcastSettings && typeof this.simulcastSettings === 'object' && Object.keys(this.simulcastSettings).length) {
+			Object.keys(this.simulcastSettings).forEach(k => {
+				this.simulcastSettings[k].bitrates = this.simulcastSettings[k].bitrates.sort((a, b) => {
+					if(a.maxBitrate === b.maxBitrate) {
+						return a.maxFramerate - b.maxFramerate;
+					}
+					return a.maxBitrate - b.maxBitrate;
+				});
 			});
 		}
+
 		this.emit('joining', true);
 		return new Promise((resolve, reject) => {
 
@@ -1551,6 +1577,17 @@ class RoomSession {
 		return this._participants.find(p => p.handleId === handleId || (rfid && p.rfid === rfid) || (userId && decodeJanusDisplay(p.userId)?.userId === userId));
 	}
 
+
+	_findSimulcastConfig(source, settings) {
+		return Object.keys(settings).reduce((acc, key) => {
+			if(settings[source]) {
+				return settings[source];
+			} else if(source.indexOf(key.match(/\*(.*?)\*/)?.[1]) > -1) {
+				return settings[key];
+			} else return acc;
+		}, settings['default']);
+	}
+
 	_disableStatsWatch() {
 		if (this._statsTimeoutId) {
 			clearInterval(this._statsTimeout);
@@ -1593,9 +1630,11 @@ class RoomSession {
 		if(this._aqTimeoutId) {
 			clearTimeout(this._aqTimeoutId);
 			this._aqTimeoutId = null;
+			this._aqIntervalCounter = 0;
 		}
-		
-		this._aqTimeoutId = setInterval(() => {
+
+
+		const checkStats = () => {
 			this._participants.forEach(p => {
 				if(p.handleId !== this.handleId) {
 
@@ -1605,27 +1644,21 @@ class RoomSession {
 
 						const {source, simulcastBitrates} = p.webrtcStuff.tracksMap.find(t => t.mid === mid) || {};
 
+						// track is gone
 						if(!simulcastBitrates) {
 							return;
 						}
 
+						const simulcastConfigForSource = this._findSimulcastConfig(source, this.simulcastSettings);
 						const initialSubstreamBeenSet = !!p.webrtcStuff.initialSimulcastSubstreamBeenSet[mid];
+						const defaultSelectedSubstream = p.webrtcStuff?.overriddenSimulcastMode[mid]?.defaultSubstream || simulcastConfigForSource?.defaultSubstream;
+						const simulcastMode = p.webrtcStuff?.overriddenSimulcastMode[mid]?.mode || simulcastConfigForSource?.mode;
 
-						const defaultSelectedSubstream = typeof this.simulcastDefaultManualSubstream === 'object'
-								? (this.simulcastDefaultManualSubstream[source] !== undefined
-									? this.simulcastDefaultManualSubstream[source]
-									: this.simulcastDefaultManualSubstream['default'])
-								: this.simulcastDefaultManualSubstream;
-
-						const simulcastMode = typeof this.simulcastMode === 'object'
-							? (this.simulcastMode[source] !== undefined ? this.simulcastMode[source] : this.simulcastMode['default'])
-							: this.simulcastMode;
-
-						if((simulcastMode === 'browserControlled' || p.webrtcStuff.forcedBrowserControlledMode[mid])) {
+						if((simulcastMode === 'browserControlled')) {
 							// do nothing
 						}
-						
-						else if(simulcastMode === 'manual' || !initialSubstreamBeenSet) {
+
+						else if((simulcastMode === 'manual' && this._aqIntervalCounter % this._aqIntervalDivisor === 0) || !initialSubstreamBeenSet) {
 							p.webrtcStuff.initialSimulcastSubstreamBeenSet[mid] = true;
 							const currentSubstream = p.webrtcStuff.selectedSubstream[mid];
 							if(defaultSelectedSubstream !== undefined && defaultSelectedSubstream !== null && defaultSelectedSubstream !== currentSubstream) {
@@ -1638,17 +1671,18 @@ class RoomSession {
 						else if(simulcastMode === 'controlled') {
 							const currentSubstream = p.webrtcStuff.selectedSubstream[mid];
 							const settingsForCurrentSubstream = simulcastBitrates?.[simulcastBitrates.length - 1 - currentSubstream];
+
 							let directionDecision = 0;
 							if(p.webrtcStuff?.stats?.[mid]?.length > this._upStatsLength) {
 								const upMedianStats = this._calculateMedianStats(p.webrtcStuff.stats[mid].slice(this._upStatsLength * -1));
-								if(upMedianStats?.framesPerSecond >= Math.floor((settingsForCurrentSubstream?.maxFramerate || 30) * 0.7) && upMedianStats?.freezeDurationSinceLast < (this._upStatsLength * this._statsInterval * 0.33) / 1000 && upMedianStats?.freezeCountSinceLast < 3) {
+								if(upMedianStats?.framesPerSecond >= Math.floor((settingsForCurrentSubstream?.maxFramerate || 30) * 0.7) && upMedianStats?.freezeDurationSinceLast < (this._upStatsLength * this._statsInterval * 0.33) / 1000 /* && upMedianStats?.freezeCountSinceLast < 3 */) {
 									directionDecision = 1;
 								}
 							}
 
 							if(p.webrtcStuff?.stats?.[mid]?.length > this._downStatsLength) {
 								const downMedianStats = this._calculateMedianStats(p.webrtcStuff.stats[mid].slice(this._downStatsLength * -1));
-								if(downMedianStats?.framesPerSecond < Math.floor((settingsForCurrentSubstream?.maxFramerate || 30) * 0.7) || downMedianStats?.freezeDurationSinceLast > (this._downStatsLength * this._statsInterval * 0.33) / 1000 || downMedianStats?.freezeCountSinceLast > 5 /* || downMedianStats?.jitter > maxJitter(settingsForCurrentSubstream.maxFramerate) */) {
+								if(downMedianStats?.framesPerSecond < Math.floor((settingsForCurrentSubstream?.maxFramerate || 30) * 0.7) || downMedianStats?.freezeDurationSinceLast > (this._downStatsLength * this._statsInterval * 0.33) / 1000 /*  || downMedianStats?.freezeCountSinceLast > 5 || downMedianStats?.jitter > maxJitter(settingsForCurrentSubstream.maxFramerate) */) {
 									directionDecision = -1;
 								}
 							}
@@ -1676,13 +1710,19 @@ class RoomSession {
 					});
 				}
 			})
-		}, this._aqInterval);
+
+			this._aqIntervalCounter++;
+			this._aqTimeoutId = setTimeout(checkStats, this._aqInterval);
+		}
+
+		checkStats();
 	}
 
 	_disableSubstreamAutoSelect() {
 		if(this._aqTimeoutId) {
 			clearTimeout(this._aqTimeoutId);
 			this._aqTimeoutId = null;
+			this._aqIntervalCounter = 0;
 		}
 	}
 
@@ -1737,6 +1777,10 @@ class RoomSession {
 							powerEfficientDecoder: null,
 						};
 						participantStats.stats.forEach(report => {
+
+							const simulcastConfigForSource = this._findSimulcastConfig(participantStats.source, this.simulcastSettings);
+							const simulcastMode = handle.webrtcStuff?.overriddenSimulcastMode[participantStats.mid]?.mode || simulcastConfigForSource?.mode ;
+
 							if(report.type === 'inbound-rtp' && report.kind === 'video') {
 								stats.framesPerSecond = report.framesPerSecond || 0;
 								stats.framesDropped = report.framesDropped || 0;
@@ -1759,14 +1803,7 @@ class RoomSession {
 							}
 
 							stats.selectedSubstream = handle.webrtcStuff.selectedSubstream[participantStats.mid];
-							if(handle.webrtcStuff.forcedBrowserControlledMode[participantStats.mid]) {
-								stats.simulcastMode = 'browserControlled';
-							}
-							else {
-								stats.simulcastMode  = typeof this.simulcastMode === 'object'
-									? (this.simulcastMode[participantStats.source] !== undefined ? this.simulcastMode[participantStats.source] : this.simulcastMode['default'])
-									: this.simulcastMode;
-							}
+							stats.simulcastMode  = simulcastMode;
 
 						});
 
@@ -2060,6 +2097,10 @@ class RoomSession {
 							});
 						};
 
+						let mutedTimerId = {};
+						let waitPeriod = 300; // ms
+						let screenShareWaitPeriod = 5000; // ms
+
 						event.track.onmute = (ev) => {
 							this._log('Remote track muted');
 
@@ -2081,22 +2122,35 @@ class RoomSession {
 								muted: true
 							});
 
-							// questionable hotfix
-							// when a track is muted, we try to switch to lower quality substream
+							// when a track is muted, we try to switch to lower quality substream, but not for screen sharing
 
 							if(!this.simulcast) {
 								return;
 							}
 
-							const simulcastMode = typeof this.simulcastMode === 'object'
-								? (this.simulcastMode[source] !== undefined ? this.simulcastMode[source] : this.simulcastMode['default'])
-								: this.simulcastMode;
-							const {simulcastBitrates} = handle.webrtcStuff.tracksMap.find(t => t.mid === mid) || {};
-							const currentSubstream = handle.webrtcStuff.selectedSubstream[mid];
-							if(!(simulcastMode === 'browserControlled' || handle.webrtcStuff.forcedBrowserControlledMode[mid]) && ev.target.kind === 'video' && currentSubstream < simulcastBitrates.length - 1) {
-								this.selectSubStream(handle.handleId, currentSubstream + 1, undefined, mid, false)
-									.catch((reason) => this._log(`Changing substream for mid: ${mid} failed. Reason: ${reason}`));
+							const wPeriod = source.indexOf('screen') > -1 ? screenShareWaitPeriod : waitPeriod;
+
+							if(!mutedTimerId[mid]) {
+								mutedTimerId[mid] = setTimeout(() => {
+									mutedTimerId[mid] = null;
+									const simulcastConfigForSource = this._findSimulcastConfig(source, this.simulcastSettings);
+									const simulcastMode = handle.webrtcStuff?.overriddenSimulcastMode[mid]?.mode || simulcastConfigForSource?.mode;
+									const {simulcastBitrates} = handle.webrtcStuff.tracksMap.find(t => t.mid === mid) || {};
+
+									// track is gone
+									if(!simulcastBitrates) {
+										return;
+									}
+
+									const currentSubstream = handle.webrtcStuff.selectedSubstream[mid];
+									if(!(simulcastMode === 'browserControlled') && ev.target.kind === 'video' && currentSubstream < simulcastBitrates.length - 1) {
+										this._log('Attempting to down the quality due to track muted');
+										this.selectSubStream(handle.handleId, currentSubstream + 1, undefined, mid, false)
+											.catch((reason) => this._log(`Changing substream for mid: ${mid} failed. Reason: ${reason}`));
+									}
+								}, wPeriod);
 							}
+
 						};
 
 						event.track.onunmute = (ev) => {
@@ -2106,6 +2160,12 @@ class RoomSession {
 								t => t.receiver.track === ev.target);
 							let mid = transceiver.mid || ev.target.id;
 							let source = Object.keys(config.streamMap).find(key => config.streamMap[key].includes(ev.target.id));
+
+							if(mutedTimerId[mid]) {
+								clearTimeout(mutedTimerId[mid]);
+								mutedTimerId[mid] = null;
+							}
+
 							this.emit('remoteTrackMuted', {
 								id: handle.handleId,
 								mid,
@@ -2591,6 +2651,7 @@ class RoomSession {
 			config.stream.removeTrack(oldVideoStream);
 		}
 
+		const simulcastConfigForSource = this._findSimulcastConfig(source, this.simulcastSettings);
 		let audioTrackReplacePromise = Promise.resolve();
 		let videoTrackReplacePromise = Promise.resolve();
 
@@ -2646,11 +2707,12 @@ class RoomSession {
 				}
 				else {
 					if(adapter.browserDetails.browser !== 'firefox') {
+
 						// standard
 						config.pc.addTransceiver(stream.getVideoTracks()[0], {
 							direction: 'sendonly',
 							streams: [config.stream],
-							sendEncodings: structuredClone(this.simulcastBitrates)
+							sendEncodings: structuredClone(simulcastConfigForSource?.bitrates)
 						})
 					}
 					else {
@@ -2662,7 +2724,7 @@ class RoomSession {
 						let sender = transceiver ? transceiver.sender : null;
 						if(sender) {
 							let parameters = sender.getParameters() || {};
-							parameters.encodings = stream.getVideoTracks()[0].sendEncodings || structuredClone(this.simulcastBitrates);
+							parameters.encodings = stream.getVideoTracks()[0].sendEncodings || structuredClone(simulcastConfigForSource?.bitrates);
 							sender.setParameters(parameters);
 						}
 					}
@@ -2796,10 +2858,11 @@ class RoomSession {
 
 				let descriptions = [];
 				Object.keys(config.streamMap).forEach(source => {
+					const simulcastConfigForSource = this._findSimulcastConfig(source, this.simulcastSettings);
 					config.streamMap[source].forEach(trackId => {
 						let t = transceivers.find(transceiver => transceiver.sender.track && transceiver.sender.track.id === trackId)
 						if(t) {
-							descriptions.push({mid: t.mid, description: JSON.stringify({source, simulcastBitrates: this.simulcastBitrates, intercomGroups: this._talkIntercomChannels})});
+							descriptions.push({mid: t.mid, description: JSON.stringify({source, simulcastBitrates: simulcastConfigForSource?.bitrates, intercomGroups: this._talkIntercomChannels})});
 						}
 					})
 				});
@@ -2993,6 +3056,39 @@ class RoomSession {
 		}
 	}
 
+	overrideSimulcastSettings(handleId, mid, source, settings = {}) {
+		const {mode, defaultSubstream} = settings;
+		let handle = this._getHandle(handleId);
+		if(!handle) {
+			return Promise.resolve();
+		}
+		let config = handle.webrtcStuff;
+		if(source !== undefined || mid !== undefined) {
+			if(mid === undefined) {
+				let transceivers = config.pc.getTransceivers();
+				for(let trackId of config.streamMap[source]) {
+					let transceiver = transceivers.find(transceiver => transceiver.receiver.track && transceiver.receiver.track.kind === 'video' && transceiver.receiver.track.id === trackId)
+					if(transceiver) {
+						mid = transceiver.mid;
+						break;
+					}
+				}
+			}
+
+			if(mid !== undefined) {
+				if(!config.overriddenSimulcastMode[mid]) {
+					config.overriddenSimulcastMode[mid] = {};
+				}
+				config.overriddenSimulcastMode[mid]['defaultSubstream'] = defaultSubstream;
+				config.overriddenSimulcastMode[mid]['mode'] = mode;
+				return true;
+			}
+			else {
+				return false;
+			}
+		}
+	}
+
 	selectSubStream(handleId, substream = 2, source, mid, manual = false) {
 		this._log('Select substream called for handle:', handleId, 'Source or mid:', source ? source : mid, 'Substream:', substream);
 		let handle = this._getHandle(handleId);
@@ -3036,10 +3132,17 @@ class RoomSession {
 					}
 				}
 				if(mid !== undefined) {
+
+					if(!config.overriddenSimulcastMode[mid]) {
+						config.overriddenSimulcastMode[mid] = {};
+					}
+
 					if(substream === null) {
 
 						if(manual) {
-							config.forcedBrowserControlledMode[mid] = false
+							// reset to previous state
+							config.overriddenSimulcastMode[mid]['defaultSubstream'] = null;
+							config.overriddenSimulcastMode[mid]['mode'] = null;
 						}
 
 						resolve({substream, sender: handleId});
@@ -3047,7 +3150,8 @@ class RoomSession {
 					}
 
 					if(manual) {
-						config.forcedBrowserControlledMode[mid] = true
+						config.overriddenSimulcastMode[mid]['defaultSubstream'] = substream;
+						config.overriddenSimulcastMode[mid]['mode'] = "manual";
 					}
 
 					this.ws.addEventListener('message', parseResponse);
@@ -3094,10 +3198,11 @@ class RoomSession {
 		let transceivers = config.pc.getTransceivers();
 		let descriptions = [];
 		Object.keys(config.streamMap).forEach(source => {
+			const simulcastConfigForSource = this._findSimulcastConfig(source, this.simulcastSettings);
 			config.streamMap[source].forEach(trackId => {
 				let t = transceivers.find(transceiver => transceiver.sender.track && transceiver.sender.track.id === trackId)
 				if(t) {
-					descriptions.push({mid: t.mid, description: JSON.stringify({simulcastBitrates: this.simulcastBitrates, intercomGroups: groups, source:source})});
+					descriptions.push({mid: t.mid, description: JSON.stringify({simulcastBitrates: simulcastConfigForSource?.bitrates, intercomGroups: groups, source:source})});
 				}
 			})
 		});

package/src/modules/wt-utils.js

@@ -128,6 +128,14 @@ const maxJitter = (x) => {
     return a / (1 + Math.exp(-b * (x - c))) + d; // Fixed the typo here
 }
 
+const chunkArray = (array, chunkSize) => {
+    if (!array?.length) return [[]];
 
+    let results = [];
+    while (array.length) {
+        results.push(array.splice(0, chunkSize));
+    }
+    return results;
+}
 
-export {wait, getBrowserFingerprint, generateUUID, decodeJanusDisplay, setExactTimeout, clearExactTimeout, median, maxJitter}
+export {wait, getBrowserFingerprint, generateUUID, decodeJanusDisplay, setExactTimeout, clearExactTimeout, median, maxJitter, chunkArray}