@torrent-tv/proxy 2.89.6 → 2.89.8

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 (92) hide show
  1. package/AGENTS.md +32 -12
  2. package/CHANGELOG.md +2340 -2330
  3. package/assets/calibration/audio/NOTICE.md +19 -19
  4. package/assets/calibration/audio/manifest.json +98 -98
  5. package/biome.json +412 -412
  6. package/docs/browser-proxy-contract.md +155 -155
  7. package/docs/container-architecture.md +273 -273
  8. package/docs/encode-run-state.md +1 -1
  9. package/docs/playback-start-forecast.md +113 -98
  10. package/package.json +51 -50
  11. package/routes/api/sources/files/get.js +106 -106
  12. package/scripts/build-audio-samples.mjs +31 -31
  13. package/services/encode/EncodeRun.js +67 -15
  14. package/services/encode/EncodeRuns.js +19 -7
  15. package/services/encode/OutputOpening.js +784 -784
  16. package/services/encode/audio-calibration.js +67 -67
  17. package/services/encode/audio-work-rate.js +15 -15
  18. package/services/encode/encode-exit.js +2 -0
  19. package/services/encode/hwaccel.js +1894 -1894
  20. package/services/encode/output/index.js +24 -24
  21. package/services/encode/piece-completeness.js +60 -2
  22. package/services/encode/run-command.js +757 -755
  23. package/services/encode/segment-formats/index.js +1 -0
  24. package/services/encode/segment-formats/mp4-boxes.js +8 -1
  25. package/services/media/ContainerOrchestrator.js +202 -202
  26. package/services/media/KeyframeTables.js +356 -356
  27. package/services/media/SubtitleCues.js +592 -592
  28. package/services/media/audio-inventory.js +299 -299
  29. package/services/media/container/AviContainer.js +268 -268
  30. package/services/media/container/Container.js +632 -632
  31. package/services/media/container/ContainerFactory.js +38 -38
  32. package/services/media/container/MatroskaContainer.js +1031 -1031
  33. package/services/media/container/Mp4Container.js +1354 -1354
  34. package/services/media/container/SubtitleFileContainer.js +339 -339
  35. package/services/media/container/ebml-stream.js +174 -174
  36. package/services/media/container/matroska-clusters.js +1165 -1165
  37. package/services/media/container/unavailable.js +77 -77
  38. package/services/media/tracks/ContainerTrack.js +84 -84
  39. package/services/media/tracks/TextSubtitleTrack.js +295 -295
  40. package/services/storage/piece-store/shared-piece-store.js +1937 -1937
  41. package/services/storage/segment-store/SegmentStore.js +1294 -1294
  42. package/services/torrent/Contents.js +382 -382
  43. package/services/torrent/episode-naming.js +182 -182
  44. package/services/torrent/torrent-pool.js +2688 -2688
  45. package/services/torrent/worker/client.js +836 -836
  46. package/services/torrent/worker/held-bytes.js +231 -231
  47. package/services/torrent/worker/worker.js +1137 -1137
  48. package/services/transport/data-channel-handler.js +1373 -1373
  49. package/services/viewer/PriorityMap.js +421 -421
  50. package/test/audio-calibration.test.js +23 -23
  51. package/test/auto-quality-step.test.js +762 -762
  52. package/test/coalesce.test.js +39 -39
  53. package/test/coverage-follows-the-disk.test.js +5 -0
  54. package/test/decode-cost.test.js +475 -475
  55. package/test/encode-run.test.js +58 -0
  56. package/test/episode-naming.test.js +131 -131
  57. package/test/failed-encoder-still-serves-what-exists.test.js +1 -1
  58. package/test/fixtures/audio-frame-boundary.json +1 -1
  59. package/test/fixtures/refused-audio-20261002.json +10 -0
  60. package/test/fmp4-presentation-clock.test.js +4 -2
  61. package/test/format-keyed-outputs.test.js +78 -78
  62. package/test/health-metrics.test.js +11 -13
  63. package/test/held-read-ownership.test.js +77 -77
  64. package/test/helpers/encode-run.js +14 -6
  65. package/test/helpers/held-file.js +77 -77
  66. package/test/helpers/manager.js +62 -62
  67. package/test/helpers/matroska-file.js +296 -296
  68. package/test/keyframe-table-budget.test.js +123 -123
  69. package/test/matroska-cluster-discovery.test.js +323 -323
  70. package/test/one-output-one-session.test.js +273 -273
  71. package/test/output-speed.test.js +6 -1
  72. package/test/piece-completeness.test.js +37 -1
  73. package/test/quality-variants.test.js +1274 -1270
  74. package/test/rate-control-in-the-output.test.js +4 -3
  75. package/test/reads-not-yet-arrived.test.js +218 -218
  76. package/test/seek-frees-the-viewers-requests.test.js +1 -1
  77. package/test/segment-closed-on-both-branches.test.js +114 -114
  78. package/test/segment-judged-by-its-own-header.test.js +222 -222
  79. package/test/segment-serve-wiring.test.js +481 -481
  80. package/test/serving-existing-output.test.js +111 -111
  81. package/test/source-files-route.test.js +113 -113
  82. package/test/subtitle-cue-walk.test.js +385 -385
  83. package/test/subtitle-metadata.test.js +15 -15
  84. package/test/subtitle-plan-waits.test.js +125 -125
  85. package/test/subtitle-track-numbering.test.js +391 -391
  86. package/test/two-viewers-one-picture.test.js +508 -508
  87. package/test/viewer-requests-admission.test.js +92 -92
  88. package/test/viewer-starts-on-map.test.js +27 -27
  89. package/test/viewer-states.test.js +5 -2
  90. package/test/viewing-generations.test.js +390 -390
  91. package/test/whole-file-held-read.test.js +30 -30
  92. package/utils/coalesce.js +41 -41
@@ -1,1031 +1,1031 @@
1
- /**
2
- * @file Matroska/WebM container — RFC 9559.
3
- *
4
- * Reads Tracks in one pass for all media types (video, audio, subtitle).
5
- * Implements spec-accurate flag handling:
6
- * - FlagEnabled 0xB9 default 1, zero-length element = default (not disabled)
7
- * - FlagDefault 0x88 default 1, declaresDefault tracks whether element was written
8
- * - FlagForced 0x55AA only for subtitles, FlagHearingImpaired 0x55AB, FlagVisualImpaired 0x55AC,
9
- * FlagTextDescriptions 0x55AD, FlagOriginal 0x55AE, FlagCommentary 0x55AF
10
- * - Language 0x22B59C default "eng" (RFC 8794 §11.1.19: an element equal to its
11
- * default need not be written, and the reader MUST read the default),
12
- * LanguageBCP47 0x22B59D MUST — when present, Language ignored
13
- * - CodecID 0x86, CodecPrivate 0x63A2, Name 0x536E, TrackType 0x83 (1 video, 2 audio, 17 subtitle)
14
- *
15
- * **One reading of each thing the file states, kept on the container.** The
16
- * layout of the Segment, the Tracks element and the Cues table are each read
17
- * once and kept — and only once they have been read whole: a read whose bytes
18
- * have not arrived throws `BytesUnavailable` and leaves nothing behind
19
- * (`unavailable.js`). The keyframe times and the subtitle plan are both taken
20
- * from the one Cues reading. Until 2026-10-01 the Cues table was read three
21
- * times by three functions, the subtitle one kept a read that had not arrived
22
- * as "no clusters", and an embedded track showed nothing for a whole session.
23
- *
24
- * **Read where it lies.** Elements are found by walking the Segment's top-level
25
- * headers, not by hoping they fit a head window, and read a portion at a time
26
- * through `ebml-stream.js` — so a large Tracks element or Cues table is read by
27
- * its own size and never cut short by a bound of ours.
28
- *
29
- * Byte-level EBML grammar is `ebml-reader.js` and `ebml-stream.js`; the clusters
30
- * found from downloaded bytes are `matroska-clusters.js`. Everything Matroska
31
- * states about itself is read in this module or that one, and the class is the
32
- * only way in.
33
- */
34
-
35
- import { Container } from "./Container.js";
36
- import { VideoTrack } from "../tracks/VideoTrack.js";
37
- import { AudioTrack } from "../tracks/AudioTrack.js";
38
- import { TextSubtitleTrack, TEXT_CODECS_MATROSKA } from "../tracks/TextSubtitleTrack.js";
39
- import { ImageSubtitleTrack } from "../tracks/ImageSubtitleTrack.js";
40
- import { ContainerTrack } from "../tracks/ContainerTrack.js";
41
- import { iterateElements, readFloat, readUint, readVint } from "./ebml-reader.js";
42
- import { ElementReader, sizeIsUnknown } from "./ebml-stream.js";
43
- import { firstFrameOffset, readBlockHeader, walkHeldClusters } from "./matroska-clusters.js";
44
-
45
- /** Enough to hold the EBML header and the Segment's own header. */
46
- const HEAD_BYTES = 64 * 1024;
47
-
48
- const ID_EBML = 0x1a45dfa3;
49
- const ID_SEGMENT = 0x18538067;
50
- const ID_SEEK_HEAD = 0x114d9b74;
51
- const ID_SEEK = 0x4dbb;
52
- const ID_SEEK_ID = 0x53ab;
53
- const ID_SEEK_POSITION = 0x53ac;
54
- const ID_INFO = 0x1549a966;
55
- const ID_TIMESTAMP_SCALE = 0x2ad7b1;
56
- const ID_DURATION = 0x4489;
57
- const ID_CLUSTER = 0x1f43b675;
58
- const ID_CUES = 0x1c53bb6b;
59
- const ID_CUE_POINT = 0xbb;
60
- const ID_CUE_TIME = 0xb3;
61
- const ID_CUE_TRACK_POSITIONS = 0xb7;
62
- const ID_CUE_TRACK = 0xf7;
63
- const ID_CUE_CLUSTER_POSITION = 0xf1;
64
- const ID_TIMESTAMP = 0xe7;
65
- const ID_SIMPLE_BLOCK = 0xa3;
66
- const ID_BLOCK_GROUP = 0xa0;
67
- const ID_BLOCK = 0xa1;
68
- const ID_BLOCK_DURATION = 0x9b;
69
- const ID_TRACKS = 0x1654ae6b;
70
- const ID_TRACK_ENTRY = 0xae;
71
- const ID_TRACK_NUMBER = 0xd7;
72
- const ID_TRACK_TYPE = 0x83;
73
- const ID_FLAG_ENABLED = 0xb9;
74
- const ID_FLAG_DEFAULT = 0x88;
75
- const ID_FLAG_FORCED = 0x55aa;
76
- const ID_FLAG_HEARING = 0x55ab;
77
- const ID_FLAG_VISUAL = 0x55ac;
78
- const ID_FLAG_TEXT_DESCR = 0x55ad;
79
- const ID_FLAG_ORIGINAL = 0x55ae;
80
- const ID_FLAG_COMMENTARY = 0x55af;
81
- const ID_CODEC_ID = 0x86;
82
- const ID_CODEC_PRIVATE = 0x63a2;
83
- const ID_LANGUAGE = 0x22b59c;
84
- const ID_LANGUAGE_BCP47 = 0x22b59d;
85
- const ID_NAME = 0x536e;
86
- const ID_VIDEO = 0xe0;
87
- const ID_AUDIO = 0xe1;
88
- const ID_PIXEL_WIDTH = 0xb0;
89
- const ID_PIXEL_HEIGHT = 0xba;
90
- const ID_DISPLAY_WIDTH = 0x54b0;
91
- const ID_DISPLAY_HEIGHT = 0x54ba;
92
- const ID_SAMPLING_FREQUENCY = 0xb5;
93
- const ID_CHANNELS = 0x9f;
94
-
95
- /** RFC 9559 §5.1.2.1: nanoseconds per tick when Info omits TimestampScale. */
96
- const DEFAULT_TIMESTAMP_SCALE = 1_000_000;
97
- /** RFC 9559 §5.1.4.1.19: what an absent or empty `Language` element means. */
98
- const DEFAULT_LANGUAGE = "eng";
99
-
100
- const TRACK_TYPE_VIDEO = 1;
101
- const TRACK_TYPE_AUDIO = 2;
102
- const TRACK_TYPE_SUBTITLE = 17;
103
-
104
- /**
105
- * ReadOrder, Layer, Style, Name, MarginL, MarginR, MarginV, Effect — the eight
106
- * fields Matroska writes before the text of an SSA/ASS event. See
107
- * {@link MatroskaContainer.cueTextOf} for the quotation this comes from.
108
- */
109
- const ASS_FIELDS_BEFORE_TEXT = 8;
110
-
111
- function readString(buf, el) {
112
- return buf.toString("utf8", el.dataOffset, el.dataOffset + el.size).replace(/\0+$/, "");
113
- }
114
-
115
- /**
116
- * @typedef {object} SegmentLayout
117
- * @property {number} segmentDataOffset - Where the Segment's data begins.
118
- * @property {number} segmentEnd - One past its last byte (the file's end for an
119
- * unknown-sized Segment).
120
- * @property {number} secondsPerTick
121
- * @property {number | null} infoAt - Positions of the top-level elements, from
122
- * the walk to the first cluster or from the SeekHead.
123
- * @property {number | null} tracksAt
124
- * @property {number | null} cuesAt
125
- * @property {number | null} firstClusterAt
126
- */
127
-
128
- export class MatroskaContainer extends Container {
129
- /** @type {Buffer | null} */
130
- #head = null;
131
-
132
- /** @type {SegmentLayout | null} */
133
- #layout = null;
134
-
135
- /** @type {Array<import("../tracks/ContainerTrack.js").ContainerTrack> | null} */
136
- #tracks = null;
137
-
138
- /**
139
- * The Cues reading: undefined until read, null when the file has none.
140
- * @type {{ points: Array<{ ticks: number, positions: Array<{ track: number, clusterAt: number }> }> } | null | undefined}
141
- */
142
- #cues = undefined;
143
-
144
- get formatName() {
145
- return "matroska";
146
- }
147
-
148
- static detect(head) {
149
- return isMatroska(head);
150
- }
151
-
152
- /**
153
- * The keyframe times this container's own index states, in ascending seconds.
154
- *
155
- * Static so a caller that has bytes and no container can ask; the reading is
156
- * the instance's, over a container built for the purpose.
157
- *
158
- * @param {(start:number,end:number)=>Promise<Buffer|null>} readRange
159
- * @param {number} fileSize
160
- * @returns {Promise<number[]|null>} Null where the container has no index.
161
- */
162
- static async readKeyframeTimes(readRange, fileSize) {
163
- const index = await new MatroskaContainer({ readRange, fileSize }).parseKeyframeIndex();
164
- return index ? index.times : null;
165
- }
166
-
167
- /**
168
- * @param {(start:number,end:number)=>Promise<Buffer|null>} readRange
169
- * @param {number} fileSize
170
- * @returns {Promise<object|null>}
171
- */
172
- static readSubtitlePlan(readRange, fileSize) {
173
- return new MatroskaContainer({ readRange, fileSize }).readSubtitlePlan();
174
- }
175
-
176
- /**
177
- * The blocks one track has inside a cluster held whole in a buffer.
178
- *
179
- * @param {Buffer} bytes - The cluster, from its own element header onward.
180
- * @param {number} trackNumber
181
- * @param {number} secondsPerTick
182
- * @returns {{ startSeconds: number, endSeconds: number | null, payload: Buffer }[]}
183
- */
184
- static blocksInCluster(bytes, trackNumber, secondsPerTick) {
185
- return harvestCluster(bytes, trackNumber, secondsPerTick);
186
- }
187
-
188
- /**
189
- * The blocks one track has inside a cluster whose bounds are already known —
190
- * RFC 9559 §5.1.3.4 (SimpleBlock) and §5.1.3.5 (BlockGroup).
191
- *
192
- * @param {Buffer} buffer
193
- * @param {{ dataOffset: number, size: number }} cluster
194
- * @param {number} trackNumber
195
- * @param {number} secondsPerTick
196
- * @returns {{ startSeconds: number, durationSeconds: number | null, payload: Buffer }[]}
197
- */
198
- static blocksOfTrack(buffer, cluster, trackNumber, secondsPerTick) {
199
- return blocksOfTrack(buffer, cluster, trackNumber, secondsPerTick);
200
- }
201
-
202
- /**
203
- * A reader for the inside of one element: a portion at a time, never past
204
- * the element's end — so a Cues table of thousands of CuePoints costs a few
205
- * reads rather than one per CuePoint, and nothing after the element is
206
- * fetched for it.
207
- *
208
- * @param {number} end - One past the element's last byte.
209
- * @returns {ElementReader}
210
- */
211
- #readerWithin(end) {
212
- return new ElementReader({
213
- read: this.readRange,
214
- fileSize: this.fileSize,
215
- portionBytes: this.portionBytes,
216
- prefetch: true,
217
- readableUntil: () => end
218
- });
219
- }
220
-
221
- /** @returns {Promise<Buffer>} */
222
- async #headBytes() {
223
- if (this.#head === null) {
224
- this.#head = await this.readRange(0, Math.min(HEAD_BYTES, this.fileSize) - 1);
225
- }
226
- return this.#head;
227
- }
228
-
229
- /**
230
- * Where the Segment's top-level elements are.
231
- *
232
- * Found by walking their HEADERS from the Segment's start to the first
233
- * cluster — each one costs the bytes of its header and nothing of its data —
234
- * and, for what lies after the clusters, from the SeekHead. RFC 9559 §6.4: a
235
- * Cues element SHOULD be stored before the first cluster or be referenced by
236
- * a SeekHead, so the two together find it wherever a conforming file puts it.
237
- *
238
- * @returns {Promise<SegmentLayout | null>} Null for bytes that are not a
239
- * Matroska Segment.
240
- */
241
- async #segmentLayout() {
242
- if (this.#layout !== null) {
243
- return this.#layout;
244
- }
245
- const head = await this.#headBytes();
246
- if (!isMatroska(head)) {
247
- return null;
248
- }
249
- const segment = segmentHeaderIn(head);
250
- if (!segment) {
251
- return null;
252
- }
253
- const segmentDataOffset = segment.dataOffset;
254
- const segmentEnd = segment.size === null ? this.fileSize : Math.min(this.fileSize, segmentDataOffset + segment.size);
255
-
256
- const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
257
- /** @type {Map<number, number>} */
258
- const found = new Map();
259
- /** @type {Map<number, number>} */
260
- const seeks = new Map();
261
- let firstClusterAt = null;
262
- let at = segmentDataOffset;
263
- while (at < segmentEnd) {
264
- const header = await reader.header(at, segmentEnd);
265
- if (!header) {
266
- break;
267
- }
268
- if (header.id === ID_CLUSTER) {
269
- firstClusterAt = at;
270
- break;
271
- }
272
- if (!found.has(header.id)) {
273
- found.set(header.id, at);
274
- }
275
- if (header.id === ID_SEEK_HEAD && header.size !== null) {
276
- const data = await reader.data(header);
277
- if (data) {
278
- for (const [id, position] of readSeekEntries(data)) {
279
- seeks.set(id, segmentDataOffset + position);
280
- }
281
- }
282
- }
283
- if (header.end === null) {
284
- break;
285
- }
286
- at = header.end;
287
- }
288
- const positionOf = (id) => found.get(id) ?? seeks.get(id) ?? null;
289
-
290
- let secondsPerTick = DEFAULT_TIMESTAMP_SCALE / 1e9;
291
- const infoAt = positionOf(ID_INFO);
292
- if (infoAt !== null) {
293
- const info = await reader.header(infoAt, segmentEnd);
294
- const data = info && info.id === ID_INFO ? await reader.data(info) : null;
295
- if (data) {
296
- for (const field of iterateElements(data)) {
297
- if (field.id === ID_TIMESTAMP_SCALE) {
298
- const scale = readUint(data, field.dataOffset, field.size);
299
- if (scale > 0) {
300
- secondsPerTick = scale / 1e9;
301
- }
302
- }
303
- }
304
- }
305
- }
306
- this.#layout = {
307
- segmentDataOffset,
308
- segmentEnd,
309
- secondsPerTick,
310
- infoAt,
311
- tracksAt: positionOf(ID_TRACKS),
312
- cuesAt: positionOf(ID_CUES),
313
- firstClusterAt: firstClusterAt ?? seeks.get(ID_CLUSTER) ?? null
314
- };
315
- return this.#layout;
316
- }
317
-
318
- /**
319
- * Duration and the start of this file's own timeline, per RFC 9559 §5.1.2.
320
- *
321
- * Duration is stated in `Info` as a FLOAT in ticks. The start of the timeline
322
- * is not stated anywhere — Matroska has no such element — so it is the
323
- * timestamp of the first Cluster, which is what the first frame is placed
324
- * against.
325
- *
326
- * Kept only once it has been read: a head that had not arrived used to leave
327
- * an empty answer here for the life of the container.
328
- *
329
- * @returns {Promise<import("./Container.js").ContainerMediaInfo>}
330
- */
331
- async readMediaInfo() {
332
- if (this.mediaInfo) {
333
- return this.mediaInfo;
334
- }
335
- /** @type {import("./Container.js").ContainerMediaInfo} */
336
- const info = { format: this.formatName, durationSeconds: null, startTimeSeconds: null };
337
- const layout = await this.#segmentLayout();
338
- if (!layout) {
339
- this.mediaInfo = info;
340
- return info;
341
- }
342
- const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
343
- if (layout.infoAt !== null) {
344
- const header = await reader.header(layout.infoAt, layout.segmentEnd);
345
- const data = header && header.id === ID_INFO ? await reader.data(header) : null;
346
- if (data) {
347
- for (const field of iterateElements(data)) {
348
- if (field.id === ID_DURATION) {
349
- const ticks = readFloat(data, field.dataOffset, field.size);
350
- if (ticks !== null && ticks > 0) {
351
- info.durationSeconds = ticks * layout.secondsPerTick;
352
- }
353
- }
354
- }
355
- }
356
- }
357
- if (layout.firstClusterAt !== null) {
358
- info.startTimeSeconds = await clusterTimestampSeconds(reader, layout.firstClusterAt, layout);
359
- }
360
- this.mediaInfo = info;
361
- return info;
362
- }
363
-
364
- /**
365
- * Every track the file declares, in its order, read once.
366
- *
367
- * @returns {Promise<import("../tracks/index.js").ContainerTrack[]>}
368
- */
369
- async readTracks() {
370
- if (this.#tracks !== null) {
371
- return this.#tracks;
372
- }
373
- const layout = await this.#segmentLayout();
374
- if (!layout || layout.tracksAt === null) {
375
- this.#tracks = [];
376
- return this.#tracks;
377
- }
378
- const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
379
- const tracksHeader = await reader.header(layout.tracksAt, layout.segmentEnd);
380
- if (!tracksHeader || tracksHeader.id !== ID_TRACKS || tracksHeader.end === null) {
381
- this.#tracks = [];
382
- return this.#tracks;
383
- }
384
- /** @type {import("../tracks/index.js").ContainerTrack[]} */
385
- const result = [];
386
- const counters = { video: -1, audio: -1, subtitle: -1 };
387
- const within = this.#readerWithin(tracksHeader.end);
388
- let at = tracksHeader.dataOffset;
389
- while (at < tracksHeader.end) {
390
- const entry = await within.header(at, tracksHeader.end);
391
- if (!entry || entry.end === null) {
392
- break;
393
- }
394
- if (entry.id === ID_TRACK_ENTRY) {
395
- const data = await within.data(entry);
396
- // An entry larger than one portion is refused rather than assembled.
397
- // Its type cannot be known without its data, so it is kept as a track
398
- // of no kind — which makes the count of its kind short by one, and
399
- // `alignWithBanner` then refuses to line the two readings up rather
400
- // than pairing them wrongly.
401
- const fields = data ? parseTrackEntry(data) : { refused: true, trackNumber: null };
402
- const track = trackFrom(fields, counters);
403
- if (track) {
404
- result.push(track);
405
- }
406
- }
407
- at = entry.end;
408
- }
409
- this.#tracks = result;
410
- return result;
411
- }
412
-
413
- /**
414
- * The Cues table, read once, every CuePoint with every track it names.
415
- *
416
- * @returns {Promise<{ points: Array<{ ticks: number, positions: Array<{ track: number, clusterAt: number }> }> } | null>}
417
- * Null where the file has no Cues element — a statement about the file,
418
- * kept. A Cues element that has not downloaded throws and is not kept.
419
- */
420
- async readCues() {
421
- if (this.#cues !== undefined) {
422
- return this.#cues;
423
- }
424
- const layout = await this.#segmentLayout();
425
- if (!layout || layout.cuesAt === null) {
426
- this.#cues = null;
427
- return null;
428
- }
429
- const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
430
- const cues = await reader.header(layout.cuesAt, layout.segmentEnd);
431
- if (!cues || cues.id !== ID_CUES || cues.end === null) {
432
- // The SeekHead names a position with no Cues element at it. The file is
433
- // wrong there, and the same bytes will say the same thing next time.
434
- this.#cues = null;
435
- return null;
436
- }
437
- const points = [];
438
- const within = this.#readerWithin(cues.end);
439
- let at = cues.dataOffset;
440
- while (at < cues.end) {
441
- const point = await within.header(at, cues.end);
442
- if (!point || point.end === null) {
443
- break;
444
- }
445
- if (point.id === ID_CUE_POINT) {
446
- const data = await within.data(point);
447
- if (data) {
448
- const parsed = parseCuePoint(data, layout.segmentDataOffset);
449
- if (parsed) {
450
- points.push(parsed);
451
- }
452
- }
453
- }
454
- at = point.end;
455
- }
456
- this.#cues = { points };
457
- return this.#cues;
458
- }
459
-
460
- /**
461
- * This container's subtitle tracks, the Cues table and the clusters it
462
- * names — everything the cue walk starts from.
463
- *
464
- * `cuesState` says whether the file has a Cues table at all; where it has
465
- * none, the walk finds clusters from the downloaded bytes themselves.
466
- *
467
- * @returns {Promise<object | null>} Null for bytes that are not Matroska.
468
- */
469
- async readSubtitlePlan() {
470
- const layout = await this.#segmentLayout();
471
- if (!layout) {
472
- return null;
473
- }
474
- const allTracks = await this.readTracks();
475
- const cues = await this.readCues();
476
- const subtitles = allTracks.filter((track) => track.type === "subtitle");
477
- const declared = subtitles.map((track) => ({
478
- trackNumber: track.trackNumber,
479
- codecId: track.codecId,
480
- // The three-letter code: this list is lined up against ffmpeg's banner,
481
- // which prints that form. The RFC 5646 tag rides beside it.
482
- language: track.languageCode || track.language,
483
- languageBcp47: track.languageBcp47,
484
- declaresLanguage: track.declaresLanguage,
485
- languageSource: track.languageSource,
486
- name: track.name,
487
- isDefault: track.isDefault,
488
- declaresDefault: track.declaresDefault,
489
- isEnabled: track.isEnabled,
490
- isForced: track.isForced === true,
491
- isHearingImpaired: track.isHearingImpaired === true
492
- }));
493
- /** @type {Map<number, Set<number>>} */
494
- const byTrack = new Map();
495
- /** @type {Map<number, number>} */
496
- const entrySeconds = new Map();
497
- for (const point of cues?.points ?? []) {
498
- const seconds = point.ticks * layout.secondsPerTick;
499
- for (const { track, clusterAt } of point.positions) {
500
- if (!byTrack.has(track)) {
501
- byTrack.set(track, new Set());
502
- }
503
- byTrack.get(track).add(clusterAt);
504
- // The cluster begins at or before the earliest frame that names it.
505
- const known = entrySeconds.get(clusterAt);
506
- if (known === undefined || seconds < known) {
507
- entrySeconds.set(clusterAt, seconds);
508
- }
509
- }
510
- }
511
- const tracks = subtitles
512
- .filter((track) => TEXT_CODECS_MATROSKA.has(track.codecId) && track.isEnabled)
513
- .map((track) => ({
514
- trackNumber: track.trackNumber,
515
- declaredIndex: track.declaredIndex,
516
- codecId: track.codecId,
517
- language: track.language,
518
- languageBcp47: track.languageBcp47,
519
- declaresLanguage: track.declaresLanguage,
520
- languageSource: track.languageSource,
521
- name: track.name,
522
- isDefault: track.isDefault,
523
- isForced: track.isForced === true,
524
- isHearingImpaired: track.isHearingImpaired === true,
525
- codecPrivate: track.codecPrivateB64,
526
- clusterPositions: [...(byTrack.get(track.trackNumber) ?? [])].sort((left, right) => left - right)
527
- }));
528
- return {
529
- tracks,
530
- declared,
531
- secondsPerTick: layout.secondsPerTick,
532
- segmentDataOffset: layout.segmentDataOffset,
533
- fileSize: this.fileSize,
534
- segmentEnd: layout.segmentEnd,
535
- firstClusterAt: layout.firstClusterAt,
536
- cuesState: cues ? "complete" : "absent",
537
- entryPoints: [...entrySeconds].map(([at, seconds]) => ({ at, seconds })).sort((left, right) => left.at - right.at),
538
- subtitleTrackNumbers: tracks.map((track) => track.trackNumber),
539
- allTrackNumbers: allTracks.map((track) => track.trackNumber).filter((number) => Number.isFinite(number))
540
- };
541
- }
542
-
543
- /**
544
- * The cues this file holds now, for every text track at once — see
545
- * `matroska-clusters.js` for how clusters are found and in what order read.
546
- *
547
- * @param {object} plan
548
- * @param {object} track
549
- * @param {object} progress
550
- * @param {import("./Container.js").HeldReader} held
551
- * @returns {Promise<{ found: Map<number, object[]>, covered: number, indexed: number, withdrawn: number[], stats: object }>}
552
- */
553
- async readHeldCues(plan, track, progress, held) {
554
- const walked = await walkHeldClusters({ plan, progress, held });
555
- const found = new Map();
556
- for (const candidate of plan.tracks) {
557
- const blocks = walked.found.get(candidate.trackNumber);
558
- if (!blocks) {
559
- continue;
560
- }
561
- found.set(
562
- candidate.trackNumber,
563
- blocks.map((block) => ({
564
- startSeconds: block.startSeconds,
565
- endSeconds: block.endSeconds,
566
- // The block's bytes become text HERE, where the container that
567
- // framed them is known.
568
- text: MatroskaContainer.cueTextOf(block.payload, candidate.codecId),
569
- source: block.source
570
- }))
571
- );
572
- }
573
- return { ...walked, found };
574
- }
575
-
576
- /**
577
- * The text field of one cue as Matroska frames it.
578
- *
579
- * Two rules, both from `matroska.org/technical/subtitles.html`, "Now, how are
580
- * they stored in Matroska?":
581
- *
582
- * 1. "All text is converted to UTF-8", so the block is decoded as UTF-8 and
583
- * no other encoding is guessed at. A subtitle FILE is a different matter —
584
- * there the bytes may be Windows-1251 and `decodeSubtitleBytes` sniffs for
585
- * it — but a muxer had to convert before writing the block.
586
- * 2. "Events are stored in the Block in this order: ReadOrder, Layer, Style,
587
- * Name, MarginL, MarginR, MarginV, Effect, Text", and "Start & End field
588
- * are used to set TimeStamp and the BlockDuration element". So eight fields
589
- * stand before the text, the two timing fields of the file's own row are
590
- * NOT among them, and a read order takes their place at the front. The text
591
- * itself may hold commas, so everything from the ninth field on is joined
592
- * back together.
593
- *
594
- * `S_TEXT/UTF8` and `S_TEXT/WEBVTT` have no such framing: the block holds the
595
- * cue text and nothing else.
596
- *
597
- * @param {Buffer} payload - The block's own bytes.
598
- * @param {string} codecId - Matroska CodecID of the track the block belongs to.
599
- * @returns {string}
600
- */
601
- static cueTextOf(payload, codecId) {
602
- const text = Buffer.isBuffer(payload) ? payload.toString("utf8") : String(payload ?? "");
603
- if (codecId !== "S_TEXT/ASS" && codecId !== "S_TEXT/SSA") {
604
- return text;
605
- }
606
- const fields = text.split(",");
607
- return fields.length > ASS_FIELDS_BEFORE_TEXT ? fields.slice(ASS_FIELDS_BEFORE_TEXT).join(",") : "";
608
- }
609
-
610
- /**
611
- * The keyframe times of the first video track, from the one Cues reading.
612
- *
613
- * A CuePoint belongs to the track named inside its CueTrackPositions, and a
614
- * muxer indexes whatever tracks it likes — field files index their subtitle
615
- * tracks too, and read without the track those times entered the cut list as
616
- * though they were keyframes (2026-08-18). Where the filter leaves nothing
617
- * although a table exists, the unfiltered table is used: less exact than the
618
- * picture's own keyframes, better than an even grid that has nothing to do
619
- * with the file.
620
- *
621
- * @returns {Promise<{ times: number[], tolerance: number } | null>}
622
- */
623
- async parseKeyframeIndex() {
624
- const layout = await this.#segmentLayout();
625
- if (!layout) {
626
- return null;
627
- }
628
- const cues = await this.readCues();
629
- if (!cues) {
630
- return null;
631
- }
632
- const tracks = await this.readTracks();
633
- const video = tracks.find((track) => track.type === "video")?.trackNumber ?? null;
634
- const timesFor = (wanted) =>
635
- cues.points
636
- .filter((point) => wanted === null || point.positions.some((position) => position.track === wanted))
637
- .map((point) => point.ticks * layout.secondsPerTick)
638
- .sort((left, right) => left - right);
639
- const times = timesFor(video);
640
- if (times.length > 0) {
641
- return { times, tolerance: 0 };
642
- }
643
- if (video === null) {
644
- return null;
645
- }
646
- const unfiltered = timesFor(null);
647
- return unfiltered.length > 0 ? { times: unfiltered, tolerance: 0 } : null;
648
- }
649
- }
650
-
651
- /**
652
- * Whether this looks like a Matroska file (the EBML magic `0x1A45DFA3`).
653
- *
654
- * @param {Buffer} head
655
- * @returns {boolean}
656
- */
657
- function isMatroska(head) {
658
- return head.length >= 4 && head.readUInt32BE(0) === ID_EBML;
659
- }
660
-
661
- /**
662
- * The Segment element's header, from the top-level elements of the head.
663
- *
664
- * @param {Buffer} head
665
- * @returns {{ dataOffset: number, size: number | null } | null} `size` is null
666
- * for an unknown-sized Segment (RFC 8794 §6.2), which runs to the file's end.
667
- */
668
- function segmentHeaderIn(head) {
669
- let offset = 0;
670
- while (offset < head.length) {
671
- const id = readVint(head, offset, true);
672
- const size = id && readVint(head, offset + id.length, false);
673
- if (!id || !size) {
674
- return null;
675
- }
676
- const dataOffset = offset + id.length + size.length;
677
- if (id.value === ID_SEGMENT) {
678
- return { dataOffset, size: sizeIsUnknown(size) ? null : size.value };
679
- }
680
- offset = dataOffset + size.value;
681
- }
682
- return null;
683
- }
684
-
685
- /**
686
- * The SeekHead's entries, id to position relative to the Segment's data.
687
- *
688
- * @param {Buffer} data - The SeekHead's data.
689
- * @returns {Map<number, number>}
690
- */
691
- function readSeekEntries(data) {
692
- const entries = new Map();
693
- for (const seek of iterateElements(data)) {
694
- if (seek.id !== ID_SEEK) {
695
- continue;
696
- }
697
- const end = Math.min(data.length, seek.dataOffset + seek.size);
698
- let targetId = null;
699
- let position = null;
700
- for (const field of iterateElements(data, seek.dataOffset, end)) {
701
- if (field.id === ID_SEEK_ID) {
702
- targetId = readUint(data, field.dataOffset, field.size);
703
- } else if (field.id === ID_SEEK_POSITION) {
704
- position = readUint(data, field.dataOffset, field.size);
705
- }
706
- }
707
- if (targetId !== null && position !== null && !entries.has(targetId)) {
708
- entries.set(targetId, position);
709
- }
710
- }
711
- return entries;
712
- }
713
-
714
- /**
715
- * The timestamp of a cluster, from its leading children.
716
- *
717
- * §5.1.3.1: the Timestamp SHOULD be the first child, or the second after a
718
- * CRC-32. Children before it are stepped over by their headers; reading stops
719
- * at the first block, so a cluster's megabytes are never pulled for this.
720
- *
721
- * @param {ElementReader} reader
722
- * @param {number} at
723
- * @param {SegmentLayout} layout
724
- * @returns {Promise<number | null>}
725
- */
726
- async function clusterTimestampSeconds(reader, at, layout) {
727
- const cluster = await reader.header(at, layout.segmentEnd);
728
- if (!cluster || cluster.id !== ID_CLUSTER) {
729
- return null;
730
- }
731
- const limit = cluster.end ?? layout.segmentEnd;
732
- let cursor = cluster.dataOffset;
733
- while (cursor < limit) {
734
- const child = await reader.header(cursor, limit);
735
- if (!child || child.size === null) {
736
- return null;
737
- }
738
- if (child.id === ID_TIMESTAMP) {
739
- const bytes = await reader.bytes(child.dataOffset, child.size);
740
- return readUint(bytes, 0, child.size) * layout.secondsPerTick;
741
- }
742
- if (child.id === ID_SIMPLE_BLOCK || child.id === ID_BLOCK_GROUP) {
743
- return null;
744
- }
745
- cursor = child.end;
746
- }
747
- return null;
748
- }
749
-
750
- /**
751
- * One CuePoint: its time and every track position it names.
752
- *
753
- * @param {Buffer} data
754
- * @param {number} segmentDataOffset - CueClusterPosition is relative to it.
755
- * @returns {{ ticks: number, positions: Array<{ track: number, clusterAt: number }> } | null}
756
- */
757
- function parseCuePoint(data, segmentDataOffset) {
758
- let ticks = null;
759
- const positions = [];
760
- for (const field of iterateElements(data)) {
761
- if (field.id === ID_CUE_TIME) {
762
- ticks = readUint(data, field.dataOffset, field.size);
763
- continue;
764
- }
765
- if (field.id !== ID_CUE_TRACK_POSITIONS) {
766
- continue;
767
- }
768
- const end = Math.min(data.length, field.dataOffset + field.size);
769
- let track = null;
770
- let cluster = null;
771
- for (const inner of iterateElements(data, field.dataOffset, end)) {
772
- if (inner.id === ID_CUE_TRACK) {
773
- track = readUint(data, inner.dataOffset, inner.size);
774
- } else if (inner.id === ID_CUE_CLUSTER_POSITION) {
775
- cluster = readUint(data, inner.dataOffset, inner.size);
776
- }
777
- }
778
- if (track !== null && cluster !== null) {
779
- positions.push({ track, clusterAt: segmentDataOffset + cluster });
780
- }
781
- }
782
- return ticks === null ? null : { ticks, positions };
783
- }
784
-
785
- /**
786
- * Every field of one TrackEntry this proxy reads, with RFC 9559's defaults.
787
- *
788
- * @param {Buffer} data - The TrackEntry's data.
789
- * @returns {object}
790
- */
791
- function parseTrackEntry(data) {
792
- const fields = {
793
- refused: false,
794
- trackNumber: null,
795
- type: null,
796
- codecId: "",
797
- language: null,
798
- languageBcp47: "",
799
- name: "",
800
- codecPrivateB64: "",
801
- isEnabled: true,
802
- // FlagDefault DEFAULTS TO 1; whether the file wrote it is kept apart,
803
- // because once the default is applied "no track marked" and "every track
804
- // marked" look the same.
805
- isDefault: true,
806
- declaresDefault: false,
807
- isForced: false,
808
- isHearing: false,
809
- isVisual: false,
810
- isOriginal: false,
811
- isCommentary: false,
812
- pixelWidth: null,
813
- pixelHeight: null,
814
- displayWidth: null,
815
- displayHeight: null,
816
- samplingFreq: null,
817
- channels: null
818
- };
819
- for (const f of iterateElements(data)) {
820
- switch (f.id) {
821
- case ID_TRACK_NUMBER: fields.trackNumber = readUint(data, f.dataOffset, f.size); break;
822
- case ID_TRACK_TYPE: fields.type = readUint(data, f.dataOffset, f.size); break;
823
- case ID_CODEC_ID: fields.codecId = readString(data, f); break;
824
- case ID_CODEC_PRIVATE: fields.codecPrivateB64 = data.toString("base64", f.dataOffset, f.dataOffset + f.size); break;
825
- // An empty element carries its default (RFC 8794 §6.3 and §11.1.19).
826
- case ID_LANGUAGE: fields.language = f.size === 0 ? DEFAULT_LANGUAGE : readString(data, f); break;
827
- case ID_LANGUAGE_BCP47: fields.languageBcp47 = readString(data, f); break;
828
- case ID_NAME: fields.name = readString(data, f); break;
829
- // Zero length carries the default, which is 1; only an explicit zero
830
- // takes a track away.
831
- case ID_FLAG_ENABLED: fields.isEnabled = f.size === 0 || readUint(data, f.dataOffset, f.size) !== 0; break;
832
- case ID_FLAG_DEFAULT: fields.isDefault = f.size === 0 || readUint(data, f.dataOffset, f.size) === 1; fields.declaresDefault = true; break;
833
- case ID_FLAG_FORCED: fields.isForced = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
834
- case ID_FLAG_HEARING: fields.isHearing = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
835
- case ID_FLAG_VISUAL: fields.isVisual = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
836
- case ID_FLAG_TEXT_DESCR: break;
837
- case ID_FLAG_ORIGINAL: fields.isOriginal = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
838
- case ID_FLAG_COMMENTARY: fields.isCommentary = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
839
- case ID_VIDEO: {
840
- const end = Math.min(data.length, f.dataOffset + f.size);
841
- for (const vf of iterateElements(data, f.dataOffset, end)) {
842
- if (vf.id === ID_PIXEL_WIDTH) fields.pixelWidth = readUint(data, vf.dataOffset, vf.size);
843
- else if (vf.id === ID_PIXEL_HEIGHT) fields.pixelHeight = readUint(data, vf.dataOffset, vf.size);
844
- else if (vf.id === ID_DISPLAY_WIDTH) fields.displayWidth = readUint(data, vf.dataOffset, vf.size);
845
- else if (vf.id === ID_DISPLAY_HEIGHT) fields.displayHeight = readUint(data, vf.dataOffset, vf.size);
846
- }
847
- break;
848
- }
849
- case ID_AUDIO: {
850
- const end = Math.min(data.length, f.dataOffset + f.size);
851
- for (const af of iterateElements(data, f.dataOffset, end)) {
852
- if (af.id === ID_SAMPLING_FREQUENCY) {
853
- fields.samplingFreq = af.size === 8 ? data.readDoubleBE(af.dataOffset) : readFloat(data, af.dataOffset, af.size);
854
- } else if (af.id === ID_CHANNELS) {
855
- fields.channels = readUint(data, af.dataOffset, af.size);
856
- }
857
- }
858
- break;
859
- }
860
- default: break;
861
- }
862
- }
863
- return fields;
864
- }
865
-
866
- /**
867
- * The track object one TrackEntry describes.
868
- *
869
- * The language follows RFC 9559's order: a `LanguageBCP47` element wins and
870
- * `Language` is then ignored; otherwise `Language`; otherwise its default,
871
- * `eng` — which a reader MUST apply (RFC 8794 §11.1.19). Where it came from is
872
- * kept as `languageSource`.
873
- *
874
- * @param {object} fields - From {@link parseTrackEntry}.
875
- * @param {{ video: number, audio: number, subtitle: number }} counters
876
- * @returns {import("../tracks/ContainerTrack.js").ContainerTrack | null}
877
- */
878
- function trackFrom(fields, counters) {
879
- if (fields.trackNumber === null && !fields.refused) {
880
- return null;
881
- }
882
- const declaresLanguage = fields.languageBcp47.length > 0 || fields.language !== null;
883
- const languageSource = fields.languageBcp47 ? "bcp47" : fields.language !== null ? "language" : "default";
884
- const language = fields.languageBcp47 || (fields.language !== null ? fields.language : DEFAULT_LANGUAGE);
885
- const common = {
886
- trackNumber: fields.trackNumber,
887
- codecId: fields.codecId,
888
- language,
889
- languageBcp47: fields.languageBcp47,
890
- declaresLanguage,
891
- languageSource,
892
- languageCode: fields.language !== null ? fields.language : DEFAULT_LANGUAGE,
893
- name: fields.name,
894
- isEnabled: fields.isEnabled,
895
- isDefault: fields.isDefault,
896
- declaresDefault: fields.declaresDefault,
897
- codecPrivateB64: fields.codecPrivateB64
898
- };
899
- if (fields.type === TRACK_TYPE_VIDEO) {
900
- counters.video += 1;
901
- return new VideoTrack({
902
- ...common,
903
- declaredIndex: counters.video,
904
- width: fields.pixelWidth,
905
- height: fields.pixelHeight,
906
- displayWidth: fields.displayWidth,
907
- displayHeight: fields.displayHeight
908
- });
909
- }
910
- if (fields.type === TRACK_TYPE_AUDIO) {
911
- counters.audio += 1;
912
- return new AudioTrack({
913
- ...common,
914
- declaredIndex: counters.audio,
915
- isOriginal: fields.isOriginal,
916
- isCommentary: fields.isCommentary,
917
- isVisualImpaired: fields.isVisual,
918
- channels: fields.channels,
919
- samplingFrequency: fields.samplingFreq
920
- });
921
- }
922
- if (fields.type === TRACK_TYPE_SUBTITLE) {
923
- counters.subtitle += 1;
924
- // A track the file marks unusable is still COUNTED: ffmpeg creates and
925
- // numbers a stream for it, so leaving it out would shift `declaredIndex`
926
- // off `0:s:N` for every track after it. It is refused where it is offered.
927
- const isText = TEXT_CODECS_MATROSKA.has(fields.codecId);
928
- const Target = isText ? TextSubtitleTrack : ImageSubtitleTrack;
929
- return new Target({
930
- ...common,
931
- declaredIndex: counters.subtitle,
932
- isForced: fields.isForced,
933
- isHearingImpaired: fields.isHearing,
934
- clusterPositions: []
935
- });
936
- }
937
- return new ContainerTrack({ ...common, declaredIndex: -1, type: "other" });
938
- }
939
-
940
- /**
941
- * Every block of one track inside one cluster held whole in a buffer.
942
- *
943
- * @param {Buffer} buffer - Bytes holding the cluster's payload.
944
- * @param {{ dataOffset: number, size: number }} cluster - Where that payload is.
945
- * @param {number} trackNumber - The track to keep.
946
- * @param {number} secondsPerTick - From the segment's timestamp scale.
947
- * @returns {{ startSeconds: number, durationSeconds: number | null, payload: Buffer }[]}
948
- */
949
- function blocksOfTrack(buffer, cluster, trackNumber, secondsPerTick) {
950
- const end = Math.min(buffer.length, cluster.dataOffset + cluster.size);
951
- const blocks = [];
952
- let clusterTicks = null;
953
- const pending = [];
954
-
955
- const take = (blockStart, blockEnd, durationTicks) => {
956
- const header = readBlockHeader(buffer, blockStart, blockEnd);
957
- if (!header || header.trackNumber !== trackNumber) {
958
- return;
959
- }
960
- const payloadAt = firstFrameOffset(buffer, header.dataOffset, blockEnd, header.flags);
961
- if (payloadAt === null || payloadAt >= blockEnd) {
962
- return;
963
- }
964
- pending.push({ relativeTicks: header.relativeTicks, durationTicks, payload: buffer.subarray(payloadAt, blockEnd) });
965
- };
966
-
967
- for (const element of iterateElements(buffer, cluster.dataOffset, end)) {
968
- const elementEnd = Math.min(end, element.dataOffset + element.size);
969
- if (element.id === ID_TIMESTAMP) {
970
- clusterTicks = readUint(buffer, element.dataOffset, element.size);
971
- continue;
972
- }
973
- if (element.id === ID_SIMPLE_BLOCK) {
974
- take(element.dataOffset, elementEnd, null);
975
- continue;
976
- }
977
- if (element.id !== ID_BLOCK_GROUP) {
978
- continue;
979
- }
980
- let blockStart = null;
981
- let blockEnd = null;
982
- let durationTicks = null;
983
- for (const field of iterateElements(buffer, element.dataOffset, elementEnd)) {
984
- const fieldEnd = Math.min(elementEnd, field.dataOffset + field.size);
985
- if (field.id === ID_BLOCK) {
986
- blockStart = field.dataOffset;
987
- blockEnd = fieldEnd;
988
- } else if (field.id === ID_BLOCK_DURATION) {
989
- durationTicks = readUint(buffer, field.dataOffset, field.size);
990
- }
991
- }
992
- if (blockStart !== null) {
993
- take(blockStart, blockEnd, durationTicks);
994
- }
995
- }
996
- // The Timestamp SHOULD come first (§5.1.3.1), not MUST: blocks before it are
997
- // placed once the cluster's time is known.
998
- if (clusterTicks === null) {
999
- return blocks;
1000
- }
1001
- for (const block of pending) {
1002
- blocks.push({
1003
- startSeconds: (clusterTicks + block.relativeTicks) * secondsPerTick,
1004
- durationSeconds: block.durationTicks === null ? null : block.durationTicks * secondsPerTick,
1005
- payload: block.payload
1006
- });
1007
- }
1008
- return blocks;
1009
- }
1010
-
1011
- /**
1012
- * The cues of one track inside one cluster held whole in a buffer.
1013
- *
1014
- * @param {Buffer} bytes - The cluster, from its own element header onward.
1015
- * @param {number} trackNumber
1016
- * @param {number} secondsPerTick
1017
- * @returns {{ startSeconds: number, endSeconds: number | null, payload: Buffer }[]}
1018
- */
1019
- function harvestCluster(bytes, trackNumber, secondsPerTick) {
1020
- const header = [...iterateElements(bytes, 0, bytes.length)][0];
1021
- if (!header) {
1022
- return [];
1023
- }
1024
- return blocksOfTrack(bytes, { dataOffset: header.dataOffset, size: header.size }, trackNumber, secondsPerTick).map(
1025
- (block) => ({
1026
- startSeconds: block.startSeconds,
1027
- endSeconds: block.durationSeconds === null ? null : block.startSeconds + block.durationSeconds,
1028
- payload: block.payload
1029
- })
1030
- );
1031
- }
1
+ /**
2
+ * @file Matroska/WebM container — RFC 9559.
3
+ *
4
+ * Reads Tracks in one pass for all media types (video, audio, subtitle).
5
+ * Implements spec-accurate flag handling:
6
+ * - FlagEnabled 0xB9 default 1, zero-length element = default (not disabled)
7
+ * - FlagDefault 0x88 default 1, declaresDefault tracks whether element was written
8
+ * - FlagForced 0x55AA only for subtitles, FlagHearingImpaired 0x55AB, FlagVisualImpaired 0x55AC,
9
+ * FlagTextDescriptions 0x55AD, FlagOriginal 0x55AE, FlagCommentary 0x55AF
10
+ * - Language 0x22B59C default "eng" (RFC 8794 §11.1.19: an element equal to its
11
+ * default need not be written, and the reader MUST read the default),
12
+ * LanguageBCP47 0x22B59D MUST — when present, Language ignored
13
+ * - CodecID 0x86, CodecPrivate 0x63A2, Name 0x536E, TrackType 0x83 (1 video, 2 audio, 17 subtitle)
14
+ *
15
+ * **One reading of each thing the file states, kept on the container.** The
16
+ * layout of the Segment, the Tracks element and the Cues table are each read
17
+ * once and kept — and only once they have been read whole: a read whose bytes
18
+ * have not arrived throws `BytesUnavailable` and leaves nothing behind
19
+ * (`unavailable.js`). The keyframe times and the subtitle plan are both taken
20
+ * from the one Cues reading. Until 2026-10-01 the Cues table was read three
21
+ * times by three functions, the subtitle one kept a read that had not arrived
22
+ * as "no clusters", and an embedded track showed nothing for a whole session.
23
+ *
24
+ * **Read where it lies.** Elements are found by walking the Segment's top-level
25
+ * headers, not by hoping they fit a head window, and read a portion at a time
26
+ * through `ebml-stream.js` — so a large Tracks element or Cues table is read by
27
+ * its own size and never cut short by a bound of ours.
28
+ *
29
+ * Byte-level EBML grammar is `ebml-reader.js` and `ebml-stream.js`; the clusters
30
+ * found from downloaded bytes are `matroska-clusters.js`. Everything Matroska
31
+ * states about itself is read in this module or that one, and the class is the
32
+ * only way in.
33
+ */
34
+
35
+ import { Container } from "./Container.js";
36
+ import { VideoTrack } from "../tracks/VideoTrack.js";
37
+ import { AudioTrack } from "../tracks/AudioTrack.js";
38
+ import { TextSubtitleTrack, TEXT_CODECS_MATROSKA } from "../tracks/TextSubtitleTrack.js";
39
+ import { ImageSubtitleTrack } from "../tracks/ImageSubtitleTrack.js";
40
+ import { ContainerTrack } from "../tracks/ContainerTrack.js";
41
+ import { iterateElements, readFloat, readUint, readVint } from "./ebml-reader.js";
42
+ import { ElementReader, sizeIsUnknown } from "./ebml-stream.js";
43
+ import { firstFrameOffset, readBlockHeader, walkHeldClusters } from "./matroska-clusters.js";
44
+
45
+ /** Enough to hold the EBML header and the Segment's own header. */
46
+ const HEAD_BYTES = 64 * 1024;
47
+
48
+ const ID_EBML = 0x1a45dfa3;
49
+ const ID_SEGMENT = 0x18538067;
50
+ const ID_SEEK_HEAD = 0x114d9b74;
51
+ const ID_SEEK = 0x4dbb;
52
+ const ID_SEEK_ID = 0x53ab;
53
+ const ID_SEEK_POSITION = 0x53ac;
54
+ const ID_INFO = 0x1549a966;
55
+ const ID_TIMESTAMP_SCALE = 0x2ad7b1;
56
+ const ID_DURATION = 0x4489;
57
+ const ID_CLUSTER = 0x1f43b675;
58
+ const ID_CUES = 0x1c53bb6b;
59
+ const ID_CUE_POINT = 0xbb;
60
+ const ID_CUE_TIME = 0xb3;
61
+ const ID_CUE_TRACK_POSITIONS = 0xb7;
62
+ const ID_CUE_TRACK = 0xf7;
63
+ const ID_CUE_CLUSTER_POSITION = 0xf1;
64
+ const ID_TIMESTAMP = 0xe7;
65
+ const ID_SIMPLE_BLOCK = 0xa3;
66
+ const ID_BLOCK_GROUP = 0xa0;
67
+ const ID_BLOCK = 0xa1;
68
+ const ID_BLOCK_DURATION = 0x9b;
69
+ const ID_TRACKS = 0x1654ae6b;
70
+ const ID_TRACK_ENTRY = 0xae;
71
+ const ID_TRACK_NUMBER = 0xd7;
72
+ const ID_TRACK_TYPE = 0x83;
73
+ const ID_FLAG_ENABLED = 0xb9;
74
+ const ID_FLAG_DEFAULT = 0x88;
75
+ const ID_FLAG_FORCED = 0x55aa;
76
+ const ID_FLAG_HEARING = 0x55ab;
77
+ const ID_FLAG_VISUAL = 0x55ac;
78
+ const ID_FLAG_TEXT_DESCR = 0x55ad;
79
+ const ID_FLAG_ORIGINAL = 0x55ae;
80
+ const ID_FLAG_COMMENTARY = 0x55af;
81
+ const ID_CODEC_ID = 0x86;
82
+ const ID_CODEC_PRIVATE = 0x63a2;
83
+ const ID_LANGUAGE = 0x22b59c;
84
+ const ID_LANGUAGE_BCP47 = 0x22b59d;
85
+ const ID_NAME = 0x536e;
86
+ const ID_VIDEO = 0xe0;
87
+ const ID_AUDIO = 0xe1;
88
+ const ID_PIXEL_WIDTH = 0xb0;
89
+ const ID_PIXEL_HEIGHT = 0xba;
90
+ const ID_DISPLAY_WIDTH = 0x54b0;
91
+ const ID_DISPLAY_HEIGHT = 0x54ba;
92
+ const ID_SAMPLING_FREQUENCY = 0xb5;
93
+ const ID_CHANNELS = 0x9f;
94
+
95
+ /** RFC 9559 §5.1.2.1: nanoseconds per tick when Info omits TimestampScale. */
96
+ const DEFAULT_TIMESTAMP_SCALE = 1_000_000;
97
+ /** RFC 9559 §5.1.4.1.19: what an absent or empty `Language` element means. */
98
+ const DEFAULT_LANGUAGE = "eng";
99
+
100
+ const TRACK_TYPE_VIDEO = 1;
101
+ const TRACK_TYPE_AUDIO = 2;
102
+ const TRACK_TYPE_SUBTITLE = 17;
103
+
104
+ /**
105
+ * ReadOrder, Layer, Style, Name, MarginL, MarginR, MarginV, Effect — the eight
106
+ * fields Matroska writes before the text of an SSA/ASS event. See
107
+ * {@link MatroskaContainer.cueTextOf} for the quotation this comes from.
108
+ */
109
+ const ASS_FIELDS_BEFORE_TEXT = 8;
110
+
111
+ function readString(buf, el) {
112
+ return buf.toString("utf8", el.dataOffset, el.dataOffset + el.size).replace(/\0+$/, "");
113
+ }
114
+
115
+ /**
116
+ * @typedef {object} SegmentLayout
117
+ * @property {number} segmentDataOffset - Where the Segment's data begins.
118
+ * @property {number} segmentEnd - One past its last byte (the file's end for an
119
+ * unknown-sized Segment).
120
+ * @property {number} secondsPerTick
121
+ * @property {number | null} infoAt - Positions of the top-level elements, from
122
+ * the walk to the first cluster or from the SeekHead.
123
+ * @property {number | null} tracksAt
124
+ * @property {number | null} cuesAt
125
+ * @property {number | null} firstClusterAt
126
+ */
127
+
128
+ export class MatroskaContainer extends Container {
129
+ /** @type {Buffer | null} */
130
+ #head = null;
131
+
132
+ /** @type {SegmentLayout | null} */
133
+ #layout = null;
134
+
135
+ /** @type {Array<import("../tracks/ContainerTrack.js").ContainerTrack> | null} */
136
+ #tracks = null;
137
+
138
+ /**
139
+ * The Cues reading: undefined until read, null when the file has none.
140
+ * @type {{ points: Array<{ ticks: number, positions: Array<{ track: number, clusterAt: number }> }> } | null | undefined}
141
+ */
142
+ #cues = undefined;
143
+
144
+ get formatName() {
145
+ return "matroska";
146
+ }
147
+
148
+ static detect(head) {
149
+ return isMatroska(head);
150
+ }
151
+
152
+ /**
153
+ * The keyframe times this container's own index states, in ascending seconds.
154
+ *
155
+ * Static so a caller that has bytes and no container can ask; the reading is
156
+ * the instance's, over a container built for the purpose.
157
+ *
158
+ * @param {(start:number,end:number)=>Promise<Buffer|null>} readRange
159
+ * @param {number} fileSize
160
+ * @returns {Promise<number[]|null>} Null where the container has no index.
161
+ */
162
+ static async readKeyframeTimes(readRange, fileSize) {
163
+ const index = await new MatroskaContainer({ readRange, fileSize }).parseKeyframeIndex();
164
+ return index ? index.times : null;
165
+ }
166
+
167
+ /**
168
+ * @param {(start:number,end:number)=>Promise<Buffer|null>} readRange
169
+ * @param {number} fileSize
170
+ * @returns {Promise<object|null>}
171
+ */
172
+ static readSubtitlePlan(readRange, fileSize) {
173
+ return new MatroskaContainer({ readRange, fileSize }).readSubtitlePlan();
174
+ }
175
+
176
+ /**
177
+ * The blocks one track has inside a cluster held whole in a buffer.
178
+ *
179
+ * @param {Buffer} bytes - The cluster, from its own element header onward.
180
+ * @param {number} trackNumber
181
+ * @param {number} secondsPerTick
182
+ * @returns {{ startSeconds: number, endSeconds: number | null, payload: Buffer }[]}
183
+ */
184
+ static blocksInCluster(bytes, trackNumber, secondsPerTick) {
185
+ return harvestCluster(bytes, trackNumber, secondsPerTick);
186
+ }
187
+
188
+ /**
189
+ * The blocks one track has inside a cluster whose bounds are already known —
190
+ * RFC 9559 §5.1.3.4 (SimpleBlock) and §5.1.3.5 (BlockGroup).
191
+ *
192
+ * @param {Buffer} buffer
193
+ * @param {{ dataOffset: number, size: number }} cluster
194
+ * @param {number} trackNumber
195
+ * @param {number} secondsPerTick
196
+ * @returns {{ startSeconds: number, durationSeconds: number | null, payload: Buffer }[]}
197
+ */
198
+ static blocksOfTrack(buffer, cluster, trackNumber, secondsPerTick) {
199
+ return blocksOfTrack(buffer, cluster, trackNumber, secondsPerTick);
200
+ }
201
+
202
+ /**
203
+ * A reader for the inside of one element: a portion at a time, never past
204
+ * the element's end — so a Cues table of thousands of CuePoints costs a few
205
+ * reads rather than one per CuePoint, and nothing after the element is
206
+ * fetched for it.
207
+ *
208
+ * @param {number} end - One past the element's last byte.
209
+ * @returns {ElementReader}
210
+ */
211
+ #readerWithin(end) {
212
+ return new ElementReader({
213
+ read: this.readRange,
214
+ fileSize: this.fileSize,
215
+ portionBytes: this.portionBytes,
216
+ prefetch: true,
217
+ readableUntil: () => end
218
+ });
219
+ }
220
+
221
+ /** @returns {Promise<Buffer>} */
222
+ async #headBytes() {
223
+ if (this.#head === null) {
224
+ this.#head = await this.readRange(0, Math.min(HEAD_BYTES, this.fileSize) - 1);
225
+ }
226
+ return this.#head;
227
+ }
228
+
229
+ /**
230
+ * Where the Segment's top-level elements are.
231
+ *
232
+ * Found by walking their HEADERS from the Segment's start to the first
233
+ * cluster — each one costs the bytes of its header and nothing of its data —
234
+ * and, for what lies after the clusters, from the SeekHead. RFC 9559 §6.4: a
235
+ * Cues element SHOULD be stored before the first cluster or be referenced by
236
+ * a SeekHead, so the two together find it wherever a conforming file puts it.
237
+ *
238
+ * @returns {Promise<SegmentLayout | null>} Null for bytes that are not a
239
+ * Matroska Segment.
240
+ */
241
+ async #segmentLayout() {
242
+ if (this.#layout !== null) {
243
+ return this.#layout;
244
+ }
245
+ const head = await this.#headBytes();
246
+ if (!isMatroska(head)) {
247
+ return null;
248
+ }
249
+ const segment = segmentHeaderIn(head);
250
+ if (!segment) {
251
+ return null;
252
+ }
253
+ const segmentDataOffset = segment.dataOffset;
254
+ const segmentEnd = segment.size === null ? this.fileSize : Math.min(this.fileSize, segmentDataOffset + segment.size);
255
+
256
+ const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
257
+ /** @type {Map<number, number>} */
258
+ const found = new Map();
259
+ /** @type {Map<number, number>} */
260
+ const seeks = new Map();
261
+ let firstClusterAt = null;
262
+ let at = segmentDataOffset;
263
+ while (at < segmentEnd) {
264
+ const header = await reader.header(at, segmentEnd);
265
+ if (!header) {
266
+ break;
267
+ }
268
+ if (header.id === ID_CLUSTER) {
269
+ firstClusterAt = at;
270
+ break;
271
+ }
272
+ if (!found.has(header.id)) {
273
+ found.set(header.id, at);
274
+ }
275
+ if (header.id === ID_SEEK_HEAD && header.size !== null) {
276
+ const data = await reader.data(header);
277
+ if (data) {
278
+ for (const [id, position] of readSeekEntries(data)) {
279
+ seeks.set(id, segmentDataOffset + position);
280
+ }
281
+ }
282
+ }
283
+ if (header.end === null) {
284
+ break;
285
+ }
286
+ at = header.end;
287
+ }
288
+ const positionOf = (id) => found.get(id) ?? seeks.get(id) ?? null;
289
+
290
+ let secondsPerTick = DEFAULT_TIMESTAMP_SCALE / 1e9;
291
+ const infoAt = positionOf(ID_INFO);
292
+ if (infoAt !== null) {
293
+ const info = await reader.header(infoAt, segmentEnd);
294
+ const data = info && info.id === ID_INFO ? await reader.data(info) : null;
295
+ if (data) {
296
+ for (const field of iterateElements(data)) {
297
+ if (field.id === ID_TIMESTAMP_SCALE) {
298
+ const scale = readUint(data, field.dataOffset, field.size);
299
+ if (scale > 0) {
300
+ secondsPerTick = scale / 1e9;
301
+ }
302
+ }
303
+ }
304
+ }
305
+ }
306
+ this.#layout = {
307
+ segmentDataOffset,
308
+ segmentEnd,
309
+ secondsPerTick,
310
+ infoAt,
311
+ tracksAt: positionOf(ID_TRACKS),
312
+ cuesAt: positionOf(ID_CUES),
313
+ firstClusterAt: firstClusterAt ?? seeks.get(ID_CLUSTER) ?? null
314
+ };
315
+ return this.#layout;
316
+ }
317
+
318
+ /**
319
+ * Duration and the start of this file's own timeline, per RFC 9559 §5.1.2.
320
+ *
321
+ * Duration is stated in `Info` as a FLOAT in ticks. The start of the timeline
322
+ * is not stated anywhere — Matroska has no such element — so it is the
323
+ * timestamp of the first Cluster, which is what the first frame is placed
324
+ * against.
325
+ *
326
+ * Kept only once it has been read: a head that had not arrived used to leave
327
+ * an empty answer here for the life of the container.
328
+ *
329
+ * @returns {Promise<import("./Container.js").ContainerMediaInfo>}
330
+ */
331
+ async readMediaInfo() {
332
+ if (this.mediaInfo) {
333
+ return this.mediaInfo;
334
+ }
335
+ /** @type {import("./Container.js").ContainerMediaInfo} */
336
+ const info = { format: this.formatName, durationSeconds: null, startTimeSeconds: null };
337
+ const layout = await this.#segmentLayout();
338
+ if (!layout) {
339
+ this.mediaInfo = info;
340
+ return info;
341
+ }
342
+ const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
343
+ if (layout.infoAt !== null) {
344
+ const header = await reader.header(layout.infoAt, layout.segmentEnd);
345
+ const data = header && header.id === ID_INFO ? await reader.data(header) : null;
346
+ if (data) {
347
+ for (const field of iterateElements(data)) {
348
+ if (field.id === ID_DURATION) {
349
+ const ticks = readFloat(data, field.dataOffset, field.size);
350
+ if (ticks !== null && ticks > 0) {
351
+ info.durationSeconds = ticks * layout.secondsPerTick;
352
+ }
353
+ }
354
+ }
355
+ }
356
+ }
357
+ if (layout.firstClusterAt !== null) {
358
+ info.startTimeSeconds = await clusterTimestampSeconds(reader, layout.firstClusterAt, layout);
359
+ }
360
+ this.mediaInfo = info;
361
+ return info;
362
+ }
363
+
364
+ /**
365
+ * Every track the file declares, in its order, read once.
366
+ *
367
+ * @returns {Promise<import("../tracks/index.js").ContainerTrack[]>}
368
+ */
369
+ async readTracks() {
370
+ if (this.#tracks !== null) {
371
+ return this.#tracks;
372
+ }
373
+ const layout = await this.#segmentLayout();
374
+ if (!layout || layout.tracksAt === null) {
375
+ this.#tracks = [];
376
+ return this.#tracks;
377
+ }
378
+ const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
379
+ const tracksHeader = await reader.header(layout.tracksAt, layout.segmentEnd);
380
+ if (!tracksHeader || tracksHeader.id !== ID_TRACKS || tracksHeader.end === null) {
381
+ this.#tracks = [];
382
+ return this.#tracks;
383
+ }
384
+ /** @type {import("../tracks/index.js").ContainerTrack[]} */
385
+ const result = [];
386
+ const counters = { video: -1, audio: -1, subtitle: -1 };
387
+ const within = this.#readerWithin(tracksHeader.end);
388
+ let at = tracksHeader.dataOffset;
389
+ while (at < tracksHeader.end) {
390
+ const entry = await within.header(at, tracksHeader.end);
391
+ if (!entry || entry.end === null) {
392
+ break;
393
+ }
394
+ if (entry.id === ID_TRACK_ENTRY) {
395
+ const data = await within.data(entry);
396
+ // An entry larger than one portion is refused rather than assembled.
397
+ // Its type cannot be known without its data, so it is kept as a track
398
+ // of no kind — which makes the count of its kind short by one, and
399
+ // `alignWithBanner` then refuses to line the two readings up rather
400
+ // than pairing them wrongly.
401
+ const fields = data ? parseTrackEntry(data) : { refused: true, trackNumber: null };
402
+ const track = trackFrom(fields, counters);
403
+ if (track) {
404
+ result.push(track);
405
+ }
406
+ }
407
+ at = entry.end;
408
+ }
409
+ this.#tracks = result;
410
+ return result;
411
+ }
412
+
413
+ /**
414
+ * The Cues table, read once, every CuePoint with every track it names.
415
+ *
416
+ * @returns {Promise<{ points: Array<{ ticks: number, positions: Array<{ track: number, clusterAt: number }> }> } | null>}
417
+ * Null where the file has no Cues element — a statement about the file,
418
+ * kept. A Cues element that has not downloaded throws and is not kept.
419
+ */
420
+ async readCues() {
421
+ if (this.#cues !== undefined) {
422
+ return this.#cues;
423
+ }
424
+ const layout = await this.#segmentLayout();
425
+ if (!layout || layout.cuesAt === null) {
426
+ this.#cues = null;
427
+ return null;
428
+ }
429
+ const reader = new ElementReader({ read: this.readRange, fileSize: this.fileSize, portionBytes: this.portionBytes });
430
+ const cues = await reader.header(layout.cuesAt, layout.segmentEnd);
431
+ if (!cues || cues.id !== ID_CUES || cues.end === null) {
432
+ // The SeekHead names a position with no Cues element at it. The file is
433
+ // wrong there, and the same bytes will say the same thing next time.
434
+ this.#cues = null;
435
+ return null;
436
+ }
437
+ const points = [];
438
+ const within = this.#readerWithin(cues.end);
439
+ let at = cues.dataOffset;
440
+ while (at < cues.end) {
441
+ const point = await within.header(at, cues.end);
442
+ if (!point || point.end === null) {
443
+ break;
444
+ }
445
+ if (point.id === ID_CUE_POINT) {
446
+ const data = await within.data(point);
447
+ if (data) {
448
+ const parsed = parseCuePoint(data, layout.segmentDataOffset);
449
+ if (parsed) {
450
+ points.push(parsed);
451
+ }
452
+ }
453
+ }
454
+ at = point.end;
455
+ }
456
+ this.#cues = { points };
457
+ return this.#cues;
458
+ }
459
+
460
+ /**
461
+ * This container's subtitle tracks, the Cues table and the clusters it
462
+ * names — everything the cue walk starts from.
463
+ *
464
+ * `cuesState` says whether the file has a Cues table at all; where it has
465
+ * none, the walk finds clusters from the downloaded bytes themselves.
466
+ *
467
+ * @returns {Promise<object | null>} Null for bytes that are not Matroska.
468
+ */
469
+ async readSubtitlePlan() {
470
+ const layout = await this.#segmentLayout();
471
+ if (!layout) {
472
+ return null;
473
+ }
474
+ const allTracks = await this.readTracks();
475
+ const cues = await this.readCues();
476
+ const subtitles = allTracks.filter((track) => track.type === "subtitle");
477
+ const declared = subtitles.map((track) => ({
478
+ trackNumber: track.trackNumber,
479
+ codecId: track.codecId,
480
+ // The three-letter code: this list is lined up against ffmpeg's banner,
481
+ // which prints that form. The RFC 5646 tag rides beside it.
482
+ language: track.languageCode || track.language,
483
+ languageBcp47: track.languageBcp47,
484
+ declaresLanguage: track.declaresLanguage,
485
+ languageSource: track.languageSource,
486
+ name: track.name,
487
+ isDefault: track.isDefault,
488
+ declaresDefault: track.declaresDefault,
489
+ isEnabled: track.isEnabled,
490
+ isForced: track.isForced === true,
491
+ isHearingImpaired: track.isHearingImpaired === true
492
+ }));
493
+ /** @type {Map<number, Set<number>>} */
494
+ const byTrack = new Map();
495
+ /** @type {Map<number, number>} */
496
+ const entrySeconds = new Map();
497
+ for (const point of cues?.points ?? []) {
498
+ const seconds = point.ticks * layout.secondsPerTick;
499
+ for (const { track, clusterAt } of point.positions) {
500
+ if (!byTrack.has(track)) {
501
+ byTrack.set(track, new Set());
502
+ }
503
+ byTrack.get(track).add(clusterAt);
504
+ // The cluster begins at or before the earliest frame that names it.
505
+ const known = entrySeconds.get(clusterAt);
506
+ if (known === undefined || seconds < known) {
507
+ entrySeconds.set(clusterAt, seconds);
508
+ }
509
+ }
510
+ }
511
+ const tracks = subtitles
512
+ .filter((track) => TEXT_CODECS_MATROSKA.has(track.codecId) && track.isEnabled)
513
+ .map((track) => ({
514
+ trackNumber: track.trackNumber,
515
+ declaredIndex: track.declaredIndex,
516
+ codecId: track.codecId,
517
+ language: track.language,
518
+ languageBcp47: track.languageBcp47,
519
+ declaresLanguage: track.declaresLanguage,
520
+ languageSource: track.languageSource,
521
+ name: track.name,
522
+ isDefault: track.isDefault,
523
+ isForced: track.isForced === true,
524
+ isHearingImpaired: track.isHearingImpaired === true,
525
+ codecPrivate: track.codecPrivateB64,
526
+ clusterPositions: [...(byTrack.get(track.trackNumber) ?? [])].sort((left, right) => left - right)
527
+ }));
528
+ return {
529
+ tracks,
530
+ declared,
531
+ secondsPerTick: layout.secondsPerTick,
532
+ segmentDataOffset: layout.segmentDataOffset,
533
+ fileSize: this.fileSize,
534
+ segmentEnd: layout.segmentEnd,
535
+ firstClusterAt: layout.firstClusterAt,
536
+ cuesState: cues ? "complete" : "absent",
537
+ entryPoints: [...entrySeconds].map(([at, seconds]) => ({ at, seconds })).sort((left, right) => left.at - right.at),
538
+ subtitleTrackNumbers: tracks.map((track) => track.trackNumber),
539
+ allTrackNumbers: allTracks.map((track) => track.trackNumber).filter((number) => Number.isFinite(number))
540
+ };
541
+ }
542
+
543
+ /**
544
+ * The cues this file holds now, for every text track at once — see
545
+ * `matroska-clusters.js` for how clusters are found and in what order read.
546
+ *
547
+ * @param {object} plan
548
+ * @param {object} track
549
+ * @param {object} progress
550
+ * @param {import("./Container.js").HeldReader} held
551
+ * @returns {Promise<{ found: Map<number, object[]>, covered: number, indexed: number, withdrawn: number[], stats: object }>}
552
+ */
553
+ async readHeldCues(plan, track, progress, held) {
554
+ const walked = await walkHeldClusters({ plan, progress, held });
555
+ const found = new Map();
556
+ for (const candidate of plan.tracks) {
557
+ const blocks = walked.found.get(candidate.trackNumber);
558
+ if (!blocks) {
559
+ continue;
560
+ }
561
+ found.set(
562
+ candidate.trackNumber,
563
+ blocks.map((block) => ({
564
+ startSeconds: block.startSeconds,
565
+ endSeconds: block.endSeconds,
566
+ // The block's bytes become text HERE, where the container that
567
+ // framed them is known.
568
+ text: MatroskaContainer.cueTextOf(block.payload, candidate.codecId),
569
+ source: block.source
570
+ }))
571
+ );
572
+ }
573
+ return { ...walked, found };
574
+ }
575
+
576
+ /**
577
+ * The text field of one cue as Matroska frames it.
578
+ *
579
+ * Two rules, both from `matroska.org/technical/subtitles.html`, "Now, how are
580
+ * they stored in Matroska?":
581
+ *
582
+ * 1. "All text is converted to UTF-8", so the block is decoded as UTF-8 and
583
+ * no other encoding is guessed at. A subtitle FILE is a different matter —
584
+ * there the bytes may be Windows-1251 and `decodeSubtitleBytes` sniffs for
585
+ * it — but a muxer had to convert before writing the block.
586
+ * 2. "Events are stored in the Block in this order: ReadOrder, Layer, Style,
587
+ * Name, MarginL, MarginR, MarginV, Effect, Text", and "Start & End field
588
+ * are used to set TimeStamp and the BlockDuration element". So eight fields
589
+ * stand before the text, the two timing fields of the file's own row are
590
+ * NOT among them, and a read order takes their place at the front. The text
591
+ * itself may hold commas, so everything from the ninth field on is joined
592
+ * back together.
593
+ *
594
+ * `S_TEXT/UTF8` and `S_TEXT/WEBVTT` have no such framing: the block holds the
595
+ * cue text and nothing else.
596
+ *
597
+ * @param {Buffer} payload - The block's own bytes.
598
+ * @param {string} codecId - Matroska CodecID of the track the block belongs to.
599
+ * @returns {string}
600
+ */
601
+ static cueTextOf(payload, codecId) {
602
+ const text = Buffer.isBuffer(payload) ? payload.toString("utf8") : String(payload ?? "");
603
+ if (codecId !== "S_TEXT/ASS" && codecId !== "S_TEXT/SSA") {
604
+ return text;
605
+ }
606
+ const fields = text.split(",");
607
+ return fields.length > ASS_FIELDS_BEFORE_TEXT ? fields.slice(ASS_FIELDS_BEFORE_TEXT).join(",") : "";
608
+ }
609
+
610
+ /**
611
+ * The keyframe times of the first video track, from the one Cues reading.
612
+ *
613
+ * A CuePoint belongs to the track named inside its CueTrackPositions, and a
614
+ * muxer indexes whatever tracks it likes — field files index their subtitle
615
+ * tracks too, and read without the track those times entered the cut list as
616
+ * though they were keyframes (2026-08-18). Where the filter leaves nothing
617
+ * although a table exists, the unfiltered table is used: less exact than the
618
+ * picture's own keyframes, better than an even grid that has nothing to do
619
+ * with the file.
620
+ *
621
+ * @returns {Promise<{ times: number[], tolerance: number } | null>}
622
+ */
623
+ async parseKeyframeIndex() {
624
+ const layout = await this.#segmentLayout();
625
+ if (!layout) {
626
+ return null;
627
+ }
628
+ const cues = await this.readCues();
629
+ if (!cues) {
630
+ return null;
631
+ }
632
+ const tracks = await this.readTracks();
633
+ const video = tracks.find((track) => track.type === "video")?.trackNumber ?? null;
634
+ const timesFor = (wanted) =>
635
+ cues.points
636
+ .filter((point) => wanted === null || point.positions.some((position) => position.track === wanted))
637
+ .map((point) => point.ticks * layout.secondsPerTick)
638
+ .sort((left, right) => left - right);
639
+ const times = timesFor(video);
640
+ if (times.length > 0) {
641
+ return { times, tolerance: 0 };
642
+ }
643
+ if (video === null) {
644
+ return null;
645
+ }
646
+ const unfiltered = timesFor(null);
647
+ return unfiltered.length > 0 ? { times: unfiltered, tolerance: 0 } : null;
648
+ }
649
+ }
650
+
651
+ /**
652
+ * Whether this looks like a Matroska file (the EBML magic `0x1A45DFA3`).
653
+ *
654
+ * @param {Buffer} head
655
+ * @returns {boolean}
656
+ */
657
+ function isMatroska(head) {
658
+ return head.length >= 4 && head.readUInt32BE(0) === ID_EBML;
659
+ }
660
+
661
+ /**
662
+ * The Segment element's header, from the top-level elements of the head.
663
+ *
664
+ * @param {Buffer} head
665
+ * @returns {{ dataOffset: number, size: number | null } | null} `size` is null
666
+ * for an unknown-sized Segment (RFC 8794 §6.2), which runs to the file's end.
667
+ */
668
+ function segmentHeaderIn(head) {
669
+ let offset = 0;
670
+ while (offset < head.length) {
671
+ const id = readVint(head, offset, true);
672
+ const size = id && readVint(head, offset + id.length, false);
673
+ if (!id || !size) {
674
+ return null;
675
+ }
676
+ const dataOffset = offset + id.length + size.length;
677
+ if (id.value === ID_SEGMENT) {
678
+ return { dataOffset, size: sizeIsUnknown(size) ? null : size.value };
679
+ }
680
+ offset = dataOffset + size.value;
681
+ }
682
+ return null;
683
+ }
684
+
685
+ /**
686
+ * The SeekHead's entries, id to position relative to the Segment's data.
687
+ *
688
+ * @param {Buffer} data - The SeekHead's data.
689
+ * @returns {Map<number, number>}
690
+ */
691
+ function readSeekEntries(data) {
692
+ const entries = new Map();
693
+ for (const seek of iterateElements(data)) {
694
+ if (seek.id !== ID_SEEK) {
695
+ continue;
696
+ }
697
+ const end = Math.min(data.length, seek.dataOffset + seek.size);
698
+ let targetId = null;
699
+ let position = null;
700
+ for (const field of iterateElements(data, seek.dataOffset, end)) {
701
+ if (field.id === ID_SEEK_ID) {
702
+ targetId = readUint(data, field.dataOffset, field.size);
703
+ } else if (field.id === ID_SEEK_POSITION) {
704
+ position = readUint(data, field.dataOffset, field.size);
705
+ }
706
+ }
707
+ if (targetId !== null && position !== null && !entries.has(targetId)) {
708
+ entries.set(targetId, position);
709
+ }
710
+ }
711
+ return entries;
712
+ }
713
+
714
+ /**
715
+ * The timestamp of a cluster, from its leading children.
716
+ *
717
+ * §5.1.3.1: the Timestamp SHOULD be the first child, or the second after a
718
+ * CRC-32. Children before it are stepped over by their headers; reading stops
719
+ * at the first block, so a cluster's megabytes are never pulled for this.
720
+ *
721
+ * @param {ElementReader} reader
722
+ * @param {number} at
723
+ * @param {SegmentLayout} layout
724
+ * @returns {Promise<number | null>}
725
+ */
726
+ async function clusterTimestampSeconds(reader, at, layout) {
727
+ const cluster = await reader.header(at, layout.segmentEnd);
728
+ if (!cluster || cluster.id !== ID_CLUSTER) {
729
+ return null;
730
+ }
731
+ const limit = cluster.end ?? layout.segmentEnd;
732
+ let cursor = cluster.dataOffset;
733
+ while (cursor < limit) {
734
+ const child = await reader.header(cursor, limit);
735
+ if (!child || child.size === null) {
736
+ return null;
737
+ }
738
+ if (child.id === ID_TIMESTAMP) {
739
+ const bytes = await reader.bytes(child.dataOffset, child.size);
740
+ return readUint(bytes, 0, child.size) * layout.secondsPerTick;
741
+ }
742
+ if (child.id === ID_SIMPLE_BLOCK || child.id === ID_BLOCK_GROUP) {
743
+ return null;
744
+ }
745
+ cursor = child.end;
746
+ }
747
+ return null;
748
+ }
749
+
750
+ /**
751
+ * One CuePoint: its time and every track position it names.
752
+ *
753
+ * @param {Buffer} data
754
+ * @param {number} segmentDataOffset - CueClusterPosition is relative to it.
755
+ * @returns {{ ticks: number, positions: Array<{ track: number, clusterAt: number }> } | null}
756
+ */
757
+ function parseCuePoint(data, segmentDataOffset) {
758
+ let ticks = null;
759
+ const positions = [];
760
+ for (const field of iterateElements(data)) {
761
+ if (field.id === ID_CUE_TIME) {
762
+ ticks = readUint(data, field.dataOffset, field.size);
763
+ continue;
764
+ }
765
+ if (field.id !== ID_CUE_TRACK_POSITIONS) {
766
+ continue;
767
+ }
768
+ const end = Math.min(data.length, field.dataOffset + field.size);
769
+ let track = null;
770
+ let cluster = null;
771
+ for (const inner of iterateElements(data, field.dataOffset, end)) {
772
+ if (inner.id === ID_CUE_TRACK) {
773
+ track = readUint(data, inner.dataOffset, inner.size);
774
+ } else if (inner.id === ID_CUE_CLUSTER_POSITION) {
775
+ cluster = readUint(data, inner.dataOffset, inner.size);
776
+ }
777
+ }
778
+ if (track !== null && cluster !== null) {
779
+ positions.push({ track, clusterAt: segmentDataOffset + cluster });
780
+ }
781
+ }
782
+ return ticks === null ? null : { ticks, positions };
783
+ }
784
+
785
+ /**
786
+ * Every field of one TrackEntry this proxy reads, with RFC 9559's defaults.
787
+ *
788
+ * @param {Buffer} data - The TrackEntry's data.
789
+ * @returns {object}
790
+ */
791
+ function parseTrackEntry(data) {
792
+ const fields = {
793
+ refused: false,
794
+ trackNumber: null,
795
+ type: null,
796
+ codecId: "",
797
+ language: null,
798
+ languageBcp47: "",
799
+ name: "",
800
+ codecPrivateB64: "",
801
+ isEnabled: true,
802
+ // FlagDefault DEFAULTS TO 1; whether the file wrote it is kept apart,
803
+ // because once the default is applied "no track marked" and "every track
804
+ // marked" look the same.
805
+ isDefault: true,
806
+ declaresDefault: false,
807
+ isForced: false,
808
+ isHearing: false,
809
+ isVisual: false,
810
+ isOriginal: false,
811
+ isCommentary: false,
812
+ pixelWidth: null,
813
+ pixelHeight: null,
814
+ displayWidth: null,
815
+ displayHeight: null,
816
+ samplingFreq: null,
817
+ channels: null
818
+ };
819
+ for (const f of iterateElements(data)) {
820
+ switch (f.id) {
821
+ case ID_TRACK_NUMBER: fields.trackNumber = readUint(data, f.dataOffset, f.size); break;
822
+ case ID_TRACK_TYPE: fields.type = readUint(data, f.dataOffset, f.size); break;
823
+ case ID_CODEC_ID: fields.codecId = readString(data, f); break;
824
+ case ID_CODEC_PRIVATE: fields.codecPrivateB64 = data.toString("base64", f.dataOffset, f.dataOffset + f.size); break;
825
+ // An empty element carries its default (RFC 8794 §6.3 and §11.1.19).
826
+ case ID_LANGUAGE: fields.language = f.size === 0 ? DEFAULT_LANGUAGE : readString(data, f); break;
827
+ case ID_LANGUAGE_BCP47: fields.languageBcp47 = readString(data, f); break;
828
+ case ID_NAME: fields.name = readString(data, f); break;
829
+ // Zero length carries the default, which is 1; only an explicit zero
830
+ // takes a track away.
831
+ case ID_FLAG_ENABLED: fields.isEnabled = f.size === 0 || readUint(data, f.dataOffset, f.size) !== 0; break;
832
+ case ID_FLAG_DEFAULT: fields.isDefault = f.size === 0 || readUint(data, f.dataOffset, f.size) === 1; fields.declaresDefault = true; break;
833
+ case ID_FLAG_FORCED: fields.isForced = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
834
+ case ID_FLAG_HEARING: fields.isHearing = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
835
+ case ID_FLAG_VISUAL: fields.isVisual = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
836
+ case ID_FLAG_TEXT_DESCR: break;
837
+ case ID_FLAG_ORIGINAL: fields.isOriginal = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
838
+ case ID_FLAG_COMMENTARY: fields.isCommentary = f.size > 0 && readUint(data, f.dataOffset, f.size) !== 0; break;
839
+ case ID_VIDEO: {
840
+ const end = Math.min(data.length, f.dataOffset + f.size);
841
+ for (const vf of iterateElements(data, f.dataOffset, end)) {
842
+ if (vf.id === ID_PIXEL_WIDTH) fields.pixelWidth = readUint(data, vf.dataOffset, vf.size);
843
+ else if (vf.id === ID_PIXEL_HEIGHT) fields.pixelHeight = readUint(data, vf.dataOffset, vf.size);
844
+ else if (vf.id === ID_DISPLAY_WIDTH) fields.displayWidth = readUint(data, vf.dataOffset, vf.size);
845
+ else if (vf.id === ID_DISPLAY_HEIGHT) fields.displayHeight = readUint(data, vf.dataOffset, vf.size);
846
+ }
847
+ break;
848
+ }
849
+ case ID_AUDIO: {
850
+ const end = Math.min(data.length, f.dataOffset + f.size);
851
+ for (const af of iterateElements(data, f.dataOffset, end)) {
852
+ if (af.id === ID_SAMPLING_FREQUENCY) {
853
+ fields.samplingFreq = af.size === 8 ? data.readDoubleBE(af.dataOffset) : readFloat(data, af.dataOffset, af.size);
854
+ } else if (af.id === ID_CHANNELS) {
855
+ fields.channels = readUint(data, af.dataOffset, af.size);
856
+ }
857
+ }
858
+ break;
859
+ }
860
+ default: break;
861
+ }
862
+ }
863
+ return fields;
864
+ }
865
+
866
+ /**
867
+ * The track object one TrackEntry describes.
868
+ *
869
+ * The language follows RFC 9559's order: a `LanguageBCP47` element wins and
870
+ * `Language` is then ignored; otherwise `Language`; otherwise its default,
871
+ * `eng` — which a reader MUST apply (RFC 8794 §11.1.19). Where it came from is
872
+ * kept as `languageSource`.
873
+ *
874
+ * @param {object} fields - From {@link parseTrackEntry}.
875
+ * @param {{ video: number, audio: number, subtitle: number }} counters
876
+ * @returns {import("../tracks/ContainerTrack.js").ContainerTrack | null}
877
+ */
878
+ function trackFrom(fields, counters) {
879
+ if (fields.trackNumber === null && !fields.refused) {
880
+ return null;
881
+ }
882
+ const declaresLanguage = fields.languageBcp47.length > 0 || fields.language !== null;
883
+ const languageSource = fields.languageBcp47 ? "bcp47" : fields.language !== null ? "language" : "default";
884
+ const language = fields.languageBcp47 || (fields.language !== null ? fields.language : DEFAULT_LANGUAGE);
885
+ const common = {
886
+ trackNumber: fields.trackNumber,
887
+ codecId: fields.codecId,
888
+ language,
889
+ languageBcp47: fields.languageBcp47,
890
+ declaresLanguage,
891
+ languageSource,
892
+ languageCode: fields.language !== null ? fields.language : DEFAULT_LANGUAGE,
893
+ name: fields.name,
894
+ isEnabled: fields.isEnabled,
895
+ isDefault: fields.isDefault,
896
+ declaresDefault: fields.declaresDefault,
897
+ codecPrivateB64: fields.codecPrivateB64
898
+ };
899
+ if (fields.type === TRACK_TYPE_VIDEO) {
900
+ counters.video += 1;
901
+ return new VideoTrack({
902
+ ...common,
903
+ declaredIndex: counters.video,
904
+ width: fields.pixelWidth,
905
+ height: fields.pixelHeight,
906
+ displayWidth: fields.displayWidth,
907
+ displayHeight: fields.displayHeight
908
+ });
909
+ }
910
+ if (fields.type === TRACK_TYPE_AUDIO) {
911
+ counters.audio += 1;
912
+ return new AudioTrack({
913
+ ...common,
914
+ declaredIndex: counters.audio,
915
+ isOriginal: fields.isOriginal,
916
+ isCommentary: fields.isCommentary,
917
+ isVisualImpaired: fields.isVisual,
918
+ channels: fields.channels,
919
+ samplingFrequency: fields.samplingFreq
920
+ });
921
+ }
922
+ if (fields.type === TRACK_TYPE_SUBTITLE) {
923
+ counters.subtitle += 1;
924
+ // A track the file marks unusable is still COUNTED: ffmpeg creates and
925
+ // numbers a stream for it, so leaving it out would shift `declaredIndex`
926
+ // off `0:s:N` for every track after it. It is refused where it is offered.
927
+ const isText = TEXT_CODECS_MATROSKA.has(fields.codecId);
928
+ const Target = isText ? TextSubtitleTrack : ImageSubtitleTrack;
929
+ return new Target({
930
+ ...common,
931
+ declaredIndex: counters.subtitle,
932
+ isForced: fields.isForced,
933
+ isHearingImpaired: fields.isHearing,
934
+ clusterPositions: []
935
+ });
936
+ }
937
+ return new ContainerTrack({ ...common, declaredIndex: -1, type: "other" });
938
+ }
939
+
940
+ /**
941
+ * Every block of one track inside one cluster held whole in a buffer.
942
+ *
943
+ * @param {Buffer} buffer - Bytes holding the cluster's payload.
944
+ * @param {{ dataOffset: number, size: number }} cluster - Where that payload is.
945
+ * @param {number} trackNumber - The track to keep.
946
+ * @param {number} secondsPerTick - From the segment's timestamp scale.
947
+ * @returns {{ startSeconds: number, durationSeconds: number | null, payload: Buffer }[]}
948
+ */
949
+ function blocksOfTrack(buffer, cluster, trackNumber, secondsPerTick) {
950
+ const end = Math.min(buffer.length, cluster.dataOffset + cluster.size);
951
+ const blocks = [];
952
+ let clusterTicks = null;
953
+ const pending = [];
954
+
955
+ const take = (blockStart, blockEnd, durationTicks) => {
956
+ const header = readBlockHeader(buffer, blockStart, blockEnd);
957
+ if (!header || header.trackNumber !== trackNumber) {
958
+ return;
959
+ }
960
+ const payloadAt = firstFrameOffset(buffer, header.dataOffset, blockEnd, header.flags);
961
+ if (payloadAt === null || payloadAt >= blockEnd) {
962
+ return;
963
+ }
964
+ pending.push({ relativeTicks: header.relativeTicks, durationTicks, payload: buffer.subarray(payloadAt, blockEnd) });
965
+ };
966
+
967
+ for (const element of iterateElements(buffer, cluster.dataOffset, end)) {
968
+ const elementEnd = Math.min(end, element.dataOffset + element.size);
969
+ if (element.id === ID_TIMESTAMP) {
970
+ clusterTicks = readUint(buffer, element.dataOffset, element.size);
971
+ continue;
972
+ }
973
+ if (element.id === ID_SIMPLE_BLOCK) {
974
+ take(element.dataOffset, elementEnd, null);
975
+ continue;
976
+ }
977
+ if (element.id !== ID_BLOCK_GROUP) {
978
+ continue;
979
+ }
980
+ let blockStart = null;
981
+ let blockEnd = null;
982
+ let durationTicks = null;
983
+ for (const field of iterateElements(buffer, element.dataOffset, elementEnd)) {
984
+ const fieldEnd = Math.min(elementEnd, field.dataOffset + field.size);
985
+ if (field.id === ID_BLOCK) {
986
+ blockStart = field.dataOffset;
987
+ blockEnd = fieldEnd;
988
+ } else if (field.id === ID_BLOCK_DURATION) {
989
+ durationTicks = readUint(buffer, field.dataOffset, field.size);
990
+ }
991
+ }
992
+ if (blockStart !== null) {
993
+ take(blockStart, blockEnd, durationTicks);
994
+ }
995
+ }
996
+ // The Timestamp SHOULD come first (§5.1.3.1), not MUST: blocks before it are
997
+ // placed once the cluster's time is known.
998
+ if (clusterTicks === null) {
999
+ return blocks;
1000
+ }
1001
+ for (const block of pending) {
1002
+ blocks.push({
1003
+ startSeconds: (clusterTicks + block.relativeTicks) * secondsPerTick,
1004
+ durationSeconds: block.durationTicks === null ? null : block.durationTicks * secondsPerTick,
1005
+ payload: block.payload
1006
+ });
1007
+ }
1008
+ return blocks;
1009
+ }
1010
+
1011
+ /**
1012
+ * The cues of one track inside one cluster held whole in a buffer.
1013
+ *
1014
+ * @param {Buffer} bytes - The cluster, from its own element header onward.
1015
+ * @param {number} trackNumber
1016
+ * @param {number} secondsPerTick
1017
+ * @returns {{ startSeconds: number, endSeconds: number | null, payload: Buffer }[]}
1018
+ */
1019
+ function harvestCluster(bytes, trackNumber, secondsPerTick) {
1020
+ const header = [...iterateElements(bytes, 0, bytes.length)][0];
1021
+ if (!header) {
1022
+ return [];
1023
+ }
1024
+ return blocksOfTrack(bytes, { dataOffset: header.dataOffset, size: header.size }, trackNumber, secondsPerTick).map(
1025
+ (block) => ({
1026
+ startSeconds: block.startSeconds,
1027
+ endSeconds: block.durationSeconds === null ? null : block.startSeconds + block.durationSeconds,
1028
+ payload: block.payload
1029
+ })
1030
+ );
1031
+ }