@signalapp/ringrtc 2.24.0 → 2.25.1

package/dist/ringrtc/Service.d.ts

@@ -4,8 +4,8 @@ declare class Config {
     use_new_audio_device_module: boolean;
     field_trials: Record<string, string> | undefined;
 }
-declare type GroupId = Buffer;
-declare type GroupCallUserId = Buffer;
+type GroupId = Buffer;
+type GroupCallUserId = Buffer;
 export declare class PeekDeviceInfo {
     demuxId: number;
     userId?: GroupCallUserId;
@@ -36,8 +36,8 @@ export declare class NetworkRoute {
     localAdapterType: NetworkAdapterType;
     constructor();
 }
-export declare type RawAudioLevel = number;
-export declare type NormalizedAudioLevel = number;
+export type RawAudioLevel = number;
+export type NormalizedAudioLevel = number;
 export declare class ReceivedAudioLevel {
     demuxId: number;
     level: RawAudioLevel;
@@ -194,13 +194,13 @@ export declare class Call {
     get remoteVideoEnabled(): boolean;
     set remoteVideoEnabled(enabled: boolean);
     sendVideoFrame(width: number, height: number, format: VideoPixelFormatEnum, buffer: Buffer): void;
-    receiveVideoFrame(buffer: Buffer): [number, number] | undefined;
+    receiveVideoFrame(buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
     private enableOrDisableCapturer;
     private setOutgoingVideoEnabled;
     updateBandwidthMode(bandwidthMode: BandwidthMode): void;
     private enableOrDisableRenderer;
 }
-export declare type GroupCallClientId = number;
+export type GroupCallClientId = number;
 export declare enum ConnectionState {
     NotConnected = 0,
     Connecting = 1,
@@ -340,14 +340,14 @@ declare class GroupCallVideoFrameSource {
     private readonly _groupCall;
     private readonly _remoteDemuxId;
     constructor(callManager: CallManager, groupCall: GroupCall, remoteDemuxId: number);
-    receiveVideoFrame(buffer: Buffer): [number, number] | undefined;
+    receiveVideoFrame(buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
 }
-declare type ProtobufBuffer = Buffer | {
+type ProtobufBuffer = Buffer | {
     toArrayBuffer: () => ArrayBuffer;
 };
-export declare type UserId = string;
-export declare type DeviceId = number;
-export declare type CallId = any;
+export type UserId = string;
+export type DeviceId = number;
+export type CallId = any;
 export declare class CallingMessage {
     offer?: OfferMessage;
     answer?: AnswerMessage;
@@ -400,9 +400,8 @@ export declare enum HangupType {
     NeedPermission = 4
 }
 export declare enum BandwidthMode {
-    VeryLow = 0,
-    Low = 1,
-    Normal = 2
+    Low = 0,
+    Normal = 1
 }
 export declare enum RingCancelReason {
     DeclinedByUser = 0,
@@ -424,7 +423,7 @@ export interface CallManager {
     setOutgoingVideoIsScreenShare(enabled: boolean): void;
     updateBandwidthMode(bandwidthMode: BandwidthMode): void;
     sendVideoFrame(width: number, height: number, format: VideoPixelFormatEnum, buffer: Buffer): void;
-    receiveVideoFrame(buffer: Buffer): [number, number] | undefined;
+    receiveVideoFrame(buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
     receivedOffer(remoteUserId: UserId, remoteDeviceId: DeviceId, messageAgeSec: number, callId: CallId, offerType: OfferType, localDeviceId: DeviceId, opaque: Buffer, senderIdentityKey: Buffer, receiverIdentityKey: Buffer): void;
     receivedAnswer(remoteUserId: UserId, remoteDeviceId: DeviceId, callId: CallId, opaque: Buffer, senderIdentityKey: Buffer, receiverIdentityKey: Buffer): void;
     receivedIceCandidates(remoteUserId: UserId, remoteDeviceId: DeviceId, callId: CallId, candidates: Array<Buffer>): void;
@@ -449,7 +448,7 @@ export interface CallManager {
     requestVideo(clientId: GroupCallClientId, resolutions: Array<VideoRequest>, activeSpeakerHeight: number): void;
     setGroupMembers(clientId: GroupCallClientId, members: Array<GroupMemberInfo>): void;
     setMembershipProof(clientId: GroupCallClientId, proof: Buffer): void;
-    receiveGroupCallVideoFrame(clientId: GroupCallClientId, remoteDemuxId: number, buffer: Buffer): [number, number] | undefined;
+    receiveGroupCallVideoFrame(clientId: GroupCallClientId, remoteDemuxId: number, buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
     peekGroupCall(requestId: number, sfu_url: string, membership_proof: Buffer, group_members: Array<GroupMemberInfo>): Promise<PeekInfo>;
     getAudioInputs(): AudioDevice[];
     setAudioInput(index: number): void;

package/dist/ringrtc/Service.js

@@ -5,7 +5,11 @@
 //
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -60,10 +64,21 @@ class NativeCallManager {
         const fieldTrialsString = Object.entries(config.field_trials || {})
             .map(([k, v]) => `${k}/${v}`)
             .join('/') + '/';
-        const callEndpoint = Native.createCallEndpoint(this, config.use_new_audio_device_module, fieldTrialsString);
         Object.defineProperty(this, Native.callEndpointPropertyKey, {
-            value: callEndpoint,
-            configurable: true, // allows it to be changed
+            configurable: true,
+            get() {
+                const callEndpoint = Native.createCallEndpoint(this, config.use_new_audio_device_module, fieldTrialsString);
+                if (process.platform === 'darwin') {
+                    // Preload devices to work around
+                    // https://bugs.chromium.org/p/chromium/issues/detail?id=1287628
+                    window.navigator.mediaDevices.enumerateDevices();
+                }
+                Object.defineProperty(this, Native.callEndpointPropertyKey, {
+                    configurable: true,
+                    value: callEndpoint,
+                });
+                return callEndpoint;
+            },
         });
     }
 }
@@ -225,6 +240,10 @@ class CallInfo {
     }
 }
 class RingRTCType {
+    getCallInfoKey(callId) {
+        // CallId is u64 so use a string key instead.
+        return callId.high.toString() + callId.low.toString();
+    }
     constructor() {
         // Set by UX
         this.handleOutgoingSignaling = null;
@@ -242,10 +261,6 @@ class RingRTCType {
         this._peekRequests = new Requests();
         this._callInfoByCallId = new Map();
     }
-    getCallInfoKey(callId) {
-        // CallId is u64 so use a string key instead.
-        return callId.high.toString() + callId.low.toString();
-    }
     setConfig(config) {
         this.callManager.setConfig(config);
     }
@@ -1021,13 +1036,13 @@ class Call {
     }
     // With this method, a Call is a VideoFrameSender
     sendVideoFrame(width, height, format, buffer) {
-        // This assumes we only have one active all.
+        // This assumes we only have one active call.
         this._callManager.sendVideoFrame(width, height, format, buffer);
     }
     // With this method, a Call is a VideoFrameSource
-    receiveVideoFrame(buffer) {
-        // This assumes we only have one active all.
-        return this._callManager.receiveVideoFrame(buffer);
+    receiveVideoFrame(buffer, maxWidth, maxHeight) {
+        // This assumes we only have one active call.
+        return this._callManager.receiveVideoFrame(buffer, maxWidth, maxHeight);
     }
     enableOrDisableCapturer() {
         if (!this._videoCapturer) {
@@ -1221,6 +1236,9 @@ class VideoRequest {
 }
 exports.VideoRequest = VideoRequest;
 class GroupCall {
+    get clientId() {
+        return this._clientId;
+    }
     // Called by UI via RingRTC object
     constructor(callManager, groupId, sfuUrl, hkdfExtraInfo, audioLevelsIntervalMillis, observer) {
         this._callManager = callManager;
@@ -1228,9 +1246,6 @@ class GroupCall {
         this._localDeviceState = new LocalDeviceState();
         this._clientId = this._callManager.createGroupCallClient(groupId, sfuUrl, hkdfExtraInfo, audioLevelsIntervalMillis || 0);
     }
-    get clientId() {
-        return this._clientId;
-    }
     // Called by UI
     connect() {
         this._callManager.connect(this._clientId);
@@ -1371,7 +1386,7 @@ class GroupCall {
     }
     // With this, a GroupCall is a VideoFrameSender
     sendVideoFrame(width, height, format, buffer) {
-        // This assumes we only have one active all.
+        // This assumes we only have one active call.
         this._callManager.sendVideoFrame(width, height, format, buffer);
     }
     // With this, a GroupCall can provide a VideoFrameSource for each remote device.
@@ -1397,9 +1412,9 @@ class GroupCallVideoFrameSource {
         this._groupCall = groupCall;
         this._remoteDemuxId = remoteDemuxId;
     }
-    receiveVideoFrame(buffer) {
-        // This assumes we only have one active all.
-        const frame = this._callManager.receiveGroupCallVideoFrame(this._groupCall.clientId, this._remoteDemuxId, buffer);
+    receiveVideoFrame(buffer, maxWidth, maxHeight) {
+        // This assumes we only have one active call.
+        const frame = this._callManager.receiveGroupCallVideoFrame(this._groupCall.clientId, this._remoteDemuxId, buffer, maxWidth, maxHeight);
         if (!!frame) {
             const [width, height] = frame;
             this._groupCall.setRemoteAspectRatio(this._remoteDemuxId, width / height);
@@ -1452,9 +1467,8 @@ var HangupType;
 })(HangupType = exports.HangupType || (exports.HangupType = {}));
 var BandwidthMode;
 (function (BandwidthMode) {
-    BandwidthMode[BandwidthMode["VeryLow"] = 0] = "VeryLow";
-    BandwidthMode[BandwidthMode["Low"] = 1] = "Low";
-    BandwidthMode[BandwidthMode["Normal"] = 2] = "Normal";
+    BandwidthMode[BandwidthMode["Low"] = 0] = "Low";
+    BandwidthMode[BandwidthMode["Normal"] = 1] = "Normal";
 })(BandwidthMode = exports.BandwidthMode || (exports.BandwidthMode = {}));
 /// Describes why a ring was cancelled.
 var RingCancelReason;

package/dist/ringrtc/VideoSupport.d.ts

@@ -8,7 +8,17 @@ export declare enum VideoPixelFormatEnum {
     Rgba = 2
 }
 export interface VideoFrameSource {
-    receiveVideoFrame(buffer: Buffer): [number, number] | undefined;
+    /**
+     * Copies the latest frame into `buffer`.
+     *
+     * Note that `maxWidth` and `maxHeight` specify maximum dimensions,
+     * but allow for rotation, i.e. a maximum of 1920x1080 will also allow
+     * portrait-mode 1080x1920.
+     *
+     * Returns a `[width, height]` pair for the resulting frame,
+     * or `undefined` if there's no new frame ready to be displayed.
+     */
+    receiveVideoFrame(buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
 }
 interface VideoFrameSender {
     sendVideoFrame(width: number, height: number, format: VideoPixelFormatEnum, buffer: Buffer): void;

package/dist/ringrtc/VideoSupport.js

@@ -376,7 +376,7 @@ class CanvasVideoRenderer {
         if (!context) {
             return;
         }
-        const frame = this.source.receiveVideoFrame(this.buffer);
+        const frame = this.source.receiveVideoFrame(this.buffer, exports.MAX_VIDEO_CAPTURE_WIDTH, exports.MAX_VIDEO_CAPTURE_HEIGHT);
         if (!frame) {
             return;
         }

package/dist/test/CallingClass.js

@@ -23,6 +23,12 @@ const long_1 = __importDefault(require("long"));
 const Utils_1 = require("./Utils");
 // This class mimics the Desktop Client CallingClass in ts/services/calling.ts to facilitate testing
 class CallingClass {
+    set delayIncomingCallSettingsRequest(value) {
+        this._delayIncomingCallSettingsRequest = value;
+    }
+    set delayOutgoingCallSettingsRequest(value) {
+        this._delayIncomingCallSettingsRequest = value;
+    }
     constructor(name, id) {
         this._name = name;
         this._id = id;
@@ -30,12 +36,6 @@ class CallingClass {
         this._delayIncomingCallSettingsRequest = 0;
         this._delayOutgoingCallSettingsRequest = 0;
     }
-    set delayIncomingCallSettingsRequest(value) {
-        this._delayIncomingCallSettingsRequest = value;
-    }
-    set delayOutgoingCallSettingsRequest(value) {
-        this._delayIncomingCallSettingsRequest = value;
-    }
     setupCallCallbacks(call) {
         // eslint-disable-next-line no-param-reassign
         call.handleStateChanged = () => __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/ringrtc",
-  "version": "2.24.0",
+  "version": "2.25.1",
   "description": "Signal Messenger voice and video calling library.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -11,7 +11,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf dist",
-    "test": "electron-mocha --recursive dist/test --timeout 10000",
+    "test": "electron-mocha --renderer --recursive dist/test --timeout 10000",
     "eslint": "eslint --cache .",
     "lint": "yarn format --list-different && yarn eslint",
     "format": "prettier --write \"*.{css,js,json,md,scss,ts,tsx}\" \"./**/*.{css,js,json,md,scss,ts,tsx}\"",
@@ -20,7 +20,7 @@
   },
   "config": {
     "prebuildUrl": "https://build-artifacts.signal.org/libraries/ringrtc-desktop-build-v${npm_package_version}.tar.gz",
-    "prebuildChecksum": "7f7f7a795d4387d59e5262c6a3b8efb910f2d3f9c60a18316e49bb9a29d65343"
+    "prebuildChecksum": "eea4b238619ac1c259b703d7c66a57b6436ea63496fff03a0dd407b410507700"
   },
   "author": "",
   "license": "AGPL-3.0-only",
@@ -28,33 +28,33 @@
     "tar": "^6.1.0"
   },
   "devDependencies": {
-    "@types/chai": "4.2.18",
-    "@types/chai-as-promised": "^7.1.3",
-    "@types/dom-mediacapture-transform": "0.1.2",
-    "@types/long": "4.0.1",
-    "@types/mocha": "5.2.7",
-    "@types/node": "14.14.37",
-    "@types/offscreencanvas": "^2019.6.4",
-    "@types/react": "16.8.5",
+    "@types/chai": "4.3.4",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/dom-mediacapture-transform": "0.1.4",
+    "@types/long": "5.0.0",
+    "@types/mocha": "10.0.1",
+    "@types/node": "18.14.0",
+    "@types/offscreencanvas": "^2019.7.0",
+    "@types/react": "18.0.28",
     "@types/sinon-chai": "^3.2.9",
-    "chai": "4.3.5",
+    "chai": "4.3.7",
     "chai-as-promised": "^7.1.1",
-    "electron": "15.3.2",
+    "electron": "22.2.0",
     "electron-mocha": "11.0.2",
-    "eslint": "7.32.0",
-    "eslint-config-airbnb-typescript-prettier": "4.2.0",
-    "eslint-config-prettier": "6.15.0",
-    "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-mocha": "9.0.0",
+    "eslint": "8.34.0",
+    "eslint-config-airbnb-typescript-prettier": "5.0.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-mocha": "10.1.0",
     "eslint-plugin-more": "1.0.5",
-    "eslint-plugin-react": "7.28.0",
-    "long": "4.0.0",
-    "mocha": "9.2.0",
-    "prettier": "^2.5.1",
-    "rimraf": "3.0.2",
+    "eslint-plugin-react": "7.32.2",
+    "long": "5.2.1",
+    "mocha": "10.2.0",
+    "prettier": "^2.8.4",
+    "rimraf": "4.1.2",
     "sinon": "^15.0.1",
     "sinon-chai": "^3.7.0",
-    "typescript": "4.5.2",
-    "yarn-audit-fix": "^9.2.2"
+    "typescript": "4.9.3",
+    "yarn-audit-fix": "^9.3.9"
   }
 }