@torrent-tv/proxy 2.86.0 → 2.87.1

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 (385) hide show
  1. package/CHANGELOG.md +2142 -1915
  2. package/CLAUDE.md +322 -197
  3. package/assets/calibration/NOTICE.md +2 -2
  4. package/bin/cli.js +684 -616
  5. package/biome.json +409 -233
  6. package/docs/browser-proxy-contract.md +94 -0
  7. package/docs/container-architecture.md +218 -213
  8. package/docs/download-architecture.md +7 -7
  9. package/docs/encode-architecture.md +287 -11
  10. package/docs/encode-run-state.md +2 -2
  11. package/docs/logs.md +97 -97
  12. package/docs/{disk-architecture.md → storage-architecture.md} +107 -1
  13. package/openspec/changes/adaptive-bitrate/design.md +2 -2
  14. package/openspec/changes/adaptive-bitrate/proposal.md +1 -1
  15. package/openspec/changes/adaptive-bitrate/tasks.md +1 -1
  16. package/openspec/changes/chunked-request-bodies/design.md +1 -1
  17. package/openspec/changes/chunked-request-bodies/proposal.md +1 -1
  18. package/openspec/changes/chunked-request-bodies/tasks.md +1 -1
  19. package/openspec/changes/cold-start/design.md +1 -1
  20. package/openspec/changes/disk-cap/proposal.md +1 -1
  21. package/openspec/changes/proxy-observability/proposal.md +2 -2
  22. package/openspec/changes/track-selection/proposal.md +1 -1
  23. package/openspec/changes/transcode-quality/proposal.md +1 -1
  24. package/package.json +2 -2
  25. package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
  26. package/research/double-spawn-2026-09-10.md +171 -171
  27. package/routes/api/playback-plan/post.js +2 -2
  28. package/routes/api/sources/files/get.js +1 -1
  29. package/routes/api/sources/stats/get.js +1 -1
  30. package/routes/api/sources/warm/post.js +10 -3
  31. package/routes/api/subtitles/get.js +230 -230
  32. package/routes/api/transcode-sessions/fragment-far/post.js +3 -3
  33. package/routes/api/transcode-sessions/net-report/post.js +129 -94
  34. package/routes/api/transcode-sessions/post.js +160 -139
  35. package/routes/api/transcode-sessions/progress/get.js +3 -3
  36. package/routes/api/transcode-sessions/release/post.js +3 -3
  37. package/routes/api/transcode-sessions/seek/post.js +12 -3
  38. package/routes/stream/get.js +2 -2
  39. package/routes/transcode/audio-file/get.js +15 -6
  40. package/routes/transcode/audio-warm/get.js +9 -6
  41. package/routes/transcode/session-file/get.js +52 -268
  42. package/routes/transcode/variant-file/get.js +46 -7
  43. package/routes/transcode/variant-warm/get.js +19 -6
  44. package/scripts/render-run-graph.js +1 -1
  45. package/server.js +720 -465
  46. package/services/encode/CoverageMap.js +428 -428
  47. package/services/encode/CushionReport.js +345 -0
  48. package/services/encode/EncodeAdmission.js +332 -0
  49. package/services/{orchestrators → encode}/EncodeOrchestrator.js +307 -29
  50. package/services/encode/EncodeRun.js +16 -9
  51. package/services/encode/EncodeRuns.js +1229 -0
  52. package/services/encode/Encoder.js +18 -2
  53. package/services/encode/EncoderSelection.js +38 -0
  54. package/services/encode/LocalObservations.js +359 -0
  55. package/services/encode/NvencEncoder.js +5 -0
  56. package/services/encode/OutputOpening.js +755 -0
  57. package/services/encode/OutputTimes.js +579 -0
  58. package/services/encode/Renditions.js +2162 -0
  59. package/services/encode/RunProgress.js +84 -0
  60. package/services/encode/SoftwareEncoder.js +12 -7
  61. package/services/encode/args.js +402 -186
  62. package/services/encode/calibration.js +361 -0
  63. package/services/encode/contention.js +128 -128
  64. package/services/encode/encode-run-state.js +16 -20
  65. package/services/encode/fingerprint.js +322 -0
  66. package/services/{hwaccel.js → encode/hwaccel.js} +82 -42
  67. package/services/{learned-median.js → encode/learned-median.js} +11 -0
  68. package/services/encode/output/EncodedOutput.js +57 -0
  69. package/services/encode/output/Output.js +131 -0
  70. package/services/{output/LiveOutputs.js → encode/output/OutputCatalog.js} +141 -40
  71. package/services/encode/output/OutputSpec.js +390 -0
  72. package/services/{output → encode/output}/Timeline.js +12 -37
  73. package/services/encode/output/index.js +20 -0
  74. package/services/encode/output/ladder.js +32 -0
  75. package/services/{output → encode/output}/playlists.js +3 -0
  76. package/services/encode/output-key-format.js +21 -0
  77. package/services/encode/quality/EncodeCost.js +1083 -0
  78. package/services/encode/quality/HostLoad.js +525 -0
  79. package/services/encode/quality/HostTimings.js +249 -0
  80. package/services/encode/quality/OutputQualityState.js +28 -0
  81. package/services/encode/quality/QualityController.js +935 -0
  82. package/services/encode/quality/QualityOffer.js +416 -0
  83. package/services/encode/quality/drain-threat.js +47 -0
  84. package/services/encode/quality/link-budget.js +254 -0
  85. package/services/encode/quality/output-format.js +266 -0
  86. package/services/encode/quality/serving-output.js +216 -0
  87. package/services/encode/quality/visible-rung.js +57 -0
  88. package/services/encode/run-command.js +23 -20
  89. package/services/encode/run-inputs.js +42 -0
  90. package/services/{segment-formats → encode/segment-formats}/fmp4.js +63 -0
  91. package/services/{segment-formats → encode/segment-formats}/index.js +3 -3
  92. package/services/encode/segment-formats/init-compat.js +324 -0
  93. package/services/{segment-formats → encode/segment-formats}/mp4-boxes.js +8 -3
  94. package/services/encode/throughput.js +97 -0
  95. package/services/{orchestrators → media}/ContainerOrchestrator.js +45 -7
  96. package/services/media/KeyframeTables.js +316 -0
  97. package/services/{source → media}/SourceFile.js +7 -55
  98. package/services/{torrent-worker/subtitle-cues.js → media/SubtitleCues.js} +103 -132
  99. package/services/media/SubtitleOrchestrator.js +167 -0
  100. package/services/{audio-inventory.js → media/audio-inventory.js} +7 -1
  101. package/services/{container → media/container}/AviContainer.js +266 -266
  102. package/services/{container → media/container}/Container.js +596 -601
  103. package/services/media/container/ContainerFactory.js +56 -0
  104. package/services/media/container/KeyframeTable.js +272 -0
  105. package/services/{container → media/container}/MatroskaContainer.js +1485 -1485
  106. package/services/{container → media/container}/Mp4Container.js +1244 -1244
  107. package/services/{container → media/container}/SubtitleFileContainer.js +322 -322
  108. package/services/media/keyframe-probe.js +157 -0
  109. package/services/media/media-info-probe.js +93 -0
  110. package/services/{playback-planner.js → media/playback-planner.js} +82 -39
  111. package/services/{tracks → media/tracks}/AudioTrack.js +131 -131
  112. package/services/{tracks → media/tracks}/language-detect.js +174 -174
  113. package/services/server/OutputLifecycle.js +418 -0
  114. package/services/server/SegmentServing.js +1146 -0
  115. package/services/server/ViewerRequests.js +522 -0
  116. package/services/server/controllers/PlaybackController.js +36 -0
  117. package/services/{controllers → server/controllers}/SubtitleController.js +17 -33
  118. package/services/server/http-responses.js +60 -0
  119. package/services/server/transcode-session-files.js +325 -0
  120. package/services/server/wire-outputs.js +983 -0
  121. package/services/storage/Diagnostics.js +202 -0
  122. package/services/storage/MachineBudget.js +235 -0
  123. package/services/{piece-store → storage}/allowance.js +107 -107
  124. package/services/{core-dumps.js → storage/core-dumps.js} +1 -1
  125. package/services/{files → storage/files}/CompletedFiles.js +116 -1
  126. package/services/{disk → storage}/free.js +33 -0
  127. package/services/storage/machine-memory.js +56 -0
  128. package/services/{memory-report.js → storage/memory-report.js} +575 -596
  129. package/services/{piece-store → storage/piece-store}/piece-disk-store.js +0 -7
  130. package/services/{piece-store → storage/piece-store}/shared-piece-store.js +28 -21
  131. package/services/{encode → storage/segment-store}/SegmentStore.js +395 -8
  132. package/services/storage/wire.js +175 -0
  133. package/services/{download → torrent/download}/SwarmSelection.js +2 -2
  134. package/services/{download → torrent/download}/registry.js +2 -2
  135. package/services/torrent/files.js +1 -1
  136. package/services/torrent/piece-store-of.js +29 -0
  137. package/services/{torrent-pool.js → torrent/torrent-pool.js} +26 -119
  138. package/services/{torrent-worker → torrent/worker}/background-fill.js +2 -2
  139. package/services/{torrent-worker → torrent/worker}/channel.js +271 -250
  140. package/services/{torrent-worker → torrent/worker}/client.js +77 -58
  141. package/services/torrent/worker/held-bytes.js +155 -0
  142. package/services/{torrent-worker → torrent/worker}/install-webrtc-shim.js +1 -1
  143. package/services/{torrent-worker → torrent/worker}/piece-reader.js +21 -30
  144. package/services/{torrent-worker → torrent/worker}/pool-adapter.js +101 -137
  145. package/services/{torrent-worker → torrent/worker}/protocol.js +26 -30
  146. package/services/torrent/worker/resume-warm.js +107 -0
  147. package/services/{torrent-worker → torrent/worker}/webrtc-shim.js +2 -2
  148. package/services/{torrent-worker → torrent/worker}/worker.js +68 -159
  149. package/services/{data-channel-handler.js → transport/data-channel-handler.js} +1356 -1356
  150. package/services/{delivery-probe.js → transport/delivery-probe.js} +842 -842
  151. package/services/{health-collector.js → transport/health-collector.js} +6 -35
  152. package/services/{packet-witness.js → transport/packet-witness.js} +808 -784
  153. package/services/{port-mapper.js → transport/port-mapper.js} +1 -1
  154. package/services/{usrsctp-state.js → transport/usrsctp-state.js} +1 -1
  155. package/services/{webrtc-manager.js → transport/webrtc-manager.js} +1 -1
  156. package/services/viewer/Assignments.js +340 -0
  157. package/services/{priority → viewer}/PriorityMap.js +390 -390
  158. package/services/{priority → viewer}/PriorityOrchestrator.js +325 -320
  159. package/services/viewer/Viewer.js +657 -483
  160. package/services/viewer/Viewers.js +368 -257
  161. package/services/viewer/active-output.js +37 -54
  162. package/services/viewer/audio-start.js +4 -3
  163. package/services/viewer/buffer-trend.js +81 -0
  164. package/services/viewer/choices.js +647 -0
  165. package/services/viewer/positions.js +126 -120
  166. package/services/viewer/report-intake.js +46 -45
  167. package/test/asset-paths.test.js +28 -0
  168. package/test/audio-inventory.test.js +3 -3
  169. package/test/audio-track-bitrate.test.js +40 -0
  170. package/test/auto-quality-step.test.js +707 -515
  171. package/test/available-share.test.js +1 -1
  172. package/test/background-fill.test.js +1 -1
  173. package/test/client-log-file.test.js +110 -110
  174. package/test/completed-files.test.js +1 -1
  175. package/test/concurrent-cost.test.js +13 -3
  176. package/test/container-media-info.test.js +3 -3
  177. package/test/core-dumps.test.js +1 -1
  178. package/test/coverage-follows-the-disk.test.js +46 -9
  179. package/test/cue-push-carries-what-the-walk-found.test.js +58 -0
  180. package/test/cut-times-timeline.test.js +2 -2
  181. package/test/cuts-follow-published-grid.test.js +9 -8
  182. package/test/data-channel-frame.test.js +1 -1
  183. package/test/dead-torrent-handle.test.js +1 -1
  184. package/test/declared-rates.test.js +2 -2
  185. package/test/declared-tracks.test.js +2 -2
  186. package/test/decode-cost-fit.test.js +1 -1
  187. package/test/decode-cost.test.js +34 -25
  188. package/test/delivery-probe.test.js +1 -1
  189. package/test/demand-register.test.js +4 -4
  190. package/test/dht-bootstrap.test.js +1 -1
  191. package/test/drain-threat.test.js +65 -0
  192. package/test/duplicate-add.test.js +1 -1
  193. package/test/encode-admission.test.js +146 -0
  194. package/test/encode-cost.test.js +199 -10
  195. package/test/encode-orchestrator.test.js +39 -1
  196. package/test/encode-plan-viewers.test.js +2 -2
  197. package/test/encode-run.test.js +2 -2
  198. package/test/encode-slope.test.js +1 -1
  199. package/test/encoded-output.test.js +39 -0
  200. package/test/encoder-readings.test.js +1 -1
  201. package/test/every-claimant-is-told-its-share.test.js +152 -0
  202. package/test/failed-encoder-still-serves-what-exists.test.js +354 -0
  203. package/test/failed-start-breaker.test.js +81 -30
  204. package/test/fastest-wires.test.js +1 -1
  205. package/test/ffmpeg-stream-counts.test.js +1 -1
  206. package/test/file-edges.test.js +3 -3
  207. package/test/fmp4-self-contained.test.js +1 -1
  208. package/test/fmp4-timestamps.test.js +1 -1
  209. package/test/fmp4-track-completeness.test.js +1 -1
  210. package/test/format-keyed-outputs.test.js +78 -0
  211. package/test/health-metrics.test.js +3 -2
  212. package/test/held-request-width.test.js +22 -23
  213. package/test/helpers/encode-run.js +136 -136
  214. package/test/helpers/held-file.js +29 -0
  215. package/test/helpers/manager.js +57 -0
  216. package/test/helpers/output-spec.js +63 -0
  217. package/test/host-load.test.js +1 -1
  218. package/test/index-accuracy-is-about-the-file.test.js +128 -0
  219. package/test/init-compat.test.js +219 -0
  220. package/test/input-lost-quiets-the-plan.test.js +1 -1
  221. package/test/input-unavailable.test.js +1 -1
  222. package/test/keeping-period.test.js +4 -4
  223. package/test/keyframe-index-accuracy.test.js +97 -45
  224. package/test/keyframe-table-budget.test.js +28 -33
  225. package/test/keyframes-belong-to-the-file.test.js +174 -57
  226. package/test/learned-median.test.js +1 -1
  227. package/test/letting-go-asks-who-is-watching.test.js +191 -0
  228. package/test/limit-row-by-area.test.js +60 -0
  229. package/test/link-budget.test.js +111 -0
  230. package/test/link-probe.test.js +56 -56
  231. package/test/local-encoding-data.test.js +273 -0
  232. package/test/look-ahead-coverage.test.js +1 -1
  233. package/test/manager-surface.test.js +294 -0
  234. package/test/matroska-blocks.test.js +0 -0
  235. package/test/matroska-cues-track.test.js +1 -1
  236. package/test/memory-budget.test.js +2 -2
  237. package/test/mp4-composition-times.test.js +0 -0
  238. package/test/mp4-subtitles.test.js +1 -1
  239. package/test/one-authority.test.js +45 -41
  240. package/test/one-budget.test.js +149 -0
  241. package/test/one-output-one-session.test.js +204 -0
  242. package/test/{disk-space.test.js → one-resource-divided.test.js} +30 -10
  243. package/test/one-serving-output-per-height.test.js +458 -0
  244. package/test/orchestrator-wired.test.js +46 -45
  245. package/test/output-catalog.test.js +39 -0
  246. package/test/output-shape.test.js +4 -51
  247. package/test/output-spec.test.js +251 -157
  248. package/test/output-speed.test.js +17 -15
  249. package/test/outputs-being-prepared.test.js +40 -0
  250. package/test/packet-witness-ring.test.js +2 -2
  251. package/test/packet-witness.test.js +1 -1
  252. package/test/piece-disk-store.test.js +2 -2
  253. package/test/piece-from-whole-file.test.js +1 -1
  254. package/test/piece-lru.test.js +1 -1
  255. package/test/piece-reader.test.js +2 -2
  256. package/test/piece-store-eviction.test.js +1 -1
  257. package/test/piece-store-never-refuses.test.js +1 -1
  258. package/test/piece-store-reservations.test.js +1 -1
  259. package/test/piece-store-slow-disk.test.js +1 -1
  260. package/test/piece-tail.test.js +1 -1
  261. package/test/plan-host-timings.test.js +1 -1
  262. package/test/plan-is-steady.test.js +225 -225
  263. package/test/priority-map-download.test.js +4 -4
  264. package/test/priority-map-emptied.test.js +204 -205
  265. package/test/priority-map-per-output.test.js +215 -209
  266. package/test/priority-map.test.js +1 -1
  267. package/test/probe-wedge-certainty.test.js +1 -1
  268. package/test/produced-copy-choice.test.js +15 -60
  269. package/test/quality-offer.test.js +162 -0
  270. package/test/quality-variants.test.js +1229 -1167
  271. package/test/rate-control-in-the-output.test.js +180 -0
  272. package/test/read-survives-withdrawal.test.js +2 -2
  273. package/test/read-window.test.js +10 -3
  274. package/test/resume-warm.test.js +1 -1
  275. package/test/run-inputs.test.js +80 -0
  276. package/test/run-position-follows-published-grid.test.js +13 -11
  277. package/test/run-progress.test.js +65 -0
  278. package/test/same-height-switch.test.js +664 -0
  279. package/test/seek-frees-the-viewers-requests.test.js +217 -0
  280. package/test/seek-landing.test.js +13 -13
  281. package/test/seek-target-not-superseded.test.js +28 -29
  282. package/test/segment-closed-on-both-branches.test.js +96 -0
  283. package/test/segment-cut-times.test.js +1 -1
  284. package/test/segment-hold-supersede.test.js +28 -35
  285. package/test/segment-judged-by-its-own-header.test.js +221 -0
  286. package/test/segment-serve-wiring.test.js +130 -39
  287. package/test/segment-store-eviction.test.js +22 -7
  288. package/test/segment-store.test.js +98 -14
  289. package/test/segment-true-start.test.js +1 -1
  290. package/test/segments-are-shared.test.js +17 -16
  291. package/test/send-chunk-bytes.test.js +1 -1
  292. package/test/serving-existing-output.test.js +102 -0
  293. package/test/serving-output.test.js +102 -0
  294. package/test/shared-piece-store.test.js +1 -1
  295. package/test/source-file.test.js +1 -1
  296. package/test/stale-request-after-seek.test.js +17 -21
  297. package/test/startup-readings.test.js +10 -5
  298. package/test/subtitle-cue-framing.test.js +5 -5
  299. package/test/subtitle-cue-source.test.js +36 -38
  300. package/test/subtitle-cue-walk.test.js +11 -10
  301. package/test/subtitle-defaults.test.js +1 -1
  302. package/test/subtitle-language.test.js +4 -4
  303. package/test/subtitle-track-numbering.test.js +5 -4
  304. package/test/supply-margin.test.js +1 -1
  305. package/test/swarm-follows-readers.test.js +3 -3
  306. package/test/swarm-reach.test.js +1 -1
  307. package/test/swarm-selection.test.js +3 -3
  308. package/test/tail-duplication.test.js +1 -1
  309. package/test/the-channel-has-both-ends.test.js +91 -0
  310. package/test/the-torrent-thread-serves-bytes.test.js +107 -0
  311. package/test/thread-pool.test.js +3 -3
  312. package/test/timeline.test.js +1 -12
  313. package/test/torrent-cost.test.js +1 -1
  314. package/test/tracks-begin-together.test.js +38 -24
  315. package/test/tunnel-renewal.test.js +1 -1
  316. package/test/two-viewers-one-picture.test.js +120 -87
  317. package/test/upload-hurry.test.js +3 -3
  318. package/test/usrsctp-state.test.js +1 -1
  319. package/test/video-facts.test.js +1 -1
  320. package/test/viewer-assignments.test.js +143 -0
  321. package/test/viewer-outputs.test.js +60 -52
  322. package/test/viewer-presence.test.js +22 -25
  323. package/test/viewer-requests-admission.test.js +89 -0
  324. package/test/viewer-states.test.js +189 -202
  325. package/test/viewer-subtitle-subscription.test.js +1 -1
  326. package/test/viewer.test.js +139 -136
  327. package/test/viewing-generations.test.js +390 -0
  328. package/test/visible-rung.test.js +37 -0
  329. package/test/wait-ledger.test.js +1 -1
  330. package/test/webrtc-shim.test.js +3 -3
  331. package/test/wedge-certainty.test.js +2 -2
  332. package/test/withdraw-piece-claim.test.js +2 -2
  333. package/test/worker-channel.test.js +1 -31
  334. package/utils/client-log-file.js +151 -151
  335. package/scripts/read-container-index.mjs +0 -108
  336. package/services/container/ContainerFactory.js +0 -122
  337. package/services/controllers/PlaybackController.js +0 -33
  338. package/services/disk/DiskSpace.js +0 -150
  339. package/services/disk/wire.js +0 -61
  340. package/services/hls-session-manager.js +0 -9608
  341. package/services/orchestrators/SubtitleOrchestrator.js +0 -160
  342. package/services/output/Output.js +0 -94
  343. package/services/output/OutputSpec.js +0 -202
  344. package/services/output/index.js +0 -1
  345. package/services/output/ladder.js +0 -26
  346. package/services/produced-index.js +0 -222
  347. package/services/quality/EncodeCost.js +0 -555
  348. package/services/torrent-worker/container-tracks.js +0 -414
  349. package/services/viewer/link-readings.js +0 -56
  350. package/test/produced-index.test.js +0 -142
  351. /package/{services → bin}/thread-pool.js +0 -0
  352. /package/services/{available-share.js → encode/available-share.js} +0 -0
  353. /package/services/{decode-cost-fit.js → encode/decode-cost-fit.js} +0 -0
  354. /package/services/{encoder-readings.js → encode/encoder-readings.js} +0 -0
  355. /package/services/{host-load.js → encode/host-load.js} +0 -0
  356. /package/services/{output → encode/output}/cut-grid.js +0 -0
  357. /package/services/{output → encode/output}/rates.js +0 -0
  358. /package/services/{segment-formats → encode/segment-formats}/mpegts.js +0 -0
  359. /package/services/{torrent-cost.js → encode/torrent-cost.js} +0 -0
  360. /package/services/{container → media/container}/ebml-reader.js +0 -0
  361. /package/services/{ffmpeg-banner.js → media/ffmpeg-banner.js} +0 -0
  362. /package/services/{tracks → media/tracks}/ContainerTrack.js +0 -0
  363. /package/services/{tracks → media/tracks}/ImageSubtitleTrack.js +0 -0
  364. /package/services/{tracks → media/tracks}/SubtitleTrack.js +0 -0
  365. /package/services/{tracks → media/tracks}/TextSubtitleTrack.js +0 -0
  366. /package/services/{tracks → media/tracks}/VideoTrack.js +0 -0
  367. /package/services/{tracks → media/tracks}/index.js +0 -0
  368. /package/services/{files → storage/files}/piece-from-whole-file.js +0 -0
  369. /package/services/{disk → storage}/keep.js +0 -0
  370. /package/services/{piece-store → storage/piece-store}/piece-lru.js +0 -0
  371. /package/services/{disk → storage}/returns.js +0 -0
  372. /package/services/{demand → torrent/demand}/DemandRegister.js +0 -0
  373. /package/services/{demand → torrent/demand}/Urgency.js +0 -0
  374. /package/services/{demand → torrent/demand}/Window.js +0 -0
  375. /package/services/{demand → torrent/demand}/index.js +0 -0
  376. /package/services/{demand → torrent/demand}/pieces.js +0 -0
  377. /package/services/{download → torrent/download}/withdraw-claim.js +0 -0
  378. /package/services/{supply-margin.js → torrent/supply-margin.js} +0 -0
  379. /package/services/{torrent-source-key.js → torrent/torrent-source-key.js} +0 -0
  380. /package/services/{torrent-worker → torrent/worker}/fastest-wires.js +0 -0
  381. /package/services/{torrent-worker → torrent/worker}/handle-state.js +0 -0
  382. /package/services/{nat-classifier.js → transport/nat-classifier.js} +0 -0
  383. /package/services/{registry-api.js → transport/registry-api.js} +0 -0
  384. /package/services/{tunnel-client.js → transport/tunnel-client.js} +0 -0
  385. /package/services/{priority → viewer}/WaitLedger.js +0 -0
@@ -1,515 +1,707 @@
1
- /**
2
- * @file The automatic quality step: what the proxy does when this machine, or
3
- * the viewer's link, cannot carry the picture it is producing.
4
- *
5
- * The rule these tests exist to pin is one sentence long: THE SIZE OF THE
6
- * PICTURE IS NEVER REWRITTEN UNDERNEATH A RUNNING SESSION. The fMP4 init
7
- * segment is fetched once, by `#EXT-X-MAP`, and `avc1` keeps SPS and PPS in it
8
- * rather than in the fragments — so a run that changes the size produces
9
- * fragments the decoder cannot read, silently, with no layer reporting an
10
- * error. Measured 2026-08-21 on two files: one browser reported
11
- * `size=1280x720` for three and a half minutes over macroblock garbage, the
12
- * other errored on the first mismatched fragment and sat at `size=0x0`.
13
- *
14
- * A change of resolution is a change of VARIANT. So the proxy ASKS, the request
15
- * travels in every progress report, and the browser — where the viewer's own
16
- * choice lives — decides whether to follow it.
17
- */
18
-
19
- import test from "node:test";
20
- import { recordViewerReport } from "../services/viewer/report-intake.js";
21
- import { fakeProcess as fakeEncoder, startRunOn } from "./helpers/encode-run.js";
22
- import assert from "node:assert/strict";
23
- import { SourceFile } from "../services/source/SourceFile.js";
24
- import { Timeline } from "../services/output/Timeline.js";
25
- import { mkdir, mkdtemp, rm, writeFile } from "node:fs/promises";
26
- import os from "node:os";
27
- import path from "node:path";
28
- import { HlsSessionManager } from "../services/hls-session-manager.js";
29
- import { Output } from "../services/output/Output.js";
30
- import { viewerOf } from "../services/viewer/Viewer.js";
31
- import { fmp4Format } from "../services/segment-formats/fmp4.js";
32
- import { softwareDescriptor, maxrateKbpsFor, nominalKbpsForHeight } from "../services/hwaccel.js";
33
- import { readVideoSampleSize } from "../services/segment-formats/mp4-boxes.js";
34
-
35
- const BASE_ID = "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee";
36
- const SEGMENT_SECONDS = 4;
37
-
38
-
39
- /**
40
- * A session shaped like a live one, encoding 720p of a 1080p source.
41
- *
42
- * @param {{ dirPath: string, transcodeVideo?: boolean, cutGrid?: string }} params
43
- * `cutGrid` goes into the file's cut table; left out, it is what production
44
- * builds for this branch.
45
- * @returns {object}
46
- */
47
- function fakeSession({ dirPath, transcodeVideo = true, cutGrid = transcodeVideo ? "uniform" : "keyframe" }) {
48
- return {
49
- id: BASE_ID,
50
- dirPath,
51
- // Where this file is cut, held by the file. A fixture that stated it
52
- // on the session was describing what production no longer does.
53
- //
54
- // The grid travels in here and nowhere else: a copy can only be cut where
55
- // the source already has a keyframe, so this is what decides whether the
56
- // stream publishes variants at all, and `#publishesVariants` reads it off
57
- // the table. The default is what production builds — a keyframe grid only
58
- // where one was read, which is the copy.
59
- timeline: new Timeline({
60
- boundaries: Array.from({ length: 101 }, (_, index) => index * SEGMENT_SECONDS),
61
- cutGrid
62
- }),
63
- state: "ready",
64
- file: new SourceFile({ sourceKey: "source-1", fileIndex: 0, name: "video.mkv" }).learn({ width: 1920, height: 1080, durationSeconds: 400 }),
65
- // An ordinary session reads its own file, and its sound is inside it. The
66
- // three differ only for a soundtrack shipped as a file of its own.
67
- get inputFile() { return this.file; },
68
- get audioFile() { return this.file; },
69
- startedAt: Date.now(),
70
- lastAccessedAt: Date.now(),
71
- runs: new Set(),
72
- runState: "running",
73
- runSerial: 1,
74
- lastError: "",
75
- consumers: new Set(),
76
- segmentFormat: fmp4Format,
77
- transcodeVideo,
78
- transcodeAudio: true,
79
- audioOnly: false,
80
- audioTrackIndex: 0,
81
- // The shape this output is encoded AS, decided once for the output.
82
- output: new Output({
83
- encodeWidth: transcodeVideo ? 1280 : 0,
84
- encodeHeight: transcodeVideo ? 720 : 0,
85
- outputFps: 24,
86
- softwarePreset: null,
87
- applyTonemap: false
88
- }),
89
- encodeRunGeneration: 0,
90
- budgetSlowSince: 0,
91
- budgetUpSince: 0,
92
- budgetLastActionAt: 0,
93
- qualityAsk: null,
94
- initSizeSaid: "",
95
- recentSpeed: null,
96
- rateCapKbps: null,
97
- viewers: new Map(),
98
- linkSlowSince: 0,
99
- lastAloneSpeed: null,
100
- usesExplicitCuts: false,
101
- useSyntheticPlaylist: true,
102
- playlistText: "#EXTM3U\n",
103
- progress: { state: "running", processedSeconds: 40, startPositionSeconds: 0, speed: "1.0x" }
104
- };
105
- }
106
-
107
- /**
108
- * @param {{ transcodeVideo?: boolean, cutGrid?: string }} [options]
109
- * @returns {Promise<{ manager: HlsSessionManager, session: object, dirPath: string, restarts: number[] }>}
110
- */
111
- async function managerWithSession({ transcodeVideo = true, cutGrid } = {}) {
112
- const dirPath = await mkdtemp(path.join(os.tmpdir(), "auto-quality-"));
113
- const manager = new HlsSessionManager({
114
- enabled: true,
115
- ffmpegBin: "ffmpeg",
116
- localBindHost: "127.0.0.1",
117
- localPort: 9090
118
- });
119
- // A software host: the budget's own precondition.
120
- manager.videoEncoder = { kind: "software", name: "libx264", inputArgs: [] };
121
- // A fully-downloaded file, so nothing here is ever read as download-bound —
122
- // the distinction is tested elsewhere and would only obscure these.
123
- manager.getSourceStats = async () => ({
124
- downloadSpeed: 10e6,
125
- fileProgress: 1,
126
- fileLength: 4e9
127
- });
128
- const session = fakeSession({ dirPath, transcodeVideo, cutGrid });
129
- manager.sessionsById.set(BASE_ID, session);
130
- startRunOn(session, { process: fakeEncoder() });
131
- return { manager, session, dirPath };
132
- }
133
-
134
- /**
135
- * Produced segments of a known size, so the observed stream bitrate the link
136
- * check compares against is a real reading of real files.
137
- *
138
- * @param {object} session
139
- * @param {number} bytesEach
140
- * @returns {Promise<void>}
141
- */
142
- async function produceSegments(session, bytesEach) {
143
- // Where the run in force writes.
144
- const runDir = session.dirPath;
145
- await mkdir(runDir, { recursive: true });
146
- for (let index = 0; index < 4; index += 1) {
147
- await writeFile(
148
- path.join(runDir, session.segmentFormat.segmentFileName(index)),
149
- Buffer.alloc(bytesEach)
150
- );
151
- }
152
- }
153
-
154
- test("a picture that cannot be kept up with is asked for as another VARIANT, and its size is left alone", async (t) => {
155
- const { manager, session, dirPath } = await managerWithSession();
156
- t.after(async () => {
157
- await manager.disposeAll();
158
- await rm(dirPath, { recursive: true, force: true });
159
- });
160
-
161
- const sizeBefore = `${session.encodeWidth}x${session.encodeHeight}`;
162
- // Sustained sub-realtime, read as a slope: the run has been slow since well
163
- // before the window, and the reading is from this very run.
164
- session.budgetSlowSince = Date.now() - 60_000;
165
- session.recentSpeed = { speed: 0.7, at: Date.now(), run: [...session.runs][0] };
166
-
167
- await manager.runQualityBudgetOnce();
168
-
169
- assert.equal(
170
- `${session.encodeWidth}x${session.encodeHeight}`,
171
- sizeBefore,
172
- "the size the init segment describes must survive the step — that is the whole fault"
173
- );
174
- assert.ok(session.qualityAsk, "the step is a request to the player to move variant");
175
- assert.ok(
176
- session.qualityAsk.height < 720,
177
- `a step DOWN, and 720p was on screen (asked for ${session.qualityAsk?.height}p)`
178
- );
179
- });
180
-
181
- test("the request reaches the browser in the progress report, and stops once the viewer is there", async (t) => {
182
- const { manager, session, dirPath } = await managerWithSession();
183
- t.after(async () => {
184
- await manager.disposeAll();
185
- await rm(dirPath, { recursive: true, force: true });
186
- });
187
-
188
- session.qualityAsk = { height: 480, at: Date.now(), reason: "measured" };
189
- const asked = await manager.getSessionProgress(BASE_ID);
190
- assert.equal(asked.requestedHeight, 480, "the request travels with every progress report");
191
-
192
- // The player moved: the variant it is now watching IS the height asked for.
193
- session.variantHeight = 480;
194
- const answered = await manager.getSessionProgress(BASE_ID);
195
- assert.equal(answered.requestedHeight, 0, "a request the viewer has answered is not repeated");
196
- assert.equal(session.qualityAsk, null, "and it is let go of, not merely hidden");
197
- });
198
-
199
- test("a request the player never follows runs out instead of being repeated for the whole film", async (t) => {
200
- const { manager, session, dirPath } = await managerWithSession();
201
- t.after(async () => {
202
- await manager.disposeAll();
203
- await rm(dirPath, { recursive: true, force: true });
204
- });
205
-
206
- // A viewer on a manual pick ignores every request by design, and so does a
207
- // stream with no variants. Neither is an error; both look the same from here.
208
- session.qualityAsk = { height: 480, at: Date.now() - 120_000, reason: "measured" };
209
-
210
- const progress = await manager.getSessionProgress(BASE_ID);
211
-
212
- assert.equal(progress.requestedHeight, 0);
213
- assert.equal(session.qualityAsk, null, "said once and let go");
214
- });
215
-
216
- test("a COPIED picture is never asked to slow its encoder, because it has none", async (t) => {
217
- const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
218
- t.after(async () => {
219
- await manager.disposeAll();
220
- await rm(dirPath, { recursive: true, force: true });
221
- });
222
-
223
- // Whatever this reading says, a copy has no encoder to make cheaper: moving
224
- // the viewer to a RE-ENCODED rung costs the machine more, not less.
225
- session.budgetSlowSince = Date.now() - 60_000;
226
- session.recentSpeed = { speed: 0.4, at: Date.now(), run: [...session.runs][0] };
227
-
228
- await manager.runQualityBudgetOnce();
229
-
230
- assert.equal(session.qualityAsk, null, "the copy path's lever is the viewer's link, not the CPU");
231
- });
232
-
233
- test("a measured link becomes the encoder's own bitrate ceiling, and nothing else moves", () => {
234
- // The one lever that reduces what is sent without touching the picture:
235
- // -maxrate/-bufsize and CRF do not appear in the SPS, so the init segment
236
- // already in the player's hands goes on describing every fragment.
237
- const uncapped = softwareDescriptor().buildVideoArgs({
238
- targetWidth: 1280,
239
- targetHeight: 720,
240
- segmentDurationSec: 4,
241
- fps: 24
242
- });
243
- const capped = softwareDescriptor().buildVideoArgs({
244
- targetWidth: 1280,
245
- targetHeight: 720,
246
- segmentDurationSec: 4,
247
- fps: 24,
248
- nominalKbps: 1200
249
- });
250
-
251
- assert.equal(
252
- uncapped[uncapped.indexOf("-maxrate") + 1],
253
- `${maxrateKbpsFor(nominalKbpsForHeight(720))}k`,
254
- "with nothing measured the rung's own nominal rate stands"
255
- );
256
- assert.equal(capped[capped.indexOf("-maxrate") + 1], `${maxrateKbpsFor(1200)}k`);
257
- // Everything that decides the SIZE must be identical in the two.
258
- assert.deepEqual(
259
- uncapped.slice(0, uncapped.indexOf("-maxrate")),
260
- capped.slice(0, capped.indexOf("-maxrate")),
261
- "the scale filter, the codec and the preset are untouched by a rate cap"
262
- );
263
- });
264
-
265
- test("the size an init segment describes is read from the init, not assumed", () => {
266
- // A minimal moov/trak/mdia/minf/stbl/stsd with one avc1 entry. Built here
267
- // rather than taken from a fixture so the offsets under test are the ones
268
- // ISO/IEC 14496-12 states, and a fixture cannot quietly encode a mistake.
269
- const avc1 = Buffer.alloc(8 + 8 + 16 + 4);
270
- avc1.writeUInt32BE(avc1.length, 0);
271
- avc1.write("avc1", 4, "latin1");
272
- avc1.writeUInt16BE(960, 32);
273
- avc1.writeUInt16BE(540, 34);
274
-
275
- const stsd = Buffer.concat([Buffer.alloc(8 + 8), avc1]);
276
- stsd.writeUInt32BE(stsd.length, 0);
277
- stsd.write("stsd", 4, "latin1");
278
- stsd.writeUInt32BE(1, 12); // entry_count
279
-
280
- const wrap = (type, payload) => {
281
- const box = Buffer.alloc(8 + payload.length);
282
- box.writeUInt32BE(box.length, 0);
283
- box.write(type, 4, "latin1");
284
- payload.copy(box, 8);
285
- return box;
286
- };
287
- const init = wrap("moov", wrap("trak", wrap("mdia", wrap("minf", wrap("stbl", stsd)))));
288
-
289
- assert.deepEqual(readVideoSampleSize(init), { width: 960, height: 540 });
290
- assert.equal(readVideoSampleSize(Buffer.alloc(0)), null);
291
- });
292
-
293
- test("a COPIED picture too thick for the viewer's link is asked for as a smaller VARIANT", async (t) => {
294
- const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
295
- t.after(async () => {
296
- await manager.disposeAll();
297
- await rm(dirPath, { recursive: true, force: true });
298
- });
299
-
300
- // Four seconds of segment at 2 MB is ~4 Mbit/s of stream. The viewer reports
301
- // a link that cannot carry it and a buffer that is running dry.
302
- await produceSegments(session, 2_000_000);
303
- viewerOf(session, "viewer").netReport = { linkMbps: 1.0, bufferedAheadSec: 1.5, positionSeconds: null, at: Date.now() };
304
- session.linkSlowSince = Date.now() - 60_000;
305
-
306
- await manager.runQualityBudgetOnce();
307
-
308
- assert.ok(
309
- session.qualityAsk,
310
- "a copy has no encoder to bound, so the only way to send fewer bits is another rendering of the film"
311
- );
312
- assert.ok(session.qualityAsk.height < 1080, `a step down (asked for ${session.qualityAsk?.height}p)`);
313
- });
314
-
315
- test("with two viewers the budget acts on the WORST link, not on whoever reported last", async (t) => {
316
- const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
317
- t.after(async () => {
318
- await manager.disposeAll();
319
- await rm(dirPath, { recursive: true, force: true });
320
- });
321
-
322
- await produceSegments(session, 2_000_000);
323
- // One viewer is comfortable and reported LAST, which under a single field was
324
- // the whole of what the budget saw. The other cannot carry the stream and is
325
- // running dry.
326
- viewerOf(session, "thin").netReport = {
327
- linkMbps: 1.0,
328
- bufferedAheadSec: 1.5,
329
- positionSeconds: 40,
330
- at: Date.now() - 1_000
331
- };
332
- viewerOf(session, "fat").netReport = {
333
- linkMbps: 80,
334
- bufferedAheadSec: 60,
335
- positionSeconds: 40,
336
- at: Date.now()
337
- };
338
- session.linkSlowSince = Date.now() - 60_000;
339
-
340
- await manager.runQualityBudgetOnce();
341
-
342
- assert.ok(
343
- session.qualityAsk,
344
- "the viewer who cannot keep up decides, whichever of them reported most recently"
345
- );
346
- });
347
-
348
- test("a reading stops counting when the person leaves, not when it gets old", async (t) => {
349
- const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
350
- t.after(async () => {
351
- await manager.disposeAll();
352
- await rm(dirPath, { recursive: true, force: true });
353
- });
354
-
355
- await produceSegments(session, 2_000_000);
356
- // A LINK READING DOES NOT EXPIRE. It is the last thing known about that link,
357
- // and how fast a link is does not change because nobody measured it for a
358
- // minute — the page keeps its own last figure for the same reason. What ends
359
- // a reading is the person leaving, which is presence, and presence is the
360
- // connection: silence removes nobody (2026-09-05, a soundtrack's encoder
361
- // stopped because those two questions had one answer).
362
- const gone = viewerOf(session, "gone");
363
- gone.report({ linkMbps: 1.0, bufferedAheadSec: 1.5, positionSeconds: 40, playing: true }, Date.now() - 120_000);
364
- gone.gone = true;
365
- recordViewerReport({
366
- sessions: manager.sessionsById,
367
- viewers: manager.viewers,
368
- sessionId: session.id,
369
- report: { linkMbps: 80, bufferedAheadSec: 60, consumerId: "here", positionSeconds: 40 }
370
- });
371
- session.linkSlowSince = Date.now() - 60_000;
372
-
373
- await manager.runQualityBudgetOnce();
374
-
375
- assert.equal(session.viewers.size, 2, "the viewer is still known — silence is not leaving");
376
- // Their reading is not deleted anywhere: it is simply not theirs to give any
377
- // more, because they are not here. Nothing walks it for a decision.
378
- assert.equal(
379
- viewerOf(session, "gone").linkReading()?.linkMbps,
380
- 1.0,
381
- "their last reading stands as the last thing known about that link"
382
- );
383
- assert.equal(session.qualityAsk, null, "the viewer who is here can carry the picture");
384
- });
385
-
386
- test("the way BACK UP exists, and a bitrate cap is lifted before the picture is enlarged", async (t) => {
387
- const { manager, session, dirPath } = await managerWithSession();
388
- t.after(async () => {
389
- await manager.disposeAll();
390
- await rm(dirPath, { recursive: true, force: true });
391
- });
392
-
393
- // The viewer is on 480p, the machine has been ahead of realtime for longer
394
- // than the up window, and nothing is capping the bitrate.
395
- session.variantHeight = 480;
396
- session.encodeWidth = 854;
397
- session.encodeHeight = 480;
398
- session.recentSpeed = { speed: 2.4, at: Date.now(), run: [...session.runs][0] };
399
- session.budgetUpSince = Date.now() - 120_000;
400
-
401
- await manager.runQualityBudgetOnce();
402
-
403
- assert.ok(session.qualityAsk, "for most of this project's life there was no step up at all");
404
- assert.equal(
405
- session.qualityAsk.height,
406
- 540,
407
- "one rung at a time: the lowest height above the one on screen, never above the source"
408
- );
409
- });
410
-
411
- test("a capped picture gets its own bitrate back before it is asked to grow", async (t) => {
412
- const { manager, session, dirPath } = await managerWithSession();
413
- t.after(async () => {
414
- await manager.disposeAll();
415
- await rm(dirPath, { recursive: true, force: true });
416
- });
417
-
418
- session.variantHeight = 480;
419
- session.encodeWidth = 854;
420
- session.encodeHeight = 480;
421
- session.rateCapKbps = 700;
422
- session.recentSpeed = { speed: 2.4, at: Date.now(), run: [...session.runs][0] };
423
- session.budgetUpSince = Date.now() - 120_000;
424
- // A restart is what lifting the cap costs, and spawning ffmpeg is not this
425
- // test's business. The run the fixture gave the session is the one the
426
- // reading above came from, and replacing it here would make that reading
427
- // belong to a run that is gone — which is exactly what the comparison is for.
428
-
429
- await manager.runQualityBudgetOnce().catch(() => undefined);
430
-
431
- assert.equal(session.rateCapKbps, null, "the cap goes first: it is cheaper than enlarging the picture");
432
- assert.equal(
433
- session.qualityAsk,
434
- null,
435
- "and the height is left for a second unbroken window, so the two do not move at once"
436
- );
437
- });
438
-
439
- test("a stream that publishes no variants is left alone, and said so once", async (t) => {
440
- const { manager, session, dirPath } = await managerWithSession({
441
- transcodeVideo: false,
442
- // A copy whose keyframe index could not be read falls back to an even grid
443
- // ffmpeg does not cut on. Nothing can be aligned to that, so there is no
444
- // master and no variant to move to.
445
- cutGrid: "even"
446
- });
447
- t.after(async () => {
448
- await manager.disposeAll();
449
- await rm(dirPath, { recursive: true, force: true });
450
- });
451
-
452
- await produceSegments(session, 2_000_000);
453
- viewerOf(session, "viewer").netReport = { linkMbps: 1.0, bufferedAheadSec: 1.5, positionSeconds: null, at: Date.now() };
454
- session.linkSlowSince = Date.now() - 60_000;
455
-
456
- await manager.runQualityBudgetOnce();
457
-
458
- assert.equal(session.qualityAsk, null, "asking a player with no variants to change variant is nothing");
459
- assert.equal(session.saidNoVariants, true, "and the reason is stated once, not once per window");
460
- });
461
-
462
- test("a height this machine has been MEASURED failing at is not what the way back up offers", async (t) => {
463
- const { manager, session, dirPath } = await managerWithSession();
464
- t.after(async () => {
465
- await manager.disposeAll();
466
- await rm(dirPath, { recursive: true, force: true });
467
- });
468
-
469
- // The base ran 720p at half realtime and the viewer was stepped down to 480p.
470
- // The base's own height used to be exempt from every refusal — it was the
471
- // rung on screen, back when a step changed the encode inside it — so the way
472
- // back up would have asked for 720p again, failed again, and stepped down
473
- // again, about every hundred seconds for the length of the film.
474
- manager.softwarePresetBenchmark = [{ preset: "ultrafast", pixelsPerSec: 1e6 }];
475
- session.lastAloneSpeed = 0.5;
476
- session.variantHeight = 720;
477
-
478
- const offered = manager.offeredHeights(session);
479
-
480
- assert.ok(!offered.includes(720) || manager.liveOutputs.variantHeightOf(session) === 720);
481
- // Now on the 480p variant: 720p has a reading of its own and must be gone.
482
- session.variantHeight = 480;
483
- session.encodeHeight = 480;
484
- session.encodeWidth = 854;
485
- assert.ok(
486
- !manager.offeredHeights(session).includes(720),
487
- "a rung measured below realtime is withdrawn once the viewer has left it"
488
- );
489
- });
490
-
491
- test("a cap is not lifted because there is no higher rung to compare against", async (t) => {
492
- const { manager, session, dirPath } = await managerWithSession();
493
- t.after(async () => {
494
- await manager.disposeAll();
495
- await rm(dirPath, { recursive: true, force: true });
496
- });
497
-
498
- // At the top offered height, so there is no NEXT rung — and the question of
499
- // whether to lift the cap is about THIS one. Deciding it on "nothing to step
500
- // to, so yes" took the cap off a link measured at a fifth of what the picture
501
- // needs, after which #checkLinkBudget put it straight back: two ffmpeg
502
- // restarts a minute and a half, on exactly the thin cellular viewer the cap
503
- // exists for.
504
- session.variantHeight = 1080;
505
- session.encodeWidth = 1920;
506
- session.encodeHeight = 1080;
507
- session.rateCapKbps = 700;
508
- session.recentSpeed = { speed: 2.4, at: Date.now(), run: [...session.runs][0] };
509
- session.budgetUpSince = Date.now() - 120_000;
510
- viewerOf(session, "viewer").netReport = { linkMbps: 1.0, bufferedAheadSec: 30, positionSeconds: null, at: Date.now() };
511
-
512
- await manager.runQualityBudgetOnce();
513
-
514
- assert.equal(session.rateCapKbps, 700, "the link still cannot carry this picture uncapped");
515
- });
1
+ /**
2
+ * @file The automatic quality step: what the proxy does when this machine, or
3
+ * the viewer's link, cannot carry the picture it is producing.
4
+ *
5
+ * The rule these tests exist to pin is one sentence long: THE SIZE OF THE
6
+ * PICTURE IS NEVER REWRITTEN UNDERNEATH A RUNNING SESSION. The fMP4 init
7
+ * segment is fetched once, by `#EXT-X-MAP`, and `avc1` keeps SPS and PPS in it
8
+ * rather than in the fragments — so a run that changes the size produces
9
+ * fragments the decoder cannot read, silently, with no layer reporting an
10
+ * error. Measured 2026-08-21 on two files: one browser reported
11
+ * `size=1280x720` for three and a half minutes over macroblock garbage, the
12
+ * other errored on the first mismatched fragment and sat at `size=0x0`.
13
+ *
14
+ * A change of resolution is a change of VARIANT. The proxy asks only a viewer
15
+ * in automatic mode, and the request travels only in that viewer's progress
16
+ * report.
17
+ */
18
+
19
+ import test from "node:test";
20
+ import { recordViewerReport } from "../services/viewer/report-intake.js";
21
+ import { fakeProcess as fakeEncoder, startRunOn } from "./helpers/encode-run.js";
22
+ import assert from "node:assert/strict";
23
+ import { SourceFile } from "../services/media/SourceFile.js";
24
+ import { Timeline } from "../services/encode/output/Timeline.js";
25
+ import { mkdir, rm, writeFile } from "node:fs/promises";
26
+ import path from "node:path";
27
+ import { managerWithOwnStore } from "./helpers/manager.js";
28
+ import { Output } from "../services/encode/output/Output.js";
29
+ import { qualityStateOf } from "../services/encode/quality/OutputQualityState.js";
30
+ import { fmp4Format } from "../services/encode/segment-formats/fmp4.js";
31
+ import { softwareDescriptor, maxrateKbpsFor, nominalKbpsFor } from "../services/encode/hwaccel.js";
32
+ import { softwareRateControlFor } from "../services/encode/args.js";
33
+ import { readVideoSampleSize } from "../services/encode/segment-formats/mp4-boxes.js";
34
+ import { outputSpec } from "./helpers/output-spec.js";
35
+
36
+ const BASE_ID = "aaaaaaaabbbbcccc";
37
+ const SEGMENT_SECONDS = 4;
38
+
39
+
40
+ /**
41
+ * A session shaped like a live one, encoding 720p of a 1080p source.
42
+ *
43
+ * @param {{ dirPath: string, transcodeVideo?: boolean, cutGrid?: string }} params
44
+ * `cutGrid` goes into the file's cut table; left out, it is what production
45
+ * builds for this branch.
46
+ * @returns {object}
47
+ */
48
+ function fakeSession({ dirPath, transcodeVideo = true, cutGrid = transcodeVideo ? "uniform" : "keyframe" }) {
49
+ return {
50
+ spec: outputSpec({ transcodeVideo, cutGrid }),
51
+ id: BASE_ID,
52
+ dirPath,
53
+ // Where this file is cut, held by the file. A fixture that stated it
54
+ // on the session was describing what production no longer does.
55
+ //
56
+ // The grid travels in here and nowhere else: a copy can only be cut where
57
+ // the source already has a keyframe, so this is what decides whether the
58
+ // stream publishes variants at all, and `#publishesVariants` reads it off
59
+ // the table. The default is what production builds — a keyframe grid only
60
+ // where one was read, which is the copy.
61
+ timeline: new Timeline({
62
+ boundaries: Array.from({ length: 101 }, (_, index) => index * SEGMENT_SECONDS),
63
+ cutGrid
64
+ }),
65
+ state: "ready",
66
+ file: new SourceFile({ sourceKey: "source-1", fileIndex: 0, name: "video.mkv" }).learn({ width: 1920, height: 1080, durationSeconds: 400 }),
67
+ // An ordinary session reads its own file, and its sound is inside it. The
68
+ // three differ only for a soundtrack shipped as a file of its own.
69
+ get inputFile() { return this.file; },
70
+ get audioFile() { return this.file; },
71
+ startedAt: Date.now(),
72
+ lastAccessedAt: Date.now(),
73
+ runs: new Set(),
74
+ runState: "running",
75
+ runSerial: 1,
76
+ lastError: "",
77
+ consumers: new Set(),
78
+ segmentFormat: fmp4Format,
79
+ transcodeVideo,
80
+ transcodeAudio: true,
81
+ audioOnly: false,
82
+ audioTrackIndex: 0,
83
+ // The shape this output is encoded AS, decided once for the output.
84
+ output: new Output({
85
+ encodeWidth: transcodeVideo ? 1280 : 0,
86
+ encodeHeight: transcodeVideo ? 720 : 0,
87
+ outputFps: 24,
88
+ softwarePreset: null,
89
+ applyTonemap: false
90
+ }),
91
+ encodeRunGeneration: 0,
92
+ usesExplicitCuts: false,
93
+ useSyntheticPlaylist: true,
94
+ playlistText: "#EXTM3U\n",
95
+ progress: { state: "running", processedSeconds: 40, startPositionSeconds: 0, speed: "1.0x" }
96
+ };
97
+ }
98
+
99
+ /**
100
+ * @param {{ transcodeVideo?: boolean, cutGrid?: string }} [options]
101
+ * @returns {Promise<{ manager: object, session: object, dirPath: string, restarts: number[] }>}
102
+ */
103
+ async function managerWithSession({ transcodeVideo = true, cutGrid } = {}) {
104
+ // Its own store root — see `helpers/manager.js` for what sharing one cost.
105
+ const { manager } = managerWithOwnStore();
106
+ // ADDRESSED THE WAY PRODUCTION ADDRESSES IT: a session's segments live in the
107
+ // store's directory for its OUTPUT, and what it has produced is asked of the
108
+ // store by that same key. A fixture with a directory of its own and no key
109
+ // describes a proxy that no longer exists — the observed bitrate the link
110
+ // budget reads would then be taken from files nothing can find.
111
+ const outputKey = `auto-quality:fmt=fmp4:grid=${transcodeVideo ? "uniform" : "kf@0"}:video-only:v=0/${transcodeVideo ? "enc/libx264/1280x720@24/-/none/vbv=-" : "copy"}`;
112
+ manager.segmentStore.useFormat(outputKey, fmp4Format);
113
+ const dirPath = manager.segmentStore.directoryFor(outputKey);
114
+ // A software host: the budget's own precondition.
115
+ // A fully-downloaded file, so nothing here is ever read as download-bound —
116
+ // the distinction is tested elsewhere and would only obscure these.
117
+ manager.getSourceStats = async () => ({
118
+ downloadSpeed: 10e6,
119
+ fileProgress: 1,
120
+ fileLength: 4e9
121
+ });
122
+ const session = fakeSession({ dirPath, transcodeVideo, cutGrid });
123
+ session.outputKey = outputKey;
124
+ manager.outputs.set(BASE_ID, session);
125
+ manager.viewers.of(session, "viewer").qualityMode = "auto";
126
+ // A run that states its speed, as every real one does from its first
127
+ // seconds, and covers the whole film to its last segment, as the plan gives a
128
+ // run: without a speed the plan cannot tell arrangements apart and takes the
129
+ // encoder away, and with an open end it moves the run to a bounded one —
130
+ // which starts a real ffmpeg in the output's directory, and on Windows that
131
+ // directory then cannot be removed while the process lives.
132
+ const run = startRunOn(session, { process: fakeEncoder(), speedX: 1, to: session.timeline.segmentCount - 1, producing: false });
133
+ manager.encodeOrchestrator.adopt(outputKey, run);
134
+ return { manager, session, dirPath };
135
+ }
136
+
137
+ /**
138
+ * Produced segments of a known size, so the observed stream bitrate the link
139
+ * check compares against is a real reading of real files.
140
+ *
141
+ * @param {object} session
142
+ * @param {number} bytesEach
143
+ * @returns {Promise<void>}
144
+ */
145
+ /**
146
+ * This viewer's page reports a buffer that falls a second per second over two
147
+ * segments' time, on the link named: what, on its trend, runs dry before
148
+ * another output could have the piece they need (roadmap item 98).
149
+ *
150
+ * @param {object} viewer
151
+ * @param {number} linkMbps
152
+ * @returns {void}
153
+ */
154
+ function drainingReports(viewer, linkMbps) {
155
+ const now = Date.now();
156
+ for (const [ago, held] of [[8_000, 9], [4_000, 5], [0, 1.5]]) {
157
+ viewer.report({ linkMbps, bufferedAheadSec: held, positionSeconds: 40, playing: true }, now - ago);
158
+ }
159
+ }
160
+
161
+ /**
162
+ * This viewer's page reports a buffer that grows, on the link named.
163
+ *
164
+ * @param {object} viewer
165
+ * @param {number} linkMbps
166
+ * @returns {void}
167
+ */
168
+ function fillingReports(viewer, linkMbps) {
169
+ const now = Date.now();
170
+ for (const [ago, held] of [[8_000, 40], [4_000, 50], [0, 60]]) {
171
+ viewer.report({ linkMbps, bufferedAheadSec: held, positionSeconds: 40, playing: true }, now - ago);
172
+ }
173
+ }
174
+
175
+ async function produceSegments(session, bytesEach) {
176
+ // Where the run in force writes.
177
+ const runDir = session.dirPath;
178
+ await mkdir(runDir, { recursive: true });
179
+ for (let index = 0; index < 4; index += 1) {
180
+ await writeFile(
181
+ path.join(runDir, session.segmentFormat.segmentFileName(index)),
182
+ Buffer.alloc(bytesEach)
183
+ );
184
+ }
185
+ }
186
+
187
+ test("a picture that cannot be kept up with is asked for as another VARIANT, and its size is left alone", async (t) => {
188
+ const { manager, session, dirPath } = await managerWithSession();
189
+ t.after(async () => {
190
+ await manager.lifecycle.disposeAll();
191
+ // The store closes its watch on the directory as it drops the output, and
192
+ // on Windows the directory stays held until the event loop has turned.
193
+ await new Promise((resolve) => setImmediate(resolve));
194
+ await rm(dirPath, { recursive: true, force: true });
195
+ });
196
+
197
+ const sizeBefore = `${session.encodeWidth}x${session.encodeHeight}`;
198
+ // Sustained sub-realtime, read as a slope: the run has been slow since well
199
+ // before the window, and the reading is from this very run.
200
+ qualityStateOf(session).budgetSlowSince = Date.now() - 60_000;
201
+ qualityStateOf(session).recentSpeed = { speed: 0.7, at: Date.now(), run: [...session.runs][0] };
202
+
203
+ await manager.quality.runQualityBudgetOnce();
204
+
205
+ assert.equal(
206
+ `${session.encodeWidth}x${session.encodeHeight}`,
207
+ sizeBefore,
208
+ "the size the init segment describes must survive the step — that is the whole fault"
209
+ );
210
+ assert.ok(manager.viewers.get("viewer").qualityAsk, "the step is a request to the AUTO viewer to move variant");
211
+ assert.ok(
212
+ manager.viewers.get("viewer").qualityAsk.height < 720,
213
+ `a step DOWN, and 720p was on screen (asked for ${manager.viewers.get("viewer").qualityAsk?.height}p)`
214
+ );
215
+ });
216
+
217
+ test("a manual viewer is never sent an automatic quality request", async (t) => {
218
+ const { manager, session, dirPath } = await managerWithSession();
219
+ t.after(async () => {
220
+ await manager.lifecycle.disposeAll();
221
+ // The store closes its watch on the directory as it drops the output, and
222
+ // on Windows the directory stays held until the event loop has turned.
223
+ await new Promise((resolve) => setImmediate(resolve));
224
+ await rm(dirPath, { recursive: true, force: true });
225
+ });
226
+ manager.viewers.get("viewer").qualityMode = "manual";
227
+ qualityStateOf(session).budgetSlowSince = Date.now() - 60_000;
228
+ qualityStateOf(session).recentSpeed = { speed: 0.7, at: Date.now(), run: [...session.runs][0] };
229
+
230
+ await manager.quality.runQualityBudgetOnce();
231
+
232
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null);
233
+ const progress = await manager.viewerRequests.getSessionProgress(BASE_ID, "viewer");
234
+ assert.equal(progress.requestedHeight, 0);
235
+ });
236
+
237
+ test("the request reaches the browser in the progress report, and stops once the viewer is there", async (t) => {
238
+ const { manager, session, dirPath } = await managerWithSession();
239
+ t.after(async () => {
240
+ await manager.lifecycle.disposeAll();
241
+ // The store closes its watch on the directory as it drops the output, and
242
+ // on Windows the directory stays held until the event loop has turned.
243
+ await new Promise((resolve) => setImmediate(resolve));
244
+ await rm(dirPath, { recursive: true, force: true });
245
+ });
246
+
247
+ manager.viewers.get("viewer").qualityAsk = { height: 480, at: Date.now(), reason: "measured" };
248
+ const asked = await manager.viewerRequests.getSessionProgress(BASE_ID, "viewer");
249
+ assert.equal(asked.requestedHeight, 480, "the request travels with every progress report");
250
+
251
+ // The player moved: the variant it is now watching IS the height asked for.
252
+ session.variantHeight = 480;
253
+ const answered = await manager.viewerRequests.getSessionProgress(BASE_ID, "viewer");
254
+ assert.equal(answered.requestedHeight, 0, "a request the viewer has answered is not repeated");
255
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null, "and it is let go of, not merely hidden");
256
+ });
257
+
258
+ test("a request the player never follows runs out instead of being repeated for the whole film", async (t) => {
259
+ const { manager, dirPath } = await managerWithSession();
260
+ t.after(async () => {
261
+ await manager.lifecycle.disposeAll();
262
+ // The store closes its watch on the directory as it drops the output, and
263
+ // on Windows the directory stays held until the event loop has turned.
264
+ await new Promise((resolve) => setImmediate(resolve));
265
+ await rm(dirPath, { recursive: true, force: true });
266
+ });
267
+
268
+ // A viewer on a manual pick ignores every request by design, and so does a
269
+ // stream with no variants. Neither is an error; both look the same from here.
270
+ manager.viewers.get("viewer").qualityAsk = { height: 480, at: Date.now() - 120_000, reason: "measured" };
271
+
272
+ const progress = await manager.viewerRequests.getSessionProgress(BASE_ID, "viewer");
273
+
274
+ assert.equal(progress.requestedHeight, 0);
275
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null, "said once and let go");
276
+ });
277
+
278
+ test("a COPIED picture is never asked to slow its encoder, because it has none", async (t) => {
279
+ const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
280
+ t.after(async () => {
281
+ await manager.lifecycle.disposeAll();
282
+ // The store closes its watch on the directory as it drops the output, and
283
+ // on Windows the directory stays held until the event loop has turned.
284
+ await new Promise((resolve) => setImmediate(resolve));
285
+ await rm(dirPath, { recursive: true, force: true });
286
+ });
287
+
288
+ // Whatever this reading says, a copy has no encoder to make cheaper: moving
289
+ // the viewer to a RE-ENCODED rung costs the machine more, not less.
290
+ qualityStateOf(session).budgetSlowSince = Date.now() - 60_000;
291
+ qualityStateOf(session).recentSpeed = { speed: 0.4, at: Date.now(), run: [...session.runs][0] };
292
+
293
+ await manager.quality.runQualityBudgetOnce();
294
+
295
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null, "the copy path's lever is the viewer's link, not the CPU");
296
+ });
297
+
298
+ test("the output's own rate control is what reaches ffmpeg, and nothing about the size moves with it", () => {
299
+ // Two limits are two outputs (roadmap item 97, step 10): the figures are
300
+ // read off the output's identity and handed to the encoder as they are. The
301
+ // level is the nominal output's, so every limit at one size declares the
302
+ // same one.
303
+ const nominal = softwareRateControlFor({ width: 1280, height: 720, fps: 24 });
304
+ const lower = softwareRateControlFor({ width: 1280, height: 720, fps: 24, capKbps: 1200 });
305
+ const build = (rateControl) => softwareDescriptor().buildVideoArgs({
306
+ targetWidth: 1280,
307
+ targetHeight: 720,
308
+ segmentDurationSec: 4,
309
+ fps: 24,
310
+ rateControl
311
+ });
312
+ const atNominal = build(nominal);
313
+ const atLower = build(lower);
314
+
315
+ assert.equal(atNominal[atNominal.indexOf("-maxrate") + 1], `${maxrateKbpsFor(nominalKbpsFor({ width: 1280, height: 720 }))}k`);
316
+ assert.equal(atLower[atLower.indexOf("-maxrate") + 1], `${maxrateKbpsFor(1200)}k`);
317
+ assert.equal(lower.level, nominal.level, "a lower limit is declared at the nominal output's level");
318
+ assert.equal(atLower[atLower.indexOf("-level:v") + 1], nominal.level);
319
+ assert.deepEqual(
320
+ atNominal.slice(0, atNominal.indexOf("-maxrate")),
321
+ atLower.slice(0, atLower.indexOf("-maxrate")),
322
+ "the scale filter, the codec and the preset are untouched by the limit"
323
+ );
324
+ assert.equal(build(null).includes("-maxrate"), false, "an output that states no limit is given none");
325
+ assert.throws(
326
+ () => softwareRateControlFor({ width: 1280, height: 720, fps: 24, capKbps: nominalKbpsFor({ width: 1280, height: 720 }) + 1 }),
327
+ RangeError,
328
+ "a limit above the size's own is refused, not lowered"
329
+ );
330
+ });
331
+
332
+ test("the size an init segment describes is read from the init, not assumed", () => {
333
+ // A minimal moov/trak/mdia/minf/stbl/stsd with one avc1 entry. Built here
334
+ // rather than taken from a fixture so the offsets under test are the ones
335
+ // ISO/IEC 14496-12 states, and a fixture cannot quietly encode a mistake.
336
+ const avc1 = Buffer.alloc(8 + 8 + 16 + 4);
337
+ avc1.writeUInt32BE(avc1.length, 0);
338
+ avc1.write("avc1", 4, "latin1");
339
+ avc1.writeUInt16BE(960, 32);
340
+ avc1.writeUInt16BE(540, 34);
341
+
342
+ const stsd = Buffer.concat([Buffer.alloc(8 + 8), avc1]);
343
+ stsd.writeUInt32BE(stsd.length, 0);
344
+ stsd.write("stsd", 4, "latin1");
345
+ stsd.writeUInt32BE(1, 12); // entry_count
346
+
347
+ const wrap = (type, payload) => {
348
+ const box = Buffer.alloc(8 + payload.length);
349
+ box.writeUInt32BE(box.length, 0);
350
+ box.write(type, 4, "latin1");
351
+ payload.copy(box, 8);
352
+ return box;
353
+ };
354
+ const init = wrap("moov", wrap("trak", wrap("mdia", wrap("minf", wrap("stbl", stsd)))));
355
+
356
+ assert.deepEqual(readVideoSampleSize(init), { width: 960, height: 540 });
357
+ assert.equal(readVideoSampleSize(Buffer.alloc(0)), null);
358
+ });
359
+
360
+ test("a COPIED picture too thick for the viewer's link is asked for as a smaller VARIANT", async (t) => {
361
+ const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
362
+ t.after(async () => {
363
+ await manager.lifecycle.disposeAll();
364
+ // The store closes its watch on the directory as it drops the output, and
365
+ // on Windows the directory stays held until the event loop has turned.
366
+ await new Promise((resolve) => setImmediate(resolve));
367
+ await rm(dirPath, { recursive: true, force: true });
368
+ });
369
+
370
+ // Four seconds of segment at 2 MB is ~4 Mbit/s of stream. The viewer reports
371
+ // a link that cannot carry it and a buffer that is running dry.
372
+ await produceSegments(session, 2_000_000);
373
+ drainingReports(manager.viewers.of(session, "viewer"), 1.0);
374
+
375
+ await manager.quality.noteViewerReported(session.id, "viewer");
376
+
377
+ assert.ok(
378
+ manager.viewers.get("viewer").qualityAsk,
379
+ "a copy has no encoder to bound, so the only way to send fewer bits is another rendering of the film"
380
+ );
381
+ assert.equal(manager.viewers.get("viewer").qualityAsk.urgent, true, "their buffer runs dry first: no cushion is waited for");
382
+ assert.ok(manager.viewers.get("viewer").qualityAsk.height < 1080, `a step down (asked for ${manager.viewers.get("viewer").qualityAsk?.height}p)`);
383
+ });
384
+
385
+ test("with two viewers each link decides for its own viewer, not the worst for both", async (t) => {
386
+ const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
387
+ t.after(async () => {
388
+ await manager.lifecycle.disposeAll();
389
+ // The store closes its watch on the directory as it drops the output, and
390
+ // on Windows the directory stays held until the event loop has turned.
391
+ await new Promise((resolve) => setImmediate(resolve));
392
+ await rm(dirPath, { recursive: true, force: true });
393
+ });
394
+
395
+ await produceSegments(session, 2_000_000);
396
+ // One viewer is comfortable and reported LAST, which under a single field was
397
+ // the whole of what the budget saw. The other cannot carry the stream and is
398
+ // running dry.
399
+ manager.viewers.of(session, "thin").qualityMode = "auto";
400
+ drainingReports(manager.viewers.of(session, "thin"), 1.0);
401
+ manager.viewers.of(session, "fat").qualityMode = "auto";
402
+ fillingReports(manager.viewers.of(session, "fat"), 80);
403
+
404
+ await manager.quality.noteViewerReported(session.id, "thin");
405
+ await manager.quality.noteViewerReported(session.id, "fat");
406
+
407
+ assert.ok(
408
+ manager.viewers.get("thin").qualityAsk,
409
+ "the viewer who cannot keep up is asked, whichever of them reported most recently"
410
+ );
411
+ assert.equal(
412
+ manager.viewers.get("fat").qualityAsk,
413
+ null,
414
+ "and ONLY them: a thin link is its owner's, and the viewer beside them keeps their picture"
415
+ );
416
+ });
417
+
418
+ test("a reading stops counting when the person leaves, not when it gets old", async (t) => {
419
+ const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
420
+ t.after(async () => {
421
+ await manager.lifecycle.disposeAll();
422
+ // The store closes its watch on the directory as it drops the output, and
423
+ // on Windows the directory stays held until the event loop has turned.
424
+ await new Promise((resolve) => setImmediate(resolve));
425
+ await rm(dirPath, { recursive: true, force: true });
426
+ });
427
+
428
+ await produceSegments(session, 2_000_000);
429
+ // A LINK READING DOES NOT EXPIRE. It is the last thing known about that link,
430
+ // and how fast a link is does not change because nobody measured it for a
431
+ // minute — the page keeps its own last figure for the same reason. What ends
432
+ // a reading is the person leaving, which is presence, and presence is the
433
+ // connection: silence removes nobody (2026-09-05, a soundtrack's encoder
434
+ // stopped because those two questions had one answer).
435
+ const gone = manager.viewers.of(session, "gone");
436
+ gone.qualityMode = "auto";
437
+ gone.report({ linkMbps: 1.0, bufferedAheadSec: 1.5, positionSeconds: 40, playing: true }, Date.now() - 120_000);
438
+ gone.gone = true;
439
+ recordViewerReport({
440
+ outputs: manager.outputs,
441
+ viewers: manager.viewers,
442
+ sessionId: session.id,
443
+ report: { linkMbps: 80, bufferedAheadSec: 60, consumerId: "here", positionSeconds: 40 }
444
+ });
445
+ manager.viewers.get("here").qualityMode = "auto";
446
+
447
+ await manager.quality.noteViewerReported(session.id, "here");
448
+
449
+ assert.equal(manager.viewers.forOutput(session).size, 3, "the viewer is still known — silence is not leaving");
450
+ // Their reading is not deleted anywhere: it is simply not theirs to give any
451
+ // more, because they are not here. Nothing walks it for a decision.
452
+ assert.equal(
453
+ manager.viewers.get("gone").linkReading()?.linkMbps,
454
+ 1.0,
455
+ "their last reading stands as the last thing known about that link"
456
+ );
457
+ assert.equal(manager.viewers.get("here").qualityAsk, null, "the viewer who is here can carry the picture");
458
+ });
459
+
460
+ test("the way BACK UP exists, one rung at a time", async (t) => {
461
+ const { manager, session, dirPath } = await managerWithSession();
462
+ t.after(async () => {
463
+ await manager.lifecycle.disposeAll();
464
+ // The store closes its watch on the directory as it drops the output, and
465
+ // on Windows the directory stays held until the event loop has turned.
466
+ await new Promise((resolve) => setImmediate(resolve));
467
+ await rm(dirPath, { recursive: true, force: true });
468
+ });
469
+
470
+ // The viewer is on 480p and the machine has been ahead of realtime for longer
471
+ // than the up window.
472
+ session.variantHeight = 480;
473
+ session.encodeWidth = 854;
474
+ session.encodeHeight = 480;
475
+ qualityStateOf(session).recentSpeed = { speed: 2.4, at: Date.now(), run: [...session.runs][0] };
476
+ qualityStateOf(session).budgetUpSince = Date.now() - 120_000;
477
+
478
+ await manager.quality.runQualityBudgetOnce();
479
+
480
+ assert.ok(manager.viewers.get("viewer").qualityAsk, "for most of this project's life there was no step up at all");
481
+ assert.equal(
482
+ manager.viewers.get("viewer").qualityAsk.height,
483
+ 540,
484
+ "one rung at a time: the lowest height above the one on screen, never above the source"
485
+ );
486
+ });
487
+
488
+ test("a re-encoded picture too thick for the viewer's link is asked for as a smaller VARIANT, and its output is left as it is", async (t) => {
489
+ // The limit on a picture's bitrate is part of the output now, so a thin link
490
+ // no longer lowers the limit of the output every viewer of it is watching.
491
+ // Until each viewer is served an output of their own (roadmap item 97, steps
492
+ // 11-12), the one lever is a lower height, asked of a viewer in AUTO.
493
+ const { manager, session, dirPath } = await managerWithSession();
494
+ t.after(async () => {
495
+ await manager.lifecycle.disposeAll();
496
+ // The store closes its watch on the directory as it drops the output, and
497
+ // on Windows the directory stays held until the event loop has turned.
498
+ await new Promise((resolve) => setImmediate(resolve));
499
+ await rm(dirPath, { recursive: true, force: true });
500
+ });
501
+ const keyBefore = session.outputKey;
502
+
503
+ await produceSegments(session, 2_000_000);
504
+ manager.viewers.of(session, "viewer").qualityMode = "auto";
505
+ drainingReports(manager.viewers.of(session, "viewer"), 1.0);
506
+
507
+ await manager.quality.noteViewerReported(session.id, "viewer");
508
+
509
+ assert.ok(manager.viewers.get("viewer").qualityAsk, "the viewer is asked to move to a smaller variant");
510
+ assert.equal(session.outputKey, keyBefore, "and the output they were on is not altered under anybody");
511
+ });
512
+
513
+ test("a stream that publishes no variants is left alone, and said so once", async (t) => {
514
+ const { manager, session, dirPath } = await managerWithSession({
515
+ transcodeVideo: false,
516
+ // A copy whose keyframe index could not be read falls back to an even grid
517
+ // ffmpeg does not cut on. Nothing can be aligned to that, so there is no
518
+ // master and no variant to move to.
519
+ cutGrid: "even"
520
+ });
521
+ t.after(async () => {
522
+ await manager.lifecycle.disposeAll();
523
+ // The store closes its watch on the directory as it drops the output, and
524
+ // on Windows the directory stays held until the event loop has turned.
525
+ await new Promise((resolve) => setImmediate(resolve));
526
+ await rm(dirPath, { recursive: true, force: true });
527
+ });
528
+
529
+ await produceSegments(session, 2_000_000);
530
+ drainingReports(manager.viewers.of(session, "viewer"), 1.0);
531
+
532
+ await manager.quality.noteViewerReported(session.id, "viewer");
533
+
534
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null, "asking a player with no variants to change variant is nothing");
535
+ assert.equal(qualityStateOf(session).saidNoVariants, true, "and the reason is stated once, not once per window");
536
+ });
537
+
538
+ test("a height this machine has been MEASURED failing at is not what the way back up offers", async (t) => {
539
+ const { manager, session, dirPath } = await managerWithSession();
540
+ t.after(async () => {
541
+ await manager.lifecycle.disposeAll();
542
+ // The store closes its watch on the directory as it drops the output, and
543
+ // on Windows the directory stays held until the event loop has turned.
544
+ await new Promise((resolve) => setImmediate(resolve));
545
+ await rm(dirPath, { recursive: true, force: true });
546
+ });
547
+
548
+ // The base ran 720p at half realtime and the viewer was stepped down to 480p.
549
+ // The base's own height used to be exempt from every refusal — it was the
550
+ // rung on screen, back when a step changed the encode inside it — so the way
551
+ // back up would have asked for 720p again, failed again, and stepped down
552
+ // again, about every hundred seconds for the length of the film.
553
+ manager.softwarePresetBenchmark = [{ preset: "ultrafast", pixelsPerSec: 1e6 }];
554
+ qualityStateOf(session).lastAloneSpeed = 0.5;
555
+ session.variantHeight = 720;
556
+
557
+ const offered = manager.quality.offeredHeights(session);
558
+
559
+ assert.ok(!offered.includes(720) || manager.outputs.variantHeightOf(session) === 720);
560
+ // Now on the 480p variant: 720p has a reading of its own and must be gone.
561
+ session.variantHeight = 480;
562
+ session.encodeHeight = 480;
563
+ session.encodeWidth = 854;
564
+ assert.ok(
565
+ !manager.quality.offeredHeights(session).includes(720),
566
+ "a rung measured below realtime is withdrawn once the viewer has left it"
567
+ );
568
+ });
569
+
570
+ test("a request is answered when the viewers watching are on that height, whoever they are", async (t) => {
571
+ const { manager, session, dirPath } = await managerWithSession();
572
+ t.after(async () => {
573
+ await manager.lifecycle.disposeAll();
574
+ // The store closes its watch on the directory as it drops the output, and
575
+ // on Windows the directory stays held until the event loop has turned.
576
+ await new Promise((resolve) => setImmediate(resolve));
577
+ await rm(dirPath, { recursive: true, force: true });
578
+ });
579
+ // A named viewer followed the request to a 480p step. The step is an output
580
+ // of its own; the picture's own height is still 720.
581
+ const stepId = "aaaaaaaabbbbdddd";
582
+ const step = { ...fakeSession({ dirPath }), id: stepId, isStep: true, variantHeight: 480 };
583
+ step.outputKey = `${session.outputKey}:step480`;
584
+ manager.outputs.set(stepId, step);
585
+ manager.outputs.markStep(step);
586
+ manager.viewers.of(session, "alice").qualityMode = "auto";
587
+ manager.viewers.of(session, "alice").activeVariantId = stepId;
588
+
589
+ manager.viewers.get("alice").qualityAsk = { height: 480, at: Date.now(), reason: "measured" };
590
+ const answered = await manager.viewerRequests.getSessionProgress(BASE_ID, "alice");
591
+
592
+ assert.equal(answered.requestedHeight, 0, "the viewer is on the height asked for");
593
+ assert.equal(manager.viewers.get("alice").qualityAsk, null, "so the request is let go of");
594
+ });
595
+
596
+ test("a thin link whose buffer is filling moves nothing: the trend, not the reading, decides", async (t) => {
597
+ const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
598
+ t.after(async () => {
599
+ await manager.lifecycle.disposeAll();
600
+ // The store closes its watch on the directory as it drops the output, and
601
+ // on Windows the directory stays held until the event loop has turned.
602
+ await new Promise((resolve) => setImmediate(resolve));
603
+ await rm(dirPath, { recursive: true, force: true });
604
+ });
605
+ await produceSegments(session, 2_000_000);
606
+ fillingReports(manager.viewers.of(session, "viewer"), 1.0);
607
+
608
+ await manager.quality.noteViewerReported(session.id, "viewer");
609
+
610
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null);
611
+ });
612
+
613
+ test("a step up being prepared is dropped once the viewer's buffer starts running dry", async (t) => {
614
+ const { manager, session, dirPath } = await managerWithSession();
615
+ t.after(async () => {
616
+ await manager.lifecycle.disposeAll();
617
+ // The store closes its watch on the directory as it drops the output, and
618
+ // on Windows the directory stays held until the event loop has turned.
619
+ await new Promise((resolve) => setImmediate(resolve));
620
+ await rm(dirPath, { recursive: true, force: true });
621
+ });
622
+ session.variantHeight = 480;
623
+ await produceSegments(session, 200_000);
624
+ const viewer = manager.viewers.get("viewer");
625
+ viewer.askQuality(540, "room to spare", Date.now());
626
+ drainingReports(viewer, 80);
627
+
628
+ await manager.quality.noteViewerReported(session.id, "viewer");
629
+
630
+ assert.equal(viewer.qualityAsk, null, "the conditions it was asked under have gone back");
631
+ });
632
+
633
+ test("a picture seen larger than the rung on screen is asked one rung up, when there is room", async (t) => {
634
+ const { manager, session, dirPath } = await managerWithSession();
635
+ t.after(async () => {
636
+ await manager.lifecycle.disposeAll();
637
+ // The store closes its watch on the directory as it drops the output, and
638
+ // on Windows the directory stays held until the event loop has turned.
639
+ await new Promise((resolve) => setImmediate(resolve));
640
+ await rm(dirPath, { recursive: true, force: true });
641
+ });
642
+ session.variantHeight = 480;
643
+ session.encodeWidth = 854;
644
+ session.encodeHeight = 480;
645
+ qualityStateOf(session).recentSpeed = { speed: 2.4, at: Date.now(), run: [...session.runs][0] };
646
+ manager.viewers.get("viewer").noteVisiblePicture({ width: 1920, height: 1080 });
647
+
648
+ await manager.quality.noteViewerReported(session.id, "viewer");
649
+
650
+ assert.equal(manager.viewers.get("viewer").qualityAsk?.height, 540);
651
+ assert.equal(manager.viewers.get("viewer").qualityAsk?.urgent, false, "a step up waits for the cushion");
652
+ });
653
+
654
+ test("a picture seen smaller than the rung on screen moves nothing until a rung of its height is ready", async (t) => {
655
+ const { manager, session, dirPath } = await managerWithSession();
656
+ t.after(async () => {
657
+ await manager.lifecycle.disposeAll();
658
+ // The store closes its watch on the directory as it drops the output, and
659
+ // on Windows the directory stays held until the event loop has turned.
660
+ await new Promise((resolve) => setImmediate(resolve));
661
+ await rm(dirPath, { recursive: true, force: true });
662
+ });
663
+ manager.viewers.get("viewer").noteVisiblePicture({ width: 640, height: 360 });
664
+
665
+ await manager.quality.noteViewerReported(session.id, "viewer");
666
+
667
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null, "no 360p rung is made yet; nothing is started for this alone");
668
+ });
669
+
670
+ test("a COPY taller than the picture seen is left alone", async (t) => {
671
+ const { manager, session, dirPath } = await managerWithSession({ transcodeVideo: false });
672
+ t.after(async () => {
673
+ await manager.lifecycle.disposeAll();
674
+ // The store closes its watch on the directory as it drops the output, and
675
+ // on Windows the directory stays held until the event loop has turned.
676
+ await new Promise((resolve) => setImmediate(resolve));
677
+ await rm(dirPath, { recursive: true, force: true });
678
+ });
679
+ manager.viewers.get("viewer").noteVisiblePicture({ width: 640, height: 360 });
680
+ // Every smaller rung is ready for them: what stops the move is the rule
681
+ // about copies, and nothing else.
682
+ manager.renditions.heightReadyFor = () => true;
683
+
684
+ await manager.quality.noteViewerReported(session.id, "viewer");
685
+
686
+ assert.equal(manager.viewers.get("viewer").qualityAsk, null, "a copy is never re-encoded for being taller than the screen");
687
+ });
688
+
689
+ test("a step down for the machine goes to the rung the picture seen bounds, where that is lower", async (t) => {
690
+ const { manager, session, dirPath } = await managerWithSession();
691
+ t.after(async () => {
692
+ await manager.lifecycle.disposeAll();
693
+ // The store closes its watch on the directory as it drops the output, and
694
+ // on Windows the directory stays held until the event loop has turned.
695
+ await new Promise((resolve) => setImmediate(resolve));
696
+ await rm(dirPath, { recursive: true, force: true });
697
+ });
698
+ manager.viewers.get("viewer").noteVisiblePicture({ width: 640, height: 360 });
699
+ qualityStateOf(session).budgetSlowSince = Date.now() - 60_000;
700
+ qualityStateOf(session).recentSpeed = { speed: 0.7, at: Date.now(), run: [...session.runs][0] };
701
+
702
+ await manager.quality.runQualityBudgetOnce();
703
+
704
+ const asked = manager.viewers.get("viewer").qualityAsk?.height;
705
+ assert.ok(asked, "the machine cannot keep up: a step down is asked");
706
+ assert.ok(asked <= 360, `not a rung between that the screen cannot show (asked for ${asked}p)`);
707
+ });