werift 0.20.1 → 0.21.0

package/lib/webrtc/src/peerConnection.d.ts

@@ -10,7 +10,7 @@ import { RTCRtpReceiver } from "./media/rtpReceiver";
 import { RTCRtpSender } from "./media/rtpSender";
 import { type Direction, RTCRtpTransceiver, type TransceiverOptions } from "./media/rtpTransceiver";
 import { MediaStream, type MediaStreamTrack } from "./media/track";
-import { GroupDescription, MediaDescription, SessionDescription } from "./sdp";
+import { MediaDescription, SessionDescription } from "./sdp";
 import { RTCDtlsTransport } from "./transport/dtls";
 import { type IceGathererState, type RTCIceCandidate, type RTCIceConnectionState, RTCIceTransport } from "./transport/ice";
 import { RTCSctpTransport } from "./transport/sctp";
@@ -19,7 +19,6 @@ import type { Callback, CallbackWithValue } from "./types/util";
 export declare class RTCPeerConnection extends EventTarget {
     readonly cname: string;
     sctpTransport?: RTCSctpTransport;
-    transportEstablished: boolean;
     config: Required<PeerConfig>;
     connectionState: ConnectionState;
     iceConnectionState: RTCIceConnectionState;
@@ -29,7 +28,7 @@ export declare class RTCPeerConnection extends EventTarget {
     private readonly transceivers;
     private pushTransceiver;
     private replaceTransceiver;
-    candidatesSent: Set<string>;
+    needRestart: boolean;
     readonly iceGatheringStateChange: Event<["complete" | "new" | "gathering"]>;
     readonly iceConnectionStateChange: Event<["disconnected" | "closed" | "completed" | "new" | "connected" | "failed" | "checking"]>;
     readonly signalingStateChange: Event<["closed" | "stable" | "have-local-offer" | "have-remote-offer" | "have-local-pranswer" | "have-remote-pranswer"]>;
@@ -47,7 +46,7 @@ export declare class RTCPeerConnection extends EventTarget {
     ontrack?: CallbackWithValue<RTCTrackEvent>;
     onconnectionstatechange?: Callback;
     private readonly router;
-    private readonly certificates;
+    private certificate?;
     sctpRemotePort?: number;
     private seenMid;
     private currentLocalDescription?;
@@ -61,7 +60,9 @@ export declare class RTCPeerConnection extends EventTarget {
     get extIdUriMap(): {
         [id: number]: string;
     };
+    get iceGeneration(): number;
     constructor(config?: Partial<PeerConfig>);
+    setConfiguration(config: Partial<PeerConfig>): void;
     get localDescription(): import("./sdp").RTCSessionDescription | undefined;
     get remoteDescription(): import("./sdp").RTCSessionDescription | undefined;
     /**@private */
@@ -71,7 +72,9 @@ export declare class RTCPeerConnection extends EventTarget {
     private getTransceiverByMid;
     private getTransceiverByMLineIndex;
     getConfiguration(): Required<PeerConfig>;
-    createOffer(): Promise<import("./sdp").RTCSessionDescription>;
+    createOffer({ iceRestart }?: {
+        iceRestart?: boolean;
+    }): Promise<import("./sdp").RTCSessionDescription>;
     private assignTransceiverCodecs;
     buildOfferSdp(): SessionDescription;
     createDataChannel(label: string, options?: Partial<{
@@ -90,6 +93,7 @@ export declare class RTCPeerConnection extends EventTarget {
         type: "offer" | "answer";
         sdp: string;
     }): Promise<SessionDescription>;
+    private gatherCandidates;
     private setLocal;
     private getTransportByMid;
     private getTransportByMLineIndex;
@@ -97,7 +101,8 @@ export declare class RTCPeerConnection extends EventTarget {
     private connect;
     private getLocalRtpParams;
     private getRemoteRtpParams;
-    get remoteIsBundled(): GroupDescription | undefined;
+    private get remoteIsBundled();
+    restartIce(): void;
     setRemoteDescription(sessionDescription: RTCSessionDescriptionInit): Promise<void>;
     private setRemoteRTP;
     private setRemoteSCTP;
@@ -159,6 +164,7 @@ export interface PeerConfig {
     dtls: Partial<{
         keys: DtlsKeys;
     }>;
+    icePasswordPrefix: string | undefined;
     bundlePolicy: BundlePolicy;
     debug: Partial<{
         /**% */

package/lib/webrtc/src/peerConnection.js

@@ -78,6 +78,9 @@ class RTCPeerConnection extends helper_1.EventTarget {
     get extIdUriMap() {
         return this.router.extIdUriMap;
     }
+    get iceGeneration() {
+        return this.iceTransports[0].connection.generation;
+    }
     constructor(config = {}) {
         super();
         Object.defineProperty(this, "cname", {
@@ -92,12 +95,6 @@ class RTCPeerConnection extends helper_1.EventTarget {
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "transportEstablished", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
         Object.defineProperty(this, "config", {
             enumerable: true,
             configurable: true,
@@ -140,11 +137,11 @@ class RTCPeerConnection extends helper_1.EventTarget {
             writable: true,
             value: []
         });
-        Object.defineProperty(this, "candidatesSent", {
+        Object.defineProperty(this, "needRestart", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: new Set()
+            value: false
         });
         Object.defineProperty(this, "iceGatheringStateChange", {
             enumerable: true,
@@ -248,11 +245,11 @@ class RTCPeerConnection extends helper_1.EventTarget {
             writable: true,
             value: new router_1.RtpRouter()
         });
-        Object.defineProperty(this, "certificates", {
+        Object.defineProperty(this, "certificate", {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: []
+            value: void 0
         });
         Object.defineProperty(this, "sctpRemotePort", {
             enumerable: true,
@@ -308,8 +305,9 @@ class RTCPeerConnection extends helper_1.EventTarget {
             writable: true,
             value: async () => {
                 this.shouldNegotiationneeded = true;
-                if (this.negotiationneeded || this.signalingState !== "stable")
+                if (this.negotiationneeded || this.signalingState !== "stable") {
                     return;
+                }
                 this.shouldNegotiationneeded = false;
                 setImmediate(() => {
                     this.negotiationneeded = true;
@@ -319,6 +317,19 @@ class RTCPeerConnection extends helper_1.EventTarget {
                 });
             }
         });
+        this.setConfiguration(config);
+        this.iceConnectionStateChange.subscribe((state) => {
+            switch (state) {
+                case "disconnected":
+                    this.setConnectionState("disconnected");
+                    break;
+                case "closed":
+                    this.close();
+                    break;
+            }
+        });
+    }
+    setConfiguration(config) {
         (0, _1.deepMerge)(this.config, config);
         if (this.config.icePortRange) {
             const [min, max] = this.config.icePortRange;
@@ -361,19 +372,9 @@ class RTCPeerConnection extends helper_1.EventTarget {
         if (this.config.dtls) {
             const { keys } = this.config.dtls;
             if (keys) {
-                this.certificates.push(new dtls_1.RTCCertificate(keys.keyPem, keys.certPem, keys.signatureHash));
+                this.certificate = new dtls_1.RTCCertificate(keys.keyPem, keys.certPem, keys.signatureHash);
             }
         }
-        this.iceConnectionStateChange.subscribe((state) => {
-            switch (state) {
-                case "disconnected":
-                    this.setConnectionState("disconnected");
-                    break;
-                case "closed":
-                    this.close();
-                    break;
-            }
-        });
     }
     get localDescription() {
         if (!this._localDescription) {
@@ -404,7 +405,13 @@ class RTCPeerConnection extends helper_1.EventTarget {
     getConfiguration() {
         return this.config;
     }
-    async createOffer() {
+    async createOffer({ iceRestart } = {}) {
+        if (iceRestart || this.needRestart) {
+            this.needRestart = false;
+            for (const t of this.iceTransports) {
+                t.restart();
+            }
+        }
         await this.ensureCerts();
         const description = this.buildOfferSdp();
         return description.toJSON();
@@ -584,12 +591,13 @@ class RTCPeerConnection extends helper_1.EventTarget {
             additionalHostAddresses: this.config.iceAdditionalHostAddresses,
             filterStunResponse: this.config.iceFilterStunResponse,
             filterCandidatePair: this.config.iceFilterCandidatePair,
+            localPasswordPrefix: this.config.icePasswordPrefix,
             useIpv4: this.config.iceUseIpv4,
             useIpv6: this.config.iceUseIpv6,
             turnTransport: this.config.forceTurnTCP === true ? "tcp" : "udp",
         });
         if (existing) {
-            iceGatherer.connection.localUserName = existing.connection.localUserName;
+            iceGatherer.connection.localUsername = existing.connection.localUsername;
             iceGatherer.connection.localPassword = existing.connection.localPassword;
         }
         iceGatherer.onGatheringStateChange.subscribe(() => {
@@ -600,7 +608,10 @@ class RTCPeerConnection extends helper_1.EventTarget {
         iceTransport.onStateChange.subscribe(() => {
             this.updateIceConnectionState();
         });
-        iceTransport.iceGather.onIceCandidate = (candidate) => {
+        iceTransport.onNegotiationNeeded.subscribe(() => {
+            this.needNegotiation();
+        });
+        iceTransport.onIceCandidate.subscribe((candidate) => {
             if (!this.localDescription) {
                 log("localDescription not found when ice candidate was gathered");
                 return;
@@ -633,22 +644,13 @@ class RTCPeerConnection extends helper_1.EventTarget {
                 }
             }
             candidate.foundation = "candidate:" + candidate.foundation;
-            // prevent ice candidates that have already been sent from being being resent
-            // when the connection is renegotiated during a later setLocalDescription call.
-            if (candidate.sdpMid) {
-                const candidateKey = `${candidate.foundation}:${candidate.sdpMid}`;
-                if (this.candidatesSent.has(candidateKey)) {
-                    return;
-                }
-                this.candidatesSent.add(candidateKey);
-            }
             this.onIceCandidate.execute(candidate.toJSON());
             if (this.onicecandidate) {
                 this.onicecandidate({ candidate: candidate.toJSON() });
             }
             this.emit("icecandidate", { candidate });
-        };
-        const dtlsTransport = new dtls_1.RTCDtlsTransport(this.config, iceTransport, this.router, this.certificates, srtpProfiles);
+        });
+        const dtlsTransport = new dtls_1.RTCDtlsTransport(this.config, iceTransport, this.router, this.certificate, srtpProfiles);
         return dtlsTransport;
     }
     createSctpTransport() {
@@ -683,7 +685,7 @@ class RTCPeerConnection extends helper_1.EventTarget {
             this.setSignalingState("stable");
         }
         // # assign MID
-        description.media.forEach((media, i) => {
+        for (const [i, media] of (0, helper_1.enumerate)(description.media)) {
             const mid = media.rtp.muxId;
             this.seenMid.add(mid);
             if (["audio", "video"].includes(media.kind)) {
@@ -695,8 +697,9 @@ class RTCPeerConnection extends helper_1.EventTarget {
             if (media.kind === "application" && this.sctpTransport) {
                 this.sctpTransport.mid = mid;
             }
-        });
-        const setupRole = (dtlsTransport) => {
+        }
+        // setup ice,dtls role
+        for (const dtlsTransport of this.dtlsTransports) {
             const iceTransport = dtlsTransport.iceTransport;
             // # set ICE role
             if (description.type === "offer") {
@@ -718,26 +721,19 @@ class RTCPeerConnection extends helper_1.EventTarget {
                     dtlsTransport.role = role;
                 }
             }
-        };
-        this.dtlsTransports.forEach((d) => setupRole(d));
+        }
         // # configure direction
         if (["answer", "pranswer"].includes(description.type)) {
-            this.transceivers.forEach((t) => {
+            for (const t of this.transceivers) {
                 const direction = (0, utils_1.andDirection)(t.direction, t.offerDirection);
                 t.setCurrentDirection(direction);
-            });
+            }
         }
         // for trickle ice
         this.setLocal(description);
-        // # gather candidates
-        const connected = this.iceTransports.find((transport) => transport.state === "connected");
-        if (this.remoteIsBundled && connected) {
-            // no need to gather ice candidates on an existing bundled connection
-            await connected.iceGather.gather();
-        }
-        else {
-            await Promise.allSettled(this.iceTransports.map((iceTransport) => iceTransport.iceGather.gather()));
-        }
+        await this.gatherCandidates().catch((e) => {
+            log("gatherCandidates failed", e);
+        });
         // connect transports
         if (description.type === "answer") {
             this.connect().catch((err) => {
@@ -751,6 +747,16 @@ class RTCPeerConnection extends helper_1.EventTarget {
         }
         return description;
     }
+    async gatherCandidates() {
+        // # gather candidates
+        const connected = this.iceTransports.find((transport) => transport.state === "connected");
+        if (this.remoteIsBundled && connected) {
+            // no need to gather ice candidates on an existing bundled connection
+        }
+        else {
+            await Promise.allSettled(this.iceTransports.map((iceTransport) => iceTransport.gather()));
+        }
+    }
     setLocal(description) {
         description.media
             .filter((m) => ["audio", "video"].includes(m.kind))
@@ -812,17 +818,20 @@ class RTCPeerConnection extends helper_1.EventTarget {
         }
     }
     async connect() {
-        if (this.transportEstablished) {
-            return;
-        }
         log("start connect");
-        this.setConnectionState("connecting");
         await Promise.allSettled(this.dtlsTransports.map(async (dtlsTransport) => {
             const { iceTransport } = dtlsTransport;
+            if (iceTransport.state === "connected") {
+                return;
+            }
+            this.setConnectionState("connecting");
             await iceTransport.start().catch((err) => {
                 log("iceTransport.start failed", err);
                 throw err;
             });
+            if (dtlsTransport.state === "connected") {
+                return;
+            }
             await dtlsTransport.start().catch((err) => {
                 log("dtlsTransport.start failed", err);
                 throw err;
@@ -835,7 +844,6 @@ class RTCPeerConnection extends helper_1.EventTarget {
                 log("sctp connected");
             }
         }));
-        this.transportEstablished = true;
         this.setConnectionState("connected");
     }
     getLocalRtpParams(transceiver) {
@@ -881,6 +889,10 @@ class RTCPeerConnection extends helper_1.EventTarget {
         const bundle = remoteSdp.group.find((g) => g.semantic === "BUNDLE" && this.config.bundlePolicy !== "disable");
         return bundle;
     }
+    restartIce() {
+        this.needRestart = true;
+        this.needNegotiation();
+    }
     async setRemoteDescription(sessionDescription) {
         if (!sessionDescription.sdp ||
             !sessionDescription.type ||
@@ -955,15 +967,18 @@ class RTCPeerConnection extends helper_1.EventTarget {
                 throw new Error("invalid media kind");
             }
             const iceTransport = dtlsTransport.iceTransport;
-            if (remoteMedia.iceParams && remoteMedia.dtlsParams) {
-                iceTransport.setRemoteParams(remoteMedia.iceParams);
-                dtlsTransport.setRemoteParams(remoteMedia.dtlsParams);
+            if (remoteMedia.iceParams) {
+                const renomination = !!remoteSdp.media.find((m) => m.direction === "inactive");
+                iceTransport.setRemoteParams(remoteMedia.iceParams, renomination);
                 // One agent full, one lite:  The full agent MUST take the controlling role, and the lite agent MUST take the controlled role
                 // RFC 8445 S6.1.1
                 if (remoteMedia.iceParams?.iceLite) {
                     iceTransport.connection.iceControlling = true;
                 }
             }
+            if (remoteMedia.dtlsParams) {
+                dtlsTransport.setRemoteParams(remoteMedia.dtlsParams);
+            }
             // # add ICE candidates
             remoteMedia.iceCandidates.forEach(iceTransport.addRemoteCandidate);
             if (remoteMedia.iceCandidatesComplete) {
@@ -1016,14 +1031,16 @@ class RTCPeerConnection extends helper_1.EventTarget {
         transceiver.codecs = remoteMedia.rtp.codecs.filter((remoteCodec) => {
             const localCodecs = this.config.codecs[remoteMedia.kind] || [];
             const existCodec = (0, exports.findCodecByMimeType)(localCodecs, remoteCodec);
-            if (!existCodec)
+            if (!existCodec) {
                 return false;
+            }
             if (existCodec?.name.toLowerCase() === "rtx") {
                 const params = (0, _2.codecParametersFromString)(existCodec.parameters ?? "");
                 const pt = params["apt"];
                 const origin = remoteMedia.rtp.codecs.find((c) => c.payloadType === pt);
-                if (!origin)
+                if (!origin) {
                     return false;
+                }
                 return !!(0, exports.findCodecByMimeType)(localCodecs, origin);
             }
             return true;
@@ -1222,17 +1239,11 @@ class RTCPeerConnection extends helper_1.EventTarget {
         }
     }
     async ensureCerts() {
-        const ensureCert = async (dtlsTransport) => {
-            if (this.certificates.length === 0) {
-                const localCertificate = await dtlsTransport.setupCertificate();
-                this.certificates.push(localCertificate);
-            }
-            else {
-                dtlsTransport.localCertificate = this.certificates[0];
-            }
-        };
+        if (!this.certificate) {
+            this.certificate = await dtls_1.RTCDtlsTransport.SetupCertificate();
+        }
         for (const dtlsTransport of this.dtlsTransports) {
-            await ensureCert(dtlsTransport);
+            dtlsTransport.localCertificate = this.certificate;
         }
     }
     async createAnswer() {
@@ -1285,11 +1296,11 @@ class RTCPeerConnection extends helper_1.EventTarget {
         });
         if (this.config.bundlePolicy !== "disable") {
             const bundle = new sdp_1.GroupDescription("BUNDLE", []);
-            description.media.forEach((media) => {
+            for (const media of description.media) {
                 if (media.direction !== "inactive") {
                     bundle.items.push(media.rtp.muxId);
                 }
-            });
+            }
             description.group.push(bundle);
         }
         return description;
@@ -1323,8 +1334,8 @@ class RTCPeerConnection extends helper_1.EventTarget {
     updateIceGatheringState() {
         const all = this.iceTransports;
         function allMatch(...state) {
-            return (all.filter((check) => state.includes(check.iceGather.gatheringState))
-                .length === all.length);
+            return (all.filter((check) => state.includes(check.gatheringState)).length ===
+                all.length);
         }
         let newState;
         if (all.length && allMatch("complete")) {
@@ -1333,7 +1344,7 @@ class RTCPeerConnection extends helper_1.EventTarget {
         else if (!all.length || allMatch("new", "complete")) {
             newState = "new";
         }
-        else if (all.map((check) => check.iceGather.gatheringState).includes("gathering")) {
+        else if (all.map((check) => check.gatheringState).includes("gathering")) {
             newState = "gathering";
         }
         else {
@@ -1398,8 +1409,9 @@ class RTCPeerConnection extends helper_1.EventTarget {
         log("connectionStateChange", state);
         this.connectionState = state;
         this.connectionStateChange.execute(state);
-        if (this.onconnectionstatechange)
+        if (this.onconnectionstatechange) {
             this.onconnectionstatechange();
+        }
         this.emit("connectionstatechange");
     }
     dispose() {
@@ -1451,10 +1463,9 @@ function createMediaDescriptionForSctp(sctp) {
 }
 function addTransportDescription(media, dtlsTransport) {
     const iceTransport = dtlsTransport.iceTransport;
-    const iceGatherer = iceTransport.iceGather;
-    media.iceCandidates = iceGatherer.localCandidates;
-    media.iceCandidatesComplete = iceGatherer.gatheringState === "complete";
-    media.iceParams = iceGatherer.localParameters;
+    media.iceCandidates = iceTransport.localCandidates;
+    media.iceCandidatesComplete = iceTransport.gatheringState === "complete";
+    media.iceParams = iceTransport.localParameters;
     media.iceOptions = "trickle";
     media.host = const_1.DISCARD_HOST;
     media.port = const_1.DISCARD_PORT;
@@ -1522,6 +1533,7 @@ exports.defaultPeerConfig = {
     iceUseIpv6: true,
     iceFilterStunResponse: undefined,
     iceFilterCandidatePair: undefined,
+    icePasswordPrefix: undefined,
     dtls: {},
     bundlePolicy: "max-compat",
     debug: {},