@torrent-tv/proxy 2.87.4 → 2.87.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.
- package/.claude/commands/opsx/apply.md +155 -155
- package/.claude/commands/opsx/archive.md +160 -160
- package/.claude/commands/opsx/explore.md +174 -174
- package/.claude/commands/opsx/propose.md +109 -109
- package/.claude/commands/opsx/sync.md +143 -143
- package/.claude/skills/openspec-apply-change/SKILL.md +159 -159
- package/.claude/skills/openspec-archive-change/SKILL.md +117 -117
- package/.claude/skills/openspec-explore/SKILL.md +289 -289
- package/.claude/skills/openspec-propose/SKILL.md +113 -113
- package/.claude/skills/openspec-sync-specs/SKILL.md +147 -147
- package/.dockerignore +5 -5
- package/AGENTS.md +322 -322
- package/CHANGELOG.md +4 -0
- package/Dockerfile +30 -30
- package/LICENSE +16 -16
- package/README.md +369 -369
- package/assets/calibration/NOTICE.md +100 -100
- package/assets/diagnostics/sctpstate.gdb +31 -31
- package/bin/cli.js +684 -684
- package/bin/thread-pool.js +30 -30
- package/biome.json +411 -411
- package/docs/browser-proxy-contract.md +94 -94
- package/docs/container-architecture.md +218 -218
- package/docs/download-architecture.md +261 -261
- package/docs/encode-architecture.md +729 -729
- package/docs/encode-run-state.md +96 -96
- package/docs/logs.md +97 -97
- package/docs/socks5-egress-research.md +114 -114
- package/docs/storage-architecture.md +267 -267
- package/knip.json +14 -14
- package/openspec/changes/adaptive-bitrate/design.md +92 -92
- package/openspec/changes/adaptive-bitrate/proposal.md +56 -56
- package/openspec/changes/adaptive-bitrate/specs/adaptive-bitrate/spec.md +51 -51
- package/openspec/changes/adaptive-bitrate/tasks.md +40 -40
- package/openspec/changes/binary-distribution/.openspec.yaml +2 -2
- package/openspec/changes/binary-distribution/proposal.md +53 -53
- package/openspec/changes/chunked-request-bodies/design.md +81 -81
- package/openspec/changes/chunked-request-bodies/proposal.md +53 -53
- package/openspec/changes/chunked-request-bodies/specs/chunked-request-bodies/spec.md +30 -30
- package/openspec/changes/chunked-request-bodies/tasks.md +40 -40
- package/openspec/changes/cold-start/design.md +98 -98
- package/openspec/changes/cold-start/proposal.md +62 -62
- package/openspec/changes/cold-start/specs/cold-start/spec.md +47 -47
- package/openspec/changes/cold-start/tasks.md +48 -48
- package/openspec/changes/disk-cap/.openspec.yaml +2 -2
- package/openspec/changes/disk-cap/proposal.md +37 -37
- package/openspec/changes/disk-cap/specs/disk-cap/spec.md +25 -25
- package/openspec/changes/disk-cap/tasks.md +19 -19
- package/openspec/changes/proxy-observability/.openspec.yaml +2 -2
- package/openspec/changes/proxy-observability/design.md +38 -38
- package/openspec/changes/proxy-observability/proposal.md +49 -49
- package/openspec/changes/proxy-observability/specs/observability/spec.md +33 -33
- package/openspec/changes/proxy-observability/tasks.md +21 -21
- package/openspec/changes/seek-debounce/design.md +118 -118
- package/openspec/changes/seek-debounce/proposal.md +59 -59
- package/openspec/changes/seek-debounce/specs/seek-debounce/spec.md +41 -41
- package/openspec/changes/seek-debounce/tasks.md +33 -33
- package/openspec/changes/subtitle-language/.openspec.yaml +2 -2
- package/openspec/changes/subtitle-language/proposal.md +50 -50
- package/openspec/changes/subtitle-language/specs/subtitle-language/spec.md +34 -34
- package/openspec/changes/subtitle-language/tasks.md +26 -26
- package/openspec/changes/track-selection/.openspec.yaml +2 -2
- package/openspec/changes/track-selection/design.md +47 -47
- package/openspec/changes/track-selection/proposal.md +45 -45
- package/openspec/changes/track-selection/specs/track-selection/spec.md +41 -41
- package/openspec/changes/track-selection/tasks.md +20 -20
- package/openspec/changes/transcode-quality/.openspec.yaml +2 -2
- package/openspec/changes/transcode-quality/proposal.md +51 -51
- package/openspec/changes/transcode-quality/specs/transcode-quality/spec.md +139 -139
- package/openspec/changes/transcode-quality/tasks.md +63 -63
- package/openspec/config.yaml +38 -38
- package/package.json +1 -1
- package/public/.well-known/appspecific/com.chrome.devtools.json +1 -1
- package/research/delivery-wedge-stand-ladder-2026-09-13.md +329 -329
- package/research/double-spawn-2026-09-10.md +171 -171
- package/research/handover-2026-09-13.md +209 -209
- package/research/handover-reader-claims-removal-2026-09-12.md +166 -166
- package/research/piece-withdrawn-but-still-claimed-2026-09-12.md +175 -175
- package/research/preset-benchmark-size-scaling-2026-08-22.md +55 -55
- package/research/priority-map-is-the-truth-2026-09-12.md +225 -225
- package/routes/api/client-logs/post.js +86 -86
- package/routes/api/delivery-sink/get.js +72 -72
- package/routes/api/link-probe/get.js +51 -51
- package/routes/api/playback-plan/post.js +53 -53
- package/routes/api/sources/files/get.js +100 -100
- package/routes/api/sources/post.js +36 -36
- package/routes/api/sources/stats/get.js +132 -132
- package/routes/api/subtitles/get.js +230 -230
- package/routes/api/transcode-sessions/fragment-far/post.js +60 -60
- package/routes/api/transcode-sessions/net-report/post.js +129 -129
- package/routes/api/transcode-sessions/post.js +160 -160
- package/routes/api/transcode-sessions/progress/get.js +27 -27
- package/routes/api/transcode-sessions/release/post.js +41 -41
- package/routes/api/transcode-sessions/seek/post.js +63 -63
- package/routes/health/get.js +13 -13
- package/routes/healthz/get.js +13 -13
- package/routes/stream/get.js +361 -361
- package/routes/transcode/audio-file/get.js +64 -64
- package/routes/transcode/audio-warm/get.js +84 -84
- package/routes/transcode/session-file/get.js +52 -52
- package/routes/transcode/variant-file/get.js +95 -95
- package/routes/transcode/variant-warm/get.js +84 -84
- package/scripts/render-run-graph.js +173 -173
- package/services/encode/CoverageMap.js +428 -428
- package/services/encode/CushionReport.js +345 -345
- package/services/encode/EncodeAdmission.js +332 -332
- package/services/encode/EncodeOrchestrator.js +1217 -1217
- package/services/encode/EncodePlan.js +1366 -1366
- package/services/encode/EncodeRun.js +776 -776
- package/services/encode/EncodeRuns.js +1229 -1229
- package/services/encode/Encoder.js +142 -142
- package/services/encode/EncoderSelection.js +38 -38
- package/services/encode/LocalObservations.js +359 -359
- package/services/encode/NvencEncoder.js +50 -50
- package/services/encode/OutputOpening.js +755 -755
- package/services/encode/OutputTimes.js +579 -579
- package/services/encode/QsvEncoder.js +58 -58
- package/services/encode/Renditions.js +2162 -2162
- package/services/encode/RunProgress.js +84 -84
- package/services/encode/SegmentDemand.js +95 -95
- package/services/encode/SoftwareEncoder.js +121 -121
- package/services/encode/V4l2m2mEncoder.js +53 -53
- package/services/encode/VaapiEncoder.js +66 -66
- package/services/encode/args.js +416 -416
- package/services/encode/available-share.js +89 -89
- package/services/encode/calibration.js +361 -361
- package/services/encode/contention.js +128 -128
- package/services/encode/decode-cost-fit.js +363 -363
- package/services/encode/encode-exit.js +114 -114
- package/services/encode/encode-run-state.js +551 -551
- package/services/encode/encoder-readings.js +45 -45
- package/services/encode/fingerprint.js +322 -322
- package/services/encode/host-load.js +174 -174
- package/services/encode/hwaccel.js +1894 -1894
- package/services/encode/index.js +9 -9
- package/services/encode/learned-median.js +90 -90
- package/services/encode/output/EncodedOutput.js +57 -57
- package/services/encode/output/Output.js +131 -131
- package/services/encode/output/OutputCatalog.js +414 -414
- package/services/encode/output/OutputSpec.js +390 -390
- package/services/encode/output/Timeline.js +308 -308
- package/services/encode/output/cut-grid.js +107 -107
- package/services/encode/output/index.js +20 -20
- package/services/encode/output/ladder.js +32 -32
- package/services/encode/output/playlists.js +284 -284
- package/services/encode/output/rates.js +125 -125
- package/services/encode/output-key-format.js +21 -21
- package/services/encode/quality/EncodeCost.js +1083 -1083
- package/services/encode/quality/HostLoad.js +525 -525
- package/services/encode/quality/HostTimings.js +249 -249
- package/services/encode/quality/OutputQualityState.js +28 -28
- package/services/encode/quality/QualityController.js +935 -935
- package/services/encode/quality/QualityOffer.js +416 -416
- package/services/encode/quality/drain-threat.js +47 -47
- package/services/encode/quality/link-budget.js +254 -254
- package/services/encode/quality/output-format.js +266 -266
- package/services/encode/quality/serving-output.js +216 -216
- package/services/encode/quality/visible-rung.js +57 -57
- package/services/encode/run-budget.js +97 -97
- package/services/encode/run-command.js +747 -747
- package/services/encode/run-costs.js +155 -155
- package/services/encode/run-inputs.js +42 -42
- package/services/encode/segment-formats/fmp4.js +437 -437
- package/services/encode/segment-formats/index.js +77 -77
- package/services/encode/segment-formats/init-compat.js +324 -324
- package/services/encode/segment-formats/mp4-boxes.js +311 -311
- package/services/encode/segment-formats/mpegts.js +134 -134
- package/services/encode/start-stop-cost.js +178 -178
- package/services/encode/throughput.js +97 -97
- package/services/encode/torrent-cost.js +88 -88
- package/services/identity/installation-id.js +38 -38
- package/services/media/ContainerOrchestrator.js +149 -149
- package/services/media/KeyframeTables.js +316 -316
- package/services/media/SourceFile.js +298 -298
- package/services/media/SubtitleCues.js +520 -520
- package/services/media/SubtitleOrchestrator.js +167 -167
- package/services/media/audio-inventory.js +212 -212
- package/services/media/container/AviContainer.js +266 -266
- package/services/media/container/Container.js +603 -603
- package/services/media/container/ContainerFactory.js +56 -56
- package/services/media/container/KeyframeTable.js +272 -272
- package/services/media/container/MatroskaContainer.js +1494 -1494
- package/services/media/container/Mp4Container.js +1244 -1244
- package/services/media/container/SubtitleFileContainer.js +322 -322
- package/services/media/container/ebml-reader.js +159 -159
- package/services/media/ffmpeg-banner.js +260 -260
- package/services/media/keyframe-probe.js +157 -157
- package/services/media/media-info-probe.js +93 -93
- package/services/media/tracks/AudioTrack.js +131 -131
- package/services/media/tracks/ContainerTrack.js +75 -75
- package/services/media/tracks/ImageSubtitleTrack.js +19 -19
- package/services/media/tracks/SubtitleTrack.js +38 -38
- package/services/media/tracks/TextSubtitleTrack.js +287 -287
- package/services/media/tracks/VideoTrack.js +33 -33
- package/services/media/tracks/index.js +15 -15
- package/services/media/tracks/language-detect.js +174 -174
- package/services/server/OutputLifecycle.js +418 -418
- package/services/server/SegmentServing.js +1146 -1146
- package/services/server/ViewerRequests.js +522 -522
- package/services/server/WaitLedger.js +142 -142
- package/services/server/controllers/PlaybackController.js +36 -36
- package/services/server/controllers/SubtitleController.js +109 -109
- package/services/server/http-responses.js +60 -60
- package/services/server/transcode-session-files.js +325 -325
- package/services/server/wire-outputs.js +983 -983
- package/services/storage/Diagnostics.js +202 -202
- package/services/storage/MachineBudget.js +235 -235
- package/services/storage/allowance.js +107 -107
- package/services/storage/core-dumps.js +106 -106
- package/services/storage/files/CompletedFiles.js +391 -391
- package/services/storage/files/piece-from-whole-file.js +118 -118
- package/services/storage/free.js +71 -71
- package/services/storage/keep.js +48 -48
- package/services/storage/machine-memory.js +56 -56
- package/services/storage/memory-report.js +575 -575
- package/services/storage/piece-store/piece-disk-store.js +516 -516
- package/services/storage/piece-store/piece-lru.js +495 -495
- package/services/storage/piece-store/shared-piece-store.js +1880 -1880
- package/services/storage/returns.js +103 -103
- package/services/storage/segment-store/SegmentStore.js +1196 -1196
- package/services/storage/wire.js +175 -175
- package/services/torrent/Contents.js +324 -324
- package/services/torrent/demand/DemandRegister.js +202 -202
- package/services/torrent/demand/Urgency.js +137 -137
- package/services/torrent/demand/Window.js +118 -118
- package/services/torrent/demand/index.js +8 -8
- package/services/torrent/demand/pieces.js +140 -140
- package/services/torrent/download/SwarmSelection.js +386 -386
- package/services/torrent/download/registry.js +102 -102
- package/services/torrent/download/withdraw-claim.js +80 -80
- package/services/torrent/files.js +455 -455
- package/services/torrent/naming.js +619 -619
- package/services/torrent/piece-store-of.js +29 -29
- package/services/torrent/supply-margin.js +262 -262
- package/services/torrent/torrent-source-key.js +38 -38
- package/services/torrent/worker/background-fill.js +213 -213
- package/services/torrent/worker/channel.js +271 -271
- package/services/torrent/worker/fastest-wires.js +342 -342
- package/services/torrent/worker/handle-state.js +23 -23
- package/services/torrent/worker/held-bytes.js +155 -155
- package/services/torrent/worker/install-webrtc-shim.js +32 -32
- package/services/torrent/worker/piece-reader.js +1078 -1078
- package/services/torrent/worker/resume-warm.js +107 -107
- package/services/torrent/worker/webrtc-shim.js +219 -219
- package/services/transport/data-channel-handler.js +1356 -1356
- package/services/transport/delivery-probe.js +842 -842
- package/services/transport/health-collector.js +53 -53
- package/services/transport/nat-classifier.js +231 -231
- package/services/transport/packet-witness.js +808 -808
- package/services/transport/port-mapper.js +235 -235
- package/services/transport/registry-api.js +81 -81
- package/services/transport/tunnel-client.js +447 -447
- package/services/transport/usrsctp-state.js +175 -175
- package/services/transport/webrtc-manager.js +484 -484
- package/services/viewer/Assignments.js +340 -340
- package/services/viewer/PriorityMap.js +390 -390
- package/services/viewer/PriorityOrchestrator.js +325 -325
- package/services/viewer/Viewer.js +657 -657
- package/services/viewer/Viewers.js +368 -368
- package/services/viewer/active-output.js +37 -37
- package/services/viewer/audio-start.js +46 -46
- package/services/viewer/buffer-trend.js +81 -81
- package/services/viewer/choices.js +647 -647
- package/services/viewer/positions.js +126 -126
- package/services/viewer/report-intake.js +46 -46
- package/store/source-registry.js +71 -73
- package/test/asset-paths.test.js +28 -28
- package/test/audio-inventory.test.js +176 -176
- package/test/audio-track-bitrate.test.js +40 -40
- package/test/auto-quality-step.test.js +707 -707
- package/test/available-share.test.js +76 -76
- package/test/background-fill.test.js +190 -190
- package/test/client-log-file.test.js +110 -110
- package/test/completed-files.test.js +115 -115
- package/test/concurrent-cost.test.js +148 -148
- package/test/container-media-info.test.js +228 -228
- package/test/contention.test.js +76 -76
- package/test/core-dumps.test.js +57 -57
- package/test/coverage-follows-the-disk.test.js +228 -228
- package/test/coverage-map.test.js +195 -195
- package/test/cue-push-carries-what-the-walk-found.test.js +58 -58
- package/test/cut-times-timeline.test.js +65 -65
- package/test/cuts-follow-published-grid.test.js +109 -109
- package/test/data-channel-frame.test.js +63 -63
- package/test/dead-torrent-handle.test.js +52 -52
- package/test/declared-rates.test.js +116 -116
- package/test/declared-tracks.test.js +35 -35
- package/test/decode-cost-fit.test.js +202 -202
- package/test/decode-cost.test.js +462 -462
- package/test/delivery-probe.test.js +393 -393
- package/test/demand-register.test.js +206 -206
- package/test/dht-bootstrap.test.js +72 -72
- package/test/drain-threat.test.js +65 -65
- package/test/duplicate-add.test.js +48 -48
- package/test/encode-admission.test.js +146 -146
- package/test/encode-cost.test.js +283 -283
- package/test/encode-exit.test.js +111 -111
- package/test/encode-orchestrator.test.js +419 -419
- package/test/encode-plan-viewers.test.js +718 -718
- package/test/encode-plan.test.js +545 -545
- package/test/encode-run-state.test.js +314 -314
- package/test/encode-run.test.js +161 -161
- package/test/encode-slope.test.js +46 -46
- package/test/encoded-output.test.js +39 -39
- package/test/encoder-kinds.test.js +122 -122
- package/test/encoder-readings.test.js +46 -46
- package/test/every-claimant-is-told-its-share.test.js +152 -152
- package/test/failed-encoder-still-serves-what-exists.test.js +354 -354
- package/test/failed-start-breaker.test.js +202 -202
- package/test/fastest-wires.test.js +143 -143
- package/test/ffmpeg-stream-counts.test.js +78 -78
- package/test/file-edges.test.js +191 -191
- package/test/fmp4-self-contained.test.js +80 -80
- package/test/fmp4-timestamps.test.js +140 -140
- package/test/fmp4-track-completeness.test.js +41 -41
- package/test/format-keyed-outputs.test.js +78 -78
- package/test/health-metrics.test.js +38 -38
- package/test/held-request-width.test.js +157 -157
- package/test/helpers/encode-run.js +136 -136
- package/test/helpers/held-file.js +29 -29
- package/test/helpers/manager.js +57 -57
- package/test/helpers/output-spec.js +63 -63
- package/test/host-load.test.js +68 -68
- package/test/index-accuracy-is-about-the-file.test.js +128 -128
- package/test/init-compat.test.js +219 -219
- package/test/input-lost-quiets-the-plan.test.js +261 -261
- package/test/input-unavailable.test.js +48 -48
- package/test/installation-id.test.js +39 -39
- package/test/keeping-period.test.js +83 -83
- package/test/keyframe-index-accuracy.test.js +188 -188
- package/test/keyframe-table-budget.test.js +102 -102
- package/test/keyframes-belong-to-the-file.test.js +249 -249
- package/test/learned-median.test.js +37 -37
- package/test/letting-go-asks-who-is-watching.test.js +191 -191
- package/test/limit-row-by-area.test.js +60 -60
- package/test/link-budget.test.js +111 -111
- package/test/link-probe.test.js +56 -56
- package/test/local-encoding-data.test.js +273 -273
- package/test/logger-repeats.test.js +134 -134
- package/test/look-ahead-coverage.test.js +56 -56
- package/test/manager-surface.test.js +292 -292
- package/test/matroska-cues-track.test.js +192 -192
- package/test/memory-budget.test.js +390 -390
- package/test/move-cost.test.js +216 -216
- package/test/mp4-subtitles.test.js +173 -173
- package/test/one-authority.test.js +285 -285
- package/test/one-budget.test.js +149 -149
- package/test/one-output-one-session.test.js +204 -204
- package/test/one-resource-divided.test.js +185 -185
- package/test/one-serving-output-per-height.test.js +458 -458
- package/test/orchestrator-wired.test.js +206 -206
- package/test/output-catalog.test.js +39 -39
- package/test/output-shape.test.js +21 -21
- package/test/output-spec.test.js +251 -251
- package/test/output-speed.test.js +88 -88
- package/test/outputs-being-prepared.test.js +40 -40
- package/test/packet-witness-ring.test.js +236 -236
- package/test/packet-witness.test.js +148 -148
- package/test/piece-disk-store.test.js +381 -381
- package/test/piece-from-whole-file.test.js +129 -129
- package/test/piece-lru.test.js +319 -319
- package/test/piece-reader.test.js +162 -162
- package/test/piece-selection-offset.test.js +85 -85
- package/test/piece-store-eviction.test.js +560 -560
- package/test/piece-store-never-refuses.test.js +153 -153
- package/test/piece-store-reservations.test.js +318 -318
- package/test/piece-store-slow-disk.test.js +159 -159
- package/test/piece-tail.test.js +97 -97
- package/test/plan-host-timings.test.js +68 -68
- package/test/plan-is-steady.test.js +225 -225
- package/test/priority-map-download.test.js +174 -174
- package/test/priority-map-emptied.test.js +204 -204
- package/test/priority-map-per-output.test.js +215 -215
- package/test/priority-map.test.js +163 -163
- package/test/probe-wedge-certainty.test.js +60 -60
- package/test/produced-copy-choice.test.js +213 -213
- package/test/published-timeline.test.js +83 -83
- package/test/quality-offer.test.js +162 -162
- package/test/quality-variants.test.js +1229 -1229
- package/test/rate-control-in-the-output.test.js +180 -180
- package/test/read-survives-withdrawal.test.js +164 -164
- package/test/read-window.test.js +365 -365
- package/test/resume-warm.test.js +39 -39
- package/test/run-graph-drift.test.js +37 -37
- package/test/run-inputs.test.js +80 -80
- package/test/run-intervals.test.js +100 -100
- package/test/run-position-follows-published-grid.test.js +89 -89
- package/test/run-progress.test.js +65 -65
- package/test/same-height-switch.test.js +664 -664
- package/test/seek-frees-the-viewers-requests.test.js +217 -217
- package/test/seek-landing.test.js +109 -109
- package/test/seek-target-not-superseded.test.js +195 -195
- package/test/segment-closed-on-both-branches.test.js +96 -96
- package/test/segment-cut-times.test.js +63 -63
- package/test/segment-demand.test.js +80 -80
- package/test/segment-hold-supersede.test.js +91 -91
- package/test/segment-judged-by-its-own-header.test.js +221 -221
- package/test/segment-serve-wiring.test.js +475 -475
- package/test/segment-store-eviction.test.js +247 -247
- package/test/segment-store.test.js +323 -323
- package/test/segment-true-start.test.js +86 -86
- package/test/segments-are-shared.test.js +176 -176
- package/test/send-chunk-bytes.test.js +86 -86
- package/test/serving-existing-output.test.js +102 -102
- package/test/serving-output.test.js +102 -102
- package/test/shared-piece-store.test.js +310 -310
- package/test/sidecar-naming.test.js +142 -142
- package/test/source-file.test.js +133 -133
- package/test/source-files-route.test.js +103 -103
- package/test/source-registry.test.js +18 -0
- package/test/split-a-stretch.test.js +139 -139
- package/test/stale-request-after-seek.test.js +158 -158
- package/test/startup-readings.test.js +124 -124
- package/test/stream-route.test.js +182 -182
- package/test/subtitle-cue-framing.test.js +200 -200
- package/test/subtitle-cue-source.test.js +102 -102
- package/test/subtitle-cue-walk.test.js +370 -370
- package/test/subtitle-cursor.test.js +63 -63
- package/test/subtitle-defaults.test.js +118 -118
- package/test/subtitle-language.test.js +252 -252
- package/test/subtitle-track-numbering.test.js +386 -386
- package/test/supply-margin.test.js +177 -177
- package/test/swarm-follows-readers.test.js +174 -174
- package/test/swarm-reach.test.js +130 -130
- package/test/swarm-selection.test.js +220 -220
- package/test/tail-duplication.test.js +167 -167
- package/test/the-channel-has-both-ends.test.js +91 -91
- package/test/the-torrent-thread-serves-bytes.test.js +107 -107
- package/test/thread-pool.test.js +53 -53
- package/test/timeline.test.js +84 -84
- package/test/torrent-contents.test.js +235 -235
- package/test/torrent-cost.test.js +71 -71
- package/test/torrent-files.test.js +221 -221
- package/test/torrent-naming.test.js +255 -255
- package/test/tracks-begin-together.test.js +209 -209
- package/test/tunnel-renewal.test.js +167 -167
- package/test/two-viewers-one-picture.test.js +407 -407
- package/test/upload-hurry.test.js +186 -186
- package/test/usrsctp-state.test.js +131 -131
- package/test/video-facts.test.js +102 -102
- package/test/viewer-assignments.test.js +143 -143
- package/test/viewer-outputs.test.js +285 -285
- package/test/viewer-presence.test.js +116 -116
- package/test/viewer-requests-admission.test.js +89 -89
- package/test/viewer-states.test.js +189 -189
- package/test/viewer-subtitle-subscription.test.js +96 -96
- package/test/viewer.test.js +139 -139
- package/test/viewing-generations.test.js +390 -390
- package/test/visible-rung.test.js +37 -37
- package/test/wait-ledger.test.js +100 -100
- package/test/webrtc-shim.test.js +149 -149
- package/test/wedge-certainty.test.js +131 -131
- package/test/withdraw-piece-claim.test.js +212 -212
- package/test/worker-channel.test.js +158 -158
- package/utils/client-log-file.js +151 -151
- package/utils/logger.js +312 -312
- package/utils/parse-range.js +25 -25
- package/utils/perf.js +59 -59
|
@@ -1,92 +1,92 @@
|
|
|
1
|
-
# Design: Adaptive bitrate (proxy)
|
|
2
|
-
|
|
3
|
-
Read before coding: `services/encode/hwaccel.js` (`chooseSoftwareEncodeSettings`,
|
|
4
|
-
the software descriptor's `buildVideoArgs`), `services/hls-session-manager.js`
|
|
5
|
-
(the `BUDGET_*` constants, `#chooseEncodeBudget`, the budget interval check
|
|
6
|
-
`#enforceRealtimeBudget`, `#classifyTranscodeBound`, `#applyBudgetDownshift`,
|
|
7
|
-
session fields around `budgetLadder`), `routes/api/transcode-sessions/`
|
|
8
|
-
(route file conventions), `server.js` (route wiring, deps injection).
|
|
9
|
-
|
|
10
|
-
## (a) Caps — constrained CRF
|
|
11
|
-
|
|
12
|
-
Nominal H.264 rates by rung height (nearest rung wins for odd heights):
|
|
13
|
-
|
|
14
|
-
RUNG_NOMINAL_KBPS = { 1080: 5000, 720: 2800, 480: 1400, 360: 800, 240: 400 }
|
|
15
|
-
CAP_MAXRATE_FACTOR = 1.3
|
|
16
|
-
CAP_BUFSIZE_FACTOR = 1.5
|
|
17
|
-
|
|
18
|
-
In the software descriptor's video args (where `-crf`/`-preset` are emitted),
|
|
19
|
-
add for encode height H (the actual encode height after budget/manual
|
|
20
|
-
selection, not the source height):
|
|
21
|
-
|
|
22
|
-
-maxrate <round(nominal(H) * 1.3)>k
|
|
23
|
-
-bufsize <round(nominal(H) * 1.5)>k
|
|
24
|
-
|
|
25
|
-
CRF stays the quality driver; the caps only bound peaks (standard
|
|
26
|
-
constrained-CRF). Do NOT touch hardware descriptors in this change.
|
|
27
|
-
|
|
28
|
-
## (b) Net report intake
|
|
29
|
-
|
|
30
|
-
Route: `POST /api/transcode-sessions/:id/net-report` (data-channel path, so
|
|
31
|
-
add the prefix to the allowlist regex in `transport/data-channel-handler.js` if not
|
|
32
|
-
covered by the existing `/api/` rule — verify). Body:
|
|
33
|
-
|
|
34
|
-
{ linkMbps: number, bufferedAheadSec: number }
|
|
35
|
-
|
|
36
|
-
Validation: both finite numbers, `linkMbps > 0`, else 400. Unknown session →
|
|
37
|
-
404. On success 204. Handler stores on the session:
|
|
38
|
-
|
|
39
|
-
session.netReport = { linkMbps, bufferedAheadSec, at: Date.now() }
|
|
40
|
-
|
|
41
|
-
## (b) Budget-loop trigger
|
|
42
|
-
|
|
43
|
-
Constants (near the other BUDGET_ constants):
|
|
44
|
-
|
|
45
|
-
LINK_REPORT_FRESH_MS = 30_000 // ignore stale reports
|
|
46
|
-
LINK_SAFETY = 0.8 // usable share of reported link
|
|
47
|
-
LINK_SLOW_WINDOW_MS = 15_000 // sustained deficit before acting
|
|
48
|
-
LINK_LOW_BUFFER_SEC = 10 // only act while the viewer runs dry
|
|
49
|
-
|
|
50
|
-
In the periodic budget check, for each active software-transcode session,
|
|
51
|
-
alongside the CPU check:
|
|
52
|
-
|
|
53
|
-
report fresh (now - at < LINK_REPORT_FRESH_MS)?
|
|
54
|
-
manualQuality not set?
|
|
55
|
-
observed = observed stream bitrate, Mbit/s — recent produced segment
|
|
56
|
-
bytes / segment duration (reuse/extend whatever the CPU path
|
|
57
|
-
reads; a rolling average over the last ~5 segments)
|
|
58
|
-
deficit = report.linkMbps * LINK_SAFETY < observed
|
|
59
|
-
if deficit AND report.bufferedAheadSec < LINK_LOW_BUFFER_SEC:
|
|
60
|
-
accumulate slow-time (same pattern as the CPU slow window)
|
|
61
|
-
if slow ≥ LINK_SLOW_WINDOW_MS → #applyBudgetDownshift(session,
|
|
62
|
-
reason "link") // existing cooldown + step cap + floor apply
|
|
63
|
-
else: reset the link slow window
|
|
64
|
-
|
|
65
|
-
`#applyBudgetDownshift` is reused as-is except the log line carries the
|
|
66
|
-
reason: `budget downshift (link) …` vs the current CPU wording, so the
|
|
67
|
-
client-log pipeline can tell them apart in the field.
|
|
68
|
-
|
|
69
|
-
No upswitch in v1 (mirrors the CPU budget's conservatism). A downshifted
|
|
70
|
-
session stays down until re-opened.
|
|
71
|
-
|
|
72
|
-
## Interactions
|
|
73
|
-
|
|
74
|
-
- Caps make `observed` honest: without (a) a complex scene can spike far
|
|
75
|
-
above nominal and flap the trigger; with caps observed ≤ maxrate.
|
|
76
|
-
- CPU trigger and link trigger share the cooldown inside
|
|
77
|
-
`#applyBudgetDownshift` — they cannot double-fire.
|
|
78
|
-
- `manualQuality` set → link trigger skipped entirely (user pinned quality
|
|
79
|
-
explicitly; the proxy respects it, matching the manual-quality contract).
|
|
80
|
-
- Old browsers never POST reports → trigger never fires → behaviour
|
|
81
|
-
identical to today plus caps.
|
|
82
|
-
|
|
83
|
-
## Verification
|
|
84
|
-
|
|
85
|
-
- Unit: nominal table lookup (exact rungs + nearest for odd heights); ffmpeg
|
|
86
|
-
arg assembly contains the caps; trigger logic with a fake clock (fresh vs
|
|
87
|
-
stale report, deficit accumulating to a downshift, buffer-high suppresses,
|
|
88
|
-
manualQuality suppresses).
|
|
89
|
-
- `node --check` on touched files.
|
|
90
|
-
- Field (after the server change ships): cellular session shows
|
|
91
|
-
`budget downshift (link)` and the stream settles at a rung whose bitrate
|
|
92
|
-
fits the link; segment sizes bounded (~maxrate × segDur / 8 max).
|
|
1
|
+
# Design: Adaptive bitrate (proxy)
|
|
2
|
+
|
|
3
|
+
Read before coding: `services/encode/hwaccel.js` (`chooseSoftwareEncodeSettings`,
|
|
4
|
+
the software descriptor's `buildVideoArgs`), `services/hls-session-manager.js`
|
|
5
|
+
(the `BUDGET_*` constants, `#chooseEncodeBudget`, the budget interval check
|
|
6
|
+
`#enforceRealtimeBudget`, `#classifyTranscodeBound`, `#applyBudgetDownshift`,
|
|
7
|
+
session fields around `budgetLadder`), `routes/api/transcode-sessions/`
|
|
8
|
+
(route file conventions), `server.js` (route wiring, deps injection).
|
|
9
|
+
|
|
10
|
+
## (a) Caps — constrained CRF
|
|
11
|
+
|
|
12
|
+
Nominal H.264 rates by rung height (nearest rung wins for odd heights):
|
|
13
|
+
|
|
14
|
+
RUNG_NOMINAL_KBPS = { 1080: 5000, 720: 2800, 480: 1400, 360: 800, 240: 400 }
|
|
15
|
+
CAP_MAXRATE_FACTOR = 1.3
|
|
16
|
+
CAP_BUFSIZE_FACTOR = 1.5
|
|
17
|
+
|
|
18
|
+
In the software descriptor's video args (where `-crf`/`-preset` are emitted),
|
|
19
|
+
add for encode height H (the actual encode height after budget/manual
|
|
20
|
+
selection, not the source height):
|
|
21
|
+
|
|
22
|
+
-maxrate <round(nominal(H) * 1.3)>k
|
|
23
|
+
-bufsize <round(nominal(H) * 1.5)>k
|
|
24
|
+
|
|
25
|
+
CRF stays the quality driver; the caps only bound peaks (standard
|
|
26
|
+
constrained-CRF). Do NOT touch hardware descriptors in this change.
|
|
27
|
+
|
|
28
|
+
## (b) Net report intake
|
|
29
|
+
|
|
30
|
+
Route: `POST /api/transcode-sessions/:id/net-report` (data-channel path, so
|
|
31
|
+
add the prefix to the allowlist regex in `transport/data-channel-handler.js` if not
|
|
32
|
+
covered by the existing `/api/` rule — verify). Body:
|
|
33
|
+
|
|
34
|
+
{ linkMbps: number, bufferedAheadSec: number }
|
|
35
|
+
|
|
36
|
+
Validation: both finite numbers, `linkMbps > 0`, else 400. Unknown session →
|
|
37
|
+
404. On success 204. Handler stores on the session:
|
|
38
|
+
|
|
39
|
+
session.netReport = { linkMbps, bufferedAheadSec, at: Date.now() }
|
|
40
|
+
|
|
41
|
+
## (b) Budget-loop trigger
|
|
42
|
+
|
|
43
|
+
Constants (near the other BUDGET_ constants):
|
|
44
|
+
|
|
45
|
+
LINK_REPORT_FRESH_MS = 30_000 // ignore stale reports
|
|
46
|
+
LINK_SAFETY = 0.8 // usable share of reported link
|
|
47
|
+
LINK_SLOW_WINDOW_MS = 15_000 // sustained deficit before acting
|
|
48
|
+
LINK_LOW_BUFFER_SEC = 10 // only act while the viewer runs dry
|
|
49
|
+
|
|
50
|
+
In the periodic budget check, for each active software-transcode session,
|
|
51
|
+
alongside the CPU check:
|
|
52
|
+
|
|
53
|
+
report fresh (now - at < LINK_REPORT_FRESH_MS)?
|
|
54
|
+
manualQuality not set?
|
|
55
|
+
observed = observed stream bitrate, Mbit/s — recent produced segment
|
|
56
|
+
bytes / segment duration (reuse/extend whatever the CPU path
|
|
57
|
+
reads; a rolling average over the last ~5 segments)
|
|
58
|
+
deficit = report.linkMbps * LINK_SAFETY < observed
|
|
59
|
+
if deficit AND report.bufferedAheadSec < LINK_LOW_BUFFER_SEC:
|
|
60
|
+
accumulate slow-time (same pattern as the CPU slow window)
|
|
61
|
+
if slow ≥ LINK_SLOW_WINDOW_MS → #applyBudgetDownshift(session,
|
|
62
|
+
reason "link") // existing cooldown + step cap + floor apply
|
|
63
|
+
else: reset the link slow window
|
|
64
|
+
|
|
65
|
+
`#applyBudgetDownshift` is reused as-is except the log line carries the
|
|
66
|
+
reason: `budget downshift (link) …` vs the current CPU wording, so the
|
|
67
|
+
client-log pipeline can tell them apart in the field.
|
|
68
|
+
|
|
69
|
+
No upswitch in v1 (mirrors the CPU budget's conservatism). A downshifted
|
|
70
|
+
session stays down until re-opened.
|
|
71
|
+
|
|
72
|
+
## Interactions
|
|
73
|
+
|
|
74
|
+
- Caps make `observed` honest: without (a) a complex scene can spike far
|
|
75
|
+
above nominal and flap the trigger; with caps observed ≤ maxrate.
|
|
76
|
+
- CPU trigger and link trigger share the cooldown inside
|
|
77
|
+
`#applyBudgetDownshift` — they cannot double-fire.
|
|
78
|
+
- `manualQuality` set → link trigger skipped entirely (user pinned quality
|
|
79
|
+
explicitly; the proxy respects it, matching the manual-quality contract).
|
|
80
|
+
- Old browsers never POST reports → trigger never fires → behaviour
|
|
81
|
+
identical to today plus caps.
|
|
82
|
+
|
|
83
|
+
## Verification
|
|
84
|
+
|
|
85
|
+
- Unit: nominal table lookup (exact rungs + nearest for odd heights); ffmpeg
|
|
86
|
+
arg assembly contains the caps; trigger logic with a fake clock (fresh vs
|
|
87
|
+
stale report, deficit accumulating to a downshift, buffer-high suppresses,
|
|
88
|
+
manualQuality suppresses).
|
|
89
|
+
- `node --check` on touched files.
|
|
90
|
+
- Field (after the server change ships): cellular session shows
|
|
91
|
+
`budget downshift (link)` and the stream settles at a rung whose bitrate
|
|
92
|
+
fits the link; segment sizes bounded (~maxrate × segDur / 8 max).
|
|
@@ -1,56 +1,56 @@
|
|
|
1
|
-
# Proposal: Adaptive bitrate for thin viewer links (proxy side)
|
|
2
|
-
|
|
3
|
-
## Why
|
|
4
|
-
|
|
5
|
-
Field evidence (iPhone on cellular, 2026-07-10, session `14cc1017`): encode
|
|
6
|
-
bitrate is unbounded — transcoded segments reached 9 MB per 4 s (~18 Mbit/s)
|
|
7
|
-
against a measured 1–5.8 Mbit/s cellular link. Result: 45 s prebuffer, buffer
|
|
8
|
-
draining during playback (`bottleneck delta=-7.1s`), "было так себе". The
|
|
9
|
-
realtime budget protects the PROXY's CPU but nothing protects the VIEWER's
|
|
10
|
-
link: quality never adapts to how fast the viewer can actually download.
|
|
11
|
-
|
|
12
|
-
## What Changes
|
|
13
|
-
|
|
14
|
-
Two parts, one release:
|
|
15
|
-
|
|
16
|
-
- **(a) Bitrate caps (constrained CRF).** Software video encodes gain
|
|
17
|
-
`-maxrate`/`-bufsize` sized per resolution rung from a nominal-rate table
|
|
18
|
-
(H.264 ladder: 1080p→5000K, 720p→2800K, 480p→1400K, 360p→800K, 240p→400K;
|
|
19
|
-
nearest rung by encode height). Multipliers from webtor's production
|
|
20
|
-
ladder: `maxrate = 1.3×` nominal, `bufsize = 1.5×` nominal. CRF/preset
|
|
21
|
-
selection stays — the caps only bound the peaks that killed the cellular
|
|
22
|
-
session. Applies to the software (libx264) path; hardware encoders keep
|
|
23
|
-
their current args (follow-up — their rate-control flags differ and any
|
|
24
|
-
change must pass the strict startup test on real hardware).
|
|
25
|
-
- **(b) Viewer-link downshift trigger.** A new data-channel route lets the
|
|
26
|
-
browser report its measured link state (`linkMbps` — rolling median of
|
|
27
|
-
per-segment transfer throughput; `bufferedAheadSec`) every ~10 s. The
|
|
28
|
-
existing realtime-budget loop gains a SECOND downshift trigger: when
|
|
29
|
-
reports are fresh, `manualQuality` is not set, the viewer's link is
|
|
30
|
-
sustainedly slower than the produced stream (`linkMbps × 0.8 <` observed
|
|
31
|
-
segment bitrate for ≥ 15 s) AND the viewer's buffer is low (< 10 s), step
|
|
32
|
-
one rung down via the existing `#applyBudgetDownshift` (same cooldown,
|
|
33
|
-
step cap, no upswitch v1). Distinct log reason (`reason=link`) so field
|
|
34
|
-
logs distinguish CPU-bound from link-bound downshifts.
|
|
35
|
-
|
|
36
|
-
Missing/stale reports change nothing (old clients keep working — the trigger
|
|
37
|
-
simply never fires). Manual quality pins win: when `manualQuality` is set the
|
|
38
|
-
trigger is skipped.
|
|
39
|
-
|
|
40
|
-
## Capabilities
|
|
41
|
-
|
|
42
|
-
### Modified Capabilities
|
|
43
|
-
|
|
44
|
-
- `transcode-quality`: encodes are bitrate-capped per rung; the budget loop
|
|
45
|
-
adapts to the viewer's link, not only to the proxy's CPU.
|
|
46
|
-
|
|
47
|
-
## Impact
|
|
48
|
-
|
|
49
|
-
- `services/encode/hwaccel.js` — nominal-rate table + caps in the software
|
|
50
|
-
descriptor's video args.
|
|
51
|
-
- `services/hls-session-manager.js` — accept/store net reports per session;
|
|
52
|
-
link trigger in the budget check; log line.
|
|
53
|
-
- `routes/api/transcode-sessions/net-report/post.js` (new) + `server.js`
|
|
54
|
-
wiring — report intake.
|
|
55
|
-
- Proxy release + ha-addon bump. The server-side reporter is a separate
|
|
56
|
-
change (`server/viewer-net-report`); release proxy+addon FIRST.
|
|
1
|
+
# Proposal: Adaptive bitrate for thin viewer links (proxy side)
|
|
2
|
+
|
|
3
|
+
## Why
|
|
4
|
+
|
|
5
|
+
Field evidence (iPhone on cellular, 2026-07-10, session `14cc1017`): encode
|
|
6
|
+
bitrate is unbounded — transcoded segments reached 9 MB per 4 s (~18 Mbit/s)
|
|
7
|
+
against a measured 1–5.8 Mbit/s cellular link. Result: 45 s prebuffer, buffer
|
|
8
|
+
draining during playback (`bottleneck delta=-7.1s`), "было так себе". The
|
|
9
|
+
realtime budget protects the PROXY's CPU but nothing protects the VIEWER's
|
|
10
|
+
link: quality never adapts to how fast the viewer can actually download.
|
|
11
|
+
|
|
12
|
+
## What Changes
|
|
13
|
+
|
|
14
|
+
Two parts, one release:
|
|
15
|
+
|
|
16
|
+
- **(a) Bitrate caps (constrained CRF).** Software video encodes gain
|
|
17
|
+
`-maxrate`/`-bufsize` sized per resolution rung from a nominal-rate table
|
|
18
|
+
(H.264 ladder: 1080p→5000K, 720p→2800K, 480p→1400K, 360p→800K, 240p→400K;
|
|
19
|
+
nearest rung by encode height). Multipliers from webtor's production
|
|
20
|
+
ladder: `maxrate = 1.3×` nominal, `bufsize = 1.5×` nominal. CRF/preset
|
|
21
|
+
selection stays — the caps only bound the peaks that killed the cellular
|
|
22
|
+
session. Applies to the software (libx264) path; hardware encoders keep
|
|
23
|
+
their current args (follow-up — their rate-control flags differ and any
|
|
24
|
+
change must pass the strict startup test on real hardware).
|
|
25
|
+
- **(b) Viewer-link downshift trigger.** A new data-channel route lets the
|
|
26
|
+
browser report its measured link state (`linkMbps` — rolling median of
|
|
27
|
+
per-segment transfer throughput; `bufferedAheadSec`) every ~10 s. The
|
|
28
|
+
existing realtime-budget loop gains a SECOND downshift trigger: when
|
|
29
|
+
reports are fresh, `manualQuality` is not set, the viewer's link is
|
|
30
|
+
sustainedly slower than the produced stream (`linkMbps × 0.8 <` observed
|
|
31
|
+
segment bitrate for ≥ 15 s) AND the viewer's buffer is low (< 10 s), step
|
|
32
|
+
one rung down via the existing `#applyBudgetDownshift` (same cooldown,
|
|
33
|
+
step cap, no upswitch v1). Distinct log reason (`reason=link`) so field
|
|
34
|
+
logs distinguish CPU-bound from link-bound downshifts.
|
|
35
|
+
|
|
36
|
+
Missing/stale reports change nothing (old clients keep working — the trigger
|
|
37
|
+
simply never fires). Manual quality pins win: when `manualQuality` is set the
|
|
38
|
+
trigger is skipped.
|
|
39
|
+
|
|
40
|
+
## Capabilities
|
|
41
|
+
|
|
42
|
+
### Modified Capabilities
|
|
43
|
+
|
|
44
|
+
- `transcode-quality`: encodes are bitrate-capped per rung; the budget loop
|
|
45
|
+
adapts to the viewer's link, not only to the proxy's CPU.
|
|
46
|
+
|
|
47
|
+
## Impact
|
|
48
|
+
|
|
49
|
+
- `services/encode/hwaccel.js` — nominal-rate table + caps in the software
|
|
50
|
+
descriptor's video args.
|
|
51
|
+
- `services/hls-session-manager.js` — accept/store net reports per session;
|
|
52
|
+
link trigger in the budget check; log line.
|
|
53
|
+
- `routes/api/transcode-sessions/net-report/post.js` (new) + `server.js`
|
|
54
|
+
wiring — report intake.
|
|
55
|
+
- Proxy release + ha-addon bump. The server-side reporter is a separate
|
|
56
|
+
change (`server/viewer-net-report`); release proxy+addon FIRST.
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# adaptive-bitrate — delta spec (proxy)
|
|
2
|
-
|
|
3
|
-
## ADDED Requirements
|
|
4
|
-
|
|
5
|
-
### Requirement: Software encodes are bitrate-capped per resolution rung
|
|
6
|
-
|
|
7
|
-
Software video encodes SHALL carry `-maxrate`/`-bufsize` derived from a
|
|
8
|
-
per-rung nominal-rate table (1.3× / 1.5× of the rung's nominal), keeping the
|
|
9
|
-
existing CRF/preset quality selection (constrained CRF). The cap follows the
|
|
10
|
-
ACTUAL encode height after budget or manual selection.
|
|
11
|
-
|
|
12
|
-
#### Scenario: Complex scene on a capped encode
|
|
13
|
-
- **WHEN** a transcoded scene would spike far above the rung's nominal rate
|
|
14
|
-
- **THEN** the produced segments stay bounded by the cap instead of reaching
|
|
15
|
-
multi-megabyte sizes that a thin viewer link cannot download in time
|
|
16
|
-
|
|
17
|
-
### Requirement: The proxy accepts viewer link reports
|
|
18
|
-
|
|
19
|
-
A data-channel route SHALL accept periodic reports
|
|
20
|
-
`{ linkMbps, bufferedAheadSec }` for an active transcode session and store
|
|
21
|
-
the latest report with its arrival time. Invalid bodies are rejected;
|
|
22
|
-
unknown sessions get 404; missing reports are not an error condition.
|
|
23
|
-
|
|
24
|
-
#### Scenario: Old client
|
|
25
|
-
- **WHEN** a browser never sends net reports
|
|
26
|
-
- **THEN** the session behaves exactly as before this change (plus caps)
|
|
27
|
-
|
|
28
|
-
### Requirement: The budget loop downshifts on a sustained link deficit
|
|
29
|
-
|
|
30
|
-
When a fresh report shows the viewer's usable link (reported × safety
|
|
31
|
-
margin) sustainedly below the observed produced bitrate AND the viewer's
|
|
32
|
-
buffer is low, the existing budget downshift SHALL step the encode one rung
|
|
33
|
-
down (same cooldown, step cap and floor as the CPU trigger; no upswitch).
|
|
34
|
-
The trigger SHALL be skipped when `manualQuality` is set, when reports are
|
|
35
|
-
stale, or when the viewer's buffer is comfortable. The downshift log line
|
|
36
|
-
SHALL name the reason (`link`) distinctly from the CPU reason.
|
|
37
|
-
|
|
38
|
-
#### Scenario: Cellular viewer, stream too fat
|
|
39
|
-
- **WHEN** reports show 3 Mbit/s usable link against 6 Mbit/s produced
|
|
40
|
-
bitrate for longer than the slow window, with a draining buffer
|
|
41
|
-
- **THEN** the encode steps down one rung and the log shows a link-reason
|
|
42
|
-
downshift
|
|
43
|
-
|
|
44
|
-
#### Scenario: Slow link but full buffer
|
|
45
|
-
- **WHEN** the link is slower than the stream but the viewer's buffer stays
|
|
46
|
-
comfortable (e.g. paused playback filling ahead)
|
|
47
|
-
- **THEN** no downshift happens
|
|
48
|
-
|
|
49
|
-
#### Scenario: Manual quality pinned
|
|
50
|
-
- **WHEN** the viewer picked a forced quality
|
|
51
|
-
- **THEN** link reports never trigger a downshift
|
|
1
|
+
# adaptive-bitrate — delta spec (proxy)
|
|
2
|
+
|
|
3
|
+
## ADDED Requirements
|
|
4
|
+
|
|
5
|
+
### Requirement: Software encodes are bitrate-capped per resolution rung
|
|
6
|
+
|
|
7
|
+
Software video encodes SHALL carry `-maxrate`/`-bufsize` derived from a
|
|
8
|
+
per-rung nominal-rate table (1.3× / 1.5× of the rung's nominal), keeping the
|
|
9
|
+
existing CRF/preset quality selection (constrained CRF). The cap follows the
|
|
10
|
+
ACTUAL encode height after budget or manual selection.
|
|
11
|
+
|
|
12
|
+
#### Scenario: Complex scene on a capped encode
|
|
13
|
+
- **WHEN** a transcoded scene would spike far above the rung's nominal rate
|
|
14
|
+
- **THEN** the produced segments stay bounded by the cap instead of reaching
|
|
15
|
+
multi-megabyte sizes that a thin viewer link cannot download in time
|
|
16
|
+
|
|
17
|
+
### Requirement: The proxy accepts viewer link reports
|
|
18
|
+
|
|
19
|
+
A data-channel route SHALL accept periodic reports
|
|
20
|
+
`{ linkMbps, bufferedAheadSec }` for an active transcode session and store
|
|
21
|
+
the latest report with its arrival time. Invalid bodies are rejected;
|
|
22
|
+
unknown sessions get 404; missing reports are not an error condition.
|
|
23
|
+
|
|
24
|
+
#### Scenario: Old client
|
|
25
|
+
- **WHEN** a browser never sends net reports
|
|
26
|
+
- **THEN** the session behaves exactly as before this change (plus caps)
|
|
27
|
+
|
|
28
|
+
### Requirement: The budget loop downshifts on a sustained link deficit
|
|
29
|
+
|
|
30
|
+
When a fresh report shows the viewer's usable link (reported × safety
|
|
31
|
+
margin) sustainedly below the observed produced bitrate AND the viewer's
|
|
32
|
+
buffer is low, the existing budget downshift SHALL step the encode one rung
|
|
33
|
+
down (same cooldown, step cap and floor as the CPU trigger; no upswitch).
|
|
34
|
+
The trigger SHALL be skipped when `manualQuality` is set, when reports are
|
|
35
|
+
stale, or when the viewer's buffer is comfortable. The downshift log line
|
|
36
|
+
SHALL name the reason (`link`) distinctly from the CPU reason.
|
|
37
|
+
|
|
38
|
+
#### Scenario: Cellular viewer, stream too fat
|
|
39
|
+
- **WHEN** reports show 3 Mbit/s usable link against 6 Mbit/s produced
|
|
40
|
+
bitrate for longer than the slow window, with a draining buffer
|
|
41
|
+
- **THEN** the encode steps down one rung and the log shows a link-reason
|
|
42
|
+
downshift
|
|
43
|
+
|
|
44
|
+
#### Scenario: Slow link but full buffer
|
|
45
|
+
- **WHEN** the link is slower than the stream but the viewer's buffer stays
|
|
46
|
+
comfortable (e.g. paused playback filling ahead)
|
|
47
|
+
- **THEN** no downshift happens
|
|
48
|
+
|
|
49
|
+
#### Scenario: Manual quality pinned
|
|
50
|
+
- **WHEN** the viewer picked a forced quality
|
|
51
|
+
- **THEN** link reports never trigger a downshift
|
|
@@ -1,40 +1,40 @@
|
|
|
1
|
-
# Tasks: Adaptive bitrate (proxy)
|
|
2
|
-
|
|
3
|
-
## 1. Caps
|
|
4
|
-
|
|
5
|
-
- [x] 1.1 `encode/hwaccel.js`: `RUNG_NOMINAL_KBPS` table + nearest-rung lookup;
|
|
6
|
-
software descriptor's video args emit `-maxrate`/`-bufsize`
|
|
7
|
-
(1.3× / 1.5× nominal for the actual encode height). Hardware
|
|
8
|
-
descriptors untouched.
|
|
9
|
-
|
|
10
|
-
## 2. Net report intake
|
|
11
|
-
|
|
12
|
-
- [x] 2.1 `routes/api/transcode-sessions/net-report/post.js`: validate
|
|
13
|
-
`{ linkMbps, bufferedAheadSec }`, store
|
|
14
|
-
`session.netReport = { linkMbps, bufferedAheadSec, at }`, 204/400/404.
|
|
15
|
-
- [x] 2.2 Wire in `server.js`; verify the data-channel path allowlist covers
|
|
16
|
-
the route.
|
|
17
|
-
|
|
18
|
-
## 3. Budget trigger
|
|
19
|
-
|
|
20
|
-
- [x] 3.1 Constants `LINK_REPORT_FRESH_MS`, `LINK_SAFETY`,
|
|
21
|
-
`LINK_SLOW_WINDOW_MS`, `LINK_LOW_BUFFER_SEC`.
|
|
22
|
-
- [x] 3.2 Observed produced bitrate (rolling, last ~5 segments) available to
|
|
23
|
-
the budget check.
|
|
24
|
-
- [x] 3.3 Link deficit accumulation + `#applyBudgetDownshift(session,
|
|
25
|
-
reason "link")`; skip on manualQuality/stale/comfortable buffer; log
|
|
26
|
-
reason distinctly.
|
|
27
|
-
|
|
28
|
-
## 4. Verification
|
|
29
|
-
|
|
30
|
-
- [x] 4.1 Unit: table lookup, arg assembly, trigger logic (fake clock):
|
|
31
|
-
deficit→downshift, stale report→no-op, high buffer→no-op,
|
|
32
|
-
manualQuality→no-op.
|
|
33
|
-
- [x] 4.2 `node --check` on touched files.
|
|
34
|
-
|
|
35
|
-
## 5. Release
|
|
36
|
-
|
|
37
|
-
- [ ] 5.1 CHANGELOG (next patch) + `npm run patch` (user OTP), then addon
|
|
38
|
-
bump + push + HA update. Release BEFORE the server reporter change.
|
|
39
|
-
- [ ] 5.2 Field: cellular Poirot/Mavka run shows `budget downshift (link)`
|
|
40
|
-
and bounded segment sizes; correlate via client-log pipeline.
|
|
1
|
+
# Tasks: Adaptive bitrate (proxy)
|
|
2
|
+
|
|
3
|
+
## 1. Caps
|
|
4
|
+
|
|
5
|
+
- [x] 1.1 `encode/hwaccel.js`: `RUNG_NOMINAL_KBPS` table + nearest-rung lookup;
|
|
6
|
+
software descriptor's video args emit `-maxrate`/`-bufsize`
|
|
7
|
+
(1.3× / 1.5× nominal for the actual encode height). Hardware
|
|
8
|
+
descriptors untouched.
|
|
9
|
+
|
|
10
|
+
## 2. Net report intake
|
|
11
|
+
|
|
12
|
+
- [x] 2.1 `routes/api/transcode-sessions/net-report/post.js`: validate
|
|
13
|
+
`{ linkMbps, bufferedAheadSec }`, store
|
|
14
|
+
`session.netReport = { linkMbps, bufferedAheadSec, at }`, 204/400/404.
|
|
15
|
+
- [x] 2.2 Wire in `server.js`; verify the data-channel path allowlist covers
|
|
16
|
+
the route.
|
|
17
|
+
|
|
18
|
+
## 3. Budget trigger
|
|
19
|
+
|
|
20
|
+
- [x] 3.1 Constants `LINK_REPORT_FRESH_MS`, `LINK_SAFETY`,
|
|
21
|
+
`LINK_SLOW_WINDOW_MS`, `LINK_LOW_BUFFER_SEC`.
|
|
22
|
+
- [x] 3.2 Observed produced bitrate (rolling, last ~5 segments) available to
|
|
23
|
+
the budget check.
|
|
24
|
+
- [x] 3.3 Link deficit accumulation + `#applyBudgetDownshift(session,
|
|
25
|
+
reason "link")`; skip on manualQuality/stale/comfortable buffer; log
|
|
26
|
+
reason distinctly.
|
|
27
|
+
|
|
28
|
+
## 4. Verification
|
|
29
|
+
|
|
30
|
+
- [x] 4.1 Unit: table lookup, arg assembly, trigger logic (fake clock):
|
|
31
|
+
deficit→downshift, stale report→no-op, high buffer→no-op,
|
|
32
|
+
manualQuality→no-op.
|
|
33
|
+
- [x] 4.2 `node --check` on touched files.
|
|
34
|
+
|
|
35
|
+
## 5. Release
|
|
36
|
+
|
|
37
|
+
- [ ] 5.1 CHANGELOG (next patch) + `npm run patch` (user OTP), then addon
|
|
38
|
+
bump + push + HA update. Release BEFORE the server reporter change.
|
|
39
|
+
- [ ] 5.2 Field: cellular Poirot/Mavka run shows `budget downshift (link)`
|
|
40
|
+
and bounded segment sizes; correlate via client-log pipeline.
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
schema: spec-driven
|
|
2
|
-
created: 2026-07-06
|
|
1
|
+
schema: spec-driven
|
|
2
|
+
created: 2026-07-06
|
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
# Proposal: Proxy as a single binary + service registration (research, queued)
|
|
2
|
-
|
|
3
|
-
## Why
|
|
4
|
-
|
|
5
|
-
Bare-npm installation assumes Node.js on the host — a real barrier for the
|
|
6
|
-
non-technical proxy owners the pool model targets. Node's Single Executable
|
|
7
|
-
Applications (SEA, stable-ish since Node 20/21) allow shipping the proxy as
|
|
8
|
-
one self-contained binary per platform (win/linux/macOS, x64/arm64): download,
|
|
9
|
-
run, done. A binary can also offer — with the user's explicit consent — to
|
|
10
|
-
register itself as an auto-starting service, closing the "survives reboot"
|
|
11
|
-
gap that the HA addon solves today.
|
|
12
|
-
|
|
13
|
-
## What Changes (research scope first)
|
|
14
|
-
|
|
15
|
-
- **SEA build pipeline**: `node --experimental-sea-config` + postject-injected
|
|
16
|
-
blob, one artifact per platform/arch, published as GitHub release assets
|
|
17
|
-
alongside the npm package.
|
|
18
|
-
- **Known hard parts to resolve in research**:
|
|
19
|
-
- Native addons (`node-datachannel`, `utp-native`) cannot live inside the
|
|
20
|
-
SEA blob — they must ship next to the binary or self-extract on first
|
|
21
|
-
run to a data dir.
|
|
22
|
-
- `ffmpeg-static`'s binary likewise ships alongside (or the system ffmpeg
|
|
23
|
-
is required, as the HA addon already does with `--ffmpeg-bin`).
|
|
24
|
-
- **Service registration (opt-in, explicit user action)**:
|
|
25
|
-
- Linux: `proxy install-service` writes a systemd unit and runs
|
|
26
|
-
`systemctl enable --now` (requires sudo — the consent step).
|
|
27
|
-
- Windows: register via `sc create` / a service wrapper (admin prompt =
|
|
28
|
-
consent).
|
|
29
|
-
- macOS: launchd plist in `~/Library/LaunchAgents` (user-level, no admin).
|
|
30
|
-
- Uninstall counterpart mandatory (`proxy uninstall-service`).
|
|
31
|
-
- Stays deployment-agnostic: the binary is a fourth distribution channel
|
|
32
|
-
next to HA addon, bare npm and Docker; no code paths may assume it.
|
|
33
|
-
|
|
34
|
-
## Capabilities
|
|
35
|
-
|
|
36
|
-
### New Capabilities
|
|
37
|
-
|
|
38
|
-
- `distribution`: how the proxy is packaged and installed on bare hosts.
|
|
39
|
-
|
|
40
|
-
### Modified Capabilities
|
|
41
|
-
|
|
42
|
-
<!-- none -->
|
|
43
|
-
|
|
44
|
-
## Impact
|
|
45
|
-
|
|
46
|
-
- Build/release tooling in this repo; a `service` CLI subcommand.
|
|
47
|
-
- No changes to runtime behaviour for existing channels.
|
|
48
|
-
|
|
49
|
-
## Priority
|
|
50
|
-
|
|
51
|
-
MINIMAL — explicitly NOT part of the POC (owner decision, 2026-07-07).
|
|
52
|
-
Research for the eventual "pool of non-technical owners" product goal; do
|
|
53
|
-
not pick up while any POC work remains.
|
|
1
|
+
# Proposal: Proxy as a single binary + service registration (research, queued)
|
|
2
|
+
|
|
3
|
+
## Why
|
|
4
|
+
|
|
5
|
+
Bare-npm installation assumes Node.js on the host — a real barrier for the
|
|
6
|
+
non-technical proxy owners the pool model targets. Node's Single Executable
|
|
7
|
+
Applications (SEA, stable-ish since Node 20/21) allow shipping the proxy as
|
|
8
|
+
one self-contained binary per platform (win/linux/macOS, x64/arm64): download,
|
|
9
|
+
run, done. A binary can also offer — with the user's explicit consent — to
|
|
10
|
+
register itself as an auto-starting service, closing the "survives reboot"
|
|
11
|
+
gap that the HA addon solves today.
|
|
12
|
+
|
|
13
|
+
## What Changes (research scope first)
|
|
14
|
+
|
|
15
|
+
- **SEA build pipeline**: `node --experimental-sea-config` + postject-injected
|
|
16
|
+
blob, one artifact per platform/arch, published as GitHub release assets
|
|
17
|
+
alongside the npm package.
|
|
18
|
+
- **Known hard parts to resolve in research**:
|
|
19
|
+
- Native addons (`node-datachannel`, `utp-native`) cannot live inside the
|
|
20
|
+
SEA blob — they must ship next to the binary or self-extract on first
|
|
21
|
+
run to a data dir.
|
|
22
|
+
- `ffmpeg-static`'s binary likewise ships alongside (or the system ffmpeg
|
|
23
|
+
is required, as the HA addon already does with `--ffmpeg-bin`).
|
|
24
|
+
- **Service registration (opt-in, explicit user action)**:
|
|
25
|
+
- Linux: `proxy install-service` writes a systemd unit and runs
|
|
26
|
+
`systemctl enable --now` (requires sudo — the consent step).
|
|
27
|
+
- Windows: register via `sc create` / a service wrapper (admin prompt =
|
|
28
|
+
consent).
|
|
29
|
+
- macOS: launchd plist in `~/Library/LaunchAgents` (user-level, no admin).
|
|
30
|
+
- Uninstall counterpart mandatory (`proxy uninstall-service`).
|
|
31
|
+
- Stays deployment-agnostic: the binary is a fourth distribution channel
|
|
32
|
+
next to HA addon, bare npm and Docker; no code paths may assume it.
|
|
33
|
+
|
|
34
|
+
## Capabilities
|
|
35
|
+
|
|
36
|
+
### New Capabilities
|
|
37
|
+
|
|
38
|
+
- `distribution`: how the proxy is packaged and installed on bare hosts.
|
|
39
|
+
|
|
40
|
+
### Modified Capabilities
|
|
41
|
+
|
|
42
|
+
<!-- none -->
|
|
43
|
+
|
|
44
|
+
## Impact
|
|
45
|
+
|
|
46
|
+
- Build/release tooling in this repo; a `service` CLI subcommand.
|
|
47
|
+
- No changes to runtime behaviour for existing channels.
|
|
48
|
+
|
|
49
|
+
## Priority
|
|
50
|
+
|
|
51
|
+
MINIMAL — explicitly NOT part of the POC (owner decision, 2026-07-07).
|
|
52
|
+
Research for the eventual "pool of non-technical owners" product goal; do
|
|
53
|
+
not pick up while any POC work remains.
|