@torrent-tv/proxy 2.87.2 → 2.87.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 (465) 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 +2157 -2148
  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 +50 -50
  73. package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
  74. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  75. package/research/double-spawn-2026-09-10.md +171 -171
  76. package/research/handover-2026-09-13.md +209 -209
  77. package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
  78. package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
  79. package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
  80. package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
  81. package/routes/api/client-logs/post.js +86 -86
  82. package/routes/api/delivery-sink/get.js +72 -72
  83. package/routes/api/link-probe/get.js +51 -51
  84. package/routes/api/playback-plan/post.js +53 -53
  85. package/routes/api/sources/files/get.js +100 -100
  86. package/routes/api/sources/post.js +36 -36
  87. package/routes/api/sources/stats/get.js +132 -132
  88. package/routes/api/sources/warm/post.js +217 -181
  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 +129 -129
  92. package/routes/api/transcode-sessions/post.js +160 -160
  93. package/routes/api/transcode-sessions/progress/get.js +27 -27
  94. package/routes/api/transcode-sessions/release/post.js +41 -41
  95. package/routes/api/transcode-sessions/seek/post.js +63 -63
  96. package/routes/health/get.js +13 -13
  97. package/routes/healthz/get.js +13 -13
  98. package/routes/stream/get.js +361 -361
  99. package/routes/transcode/audio-file/get.js +64 -64
  100. package/routes/transcode/audio-warm/get.js +84 -84
  101. package/routes/transcode/session-file/get.js +52 -52
  102. package/routes/transcode/variant-file/get.js +95 -95
  103. package/routes/transcode/variant-warm/get.js +84 -84
  104. package/scripts/render-run-graph.js +173 -173
  105. package/server.js +721 -720
  106. package/services/encode/CoverageMap.js +428 -428
  107. package/services/encode/CushionReport.js +345 -345
  108. package/services/encode/EncodeAdmission.js +332 -332
  109. package/services/encode/EncodeOrchestrator.js +1217 -1217
  110. package/services/encode/EncodePlan.js +1366 -1366
  111. package/services/encode/EncodeRun.js +776 -776
  112. package/services/encode/EncodeRuns.js +1229 -1229
  113. package/services/encode/Encoder.js +142 -142
  114. package/services/encode/EncoderSelection.js +38 -38
  115. package/services/encode/LocalObservations.js +359 -359
  116. package/services/encode/NvencEncoder.js +50 -50
  117. package/services/encode/OutputOpening.js +755 -755
  118. package/services/encode/OutputTimes.js +579 -579
  119. package/services/encode/QsvEncoder.js +58 -58
  120. package/services/encode/Renditions.js +2162 -2162
  121. package/services/encode/RunProgress.js +84 -84
  122. package/services/encode/SegmentDemand.js +95 -95
  123. package/services/encode/SoftwareEncoder.js +121 -121
  124. package/services/encode/V4l2m2mEncoder.js +53 -53
  125. package/services/encode/VaapiEncoder.js +66 -66
  126. package/services/encode/args.js +416 -416
  127. package/services/encode/available-share.js +89 -89
  128. package/services/encode/calibration.js +361 -361
  129. package/services/encode/contention.js +128 -128
  130. package/services/encode/decode-cost-fit.js +363 -363
  131. package/services/encode/encode-exit.js +114 -114
  132. package/services/encode/encode-run-state.js +551 -551
  133. package/services/encode/encoder-readings.js +45 -45
  134. package/services/encode/fingerprint.js +322 -322
  135. package/services/encode/host-load.js +174 -174
  136. package/services/encode/hwaccel.js +1894 -1894
  137. package/services/encode/index.js +9 -9
  138. package/services/encode/learned-median.js +90 -90
  139. package/services/encode/output/EncodedOutput.js +57 -57
  140. package/services/encode/output/Output.js +131 -131
  141. package/services/encode/output/OutputCatalog.js +414 -414
  142. package/services/encode/output/OutputSpec.js +390 -390
  143. package/services/encode/output/Timeline.js +308 -308
  144. package/services/encode/output/cut-grid.js +107 -107
  145. package/services/encode/output/index.js +20 -20
  146. package/services/encode/output/ladder.js +32 -32
  147. package/services/encode/output/playlists.js +284 -284
  148. package/services/encode/output/rates.js +125 -125
  149. package/services/encode/output-key-format.js +21 -21
  150. package/services/encode/quality/EncodeCost.js +1083 -1083
  151. package/services/encode/quality/HostLoad.js +525 -525
  152. package/services/encode/quality/HostTimings.js +249 -249
  153. package/services/encode/quality/OutputQualityState.js +28 -28
  154. package/services/encode/quality/QualityController.js +935 -935
  155. package/services/encode/quality/QualityOffer.js +416 -416
  156. package/services/encode/quality/drain-threat.js +47 -47
  157. package/services/encode/quality/link-budget.js +254 -254
  158. package/services/encode/quality/output-format.js +266 -266
  159. package/services/encode/quality/serving-output.js +216 -216
  160. package/services/encode/quality/visible-rung.js +57 -57
  161. package/services/encode/run-budget.js +97 -97
  162. package/services/encode/run-command.js +747 -747
  163. package/services/encode/run-costs.js +155 -155
  164. package/services/encode/run-inputs.js +42 -42
  165. package/services/encode/segment-formats/fmp4.js +437 -437
  166. package/services/encode/segment-formats/index.js +77 -77
  167. package/services/encode/segment-formats/init-compat.js +324 -324
  168. package/services/encode/segment-formats/mp4-boxes.js +311 -311
  169. package/services/encode/segment-formats/mpegts.js +134 -134
  170. package/services/encode/start-stop-cost.js +178 -178
  171. package/services/encode/throughput.js +97 -97
  172. package/services/encode/torrent-cost.js +88 -88
  173. package/services/identity/installation-id.js +38 -38
  174. package/services/media/ContainerOrchestrator.js +149 -149
  175. package/services/media/KeyframeTables.js +316 -316
  176. package/services/media/SourceFile.js +298 -298
  177. package/services/media/SubtitleCues.js +520 -520
  178. package/services/media/SubtitleOrchestrator.js +167 -167
  179. package/services/media/audio-inventory.js +212 -212
  180. package/services/media/container/AviContainer.js +266 -266
  181. package/services/media/container/Container.js +603 -603
  182. package/services/media/container/ContainerFactory.js +56 -56
  183. package/services/media/container/KeyframeTable.js +272 -272
  184. package/services/media/container/MatroskaContainer.js +1494 -1494
  185. package/services/media/container/Mp4Container.js +1244 -1244
  186. package/services/media/container/SubtitleFileContainer.js +322 -322
  187. package/services/media/container/ebml-reader.js +159 -159
  188. package/services/media/ffmpeg-banner.js +260 -260
  189. package/services/media/keyframe-probe.js +157 -157
  190. package/services/media/media-info-probe.js +93 -93
  191. package/services/media/playback-planner.js +856 -848
  192. package/services/media/tracks/AudioTrack.js +131 -131
  193. package/services/media/tracks/ContainerTrack.js +75 -75
  194. package/services/media/tracks/ImageSubtitleTrack.js +19 -19
  195. package/services/media/tracks/SubtitleTrack.js +38 -38
  196. package/services/media/tracks/TextSubtitleTrack.js +287 -287
  197. package/services/media/tracks/VideoTrack.js +33 -33
  198. package/services/media/tracks/index.js +15 -15
  199. package/services/media/tracks/language-detect.js +174 -174
  200. package/services/server/OutputLifecycle.js +418 -418
  201. package/services/server/SegmentServing.js +1146 -1146
  202. package/services/server/ViewerRequests.js +522 -522
  203. package/services/{viewer → server}/WaitLedger.js +142 -142
  204. package/services/server/controllers/PlaybackController.js +36 -36
  205. package/services/server/controllers/SubtitleController.js +109 -109
  206. package/services/server/http-responses.js +60 -60
  207. package/services/server/transcode-session-files.js +325 -325
  208. package/services/server/wire-outputs.js +983 -983
  209. package/services/storage/Diagnostics.js +202 -202
  210. package/services/storage/MachineBudget.js +235 -235
  211. package/services/storage/allowance.js +107 -107
  212. package/services/storage/core-dumps.js +106 -106
  213. package/services/storage/files/CompletedFiles.js +391 -391
  214. package/services/storage/files/piece-from-whole-file.js +118 -118
  215. package/services/storage/free.js +71 -71
  216. package/services/storage/keep.js +48 -48
  217. package/services/storage/machine-memory.js +56 -56
  218. package/services/storage/memory-report.js +575 -575
  219. package/services/storage/piece-store/piece-disk-store.js +516 -516
  220. package/services/storage/piece-store/piece-lru.js +495 -495
  221. package/services/storage/piece-store/shared-piece-store.js +1880 -1880
  222. package/services/storage/returns.js +103 -103
  223. package/services/storage/segment-store/SegmentStore.js +1196 -1196
  224. package/services/storage/wire.js +175 -175
  225. package/services/torrent/Contents.js +324 -324
  226. package/services/torrent/demand/DemandRegister.js +202 -202
  227. package/services/torrent/demand/Urgency.js +137 -137
  228. package/services/torrent/demand/Window.js +118 -118
  229. package/services/torrent/demand/index.js +8 -8
  230. package/services/torrent/demand/pieces.js +140 -140
  231. package/services/torrent/download/SwarmSelection.js +386 -386
  232. package/services/torrent/download/registry.js +102 -102
  233. package/services/torrent/download/withdraw-claim.js +80 -80
  234. package/services/torrent/files.js +455 -455
  235. package/services/torrent/naming.js +619 -619
  236. package/services/torrent/piece-store-of.js +29 -29
  237. package/services/torrent/supply-margin.js +262 -262
  238. package/services/torrent/torrent-pool.js +2675 -2635
  239. package/services/torrent/torrent-source-key.js +38 -38
  240. package/services/torrent/worker/background-fill.js +213 -213
  241. package/services/torrent/worker/channel.js +271 -271
  242. package/services/torrent/worker/client.js +765 -760
  243. package/services/torrent/worker/fastest-wires.js +342 -342
  244. package/services/torrent/worker/handle-state.js +23 -23
  245. package/services/torrent/worker/held-bytes.js +155 -155
  246. package/services/torrent/worker/install-webrtc-shim.js +32 -32
  247. package/services/torrent/worker/piece-reader.js +1078 -1078
  248. package/services/torrent/worker/pool-adapter.js +365 -350
  249. package/services/torrent/worker/protocol.js +184 -182
  250. package/services/torrent/worker/resume-warm.js +107 -107
  251. package/services/torrent/worker/webrtc-shim.js +219 -219
  252. package/services/torrent/worker/worker.js +1129 -1116
  253. package/services/transport/data-channel-handler.js +1356 -1356
  254. package/services/transport/delivery-probe.js +842 -842
  255. package/services/transport/health-collector.js +53 -53
  256. package/services/transport/nat-classifier.js +231 -231
  257. package/services/transport/packet-witness.js +808 -808
  258. package/services/transport/port-mapper.js +235 -235
  259. package/services/transport/registry-api.js +81 -81
  260. package/services/transport/tunnel-client.js +447 -447
  261. package/services/transport/usrsctp-state.js +175 -175
  262. package/services/transport/webrtc-manager.js +484 -484
  263. package/services/viewer/Assignments.js +340 -340
  264. package/services/viewer/PriorityMap.js +390 -390
  265. package/services/viewer/PriorityOrchestrator.js +325 -325
  266. package/services/viewer/Viewer.js +657 -657
  267. package/services/viewer/Viewers.js +368 -368
  268. package/services/viewer/active-output.js +37 -37
  269. package/services/viewer/audio-start.js +46 -46
  270. package/services/viewer/buffer-trend.js +81 -81
  271. package/services/viewer/choices.js +647 -647
  272. package/services/viewer/positions.js +126 -126
  273. package/services/viewer/report-intake.js +46 -46
  274. package/store/source-registry.js +73 -73
  275. package/test/asset-paths.test.js +28 -28
  276. package/test/audio-inventory.test.js +176 -176
  277. package/test/audio-track-bitrate.test.js +40 -40
  278. package/test/auto-quality-step.test.js +707 -707
  279. package/test/available-share.test.js +76 -76
  280. package/test/background-fill.test.js +190 -190
  281. package/test/client-log-file.test.js +110 -110
  282. package/test/completed-files.test.js +115 -115
  283. package/test/concurrent-cost.test.js +148 -148
  284. package/test/container-media-info.test.js +228 -228
  285. package/test/contention.test.js +76 -76
  286. package/test/core-dumps.test.js +57 -57
  287. package/test/coverage-follows-the-disk.test.js +228 -228
  288. package/test/coverage-map.test.js +195 -195
  289. package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
  290. package/test/cut-times-timeline.test.js +65 -65
  291. package/test/cuts-follow-published-grid.test.js +109 -109
  292. package/test/data-channel-frame.test.js +63 -63
  293. package/test/dead-torrent-handle.test.js +52 -52
  294. package/test/declared-rates.test.js +116 -116
  295. package/test/declared-tracks.test.js +35 -35
  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 +161 -161
  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/every-claimant-is-told-its-share.test.js +152 -152
  316. package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
  317. package/test/failed-start-breaker.test.js +202 -202
  318. package/test/fastest-wires.test.js +143 -143
  319. package/test/ffmpeg-stream-counts.test.js +78 -78
  320. package/test/file-edges.test.js +191 -191
  321. package/test/fmp4-self-contained.test.js +80 -80
  322. package/test/fmp4-timestamps.test.js +140 -140
  323. package/test/fmp4-track-completeness.test.js +41 -41
  324. package/test/format-keyed-outputs.test.js +78 -78
  325. package/test/health-metrics.test.js +38 -38
  326. package/test/held-request-width.test.js +157 -157
  327. package/test/helpers/encode-run.js +136 -136
  328. package/test/helpers/held-file.js +29 -29
  329. package/test/helpers/manager.js +57 -57
  330. package/test/helpers/output-spec.js +63 -63
  331. package/test/host-load.test.js +68 -68
  332. package/test/index-accuracy-is-about-the-file.test.js +128 -128
  333. package/test/init-compat.test.js +219 -219
  334. package/test/input-lost-quiets-the-plan.test.js +261 -261
  335. package/test/input-unavailable.test.js +48 -48
  336. package/test/installation-id.test.js +39 -39
  337. package/test/keeping-period.test.js +83 -83
  338. package/test/keyframe-index-accuracy.test.js +188 -188
  339. package/test/keyframe-table-budget.test.js +102 -102
  340. package/test/keyframes-belong-to-the-file.test.js +249 -249
  341. package/test/learned-median.test.js +37 -37
  342. package/test/letting-go-asks-who-is-watching.test.js +191 -191
  343. package/test/limit-row-by-area.test.js +60 -60
  344. package/test/link-budget.test.js +111 -111
  345. package/test/link-probe.test.js +56 -56
  346. package/test/local-encoding-data.test.js +273 -273
  347. package/test/logger-repeats.test.js +134 -134
  348. package/test/look-ahead-coverage.test.js +56 -56
  349. package/test/manager-surface.test.js +292 -294
  350. package/test/matroska-cues-track.test.js +192 -192
  351. package/test/memory-budget.test.js +390 -390
  352. package/test/move-cost.test.js +216 -216
  353. package/test/mp4-subtitles.test.js +173 -173
  354. package/test/one-authority.test.js +285 -285
  355. package/test/one-budget.test.js +149 -149
  356. package/test/one-output-one-session.test.js +204 -204
  357. package/test/one-resource-divided.test.js +185 -185
  358. package/test/one-serving-output-per-height.test.js +458 -458
  359. package/test/orchestrator-wired.test.js +206 -206
  360. package/test/output-catalog.test.js +39 -39
  361. package/test/output-shape.test.js +21 -21
  362. package/test/output-spec.test.js +251 -251
  363. package/test/output-speed.test.js +88 -88
  364. package/test/outputs-being-prepared.test.js +40 -40
  365. package/test/packet-witness-ring.test.js +236 -236
  366. package/test/packet-witness.test.js +148 -148
  367. package/test/piece-disk-store.test.js +381 -381
  368. package/test/piece-from-whole-file.test.js +129 -129
  369. package/test/piece-lru.test.js +319 -319
  370. package/test/piece-reader.test.js +162 -162
  371. package/test/piece-selection-offset.test.js +85 -85
  372. package/test/piece-store-eviction.test.js +560 -560
  373. package/test/piece-store-never-refuses.test.js +153 -153
  374. package/test/piece-store-reservations.test.js +318 -318
  375. package/test/piece-store-slow-disk.test.js +159 -159
  376. package/test/piece-tail.test.js +97 -97
  377. package/test/plan-host-timings.test.js +68 -68
  378. package/test/plan-is-steady.test.js +225 -225
  379. package/test/priority-map-download.test.js +174 -174
  380. package/test/priority-map-emptied.test.js +204 -204
  381. package/test/priority-map-per-output.test.js +215 -215
  382. package/test/priority-map.test.js +163 -163
  383. package/test/probe-wedge-certainty.test.js +60 -60
  384. package/test/produced-copy-choice.test.js +213 -213
  385. package/test/published-timeline.test.js +83 -83
  386. package/test/quality-offer.test.js +162 -162
  387. package/test/quality-variants.test.js +1229 -1229
  388. package/test/rate-control-in-the-output.test.js +180 -180
  389. package/test/read-survives-withdrawal.test.js +164 -164
  390. package/test/read-window.test.js +365 -365
  391. package/test/resume-warm.test.js +39 -39
  392. package/test/run-graph-drift.test.js +37 -37
  393. package/test/run-inputs.test.js +80 -80
  394. package/test/run-intervals.test.js +100 -100
  395. package/test/run-position-follows-published-grid.test.js +89 -89
  396. package/test/run-progress.test.js +65 -65
  397. package/test/same-height-switch.test.js +664 -664
  398. package/test/seek-frees-the-viewers-requests.test.js +217 -217
  399. package/test/seek-landing.test.js +109 -109
  400. package/test/seek-target-not-superseded.test.js +195 -195
  401. package/test/segment-closed-on-both-branches.test.js +96 -96
  402. package/test/segment-cut-times.test.js +63 -63
  403. package/test/segment-demand.test.js +80 -80
  404. package/test/segment-hold-supersede.test.js +91 -91
  405. package/test/segment-judged-by-its-own-header.test.js +221 -221
  406. package/test/segment-serve-wiring.test.js +475 -475
  407. package/test/segment-store-eviction.test.js +247 -247
  408. package/test/segment-store.test.js +323 -323
  409. package/test/segment-true-start.test.js +86 -86
  410. package/test/segments-are-shared.test.js +176 -176
  411. package/test/send-chunk-bytes.test.js +86 -86
  412. package/test/serving-existing-output.test.js +102 -102
  413. package/test/serving-output.test.js +102 -102
  414. package/test/shared-piece-store.test.js +310 -310
  415. package/test/sidecar-naming.test.js +142 -142
  416. package/test/source-file.test.js +133 -133
  417. package/test/source-files-route.test.js +103 -103
  418. package/test/split-a-stretch.test.js +139 -139
  419. package/test/stale-request-after-seek.test.js +158 -158
  420. package/test/startup-readings.test.js +124 -124
  421. package/test/stream-route.test.js +182 -182
  422. package/test/subtitle-cue-framing.test.js +200 -200
  423. package/test/subtitle-cue-source.test.js +102 -102
  424. package/test/subtitle-cue-walk.test.js +370 -370
  425. package/test/subtitle-cursor.test.js +63 -63
  426. package/test/subtitle-defaults.test.js +118 -118
  427. package/test/subtitle-language.test.js +252 -252
  428. package/test/subtitle-track-numbering.test.js +386 -386
  429. package/test/supply-margin.test.js +177 -177
  430. package/test/swarm-follows-readers.test.js +174 -174
  431. package/test/swarm-reach.test.js +130 -130
  432. package/test/swarm-selection.test.js +220 -220
  433. package/test/tail-duplication.test.js +167 -167
  434. package/test/the-channel-has-both-ends.test.js +91 -91
  435. package/test/the-torrent-thread-serves-bytes.test.js +107 -107
  436. package/test/thread-pool.test.js +53 -53
  437. package/test/timeline.test.js +84 -84
  438. package/test/torrent-contents.test.js +235 -235
  439. package/test/torrent-cost.test.js +71 -71
  440. package/test/torrent-files.test.js +221 -221
  441. package/test/torrent-naming.test.js +255 -255
  442. package/test/tracks-begin-together.test.js +209 -209
  443. package/test/tunnel-renewal.test.js +167 -167
  444. package/test/two-viewers-one-picture.test.js +407 -407
  445. package/test/upload-hurry.test.js +186 -186
  446. package/test/usrsctp-state.test.js +131 -131
  447. package/test/video-facts.test.js +102 -102
  448. package/test/viewer-assignments.test.js +143 -143
  449. package/test/viewer-outputs.test.js +285 -285
  450. package/test/viewer-presence.test.js +116 -116
  451. package/test/viewer-requests-admission.test.js +89 -89
  452. package/test/viewer-states.test.js +189 -189
  453. package/test/viewer-subtitle-subscription.test.js +96 -96
  454. package/test/viewer.test.js +139 -139
  455. package/test/viewing-generations.test.js +390 -390
  456. package/test/visible-rung.test.js +37 -37
  457. package/test/wait-ledger.test.js +100 -100
  458. package/test/webrtc-shim.test.js +149 -149
  459. package/test/wedge-certainty.test.js +131 -131
  460. package/test/withdraw-piece-claim.test.js +212 -212
  461. package/test/worker-channel.test.js +158 -158
  462. package/utils/client-log-file.js +151 -151
  463. package/utils/logger.js +312 -312
  464. package/utils/parse-range.js +25 -25
  465. package/utils/perf.js +59 -59
@@ -1,983 +1,983 @@
1
- /**
2
- * @file Wiring of the outputs, the viewers and the encoding.
3
- *
4
- * Builds each component and hands it the narrow host it reads, and nothing
5
- * else. It holds no behaviour: every member that used to be a method of the
6
- * session manager is a method of the component that owns it now. What it
7
- * returns is the set of components and the settings they share, for
8
- * `server.js` to give each route the ones that route asks.
9
- */
10
-
11
- import { logger } from "../../utils/logger.js";
12
- import { KeyframeTables } from "../media/KeyframeTables.js";
13
- import { waits } from "../viewer/WaitLedger.js";
14
- import { readMachineState, readProcessCpuSeconds, readProxyCpuSeconds, readSystemCpu, shareOfMachine } from "../encode/host-load.js";
15
- import { minimumBufferFrom } from "../torrent/supply-margin.js";
16
- import { PriorityOrchestrator } from "../viewer/PriorityOrchestrator.js";
17
- import { softwareDescriptor } from "../encode/hwaccel.js";
18
- import { resolveSegmentFormat } from "../encode/segment-formats/index.js";
19
- import { Timelines } from "../encode/output/Timeline.js";
20
- import { SourceFiles } from "../media/SourceFile.js";
21
- import { SegmentStore } from "../storage/segment-store/SegmentStore.js";
22
- import { EncodeCost } from "../encode/quality/EncodeCost.js";
23
- import { QualityOffer } from "../encode/quality/QualityOffer.js";
24
- import { activeOutputFor } from "../viewer/active-output.js";
25
- import {
26
- acceptsGeneration,
27
- askQualityOf,
28
- audioBeingWarmedOf,
29
- audioChoiceOf,
30
- chooseAudioTrack,
31
- chooseOutput,
32
- chosenOutputOf,
33
- consumersOn,
34
- dropAskOf,
35
- generationOfRequest,
36
- givenOutputOf,
37
- heightsChosenAs,
38
- highestGivenSegmentOf,
39
- holdForResponse,
40
- linkMbpsOf,
41
- linkReportOf,
42
- bufferOf,
43
- bufferedSecondsOf,
44
- visiblePictureOf,
45
- linkReportsOn,
46
- noteAudioBeingWarmed,
47
- noteGivenOutput,
48
- noteSameHeightSwitch,
49
- noteServingVerdict,
50
- noteStepBeingWarmed,
51
- noteStepOnScreen,
52
- outputsBeingPrepared,
53
- placeOn,
54
- presentOn,
55
- qualityModeOf,
56
- sameHeightSwitchOf,
57
- servingVerdictOf,
58
- standingAskOf,
59
- stepBeingWarmedOf,
60
- stepBeingWarmedSinceOf,
61
- stepOnScreenOf,
62
- switchingOnto,
63
- watches
64
- } from "../viewer/choices.js";
65
- import { viewerSecondsOn, viewerSegmentsOn } from "../viewer/positions.js";
66
- import { Viewers } from "../viewer/Viewers.js";
67
- import { OutputCatalog } from "../encode/output/OutputCatalog.js";
68
- import { ViewerRequests } from "./ViewerRequests.js";
69
- import { OutputLifecycle } from "./OutputLifecycle.js";
70
- import { SegmentServing } from "./SegmentServing.js";
71
- import { audioStartSecondsFor } from "../viewer/audio-start.js";
72
- import { audioRenditionName } from "../media/audio-inventory.js";
73
- import { Renditions } from "../encode/Renditions.js";
74
- import { CushionReport, LOOKAHEAD_PAUSE_SECONDS } from "../encode/CushionReport.js";
75
- import { EncodeRuns } from "../encode/EncodeRuns.js";
76
- import { OutputTimes } from "../encode/OutputTimes.js";
77
- import { HostLoad } from "../encode/quality/HostLoad.js";
78
- import { HostTimings } from "../encode/quality/HostTimings.js";
79
- import { BUDGET_CHECK_INTERVAL_MS, QualityController } from "../encode/quality/QualityController.js";
80
- import { EncodeOrchestrator } from "../encode/EncodeOrchestrator.js";
81
- import { EncodeAdmission } from "../encode/EncodeAdmission.js";
82
- import { EncoderSelection } from "../encode/EncoderSelection.js";
83
- import { OutputOpening } from "../encode/OutputOpening.js";
84
- import { segmentFormatOfKey } from "../encode/output-key-format.js";
85
- import { OutputSpec } from "../encode/output/OutputSpec.js";
86
- import { compareInits } from "../encode/segment-formats/init-compat.js";
87
- import { nominalKbpsFor } from "../encode/args.js";
88
- import { probeInputMediaInfo } from "../media/media-info-probe.js";
89
- import { probeVideoKeyframeTimes } from "../media/keyframe-probe.js";
90
- import { wireMachineBudget } from "../storage/wire.js";
91
- import { Returns } from "../storage/returns.js";
92
- import { freeBytesFor } from "../storage/free.js";
93
- import path from "node:path";
94
- import { contentOf, LocalObservations } from "../encode/LocalObservations.js";
95
- import { configurationKeyOf } from "../encode/fingerprint.js";
96
- import { PROXY_ROOT } from "../encode/quality/HostTimings.js";
97
- import { qualityStateOf } from "../encode/quality/OutputQualityState.js";
98
-
99
- // Where a variant and an audio rendition live under a session — `v/<height>/…`
100
- // and `a/<track>/…` — is stated in `encode/output/playlists.js`, beside the lines that
101
- // write those addresses into a master playlist. The routes that parse them back
102
- // are in `server.js`.
103
-
104
- const CLEANUP_INTERVAL_MS = 30_000;
105
- const DEFAULT_SEGMENT_DURATION_SEC = 4;
106
- // Idle TTL: a session is disposed this long after the last segment/playlist
107
- // access. Long enough that a viewer who pauses, backgrounds the tab, or briefly
108
- // turns the phone off can resume WITHOUT a cold ffmpeg restart (the warm session
109
- // also backs the seamless auto-reconnect). ffmpeg stops producing at the
110
- // look-ahead cap when idle, so a lingering session costs retained segments on
111
- // disk, not sustained CPU. Active playback refreshes the timer on every segment
112
- // fetch, so it never expires mid-watch.
113
- // How long a session outlives the BROWSER, not the viewing. Since server
114
- // 0.8.103 a browser that holds a session re-asserts it every 30 s, so an open
115
- // tab never consumes this at all — not while paused, not across a three-hour
116
- // film. What is left is the case where the browser has genuinely gone: the tab
117
- // was killed without releasing, the phone slept, the network dropped. Keeping
118
- // the session means such a viewer comes back to a warm encoder instead of
119
- // waiting out a cold start; the cost while nobody is there is disk for the
120
- // produced segments, since the encoder is suspended and burns no CPU, and that
121
- // disk is already bounded by the pool's 10 GB cap with eviction. Thirty minutes
122
- // covers a meal, a phone call or a lift ride.
123
- const DEFAULT_SESSION_TTL_MS = 30 * 60 * 1000;
124
- const DEFAULT_STARTUP_WAIT_MS = 5_000;
125
-
126
- /**
127
- * Convert a bind-all host address to the loopback address so that
128
- * the HLS input URL is always reachable from the same machine.
129
- *
130
- * @param {string} host
131
- * @returns {string}
132
- */
133
- function toLoopbackHost(host) {
134
- if (host === "0.0.0.0" || host === "::") {
135
- return "127.0.0.1";
136
- }
137
- return host;
138
- }
139
-
140
- /**
141
- * Build the HTTP base URL (scheme + host + port) for the local proxy server.
142
- *
143
- * @param {string} host - Bind host (may be "0.0.0.0" or "::").
144
- * @param {number} port
145
- * @returns {string} e.g. "http://127.0.0.1:9090"
146
- */
147
- function buildHttpBaseUrl(host, port) {
148
- const url = new URL("http://localhost");
149
- url.hostname = toLoopbackHost(host);
150
- url.port = String(port);
151
- return url.origin;
152
- }
153
-
154
- /**
155
- * @typedef {Object} WireOutputsOptions
156
- * @property {boolean} enabled - Whether HLS transcoding is enabled.
157
- * @property {string} ffmpegBin - Path to the ffmpeg executable.
158
- * @property {string} localBindHost - Host the proxy HTTP server is bound to.
159
- * @property {number} localPort - Port the proxy HTTP server is listening on.
160
- * @property {number} [segmentDurationSec] - HLS segment length in seconds.
161
- * @property {number} [sessionTtlMs] - Session idle TTL in milliseconds.
162
- * @property {number} [startupWaitMs] - Max time to wait for the first playlist file.
163
- * @property {string} [segmentFormatId] - Output container: "fmp4" (default)
164
- * or "mpegts". See `../segment-formats/index.js`.
165
- */
166
-
167
- /**
168
- * @typedef {Object} HlsSession
169
- * @property {string} id - The name of the output it produces.
170
- * @property {string} fileName - Display name of the file being transcoded.
171
- * @property {import("../media/container/KeyframeTable.js").KeyframeTable} keyframes -
172
- * Where this file's keyframes are. One object per file, held by every session
173
- * of it, so a table read late still reaches them. Used to snap a source seek
174
- * onto a known-valid position (see #startEncodeRun).
175
- */
176
-
177
- /**
178
- * Build the components and connect them.
179
- *
180
- * @param {WireOutputsOptions} options
181
- * @returns {object} The components, and the settings they read.
182
- */
183
- export function wireOutputs({
184
- enabled,
185
- ffmpegBin,
186
- localBindHost,
187
- localPort,
188
- segmentDurationSec = DEFAULT_SEGMENT_DURATION_SEC,
189
- sessionTtlMs = DEFAULT_SESSION_TTL_MS,
190
- startupWaitMs = DEFAULT_STARTUP_WAIT_MS,
191
- // Where every file's keyframe table lives, and the only thing that reads
192
- // one. A session asks for its file's table and is handed the object every
193
- // other reader of that file holds, so a table that arrives late reaches the
194
- // sessions created before it. Built here when nothing supplied one, which
195
- // is a registry with no reader: it answers "not read" about every file, and
196
- // every picture is then re-encoded — the correct behaviour for a proxy
197
- // wired without a container reader, and what every unit test gets.
198
- keyframeTables = new KeyframeTables(),
199
- videoEncoder = null,
200
- softwarePresetBenchmark = null,
201
- // What every encoder this host may use was qualified and measured to do at
202
- // startup, by kind (`encode/calibration.js`). Takes the place of the one
203
- // array above, which a test may still hand in on its own.
204
- calibration = null,
205
- decodeCostModel = null,
206
- getSourceStats = null,
207
- setPriorityMap = null,
208
- // What a second job costs on this host, measured at startup. Null when it
209
- // could not be measured, and then nothing is corrected — the alternative
210
- // is inventing a penalty, which is the same fault as inventing a fill rate.
211
- contentionPenalties = null,
212
- copySpeedX = null,
213
- tonemapSupported = false,
214
- getCachedMediaInfo = null,
215
- getCachedAudioTracks = null,
216
- getContainerMediaInfo = null,
217
- fetchWholeFile = null,
218
- segmentFormatId = undefined,
219
- stateDir = "",
220
- segmentStore = null,
221
- getTorrentTotals,
222
- startStopCost = null,
223
- spillDisk = null,
224
- wholeFiles = null,
225
- diagnostics = null,
226
- diagnosticsRoot = "",
227
- memoryClaimant = null,
228
- budgetPolicy = null}) {
229
- const parts = {};
230
- // Encode components receive only the storage operations they use. The
231
- // concrete SegmentStore remains owned by this assembly and is never handed
232
- // to the encode layer.
233
- const segmentCoverage = {
234
- provenNumbers: (address) => parts.segmentStore.provenNumbers(address),
235
- announce: (address, index) => parts.segmentStore.announce(address, index),
236
- filesHeld: (address) => parts.segmentStore.filesHeld(address),
237
- clearUpAfter: (address, startedAt) => parts.segmentStore.clearUpAfter(address, startedAt)
238
- };
239
- const segmentFiles = {
240
- pathFor: (address) => parts.segmentStore.pathFor(address),
241
- initOf: (address) => parts.segmentStore.initOf(address),
242
- directoryFor: (address) => parts.segmentStore.directoryFor(address),
243
- publish: (address, makingName, format) => parts.segmentStore.publish(address, makingName, format)
244
- };
245
- const segmentOutputFiles = {
246
- addresses: () => parts.segmentStore.addresses(),
247
- isClosed: (address, index) => parts.segmentStore.isClosed(address, index),
248
- lastReadAt: (address) => parts.segmentStore.lastReadAt(address),
249
- directoryFor: (address) => parts.segmentStore.directoryFor(address),
250
- useFormat: (address, format) => parts.segmentStore.useFormat(address, format)
251
- };
252
- const segmentPaths = {
253
- pathOf: (address, index) => parts.segmentStore.pathOf(address, index)
254
- };
255
- /**
256
- * Whether everything this output will ever serve is made: every segment of
257
- * its timeline closed in the store. Such an output needs no encoder and
258
- * holds no place, however many watch it.
259
- *
260
- * @param {object} session
261
- * @returns {boolean}
262
- */
263
- const finishedOutput = (session) => {
264
- const count = Number(session?.timeline?.segmentCount) || 0;
265
- return count > 0 && parts.segmentStore.provenNumbers(session.outputKey).length >= count;
266
- };
267
- // The nominal limits a size may be produced at, highest first. ONE list, read
268
- // by the opening of an output and by the move between limits of a height, so
269
- // the two cannot disagree about which limits exist. Only the size's own until
270
- // a set of lower limits is decided (roadmap item 97, step 14): a lower limit
271
- // handed to a viewer must come with the page saying so. Asked with the whole
272
- // frame, because the row is chosen by area (`limitRowFor`).
273
- parts.limitsFor = (frame) => [nominalKbpsFor(frame)];
274
- // What the torrent and the proxy itself spend on this host, and how fast each watched torrent moves.
275
- parts.hostLoad = new HostLoad({
276
- readMachineState,
277
- readProcessCpuSeconds,
278
- readProxyCpuSeconds,
279
- readSystemCpu,
280
- shareOfMachine,
281
- liveRunsOf: (...args) => parts.encodeRuns.liveRunsOf(...args),
282
- runStateOf: (...args) => parts.encodeRuns.runStateOf(...args),
283
- get getSourceStats() { return parts.getSourceStats; },
284
- get getTorrentTotals() { return parts.getTorrentTotals; },
285
- get outputs() { return parts.outputs; },
286
- });
287
- // Where each segment of an output begins, and how that table is corrected from what the encoder produced.
288
- parts.outputTimes = new OutputTimes({
289
- logger,
290
- runsOf: (...args) => parts.encodeRuns.runsOf(...args),
291
- stopEncodeRun: (...args) => parts.encodeRuns.stopEncodeRun(...args),
292
- planEncodersSoon: (...args) => parts.encodeRuns.planEncodersSoon(...args),
293
- get outputs() { return parts.outputs; },
294
- get segmentDurationSec() { return parts.segmentDurationSec; },
295
- });
296
- // The encoders of this proxy: built where the plan places them, followed while they run, accounted when they end.
297
- parts.encodeRuns = new EncodeRuns({
298
- logger,
299
- // What an admitted encode was seen to do, filed under its configuration.
300
- observeEncodeEnded: (session) => {
301
- if (!parts.localObservations || !session?.spec?.video?.encode) {
302
- return;
303
- }
304
- const alone = Number(qualityStateOf(session).lastAloneSpeed);
305
- parts.localObservations.noteEncode({
306
- spec: session.spec,
307
- content: contentOf(session.file),
308
- aloneSpeedX: Number.isFinite(alone) && alone > 0 ? alone : null,
309
- segmentKbps: segmentRatesOf(session)
310
- });
311
- },
312
- viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
313
- noteRunStarting: (output) => parts.quality.noteRunStarting(output),
314
- inputOf: (...args) => parts.renditions.inputOf(...args),
315
- producedNumbers: (...args) => parts.serving.producedNumbers(...args),
316
- servesAudioSeparately: (...args) => parts.renditions.servesAudioSeparately(...args),
317
- disposeSession: (...args) => parts.lifecycle.disposeSession(...args),
318
- get contentionPenalties() { return parts.contentionPenalties; },
319
- get encodeCost() { return parts.encodeCost; },
320
- get encodeOrchestrator() { return parts.encodeOrchestrator; },
321
- get ffmpegBin() { return parts.ffmpegBin; },
322
- get outputTimes() { return parts.outputTimes; },
323
- get outputs() { return parts.outputs; },
324
- get priority() { return parts.priority; },
325
- get segmentDurationSec() { return parts.segmentDurationSec; },
326
- segmentFiles,
327
- get videoEncoder() { return parts.encoders.current; },
328
- get encoders() { return parts.encoders; },
329
- invalidateWaits: (output) => parts.serving.invalidateWaits(output),
330
- productionFailed: (output) => parts.renditions.noteProductionFailed(output),
331
- });
332
- // How much film is ready in front of the viewers, said; and the spare soundtracks fetched once it is full.
333
- parts.cushion = new CushionReport({
334
- viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
335
- linkReportsOn: (output) => linkReportsOn(parts.viewers, output),
336
- SourceFiles,
337
- logger,
338
- producedNumbers: (...args) => parts.serving.producedNumbers(...args),
339
- get encodeRuns() { return parts.encodeRuns; },
340
- get fetchWholeFile() { return parts.fetchWholeFile; },
341
- get getCachedAudioTracks() { return parts.getCachedAudioTracks; },
342
- get hostLoad() { return parts.hostLoad; },
343
- get lookaheadSeconds() { return parts.lookaheadSeconds; },
344
- get outputTimes() { return parts.outputTimes; },
345
- get outputs() { return parts.outputs; },
346
- });
347
- // The steps of a picture and its soundtracks: which output answers each, made when first asked for, and the master playlist listing them.
348
- // The cushion this file needs, from its segment length and the worst
349
- // interruption its supply has shown — one statement read by every operation
350
- // that asks it.
351
- const minimumBufferSecondsOf = (output) => minimumBufferFrom({
352
- segmentSeconds: parts.segmentDurationSec,
353
- worstSupplyWaitSec: parts.hostLoad.supplyFor(output.file)?.worstWaitSec
354
- })?.seconds ?? null;
355
- parts.renditions = new Renditions({
356
- observedPeakMbps: (spec) => parts.localObservations?.peakMbps(spec) ?? null,
357
- // A viewer has been moved onto an output prepared for them: how long it
358
- // took, and what they held.
359
- notePreparation: (output, seconds, bufferedSec) =>
360
- parts.localObservations?.notePreparation({ spec: output?.spec, seconds, bufferedSec }),
361
- viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
362
- audioStartSecondsFor: (args) => audioStartSecondsFor({ ...args, viewers: parts.viewers }),
363
- activeOutputFor: (args) => activeOutputFor({ ...args, viewers: parts.viewers }),
364
- // WHAT ENCODING IS TOLD ABOUT A PERSON, and what it may tell the viewer
365
- // layer about them: values and names, never the viewer itself. Steps and
366
- // soundtracks are chosen, warmed and left per person, so this is the widest
367
- // of the three sets — and every one of them is a call on the owner, which
368
- // is what keeps one writer per fact.
369
- viewerCountOn: (output) => parts.viewers.forOutput(output).size,
370
- // Whether anything still stands on it — somebody watching, or an
371
- // assignment not yet released. See `Viewers.stillNeeded`.
372
- outputStillNeeded: (output) => parts.viewers.stillNeeded(output),
373
- consumersOn: (output) => consumersOn(parts.viewers, output),
374
- presentOn: (output) => presentOn(parts.viewers, output),
375
- qualityModeOf: (output, consumerId) => qualityModeOf(parts.viewers, output, consumerId),
376
- linkMbpsOf: (output, consumerId) => linkMbpsOf(parts.viewers, output, consumerId),
377
- audioChoiceOf: (output, consumerId) => audioChoiceOf(parts.viewers, output, consumerId),
378
- chooseAudioTrack: (output, consumerId, choice) =>
379
- chooseAudioTrack(parts.viewers, output, consumerId, choice),
380
- stepOnScreenOf: (output, consumerId) => stepOnScreenOf(parts.viewers, output, consumerId),
381
- noteStepOnScreen: (output, consumerId, stepId) =>
382
- noteStepOnScreen(parts.viewers, output, consumerId, stepId),
383
- stepBeingWarmedOf: (output, consumerId) => stepBeingWarmedOf(parts.viewers, output, consumerId),
384
- stepBeingWarmedSinceOf: (output, consumerId) => stepBeingWarmedSinceOf(parts.viewers, output, consumerId),
385
- noteStepBeingWarmed: (output, consumerId, stepId) =>
386
- noteStepBeingWarmed(parts.viewers, output, consumerId, stepId),
387
- audioBeingWarmedOf: (output, consumerId) => audioBeingWarmedOf(parts.viewers, output, consumerId),
388
- noteAudioBeingWarmed: (output, consumerId, renditionId) =>
389
- noteAudioBeingWarmed(parts.viewers, output, consumerId, renditionId),
390
- watches: (output, consumerId) => watches(parts.viewers, output, consumerId),
391
- placeOn: (output, consumerId, seconds) => placeOn(parts.viewers, output, consumerId, seconds),
392
- // A viewer's own assignments: which output answered a height and segment in
393
- // one generation of their viewing, so a repeat is answered the same way.
394
- // Values in and out, like everything above.
395
- generationOfRequest: (consumerId, stated) => generationOfRequest(parts.viewers, consumerId, stated),
396
- givenOutputOf: (consumerId, generation, askedHeight, segmentIndex) =>
397
- givenOutputOf(parts.viewers, consumerId, generation, askedHeight, segmentIndex),
398
- noteGivenOutput: (consumerId, generation, askedHeight, segmentIndex, outputKey) =>
399
- noteGivenOutput(parts.viewers, consumerId, generation, askedHeight, segmentIndex, outputKey),
400
- // The output this viewer was chosen at a height, and the rule's choice of
401
- // it — the viewer's own record, never one per file.
402
- chosenOutputOf: (consumerId, askedHeight) => chosenOutputOf(parts.viewers, consumerId, askedHeight),
403
- chooseOutput: (consumerId, askedHeight, outputKey) => chooseOutput(parts.viewers, consumerId, askedHeight, outputKey),
404
- noteServingVerdict: (consumerId, verdict) => noteServingVerdict(parts.viewers, consumerId, verdict),
405
- // A move between two limits of the height on a viewer's screen (roadmap
406
- // item 97, step 12): which heights their choice is the output on screen
407
- // under, the segment they were last given, the move being prepared, and
408
- // whether a segment is closed on the output being prepared.
409
- limitsFor: (frame) => parts.limitsFor(frame),
410
- heightsChosenAs: (consumerId, outputKey) => heightsChosenAs(parts.viewers, consumerId, outputKey),
411
- highestGivenSegmentOf: (consumerId, askedHeight) => highestGivenSegmentOf(parts.viewers, consumerId, askedHeight),
412
- sameHeightSwitchOf: (consumerId) => sameHeightSwitchOf(parts.viewers, consumerId),
413
- noteSameHeightSwitch: (consumerId, value) => noteSameHeightSwitch(parts.viewers, consumerId, value),
414
- switchingOnto: (output) => switchingOnto(parts.viewers, output),
415
- // What a viewer holds, and the cushion this file needs before a move that
416
- // is not urgent is made (roadmap item 98).
417
- bufferedSecondsOf: (consumerId) => bufferedSecondsOf(parts.viewers, consumerId),
418
- minimumBufferSecondsFor: (output) => minimumBufferSecondsOf(output),
419
- // Whether the whole machine has a place for one more encoder on this output,
420
- // asked before a preparation is recorded.
421
- admitsPreparation: (output) => parts.admission.admitsPreparation(output?.outputKey ?? ""),
422
- segmentClosed: (key, index) => parts.segmentStore.isClosed(key, index),
423
- // What a gone output left in the store, and whether another output's header
424
- // may stand in for its own.
425
- storedPieceReady: (key, fileName) => parts.serving.hasStoredPiece(key, fileName),
426
- headersCompatible: (goneKey, liveKey) => parts.serving.headersCompatible(goneKey, liveKey),
427
- placeViewerOn: (...args) => parts.viewerRequests.placeViewerOn(...args),
428
- audioRenditionName,
429
- logger,
430
- viewerLeaves: (...args) => parts.lifecycle.viewerLeaves(...args),
431
- createOrGetSession: (...args) => parts.viewerRequests.createOrGetSession(...args),
432
- planEncodersSoon: (...args) => parts.encodeRuns.planEncodersSoon(...args),
433
- disposeSession: (...args) => parts.lifecycle.disposeSession(...args),
434
- viewerPositionOf: (...args) => parts.viewerRequests.viewerPositionOf(...args),
435
- get encodeRuns() { return parts.encodeRuns; },
436
- get fileStartTimeReads() { return parts.fileStartTimeReads; },
437
- set fileStartTimeReads(value) { parts.fileStartTimeReads = value; },
438
- get getCachedAudioTracks() { return parts.getCachedAudioTracks; },
439
- get getCachedMediaInfo() { return parts.getCachedMediaInfo; },
440
- get getContainerMediaInfo() { return parts.getContainerMediaInfo; },
441
- get localBaseUrl() { return parts.localBaseUrl; },
442
- get outputTimes() { return parts.outputTimes; },
443
- get outputs() { return parts.outputs; },
444
- get quality() { return parts.quality; },
445
- get qualityOffer() { return parts.qualityOffer; },
446
- get segmentDurationSec() { return parts.segmentDurationSec; },
447
- get sourceFiles() { return parts.sourceFiles; },
448
- invalidateWaits: (output) => parts.serving.invalidateWaits(output),
449
- });
450
- // Answering a request for a playlist, an init segment or a segment: from the store when the piece is made and whole, otherwise held until it is.
451
- parts.serving = new SegmentServing({
452
- // What a key names, read back from the key: how to find a gone output's
453
- // stored pieces and whether they are cut at given times.
454
- segmentFormatOfKey,
455
- specOfKey: (key) => OutputSpec.fromKey(key),
456
- compareInits,
457
- activeOutputFor: (args) => activeOutputFor({ ...args, viewers: parts.viewers }),
458
- viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
459
- buildMasterPlaylist: (...args) => parts.renditions.buildMasterPlaylist(...args),
460
- declaredTracks: (...args) => parts.renditions.declaredTracks(...args),
461
- publishedGridFor: (...args) => parts.outputTimes.publishedGridFor(...args),
462
- runStartTimeFor: (...args) => parts.outputTimes.runStartTimeFor(...args),
463
- get cushion() { return parts.cushion; },
464
- get encodeOrchestrator() { return parts.encodeOrchestrator; },
465
- get encodeRuns() { return parts.encodeRuns; },
466
- get hostTimings() { return parts.hostTimings; },
467
- get lookaheadSeconds() { return parts.lookaheadSeconds; },
468
- get outputTimes() { return parts.outputTimes; },
469
- get outputs() { return parts.outputs; },
470
- get segmentStore() { return parts.segmentStore; },
471
- get startupWaitMs() { return parts.startupWaitMs; },
472
- get viewers() { return parts.viewers; },
473
- });
474
- // How an output ends: disposed when nobody is left on it and it has been idle, or all at once on shutdown; and the segments an earlier process left behind adopted at startup.
475
- parts.lifecycle = new OutputLifecycle({
476
- invalidateWaits: (output) => parts.serving.invalidateWaits(output),
477
- segmentFormatOfKey,
478
- // Where the viewers of one output stand, in its segments: what the store
479
- // reads to give disk back in the right order.
480
- viewerSegmentsOn: (key) => viewerSegmentsOn({
481
- outputs: parts.outputs.values(),
482
- outputKey: key,
483
- segmentAt: (output, seconds) => parts.outputTimes.segmentIndexForTime(output, seconds),
484
- now: Date.now(),
485
- viewers: parts.viewers
486
- }),
487
- get budgetTimer() { return parts.budgetTimer; },
488
- get cleanupTimer() { return parts.cleanupTimer; },
489
- get encodeRuns() { return parts.encodeRuns; },
490
- get keyframeTables() { return parts.keyframeTables; },
491
- get machineBudget() { return parts.machineBudget; },
492
- get outputTimes() { return parts.outputTimes; },
493
- get outputs() { return parts.outputs; },
494
- get returns() { return parts.returns; },
495
- get segmentStore() { return parts.segmentStore; },
496
- get sessionTtlMs() { return parts.sessionTtlMs; },
497
- get sourceFiles() { return parts.sourceFiles; },
498
- get timelines() { return parts.timelines; },
499
- get viewers() { return parts.viewers; },
500
- });
501
- // Which output answers a request for a file, made if it is not here yet: the encoding component's decision, made without knowing who asked.
502
- parts.opening = new OutputOpening({
503
- logger,
504
- // The largest peak an output of this mode and rate control has been seen
505
- // carrying here: the only figure an encoder with no bound of its own has.
506
- observedPeakMbps: (spec) => parts.localObservations?.peakMbps(spec) ?? null,
507
- limitsFor: (frame) => parts.limitsFor(frame),
508
- probeMediaInfo: (url) => probeInputMediaInfo(parts.ffmpegBin, url),
509
- probeKeyframeTimes: (url, budgetMs) => probeVideoKeyframeTimes(parts.ffmpegBin, url, budgetMs),
510
- get decodeCostModel() { return parts.decodeCostModel; },
511
- get enabled() { return parts.enabled; },
512
- get encodeCost() { return parts.encodeCost; },
513
- get encodeRuns() { return parts.encodeRuns; },
514
- get getCachedMediaInfo() { return parts.getCachedMediaInfo; },
515
- get hostLoad() { return parts.hostLoad; },
516
- get hostTimings() { return parts.hostTimings; },
517
- get keyframeTables() { return parts.keyframeTables; },
518
- get localBaseUrl() { return parts.localBaseUrl; },
519
- get outputs() { return parts.outputs; },
520
- get renditions() { return parts.renditions; },
521
- get returns() { return parts.returns; },
522
- get segmentDurationSec() { return parts.segmentDurationSec; },
523
- get segmentFormat() { return parts.segmentFormat; },
524
- segmentOutputFiles,
525
- get softwarePresetBenchmark() { return parts.softwarePresetBenchmark; },
526
- get sourceFiles() { return parts.sourceFiles; },
527
- get timelines() { return parts.timelines; },
528
- get tonemapSupported() { return parts.tonemapSupported; },
529
- get videoEncoder() { return parts.encoders.current; },
530
- });
531
- // What a viewer asks for: an output of a file, a position, a report of progress.
532
- parts.viewerRequests = new ViewerRequests({
533
- // Whether this machine has a place for one more viewer on this output —
534
- // asked in the same synchronous stretch as they are put on it.
535
- admitsWatching: (output) => parts.admission.admitsWatching(output?.outputKey ?? ""),
536
- activeOutputFor: (args) => activeOutputFor({ ...args, viewers: parts.viewers }),
537
- viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
538
- minimumBufferSecondsFor: (output) => minimumBufferSecondsOf(output),
539
- disposeSession: (...args) => parts.lifecycle.disposeSession(...args),
540
- expectedFirstSegmentMs: (...args) => parts.hostTimings.expectedFirstSegmentMs(...args),
541
- expectedSessionCreateMs: (...args) => parts.hostTimings.expectedSessionCreateMs(...args),
542
- planEncodersSoon: (...args) => parts.encodeRuns.planEncodersSoon(...args),
543
- waitUntilReady: (...args) => parts.serving.waitUntilReady(...args),
544
- get encodeRuns() { return parts.encodeRuns; },
545
- get opening() { return parts.opening; },
546
- get outputTimes() { return parts.outputTimes; },
547
- get outputs() { return parts.outputs; },
548
- get quality() { return parts.quality; },
549
- get qualityOffer() { return parts.qualityOffer; },
550
- get segmentDurationSec() { return parts.segmentDurationSec; },
551
- get startupWaitMs() { return parts.startupWaitMs; },
552
- get viewers() { return parts.viewers; },
553
- invalidateWaits: (output) => parts.serving.invalidateWaits(output),
554
- // Whether a request of this generation is still taken, what it belongs to,
555
- // what answered it, and the hold a response keeps while it is being sent.
556
- acceptsGeneration: (consumerId, stated) => acceptsGeneration(parts.viewers, consumerId, stated),
557
- generationOfRequest: (consumerId, stated) => generationOfRequest(parts.viewers, consumerId, stated),
558
- noteGivenOutput: (consumerId, generation, askedHeight, segmentIndex, outputKey) =>
559
- noteGivenOutput(parts.viewers, consumerId, generation, askedHeight, segmentIndex, outputKey),
560
- holdForResponse: (consumerId, outputKey) => holdForResponse(parts.viewers, consumerId, outputKey),
561
- noteServingVerdict: (consumerId, verdict) => noteServingVerdict(parts.viewers, consumerId, verdict),
562
- servingVerdictOf: (consumerId) => servingVerdictOf(parts.viewers, consumerId),
563
- });
564
- // What this host takes to create an output and to produce its first segment, kept across restarts until the synthetic figure can replace it (CLAUDE.md, host timings).
565
- parts.hostTimings = new HostTimings({
566
- get segmentDurationSec() { return parts.segmentDurationSec; },
567
- get softwarePresetBenchmark() { return parts.softwarePresetBenchmark; },
568
- get stateDir() { return parts.stateDir; },
569
- });
570
- parts.enabled = Boolean(enabled);
571
- parts.ffmpegBin = ffmpegBin;
572
- parts.keyframeTables = keyframeTables;
573
- // Where measurements about this host are kept between runs. Empty means
574
- // beside the installed proxy; a deployment with somewhere persistent to
575
- // write names it (--state-dir).
576
- parts.stateDir = typeof stateDir === "string" ? stateDir : "";
577
- // Output container (fMP4/CMAF or MPEG-TS). Everything container-specific —
578
- // muxer args, file naming, playlist header, per-segment correction — lives
579
- // in this module; nothing here branches on the format.
580
- parts.segmentFormat = resolveSegmentFormat(segmentFormatId);
581
- // Optional accessor for media info the playback planner already probed for
582
- // (sourceKey, fileIndex), so session create can skip its own ffmpeg scan.
583
- parts.getCachedMediaInfo = typeof getCachedMediaInfo === "function" ? getCachedMediaInfo : null;
584
- // The file's audio tracks, for the master playlist's rendition group. Same
585
- // inventory the browser's audio menu is built from.
586
- parts.getCachedAudioTracks = typeof getCachedAudioTracks === "function" ? getCachedAudioTracks : null;
587
- // What a file declares about itself, read by the container layer from the
588
- // same header its track table comes from: format, duration, and where its
589
- // own timeline begins. The last of those is why this exists — a soundtrack
590
- // shipped as its own file has a timeline of its own, and asking ffmpeg for
591
- // it meant reading a header this proxy had already read.
592
- parts.getContainerMediaInfo =
593
- typeof getContainerMediaInfo === "function" ? getContainerMediaInfo : null;
594
- // Fetch one whole file of a source, as a bounded read rather than a
595
- // selection. Used to pull a soundtrack that ships beside the picture onto
596
- // the disk while the swarm has capacity to spare — see
597
- // `#fetchSpareSoundtracks`. Optional: a proxy wired without it simply reads
598
- // such a soundtrack when it is played.
599
- parts.fetchWholeFile = typeof fetchWholeFile === "function" ? fetchWholeFile : null;
600
- // Optional async accessor for a source's live download stats, used by the
601
- // realtime budget to tell a CPU limit from a download-starved input:
602
- // (sourceKey, fileIndex) => Promise<{ downloadSpeed, fileLength, fileProgress } | null>.
603
- parts.getSourceStats = typeof getSourceStats === "function" ? getSourceStats : null;
604
- parts.setPriorityMap = typeof setPriorityMap === "function" ? setPriorityMap : null;
605
- parts.contentionPenalties = contentionPenalties instanceof Map ? contentionPenalties : null;
606
- // Seconds of film per second when the picture is COPIED, measured at
607
- // startup. Nothing else prices that branch: the other benchmarks measure
608
- // encoding and decoding, and a copy does neither.
609
- parts.copySpeedX = Number.isFinite(copySpeedX) && copySpeedX > 0 ? copySpeedX : null;
610
- // Totals across every torrent this proxy holds, used to price what the
611
- // torrent itself costs the machine (item 7). Optional: a proxy wired
612
- // without it simply never learns that figure.
613
- parts.getTorrentTotals = typeof getTorrentTotals === "function" ? getTorrentTotals : null;
614
- // The spilled pieces, as a pair of closures over the torrent thread: what
615
- // they weigh and how to tell them their share. Not the pool — the pool is
616
- // on the other side of the thread boundary and this side holds none of it.
617
- parts.spillDisk = spillDisk;
618
- parts.wholeFiles = wholeFiles;
619
- parts.diagnostics = diagnostics;
620
- parts.diagnosticsRoot = diagnosticsRoot;
621
- parts.memoryClaimant = memoryClaimant;
622
- parts.budgetPolicy = budgetPolicy;
623
- // Detected H.264 encoder descriptor (hardware or software). Defaults to
624
- // software libx264 when no detection result is supplied. May be downgraded
625
- // to software at runtime if a hardware encode fails.
626
- parts.encoders = new EncoderSelection({ detected: videoEncoder, softwareDescriptor });
627
- // WHAT THIS HOST HAS SEEN ITS OWN ADMITTED ENCODES DO, kept between runs and
628
- // used only on the configuration it was seen on (roadmap item 97, step 14).
629
- // A refinement of figures that exist without it: nothing is selected,
630
- // admitted or served differently when it is empty. Absent where the startup
631
- // calibration was not run, which is only a wiring made without it.
632
- parts.localObservations = null;
633
- if (calibration?.fingerprint) {
634
- parts.localObservations = new LocalObservations({
635
- fingerprint: calibration.fingerprint,
636
- filePath: path.join(typeof stateDir === "string" && stateDir.length > 0 ? stateDir : PROXY_ROOT, "local-observations.json"),
637
- logger
638
- });
639
- parts.localObservations.load(calibration.kinds().map((kind) => configurationKeyOf(calibration.fingerprint, {
640
- kind,
641
- name: kind === "software" ? softwareDescriptor().name : (videoEncoder?.kind === kind ? videoEncoder.name : kind)
642
- })));
643
- }
644
- /**
645
- * What the segments an output has closed carried, from their sizes and the
646
- * spans its timeline gives them: the average over all of them and the
647
- * largest one.
648
- *
649
- * @param {object} session
650
- * @returns {{ averageKbps: number, peakKbps: number } | null}
651
- */
652
- const segmentRatesOf = (session) => {
653
- const sizes = parts.segmentStore.sizesOf(session.outputKey);
654
- const timeline = session.timeline;
655
- if (!timeline || sizes.size === 0) {
656
- return null;
657
- }
658
- let bits = 0;
659
- let seconds = 0;
660
- let peakKbps = 0;
661
- for (const [index, size] of sizes) {
662
- const start = timeline.publishedStartOf(index);
663
- const end = index < timeline.segmentCount ? timeline.publishedStartOf(index + 1) : null;
664
- if (!(Number.isFinite(start) && Number.isFinite(end) && end > start) || !(size > 0)) {
665
- continue;
666
- }
667
- bits += size * 8;
668
- seconds += end - start;
669
- peakKbps = Math.max(peakKbps, (size * 8) / (end - start) / 1000);
670
- }
671
- return seconds > 0 ? { averageKbps: bits / seconds / 1000, peakKbps } : null;
672
- };
673
- // The modes of the encoder IN USE NOW, as measured at startup: slowest
674
- // first, each with its throughput by size. Read through the selection rather
675
- // than copied, because the encoder in use can change — a failing device
676
- // moves this host to software for the rest of the process, and from then on
677
- // it is software's own modes that price and choose, not the device's.
678
- // Null where nothing was measured, and then nothing is re-encoded here.
679
- parts.calibration = calibration ?? null;
680
- const givenModes = Array.isArray(softwarePresetBenchmark) ? softwarePresetBenchmark : null;
681
- Object.defineProperty(parts, "softwarePresetBenchmark", {
682
- get: () => (parts.calibration
683
- ? parts.calibration.modesFor(parts.encoders.current?.kind)
684
- : givenModes),
685
- enumerable: true
686
- });
687
- // Host decode cost solved at startup from the calibration clips:
688
- // `a × Mpixel/s + b × Mbit/s + c` seconds of decoding per second of video.
689
- // A re-encode pays for this as well as for the encoder, and leaving it out
690
- // is what made the budget offer rungs this host ran at a third of realtime.
691
- // Null when the clips are missing or the fit was rejected — the budget then
692
- // prices the encoder alone, as it did before.
693
- parts.decodeCostModel = decodeCostModel ?? null;
694
- // Whether this ffmpeg build can tone-map HDR→SDR (zscale + tonemap filters).
695
- // Gates the tonemap chain for HDR sources on the software path.
696
- parts.tonemapSupported = Boolean(tonemapSupported);
697
- parts.segmentDurationSec = segmentDurationSec;
698
- // How far ahead of the viewer this proxy lets an encoder run, in seconds of
699
- // playback. Stated rather than kept private, because the browser's forward
700
- // buffer is bounded by the same quantity and used to carry a copy of its
701
- // own: a hand-written 30 s, justified in a comment by a DIFFERENT constant
702
- // (the eight segments that bound a request ahead of the ENCODE HEAD), so
703
- // three quarters of what the encoder had already produced was thrown away.
704
- // One figure, said by the side that owns it (roadmap item 4).
705
- parts.lookaheadSeconds = LOOKAHEAD_PAUSE_SECONDS;
706
- parts.sessionTtlMs = sessionTtlMs;
707
- parts.startupWaitMs = startupWaitMs;
708
- parts.localBaseUrl = buildHttpBaseUrl(localBindHost, localPort);
709
- // Everyone watching anything, one object per person rather than one per
710
- // person per output. What a viewer chose, where they are and which outputs
711
- // they are watching are facts about the person; kept per output they were
712
- // three copies of which two were always stale.
713
- // Every change to who is watching what re-decides which encoders should
714
- // exist, because that decision reads nothing else about viewers. It used to
715
- // be re-taken on a five-second timer instead, which made a just-created
716
- // output wait up to five seconds before anything noticed it had a viewer.
717
- parts.viewers = new Viewers({ onChange: () => parts.encodeRuns.planEncodersSoon() });
718
- // The outputs that exist, and every question about them: the picture a step
719
- // belongs to, the steps, the soundtracks, the height a step is named by.
720
- parts.outputs = new OutputCatalog({
721
- fileLengthOf: (session) => parts.hostLoad.fileLengthByKey.get(session.file.key) ?? 0,
722
- largestPieceOf: (address) => parts.segmentStore.largestPiece(address)
723
- });
724
- // What this host learned last time it ran. Without it every restart shows
725
- // the first viewer a figure with no measurement behind it.
726
- parts.hostTimings.loadHostTimings();
727
- // Where produced segments live, addressed by WHAT they are rather than by
728
- // which session's encoder wrote them. Two sessions of one output — two
729
- // viewers who opened the same film at different places — write into one
730
- // directory and each serves what the other has already made. Injectable so
731
- // a test can give it a root of its own.
732
- parts.segmentStore = segmentStore instanceof SegmentStore
733
- ? segmentStore
734
- : new SegmentStore({ logger });
735
- // The store has grown: whether it still fits its share is asked now rather
736
- // than on the next cleanup pass.
737
- parts.segmentStore.onPublished(() => parts.lifecycle.keepWithinRoomSoon());
738
- // A segment closed may be the one a viewer's move between two limits of a
739
- // height is waiting for.
740
- parts.segmentStore.onPublished((key, index) => parts.renditions.noteSegmentPublished(key, index));
741
- // What encoders there should be on each output, and where. Given the two
742
- // things only this class can answer: how many this machine can afford, and
743
- // how to make one.
744
- // What encoding costs this machine, and which heights follow from it. Given
745
- // what it cannot work out for itself: which sessions belong to one file, the
746
- // host's own readings AT THE MOMENT OF THE QUESTION rather than copied, how
747
- // a soundtrack is keyed, how many encoders are running, and what a file
748
- // costs merely by being fetched.
749
- parts.encodeCost = new EncodeCost({
750
- outputs: parts.outputs,
751
- host: () => ({
752
- benchmark: parts.softwarePresetBenchmark,
753
- decodeModel: parts.decodeCostModel,
754
- contentionPenalties: parts.contentionPenalties,
755
- copySpeedX: parts.copySpeedX,
756
- availability: parts.hostLoad.hostAvailability,
757
- // WHICH encoder this host settled on. Only the software ladder is
758
- // benchmarked, so a reading taken off a hardware encoder cannot be
759
- // split into its decode and encode halves and is not filed as one.
760
- encoderKind: parts.encoders.current?.kind ?? null,
761
- // The slowest this output's mode has been seen running alone on
762
- // comparable material on this configuration, or null.
763
- observedAloneSpeed: (session) => parts.localObservations?.slowestAloneSpeed(session.spec, contentOf(session.file)) ?? null
764
- }),
765
- // HOW MANY ENCODER PROCESSES ARE RUNNING, asked of the one thing that
766
- // makes and unmakes them. This used to be two counts of one fact, taken
767
- // by walking the session registry — one per session, one per run — and
768
- // they agreed only while a session held at most one run.
769
- runningEncoders: () => parts.encodeOrchestrator.runningCount(),
770
- encodersRunningNow: () => parts.encodeOrchestrator.runningCount(),
771
- torrentCostSecFor: (session) => parts.hostLoad.torrentCostSecFor(session),
772
- boundBy: (session) => parts.quality.classifyTranscodeBound(session),
773
- runsFor: (session) => parts.encodeRuns.runsOf(session),
774
- stateFor: (session) => parts.encodeRuns.runStateOf(session),
775
- // The run's OWN progress: a speed is a pair of readings of one process.
776
- progressFor: (_session, run) => run?.progress?.snapshot?.() ?? null
777
- });
778
- // WHICH HEIGHTS ARE ON THE MENU, which is the arithmetic above plus three
779
- // things that are nothing to do with it: whose answer it is, what may never
780
- // be withdrawn, and when the answer may be reused.
781
- parts.qualityOffer = new QualityOffer({
782
- encodeCost: parts.encodeCost,
783
- occupiedCostSec: (fileKey) => parts.admission?.occupiedCost({ exceptFileKey: fileKey }).costSec ?? 0,
784
- occupancyKnownFor: (fileKey) => (parts.admission?.occupiedCost({ exceptFileKey: fileKey }).unpriced ?? 0) === 0,
785
- outputs: parts.outputs,
786
- stateFor: (session) => parts.encodeRuns.runStateOf(session),
787
- // WHICH HEIGHTS A LIVE VIEWER HAS ON SCREEN, as numbers. Who is watching
788
- // what is the viewer layer's, and which session is which height is the
789
- // film's shape; neither travels — what crosses is the list of heights.
790
- heightsOnScreen: (owner) => parts.quality.heightsOnScreen(owner),
791
- // WHAT THE SWARM IS DOING WITH THIS FILE. Three readings, taken by
792
- // whoever reads it and handed over as three numbers: the speed this
793
- // file's own interruptions demand, the megabytes a second a viewer draws
794
- // through it, and what a megabyte costs this process.
795
- supplyFor: (file) => ({
796
- requiredSpeed: parts.hostLoad.requiredSpeedFor(file.sourceKey, file.fileIndex),
797
- megabytesPerSecond: parts.hostLoad.torrentMegabytesPerSecond(
798
- file.sourceKey,
799
- file.fileIndex,
800
- file.lengthBytes ?? parts.hostLoad.fileLengthByKey.get(file.key) ?? null,
801
- file.durationSeconds
802
- ),
803
- costPerMegabyte: parts.hostLoad.observedTorrentCostPerMegabyte
804
- })
805
- });
806
- // The priority map, built from where the viewers are and handed to both
807
- // sides that act on it. The downloading lives in another thread, so its
808
- // copy travels over the worker channel.
809
- parts.priority = new PriorityOrchestrator({
810
- publish: ({ sourceKey, fileIndex, durationSeconds, zones }) => {
811
- void Promise.resolve(
812
- parts.setPriorityMap?.({ sourceKey, fileIndex, durationSeconds, zones })
813
- ).catch(() => {});
814
- },
815
- get viewers() { return parts.viewers; },
816
- // WHERE THE TWO FACTS MEET, and this is the only place that holds both.
817
- // Which step is on somebody's screen belongs to the person; which output
818
- // a step supersedes belongs to the film's shape. Neither layer is handed
819
- // the other — one gets a plain id, the other is read for one field.
820
- watchedBy: (session, viewer) => !parts.outputs.supersededBy(session, viewer.activeVariantId ?? null),
821
- allowanceFor: (session) => minimumBufferFrom({
822
- segmentSeconds: parts.segmentDurationSec,
823
- worstSupplyWaitSec: parts.hostLoad.supplyFor(session.file)?.worstWaitSec
824
- })?.seconds ?? parts.segmentDurationSec
825
- });
826
- // WHETHER THE WHOLE MACHINE HAS A PLACE for one more encoder, across outputs.
827
- // Given what it cannot hold itself: what runs (the orchestrator's), what is
828
- // being prepared (the viewers' records), what an output costs (the encoding
829
- // cost) and how much of the machine nobody has priced (the host's reading).
830
- parts.admission = new EncodeAdmission({
831
- liveRunsByAddress: () => parts.encodeOrchestrator.liveRunsByAddress(),
832
- preparedAddresses: () => {
833
- const addresses = new Set();
834
- for (const id of outputsBeingPrepared(parts.viewers)) {
835
- const key = parts.outputs.get(id)?.outputKey;
836
- if (key) {
837
- addresses.add(key);
838
- }
839
- }
840
- return addresses;
841
- },
842
- // Every output a present viewer RECEIVES — by the same rule the per-output
843
- // priority map is built by — that still has something left to make. The
844
- // place an output is opened on is held from the moment its viewer is put
845
- // on it, not from when the plan gets round to its first encoder.
846
- watchedAddresses: () => {
847
- const addresses = new Set();
848
- for (const session of parts.outputs.values()) {
849
- const address = session.outputKey;
850
- if (!address || addresses.has(address) || finishedOutput(session)) {
851
- continue;
852
- }
853
- for (const viewer of parts.viewers.forOutput(session).values()) {
854
- if (viewer.isPresent() && !parts.outputs.supersededBy(session, viewer.activeVariantId ?? null)) {
855
- addresses.add(address);
856
- break;
857
- }
858
- }
859
- }
860
- return addresses;
861
- },
862
- finished: (address) => parts.outputs.outputsOn(address).some((session) => finishedOutput(session)),
863
- loadOf: (address) => parts.encodeCost.loadOfOutput(address),
864
- availability: () => parts.hostLoad.hostAvailability ?? null
865
- });
866
- parts.encodeOrchestrator = new EncodeOrchestrator({
867
- admission: parts.admission,
868
- // What the viewers actually waited for, by band. The ledger is the
869
- // priority layer's; the encoding is handed a way to ask it.
870
- describeWaits: (address) => waits.describe(address),
871
- maxRunsFor: (address) => parts.encodeRuns.maxRunsForOutput(address),
872
- makeRun: ({ address, from, to, because }) => parts.encodeRuns.makeRunAt(address, from, to, because),
873
- segmentSeconds: parts.segmentDurationSec,
874
- contentionPenalties: parts.contentionPenalties,
875
- startingSpeedFor: (address) => parts.encodeCost.speedForOutput(address),
876
- segmentCoverage,
877
- // HOW IT ASKS TO DECIDE AGAIN. A plan that refuses to place anything
878
- // because an output's input is away needs something to bring it back:
879
- // nothing about the state changes while the data is missing, so no event
880
- // arrives on its own.
881
- planSoon: () => parts.encodeRuns.planEncodersSoon(),
882
- logger
883
- });
884
- // What a start and a stop were measured to cost here, before any viewer
885
- // existed. Without it both read zero at a cold open, and zero is not
886
- // "unmeasured" — it is "free", which is what moved an encoder between two
887
- // adjacent numbers every half second in the field.
888
- parts.encodeOrchestrator.noteStartupCosts(startStopCost);
889
- // Where each file is cut, held once per file and grid rather than once per
890
- // session. Two sessions of one film MUST agree about this to the
891
- // millisecond — a segment made by either has to be appendable where the
892
- // other's would have gone — and until now they agreed by copying, which is
893
- // a thing somebody has to remember to do and which drifted twice in the
894
- // field. They share the table now.
895
- parts.timelines = new Timelines();
896
- // The files this proxy is serving, one object per file however many
897
- // sessions are of it. It holds the file's key — which every cache about a
898
- // file is keyed by — its name, and the facts a probe returned.
899
- parts.sourceFiles = new SourceFiles();
900
- parts.cleanupTimer = setInterval(() => {
901
- void parts.lifecycle.cleanupExpired();
902
- }, CLEANUP_INTERVAL_MS);
903
- parts.cleanupTimer.unref();
904
- // How long after material stops being read somebody asks for it again — the
905
- // one term of the keeping period that is guessed rather than measured, and
906
- // the only place it can be measured from.
907
- parts.returns = new Returns();
908
- // One owner of the disk, and the list of what takes it lives with the owner.
909
- parts.machineBudget = wireMachineBudget({
910
- segmentStore: parts.segmentStore,
911
- spill: parts.spillDisk,
912
- wholeFiles: parts.wholeFiles,
913
- diagnostics: parts.diagnostics,
914
- diagnosticsRoot: parts.diagnosticsRoot,
915
- memory: parts.memoryClaimant,
916
- policy: parts.budgetPolicy ?? undefined,
917
- readFree: freeBytesFor,
918
- logger
919
- });
920
- // Realtime-budget monitor: only meaningful for the software encoder with a
921
- // benchmark (the only path that can pick/step resolution). Cheap no-op scan
922
- // otherwise.
923
- // The quality budget: what each output is asked to step to, and the bitrate ceiling a viewer's link sets. Everything it reads of the rest of the proxy is listed here.
924
- parts.quality = new QualityController({
925
- // The longest an output of this mode has been seen taking to be ready for
926
- // a viewer moving onto it, in milliseconds, or null.
927
- observedPreparationMs: (output) => {
928
- const seconds = parts.localObservations?.longestPreparationSec(output?.spec) ?? null;
929
- return seconds === null ? null : seconds * 1000;
930
- },
931
- // WHAT ENCODING IS TOLD ABOUT A PERSON: values, by name. Not the viewer,
932
- // whose record belongs to the viewer layer and is written only there.
933
- consumersOn: (output) => consumersOn(parts.viewers, output),
934
- qualityModeOf: (output, consumerId) => qualityModeOf(parts.viewers, output, consumerId),
935
- stepOnScreenOf: (output, consumerId) => stepOnScreenOf(parts.viewers, output, consumerId),
936
- standingAskOf: (output, consumerId) => standingAskOf(parts.viewers, output, consumerId),
937
- askQualityOf: (output, consumerId, height, reason, now, urgent) =>
938
- askQualityOf(parts.viewers, output, consumerId, height, reason, now, urgent),
939
- // What a viewer's page said about their buffer and the picture they see
940
- // (roadmap item 98), as values.
941
- bufferOf: (output, consumerId, spanSec) => bufferOf(parts.viewers, output, consumerId, spanSec),
942
- visiblePictureOf: (output, consumerId) => visiblePictureOf(parts.viewers, output, consumerId),
943
- // How long this host takes to close a first segment: how soon another
944
- // output could have the piece a viewer needs.
945
- expectedFirstSegmentMs: () => parts.hostTimings.expectedFirstSegmentMs(),
946
- dropAskOf: (output, consumerId) => dropAskOf(parts.viewers, output, consumerId),
947
- // EACH viewer's own link and who is present: a thin link decides for the
948
- // person on it and for nobody else (roadmap item 97, step 11), so the
949
- // budget asks per viewer instead of taking the worst over all of them.
950
- presentOn: (output) => presentOn(parts.viewers, output),
951
- linkReportOf: (output, consumerId) => linkReportOf(parts.viewers, output, consumerId),
952
- // The soundtrack a viewer receives, as part of the load their link carries.
953
- viewerAudioLoadOf: (base, consumerId) => parts.renditions.viewerAudioLoadOf(base, consumerId),
954
- // The first lever on a viewer's link: another limit of the height on their
955
- // screen, prepared and moved to without their player being told.
956
- prepareSameHeightSwitch: (output, consumerId, direction, reason) =>
957
- parts.renditions.prepareSameHeightSwitch(output, consumerId, direction, reason),
958
- sameHeightSwitchPending: (consumerId) => parts.renditions.sameHeightSwitchPending(consumerId),
959
- sameHeightSwitchDirection: (consumerId) => parts.renditions.sameHeightSwitchDirection(consumerId),
960
- cancelSameHeightSwitch: (consumerId, reason) => parts.renditions.cancelSameHeightSwitch(consumerId, reason),
961
- heightReadyFor: (base, consumerId, height) => parts.renditions.heightReadyFor(base, consumerId, height),
962
- isLive: (...args) => parts.encodeRuns.isLive(...args),
963
- liveConsumers: (...args) => parts.renditions.liveConsumers(...args),
964
- liveRunsOf: (...args) => parts.encodeRuns.liveRunsOf(...args),
965
- producedNumbers: (...args) => parts.serving.producedNumbers(...args),
966
- reportHostLoad: (...args) => parts.hostLoad.reportHostLoad(...args),
967
- runStateOf: (...args) => parts.encodeRuns.runStateOf(...args),
968
- sampleDownloadRates: (...args) => parts.hostLoad.sampleDownloadRates(...args),
969
- get encodeCost() { return parts.encodeCost; },
970
- get getSourceStats() { return parts.getSourceStats; },
971
- get outputs() { return parts.outputs; },
972
- get qualityOffer() { return parts.qualityOffer; },
973
- get segmentDurationSec() { return parts.segmentDurationSec; },
974
- segmentPaths,
975
- get videoEncoder() { return parts.encoders.current; },
976
- });
977
- parts.budgetTimer = setInterval(() => {
978
- parts.cushion.reportCushions();
979
- void parts.quality.runQualityBudgetOnce();
980
- }, BUDGET_CHECK_INTERVAL_MS);
981
- parts.budgetTimer.unref();
982
- return parts;
983
- }
1
+ /**
2
+ * @file Wiring of the outputs, the viewers and the encoding.
3
+ *
4
+ * Builds each component and hands it the narrow host it reads, and nothing
5
+ * else. It holds no behaviour: every member that used to be a method of the
6
+ * session manager is a method of the component that owns it now. What it
7
+ * returns is the set of components and the settings they share, for
8
+ * `server.js` to give each route the ones that route asks.
9
+ */
10
+
11
+ import { logger } from "../../utils/logger.js";
12
+ import { KeyframeTables } from "../media/KeyframeTables.js";
13
+ import { waits } from "./WaitLedger.js";
14
+ import { readMachineState, readProcessCpuSeconds, readProxyCpuSeconds, readSystemCpu, shareOfMachine } from "../encode/host-load.js";
15
+ import { minimumBufferFrom } from "../torrent/supply-margin.js";
16
+ import { PriorityOrchestrator } from "../viewer/PriorityOrchestrator.js";
17
+ import { softwareDescriptor } from "../encode/hwaccel.js";
18
+ import { resolveSegmentFormat } from "../encode/segment-formats/index.js";
19
+ import { Timelines } from "../encode/output/Timeline.js";
20
+ import { SourceFiles } from "../media/SourceFile.js";
21
+ import { SegmentStore } from "../storage/segment-store/SegmentStore.js";
22
+ import { EncodeCost } from "../encode/quality/EncodeCost.js";
23
+ import { QualityOffer } from "../encode/quality/QualityOffer.js";
24
+ import { activeOutputFor } from "../viewer/active-output.js";
25
+ import {
26
+ acceptsGeneration,
27
+ askQualityOf,
28
+ audioBeingWarmedOf,
29
+ audioChoiceOf,
30
+ chooseAudioTrack,
31
+ chooseOutput,
32
+ chosenOutputOf,
33
+ consumersOn,
34
+ dropAskOf,
35
+ generationOfRequest,
36
+ givenOutputOf,
37
+ heightsChosenAs,
38
+ highestGivenSegmentOf,
39
+ holdForResponse,
40
+ linkMbpsOf,
41
+ linkReportOf,
42
+ bufferOf,
43
+ bufferedSecondsOf,
44
+ visiblePictureOf,
45
+ linkReportsOn,
46
+ noteAudioBeingWarmed,
47
+ noteGivenOutput,
48
+ noteSameHeightSwitch,
49
+ noteServingVerdict,
50
+ noteStepBeingWarmed,
51
+ noteStepOnScreen,
52
+ outputsBeingPrepared,
53
+ placeOn,
54
+ presentOn,
55
+ qualityModeOf,
56
+ sameHeightSwitchOf,
57
+ servingVerdictOf,
58
+ standingAskOf,
59
+ stepBeingWarmedOf,
60
+ stepBeingWarmedSinceOf,
61
+ stepOnScreenOf,
62
+ switchingOnto,
63
+ watches
64
+ } from "../viewer/choices.js";
65
+ import { viewerSecondsOn, viewerSegmentsOn } from "../viewer/positions.js";
66
+ import { Viewers } from "../viewer/Viewers.js";
67
+ import { OutputCatalog } from "../encode/output/OutputCatalog.js";
68
+ import { ViewerRequests } from "./ViewerRequests.js";
69
+ import { OutputLifecycle } from "./OutputLifecycle.js";
70
+ import { SegmentServing } from "./SegmentServing.js";
71
+ import { audioStartSecondsFor } from "../viewer/audio-start.js";
72
+ import { audioRenditionName } from "../media/audio-inventory.js";
73
+ import { Renditions } from "../encode/Renditions.js";
74
+ import { CushionReport, LOOKAHEAD_PAUSE_SECONDS } from "../encode/CushionReport.js";
75
+ import { EncodeRuns } from "../encode/EncodeRuns.js";
76
+ import { OutputTimes } from "../encode/OutputTimes.js";
77
+ import { HostLoad } from "../encode/quality/HostLoad.js";
78
+ import { HostTimings } from "../encode/quality/HostTimings.js";
79
+ import { BUDGET_CHECK_INTERVAL_MS, QualityController } from "../encode/quality/QualityController.js";
80
+ import { EncodeOrchestrator } from "../encode/EncodeOrchestrator.js";
81
+ import { EncodeAdmission } from "../encode/EncodeAdmission.js";
82
+ import { EncoderSelection } from "../encode/EncoderSelection.js";
83
+ import { OutputOpening } from "../encode/OutputOpening.js";
84
+ import { segmentFormatOfKey } from "../encode/output-key-format.js";
85
+ import { OutputSpec } from "../encode/output/OutputSpec.js";
86
+ import { compareInits } from "../encode/segment-formats/init-compat.js";
87
+ import { nominalKbpsFor } from "../encode/args.js";
88
+ import { probeInputMediaInfo } from "../media/media-info-probe.js";
89
+ import { probeVideoKeyframeTimes } from "../media/keyframe-probe.js";
90
+ import { wireMachineBudget } from "../storage/wire.js";
91
+ import { Returns } from "../storage/returns.js";
92
+ import { freeBytesFor } from "../storage/free.js";
93
+ import path from "node:path";
94
+ import { contentOf, LocalObservations } from "../encode/LocalObservations.js";
95
+ import { configurationKeyOf } from "../encode/fingerprint.js";
96
+ import { PROXY_ROOT } from "../encode/quality/HostTimings.js";
97
+ import { qualityStateOf } from "../encode/quality/OutputQualityState.js";
98
+
99
+ // Where a variant and an audio rendition live under a session — `v/<height>/…`
100
+ // and `a/<track>/…` — is stated in `encode/output/playlists.js`, beside the lines that
101
+ // write those addresses into a master playlist. The routes that parse them back
102
+ // are in `server.js`.
103
+
104
+ const CLEANUP_INTERVAL_MS = 30_000;
105
+ const DEFAULT_SEGMENT_DURATION_SEC = 4;
106
+ // Idle TTL: a session is disposed this long after the last segment/playlist
107
+ // access. Long enough that a viewer who pauses, backgrounds the tab, or briefly
108
+ // turns the phone off can resume WITHOUT a cold ffmpeg restart (the warm session
109
+ // also backs the seamless auto-reconnect). ffmpeg stops producing at the
110
+ // look-ahead cap when idle, so a lingering session costs retained segments on
111
+ // disk, not sustained CPU. Active playback refreshes the timer on every segment
112
+ // fetch, so it never expires mid-watch.
113
+ // How long a session outlives the BROWSER, not the viewing. Since server
114
+ // 0.8.103 a browser that holds a session re-asserts it every 30 s, so an open
115
+ // tab never consumes this at all — not while paused, not across a three-hour
116
+ // film. What is left is the case where the browser has genuinely gone: the tab
117
+ // was killed without releasing, the phone slept, the network dropped. Keeping
118
+ // the session means such a viewer comes back to a warm encoder instead of
119
+ // waiting out a cold start; the cost while nobody is there is disk for the
120
+ // produced segments, since the encoder is suspended and burns no CPU, and that
121
+ // disk is already bounded by the pool's 10 GB cap with eviction. Thirty minutes
122
+ // covers a meal, a phone call or a lift ride.
123
+ const DEFAULT_SESSION_TTL_MS = 30 * 60 * 1000;
124
+ const DEFAULT_STARTUP_WAIT_MS = 5_000;
125
+
126
+ /**
127
+ * Convert a bind-all host address to the loopback address so that
128
+ * the HLS input URL is always reachable from the same machine.
129
+ *
130
+ * @param {string} host
131
+ * @returns {string}
132
+ */
133
+ function toLoopbackHost(host) {
134
+ if (host === "0.0.0.0" || host === "::") {
135
+ return "127.0.0.1";
136
+ }
137
+ return host;
138
+ }
139
+
140
+ /**
141
+ * Build the HTTP base URL (scheme + host + port) for the local proxy server.
142
+ *
143
+ * @param {string} host - Bind host (may be "0.0.0.0" or "::").
144
+ * @param {number} port
145
+ * @returns {string} e.g. "http://127.0.0.1:9090"
146
+ */
147
+ function buildHttpBaseUrl(host, port) {
148
+ const url = new URL("http://localhost");
149
+ url.hostname = toLoopbackHost(host);
150
+ url.port = String(port);
151
+ return url.origin;
152
+ }
153
+
154
+ /**
155
+ * @typedef {Object} WireOutputsOptions
156
+ * @property {boolean} enabled - Whether HLS transcoding is enabled.
157
+ * @property {string} ffmpegBin - Path to the ffmpeg executable.
158
+ * @property {string} localBindHost - Host the proxy HTTP server is bound to.
159
+ * @property {number} localPort - Port the proxy HTTP server is listening on.
160
+ * @property {number} [segmentDurationSec] - HLS segment length in seconds.
161
+ * @property {number} [sessionTtlMs] - Session idle TTL in milliseconds.
162
+ * @property {number} [startupWaitMs] - Max time to wait for the first playlist file.
163
+ * @property {string} [segmentFormatId] - Output container: "fmp4" (default)
164
+ * or "mpegts". See `../segment-formats/index.js`.
165
+ */
166
+
167
+ /**
168
+ * @typedef {Object} HlsSession
169
+ * @property {string} id - The name of the output it produces.
170
+ * @property {string} fileName - Display name of the file being transcoded.
171
+ * @property {import("../media/container/KeyframeTable.js").KeyframeTable} keyframes -
172
+ * Where this file's keyframes are. One object per file, held by every session
173
+ * of it, so a table read late still reaches them. Used to snap a source seek
174
+ * onto a known-valid position (see #startEncodeRun).
175
+ */
176
+
177
+ /**
178
+ * Build the components and connect them.
179
+ *
180
+ * @param {WireOutputsOptions} options
181
+ * @returns {object} The components, and the settings they read.
182
+ */
183
+ export function wireOutputs({
184
+ enabled,
185
+ ffmpegBin,
186
+ localBindHost,
187
+ localPort,
188
+ segmentDurationSec = DEFAULT_SEGMENT_DURATION_SEC,
189
+ sessionTtlMs = DEFAULT_SESSION_TTL_MS,
190
+ startupWaitMs = DEFAULT_STARTUP_WAIT_MS,
191
+ // Where every file's keyframe table lives, and the only thing that reads
192
+ // one. A session asks for its file's table and is handed the object every
193
+ // other reader of that file holds, so a table that arrives late reaches the
194
+ // sessions created before it. Built here when nothing supplied one, which
195
+ // is a registry with no reader: it answers "not read" about every file, and
196
+ // every picture is then re-encoded — the correct behaviour for a proxy
197
+ // wired without a container reader, and what every unit test gets.
198
+ keyframeTables = new KeyframeTables(),
199
+ videoEncoder = null,
200
+ softwarePresetBenchmark = null,
201
+ // What every encoder this host may use was qualified and measured to do at
202
+ // startup, by kind (`encode/calibration.js`). Takes the place of the one
203
+ // array above, which a test may still hand in on its own.
204
+ calibration = null,
205
+ decodeCostModel = null,
206
+ getSourceStats = null,
207
+ setPriorityMap = null,
208
+ // What a second job costs on this host, measured at startup. Null when it
209
+ // could not be measured, and then nothing is corrected — the alternative
210
+ // is inventing a penalty, which is the same fault as inventing a fill rate.
211
+ contentionPenalties = null,
212
+ copySpeedX = null,
213
+ tonemapSupported = false,
214
+ getCachedMediaInfo = null,
215
+ getCachedAudioTracks = null,
216
+ getContainerMediaInfo = null,
217
+ fetchWholeFile = null,
218
+ segmentFormatId = undefined,
219
+ stateDir = "",
220
+ segmentStore = null,
221
+ getTorrentTotals,
222
+ startStopCost = null,
223
+ spillDisk = null,
224
+ wholeFiles = null,
225
+ diagnostics = null,
226
+ diagnosticsRoot = "",
227
+ memoryClaimant = null,
228
+ budgetPolicy = null}) {
229
+ const parts = {};
230
+ // Encode components receive only the storage operations they use. The
231
+ // concrete SegmentStore remains owned by this assembly and is never handed
232
+ // to the encode layer.
233
+ const segmentCoverage = {
234
+ provenNumbers: (address) => parts.segmentStore.provenNumbers(address),
235
+ announce: (address, index) => parts.segmentStore.announce(address, index),
236
+ filesHeld: (address) => parts.segmentStore.filesHeld(address),
237
+ clearUpAfter: (address, startedAt) => parts.segmentStore.clearUpAfter(address, startedAt)
238
+ };
239
+ const segmentFiles = {
240
+ pathFor: (address) => parts.segmentStore.pathFor(address),
241
+ initOf: (address) => parts.segmentStore.initOf(address),
242
+ directoryFor: (address) => parts.segmentStore.directoryFor(address),
243
+ publish: (address, makingName, format) => parts.segmentStore.publish(address, makingName, format)
244
+ };
245
+ const segmentOutputFiles = {
246
+ addresses: () => parts.segmentStore.addresses(),
247
+ isClosed: (address, index) => parts.segmentStore.isClosed(address, index),
248
+ lastReadAt: (address) => parts.segmentStore.lastReadAt(address),
249
+ directoryFor: (address) => parts.segmentStore.directoryFor(address),
250
+ useFormat: (address, format) => parts.segmentStore.useFormat(address, format)
251
+ };
252
+ const segmentPaths = {
253
+ pathOf: (address, index) => parts.segmentStore.pathOf(address, index)
254
+ };
255
+ /**
256
+ * Whether everything this output will ever serve is made: every segment of
257
+ * its timeline closed in the store. Such an output needs no encoder and
258
+ * holds no place, however many watch it.
259
+ *
260
+ * @param {object} session
261
+ * @returns {boolean}
262
+ */
263
+ const finishedOutput = (session) => {
264
+ const count = Number(session?.timeline?.segmentCount) || 0;
265
+ return count > 0 && parts.segmentStore.provenNumbers(session.outputKey).length >= count;
266
+ };
267
+ // The nominal limits a size may be produced at, highest first. ONE list, read
268
+ // by the opening of an output and by the move between limits of a height, so
269
+ // the two cannot disagree about which limits exist. Only the size's own until
270
+ // a set of lower limits is decided (roadmap item 97, step 14): a lower limit
271
+ // handed to a viewer must come with the page saying so. Asked with the whole
272
+ // frame, because the row is chosen by area (`limitRowFor`).
273
+ parts.limitsFor = (frame) => [nominalKbpsFor(frame)];
274
+ // What the torrent and the proxy itself spend on this host, and how fast each watched torrent moves.
275
+ parts.hostLoad = new HostLoad({
276
+ readMachineState,
277
+ readProcessCpuSeconds,
278
+ readProxyCpuSeconds,
279
+ readSystemCpu,
280
+ shareOfMachine,
281
+ liveRunsOf: (...args) => parts.encodeRuns.liveRunsOf(...args),
282
+ runStateOf: (...args) => parts.encodeRuns.runStateOf(...args),
283
+ get getSourceStats() { return parts.getSourceStats; },
284
+ get getTorrentTotals() { return parts.getTorrentTotals; },
285
+ get outputs() { return parts.outputs; },
286
+ });
287
+ // Where each segment of an output begins, and how that table is corrected from what the encoder produced.
288
+ parts.outputTimes = new OutputTimes({
289
+ logger,
290
+ runsOf: (...args) => parts.encodeRuns.runsOf(...args),
291
+ stopEncodeRun: (...args) => parts.encodeRuns.stopEncodeRun(...args),
292
+ planEncodersSoon: (...args) => parts.encodeRuns.planEncodersSoon(...args),
293
+ get outputs() { return parts.outputs; },
294
+ get segmentDurationSec() { return parts.segmentDurationSec; },
295
+ });
296
+ // The encoders of this proxy: built where the plan places them, followed while they run, accounted when they end.
297
+ parts.encodeRuns = new EncodeRuns({
298
+ logger,
299
+ // What an admitted encode was seen to do, filed under its configuration.
300
+ observeEncodeEnded: (session) => {
301
+ if (!parts.localObservations || !session?.spec?.video?.encode) {
302
+ return;
303
+ }
304
+ const alone = Number(qualityStateOf(session).lastAloneSpeed);
305
+ parts.localObservations.noteEncode({
306
+ spec: session.spec,
307
+ content: contentOf(session.file),
308
+ aloneSpeedX: Number.isFinite(alone) && alone > 0 ? alone : null,
309
+ segmentKbps: segmentRatesOf(session)
310
+ });
311
+ },
312
+ viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
313
+ noteRunStarting: (output) => parts.quality.noteRunStarting(output),
314
+ inputOf: (...args) => parts.renditions.inputOf(...args),
315
+ producedNumbers: (...args) => parts.serving.producedNumbers(...args),
316
+ servesAudioSeparately: (...args) => parts.renditions.servesAudioSeparately(...args),
317
+ disposeSession: (...args) => parts.lifecycle.disposeSession(...args),
318
+ get contentionPenalties() { return parts.contentionPenalties; },
319
+ get encodeCost() { return parts.encodeCost; },
320
+ get encodeOrchestrator() { return parts.encodeOrchestrator; },
321
+ get ffmpegBin() { return parts.ffmpegBin; },
322
+ get outputTimes() { return parts.outputTimes; },
323
+ get outputs() { return parts.outputs; },
324
+ get priority() { return parts.priority; },
325
+ get segmentDurationSec() { return parts.segmentDurationSec; },
326
+ segmentFiles,
327
+ get videoEncoder() { return parts.encoders.current; },
328
+ get encoders() { return parts.encoders; },
329
+ invalidateWaits: (output) => parts.serving.invalidateWaits(output),
330
+ productionFailed: (output) => parts.renditions.noteProductionFailed(output),
331
+ });
332
+ // How much film is ready in front of the viewers, said; and the spare soundtracks fetched once it is full.
333
+ parts.cushion = new CushionReport({
334
+ viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
335
+ linkReportsOn: (output) => linkReportsOn(parts.viewers, output),
336
+ SourceFiles,
337
+ logger,
338
+ producedNumbers: (...args) => parts.serving.producedNumbers(...args),
339
+ get encodeRuns() { return parts.encodeRuns; },
340
+ get fetchWholeFile() { return parts.fetchWholeFile; },
341
+ get getCachedAudioTracks() { return parts.getCachedAudioTracks; },
342
+ get hostLoad() { return parts.hostLoad; },
343
+ get lookaheadSeconds() { return parts.lookaheadSeconds; },
344
+ get outputTimes() { return parts.outputTimes; },
345
+ get outputs() { return parts.outputs; },
346
+ });
347
+ // The steps of a picture and its soundtracks: which output answers each, made when first asked for, and the master playlist listing them.
348
+ // The cushion this file needs, from its segment length and the worst
349
+ // interruption its supply has shown — one statement read by every operation
350
+ // that asks it.
351
+ const minimumBufferSecondsOf = (output) => minimumBufferFrom({
352
+ segmentSeconds: parts.segmentDurationSec,
353
+ worstSupplyWaitSec: parts.hostLoad.supplyFor(output.file)?.worstWaitSec
354
+ })?.seconds ?? null;
355
+ parts.renditions = new Renditions({
356
+ observedPeakMbps: (spec) => parts.localObservations?.peakMbps(spec) ?? null,
357
+ // A viewer has been moved onto an output prepared for them: how long it
358
+ // took, and what they held.
359
+ notePreparation: (output, seconds, bufferedSec) =>
360
+ parts.localObservations?.notePreparation({ spec: output?.spec, seconds, bufferedSec }),
361
+ viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
362
+ audioStartSecondsFor: (args) => audioStartSecondsFor({ ...args, viewers: parts.viewers }),
363
+ activeOutputFor: (args) => activeOutputFor({ ...args, viewers: parts.viewers }),
364
+ // WHAT ENCODING IS TOLD ABOUT A PERSON, and what it may tell the viewer
365
+ // layer about them: values and names, never the viewer itself. Steps and
366
+ // soundtracks are chosen, warmed and left per person, so this is the widest
367
+ // of the three sets — and every one of them is a call on the owner, which
368
+ // is what keeps one writer per fact.
369
+ viewerCountOn: (output) => parts.viewers.forOutput(output).size,
370
+ // Whether anything still stands on it — somebody watching, or an
371
+ // assignment not yet released. See `Viewers.stillNeeded`.
372
+ outputStillNeeded: (output) => parts.viewers.stillNeeded(output),
373
+ consumersOn: (output) => consumersOn(parts.viewers, output),
374
+ presentOn: (output) => presentOn(parts.viewers, output),
375
+ qualityModeOf: (output, consumerId) => qualityModeOf(parts.viewers, output, consumerId),
376
+ linkMbpsOf: (output, consumerId) => linkMbpsOf(parts.viewers, output, consumerId),
377
+ audioChoiceOf: (output, consumerId) => audioChoiceOf(parts.viewers, output, consumerId),
378
+ chooseAudioTrack: (output, consumerId, choice) =>
379
+ chooseAudioTrack(parts.viewers, output, consumerId, choice),
380
+ stepOnScreenOf: (output, consumerId) => stepOnScreenOf(parts.viewers, output, consumerId),
381
+ noteStepOnScreen: (output, consumerId, stepId) =>
382
+ noteStepOnScreen(parts.viewers, output, consumerId, stepId),
383
+ stepBeingWarmedOf: (output, consumerId) => stepBeingWarmedOf(parts.viewers, output, consumerId),
384
+ stepBeingWarmedSinceOf: (output, consumerId) => stepBeingWarmedSinceOf(parts.viewers, output, consumerId),
385
+ noteStepBeingWarmed: (output, consumerId, stepId) =>
386
+ noteStepBeingWarmed(parts.viewers, output, consumerId, stepId),
387
+ audioBeingWarmedOf: (output, consumerId) => audioBeingWarmedOf(parts.viewers, output, consumerId),
388
+ noteAudioBeingWarmed: (output, consumerId, renditionId) =>
389
+ noteAudioBeingWarmed(parts.viewers, output, consumerId, renditionId),
390
+ watches: (output, consumerId) => watches(parts.viewers, output, consumerId),
391
+ placeOn: (output, consumerId, seconds) => placeOn(parts.viewers, output, consumerId, seconds),
392
+ // A viewer's own assignments: which output answered a height and segment in
393
+ // one generation of their viewing, so a repeat is answered the same way.
394
+ // Values in and out, like everything above.
395
+ generationOfRequest: (consumerId, stated) => generationOfRequest(parts.viewers, consumerId, stated),
396
+ givenOutputOf: (consumerId, generation, askedHeight, segmentIndex) =>
397
+ givenOutputOf(parts.viewers, consumerId, generation, askedHeight, segmentIndex),
398
+ noteGivenOutput: (consumerId, generation, askedHeight, segmentIndex, outputKey) =>
399
+ noteGivenOutput(parts.viewers, consumerId, generation, askedHeight, segmentIndex, outputKey),
400
+ // The output this viewer was chosen at a height, and the rule's choice of
401
+ // it — the viewer's own record, never one per file.
402
+ chosenOutputOf: (consumerId, askedHeight) => chosenOutputOf(parts.viewers, consumerId, askedHeight),
403
+ chooseOutput: (consumerId, askedHeight, outputKey) => chooseOutput(parts.viewers, consumerId, askedHeight, outputKey),
404
+ noteServingVerdict: (consumerId, verdict) => noteServingVerdict(parts.viewers, consumerId, verdict),
405
+ // A move between two limits of the height on a viewer's screen (roadmap
406
+ // item 97, step 12): which heights their choice is the output on screen
407
+ // under, the segment they were last given, the move being prepared, and
408
+ // whether a segment is closed on the output being prepared.
409
+ limitsFor: (frame) => parts.limitsFor(frame),
410
+ heightsChosenAs: (consumerId, outputKey) => heightsChosenAs(parts.viewers, consumerId, outputKey),
411
+ highestGivenSegmentOf: (consumerId, askedHeight) => highestGivenSegmentOf(parts.viewers, consumerId, askedHeight),
412
+ sameHeightSwitchOf: (consumerId) => sameHeightSwitchOf(parts.viewers, consumerId),
413
+ noteSameHeightSwitch: (consumerId, value) => noteSameHeightSwitch(parts.viewers, consumerId, value),
414
+ switchingOnto: (output) => switchingOnto(parts.viewers, output),
415
+ // What a viewer holds, and the cushion this file needs before a move that
416
+ // is not urgent is made (roadmap item 98).
417
+ bufferedSecondsOf: (consumerId) => bufferedSecondsOf(parts.viewers, consumerId),
418
+ minimumBufferSecondsFor: (output) => minimumBufferSecondsOf(output),
419
+ // Whether the whole machine has a place for one more encoder on this output,
420
+ // asked before a preparation is recorded.
421
+ admitsPreparation: (output) => parts.admission.admitsPreparation(output?.outputKey ?? ""),
422
+ segmentClosed: (key, index) => parts.segmentStore.isClosed(key, index),
423
+ // What a gone output left in the store, and whether another output's header
424
+ // may stand in for its own.
425
+ storedPieceReady: (key, fileName) => parts.serving.hasStoredPiece(key, fileName),
426
+ headersCompatible: (goneKey, liveKey) => parts.serving.headersCompatible(goneKey, liveKey),
427
+ placeViewerOn: (...args) => parts.viewerRequests.placeViewerOn(...args),
428
+ audioRenditionName,
429
+ logger,
430
+ viewerLeaves: (...args) => parts.lifecycle.viewerLeaves(...args),
431
+ createOrGetSession: (...args) => parts.viewerRequests.createOrGetSession(...args),
432
+ planEncodersSoon: (...args) => parts.encodeRuns.planEncodersSoon(...args),
433
+ disposeSession: (...args) => parts.lifecycle.disposeSession(...args),
434
+ viewerPositionOf: (...args) => parts.viewerRequests.viewerPositionOf(...args),
435
+ get encodeRuns() { return parts.encodeRuns; },
436
+ get fileStartTimeReads() { return parts.fileStartTimeReads; },
437
+ set fileStartTimeReads(value) { parts.fileStartTimeReads = value; },
438
+ get getCachedAudioTracks() { return parts.getCachedAudioTracks; },
439
+ get getCachedMediaInfo() { return parts.getCachedMediaInfo; },
440
+ get getContainerMediaInfo() { return parts.getContainerMediaInfo; },
441
+ get localBaseUrl() { return parts.localBaseUrl; },
442
+ get outputTimes() { return parts.outputTimes; },
443
+ get outputs() { return parts.outputs; },
444
+ get quality() { return parts.quality; },
445
+ get qualityOffer() { return parts.qualityOffer; },
446
+ get segmentDurationSec() { return parts.segmentDurationSec; },
447
+ get sourceFiles() { return parts.sourceFiles; },
448
+ invalidateWaits: (output) => parts.serving.invalidateWaits(output),
449
+ });
450
+ // Answering a request for a playlist, an init segment or a segment: from the store when the piece is made and whole, otherwise held until it is.
451
+ parts.serving = new SegmentServing({
452
+ // What a key names, read back from the key: how to find a gone output's
453
+ // stored pieces and whether they are cut at given times.
454
+ segmentFormatOfKey,
455
+ specOfKey: (key) => OutputSpec.fromKey(key),
456
+ compareInits,
457
+ activeOutputFor: (args) => activeOutputFor({ ...args, viewers: parts.viewers }),
458
+ viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
459
+ buildMasterPlaylist: (...args) => parts.renditions.buildMasterPlaylist(...args),
460
+ declaredTracks: (...args) => parts.renditions.declaredTracks(...args),
461
+ publishedGridFor: (...args) => parts.outputTimes.publishedGridFor(...args),
462
+ runStartTimeFor: (...args) => parts.outputTimes.runStartTimeFor(...args),
463
+ get cushion() { return parts.cushion; },
464
+ get encodeOrchestrator() { return parts.encodeOrchestrator; },
465
+ get encodeRuns() { return parts.encodeRuns; },
466
+ get hostTimings() { return parts.hostTimings; },
467
+ get lookaheadSeconds() { return parts.lookaheadSeconds; },
468
+ get outputTimes() { return parts.outputTimes; },
469
+ get outputs() { return parts.outputs; },
470
+ get segmentStore() { return parts.segmentStore; },
471
+ get startupWaitMs() { return parts.startupWaitMs; },
472
+ get viewers() { return parts.viewers; },
473
+ });
474
+ // How an output ends: disposed when nobody is left on it and it has been idle, or all at once on shutdown; and the segments an earlier process left behind adopted at startup.
475
+ parts.lifecycle = new OutputLifecycle({
476
+ invalidateWaits: (output) => parts.serving.invalidateWaits(output),
477
+ segmentFormatOfKey,
478
+ // Where the viewers of one output stand, in its segments: what the store
479
+ // reads to give disk back in the right order.
480
+ viewerSegmentsOn: (key) => viewerSegmentsOn({
481
+ outputs: parts.outputs.values(),
482
+ outputKey: key,
483
+ segmentAt: (output, seconds) => parts.outputTimes.segmentIndexForTime(output, seconds),
484
+ now: Date.now(),
485
+ viewers: parts.viewers
486
+ }),
487
+ get budgetTimer() { return parts.budgetTimer; },
488
+ get cleanupTimer() { return parts.cleanupTimer; },
489
+ get encodeRuns() { return parts.encodeRuns; },
490
+ get keyframeTables() { return parts.keyframeTables; },
491
+ get machineBudget() { return parts.machineBudget; },
492
+ get outputTimes() { return parts.outputTimes; },
493
+ get outputs() { return parts.outputs; },
494
+ get returns() { return parts.returns; },
495
+ get segmentStore() { return parts.segmentStore; },
496
+ get sessionTtlMs() { return parts.sessionTtlMs; },
497
+ get sourceFiles() { return parts.sourceFiles; },
498
+ get timelines() { return parts.timelines; },
499
+ get viewers() { return parts.viewers; },
500
+ });
501
+ // Which output answers a request for a file, made if it is not here yet: the encoding component's decision, made without knowing who asked.
502
+ parts.opening = new OutputOpening({
503
+ logger,
504
+ // The largest peak an output of this mode and rate control has been seen
505
+ // carrying here: the only figure an encoder with no bound of its own has.
506
+ observedPeakMbps: (spec) => parts.localObservations?.peakMbps(spec) ?? null,
507
+ limitsFor: (frame) => parts.limitsFor(frame),
508
+ probeMediaInfo: (url) => probeInputMediaInfo(parts.ffmpegBin, url),
509
+ probeKeyframeTimes: (url, budgetMs) => probeVideoKeyframeTimes(parts.ffmpegBin, url, budgetMs),
510
+ get decodeCostModel() { return parts.decodeCostModel; },
511
+ get enabled() { return parts.enabled; },
512
+ get encodeCost() { return parts.encodeCost; },
513
+ get encodeRuns() { return parts.encodeRuns; },
514
+ get getCachedMediaInfo() { return parts.getCachedMediaInfo; },
515
+ get hostLoad() { return parts.hostLoad; },
516
+ get hostTimings() { return parts.hostTimings; },
517
+ get keyframeTables() { return parts.keyframeTables; },
518
+ get localBaseUrl() { return parts.localBaseUrl; },
519
+ get outputs() { return parts.outputs; },
520
+ get renditions() { return parts.renditions; },
521
+ get returns() { return parts.returns; },
522
+ get segmentDurationSec() { return parts.segmentDurationSec; },
523
+ get segmentFormat() { return parts.segmentFormat; },
524
+ segmentOutputFiles,
525
+ get softwarePresetBenchmark() { return parts.softwarePresetBenchmark; },
526
+ get sourceFiles() { return parts.sourceFiles; },
527
+ get timelines() { return parts.timelines; },
528
+ get tonemapSupported() { return parts.tonemapSupported; },
529
+ get videoEncoder() { return parts.encoders.current; },
530
+ });
531
+ // What a viewer asks for: an output of a file, a position, a report of progress.
532
+ parts.viewerRequests = new ViewerRequests({
533
+ // Whether this machine has a place for one more viewer on this output —
534
+ // asked in the same synchronous stretch as they are put on it.
535
+ admitsWatching: (output) => parts.admission.admitsWatching(output?.outputKey ?? ""),
536
+ activeOutputFor: (args) => activeOutputFor({ ...args, viewers: parts.viewers }),
537
+ viewerSecondsOn: (output, consumerId, now) => viewerSecondsOn(parts.viewers, output, consumerId, now),
538
+ minimumBufferSecondsFor: (output) => minimumBufferSecondsOf(output),
539
+ disposeSession: (...args) => parts.lifecycle.disposeSession(...args),
540
+ expectedFirstSegmentMs: (...args) => parts.hostTimings.expectedFirstSegmentMs(...args),
541
+ expectedSessionCreateMs: (...args) => parts.hostTimings.expectedSessionCreateMs(...args),
542
+ planEncodersSoon: (...args) => parts.encodeRuns.planEncodersSoon(...args),
543
+ waitUntilReady: (...args) => parts.serving.waitUntilReady(...args),
544
+ get encodeRuns() { return parts.encodeRuns; },
545
+ get opening() { return parts.opening; },
546
+ get outputTimes() { return parts.outputTimes; },
547
+ get outputs() { return parts.outputs; },
548
+ get quality() { return parts.quality; },
549
+ get qualityOffer() { return parts.qualityOffer; },
550
+ get segmentDurationSec() { return parts.segmentDurationSec; },
551
+ get startupWaitMs() { return parts.startupWaitMs; },
552
+ get viewers() { return parts.viewers; },
553
+ invalidateWaits: (output) => parts.serving.invalidateWaits(output),
554
+ // Whether a request of this generation is still taken, what it belongs to,
555
+ // what answered it, and the hold a response keeps while it is being sent.
556
+ acceptsGeneration: (consumerId, stated) => acceptsGeneration(parts.viewers, consumerId, stated),
557
+ generationOfRequest: (consumerId, stated) => generationOfRequest(parts.viewers, consumerId, stated),
558
+ noteGivenOutput: (consumerId, generation, askedHeight, segmentIndex, outputKey) =>
559
+ noteGivenOutput(parts.viewers, consumerId, generation, askedHeight, segmentIndex, outputKey),
560
+ holdForResponse: (consumerId, outputKey) => holdForResponse(parts.viewers, consumerId, outputKey),
561
+ noteServingVerdict: (consumerId, verdict) => noteServingVerdict(parts.viewers, consumerId, verdict),
562
+ servingVerdictOf: (consumerId) => servingVerdictOf(parts.viewers, consumerId),
563
+ });
564
+ // What this host takes to create an output and to produce its first segment, kept across restarts until the synthetic figure can replace it (CLAUDE.md, host timings).
565
+ parts.hostTimings = new HostTimings({
566
+ get segmentDurationSec() { return parts.segmentDurationSec; },
567
+ get softwarePresetBenchmark() { return parts.softwarePresetBenchmark; },
568
+ get stateDir() { return parts.stateDir; },
569
+ });
570
+ parts.enabled = Boolean(enabled);
571
+ parts.ffmpegBin = ffmpegBin;
572
+ parts.keyframeTables = keyframeTables;
573
+ // Where measurements about this host are kept between runs. Empty means
574
+ // beside the installed proxy; a deployment with somewhere persistent to
575
+ // write names it (--state-dir).
576
+ parts.stateDir = typeof stateDir === "string" ? stateDir : "";
577
+ // Output container (fMP4/CMAF or MPEG-TS). Everything container-specific —
578
+ // muxer args, file naming, playlist header, per-segment correction — lives
579
+ // in this module; nothing here branches on the format.
580
+ parts.segmentFormat = resolveSegmentFormat(segmentFormatId);
581
+ // Optional accessor for media info the playback planner already probed for
582
+ // (sourceKey, fileIndex), so session create can skip its own ffmpeg scan.
583
+ parts.getCachedMediaInfo = typeof getCachedMediaInfo === "function" ? getCachedMediaInfo : null;
584
+ // The file's audio tracks, for the master playlist's rendition group. Same
585
+ // inventory the browser's audio menu is built from.
586
+ parts.getCachedAudioTracks = typeof getCachedAudioTracks === "function" ? getCachedAudioTracks : null;
587
+ // What a file declares about itself, read by the container layer from the
588
+ // same header its track table comes from: format, duration, and where its
589
+ // own timeline begins. The last of those is why this exists — a soundtrack
590
+ // shipped as its own file has a timeline of its own, and asking ffmpeg for
591
+ // it meant reading a header this proxy had already read.
592
+ parts.getContainerMediaInfo =
593
+ typeof getContainerMediaInfo === "function" ? getContainerMediaInfo : null;
594
+ // Fetch one whole file of a source, as a bounded read rather than a
595
+ // selection. Used to pull a soundtrack that ships beside the picture onto
596
+ // the disk while the swarm has capacity to spare — see
597
+ // `#fetchSpareSoundtracks`. Optional: a proxy wired without it simply reads
598
+ // such a soundtrack when it is played.
599
+ parts.fetchWholeFile = typeof fetchWholeFile === "function" ? fetchWholeFile : null;
600
+ // Optional async accessor for a source's live download stats, used by the
601
+ // realtime budget to tell a CPU limit from a download-starved input:
602
+ // (sourceKey, fileIndex) => Promise<{ downloadSpeed, fileLength, fileProgress } | null>.
603
+ parts.getSourceStats = typeof getSourceStats === "function" ? getSourceStats : null;
604
+ parts.setPriorityMap = typeof setPriorityMap === "function" ? setPriorityMap : null;
605
+ parts.contentionPenalties = contentionPenalties instanceof Map ? contentionPenalties : null;
606
+ // Seconds of film per second when the picture is COPIED, measured at
607
+ // startup. Nothing else prices that branch: the other benchmarks measure
608
+ // encoding and decoding, and a copy does neither.
609
+ parts.copySpeedX = Number.isFinite(copySpeedX) && copySpeedX > 0 ? copySpeedX : null;
610
+ // Totals across every torrent this proxy holds, used to price what the
611
+ // torrent itself costs the machine (item 7). Optional: a proxy wired
612
+ // without it simply never learns that figure.
613
+ parts.getTorrentTotals = typeof getTorrentTotals === "function" ? getTorrentTotals : null;
614
+ // The spilled pieces, as a pair of closures over the torrent thread: what
615
+ // they weigh and how to tell them their share. Not the pool — the pool is
616
+ // on the other side of the thread boundary and this side holds none of it.
617
+ parts.spillDisk = spillDisk;
618
+ parts.wholeFiles = wholeFiles;
619
+ parts.diagnostics = diagnostics;
620
+ parts.diagnosticsRoot = diagnosticsRoot;
621
+ parts.memoryClaimant = memoryClaimant;
622
+ parts.budgetPolicy = budgetPolicy;
623
+ // Detected H.264 encoder descriptor (hardware or software). Defaults to
624
+ // software libx264 when no detection result is supplied. May be downgraded
625
+ // to software at runtime if a hardware encode fails.
626
+ parts.encoders = new EncoderSelection({ detected: videoEncoder, softwareDescriptor });
627
+ // WHAT THIS HOST HAS SEEN ITS OWN ADMITTED ENCODES DO, kept between runs and
628
+ // used only on the configuration it was seen on (roadmap item 97, step 14).
629
+ // A refinement of figures that exist without it: nothing is selected,
630
+ // admitted or served differently when it is empty. Absent where the startup
631
+ // calibration was not run, which is only a wiring made without it.
632
+ parts.localObservations = null;
633
+ if (calibration?.fingerprint) {
634
+ parts.localObservations = new LocalObservations({
635
+ fingerprint: calibration.fingerprint,
636
+ filePath: path.join(typeof stateDir === "string" && stateDir.length > 0 ? stateDir : PROXY_ROOT, "local-observations.json"),
637
+ logger
638
+ });
639
+ parts.localObservations.load(calibration.kinds().map((kind) => configurationKeyOf(calibration.fingerprint, {
640
+ kind,
641
+ name: kind === "software" ? softwareDescriptor().name : (videoEncoder?.kind === kind ? videoEncoder.name : kind)
642
+ })));
643
+ }
644
+ /**
645
+ * What the segments an output has closed carried, from their sizes and the
646
+ * spans its timeline gives them: the average over all of them and the
647
+ * largest one.
648
+ *
649
+ * @param {object} session
650
+ * @returns {{ averageKbps: number, peakKbps: number } | null}
651
+ */
652
+ const segmentRatesOf = (session) => {
653
+ const sizes = parts.segmentStore.sizesOf(session.outputKey);
654
+ const timeline = session.timeline;
655
+ if (!timeline || sizes.size === 0) {
656
+ return null;
657
+ }
658
+ let bits = 0;
659
+ let seconds = 0;
660
+ let peakKbps = 0;
661
+ for (const [index, size] of sizes) {
662
+ const start = timeline.publishedStartOf(index);
663
+ const end = index < timeline.segmentCount ? timeline.publishedStartOf(index + 1) : null;
664
+ if (!(Number.isFinite(start) && Number.isFinite(end) && end > start) || !(size > 0)) {
665
+ continue;
666
+ }
667
+ bits += size * 8;
668
+ seconds += end - start;
669
+ peakKbps = Math.max(peakKbps, (size * 8) / (end - start) / 1000);
670
+ }
671
+ return seconds > 0 ? { averageKbps: bits / seconds / 1000, peakKbps } : null;
672
+ };
673
+ // The modes of the encoder IN USE NOW, as measured at startup: slowest
674
+ // first, each with its throughput by size. Read through the selection rather
675
+ // than copied, because the encoder in use can change — a failing device
676
+ // moves this host to software for the rest of the process, and from then on
677
+ // it is software's own modes that price and choose, not the device's.
678
+ // Null where nothing was measured, and then nothing is re-encoded here.
679
+ parts.calibration = calibration ?? null;
680
+ const givenModes = Array.isArray(softwarePresetBenchmark) ? softwarePresetBenchmark : null;
681
+ Object.defineProperty(parts, "softwarePresetBenchmark", {
682
+ get: () => (parts.calibration
683
+ ? parts.calibration.modesFor(parts.encoders.current?.kind)
684
+ : givenModes),
685
+ enumerable: true
686
+ });
687
+ // Host decode cost solved at startup from the calibration clips:
688
+ // `a × Mpixel/s + b × Mbit/s + c` seconds of decoding per second of video.
689
+ // A re-encode pays for this as well as for the encoder, and leaving it out
690
+ // is what made the budget offer rungs this host ran at a third of realtime.
691
+ // Null when the clips are missing or the fit was rejected — the budget then
692
+ // prices the encoder alone, as it did before.
693
+ parts.decodeCostModel = decodeCostModel ?? null;
694
+ // Whether this ffmpeg build can tone-map HDR→SDR (zscale + tonemap filters).
695
+ // Gates the tonemap chain for HDR sources on the software path.
696
+ parts.tonemapSupported = Boolean(tonemapSupported);
697
+ parts.segmentDurationSec = segmentDurationSec;
698
+ // How far ahead of the viewer this proxy lets an encoder run, in seconds of
699
+ // playback. Stated rather than kept private, because the browser's forward
700
+ // buffer is bounded by the same quantity and used to carry a copy of its
701
+ // own: a hand-written 30 s, justified in a comment by a DIFFERENT constant
702
+ // (the eight segments that bound a request ahead of the ENCODE HEAD), so
703
+ // three quarters of what the encoder had already produced was thrown away.
704
+ // One figure, said by the side that owns it (roadmap item 4).
705
+ parts.lookaheadSeconds = LOOKAHEAD_PAUSE_SECONDS;
706
+ parts.sessionTtlMs = sessionTtlMs;
707
+ parts.startupWaitMs = startupWaitMs;
708
+ parts.localBaseUrl = buildHttpBaseUrl(localBindHost, localPort);
709
+ // Everyone watching anything, one object per person rather than one per
710
+ // person per output. What a viewer chose, where they are and which outputs
711
+ // they are watching are facts about the person; kept per output they were
712
+ // three copies of which two were always stale.
713
+ // Every change to who is watching what re-decides which encoders should
714
+ // exist, because that decision reads nothing else about viewers. It used to
715
+ // be re-taken on a five-second timer instead, which made a just-created
716
+ // output wait up to five seconds before anything noticed it had a viewer.
717
+ parts.viewers = new Viewers({ onChange: () => parts.encodeRuns.planEncodersSoon() });
718
+ // The outputs that exist, and every question about them: the picture a step
719
+ // belongs to, the steps, the soundtracks, the height a step is named by.
720
+ parts.outputs = new OutputCatalog({
721
+ fileLengthOf: (session) => parts.hostLoad.fileLengthByKey.get(session.file.key) ?? 0,
722
+ largestPieceOf: (address) => parts.segmentStore.largestPiece(address)
723
+ });
724
+ // What this host learned last time it ran. Without it every restart shows
725
+ // the first viewer a figure with no measurement behind it.
726
+ parts.hostTimings.loadHostTimings();
727
+ // Where produced segments live, addressed by WHAT they are rather than by
728
+ // which session's encoder wrote them. Two sessions of one output — two
729
+ // viewers who opened the same film at different places — write into one
730
+ // directory and each serves what the other has already made. Injectable so
731
+ // a test can give it a root of its own.
732
+ parts.segmentStore = segmentStore instanceof SegmentStore
733
+ ? segmentStore
734
+ : new SegmentStore({ logger });
735
+ // The store has grown: whether it still fits its share is asked now rather
736
+ // than on the next cleanup pass.
737
+ parts.segmentStore.onPublished(() => parts.lifecycle.keepWithinRoomSoon());
738
+ // A segment closed may be the one a viewer's move between two limits of a
739
+ // height is waiting for.
740
+ parts.segmentStore.onPublished((key, index) => parts.renditions.noteSegmentPublished(key, index));
741
+ // What encoders there should be on each output, and where. Given the two
742
+ // things only this class can answer: how many this machine can afford, and
743
+ // how to make one.
744
+ // What encoding costs this machine, and which heights follow from it. Given
745
+ // what it cannot work out for itself: which sessions belong to one file, the
746
+ // host's own readings AT THE MOMENT OF THE QUESTION rather than copied, how
747
+ // a soundtrack is keyed, how many encoders are running, and what a file
748
+ // costs merely by being fetched.
749
+ parts.encodeCost = new EncodeCost({
750
+ outputs: parts.outputs,
751
+ host: () => ({
752
+ benchmark: parts.softwarePresetBenchmark,
753
+ decodeModel: parts.decodeCostModel,
754
+ contentionPenalties: parts.contentionPenalties,
755
+ copySpeedX: parts.copySpeedX,
756
+ availability: parts.hostLoad.hostAvailability,
757
+ // WHICH encoder this host settled on. Only the software ladder is
758
+ // benchmarked, so a reading taken off a hardware encoder cannot be
759
+ // split into its decode and encode halves and is not filed as one.
760
+ encoderKind: parts.encoders.current?.kind ?? null,
761
+ // The slowest this output's mode has been seen running alone on
762
+ // comparable material on this configuration, or null.
763
+ observedAloneSpeed: (session) => parts.localObservations?.slowestAloneSpeed(session.spec, contentOf(session.file)) ?? null
764
+ }),
765
+ // HOW MANY ENCODER PROCESSES ARE RUNNING, asked of the one thing that
766
+ // makes and unmakes them. This used to be two counts of one fact, taken
767
+ // by walking the session registry — one per session, one per run — and
768
+ // they agreed only while a session held at most one run.
769
+ runningEncoders: () => parts.encodeOrchestrator.runningCount(),
770
+ encodersRunningNow: () => parts.encodeOrchestrator.runningCount(),
771
+ torrentCostSecFor: (session) => parts.hostLoad.torrentCostSecFor(session),
772
+ boundBy: (session) => parts.quality.classifyTranscodeBound(session),
773
+ runsFor: (session) => parts.encodeRuns.runsOf(session),
774
+ stateFor: (session) => parts.encodeRuns.runStateOf(session),
775
+ // The run's OWN progress: a speed is a pair of readings of one process.
776
+ progressFor: (_session, run) => run?.progress?.snapshot?.() ?? null
777
+ });
778
+ // WHICH HEIGHTS ARE ON THE MENU, which is the arithmetic above plus three
779
+ // things that are nothing to do with it: whose answer it is, what may never
780
+ // be withdrawn, and when the answer may be reused.
781
+ parts.qualityOffer = new QualityOffer({
782
+ encodeCost: parts.encodeCost,
783
+ occupiedCostSec: (fileKey) => parts.admission?.occupiedCost({ exceptFileKey: fileKey }).costSec ?? 0,
784
+ occupancyKnownFor: (fileKey) => (parts.admission?.occupiedCost({ exceptFileKey: fileKey }).unpriced ?? 0) === 0,
785
+ outputs: parts.outputs,
786
+ stateFor: (session) => parts.encodeRuns.runStateOf(session),
787
+ // WHICH HEIGHTS A LIVE VIEWER HAS ON SCREEN, as numbers. Who is watching
788
+ // what is the viewer layer's, and which session is which height is the
789
+ // film's shape; neither travels — what crosses is the list of heights.
790
+ heightsOnScreen: (owner) => parts.quality.heightsOnScreen(owner),
791
+ // WHAT THE SWARM IS DOING WITH THIS FILE. Three readings, taken by
792
+ // whoever reads it and handed over as three numbers: the speed this
793
+ // file's own interruptions demand, the megabytes a second a viewer draws
794
+ // through it, and what a megabyte costs this process.
795
+ supplyFor: (file) => ({
796
+ requiredSpeed: parts.hostLoad.requiredSpeedFor(file.sourceKey, file.fileIndex),
797
+ megabytesPerSecond: parts.hostLoad.torrentMegabytesPerSecond(
798
+ file.sourceKey,
799
+ file.fileIndex,
800
+ file.lengthBytes ?? parts.hostLoad.fileLengthByKey.get(file.key) ?? null,
801
+ file.durationSeconds
802
+ ),
803
+ costPerMegabyte: parts.hostLoad.observedTorrentCostPerMegabyte
804
+ })
805
+ });
806
+ // The priority map, built from where the viewers are and handed to both
807
+ // sides that act on it. The downloading lives in another thread, so its
808
+ // copy travels over the worker channel.
809
+ parts.priority = new PriorityOrchestrator({
810
+ publish: ({ sourceKey, fileIndex, durationSeconds, zones }) => {
811
+ void Promise.resolve(
812
+ parts.setPriorityMap?.({ sourceKey, fileIndex, durationSeconds, zones })
813
+ ).catch(() => {});
814
+ },
815
+ get viewers() { return parts.viewers; },
816
+ // WHERE THE TWO FACTS MEET, and this is the only place that holds both.
817
+ // Which step is on somebody's screen belongs to the person; which output
818
+ // a step supersedes belongs to the film's shape. Neither layer is handed
819
+ // the other — one gets a plain id, the other is read for one field.
820
+ watchedBy: (session, viewer) => !parts.outputs.supersededBy(session, viewer.activeVariantId ?? null),
821
+ allowanceFor: (session) => minimumBufferFrom({
822
+ segmentSeconds: parts.segmentDurationSec,
823
+ worstSupplyWaitSec: parts.hostLoad.supplyFor(session.file)?.worstWaitSec
824
+ })?.seconds ?? parts.segmentDurationSec
825
+ });
826
+ // WHETHER THE WHOLE MACHINE HAS A PLACE for one more encoder, across outputs.
827
+ // Given what it cannot hold itself: what runs (the orchestrator's), what is
828
+ // being prepared (the viewers' records), what an output costs (the encoding
829
+ // cost) and how much of the machine nobody has priced (the host's reading).
830
+ parts.admission = new EncodeAdmission({
831
+ liveRunsByAddress: () => parts.encodeOrchestrator.liveRunsByAddress(),
832
+ preparedAddresses: () => {
833
+ const addresses = new Set();
834
+ for (const id of outputsBeingPrepared(parts.viewers)) {
835
+ const key = parts.outputs.get(id)?.outputKey;
836
+ if (key) {
837
+ addresses.add(key);
838
+ }
839
+ }
840
+ return addresses;
841
+ },
842
+ // Every output a present viewer RECEIVES — by the same rule the per-output
843
+ // priority map is built by — that still has something left to make. The
844
+ // place an output is opened on is held from the moment its viewer is put
845
+ // on it, not from when the plan gets round to its first encoder.
846
+ watchedAddresses: () => {
847
+ const addresses = new Set();
848
+ for (const session of parts.outputs.values()) {
849
+ const address = session.outputKey;
850
+ if (!address || addresses.has(address) || finishedOutput(session)) {
851
+ continue;
852
+ }
853
+ for (const viewer of parts.viewers.forOutput(session).values()) {
854
+ if (viewer.isPresent() && !parts.outputs.supersededBy(session, viewer.activeVariantId ?? null)) {
855
+ addresses.add(address);
856
+ break;
857
+ }
858
+ }
859
+ }
860
+ return addresses;
861
+ },
862
+ finished: (address) => parts.outputs.outputsOn(address).some((session) => finishedOutput(session)),
863
+ loadOf: (address) => parts.encodeCost.loadOfOutput(address),
864
+ availability: () => parts.hostLoad.hostAvailability ?? null
865
+ });
866
+ parts.encodeOrchestrator = new EncodeOrchestrator({
867
+ admission: parts.admission,
868
+ // What the viewers actually waited for, by band. The ledger is the
869
+ // priority layer's; the encoding is handed a way to ask it.
870
+ describeWaits: (address) => waits.describe(address),
871
+ maxRunsFor: (address) => parts.encodeRuns.maxRunsForOutput(address),
872
+ makeRun: ({ address, from, to, because }) => parts.encodeRuns.makeRunAt(address, from, to, because),
873
+ segmentSeconds: parts.segmentDurationSec,
874
+ contentionPenalties: parts.contentionPenalties,
875
+ startingSpeedFor: (address) => parts.encodeCost.speedForOutput(address),
876
+ segmentCoverage,
877
+ // HOW IT ASKS TO DECIDE AGAIN. A plan that refuses to place anything
878
+ // because an output's input is away needs something to bring it back:
879
+ // nothing about the state changes while the data is missing, so no event
880
+ // arrives on its own.
881
+ planSoon: () => parts.encodeRuns.planEncodersSoon(),
882
+ logger
883
+ });
884
+ // What a start and a stop were measured to cost here, before any viewer
885
+ // existed. Without it both read zero at a cold open, and zero is not
886
+ // "unmeasured" — it is "free", which is what moved an encoder between two
887
+ // adjacent numbers every half second in the field.
888
+ parts.encodeOrchestrator.noteStartupCosts(startStopCost);
889
+ // Where each file is cut, held once per file and grid rather than once per
890
+ // session. Two sessions of one film MUST agree about this to the
891
+ // millisecond — a segment made by either has to be appendable where the
892
+ // other's would have gone — and until now they agreed by copying, which is
893
+ // a thing somebody has to remember to do and which drifted twice in the
894
+ // field. They share the table now.
895
+ parts.timelines = new Timelines();
896
+ // The files this proxy is serving, one object per file however many
897
+ // sessions are of it. It holds the file's key — which every cache about a
898
+ // file is keyed by — its name, and the facts a probe returned.
899
+ parts.sourceFiles = new SourceFiles();
900
+ parts.cleanupTimer = setInterval(() => {
901
+ void parts.lifecycle.cleanupExpired();
902
+ }, CLEANUP_INTERVAL_MS);
903
+ parts.cleanupTimer.unref();
904
+ // How long after material stops being read somebody asks for it again — the
905
+ // one term of the keeping period that is guessed rather than measured, and
906
+ // the only place it can be measured from.
907
+ parts.returns = new Returns();
908
+ // One owner of the disk, and the list of what takes it lives with the owner.
909
+ parts.machineBudget = wireMachineBudget({
910
+ segmentStore: parts.segmentStore,
911
+ spill: parts.spillDisk,
912
+ wholeFiles: parts.wholeFiles,
913
+ diagnostics: parts.diagnostics,
914
+ diagnosticsRoot: parts.diagnosticsRoot,
915
+ memory: parts.memoryClaimant,
916
+ policy: parts.budgetPolicy ?? undefined,
917
+ readFree: freeBytesFor,
918
+ logger
919
+ });
920
+ // Realtime-budget monitor: only meaningful for the software encoder with a
921
+ // benchmark (the only path that can pick/step resolution). Cheap no-op scan
922
+ // otherwise.
923
+ // The quality budget: what each output is asked to step to, and the bitrate ceiling a viewer's link sets. Everything it reads of the rest of the proxy is listed here.
924
+ parts.quality = new QualityController({
925
+ // The longest an output of this mode has been seen taking to be ready for
926
+ // a viewer moving onto it, in milliseconds, or null.
927
+ observedPreparationMs: (output) => {
928
+ const seconds = parts.localObservations?.longestPreparationSec(output?.spec) ?? null;
929
+ return seconds === null ? null : seconds * 1000;
930
+ },
931
+ // WHAT ENCODING IS TOLD ABOUT A PERSON: values, by name. Not the viewer,
932
+ // whose record belongs to the viewer layer and is written only there.
933
+ consumersOn: (output) => consumersOn(parts.viewers, output),
934
+ qualityModeOf: (output, consumerId) => qualityModeOf(parts.viewers, output, consumerId),
935
+ stepOnScreenOf: (output, consumerId) => stepOnScreenOf(parts.viewers, output, consumerId),
936
+ standingAskOf: (output, consumerId) => standingAskOf(parts.viewers, output, consumerId),
937
+ askQualityOf: (output, consumerId, height, reason, now, urgent) =>
938
+ askQualityOf(parts.viewers, output, consumerId, height, reason, now, urgent),
939
+ // What a viewer's page said about their buffer and the picture they see
940
+ // (roadmap item 98), as values.
941
+ bufferOf: (output, consumerId, spanSec) => bufferOf(parts.viewers, output, consumerId, spanSec),
942
+ visiblePictureOf: (output, consumerId) => visiblePictureOf(parts.viewers, output, consumerId),
943
+ // How long this host takes to close a first segment: how soon another
944
+ // output could have the piece a viewer needs.
945
+ expectedFirstSegmentMs: () => parts.hostTimings.expectedFirstSegmentMs(),
946
+ dropAskOf: (output, consumerId) => dropAskOf(parts.viewers, output, consumerId),
947
+ // EACH viewer's own link and who is present: a thin link decides for the
948
+ // person on it and for nobody else (roadmap item 97, step 11), so the
949
+ // budget asks per viewer instead of taking the worst over all of them.
950
+ presentOn: (output) => presentOn(parts.viewers, output),
951
+ linkReportOf: (output, consumerId) => linkReportOf(parts.viewers, output, consumerId),
952
+ // The soundtrack a viewer receives, as part of the load their link carries.
953
+ viewerAudioLoadOf: (base, consumerId) => parts.renditions.viewerAudioLoadOf(base, consumerId),
954
+ // The first lever on a viewer's link: another limit of the height on their
955
+ // screen, prepared and moved to without their player being told.
956
+ prepareSameHeightSwitch: (output, consumerId, direction, reason) =>
957
+ parts.renditions.prepareSameHeightSwitch(output, consumerId, direction, reason),
958
+ sameHeightSwitchPending: (consumerId) => parts.renditions.sameHeightSwitchPending(consumerId),
959
+ sameHeightSwitchDirection: (consumerId) => parts.renditions.sameHeightSwitchDirection(consumerId),
960
+ cancelSameHeightSwitch: (consumerId, reason) => parts.renditions.cancelSameHeightSwitch(consumerId, reason),
961
+ heightReadyFor: (base, consumerId, height) => parts.renditions.heightReadyFor(base, consumerId, height),
962
+ isLive: (...args) => parts.encodeRuns.isLive(...args),
963
+ liveConsumers: (...args) => parts.renditions.liveConsumers(...args),
964
+ liveRunsOf: (...args) => parts.encodeRuns.liveRunsOf(...args),
965
+ producedNumbers: (...args) => parts.serving.producedNumbers(...args),
966
+ reportHostLoad: (...args) => parts.hostLoad.reportHostLoad(...args),
967
+ runStateOf: (...args) => parts.encodeRuns.runStateOf(...args),
968
+ sampleDownloadRates: (...args) => parts.hostLoad.sampleDownloadRates(...args),
969
+ get encodeCost() { return parts.encodeCost; },
970
+ get getSourceStats() { return parts.getSourceStats; },
971
+ get outputs() { return parts.outputs; },
972
+ get qualityOffer() { return parts.qualityOffer; },
973
+ get segmentDurationSec() { return parts.segmentDurationSec; },
974
+ segmentPaths,
975
+ get videoEncoder() { return parts.encoders.current; },
976
+ });
977
+ parts.budgetTimer = setInterval(() => {
978
+ parts.cushion.reportCushions();
979
+ void parts.quality.runQualityBudgetOnce();
980
+ }, BUDGET_CHECK_INTERVAL_MS);
981
+ parts.budgetTimer.unref();
982
+ return parts;
983
+ }