@signalapp/ringrtc 2.50.5 → 2.51.0

package/dist/acknowledgments.md

@@ -669,7 +669,7 @@ For more information on this, and how to apply and follow the GNU AGPL, see
 
 ```
 
-## libsignal-account-keys 0.1.0, libsignal-core 0.1.0, mrp 2.50.5, protobuf 2.50.5, ringrtc 2.50.5, regex-aot 0.1.0, partial-default-derive 0.1.0
+## libsignal-account-keys 0.1.0, libsignal-core 0.1.0, mrp 2.51.0, protobuf 2.51.0, ringrtc 2.51.0, regex-aot 0.1.0, partial-default-derive 0.1.0
 
 ```
 GNU AFFERO GENERAL PUBLIC LICENSE

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { RingRTCType } from './ringrtc/Service';
-export { AnswerMessage, AudioDevice, DataMode, BusyMessage, Call, CallEndedReason, CallId, CallLogLevel, CallMessageUrgency, CallSettings, CallState, CallingMessage, ConnectionState, DeviceId, GroupCall, GroupCallEndReason, GroupCallKind, GroupCallObserver, GroupMemberInfo, HangupMessage, HangupType, HttpMethod, HttpResult, IceCandidateMessage, JoinState, LocalDeviceState, OfferMessage, OfferType, OpaqueMessage, PeekDeviceInfo, PeekInfo, PeekStatusCodes, Reaction, RemoteDeviceState, RingCancelReason, RingRTCType, RingUpdate, SpeechEvent, UserId, VideoCapturer, VideoRenderer, VideoRequest, callIdFromEra, callIdFromRingId, } from './ringrtc/Service';
-export { CanvasVideoRenderer, GumVideoCapturer, VideoFrameSource, MAX_VIDEO_CAPTURE_AREA, MAX_VIDEO_CAPTURE_BUFFER_SIZE, MAX_VIDEO_CAPTURE_HEIGHT, MAX_VIDEO_CAPTURE_WIDTH, } from './ringrtc/VideoSupport';
+export { AnswerMessage, AudioDevice, DataMode, BusyMessage, Call, CallEndedReason, CallId, CallLogLevel, CallMessageUrgency, CallSettings, CallState, CallingMessage, ConnectionState, DeviceId, GroupCall, GroupCallEndReason, GroupCallKind, GroupCallObserver, GroupMemberInfo, HangupMessage, HangupType, HttpMethod, HttpResult, IceCandidateMessage, JoinState, LocalDeviceState, OfferMessage, OfferType, OpaqueMessage, PeekDeviceInfo, PeekInfo, PeekStatusCodes, Reaction, RemoteDeviceState, RingCancelReason, RingRTCType, RingUpdate, SpeechEvent, UserId, VideoFrameSender, VideoFrameSource, VideoPixelFormatEnum, videoPixelFormatToEnum, VideoRequest, callIdFromEra, callIdFromRingId, } from './ringrtc/Service';
 export { CallLinkRootKey, CallLinkRestrictions, CallLinkState, } from './ringrtc/CallLinks';
 export declare const RingRTC: RingRTCType;

package/dist/index.js

@@ -4,7 +4,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RingRTC = exports.CallLinkState = exports.CallLinkRestrictions = exports.CallLinkRootKey = exports.MAX_VIDEO_CAPTURE_WIDTH = exports.MAX_VIDEO_CAPTURE_HEIGHT = exports.MAX_VIDEO_CAPTURE_BUFFER_SIZE = exports.MAX_VIDEO_CAPTURE_AREA = exports.GumVideoCapturer = exports.CanvasVideoRenderer = exports.callIdFromRingId = exports.callIdFromEra = exports.VideoRequest = exports.SpeechEvent = exports.RingUpdate = exports.RingRTCType = exports.RingCancelReason = exports.RemoteDeviceState = exports.PeekStatusCodes = exports.OpaqueMessage = exports.OfferType = exports.OfferMessage = exports.LocalDeviceState = exports.JoinState = exports.IceCandidateMessage = exports.HttpMethod = exports.HangupType = exports.HangupMessage = exports.GroupMemberInfo = exports.GroupCallKind = exports.GroupCallEndReason = exports.GroupCall = exports.ConnectionState = exports.CallingMessage = exports.CallState = exports.CallMessageUrgency = exports.CallLogLevel = exports.CallEndedReason = exports.Call = exports.BusyMessage = exports.DataMode = exports.AnswerMessage = void 0;
+exports.RingRTC = exports.CallLinkState = exports.CallLinkRestrictions = exports.CallLinkRootKey = exports.callIdFromRingId = exports.callIdFromEra = exports.VideoRequest = exports.videoPixelFormatToEnum = exports.VideoPixelFormatEnum = exports.SpeechEvent = exports.RingUpdate = exports.RingRTCType = exports.RingCancelReason = exports.RemoteDeviceState = exports.PeekStatusCodes = exports.OpaqueMessage = exports.OfferType = exports.OfferMessage = exports.LocalDeviceState = exports.JoinState = exports.IceCandidateMessage = exports.HttpMethod = exports.HangupType = exports.HangupMessage = exports.GroupMemberInfo = exports.GroupCallKind = exports.GroupCallEndReason = exports.GroupCall = exports.ConnectionState = exports.CallingMessage = exports.CallState = exports.CallMessageUrgency = exports.CallLogLevel = exports.CallEndedReason = exports.Call = exports.BusyMessage = exports.DataMode = exports.AnswerMessage = void 0;
 const Service_1 = require("./ringrtc/Service");
 var Service_2 = require("./ringrtc/Service");
 Object.defineProperty(exports, "AnswerMessage", { enumerable: true, get: function () { return Service_2.AnswerMessage; } });
@@ -36,16 +36,11 @@ Object.defineProperty(exports, "RingCancelReason", { enumerable: true, get: func
 Object.defineProperty(exports, "RingRTCType", { enumerable: true, get: function () { return Service_2.RingRTCType; } });
 Object.defineProperty(exports, "RingUpdate", { enumerable: true, get: function () { return Service_2.RingUpdate; } });
 Object.defineProperty(exports, "SpeechEvent", { enumerable: true, get: function () { return Service_2.SpeechEvent; } });
+Object.defineProperty(exports, "VideoPixelFormatEnum", { enumerable: true, get: function () { return Service_2.VideoPixelFormatEnum; } });
+Object.defineProperty(exports, "videoPixelFormatToEnum", { enumerable: true, get: function () { return Service_2.videoPixelFormatToEnum; } });
 Object.defineProperty(exports, "VideoRequest", { enumerable: true, get: function () { return Service_2.VideoRequest; } });
 Object.defineProperty(exports, "callIdFromEra", { enumerable: true, get: function () { return Service_2.callIdFromEra; } });
 Object.defineProperty(exports, "callIdFromRingId", { enumerable: true, get: function () { return Service_2.callIdFromRingId; } });
-var VideoSupport_1 = require("./ringrtc/VideoSupport");
-Object.defineProperty(exports, "CanvasVideoRenderer", { enumerable: true, get: function () { return VideoSupport_1.CanvasVideoRenderer; } });
-Object.defineProperty(exports, "GumVideoCapturer", { enumerable: true, get: function () { return VideoSupport_1.GumVideoCapturer; } });
-Object.defineProperty(exports, "MAX_VIDEO_CAPTURE_AREA", { enumerable: true, get: function () { return VideoSupport_1.MAX_VIDEO_CAPTURE_AREA; } });
-Object.defineProperty(exports, "MAX_VIDEO_CAPTURE_BUFFER_SIZE", { enumerable: true, get: function () { return VideoSupport_1.MAX_VIDEO_CAPTURE_BUFFER_SIZE; } });
-Object.defineProperty(exports, "MAX_VIDEO_CAPTURE_HEIGHT", { enumerable: true, get: function () { return VideoSupport_1.MAX_VIDEO_CAPTURE_HEIGHT; } });
-Object.defineProperty(exports, "MAX_VIDEO_CAPTURE_WIDTH", { enumerable: true, get: function () { return VideoSupport_1.MAX_VIDEO_CAPTURE_WIDTH; } });
 var CallLinks_1 = require("./ringrtc/CallLinks");
 Object.defineProperty(exports, "CallLinkRootKey", { enumerable: true, get: function () { return CallLinks_1.CallLinkRootKey; } });
 Object.defineProperty(exports, "CallLinkRestrictions", { enumerable: true, get: function () { return CallLinks_1.CallLinkRestrictions; } });

package/dist/ringrtc/Service.d.ts

@@ -1,4 +1,3 @@
-import { GumVideoCaptureOptions, VideoPixelFormatEnum } from './VideoSupport';
 import { CallLinkState, CallLinkRestrictions, CallLinkRootKey } from './CallLinks';
 export declare const callIdFromEra: (era: string) => CallId;
 export declare function callIdFromRingId(ringId: bigint): CallId;
@@ -270,15 +269,10 @@ export declare class RingRTCType {
     sendCallMessageToGroup(groupId: Buffer, message: Buffer, urgency: CallMessageUrgency, overrideRecipients: Array<Buffer>): void;
     get call(): Call | null;
     getCall(callId: CallId): Call | null;
-    accept(callId: CallId, asVideoCall: boolean): void;
+    accept(callId: CallId): void;
     decline(callId: CallId): void;
     ignore(callId: CallId): void;
     hangup(callId: CallId): void;
-    setOutgoingAudio(callId: CallId, enabled: boolean): void;
-    setOutgoingVideo(callId: CallId, enabled: boolean): void;
-    setOutgoingVideoIsScreenShare(callId: CallId, isScreenShare: boolean): void;
-    setVideoCapturer(callId: CallId, capturer: VideoCapturer | null): void;
-    setVideoRenderer(callId: CallId, renderer: VideoRenderer | null): void;
     getAudioInputs(): Array<AudioDevice>;
     setAudioInput(index: number): void;
     getAudioOutputs(): Array<AudioDevice>;
@@ -303,14 +297,50 @@ export interface AudioDevice {
     uniqueId: string;
     i18nKey?: string;
 }
-export interface VideoCapturer {
-    enableCapture(): void;
-    enableCaptureAndSend(call: Call, captureOptions?: GumVideoCaptureOptions): void;
-    disable(): void;
+export declare enum VideoPixelFormatEnum {
+    I420 = 0,
+    Nv12 = 1,
+    Rgba = 2
+}
+export declare function videoPixelFormatToEnum(format: VideoPixelFormat): VideoPixelFormatEnum | undefined;
+/**
+ * Interface for sending video frames to the RingRTC library.
+ *
+ * VideoFrameSender is used to transmit video frames (from a camera or screen share) over
+ * RTP via the RingRTC library.
+ */
+export interface VideoFrameSender {
+    /**
+     * Sends a video frame to be transmitted via RingRTC.
+     *
+     * @param width - The width of the video frame in pixels
+     * @param height - The height of the video frame in pixels
+     * @param format - The pixel format of the video data
+     * @param buffer - Buffer containing the raw video frame data
+     */
+    sendVideoFrame(width: number, height: number, format: VideoPixelFormatEnum, buffer: Buffer): void;
 }
-export interface VideoRenderer {
-    enable(call: Call): void;
-    disable(): void;
+/**
+ * Interface for retrieving received video frames from the RingRTC library.
+ */
+export interface VideoFrameSource {
+    /**
+     * 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.
+     *
+     * @param buffer - The destination buffer where the frame will be copied
+     * @param maxWidth - Maximum width of the frame to receive
+     * @param maxHeight - Maximum height of the frame to receive
+     * @returns
+     *   A tuple of [width, height] of the received frame, containing:
+     *   - The width in pixels of the received frame
+     *   - The height in pixels of the received frame
+     *
+     *   Returns undefined if no new frame is available
+     */
+    receiveVideoFrame(buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
 }
 export declare class Call {
     private readonly _callManager;
@@ -319,6 +349,7 @@ export declare class Call {
     private readonly _isIncoming;
     private readonly _isVideoCall;
     private _state;
+    private _mediaSessionStarted;
     private _outgoingAudioEnabled;
     private _outgoingVideoEnabled;
     private _outgoingVideoIsScreenShare;
@@ -328,8 +359,6 @@ export declare class Call {
     remoteAudioLevel: NormalizedAudioLevel;
     remoteSharingScreen: boolean;
     networkRoute: NetworkRoute;
-    private _videoCapturer;
-    private _videoRenderer;
     endedReason?: CallEndedReason;
     handleStateChanged?: () => void;
     handleRemoteAudioEnabled?: () => void;
@@ -355,27 +384,20 @@ export declare class Call {
     get state(): CallState;
     set state(state: CallState);
     setCallEnded(): void;
-    set videoCapturer(capturer: VideoCapturer | null);
-    set videoRenderer(renderer: VideoRenderer | null);
     accept(): void;
     decline(): void;
     ignore(): void;
     hangup(): void;
-    get outgoingAudioEnabled(): boolean;
-    set outgoingAudioEnabled(enabled: boolean);
-    get outgoingVideoEnabled(): boolean;
-    set outgoingVideoEnabled(enabled: boolean);
-    set outgoingVideoIsScreenShare(isScreenShare: boolean);
     get remoteAudioEnabled(): boolean;
     set remoteAudioEnabled(enabled: boolean);
     get remoteVideoEnabled(): boolean;
     set remoteVideoEnabled(enabled: boolean);
+    setOutgoingAudioMuted(muted: boolean): void;
+    setOutgoingVideoMuted(muted: boolean): void;
+    setOutgoingVideoIsScreenShare(isScreenShare: boolean): void;
     sendVideoFrame(width: number, height: number, format: VideoPixelFormatEnum, buffer: Buffer): void;
     receiveVideoFrame(buffer: Buffer, maxWidth: number, maxHeight: number): [number, number] | undefined;
-    private enableOrDisableCapturer;
-    private setOutgoingVideoEnabled;
     updateDataMode(dataMode: DataMode): void;
-    private enableOrDisableRenderer;
 }
 export type GroupCallClientId = number;
 export declare enum ConnectionState {

package/dist/ringrtc/Service.js

@@ -7,8 +7,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CallLogLevel = exports.CallEndedReason = exports.CallState = exports.RingCancelReason = exports.DataMode = exports.HangupType = exports.OpaqueMessage = exports.HangupMessage = exports.BusyMessage = exports.IceCandidateMessage = exports.AnswerMessage = exports.OfferType = exports.OfferMessage = exports.CallingMessage = exports.GroupCall = exports.GroupCallKind = exports.VideoRequest = exports.GroupMemberInfo = exports.RemoteDeviceState = exports.LocalDeviceState = exports.HttpMethod = exports.RingUpdate = exports.CallMessageUrgency = exports.SpeechEvent = exports.GroupCallEndReason = exports.JoinState = exports.ConnectionState = exports.Call = exports.RingRTCType = exports.ReceivedAudioLevel = exports.NetworkRoute = exports.PeekStatusCodes = exports.callIdFromEra = void 0;
+exports.CallLogLevel = exports.CallEndedReason = exports.CallState = exports.RingCancelReason = exports.DataMode = exports.HangupType = exports.OpaqueMessage = exports.HangupMessage = exports.BusyMessage = exports.IceCandidateMessage = exports.AnswerMessage = exports.OfferType = exports.OfferMessage = exports.CallingMessage = exports.GroupCall = exports.GroupCallKind = exports.VideoRequest = exports.GroupMemberInfo = exports.RemoteDeviceState = exports.LocalDeviceState = exports.HttpMethod = exports.RingUpdate = exports.CallMessageUrgency = exports.SpeechEvent = exports.GroupCallEndReason = exports.JoinState = exports.ConnectionState = exports.Call = exports.VideoPixelFormatEnum = exports.RingRTCType = exports.ReceivedAudioLevel = exports.NetworkRoute = exports.PeekStatusCodes = exports.callIdFromEra = void 0;
 exports.callIdFromRingId = callIdFromRingId;
+exports.videoPixelFormatToEnum = videoPixelFormatToEnum;
+/* eslint-disable max-classes-per-file */
 const CallLinks_1 = require("./CallLinks");
 const Native_1 = __importDefault(require("./Native"));
 const INVALID_CLIENT_ID = 0;
@@ -287,7 +289,6 @@ class RingRTCType {
         const isIncoming = false;
         const call = new Call(this.callManager, remoteUserId, callId, isIncoming, isVideoCall, CallState.Prering);
         this._call = call;
-        call.outgoingVideoEnabled = isVideoCall;
         return call;
     }
     // Called by UX
@@ -1111,14 +1112,12 @@ class RingRTCType {
         }
         return null;
     }
-    accept(callId, asVideoCall) {
+    accept(callId) {
         const call = this.getCall(callId);
         if (!call) {
             return;
         }
         call.accept();
-        call.outgoingAudioEnabled = true;
-        call.outgoingVideoEnabled = asVideoCall;
     }
     decline(callId) {
         const call = this.getCall(callId);
@@ -1141,41 +1140,6 @@ class RingRTCType {
         }
         call.hangup();
     }
-    setOutgoingAudio(callId, enabled) {
-        const call = this.getCall(callId);
-        if (!call) {
-            return;
-        }
-        call.outgoingAudioEnabled = enabled;
-    }
-    setOutgoingVideo(callId, enabled) {
-        const call = this.getCall(callId);
-        if (!call) {
-            return;
-        }
-        call.outgoingVideoEnabled = enabled;
-    }
-    setOutgoingVideoIsScreenShare(callId, isScreenShare) {
-        const call = this.getCall(callId);
-        if (!call) {
-            return;
-        }
-        call.outgoingVideoIsScreenShare = isScreenShare;
-    }
-    setVideoCapturer(callId, capturer) {
-        const call = this.getCall(callId);
-        if (!call) {
-            return;
-        }
-        call.videoCapturer = capturer;
-    }
-    setVideoRenderer(callId, renderer) {
-        const call = this.getCall(callId);
-        if (!call) {
-            return;
-        }
-        call.videoRenderer = renderer;
-    }
     getAudioInputs() {
         return this.callManager.getAudioInputs();
     }
@@ -1190,8 +1154,30 @@ class RingRTCType {
     }
 }
 exports.RingRTCType = RingRTCType;
+// Given a weird name to not conflict with WebCodec's VideoPixelFormat
+var VideoPixelFormatEnum;
+(function (VideoPixelFormatEnum) {
+    VideoPixelFormatEnum[VideoPixelFormatEnum["I420"] = 0] = "I420";
+    VideoPixelFormatEnum[VideoPixelFormatEnum["Nv12"] = 1] = "Nv12";
+    VideoPixelFormatEnum[VideoPixelFormatEnum["Rgba"] = 2] = "Rgba";
+})(VideoPixelFormatEnum || (exports.VideoPixelFormatEnum = VideoPixelFormatEnum = {}));
+function videoPixelFormatToEnum(format) {
+    switch (format) {
+        case 'I420': {
+            return VideoPixelFormatEnum.I420;
+        }
+        case 'NV12': {
+            return VideoPixelFormatEnum.Nv12;
+        }
+        case 'RGBA': {
+            return VideoPixelFormatEnum.Rgba;
+        }
+    }
+}
 class Call {
     constructor(callManager, remoteUserId, callId, isIncoming, isVideoCall, state) {
+        // Media state flags.
+        this._mediaSessionStarted = false;
         this._outgoingAudioEnabled = false;
         this._outgoingVideoEnabled = false;
         this._outgoingVideoIsScreenShare = false;
@@ -1201,8 +1187,6 @@ class Call {
         this.remoteAudioLevel = 0;
         this.remoteSharingScreen = false;
         this.networkRoute = new NetworkRoute();
-        this._videoCapturer = null;
-        this._videoRenderer = null;
         this._callManager = callManager;
         this._remoteUserId = remoteUserId;
         this.callId = callId;
@@ -1228,11 +1212,39 @@ class Call {
         }
         this._state = state;
         if (state === CallState.Accepted) {
-            // Make sure the status gets sent.
-            this.outgoingAudioEnabled = this._outgoingAudioEnabled;
+            // We might have been in the reconnecting state and already started media.
+            if (!this._mediaSessionStarted) {
+                sillyDeadlockProtection(() => {
+                    if (this._outgoingAudioEnabled) {
+                        this._callManager.setOutgoingAudioEnabled(true);
+                    }
+                    if (this._outgoingVideoIsScreenShare) {
+                        this._callManager.setOutgoingVideoIsScreenShare(true);
+                        this._callManager.setOutgoingVideoEnabled(true);
+                    }
+                    else if (this._outgoingVideoEnabled) {
+                        this._callManager.setOutgoingVideoEnabled(true);
+                    }
+                });
+                this._mediaSessionStarted = true;
+            }
+        }
+        else if (state === CallState.Ended) {
+            if (this._mediaSessionStarted) {
+                sillyDeadlockProtection(() => {
+                    if (this._outgoingAudioEnabled) {
+                        this._callManager.setOutgoingAudioEnabled(false);
+                    }
+                    if (this._outgoingVideoEnabled) {
+                        this._callManager.setOutgoingVideoEnabled(false);
+                    }
+                });
+                this._outgoingAudioEnabled = false;
+                this._outgoingVideoEnabled = false;
+                this._outgoingVideoIsScreenShare = false;
+                this._mediaSessionStarted = false;
+            }
         }
-        this.enableOrDisableCapturer();
-        this.enableOrDisableRenderer();
         if (this.handleStateChanged) {
             this.handleStateChanged();
         }
@@ -1240,14 +1252,6 @@ class Call {
     setCallEnded() {
         this._state = CallState.Ended;
     }
-    set videoCapturer(capturer) {
-        this._videoCapturer = capturer;
-        this.enableOrDisableCapturer();
-    }
-    set videoRenderer(renderer) {
-        this._videoRenderer = renderer;
-        this.enableOrDisableRenderer();
-    }
     accept() {
         this._callManager.accept(this.callId);
     }
@@ -1258,43 +1262,10 @@ class Call {
         this._callManager.ignore(this.callId);
     }
     hangup() {
-        // This is a little faster than waiting for the
-        // change in call state to come back.
-        if (this._videoCapturer) {
-            this._videoCapturer.disable();
-        }
-        if (this._videoRenderer) {
-            this._videoRenderer.disable();
-        }
-        // This assumes we only have one active call.
         sillyDeadlockProtection(() => {
             this._callManager.hangup();
         });
     }
-    get outgoingAudioEnabled() {
-        return this._outgoingAudioEnabled;
-    }
-    set outgoingAudioEnabled(enabled) {
-        this._outgoingAudioEnabled = enabled;
-        // This assumes we only have one active call.
-        sillyDeadlockProtection(() => {
-            this._callManager.setOutgoingAudioEnabled(enabled);
-        });
-    }
-    get outgoingVideoEnabled() {
-        return this._outgoingVideoEnabled;
-    }
-    set outgoingVideoEnabled(enabled) {
-        this._outgoingVideoEnabled = enabled;
-        this.enableOrDisableCapturer();
-    }
-    set outgoingVideoIsScreenShare(isScreenShare) {
-        // This assumes we only have one active call.
-        this._outgoingVideoIsScreenShare = isScreenShare;
-        sillyDeadlockProtection(() => {
-            this._callManager.setOutgoingVideoIsScreenShare(isScreenShare);
-        });
-    }
     get remoteAudioEnabled() {
         return this._remoteAudioEnabled;
     }
@@ -1306,63 +1277,51 @@ class Call {
     }
     set remoteVideoEnabled(enabled) {
         this._remoteVideoEnabled = enabled;
-        this.enableOrDisableRenderer();
+    }
+    setOutgoingAudioMuted(muted) {
+        const enabled = !muted;
+        if (this._mediaSessionStarted && this._outgoingAudioEnabled !== enabled) {
+            this._outgoingAudioEnabled = enabled;
+            sillyDeadlockProtection(() => {
+                this._callManager.setOutgoingAudioEnabled(enabled);
+            });
+        }
+        else {
+            this._outgoingAudioEnabled = enabled;
+        }
+    }
+    setOutgoingVideoMuted(muted) {
+        const enabled = !muted;
+        if (this._mediaSessionStarted && this._outgoingVideoEnabled !== enabled) {
+            this._outgoingVideoEnabled = enabled;
+            sillyDeadlockProtection(() => {
+                this._callManager.setOutgoingVideoEnabled(enabled);
+            });
+        }
+        else {
+            this._outgoingVideoEnabled = enabled;
+        }
+    }
+    setOutgoingVideoIsScreenShare(isScreenShare) {
+        if (this._mediaSessionStarted &&
+            this._outgoingVideoIsScreenShare !== isScreenShare) {
+            this._outgoingVideoIsScreenShare = isScreenShare;
+            sillyDeadlockProtection(() => {
+                this._callManager.setOutgoingVideoIsScreenShare(isScreenShare);
+            });
+        }
+        else {
+            this._outgoingVideoIsScreenShare = isScreenShare;
+        }
     }
     // With this method, a Call is a VideoFrameSender
     sendVideoFrame(width, height, format, buffer) {
-        // 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, maxWidth, maxHeight) {
-        // This assumes we only have one active call.
         return this._callManager.receiveVideoFrame(buffer, maxWidth, maxHeight);
     }
-    enableOrDisableCapturer() {
-        if (!this._videoCapturer) {
-            return;
-        }
-        if (!this.outgoingVideoEnabled) {
-            this._videoCapturer.disable();
-            if (this.state === CallState.Accepted) {
-                this.setOutgoingVideoEnabled(false);
-            }
-            return;
-        }
-        switch (this.state) {
-            case CallState.Prering:
-            case CallState.Ringing:
-                this._videoCapturer.enableCapture();
-                break;
-            case CallState.Accepted:
-                this._videoCapturer.enableCaptureAndSend(this);
-                this.setOutgoingVideoEnabled(true);
-                if (this._outgoingVideoIsScreenShare) {
-                    // Make sure the status gets sent.
-                    this.outgoingVideoIsScreenShare = true;
-                }
-                break;
-            case CallState.Reconnecting:
-                this._videoCapturer.enableCaptureAndSend(this);
-                // Don't send status until we're reconnected.
-                break;
-            case CallState.Ended:
-                this._videoCapturer.disable();
-                break;
-            default:
-        }
-    }
-    setOutgoingVideoEnabled(enabled) {
-        sillyDeadlockProtection(() => {
-            try {
-                this._callManager.setOutgoingVideoEnabled(enabled);
-            }
-            catch {
-                // We may not have an active connection any more.
-                // In which case it doesn't matter
-            }
-        });
-    }
     updateDataMode(dataMode) {
         sillyDeadlockProtection(() => {
             try {
@@ -1374,29 +1333,6 @@ class Call {
             }
         });
     }
-    enableOrDisableRenderer() {
-        if (!this._videoRenderer) {
-            return;
-        }
-        if (!this.remoteVideoEnabled) {
-            this._videoRenderer.disable();
-            return;
-        }
-        switch (this.state) {
-            case CallState.Prering:
-            case CallState.Ringing:
-                this._videoRenderer.disable();
-                break;
-            case CallState.Accepted:
-            case CallState.Reconnecting:
-                this._videoRenderer.enable(this);
-                break;
-            case CallState.Ended:
-                this._videoRenderer.disable();
-                break;
-            default:
-        }
-    }
 }
 exports.Call = Call;
 // Represents the connection state to a media server for a group call.
@@ -1722,7 +1658,6 @@ class GroupCall {
     }
     // With this, a GroupCall is a VideoFrameSender
     sendVideoFrame(width, height, format, buffer) {
-        // 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.
@@ -1745,7 +1680,6 @@ class GroupCall {
     }
 }
 exports.GroupCall = GroupCall;
-// Implements VideoSource for use in CanvasVideoRenderer
 class GroupCallVideoFrameSource {
     constructor(callManager, groupCall, remoteDemuxId // Uint32
     ) {
@@ -1754,7 +1688,6 @@ class GroupCallVideoFrameSource {
         this._remoteDemuxId = remoteDemuxId;
     }
     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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/ringrtc",
-  "version": "2.50.5",
+  "version": "2.51.0",
   "description": "Signal Messenger voice and video calling library.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
   },
   "config": {
     "prebuildUrl": "https://build-artifacts.signal.org/libraries/ringrtc-desktop-build-v${npm_package_version}.tar.gz",
-    "prebuildChecksum": "dd146af89b530b86ff42bd6546f96371266fd6226e280fcc7c62fb11fbe7afcd"
+    "prebuildChecksum": "77621836d3b47b8a4a5ba81941b9bdf1f27e9b70187ca2b00e8e467d0292f137"
   },
   "author": "",
   "license": "AGPL-3.0-only",
@@ -36,11 +36,9 @@
   "devDependencies": {
     "@types/chai": "4.3.16",
     "@types/chai-as-promised": "^7.1.4",
-    "@types/dom-mediacapture-transform": "0.1.10",
     "@types/lodash": "^4.14.106",
     "@types/mocha": "10.0.9",
     "@types/node": "20.17.6",
-    "@types/offscreencanvas": "^2019.7.3",
     "@types/sinon-chai": "^3.2.12",
     "chai": "4.4.1",
     "chai-as-promised": "^7.1.1",

package/dist/ringrtc/VideoSupport.d.ts

@@ -1,77 +0,0 @@
-interface Ref<T> {
-    readonly current: T | null;
-}
-export declare enum VideoPixelFormatEnum {
-    I420 = 0,
-    Nv12 = 1,
-    Rgba = 2
-}
-export interface VideoFrameSource {
-    /**
-     * 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;
-}
-export declare class GumVideoCaptureOptions {
-    maxWidth: number;
-    maxHeight: number;
-    maxFramerate: number;
-    preferredDeviceId?: string;
-    screenShareSourceId?: string;
-    mediaStream?: MediaStream;
-    onEnded?: () => void;
-}
-export declare class GumVideoCapturer {
-    private defaultCaptureOptions;
-    private localPreview?;
-    private captureOptions?;
-    private sender?;
-    private mediaStream?;
-    private spawnedSenderRunning;
-    private preferredDeviceId?;
-    private updateLocalPreviewIntervalId?;
-    constructor(defaultCaptureOptions: GumVideoCaptureOptions);
-    capturing(): boolean;
-    setLocalPreview(localPreview: Ref<HTMLVideoElement> | undefined): void;
-    enableCapture(options?: GumVideoCaptureOptions): Promise<void>;
-    enableCaptureAndSend(sender?: VideoFrameSender, options?: GumVideoCaptureOptions): Promise<void>;
-    disable(): void;
-    setPreferredDevice(deviceId: string): Promise<void>;
-    enumerateDevices(): Promise<Array<MediaDeviceInfo>>;
-    private getUserMedia;
-    private startCapturing;
-    private stopCapturing;
-    private startSending;
-    private spawnSender;
-    private stopSending;
-    private updateLocalPreviewSourceObject;
-}
-export declare const MAX_VIDEO_CAPTURE_WIDTH: number;
-export declare const MAX_VIDEO_CAPTURE_HEIGHT: number;
-export declare const MAX_VIDEO_CAPTURE_AREA: number;
-export declare const MAX_VIDEO_CAPTURE_BUFFER_SIZE: number;
-export declare class CanvasVideoRenderer {
-    private canvas?;
-    private buffer;
-    private imageData?;
-    private source?;
-    private rafId?;
-    constructor();
-    setCanvas(canvas: Ref<HTMLCanvasElement> | undefined): void;
-    enable(source: VideoFrameSource): void;
-    disable(): void;
-    private requestAnimationFrameCallback;
-    private renderBlack;
-    private renderVideoFrame;
-}
-export {};

package/dist/ringrtc/VideoSupport.js

@@ -1,433 +0,0 @@
-"use strict";
-//
-// Copyright 2019-2021 Signal Messenger, LLC
-// SPDX-License-Identifier: AGPL-3.0-only
-//
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CanvasVideoRenderer = exports.MAX_VIDEO_CAPTURE_BUFFER_SIZE = exports.MAX_VIDEO_CAPTURE_AREA = exports.MAX_VIDEO_CAPTURE_HEIGHT = exports.MAX_VIDEO_CAPTURE_WIDTH = exports.GumVideoCapturer = exports.GumVideoCaptureOptions = exports.VideoPixelFormatEnum = void 0;
-const index_1 = require("../index");
-// Given a weird name to not conflict with WebCodec's VideoPixelFormat
-var VideoPixelFormatEnum;
-(function (VideoPixelFormatEnum) {
-    VideoPixelFormatEnum[VideoPixelFormatEnum["I420"] = 0] = "I420";
-    VideoPixelFormatEnum[VideoPixelFormatEnum["Nv12"] = 1] = "Nv12";
-    VideoPixelFormatEnum[VideoPixelFormatEnum["Rgba"] = 2] = "Rgba";
-})(VideoPixelFormatEnum || (exports.VideoPixelFormatEnum = VideoPixelFormatEnum = {}));
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-function videoPixelFormatFromEnum(format) {
-    switch (format) {
-        case VideoPixelFormatEnum.I420: {
-            return 'I420';
-        }
-        case VideoPixelFormatEnum.Nv12: {
-            return 'NV12';
-        }
-        case VideoPixelFormatEnum.Rgba: {
-            return 'RGBA';
-        }
-    }
-}
-function videoPixelFormatToEnum(format) {
-    switch (format) {
-        case 'I420': {
-            return VideoPixelFormatEnum.I420;
-        }
-        case 'NV12': {
-            return VideoPixelFormatEnum.Nv12;
-        }
-        case 'RGBA': {
-            return VideoPixelFormatEnum.Rgba;
-        }
-    }
-}
-class GumVideoCaptureOptions {
-    constructor() {
-        this.maxWidth = 640;
-        this.maxHeight = 480;
-        this.maxFramerate = 30;
-    }
-}
-exports.GumVideoCaptureOptions = GumVideoCaptureOptions;
-class GumVideoCapturer {
-    constructor(defaultCaptureOptions) {
-        this.spawnedSenderRunning = false;
-        this.defaultCaptureOptions = defaultCaptureOptions;
-    }
-    capturing() {
-        return this.captureOptions != undefined;
-    }
-    setLocalPreview(localPreview) {
-        const oldLocalPreview = this.localPreview?.current;
-        if (oldLocalPreview) {
-            oldLocalPreview.srcObject = null;
-        }
-        this.localPreview = localPreview;
-        this.updateLocalPreviewSourceObject();
-        // This is a dumb hack around the fact that sometimes the
-        // this.localPreview.current is updated without a call
-        // to setLocalPreview, in which case the local preview
-        // won't be rendered.
-        if (this.updateLocalPreviewIntervalId != undefined) {
-            clearInterval(this.updateLocalPreviewIntervalId);
-        }
-        this.updateLocalPreviewIntervalId = setInterval(this.updateLocalPreviewSourceObject.bind(this), 1000);
-    }
-    async enableCapture(options) {
-        return this.startCapturing(options ?? this.defaultCaptureOptions);
-    }
-    async enableCaptureAndSend(sender, options) {
-        const startCapturingPromise = this.startCapturing(options ?? this.defaultCaptureOptions);
-        if (sender) {
-            this.startSending(sender);
-        }
-        // Bubble up the error.
-        return startCapturingPromise;
-    }
-    disable() {
-        this.stopCapturing();
-        this.stopSending();
-        if (this.updateLocalPreviewIntervalId != undefined) {
-            clearInterval(this.updateLocalPreviewIntervalId);
-        }
-        this.updateLocalPreviewIntervalId = undefined;
-    }
-    // eslint-disable-next-line @typescript-eslint/require-await
-    async setPreferredDevice(deviceId) {
-        this.preferredDeviceId = deviceId;
-        if (this.captureOptions) {
-            const { captureOptions, sender } = this;
-            this.disable();
-            // Bubble up the error if starting video failed.
-            return this.enableCaptureAndSend(sender, captureOptions);
-        }
-    }
-    async enumerateDevices() {
-        const devices = await window.navigator.mediaDevices.enumerateDevices();
-        const cameras = devices.filter(d => d.kind == 'videoinput');
-        return cameras;
-    }
-    async getUserMedia(options) {
-        // Return provided media stream
-        if (options.mediaStream) {
-            return options.mediaStream;
-        }
-        const constraints = {
-            audio: false,
-            video: {
-                deviceId: options.preferredDeviceId ?? this.preferredDeviceId,
-                width: {
-                    max: options.maxWidth,
-                    ideal: options.maxWidth,
-                },
-                height: {
-                    max: options.maxHeight,
-                    ideal: options.maxHeight,
-                },
-                frameRate: {
-                    max: options.maxFramerate,
-                    ideal: options.maxFramerate,
-                },
-            },
-        };
-        if (options.screenShareSourceId != undefined) {
-            constraints.video = {
-                mandatory: {
-                    chromeMediaSource: 'desktop',
-                    chromeMediaSourceId: options.screenShareSourceId,
-                    maxWidth: options.maxWidth,
-                    maxHeight: options.maxHeight,
-                    minFrameRate: 1,
-                    maxFrameRate: options.maxFramerate,
-                },
-            };
-        }
-        return window.navigator.mediaDevices.getUserMedia(constraints);
-    }
-    async startCapturing(options) {
-        if (this.capturing()) {
-            index_1.RingRTC.logWarn('startCapturing(): already capturing');
-            return;
-        }
-        index_1.RingRTC.logInfo(`startCapturing(): ${options.maxWidth}x${options.maxHeight}@${options.maxFramerate}`);
-        this.captureOptions = options;
-        try {
-            // If we start/stop/start, we may have concurrent calls to getUserMedia,
-            // which is what we want if we're switching from camera to screenshare.
-            // But we need to make sure we deal with the fact that things might be
-            // different after the await here.
-            const mediaStream = await this.getUserMedia(options);
-            // It's possible video was disabled, switched to screenshare, or
-            // switched to a different camera while awaiting a response, in
-            // which case we need to disable the camera we just accessed.
-            if (this.captureOptions != options) {
-                index_1.RingRTC.logWarn('startCapturing(): different state after getUserMedia()');
-                for (const track of mediaStream.getVideoTracks()) {
-                    // Make the light turn off faster
-                    track.stop();
-                }
-                return;
-            }
-            if (this.mediaStream !== undefined &&
-                this.mediaStream.getVideoTracks().length > 0) {
-                // We have a stream and track for the requested camera already. Stop
-                // the duplicate track that we just started.
-                index_1.RingRTC.logWarn('startCapturing(): dropping duplicate call to startCapturing');
-                for (const track of mediaStream.getVideoTracks()) {
-                    track.stop();
-                }
-                return;
-            }
-            this.mediaStream = mediaStream;
-            if (!this.spawnedSenderRunning &&
-                this.mediaStream != undefined &&
-                this.sender != undefined) {
-                this.spawnSender(this.mediaStream, this.sender);
-            }
-            this.updateLocalPreviewSourceObject();
-        }
-        catch (e) {
-            index_1.RingRTC.logError(`startCapturing(): ${e}`);
-            // It's possible video was disabled, switched to screenshare, or
-            // switched to a different camera while awaiting a response, in
-            // which case we should reset the captureOptions if we set them.
-            if (this.captureOptions == options) {
-                // We couldn't open the camera.  Oh well.
-                this.captureOptions = undefined;
-            }
-            // Re-raise so that callers can surface this condition to the user.
-            throw e;
-        }
-    }
-    stopCapturing() {
-        if (!this.capturing()) {
-            index_1.RingRTC.logWarn('stopCapturing(): not capturing');
-            return;
-        }
-        index_1.RingRTC.logInfo('stopCapturing()');
-        this.captureOptions = undefined;
-        if (this.mediaStream) {
-            for (const track of this.mediaStream.getVideoTracks()) {
-                // Make the light turn off faster
-                track.stop();
-            }
-            this.mediaStream = undefined;
-        }
-        this.updateLocalPreviewSourceObject();
-    }
-    startSending(sender) {
-        if (this.sender === sender) {
-            return;
-        }
-        if (this.sender) {
-            // If we're replacing an existing sender, make sure we stop the
-            // current setInterval loop before starting another one.
-            this.stopSending();
-        }
-        this.sender = sender;
-        if (!this.spawnedSenderRunning && this.mediaStream != undefined) {
-            this.spawnSender(this.mediaStream, this.sender);
-        }
-    }
-    spawnSender(mediaStream, sender) {
-        const track = mediaStream.getVideoTracks()[0];
-        if (track == undefined || this.spawnedSenderRunning) {
-            return;
-        }
-        const captureOptions = this.captureOptions;
-        if (track.readyState === 'ended') {
-            this.stopCapturing();
-            index_1.RingRTC.logError('spawnSender(): Video track ended before spawning sender');
-            return;
-        }
-        const reader = new MediaStreamTrackProcessor({
-            track,
-        }).readable.getReader();
-        const buffer = Buffer.alloc(exports.MAX_VIDEO_CAPTURE_BUFFER_SIZE);
-        this.spawnedSenderRunning = true;
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        (async () => {
-            try {
-                while (mediaStream == this.mediaStream) {
-                    const { done, value: frame } = await reader.read();
-                    if (done) {
-                        break;
-                    }
-                    if (!frame) {
-                        continue;
-                    }
-                    try {
-                        const format = videoPixelFormatToEnum(frame.format ?? 'I420');
-                        if (format == undefined) {
-                            index_1.RingRTC.logWarn(`Unsupported video frame format: ${frame.format}`);
-                            break;
-                        }
-                        const visibleRect = frame.visibleRect;
-                        if (!visibleRect) {
-                            continue;
-                        }
-                        await frame.copyTo(buffer);
-                        if (sender !== this.sender) {
-                            break;
-                        }
-                        sender.sendVideoFrame(visibleRect.width, visibleRect.height, format, buffer);
-                    }
-                    catch (e) {
-                        index_1.RingRTC.logError(`sendVideoFrame(): ${e}`);
-                    }
-                    finally {
-                        // This must be called for more frames to come.
-                        frame.close();
-                    }
-                }
-            }
-            catch (e) {
-                index_1.RingRTC.logError(`spawnSender(): ${e}`);
-            }
-            finally {
-                reader.releaseLock();
-                captureOptions?.onEnded?.();
-            }
-            this.spawnedSenderRunning = false;
-        })();
-    }
-    stopSending() {
-        // The spawned sender should stop
-        this.sender = undefined;
-    }
-    updateLocalPreviewSourceObject() {
-        if (!this.localPreview) {
-            return;
-        }
-        const localPreview = this.localPreview.current;
-        if (!localPreview) {
-            return;
-        }
-        const { mediaStream = null } = this;
-        if (localPreview.srcObject === mediaStream) {
-            return;
-        }
-        if (mediaStream && this.captureOptions) {
-            localPreview.srcObject = mediaStream;
-            if (localPreview.width === 0) {
-                localPreview.width = this.captureOptions.maxWidth;
-            }
-            if (localPreview.height === 0) {
-                localPreview.height = this.captureOptions.maxHeight;
-            }
-        }
-        else {
-            localPreview.srcObject = null;
-        }
-    }
-}
-exports.GumVideoCapturer = GumVideoCapturer;
-// We add 10% in each dimension to allow for things that are slightly wider or taller than 1080p.
-const MAX_VIDEO_CAPTURE_MULTIPLIER = 1.0;
-exports.MAX_VIDEO_CAPTURE_WIDTH = 2880 * MAX_VIDEO_CAPTURE_MULTIPLIER;
-exports.MAX_VIDEO_CAPTURE_HEIGHT = 1800 * MAX_VIDEO_CAPTURE_MULTIPLIER;
-exports.MAX_VIDEO_CAPTURE_AREA = exports.MAX_VIDEO_CAPTURE_WIDTH * exports.MAX_VIDEO_CAPTURE_HEIGHT;
-exports.MAX_VIDEO_CAPTURE_BUFFER_SIZE = exports.MAX_VIDEO_CAPTURE_AREA * 4;
-class CanvasVideoRenderer {
-    constructor() {
-        this.buffer = Buffer.alloc(exports.MAX_VIDEO_CAPTURE_BUFFER_SIZE);
-    }
-    setCanvas(canvas) {
-        this.canvas = canvas;
-    }
-    enable(source) {
-        if (this.source === source) {
-            return;
-        }
-        if (this.source) {
-            // If we're replacing an existing source, make sure we stop the
-            // current rAF loop before starting another one.
-            if (this.rafId) {
-                window.cancelAnimationFrame(this.rafId);
-            }
-        }
-        this.source = source;
-        this.requestAnimationFrameCallback();
-    }
-    disable() {
-        this.renderBlack();
-        this.source = undefined;
-        if (this.rafId) {
-            window.cancelAnimationFrame(this.rafId);
-        }
-    }
-    requestAnimationFrameCallback() {
-        this.renderVideoFrame();
-        this.rafId = window.requestAnimationFrame(this.requestAnimationFrameCallback.bind(this));
-    }
-    renderBlack() {
-        if (!this.canvas) {
-            return;
-        }
-        const canvas = this.canvas.current;
-        if (!canvas) {
-            return;
-        }
-        const context = canvas.getContext('2d');
-        if (!context) {
-            return;
-        }
-        context.fillStyle = 'black';
-        context.fillRect(0, 0, canvas.width, canvas.height);
-    }
-    renderVideoFrame() {
-        if (!this.source || !this.canvas) {
-            return;
-        }
-        const canvas = this.canvas.current;
-        if (!canvas) {
-            return;
-        }
-        const context = canvas.getContext('2d');
-        if (!context) {
-            return;
-        }
-        const frame = this.source.receiveVideoFrame(this.buffer, exports.MAX_VIDEO_CAPTURE_WIDTH, exports.MAX_VIDEO_CAPTURE_HEIGHT);
-        if (!frame) {
-            return;
-        }
-        const [width, height] = frame;
-        if (canvas.clientWidth <= 0 ||
-            width <= 0 ||
-            canvas.clientHeight <= 0 ||
-            height <= 0) {
-            return;
-        }
-        const frameAspectRatio = width / height;
-        const canvasAspectRatio = canvas.clientWidth / canvas.clientHeight;
-        let dx = 0;
-        let dy = 0;
-        if (frameAspectRatio > canvasAspectRatio) {
-            // Frame wider than view: We need bars at the top and bottom
-            canvas.width = width;
-            canvas.height = width / canvasAspectRatio;
-            dy = (canvas.height - height) / 2;
-        }
-        else if (frameAspectRatio < canvasAspectRatio) {
-            // Frame narrower than view: We need pillars on the sides
-            canvas.width = height * canvasAspectRatio;
-            canvas.height = height;
-            dx = (canvas.width - width) / 2;
-        }
-        else {
-            // Will stretch perfectly with no bars
-            canvas.width = width;
-            canvas.height = height;
-        }
-        if (dx > 0 || dy > 0) {
-            context.fillStyle = 'black';
-            context.fillRect(0, 0, canvas.width, canvas.height);
-        }
-        if (this.imageData?.width !== width || this.imageData?.height !== height) {
-            this.imageData = new ImageData(width, height);
-        }
-        this.imageData.data.set(this.buffer.subarray(0, width * height * 4));
-        context.putImageData(this.imageData, dx, dy);
-    }
-}
-exports.CanvasVideoRenderer = CanvasVideoRenderer;
-//# sourceMappingURL=VideoSupport.js.map