mediasoup-client 3.6.45 → 3.6.49

package/lib/handlers/Safari12.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -121,7 +121,13 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
                 ? 'client'
                 : 'server';
         }
-        this._pc = new RTCPeerConnection(Object.assign({ iceServers: iceServers || [], iceTransportPolicy: iceTransportPolicy || 'all', bundlePolicy: 'max-bundle', rtcpMuxPolicy: 'require' }, additionalSettings), proprietaryConstraints);
+        this._pc = new RTCPeerConnection({
+            iceServers: iceServers || [],
+            iceTransportPolicy: iceTransportPolicy || 'all',
+            bundlePolicy: 'max-bundle',
+            rtcpMuxPolicy: 'require',
+            ...additionalSettings
+        }, proprietaryConstraints);
         // Handle RTCPeerConnection connection status.
         this._pc.addEventListener('iceconnectionstatechange', () => {
             switch (this._pc.iceConnectionState) {
@@ -310,7 +316,7 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
             throw new Error('associated RTCRtpTransceiver not found');
         const parameters = transceiver.sender.getParameters();
         parameters.encodings.forEach((encoding, idx) => {
-            parameters.encodings[idx] = Object.assign(Object.assign({}, encoding), params);
+            parameters.encodings[idx] = { ...encoding, ...params };
         });
         await transceiver.sender.setParameters(parameters);
     }
@@ -366,31 +372,39 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
         };
         return { dataChannel, sctpStreamParameters };
     }
-    async receive({ trackId, kind, rtpParameters }) {
+    async receive(optionsList) {
         var _a;
         this._assertRecvDirection();
-        logger.debug('receive() [trackId:%s, kind:%s]', trackId, kind);
-        const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
-        this._remoteSdp.receive({
-            mid: localId,
-            kind,
-            offerRtpParameters: rtpParameters,
-            streamId: rtpParameters.rtcp.cname,
-            trackId
-        });
+        const results = [];
+        for (const options of optionsList) {
+            const { trackId, kind, rtpParameters } = options;
+            logger.debug('receive() [trackId:%s, kind:%s]', trackId, kind);
+            const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+            this._remoteSdp.receive({
+                mid: localId,
+                kind,
+                offerRtpParameters: rtpParameters,
+                streamId: rtpParameters.rtcp.cname,
+                trackId
+            });
+        }
         const offer = { type: 'offer', sdp: this._remoteSdp.getSdp() };
         logger.debug('receive() | calling pc.setRemoteDescription() [offer:%o]', offer);
         await this._pc.setRemoteDescription(offer);
         let answer = await this._pc.createAnswer();
         const localSdpObject = sdpTransform.parse(answer.sdp);
-        const answerMediaObject = localSdpObject.media
-            .find((m) => String(m.mid) === localId);
-        // May need to modify codec parameters in the answer based on codec
-        // parameters in the offer.
-        sdpCommonUtils.applyCodecParameters({
-            offerRtpParameters: rtpParameters,
-            answerMediaObject
-        });
+        for (const options of optionsList) {
+            const { rtpParameters } = options;
+            const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+            const answerMediaObject = localSdpObject.media
+                .find((m) => String(m.mid) === localId);
+            // May need to modify codec parameters in the answer based on codec
+            // parameters in the offer.
+            sdpCommonUtils.applyCodecParameters({
+                offerRtpParameters: rtpParameters,
+                answerMediaObject
+            });
+        }
         answer = { type: 'answer', sdp: sdpTransform.write(localSdpObject) };
         if (!this._transportReady) {
             await this._setupTransport({
@@ -400,17 +414,22 @@ class Safari12 extends HandlerInterface_1.HandlerInterface {
         }
         logger.debug('receive() | calling pc.setLocalDescription() [answer:%o]', answer);
         await this._pc.setLocalDescription(answer);
-        const transceiver = this._pc.getTransceivers()
-            .find((t) => t.mid === localId);
-        if (!transceiver)
-            throw new Error('new RTCRtpTransceiver not found');
-        // Store in the map.
-        this._mapMidTransceiver.set(localId, transceiver);
-        return {
-            localId,
-            track: transceiver.receiver.track,
-            rtpReceiver: transceiver.receiver
-        };
+        for (const options of optionsList) {
+            const { rtpParameters } = options;
+            const localId = rtpParameters.mid || String(this._mapMidTransceiver.size);
+            const transceiver = this._pc.getTransceivers()
+                .find((t) => t.mid === localId);
+            if (!transceiver)
+                throw new Error('new RTCRtpTransceiver not found');
+            // Store in the map.
+            this._mapMidTransceiver.set(localId, transceiver);
+            results.push({
+                localId,
+                track: transceiver.receiver.track,
+                rtpReceiver: transceiver.receiver
+            });
+        }
+        return results;
     }
     async stopReceiving(localId) {
         this._assertRecvDirection();

package/lib/handlers/ortc/edgeUtils.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };

package/lib/handlers/sdp/MediaSection.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };

package/lib/handlers/sdp/RemoteSdp.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };

package/lib/handlers/sdp/commonUtils.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };

package/lib/index.d.ts

@@ -8,7 +8,7 @@ export { types };
 /**
  * Expose mediasoup-client version.
  */
-export declare const version = "3.6.45";
+export declare const version = "3.6.49";
 /**
  * Expose Device class and detectDevice() helper.
  */

package/lib/index.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = exports.detectDevice = exports.Device = exports.version = exports.types = void 0;
+exports.debug = exports.parseScalabilityMode = exports.detectDevice = exports.Device = exports.version = exports.types = void 0;
 const debug_1 = __importDefault(require("debug"));
 exports.debug = debug_1.default;
 const Device_1 = require("./Device");
@@ -33,7 +33,7 @@ exports.types = types;
 /**
  * Expose mediasoup-client version.
  */
-exports.version = '3.6.45';
+exports.version = '3.6.49';
 /**
  * Expose parseScalabilityMode() function.
  */

package/lib/ortc.js

@@ -14,7 +14,7 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 var __importStar = (this && this.__importStar) || function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
 };
@@ -780,12 +780,11 @@ function matchCodecs(aCodec, bCodec, { strict = false, modify = false } = {}) {
     switch (aMimeType) {
         case 'video/h264':
             {
-                const aPacketizationMode = aCodec.parameters['packetization-mode'] || 0;
-                const bPacketizationMode = bCodec.parameters['packetization-mode'] || 0;
-                if (aPacketizationMode !== bPacketizationMode)
-                    return false;
-                // If strict matching check profile-level-id.
                 if (strict) {
+                    const aPacketizationMode = aCodec.parameters['packetization-mode'] || 0;
+                    const bPacketizationMode = bCodec.parameters['packetization-mode'] || 0;
+                    if (aPacketizationMode !== bPacketizationMode)
+                        return false;
                     if (!h264.isSameProfile(aCodec.parameters, bCodec.parameters))
                         return false;
                     let selectedProfileLevelId;
@@ -811,7 +810,6 @@ function matchCodecs(aCodec, bCodec, { strict = false, modify = false } = {}) {
             }
         case 'video/vp9':
             {
-                // If strict matching check profile-id.
                 if (strict) {
                     const aProfileId = aCodec.parameters['profile-id'] || 0;
                     const bProfileId = bCodec.parameters['profile-id'] || 0;

package/lib/types.js

@@ -7,7 +7,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     o[k2] = m[k];
 }));
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Device"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mediasoup-client",
-  "version": "3.6.45",
+  "version": "3.6.49",
   "description": "mediasoup client side JavaScript library",
   "contributors": [
     "Iñaki Baz Castillo <ibc@aliax.net> (https://inakibaz.me)",
@@ -39,25 +39,25 @@
     "@types/events": "^3.0.0",
     "awaitqueue": "^2.3.3",
     "bowser": "^2.11.0",
-    "debug": "^4.3.2",
+    "debug": "^4.3.3",
     "events": "^3.3.0",
     "fake-mediastreamtrack": "^1.1.6",
     "h264-profile-level-id": "^1.0.1",
     "sdp-transform": "^2.14.1",
-    "supports-color": "^8.1.1"
+    "supports-color": "^9.2.1"
   },
   "devDependencies": {
     "@types/sdp-transform": "^2.4.5",
     "@types/uuid": "^3.4.9",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^7.32.0",
-    "eslint-plugin-jest": "^24.5.2",
-    "jest": "^27.3.1",
+    "@typescript-eslint/eslint-plugin": "^5.9.1",
+    "@typescript-eslint/parser": "^5.9.1",
+    "eslint": "^8.6.0",
+    "eslint-plugin-jest": "^25.3.4",
+    "jest": "^27.4.7",
     "jest-tobetype": "^1.2.3",
-    "open-cli": "^6.0.1",
-    "tsc-watch": "^4.5.0",
-    "typescript": "^3.8",
+    "open-cli": "^7.0.1",
+    "tsc-watch": "^4.6.0",
+    "typescript": "^4.5.4",
     "uuid": "^3.4.0"
   }
 }

package/src/DataConsumer.ts

@@ -128,7 +128,7 @@ export class DataConsumer extends EnhancedEventEmitter
 	/**
 	 * DataChannel binaryType.
 	 */
-	get binaryType(): string
+	get binaryType(): BinaryType
 	{
 		return this._dataChannel.binaryType;
 	}
@@ -136,7 +136,7 @@ export class DataConsumer extends EnhancedEventEmitter
 	/**
 	 * Set DataChannel binaryType.
 	 */
-	set binaryType(binaryType: string)
+	set binaryType(binaryType: BinaryType)
 	{
 		this._dataChannel.binaryType = binaryType;
 	}

package/src/Device.ts

@@ -80,8 +80,8 @@ export function detectDevice(): BuiltinHandlerName | undefined
 		const browser = Bowser.getParser(ua);
 		const engine = browser.getEngine();
 
-		// Chrome and Chromium.
-		if (browser.satisfies({ chrome: '>=74', chromium: '>=74' }))
+		// Chrome, Chromium, and Edge.
+		if (browser.satisfies({ chrome: '>=74', chromium: '>=74', 'microsoft edge': '>=88' }))
 		{
 			return 'Chrome74';
 		}
@@ -102,6 +102,11 @@ export function detectDevice(): BuiltinHandlerName | undefined
 		{
 			return 'Firefox60';
 		}
+		// Firefox on iOS.
+		else if (browser.satisfies({ ios: { OS: '>=14.3', firefox: '>=30.0' } }))
+		{
+			return 'Safari12';
+		}
 		// Safari with Unified-Plan support enabled.
 		else if (
 			browser.satisfies({ safari: '>=12.0' }) &&

package/src/Transport.ts

@@ -4,7 +4,7 @@ import { EnhancedEventEmitter } from './EnhancedEventEmitter';
 import { UnsupportedError, InvalidStateError } from './errors';
 import * as utils from './utils';
 import * as ortc from './ortc';
-import { HandlerFactory, HandlerInterface } from './handlers/HandlerInterface';
+import { HandlerFactory, HandlerInterface, HandlerReceiveOptions } from './handlers/HandlerInterface';
 import { Producer, ProducerOptions } from './Producer';
 import { Consumer, ConsumerOptions } from './Consumer';
 import { DataProducer, DataProducerOptions } from './DataProducer';
@@ -19,6 +19,24 @@ interface InternalTransportOptions extends TransportOptions
 	canProduceByKind: CanProduceByKind;
 }
 
+class ConsumerCreationTask
+{
+	consumerOptions: ConsumerOptions;
+	promise: Promise<Consumer>;
+	resolve?: (consumer: Consumer) => void;
+	reject?: (error: Error) => void;
+
+	constructor(consumerOptions: ConsumerOptions)
+	{
+		this.consumerOptions = consumerOptions;
+		this.promise = new Promise((resolve, reject) =>
+		{
+			this.resolve = resolve;
+			this.reject = reject;
+		});
+	}
+}
+
 export type TransportOptions =
 {
 	id: string;
@@ -165,6 +183,10 @@ export class Transport extends EnhancedEventEmitter
 	private _probatorConsumerCreated = false;
 	// AwaitQueue instance to make async tasks happen sequentially.
 	private readonly _awaitQueue = new AwaitQueue({ ClosedErrorClass: InvalidStateError });
+	// Consumer creation tasks awaiting to be processed.
+	private _pendingConsumerTasks: ConsumerCreationTask[] = [];
+	// Consumer creation in progress flag.
+	private _consumerCreationInProgress = false;
 	// Observer instance.
 	protected readonly _observer = new EnhancedEventEmitter();
 
@@ -583,68 +605,33 @@ export class Transport extends EnhancedEventEmitter
 		else if (appData && typeof appData !== 'object')
 			throw new TypeError('if given, appData must be an object');
 
-		// Enqueue command.
-		return this._awaitQueue.push(
-			async () =>
-			{
-				// Ensure the device can consume it.
-				const canConsume = ortc.canReceive(
-					rtpParameters, this._extendedRtpCapabilities);
-
-				if (!canConsume)
-					throw new UnsupportedError('cannot consume this Producer');
-
-				const { localId, rtpReceiver, track } =
-					await this._handler.receive({ trackId: id, kind, rtpParameters });
-
-				const consumer = new Consumer(
-					{
-						id,
-						localId,
-						producerId,
-						rtpReceiver,
-						track,
-						rtpParameters,
-						appData
-					});
-
-				this._consumers.set(consumer.id, consumer);
-				this._handleConsumer(consumer);
-
-				// If this is the first video Consumer and the Consumer for RTP probation
-				// has not yet been created, create it now.
-				if (!this._probatorConsumerCreated && kind === 'video')
-				{
-					try
-					{
-						const probatorRtpParameters =
-							ortc.generateProbatorRtpParameters(consumer.rtpParameters);
+		// Ensure the device can consume it.
+		const canConsume = ortc.canReceive(
+			rtpParameters, this._extendedRtpCapabilities);
 
-						await this._handler.receive(
-							{
-								trackId       : 'probator',
-								kind          : 'video',
-								rtpParameters : probatorRtpParameters
-							});
+		if (!canConsume)
+			throw new UnsupportedError('cannot consume this Producer');
 
-						logger.debug('consume() | Consumer for RTP probation created');
+		const consumerCreationTask = new ConsumerCreationTask(
+			{
+				id,
+				producerId,
+				kind,
+				rtpParameters,
+				appData
+			}
+		);
 
-						this._probatorConsumerCreated = true;
-					}
-					catch (error)
-					{
-						logger.error(
-							'consume() | failed to create Consumer for RTP probation:%o',
-							error);
-					}
-				}
+		// Store the Consumer creation task.
+		this._pendingConsumerTasks.push(consumerCreationTask);
 
-				// Emit observer event.
-				this._observer.safeEmit('newconsumer', consumer);
+		// There is no Consumer creation in progress, create it now.
+		if (this._consumerCreationInProgress === false)
+		{
+			this._createPendingConsumers();
+		}
 
-				return consumer;
-			},
-			'transport.consume()');
+		return consumerCreationTask.promise;
 	}
 
 	/**
@@ -788,6 +775,123 @@ export class Transport extends EnhancedEventEmitter
 			'transport.consumeData()');
 	}
 
+	// This method is guaranteed to never throw.
+	async _createPendingConsumers(): Promise<void>
+	{
+		this._awaitQueue.push(
+			async () =>
+			{
+				this._consumerCreationInProgress = true;
+
+				const pendingConsumerTasks = [ ...this._pendingConsumerTasks ];
+
+				// Clear pending Consumer tasks.
+				this._pendingConsumerTasks = [];
+
+				// Video Consumer in order to create the probator.
+				let videoConsumerForProbator: Consumer | undefined = undefined;
+
+				// Fill options list.
+				const optionsList: HandlerReceiveOptions[] = [];
+
+				for (const task of pendingConsumerTasks)
+				{
+					const { id, kind, rtpParameters } = task.consumerOptions;
+
+					optionsList.push({
+						trackId : id!,
+						kind    : kind as 'audio' | 'video',
+						rtpParameters
+					});
+				}
+
+				try
+				{
+					const results = await this._handler.receive(optionsList);
+
+					for (let idx=0; idx < results.length; idx++)
+					{
+						const task = pendingConsumerTasks[idx];
+						const result = results[idx];
+						const { id, producerId, kind, rtpParameters, appData } = task.consumerOptions;
+						const { localId, rtpReceiver, track } = result;
+						const consumer = new Consumer(
+							{
+								id         : id!,
+								localId,
+								producerId : producerId!,
+								rtpReceiver,
+								track,
+								rtpParameters,
+								appData
+							});
+
+						this._consumers.set(consumer.id, consumer);
+						this._handleConsumer(consumer);
+
+						// If this is the first video Consumer and the Consumer for RTP probation
+						// has not yet been created, it's time to create it.
+						if (!this._probatorConsumerCreated && !videoConsumerForProbator && kind === 'video')
+						{
+							videoConsumerForProbator = consumer;
+						}
+
+						// Emit observer event.
+						this._observer.safeEmit('newconsumer', consumer);
+
+						task.resolve!(consumer);
+					}
+				}
+				catch (error)
+				{
+					for (const task of pendingConsumerTasks)
+					{
+						task.reject!(error as Error);
+					}
+				}
+
+				// If RTP probation must be handled, do it now.
+				if (videoConsumerForProbator)
+				{
+					try
+					{
+						const probatorRtpParameters =
+							ortc.generateProbatorRtpParameters(videoConsumerForProbator!.rtpParameters);
+
+						await this._handler.receive(
+							[ {
+								trackId       : 'probator',
+								kind          : 'video',
+								rtpParameters : probatorRtpParameters
+							} ]);
+
+						logger.debug('_createPendingConsumers() | Consumer for RTP probation created');
+
+						this._probatorConsumerCreated = true;
+					}
+					catch (error)
+					{
+						logger.error(
+							'_createPendingConsumers() | failed to create Consumer for RTP probation:%o',
+							error);
+					}
+				}
+
+				this._consumerCreationInProgress = false;
+			},
+			'transport._createPendingConsumers()')
+			.then(() =>
+			{
+				// There are pending Consumer tasks, enqueue their creation.
+				if (this._pendingConsumerTasks.length > 0)
+				{
+					this._createPendingConsumers();
+				}
+			})
+			// NOTE: We only get here when the await queue is closed.
+			.catch(() => {});
+	}
+
 	_handleHandler(): void
 	{
 		const handler = this._handler;