@torrent-tv/proxy 2.87.4 → 2.87.6

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 (460) 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 +8 -0
  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 +94 -94
  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 +1 -1
  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/subtitles/get.js +230 -230
  89. package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
  90. package/routes/api/transcode-sessions/net-report/post.js +129 -129
  91. package/routes/api/transcode-sessions/post.js +160 -160
  92. package/routes/api/transcode-sessions/progress/get.js +27 -27
  93. package/routes/api/transcode-sessions/release/post.js +41 -41
  94. package/routes/api/transcode-sessions/seek/post.js +63 -63
  95. package/routes/health/get.js +13 -13
  96. package/routes/healthz/get.js +13 -13
  97. package/routes/stream/get.js +361 -361
  98. package/routes/transcode/audio-file/get.js +64 -64
  99. package/routes/transcode/audio-warm/get.js +84 -84
  100. package/routes/transcode/session-file/get.js +52 -52
  101. package/routes/transcode/variant-file/get.js +95 -95
  102. package/routes/transcode/variant-warm/get.js +84 -84
  103. package/scripts/render-run-graph.js +173 -173
  104. package/services/encode/CoverageMap.js +428 -428
  105. package/services/encode/CushionReport.js +345 -345
  106. package/services/encode/EncodeAdmission.js +332 -332
  107. package/services/encode/EncodeOrchestrator.js +1217 -1217
  108. package/services/encode/EncodePlan.js +1366 -1366
  109. package/services/encode/EncodeRun.js +776 -776
  110. package/services/encode/EncodeRuns.js +1229 -1229
  111. package/services/encode/Encoder.js +142 -142
  112. package/services/encode/EncoderSelection.js +38 -38
  113. package/services/encode/LocalObservations.js +359 -359
  114. package/services/encode/NvencEncoder.js +50 -50
  115. package/services/encode/OutputOpening.js +755 -755
  116. package/services/encode/OutputTimes.js +579 -579
  117. package/services/encode/QsvEncoder.js +58 -58
  118. package/services/encode/Renditions.js +2162 -2162
  119. package/services/encode/RunProgress.js +84 -84
  120. package/services/encode/SegmentDemand.js +95 -95
  121. package/services/encode/SoftwareEncoder.js +121 -121
  122. package/services/encode/V4l2m2mEncoder.js +53 -53
  123. package/services/encode/VaapiEncoder.js +66 -66
  124. package/services/encode/args.js +416 -416
  125. package/services/encode/available-share.js +89 -89
  126. package/services/encode/calibration.js +361 -361
  127. package/services/encode/contention.js +128 -128
  128. package/services/encode/decode-cost-fit.js +363 -363
  129. package/services/encode/encode-exit.js +114 -114
  130. package/services/encode/encode-run-state.js +551 -551
  131. package/services/encode/encoder-readings.js +45 -45
  132. package/services/encode/fingerprint.js +322 -322
  133. package/services/encode/host-load.js +174 -174
  134. package/services/encode/hwaccel.js +1894 -1894
  135. package/services/encode/index.js +9 -9
  136. package/services/encode/learned-median.js +90 -90
  137. package/services/encode/output/EncodedOutput.js +57 -57
  138. package/services/encode/output/Output.js +131 -131
  139. package/services/encode/output/OutputCatalog.js +414 -414
  140. package/services/encode/output/OutputSpec.js +390 -390
  141. package/services/encode/output/Timeline.js +308 -308
  142. package/services/encode/output/cut-grid.js +107 -107
  143. package/services/encode/output/index.js +20 -20
  144. package/services/encode/output/ladder.js +32 -32
  145. package/services/encode/output/playlists.js +284 -284
  146. package/services/encode/output/rates.js +125 -125
  147. package/services/encode/output-key-format.js +21 -21
  148. package/services/encode/quality/EncodeCost.js +1083 -1083
  149. package/services/encode/quality/HostLoad.js +525 -525
  150. package/services/encode/quality/HostTimings.js +249 -249
  151. package/services/encode/quality/OutputQualityState.js +28 -28
  152. package/services/encode/quality/QualityController.js +935 -935
  153. package/services/encode/quality/QualityOffer.js +416 -416
  154. package/services/encode/quality/drain-threat.js +47 -47
  155. package/services/encode/quality/link-budget.js +254 -254
  156. package/services/encode/quality/output-format.js +266 -266
  157. package/services/encode/quality/serving-output.js +216 -216
  158. package/services/encode/quality/visible-rung.js +57 -57
  159. package/services/encode/run-budget.js +97 -97
  160. package/services/encode/run-command.js +747 -747
  161. package/services/encode/run-costs.js +155 -155
  162. package/services/encode/run-inputs.js +42 -42
  163. package/services/encode/segment-formats/fmp4.js +437 -437
  164. package/services/encode/segment-formats/index.js +77 -77
  165. package/services/encode/segment-formats/init-compat.js +324 -324
  166. package/services/encode/segment-formats/mp4-boxes.js +311 -311
  167. package/services/encode/segment-formats/mpegts.js +134 -134
  168. package/services/encode/start-stop-cost.js +178 -178
  169. package/services/encode/throughput.js +97 -97
  170. package/services/encode/torrent-cost.js +88 -88
  171. package/services/identity/installation-id.js +38 -38
  172. package/services/media/ContainerOrchestrator.js +149 -149
  173. package/services/media/KeyframeTables.js +316 -316
  174. package/services/media/SourceFile.js +298 -298
  175. package/services/media/SubtitleCues.js +520 -520
  176. package/services/media/SubtitleOrchestrator.js +167 -167
  177. package/services/media/audio-inventory.js +212 -212
  178. package/services/media/container/AviContainer.js +266 -266
  179. package/services/media/container/Container.js +603 -603
  180. package/services/media/container/ContainerFactory.js +56 -56
  181. package/services/media/container/KeyframeTable.js +272 -272
  182. package/services/media/container/MatroskaContainer.js +1494 -1494
  183. package/services/media/container/Mp4Container.js +1244 -1244
  184. package/services/media/container/SubtitleFileContainer.js +322 -322
  185. package/services/media/container/ebml-reader.js +159 -159
  186. package/services/media/ffmpeg-banner.js +260 -260
  187. package/services/media/keyframe-probe.js +157 -157
  188. package/services/media/media-info-probe.js +93 -93
  189. package/services/media/tracks/AudioTrack.js +131 -131
  190. package/services/media/tracks/ContainerTrack.js +75 -75
  191. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  192. package/services/media/tracks/SubtitleTrack.js +38 -38
  193. package/services/media/tracks/TextSubtitleTrack.js +287 -287
  194. package/services/media/tracks/VideoTrack.js +33 -33
  195. package/services/media/tracks/index.js +15 -15
  196. package/services/media/tracks/language-detect.js +174 -174
  197. package/services/server/OutputLifecycle.js +418 -418
  198. package/services/server/SegmentServing.js +1146 -1146
  199. package/services/server/ViewerRequests.js +522 -522
  200. package/services/server/WaitLedger.js +142 -142
  201. package/services/server/controllers/PlaybackController.js +36 -36
  202. package/services/server/controllers/SubtitleController.js +109 -109
  203. package/services/server/http-responses.js +60 -60
  204. package/services/server/transcode-session-files.js +325 -325
  205. package/services/server/wire-outputs.js +983 -983
  206. package/services/storage/Diagnostics.js +202 -202
  207. package/services/storage/MachineBudget.js +235 -235
  208. package/services/storage/allowance.js +107 -107
  209. package/services/storage/core-dumps.js +106 -106
  210. package/services/storage/files/CompletedFiles.js +391 -391
  211. package/services/storage/files/piece-from-whole-file.js +118 -118
  212. package/services/storage/free.js +71 -71
  213. package/services/storage/keep.js +48 -48
  214. package/services/storage/machine-memory.js +56 -56
  215. package/services/storage/memory-report.js +575 -575
  216. package/services/storage/piece-store/piece-disk-store.js +516 -516
  217. package/services/storage/piece-store/piece-lru.js +495 -495
  218. package/services/storage/piece-store/shared-piece-store.js +1880 -1880
  219. package/services/storage/returns.js +103 -103
  220. package/services/storage/segment-store/SegmentStore.js +1196 -1196
  221. package/services/storage/wire.js +175 -175
  222. package/services/torrent/Contents.js +324 -324
  223. package/services/torrent/demand/DemandRegister.js +202 -202
  224. package/services/torrent/demand/Urgency.js +137 -137
  225. package/services/torrent/demand/Window.js +118 -118
  226. package/services/torrent/demand/index.js +8 -8
  227. package/services/torrent/demand/pieces.js +140 -140
  228. package/services/torrent/download/SwarmSelection.js +386 -386
  229. package/services/torrent/download/registry.js +102 -102
  230. package/services/torrent/download/withdraw-claim.js +80 -80
  231. package/services/torrent/files.js +455 -455
  232. package/services/torrent/naming.js +619 -619
  233. package/services/torrent/piece-store-of.js +29 -29
  234. package/services/torrent/supply-margin.js +262 -262
  235. package/services/torrent/torrent-pool.js +2 -2
  236. package/services/torrent/worker/background-fill.js +213 -213
  237. package/services/torrent/worker/channel.js +271 -271
  238. package/services/torrent/worker/fastest-wires.js +342 -342
  239. package/services/torrent/worker/handle-state.js +23 -23
  240. package/services/torrent/worker/held-bytes.js +155 -155
  241. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  242. package/services/torrent/worker/piece-reader.js +1078 -1078
  243. package/services/torrent/worker/pool-adapter.js +1 -1
  244. package/services/torrent/worker/resume-warm.js +107 -107
  245. package/services/torrent/worker/webrtc-shim.js +219 -219
  246. package/services/transport/data-channel-handler.js +1356 -1356
  247. package/services/transport/delivery-probe.js +842 -842
  248. package/services/transport/health-collector.js +53 -53
  249. package/services/transport/nat-classifier.js +231 -231
  250. package/services/transport/packet-witness.js +808 -808
  251. package/services/transport/port-mapper.js +235 -235
  252. package/services/transport/registry-api.js +81 -81
  253. package/services/transport/tunnel-client.js +447 -447
  254. package/services/transport/usrsctp-state.js +175 -175
  255. package/services/transport/webrtc-manager.js +484 -484
  256. package/services/viewer/Assignments.js +340 -340
  257. package/services/viewer/PriorityMap.js +390 -390
  258. package/services/viewer/PriorityOrchestrator.js +325 -325
  259. package/services/viewer/Viewer.js +657 -657
  260. package/services/viewer/Viewers.js +368 -368
  261. package/services/viewer/active-output.js +37 -37
  262. package/services/viewer/audio-start.js +46 -46
  263. package/services/viewer/buffer-trend.js +81 -81
  264. package/services/viewer/choices.js +647 -647
  265. package/services/viewer/positions.js +126 -126
  266. package/services/viewer/report-intake.js +46 -46
  267. package/store/source-registry.js +71 -73
  268. package/test/asset-paths.test.js +28 -28
  269. package/test/audio-inventory.test.js +176 -176
  270. package/test/audio-track-bitrate.test.js +40 -40
  271. package/test/auto-quality-step.test.js +707 -707
  272. package/test/available-share.test.js +76 -76
  273. package/test/background-fill.test.js +190 -190
  274. package/test/client-log-file.test.js +110 -110
  275. package/test/completed-files.test.js +115 -115
  276. package/test/concurrent-cost.test.js +148 -148
  277. package/test/container-media-info.test.js +228 -228
  278. package/test/contention.test.js +76 -76
  279. package/test/core-dumps.test.js +57 -57
  280. package/test/coverage-follows-the-disk.test.js +228 -228
  281. package/test/coverage-map.test.js +195 -195
  282. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  283. package/test/cut-times-timeline.test.js +65 -65
  284. package/test/cuts-follow-published-grid.test.js +109 -109
  285. package/test/data-channel-frame.test.js +63 -63
  286. package/test/dead-torrent-handle.test.js +52 -52
  287. package/test/declared-rates.test.js +116 -116
  288. package/test/declared-tracks.test.js +35 -35
  289. package/test/decode-cost-fit.test.js +202 -202
  290. package/test/decode-cost.test.js +462 -462
  291. package/test/delivery-probe.test.js +393 -393
  292. package/test/demand-register.test.js +206 -206
  293. package/test/dht-bootstrap.test.js +72 -72
  294. package/test/drain-threat.test.js +65 -65
  295. package/test/duplicate-add.test.js +48 -48
  296. package/test/encode-admission.test.js +146 -146
  297. package/test/encode-cost.test.js +283 -283
  298. package/test/encode-exit.test.js +111 -111
  299. package/test/encode-orchestrator.test.js +419 -419
  300. package/test/encode-plan-viewers.test.js +718 -718
  301. package/test/encode-plan.test.js +545 -545
  302. package/test/encode-run-state.test.js +314 -314
  303. package/test/encode-run.test.js +161 -161
  304. package/test/encode-slope.test.js +46 -46
  305. package/test/encoded-output.test.js +39 -39
  306. package/test/encoder-kinds.test.js +122 -122
  307. package/test/encoder-readings.test.js +46 -46
  308. package/test/every-claimant-is-told-its-share.test.js +152 -152
  309. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  310. package/test/failed-start-breaker.test.js +202 -202
  311. package/test/fastest-wires.test.js +143 -143
  312. package/test/ffmpeg-stream-counts.test.js +78 -78
  313. package/test/file-edges.test.js +191 -191
  314. package/test/fmp4-self-contained.test.js +80 -80
  315. package/test/fmp4-timestamps.test.js +140 -140
  316. package/test/fmp4-track-completeness.test.js +41 -41
  317. package/test/format-keyed-outputs.test.js +78 -78
  318. package/test/health-metrics.test.js +38 -38
  319. package/test/held-request-width.test.js +157 -157
  320. package/test/helpers/encode-run.js +136 -136
  321. package/test/helpers/held-file.js +29 -29
  322. package/test/helpers/manager.js +57 -57
  323. package/test/helpers/output-spec.js +63 -63
  324. package/test/host-load.test.js +68 -68
  325. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  326. package/test/init-compat.test.js +219 -219
  327. package/test/input-lost-quiets-the-plan.test.js +261 -261
  328. package/test/input-unavailable.test.js +48 -48
  329. package/test/installation-id.test.js +39 -39
  330. package/test/keeping-period.test.js +83 -83
  331. package/test/keyframe-index-accuracy.test.js +188 -188
  332. package/test/keyframe-table-budget.test.js +102 -102
  333. package/test/keyframes-belong-to-the-file.test.js +249 -249
  334. package/test/learned-median.test.js +37 -37
  335. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  336. package/test/limit-row-by-area.test.js +60 -60
  337. package/test/link-budget.test.js +111 -111
  338. package/test/link-probe.test.js +56 -56
  339. package/test/local-encoding-data.test.js +273 -273
  340. package/test/logger-repeats.test.js +134 -134
  341. package/test/look-ahead-coverage.test.js +56 -56
  342. package/test/manager-surface.test.js +292 -292
  343. package/test/matroska-cues-track.test.js +192 -192
  344. package/test/memory-budget.test.js +390 -390
  345. package/test/move-cost.test.js +216 -216
  346. package/test/mp4-subtitles.test.js +173 -173
  347. package/test/one-authority.test.js +285 -285
  348. package/test/one-budget.test.js +149 -149
  349. package/test/one-output-one-session.test.js +204 -204
  350. package/test/one-resource-divided.test.js +185 -185
  351. package/test/one-serving-output-per-height.test.js +458 -458
  352. package/test/orchestrator-wired.test.js +206 -206
  353. package/test/output-catalog.test.js +39 -39
  354. package/test/output-shape.test.js +21 -21
  355. package/test/output-spec.test.js +251 -251
  356. package/test/output-speed.test.js +88 -88
  357. package/test/outputs-being-prepared.test.js +40 -40
  358. package/test/packet-witness-ring.test.js +236 -236
  359. package/test/packet-witness.test.js +148 -148
  360. package/test/piece-disk-store.test.js +381 -381
  361. package/test/piece-from-whole-file.test.js +129 -129
  362. package/test/piece-lru.test.js +319 -319
  363. package/test/piece-reader.test.js +162 -162
  364. package/test/piece-selection-offset.test.js +85 -85
  365. package/test/piece-store-eviction.test.js +560 -560
  366. package/test/piece-store-never-refuses.test.js +153 -153
  367. package/test/piece-store-reservations.test.js +318 -318
  368. package/test/piece-store-slow-disk.test.js +159 -159
  369. package/test/piece-tail.test.js +97 -97
  370. package/test/plan-host-timings.test.js +68 -68
  371. package/test/plan-is-steady.test.js +225 -225
  372. package/test/priority-map-download.test.js +174 -174
  373. package/test/priority-map-emptied.test.js +204 -204
  374. package/test/priority-map-per-output.test.js +215 -215
  375. package/test/priority-map.test.js +163 -163
  376. package/test/probe-wedge-certainty.test.js +60 -60
  377. package/test/produced-copy-choice.test.js +213 -213
  378. package/test/published-timeline.test.js +83 -83
  379. package/test/quality-offer.test.js +162 -162
  380. package/test/quality-variants.test.js +1229 -1229
  381. package/test/rate-control-in-the-output.test.js +180 -180
  382. package/test/read-survives-withdrawal.test.js +164 -164
  383. package/test/read-window.test.js +365 -365
  384. package/test/resume-warm.test.js +39 -39
  385. package/test/run-graph-drift.test.js +37 -37
  386. package/test/run-inputs.test.js +80 -80
  387. package/test/run-intervals.test.js +100 -100
  388. package/test/run-position-follows-published-grid.test.js +89 -89
  389. package/test/run-progress.test.js +65 -65
  390. package/test/same-height-switch.test.js +664 -664
  391. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  392. package/test/seek-landing.test.js +109 -109
  393. package/test/seek-target-not-superseded.test.js +195 -195
  394. package/test/segment-closed-on-both-branches.test.js +96 -96
  395. package/test/segment-cut-times.test.js +63 -63
  396. package/test/segment-demand.test.js +80 -80
  397. package/test/segment-hold-supersede.test.js +91 -91
  398. package/test/segment-judged-by-its-own-header.test.js +221 -221
  399. package/test/segment-serve-wiring.test.js +475 -475
  400. package/test/segment-store-eviction.test.js +247 -247
  401. package/test/segment-store.test.js +323 -323
  402. package/test/segment-true-start.test.js +86 -86
  403. package/test/segments-are-shared.test.js +176 -176
  404. package/test/send-chunk-bytes.test.js +86 -86
  405. package/test/serving-existing-output.test.js +102 -102
  406. package/test/serving-output.test.js +102 -102
  407. package/test/shared-piece-store.test.js +310 -310
  408. package/test/sidecar-naming.test.js +142 -142
  409. package/test/source-file.test.js +133 -133
  410. package/test/source-files-route.test.js +103 -103
  411. package/test/source-registry.test.js +18 -0
  412. package/test/split-a-stretch.test.js +139 -139
  413. package/test/stale-request-after-seek.test.js +158 -158
  414. package/test/startup-readings.test.js +124 -124
  415. package/test/stream-route.test.js +182 -182
  416. package/test/subtitle-cue-framing.test.js +200 -200
  417. package/test/subtitle-cue-source.test.js +102 -102
  418. package/test/subtitle-cue-walk.test.js +370 -370
  419. package/test/subtitle-cursor.test.js +63 -63
  420. package/test/subtitle-defaults.test.js +118 -118
  421. package/test/subtitle-language.test.js +252 -252
  422. package/test/subtitle-track-numbering.test.js +386 -386
  423. package/test/supply-margin.test.js +177 -177
  424. package/test/swarm-follows-readers.test.js +174 -174
  425. package/test/swarm-reach.test.js +130 -130
  426. package/test/swarm-selection.test.js +220 -220
  427. package/test/tail-duplication.test.js +167 -167
  428. package/test/the-channel-has-both-ends.test.js +91 -91
  429. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  430. package/test/thread-pool.test.js +53 -53
  431. package/test/timeline.test.js +84 -84
  432. package/test/torrent-contents.test.js +235 -235
  433. package/test/torrent-cost.test.js +71 -71
  434. package/test/torrent-files.test.js +221 -221
  435. package/test/torrent-naming.test.js +255 -255
  436. package/test/tracks-begin-together.test.js +209 -209
  437. package/test/tunnel-renewal.test.js +167 -167
  438. package/test/two-viewers-one-picture.test.js +407 -407
  439. package/test/upload-hurry.test.js +186 -186
  440. package/test/usrsctp-state.test.js +131 -131
  441. package/test/video-facts.test.js +102 -102
  442. package/test/viewer-assignments.test.js +143 -143
  443. package/test/viewer-outputs.test.js +285 -285
  444. package/test/viewer-presence.test.js +116 -116
  445. package/test/viewer-requests-admission.test.js +89 -89
  446. package/test/viewer-states.test.js +189 -189
  447. package/test/viewer-subtitle-subscription.test.js +96 -96
  448. package/test/viewer.test.js +139 -139
  449. package/test/viewing-generations.test.js +390 -390
  450. package/test/visible-rung.test.js +37 -37
  451. package/test/wait-ledger.test.js +100 -100
  452. package/test/webrtc-shim.test.js +149 -149
  453. package/test/wedge-certainty.test.js +131 -131
  454. package/test/withdraw-piece-claim.test.js +212 -212
  455. package/test/worker-channel.test.js +158 -158
  456. package/utils/client-log-file.js +151 -151
  457. package/utils/logger.js +312 -312
  458. package/utils/parse-range.js +25 -25
  459. package/utils/perf.js +59 -59
  460. package/{services/torrent → utils}/torrent-source-key.js +38 -38
@@ -1,386 +1,386 @@
1
- /**
2
- * @file The number a subtitle track is asked for by, and one walk per file.
3
- *
4
- * Two rules, both found by reading on 2026-08-26 after the report that embedded
5
- * subtitles appear late (`research/subtitle-delay-2026-08-26.md`):
6
- *
7
- * 1. The browser names a track by ffmpeg's `0:s:N`, which counts EVERY subtitle
8
- * stream. The container plan drops the picture-based ones — PGS, VobSub —
9
- * because they cannot become WebVTT, so counting the kept ones is a
10
- * different numbering as soon as a file carries one of each. What that cost:
11
- * the push landed on a track the browser does not know, and the browser's
12
- * own request found no track at all and fell through to the ffmpeg
13
- * extraction, which reads the whole film (752 s measured, 2026-08-19).
14
- * 2. A file is walked once at a time. The walk marks a cluster as read only
15
- * after two suspension points, and it is started both on every verified
16
- * piece and on a 3 s timer, so two passes could read and parse the same
17
- * cluster and push the same line twice.
18
- */
19
-
20
- import test from "node:test";
21
- import assert from "node:assert/strict";
22
- import { Readable } from "node:stream";
23
- import { MatroskaContainer } from "../services/media/container/MatroskaContainer.js";
24
- import { cuesHeldFor, forgetSubtitles } from "../services/media/SubtitleCues.js";
25
- import { heldFileOver } from "./helpers/held-file.js";
26
-
27
- const ID_EBML = 0x1a45dfa3;
28
- const ID_SEGMENT = 0x18538067;
29
- const ID_SEEK_HEAD = 0x114d9b74;
30
- const ID_SEEK = 0x4dbb;
31
- const ID_SEEK_ID = 0x53ab;
32
- const ID_SEEK_POSITION = 0x53ac;
33
- const ID_INFO = 0x1549a966;
34
- const ID_TIMESTAMP_SCALE = 0x2ad7b1;
35
- const ID_TRACKS = 0x1654ae6b;
36
- const ID_TRACK_ENTRY = 0xae;
37
- const ID_TRACK_NUMBER = 0xd7;
38
- const ID_TRACK_TYPE = 0x83;
39
- const ID_CODEC_ID = 0x86;
40
- const ID_LANGUAGE = 0x22b59c;
41
- const ID_LANGUAGE_BCP47 = 0x22b59d;
42
- const ID_FLAG_ENABLED = 0xb9;
43
- const ID_FLAG_FORCED = 0x55aa;
44
- const ID_FLAG_HEARING_IMPAIRED = 0x55ab;
45
- const ID_CUES = 0x1c53bb6b;
46
- const ID_CUE_POINT = 0xbb;
47
- const ID_CUE_TIME = 0xb3;
48
- const ID_CUE_TRACK_POSITIONS = 0xb7;
49
- const ID_CUE_TRACK = 0xf7;
50
- const ID_CUE_CLUSTER_POSITION = 0xf1;
51
- const ID_CLUSTER = 0x1f43b675;
52
- const ID_TIMESTAMP = 0xe7;
53
-
54
- /** An element id, as the bytes the specification gives it. */
55
- function idBytes(id) {
56
- const bytes = [];
57
- let rest = id;
58
- while (rest > 0) {
59
- bytes.unshift(rest & 0xff);
60
- rest = Math.floor(rest / 256);
61
- }
62
- return Buffer.from(bytes);
63
- }
64
-
65
- /** A size, as a four-byte EBML variable-length integer. */
66
- function sizeBytes(size) {
67
- const buffer = Buffer.alloc(4);
68
- buffer.writeUInt32BE(size, 0);
69
- buffer[0] |= 0x10;
70
- return buffer;
71
- }
72
-
73
- function element(id, payload) {
74
- return Buffer.concat([idBytes(id), sizeBytes(payload.length), payload]);
75
- }
76
-
77
- function uintElement(id, value) {
78
- const bytes = [];
79
- let rest = value;
80
- do {
81
- bytes.unshift(rest & 0xff);
82
- rest = Math.floor(rest / 256);
83
- } while (rest > 0);
84
- return element(id, Buffer.from(bytes));
85
- }
86
-
87
- function stringElement(id, value) {
88
- return element(id, Buffer.from(value, "utf8"));
89
- }
90
-
91
- /**
92
- * An unsigned value at a FIXED four bytes. A cue's cluster position has to be
93
- * written twice — once to measure the table, once with the position that
94
- * measurement produced — and a value-sized element would make the second table
95
- * a different length from the first, moving the very cluster it names.
96
- */
97
- function uint32Element(id, value) {
98
- const payload = Buffer.alloc(4);
99
- payload.writeUInt32BE(value, 0);
100
- return element(id, payload);
101
- }
102
-
103
- function trackEntry({ number, type, codecId, language, flags = {}, languageBcp47 = null }) {
104
- const parts = [
105
- uintElement(ID_TRACK_NUMBER, number),
106
- uintElement(ID_TRACK_TYPE, type),
107
- stringElement(ID_CODEC_ID, codecId)
108
- ];
109
- if (language !== undefined && language !== null) {
110
- parts.push(stringElement(ID_LANGUAGE, language));
111
- }
112
- if (languageBcp47 !== null) {
113
- parts.push(stringElement(ID_LANGUAGE_BCP47, languageBcp47));
114
- }
115
- for (const [id, value] of [
116
- [ID_FLAG_ENABLED, flags.enabled],
117
- [ID_FLAG_FORCED, flags.forced],
118
- [ID_FLAG_HEARING_IMPAIRED, flags.hearingImpaired]
119
- ]) {
120
- if (value !== undefined) {
121
- parts.push(uintElement(id, value ? 1 : 0));
122
- }
123
- }
124
- return element(ID_TRACK_ENTRY, Buffer.concat(parts));
125
- }
126
-
127
- /**
128
- * A file whose subtitle tracks are, in the container's own order: a picture
129
- * one, then two text ones. ffmpeg numbers those `0:s:0`, `0:s:1`, `0:s:2`;
130
- * the plan can only read the last two.
131
- *
132
- * The Cues table points both text tracks at one cluster, which is written after
133
- * the table so its position can be stated.
134
- *
135
- * @returns {{ file: Buffer, clusterAt: number }}
136
- */
137
- function buildFile() {
138
- const info = element(ID_INFO, uintElement(ID_TIMESTAMP_SCALE, 1_000_000));
139
- const tracks = element(ID_TRACKS, Buffer.concat([
140
- trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "und" }),
141
- trackEntry({ number: 2, type: 17, codecId: "S_HDMV/PGS", language: "eng" }),
142
- trackEntry({ number: 3, type: 17, codecId: "S_TEXT/UTF8", language: "rus" }),
143
- trackEntry({ number: 4, type: 17, codecId: "S_TEXT/ASS", language: "eng" })
144
- ]));
145
-
146
- // Built twice: the cue points state where the cluster is, and that position
147
- // is only known once everything before it has its final length. Every size
148
- // and position here is written at a fixed width, so the draft and the final
149
- // table are the same length.
150
- const cuesWith = (clusterAt) => element(ID_CUES, Buffer.concat([
151
- element(ID_CUE_POINT, Buffer.concat([
152
- uintElement(ID_CUE_TIME, 1000),
153
- element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
154
- uintElement(ID_CUE_TRACK, 3),
155
- uint32Element(ID_CUE_CLUSTER_POSITION, clusterAt)
156
- ])),
157
- element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
158
- uintElement(ID_CUE_TRACK, 4),
159
- uint32Element(ID_CUE_CLUSTER_POSITION, clusterAt)
160
- ]))
161
- ]))
162
- ]));
163
-
164
- const seekEntry = (targetId, position) => element(ID_SEEK, Buffer.concat([
165
- element(ID_SEEK_ID, idBytes(targetId)),
166
- element(ID_SEEK_POSITION, (() => {
167
- const buffer = Buffer.alloc(4);
168
- buffer.writeUInt32BE(position, 0);
169
- return buffer;
170
- })())
171
- ]));
172
- const seekHeadWith = (infoAt, tracksAt, cuesAt) => element(ID_SEEK_HEAD, Buffer.concat([
173
- seekEntry(ID_INFO, infoAt),
174
- seekEntry(ID_TRACKS, tracksAt),
175
- seekEntry(ID_CUES, cuesAt)
176
- ]));
177
-
178
- const headLength = seekHeadWith(0, 0, 0).length;
179
- const infoAt = headLength;
180
- const tracksAt = infoAt + info.length;
181
- const cuesAt = tracksAt + tracks.length;
182
- // A position in the Cues table is measured from the Segment's payload, and so
183
- // is the one the reader turns it into.
184
- const clusterRelative = cuesAt + cuesWith(0).length;
185
-
186
- // Enough of a cluster to be read and recognised: its own header and a
187
- // timestamp. No blocks, so it yields no cues — what the walk test counts is
188
- // that its bytes are fetched once, and that does not depend on their content.
189
- const cluster = element(ID_CLUSTER, uintElement(ID_TIMESTAMP, 1000));
190
-
191
- const segmentPayload = Buffer.concat([
192
- seekHeadWith(infoAt, tracksAt, cuesAt),
193
- info,
194
- tracks,
195
- cuesWith(clusterRelative),
196
- cluster
197
- ]);
198
- const ebml = element(ID_EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
199
- const segment = element(ID_SEGMENT, segmentPayload);
200
- const segmentDataOffset = ebml.length + segment.length - segmentPayload.length;
201
- return {
202
- file: Buffer.concat([ebml, segment]),
203
- clusterAt: segmentDataOffset + clusterRelative
204
- };
205
- }
206
-
207
- function readerOver(file) {
208
- return async (start, end) => {
209
- const last = Math.min(end, file.length - 1);
210
- return start > last ? null : file.subarray(start, last + 1);
211
- };
212
- }
213
-
214
- test("a text track is numbered as ffmpeg numbers it, past the picture ones", async () => {
215
- const { file } = buildFile();
216
-
217
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(file), file.length);
218
-
219
- assert.equal(plan.declared.length, 3, "all three subtitle tracks are declared");
220
- assert.deepEqual(plan.tracks.map((track) => track.trackNumber), [3, 4], "only the text ones are readable");
221
- assert.deepEqual(
222
- plan.tracks.map((track) => track.declaredIndex),
223
- [1, 2],
224
- "the PGS track is 0:s:0, so the text tracks are 0:s:1 and 0:s:2 — not 0 and 1"
225
- );
226
- });
227
-
228
- /**
229
- * A torrent holding one file entirely, counting the byte ranges read from it.
230
- *
231
- * @param {Buffer} bytes
232
- * @returns {{ torrent: object, reads: Array<{ start: number, end: number }> }}
233
- */
234
- function torrentOver(bytes) {
235
- const reads = [];
236
- const file = {
237
- name: "film.mkv",
238
- length: bytes.length,
239
- offset: 0,
240
- createReadStream({ start = 0, end = bytes.length - 1 } = {}) {
241
- reads.push({ start, end });
242
- // Asynchronous on purpose: a read that resolves in the same tick would
243
- // hide exactly the interleaving this test is about.
244
- return Readable.from((async function* chunks() {
245
- await new Promise((resolve) => setImmediate(resolve));
246
- yield bytes.subarray(start, end + 1);
247
- })());
248
- }
249
- };
250
- return {
251
- reads,
252
- torrent: {
253
- pieceLength: 1024,
254
- bitfield: { get: () => true },
255
- files: [file]
256
- }
257
- };
258
- }
259
-
260
- test("two walks of one file at the same time read each cluster once", async () => {
261
- const { file, clusterAt } = buildFile();
262
- const { torrent, reads } = torrentOver(file);
263
- const sourceKey = "torrent:numbering-test";
264
- forgetSubtitles(sourceKey);
265
-
266
- // Both text tracks at once, which is what the warmup does on every verified
267
- // piece and every three seconds.
268
- const [first, second] = await Promise.all([
269
- cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 3),
270
- cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 4)
271
- ]);
272
-
273
- assert.equal(first.coveredClusters, 1, "the cluster the table names was walked");
274
- assert.equal(second.coveredClusters, 1, "and the second track sees the same walk, not its own");
275
- const clusterReads = reads.filter((range) => range.start === clusterAt);
276
- assert.equal(
277
- clusterReads.length,
278
- 2,
279
- "one probe of the cluster's header and one read of its body — not two of each"
280
- );
281
- forgetSubtitles(sourceKey);
282
- });
283
-
284
- /**
285
- * A file whose subtitle tracks carry the flags RFC 9559 defines for them: one
286
- * forced, one for viewers who cannot hear, one the file marks unusable, one
287
- * writing its language as RFC 5646 alongside the three-letter code, and one
288
- * relying on Matroska's default language.
289
- *
290
- * @returns {Buffer}
291
- */
292
- function fileWithFlags() {
293
- const info = element(ID_INFO, uintElement(ID_TIMESTAMP_SCALE, 1_000_000));
294
- const tracks = element(ID_TRACKS, Buffer.concat([
295
- trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "und" }),
296
- trackEntry({ number: 2, type: 17, codecId: "S_TEXT/UTF8", language: "rus", flags: { forced: true } }),
297
- trackEntry({ number: 3, type: 17, codecId: "S_TEXT/UTF8", language: "eng", flags: { hearingImpaired: true } }),
298
- trackEntry({ number: 4, type: 17, codecId: "S_TEXT/UTF8", language: "fre", flags: { enabled: false } }),
299
- trackEntry({ number: 5, type: 17, codecId: "S_TEXT/ASS", language: "por", languageBcp47: "pt-BR" }),
300
- trackEntry({ number: 6, type: 17, codecId: "S_TEXT/UTF8", language: null })
301
- ]));
302
- const seekEntry = (targetId, position) => element(ID_SEEK, Buffer.concat([
303
- element(ID_SEEK_ID, idBytes(targetId)),
304
- uint32Element(ID_SEEK_POSITION, position)
305
- ]));
306
- const seekHeadWith = (infoAt, tracksAt) => element(ID_SEEK_HEAD, Buffer.concat([
307
- seekEntry(ID_INFO, infoAt),
308
- seekEntry(ID_TRACKS, tracksAt)
309
- ]));
310
- const headLength = seekHeadWith(0, 0).length;
311
- const segmentPayload = Buffer.concat([
312
- seekHeadWith(headLength, headLength + info.length),
313
- info,
314
- tracks
315
- ]);
316
- const ebml = element(ID_EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
317
- return Buffer.concat([ebml, element(ID_SEGMENT, segmentPayload)]);
318
- }
319
-
320
- test("the flags the file states about a track are read, not guessed from its name", async () => {
321
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
322
-
323
- const forced = plan.tracks.find((track) => track.trackNumber === 2);
324
- assert.equal(forced.isForced, true, "FlagForced 0x55AA");
325
- assert.equal(forced.isHearingImpaired, false);
326
-
327
- const sdh = plan.tracks.find((track) => track.trackNumber === 3);
328
- assert.equal(sdh.isHearingImpaired, true, "FlagHearingImpaired 0x55AB");
329
- assert.equal(sdh.isForced, false);
330
- });
331
-
332
- test("a track the file marks unusable is not offered, but is still counted", async () => {
333
- // FlagEnabled (0xB9): "Set to 1 if the track is usable." Track 4 says 0, so
334
- // it is not offered — but it KEEPS its place in the numbering, because ffmpeg
335
- // keeps it: `matroskadec.c` parses MATROSKA_ID_TRACKFLAGENABLED as EBML_NONE,
336
- // reading the element and storing nothing, so the stream is created and gets
337
- // its own `0:s:N`. Dropping it here would shift every track after it.
338
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
339
-
340
- assert.equal(plan.tracks.some((track) => track.trackNumber === 4), false, "not offered for extraction");
341
- const counted = plan.declared.find((track) => track.trackNumber === 4);
342
- assert.ok(counted, "still declared, so the numbering does not move");
343
- assert.equal(counted.isEnabled, false);
344
- });
345
-
346
- test("an unusable track keeps its place, so the tracks after it keep theirs", async () => {
347
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
348
-
349
- // s:0 forced, s:1 SDH, s:2 the unusable one, s:3 the Brazilian track.
350
- assert.deepEqual(
351
- plan.tracks.map((track) => [track.trackNumber, track.declaredIndex]),
352
- [[2, 0], [3, 1], [5, 3], [6, 4]]
353
- );
354
- });
355
-
356
- test("the list ffmpeg is lined up against still speaks ffmpeg's language codes", async () => {
357
- // `declared` exists to be paired with the `-i` banner, which prints the
358
- // three-letter code; reporting "pt-BR" there would break the pairing and cost
359
- // the FlagDefault reading with it.
360
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
361
-
362
- const declared = plan.declared.find((track) => track.trackNumber === 5);
363
- assert.equal(declared.language, "por");
364
- assert.equal(declared.languageBcp47, "pt-BR");
365
- });
366
-
367
- test("where the file writes RFC 5646, that is the language", async () => {
368
- // "If this element is used, then any Language elements used in the same
369
- // TrackEntry MUST be ignored."
370
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
371
-
372
- const track = plan.tracks.find((entry) => entry.trackNumber === 5);
373
- assert.equal(track.language, "pt-BR", "not the three-letter por");
374
- assert.equal(track.languageBcp47, "pt-BR");
375
- });
376
-
377
- test("an omitted Matroska Language element stays unstated rather than becoming the RFC default", async () => {
378
- const file = fileWithFlags();
379
- const plan = await MatroskaContainer.readSubtitlePlan(readerOver(file), file.length);
380
-
381
- const track = plan.tracks.find((entry) => entry.trackNumber === 6);
382
- const declared = plan.declared.find((entry) => entry.trackNumber === 6);
383
- assert.equal(track.language, "");
384
- assert.equal(track.declaresLanguage, false);
385
- assert.equal(declared.declaresLanguage, false);
386
- });
1
+ /**
2
+ * @file The number a subtitle track is asked for by, and one walk per file.
3
+ *
4
+ * Two rules, both found by reading on 2026-08-26 after the report that embedded
5
+ * subtitles appear late (`research/subtitle-delay-2026-08-26.md`):
6
+ *
7
+ * 1. The browser names a track by ffmpeg's `0:s:N`, which counts EVERY subtitle
8
+ * stream. The container plan drops the picture-based ones — PGS, VobSub —
9
+ * because they cannot become WebVTT, so counting the kept ones is a
10
+ * different numbering as soon as a file carries one of each. What that cost:
11
+ * the push landed on a track the browser does not know, and the browser's
12
+ * own request found no track at all and fell through to the ffmpeg
13
+ * extraction, which reads the whole film (752 s measured, 2026-08-19).
14
+ * 2. A file is walked once at a time. The walk marks a cluster as read only
15
+ * after two suspension points, and it is started both on every verified
16
+ * piece and on a 3 s timer, so two passes could read and parse the same
17
+ * cluster and push the same line twice.
18
+ */
19
+
20
+ import test from "node:test";
21
+ import assert from "node:assert/strict";
22
+ import { Readable } from "node:stream";
23
+ import { MatroskaContainer } from "../services/media/container/MatroskaContainer.js";
24
+ import { cuesHeldFor, forgetSubtitles } from "../services/media/SubtitleCues.js";
25
+ import { heldFileOver } from "./helpers/held-file.js";
26
+
27
+ const ID_EBML = 0x1a45dfa3;
28
+ const ID_SEGMENT = 0x18538067;
29
+ const ID_SEEK_HEAD = 0x114d9b74;
30
+ const ID_SEEK = 0x4dbb;
31
+ const ID_SEEK_ID = 0x53ab;
32
+ const ID_SEEK_POSITION = 0x53ac;
33
+ const ID_INFO = 0x1549a966;
34
+ const ID_TIMESTAMP_SCALE = 0x2ad7b1;
35
+ const ID_TRACKS = 0x1654ae6b;
36
+ const ID_TRACK_ENTRY = 0xae;
37
+ const ID_TRACK_NUMBER = 0xd7;
38
+ const ID_TRACK_TYPE = 0x83;
39
+ const ID_CODEC_ID = 0x86;
40
+ const ID_LANGUAGE = 0x22b59c;
41
+ const ID_LANGUAGE_BCP47 = 0x22b59d;
42
+ const ID_FLAG_ENABLED = 0xb9;
43
+ const ID_FLAG_FORCED = 0x55aa;
44
+ const ID_FLAG_HEARING_IMPAIRED = 0x55ab;
45
+ const ID_CUES = 0x1c53bb6b;
46
+ const ID_CUE_POINT = 0xbb;
47
+ const ID_CUE_TIME = 0xb3;
48
+ const ID_CUE_TRACK_POSITIONS = 0xb7;
49
+ const ID_CUE_TRACK = 0xf7;
50
+ const ID_CUE_CLUSTER_POSITION = 0xf1;
51
+ const ID_CLUSTER = 0x1f43b675;
52
+ const ID_TIMESTAMP = 0xe7;
53
+
54
+ /** An element id, as the bytes the specification gives it. */
55
+ function idBytes(id) {
56
+ const bytes = [];
57
+ let rest = id;
58
+ while (rest > 0) {
59
+ bytes.unshift(rest & 0xff);
60
+ rest = Math.floor(rest / 256);
61
+ }
62
+ return Buffer.from(bytes);
63
+ }
64
+
65
+ /** A size, as a four-byte EBML variable-length integer. */
66
+ function sizeBytes(size) {
67
+ const buffer = Buffer.alloc(4);
68
+ buffer.writeUInt32BE(size, 0);
69
+ buffer[0] |= 0x10;
70
+ return buffer;
71
+ }
72
+
73
+ function element(id, payload) {
74
+ return Buffer.concat([idBytes(id), sizeBytes(payload.length), payload]);
75
+ }
76
+
77
+ function uintElement(id, value) {
78
+ const bytes = [];
79
+ let rest = value;
80
+ do {
81
+ bytes.unshift(rest & 0xff);
82
+ rest = Math.floor(rest / 256);
83
+ } while (rest > 0);
84
+ return element(id, Buffer.from(bytes));
85
+ }
86
+
87
+ function stringElement(id, value) {
88
+ return element(id, Buffer.from(value, "utf8"));
89
+ }
90
+
91
+ /**
92
+ * An unsigned value at a FIXED four bytes. A cue's cluster position has to be
93
+ * written twice — once to measure the table, once with the position that
94
+ * measurement produced — and a value-sized element would make the second table
95
+ * a different length from the first, moving the very cluster it names.
96
+ */
97
+ function uint32Element(id, value) {
98
+ const payload = Buffer.alloc(4);
99
+ payload.writeUInt32BE(value, 0);
100
+ return element(id, payload);
101
+ }
102
+
103
+ function trackEntry({ number, type, codecId, language, flags = {}, languageBcp47 = null }) {
104
+ const parts = [
105
+ uintElement(ID_TRACK_NUMBER, number),
106
+ uintElement(ID_TRACK_TYPE, type),
107
+ stringElement(ID_CODEC_ID, codecId)
108
+ ];
109
+ if (language !== undefined && language !== null) {
110
+ parts.push(stringElement(ID_LANGUAGE, language));
111
+ }
112
+ if (languageBcp47 !== null) {
113
+ parts.push(stringElement(ID_LANGUAGE_BCP47, languageBcp47));
114
+ }
115
+ for (const [id, value] of [
116
+ [ID_FLAG_ENABLED, flags.enabled],
117
+ [ID_FLAG_FORCED, flags.forced],
118
+ [ID_FLAG_HEARING_IMPAIRED, flags.hearingImpaired]
119
+ ]) {
120
+ if (value !== undefined) {
121
+ parts.push(uintElement(id, value ? 1 : 0));
122
+ }
123
+ }
124
+ return element(ID_TRACK_ENTRY, Buffer.concat(parts));
125
+ }
126
+
127
+ /**
128
+ * A file whose subtitle tracks are, in the container's own order: a picture
129
+ * one, then two text ones. ffmpeg numbers those `0:s:0`, `0:s:1`, `0:s:2`;
130
+ * the plan can only read the last two.
131
+ *
132
+ * The Cues table points both text tracks at one cluster, which is written after
133
+ * the table so its position can be stated.
134
+ *
135
+ * @returns {{ file: Buffer, clusterAt: number }}
136
+ */
137
+ function buildFile() {
138
+ const info = element(ID_INFO, uintElement(ID_TIMESTAMP_SCALE, 1_000_000));
139
+ const tracks = element(ID_TRACKS, Buffer.concat([
140
+ trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "und" }),
141
+ trackEntry({ number: 2, type: 17, codecId: "S_HDMV/PGS", language: "eng" }),
142
+ trackEntry({ number: 3, type: 17, codecId: "S_TEXT/UTF8", language: "rus" }),
143
+ trackEntry({ number: 4, type: 17, codecId: "S_TEXT/ASS", language: "eng" })
144
+ ]));
145
+
146
+ // Built twice: the cue points state where the cluster is, and that position
147
+ // is only known once everything before it has its final length. Every size
148
+ // and position here is written at a fixed width, so the draft and the final
149
+ // table are the same length.
150
+ const cuesWith = (clusterAt) => element(ID_CUES, Buffer.concat([
151
+ element(ID_CUE_POINT, Buffer.concat([
152
+ uintElement(ID_CUE_TIME, 1000),
153
+ element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
154
+ uintElement(ID_CUE_TRACK, 3),
155
+ uint32Element(ID_CUE_CLUSTER_POSITION, clusterAt)
156
+ ])),
157
+ element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
158
+ uintElement(ID_CUE_TRACK, 4),
159
+ uint32Element(ID_CUE_CLUSTER_POSITION, clusterAt)
160
+ ]))
161
+ ]))
162
+ ]));
163
+
164
+ const seekEntry = (targetId, position) => element(ID_SEEK, Buffer.concat([
165
+ element(ID_SEEK_ID, idBytes(targetId)),
166
+ element(ID_SEEK_POSITION, (() => {
167
+ const buffer = Buffer.alloc(4);
168
+ buffer.writeUInt32BE(position, 0);
169
+ return buffer;
170
+ })())
171
+ ]));
172
+ const seekHeadWith = (infoAt, tracksAt, cuesAt) => element(ID_SEEK_HEAD, Buffer.concat([
173
+ seekEntry(ID_INFO, infoAt),
174
+ seekEntry(ID_TRACKS, tracksAt),
175
+ seekEntry(ID_CUES, cuesAt)
176
+ ]));
177
+
178
+ const headLength = seekHeadWith(0, 0, 0).length;
179
+ const infoAt = headLength;
180
+ const tracksAt = infoAt + info.length;
181
+ const cuesAt = tracksAt + tracks.length;
182
+ // A position in the Cues table is measured from the Segment's payload, and so
183
+ // is the one the reader turns it into.
184
+ const clusterRelative = cuesAt + cuesWith(0).length;
185
+
186
+ // Enough of a cluster to be read and recognised: its own header and a
187
+ // timestamp. No blocks, so it yields no cues — what the walk test counts is
188
+ // that its bytes are fetched once, and that does not depend on their content.
189
+ const cluster = element(ID_CLUSTER, uintElement(ID_TIMESTAMP, 1000));
190
+
191
+ const segmentPayload = Buffer.concat([
192
+ seekHeadWith(infoAt, tracksAt, cuesAt),
193
+ info,
194
+ tracks,
195
+ cuesWith(clusterRelative),
196
+ cluster
197
+ ]);
198
+ const ebml = element(ID_EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
199
+ const segment = element(ID_SEGMENT, segmentPayload);
200
+ const segmentDataOffset = ebml.length + segment.length - segmentPayload.length;
201
+ return {
202
+ file: Buffer.concat([ebml, segment]),
203
+ clusterAt: segmentDataOffset + clusterRelative
204
+ };
205
+ }
206
+
207
+ function readerOver(file) {
208
+ return async (start, end) => {
209
+ const last = Math.min(end, file.length - 1);
210
+ return start > last ? null : file.subarray(start, last + 1);
211
+ };
212
+ }
213
+
214
+ test("a text track is numbered as ffmpeg numbers it, past the picture ones", async () => {
215
+ const { file } = buildFile();
216
+
217
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(file), file.length);
218
+
219
+ assert.equal(plan.declared.length, 3, "all three subtitle tracks are declared");
220
+ assert.deepEqual(plan.tracks.map((track) => track.trackNumber), [3, 4], "only the text ones are readable");
221
+ assert.deepEqual(
222
+ plan.tracks.map((track) => track.declaredIndex),
223
+ [1, 2],
224
+ "the PGS track is 0:s:0, so the text tracks are 0:s:1 and 0:s:2 — not 0 and 1"
225
+ );
226
+ });
227
+
228
+ /**
229
+ * A torrent holding one file entirely, counting the byte ranges read from it.
230
+ *
231
+ * @param {Buffer} bytes
232
+ * @returns {{ torrent: object, reads: Array<{ start: number, end: number }> }}
233
+ */
234
+ function torrentOver(bytes) {
235
+ const reads = [];
236
+ const file = {
237
+ name: "film.mkv",
238
+ length: bytes.length,
239
+ offset: 0,
240
+ createReadStream({ start = 0, end = bytes.length - 1 } = {}) {
241
+ reads.push({ start, end });
242
+ // Asynchronous on purpose: a read that resolves in the same tick would
243
+ // hide exactly the interleaving this test is about.
244
+ return Readable.from((async function* chunks() {
245
+ await new Promise((resolve) => setImmediate(resolve));
246
+ yield bytes.subarray(start, end + 1);
247
+ })());
248
+ }
249
+ };
250
+ return {
251
+ reads,
252
+ torrent: {
253
+ pieceLength: 1024,
254
+ bitfield: { get: () => true },
255
+ files: [file]
256
+ }
257
+ };
258
+ }
259
+
260
+ test("two walks of one file at the same time read each cluster once", async () => {
261
+ const { file, clusterAt } = buildFile();
262
+ const { torrent, reads } = torrentOver(file);
263
+ const sourceKey = "torrent:numbering-test";
264
+ forgetSubtitles(sourceKey);
265
+
266
+ // Both text tracks at once, which is what the warmup does on every verified
267
+ // piece and every three seconds.
268
+ const [first, second] = await Promise.all([
269
+ cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 3),
270
+ cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 4)
271
+ ]);
272
+
273
+ assert.equal(first.coveredClusters, 1, "the cluster the table names was walked");
274
+ assert.equal(second.coveredClusters, 1, "and the second track sees the same walk, not its own");
275
+ const clusterReads = reads.filter((range) => range.start === clusterAt);
276
+ assert.equal(
277
+ clusterReads.length,
278
+ 2,
279
+ "one probe of the cluster's header and one read of its body — not two of each"
280
+ );
281
+ forgetSubtitles(sourceKey);
282
+ });
283
+
284
+ /**
285
+ * A file whose subtitle tracks carry the flags RFC 9559 defines for them: one
286
+ * forced, one for viewers who cannot hear, one the file marks unusable, one
287
+ * writing its language as RFC 5646 alongside the three-letter code, and one
288
+ * relying on Matroska's default language.
289
+ *
290
+ * @returns {Buffer}
291
+ */
292
+ function fileWithFlags() {
293
+ const info = element(ID_INFO, uintElement(ID_TIMESTAMP_SCALE, 1_000_000));
294
+ const tracks = element(ID_TRACKS, Buffer.concat([
295
+ trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "und" }),
296
+ trackEntry({ number: 2, type: 17, codecId: "S_TEXT/UTF8", language: "rus", flags: { forced: true } }),
297
+ trackEntry({ number: 3, type: 17, codecId: "S_TEXT/UTF8", language: "eng", flags: { hearingImpaired: true } }),
298
+ trackEntry({ number: 4, type: 17, codecId: "S_TEXT/UTF8", language: "fre", flags: { enabled: false } }),
299
+ trackEntry({ number: 5, type: 17, codecId: "S_TEXT/ASS", language: "por", languageBcp47: "pt-BR" }),
300
+ trackEntry({ number: 6, type: 17, codecId: "S_TEXT/UTF8", language: null })
301
+ ]));
302
+ const seekEntry = (targetId, position) => element(ID_SEEK, Buffer.concat([
303
+ element(ID_SEEK_ID, idBytes(targetId)),
304
+ uint32Element(ID_SEEK_POSITION, position)
305
+ ]));
306
+ const seekHeadWith = (infoAt, tracksAt) => element(ID_SEEK_HEAD, Buffer.concat([
307
+ seekEntry(ID_INFO, infoAt),
308
+ seekEntry(ID_TRACKS, tracksAt)
309
+ ]));
310
+ const headLength = seekHeadWith(0, 0).length;
311
+ const segmentPayload = Buffer.concat([
312
+ seekHeadWith(headLength, headLength + info.length),
313
+ info,
314
+ tracks
315
+ ]);
316
+ const ebml = element(ID_EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
317
+ return Buffer.concat([ebml, element(ID_SEGMENT, segmentPayload)]);
318
+ }
319
+
320
+ test("the flags the file states about a track are read, not guessed from its name", async () => {
321
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
322
+
323
+ const forced = plan.tracks.find((track) => track.trackNumber === 2);
324
+ assert.equal(forced.isForced, true, "FlagForced 0x55AA");
325
+ assert.equal(forced.isHearingImpaired, false);
326
+
327
+ const sdh = plan.tracks.find((track) => track.trackNumber === 3);
328
+ assert.equal(sdh.isHearingImpaired, true, "FlagHearingImpaired 0x55AB");
329
+ assert.equal(sdh.isForced, false);
330
+ });
331
+
332
+ test("a track the file marks unusable is not offered, but is still counted", async () => {
333
+ // FlagEnabled (0xB9): "Set to 1 if the track is usable." Track 4 says 0, so
334
+ // it is not offered — but it KEEPS its place in the numbering, because ffmpeg
335
+ // keeps it: `matroskadec.c` parses MATROSKA_ID_TRACKFLAGENABLED as EBML_NONE,
336
+ // reading the element and storing nothing, so the stream is created and gets
337
+ // its own `0:s:N`. Dropping it here would shift every track after it.
338
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
339
+
340
+ assert.equal(plan.tracks.some((track) => track.trackNumber === 4), false, "not offered for extraction");
341
+ const counted = plan.declared.find((track) => track.trackNumber === 4);
342
+ assert.ok(counted, "still declared, so the numbering does not move");
343
+ assert.equal(counted.isEnabled, false);
344
+ });
345
+
346
+ test("an unusable track keeps its place, so the tracks after it keep theirs", async () => {
347
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
348
+
349
+ // s:0 forced, s:1 SDH, s:2 the unusable one, s:3 the Brazilian track.
350
+ assert.deepEqual(
351
+ plan.tracks.map((track) => [track.trackNumber, track.declaredIndex]),
352
+ [[2, 0], [3, 1], [5, 3], [6, 4]]
353
+ );
354
+ });
355
+
356
+ test("the list ffmpeg is lined up against still speaks ffmpeg's language codes", async () => {
357
+ // `declared` exists to be paired with the `-i` banner, which prints the
358
+ // three-letter code; reporting "pt-BR" there would break the pairing and cost
359
+ // the FlagDefault reading with it.
360
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
361
+
362
+ const declared = plan.declared.find((track) => track.trackNumber === 5);
363
+ assert.equal(declared.language, "por");
364
+ assert.equal(declared.languageBcp47, "pt-BR");
365
+ });
366
+
367
+ test("where the file writes RFC 5646, that is the language", async () => {
368
+ // "If this element is used, then any Language elements used in the same
369
+ // TrackEntry MUST be ignored."
370
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(fileWithFlags()), fileWithFlags().length);
371
+
372
+ const track = plan.tracks.find((entry) => entry.trackNumber === 5);
373
+ assert.equal(track.language, "pt-BR", "not the three-letter por");
374
+ assert.equal(track.languageBcp47, "pt-BR");
375
+ });
376
+
377
+ test("an omitted Matroska Language element stays unstated rather than becoming the RFC default", async () => {
378
+ const file = fileWithFlags();
379
+ const plan = await MatroskaContainer.readSubtitlePlan(readerOver(file), file.length);
380
+
381
+ const track = plan.tracks.find((entry) => entry.trackNumber === 6);
382
+ const declared = plan.declared.find((entry) => entry.trackNumber === 6);
383
+ assert.equal(track.language, "");
384
+ assert.equal(track.declaresLanguage, false);
385
+ assert.equal(declared.declaresLanguage, false);
386
+ });