@torrent-tv/proxy 2.100.10 → 2.100.12

package/bin/cli.js

@@ -18,6 +18,7 @@ import os from "node:os";
 import { spawnSync } from "node:child_process";
 import { createRequire } from "node:module";
 import ffmpegStatic from "ffmpeg-static";
+import nodeDataChannel from "node-datachannel";
 import { startProxyServer } from "../server.js";
 import { registerClient } from "../services/transport/registry-api.js";
 import { createTunnelClient } from "../services/transport/tunnel-client.js";
@@ -689,6 +690,7 @@ try {
   });
 
   webRtcManager = createWebRtcManager({
+    rtc: nodeDataChannel,
     // Single UDP port (UPnP-mapped above) shared by all sessions via a
     // persistent ICE UDP mux listener, so the WebRTC path is reachable from the
     // internet on one fixed port.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@torrent-tv/proxy",
-  "version": "2.100.10",
+  "version": "2.100.12",
   "description": "Torrent proxy client that exposes webseed-like HTTP stream endpoint.",
   "license": "GPL-3.0-or-later",
   "repository": {

package/services/encode/Renditions.js

@@ -36,7 +36,15 @@ export class Renditions {
   #host;
 
   /**
-   * @param {object} host - `viewerSecondsOn`, `audioStartSecondsFor`, `activeOutputFor`, `viewersOf`, `audioRenditionName`, `logger`, `placeViewer`, `viewerLeaves`, `createOrGetSession`, `planEncodersSoon`, `disposeSession`, `viewerPositionOf`, `encodeRuns`, `fileStartTimeReads`, `getCachedAudioTracks`, `getCachedMediaInfo`, `getContainerMediaInfo`, `localBaseUrl`, `outputTimes`, `outputs`, `quality`, `qualityOffer`, `segmentDurationSec`, `sourceFiles`, `viewers`, `generationOfRequest`, `givenOutputOf`, `noteGivenOutput`, `chosenOutputOf`, `chooseOutput`, `storedPieceReady`, `headersCompatible`, `audioChoiceOf`, `linkMbpsOf`, `qualityModeOf`, `noteServingVerdict`, `limitsFor`, `heightsChosenAs`, `highestGivenSegmentOf`, `sameHeightSwitchOf`, `noteSameHeightSwitch`, `switchingOnto`, `segmentClosed`, `bufferedSecondsOf`, `minimumBufferSecondsFor`
+   * The segment each viewer's move was last said to wait for on the output
+   * they are leaving, so that a wait is said once per segment.
+   *
+   * @type {Map<string, number>}
+   */
+  #moveWaitsSaid = new Map();
+
+  /**
+   * @param {object} host - `viewerSecondsOn`, `audioStartSecondsFor`, `activeOutputFor`, `viewersOf`, `audioRenditionName`, `logger`, `placeViewer`, `viewerLeaves`, `createOrGetSession`, `planEncodersSoon`, `disposeSession`, `viewerPositionOf`, `encodeRuns`, `fileStartTimeReads`, `getCachedAudioTracks`, `getCachedMediaInfo`, `getContainerMediaInfo`, `localBaseUrl`, `outputTimes`, `outputs`, `quality`, `qualityOffer`, `segmentDurationSec`, `sourceFiles`, `viewers`, `generationOfRequest`, `givenOutputOf`, `noteGivenOutput`, `chosenOutputOf`, `chooseOutput`, `storedPieceReady`, `headersCompatible`, `audioChoiceOf`, `linkMbpsOf`, `qualityModeOf`, `noteServingVerdict`, `limitsFor`, `heightsChosenAs`, `highestGivenSegmentOf`, `sameHeightSwitchOf`, `noteSameHeightSwitch`, `switchingOnto`, `switchingFrom`, `segmentClosed`, `bufferedSecondsOf`, `minimumBufferSecondsFor`
    */
   constructor(host) {
     this.#host = host;
@@ -836,6 +844,14 @@ export class Renditions {
       for (const consumerId of this.#host.switchingOnto(output)) {
         this.#reconsiderSameHeightSwitch(base, consumerId, index);
       }
+      // A segment closed on the output a viewer is LEAVING may be the one their
+      // move waits for (`#givenAndOpenOn`). It is behind the segment the move
+      // begins at by construction, so it is asked about with no index.
+      for (const consumerId of this.#host.switchingFrom?.(output) ?? []) {
+        if (this.#host.activeOutputFor({ base, consumerId, outputs: this.#host.outputs }) === output) {
+          this.#reconsiderSameHeightSwitch(base, consumerId, null);
+        }
+      }
     }
   }
 
@@ -894,6 +910,28 @@ export class Renditions {
     }
   }
 
+  /**
+   * The segment just before the one a move would begin at, when it was given
+   * to this viewer from the output on their screen and is not closed there:
+   * the segment their held request waits for. Null otherwise.
+   *
+   * @param {HlsSession | null} current - The output on their screen.
+   * @param {string} consumerId
+   * @param {number[]} askedHeights
+   * @param {number} next - The segment the move would begin at.
+   * @returns {number | null}
+   */
+  #givenAndOpenOn(current, consumerId, askedHeights, next) {
+    const segment = next - 1;
+    if (!current?.outputKey || segment < 0) {
+      return null;
+    }
+    const generation = this.#host.generationOfRequest(consumerId, Number.NaN);
+    const given = askedHeights.some((height) =>
+      this.#host.givenOutputOf(consumerId, generation, height, segment) === current.outputKey);
+    return given && !this.#host.segmentClosed(current.outputKey, segment) ? segment : null;
+  }
+
   /**
    * The segment this viewer will ask for next at these heights.
    *
@@ -967,6 +1005,24 @@ export class Renditions {
     if (!this.#host.segmentClosed(prepared.outputKey ?? "", next)) {
       return;
     }
+    // THE SEGMENT ALREADY GIVEN FROM THE OUTPUT ON SCREEN. A request is held by
+    // the output it was given from, and leaving that output stops its encoder:
+    // a segment given and not yet closed there would then be made by nobody.
+    // On Home Assistant a viewer waiting for #2176 was moved from #2177 and
+    // the picture stood for good (r71, torrent-tv/meta#178). The move waits for
+    // that segment to be closed; an output whose encoding has failed for good
+    // closes nothing, and its held request is the serving path's to answer.
+    const open = this.#givenAndOpenOn(current, consumerId, move.askedHeights, next);
+    if (open !== null && !this.#host.encodeRuns.hasFailed(current)) {
+      if (this.#moveWaitsSaid.get(consumerId) !== open) {
+        this.#moveWaitsSaid.set(consumerId, open);
+        this.#host.logger.info(
+          `transcode ${base.id} ${consumerId}'s move to ${move.outputKey} waits for #${open} on ` +
+          `${current.outputKey}, given and not yet closed there`
+        );
+      }
+      return;
+    }
     // THE CUSHION, for a move that is not urgent (roadmap item 98): a move up
     // is made once the viewer holds the cushion this file needs, and their
     // next report asks again until they do. A move DOWN is made at once — it
@@ -1026,6 +1082,7 @@ export class Renditions {
    * @returns {void}
    */
   #completeSameHeightSwitch(base, consumerId, move, prepared, current, next) {
+    this.#moveWaitsSaid.delete(consumerId);
     for (const height of move.askedHeights) {
       this.#choose(consumerId, height, prepared, base);
     }
@@ -1063,6 +1120,7 @@ export class Renditions {
    * @returns {void}
    */
   #cancelSameHeightSwitch(base, consumerId, reason) {
+    this.#moveWaitsSaid.delete(consumerId);
     const move = this.#host.sameHeightSwitchOf(consumerId);
     if (!move) {
       return;

package/services/server/wire-outputs.js

@@ -60,6 +60,7 @@ import {
   stepBeingWarmedOf,
   stepBeingWarmedSinceOf,
   stepOnScreenOf,
+  switchingFrom,
   switchingOnto,
   watches
 } from "../viewer/choices.js";
@@ -450,6 +451,7 @@ export function wireOutputs({
     sameHeightSwitchOf: (consumerId) => sameHeightSwitchOf(parts.viewers, consumerId),
     noteSameHeightSwitch: (consumerId, value) => noteSameHeightSwitch(parts.viewers, consumerId, value),
     switchingOnto: (output) => switchingOnto(parts.viewers, output),
+    switchingFrom: (output) => switchingFrom(parts.viewers, output),
     // What a viewer holds, and the cushion this file needs before a move that
     // is not urgent is made (roadmap item 98).
     bufferedSecondsOf: (consumerId) => bufferedSecondsOf(parts.viewers, consumerId),

package/services/transport/webrtc-manager.js

@@ -1,7 +1,8 @@
 /**
  * @file WebRTC connection manager for the proxy (Node.js side).
  *
- * Maintains one `PeerConnection` per browser session, keyed by `sessionId`.
+ * Maintains a media connection and an optional independent control connection
+ * per browser session. Control signals carry a generation's `connectionId`.
  * Receives SDP offers and ICE candidates through the signalling tunnel
  * and responds with SDP answers and its own candidates through the same channel.
  *
@@ -9,8 +10,6 @@
  * via the `onDataChannel` callback — this module only owns the signalling phase.
  */
 
-import nodeDataChannel from "node-datachannel";
-
 /** @import { WebRtcSignal } from './tunnel-client.js' */
 
 // Two STUN servers from different operators, both with IPv6 (AAAA) records, so
@@ -148,6 +147,8 @@ function candidateAddrKind(candidate) {
  * Configuration for the WebRTC manager.
  *
  * @typedef {Object} WebRtcManagerOptions
+ * @property {typeof import("node-datachannel").default} rtc
+ *   The peer connection implementation, supplied by the composition root.
  * @property {(sessionId: string, signal: WebRtcSignal) => void} sendSignal
  *   Send a WebRTC signal (answer or ICE candidate) back to the browser via
  *   the tunnel.  Typically wired to `tunnelClient.sendSignal`.
@@ -196,9 +197,10 @@ function candidateAddrKind(candidate) {
  * @param {WebRtcManagerOptions} options
  * @returns {WebRtcManager}
  */
-export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort, getNatInfo }) {
+export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort, getNatInfo, rtc }) {
   /** @type {Map<string, import("node-datachannel").PeerConnection>} */
   const peers = new Map();
+  const controlPeers = new Map();
 
   /**
    * @param {string} message
@@ -222,7 +224,7 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
   let udpMuxListener = null;
   if (Number.isInteger(udpPort) && udpPort > 0 && udpPort <= 65535) {
     try {
-      udpMuxListener = new nodeDataChannel.IceUdpMuxListener(udpPort);
+      udpMuxListener = new rtc.IceUdpMuxListener(udpPort);
       // STUN that doesn't match an existing session (our PeerConnections are
       // created from the SDP offer before the browser's STUN arrives, so normal
       // traffic is "handled"). Stray/unhandled requests are simply dropped.
@@ -249,13 +251,23 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
    * @param {string} sessionId
    * @returns {import("node-datachannel").PeerConnection}
    */
-  function getOrCreatePeer(sessionId) {
-    const existing = peers.get(sessionId);
+  function getOrCreatePeer(sessionId, connectionId = null) {
+    const peerId = connectionId === null ? sessionId : `${sessionId}/${connectionId}`;
+    const existing = peers.get(peerId);
     if (existing) {
       return existing;
     }
 
-    const pc = new nodeDataChannel.PeerConnection(`proxy-${sessionId.slice(0, 8)}`, pcConfig);
+    if (connectionId !== null) {
+      const previous = controlPeers.get(sessionId);
+      if (previous) closePeer(previous);
+    }
+    const pc = new rtc.PeerConnection(`proxy-${peerId}`, pcConfig);
+    if (connectionId !== null) controlPeers.set(sessionId, peerId);
+    const signalBrowser = (signal) => sendSignal(sessionId, {
+      ...signal,
+      ...(connectionId === null ? {} : { connectionId })
+    });
 
     // Forward all ICE candidates to the browser through the tunnel.
     //
@@ -272,7 +284,7 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
       log(
         `[webrtc] Session ${sessionId.slice(0, 8)}: sending ${kind} candidate: ${candidate.replace(/^a=/, "")}`
       );
-      sendSignal(sessionId, { type: "candidate", candidate, mid });
+      signalBrowser({ type: "candidate", candidate, mid });
 
       // Symmetric-NAT port prediction: offer extra srflx candidates at the
       // predicted external ports so the browser probes them too. No-op unless
@@ -287,7 +299,7 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
               `[webrtc] Session ${sessionId.slice(0, 8)}: symmetric NAT (delta=${nat.portDelta}) — injecting ${predicted.length} predicted srflx candidates: ${predicted.map((p) => p.port).join(",")}`
             );
             for (const p of predicted) {
-              sendSignal(sessionId, { type: "candidate", candidate: p.candidate, mid });
+              signalBrowser({ type: "candidate", candidate: p.candidate, mid });
             }
           }
         }
@@ -304,7 +316,7 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
     // Forward our SDP answer to the browser through the tunnel.
     pc.onLocalDescription((sdp, type) => {
       log(`[webrtc] Session ${sessionId.slice(0, 8)}: sending ${type}`);
-      sendSignal(sessionId, { type, sdp });
+      signalBrowser({ type, sdp, ...(connectionId === null ? { separateControl: true } : {}) });
     });
 
     pc.onStateChange((state) => {
@@ -328,7 +340,7 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
       // "disconnected" is a transient state — ICE may recover on its own.
       // Only tear down on terminal states: "failed" and "closed".
       if (state === "failed" || state === "closed") {
-        closeSession(sessionId);
+        if (peers.get(peerId) === pc) closePeer(peerId);
       }
     });
 
@@ -340,11 +352,15 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
 
     // Browser creates the data channel — we receive it here.
     pc.onDataChannel((channel) => {
-      log(`[webrtc] Session ${sessionId.slice(0, 8)}: data channel "${channel.getLabel()}" opened`);
-      onDataChannel(sessionId, channel);
+      if (peers.get(peerId) !== pc || (connectionId !== null && channel.getLabel() !== "proxy-control")) {
+        channel.close();
+        return;
+      }
+      log(`[webrtc] Session ${sessionId.slice(0, 8)}: ${connectionId === null ? "media" : `control ${connectionId}`} channel "${channel.getLabel()}" opened`);
+      onDataChannel(peerId, channel);
     });
 
-    peers.set(sessionId, pc);
+    peers.set(peerId, pc);
     return pc;
   }
 
@@ -364,6 +380,11 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
     if (!signal || typeof signal.type !== "string") {
       return;
     }
+    const connectionId = signal.connectionId ?? null;
+    if (connectionId !== null && (typeof connectionId !== "string" || !/^[a-zA-Z0-9-]{1,64}$/.test(connectionId))) return;
+    // A second association is subordinate to an existing media connection.
+    if (connectionId !== null && !peers.has(sessionId)) return;
+    const peerId = connectionId === null ? sessionId : `${sessionId}/${connectionId}`;
 
     if (signal.type === "offer") {
       if (typeof signal.sdp !== "string") {
@@ -375,19 +396,19 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
       // single bad session must never crash the whole proxy — that would drop
       // every other viewer and the tunnel. Contain it: fail this session only.
       try {
-        const pc = getOrCreatePeer(sessionId);
+        const pc = getOrCreatePeer(sessionId, connectionId);
         pc.setRemoteDescription(signal.sdp, "offer");
         // `onLocalDescription` fires automatically with the SDP answer.
       } catch (error) {
         const message = error instanceof Error ? error.message : String(error);
         log(`[webrtc] Session ${sessionId.slice(0, 8)}: failed to handle offer: ${message}`);
-        closeSession(sessionId);
+        closePeer(peerId);
       }
       return;
     }
 
     if (signal.type === "candidate") {
-      const pc = peers.get(sessionId);
+      const pc = peers.get(peerId);
       if (!pc) {
         return;
       }
@@ -409,15 +430,23 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
    * @param {string} sessionId
    * @returns {void}
    */
-  function closeSession(sessionId) {
-    const pc = peers.get(sessionId);
+  function closePeer(peerId) {
+    const pc = peers.get(peerId);
     if (pc) {
+      peers.delete(peerId);
+      const sessionId = peerId.split("/")[0];
+      if (controlPeers.get(sessionId) === peerId) controlPeers.delete(sessionId);
       try { pc.close(); } catch { /* ignore */ }
-      peers.delete(sessionId);
-      log(`[webrtc] Session ${sessionId.slice(0, 8)}: closed`);
+      log(`[webrtc] Session ${sessionId.slice(0, 8)}: peer ${peerId} closed`);
     }
   }
 
+  function closeSession(sessionId) {
+    const control = controlPeers.get(sessionId);
+    if (control) closePeer(control);
+    closePeer(sessionId);
+  }
+
   /**
    * Close all peer connections and stop the shared UDP mux listener.
    *
@@ -425,7 +454,7 @@ export function createWebRtcManager({ sendSignal, onDataChannel, onLog, udpPort,
    */
   function dispose() {
     for (const sessionId of [...peers.keys()]) {
-      closeSession(sessionId);
+      closePeer(sessionId);
     }
     if (udpMuxListener) {
       try { udpMuxListener.stop(); } catch { /* ignore */ }

package/services/viewer/choices.js

@@ -565,6 +565,25 @@ export function switchingOnto(viewers, output) {
   return found;
 }
 
+/**
+ * The present viewers on this output for whom a move onto ANOTHER output is
+ * being prepared: the ones a segment closed here may let go.
+ *
+ * @param {object} viewers
+ * @param {object} output
+ * @returns {string[]}
+ */
+export function switchingFrom(viewers, output) {
+  const found = [];
+  for (const [consumerId, viewer] of viewers.forOutput(output)) {
+    const move = viewer.sameHeightSwitch;
+    if (viewer.isPresent() && move && move.outputKey !== output.outputKey) {
+      found.push(consumerId);
+    }
+  }
+  return found;
+}
+
 /**
  * Every output a present viewer is being prepared onto, as ids.
  *