npm - @whereby.com/media - Versions diffs - 2.2.0 → 2.4.0 - Mend

@whereby.com/media 2.2.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/dist/index.cjs CHANGED Viewed

@@ -3989,6 +3989,37 @@ function getNumberOfTemporalLayers(consumer) {
     var _a, _b, _c;
     return /T3/.test(((_c = (_b = (_a = consumer._rtpParameters) === null || _a === void 0 ? void 0 : _a.encodings) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.scalabilityMode) || "") ? 3 : 2;
 }
+function addProducerCpuOveruseWatch({ producer, onOveruse }) {
+    var _a;
+    const encodings = (_a = producer.rtpParameters) === null || _a === void 0 ? void 0 : _a.encodings;
+    let interval = null;
+    if ((encodings === null || encodings === void 0 ? void 0 : encodings.length) === 3) {
+        const { ssrc, rid } = encodings[0];
+        let maxHeight = 0;
+        let ticks = 0;
+        const targetTicksForTrigger = 2;
+        interval = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+            (yield producer.getStats()).forEach((report) => {
+                if (report.type === "outbound-rtp" && ((ssrc && report.ssrc === ssrc) || (rid && report.rid === rid))) {
+                    if (maxHeight && report.frameHeight && report.frameHeight < maxHeight) {
+                        ticks++;
+                        if (ticks >= targetTicksForTrigger) {
+                            onOveruse();
+                        }
+                    }
+                    else {
+                        ticks = 0;
+                    }
+                    maxHeight = Math.max(maxHeight, report.frameHeight || 0);
+                }
+            });
+        }), 2000);
+    }
+    return () => {
+        if (interval)
+            clearInterval(interval);
+    };
+}
 class SfuV2Parser {
     static parse(raw) {
@@ -4454,6 +4485,7 @@ class VegaRtcManager {
             this._emitToPWA(PROTOCOL_EVENTS.MEDIA_QUALITY_CHANGED, payload);
         });
         this._networkIsDetectedUpBySignal = false;
+        this._cpuOveruseDetected = false;
     }
     _updateAndScheduleMediaServersRefresh({ iceServers, turnServers, sfuServer, sfuServers, mediaserverConfigTtlSeconds, }) {
         var _a, _b, _c;
@@ -4945,6 +4977,23 @@ class VegaRtcManager {
             this._internalSetupMicScore();
         }
     }
+    _syncResourceUsage() {
+        var _a;
+        if (this._webcamProducer) {
+            const simulcastLayer3ShouldBeActive = !this._cpuOveruseDetected;
+            const params = this._webcamProducer.rtpParameters;
+            if (((_a = params === null || params === void 0 ? void 0 : params.encodings) === null || _a === void 0 ? void 0 : _a.length) === 3) {
+                const targetMaxSpatialLayer = simulcastLayer3ShouldBeActive ? 2 : 1;
+                if (this._webcamProducer.maxSpatialLayer !== targetMaxSpatialLayer) {
+                    this._webcamProducer.setMaxSpatialLayer(targetMaxSpatialLayer);
+                    rtcStats.sendEvent("simulcast_layer_activation_changed", {
+                        layerIndex: 2,
+                        active: simulcastLayer3ShouldBeActive,
+                    });
+                }
+            }
+        }
+    }
     _internalSendWebcam() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -4967,6 +5016,17 @@ class VegaRtcManager {
                             paused: currentPaused,
                         } }));
                     currentPaused ? producer.pause() : producer.resume();
+                    const cleanUpCpuWatch = this._features.producerCpuOveruseWatchOn
+                        ? addProducerCpuOveruseWatch({
+                            producer,
+                            onOveruse: () => {
+                                rtcStats.sendEvent("producer_cpuoveruse_detected", {});
+                                cleanUpCpuWatch();
+                                this._cpuOveruseDetected = true;
+                                this._syncResourceUsage();
+                            },
+                        })
+                        : () => { };
                     this._webcamProducer = producer;
                     this._qualityMonitor.addProducer(this._selfId, producer.id);
                     producer.observer.once("close", () => {
@@ -4974,6 +5034,7 @@ class VegaRtcManager {
                         logger$2.info('webcamProducer "close" event');
                         if (producer.appData.localClosed)
                             (_a = this._vegaConnection) === null || _a === void 0 ? void 0 : _a.message("closeProducers", { producerIds: [producer.id] });
+                        cleanUpCpuWatch();
                         this._webcamProducer = null;
                         this._webcamProducerPromise = null;
                         this._qualityMonitor.removeProducer(this._selfId, producer.id);
@@ -6085,6 +6146,17 @@ const metrics = [
         enabled: ({ hasLiveTrack, track, trackStats, ssrc0, kind }) => hasLiveTrack && kind === "video" && !!trackStats && !!track && !!ssrc0 && !!ssrc0.height,
         value: ({ trackStats }) => Object.values((trackStats === null || trackStats === void 0 ? void 0 : trackStats.ssrcs) || {}).reduce((max, ssrc) => Math.max(max, ssrc.fps || 0 > 0 ? ssrc.height || 0 : 0), 0),
     },
+    {
+        id: "layer0-height",
+        enabled: ({ hasLiveTrack, track, ssrc0, kind }) => hasLiveTrack &&
+            kind === "video" &&
+            !!track &&
+            !!ssrc0 &&
+            !!ssrc0.height &&
+            !!ssrc0.fps &&
+            ssrc0.direction === "out",
+        value: ({ ssrc0 }) => (ssrc0 === null || ssrc0 === void 0 ? void 0 : ssrc0.height) || 0,
+    },
     {
         id: "sourceHeight",
         enabled: ({ hasLiveTrack, track, ssrc0, kind }) => hasLiveTrack && kind === "video" && !!track && !!ssrc0 && !!ssrc0.sourceHeight && ssrc0.direction === "out",

package/dist/index.d.cts CHANGED Viewed

@@ -1546,6 +1546,7 @@ declare class VegaRtcManager implements RtcManager {
     _isConnectingOrConnected: boolean;
     _vegaConnectionManager?: ReturnType<typeof createVegaConnectionManager>;
     _networkIsDetectedUpBySignal: boolean;
+    _cpuOveruseDetected: boolean;
     constructor({ selfId, room, emitter, serverSocket, webrtcProvider, features, eventClaim, }: {
         selfId: any;
         room: any;
@@ -1579,6 +1580,7 @@ declare class VegaRtcManager implements RtcManager {
     _pauseResumeMic(): void;
     _sendMic(track: MediaStreamTrack): Promise<void>;
     _sendMicScore(score: number): void;
+    _syncResourceUsage(): void;
     _internalSendWebcam(): Promise<void>;
     _replaceWebcamTrack(): Promise<void>;
     _pauseResumeWebcam(): void;

package/dist/index.d.mts CHANGED Viewed

@@ -1546,6 +1546,7 @@ declare class VegaRtcManager implements RtcManager {
     _isConnectingOrConnected: boolean;
     _vegaConnectionManager?: ReturnType<typeof createVegaConnectionManager>;
     _networkIsDetectedUpBySignal: boolean;
+    _cpuOveruseDetected: boolean;
     constructor({ selfId, room, emitter, serverSocket, webrtcProvider, features, eventClaim, }: {
         selfId: any;
         room: any;
@@ -1579,6 +1580,7 @@ declare class VegaRtcManager implements RtcManager {
     _pauseResumeMic(): void;
     _sendMic(track: MediaStreamTrack): Promise<void>;
     _sendMicScore(score: number): void;
+    _syncResourceUsage(): void;
     _internalSendWebcam(): Promise<void>;
     _replaceWebcamTrack(): Promise<void>;
     _pauseResumeWebcam(): void;

package/dist/index.d.ts CHANGED Viewed

@@ -1546,6 +1546,7 @@ declare class VegaRtcManager implements RtcManager {
     _isConnectingOrConnected: boolean;
     _vegaConnectionManager?: ReturnType<typeof createVegaConnectionManager>;
     _networkIsDetectedUpBySignal: boolean;
+    _cpuOveruseDetected: boolean;
     constructor({ selfId, room, emitter, serverSocket, webrtcProvider, features, eventClaim, }: {
         selfId: any;
         room: any;
@@ -1579,6 +1580,7 @@ declare class VegaRtcManager implements RtcManager {
     _pauseResumeMic(): void;
     _sendMic(track: MediaStreamTrack): Promise<void>;
     _sendMicScore(score: number): void;
+    _syncResourceUsage(): void;
     _internalSendWebcam(): Promise<void>;
     _replaceWebcamTrack(): Promise<void>;
     _pauseResumeWebcam(): void;

package/dist/index.mjs CHANGED Viewed

@@ -3968,6 +3968,37 @@ function getNumberOfTemporalLayers(consumer) {
     var _a, _b, _c;
     return /T3/.test(((_c = (_b = (_a = consumer._rtpParameters) === null || _a === void 0 ? void 0 : _a.encodings) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.scalabilityMode) || "") ? 3 : 2;
 }
+function addProducerCpuOveruseWatch({ producer, onOveruse }) {
+    var _a;
+    const encodings = (_a = producer.rtpParameters) === null || _a === void 0 ? void 0 : _a.encodings;
+    let interval = null;
+    if ((encodings === null || encodings === void 0 ? void 0 : encodings.length) === 3) {
+        const { ssrc, rid } = encodings[0];
+        let maxHeight = 0;
+        let ticks = 0;
+        const targetTicksForTrigger = 2;
+        interval = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+            (yield producer.getStats()).forEach((report) => {
+                if (report.type === "outbound-rtp" && ((ssrc && report.ssrc === ssrc) || (rid && report.rid === rid))) {
+                    if (maxHeight && report.frameHeight && report.frameHeight < maxHeight) {
+                        ticks++;
+                        if (ticks >= targetTicksForTrigger) {
+                            onOveruse();
+                        }
+                    }
+                    else {
+                        ticks = 0;
+                    }
+                    maxHeight = Math.max(maxHeight, report.frameHeight || 0);
+                }
+            });
+        }), 2000);
+    }
+    return () => {
+        if (interval)
+            clearInterval(interval);
+    };
+}
 class SfuV2Parser {
     static parse(raw) {
@@ -4433,6 +4464,7 @@ class VegaRtcManager {
             this._emitToPWA(PROTOCOL_EVENTS.MEDIA_QUALITY_CHANGED, payload);
         });
         this._networkIsDetectedUpBySignal = false;
+        this._cpuOveruseDetected = false;
     }
     _updateAndScheduleMediaServersRefresh({ iceServers, turnServers, sfuServer, sfuServers, mediaserverConfigTtlSeconds, }) {
         var _a, _b, _c;
@@ -4924,6 +4956,23 @@ class VegaRtcManager {
             this._internalSetupMicScore();
         }
     }
+    _syncResourceUsage() {
+        var _a;
+        if (this._webcamProducer) {
+            const simulcastLayer3ShouldBeActive = !this._cpuOveruseDetected;
+            const params = this._webcamProducer.rtpParameters;
+            if (((_a = params === null || params === void 0 ? void 0 : params.encodings) === null || _a === void 0 ? void 0 : _a.length) === 3) {
+                const targetMaxSpatialLayer = simulcastLayer3ShouldBeActive ? 2 : 1;
+                if (this._webcamProducer.maxSpatialLayer !== targetMaxSpatialLayer) {
+                    this._webcamProducer.setMaxSpatialLayer(targetMaxSpatialLayer);
+                    rtcStats.sendEvent("simulcast_layer_activation_changed", {
+                        layerIndex: 2,
+                        active: simulcastLayer3ShouldBeActive,
+                    });
+                }
+            }
+        }
+    }
     _internalSendWebcam() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -4946,6 +4995,17 @@ class VegaRtcManager {
                             paused: currentPaused,
                         } }));
                     currentPaused ? producer.pause() : producer.resume();
+                    const cleanUpCpuWatch = this._features.producerCpuOveruseWatchOn
+                        ? addProducerCpuOveruseWatch({
+                            producer,
+                            onOveruse: () => {
+                                rtcStats.sendEvent("producer_cpuoveruse_detected", {});
+                                cleanUpCpuWatch();
+                                this._cpuOveruseDetected = true;
+                                this._syncResourceUsage();
+                            },
+                        })
+                        : () => { };
                     this._webcamProducer = producer;
                     this._qualityMonitor.addProducer(this._selfId, producer.id);
                     producer.observer.once("close", () => {
@@ -4953,6 +5013,7 @@ class VegaRtcManager {
                         logger$2.info('webcamProducer "close" event');
                         if (producer.appData.localClosed)
                             (_a = this._vegaConnection) === null || _a === void 0 ? void 0 : _a.message("closeProducers", { producerIds: [producer.id] });
+                        cleanUpCpuWatch();
                         this._webcamProducer = null;
                         this._webcamProducerPromise = null;
                         this._qualityMonitor.removeProducer(this._selfId, producer.id);
@@ -6064,6 +6125,17 @@ const metrics = [
         enabled: ({ hasLiveTrack, track, trackStats, ssrc0, kind }) => hasLiveTrack && kind === "video" && !!trackStats && !!track && !!ssrc0 && !!ssrc0.height,
         value: ({ trackStats }) => Object.values((trackStats === null || trackStats === void 0 ? void 0 : trackStats.ssrcs) || {}).reduce((max, ssrc) => Math.max(max, ssrc.fps || 0 > 0 ? ssrc.height || 0 : 0), 0),
     },
+    {
+        id: "layer0-height",
+        enabled: ({ hasLiveTrack, track, ssrc0, kind }) => hasLiveTrack &&
+            kind === "video" &&
+            !!track &&
+            !!ssrc0 &&
+            !!ssrc0.height &&
+            !!ssrc0.fps &&
+            ssrc0.direction === "out",
+        value: ({ ssrc0 }) => (ssrc0 === null || ssrc0 === void 0 ? void 0 : ssrc0.height) || 0,
+    },
     {
         id: "sourceHeight",
         enabled: ({ hasLiveTrack, track, ssrc0, kind }) => hasLiveTrack && kind === "video" && !!track && !!ssrc0 && !!ssrc0.sourceHeight && ssrc0.direction === "out",

package/dist/legacy-esm.js CHANGED Viewed

@@ -3968,6 +3968,37 @@ function getNumberOfTemporalLayers(consumer) {
     var _a, _b, _c;
     return /T3/.test(((_c = (_b = (_a = consumer._rtpParameters) === null || _a === void 0 ? void 0 : _a.encodings) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.scalabilityMode) || "") ? 3 : 2;
 }
+function addProducerCpuOveruseWatch({ producer, onOveruse }) {
+    var _a;
+    const encodings = (_a = producer.rtpParameters) === null || _a === void 0 ? void 0 : _a.encodings;
+    let interval = null;
+    if ((encodings === null || encodings === void 0 ? void 0 : encodings.length) === 3) {
+        const { ssrc, rid } = encodings[0];
+        let maxHeight = 0;
+        let ticks = 0;
+        const targetTicksForTrigger = 2;
+        interval = setInterval(() => __awaiter(this, void 0, void 0, function* () {
+            (yield producer.getStats()).forEach((report) => {
+                if (report.type === "outbound-rtp" && ((ssrc && report.ssrc === ssrc) || (rid && report.rid === rid))) {
+                    if (maxHeight && report.frameHeight && report.frameHeight < maxHeight) {
+                        ticks++;
+                        if (ticks >= targetTicksForTrigger) {
+                            onOveruse();
+                        }
+                    }
+                    else {
+                        ticks = 0;
+                    }
+                    maxHeight = Math.max(maxHeight, report.frameHeight || 0);
+                }
+            });
+        }), 2000);
+    }
+    return () => {
+        if (interval)
+            clearInterval(interval);
+    };
+}
 class SfuV2Parser {
     static parse(raw) {
@@ -4433,6 +4464,7 @@ class VegaRtcManager {
             this._emitToPWA(PROTOCOL_EVENTS.MEDIA_QUALITY_CHANGED, payload);
         });
         this._networkIsDetectedUpBySignal = false;
+        this._cpuOveruseDetected = false;
     }
     _updateAndScheduleMediaServersRefresh({ iceServers, turnServers, sfuServer, sfuServers, mediaserverConfigTtlSeconds, }) {
         var _a, _b, _c;
@@ -4924,6 +4956,23 @@ class VegaRtcManager {
             this._internalSetupMicScore();
         }
     }
+    _syncResourceUsage() {
+        var _a;
+        if (this._webcamProducer) {
+            const simulcastLayer3ShouldBeActive = !this._cpuOveruseDetected;
+            const params = this._webcamProducer.rtpParameters;
+            if (((_a = params === null || params === void 0 ? void 0 : params.encodings) === null || _a === void 0 ? void 0 : _a.length) === 3) {
+                const targetMaxSpatialLayer = simulcastLayer3ShouldBeActive ? 2 : 1;
+                if (this._webcamProducer.maxSpatialLayer !== targetMaxSpatialLayer) {
+                    this._webcamProducer.setMaxSpatialLayer(targetMaxSpatialLayer);
+                    rtcStats.sendEvent("simulcast_layer_activation_changed", {
+                        layerIndex: 2,
+                        active: simulcastLayer3ShouldBeActive,
+                    });
+                }
+            }
+        }
+    }
     _internalSendWebcam() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -4946,6 +4995,17 @@ class VegaRtcManager {
                             paused: currentPaused,
                         } }));
                     currentPaused ? producer.pause() : producer.resume();
+                    const cleanUpCpuWatch = this._features.producerCpuOveruseWatchOn
+                        ? addProducerCpuOveruseWatch({
+                            producer,
+                            onOveruse: () => {
+                                rtcStats.sendEvent("producer_cpuoveruse_detected", {});
+                                cleanUpCpuWatch();
+                                this._cpuOveruseDetected = true;
+                                this._syncResourceUsage();
+                            },
+                        })
+                        : () => { };
                     this._webcamProducer = producer;
                     this._qualityMonitor.addProducer(this._selfId, producer.id);
                     producer.observer.once("close", () => {
@@ -4953,6 +5013,7 @@ class VegaRtcManager {
                         logger$2.info('webcamProducer "close" event');
                         if (producer.appData.localClosed)
                             (_a = this._vegaConnection) === null || _a === void 0 ? void 0 : _a.message("closeProducers", { producerIds: [producer.id] });
+                        cleanUpCpuWatch();
                         this._webcamProducer = null;
                         this._webcamProducerPromise = null;
                         this._qualityMonitor.removeProducer(this._selfId, producer.id);
@@ -6064,6 +6125,17 @@ const metrics = [
         enabled: ({ hasLiveTrack, track, trackStats, ssrc0, kind }) => hasLiveTrack && kind === "video" && !!trackStats && !!track && !!ssrc0 && !!ssrc0.height,
         value: ({ trackStats }) => Object.values((trackStats === null || trackStats === void 0 ? void 0 : trackStats.ssrcs) || {}).reduce((max, ssrc) => Math.max(max, ssrc.fps || 0 > 0 ? ssrc.height || 0 : 0), 0),
     },
+    {
+        id: "layer0-height",
+        enabled: ({ hasLiveTrack, track, ssrc0, kind }) => hasLiveTrack &&
+            kind === "video" &&
+            !!track &&
+            !!ssrc0 &&
+            !!ssrc0.height &&
+            !!ssrc0.fps &&
+            ssrc0.direction === "out",
+        value: ({ ssrc0 }) => (ssrc0 === null || ssrc0 === void 0 ? void 0 : ssrc0.height) || 0,
+    },
     {
         id: "sourceHeight",
         enabled: ({ hasLiveTrack, track, ssrc0, kind }) => hasLiveTrack && kind === "video" && !!track && !!ssrc0 && !!ssrc0.sourceHeight && ssrc0.direction === "out",

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@whereby.com/media",
   "description": "Media library for Whereby",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "license": "MIT",
   "homepage": "https://github.com/whereby/sdk",
   "repository": {