@torrent-tv/proxy 2.88.3 → 2.88.4

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 (473) 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 +2259 -2250
  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 +23 -4
  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/audio-tracks/post.js +29 -29
  85. package/routes/api/playback-plan/post.js +53 -53
  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 +138 -138
  92. package/routes/api/transcode-sessions/post.js +178 -173
  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 +380 -380
  99. package/routes/transcode/audio-file/get.js +64 -64
  100. package/routes/transcode/audio-warm/get.js +95 -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 -376
  109. package/services/encode/EncodeOrchestrator.js +1217 -1217
  110. package/services/encode/EncodePlan.js +1366 -1366
  111. package/services/encode/EncodeRun.js +813 -813
  112. package/services/encode/EncodeRuns.js +1235 -1235
  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 +783 -758
  118. package/services/encode/OutputTimes.js +579 -579
  119. package/services/encode/QsvEncoder.js +58 -58
  120. package/services/encode/Renditions.js +2282 -2184
  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 +418 -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 +1150 -1141
  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 +349 -254
  158. package/services/encode/quality/output-format.js +319 -315
  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 +754 -754
  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 +456 -456
  166. package/services/encode/segment-formats/index.js +85 -85
  167. package/services/encode/segment-formats/init-compat.js +324 -324
  168. package/services/encode/segment-formats/mpegts.js +134 -134
  169. package/services/encode/start-stop-cost.js +178 -178
  170. package/services/encode/throughput.js +97 -97
  171. package/services/encode/torrent-cost.js +88 -88
  172. package/services/identity/installation-id.js +38 -38
  173. package/services/media/ContainerOrchestrator.js +149 -149
  174. package/services/media/KeyframeTables.js +316 -316
  175. package/services/media/SourceFile.js +298 -298
  176. package/services/media/SubtitleCues.js +520 -520
  177. package/services/media/SubtitleOrchestrator.js +167 -167
  178. package/services/media/audio-inventory.js +298 -245
  179. package/services/media/container/AviContainer.js +266 -266
  180. package/services/media/container/Container.js +609 -603
  181. package/services/media/container/ContainerFactory.js +56 -56
  182. package/services/media/container/KeyframeTable.js +272 -272
  183. package/services/media/container/MatroskaContainer.js +1494 -1494
  184. package/services/media/container/Mp4Container.js +1344 -1244
  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/playback-planner.js +931 -931
  190. package/services/media/tracks/AudioTrack.js +143 -131
  191. package/services/media/tracks/ContainerTrack.js +75 -75
  192. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  193. package/services/media/tracks/SubtitleTrack.js +38 -38
  194. package/services/media/tracks/TextSubtitleTrack.js +287 -287
  195. package/services/media/tracks/VideoTrack.js +33 -33
  196. package/services/media/tracks/audio-bound.js +233 -0
  197. package/services/media/tracks/index.js +15 -15
  198. package/services/media/tracks/language-detect.js +174 -174
  199. package/services/server/OutputLifecycle.js +418 -418
  200. package/services/server/SegmentServing.js +1150 -1150
  201. package/services/server/ViewerRequests.js +760 -760
  202. package/services/server/WaitLedger.js +142 -142
  203. package/services/server/controllers/PlaybackController.js +40 -40
  204. package/services/server/controllers/SubtitleController.js +109 -109
  205. package/services/server/http-responses.js +60 -60
  206. package/services/server/transcode-session-files.js +325 -325
  207. package/services/server/wire-outputs.js +995 -992
  208. package/services/storage/Diagnostics.js +202 -202
  209. package/services/storage/MachineBudget.js +235 -235
  210. package/services/storage/allowance.js +107 -107
  211. package/services/storage/core-dumps.js +106 -106
  212. package/services/storage/files/CompletedFiles.js +391 -391
  213. package/services/storage/files/piece-from-whole-file.js +118 -118
  214. package/services/storage/free.js +71 -71
  215. package/services/storage/keep.js +48 -48
  216. package/services/storage/machine-memory.js +56 -56
  217. package/services/storage/memory-report.js +575 -575
  218. package/services/storage/piece-store/piece-disk-store.js +539 -539
  219. package/services/storage/piece-store/piece-lru.js +495 -495
  220. package/services/storage/piece-store/shared-piece-store.js +1931 -1931
  221. package/services/storage/returns.js +103 -103
  222. package/services/storage/segment-store/SegmentStore.js +1240 -1240
  223. package/services/storage/wire.js +175 -175
  224. package/services/torrent/demand/DemandRegister.js +202 -202
  225. package/services/torrent/demand/Urgency.js +137 -137
  226. package/services/torrent/demand/Window.js +118 -118
  227. package/services/torrent/demand/index.js +8 -8
  228. package/services/torrent/demand/pieces.js +140 -140
  229. package/services/torrent/download/SwarmSelection.js +386 -386
  230. package/services/torrent/download/registry.js +102 -102
  231. package/services/torrent/download/withdraw-claim.js +80 -80
  232. package/services/torrent/episode-naming.js +182 -182
  233. package/services/torrent/files.js +455 -455
  234. package/services/torrent/naming.js +619 -619
  235. package/services/torrent/piece-store-of.js +29 -29
  236. package/services/torrent/supply-margin.js +262 -262
  237. package/services/torrent/torrent-pool.js +2675 -2675
  238. package/services/torrent/worker/background-fill.js +213 -213
  239. package/services/torrent/worker/channel.js +271 -271
  240. package/services/torrent/worker/client.js +765 -765
  241. package/services/torrent/worker/fastest-wires.js +342 -342
  242. package/services/torrent/worker/handle-state.js +23 -23
  243. package/services/torrent/worker/held-bytes.js +155 -155
  244. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  245. package/services/torrent/worker/piece-reader.js +1078 -1078
  246. package/services/torrent/worker/pool-adapter.js +371 -371
  247. package/services/torrent/worker/protocol.js +184 -184
  248. package/services/torrent/worker/resume-warm.js +107 -107
  249. package/services/torrent/worker/webrtc-shim.js +219 -219
  250. package/services/torrent/worker/worker.js +1129 -1129
  251. package/services/transport/data-channel-handler.js +1369 -1369
  252. package/services/transport/delivery-probe.js +842 -842
  253. package/services/transport/health-collector.js +53 -53
  254. package/services/transport/nat-classifier.js +231 -231
  255. package/services/transport/packet-witness.js +808 -808
  256. package/services/transport/port-mapper.js +235 -235
  257. package/services/transport/registry-api.js +81 -81
  258. package/services/transport/tunnel-client.js +447 -447
  259. package/services/transport/usrsctp-state.js +175 -175
  260. package/services/transport/webrtc-manager.js +484 -484
  261. package/services/viewer/Assignments.js +340 -340
  262. package/services/viewer/PriorityMap.js +390 -390
  263. package/services/viewer/PriorityOrchestrator.js +325 -325
  264. package/services/viewer/Viewer.js +691 -691
  265. package/services/viewer/Viewers.js +368 -368
  266. package/services/viewer/active-output.js +37 -37
  267. package/services/viewer/audio-start.js +46 -46
  268. package/services/viewer/buffer-trend.js +81 -81
  269. package/services/viewer/choices.js +647 -647
  270. package/services/viewer/positions.js +126 -126
  271. package/services/viewer/report-intake.js +46 -46
  272. package/store/source-registry.js +71 -71
  273. package/test/asset-paths.test.js +28 -28
  274. package/test/audio-buffer-continuity.test.js +70 -70
  275. package/test/audio-inventory.test.js +212 -212
  276. package/test/audio-track-bitrate.test.js +40 -40
  277. package/test/auto-quality-step.test.js +707 -707
  278. package/test/available-share.test.js +76 -76
  279. package/test/background-fill.test.js +190 -190
  280. package/test/client-log-file.test.js +110 -110
  281. package/test/completed-files.test.js +115 -115
  282. package/test/concurrent-cost.test.js +148 -148
  283. package/test/container-media-info.test.js +228 -228
  284. package/test/contention.test.js +76 -76
  285. package/test/core-dumps.test.js +57 -57
  286. package/test/coverage-follows-the-disk.test.js +228 -228
  287. package/test/coverage-map.test.js +195 -195
  288. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  289. package/test/cut-times-timeline.test.js +65 -65
  290. package/test/cuts-follow-published-grid.test.js +109 -109
  291. package/test/data-channel-frame.test.js +63 -63
  292. package/test/data-channel-viewer-lifecycle.test.js +92 -92
  293. package/test/dead-torrent-handle.test.js +52 -52
  294. package/test/declared-rates.test.js +116 -116
  295. package/test/declared-tracks.test.js +43 -43
  296. package/test/decode-cost-fit.test.js +202 -202
  297. package/test/decode-cost.test.js +462 -462
  298. package/test/delivery-probe.test.js +393 -393
  299. package/test/demand-register.test.js +206 -206
  300. package/test/dht-bootstrap.test.js +72 -72
  301. package/test/drain-threat.test.js +65 -65
  302. package/test/duplicate-add.test.js +48 -48
  303. package/test/encode-admission.test.js +146 -146
  304. package/test/encode-cost.test.js +283 -283
  305. package/test/encode-exit.test.js +111 -111
  306. package/test/encode-orchestrator.test.js +419 -419
  307. package/test/encode-plan-viewers.test.js +718 -718
  308. package/test/encode-plan.test.js +545 -545
  309. package/test/encode-run-state.test.js +314 -314
  310. package/test/encode-run.test.js +162 -162
  311. package/test/encode-slope.test.js +46 -46
  312. package/test/encoded-output.test.js +39 -39
  313. package/test/encoder-kinds.test.js +122 -122
  314. package/test/encoder-readings.test.js +46 -46
  315. package/test/episode-naming.test.js +131 -131
  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/fixtures/audio-frame-boundary.json +1 -1
  323. package/test/fmp4-presentation-clock.test.js +147 -147
  324. package/test/fmp4-self-contained.test.js +80 -80
  325. package/test/fmp4-timestamps.test.js +140 -140
  326. package/test/fmp4-track-completeness.test.js +41 -41
  327. package/test/format-keyed-outputs.test.js +78 -78
  328. package/test/health-metrics.test.js +38 -38
  329. package/test/held-request-width.test.js +157 -157
  330. package/test/helpers/encode-run.js +136 -136
  331. package/test/helpers/held-file.js +29 -29
  332. package/test/helpers/manager.js +57 -57
  333. package/test/helpers/output-spec.js +63 -63
  334. package/test/host-load.test.js +68 -68
  335. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  336. package/test/init-compat.test.js +219 -219
  337. package/test/input-lost-quiets-the-plan.test.js +261 -261
  338. package/test/input-unavailable.test.js +48 -48
  339. package/test/installation-id.test.js +39 -39
  340. package/test/keeping-period.test.js +83 -83
  341. package/test/keyframe-index-accuracy.test.js +188 -188
  342. package/test/keyframe-table-budget.test.js +102 -102
  343. package/test/keyframes-belong-to-the-file.test.js +249 -249
  344. package/test/learned-median.test.js +37 -37
  345. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  346. package/test/limit-row-by-area.test.js +60 -60
  347. package/test/link-budget.test.js +112 -111
  348. package/test/link-probe.test.js +56 -56
  349. package/test/local-encoding-data.test.js +273 -273
  350. package/test/logger-repeats.test.js +134 -134
  351. package/test/look-ahead-coverage.test.js +56 -56
  352. package/test/manager-surface.test.js +292 -292
  353. package/test/matroska-cues-track.test.js +192 -192
  354. package/test/memory-budget.test.js +390 -390
  355. package/test/move-cost.test.js +216 -216
  356. package/test/mp4-subtitles.test.js +173 -173
  357. package/test/one-authority.test.js +285 -285
  358. package/test/one-budget.test.js +149 -149
  359. package/test/one-output-one-session.test.js +270 -204
  360. package/test/one-resource-divided.test.js +185 -185
  361. package/test/one-serving-output-per-height.test.js +458 -458
  362. package/test/orchestrator-wired.test.js +206 -206
  363. package/test/output-catalog.test.js +39 -39
  364. package/test/output-shape.test.js +21 -21
  365. package/test/output-spec.test.js +251 -251
  366. package/test/output-speed.test.js +88 -88
  367. package/test/outputs-being-prepared.test.js +40 -40
  368. package/test/packet-witness-ring.test.js +236 -236
  369. package/test/packet-witness.test.js +148 -148
  370. package/test/piece-disk-store.test.js +401 -401
  371. package/test/piece-from-whole-file.test.js +129 -129
  372. package/test/piece-lru.test.js +319 -319
  373. package/test/piece-reader.test.js +162 -162
  374. package/test/piece-selection-offset.test.js +85 -85
  375. package/test/piece-store-eviction.test.js +595 -595
  376. package/test/piece-store-never-refuses.test.js +153 -153
  377. package/test/piece-store-reservations.test.js +403 -403
  378. package/test/piece-store-slow-disk.test.js +159 -159
  379. package/test/piece-tail.test.js +97 -97
  380. package/test/plan-host-timings.test.js +68 -68
  381. package/test/plan-is-steady.test.js +225 -225
  382. package/test/playback-readiness.test.js +453 -453
  383. package/test/playback-start-regressions.test.js +99 -99
  384. package/test/priority-map-download.test.js +174 -174
  385. package/test/priority-map-emptied.test.js +204 -204
  386. package/test/priority-map-per-output.test.js +215 -215
  387. package/test/priority-map.test.js +163 -163
  388. package/test/probe-wedge-certainty.test.js +60 -60
  389. package/test/produced-copy-choice.test.js +213 -213
  390. package/test/published-timeline.test.js +83 -83
  391. package/test/quality-offer.test.js +162 -162
  392. package/test/quality-variants.test.js +1257 -1229
  393. package/test/rate-control-in-the-output.test.js +180 -180
  394. package/test/read-survives-withdrawal.test.js +164 -164
  395. package/test/read-window.test.js +365 -365
  396. package/test/resume-warm.test.js +39 -39
  397. package/test/run-graph-drift.test.js +37 -37
  398. package/test/run-inputs.test.js +80 -80
  399. package/test/run-intervals.test.js +100 -100
  400. package/test/run-position-follows-published-grid.test.js +89 -89
  401. package/test/run-progress.test.js +65 -65
  402. package/test/same-height-switch.test.js +664 -664
  403. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  404. package/test/seek-landing.test.js +109 -109
  405. package/test/seek-target-not-superseded.test.js +195 -195
  406. package/test/segment-closed-on-both-branches.test.js +96 -96
  407. package/test/segment-cut-times.test.js +63 -63
  408. package/test/segment-demand.test.js +80 -80
  409. package/test/segment-hold-supersede.test.js +91 -91
  410. package/test/segment-judged-by-its-own-header.test.js +221 -221
  411. package/test/segment-serve-wiring.test.js +475 -475
  412. package/test/segment-store-eviction.test.js +247 -247
  413. package/test/segment-store.test.js +323 -323
  414. package/test/segment-true-start.test.js +86 -86
  415. package/test/segments-are-shared.test.js +176 -176
  416. package/test/send-chunk-bytes.test.js +86 -86
  417. package/test/serving-existing-output.test.js +105 -102
  418. package/test/serving-output.test.js +102 -102
  419. package/test/shared-piece-store.test.js +310 -310
  420. package/test/sidecar-naming.test.js +142 -142
  421. package/test/soundtrack-rate-bound.test.js +289 -0
  422. package/test/source-file.test.js +133 -133
  423. package/test/source-files-route.test.js +113 -113
  424. package/test/source-registry.test.js +18 -18
  425. package/test/split-a-stretch.test.js +139 -139
  426. package/test/stale-request-after-seek.test.js +158 -158
  427. package/test/startup-readings.test.js +124 -124
  428. package/test/stream-route.test.js +209 -209
  429. package/test/subtitle-cue-framing.test.js +200 -200
  430. package/test/subtitle-cue-source.test.js +102 -102
  431. package/test/subtitle-cue-walk.test.js +370 -370
  432. package/test/subtitle-cursor.test.js +63 -63
  433. package/test/subtitle-defaults.test.js +118 -118
  434. package/test/subtitle-language.test.js +252 -252
  435. package/test/subtitle-track-numbering.test.js +386 -386
  436. package/test/supply-margin.test.js +177 -177
  437. package/test/swarm-follows-readers.test.js +174 -174
  438. package/test/swarm-reach.test.js +130 -130
  439. package/test/swarm-selection.test.js +220 -220
  440. package/test/tail-duplication.test.js +167 -167
  441. package/test/the-channel-has-both-ends.test.js +91 -91
  442. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  443. package/test/thread-pool.test.js +53 -53
  444. package/test/timeline.test.js +84 -84
  445. package/test/torrent-contents.test.js +235 -235
  446. package/test/torrent-cost.test.js +71 -71
  447. package/test/torrent-files.test.js +221 -221
  448. package/test/torrent-naming.test.js +255 -255
  449. package/test/tracks-begin-together.test.js +209 -209
  450. package/test/tunnel-renewal.test.js +167 -167
  451. package/test/two-viewers-one-picture.test.js +504 -407
  452. package/test/upload-hurry.test.js +186 -186
  453. package/test/usrsctp-state.test.js +131 -131
  454. package/test/video-facts.test.js +102 -102
  455. package/test/viewer-assignments.test.js +143 -143
  456. package/test/viewer-outputs.test.js +285 -285
  457. package/test/viewer-presence.test.js +116 -116
  458. package/test/viewer-requests-admission.test.js +89 -89
  459. package/test/viewer-states.test.js +189 -189
  460. package/test/viewer-subtitle-subscription.test.js +96 -96
  461. package/test/viewer.test.js +139 -139
  462. package/test/viewing-generations.test.js +390 -390
  463. package/test/visible-rung.test.js +37 -37
  464. package/test/wait-ledger.test.js +100 -100
  465. package/test/webrtc-shim.test.js +149 -149
  466. package/test/wedge-certainty.test.js +131 -131
  467. package/test/withdraw-piece-claim.test.js +212 -212
  468. package/test/worker-channel.test.js +158 -158
  469. package/utils/client-log-file.js +151 -151
  470. package/utils/logger.js +312 -312
  471. package/utils/parse-range.js +25 -25
  472. package/utils/perf.js +59 -59
  473. package/utils/torrent-source-key.js +38 -38
@@ -1,370 +1,370 @@
1
- /**
2
- * @file What comes out of a real cluster walk, end to end.
3
- *
4
- * This is the check the walk never had. Everything around it was covered — the
5
- * numbering a track is asked for by, the framing one cue's bytes carry, the
6
- * thread a pull is answered on — and the walk itself, six hundred lines of it,
7
- * had none: a file is built here with real clusters carrying real blocks, and
8
- * the cues that come back out are stated exactly. Two field defects landed on
9
- * this path in one week; a move of this code without a check that would catch a
10
- * regression is a change nobody can verify.
11
- *
12
- * The four things asserted are the four the walk exists for: the text of each
13
- * cue with its times, the found-order cursor a browser follows, the rule that
14
- * only already-downloaded clusters are read, and the rule that one walk fills
15
- * every track of the file.
16
- */
17
-
18
- import test from "node:test";
19
- import assert from "node:assert/strict";
20
- import { Readable } from "node:stream";
21
-
22
- import { cuesHeldFor, warmSubtitleCues, forgetSubtitles } from "../services/media/SubtitleCues.js";
23
- import { heldFileOver } from "./helpers/held-file.js";
24
-
25
- const ID_EBML = 0x1a45dfa3;
26
- const ID_SEGMENT = 0x18538067;
27
- const ID_SEEK_HEAD = 0x114d9b74;
28
- const ID_SEEK = 0x4dbb;
29
- const ID_SEEK_ID = 0x53ab;
30
- const ID_SEEK_POSITION = 0x53ac;
31
- const ID_INFO = 0x1549a966;
32
- const ID_TIMESTAMP_SCALE = 0x2ad7b1;
33
- const ID_TRACKS = 0x1654ae6b;
34
- const ID_TRACK_ENTRY = 0xae;
35
- const ID_TRACK_NUMBER = 0xd7;
36
- const ID_TRACK_TYPE = 0x83;
37
- const ID_CODEC_ID = 0x86;
38
- const ID_LANGUAGE = 0x22b59c;
39
- const ID_CUES = 0x1c53bb6b;
40
- const ID_CUE_POINT = 0xbb;
41
- const ID_CUE_TIME = 0xb3;
42
- const ID_CUE_TRACK_POSITIONS = 0xb7;
43
- const ID_CUE_TRACK = 0xf7;
44
- const ID_CUE_CLUSTER_POSITION = 0xf1;
45
- const ID_CLUSTER = 0x1f43b675;
46
- const ID_TIMESTAMP = 0xe7;
47
- const ID_BLOCK_GROUP = 0xa0;
48
- const ID_BLOCK = 0xa1;
49
- const ID_BLOCK_DURATION = 0x9b;
50
-
51
- function idBytes(id) {
52
- const bytes = [];
53
- let rest = id;
54
- while (rest > 0) {
55
- bytes.unshift(rest & 0xff);
56
- rest = Math.floor(rest / 256);
57
- }
58
- return Buffer.from(bytes);
59
- }
60
-
61
- /** A four-byte size: a valid variable-length integer whatever the payload. */
62
- function sizeBytes(size) {
63
- const buffer = Buffer.alloc(4);
64
- buffer.writeUInt32BE(size, 0);
65
- buffer[0] |= 0x10;
66
- return buffer;
67
- }
68
-
69
- function element(id, payload) {
70
- return Buffer.concat([idBytes(id), sizeBytes(payload.length), payload]);
71
- }
72
-
73
- function uintElement(id, value) {
74
- const bytes = [];
75
- let rest = value;
76
- do {
77
- bytes.unshift(rest & 0xff);
78
- rest = Math.floor(rest / 256);
79
- } while (rest > 0);
80
- return element(id, Buffer.from(bytes));
81
- }
82
-
83
- function stringElement(id, value) {
84
- return element(id, Buffer.from(value, "utf8"));
85
- }
86
-
87
- /** A fixed four bytes, so a table measured twice comes out the same length. */
88
- function uint32Element(id, value) {
89
- const payload = Buffer.alloc(4);
90
- payload.writeUInt32BE(value, 0);
91
- return element(id, payload);
92
- }
93
-
94
- function trackEntry({ number, type, codecId, language }) {
95
- return element(ID_TRACK_ENTRY, Buffer.concat([
96
- uintElement(ID_TRACK_NUMBER, number),
97
- uintElement(ID_TRACK_TYPE, type),
98
- stringElement(ID_CODEC_ID, codecId),
99
- stringElement(ID_LANGUAGE, language)
100
- ]));
101
- }
102
-
103
- /**
104
- * One cue, as a BlockGroup so it can carry its own duration.
105
- *
106
- * @param {{ track: number, relativeTicks: number, durationTicks: number, text: string }} params
107
- * @returns {Buffer}
108
- */
109
- function cueBlock({ track, relativeTicks, durationTicks, text }) {
110
- const header = Buffer.alloc(4);
111
- header[0] = 0x80 | track; // track numbers under 128 are one byte, marker set
112
- header.writeInt16BE(relativeTicks, 1);
113
- header[3] = 0;
114
- const block = element(ID_BLOCK, Buffer.concat([header, Buffer.from(text, "utf8")]));
115
- return element(ID_BLOCK_GROUP, Buffer.concat([block, uintElement(ID_BLOCK_DURATION, durationTicks)]));
116
- }
117
-
118
- /**
119
- * A file with two text tracks and two clusters, each carrying a line for each
120
- * track.
121
- *
122
- * Track 2 is `S_TEXT/UTF8`, whose block payload IS the text. Track 3 is
123
- * `S_TEXT/ASS`, whose payload is the dialogue row without its `Dialogue:`
124
- * header — eight comma-separated fields and then the words, which is what
125
- * Matroska states and what the framing rule has to strip.
126
- *
127
- * @returns {{ file: Buffer, clusterAt: number[] }}
128
- */
129
- function buildFile() {
130
- const info = element(ID_INFO, uintElement(ID_TIMESTAMP_SCALE, 1_000_000));
131
- const tracks = element(ID_TRACKS, Buffer.concat([
132
- trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "und" }),
133
- trackEntry({ number: 2, type: 17, codecId: "S_TEXT/UTF8", language: "eng" }),
134
- trackEntry({ number: 3, type: 17, codecId: "S_TEXT/ASS", language: "rus" })
135
- ]));
136
-
137
- const clusterOne = element(ID_CLUSTER, Buffer.concat([
138
- uintElement(ID_TIMESTAMP, 1000),
139
- cueBlock({ track: 2, relativeTicks: 0, durationTicks: 2000, text: "First English line" }),
140
- cueBlock({
141
- track: 3,
142
- relativeTicks: 500,
143
- durationTicks: 1500,
144
- // ReadOrder, Layer, Style, Name, MarginL, MarginR, MarginV, Effect,
145
- // then the text — the Dialogue row without its header and its timestamps.
146
- text: "1,0,Default,,0000,0000,0000,,Первая русская строка"
147
- })
148
- ]));
149
- const clusterTwo = element(ID_CLUSTER, Buffer.concat([
150
- uintElement(ID_TIMESTAMP, 10_000),
151
- cueBlock({ track: 2, relativeTicks: 0, durationTicks: 1000, text: "Second English line" }),
152
- cueBlock({
153
- track: 3,
154
- relativeTicks: 250,
155
- durationTicks: 1000,
156
- text: "2,0,Default,,0000,0000,0000,,Вторая, с запятой"
157
- })
158
- ]));
159
-
160
- const cuesWith = (firstAt, secondAt) => element(ID_CUES, Buffer.concat([
161
- element(ID_CUE_POINT, Buffer.concat([
162
- uintElement(ID_CUE_TIME, 1000),
163
- element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
164
- uintElement(ID_CUE_TRACK, 2),
165
- uint32Element(ID_CUE_CLUSTER_POSITION, firstAt)
166
- ])),
167
- element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
168
- uintElement(ID_CUE_TRACK, 3),
169
- uint32Element(ID_CUE_CLUSTER_POSITION, firstAt)
170
- ]))
171
- ])),
172
- element(ID_CUE_POINT, Buffer.concat([
173
- uintElement(ID_CUE_TIME, 10_000),
174
- element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
175
- uintElement(ID_CUE_TRACK, 2),
176
- uint32Element(ID_CUE_CLUSTER_POSITION, secondAt)
177
- ])),
178
- element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
179
- uintElement(ID_CUE_TRACK, 3),
180
- uint32Element(ID_CUE_CLUSTER_POSITION, secondAt)
181
- ]))
182
- ]))
183
- ]));
184
-
185
- const seekEntry = (targetId, position) => element(ID_SEEK, Buffer.concat([
186
- element(ID_SEEK_ID, idBytes(targetId)),
187
- uint32Element(ID_SEEK_POSITION, position)
188
- ]));
189
- const seekHeadWith = (infoAt, tracksAt, cuesAt) => element(ID_SEEK_HEAD, Buffer.concat([
190
- seekEntry(ID_INFO, infoAt),
191
- seekEntry(ID_TRACKS, tracksAt),
192
- seekEntry(ID_CUES, cuesAt)
193
- ]));
194
-
195
- const headLength = seekHeadWith(0, 0, 0).length;
196
- const infoAt = headLength;
197
- const tracksAt = infoAt + info.length;
198
- const cuesAt = tracksAt + tracks.length;
199
- const firstClusterAt = cuesAt + cuesWith(0, 0).length;
200
- const secondClusterAt = firstClusterAt + clusterOne.length;
201
-
202
- const segmentPayload = Buffer.concat([
203
- seekHeadWith(infoAt, tracksAt, cuesAt),
204
- info,
205
- tracks,
206
- cuesWith(firstClusterAt, secondClusterAt),
207
- clusterOne,
208
- clusterTwo
209
- ]);
210
- const ebml = element(ID_EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
211
- const segment = element(ID_SEGMENT, segmentPayload);
212
- const segmentDataOffset = ebml.length + segment.length - segmentPayload.length;
213
- return {
214
- file: Buffer.concat([ebml, segment]),
215
- clusterAt: [segmentDataOffset + firstClusterAt, segmentDataOffset + secondClusterAt]
216
- };
217
- }
218
-
219
- /**
220
- * A torrent over one file, holding whichever pieces the caller says.
221
- *
222
- * @param {Buffer} bytes
223
- * @param {(index: number) => boolean} [holds] - Whether a piece is downloaded.
224
- * @returns {{ torrent: object, reads: Array<{ start: number, end: number }>, pieceLength: number }}
225
- */
226
- function torrentOver(bytes, holds = () => true) {
227
- const pieceLength = 64;
228
- const reads = [];
229
- const file = {
230
- name: "film.mkv",
231
- length: bytes.length,
232
- offset: 0,
233
- createReadStream({ start = 0, end = bytes.length - 1 } = {}) {
234
- reads.push({ start, end });
235
- return Readable.from((async function* chunks() {
236
- await new Promise((resolve) => setImmediate(resolve));
237
- yield bytes.subarray(start, end + 1);
238
- })());
239
- }
240
- };
241
- return {
242
- reads,
243
- pieceLength,
244
- torrent: {
245
- name: "film",
246
- pieceLength,
247
- bitfield: { get: (index) => holds(index) },
248
- files: [file]
249
- }
250
- };
251
- }
252
-
253
- test("a walk of a downloaded file gives up every cue, unframed, with its times", async () => {
254
- const { file } = buildFile();
255
- const { torrent } = torrentOver(file);
256
- const sourceKey = "a".repeat(40);
257
- forgetSubtitles(sourceKey);
258
- try {
259
- const plain = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
260
- assert.deepEqual(
261
- plain.cues.map((cue) => [cue.startSeconds, cue.endSeconds, cue.text]),
262
- [
263
- [1, 3, "First English line"],
264
- [10, 11, "Second English line"]
265
- ]
266
- );
267
-
268
- const ass = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 3);
269
- assert.deepEqual(
270
- ass.cues.map((cue) => [cue.startSeconds, cue.endSeconds, cue.text]),
271
- [
272
- [1.5, 3, "Первая русская строка"],
273
- [10.25, 11.25, "Вторая, с запятой"]
274
- ],
275
- "the eight fields Matroska puts before the text are the container's framing, not the words"
276
- );
277
- } finally {
278
- forgetSubtitles(sourceKey);
279
- }
280
- });
281
-
282
- test("the cursor is the order cues were FOUND, and it never repeats", async () => {
283
- const { file } = buildFile();
284
- const { torrent } = torrentOver(file);
285
- const sourceKey = "b".repeat(40);
286
- forgetSubtitles(sourceKey);
287
- try {
288
- const held = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
289
- const cursors = held.cues.map((cue) => cue.seq);
290
- assert.deepEqual(cursors, [1, 2], "two cues found, in the order they were read");
291
- assert.equal(new Set(cursors).size, cursors.length, "no cue shares a cursor with another");
292
- } finally {
293
- forgetSubtitles(sourceKey);
294
- }
295
- });
296
-
297
- test("a cluster whose bytes are not downloaded is left for next time", async () => {
298
- const { file, clusterAt } = buildFile();
299
- // Everything except the pieces the SECOND cluster sits in.
300
- const { torrent, pieceLength } = torrentOver(file, (index) => index * pieceLength < clusterAt[1]);
301
- const sourceKey = "c".repeat(40);
302
- forgetSubtitles(sourceKey);
303
- try {
304
- const held = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
305
- assert.deepEqual(
306
- held.cues.map((cue) => cue.text),
307
- ["First English line"],
308
- "the downloaded cluster is read and the other is not — nothing is asked of the swarm"
309
- );
310
- assert.equal(held.coveredClusters, 1);
311
- assert.equal(held.indexedClusters, 2, "the file states two, and one is not here yet");
312
- } finally {
313
- forgetSubtitles(sourceKey);
314
- }
315
- });
316
-
317
- test("one walk fills every track, and a second call reads no cluster again", async () => {
318
- const { file, clusterAt } = buildFile();
319
- const { torrent, reads } = torrentOver(file);
320
- const sourceKey = "d".repeat(40);
321
- forgetSubtitles(sourceKey);
322
- try {
323
- await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
324
- const clusterReads = reads.filter((range) => clusterAt.includes(range.start)).length;
325
-
326
- const other = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 3);
327
- assert.equal(other.cues.length, 2, "the other track was filled by the same walk");
328
- assert.equal(
329
- reads.filter((range) => clusterAt.includes(range.start)).length,
330
- clusterReads,
331
- "asking for the second track reads no cluster a second time"
332
- );
333
- } finally {
334
- forgetSubtitles(sourceKey);
335
- }
336
- });
337
-
338
- test("the warm pass reports what is new, by the number the browser knows", async () => {
339
- const { file } = buildFile();
340
- const { torrent } = torrentOver(file);
341
- const sourceKey = "e".repeat(40);
342
- forgetSubtitles(sourceKey);
343
- try {
344
- const first = await warmSubtitleCues(heldFileOver(torrent, 0, sourceKey));
345
- assert.deepEqual(
346
- first.map((entry) => [entry.trackIndex, entry.cues.length, entry.language]).sort(),
347
- [[0, 2, "eng"], [1, 2, "rus"]].sort(),
348
- "both text tracks gained two cues, numbered as ffmpeg numbers them"
349
- );
350
-
351
- const again = await warmSubtitleCues(heldFileOver(torrent, 0, sourceKey));
352
- assert.deepEqual(again, [], "nothing is new the second time round");
353
- } finally {
354
- forgetSubtitles(sourceKey);
355
- }
356
- });
357
-
358
- test("a torrent that cannot say which pieces it holds is refused, not answered emptily", async () => {
359
- const { file } = buildFile();
360
- const { torrent } = torrentOver(file);
361
- const sourceKey = "f".repeat(40);
362
- forgetSubtitles(sourceKey);
363
- try {
364
- const held = await cuesHeldFor({ ...heldFileOver(torrent, 0, sourceKey), heldRanges: null }, 2);
365
- assert.deepEqual(held.cues, []);
366
- assert.equal(held.track, null, "the answer says nothing was read, not that there is nothing");
367
- } finally {
368
- forgetSubtitles(sourceKey);
369
- }
370
- });
1
+ /**
2
+ * @file What comes out of a real cluster walk, end to end.
3
+ *
4
+ * This is the check the walk never had. Everything around it was covered — the
5
+ * numbering a track is asked for by, the framing one cue's bytes carry, the
6
+ * thread a pull is answered on — and the walk itself, six hundred lines of it,
7
+ * had none: a file is built here with real clusters carrying real blocks, and
8
+ * the cues that come back out are stated exactly. Two field defects landed on
9
+ * this path in one week; a move of this code without a check that would catch a
10
+ * regression is a change nobody can verify.
11
+ *
12
+ * The four things asserted are the four the walk exists for: the text of each
13
+ * cue with its times, the found-order cursor a browser follows, the rule that
14
+ * only already-downloaded clusters are read, and the rule that one walk fills
15
+ * every track of the file.
16
+ */
17
+
18
+ import test from "node:test";
19
+ import assert from "node:assert/strict";
20
+ import { Readable } from "node:stream";
21
+
22
+ import { cuesHeldFor, warmSubtitleCues, forgetSubtitles } from "../services/media/SubtitleCues.js";
23
+ import { heldFileOver } from "./helpers/held-file.js";
24
+
25
+ const ID_EBML = 0x1a45dfa3;
26
+ const ID_SEGMENT = 0x18538067;
27
+ const ID_SEEK_HEAD = 0x114d9b74;
28
+ const ID_SEEK = 0x4dbb;
29
+ const ID_SEEK_ID = 0x53ab;
30
+ const ID_SEEK_POSITION = 0x53ac;
31
+ const ID_INFO = 0x1549a966;
32
+ const ID_TIMESTAMP_SCALE = 0x2ad7b1;
33
+ const ID_TRACKS = 0x1654ae6b;
34
+ const ID_TRACK_ENTRY = 0xae;
35
+ const ID_TRACK_NUMBER = 0xd7;
36
+ const ID_TRACK_TYPE = 0x83;
37
+ const ID_CODEC_ID = 0x86;
38
+ const ID_LANGUAGE = 0x22b59c;
39
+ const ID_CUES = 0x1c53bb6b;
40
+ const ID_CUE_POINT = 0xbb;
41
+ const ID_CUE_TIME = 0xb3;
42
+ const ID_CUE_TRACK_POSITIONS = 0xb7;
43
+ const ID_CUE_TRACK = 0xf7;
44
+ const ID_CUE_CLUSTER_POSITION = 0xf1;
45
+ const ID_CLUSTER = 0x1f43b675;
46
+ const ID_TIMESTAMP = 0xe7;
47
+ const ID_BLOCK_GROUP = 0xa0;
48
+ const ID_BLOCK = 0xa1;
49
+ const ID_BLOCK_DURATION = 0x9b;
50
+
51
+ function idBytes(id) {
52
+ const bytes = [];
53
+ let rest = id;
54
+ while (rest > 0) {
55
+ bytes.unshift(rest & 0xff);
56
+ rest = Math.floor(rest / 256);
57
+ }
58
+ return Buffer.from(bytes);
59
+ }
60
+
61
+ /** A four-byte size: a valid variable-length integer whatever the payload. */
62
+ function sizeBytes(size) {
63
+ const buffer = Buffer.alloc(4);
64
+ buffer.writeUInt32BE(size, 0);
65
+ buffer[0] |= 0x10;
66
+ return buffer;
67
+ }
68
+
69
+ function element(id, payload) {
70
+ return Buffer.concat([idBytes(id), sizeBytes(payload.length), payload]);
71
+ }
72
+
73
+ function uintElement(id, value) {
74
+ const bytes = [];
75
+ let rest = value;
76
+ do {
77
+ bytes.unshift(rest & 0xff);
78
+ rest = Math.floor(rest / 256);
79
+ } while (rest > 0);
80
+ return element(id, Buffer.from(bytes));
81
+ }
82
+
83
+ function stringElement(id, value) {
84
+ return element(id, Buffer.from(value, "utf8"));
85
+ }
86
+
87
+ /** A fixed four bytes, so a table measured twice comes out the same length. */
88
+ function uint32Element(id, value) {
89
+ const payload = Buffer.alloc(4);
90
+ payload.writeUInt32BE(value, 0);
91
+ return element(id, payload);
92
+ }
93
+
94
+ function trackEntry({ number, type, codecId, language }) {
95
+ return element(ID_TRACK_ENTRY, Buffer.concat([
96
+ uintElement(ID_TRACK_NUMBER, number),
97
+ uintElement(ID_TRACK_TYPE, type),
98
+ stringElement(ID_CODEC_ID, codecId),
99
+ stringElement(ID_LANGUAGE, language)
100
+ ]));
101
+ }
102
+
103
+ /**
104
+ * One cue, as a BlockGroup so it can carry its own duration.
105
+ *
106
+ * @param {{ track: number, relativeTicks: number, durationTicks: number, text: string }} params
107
+ * @returns {Buffer}
108
+ */
109
+ function cueBlock({ track, relativeTicks, durationTicks, text }) {
110
+ const header = Buffer.alloc(4);
111
+ header[0] = 0x80 | track; // track numbers under 128 are one byte, marker set
112
+ header.writeInt16BE(relativeTicks, 1);
113
+ header[3] = 0;
114
+ const block = element(ID_BLOCK, Buffer.concat([header, Buffer.from(text, "utf8")]));
115
+ return element(ID_BLOCK_GROUP, Buffer.concat([block, uintElement(ID_BLOCK_DURATION, durationTicks)]));
116
+ }
117
+
118
+ /**
119
+ * A file with two text tracks and two clusters, each carrying a line for each
120
+ * track.
121
+ *
122
+ * Track 2 is `S_TEXT/UTF8`, whose block payload IS the text. Track 3 is
123
+ * `S_TEXT/ASS`, whose payload is the dialogue row without its `Dialogue:`
124
+ * header — eight comma-separated fields and then the words, which is what
125
+ * Matroska states and what the framing rule has to strip.
126
+ *
127
+ * @returns {{ file: Buffer, clusterAt: number[] }}
128
+ */
129
+ function buildFile() {
130
+ const info = element(ID_INFO, uintElement(ID_TIMESTAMP_SCALE, 1_000_000));
131
+ const tracks = element(ID_TRACKS, Buffer.concat([
132
+ trackEntry({ number: 1, type: 1, codecId: "V_MPEG4/ISO/AVC", language: "und" }),
133
+ trackEntry({ number: 2, type: 17, codecId: "S_TEXT/UTF8", language: "eng" }),
134
+ trackEntry({ number: 3, type: 17, codecId: "S_TEXT/ASS", language: "rus" })
135
+ ]));
136
+
137
+ const clusterOne = element(ID_CLUSTER, Buffer.concat([
138
+ uintElement(ID_TIMESTAMP, 1000),
139
+ cueBlock({ track: 2, relativeTicks: 0, durationTicks: 2000, text: "First English line" }),
140
+ cueBlock({
141
+ track: 3,
142
+ relativeTicks: 500,
143
+ durationTicks: 1500,
144
+ // ReadOrder, Layer, Style, Name, MarginL, MarginR, MarginV, Effect,
145
+ // then the text — the Dialogue row without its header and its timestamps.
146
+ text: "1,0,Default,,0000,0000,0000,,Первая русская строка"
147
+ })
148
+ ]));
149
+ const clusterTwo = element(ID_CLUSTER, Buffer.concat([
150
+ uintElement(ID_TIMESTAMP, 10_000),
151
+ cueBlock({ track: 2, relativeTicks: 0, durationTicks: 1000, text: "Second English line" }),
152
+ cueBlock({
153
+ track: 3,
154
+ relativeTicks: 250,
155
+ durationTicks: 1000,
156
+ text: "2,0,Default,,0000,0000,0000,,Вторая, с запятой"
157
+ })
158
+ ]));
159
+
160
+ const cuesWith = (firstAt, secondAt) => element(ID_CUES, Buffer.concat([
161
+ element(ID_CUE_POINT, Buffer.concat([
162
+ uintElement(ID_CUE_TIME, 1000),
163
+ element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
164
+ uintElement(ID_CUE_TRACK, 2),
165
+ uint32Element(ID_CUE_CLUSTER_POSITION, firstAt)
166
+ ])),
167
+ element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
168
+ uintElement(ID_CUE_TRACK, 3),
169
+ uint32Element(ID_CUE_CLUSTER_POSITION, firstAt)
170
+ ]))
171
+ ])),
172
+ element(ID_CUE_POINT, Buffer.concat([
173
+ uintElement(ID_CUE_TIME, 10_000),
174
+ element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
175
+ uintElement(ID_CUE_TRACK, 2),
176
+ uint32Element(ID_CUE_CLUSTER_POSITION, secondAt)
177
+ ])),
178
+ element(ID_CUE_TRACK_POSITIONS, Buffer.concat([
179
+ uintElement(ID_CUE_TRACK, 3),
180
+ uint32Element(ID_CUE_CLUSTER_POSITION, secondAt)
181
+ ]))
182
+ ]))
183
+ ]));
184
+
185
+ const seekEntry = (targetId, position) => element(ID_SEEK, Buffer.concat([
186
+ element(ID_SEEK_ID, idBytes(targetId)),
187
+ uint32Element(ID_SEEK_POSITION, position)
188
+ ]));
189
+ const seekHeadWith = (infoAt, tracksAt, cuesAt) => element(ID_SEEK_HEAD, Buffer.concat([
190
+ seekEntry(ID_INFO, infoAt),
191
+ seekEntry(ID_TRACKS, tracksAt),
192
+ seekEntry(ID_CUES, cuesAt)
193
+ ]));
194
+
195
+ const headLength = seekHeadWith(0, 0, 0).length;
196
+ const infoAt = headLength;
197
+ const tracksAt = infoAt + info.length;
198
+ const cuesAt = tracksAt + tracks.length;
199
+ const firstClusterAt = cuesAt + cuesWith(0, 0).length;
200
+ const secondClusterAt = firstClusterAt + clusterOne.length;
201
+
202
+ const segmentPayload = Buffer.concat([
203
+ seekHeadWith(infoAt, tracksAt, cuesAt),
204
+ info,
205
+ tracks,
206
+ cuesWith(firstClusterAt, secondClusterAt),
207
+ clusterOne,
208
+ clusterTwo
209
+ ]);
210
+ const ebml = element(ID_EBML, Buffer.from([0x42, 0x86, 0x81, 0x01]));
211
+ const segment = element(ID_SEGMENT, segmentPayload);
212
+ const segmentDataOffset = ebml.length + segment.length - segmentPayload.length;
213
+ return {
214
+ file: Buffer.concat([ebml, segment]),
215
+ clusterAt: [segmentDataOffset + firstClusterAt, segmentDataOffset + secondClusterAt]
216
+ };
217
+ }
218
+
219
+ /**
220
+ * A torrent over one file, holding whichever pieces the caller says.
221
+ *
222
+ * @param {Buffer} bytes
223
+ * @param {(index: number) => boolean} [holds] - Whether a piece is downloaded.
224
+ * @returns {{ torrent: object, reads: Array<{ start: number, end: number }>, pieceLength: number }}
225
+ */
226
+ function torrentOver(bytes, holds = () => true) {
227
+ const pieceLength = 64;
228
+ const reads = [];
229
+ const file = {
230
+ name: "film.mkv",
231
+ length: bytes.length,
232
+ offset: 0,
233
+ createReadStream({ start = 0, end = bytes.length - 1 } = {}) {
234
+ reads.push({ start, end });
235
+ return Readable.from((async function* chunks() {
236
+ await new Promise((resolve) => setImmediate(resolve));
237
+ yield bytes.subarray(start, end + 1);
238
+ })());
239
+ }
240
+ };
241
+ return {
242
+ reads,
243
+ pieceLength,
244
+ torrent: {
245
+ name: "film",
246
+ pieceLength,
247
+ bitfield: { get: (index) => holds(index) },
248
+ files: [file]
249
+ }
250
+ };
251
+ }
252
+
253
+ test("a walk of a downloaded file gives up every cue, unframed, with its times", async () => {
254
+ const { file } = buildFile();
255
+ const { torrent } = torrentOver(file);
256
+ const sourceKey = "a".repeat(40);
257
+ forgetSubtitles(sourceKey);
258
+ try {
259
+ const plain = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
260
+ assert.deepEqual(
261
+ plain.cues.map((cue) => [cue.startSeconds, cue.endSeconds, cue.text]),
262
+ [
263
+ [1, 3, "First English line"],
264
+ [10, 11, "Second English line"]
265
+ ]
266
+ );
267
+
268
+ const ass = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 3);
269
+ assert.deepEqual(
270
+ ass.cues.map((cue) => [cue.startSeconds, cue.endSeconds, cue.text]),
271
+ [
272
+ [1.5, 3, "Первая русская строка"],
273
+ [10.25, 11.25, "Вторая, с запятой"]
274
+ ],
275
+ "the eight fields Matroska puts before the text are the container's framing, not the words"
276
+ );
277
+ } finally {
278
+ forgetSubtitles(sourceKey);
279
+ }
280
+ });
281
+
282
+ test("the cursor is the order cues were FOUND, and it never repeats", async () => {
283
+ const { file } = buildFile();
284
+ const { torrent } = torrentOver(file);
285
+ const sourceKey = "b".repeat(40);
286
+ forgetSubtitles(sourceKey);
287
+ try {
288
+ const held = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
289
+ const cursors = held.cues.map((cue) => cue.seq);
290
+ assert.deepEqual(cursors, [1, 2], "two cues found, in the order they were read");
291
+ assert.equal(new Set(cursors).size, cursors.length, "no cue shares a cursor with another");
292
+ } finally {
293
+ forgetSubtitles(sourceKey);
294
+ }
295
+ });
296
+
297
+ test("a cluster whose bytes are not downloaded is left for next time", async () => {
298
+ const { file, clusterAt } = buildFile();
299
+ // Everything except the pieces the SECOND cluster sits in.
300
+ const { torrent, pieceLength } = torrentOver(file, (index) => index * pieceLength < clusterAt[1]);
301
+ const sourceKey = "c".repeat(40);
302
+ forgetSubtitles(sourceKey);
303
+ try {
304
+ const held = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
305
+ assert.deepEqual(
306
+ held.cues.map((cue) => cue.text),
307
+ ["First English line"],
308
+ "the downloaded cluster is read and the other is not — nothing is asked of the swarm"
309
+ );
310
+ assert.equal(held.coveredClusters, 1);
311
+ assert.equal(held.indexedClusters, 2, "the file states two, and one is not here yet");
312
+ } finally {
313
+ forgetSubtitles(sourceKey);
314
+ }
315
+ });
316
+
317
+ test("one walk fills every track, and a second call reads no cluster again", async () => {
318
+ const { file, clusterAt } = buildFile();
319
+ const { torrent, reads } = torrentOver(file);
320
+ const sourceKey = "d".repeat(40);
321
+ forgetSubtitles(sourceKey);
322
+ try {
323
+ await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 2);
324
+ const clusterReads = reads.filter((range) => clusterAt.includes(range.start)).length;
325
+
326
+ const other = await cuesHeldFor(heldFileOver(torrent, 0, sourceKey), 3);
327
+ assert.equal(other.cues.length, 2, "the other track was filled by the same walk");
328
+ assert.equal(
329
+ reads.filter((range) => clusterAt.includes(range.start)).length,
330
+ clusterReads,
331
+ "asking for the second track reads no cluster a second time"
332
+ );
333
+ } finally {
334
+ forgetSubtitles(sourceKey);
335
+ }
336
+ });
337
+
338
+ test("the warm pass reports what is new, by the number the browser knows", async () => {
339
+ const { file } = buildFile();
340
+ const { torrent } = torrentOver(file);
341
+ const sourceKey = "e".repeat(40);
342
+ forgetSubtitles(sourceKey);
343
+ try {
344
+ const first = await warmSubtitleCues(heldFileOver(torrent, 0, sourceKey));
345
+ assert.deepEqual(
346
+ first.map((entry) => [entry.trackIndex, entry.cues.length, entry.language]).sort(),
347
+ [[0, 2, "eng"], [1, 2, "rus"]].sort(),
348
+ "both text tracks gained two cues, numbered as ffmpeg numbers them"
349
+ );
350
+
351
+ const again = await warmSubtitleCues(heldFileOver(torrent, 0, sourceKey));
352
+ assert.deepEqual(again, [], "nothing is new the second time round");
353
+ } finally {
354
+ forgetSubtitles(sourceKey);
355
+ }
356
+ });
357
+
358
+ test("a torrent that cannot say which pieces it holds is refused, not answered emptily", async () => {
359
+ const { file } = buildFile();
360
+ const { torrent } = torrentOver(file);
361
+ const sourceKey = "f".repeat(40);
362
+ forgetSubtitles(sourceKey);
363
+ try {
364
+ const held = await cuesHeldFor({ ...heldFileOver(torrent, 0, sourceKey), heldRanges: null }, 2);
365
+ assert.deepEqual(held.cues, []);
366
+ assert.equal(held.track, null, "the answer says nothing was read, not that there is nothing");
367
+ } finally {
368
+ forgetSubtitles(sourceKey);
369
+ }
370
+ });