@torrent-tv/proxy 2.88.4 → 2.88.5

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