@torrent-tv/proxy 2.64.9 → 2.65.0

package/services/torrent-worker/worker.js

@@ -28,6 +28,7 @@ import { createSendStream } from "./channel.js";
 import { createFileClaims } from "./file-claims.js";
 import { readFragments, supplyFiguresFor } from "./piece-reader.js";
 import { cuesHeldFor, declaredSubtitleTracksOf, subtitleTracksOf, warmSubtitleCues } from "./subtitle-cues.js";
+import { CONTAINER_HEAD_BYTES, containerTracksOf } from "./container-tracks.js";
 import { Command, Event } from "./protocol.js";
 import { startMemoryReport, WORKER_MEMORY_SAMPLE_MS } from "../memory-report.js";
 
@@ -370,6 +371,24 @@ async function runCommand(command, params, id) {
       };
     }
 
+    case Command.CONTAINER_TRACKS: {
+      const torrent = await requireTorrent(params.sourceKey);
+      return {
+        tracks: await containerTracksOf(torrent, params.fileIndex, params.sourceKey, {
+          // The header of a file nobody is playing has usually not arrived at
+          // all — a sidecar soundtrack is asked about before anyone has chosen
+          // it. Its head is a few hundred kilobytes, and without them there is
+          // nothing to read.
+          prefetchEdges: () =>
+            pool.prefetchFileEdges(torrent, params.fileIndex, {
+              headBytes: CONTAINER_HEAD_BYTES,
+              tailBytes: 0,
+              timeoutMs: 60_000
+            })
+        })
+      };
+    }
+
     case Command.SUBTITLE_CUES: {
       const torrent = await requireTorrent(params.sourceKey);
       const held = await cuesHeldFor(torrent, params.fileIndex, params.sourceKey, params.trackNumber);

package/services/tracks/index.js

@@ -4,4 +4,10 @@ export { AudioTrack } from "./AudioTrack.js";
 export { SubtitleTrack } from "./SubtitleTrack.js";
 export { TextSubtitleTrack, TEXT_CODECS_MATROSKA, TEXT_FORMATS_MP4 } from "./TextSubtitleTrack.js";
 export { ImageSubtitleTrack } from "./ImageSubtitleTrack.js";
-export { ExternalSubtitleFile } from "./ExternalSubtitleFile.js";
+// There is deliberately no class for a track that lives in a file of its own.
+// `<name>.mka` is a Matroska container holding an `AudioTrack`, and
+// `MatroskaContainer` reads it exactly as it reads the picture's — so "external"
+// is not a KIND of track, only the answer to where a track's bytes are. That
+// answer belongs to the application layer, which knows about torrents; this one
+// describes what a container declares and must not. `ExternalSubtitleFile`,
+// which asserted the opposite, was never used by anything and is gone.

package/test/audio-inventory.test.js

@@ -0,0 +1,177 @@
+/**
+ * @file One numbered list of soundtracks, from two readings of the same file.
+ *
+ * Two things are being pinned here, and each has cost a real failure elsewhere
+ * in this project:
+ *
+ * 1. **The alignment guard.** The container reading is used ONLY when it can be
+ *    lined up with ffmpeg's own numbering, because `0:a:N` is what the encoder
+ *    is handed — a flag attributed to the wrong track is worse than a missing
+ *    one. Same discipline as `subtitle-defaults.js`, for the same reason.
+ * 2. **The flat numbering.** The browser's menu, the `audioTrackIndex` on a
+ *    session request and the `a/<n>/` address of a rendition are one number.
+ *    Embedded tracks must keep the numbers they have always had, so that a
+ *    session created against an older cached plan means the same thing.
+ */
+
+import test from "node:test";
+import assert from "node:assert/strict";
+import {
+  audioPairingHolds,
+  audioRenditionName,
+  buildAudioInventory,
+  codecNameOf,
+  mergeContainerAudioFlags,
+  resolveAudioIndex
+} from "../services/audio-inventory.js";
+
+test("a pair agreeing on language is accepted", () => {
+  assert.equal(audioPairingHolds({ language: "jpn" }, { language: "jpn" }), true);
+});
+
+test("a pair disagreeing on language is refused", () => {
+  assert.equal(audioPairingHolds({ language: "jpn" }, { language: "rus" }), false);
+});
+
+test("two tracks that say nothing about themselves do not break the alignment", () => {
+  assert.equal(audioPairingHolds({ language: "und", title: "" }, { language: "", name: "" }), true);
+});
+
+test("the container's own flags reach the merged track", () => {
+  const merged = mergeContainerAudioFlags(
+    [
+      { index: 0, language: "eng", title: "", isDefault: true, codec: "aac" },
+      { index: 1, language: "eng", title: "Director", isDefault: true, codec: "ac3" }
+    ],
+    [
+      { language: "eng", name: "", isOriginal: true, isDefault: true, declaresDefault: true, channels: 6 },
+      { language: "eng", name: "Director", isCommentary: true, isDefault: false, declaresDefault: true, channels: 2 }
+    ]
+  );
+  assert.equal(merged.aligned, true);
+  assert.equal(merged.tracks[0].isOriginal, true);
+  assert.equal(merged.tracks[0].channels, 6);
+  assert.equal(merged.tracks[1].isCommentary, true);
+  // Matroska defaults FlagDefault to 1 and ffmpeg prints the applied default, so
+  // the banner said both tracks were default. The container says otherwise.
+  assert.equal(merged.tracks[1].isDefault, false);
+});
+
+test("a count that differs drops the container reading whole", () => {
+  const merged = mergeContainerAudioFlags(
+    [{ index: 0, language: "eng", isDefault: true }],
+    [{ language: "eng" }, { language: "rus" }]
+  );
+  assert.equal(merged.aligned, false);
+  assert.match(merged.reason, /declares 2 audio tracks and the probe found 1/);
+  // Nothing of it is used — not even the flags that happened to line up.
+  assert.equal(merged.tracks[0].isCommentary, false);
+  assert.equal(merged.tracks[0].declaresDefault, false);
+});
+
+test("one pair that agrees on neither language nor title drops it too", () => {
+  const merged = mergeContainerAudioFlags(
+    [{ index: 0, language: "jpn", title: "" }, { index: 1, language: "rus", title: "" }],
+    [{ language: "jpn", name: "" }, { language: "eng", name: "" }]
+  );
+  assert.equal(merged.aligned, false);
+  assert.match(merged.reason, /audio 1 is/);
+});
+
+test("embedded tracks keep the numbers they have always had, sidecars follow", () => {
+  const inventory = buildAudioInventory({
+    embedded: [
+      { language: "jpn", codec: "aac", isDefault: true },
+      { language: "eng", codec: "ac3", title: "Commentary", isCommentary: true }
+    ],
+    videoFileIndex: 24,
+    sidecars: [
+      {
+        file: { fileIndex: 12, name: "ep.mka", folders: ["Rus Sound"], extension: ".mka" },
+        tracks: [{ language: "rus", codecId: "A_AC3", channels: 6 }]
+      }
+    ]
+  });
+
+  assert.deepEqual(inventory.map((entry) => entry.index), [0, 1, 2]);
+  assert.deepEqual(inventory.map((entry) => entry.fileIndex), [24, 24, 12]);
+  assert.deepEqual(inventory.map((entry) => entry.sourceTrackIndex), [0, 1, 0]);
+  assert.deepEqual(inventory.map((entry) => entry.kind), ["embedded", "embedded", "sidecar"]);
+  assert.equal(inventory[2].codec, "ac3");
+  assert.deepEqual(inventory[2].folders, ["Rus Sound"]);
+  assert.equal(inventory[2].fileName, "ep.mka");
+});
+
+test("a sidecar whose table could not be read is still offered, as one track", () => {
+  const inventory = buildAudioInventory({
+    embedded: [{ language: "eng", codec: "aac" }],
+    videoFileIndex: 0,
+    sidecars: [{ file: { fileIndex: 1, name: "dub.ac3", folders: [], extension: ".ac3" }, tracks: [] }]
+  });
+  assert.equal(inventory.length, 2);
+  assert.equal(inventory[1].sourceTrackIndex, 0);
+  // The extension of a bare elementary stream IS its codec.
+  assert.equal(inventory[1].codec, "ac3");
+});
+
+test("a sidecar carrying two tracks contributes both", () => {
+  const inventory = buildAudioInventory({
+    embedded: [],
+    videoFileIndex: 0,
+    sidecars: [
+      {
+        file: { fileIndex: 3, name: "dubs.mka", folders: [], extension: ".mka" },
+        tracks: [{ language: "rus" }, { language: "ukr" }]
+      }
+    ]
+  });
+  assert.deepEqual(inventory.map((entry) => [entry.index, entry.sourceTrackIndex]), [[0, 0], [1, 1]]);
+});
+
+test("the flat number resolves back to a file and a track inside it", () => {
+  const inventory = buildAudioInventory({
+    embedded: [{ language: "jpn" }],
+    videoFileIndex: 24,
+    sidecars: [{ file: { fileIndex: 12, name: "ep.mka", folders: [], extension: ".mka" }, tracks: [{}] }]
+  });
+  assert.equal(resolveAudioIndex(inventory, 1).fileIndex, 12);
+  assert.equal(resolveAudioIndex(inventory, 1).sourceTrackIndex, 0);
+  assert.equal(resolveAudioIndex(inventory, 9), null);
+});
+
+test("codec identifiers are translated to the names the browser judges by", () => {
+  assert.equal(codecNameOf({ codec: "AAC" }), "aac");
+  assert.equal(codecNameOf({ codecId: "A_AC3" }), "ac3");
+  assert.equal(codecNameOf({ codecId: "A_AAC/MPEG4/LC" }), "aac");
+  assert.equal(codecNameOf({ codecId: "A_PCM/INT/LIT" }), "pcm");
+  assert.equal(codecNameOf({ codecId: "ec-3" }), "eac3");
+  assert.equal(codecNameOf({}, ".dts"), "dts");
+  assert.equal(codecNameOf({}, ".unknown"), "");
+});
+
+test("a rendition is named by what the file says, and two never share a name", () => {
+  const inventory = buildAudioInventory({
+    embedded: [{ language: "jpn" }],
+    videoFileIndex: 0,
+    sidecars: [
+      { file: { fileIndex: 1, name: "a.mka", folders: ["Rus Sound"], extension: ".mka" }, tracks: [{}] },
+      { file: { fileIndex: 2, name: "b.mka", folders: ["Rus Sound"], extension: ".mka" }, tracks: [{}] }
+    ]
+  });
+  assert.equal(audioRenditionName(inventory[0], inventory), "jpn");
+  // Both sidecars sit in the same folder and neither names itself, so the names
+  // would collide — and hls.js groups renditions by name.
+  assert.notEqual(
+    audioRenditionName(inventory[1], inventory),
+    audioRenditionName(inventory[2], inventory)
+  );
+});
+
+test("a commentary says so in its rendition name", () => {
+  const inventory = buildAudioInventory({
+    embedded: [{ language: "eng" }, { language: "eng", title: "Director", isCommentary: true }],
+    videoFileIndex: 0,
+    sidecars: []
+  });
+  assert.match(audioRenditionName(inventory[1], inventory), /commentary/);
+});

package/test/sidecar-files.test.js

@@ -0,0 +1,178 @@
+/**
+ * @file Which files of a torrent are one video file's sound and subtitles.
+ *
+ * The case these were written against is a real torrent, and every name below
+ * is copied from it: `Drifters`, twelve episodes as `.mkv` in the root, twelve
+ * Russian soundtracks as `.mka` under `Rus Sound/`, twelve subtitle files under
+ * `Sub/[Stan WarHammer & Nesitach]/`, all sharing one base name per episode.
+ *
+ * The rule that matters most is the one about a torrent with SEVERAL videos: a
+ * sidecar is taken only when its name pairs with this episode's, because a
+ * wrong pairing would put the sound of episode 2 over the picture of episode 7
+ * and nothing downstream could notice.
+ */
+
+import test from "node:test";
+import assert from "node:assert/strict";
+import {
+  baseNameOf,
+  bracketTokensOf,
+  countVideoFiles,
+  extensionOf,
+  matchSidecarFiles,
+  namesPair,
+  splitTorrentPath
+} from "../services/sidecar-files.js";
+
+/**
+ * The Drifters torrent, as WebTorrent reports it: every path prefixed with the
+ * torrent's own name.
+ *
+ * @param {number} episodes
+ * @returns {Array<{ path: string, name: string, length: number }>}
+ */
+function driftersFiles(episodes = 3) {
+  const files = [];
+  const push = (relative, length) => {
+    const name = relative.slice(relative.lastIndexOf("/") + 1);
+    files.push({ path: `Drifters/${relative}`, name, length });
+  };
+  for (let episode = 1; episode <= episodes; episode += 1) {
+    const stem = `[HorribleSubs] Drifters - ${String(episode).padStart(2, "0")} [1080p]`;
+    push(`Sub/[Stan WarHammer & Nesitach]/${stem}.ass`, 29_000);
+    push(`Rus Sound/${stem}.mka`, 30_000_000);
+    push(`${stem}.mkv`, 566_000_000);
+  }
+  return files;
+}
+
+test("a path is split into folders and a name, with the torrent's own name removed", () => {
+  const split = splitTorrentPath("Drifters/Rus Sound/[HorribleSubs] Drifters - 02 [1080p].mka", "Drifters");
+  assert.deepEqual(split.folders, ["Rus Sound"]);
+  assert.equal(split.name, "[HorribleSubs] Drifters - 02 [1080p].mka");
+});
+
+test("a path that does not begin with the torrent name is left alone", () => {
+  const split = splitTorrentPath("Sub/x.ass", "Drifters");
+  assert.deepEqual(split.folders, ["Sub"]);
+  assert.equal(split.name, "x.ass");
+});
+
+test("extension and base name", () => {
+  assert.equal(extensionOf("[HorribleSubs] Drifters - 02 [1080p].mka"), ".mka");
+  assert.equal(extensionOf("no-extension"), "");
+  assert.equal(extensionOf(".hidden"), "");
+  assert.equal(baseNameOf("a.b.mkv"), "a.b");
+});
+
+test("bracketed groups are read in order", () => {
+  assert.deepEqual(
+    bracketTokensOf("[HorribleSubs] Drifters - 02 [1080p]"),
+    ["HorribleSubs", "1080p"]
+  );
+  assert.deepEqual(bracketTokensOf("nothing here"), []);
+});
+
+test("equal base names pair, whatever folder each sits in", () => {
+  assert.equal(
+    namesPair("[HorribleSubs] Drifters - 02 [1080p].mka", "[HorribleSubs] Drifters - 02 [1080p].mkv"),
+    true
+  );
+  assert.equal(
+    namesPair("[HorribleSubs] Drifters - 03 [1080p].mka", "[HorribleSubs] Drifters - 02 [1080p].mkv"),
+    false
+  );
+});
+
+test("a shared release hash pairs two differently named files", () => {
+  assert.equal(namesPair("Ep01_rus [A1B2C3D4].mka", "[Group] Ep 01 [A1B2C3D4].mkv"), true);
+  assert.equal(namesPair("Ep01_rus [11112222].mka", "[Group] Ep 01 [A1B2C3D4].mkv"), false);
+});
+
+test("the sound and the subtitles of THIS episode are found, and no other's", () => {
+  const files = driftersFiles(3);
+  // Episode 2's picture: index 5 in the list built above.
+  const videoIndex = files.findIndex((file) => file.name === "[HorribleSubs] Drifters - 02 [1080p].mkv");
+  const matched = matchSidecarFiles({
+    files,
+    videoIndex,
+    torrentName: "Drifters",
+    videoCount: countVideoFiles(files)
+  });
+
+  assert.equal(matched.audio.length, 1);
+  assert.equal(matched.audio[0].name, "[HorribleSubs] Drifters - 02 [1080p].mka");
+  assert.deepEqual(matched.audio[0].folders, ["Rus Sound"]);
+  assert.equal(matched.audio[0].extension, ".mka");
+  // A `.mka` is Matroska, so its own track table can be read — which is the
+  // whole reason no new container class was needed for a separate soundtrack.
+  assert.equal(matched.audio[0].declaresTracks, true);
+
+  assert.equal(matched.subtitles.length, 1);
+  assert.equal(matched.subtitles[0].name, "[HorribleSubs] Drifters - 02 [1080p].ass");
+  assert.deepEqual(matched.subtitles[0].folders, ["Sub", "[Stan WarHammer & Nesitach]"]);
+});
+
+test("the picture itself is never its own sidecar", () => {
+  const files = driftersFiles(1);
+  const videoIndex = files.findIndex((file) => file.name.endsWith(".mkv"));
+  const matched = matchSidecarFiles({ files, videoIndex, torrentName: "Drifters", videoCount: 1 });
+  assert.equal(matched.audio.some((entry) => entry.fileIndex === videoIndex), false);
+});
+
+test("a torrent with one picture takes every sidecar, however it is named", () => {
+  const files = [
+    { path: "Film/Film.2019.1080p.mkv", name: "Film.2019.1080p.mkv", length: 5_000_000_000 },
+    { path: "Film/Rus.mka", name: "Rus.mka", length: 300_000_000 },
+    { path: "Film/subs/forced.srt", name: "forced.srt", length: 4_000 }
+  ];
+  const matched = matchSidecarFiles({
+    files,
+    videoIndex: 0,
+    torrentName: "Film",
+    videoCount: countVideoFiles(files)
+  });
+  assert.deepEqual(matched.audio.map((entry) => entry.name), ["Rus.mka"]);
+  assert.deepEqual(matched.subtitles.map((entry) => entry.name), ["forced.srt"]);
+});
+
+test("a torrent with several pictures does NOT take a sidecar that names none of them", () => {
+  const files = [
+    { path: "Pack/Ep01.mkv", name: "Ep01.mkv", length: 100 },
+    { path: "Pack/Ep02.mkv", name: "Ep02.mkv", length: 100 },
+    { path: "Pack/Sound/Something Else.mka", name: "Something Else.mka", length: 100 }
+  ];
+  const matched = matchSidecarFiles({
+    files,
+    videoIndex: 0,
+    torrentName: "Pack",
+    videoCount: countVideoFiles(files)
+  });
+  assert.deepEqual(matched.audio, []);
+});
+
+test("files of no interest are ignored", () => {
+  const files = [
+    { path: "X/film.mkv", name: "film.mkv", length: 100 },
+    { path: "X/film.nfo", name: "film.nfo", length: 10 },
+    { path: "X/cover.jpg", name: "cover.jpg", length: 10 }
+  ];
+  const matched = matchSidecarFiles({ files, videoIndex: 0, torrentName: "X", videoCount: 1 });
+  assert.deepEqual(matched.audio, []);
+  assert.deepEqual(matched.subtitles, []);
+});
+
+test("a raw elementary stream is recognised but declares no tracks of its own", () => {
+  const files = [
+    { path: "X/film.mkv", name: "film.mkv", length: 100 },
+    { path: "X/film.ac3", name: "film.ac3", length: 100 }
+  ];
+  const matched = matchSidecarFiles({ files, videoIndex: 0, torrentName: "X", videoCount: 1 });
+  assert.equal(matched.audio.length, 1);
+  assert.equal(matched.audio[0].declaresTracks, false);
+});
+
+test("pictures are counted, and nothing else is", () => {
+  assert.equal(countVideoFiles(driftersFiles(12)), 12);
+  assert.equal(countVideoFiles([{ name: "a.mka" }, { name: "b.srt" }]), 0);
+});

package/services/tracks/ExternalSubtitleFile.js

@@ -1,27 +0,0 @@
-/**
- * @file External subtitle file — not part of the media container, but shares TextSubtitleTrack API.
- *
- * A standalone .srt/.ass/.ssa/.vtt file beside the video in the same torrent.
- * Has no container flags; language comes from filename suffix or franc detection.
- */
-
-export class ExternalSubtitleFile {
-  /**
-   * @param {object} params
-   * @param {string} params.fileName
-   * @param {number} params.fileIndex - Torrent file index.
-   * @param {string} params.extension - ".srt" etc. lowercased.
-   * @param {string} params.language - Hint from filename or "".
-   */
-  constructor({ fileName, fileIndex, extension, language = "" }) {
-    this.fileName = fileName;
-    this.fileIndex = fileIndex;
-    this.extension = extension;
-    this.language = language;
-    this.type = "external-subtitle";
-  }
-
-  isTextBased() {
-    return true;
-  }
-}