@torrent-tv/proxy 2.88.6 → 2.89.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/AGENTS.md +21 -12
  2. package/CHANGELOG.md +17 -3
  3. package/assets/calibration/audio/NOTICE.md +19 -19
  4. package/assets/calibration/audio/manifest.json +98 -98
  5. package/docs/container-architecture.md +77 -22
  6. package/docs/playback-start-forecast.md +56 -56
  7. package/main2.cpuprofile +1 -0
  8. package/package.json +1 -1
  9. package/scripts/build-audio-samples.mjs +31 -31
  10. package/server.js +42 -27
  11. package/services/encode/OutputOpening.js +5 -4
  12. package/services/encode/audio-calibration.js +67 -67
  13. package/services/encode/audio-work-rate.js +15 -15
  14. package/services/media/ContainerOrchestrator.js +99 -46
  15. package/services/media/KeyframeTables.js +61 -21
  16. package/services/media/SubtitleCues.js +255 -183
  17. package/services/media/container/AviContainer.js +5 -3
  18. package/services/media/container/Container.js +66 -43
  19. package/services/media/container/ContainerFactory.js +8 -26
  20. package/services/media/container/MatroskaContainer.js +719 -1182
  21. package/services/media/container/Mp4Container.js +83 -73
  22. package/services/media/container/ebml-stream.js +174 -0
  23. package/services/media/container/matroska-clusters.js +1165 -0
  24. package/services/media/container/unavailable.js +77 -0
  25. package/services/media/tracks/ContainerTrack.js +9 -0
  26. package/services/media/tracks/TextSubtitleTrack.js +9 -1
  27. package/services/server/playback-readiness.js +516 -516
  28. package/services/torrent/worker/client.js +6 -2
  29. package/services/torrent/worker/held-bytes.js +84 -8
  30. package/services/torrent/worker/worker.js +10 -2
  31. package/services/transport/data-channel-handler.js +7 -3
  32. package/services/viewer/PriorityMap.js +31 -0
  33. package/test/audio-calibration.test.js +23 -23
  34. package/test/coalesce.test.js +39 -0
  35. package/test/held-read-ownership.test.js +77 -0
  36. package/test/helpers/held-file.js +50 -2
  37. package/test/helpers/matroska-file.js +296 -0
  38. package/test/keyframe-table-budget.test.js +21 -0
  39. package/test/matroska-cluster-discovery.test.js +323 -0
  40. package/test/reads-not-yet-arrived.test.js +218 -0
  41. package/test/subtitle-cue-walk.test.js +16 -1
  42. package/test/subtitle-plan-waits.test.js +125 -0
  43. package/test/subtitle-track-numbering.test.js +8 -3
  44. package/test/viewer-starts-on-map.test.js +27 -0
  45. package/utils/coalesce.js +41 -0
@@ -0,0 +1,296 @@
1
+ /**
2
+ * @file Synthetic Matroska files for the checks — built element by element,
3
+ * so every check states exactly what the file says and where.
4
+ *
5
+ * Positions inside the Segment are known only after the elements before them
6
+ * are built, so a file is described as a list of top-level elements, and the
7
+ * SeekHead and Cues that point at others are built from the lengths of the
8
+ * rest (all positions are fixed-width, so they do not change the lengths they
9
+ * are computed from).
10
+ */
11
+
12
+ import { crc32 } from "node:zlib";
13
+
14
+ export const ID = {
15
+ EBML: 0x1a45dfa3,
16
+ SEGMENT: 0x18538067,
17
+ SEEK_HEAD: 0x114d9b74,
18
+ SEEK: 0x4dbb,
19
+ SEEK_ID: 0x53ab,
20
+ SEEK_POSITION: 0x53ac,
21
+ INFO: 0x1549a966,
22
+ TIMESTAMP_SCALE: 0x2ad7b1,
23
+ TRACKS: 0x1654ae6b,
24
+ TRACK_ENTRY: 0xae,
25
+ TRACK_NUMBER: 0xd7,
26
+ TRACK_TYPE: 0x83,
27
+ CODEC_ID: 0x86,
28
+ LANGUAGE: 0x22b59c,
29
+ LANGUAGE_BCP47: 0x22b59d,
30
+ NAME: 0x536e,
31
+ CUES: 0x1c53bb6b,
32
+ CUE_POINT: 0xbb,
33
+ CUE_TIME: 0xb3,
34
+ CUE_TRACK_POSITIONS: 0xb7,
35
+ CUE_TRACK: 0xf7,
36
+ CUE_CLUSTER_POSITION: 0xf1,
37
+ CLUSTER: 0x1f43b675,
38
+ TIMESTAMP: 0xe7,
39
+ CRC32: 0xbf,
40
+ SIMPLE_BLOCK: 0xa3,
41
+ BLOCK_GROUP: 0xa0,
42
+ BLOCK: 0xa1,
43
+ BLOCK_DURATION: 0x9b,
44
+ VOID: 0xec
45
+ };
46
+
47
+ /** @param {number} id @returns {Buffer} */
48
+ export function idBytes(id) {
49
+ const bytes = [];
50
+ let rest = id;
51
+ while (rest > 0) {
52
+ bytes.unshift(rest & 0xff);
53
+ rest = Math.floor(rest / 256);
54
+ }
55
+ return Buffer.from(bytes);
56
+ }
57
+
58
+ /** A four-byte size: a valid vint whatever the payload. @param {number} size */
59
+ function sizeBytes(size) {
60
+ const buffer = Buffer.alloc(4);
61
+ buffer.writeUInt32BE(size, 0);
62
+ buffer[0] |= 0x10;
63
+ return buffer;
64
+ }
65
+
66
+ /** @param {number} id @param {Buffer} payload @returns {Buffer} */
67
+ export function element(id, payload) {
68
+ return Buffer.concat([idBytes(id), sizeBytes(payload.length), payload]);
69
+ }
70
+
71
+ /** An element whose size field says "unknown" (one byte, all value bits set). */
72
+ export function unknownSizeElement(id, payload) {
73
+ return Buffer.concat([idBytes(id), Buffer.from([0xff]), payload]);
74
+ }
75
+
76
+ /** @param {number} id @param {number} value */
77
+ export function uintElement(id, value) {
78
+ const bytes = [];
79
+ let rest = value;
80
+ do {
81
+ bytes.unshift(rest & 0xff);
82
+ rest = Math.floor(rest / 256);
83
+ } while (rest > 0);
84
+ return element(id, Buffer.from(bytes));
85
+ }
86
+
87
+ /** A fixed-width unsigned integer, so a position computed twice keeps its length. */
88
+ export function uint32Element(id, value) {
89
+ const payload = Buffer.alloc(4);
90
+ payload.writeUInt32BE(value, 0);
91
+ return element(id, payload);
92
+ }
93
+
94
+ /** @param {number} id @param {string} value */
95
+ export function stringElement(id, value) {
96
+ return element(id, Buffer.from(value, "utf8"));
97
+ }
98
+
99
+ /**
100
+ * @param {{ number: number, type: number, codecId: string, language?: string | null, languageBcp47?: string, name?: string }} track
101
+ * @returns {Buffer}
102
+ */
103
+ export function trackEntry({ number, type, codecId, language = null, languageBcp47 = "", name = "" }) {
104
+ const parts = [uintElement(ID.TRACK_NUMBER, number), uintElement(ID.TRACK_TYPE, type), stringElement(ID.CODEC_ID, codecId)];
105
+ if (language !== null) {
106
+ parts.push(stringElement(ID.LANGUAGE, language));
107
+ }
108
+ if (languageBcp47) {
109
+ parts.push(stringElement(ID.LANGUAGE_BCP47, languageBcp47));
110
+ }
111
+ if (name) {
112
+ parts.push(stringElement(ID.NAME, name));
113
+ }
114
+ return element(ID.TRACK_ENTRY, Buffer.concat(parts));
115
+ }
116
+
117
+ /**
118
+ * One cue, as a BlockGroup carrying its own duration.
119
+ *
120
+ * @param {{ track: number, relativeTicks: number, durationTicks: number, text: string }} params
121
+ */
122
+ export function cueBlock({ track, relativeTicks, durationTicks, text }) {
123
+ const header = Buffer.alloc(4);
124
+ header[0] = 0x80 | track;
125
+ header.writeInt16BE(relativeTicks, 1);
126
+ header[3] = 0;
127
+ const block = element(ID.BLOCK, Buffer.concat([header, Buffer.from(text, "utf8")]));
128
+ return element(ID.BLOCK_GROUP, Buffer.concat([block, uintElement(ID.BLOCK_DURATION, durationTicks)]));
129
+ }
130
+
131
+ /**
132
+ * A picture block: a SimpleBlock of `payload` bytes on `track`.
133
+ *
134
+ * @param {{ track: number, payload: Buffer }} params
135
+ */
136
+ export function pictureBlock({ track, payload }) {
137
+ const header = Buffer.alloc(4);
138
+ header[0] = 0x80 | track;
139
+ header.writeInt16BE(0, 1);
140
+ header[3] = 0x80;
141
+ return element(ID.SIMPLE_BLOCK, Buffer.concat([header, payload]));
142
+ }
143
+
144
+ /**
145
+ * A cluster's DATA: its Timestamp (optionally after a CRC-32) and its blocks.
146
+ *
147
+ * @param {{ ticks: number, blocks: Buffer[], crc?: boolean | "wrong" }} params
148
+ * @returns {Buffer}
149
+ */
150
+ export function clusterData({ ticks, blocks, crc = false }) {
151
+ const rest = Buffer.concat([uintElement(ID.TIMESTAMP, ticks), ...blocks]);
152
+ if (!crc) {
153
+ return rest;
154
+ }
155
+ const value = Buffer.alloc(4);
156
+ value.writeUInt32LE(crc === "wrong" ? (crc32(rest) ^ 0xffffffff) >>> 0 : crc32(rest), 0);
157
+ return Buffer.concat([Buffer.concat([idBytes(ID.CRC32), Buffer.from([0x84]), value]), rest]);
158
+ }
159
+
160
+ /**
161
+ * A whole file.
162
+ *
163
+ * `clusters` are each `{ data, unknownSize? }`. `cues` says which tracks the
164
+ * Cues table names for every cluster: an array of track numbers, or null for
165
+ * no Cues element at all. `cuesBeforeClusters` puts the Cues element ahead of
166
+ * the clusters with no SeekHead entry for it.
167
+ *
168
+ * @param {object} params
169
+ * @param {Buffer[]} params.tracks - TrackEntry elements.
170
+ * @param {Array<{ data: Buffer, unknownSize?: boolean, ticks: number }>} params.clusters
171
+ * @param {number[] | null} [params.cues]
172
+ * @param {boolean} [params.cuesBeforeClusters]
173
+ * @returns {{ file: Buffer, clusterAt: number[], cuesAt: number | null, segmentDataOffset: number }}
174
+ */
175
+ export function buildMatroska({ tracks, clusters, cues = [], cuesBeforeClusters = false }) {
176
+ const info = element(ID.INFO, uintElement(ID.TIMESTAMP_SCALE, 1_000_000));
177
+ const tracksElement = element(ID.TRACKS, Buffer.concat(tracks));
178
+ const clusterElements = clusters.map((cluster) =>
179
+ cluster.unknownSize ? unknownSizeElement(ID.CLUSTER, cluster.data) : element(ID.CLUSTER, cluster.data)
180
+ );
181
+
182
+ const cuesWith = (positions) =>
183
+ cues === null
184
+ ? Buffer.alloc(0)
185
+ : element(
186
+ ID.CUES,
187
+ Buffer.concat(
188
+ clusters.map((cluster, index) =>
189
+ element(
190
+ ID.CUE_POINT,
191
+ Buffer.concat([
192
+ uint32Element(ID.CUE_TIME, cluster.ticks),
193
+ ...cues.map((track) =>
194
+ element(
195
+ ID.CUE_TRACK_POSITIONS,
196
+ Buffer.concat([uintElement(ID.CUE_TRACK, track), uint32Element(ID.CUE_CLUSTER_POSITION, positions[index])])
197
+ )
198
+ )
199
+ ])
200
+ )
201
+ )
202
+ )
203
+ );
204
+ const seekEntry = (targetId, position) =>
205
+ element(ID.SEEK, Buffer.concat([element(ID.SEEK_ID, idBytes(targetId)), uint32Element(ID.SEEK_POSITION, position)]));
206
+ const seekHeadWith = (infoAt, tracksAt, cuesAt) =>
207
+ element(
208
+ ID.SEEK_HEAD,
209
+ Buffer.concat([
210
+ seekEntry(ID.INFO, infoAt),
211
+ seekEntry(ID.TRACKS, tracksAt),
212
+ ...(cues !== null && !cuesBeforeClusters ? [seekEntry(ID.CUES, cuesAt)] : [])
213
+ ])
214
+ );
215
+
216
+ const zeros = clusters.map(() => 0);
217
+ const headLength = seekHeadWith(0, 0, 0).length;
218
+ const infoAt = headLength;
219
+ const tracksAt = infoAt + info.length;
220
+ const cuesLength = cuesWith(zeros).length;
221
+ const firstClusterAt = tracksAt + tracksElement.length + (cuesBeforeClusters ? cuesLength : 0);
222
+ const positions = [];
223
+ let at = firstClusterAt;
224
+ for (const cluster of clusterElements) {
225
+ positions.push(at);
226
+ at += cluster.length;
227
+ }
228
+ const cuesAt = cues === null ? null : cuesBeforeClusters ? tracksAt + tracksElement.length : at;
229
+ const parts = [seekHeadWith(infoAt, tracksAt, cuesAt ?? 0), info, tracksElement];
230
+ if (cuesBeforeClusters) {
231
+ parts.push(cuesWith(positions));
232
+ }
233
+ parts.push(...clusterElements);
234
+ if (!cuesBeforeClusters) {
235
+ parts.push(cuesWith(positions));
236
+ }
237
+ const payload = Buffer.concat(parts);
238
+ const ebml = element(ID.EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
239
+ const segment = element(ID.SEGMENT, payload);
240
+ const segmentDataOffset = ebml.length + segment.length - payload.length;
241
+ return {
242
+ file: Buffer.concat([ebml, segment]),
243
+ clusterAt: positions.map((position) => segmentDataOffset + position),
244
+ cuesAt: cuesAt === null ? null : segmentDataOffset + cuesAt,
245
+ segmentDataOffset
246
+ };
247
+ }
248
+
249
+ /**
250
+ * A reader over a buffer that answers null for the ranges a check says are
251
+ * not here, and records every range asked for.
252
+ *
253
+ * @param {Buffer} bytes
254
+ * @param {{ missing?: (start: number, end: number) => boolean, short?: boolean }} [options]
255
+ */
256
+ export function readerOver(bytes, options = {}) {
257
+ const reads = [];
258
+ const read = async (start, end) => {
259
+ reads.push({ start, end });
260
+ if (options.missing?.(start, end)) {
261
+ return null;
262
+ }
263
+ const slice = bytes.subarray(start, end + 1);
264
+ return options.short ? slice.subarray(0, Math.max(0, slice.length - 1)) : Buffer.from(slice);
265
+ };
266
+ return { read, reads };
267
+ }
268
+
269
+ /**
270
+ * What the cue walk may read: the held ranges, a strict read of them, a
271
+ * portion and where viewers stand.
272
+ *
273
+ * @param {Buffer} bytes
274
+ * @param {Array<[number, number]>} ranges
275
+ * @param {{ portionBytes?: number, wantedSeconds?: number[], reads?: Array<{ start: number, end: number }> }} [options]
276
+ * @returns {import("../../services/media/container/Container.js").HeldReader}
277
+ */
278
+ export function heldOver(bytes, ranges, options = {}) {
279
+ const holds = (start, end) => ranges.some(([from, to]) => start >= from && end <= to);
280
+ return {
281
+ ranges,
282
+ isHeld: (start, end) => holds(start, Math.min(end, bytes.length - 1)),
283
+ read: async (start, end) => {
284
+ options.reads?.push({ start, end });
285
+ const last = Math.min(end, bytes.length - 1);
286
+ if (!holds(start, last)) {
287
+ const error = new Error(`bytes ${start}-${last} are not available yet`);
288
+ error.name = "BytesUnavailable";
289
+ throw error;
290
+ }
291
+ return Buffer.from(bytes.subarray(start, last + 1));
292
+ },
293
+ portionBytes: options.portionBytes ?? Number.POSITIVE_INFINITY,
294
+ wantedSeconds: options.wantedSeconds ?? []
295
+ };
296
+ }
@@ -17,6 +17,7 @@
17
17
  import test from "node:test";
18
18
  import assert from "node:assert/strict";
19
19
  import { KeyframeTables } from "../services/media/KeyframeTables.js";
20
+ import { BytesUnavailable } from "../services/media/container/unavailable.js";
20
21
 
21
22
  const QUIET = { info: () => {}, warn: () => {} };
22
23
 
@@ -100,3 +101,23 @@ test("a read that fails is not turned into a bounded wait's silence", async () =
100
101
  "a read that threw is a different thing from a read that is still running"
101
102
  );
102
103
  });
104
+
105
+ test("bytes not downloaded yet are a table that has not arrived, and the next arrival reads again", async () => {
106
+ let calls = 0;
107
+ const keyframes = tables(1_000, async () => {
108
+ calls += 1;
109
+ if (calls === 1) {
110
+ throw new BytesUnavailable(100, 199, 0);
111
+ }
112
+ return { times: [0, 4], tolerance: 0, format: "matroska" };
113
+ });
114
+
115
+ const { table, arrived } = await keyframes.within(FILE);
116
+ assert.equal(arrived, false, "the opening goes on and re-encodes; it is not failed over a shortage of bytes");
117
+ assert.equal(table.answered, false, "missing bytes say nothing about the file's keyframes");
118
+
119
+ keyframes.readAgainIfUnanswered(FILE);
120
+ await keyframes.read(FILE);
121
+ assert.equal(calls, 2);
122
+ assert.deepEqual(keyframes.of(FILE).times, [0, 4]);
123
+ });
@@ -0,0 +1,323 @@
1
+ /**
2
+ * @file Where a Matroska file's clusters are, found from what is downloaded —
3
+ * and what is read out of them, in what order, within what memory.
4
+ *
5
+ * RFC 9559 §22.1 says each subtitle frame SHOULD be named by the Cues table, and
6
+ * a file may have no Cues at all. Until 2026-10-01 such a file showed no
7
+ * subtitles ever. Every check builds a file element by element, says which
8
+ * byte ranges are "downloaded", and runs passes of the walk the way arriving
9
+ * pieces would. Fakes only.
10
+ */
11
+
12
+ import test from "node:test";
13
+ import assert from "node:assert/strict";
14
+
15
+ import { MatroskaContainer } from "../services/media/container/MatroskaContainer.js";
16
+ import {
17
+ ID,
18
+ buildMatroska,
19
+ clusterData,
20
+ cueBlock,
21
+ element,
22
+ heldOver,
23
+ idBytes,
24
+ pictureBlock,
25
+ readerOver,
26
+ trackEntry
27
+ } from "./helpers/matroska-file.js";
28
+
29
+ const TRACKS = [
30
+ trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "jpn" }),
31
+ trackEntry({ number: 2, type: 17, codecId: "S_TEXT/UTF8" })
32
+ ];
33
+
34
+ /** One cluster a second-and-a-bit long with one line on track 2 and a picture. */
35
+ function plainCluster(ticks, text, picture = Buffer.alloc(16, 7)) {
36
+ return {
37
+ ticks,
38
+ data: clusterData({
39
+ ticks,
40
+ blocks: [pictureBlock({ track: 1, payload: picture }), cueBlock({ track: 2, relativeTicks: 0, durationTicks: 900, text })]
41
+ })
42
+ };
43
+ }
44
+
45
+ async function planOf(file) {
46
+ const { read } = readerOver(file);
47
+ const container = new MatroskaContainer({ readRange: read, fileSize: file.length });
48
+ return { container, plan: await container.readSubtitlePlan() };
49
+ }
50
+
51
+ async function pass(container, plan, progress, held) {
52
+ const result = await container.readHeldCues(plan, plan.tracks[0], progress, held);
53
+ return { ...result, texts: (result.found.get(2) ?? []).map((cue) => cue.text) };
54
+ }
55
+
56
+ test("a Cues table that names only the picture still leads to every subtitle line", async () => {
57
+ const { file } = buildMatroska({
58
+ tracks: TRACKS,
59
+ cues: [1],
60
+ clusters: [plainCluster(0, "a"), plainCluster(10_000, "b"), plainCluster(20_000, "c")]
61
+ });
62
+ const { container, plan } = await planOf(file);
63
+ assert.equal(plan.cuesState, "complete");
64
+ assert.deepEqual(plan.tracks[0].clusterPositions, [], "the table names no cluster for the subtitle track");
65
+ const result = await pass(container, plan, {}, heldOver(file, [[0, file.length - 1]]));
66
+ assert.deepEqual(result.texts.sort(), ["a", "b", "c"]);
67
+ });
68
+
69
+ test("with no Cues, the chain reads what is joined up and the search finds what lies past a gap", async () => {
70
+ const { file, clusterAt } = buildMatroska({
71
+ tracks: TRACKS,
72
+ cues: null,
73
+ clusters: [plainCluster(0, "a"), plainCluster(10_000, "b"), plainCluster(20_000, "c"), plainCluster(30_000, "d")]
74
+ });
75
+ const { container, plan } = await planOf(file);
76
+ assert.equal(plan.cuesState, "absent");
77
+ const progress = {};
78
+ const gap = [clusterAt[2], clusterAt[3] - 1];
79
+ const first = await pass(container, plan, progress, heldOver(file, [[0, gap[0] - 1], [gap[1] + 1, file.length - 1]]));
80
+ assert.deepEqual(first.texts.sort(), ["a", "b", "d"], "the third cluster is not downloaded; the fourth is found by searching");
81
+ assert.equal(first.stats.fromSearch, 1);
82
+
83
+ const second = await pass(container, plan, progress, heldOver(file, [[0, file.length - 1]]));
84
+ assert.deepEqual(second.texts, ["c"], "the gap filled: the chain reaches the third, and nothing is read twice");
85
+ assert.deepEqual(second.withdrawn, [], "the search was right, so nothing is taken back");
86
+ });
87
+
88
+ test("the walk reads the structure of a cluster, not the frames of its picture", async () => {
89
+ // Pictures of 64 KB: a walk that read them would move them all.
90
+ const picture = Buffer.alloc(64 * 1024, 7);
91
+ const { file } = buildMatroska({
92
+ tracks: TRACKS,
93
+ cues: [1],
94
+ clusters: [plainCluster(0, "a", picture), plainCluster(10_000, "b", picture), plainCluster(20_000, "c", picture)]
95
+ });
96
+ const { container, plan } = await planOf(file);
97
+ const reads = [];
98
+ const held = heldOver(file, [[0, file.length - 1]], { portionBytes: 4 * 1024 * 1024, reads });
99
+ const result = await pass(container, plan, {}, held);
100
+ assert.deepEqual(result.texts.sort(), ["a", "b", "c"]);
101
+ const moved = reads.reduce((sum, { start, end }) => sum + (end - start + 1), 0);
102
+ assert.ok(moved < picture.length, `${moved} bytes read for three clusters of ${picture.length}-byte pictures`);
103
+ });
104
+
105
+ test("with no Cues, the search stops at the first cluster it accepts and the chain knows the rest", async () => {
106
+ const picture = Buffer.alloc(64 * 1024, 7);
107
+ const { file, clusterAt } = buildMatroska({
108
+ tracks: TRACKS,
109
+ cues: null,
110
+ clusters: [0, 10_000, 20_000, 30_000, 40_000].map((ticks, index) => plainCluster(ticks, String(index), picture))
111
+ });
112
+ const { container, plan } = await planOf(file);
113
+ const reads = [];
114
+ // The first cluster's header is not here, so nothing establishes the chain:
115
+ // only the search can start it.
116
+ const held = heldOver(file, [[0, clusterAt[0] - 1], [clusterAt[0] + 12, file.length - 1]], { portionBytes: 32 * 1024, reads });
117
+ const result = await pass(container, plan, {}, held);
118
+ assert.deepEqual(result.texts.sort(), ["1", "2", "3", "4"]);
119
+ assert.equal(result.stats.fromSearch, 4, "found by the search, then by its chain");
120
+ const searchedPast = reads.filter(({ start }) => start > clusterAt[2]).reduce((sum, { start, end }) => sum + (end - start + 1), 0);
121
+ assert.ok(searchedPast < picture.length, `${searchedPast} bytes read past the third cluster`);
122
+ });
123
+
124
+ test("a Cluster id inside a picture's bytes is checked and refused, and gives no line", async () => {
125
+ // An id, a plausible size and some bytes — inside a SimpleBlock's payload.
126
+ const fake = Buffer.concat([idBytes(ID.CLUSTER), Buffer.from([0x88]), Buffer.alloc(8, 0x41)]);
127
+ const { file, clusterAt } = buildMatroska({
128
+ tracks: TRACKS,
129
+ cues: null,
130
+ clusters: [plainCluster(0, "a"), plainCluster(10_000, "b", Buffer.concat([Buffer.alloc(8), fake, Buffer.alloc(8)]))]
131
+ });
132
+ const { container, plan } = await planOf(file);
133
+ // The second cluster's own header is not downloaded, so nothing establishes it.
134
+ const result = await pass(
135
+ container,
136
+ plan,
137
+ {},
138
+ heldOver(file, [[0, clusterAt[1] - 1], [clusterAt[1] + 12, file.length - 1]])
139
+ );
140
+ assert.deepEqual(result.texts, ["a"]);
141
+ assert.ok(result.stats.rejectedCandidates >= 1, "the false start was looked at and refused");
142
+ });
143
+
144
+ test("a candidate that a cluster the file establishes later turns out to contain is taken back, with its lines", async () => {
145
+ // A whole, well-formed cluster hidden inside a picture block of a real one.
146
+ const hidden = element(
147
+ ID.CLUSTER,
148
+ clusterData({ ticks: 12_000, blocks: [cueBlock({ track: 2, relativeTicks: 0, durationTicks: 500, text: "hidden" })] })
149
+ );
150
+ const { file, clusterAt } = buildMatroska({
151
+ tracks: TRACKS,
152
+ cues: null,
153
+ clusters: [
154
+ plainCluster(0, "a"),
155
+ plainCluster(10_000, "b", Buffer.concat([Buffer.alloc(4), hidden, Buffer.alloc(4)])),
156
+ plainCluster(20_000, "c")
157
+ ]
158
+ });
159
+ const { container, plan } = await planOf(file);
160
+ const progress = {};
161
+ const hiddenAt = file.indexOf(hidden);
162
+ const first = await pass(
163
+ container,
164
+ plan,
165
+ progress,
166
+ heldOver(file, [[0, clusterAt[1] - 1], [clusterAt[1] + 12, file.length - 1]])
167
+ );
168
+ assert.ok(first.texts.includes("hidden"), "the search found it and its structure held");
169
+
170
+ const second = await pass(container, plan, progress, heldOver(file, [[0, file.length - 1]]));
171
+ assert.deepEqual(second.withdrawn, [hiddenAt], "the real cluster around it takes it back");
172
+ assert.deepEqual(second.texts, ["b"], "and gives its own line");
173
+ });
174
+
175
+ test("a cluster whose bytes are only partly here is read once, when they all are", async () => {
176
+ const { file, clusterAt } = buildMatroska({
177
+ tracks: TRACKS,
178
+ cues: [1],
179
+ clusters: [plainCluster(0, "a"), plainCluster(10_000, "b")]
180
+ });
181
+ const { container, plan } = await planOf(file);
182
+ const progress = {};
183
+ const partly = await pass(container, plan, progress, heldOver(file, [[0, clusterAt[1] + 20]]));
184
+ assert.deepEqual(partly.texts, ["a"]);
185
+ const whole = await pass(container, plan, progress, heldOver(file, [[0, file.length - 1]]));
186
+ assert.deepEqual(whole.texts, ["b"]);
187
+ const again = await pass(container, plan, progress, heldOver(file, [[0, file.length - 1]]));
188
+ assert.deepEqual(again.texts, [], "nothing is read twice");
189
+ });
190
+
191
+ test("a cluster of unknown size ends where the next top-level element begins", async () => {
192
+ const { file } = buildMatroska({
193
+ tracks: TRACKS,
194
+ cues: null,
195
+ clusters: [plainCluster(0, "a"), { ...plainCluster(10_000, "b"), unknownSize: true }, plainCluster(20_000, "c")]
196
+ });
197
+ const { container, plan } = await planOf(file);
198
+ const progress = {};
199
+ const held = heldOver(file, [[0, file.length - 1]]);
200
+ const first = await pass(container, plan, progress, held);
201
+ const second = await pass(container, plan, progress, held);
202
+ assert.deepEqual([...first.texts, ...second.texts].sort(), ["a", "b", "c"]);
203
+ });
204
+
205
+ test("a CRC-32 before the Timestamp is a cluster like any other; a candidate whose CRC is wrong is refused", async () => {
206
+ const withCrc = (ticks, text, crc) => ({
207
+ ticks,
208
+ data: clusterData({ ticks, crc, blocks: [cueBlock({ track: 2, relativeTicks: 0, durationTicks: 500, text })] })
209
+ });
210
+ for (const [crc, expected] of [[true, ["b", "c"]], ["wrong", ["c"]]]) {
211
+ const { file, clusterAt } = buildMatroska({
212
+ tracks: TRACKS,
213
+ cues: null,
214
+ clusters: [withCrc(0, "a", false), withCrc(10_000, "b", crc), withCrc(20_000, "c", false)]
215
+ });
216
+ const { container, plan } = await planOf(file);
217
+ // The first cluster's header is not here, so the second is reached only by
218
+ // the search, which checks the CRC.
219
+ const result = await pass(container, plan, {}, heldOver(file, [[0, clusterAt[0] - 1], [clusterAt[0] + 12, file.length - 1]]));
220
+ assert.deepEqual(result.texts.sort(), expected, `crc ${crc}`);
221
+ if (crc === "wrong") {
222
+ assert.ok(result.stats.rejectedCandidates >= 1);
223
+ }
224
+ }
225
+ });
226
+
227
+ test("a candidate whose end has not arrived waits, and is read when it has", async () => {
228
+ const { file, clusterAt } = buildMatroska({
229
+ tracks: TRACKS,
230
+ cues: null,
231
+ clusters: [plainCluster(0, "a"), plainCluster(10_000, "b"), plainCluster(20_000, "c")]
232
+ });
233
+ const { container, plan } = await planOf(file);
234
+ const progress = {};
235
+ const first = await pass(
236
+ container,
237
+ plan,
238
+ progress,
239
+ heldOver(file, [[0, clusterAt[1] - 1], [clusterAt[2], clusterAt[2] + 20]])
240
+ );
241
+ assert.deepEqual(first.texts, ["a"]);
242
+ assert.equal(first.stats.pendingCandidates, 1, "found, and waiting for its bytes");
243
+ const second = await pass(container, plan, progress, heldOver(file, [[0, clusterAt[1] - 1], [clusterAt[2], file.length - 1]]));
244
+ assert.deepEqual(second.texts, ["c"]);
245
+ });
246
+
247
+ test("an id cut by the end of what is downloaded is found once the run grows", async () => {
248
+ const { file, clusterAt } = buildMatroska({
249
+ tracks: TRACKS,
250
+ cues: null,
251
+ clusters: [plainCluster(0, "a"), plainCluster(10_000, "b"), plainCluster(20_000, "c")]
252
+ });
253
+ const { container, plan } = await planOf(file);
254
+ const progress = {};
255
+ // The run ends two bytes into the third cluster's id.
256
+ await pass(container, plan, progress, heldOver(file, [[0, clusterAt[1] - 1], [clusterAt[1] + 12, clusterAt[2] + 1]]));
257
+ const grown = await pass(container, plan, progress, heldOver(file, [[0, clusterAt[1] - 1], [clusterAt[1] + 12, file.length - 1]]));
258
+ assert.ok(grown.texts.includes("c"), "the cut id was searched again and found");
259
+ });
260
+
261
+ test("the cluster a viewer stands in is read first, then the one before it, then onward", async () => {
262
+ const clusters = [0, 10_000, 20_000, 30_000, 40_000].map((ticks) => plainCluster(ticks, `at ${ticks / 1000}`));
263
+ // A line that starts in the 10 s cluster and is still on screen at 25 s.
264
+ clusters[1] = {
265
+ ticks: 10_000,
266
+ data: clusterData({ ticks: 10_000, blocks: [cueBlock({ track: 2, relativeTicks: 0, durationTicks: 16_000, text: "at 10" })] })
267
+ };
268
+ const { file } = buildMatroska({ tracks: TRACKS, cues: [1], clusters });
269
+ const { container, plan } = await planOf(file);
270
+ const progress = {};
271
+ const held = heldOver(file, [[0, file.length - 1]], { wantedSeconds: [25] });
272
+ const first = await pass(container, plan, progress, held);
273
+ assert.deepEqual(first.texts, ["at 20", "at 10"], "the pass ends with what is on screen, to be pushed at once");
274
+ assert.equal(first.more, true, "and says there is more to read now");
275
+ const second = await pass(container, plan, progress, held);
276
+ assert.deepEqual(second.texts, ["at 30", "at 40", "at 0"], "then onward from the viewer, then the rest");
277
+ assert.equal(second.more, false);
278
+ });
279
+
280
+ test("a pass reading the rest stops when a viewer moves, and the next one starts from there", async () => {
281
+ const clusters = [0, 10_000, 20_000, 30_000, 40_000, 50_000].map((ticks) => plainCluster(ticks, `at ${ticks / 1000}`));
282
+ const { file } = buildMatroska({ tracks: TRACKS, cues: [1], clusters });
283
+ const { container, plan } = await planOf(file);
284
+ const progress = {};
285
+ let viewer = [];
286
+ let readsBeforeSeek = 2;
287
+ const held = heldOver(file, [[0, file.length - 1]]);
288
+ held.wantedSeconds = () => {
289
+ // The viewer seeks to 45 s after the pass has read two clusters.
290
+ readsBeforeSeek -= 1;
291
+ if (readsBeforeSeek < 0) {
292
+ viewer = [45];
293
+ }
294
+ return viewer;
295
+ };
296
+ const first = await pass(container, plan, progress, held);
297
+ assert.equal(first.more, true, "stopped for the viewer who moved");
298
+ const second = await pass(container, plan, progress, held);
299
+ assert.deepEqual(second.texts.slice(0, 1), ["at 40"], "the next pass reads where the viewer now is first");
300
+ });
301
+
302
+ test("no read is larger than one portion, and a block larger than one is refused while the rest is read", async () => {
303
+ const portion = 96;
304
+ const { file } = buildMatroska({
305
+ tracks: TRACKS,
306
+ cues: [1],
307
+ clusters: [
308
+ plainCluster(0, "short"),
309
+ {
310
+ ticks: 10_000,
311
+ data: clusterData({ ticks: 10_000, blocks: [cueBlock({ track: 2, relativeTicks: 0, durationTicks: 500, text: "x".repeat(200) })] })
312
+ },
313
+ plainCluster(20_000, "also short")
314
+ ]
315
+ });
316
+ const { container, plan } = await planOf(file);
317
+ const reads = [];
318
+ const result = await pass(container, plan, {}, heldOver(file, [[0, file.length - 1]], { portionBytes: portion, reads }));
319
+ assert.deepEqual(result.texts.sort(), ["also short", "short"]);
320
+ assert.equal(result.stats.refusedElements, 1);
321
+ assert.ok(reads.every(({ start, end }) => end - start + 1 <= portion), "every read stayed within one portion");
322
+ });
323
+