@torrent-tv/proxy 2.89.7 → 2.89.9

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 (498) hide show
  1. package/.claude/commands/opsx/apply.md +155 -155
  2. package/.claude/commands/opsx/archive.md +160 -160
  3. package/.claude/commands/opsx/explore.md +174 -174
  4. package/.claude/commands/opsx/propose.md +109 -109
  5. package/.claude/commands/opsx/sync.md +143 -143
  6. package/.claude/skills/openspec-apply-change/SKILL.md +159 -159
  7. package/.claude/skills/openspec-archive-change/SKILL.md +117 -117
  8. package/.claude/skills/openspec-explore/SKILL.md +289 -289
  9. package/.claude/skills/openspec-propose/SKILL.md +113 -113
  10. package/.claude/skills/openspec-sync-specs/SKILL.md +147 -147
  11. package/.dockerignore +5 -5
  12. package/AGENTS.md +363 -338
  13. package/CHANGELOG.md +2345 -2335
  14. package/Dockerfile +30 -30
  15. package/LICENSE +16 -16
  16. package/README.md +369 -369
  17. package/assets/calibration/NOTICE.md +100 -100
  18. package/assets/calibration/audio/NOTICE.md +19 -19
  19. package/assets/calibration/audio/manifest.json +98 -98
  20. package/assets/diagnostics/sctpstate.gdb +31 -31
  21. package/bin/cli.js +684 -684
  22. package/bin/thread-pool.js +30 -30
  23. package/biome.json +412 -412
  24. package/docs/browser-proxy-contract.md +155 -155
  25. package/docs/container-architecture.md +273 -273
  26. package/docs/download-architecture.md +261 -261
  27. package/docs/encode-architecture.md +765 -765
  28. package/docs/encode-run-state.md +96 -96
  29. package/docs/logs.md +97 -97
  30. package/docs/playback-start-forecast.md +113 -113
  31. package/docs/socks5-egress-research.md +114 -114
  32. package/docs/storage-architecture.md +273 -273
  33. package/knip.json +14 -14
  34. package/openspec/changes/adaptive-bitrate/design.md +92 -92
  35. package/openspec/changes/adaptive-bitrate/proposal.md +56 -56
  36. package/openspec/changes/adaptive-bitrate/specs/adaptive-bitrate/spec.md +51 -51
  37. package/openspec/changes/adaptive-bitrate/tasks.md +40 -40
  38. package/openspec/changes/binary-distribution/.openspec.yaml +2 -2
  39. package/openspec/changes/binary-distribution/proposal.md +53 -53
  40. package/openspec/changes/chunked-request-bodies/design.md +81 -81
  41. package/openspec/changes/chunked-request-bodies/proposal.md +53 -53
  42. package/openspec/changes/chunked-request-bodies/specs/chunked-request-bodies/spec.md +30 -30
  43. package/openspec/changes/chunked-request-bodies/tasks.md +40 -40
  44. package/openspec/changes/cold-start/design.md +98 -98
  45. package/openspec/changes/cold-start/proposal.md +62 -62
  46. package/openspec/changes/cold-start/specs/cold-start/spec.md +47 -47
  47. package/openspec/changes/cold-start/tasks.md +48 -48
  48. package/openspec/changes/disk-cap/.openspec.yaml +2 -2
  49. package/openspec/changes/disk-cap/proposal.md +37 -37
  50. package/openspec/changes/disk-cap/specs/disk-cap/spec.md +25 -25
  51. package/openspec/changes/disk-cap/tasks.md +19 -19
  52. package/openspec/changes/proxy-observability/.openspec.yaml +2 -2
  53. package/openspec/changes/proxy-observability/design.md +38 -38
  54. package/openspec/changes/proxy-observability/proposal.md +49 -49
  55. package/openspec/changes/proxy-observability/specs/observability/spec.md +33 -33
  56. package/openspec/changes/proxy-observability/tasks.md +21 -21
  57. package/openspec/changes/seek-debounce/design.md +118 -118
  58. package/openspec/changes/seek-debounce/proposal.md +59 -59
  59. package/openspec/changes/seek-debounce/specs/seek-debounce/spec.md +41 -41
  60. package/openspec/changes/seek-debounce/tasks.md +33 -33
  61. package/openspec/changes/subtitle-language/.openspec.yaml +2 -2
  62. package/openspec/changes/subtitle-language/proposal.md +50 -50
  63. package/openspec/changes/subtitle-language/specs/subtitle-language/spec.md +34 -34
  64. package/openspec/changes/subtitle-language/tasks.md +26 -26
  65. package/openspec/changes/track-selection/.openspec.yaml +2 -2
  66. package/openspec/changes/track-selection/design.md +47 -47
  67. package/openspec/changes/track-selection/proposal.md +45 -45
  68. package/openspec/changes/track-selection/specs/track-selection/spec.md +41 -41
  69. package/openspec/changes/track-selection/tasks.md +20 -20
  70. package/openspec/changes/transcode-quality/.openspec.yaml +2 -2
  71. package/openspec/changes/transcode-quality/proposal.md +51 -51
  72. package/openspec/changes/transcode-quality/specs/transcode-quality/spec.md +139 -139
  73. package/openspec/changes/transcode-quality/tasks.md +63 -63
  74. package/openspec/config.yaml +38 -38
  75. package/package.json +51 -50
  76. package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
  77. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  78. package/research/double-spawn-2026-09-10.md +171 -171
  79. package/research/handover-2026-09-13.md +209 -209
  80. package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
  81. package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
  82. package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
  83. package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
  84. package/routes/api/client-logs/post.js +86 -86
  85. package/routes/api/delivery-sink/get.js +72 -72
  86. package/routes/api/link-probe/get.js +51 -51
  87. package/routes/api/playback-plan/audio-tracks/post.js +29 -29
  88. package/routes/api/playback-plan/post.js +53 -53
  89. package/routes/api/sources/files/get.js +106 -106
  90. package/routes/api/sources/post.js +36 -36
  91. package/routes/api/sources/stats/get.js +132 -132
  92. package/routes/api/sources/warm/post.js +217 -217
  93. package/routes/api/subtitles/get.js +230 -230
  94. package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
  95. package/routes/api/transcode-sessions/net-report/post.js +138 -138
  96. package/routes/api/transcode-sessions/post.js +178 -178
  97. package/routes/api/transcode-sessions/progress/get.js +27 -27
  98. package/routes/api/transcode-sessions/release/post.js +41 -41
  99. package/routes/api/transcode-sessions/seek/post.js +63 -63
  100. package/routes/health/get.js +13 -13
  101. package/routes/healthz/get.js +13 -13
  102. package/routes/stream/get.js +416 -416
  103. package/routes/transcode/audio-file/get.js +64 -64
  104. package/routes/transcode/audio-warm/get.js +95 -95
  105. package/routes/transcode/session-file/get.js +52 -52
  106. package/routes/transcode/variant-file/get.js +95 -95
  107. package/routes/transcode/variant-warm/get.js +84 -84
  108. package/scripts/build-audio-samples.mjs +31 -31
  109. package/scripts/render-run-graph.js +173 -173
  110. package/server.js +748 -748
  111. package/services/encode/CoverageMap.js +428 -428
  112. package/services/encode/CushionReport.js +345 -345
  113. package/services/encode/EncodeAdmission.js +376 -376
  114. package/services/encode/EncodeOrchestrator.js +1192 -1192
  115. package/services/encode/EncodePlan.js +1368 -1368
  116. package/services/encode/EncodeRun.js +36 -12
  117. package/services/encode/Encoder.js +142 -142
  118. package/services/encode/EncoderSelection.js +38 -38
  119. package/services/encode/LocalObservations.js +359 -359
  120. package/services/encode/NvencEncoder.js +50 -50
  121. package/services/encode/OutputOpening.js +784 -784
  122. package/services/encode/OutputTimes.js +579 -579
  123. package/services/encode/QsvEncoder.js +58 -58
  124. package/services/encode/Renditions.js +2283 -2283
  125. package/services/encode/RunClock.js +87 -87
  126. package/services/encode/RunProgress.js +79 -79
  127. package/services/encode/SegmentDemand.js +95 -95
  128. package/services/encode/SoftwareEncoder.js +121 -121
  129. package/services/encode/V4l2m2mEncoder.js +53 -53
  130. package/services/encode/VaapiEncoder.js +66 -66
  131. package/services/encode/args.js +418 -418
  132. package/services/encode/audio-calibration.js +67 -67
  133. package/services/encode/audio-work-rate.js +15 -15
  134. package/services/encode/available-share.js +89 -89
  135. package/services/encode/calibration.js +361 -361
  136. package/services/encode/contention.js +128 -128
  137. package/services/encode/decode-cost-fit.js +363 -363
  138. package/services/encode/encode-exit.js +116 -116
  139. package/services/encode/encode-run-state.js +551 -551
  140. package/services/encode/encoder-readings.js +43 -43
  141. package/services/encode/fingerprint.js +322 -322
  142. package/services/encode/host-load.js +174 -174
  143. package/services/encode/hwaccel.js +1894 -1894
  144. package/services/encode/index.js +9 -9
  145. package/services/encode/learned-median.js +90 -90
  146. package/services/encode/output/EncodedOutput.js +57 -57
  147. package/services/encode/output/Output.js +131 -131
  148. package/services/encode/output/OutputCatalog.js +414 -414
  149. package/services/encode/output/OutputSpec.js +390 -390
  150. package/services/encode/output/Timeline.js +308 -308
  151. package/services/encode/output/cut-grid.js +107 -107
  152. package/services/encode/output/index.js +24 -24
  153. package/services/encode/output/ladder.js +32 -32
  154. package/services/encode/output/playlists.js +284 -284
  155. package/services/encode/output/rates.js +125 -125
  156. package/services/encode/output-key-format.js +21 -21
  157. package/services/encode/quality/EncodeCost.js +1043 -1043
  158. package/services/encode/quality/HostLoad.js +525 -525
  159. package/services/encode/quality/HostTimings.js +249 -249
  160. package/services/encode/quality/OutputQualityState.js +24 -24
  161. package/services/encode/quality/QualityController.js +758 -758
  162. package/services/encode/quality/QualityOffer.js +416 -416
  163. package/services/encode/quality/drain-threat.js +47 -47
  164. package/services/encode/quality/link-budget.js +337 -337
  165. package/services/encode/quality/output-format.js +319 -319
  166. package/services/encode/quality/serving-output.js +216 -216
  167. package/services/encode/quality/visible-rung.js +57 -57
  168. package/services/encode/run-budget.js +97 -97
  169. package/services/encode/run-command.js +757 -757
  170. package/services/encode/run-costs.js +155 -155
  171. package/services/encode/run-inputs.js +53 -53
  172. package/services/encode/segment-formats/fmp4.js +476 -476
  173. package/services/encode/segment-formats/init-compat.js +324 -324
  174. package/services/encode/segment-formats/mpegts.js +134 -134
  175. package/services/encode/start-stop-cost.js +178 -178
  176. package/services/encode/throughput.js +97 -97
  177. package/services/encode/torrent-cost.js +88 -88
  178. package/services/identity/installation-id.js +38 -38
  179. package/services/media/ContainerOrchestrator.js +202 -202
  180. package/services/media/KeyframeTables.js +356 -356
  181. package/services/media/SourceFile.js +298 -298
  182. package/services/media/SubtitleCues.js +592 -592
  183. package/services/media/SubtitleOrchestrator.js +167 -167
  184. package/services/media/audio-inventory.js +299 -299
  185. package/services/media/container/AviContainer.js +268 -268
  186. package/services/media/container/Container.js +632 -632
  187. package/services/media/container/ContainerFactory.js +38 -38
  188. package/services/media/container/KeyframeTable.js +272 -272
  189. package/services/media/container/MatroskaContainer.js +1031 -1031
  190. package/services/media/container/Mp4Container.js +1354 -1354
  191. package/services/media/container/SubtitleFileContainer.js +339 -339
  192. package/services/media/container/ebml-reader.js +159 -159
  193. package/services/media/container/ebml-stream.js +174 -174
  194. package/services/media/container/matroska-clusters.js +1165 -1165
  195. package/services/media/container/unavailable.js +77 -77
  196. package/services/media/ffmpeg-banner.js +260 -260
  197. package/services/media/keyframe-probe.js +157 -157
  198. package/services/media/media-info-probe.js +93 -93
  199. package/services/media/playback-planner.js +931 -931
  200. package/services/media/tracks/AudioTrack.js +143 -143
  201. package/services/media/tracks/ContainerTrack.js +84 -84
  202. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  203. package/services/media/tracks/SubtitleTrack.js +38 -38
  204. package/services/media/tracks/TextSubtitleTrack.js +295 -295
  205. package/services/media/tracks/VideoTrack.js +33 -33
  206. package/services/media/tracks/audio-bound.js +233 -233
  207. package/services/media/tracks/index.js +15 -15
  208. package/services/media/tracks/language-detect.js +174 -174
  209. package/services/server/OutputLifecycle.js +418 -418
  210. package/services/server/SegmentServing.js +1152 -1152
  211. package/services/server/ViewerRequests.js +785 -785
  212. package/services/server/WaitLedger.js +142 -142
  213. package/services/server/controllers/PlaybackController.js +40 -40
  214. package/services/server/controllers/SubtitleController.js +109 -109
  215. package/services/server/http-responses.js +60 -60
  216. package/services/server/transcode-session-files.js +325 -325
  217. package/services/server/wire-outputs.js +1029 -1029
  218. package/services/storage/Diagnostics.js +202 -202
  219. package/services/storage/MachineBudget.js +235 -235
  220. package/services/storage/allowance.js +107 -107
  221. package/services/storage/core-dumps.js +106 -106
  222. package/services/storage/files/CompletedFiles.js +391 -391
  223. package/services/storage/files/piece-from-whole-file.js +118 -118
  224. package/services/storage/free.js +71 -71
  225. package/services/storage/keep.js +48 -48
  226. package/services/storage/machine-memory.js +56 -56
  227. package/services/storage/memory-report.js +575 -575
  228. package/services/storage/piece-store/piece-disk-store.js +539 -539
  229. package/services/storage/piece-store/piece-lru.js +495 -495
  230. package/services/storage/piece-store/shared-piece-store.js +1937 -1937
  231. package/services/storage/returns.js +103 -103
  232. package/services/storage/segment-store/SegmentStore.js +1294 -1294
  233. package/services/storage/wire.js +175 -175
  234. package/services/torrent/Contents.js +382 -382
  235. package/services/torrent/demand/DemandRegister.js +202 -202
  236. package/services/torrent/demand/Urgency.js +137 -137
  237. package/services/torrent/demand/Window.js +118 -118
  238. package/services/torrent/demand/index.js +8 -8
  239. package/services/torrent/demand/pieces.js +140 -140
  240. package/services/torrent/download/SwarmSelection.js +386 -386
  241. package/services/torrent/download/registry.js +102 -102
  242. package/services/torrent/download/withdraw-claim.js +80 -80
  243. package/services/torrent/episode-naming.js +182 -182
  244. package/services/torrent/files.js +455 -455
  245. package/services/torrent/naming.js +619 -619
  246. package/services/torrent/piece-store-of.js +29 -29
  247. package/services/torrent/supply-margin.js +264 -264
  248. package/services/torrent/torrent-pool.js +2688 -2688
  249. package/services/torrent/worker/background-fill.js +213 -213
  250. package/services/torrent/worker/channel.js +271 -271
  251. package/services/torrent/worker/client.js +836 -836
  252. package/services/torrent/worker/fastest-wires.js +342 -342
  253. package/services/torrent/worker/handle-state.js +23 -23
  254. package/services/torrent/worker/held-bytes.js +231 -231
  255. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  256. package/services/torrent/worker/piece-reader.js +1078 -1078
  257. package/services/torrent/worker/pool-adapter.js +371 -371
  258. package/services/torrent/worker/protocol.js +184 -184
  259. package/services/torrent/worker/resume-warm.js +107 -107
  260. package/services/torrent/worker/webrtc-shim.js +219 -219
  261. package/services/torrent/worker/worker.js +1137 -1137
  262. package/services/transport/data-channel-handler.js +1406 -1373
  263. package/services/transport/delivery-probe.js +798 -842
  264. package/services/transport/health-collector.js +53 -53
  265. package/services/transport/nat-classifier.js +231 -231
  266. package/services/transport/packet-witness.js +808 -808
  267. package/services/transport/port-mapper.js +235 -235
  268. package/services/transport/registry-api.js +81 -81
  269. package/services/transport/tunnel-client.js +447 -447
  270. package/services/transport/usrsctp-state.js +175 -175
  271. package/services/transport/webrtc-manager.js +484 -484
  272. package/services/viewer/Assignments.js +340 -340
  273. package/services/viewer/PriorityMap.js +421 -421
  274. package/services/viewer/PriorityOrchestrator.js +325 -325
  275. package/services/viewer/Viewer.js +691 -691
  276. package/services/viewer/Viewers.js +368 -368
  277. package/services/viewer/active-output.js +37 -37
  278. package/services/viewer/audio-start.js +46 -46
  279. package/services/viewer/buffer-trend.js +81 -81
  280. package/services/viewer/choices.js +647 -647
  281. package/services/viewer/media-time.js +355 -355
  282. package/services/viewer/playback-readiness.js +635 -635
  283. package/services/viewer/positions.js +126 -126
  284. package/services/viewer/report-intake.js +46 -46
  285. package/store/source-registry.js +71 -71
  286. package/test/asset-paths.test.js +28 -28
  287. package/test/audio-buffer-continuity.test.js +77 -77
  288. package/test/audio-calibration.test.js +23 -23
  289. package/test/audio-inventory.test.js +212 -212
  290. package/test/audio-track-bitrate.test.js +40 -40
  291. package/test/auto-quality-step.test.js +762 -762
  292. package/test/available-share.test.js +76 -76
  293. package/test/background-fill.test.js +190 -190
  294. package/test/client-log-file.test.js +110 -110
  295. package/test/coalesce.test.js +39 -39
  296. package/test/completed-files.test.js +115 -115
  297. package/test/concurrent-cost.test.js +148 -148
  298. package/test/container-media-info.test.js +228 -228
  299. package/test/contention.test.js +76 -76
  300. package/test/core-dumps.test.js +57 -57
  301. package/test/coverage-follows-the-disk.test.js +233 -228
  302. package/test/coverage-map.test.js +195 -195
  303. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  304. package/test/cut-times-timeline.test.js +65 -65
  305. package/test/cuts-follow-published-grid.test.js +109 -109
  306. package/test/data-channel-frame.test.js +63 -63
  307. package/test/data-channel-viewer-lifecycle.test.js +162 -92
  308. package/test/dead-torrent-handle.test.js +52 -52
  309. package/test/declared-rates.test.js +116 -116
  310. package/test/declared-tracks.test.js +43 -43
  311. package/test/decode-cost-fit.test.js +202 -202
  312. package/test/decode-cost.test.js +475 -475
  313. package/test/delivery-probe-field.test.js +173 -0
  314. package/test/delivery-probe.test.js +382 -393
  315. package/test/demand-register.test.js +206 -206
  316. package/test/dht-bootstrap.test.js +72 -72
  317. package/test/drain-threat.test.js +65 -65
  318. package/test/duplicate-add.test.js +48 -48
  319. package/test/encode-admission.test.js +146 -146
  320. package/test/encode-cost.test.js +275 -275
  321. package/test/encode-exit.test.js +111 -111
  322. package/test/encode-orchestrator.test.js +426 -426
  323. package/test/encode-plan-viewers.test.js +725 -725
  324. package/test/encode-plan.test.js +545 -545
  325. package/test/encode-run-state.test.js +314 -314
  326. package/test/encode-run.test.js +20 -0
  327. package/test/encode-slope.test.js +46 -46
  328. package/test/encoded-output.test.js +39 -39
  329. package/test/encoder-kinds.test.js +122 -122
  330. package/test/encoder-readings.test.js +68 -68
  331. package/test/episode-naming.test.js +131 -131
  332. package/test/every-claimant-is-told-its-share.test.js +152 -152
  333. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  334. package/test/failed-start-breaker.test.js +202 -202
  335. package/test/fastest-wires.test.js +143 -143
  336. package/test/ffmpeg-stream-counts.test.js +78 -78
  337. package/test/file-edges.test.js +191 -191
  338. package/test/fixtures/audio-frame-boundary.json +1 -1
  339. package/test/fmp4-self-contained.test.js +80 -80
  340. package/test/fmp4-timestamps.test.js +140 -140
  341. package/test/fmp4-track-completeness.test.js +41 -41
  342. package/test/format-keyed-outputs.test.js +78 -78
  343. package/test/health-metrics.test.js +36 -38
  344. package/test/held-read-ownership.test.js +77 -77
  345. package/test/held-request-width.test.js +157 -157
  346. package/test/helpers/encode-run.js +248 -240
  347. package/test/helpers/held-file.js +77 -77
  348. package/test/helpers/manager.js +62 -62
  349. package/test/helpers/matroska-file.js +296 -296
  350. package/test/helpers/output-spec.js +63 -63
  351. package/test/host-load.test.js +68 -68
  352. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  353. package/test/init-compat.test.js +219 -219
  354. package/test/input-lost-quiets-the-plan.test.js +261 -261
  355. package/test/input-unavailable.test.js +48 -48
  356. package/test/installation-id.test.js +39 -39
  357. package/test/keeping-period.test.js +83 -83
  358. package/test/keyframe-index-accuracy.test.js +188 -188
  359. package/test/keyframe-table-budget.test.js +123 -123
  360. package/test/keyframes-belong-to-the-file.test.js +249 -249
  361. package/test/learned-median.test.js +37 -37
  362. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  363. package/test/limit-row-by-area.test.js +60 -60
  364. package/test/link-budget.test.js +111 -111
  365. package/test/link-probe.test.js +56 -56
  366. package/test/local-encoding-data.test.js +273 -273
  367. package/test/logger-repeats.test.js +134 -134
  368. package/test/look-ahead-coverage.test.js +56 -56
  369. package/test/manager-surface.test.js +291 -291
  370. package/test/matroska-cluster-discovery.test.js +323 -323
  371. package/test/matroska-cues-track.test.js +192 -192
  372. package/test/media-time.test.js +62 -62
  373. package/test/memory-budget.test.js +390 -390
  374. package/test/move-cost.test.js +216 -216
  375. package/test/mp4-subtitles.test.js +173 -173
  376. package/test/one-authority.test.js +285 -285
  377. package/test/one-budget.test.js +149 -149
  378. package/test/one-output-one-session.test.js +273 -273
  379. package/test/one-resource-divided.test.js +185 -185
  380. package/test/one-serving-output-per-height.test.js +458 -458
  381. package/test/orchestrator-wired.test.js +207 -207
  382. package/test/output-catalog.test.js +39 -39
  383. package/test/output-shape.test.js +21 -21
  384. package/test/output-spec.test.js +251 -251
  385. package/test/output-speed.test.js +92 -87
  386. package/test/outputs-being-prepared.test.js +40 -40
  387. package/test/packet-witness-ring.test.js +236 -236
  388. package/test/packet-witness.test.js +148 -148
  389. package/test/piece-disk-store.test.js +401 -401
  390. package/test/piece-from-whole-file.test.js +129 -129
  391. package/test/piece-lru.test.js +319 -319
  392. package/test/piece-reader.test.js +162 -162
  393. package/test/piece-selection-offset.test.js +85 -85
  394. package/test/piece-store-eviction.test.js +595 -595
  395. package/test/piece-store-never-refuses.test.js +153 -153
  396. package/test/piece-store-reservations.test.js +403 -403
  397. package/test/piece-store-slow-disk.test.js +159 -159
  398. package/test/piece-tail.test.js +97 -97
  399. package/test/plan-host-timings.test.js +68 -68
  400. package/test/plan-is-steady.test.js +225 -225
  401. package/test/playback-readiness.test.js +518 -518
  402. package/test/playback-start-regressions.test.js +101 -101
  403. package/test/priority-map-download.test.js +174 -174
  404. package/test/priority-map-emptied.test.js +204 -204
  405. package/test/priority-map-per-output.test.js +215 -215
  406. package/test/priority-map.test.js +163 -163
  407. package/test/probe-wedge-certainty.test.js +60 -60
  408. package/test/produced-copy-choice.test.js +213 -213
  409. package/test/published-timeline.test.js +83 -83
  410. package/test/quality-offer.test.js +160 -160
  411. package/test/quality-variants.test.js +1274 -1270
  412. package/test/rate-control-in-the-output.test.js +181 -180
  413. package/test/read-survives-withdrawal.test.js +164 -164
  414. package/test/read-window.test.js +365 -365
  415. package/test/reads-not-yet-arrived.test.js +218 -218
  416. package/test/resume-warm.test.js +39 -39
  417. package/test/run-graph-drift.test.js +37 -37
  418. package/test/run-inputs.test.js +80 -80
  419. package/test/run-intervals.test.js +100 -100
  420. package/test/run-position-follows-published-grid.test.js +89 -89
  421. package/test/run-progress.test.js +64 -64
  422. package/test/same-height-switch.test.js +663 -663
  423. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  424. package/test/seek-landing.test.js +109 -109
  425. package/test/seek-target-not-superseded.test.js +195 -195
  426. package/test/segment-closed-on-both-branches.test.js +114 -114
  427. package/test/segment-cut-times.test.js +63 -63
  428. package/test/segment-demand.test.js +80 -80
  429. package/test/segment-hold-supersede.test.js +91 -91
  430. package/test/segment-judged-by-its-own-header.test.js +222 -222
  431. package/test/segment-serve-wiring.test.js +481 -481
  432. package/test/segment-store-eviction.test.js +247 -247
  433. package/test/segment-store.test.js +352 -352
  434. package/test/segment-true-start.test.js +86 -86
  435. package/test/segments-are-shared.test.js +176 -176
  436. package/test/send-chunk-bytes.test.js +86 -86
  437. package/test/serving-existing-output.test.js +111 -111
  438. package/test/serving-output.test.js +102 -102
  439. package/test/shared-piece-store.test.js +310 -310
  440. package/test/sidecar-naming.test.js +142 -142
  441. package/test/soundtrack-rate-bound.test.js +289 -289
  442. package/test/source-file.test.js +133 -133
  443. package/test/source-files-route.test.js +113 -113
  444. package/test/source-registry.test.js +18 -18
  445. package/test/split-a-stretch.test.js +139 -139
  446. package/test/stale-request-after-seek.test.js +158 -158
  447. package/test/startup-readings.test.js +124 -124
  448. package/test/stream-route.test.js +237 -237
  449. package/test/subtitle-cue-framing.test.js +200 -200
  450. package/test/subtitle-cue-source.test.js +102 -102
  451. package/test/subtitle-cue-walk.test.js +385 -385
  452. package/test/subtitle-cursor.test.js +63 -63
  453. package/test/subtitle-defaults.test.js +118 -118
  454. package/test/subtitle-language.test.js +252 -252
  455. package/test/subtitle-metadata.test.js +15 -15
  456. package/test/subtitle-plan-waits.test.js +125 -125
  457. package/test/subtitle-track-numbering.test.js +391 -391
  458. package/test/supply-margin.test.js +190 -190
  459. package/test/swarm-follows-readers.test.js +174 -174
  460. package/test/swarm-reach.test.js +130 -130
  461. package/test/swarm-selection.test.js +220 -220
  462. package/test/tail-duplication.test.js +167 -167
  463. package/test/the-channel-has-both-ends.test.js +91 -91
  464. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  465. package/test/thread-pool.test.js +53 -53
  466. package/test/timeline.test.js +84 -84
  467. package/test/torrent-contents.test.js +235 -235
  468. package/test/torrent-cost.test.js +71 -71
  469. package/test/torrent-files.test.js +221 -221
  470. package/test/torrent-naming.test.js +255 -255
  471. package/test/tracks-begin-together.test.js +209 -209
  472. package/test/tunnel-renewal.test.js +167 -167
  473. package/test/two-viewers-one-picture.test.js +508 -508
  474. package/test/upload-hurry.test.js +186 -186
  475. package/test/usrsctp-state.test.js +131 -131
  476. package/test/video-facts.test.js +102 -102
  477. package/test/viewer-assignments.test.js +143 -143
  478. package/test/viewer-outputs.test.js +285 -285
  479. package/test/viewer-presence.test.js +116 -116
  480. package/test/viewer-requests-admission.test.js +92 -92
  481. package/test/viewer-starts-on-map.test.js +27 -27
  482. package/test/viewer-states.test.js +192 -189
  483. package/test/viewer-subtitle-subscription.test.js +96 -96
  484. package/test/viewer.test.js +139 -139
  485. package/test/viewing-generations.test.js +390 -390
  486. package/test/visible-rung.test.js +37 -37
  487. package/test/wait-ledger.test.js +100 -100
  488. package/test/webrtc-shim.test.js +149 -149
  489. package/test/wedge-certainty.test.js +131 -131
  490. package/test/whole-file-held-read.test.js +30 -30
  491. package/test/withdraw-piece-claim.test.js +212 -212
  492. package/test/worker-channel.test.js +158 -158
  493. package/utils/client-log-file.js +151 -151
  494. package/utils/coalesce.js +41 -41
  495. package/utils/logger.js +312 -312
  496. package/utils/parse-range.js +25 -25
  497. package/utils/perf.js +59 -59
  498. package/utils/torrent-source-key.js +38 -38
@@ -1,632 +1,632 @@
1
- /**
2
- * @file Base Container — abstract per RFC 9559 / ISO 14496-12.
3
- *
4
- * A Container knows how to read its own format's track table and index.
5
- * Concrete containers (MatroskaContainer, Mp4Container, AviContainer) implement
6
- * spec-specific parsing. All byte access goes through `readRange(start,end)` so
7
- * the class works over torrent piece windows.
8
- *
9
- * Spec refs:
10
- * - Matroska RFC 9559 §5: EBML, Segment, SeekHead, Tracks, Cues, Clusters
11
- * - MP4 ISO/IEC 14496-12 §8: ftyp, moov, trak, tkhd, mdhd, hdlr, elng, stbl
12
- * - AVI RIFF §: LIST hdrl, idx1
13
- */
14
-
15
- import { strictReader } from "./unavailable.js";
16
-
17
- /**
18
- * What one file declares about itself. Every field is either a value the
19
- * container states or `null`, which means the container does not state it —
20
- * a defined absence, not "nobody has looked yet".
21
- *
22
- * @typedef {object} ContainerMediaInfo
23
- * @property {string} format - "matroska" | "mp4" | "avi" | "unknown".
24
- * @property {number | null} durationSeconds
25
- * @property {number | null} startTimeSeconds - Where this file's own timeline
26
- * begins. Two files of one release need not agree on it, and the difference
27
- * is what keeps a soundtrack shipped separately aligned with its picture.
28
- */
29
-
30
- export class Container {
31
- /**
32
- * One reader, the one that fetches what is missing, and one container per
33
- * file — the one `ContainerOrchestrator` keeps.
34
- *
35
- * `readRange` is made strict here: it answers with every byte asked for or
36
- * throws `BytesUnavailable`, so no reading in any subclass can mistake a read
37
- * that has not arrived for an element that is not there. What a subclass keeps
38
- * it keeps only after a reading succeeded (see `unavailable.js`).
39
- *
40
- * The cue walk reads only what is already downloaded and asks the swarm for
41
- * nothing. That reader is NOT given here: it is handed to
42
- * {@link Container#readHeldCues} on every pass, because what is downloaded
43
- * changes between passes and the container is kept for the life of the file.
44
- * It used to be given here, which is why the walk had to build a second
45
- * container over the same file and read its head and Cues a second time.
46
- *
47
- * `portionBytes` is the largest read a reading makes, stated by whoever knows
48
- * the medium — a torrent's piece length. Absent, an element is read in one go.
49
- *
50
- * @param {object} params
51
- * @param {(start:number,end:number)=>Promise<Buffer|null>} [params.readRange]
52
- * @param {number} [params.fileSize]
53
- * @param {string} [params.label]
54
- * @param {number} [params.portionBytes]
55
- */
56
- constructor({ readRange, fileSize, label = "", portionBytes } = {}) {
57
- this.fileSize = fileSize;
58
- this.readRange = typeof readRange === "function" ? strictReader(readRange, fileSize) : readRange;
59
- this.label = label;
60
- this.portionBytes = Number.isFinite(portionBytes) && portionBytes > 0 ? portionBytes : Number.POSITIVE_INFINITY;
61
- }
62
-
63
-
64
- /**
65
- * Whether one of ffmpeg's banner streams and one of this container's tracks
66
- * can be the same track.
67
- *
68
- * @param {{ language?: string, title?: string }} banner
69
- * @param {{ language?: string, name?: string }} container
70
- * @returns {boolean}
71
- */
72
- static pairingHolds(banner, container) {
73
- return pairingHolds(banner, container);
74
- }
75
-
76
- /**
77
- * ffmpeg's description of a file's subtitle streams, corrected by what the
78
- * container itself declares.
79
- *
80
- * The banner cannot express the difference between "no track is marked" and
81
- * "every track is marked", because Matroska's `FlagDefault` defaults to 1 and
82
- * ffmpeg has already applied that default by the time it prints. The
83
- * container can be asked, and this is where the two readings are lined up —
84
- * by position, checked pair by pair rather than assumed.
85
- *
86
- * @param {object[]} bannerTracks
87
- * @param {object[]} declared - This container's own subtitle tracks, in its order.
88
- * @returns {object[]}
89
- */
90
- /**
91
- * The picture's facts, from the two readings that state them.
92
- *
93
- * Audio and subtitles have had this since the flags were first read from the
94
- * file; video never did. Every figure the encode is planned from — the size,
95
- * the frame rate, whether it is HDR, how many bits a sample carries — was
96
- * taken from ffmpeg's `-i` banner alone, and the `VideoTrack` the container
97
- * declares was read and then used for nothing but a line in the log.
98
- *
99
- * Which reading wins is decided per field by what each one IS, and the rule
100
- * is the one `readMediaInfo` already states: a fact the container DECLARES is
101
- * read from the container; a fact only the media has is measured from the
102
- * media.
103
- *
104
- * - the coded size and the frame rate are the BANNER's. Both are declared by
105
- * the container as well, but what the encoder receives is what the decoder
106
- * produced, and the ladder and the scale filter have to be sized to that. A
107
- * container that declares something else is mis-declaring, and using its
108
- * numbers would size the encode to a picture that never arrives;
109
- * - the bit depth and the HDR signalling are the CONTAINER's where it states
110
- * them. They are not properties of the decoded frames at all — they are the
111
- * file saying how its samples are to be read — and ffmpeg prints them only
112
- * as a side effect of naming a pixel format. HDR is not compared for
113
- * disagreement: both sides give a boolean, and a boolean cannot say "I did
114
- * not look";
115
- * - the display size is the container's alone; the banner has no such field.
116
- *
117
- * Where only one side states a field, that side answers whatever the rule
118
- * would have preferred. Where both state it and they DISAGREE, the
119
- * disagreement is reported: it is a fact about the file, and until now
120
- * nothing could see it.
121
- *
122
- * @param {{ width?: number|null, height?: number|null, fps?: number|null, isHdr?: boolean, bitDepth?: number|null }} banner
123
- * @param {object | null} declared - The container's own `VideoTrack`.
124
- * @returns {{ width: number|null, height: number|null, fps: number|null, isHdr: boolean, bitDepth: number|null, displayWidth: number|null, displayHeight: number|null, disagreements: string[] }}
125
- */
126
- static mergeVideoFacts(banner, declared) {
127
- const number = (value) => (Number.isFinite(value) && value > 0 ? Number(value) : null);
128
- const fromBanner = {
129
- width: number(banner?.width),
130
- height: number(banner?.height),
131
- fps: number(banner?.fps),
132
- isHdr: banner?.isHdr === true,
133
- bitDepth: number(banner?.bitDepth)
134
- };
135
- if (!declared) {
136
- return { ...fromBanner, displayWidth: null, displayHeight: null, disagreements: [] };
137
- }
138
- const fromContainer = {
139
- width: number(declared.width),
140
- height: number(declared.height),
141
- fps: number(declared.fps),
142
- isHdr: declared.isHdr === true,
143
- bitDepth: number(declared.bitDepth)
144
- };
145
- const disagreements = [];
146
- const note = (field, mine, theirs) => {
147
- if (mine !== null && theirs !== null && mine !== theirs) {
148
- disagreements.push(`${field} ${theirs} in the container against ${mine} in the probe`);
149
- }
150
- };
151
- note("width", fromBanner.width, fromContainer.width);
152
- note("height", fromBanner.height, fromContainer.height);
153
- if (fromBanner.bitDepth !== null && fromContainer.bitDepth !== null && fromBanner.bitDepth !== fromContainer.bitDepth) {
154
- disagreements.push(
155
- `bit depth ${fromContainer.bitDepth} in the container against ${fromBanner.bitDepth} in the probe`
156
- );
157
- }
158
- // HDR is deliberately NOT compared. Both sides give it as a boolean, and a
159
- // boolean cannot say "I did not look": a container with no Colour element
160
- // and one that states SDR are the same `false`, as are a probe that printed
161
- // no colour metadata and one that printed BT.709. Reporting that as a
162
- // disagreement would report it on almost every file. Either side saying yes
163
- // is taken as yes, which is the safe direction — the cost of tone mapping a
164
- // picture that did not need it is smaller than showing a washed-out one.
165
- return {
166
- width: fromBanner.width ?? fromContainer.width,
167
- height: fromBanner.height ?? fromContainer.height,
168
- fps: fromBanner.fps ?? fromContainer.fps,
169
- // The container declares these; the probe only reflects them.
170
- bitDepth: fromContainer.bitDepth ?? fromBanner.bitDepth,
171
- isHdr: fromContainer.isHdr || fromBanner.isHdr,
172
- displayWidth: number(declared.displayWidth),
173
- displayHeight: number(declared.displayHeight),
174
- disagreements
175
- };
176
- }
177
-
178
- /**
179
- * Line ffmpeg's banner up with what the container declares, and say whether the
180
- * two are describing the same thing in the same order.
181
- *
182
- * ffmpeg numbers a file's streams `0:a:N` / `0:s:N` over every stream of that
183
- * kind, in the order the container declares them; the container reading is a
184
- * list in that same order. So position is the correspondence — but a position
185
- * match that is merely assumed is worth nothing, and it is CHECKED: each pair
186
- * has to agree on language or on title. One pair that agrees on neither, or a
187
- * length that differs, means the two readings are not about the same thing, and
188
- * then the container reading is not used AT ALL. A wrong flag is worse than a
189
- * missing one, because `0:a:N` is what the encoder is given.
190
- *
191
- * One alignment for every media kind, because it is one rule. It was written
192
- * twice — once for subtitles, once for audio — down to a `pairingHolds` that
193
- * was byte-for-byte the same function under two names.
194
- *
195
- * @param {object[]} bannerTracks
196
- * @param {object[]} declared
197
- * @param {string} noun - "subtitle" or "audio"; only for the reason text.
198
- * @returns {{ aligned: boolean, reason: string, banner: object[], container: object[] }}
199
- */
200
- static alignWithBanner(bannerTracks, declared, noun) {
201
- const banner = Array.isArray(bannerTracks) ? bannerTracks : [];
202
- const container = Array.isArray(declared) ? declared : [];
203
- if (banner.length === 0) {
204
- return { aligned: false, reason: `the probe found no ${noun} stream`, banner, container };
205
- }
206
- if (container.length === 0) {
207
- return { aligned: false, reason: `the container declares no ${noun} track`, banner, container };
208
- }
209
- if (container.length !== banner.length) {
210
- return {
211
- aligned: false,
212
- reason: `the container declares ${container.length} ${noun} tracks and the probe found ${banner.length}`,
213
- banner,
214
- container
215
- };
216
- }
217
- for (const [order, track] of banner.entries()) {
218
- if (!Container.pairingHolds(track, container[order])) {
219
- return {
220
- aligned: false,
221
- reason:
222
- `${noun} ${order} is "${normalise(track?.title) || "-"}"/${normalise(track?.language) || "-"} ` +
223
- `in the probe and "${normalise(container[order]?.name) || "-"}"/` +
224
- `${normalise(container[order]?.language) || "-"} in the container`,
225
- banner,
226
- container
227
- };
228
- }
229
- }
230
- return { aligned: true, reason: "", banner, container };
231
- }
232
-
233
- /**
234
- * What the banner says, with the flags only the container knows added — or the
235
- * banner alone where the two could not be lined up.
236
- *
237
- * `take` says which of the container's fields this kind of track wants, and is
238
- * the only part that differs between them.
239
- *
240
- * @param {object[]} bannerTracks
241
- * @param {object[]} declared
242
- * @param {string} noun
243
- * @param {(containerTrack: object, bannerTrack: object) => object} take
244
- * @param {object} absent - The same fields as `take` returns, for a track whose
245
- * container reading could not be used. Not "the container says no" — the
246
- * container has not been heard from.
247
- * @returns {{ tracks: object[], aligned: boolean, reason: string }}
248
- */
249
- static mergeDeclaredFlags(bannerTracks, declared, noun, take, absent) {
250
- const { aligned, reason, banner, container } = Container.alignWithBanner(bannerTracks, declared, noun);
251
- if (!aligned) {
252
- return {
253
- tracks: banner.map((track) => ({ ...track, ...absent })),
254
- aligned,
255
- reason
256
- };
257
- }
258
- return {
259
- tracks: banner.map((track, order) => ({ ...track, ...take(container[order], track) })),
260
- aligned: true,
261
- reason: ""
262
- };
263
- }
264
-
265
- static mergeSubtitleFlags(bannerTracks, declared) {
266
- return Container.mergeDeclaredFlags(
267
- bannerTracks,
268
- declared,
269
- "subtitle",
270
- (track) => ({
271
- // The language the container states, its default included. RFC 9559
272
- // §5.1.4.1.19 gives `Language` the default `eng`, and RFC 8794
273
- // §11.1.19 says an element equal to its default need not be written
274
- // and that a reader MUST then read the default — so a track with no
275
- // Language element is English by the file's own statement. Until
276
- // 2026-10-01 that was treated as "says nothing", and an English track
277
- // was offered as Unknown. Where the language came from travels beside
278
- // it, so a reading of the text that disagrees can be reported.
279
- language: track.languageBcp47 || track.language || "",
280
- declaresLanguage: track.declaresLanguage === true,
281
- languageSource: typeof track.languageSource === "string" ? track.languageSource : "",
282
- isDefault: track.isDefault === true,
283
- declaresDefault: track.declaresDefault === true,
284
- // Read from the file rather than guessed from the track's name. Both
285
- // are stated by the container itself (RFC 9559 §5.1.4.1) and neither
286
- // reaches ffmpeg's `-i` banner, which is where every other field here
287
- // comes from.
288
- isForced: track.isForced === true,
289
- isHearingImpaired: track.isHearingImpaired === true,
290
- // FlagEnabled, so the browser can leave an unusable track out of the
291
- // menu. It stays in the list and keeps its number: ffmpeg creates a
292
- // stream for it either way.
293
- isEnabled: track.isEnabled !== false,
294
- // The RFC 5646 tag where the file writes one, kept BESIDE the code
295
- // rather than replacing it: this list is aligned against ffmpeg's
296
- // banner, which prints the three-letter form.
297
- languageBcp47: typeof track.languageBcp47 === "string" ? track.languageBcp47 : ""
298
- }),
299
- {
300
- declaresDefault: false,
301
- isForced: false,
302
- isHearingImpaired: false,
303
- isEnabled: true,
304
- languageBcp47: ""
305
- }
306
- );
307
- }
308
-
309
- /**
310
- * The same for audio, with the flags RFC 9559 §5.1.4.1 defines for it.
311
- *
312
- * `FlagOriginal`, `FlagCommentary` and `FlagVisualImpaired` do not appear in
313
- * the banner at all, so without this the audio menu cannot tell a director's
314
- * commentary from the film.
315
- *
316
- * @param {object[]} bannerTracks
317
- * @param {object[]} declared
318
- * @returns {{ tracks: object[], aligned: boolean, reason: string }}
319
- */
320
- static mergeAudioFlags(bannerTracks, declared) {
321
- return Container.mergeDeclaredFlags(
322
- bannerTracks,
323
- declared,
324
- "audio",
325
- (track, banner) => ({
326
- isOriginal: track.isOriginal === true,
327
- isCommentary: track.isCommentary === true,
328
- isVisualImpaired: track.isVisualImpaired === true,
329
- isEnabled: track.isEnabled !== false,
330
- isDefault: track.isDefault === true,
331
- declaresDefault: track.declaresDefault === true,
332
- languageBcp47: typeof track.languageBcp47 === "string" ? track.languageBcp47 : "",
333
- channels: Number.isFinite(track.channels) ? track.channels : null,
334
- // The codec's configuration and the most it allows the track to
335
- // carry, both as the container states them (`tracks/audio-bound.js`).
336
- codecParameters: track.codecParameters ?? null,
337
- peakKbps: Number.isFinite(track.peakKbps) && track.peakKbps > 0 ? track.peakKbps : null,
338
- title:
339
- typeof banner?.title === "string" && banner.title.length > 0
340
- ? banner.title
341
- : (typeof track.name === "string" ? track.name : "")
342
- }),
343
- {
344
- declaresDefault: false,
345
- isOriginal: false,
346
- isCommentary: false,
347
- isVisualImpaired: false,
348
- isEnabled: true,
349
- languageBcp47: "",
350
- channels: null,
351
- codecParameters: null,
352
- peakKbps: null
353
- }
354
- );
355
- }
356
-
357
-
358
- /** @returns {string} Human name: "matroska" | "mp4" | "avi" | "unknown" */
359
- get formatName() {
360
- return "unknown";
361
- }
362
-
363
- /** Whether `head` (first bytes) looks like this container. */
364
- static detect(_head) {
365
- return false;
366
- }
367
-
368
- /**
369
- * All tracks declared by the container, in container order.
370
- * Includes disabled tracks (isEnabled=false) to preserve declaredIndex alignment with ffmpeg.
371
- * @returns {Promise<import("../tracks/index.js").ContainerTrack[]>}
372
- */
373
- async readTracks() {
374
- throw new Error("readTracks not implemented");
375
- }
376
-
377
-
378
- /**
379
- * This container's subtitle tracks and where their cues are, in ONE shape
380
- * whichever container answers.
381
- *
382
- * `tracks` carries a `clusterPositions` list for a container that stores cues
383
- * in clusters and a `samples` list for one that states each cue's own byte
384
- * range; a caller reads neither, and asks {@link Container#readHeldCues}
385
- * instead. `declared` is what the container says about its subtitle tracks in
386
- * its own order, and empty means the container said nothing — a real answer,
387
- * not a missing one.
388
- *
389
- * @returns {Promise<{ tracks: object[], declared: object[], secondsPerTick: number, segmentDataOffset: number } | null>}
390
- * Null where this container declares no subtitles at all.
391
- */
392
- async readSubtitlePlan() {
393
- return null;
394
- }
395
-
396
- /**
397
- * The cues this container can read RIGHT NOW for one track, without fetching.
398
- *
399
- * Every container answers this, and each reads what its own specification
400
- * says: Matroska walks the clusters its Cues table names, an MP4 reads the
401
- * samples its table states. The caller therefore chooses a container once —
402
- * from the bytes — and never again. It used to choose twice, once by file
403
- * extension for the container and once by whether a track carried a sample
404
- * list for the reading, and two choices that must agree and are made from
405
- * different evidence are a disagreement waiting to happen.
406
- *
407
- * `progress` is what has already been read, kept by the caller because it
408
- * belongs to the file rather than to one pass. Each container keeps its own
409
- * part of it under its own name; nothing else reads inside.
410
- *
411
- * `held` is how to read what is downloaded NOW, handed in per pass: which
412
- * ranges are whole, a read of one that never fetches (strict: every byte or
413
- * `BytesUnavailable`), the portion a read may span, and where the viewers
414
- * stand, in seconds, so the work nearest them is taken first.
415
- *
416
- * @param {object} _plan - This file's subtitle plan.
417
- * @param {object} _track - The track asked about.
418
- * @param {object} _progress
419
- * @param {HeldReader} _held
420
- * @returns {Promise<{ found: Map<number, object[]>, covered: number, indexed: number, withdrawn: number[] }>}
421
- * `found` is track number to the cues found in THIS pass — Matroska fills
422
- * every track from one walk, so it is a map and not a list. Each cue may
423
- * carry `source`, the position it was read from; `withdrawn` lists sources
424
- * found in an earlier pass that turned out not to be what they were taken
425
- * for, whose cues the caller must take back.
426
- */
427
- async readHeldCues(_plan, _track, _progress, _held) {
428
- return { found: new Map(), covered: 0, indexed: 0, withdrawn: [] };
429
- }
430
-
431
- /**
432
- * Keyframe times for the video track, ascending seconds. Null when index
433
- * absent (MPEG-TS, fragmented MP4, truncated).
434
- *
435
- * **It reads, and does not remember.** It used to keep the answer, and that
436
- * made the table the one fact in this proxy stored in two places: here, and
437
- * in the file's `KeyframeTable` on the main thread. Traced 2026-09-15, this
438
- * copy had no reader: nothing ever asked a container twice for its keyframes.
439
- * The parse itself has since moved to the thread the sessions are on, so
440
- * there is no longer a second thread for a second copy to sit in either.
441
- *
442
- * The remembering lives where the fact is USED, which is also the only place
443
- * that can do the rest of the job: bound how long a viewer waits for it
444
- * while letting the read go on, join a second asker to a read already
445
- * running, and keep the answer reachable by a session created before it
446
- * landed. A container cannot do any of those — it does not know there is a
447
- * viewer — so a copy here was never the whole answer, only a second one.
448
- *
449
- * @returns {Promise<{times:number[],tolerance:number}|null>}
450
- */
451
- async readKeyframeIndex() {
452
- return this.parseKeyframeIndex();
453
- }
454
-
455
- /**
456
- * How THIS format states where its keyframes are. Overridden by every
457
- * container that has such a table; the default is the honest answer for one
458
- * that does not.
459
- *
460
- * @returns {Promise<{times:number[],tolerance:number}|null>}
461
- */
462
- async parseKeyframeIndex() {
463
- return null;
464
- }
465
-
466
- /**
467
- * What this file DECLARES about itself as a whole, as distinct from what its
468
- * individual tracks declare.
469
- *
470
- * The rule this method exists to hold: a fact the container declares is read
471
- * from the container; a fact only the media itself has is measured from the
472
- * media. Both halves used to be asked of ffmpeg, so the same header was read
473
- * twice — measured 2026-09-03, this layer read one `.mka` header in 8 ms while
474
- * a second ffmpeg read the same header over HTTP for 8121 ms, in the same
475
- * second, on the same file.
476
- *
477
- * `null` is not "unknown, ask someone else". It means the container does not
478
- * declare the field, which is a final answer about the container and the point
479
- * at which a caller may go to the media — see `docs/container-architecture.md`.
480
- *
481
- * @returns {Promise<import("./Container.js").ContainerMediaInfo>}
482
- */
483
- async readMediaInfo() {
484
- if (!this.mediaInfo) {
485
- this.mediaInfo = {
486
- format: this.formatName,
487
- durationSeconds: null,
488
- startTimeSeconds: null
489
- };
490
- }
491
- return this.mediaInfo;
492
- }
493
-
494
- /**
495
- * Subtitle-specific: where cues live (Matroska cluster positions or MP4 sample ranges).
496
- * Returned via track objects' clusterPositions/samples, so base has no extra method — tracks carry it.
497
- */
498
-
499
- /**
500
- * The TEXT FIELD of one subtitle cue, taken out of this container's framing.
501
- *
502
- * How a cue's bytes are wrapped is stated by the container's own
503
- * specification, so each subclass answers for itself: Matroska reorders an ASS
504
- * dialogue row, drops its two timing fields and prepends a read order
505
- * (`matroska.org/technical/subtitles.html`); an MP4 prefixes a `tx3g` sample
506
- * with its length (ISO/IEC 14496-12 §12.6); a subtitle FILE states its own
507
- * field order in `[Events]`. None of that is a fact about the subtitle format,
508
- * and the format's own markup — `{\pos(…)}`, `\N` — is not a fact about the
509
- * container. The second half is `TextSubtitleTrack`; this is the
510
- * first, and the two are applied in that order.
511
- *
512
- * Static because de-framing reads no instance state: a caller that has bytes
513
- * and knows the format needs no container built over the whole file. The
514
- * instance form below exists so a caller that DOES hold a container gets the
515
- * right answer without naming the subclass.
516
- *
517
- * @param {Buffer} _payload - The cue's bytes as the container stores them.
518
- * @param {string} _codecId - CodecID / sample entry type / file extension.
519
- * @returns {string} The text field, markup still in place.
520
- */
521
- static cueTextOf(_payload, _codecId) {
522
- throw new Error("cueTextOf not implemented");
523
- }
524
-
525
- /**
526
- * @param {Buffer} payload
527
- * @param {string} codecId
528
- * @returns {string}
529
- */
530
- cueTextOf(payload, codecId) {
531
- return /** @type {typeof Container} */ (this.constructor).cueTextOf(payload, codecId);
532
- }
533
- }
534
-
535
- /**
536
- * What the cue walk may read on one pass.
537
- *
538
- * @typedef {object} HeldReader
539
- * @property {(start: number, end: number) => boolean} isHeld - Whether the whole
540
- * inclusive range is downloaded.
541
- * @property {Array<[number, number]>} ranges - The downloaded ranges, ascending.
542
- * @property {(start: number, end: number) => Promise<Buffer>} read - Every byte
543
- * of a downloaded range, or `BytesUnavailable`; never fetches.
544
- * @property {number} portionBytes - The largest read one step may make.
545
- * @property {(() => number[]) | number[]} wantedSeconds - Where viewers stand,
546
- * in film seconds — a function, read again between clusters, so a pass can
547
- * stop when a viewer has moved.
548
- */
549
-
550
- // ---------------------------------------------------------------------------
551
- // Lining ffmpeg's banner up with what a container declares. Here because the
552
- // correction is about what a CONTAINER states and the banner cannot.
553
- // ---------------------------------------------------------------------------
554
- /**
555
- * Which subtitle track the FILE says to show, read from the file rather than
556
- * from ffmpeg's description of it.
557
- *
558
- * Why this exists. The browser decides which subtitle track to turn on from
559
- * `isDefault`, and until now that came from ffmpeg's `-i` banner, which prints
560
- * `(default)`. In Matroska `FlagDefault` DEFAULTS TO 1 and ffmpeg has already
561
- * applied that default by the time it prints — so a file whose muxer wrote the
562
- * flag on no track arrives looking exactly like one that wrote it on every
563
- * track: everything marked. The banner cannot tell the two apart, and the
564
- * difference is the whole question, because one of them means "show this one"
565
- * and the other means "the file has no opinion".
566
- *
567
- * The container itself can be asked, and the EBML reader already walks the
568
- * Tracks element for subtitle extraction. What it now also records is whether
569
- * the element was WRITTEN, which is the fact the banner destroys.
570
- *
571
- * The awkward part is lining the two readings up. ffmpeg numbers its subtitle
572
- * streams `0:s:0`, `0:s:1`, … over EVERY subtitle stream, picture-based ones
573
- * included, in the order the container declares them; the container reading is
574
- * a list in that same order. So position is the correspondence — but a position
575
- * match that is merely assumed is worth nothing, so it is CHECKED: each pair
576
- * has to agree on language or on title. One pair that agrees on neither, or a
577
- * length that differs, means the two readings are not describing the same
578
- * thing in the same order, and then the container reading is not used at all.
579
- */
580
-
581
- /**
582
- * Language codes that carry no information, and so cannot confirm a pairing.
583
- *
584
- * ffmpeg prints `und` for a stream with no language; Matroska's own default
585
- * for `Language` is `eng`, which is why an absent element cannot be read as a
586
- * statement either — but `eng` is also a real answer, so it is not listed here
587
- * and is compared like any other.
588
- */
589
- const EMPTY_LANGUAGES = new Set(["", "und", "unknown"]);
590
-
591
- /**
592
- * @param {unknown} value
593
- * @returns {string}
594
- */
595
- function normalise(value) {
596
- return typeof value === "string" ? value.trim().toLowerCase() : "";
597
- }
598
-
599
- /**
600
- * Whether one banner stream and one container track can be the same track.
601
- *
602
- * Agreement on either the language or the name is enough; both being empty is
603
- * not agreement, because two tracks that say nothing about themselves say
604
- * nothing about their pairing either.
605
- *
606
- * @param {{ language?: string, title?: string }} banner
607
- * @param {{ language?: string, name?: string }} container
608
- * @returns {boolean}
609
- */
610
- function pairingHolds(banner, container) {
611
- const bannerLanguage = normalise(banner?.language);
612
- const containerLanguage = normalise(container?.language);
613
- if (
614
- !EMPTY_LANGUAGES.has(bannerLanguage) &&
615
- !EMPTY_LANGUAGES.has(containerLanguage) &&
616
- bannerLanguage === containerLanguage
617
- ) {
618
- return true;
619
- }
620
- const bannerTitle = normalise(banner?.title);
621
- const containerName = normalise(container?.name);
622
- if (bannerTitle.length > 0 && bannerTitle === containerName) {
623
- return true;
624
- }
625
- // Nothing to compare on either side. Not a disagreement — a file may name
626
- // neither — so it does not break the alignment; it simply adds no support.
627
- return (
628
- (EMPTY_LANGUAGES.has(bannerLanguage) || EMPTY_LANGUAGES.has(containerLanguage)) &&
629
- (bannerTitle.length === 0 || containerName.length === 0)
630
- );
631
- }
632
-
1
+ /**
2
+ * @file Base Container — abstract per RFC 9559 / ISO 14496-12.
3
+ *
4
+ * A Container knows how to read its own format's track table and index.
5
+ * Concrete containers (MatroskaContainer, Mp4Container, AviContainer) implement
6
+ * spec-specific parsing. All byte access goes through `readRange(start,end)` so
7
+ * the class works over torrent piece windows.
8
+ *
9
+ * Spec refs:
10
+ * - Matroska RFC 9559 §5: EBML, Segment, SeekHead, Tracks, Cues, Clusters
11
+ * - MP4 ISO/IEC 14496-12 §8: ftyp, moov, trak, tkhd, mdhd, hdlr, elng, stbl
12
+ * - AVI RIFF §: LIST hdrl, idx1
13
+ */
14
+
15
+ import { strictReader } from "./unavailable.js";
16
+
17
+ /**
18
+ * What one file declares about itself. Every field is either a value the
19
+ * container states or `null`, which means the container does not state it —
20
+ * a defined absence, not "nobody has looked yet".
21
+ *
22
+ * @typedef {object} ContainerMediaInfo
23
+ * @property {string} format - "matroska" | "mp4" | "avi" | "unknown".
24
+ * @property {number | null} durationSeconds
25
+ * @property {number | null} startTimeSeconds - Where this file's own timeline
26
+ * begins. Two files of one release need not agree on it, and the difference
27
+ * is what keeps a soundtrack shipped separately aligned with its picture.
28
+ */
29
+
30
+ export class Container {
31
+ /**
32
+ * One reader, the one that fetches what is missing, and one container per
33
+ * file — the one `ContainerOrchestrator` keeps.
34
+ *
35
+ * `readRange` is made strict here: it answers with every byte asked for or
36
+ * throws `BytesUnavailable`, so no reading in any subclass can mistake a read
37
+ * that has not arrived for an element that is not there. What a subclass keeps
38
+ * it keeps only after a reading succeeded (see `unavailable.js`).
39
+ *
40
+ * The cue walk reads only what is already downloaded and asks the swarm for
41
+ * nothing. That reader is NOT given here: it is handed to
42
+ * {@link Container#readHeldCues} on every pass, because what is downloaded
43
+ * changes between passes and the container is kept for the life of the file.
44
+ * It used to be given here, which is why the walk had to build a second
45
+ * container over the same file and read its head and Cues a second time.
46
+ *
47
+ * `portionBytes` is the largest read a reading makes, stated by whoever knows
48
+ * the medium — a torrent's piece length. Absent, an element is read in one go.
49
+ *
50
+ * @param {object} params
51
+ * @param {(start:number,end:number)=>Promise<Buffer|null>} [params.readRange]
52
+ * @param {number} [params.fileSize]
53
+ * @param {string} [params.label]
54
+ * @param {number} [params.portionBytes]
55
+ */
56
+ constructor({ readRange, fileSize, label = "", portionBytes } = {}) {
57
+ this.fileSize = fileSize;
58
+ this.readRange = typeof readRange === "function" ? strictReader(readRange, fileSize) : readRange;
59
+ this.label = label;
60
+ this.portionBytes = Number.isFinite(portionBytes) && portionBytes > 0 ? portionBytes : Number.POSITIVE_INFINITY;
61
+ }
62
+
63
+
64
+ /**
65
+ * Whether one of ffmpeg's banner streams and one of this container's tracks
66
+ * can be the same track.
67
+ *
68
+ * @param {{ language?: string, title?: string }} banner
69
+ * @param {{ language?: string, name?: string }} container
70
+ * @returns {boolean}
71
+ */
72
+ static pairingHolds(banner, container) {
73
+ return pairingHolds(banner, container);
74
+ }
75
+
76
+ /**
77
+ * ffmpeg's description of a file's subtitle streams, corrected by what the
78
+ * container itself declares.
79
+ *
80
+ * The banner cannot express the difference between "no track is marked" and
81
+ * "every track is marked", because Matroska's `FlagDefault` defaults to 1 and
82
+ * ffmpeg has already applied that default by the time it prints. The
83
+ * container can be asked, and this is where the two readings are lined up —
84
+ * by position, checked pair by pair rather than assumed.
85
+ *
86
+ * @param {object[]} bannerTracks
87
+ * @param {object[]} declared - This container's own subtitle tracks, in its order.
88
+ * @returns {object[]}
89
+ */
90
+ /**
91
+ * The picture's facts, from the two readings that state them.
92
+ *
93
+ * Audio and subtitles have had this since the flags were first read from the
94
+ * file; video never did. Every figure the encode is planned from — the size,
95
+ * the frame rate, whether it is HDR, how many bits a sample carries — was
96
+ * taken from ffmpeg's `-i` banner alone, and the `VideoTrack` the container
97
+ * declares was read and then used for nothing but a line in the log.
98
+ *
99
+ * Which reading wins is decided per field by what each one IS, and the rule
100
+ * is the one `readMediaInfo` already states: a fact the container DECLARES is
101
+ * read from the container; a fact only the media has is measured from the
102
+ * media.
103
+ *
104
+ * - the coded size and the frame rate are the BANNER's. Both are declared by
105
+ * the container as well, but what the encoder receives is what the decoder
106
+ * produced, and the ladder and the scale filter have to be sized to that. A
107
+ * container that declares something else is mis-declaring, and using its
108
+ * numbers would size the encode to a picture that never arrives;
109
+ * - the bit depth and the HDR signalling are the CONTAINER's where it states
110
+ * them. They are not properties of the decoded frames at all — they are the
111
+ * file saying how its samples are to be read — and ffmpeg prints them only
112
+ * as a side effect of naming a pixel format. HDR is not compared for
113
+ * disagreement: both sides give a boolean, and a boolean cannot say "I did
114
+ * not look";
115
+ * - the display size is the container's alone; the banner has no such field.
116
+ *
117
+ * Where only one side states a field, that side answers whatever the rule
118
+ * would have preferred. Where both state it and they DISAGREE, the
119
+ * disagreement is reported: it is a fact about the file, and until now
120
+ * nothing could see it.
121
+ *
122
+ * @param {{ width?: number|null, height?: number|null, fps?: number|null, isHdr?: boolean, bitDepth?: number|null }} banner
123
+ * @param {object | null} declared - The container's own `VideoTrack`.
124
+ * @returns {{ width: number|null, height: number|null, fps: number|null, isHdr: boolean, bitDepth: number|null, displayWidth: number|null, displayHeight: number|null, disagreements: string[] }}
125
+ */
126
+ static mergeVideoFacts(banner, declared) {
127
+ const number = (value) => (Number.isFinite(value) && value > 0 ? Number(value) : null);
128
+ const fromBanner = {
129
+ width: number(banner?.width),
130
+ height: number(banner?.height),
131
+ fps: number(banner?.fps),
132
+ isHdr: banner?.isHdr === true,
133
+ bitDepth: number(banner?.bitDepth)
134
+ };
135
+ if (!declared) {
136
+ return { ...fromBanner, displayWidth: null, displayHeight: null, disagreements: [] };
137
+ }
138
+ const fromContainer = {
139
+ width: number(declared.width),
140
+ height: number(declared.height),
141
+ fps: number(declared.fps),
142
+ isHdr: declared.isHdr === true,
143
+ bitDepth: number(declared.bitDepth)
144
+ };
145
+ const disagreements = [];
146
+ const note = (field, mine, theirs) => {
147
+ if (mine !== null && theirs !== null && mine !== theirs) {
148
+ disagreements.push(`${field} ${theirs} in the container against ${mine} in the probe`);
149
+ }
150
+ };
151
+ note("width", fromBanner.width, fromContainer.width);
152
+ note("height", fromBanner.height, fromContainer.height);
153
+ if (fromBanner.bitDepth !== null && fromContainer.bitDepth !== null && fromBanner.bitDepth !== fromContainer.bitDepth) {
154
+ disagreements.push(
155
+ `bit depth ${fromContainer.bitDepth} in the container against ${fromBanner.bitDepth} in the probe`
156
+ );
157
+ }
158
+ // HDR is deliberately NOT compared. Both sides give it as a boolean, and a
159
+ // boolean cannot say "I did not look": a container with no Colour element
160
+ // and one that states SDR are the same `false`, as are a probe that printed
161
+ // no colour metadata and one that printed BT.709. Reporting that as a
162
+ // disagreement would report it on almost every file. Either side saying yes
163
+ // is taken as yes, which is the safe direction — the cost of tone mapping a
164
+ // picture that did not need it is smaller than showing a washed-out one.
165
+ return {
166
+ width: fromBanner.width ?? fromContainer.width,
167
+ height: fromBanner.height ?? fromContainer.height,
168
+ fps: fromBanner.fps ?? fromContainer.fps,
169
+ // The container declares these; the probe only reflects them.
170
+ bitDepth: fromContainer.bitDepth ?? fromBanner.bitDepth,
171
+ isHdr: fromContainer.isHdr || fromBanner.isHdr,
172
+ displayWidth: number(declared.displayWidth),
173
+ displayHeight: number(declared.displayHeight),
174
+ disagreements
175
+ };
176
+ }
177
+
178
+ /**
179
+ * Line ffmpeg's banner up with what the container declares, and say whether the
180
+ * two are describing the same thing in the same order.
181
+ *
182
+ * ffmpeg numbers a file's streams `0:a:N` / `0:s:N` over every stream of that
183
+ * kind, in the order the container declares them; the container reading is a
184
+ * list in that same order. So position is the correspondence — but a position
185
+ * match that is merely assumed is worth nothing, and it is CHECKED: each pair
186
+ * has to agree on language or on title. One pair that agrees on neither, or a
187
+ * length that differs, means the two readings are not about the same thing, and
188
+ * then the container reading is not used AT ALL. A wrong flag is worse than a
189
+ * missing one, because `0:a:N` is what the encoder is given.
190
+ *
191
+ * One alignment for every media kind, because it is one rule. It was written
192
+ * twice — once for subtitles, once for audio — down to a `pairingHolds` that
193
+ * was byte-for-byte the same function under two names.
194
+ *
195
+ * @param {object[]} bannerTracks
196
+ * @param {object[]} declared
197
+ * @param {string} noun - "subtitle" or "audio"; only for the reason text.
198
+ * @returns {{ aligned: boolean, reason: string, banner: object[], container: object[] }}
199
+ */
200
+ static alignWithBanner(bannerTracks, declared, noun) {
201
+ const banner = Array.isArray(bannerTracks) ? bannerTracks : [];
202
+ const container = Array.isArray(declared) ? declared : [];
203
+ if (banner.length === 0) {
204
+ return { aligned: false, reason: `the probe found no ${noun} stream`, banner, container };
205
+ }
206
+ if (container.length === 0) {
207
+ return { aligned: false, reason: `the container declares no ${noun} track`, banner, container };
208
+ }
209
+ if (container.length !== banner.length) {
210
+ return {
211
+ aligned: false,
212
+ reason: `the container declares ${container.length} ${noun} tracks and the probe found ${banner.length}`,
213
+ banner,
214
+ container
215
+ };
216
+ }
217
+ for (const [order, track] of banner.entries()) {
218
+ if (!Container.pairingHolds(track, container[order])) {
219
+ return {
220
+ aligned: false,
221
+ reason:
222
+ `${noun} ${order} is "${normalise(track?.title) || "-"}"/${normalise(track?.language) || "-"} ` +
223
+ `in the probe and "${normalise(container[order]?.name) || "-"}"/` +
224
+ `${normalise(container[order]?.language) || "-"} in the container`,
225
+ banner,
226
+ container
227
+ };
228
+ }
229
+ }
230
+ return { aligned: true, reason: "", banner, container };
231
+ }
232
+
233
+ /**
234
+ * What the banner says, with the flags only the container knows added — or the
235
+ * banner alone where the two could not be lined up.
236
+ *
237
+ * `take` says which of the container's fields this kind of track wants, and is
238
+ * the only part that differs between them.
239
+ *
240
+ * @param {object[]} bannerTracks
241
+ * @param {object[]} declared
242
+ * @param {string} noun
243
+ * @param {(containerTrack: object, bannerTrack: object) => object} take
244
+ * @param {object} absent - The same fields as `take` returns, for a track whose
245
+ * container reading could not be used. Not "the container says no" — the
246
+ * container has not been heard from.
247
+ * @returns {{ tracks: object[], aligned: boolean, reason: string }}
248
+ */
249
+ static mergeDeclaredFlags(bannerTracks, declared, noun, take, absent) {
250
+ const { aligned, reason, banner, container } = Container.alignWithBanner(bannerTracks, declared, noun);
251
+ if (!aligned) {
252
+ return {
253
+ tracks: banner.map((track) => ({ ...track, ...absent })),
254
+ aligned,
255
+ reason
256
+ };
257
+ }
258
+ return {
259
+ tracks: banner.map((track, order) => ({ ...track, ...take(container[order], track) })),
260
+ aligned: true,
261
+ reason: ""
262
+ };
263
+ }
264
+
265
+ static mergeSubtitleFlags(bannerTracks, declared) {
266
+ return Container.mergeDeclaredFlags(
267
+ bannerTracks,
268
+ declared,
269
+ "subtitle",
270
+ (track) => ({
271
+ // The language the container states, its default included. RFC 9559
272
+ // §5.1.4.1.19 gives `Language` the default `eng`, and RFC 8794
273
+ // §11.1.19 says an element equal to its default need not be written
274
+ // and that a reader MUST then read the default — so a track with no
275
+ // Language element is English by the file's own statement. Until
276
+ // 2026-10-01 that was treated as "says nothing", and an English track
277
+ // was offered as Unknown. Where the language came from travels beside
278
+ // it, so a reading of the text that disagrees can be reported.
279
+ language: track.languageBcp47 || track.language || "",
280
+ declaresLanguage: track.declaresLanguage === true,
281
+ languageSource: typeof track.languageSource === "string" ? track.languageSource : "",
282
+ isDefault: track.isDefault === true,
283
+ declaresDefault: track.declaresDefault === true,
284
+ // Read from the file rather than guessed from the track's name. Both
285
+ // are stated by the container itself (RFC 9559 §5.1.4.1) and neither
286
+ // reaches ffmpeg's `-i` banner, which is where every other field here
287
+ // comes from.
288
+ isForced: track.isForced === true,
289
+ isHearingImpaired: track.isHearingImpaired === true,
290
+ // FlagEnabled, so the browser can leave an unusable track out of the
291
+ // menu. It stays in the list and keeps its number: ffmpeg creates a
292
+ // stream for it either way.
293
+ isEnabled: track.isEnabled !== false,
294
+ // The RFC 5646 tag where the file writes one, kept BESIDE the code
295
+ // rather than replacing it: this list is aligned against ffmpeg's
296
+ // banner, which prints the three-letter form.
297
+ languageBcp47: typeof track.languageBcp47 === "string" ? track.languageBcp47 : ""
298
+ }),
299
+ {
300
+ declaresDefault: false,
301
+ isForced: false,
302
+ isHearingImpaired: false,
303
+ isEnabled: true,
304
+ languageBcp47: ""
305
+ }
306
+ );
307
+ }
308
+
309
+ /**
310
+ * The same for audio, with the flags RFC 9559 §5.1.4.1 defines for it.
311
+ *
312
+ * `FlagOriginal`, `FlagCommentary` and `FlagVisualImpaired` do not appear in
313
+ * the banner at all, so without this the audio menu cannot tell a director's
314
+ * commentary from the film.
315
+ *
316
+ * @param {object[]} bannerTracks
317
+ * @param {object[]} declared
318
+ * @returns {{ tracks: object[], aligned: boolean, reason: string }}
319
+ */
320
+ static mergeAudioFlags(bannerTracks, declared) {
321
+ return Container.mergeDeclaredFlags(
322
+ bannerTracks,
323
+ declared,
324
+ "audio",
325
+ (track, banner) => ({
326
+ isOriginal: track.isOriginal === true,
327
+ isCommentary: track.isCommentary === true,
328
+ isVisualImpaired: track.isVisualImpaired === true,
329
+ isEnabled: track.isEnabled !== false,
330
+ isDefault: track.isDefault === true,
331
+ declaresDefault: track.declaresDefault === true,
332
+ languageBcp47: typeof track.languageBcp47 === "string" ? track.languageBcp47 : "",
333
+ channels: Number.isFinite(track.channels) ? track.channels : null,
334
+ // The codec's configuration and the most it allows the track to
335
+ // carry, both as the container states them (`tracks/audio-bound.js`).
336
+ codecParameters: track.codecParameters ?? null,
337
+ peakKbps: Number.isFinite(track.peakKbps) && track.peakKbps > 0 ? track.peakKbps : null,
338
+ title:
339
+ typeof banner?.title === "string" && banner.title.length > 0
340
+ ? banner.title
341
+ : (typeof track.name === "string" ? track.name : "")
342
+ }),
343
+ {
344
+ declaresDefault: false,
345
+ isOriginal: false,
346
+ isCommentary: false,
347
+ isVisualImpaired: false,
348
+ isEnabled: true,
349
+ languageBcp47: "",
350
+ channels: null,
351
+ codecParameters: null,
352
+ peakKbps: null
353
+ }
354
+ );
355
+ }
356
+
357
+
358
+ /** @returns {string} Human name: "matroska" | "mp4" | "avi" | "unknown" */
359
+ get formatName() {
360
+ return "unknown";
361
+ }
362
+
363
+ /** Whether `head` (first bytes) looks like this container. */
364
+ static detect(_head) {
365
+ return false;
366
+ }
367
+
368
+ /**
369
+ * All tracks declared by the container, in container order.
370
+ * Includes disabled tracks (isEnabled=false) to preserve declaredIndex alignment with ffmpeg.
371
+ * @returns {Promise<import("../tracks/index.js").ContainerTrack[]>}
372
+ */
373
+ async readTracks() {
374
+ throw new Error("readTracks not implemented");
375
+ }
376
+
377
+
378
+ /**
379
+ * This container's subtitle tracks and where their cues are, in ONE shape
380
+ * whichever container answers.
381
+ *
382
+ * `tracks` carries a `clusterPositions` list for a container that stores cues
383
+ * in clusters and a `samples` list for one that states each cue's own byte
384
+ * range; a caller reads neither, and asks {@link Container#readHeldCues}
385
+ * instead. `declared` is what the container says about its subtitle tracks in
386
+ * its own order, and empty means the container said nothing — a real answer,
387
+ * not a missing one.
388
+ *
389
+ * @returns {Promise<{ tracks: object[], declared: object[], secondsPerTick: number, segmentDataOffset: number } | null>}
390
+ * Null where this container declares no subtitles at all.
391
+ */
392
+ async readSubtitlePlan() {
393
+ return null;
394
+ }
395
+
396
+ /**
397
+ * The cues this container can read RIGHT NOW for one track, without fetching.
398
+ *
399
+ * Every container answers this, and each reads what its own specification
400
+ * says: Matroska walks the clusters its Cues table names, an MP4 reads the
401
+ * samples its table states. The caller therefore chooses a container once —
402
+ * from the bytes — and never again. It used to choose twice, once by file
403
+ * extension for the container and once by whether a track carried a sample
404
+ * list for the reading, and two choices that must agree and are made from
405
+ * different evidence are a disagreement waiting to happen.
406
+ *
407
+ * `progress` is what has already been read, kept by the caller because it
408
+ * belongs to the file rather than to one pass. Each container keeps its own
409
+ * part of it under its own name; nothing else reads inside.
410
+ *
411
+ * `held` is how to read what is downloaded NOW, handed in per pass: which
412
+ * ranges are whole, a read of one that never fetches (strict: every byte or
413
+ * `BytesUnavailable`), the portion a read may span, and where the viewers
414
+ * stand, in seconds, so the work nearest them is taken first.
415
+ *
416
+ * @param {object} _plan - This file's subtitle plan.
417
+ * @param {object} _track - The track asked about.
418
+ * @param {object} _progress
419
+ * @param {HeldReader} _held
420
+ * @returns {Promise<{ found: Map<number, object[]>, covered: number, indexed: number, withdrawn: number[] }>}
421
+ * `found` is track number to the cues found in THIS pass — Matroska fills
422
+ * every track from one walk, so it is a map and not a list. Each cue may
423
+ * carry `source`, the position it was read from; `withdrawn` lists sources
424
+ * found in an earlier pass that turned out not to be what they were taken
425
+ * for, whose cues the caller must take back.
426
+ */
427
+ async readHeldCues(_plan, _track, _progress, _held) {
428
+ return { found: new Map(), covered: 0, indexed: 0, withdrawn: [] };
429
+ }
430
+
431
+ /**
432
+ * Keyframe times for the video track, ascending seconds. Null when index
433
+ * absent (MPEG-TS, fragmented MP4, truncated).
434
+ *
435
+ * **It reads, and does not remember.** It used to keep the answer, and that
436
+ * made the table the one fact in this proxy stored in two places: here, and
437
+ * in the file's `KeyframeTable` on the main thread. Traced 2026-09-15, this
438
+ * copy had no reader: nothing ever asked a container twice for its keyframes.
439
+ * The parse itself has since moved to the thread the sessions are on, so
440
+ * there is no longer a second thread for a second copy to sit in either.
441
+ *
442
+ * The remembering lives where the fact is USED, which is also the only place
443
+ * that can do the rest of the job: bound how long a viewer waits for it
444
+ * while letting the read go on, join a second asker to a read already
445
+ * running, and keep the answer reachable by a session created before it
446
+ * landed. A container cannot do any of those — it does not know there is a
447
+ * viewer — so a copy here was never the whole answer, only a second one.
448
+ *
449
+ * @returns {Promise<{times:number[],tolerance:number}|null>}
450
+ */
451
+ async readKeyframeIndex() {
452
+ return this.parseKeyframeIndex();
453
+ }
454
+
455
+ /**
456
+ * How THIS format states where its keyframes are. Overridden by every
457
+ * container that has such a table; the default is the honest answer for one
458
+ * that does not.
459
+ *
460
+ * @returns {Promise<{times:number[],tolerance:number}|null>}
461
+ */
462
+ async parseKeyframeIndex() {
463
+ return null;
464
+ }
465
+
466
+ /**
467
+ * What this file DECLARES about itself as a whole, as distinct from what its
468
+ * individual tracks declare.
469
+ *
470
+ * The rule this method exists to hold: a fact the container declares is read
471
+ * from the container; a fact only the media itself has is measured from the
472
+ * media. Both halves used to be asked of ffmpeg, so the same header was read
473
+ * twice — measured 2026-09-03, this layer read one `.mka` header in 8 ms while
474
+ * a second ffmpeg read the same header over HTTP for 8121 ms, in the same
475
+ * second, on the same file.
476
+ *
477
+ * `null` is not "unknown, ask someone else". It means the container does not
478
+ * declare the field, which is a final answer about the container and the point
479
+ * at which a caller may go to the media — see `docs/container-architecture.md`.
480
+ *
481
+ * @returns {Promise<import("./Container.js").ContainerMediaInfo>}
482
+ */
483
+ async readMediaInfo() {
484
+ if (!this.mediaInfo) {
485
+ this.mediaInfo = {
486
+ format: this.formatName,
487
+ durationSeconds: null,
488
+ startTimeSeconds: null
489
+ };
490
+ }
491
+ return this.mediaInfo;
492
+ }
493
+
494
+ /**
495
+ * Subtitle-specific: where cues live (Matroska cluster positions or MP4 sample ranges).
496
+ * Returned via track objects' clusterPositions/samples, so base has no extra method — tracks carry it.
497
+ */
498
+
499
+ /**
500
+ * The TEXT FIELD of one subtitle cue, taken out of this container's framing.
501
+ *
502
+ * How a cue's bytes are wrapped is stated by the container's own
503
+ * specification, so each subclass answers for itself: Matroska reorders an ASS
504
+ * dialogue row, drops its two timing fields and prepends a read order
505
+ * (`matroska.org/technical/subtitles.html`); an MP4 prefixes a `tx3g` sample
506
+ * with its length (ISO/IEC 14496-12 §12.6); a subtitle FILE states its own
507
+ * field order in `[Events]`. None of that is a fact about the subtitle format,
508
+ * and the format's own markup — `{\pos(…)}`, `\N` — is not a fact about the
509
+ * container. The second half is `TextSubtitleTrack`; this is the
510
+ * first, and the two are applied in that order.
511
+ *
512
+ * Static because de-framing reads no instance state: a caller that has bytes
513
+ * and knows the format needs no container built over the whole file. The
514
+ * instance form below exists so a caller that DOES hold a container gets the
515
+ * right answer without naming the subclass.
516
+ *
517
+ * @param {Buffer} _payload - The cue's bytes as the container stores them.
518
+ * @param {string} _codecId - CodecID / sample entry type / file extension.
519
+ * @returns {string} The text field, markup still in place.
520
+ */
521
+ static cueTextOf(_payload, _codecId) {
522
+ throw new Error("cueTextOf not implemented");
523
+ }
524
+
525
+ /**
526
+ * @param {Buffer} payload
527
+ * @param {string} codecId
528
+ * @returns {string}
529
+ */
530
+ cueTextOf(payload, codecId) {
531
+ return /** @type {typeof Container} */ (this.constructor).cueTextOf(payload, codecId);
532
+ }
533
+ }
534
+
535
+ /**
536
+ * What the cue walk may read on one pass.
537
+ *
538
+ * @typedef {object} HeldReader
539
+ * @property {(start: number, end: number) => boolean} isHeld - Whether the whole
540
+ * inclusive range is downloaded.
541
+ * @property {Array<[number, number]>} ranges - The downloaded ranges, ascending.
542
+ * @property {(start: number, end: number) => Promise<Buffer>} read - Every byte
543
+ * of a downloaded range, or `BytesUnavailable`; never fetches.
544
+ * @property {number} portionBytes - The largest read one step may make.
545
+ * @property {(() => number[]) | number[]} wantedSeconds - Where viewers stand,
546
+ * in film seconds — a function, read again between clusters, so a pass can
547
+ * stop when a viewer has moved.
548
+ */
549
+
550
+ // ---------------------------------------------------------------------------
551
+ // Lining ffmpeg's banner up with what a container declares. Here because the
552
+ // correction is about what a CONTAINER states and the banner cannot.
553
+ // ---------------------------------------------------------------------------
554
+ /**
555
+ * Which subtitle track the FILE says to show, read from the file rather than
556
+ * from ffmpeg's description of it.
557
+ *
558
+ * Why this exists. The browser decides which subtitle track to turn on from
559
+ * `isDefault`, and until now that came from ffmpeg's `-i` banner, which prints
560
+ * `(default)`. In Matroska `FlagDefault` DEFAULTS TO 1 and ffmpeg has already
561
+ * applied that default by the time it prints — so a file whose muxer wrote the
562
+ * flag on no track arrives looking exactly like one that wrote it on every
563
+ * track: everything marked. The banner cannot tell the two apart, and the
564
+ * difference is the whole question, because one of them means "show this one"
565
+ * and the other means "the file has no opinion".
566
+ *
567
+ * The container itself can be asked, and the EBML reader already walks the
568
+ * Tracks element for subtitle extraction. What it now also records is whether
569
+ * the element was WRITTEN, which is the fact the banner destroys.
570
+ *
571
+ * The awkward part is lining the two readings up. ffmpeg numbers its subtitle
572
+ * streams `0:s:0`, `0:s:1`, … over EVERY subtitle stream, picture-based ones
573
+ * included, in the order the container declares them; the container reading is
574
+ * a list in that same order. So position is the correspondence — but a position
575
+ * match that is merely assumed is worth nothing, so it is CHECKED: each pair
576
+ * has to agree on language or on title. One pair that agrees on neither, or a
577
+ * length that differs, means the two readings are not describing the same
578
+ * thing in the same order, and then the container reading is not used at all.
579
+ */
580
+
581
+ /**
582
+ * Language codes that carry no information, and so cannot confirm a pairing.
583
+ *
584
+ * ffmpeg prints `und` for a stream with no language; Matroska's own default
585
+ * for `Language` is `eng`, which is why an absent element cannot be read as a
586
+ * statement either — but `eng` is also a real answer, so it is not listed here
587
+ * and is compared like any other.
588
+ */
589
+ const EMPTY_LANGUAGES = new Set(["", "und", "unknown"]);
590
+
591
+ /**
592
+ * @param {unknown} value
593
+ * @returns {string}
594
+ */
595
+ function normalise(value) {
596
+ return typeof value === "string" ? value.trim().toLowerCase() : "";
597
+ }
598
+
599
+ /**
600
+ * Whether one banner stream and one container track can be the same track.
601
+ *
602
+ * Agreement on either the language or the name is enough; both being empty is
603
+ * not agreement, because two tracks that say nothing about themselves say
604
+ * nothing about their pairing either.
605
+ *
606
+ * @param {{ language?: string, title?: string }} banner
607
+ * @param {{ language?: string, name?: string }} container
608
+ * @returns {boolean}
609
+ */
610
+ function pairingHolds(banner, container) {
611
+ const bannerLanguage = normalise(banner?.language);
612
+ const containerLanguage = normalise(container?.language);
613
+ if (
614
+ !EMPTY_LANGUAGES.has(bannerLanguage) &&
615
+ !EMPTY_LANGUAGES.has(containerLanguage) &&
616
+ bannerLanguage === containerLanguage
617
+ ) {
618
+ return true;
619
+ }
620
+ const bannerTitle = normalise(banner?.title);
621
+ const containerName = normalise(container?.name);
622
+ if (bannerTitle.length > 0 && bannerTitle === containerName) {
623
+ return true;
624
+ }
625
+ // Nothing to compare on either side. Not a disagreement — a file may name
626
+ // neither — so it does not break the alignment; it simply adds no support.
627
+ return (
628
+ (EMPTY_LANGUAGES.has(bannerLanguage) || EMPTY_LANGUAGES.has(containerLanguage)) &&
629
+ (bannerTitle.length === 0 || containerName.length === 0)
630
+ );
631
+ }
632
+