livedesk 0.1.115 → 0.1.116

package/hub/src/server.js

@@ -22,7 +22,11 @@ const packageInfo = JSON.parse(readFileSync(resolve(__dirname, '..', 'package.js
 const httpHost = process.env.LIVEDESK_HUB_HTTP_HOST || '0.0.0.0';
 const httpPort = Number(process.env.LIVEDESK_HUB_HTTP_PORT || process.env.PORT || 5179);
 const frameBackpressureBytes = readPositiveIntegerEnv('LIVEDESK_FRAME_WS_BACKPRESSURE_BYTES', 512 * 1024);
+const frameClientQueuePackets = readPositiveIntegerEnv('LIVEDESK_FRAME_WS_QUEUE_PACKETS', 3);
+const frameClientDrainBudgetPackets = readPositiveIntegerEnv('LIVEDESK_FRAME_WS_DRAIN_BUDGET_PACKETS', 2);
 const frameClients = new Set();
+const frameClientsByDeviceId = new Map();
+const frameWildcardClients = new Set();
 const inputClients = new Set();
 const audioClients = new Set();
 let frameClientSeq = 0;
@@ -42,10 +46,14 @@ function handleRemoteHubEvent(type, event) {
   if (!deviceId) {
     return;
   }
-  for (const ws of frameClients) {
+  const clients = new Set([
+    ...(frameClientsByDeviceId.get(deviceId) || []),
+    ...frameWildcardClients
+  ]);
+  for (const ws of clients) {
     if (ws.readyState === 1
       && ws.liveDeskAutoStart
-      && ws.liveDeskDeviceIds?.has(deviceId)) {
+      && (!ws.liveDeskDeviceIds?.size || ws.liveDeskDeviceIds.has(deviceId))) {
       startFrameSubscriptionLive(ws, 'device-reconnected', deviceId);
     }
   }
@@ -68,9 +76,9 @@ const remoteHub = createRemoteHub({
 
 const app = express();
 const httpServer = createServer(app);
-const frameWss = new WebSocketServer({ noServer: true });
-const inputWss = new WebSocketServer({ noServer: true });
-const audioWss = new WebSocketServer({ noServer: true });
+const frameWss = new WebSocketServer({ noServer: true, perMessageDeflate: false });
+const inputWss = new WebSocketServer({ noServer: true, perMessageDeflate: false });
+const audioWss = new WebSocketServer({ noServer: true, perMessageDeflate: false });
 
 app.use((req, res, next) => {
   if (req.headers.origin) {
@@ -200,6 +208,7 @@ function sendJson(ws, payload) {
 }
 
 function forgetWebSocketClient(ws) {
+  unregisterFrameClient(ws);
   frameClients.delete(ws);
   audioClients.delete(ws);
   inputClients.delete(ws);
@@ -228,12 +237,129 @@ function safeWebSocketSend(ws, payload, options = undefined) {
   }
 }
 
+function unregisterFrameClient(ws) {
+  if (!ws) {
+    return;
+  }
+  const ids = ws.liveDeskDeviceIds instanceof Set ? ws.liveDeskDeviceIds : new Set();
+  for (const deviceId of ids) {
+    const clients = frameClientsByDeviceId.get(deviceId);
+    if (!clients) {
+      continue;
+    }
+    clients.delete(ws);
+    if (clients.size === 0) {
+      frameClientsByDeviceId.delete(deviceId);
+    }
+  }
+  frameWildcardClients.delete(ws);
+  ws.liveDeskFrameSendLane?.queue?.splice?.(0);
+}
+
+function registerFrameClient(ws) {
+  if (!ws) {
+    return;
+  }
+  const ids = ws.liveDeskDeviceIds instanceof Set ? ws.liveDeskDeviceIds : new Set();
+  if (ids.size === 0) {
+    frameWildcardClients.add(ws);
+    return;
+  }
+  for (const deviceId of ids) {
+    let clients = frameClientsByDeviceId.get(deviceId);
+    if (!clients) {
+      clients = new Set();
+      frameClientsByDeviceId.set(deviceId, clients);
+    }
+    clients.add(ws);
+  }
+}
+
+function ensureFrameClientSendLane(ws) {
+  if (!ws.liveDeskFrameSendLane) {
+    ws.liveDeskFrameSendLane = {
+      queue: [],
+      draining: false,
+      dropped: 0
+    };
+  }
+  return ws.liveDeskFrameSendLane;
+}
+
+function dropQueuedFrameForLane(lane) {
+  const deltaIndex = lane.queue.findIndex(item => item?.isKeyFrame !== true);
+  const dropIndex = deltaIndex >= 0 ? deltaIndex : 0;
+  const dropped = lane.queue.splice(dropIndex, 1);
+  lane.dropped += dropped.length;
+}
+
+function drainFrameClientSendLane(ws) {
+  const lane = ws.liveDeskFrameSendLane;
+  if (!lane || lane.draining) {
+    return;
+  }
+  lane.draining = true;
+  setImmediate(() => {
+    lane.draining = false;
+    if (!ws || ws.readyState !== ws.OPEN) {
+      lane.queue.length = 0;
+      return;
+    }
+
+    let sent = 0;
+    while (lane.queue.length > 0 && sent < frameClientDrainBudgetPackets) {
+      if (ws.bufferedAmount > frameBackpressureBytes) {
+        ws.liveDeskFrameBackpressured = true;
+        break;
+      }
+      const item = lane.queue.shift();
+      if (!item) {
+        continue;
+      }
+      ws.liveDeskFrameBackpressured = false;
+      safeWebSocketSend(ws, item.packet, { binary: true });
+      sent += 1;
+    }
+
+    if (lane.queue.length > 0 && ws.readyState === ws.OPEN) {
+      drainFrameClientSendLane(ws);
+    }
+  });
+}
+
+function enqueueFramePacketForClient(ws, packet, meta) {
+  if (!ws || ws.readyState !== ws.OPEN) {
+    return false;
+  }
+  const lane = ensureFrameClientSendLane(ws);
+  if (ws.bufferedAmount > frameBackpressureBytes) {
+    ws.liveDeskFrameBackpressured = true;
+    ws.liveDeskFrameBackpressureDrops = Number(ws.liveDeskFrameBackpressureDrops || 0) + 1;
+    return false;
+  }
+  while (lane.queue.length >= frameClientQueuePackets) {
+    dropQueuedFrameForLane(lane);
+    ws.liveDeskFrameBackpressureDrops = Number(ws.liveDeskFrameBackpressureDrops || 0) + 1;
+  }
+  lane.queue.push({
+    packet,
+    deviceId: meta.deviceId,
+    frameSeq: meta.frameSeq,
+    isH264: meta.isH264,
+    isKeyFrame: meta.isKeyFrame
+  });
+  drainFrameClientSendLane(ws);
+  return true;
+}
+
 function updateFrameSubscription(ws, payload = {}) {
   const previousDeviceIds = ws.liveDeskDeviceIds instanceof Set
     ? new Set(ws.liveDeskDeviceIds)
     : new Set();
+  unregisterFrameClient(ws);
   const deviceIds = normalizeDeviceIds(payload.deviceIds ?? payload.devices ?? payload.deviceId);
   ws.liveDeskDeviceIds = new Set(deviceIds);
+  registerFrameClient(ws);
   ws.liveDeskAutoStart = /^(1|true|yes|on|live)$/i.test(String(payload.autoStartLive ?? payload.startLive ?? ''));
   ws.liveDeskLiveOptions = normalizeLiveOptions(payload);
   sendJson(ws, {
@@ -424,6 +550,13 @@ function broadcastRemoteBinaryFrame(frameEvent) {
   if (!deviceId || frameClients.size === 0) {
     return;
   }
+  const targetClients = new Set([
+    ...(frameClientsByDeviceId.get(deviceId) || []),
+    ...frameWildcardClients
+  ]);
+  if (targetClients.size === 0) {
+    return;
+  }
   const frame = frameEvent.frame || {};
   const isH264 = String(frame.codec || frame.mimeType || frame.format || '').toLowerCase().includes('h264')
     || String(frame.frameMode || frame.mode || '').toLowerCase() === 'mode3-h264-hw';
@@ -432,24 +565,16 @@ function broadcastRemoteBinaryFrame(frameEvent) {
   if (!packet) {
     return;
   }
-  for (const client of frameClients) {
+  const frameSeq = Number(frame.frameSeq || 0) || 0;
+  for (const client of targetClients) {
     if (client.readyState !== client.OPEN) {
       continue;
     }
-    if (client.liveDeskDeviceIds?.size > 0 && !client.liveDeskDeviceIds.has(deviceId)) {
-      continue;
-    }
-    if (client.bufferedAmount > frameBackpressureBytes) {
-      client.liveDeskFrameBackpressured = true;
-      client.liveDeskFrameBackpressureDrops = Number(client.liveDeskFrameBackpressureDrops || 0) + 1;
-      continue;
-    }
     if (client.liveDeskFrameBackpressured && isH264 && !isKeyFrame) {
       client.liveDeskFrameBackpressureDrops = Number(client.liveDeskFrameBackpressureDrops || 0) + 1;
       continue;
     }
-    client.liveDeskFrameBackpressured = false;
-    safeWebSocketSend(client, packet, { binary: true });
+    enqueueFramePacketForClient(client, packet, { deviceId, frameSeq, isH264, isKeyFrame });
   }
 }
 
@@ -799,6 +924,7 @@ frameWss.on('connection', (ws, req) => {
     // Best-effort latency hint for browser frame sockets.
   }
   const cleanup = () => {
+    unregisterFrameClient(ws);
     frameClients.delete(ws);
   };
   try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "livedesk",
-  "version": "0.1.115",
+  "version": "0.1.116",
   "description": "LiveDesk Hub and client launcher",
   "type": "module",
   "bin": {