@torrent-tv/proxy 2.87.10 → 2.87.12

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 (469) 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 +322 -322
  13. package/CHANGELOG.md +2191 -2181
  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/diagnostics/sctpstate.gdb +31 -31
  19. package/bin/cli.js +684 -684
  20. package/bin/thread-pool.js +30 -30
  21. package/biome.json +411 -411
  22. package/docs/browser-proxy-contract.md +124 -101
  23. package/docs/container-architecture.md +218 -218
  24. package/docs/download-architecture.md +261 -261
  25. package/docs/encode-architecture.md +729 -729
  26. package/docs/encode-run-state.md +96 -96
  27. package/docs/logs.md +97 -97
  28. package/docs/socks5-egress-research.md +114 -114
  29. package/docs/storage-architecture.md +267 -267
  30. package/knip.json +14 -14
  31. package/openspec/changes/adaptive-bitrate/design.md +92 -92
  32. package/openspec/changes/adaptive-bitrate/proposal.md +56 -56
  33. package/openspec/changes/adaptive-bitrate/specs/adaptive-bitrate/spec.md +51 -51
  34. package/openspec/changes/adaptive-bitrate/tasks.md +40 -40
  35. package/openspec/changes/binary-distribution/.openspec.yaml +2 -2
  36. package/openspec/changes/binary-distribution/proposal.md +53 -53
  37. package/openspec/changes/chunked-request-bodies/design.md +81 -81
  38. package/openspec/changes/chunked-request-bodies/proposal.md +53 -53
  39. package/openspec/changes/chunked-request-bodies/specs/chunked-request-bodies/spec.md +30 -30
  40. package/openspec/changes/chunked-request-bodies/tasks.md +40 -40
  41. package/openspec/changes/cold-start/design.md +98 -98
  42. package/openspec/changes/cold-start/proposal.md +62 -62
  43. package/openspec/changes/cold-start/specs/cold-start/spec.md +47 -47
  44. package/openspec/changes/cold-start/tasks.md +48 -48
  45. package/openspec/changes/disk-cap/.openspec.yaml +2 -2
  46. package/openspec/changes/disk-cap/proposal.md +37 -37
  47. package/openspec/changes/disk-cap/specs/disk-cap/spec.md +25 -25
  48. package/openspec/changes/disk-cap/tasks.md +19 -19
  49. package/openspec/changes/proxy-observability/.openspec.yaml +2 -2
  50. package/openspec/changes/proxy-observability/design.md +38 -38
  51. package/openspec/changes/proxy-observability/proposal.md +49 -49
  52. package/openspec/changes/proxy-observability/specs/observability/spec.md +33 -33
  53. package/openspec/changes/proxy-observability/tasks.md +21 -21
  54. package/openspec/changes/seek-debounce/design.md +118 -118
  55. package/openspec/changes/seek-debounce/proposal.md +59 -59
  56. package/openspec/changes/seek-debounce/specs/seek-debounce/spec.md +41 -41
  57. package/openspec/changes/seek-debounce/tasks.md +33 -33
  58. package/openspec/changes/subtitle-language/.openspec.yaml +2 -2
  59. package/openspec/changes/subtitle-language/proposal.md +50 -50
  60. package/openspec/changes/subtitle-language/specs/subtitle-language/spec.md +34 -34
  61. package/openspec/changes/subtitle-language/tasks.md +26 -26
  62. package/openspec/changes/track-selection/.openspec.yaml +2 -2
  63. package/openspec/changes/track-selection/design.md +47 -47
  64. package/openspec/changes/track-selection/proposal.md +45 -45
  65. package/openspec/changes/track-selection/specs/track-selection/spec.md +41 -41
  66. package/openspec/changes/track-selection/tasks.md +20 -20
  67. package/openspec/changes/transcode-quality/.openspec.yaml +2 -2
  68. package/openspec/changes/transcode-quality/proposal.md +51 -51
  69. package/openspec/changes/transcode-quality/specs/transcode-quality/spec.md +139 -139
  70. package/openspec/changes/transcode-quality/tasks.md +63 -63
  71. package/openspec/config.yaml +38 -38
  72. package/package.json +50 -50
  73. package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
  74. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  75. package/research/double-spawn-2026-09-10.md +171 -171
  76. package/research/handover-2026-09-13.md +209 -209
  77. package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
  78. package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
  79. package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
  80. package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
  81. package/routes/api/client-logs/post.js +86 -86
  82. package/routes/api/delivery-sink/get.js +72 -72
  83. package/routes/api/link-probe/get.js +51 -51
  84. package/routes/api/playback-plan/post.js +53 -53
  85. package/routes/api/sources/files/get.js +100 -100
  86. package/routes/api/sources/post.js +36 -36
  87. package/routes/api/sources/stats/get.js +132 -132
  88. package/routes/api/sources/warm/post.js +217 -217
  89. package/routes/api/subtitles/get.js +230 -230
  90. package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
  91. package/routes/api/transcode-sessions/net-report/post.js +136 -129
  92. package/routes/api/transcode-sessions/post.js +173 -160
  93. package/routes/api/transcode-sessions/progress/get.js +27 -27
  94. package/routes/api/transcode-sessions/release/post.js +41 -41
  95. package/routes/api/transcode-sessions/seek/post.js +63 -63
  96. package/routes/health/get.js +13 -13
  97. package/routes/healthz/get.js +13 -13
  98. package/routes/stream/get.js +361 -361
  99. package/routes/transcode/audio-file/get.js +64 -64
  100. package/routes/transcode/audio-warm/get.js +84 -84
  101. package/routes/transcode/session-file/get.js +52 -52
  102. package/routes/transcode/variant-file/get.js +95 -95
  103. package/routes/transcode/variant-warm/get.js +84 -84
  104. package/scripts/render-run-graph.js +173 -173
  105. package/server.js +725 -725
  106. package/services/encode/CoverageMap.js +428 -428
  107. package/services/encode/CushionReport.js +345 -345
  108. package/services/encode/EncodeAdmission.js +376 -332
  109. package/services/encode/EncodeOrchestrator.js +1217 -1217
  110. package/services/encode/EncodePlan.js +1366 -1366
  111. package/services/encode/EncodeRun.js +776 -776
  112. package/services/encode/EncodeRuns.js +1229 -1229
  113. package/services/encode/Encoder.js +142 -142
  114. package/services/encode/EncoderSelection.js +38 -38
  115. package/services/encode/LocalObservations.js +359 -359
  116. package/services/encode/NvencEncoder.js +50 -50
  117. package/services/encode/OutputOpening.js +758 -755
  118. package/services/encode/OutputTimes.js +579 -579
  119. package/services/encode/QsvEncoder.js +58 -58
  120. package/services/encode/Renditions.js +2184 -2162
  121. package/services/encode/RunProgress.js +84 -84
  122. package/services/encode/SegmentDemand.js +95 -95
  123. package/services/encode/SoftwareEncoder.js +121 -121
  124. package/services/encode/V4l2m2mEncoder.js +53 -53
  125. package/services/encode/VaapiEncoder.js +66 -66
  126. package/services/encode/args.js +416 -416
  127. package/services/encode/available-share.js +89 -89
  128. package/services/encode/calibration.js +361 -361
  129. package/services/encode/contention.js +128 -128
  130. package/services/encode/decode-cost-fit.js +363 -363
  131. package/services/encode/encode-exit.js +114 -114
  132. package/services/encode/encode-run-state.js +551 -551
  133. package/services/encode/encoder-readings.js +45 -45
  134. package/services/encode/fingerprint.js +322 -322
  135. package/services/encode/host-load.js +174 -174
  136. package/services/encode/hwaccel.js +1894 -1894
  137. package/services/encode/index.js +9 -9
  138. package/services/encode/learned-median.js +90 -90
  139. package/services/encode/output/EncodedOutput.js +57 -57
  140. package/services/encode/output/Output.js +131 -131
  141. package/services/encode/output/OutputCatalog.js +414 -414
  142. package/services/encode/output/OutputSpec.js +390 -390
  143. package/services/encode/output/Timeline.js +308 -308
  144. package/services/encode/output/cut-grid.js +107 -107
  145. package/services/encode/output/index.js +20 -20
  146. package/services/encode/output/ladder.js +32 -32
  147. package/services/encode/output/playlists.js +284 -284
  148. package/services/encode/output/rates.js +125 -125
  149. package/services/encode/output-key-format.js +21 -21
  150. package/services/encode/quality/EncodeCost.js +1141 -1083
  151. package/services/encode/quality/HostLoad.js +525 -525
  152. package/services/encode/quality/HostTimings.js +249 -249
  153. package/services/encode/quality/OutputQualityState.js +28 -28
  154. package/services/encode/quality/QualityController.js +935 -935
  155. package/services/encode/quality/QualityOffer.js +416 -416
  156. package/services/encode/quality/drain-threat.js +47 -47
  157. package/services/encode/quality/link-budget.js +254 -254
  158. package/services/encode/quality/output-format.js +315 -266
  159. package/services/encode/quality/serving-output.js +216 -216
  160. package/services/encode/quality/visible-rung.js +57 -57
  161. package/services/encode/run-budget.js +97 -97
  162. package/services/encode/run-command.js +747 -747
  163. package/services/encode/run-costs.js +155 -155
  164. package/services/encode/run-inputs.js +42 -42
  165. package/services/encode/segment-formats/fmp4.js +437 -437
  166. package/services/encode/segment-formats/index.js +77 -77
  167. package/services/encode/segment-formats/init-compat.js +324 -324
  168. package/services/encode/segment-formats/mp4-boxes.js +311 -311
  169. package/services/encode/segment-formats/mpegts.js +134 -134
  170. package/services/encode/start-stop-cost.js +178 -178
  171. package/services/encode/throughput.js +97 -97
  172. package/services/encode/torrent-cost.js +88 -88
  173. package/services/identity/installation-id.js +38 -38
  174. package/services/media/ContainerOrchestrator.js +149 -149
  175. package/services/media/KeyframeTables.js +316 -316
  176. package/services/media/SourceFile.js +298 -298
  177. package/services/media/SubtitleCues.js +520 -520
  178. package/services/media/SubtitleOrchestrator.js +167 -167
  179. package/services/media/audio-inventory.js +245 -245
  180. package/services/media/container/AviContainer.js +266 -266
  181. package/services/media/container/Container.js +603 -603
  182. package/services/media/container/ContainerFactory.js +56 -56
  183. package/services/media/container/KeyframeTable.js +272 -272
  184. package/services/media/container/MatroskaContainer.js +1494 -1494
  185. package/services/media/container/Mp4Container.js +1244 -1244
  186. package/services/media/container/SubtitleFileContainer.js +322 -322
  187. package/services/media/container/ebml-reader.js +159 -159
  188. package/services/media/ffmpeg-banner.js +260 -260
  189. package/services/media/keyframe-probe.js +157 -157
  190. package/services/media/media-info-probe.js +93 -93
  191. package/services/media/playback-planner.js +931 -931
  192. package/services/media/tracks/AudioTrack.js +131 -131
  193. package/services/media/tracks/ContainerTrack.js +75 -75
  194. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  195. package/services/media/tracks/SubtitleTrack.js +38 -38
  196. package/services/media/tracks/TextSubtitleTrack.js +287 -287
  197. package/services/media/tracks/VideoTrack.js +33 -33
  198. package/services/media/tracks/index.js +15 -15
  199. package/services/media/tracks/language-detect.js +174 -174
  200. package/services/server/OutputLifecycle.js +418 -418
  201. package/services/server/SegmentServing.js +1146 -1146
  202. package/services/server/ViewerRequests.js +727 -522
  203. package/services/server/WaitLedger.js +142 -142
  204. package/services/server/controllers/PlaybackController.js +40 -40
  205. package/services/server/controllers/SubtitleController.js +109 -109
  206. package/services/server/http-responses.js +60 -60
  207. package/services/server/playback-readiness.js +620 -0
  208. package/services/server/transcode-session-files.js +325 -325
  209. package/services/server/wire-outputs.js +992 -983
  210. package/services/storage/Diagnostics.js +202 -202
  211. package/services/storage/MachineBudget.js +235 -235
  212. package/services/storage/allowance.js +107 -107
  213. package/services/storage/core-dumps.js +106 -106
  214. package/services/storage/files/CompletedFiles.js +391 -391
  215. package/services/storage/files/piece-from-whole-file.js +118 -118
  216. package/services/storage/free.js +71 -71
  217. package/services/storage/keep.js +48 -48
  218. package/services/storage/machine-memory.js +56 -56
  219. package/services/storage/memory-report.js +575 -575
  220. package/services/storage/piece-store/piece-disk-store.js +516 -516
  221. package/services/storage/piece-store/piece-lru.js +495 -495
  222. package/services/storage/piece-store/shared-piece-store.js +1880 -1880
  223. package/services/storage/returns.js +103 -103
  224. package/services/storage/segment-store/SegmentStore.js +1196 -1196
  225. package/services/storage/wire.js +175 -175
  226. package/services/torrent/Contents.js +324 -324
  227. package/services/torrent/demand/DemandRegister.js +202 -202
  228. package/services/torrent/demand/Urgency.js +137 -137
  229. package/services/torrent/demand/Window.js +118 -118
  230. package/services/torrent/demand/index.js +8 -8
  231. package/services/torrent/demand/pieces.js +140 -140
  232. package/services/torrent/download/SwarmSelection.js +386 -386
  233. package/services/torrent/download/registry.js +102 -102
  234. package/services/torrent/download/withdraw-claim.js +80 -80
  235. package/services/torrent/files.js +455 -455
  236. package/services/torrent/naming.js +619 -619
  237. package/services/torrent/piece-store-of.js +29 -29
  238. package/services/torrent/supply-margin.js +262 -262
  239. package/services/torrent/torrent-pool.js +2675 -2675
  240. package/services/torrent/worker/background-fill.js +213 -213
  241. package/services/torrent/worker/channel.js +271 -271
  242. package/services/torrent/worker/client.js +765 -765
  243. package/services/torrent/worker/fastest-wires.js +342 -342
  244. package/services/torrent/worker/handle-state.js +23 -23
  245. package/services/torrent/worker/held-bytes.js +155 -155
  246. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  247. package/services/torrent/worker/piece-reader.js +1078 -1078
  248. package/services/torrent/worker/pool-adapter.js +365 -365
  249. package/services/torrent/worker/protocol.js +184 -184
  250. package/services/torrent/worker/resume-warm.js +107 -107
  251. package/services/torrent/worker/webrtc-shim.js +219 -219
  252. package/services/torrent/worker/worker.js +1129 -1129
  253. package/services/transport/data-channel-handler.js +1369 -1369
  254. package/services/transport/delivery-probe.js +842 -842
  255. package/services/transport/health-collector.js +53 -53
  256. package/services/transport/nat-classifier.js +231 -231
  257. package/services/transport/packet-witness.js +808 -808
  258. package/services/transport/port-mapper.js +235 -235
  259. package/services/transport/registry-api.js +81 -81
  260. package/services/transport/tunnel-client.js +447 -447
  261. package/services/transport/usrsctp-state.js +175 -175
  262. package/services/transport/webrtc-manager.js +484 -484
  263. package/services/viewer/Assignments.js +340 -340
  264. package/services/viewer/PriorityMap.js +390 -390
  265. package/services/viewer/PriorityOrchestrator.js +325 -325
  266. package/services/viewer/Viewer.js +682 -657
  267. package/services/viewer/Viewers.js +368 -368
  268. package/services/viewer/active-output.js +37 -37
  269. package/services/viewer/audio-start.js +46 -46
  270. package/services/viewer/buffer-trend.js +81 -81
  271. package/services/viewer/choices.js +647 -647
  272. package/services/viewer/positions.js +126 -126
  273. package/services/viewer/report-intake.js +46 -46
  274. package/store/source-registry.js +71 -71
  275. package/test/asset-paths.test.js +28 -28
  276. package/test/audio-inventory.test.js +212 -212
  277. package/test/audio-track-bitrate.test.js +40 -40
  278. package/test/auto-quality-step.test.js +707 -707
  279. package/test/available-share.test.js +76 -76
  280. package/test/background-fill.test.js +190 -190
  281. package/test/client-log-file.test.js +110 -110
  282. package/test/completed-files.test.js +115 -115
  283. package/test/concurrent-cost.test.js +148 -148
  284. package/test/container-media-info.test.js +228 -228
  285. package/test/contention.test.js +76 -76
  286. package/test/core-dumps.test.js +57 -57
  287. package/test/coverage-follows-the-disk.test.js +228 -228
  288. package/test/coverage-map.test.js +195 -195
  289. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  290. package/test/cut-times-timeline.test.js +65 -65
  291. package/test/cuts-follow-published-grid.test.js +109 -109
  292. package/test/data-channel-frame.test.js +63 -63
  293. package/test/data-channel-viewer-lifecycle.test.js +92 -92
  294. package/test/dead-torrent-handle.test.js +52 -52
  295. package/test/declared-rates.test.js +116 -116
  296. package/test/declared-tracks.test.js +43 -43
  297. package/test/decode-cost-fit.test.js +202 -202
  298. package/test/decode-cost.test.js +462 -462
  299. package/test/delivery-probe.test.js +393 -393
  300. package/test/demand-register.test.js +206 -206
  301. package/test/dht-bootstrap.test.js +72 -72
  302. package/test/drain-threat.test.js +65 -65
  303. package/test/duplicate-add.test.js +48 -48
  304. package/test/encode-admission.test.js +146 -146
  305. package/test/encode-cost.test.js +283 -283
  306. package/test/encode-exit.test.js +111 -111
  307. package/test/encode-orchestrator.test.js +419 -419
  308. package/test/encode-plan-viewers.test.js +718 -718
  309. package/test/encode-plan.test.js +545 -545
  310. package/test/encode-run-state.test.js +314 -314
  311. package/test/encode-run.test.js +161 -161
  312. package/test/encode-slope.test.js +46 -46
  313. package/test/encoded-output.test.js +39 -39
  314. package/test/encoder-kinds.test.js +122 -122
  315. package/test/encoder-readings.test.js +46 -46
  316. package/test/every-claimant-is-told-its-share.test.js +152 -152
  317. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  318. package/test/failed-start-breaker.test.js +202 -202
  319. package/test/fastest-wires.test.js +143 -143
  320. package/test/ffmpeg-stream-counts.test.js +78 -78
  321. package/test/file-edges.test.js +191 -191
  322. package/test/fmp4-self-contained.test.js +80 -80
  323. package/test/fmp4-timestamps.test.js +140 -140
  324. package/test/fmp4-track-completeness.test.js +41 -41
  325. package/test/format-keyed-outputs.test.js +78 -78
  326. package/test/health-metrics.test.js +38 -38
  327. package/test/held-request-width.test.js +157 -157
  328. package/test/helpers/encode-run.js +136 -136
  329. package/test/helpers/held-file.js +29 -29
  330. package/test/helpers/manager.js +57 -57
  331. package/test/helpers/output-spec.js +63 -63
  332. package/test/host-load.test.js +68 -68
  333. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  334. package/test/init-compat.test.js +219 -219
  335. package/test/input-lost-quiets-the-plan.test.js +261 -261
  336. package/test/input-unavailable.test.js +48 -48
  337. package/test/installation-id.test.js +39 -39
  338. package/test/keeping-period.test.js +83 -83
  339. package/test/keyframe-index-accuracy.test.js +188 -188
  340. package/test/keyframe-table-budget.test.js +102 -102
  341. package/test/keyframes-belong-to-the-file.test.js +249 -249
  342. package/test/learned-median.test.js +37 -37
  343. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  344. package/test/limit-row-by-area.test.js +60 -60
  345. package/test/link-budget.test.js +111 -111
  346. package/test/link-probe.test.js +56 -56
  347. package/test/local-encoding-data.test.js +273 -273
  348. package/test/logger-repeats.test.js +134 -134
  349. package/test/look-ahead-coverage.test.js +56 -56
  350. package/test/manager-surface.test.js +292 -292
  351. package/test/matroska-cues-track.test.js +192 -192
  352. package/test/memory-budget.test.js +390 -390
  353. package/test/move-cost.test.js +216 -216
  354. package/test/mp4-subtitles.test.js +173 -173
  355. package/test/one-authority.test.js +285 -285
  356. package/test/one-budget.test.js +149 -149
  357. package/test/one-output-one-session.test.js +204 -204
  358. package/test/one-resource-divided.test.js +185 -185
  359. package/test/one-serving-output-per-height.test.js +458 -458
  360. package/test/orchestrator-wired.test.js +206 -206
  361. package/test/output-catalog.test.js +39 -39
  362. package/test/output-shape.test.js +21 -21
  363. package/test/output-spec.test.js +251 -251
  364. package/test/output-speed.test.js +88 -88
  365. package/test/outputs-being-prepared.test.js +40 -40
  366. package/test/packet-witness-ring.test.js +236 -236
  367. package/test/packet-witness.test.js +148 -148
  368. package/test/piece-disk-store.test.js +381 -381
  369. package/test/piece-from-whole-file.test.js +129 -129
  370. package/test/piece-lru.test.js +319 -319
  371. package/test/piece-reader.test.js +162 -162
  372. package/test/piece-selection-offset.test.js +85 -85
  373. package/test/piece-store-eviction.test.js +560 -560
  374. package/test/piece-store-never-refuses.test.js +153 -153
  375. package/test/piece-store-reservations.test.js +318 -318
  376. package/test/piece-store-slow-disk.test.js +159 -159
  377. package/test/piece-tail.test.js +97 -97
  378. package/test/plan-host-timings.test.js +68 -68
  379. package/test/plan-is-steady.test.js +225 -225
  380. package/test/playback-readiness.test.js +323 -0
  381. package/test/priority-map-download.test.js +174 -174
  382. package/test/priority-map-emptied.test.js +204 -204
  383. package/test/priority-map-per-output.test.js +215 -215
  384. package/test/priority-map.test.js +163 -163
  385. package/test/probe-wedge-certainty.test.js +60 -60
  386. package/test/produced-copy-choice.test.js +213 -213
  387. package/test/published-timeline.test.js +83 -83
  388. package/test/quality-offer.test.js +162 -162
  389. package/test/quality-variants.test.js +1229 -1229
  390. package/test/rate-control-in-the-output.test.js +180 -180
  391. package/test/read-survives-withdrawal.test.js +164 -164
  392. package/test/read-window.test.js +365 -365
  393. package/test/resume-warm.test.js +39 -39
  394. package/test/run-graph-drift.test.js +37 -37
  395. package/test/run-inputs.test.js +80 -80
  396. package/test/run-intervals.test.js +100 -100
  397. package/test/run-position-follows-published-grid.test.js +89 -89
  398. package/test/run-progress.test.js +65 -65
  399. package/test/same-height-switch.test.js +664 -664
  400. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  401. package/test/seek-landing.test.js +109 -109
  402. package/test/seek-target-not-superseded.test.js +195 -195
  403. package/test/segment-closed-on-both-branches.test.js +96 -96
  404. package/test/segment-cut-times.test.js +63 -63
  405. package/test/segment-demand.test.js +80 -80
  406. package/test/segment-hold-supersede.test.js +91 -91
  407. package/test/segment-judged-by-its-own-header.test.js +221 -221
  408. package/test/segment-serve-wiring.test.js +475 -475
  409. package/test/segment-store-eviction.test.js +247 -247
  410. package/test/segment-store.test.js +323 -323
  411. package/test/segment-true-start.test.js +86 -86
  412. package/test/segments-are-shared.test.js +176 -176
  413. package/test/send-chunk-bytes.test.js +86 -86
  414. package/test/serving-existing-output.test.js +102 -102
  415. package/test/serving-output.test.js +102 -102
  416. package/test/shared-piece-store.test.js +310 -310
  417. package/test/sidecar-naming.test.js +142 -142
  418. package/test/source-file.test.js +133 -133
  419. package/test/source-files-route.test.js +103 -103
  420. package/test/source-registry.test.js +18 -18
  421. package/test/split-a-stretch.test.js +139 -139
  422. package/test/stale-request-after-seek.test.js +158 -158
  423. package/test/startup-readings.test.js +124 -124
  424. package/test/stream-route.test.js +182 -182
  425. package/test/subtitle-cue-framing.test.js +200 -200
  426. package/test/subtitle-cue-source.test.js +102 -102
  427. package/test/subtitle-cue-walk.test.js +370 -370
  428. package/test/subtitle-cursor.test.js +63 -63
  429. package/test/subtitle-defaults.test.js +118 -118
  430. package/test/subtitle-language.test.js +252 -252
  431. package/test/subtitle-track-numbering.test.js +386 -386
  432. package/test/supply-margin.test.js +177 -177
  433. package/test/swarm-follows-readers.test.js +174 -174
  434. package/test/swarm-reach.test.js +130 -130
  435. package/test/swarm-selection.test.js +220 -220
  436. package/test/tail-duplication.test.js +167 -167
  437. package/test/the-channel-has-both-ends.test.js +91 -91
  438. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  439. package/test/thread-pool.test.js +53 -53
  440. package/test/timeline.test.js +84 -84
  441. package/test/torrent-contents.test.js +235 -235
  442. package/test/torrent-cost.test.js +71 -71
  443. package/test/torrent-files.test.js +221 -221
  444. package/test/torrent-naming.test.js +255 -255
  445. package/test/tracks-begin-together.test.js +209 -209
  446. package/test/tunnel-renewal.test.js +167 -167
  447. package/test/two-viewers-one-picture.test.js +407 -407
  448. package/test/upload-hurry.test.js +186 -186
  449. package/test/usrsctp-state.test.js +131 -131
  450. package/test/video-facts.test.js +102 -102
  451. package/test/viewer-assignments.test.js +143 -143
  452. package/test/viewer-outputs.test.js +285 -285
  453. package/test/viewer-presence.test.js +116 -116
  454. package/test/viewer-requests-admission.test.js +89 -89
  455. package/test/viewer-states.test.js +189 -189
  456. package/test/viewer-subtitle-subscription.test.js +96 -96
  457. package/test/viewer.test.js +139 -139
  458. package/test/viewing-generations.test.js +390 -390
  459. package/test/visible-rung.test.js +37 -37
  460. package/test/wait-ledger.test.js +100 -100
  461. package/test/webrtc-shim.test.js +149 -149
  462. package/test/wedge-certainty.test.js +131 -131
  463. package/test/withdraw-piece-claim.test.js +212 -212
  464. package/test/worker-channel.test.js +158 -158
  465. package/utils/client-log-file.js +151 -151
  466. package/utils/logger.js +312 -312
  467. package/utils/parse-range.js +25 -25
  468. package/utils/perf.js +59 -59
  469. package/utils/torrent-source-key.js +38 -38
@@ -1,218 +1,218 @@
1
- # Container & Track architecture
2
-
3
- Domain → Application → Interface, per RFC 9559 (Matroska) and ISO/IEC 14496-12 (MP4).
4
-
5
- ## Two axes, and what is NOT a third
6
-
7
- Everything here is placed on exactly two axes: **which container** a track lives
8
- in, and **what kind of track** it is (video / audio / subtitle). A file lying
9
- beside the video — a dub as `<name>.mka`, subtitles as `<name>.ass` — is not a
10
- third kind of anything:
11
-
12
- - a `.mka` **is** Matroska. `ContainerFactory` sniffs it, `MatroskaContainer`
13
- reads its `TrackEntry` list, and out comes an `AudioTrack` with its language,
14
- title and flags. It differs from the picture's own file only in having no
15
- video track. The same holds for `.m4a` and `Mp4Container`;
16
- - "external" is therefore not a TYPE. It is the answer to WHERE a track's bytes
17
- are, and that is torrent knowledge — which this layer must not have
18
- (`ContainerFactory`: no torrent knowledge; `ContainerOrchestrator`:
19
- transport-agnostic). The pairing of a sidecar file with a picture lives in
20
- `services/sidecar-files.js`, and the numbered list a viewer chooses from lives
21
- in `services/media/audio-inventory.js`. Both are pure and both are application-layer.
22
-
23
- A class called `ExternalSubtitleFile` used to sit in `tracks/` asserting the
24
- opposite. It did not extend `ContainerTrack`, duplicated four of its fields, and
25
- was imported by nothing; it was deleted rather than extended. Nothing replaced
26
- it — a subtitle file beside the video is a `TextSubtitleTrack` whose bytes are
27
- read from another file, and a raw `.srt` needs no `Container` subclass because
28
- it has no track table and no index to read: the whole file is the payload, and
29
- `SubtitleController` already reads it as such.
30
-
31
- ## Who answers what — the rule
32
-
33
- A fact the container DECLARES is read from the container. A fact only the media
34
- itself has is measured from the media, which means ffmpeg.
35
-
36
- That is the whole boundary, and it is not about speed. Speed is a consequence:
37
- this layer asks for the smallest region that holds the answer — 64 KB of header,
38
- the Cues block, a sample table — while ffmpeg cannot be asked for a bounded
39
- region at all. Its input analysis pulls megabytes before it will say anything,
40
- and over a torrent those megabytes may not exist yet. Measured 2026-09-03 on one
41
- `.mka`: this layer read its header in **8 ms**, and an ffmpeg reading the same
42
- header of the same file through the proxy's own `/stream`, in the same second,
43
- took **8121 ms** — and spent all of it waiting for a DURATION its caller did not
44
- want, because its early exit is gated on one.
45
-
46
- So ffmpeg keeps exactly three jobs, and nothing else:
47
-
48
- 1. producing media — the encode run;
49
- 2. measuring THIS MACHINE — encoder detection and its strict test, decode
50
- calibration, the contention penalty;
51
- 3. answering what the container does not declare — above all keyframe positions
52
- in a container with no index, where a packet scan is the only source. Even
53
- there the container is asked FIRST: measured, the container index gave 570
54
- keyframes in 0.8 s from two point reads of 16 KB, while a scan of the same
55
- file found 77 in 45 s and did not finish.
56
-
57
- `null` in `ContainerMediaInfo` means the container does not declare the field.
58
- That is a final answer about the container, and the point at which a caller may
59
- go to the media — not "unknown, ask again".
60
-
61
- ## Where byte access lives, and why not on a track
62
-
63
- A `ContainerTrack` is a DECLARATION. It carries no `readRange` and no file
64
- identity, and it should not: byte access is the `Container`'s, injected as
65
- `readRange(start, end)` and bound to one file.
66
-
67
- The obvious-looking improvement — hand the track a reader so it can fetch its own
68
- bytes — was reviewed on 2026-09-03 and is **not** the right shape:
69
-
70
- - for video and audio, this layer never reads the payload at all. It goes to
71
- ffmpeg by URL, where seeking and gigabytes belong. A `readRange` on a
72
- `VideoTrack` would be a capability with no consumer, inviting reads of a size
73
- this path is not built for;
74
- - tracks cross the worker boundary as PLAIN OBJECTS (`plainTrack()`), because a
75
- class instance does not survive it as a class. A back-reference to a container
76
- cannot cross either, so such a track would be able to read its own bytes only
77
- on the thread where the container is already at hand.
78
-
79
- **That split is closed.** `SubtitleTrack` carries `clusterPositions` and
80
- `samples` — byte POSITIONS — and the reading of those positions is now the
81
- container's: `MatroskaContainer.walkHeldClusters(plan, walked)` and
82
- `Mp4Container.readHeldSamples(track, harvested)`, beside `readTracks`,
83
- `readKeyframeIndex`, `readMediaInfo` and `cueTextOf`.
84
-
85
- The obstacle was real and this is how it was answered. The two readers want
86
- different read POLICIES over the same file: the track table fetches what is
87
- missing from the swarm, while the cue walk deliberately reads only what is
88
- already downloaded, so that turning subtitles on never pulls bytes the viewer is
89
- not waiting for. A container is now built with BOTH — `readRange` that fetches,
90
- `readHeld` that does not, and `isHeld` that says whether a range can be read
91
- without fetching — so one instance per file serves both readers and the per-file
92
- cache is kept.
93
-
94
- What the container is NOT given is the torrent. Those three functions are the
95
- whole of what the caller knows and the container does not, and reducing the
96
- torrent to them is what lets the reading live where the format is specified.
97
- `torrent-worker/subtitle-cues.js` supplies them (`containerOver`) and keeps only
98
- what is genuinely its own: the found-order cursor a browser follows, the
99
- per-file state, and one walk of a file at a time.
100
-
101
- ## Layers
102
-
103
- ```mermaid
104
- flowchart TB
105
- subgraph Domain
106
- C[Container<br/>abstract<br/>RFC9559 / 14496-12]
107
- MC[MatroskaContainer]
108
- MpC[Mp4Container]
109
- AC[AviContainer]
110
- CT[ContainerTrack<br/>isEnabled/isDefault/language]
111
- VT[VideoTrack]
112
- AT[AudioTrack]
113
- ST[SubtitleTrack]
114
- TST[TextSubtitleTrack<br/>S_TEXT/UTF8 tx3g wvtt]
115
- IST[ImageSubtitleTrack<br/>PGS VobSub subp]
116
- C --> MC & MpC & AC
117
- CT --> VT & AT & ST
118
- ST --> TST & IST
119
- MC & MpC & AC -- readTracks --> CT
120
- end
121
- subgraph Application
122
- CF[ContainerFactory<br/>detect 16 bytes]
123
- KT[KeyframeTables<br/>one read per file, bounded wait]
124
- CO[ContainerOrchestrator<br/>cache + getTracks/getKeyframeIndex]
125
- SO[SubtitleOrchestrator<br/>cursor + per-file state]
126
- SF[sidecar-files.js<br/>which file goes with which]
127
- AI[audio-inventory.js<br/>one flat numbering]
128
- CF --> CO
129
- CO --> KT
130
- CO --> SO
131
- SF --> AI
132
- CO --> AI
133
- end
134
- subgraph Interface
135
- PC[PlaybackController]
136
- SC[SubtitleController]
137
- R1[routes/api/playback-plan]
138
- R2[routes/api/subtitles]
139
- PC --> R1
140
- SC --> R2
141
- CO --> PC
142
- SO --> SC
143
- end
144
- ```
145
-
146
- ## Class responsibilities (spec-grounded)
147
-
148
- | Class | Spec section | Fields | Not responsible |
149
- |---|---|---|---|
150
- | `ContainerTrack` | RFC9559 TrackEntry common + ISO 14496-12 tkhd/mdhd/hdlr/elng | `trackNumber`, `declaredIndex`, `codecId`, `language`/`languageBcp47` (MUST rule), `name`, `isEnabled` (0xB9 / track_enabled), `isDefault`+`declaresDefault` (0x88) | Type-specific flags |
151
- | `VideoTrack` | RFC9559 Video, ISO 14496-12 tkhd width/height, stsd | `width/height/display*`, `fps`, `isHdr`, `bitDepth` | Subtitle flags |
152
- | `AudioTrack` | RFC9559 FlagOriginal 0x55AE, FlagCommentary 0x55AF, FlagVisualImpaired 0x55AC | `isOriginal/isCommentary/isVisualImpaired`, `channels/samplingFrequency` | FlagForced |
153
- | `SubtitleTrack` | RFC9559 FlagForced 0x55AA (subtitle-only), FlagHearingImpaired 0x55AB | `isForced/isHearingImpaired`, `clusterPositions`/`samples` | Video dims |
154
- | `TextSubtitleTrack` | `S_TEXT/UTF8, S_TEXT/ASS, tx3g, wvtt` | `toVtt()` convertible | Image tracks |
155
- | `sidecar-files.js` | — (torrent naming) | which files of a torrent are one picture's sound and subtitles | what is inside them |
156
- | `audio-inventory.js` | RFC9559 audio flags, merged against ffmpeg's numbering | one flat number per soundtrack → `(fileIndex, 0:a:N)` | display labels |
157
- | `ImageSubtitleTrack` | `S_HDMV/PGS, S_VOBSUB, subp, clcp` | kept for `declaredIndex` alignment | Conversion |
158
- | `MatroskaContainer` | RFC9559 SeekHead, Tracks, Cues, Clusters | single Tracks walk for all types, EBML via `ebml-reader.js` | HTTP |
159
- | `Mp4Container` | ISO 14496-12 moov/trak/tkhd/mdhd/hdlr/elng/stbl | `alternate_group` grouping, packed language, `tx3g` forced bits | Torrent |
160
- | `AviContainer` | RIFF AVI idx1 | `AVIIF_KEYFRAME` keyframe times | Tracks beyond video |
161
-
162
- `VideoTrack` never carries `isForced` — spec states FlagForced "Applies only to subtitles". Placing it in base would pollute video with irrelevant state.
163
-
164
- ## Orchestrators & Controllers
165
-
166
- - `ContainerFactory.create({readRange,fileSize})` — sniffs 16 bytes, returns precise `Container` subclass. No torrent knowledge.
167
- - `ContainerOrchestrator` — per-file cache (`sourceKey:fileIndex`), `getTracks()` / `getMediaInfo()` / `getKeyframeIndex()`. Transport-agnostic.
168
- - **The keyframe table is read once per file, and the container is not what remembers it.** `Container.readKeyframeIndex` parses and returns; each format implements `parseKeyframeIndex`. It used to keep the answer, and that made this the one fact stored in two places — here and in the file's `KeyframeTable` on the main thread. That copy had no reader, and since the parse itself moved to the main thread there is no second thread for a second copy to sit in.
169
- - **`KeyframeTable` / `KeyframeTables` — the answer, and the policy around getting one.** The table is one object per file (`media/container/KeyframeTable.js`), held by everyone who reads that file rather than copied, so a read that lands after a session was made still reaches it. `media/KeyframeTables.js` reads it once per file whoever asks, joins the second asker to the read already running, bounds how long any one caller waits (`KEYFRAME_TABLE_BUDGET_MS`, measured), and never records a read that threw as an answer. Its reader is one function handed in at construction, so it knows nothing of torrents or HTTP. It is not `ContainerOrchestrator` because of the THREAD: that one needs byte ranges and lives in the worker, this one lives beside the sessions and reaches it across the channel.
170
- - **`answered` and `readable` are different questions.** `answered` says a reader came back; `readable` says it came back with times. A file that answered nothing must be re-encoded for ever (MPEG-TS: 669 real keyframes, no index of any kind); a file that has not answered is a shortage of bytes off the swarm. Held as loose fields in a bag of probe results nothing told them apart, and a passing shortage was written onto the file as a property of the bytes.
171
- - **The second reader is the packet probe** (`media/keyframe-probe.js`): it finds keyframes by decoding, for containers that state no index. It is never waited for, and `KeyframeTable.learn` keeps the fuller answer whichever arrives second — measured 2026-08-02, a scan found 77 keyframes in 45 s without finishing against all 570 in 0.8 s from the index.
172
- - `SubtitleOrchestrator` — wraps `torrent-worker/subtitle-cues.js` (`planFor`, `cuesHeldFor`, `warmSubtitleCues`) behind the `ContainerTrack` abstraction. Routes depend on this, not on the worker directly. The reading itself is the containers' — that module supplies the torrent's read policy and keeps the cursor.
173
- - `PlaybackController` / `SubtitleController` — thin interface adapters; `routes/api/*` delegate to them, handle HTTP headers (`X-Subtitle-Language`, `X-Subtitle-Cursor`) only.
174
-
175
- ## Legacy
176
-
177
- Everything a container states about ITSELF is in its own class: the track table,
178
- the Cues, the keyframe times they name, the cluster positions, the blocks inside
179
- a cluster, the MP4 sample table. `services/container-index/` no longer exists.
180
- What was kept apart is `container/ebml-reader.js` — EBML element walking is the
181
- format's grammar rather than any of its statements.
182
-
183
- `ContainerFactory` is the one place that decides what a file IS. It sniffs the
184
- header, because that is what the muxer wrote while a name is what somebody
185
- typed, and it answers `readKeyframeIndex` for the same reason: doing it anywhere
186
- else meant a third place making that decision. `ContainerFactory.byName` exists
187
- for the one path that cannot sniff — the cue walk asks the swarm for nothing, so
188
- a file whose head is not downloaded has only its name.
189
-
190
- **Two readings of one file, and which answers.** ffmpeg's `-i` banner and the
191
- container's own table both describe a file's tracks, and the rule is stated once
192
- per media kind on `Container`. `alignWithBanner` lines them up by position and
193
- CHECKS each pair on language or title; one pair agreeing on neither, or a length
194
- that differs, drops the container reading whole, because a wrong flag is worse
195
- than a missing one. `mergeSubtitleFlags`, `mergeAudioFlags` and
196
- `mergeVideoFacts` then say which side answers for which field: flags the banner
197
- cannot express come from the container; the coded size and frame rate come from
198
- the probe, because the encoder receives what the decoder produced.
199
-
200
- Direct imports from routes are deprecated — use `orchestrators/` and
201
- `server/controllers/` instead.
202
-
203
- ## Flags matrix
204
-
205
- | Flag | Matroska ID | Applies to | Base or subclass |
206
- |---|---|---|---|
207
- | `FlagEnabled` | 0xB9 default 1 | all | `ContainerTrack` |
208
- | `FlagDefault` | 0x88 default 1 | all | `ContainerTrack` (`declaresDefault`) |
209
- | `Language` | 0x22B59C | all | `ContainerTrack` |
210
- | `LanguageBCP47` | 0x22B59D MUST | all | `ContainerTrack` |
211
- | `FlagForced` | 0x55AA | subtitle only | `SubtitleTrack` |
212
- | `FlagHearingImpaired` | 0x55AB | subtitle | `SubtitleTrack` |
213
- | `FlagVisualImpaired` | 0x55AC | audio (descriptive) + subtitle | `AudioTrack`/`SubtitleTrack` |
214
- | `FlagOriginal` | 0x55AE | audio | `AudioTrack` |
215
- | `FlagCommentary` | 0x55AF | audio | `AudioTrack` |
216
- | `track_enabled` | tkhd 0x000001 | all | `ContainerTrack` |
217
- | `alternate_group` | tkhd | audio/video alternates | `ContainerTrack.alternateGroup` |
218
- | `elng` | 14496-12 §8.4.6 | all | `ContainerTrack.languageBcp47` |
1
+ # Container & Track architecture
2
+
3
+ Domain → Application → Interface, per RFC 9559 (Matroska) and ISO/IEC 14496-12 (MP4).
4
+
5
+ ## Two axes, and what is NOT a third
6
+
7
+ Everything here is placed on exactly two axes: **which container** a track lives
8
+ in, and **what kind of track** it is (video / audio / subtitle). A file lying
9
+ beside the video — a dub as `<name>.mka`, subtitles as `<name>.ass` — is not a
10
+ third kind of anything:
11
+
12
+ - a `.mka` **is** Matroska. `ContainerFactory` sniffs it, `MatroskaContainer`
13
+ reads its `TrackEntry` list, and out comes an `AudioTrack` with its language,
14
+ title and flags. It differs from the picture's own file only in having no
15
+ video track. The same holds for `.m4a` and `Mp4Container`;
16
+ - "external" is therefore not a TYPE. It is the answer to WHERE a track's bytes
17
+ are, and that is torrent knowledge — which this layer must not have
18
+ (`ContainerFactory`: no torrent knowledge; `ContainerOrchestrator`:
19
+ transport-agnostic). The pairing of a sidecar file with a picture lives in
20
+ `services/sidecar-files.js`, and the numbered list a viewer chooses from lives
21
+ in `services/media/audio-inventory.js`. Both are pure and both are application-layer.
22
+
23
+ A class called `ExternalSubtitleFile` used to sit in `tracks/` asserting the
24
+ opposite. It did not extend `ContainerTrack`, duplicated four of its fields, and
25
+ was imported by nothing; it was deleted rather than extended. Nothing replaced
26
+ it — a subtitle file beside the video is a `TextSubtitleTrack` whose bytes are
27
+ read from another file, and a raw `.srt` needs no `Container` subclass because
28
+ it has no track table and no index to read: the whole file is the payload, and
29
+ `SubtitleController` already reads it as such.
30
+
31
+ ## Who answers what — the rule
32
+
33
+ A fact the container DECLARES is read from the container. A fact only the media
34
+ itself has is measured from the media, which means ffmpeg.
35
+
36
+ That is the whole boundary, and it is not about speed. Speed is a consequence:
37
+ this layer asks for the smallest region that holds the answer — 64 KB of header,
38
+ the Cues block, a sample table — while ffmpeg cannot be asked for a bounded
39
+ region at all. Its input analysis pulls megabytes before it will say anything,
40
+ and over a torrent those megabytes may not exist yet. Measured 2026-09-03 on one
41
+ `.mka`: this layer read its header in **8 ms**, and an ffmpeg reading the same
42
+ header of the same file through the proxy's own `/stream`, in the same second,
43
+ took **8121 ms** — and spent all of it waiting for a DURATION its caller did not
44
+ want, because its early exit is gated on one.
45
+
46
+ So ffmpeg keeps exactly three jobs, and nothing else:
47
+
48
+ 1. producing media — the encode run;
49
+ 2. measuring THIS MACHINE — encoder detection and its strict test, decode
50
+ calibration, the contention penalty;
51
+ 3. answering what the container does not declare — above all keyframe positions
52
+ in a container with no index, where a packet scan is the only source. Even
53
+ there the container is asked FIRST: measured, the container index gave 570
54
+ keyframes in 0.8 s from two point reads of 16 KB, while a scan of the same
55
+ file found 77 in 45 s and did not finish.
56
+
57
+ `null` in `ContainerMediaInfo` means the container does not declare the field.
58
+ That is a final answer about the container, and the point at which a caller may
59
+ go to the media — not "unknown, ask again".
60
+
61
+ ## Where byte access lives, and why not on a track
62
+
63
+ A `ContainerTrack` is a DECLARATION. It carries no `readRange` and no file
64
+ identity, and it should not: byte access is the `Container`'s, injected as
65
+ `readRange(start, end)` and bound to one file.
66
+
67
+ The obvious-looking improvement — hand the track a reader so it can fetch its own
68
+ bytes — was reviewed on 2026-09-03 and is **not** the right shape:
69
+
70
+ - for video and audio, this layer never reads the payload at all. It goes to
71
+ ffmpeg by URL, where seeking and gigabytes belong. A `readRange` on a
72
+ `VideoTrack` would be a capability with no consumer, inviting reads of a size
73
+ this path is not built for;
74
+ - tracks cross the worker boundary as PLAIN OBJECTS (`plainTrack()`), because a
75
+ class instance does not survive it as a class. A back-reference to a container
76
+ cannot cross either, so such a track would be able to read its own bytes only
77
+ on the thread where the container is already at hand.
78
+
79
+ **That split is closed.** `SubtitleTrack` carries `clusterPositions` and
80
+ `samples` — byte POSITIONS — and the reading of those positions is now the
81
+ container's: `MatroskaContainer.walkHeldClusters(plan, walked)` and
82
+ `Mp4Container.readHeldSamples(track, harvested)`, beside `readTracks`,
83
+ `readKeyframeIndex`, `readMediaInfo` and `cueTextOf`.
84
+
85
+ The obstacle was real and this is how it was answered. The two readers want
86
+ different read POLICIES over the same file: the track table fetches what is
87
+ missing from the swarm, while the cue walk deliberately reads only what is
88
+ already downloaded, so that turning subtitles on never pulls bytes the viewer is
89
+ not waiting for. A container is now built with BOTH — `readRange` that fetches,
90
+ `readHeld` that does not, and `isHeld` that says whether a range can be read
91
+ without fetching — so one instance per file serves both readers and the per-file
92
+ cache is kept.
93
+
94
+ What the container is NOT given is the torrent. Those three functions are the
95
+ whole of what the caller knows and the container does not, and reducing the
96
+ torrent to them is what lets the reading live where the format is specified.
97
+ `torrent-worker/subtitle-cues.js` supplies them (`containerOver`) and keeps only
98
+ what is genuinely its own: the found-order cursor a browser follows, the
99
+ per-file state, and one walk of a file at a time.
100
+
101
+ ## Layers
102
+
103
+ ```mermaid
104
+ flowchart TB
105
+ subgraph Domain
106
+ C[Container<br/>abstract<br/>RFC9559 / 14496-12]
107
+ MC[MatroskaContainer]
108
+ MpC[Mp4Container]
109
+ AC[AviContainer]
110
+ CT[ContainerTrack<br/>isEnabled/isDefault/language]
111
+ VT[VideoTrack]
112
+ AT[AudioTrack]
113
+ ST[SubtitleTrack]
114
+ TST[TextSubtitleTrack<br/>S_TEXT/UTF8 tx3g wvtt]
115
+ IST[ImageSubtitleTrack<br/>PGS VobSub subp]
116
+ C --> MC & MpC & AC
117
+ CT --> VT & AT & ST
118
+ ST --> TST & IST
119
+ MC & MpC & AC -- readTracks --> CT
120
+ end
121
+ subgraph Application
122
+ CF[ContainerFactory<br/>detect 16 bytes]
123
+ KT[KeyframeTables<br/>one read per file, bounded wait]
124
+ CO[ContainerOrchestrator<br/>cache + getTracks/getKeyframeIndex]
125
+ SO[SubtitleOrchestrator<br/>cursor + per-file state]
126
+ SF[sidecar-files.js<br/>which file goes with which]
127
+ AI[audio-inventory.js<br/>one flat numbering]
128
+ CF --> CO
129
+ CO --> KT
130
+ CO --> SO
131
+ SF --> AI
132
+ CO --> AI
133
+ end
134
+ subgraph Interface
135
+ PC[PlaybackController]
136
+ SC[SubtitleController]
137
+ R1[routes/api/playback-plan]
138
+ R2[routes/api/subtitles]
139
+ PC --> R1
140
+ SC --> R2
141
+ CO --> PC
142
+ SO --> SC
143
+ end
144
+ ```
145
+
146
+ ## Class responsibilities (spec-grounded)
147
+
148
+ | Class | Spec section | Fields | Not responsible |
149
+ |---|---|---|---|
150
+ | `ContainerTrack` | RFC9559 TrackEntry common + ISO 14496-12 tkhd/mdhd/hdlr/elng | `trackNumber`, `declaredIndex`, `codecId`, `language`/`languageBcp47` (MUST rule), `name`, `isEnabled` (0xB9 / track_enabled), `isDefault`+`declaresDefault` (0x88) | Type-specific flags |
151
+ | `VideoTrack` | RFC9559 Video, ISO 14496-12 tkhd width/height, stsd | `width/height/display*`, `fps`, `isHdr`, `bitDepth` | Subtitle flags |
152
+ | `AudioTrack` | RFC9559 FlagOriginal 0x55AE, FlagCommentary 0x55AF, FlagVisualImpaired 0x55AC | `isOriginal/isCommentary/isVisualImpaired`, `channels/samplingFrequency` | FlagForced |
153
+ | `SubtitleTrack` | RFC9559 FlagForced 0x55AA (subtitle-only), FlagHearingImpaired 0x55AB | `isForced/isHearingImpaired`, `clusterPositions`/`samples` | Video dims |
154
+ | `TextSubtitleTrack` | `S_TEXT/UTF8, S_TEXT/ASS, tx3g, wvtt` | `toVtt()` convertible | Image tracks |
155
+ | `sidecar-files.js` | — (torrent naming) | which files of a torrent are one picture's sound and subtitles | what is inside them |
156
+ | `audio-inventory.js` | RFC9559 audio flags, merged against ffmpeg's numbering | one flat number per soundtrack → `(fileIndex, 0:a:N)` | display labels |
157
+ | `ImageSubtitleTrack` | `S_HDMV/PGS, S_VOBSUB, subp, clcp` | kept for `declaredIndex` alignment | Conversion |
158
+ | `MatroskaContainer` | RFC9559 SeekHead, Tracks, Cues, Clusters | single Tracks walk for all types, EBML via `ebml-reader.js` | HTTP |
159
+ | `Mp4Container` | ISO 14496-12 moov/trak/tkhd/mdhd/hdlr/elng/stbl | `alternate_group` grouping, packed language, `tx3g` forced bits | Torrent |
160
+ | `AviContainer` | RIFF AVI idx1 | `AVIIF_KEYFRAME` keyframe times | Tracks beyond video |
161
+
162
+ `VideoTrack` never carries `isForced` — spec states FlagForced "Applies only to subtitles". Placing it in base would pollute video with irrelevant state.
163
+
164
+ ## Orchestrators & Controllers
165
+
166
+ - `ContainerFactory.create({readRange,fileSize})` — sniffs 16 bytes, returns precise `Container` subclass. No torrent knowledge.
167
+ - `ContainerOrchestrator` — per-file cache (`sourceKey:fileIndex`), `getTracks()` / `getMediaInfo()` / `getKeyframeIndex()`. Transport-agnostic.
168
+ - **The keyframe table is read once per file, and the container is not what remembers it.** `Container.readKeyframeIndex` parses and returns; each format implements `parseKeyframeIndex`. It used to keep the answer, and that made this the one fact stored in two places — here and in the file's `KeyframeTable` on the main thread. That copy had no reader, and since the parse itself moved to the main thread there is no second thread for a second copy to sit in.
169
+ - **`KeyframeTable` / `KeyframeTables` — the answer, and the policy around getting one.** The table is one object per file (`media/container/KeyframeTable.js`), held by everyone who reads that file rather than copied, so a read that lands after a session was made still reaches it. `media/KeyframeTables.js` reads it once per file whoever asks, joins the second asker to the read already running, bounds how long any one caller waits (`KEYFRAME_TABLE_BUDGET_MS`, measured), and never records a read that threw as an answer. Its reader is one function handed in at construction, so it knows nothing of torrents or HTTP. It is not `ContainerOrchestrator` because of the THREAD: that one needs byte ranges and lives in the worker, this one lives beside the sessions and reaches it across the channel.
170
+ - **`answered` and `readable` are different questions.** `answered` says a reader came back; `readable` says it came back with times. A file that answered nothing must be re-encoded for ever (MPEG-TS: 669 real keyframes, no index of any kind); a file that has not answered is a shortage of bytes off the swarm. Held as loose fields in a bag of probe results nothing told them apart, and a passing shortage was written onto the file as a property of the bytes.
171
+ - **The second reader is the packet probe** (`media/keyframe-probe.js`): it finds keyframes by decoding, for containers that state no index. It is never waited for, and `KeyframeTable.learn` keeps the fuller answer whichever arrives second — measured 2026-08-02, a scan found 77 keyframes in 45 s without finishing against all 570 in 0.8 s from the index.
172
+ - `SubtitleOrchestrator` — wraps `torrent-worker/subtitle-cues.js` (`planFor`, `cuesHeldFor`, `warmSubtitleCues`) behind the `ContainerTrack` abstraction. Routes depend on this, not on the worker directly. The reading itself is the containers' — that module supplies the torrent's read policy and keeps the cursor.
173
+ - `PlaybackController` / `SubtitleController` — thin interface adapters; `routes/api/*` delegate to them, handle HTTP headers (`X-Subtitle-Language`, `X-Subtitle-Cursor`) only.
174
+
175
+ ## Legacy
176
+
177
+ Everything a container states about ITSELF is in its own class: the track table,
178
+ the Cues, the keyframe times they name, the cluster positions, the blocks inside
179
+ a cluster, the MP4 sample table. `services/container-index/` no longer exists.
180
+ What was kept apart is `container/ebml-reader.js` — EBML element walking is the
181
+ format's grammar rather than any of its statements.
182
+
183
+ `ContainerFactory` is the one place that decides what a file IS. It sniffs the
184
+ header, because that is what the muxer wrote while a name is what somebody
185
+ typed, and it answers `readKeyframeIndex` for the same reason: doing it anywhere
186
+ else meant a third place making that decision. `ContainerFactory.byName` exists
187
+ for the one path that cannot sniff — the cue walk asks the swarm for nothing, so
188
+ a file whose head is not downloaded has only its name.
189
+
190
+ **Two readings of one file, and which answers.** ffmpeg's `-i` banner and the
191
+ container's own table both describe a file's tracks, and the rule is stated once
192
+ per media kind on `Container`. `alignWithBanner` lines them up by position and
193
+ CHECKS each pair on language or title; one pair agreeing on neither, or a length
194
+ that differs, drops the container reading whole, because a wrong flag is worse
195
+ than a missing one. `mergeSubtitleFlags`, `mergeAudioFlags` and
196
+ `mergeVideoFacts` then say which side answers for which field: flags the banner
197
+ cannot express come from the container; the coded size and frame rate come from
198
+ the probe, because the encoder receives what the decoder produced.
199
+
200
+ Direct imports from routes are deprecated — use `orchestrators/` and
201
+ `server/controllers/` instead.
202
+
203
+ ## Flags matrix
204
+
205
+ | Flag | Matroska ID | Applies to | Base or subclass |
206
+ |---|---|---|---|
207
+ | `FlagEnabled` | 0xB9 default 1 | all | `ContainerTrack` |
208
+ | `FlagDefault` | 0x88 default 1 | all | `ContainerTrack` (`declaresDefault`) |
209
+ | `Language` | 0x22B59C | all | `ContainerTrack` |
210
+ | `LanguageBCP47` | 0x22B59D MUST | all | `ContainerTrack` |
211
+ | `FlagForced` | 0x55AA | subtitle only | `SubtitleTrack` |
212
+ | `FlagHearingImpaired` | 0x55AB | subtitle | `SubtitleTrack` |
213
+ | `FlagVisualImpaired` | 0x55AC | audio (descriptive) + subtitle | `AudioTrack`/`SubtitleTrack` |
214
+ | `FlagOriginal` | 0x55AE | audio | `AudioTrack` |
215
+ | `FlagCommentary` | 0x55AF | audio | `AudioTrack` |
216
+ | `track_enabled` | tkhd 0x000001 | all | `ContainerTrack` |
217
+ | `alternate_group` | tkhd | audio/video alternates | `ContainerTrack.alternateGroup` |
218
+ | `elng` | 14496-12 §8.4.6 | all | `ContainerTrack.languageBcp47` |