major remote desktop improvements

This commit is contained in:
KingKDot
2026-07-30 00:22:08 -05:00
parent a68172538d
commit 095a119bf4
35 changed files with 984 additions and 120 deletions
+5
View File
@@ -42,6 +42,11 @@
# OVERLORD_TLS_OFFLOAD=true
# OVERLORD_HEALTHCHECK_URL=http://127.0.0.1:5173/health
# WebRTC TURN relay ports. Docker Desktop on Windows defaults to 40000-40040
# because Windows commonly reserves ports in the 49152+ dynamic range.
# OVERLORD_TURN_MIN_PORT=40000
# OVERLORD_TURN_MAX_PORT=40040
# ============================================
# ADVANCED: Custom JWT secret
# ============================================
@@ -46,7 +46,8 @@ func (b *amfD3D11TextureBackend) Encode(req h264D3D11TextureRequest) ([]byte, er
b.device, b.inputWidth, b.inputHeight = req.Device, req.InputWidth, req.InputHeight
b.encodeWidth, b.encodeHeight, b.fps, b.dxgiFormat = req.EncodeWidth, req.EncodeHeight, req.FPS, req.DXGIFormat
}
forceIDR := req.ForceIDR || b.forceIDR.Swap(false)
pendingIDR := b.forceIDR.Swap(false)
forceIDR := req.ForceIDR || pendingIDR
for attempts := 0; attempts < 2; attempts++ {
result, outputSize, err := b.encoder.Encode(req.Texture, forceIDR, b.output)
if err != nil {
+88 -5
View File
@@ -108,19 +108,41 @@ func CaptureAndSend(ctx context.Context, env *rt.Env) error {
time.Sleep(50 * time.Millisecond)
}
codec := desktopCodec()
directCanvasVideo := (codec == "h264" || codec == "hevc") &&
(codec != "h264" || !useDesktopSoftwareH264()) &&
useDesktopDuplication() &&
!(codec == "h264" && webrtcpub.IsActive(webrtcpub.KindDesktop))
directSlotAcquired := false
if directCanvasVideo {
if !AcquireFrameSlot() {
return nil
}
directSlotAcquired = true
}
if frame, captureDur, encodeDur, used, err := tryBuildDirectH264Frame(display); used {
if err != nil {
if directSlotAcquired {
ReleaseFrameSlot()
directSlotAcquired = false
}
suppressDesktopHardwareH264(err)
log.Printf("capture: direct video encode failed: %v; falling back to the software H.264 path", err)
} else {
emitDesktopCursor(ctx, env, display, frame.Header.Width, frame.Header.Height)
if len(frame.Data) == 0 {
if directSlotAcquired {
ReleaseFrameSlot()
}
consecutiveCaptureFails.Store(0)
return nil
}
consecutiveCaptureFails.Store(0)
return sendCompletedFrame(ctx, env, frame, display, t0, captureDur, encodeDur)
return sendCompletedFrame(ctx, env, frame, display, t0, captureDur, encodeDur, directSlotAcquired)
}
} else if directSlotAcquired {
ReleaseFrameSlot()
}
img, err := safeCaptureDisplay(display)
@@ -247,7 +269,7 @@ func CaptureAndSend(ctx context.Context, env *rt.Env) error {
return err
}
func sendCompletedFrame(ctx context.Context, env *rt.Env, frame wire.Frame, display int, t0 time.Time, captureDur, encodeDur time.Duration) error {
func sendCompletedFrame(ctx context.Context, env *rt.Env, frame wire.Frame, display int, t0 time.Time, captureDur, encodeDur time.Duration, slotAcquired bool) error {
now := time.Now()
fps := frameFPS(now)
if fps <= 0 {
@@ -255,6 +277,9 @@ func sendCompletedFrame(ctx context.Context, env *rt.Env, frame wire.Frame, disp
}
frame.Header.FPS = fps
if ctx.Err() != nil {
if slotAcquired {
ReleaseFrameSlot()
}
return nil
}
if frame.Header.Format == "h264" && webrtcpub.IsActive(webrtcpub.KindDesktop) {
@@ -274,11 +299,17 @@ func sendCompletedFrame(ctx context.Context, env *rt.Env, frame wire.Frame, disp
statTotalNs.Add(totalDur.Nanoseconds())
statBytes.Add(int64(len(frame.Data)))
emitDesktopStreamStats(ctx, env, frame, fps, captureDur, encodeDur, sendDur, totalDur, "webrtc")
if slotAcquired {
ReleaseFrameSlot()
}
return nil
}
if !slotAcquired {
if !AcquireFrameSlot() {
return nil
}
slotAcquired = true
}
sendStart := time.Now()
err := wire.WriteMsg(ctx, env.Conn, frame)
sendDur := time.Since(sendStart)
@@ -675,6 +706,8 @@ func SetDesktopSoftwareH264(enabled bool) {
}
desktopHardwareFallbackUntil.Store(0)
resetH264Encoder()
lastKeyframe.Store(0)
webrtcpub.RequestKeyframe(webrtcpub.KindDesktop)
requestFullFrames(2)
log.Printf("capture: desktop software h264 %v", enabled)
}
@@ -796,6 +829,25 @@ const (
backstageChangeThresh = 1
)
var videoKeyframeEvery = configuredVideoKeyframeInterval()
func configuredVideoKeyframeInterval() time.Duration {
raw := strings.TrimSpace(os.Getenv("OVERLORD_VIDEO_KEYFRAME_INTERVAL"))
if raw == "" || strings.EqualFold(raw, "off") || raw == "0" {
return 0
}
if interval, err := time.ParseDuration(raw); err == nil {
if interval > 0 {
return interval
}
return 0
}
if seconds, err := strconv.Atoi(raw); err == nil && seconds > 0 {
return time.Duration(seconds) * time.Second
}
return 0
}
func buildFrame(img *image.RGBA, display int, quality int) (wire.Frame, time.Duration, error) {
encStart := time.Now()
width := img.Bounds().Dx()
@@ -808,15 +860,22 @@ func buildFrame(img *image.RGBA, display int, quality int) (wire.Frame, time.Dur
log.Printf("capture: hevc skipped for odd dimensions (%dx%d), falling back to h264/jpeg", width, height)
codec = "h264"
} else {
if webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop) {
requestedKeyframe := webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop)
if requestedKeyframe || lastKeyframe.Load() == 0 ||
(videoKeyframeEvery > 0 && now.Sub(time.Unix(0, lastKeyframe.Load())) >= videoKeyframeEvery) {
resetHEVCEncoder()
}
hevcBytes, err := encodeHEVCFrame(img)
if err == nil && len(hevcBytes) > 0 {
if retainKeyframeRequestUntilOutput(webrtcpub.KindDesktop, requestedKeyframe, "hevc", hevcBytes) {
lastKeyframe.Store(now.UnixNano())
}
statFullFrames.Add(1)
return wire.Frame{Type: "frame", Header: wire.FrameHeader{Monitor: display, FPS: 0, Format: "hevc"}, Data: hevcBytes}, time.Since(encStart), nil
}
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.KindDesktop)
}
hevcWarnOnce.Do(func() {
log.Printf("capture: hevc encode unavailable, falling back to h264/jpeg: %v (%s)", err, hevcAvailabilityDetail())
})
@@ -836,15 +895,22 @@ func buildFrame(img *image.RGBA, display int, quality int) (wire.Frame, time.Dur
log.Printf("capture: h264 skipped for odd dimensions (%dx%d), falling back to jpeg", width, height)
codec = "jpeg"
} else {
if webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop) {
requestedKeyframe := webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop)
if requestedKeyframe || lastKeyframe.Load() == 0 ||
(videoKeyframeEvery > 0 && now.Sub(time.Unix(0, lastKeyframe.Load())) >= videoKeyframeEvery) {
resetH264Encoder()
}
h264Bytes, err := encodeH264Frame(img)
if err == nil && len(h264Bytes) > 0 {
if retainKeyframeRequestUntilOutput(webrtcpub.KindDesktop, requestedKeyframe, "h264", h264Bytes) {
lastKeyframe.Store(now.UnixNano())
}
statFullFrames.Add(1)
return wire.Frame{Type: "frame", Header: wire.FrameHeader{Monitor: display, FPS: 0, Format: "h264"}, Data: h264Bytes}, time.Since(encStart), nil
}
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.KindDesktop)
}
h264WarnOnce.Do(func() {
detail := h264AvailabilityDetail()
if detail != "" {
@@ -941,16 +1007,23 @@ func buildFramebackstage(img *image.RGBA, display int, quality int) (wire.Frame,
log.Printf("backstage capture: h264 skipped for odd dimensions (%dx%d), falling back to jpeg", width, height)
codec = "jpeg"
} else {
if webrtcpub.ConsumeKeyframeRequest(webrtcpub.Kindbackstage) {
requestedKeyframe := webrtcpub.ConsumeKeyframeRequest(webrtcpub.Kindbackstage)
if requestedKeyframe || backstageLastKeyframe.Load() == 0 ||
(videoKeyframeEvery > 0 && now.Sub(time.Unix(0, backstageLastKeyframe.Load())) >= videoKeyframeEvery) {
resetH264Encoderbackstage()
}
h264Bytes, err := encodeH264Framebackstage(img)
if err == nil && len(h264Bytes) > 0 {
if retainKeyframeRequestUntilOutput(webrtcpub.Kindbackstage, requestedKeyframe, "h264", h264Bytes) {
backstageLastKeyframe.Store(now.UnixNano())
}
statFullFrames.Add(1)
frame := wire.Frame{Type: "frame", Header: wire.FrameHeader{Monitor: display, FPS: 0, Format: "h264", Backstage: true}, Data: h264Bytes}
return frame, time.Since(encStart), nil
}
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.Kindbackstage)
}
backstageH264WarnOnce.Do(func() {
detail := h264AvailabilityDetail()
if detail != "" {
@@ -1671,6 +1744,7 @@ func backstageCodec() string {
}
func SetDesktopQualityAndCodec(quality int, codec string) {
previousCodec := desktopCodec()
if quality > 0 {
if quality > 100 {
quality = 100
@@ -1706,6 +1780,10 @@ func SetDesktopQualityAndCodec(quality int, codec string) {
if s != "hevc" {
resetHEVCEncoder()
}
if previousCodec != s && (s == "h264" || s == "hevc") {
lastKeyframe.Store(0)
webrtcpub.RequestKeyframe(webrtcpub.KindDesktop)
}
case "":
default:
desktopOverrideCodec.Store("jpeg")
@@ -1715,6 +1793,7 @@ func SetDesktopQualityAndCodec(quality int, codec string) {
}
func SetBackstageQualityAndCodec(quality int, codec string) {
previousCodec := backstageCodec()
if quality > 0 {
if quality > 100 {
quality = 100
@@ -1734,6 +1813,10 @@ func SetBackstageQualityAndCodec(quality int, codec string) {
if s != "h264" {
resetH264Encoderbackstage()
}
if previousCodec != s && s == "h264" {
backstageLastKeyframe.Store(0)
webrtcpub.RequestKeyframe(webrtcpub.Kindbackstage)
}
case "":
default:
backstageOverrideCodec.Store("jpeg")
@@ -456,16 +456,16 @@ func TestSetFrameFlowTargetFPSScalesHighFPS(t *testing.T) {
t.Setenv("OVERLORD_DESKTOP_IN_FLIGHT_FRAMES", "")
ResetFrameSlots()
SetFrameFlowTargetFPS(60)
if got := activeFrameSlotLimit(); got != 2 {
t.Fatalf("expected 60 fps slot limit 2, got %d", got)
if got := activeFrameSlotLimit(); got != 4 {
t.Fatalf("expected 60 fps slot limit 4, got %d", got)
}
SetFrameFlowTargetFPS(120)
if got := activeFrameSlotLimit(); got != 4 {
t.Fatalf("expected 120 fps slot limit 4, got %d", got)
if got := activeFrameSlotLimit(); got != 8 {
t.Fatalf("expected 120 fps slot limit 8, got %d", got)
}
SetFrameFlowTargetFPS(240)
if got := activeFrameSlotLimit(); got != 8 {
t.Fatalf("expected 240 fps slot limit 8, got %d", got)
if got := activeFrameSlotLimit(); got != 12 {
t.Fatalf("expected 240 fps slot limit 12, got %d", got)
}
}
@@ -123,6 +123,9 @@ func probeDesktopEncoderCapabilities(display int, bounds image.Rectangle) Deskto
for _, probe := range probes {
maxFPS := 0
for _, fps := range fpsOptions {
if fps > desktopProfileFPSCeiling(size.height) {
continue
}
req := h264D3D11TextureRequest{
Device: unsafe.Pointer(device), Texture: unsafe.Pointer(texture),
InputWidth: nativeWidth, InputHeight: nativeHeight,
@@ -140,7 +143,7 @@ func probeDesktopEncoderCapabilities(display int, bounds image.Rectangle) Deskto
continue
}
for _, fps := range fpsOptions {
if fps <= maxFPS {
if fps <= maxFPS && fps <= desktopProfileFPSCeiling(size.height) {
key := desktopProfileKey(size.width, size.height, fps)
providersByProfile[key] = appendUniqueString(providersByProfile[key], probe.name)
}
@@ -254,6 +257,20 @@ func safeDesktopProfiles(nativeWidth, nativeHeight int) []DesktopEncoderProfile
return profiles
}
// The probe repeatedly encodes an unchanged synthetic texture and excludes
// capture, conversion, transport, and browser decode. Bound its advertised
// result to practical end-to-end desktop profiles.
func desktopProfileFPSCeiling(height int) int {
switch {
case height <= 1080:
return 240
case height <= 1440:
return 120
default:
return 60
}
}
func desktopProfileKey(width, height, fps int) string {
return fmt.Sprintf("%dx%d@%d", width, height, fps)
}
@@ -0,0 +1,21 @@
package capture
import "testing"
func TestDesktopProfileFPSCeiling(t *testing.T) {
tests := []struct {
height int
want int
}{
{height: 720, want: 240},
{height: 1080, want: 240},
{height: 1440, want: 120},
{height: 2160, want: 60},
{height: 4320, want: 60},
}
for _, test := range tests {
if got := desktopProfileFPSCeiling(test.height); got != test.want {
t.Fatalf("height %d: expected ceiling %d, got %d", test.height, test.want, got)
}
}
}
@@ -57,8 +57,10 @@ func SetFrameFlowTargetFPS(fps int) {
limit := defaultMaxInFlightFrames
switch {
case fps >= 180:
limit = 8
limit = 12
case fps >= 120:
limit = 8
case fps >= 60:
limit = 4
}
if env := strings.TrimSpace(os.Getenv("OVERLORD_DESKTOP_IN_FLIGHT_FRAMES")); env != "" {
@@ -9,6 +9,9 @@ import (
"strings"
"sync"
"testing"
"time"
"overlord-client/cmd/agent/webrtcpub"
)
func resetCodecSelectionForTest() {
@@ -18,6 +21,8 @@ func resetCodecSelectionForTest() {
backstageOverrideCodec.Store("")
desktopOverrideQuality.Store(0)
backstageOverrideQuality.Store(0)
_ = webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop)
_ = webrtcpub.ConsumeKeyframeRequest(webrtcpub.Kindbackstage)
}
func TestSetQualityAndCodec_H264FallbackDependsOnAvailability(t *testing.T) {
@@ -72,6 +77,27 @@ func TestDesktopAndBackstageCodecSelectionsAreIndependent(t *testing.T) {
}
}
func TestSwitchingToH264RequestsRecoveryPoint(t *testing.T) {
if !h264Available() {
t.Skip("h264 is unavailable in this build")
}
t.Cleanup(resetCodecSelectionForTest)
resetCodecSelectionForTest()
SetDesktopQualityAndCodec(80, "jpeg")
_ = webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop)
lastKeyframe.Store(time.Now().UnixNano())
SetDesktopQualityAndCodec(80, "h264")
if lastKeyframe.Load() != 0 {
t.Fatal("codec transition did not invalidate the previous keyframe timestamp")
}
if !webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop) {
t.Fatal("codec transition did not request an H.264 recovery point")
}
}
func TestDesktopHardwareFailureDoesNotChangeBackstageCodec(t *testing.T) {
t.Cleanup(func() {
desktopHardwareFallbackUntil.Store(0)
@@ -13,7 +13,7 @@ func directVideoKeyframeDue(requested bool, nowNs, lastKeyframeNs int64) bool {
if requested || lastKeyframeNs == 0 {
return true
}
return keyframeEvery > 0 && time.Duration(nowNs-lastKeyframeNs) >= keyframeEvery
return videoKeyframeEvery > 0 && time.Duration(nowNs-lastKeyframeNs) >= videoKeyframeEvery
}
func tryBuildDirectH264Frame(display int) (wire.Frame, time.Duration, time.Duration, bool, error) {
@@ -22,8 +22,9 @@ func tryBuildDirectH264Frame(display int) (wire.Frame, time.Duration, time.Durat
return wire.Frame{}, 0, 0, false, nil
}
now := time.Now()
requestedKeyframe := webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop)
forceKeyframe := directVideoKeyframeDue(
webrtcpub.ConsumeKeyframeRequest(webrtcpub.KindDesktop),
requestedKeyframe,
now.UnixNano(),
lastKeyframe.Load(),
)
@@ -38,12 +39,18 @@ func tryBuildDirectH264Frame(display int) (wire.Frame, time.Duration, time.Durat
data, width, height, captureDur, encodeDur, used, err = captureDisplayDXGIH264(display, forceKeyframe)
}
if !used || err != nil {
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.KindDesktop)
}
return wire.Frame{}, captureDur, encodeDur, used, err
}
if len(data) == 0 {
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.KindDesktop)
}
return wire.Frame{}, captureDur, encodeDur, true, nil
}
if forceKeyframe {
if retainKeyframeRequestUntilOutput(webrtcpub.KindDesktop, requestedKeyframe, codec, data) {
lastKeyframe.Store(now.UnixNano())
}
statFullFrames.Add(1)
@@ -122,9 +122,14 @@ static void nvenc_configure_h264_stream(NV_ENC_CONFIG *cfg, int fps) {
(void)fps;
cfg->gopLength = NVENC_INFINITE_GOPLENGTH;
cfg->frameIntervalP = 1;
// The low-latency presets otherwise constrain an IDR to roughly the same
// bit budget as a P-frame. That makes recovery frames visibly pulse or
// smear under motion. Allow IDRs a larger transient budget while keeping
// the normal one-frame VBV/CBR latency behavior.
cfg->rcParams.lowDelayKeyFrameScale = 4;
cfg->encodeCodecConfig.h264Config.idrPeriod = NVENC_INFINITE_GOPLENGTH;
cfg->encodeCodecConfig.h264Config.repeatSPSPPS = 1;
cfg->encodeCodecConfig.h264Config.level = NV_ENC_LEVEL_H264_52;
cfg->encodeCodecConfig.h264Config.level = NV_ENC_LEVEL_AUTOSELECT;
cfg->encodeCodecConfig.h264Config.h264VUIParameters.videoSignalTypePresentFlag = 1;
cfg->encodeCodecConfig.h264Config.h264VUIParameters.videoFormat = NV_ENC_VUI_VIDEO_FORMAT_UNSPECIFIED;
cfg->encodeCodecConfig.h264Config.h264VUIParameters.videoFullRangeFlag = 0;
@@ -393,7 +398,7 @@ static nvenc_d3d11_texture_create_result nvenc_create_d3d11_texture_encoder(ID3D
nvenc_release_texture_encoder(enc);
return out;
}
preset.presetCfg.profileGUID = codec == 1 ? NV_ENC_HEVC_PROFILE_MAIN_GUID : NV_ENC_H264_PROFILE_HIGH_GUID;
preset.presetCfg.profileGUID = codec == 1 ? NV_ENC_HEVC_PROFILE_MAIN_GUID : NV_ENC_H264_PROFILE_MAIN_GUID;
preset.presetCfg.rcParams.rateControlMode = NV_ENC_PARAMS_RC_CBR;
preset.presetCfg.rcParams.averageBitRate = (uint32_t)bitrate;
preset.presetCfg.rcParams.maxBitRate = (uint32_t)bitrate;
@@ -703,7 +708,7 @@ static nvenc_d3d11_create_result nvenc_create_d3d11_encoder(int width, int heigh
nvenc_release_encoder(enc);
return out;
}
preset.presetCfg.profileGUID = codec == 1 ? NV_ENC_HEVC_PROFILE_MAIN_GUID : NV_ENC_H264_PROFILE_HIGH_GUID;
preset.presetCfg.profileGUID = codec == 1 ? NV_ENC_HEVC_PROFILE_MAIN_GUID : NV_ENC_H264_PROFILE_MAIN_GUID;
preset.presetCfg.rcParams.rateControlMode = NV_ENC_PARAMS_RC_CBR;
preset.presetCfg.rcParams.averageBitRate = (uint32_t)bitrate;
preset.presetCfg.rcParams.maxBitRate = (uint32_t)bitrate;
@@ -1160,7 +1165,7 @@ static nvenc_d3d11_smoke_result run_nvenc_d3d11_smoke_c(int width, int height, i
return out;
}
preset.presetCfg.profileGUID = NV_ENC_H264_PROFILE_HIGH_GUID;
preset.presetCfg.profileGUID = NV_ENC_H264_PROFILE_MAIN_GUID;
preset.presetCfg.rcParams.rateControlMode = NV_ENC_PARAMS_RC_CBR;
preset.presetCfg.rcParams.averageBitRate = (uint32_t)bitrate;
preset.presetCfg.rcParams.maxBitRate = (uint32_t)bitrate;
@@ -1961,7 +1966,8 @@ func encodeNativeH264D3D11Texture(stream string, device, texture unsafe.Pointer,
}
state.encoder = enc
}
return state.encoder.EncodeTexture(texture, forceIDR || state.forceIDR.Swap(false))
pendingIDR := state.forceIDR.Swap(false)
return state.encoder.EncodeTexture(texture, forceIDR || pendingIDR)
}
func requestNativeH264D3D11TextureKeyframe(stream string) {
@@ -1997,7 +2003,8 @@ func encodeNativeHEVCD3D11Texture(device, texture unsafe.Pointer, inputWidth, in
}
nativeTextureHEVCEnc = enc
}
return nativeTextureHEVCEnc.EncodeTexture(texture, forceIDR || nativeTextureHEVCForceIDR.Swap(false))
pendingIDR := nativeTextureHEVCForceIDR.Swap(false)
return nativeTextureHEVCEnc.EncodeTexture(texture, forceIDR || pendingIDR)
}
func requestNativeHEVCD3D11TextureKeyframe() {
@@ -42,7 +42,8 @@ func (b *qsvD3D11TextureBackend) Encode(req h264D3D11TextureRequest) ([]byte, er
b.device, b.inputWidth, b.inputHeight = req.Device, req.InputWidth, req.InputHeight
b.encodeWidth, b.encodeHeight, b.fps, b.dxgiFormat = req.EncodeWidth, req.EncodeHeight, req.FPS, req.DXGIFormat
}
forceIDR := req.ForceIDR || b.forceIDR.Swap(false)
pendingIDR := b.forceIDR.Swap(false)
forceIDR := req.ForceIDR || pendingIDR
for attempts := 0; attempts < 2; attempts++ {
result, size, err := b.encoder.Encode(req.Texture, forceIDR, b.output)
if err != nil {
@@ -0,0 +1,73 @@
package capture
import (
"overlord-client/cmd/agent/h264util"
"overlord-client/cmd/agent/webrtcpub"
)
func videoAccessUnitIsKey(codec string, data []byte) bool {
if codec == "hevc" {
return inspectHEVCAccessUnit(data).hasIRAP
}
return h264util.IsIDR(data)
}
type hevcAccessUnit struct {
hasVPS bool
hasSPS bool
hasPPS bool
hasIRAP bool
}
func inspectHEVCAccessUnit(data []byte) hevcAccessUnit {
var out hevcAccessUnit
for i := 0; i+4 < len(data); {
startCodeLen := 0
switch {
case data[i] == 0 && data[i+1] == 0 && data[i+2] == 1:
startCodeLen = 3
case i+4 < len(data) && data[i] == 0 && data[i+1] == 0 && data[i+2] == 0 && data[i+3] == 1:
startCodeLen = 4
}
if startCodeLen == 0 {
i++
continue
}
nal := i + startCodeLen
if nal >= len(data) {
break
}
nalType := (data[nal] >> 1) & 0x3f
switch nalType {
case 32:
out.hasVPS = true
case 33:
out.hasSPS = true
case 34:
out.hasPPS = true
default:
if nalType >= 16 && nalType <= 21 {
out.hasIRAP = true
}
}
i = nal + 1
}
return out
}
func videoAccessUnitIsRecoveryPoint(codec string, data []byte) bool {
if codec == "hevc" {
accessUnit := inspectHEVCAccessUnit(data)
return accessUnit.hasVPS && accessUnit.hasSPS && accessUnit.hasPPS && accessUnit.hasIRAP
}
accessUnit := h264util.InspectAnnexB(data)
return accessUnit.HasSPS && accessUnit.HasPPS && accessUnit.HasIDR
}
func retainKeyframeRequestUntilOutput(kind webrtcpub.Kind, requested bool, codec string, data []byte) bool {
isKey := videoAccessUnitIsKey(codec, data)
if requested && !videoAccessUnitIsRecoveryPoint(codec, data) {
webrtcpub.RequestKeyframe(kind)
}
return isKey
}
@@ -0,0 +1,38 @@
package capture
import (
"testing"
"overlord-client/cmd/agent/webrtcpub"
)
func TestRetainKeyframeRequestUntilIDROutput(t *testing.T) {
kind := webrtcpub.KindDesktop
_ = webrtcpub.ConsumeKeyframeRequest(kind)
if retainKeyframeRequestUntilOutput(kind, true, "h264", []byte{0, 0, 1, 0x41, 1}) {
t.Fatal("delta access unit was classified as a keyframe")
}
if !webrtcpub.ConsumeKeyframeRequest(kind) {
t.Fatal("keyframe request was not retained after delta output")
}
if !retainKeyframeRequestUntilOutput(kind, true, "h264", []byte{0, 0, 1, 0x65, 1}) {
t.Fatal("IDR access unit was not classified as a keyframe")
}
if !webrtcpub.ConsumeKeyframeRequest(kind) {
t.Fatal("keyframe request was not retained when IDR omitted SPS/PPS")
}
recoveryPoint := []byte{
0, 0, 1, 0x67, 1,
0, 0, 1, 0x68, 1,
0, 0, 1, 0x65, 1,
}
if !retainKeyframeRequestUntilOutput(kind, true, "h264", recoveryPoint) {
t.Fatal("complete recovery access unit was not classified as a keyframe")
}
if webrtcpub.ConsumeKeyframeRequest(kind) {
t.Fatal("completed keyframe request was unexpectedly requeued")
}
}
@@ -0,0 +1,29 @@
package capture
import (
"testing"
"time"
)
func TestConfiguredVideoKeyframeInterval(t *testing.T) {
tests := []struct {
value string
want time.Duration
}{
{value: "", want: 0},
{value: "off", want: 0},
{value: "0", want: 0},
{value: "30", want: 30 * time.Second},
{value: "2m", want: 2 * time.Minute},
{value: "invalid", want: 0},
}
for _, test := range tests {
t.Run(test.value, func(t *testing.T) {
t.Setenv("OVERLORD_VIDEO_KEYFRAME_INTERVAL", test.value)
if got := configuredVideoKeyframeInterval(); got != test.want {
t.Fatalf("configuredVideoKeyframeInterval() = %s, want %s", got, test.want)
}
})
}
}
@@ -281,19 +281,31 @@ func (s *virtualDuplicationState) captureDirectH264() (wire.Frame, time.Duration
func (s *virtualDuplicationState) encodeCachedDirectH264(capStart time.Time, width, height int) (wire.Frame, time.Duration, time.Duration, bool, error) {
fps := activeH264FPSForStream("backstage")
now := time.Now()
requestedKeyframe := webrtcpub.ConsumeKeyframeRequest(webrtcpub.Kindbackstage)
forceKeyframe := directVideoKeyframeDue(requestedKeyframe, now.UnixNano(), backstageLastKeyframe.Load())
encStart := time.Now()
out, _, err := encodeH264D3D11Texture("backstage", h264D3D11TextureRequest{
Device: unsafe.Pointer(s.device), Texture: unsafe.Pointer(s.h264LastTex),
InputWidth: width, InputHeight: height, EncodeWidth: width, EncodeHeight: height,
FPS: fps, DXGIFormat: s.h264LastDesc.Format, ForceIDR: webrtcpub.ConsumeKeyframeRequest(webrtcpub.Kindbackstage),
FPS: fps, DXGIFormat: s.h264LastDesc.Format, ForceIDR: forceKeyframe,
})
encodeDur := time.Since(encStart)
if err != nil {
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.Kindbackstage)
}
return wire.Frame{}, time.Since(capStart), encodeDur, true, err
}
if len(out) == 0 {
if requestedKeyframe {
webrtcpub.RequestKeyframe(webrtcpub.Kindbackstage)
}
return wire.Frame{}, time.Since(capStart), encodeDur, true, nil
}
if retainKeyframeRequestUntilOutput(webrtcpub.Kindbackstage, requestedKeyframe, "h264", out) {
backstageLastKeyframe.Store(now.UnixNano())
}
return wire.Frame{Type: "frame", Header: wire.FrameHeader{Monitor: 0, FPS: 0, Format: "h264", Backstage: true}, Data: out}, time.Since(capStart), encodeDur, true, nil
}
@@ -93,6 +93,9 @@ func TestCaptureDisplayDXGI(t *testing.T) {
func TestDirectVideoKeyframeDue(t *testing.T) {
now := (10 * time.Second).Nanoseconds()
previousInterval := videoKeyframeEvery
videoKeyframeEvery = 5 * time.Second
defer func() { videoKeyframeEvery = previousInterval }()
tests := []struct {
name string
@@ -102,7 +105,8 @@ func TestDirectVideoKeyframeDue(t *testing.T) {
}{
{name: "explicit request", requested: true, last: now, want: true},
{name: "first frame", last: 0, want: true},
{name: "periodic keyframes disabled", last: now - (30 * time.Second).Nanoseconds(), want: false},
{name: "periodic keyframe due", last: now - (30 * time.Second).Nanoseconds(), want: true},
{name: "periodic keyframe not due", last: now - time.Second.Nanoseconds(), want: false},
}
for _, test := range tests {
@@ -112,4 +116,9 @@ func TestDirectVideoKeyframeDue(t *testing.T) {
}
})
}
videoKeyframeEvery = 0
if directVideoKeyframeDue(false, now, now-(30*time.Second).Nanoseconds()) {
t.Fatal("periodic keyframe fired while the interval was disabled")
}
}
@@ -0,0 +1,45 @@
package h264util
type AccessUnit struct {
HasSPS bool
HasPPS bool
HasIDR bool
}
func InspectAnnexB(data []byte) AccessUnit {
var out AccessUnit
for i := 0; i+3 < len(data); {
startCodeLen := 0
switch {
case i+3 < len(data) && data[i] == 0 && data[i+1] == 0 && data[i+2] == 1:
startCodeLen = 3
case i+4 < len(data) && data[i] == 0 && data[i+1] == 0 && data[i+2] == 0 && data[i+3] == 1:
startCodeLen = 4
}
if startCodeLen == 0 {
i++
continue
}
nal := i + startCodeLen
if nal >= len(data) {
break
}
switch data[nal] & 0x1f {
case 5:
out.HasIDR = true
case 7:
out.HasSPS = true
case 8:
out.HasPPS = true
}
if out.HasSPS && out.HasPPS && out.HasIDR {
return out
}
i = nal + 1
}
return out
}
func IsIDR(data []byte) bool {
return InspectAnnexB(data).HasIDR
}
@@ -0,0 +1,22 @@
package h264util
import "testing"
func TestInspectAnnexB(t *testing.T) {
data := []byte{
0, 0, 0, 1, 0x67, 1, 2, 3,
0, 0, 1, 0x68, 4, 5,
0, 0, 0, 1, 0x65, 6, 7,
}
got := InspectAnnexB(data)
if !got.HasSPS || !got.HasPPS || !got.HasIDR {
t.Fatalf("InspectAnnexB() = %+v", got)
}
}
func TestInspectAnnexBRejectsDeltaFrame(t *testing.T) {
got := InspectAnnexB([]byte{0, 0, 1, 0x41, 1, 2, 3})
if got.HasSPS || got.HasPPS || got.HasIDR {
t.Fatalf("delta frame was misclassified: %+v", got)
}
}
+60 -11
View File
@@ -4,6 +4,8 @@ import (
"sync"
"sync/atomic"
"time"
"overlord-client/cmd/agent/h264util"
)
type Kind string
@@ -28,30 +30,64 @@ type writerEntry struct {
audio AudioWriter
}
const maxPendingVideoFrames = 6
type queuedVideoFrame struct {
data []byte
dur time.Duration
key bool
}
type latestVideoWriter struct {
writer VideoWriter
kind Kind
mu sync.Mutex
pending []byte
dur time.Duration
pending []queuedVideoFrame
needsKeyframe bool
closed bool
wake chan struct{}
}
func newLatestVideoWriter(writer VideoWriter) *latestVideoWriter {
queued := &latestVideoWriter{writer: writer, wake: make(chan struct{}, 1)}
func newLatestVideoWriter(kind Kind, writer VideoWriter) *latestVideoWriter {
queued := &latestVideoWriter{writer: writer, kind: kind, wake: make(chan struct{}, 1)}
go queued.run()
return queued
}
func (w *latestVideoWriter) enqueue(frame []byte, dur time.Duration) {
isKey := h264util.IsIDR(frame)
w.mu.Lock()
if w.closed {
w.mu.Unlock()
return
}
w.pending = frame
w.dur = dur
if w.needsKeyframe && !isKey {
w.mu.Unlock()
RequestKeyframe(w.kind)
return
}
requestKeyframe := false
if len(w.pending) >= maxPendingVideoFrames {
w.pending = nil
w.needsKeyframe = true
requestKeyframe = true
if !isKey {
w.mu.Unlock()
RequestKeyframe(w.kind)
return
}
}
if isKey && w.needsKeyframe {
w.pending = nil
w.needsKeyframe = false
requestKeyframe = false
}
w.pending = append(w.pending, queuedVideoFrame{data: frame, dur: dur, key: isKey})
w.mu.Unlock()
if requestKeyframe {
RequestKeyframe(w.kind)
}
select {
case w.wake <- struct{}{}:
default:
@@ -77,13 +113,26 @@ func (w *latestVideoWriter) run() {
w.mu.Unlock()
return
}
frame, dur := w.pending, w.dur
w.pending = nil
if len(w.pending) == 0 {
w.mu.Unlock()
if len(frame) == 0 {
break
}
_ = w.writer.WriteH264(frame, dur)
frame := w.pending[0]
w.pending[0] = queuedVideoFrame{}
w.pending = w.pending[1:]
w.mu.Unlock()
err := w.writer.WriteH264(frame.data, frame.dur)
requestKeyframe := false
w.mu.Lock()
if err != nil {
w.pending = nil
w.needsKeyframe = true
requestKeyframe = true
}
w.mu.Unlock()
if requestKeyframe {
RequestKeyframe(w.kind)
}
}
}
}
@@ -107,7 +156,7 @@ func registerVideoWriter(kind Kind, id string, w VideoWriter) {
if entry.video != nil {
entry.video.close()
}
entry.video = newLatestVideoWriter(w)
entry.video = newLatestVideoWriter(kind, w)
bucket[id] = entry
writersMu.Unlock()
RequestKeyframe(kind)
@@ -4,6 +4,8 @@ import (
"sync"
"testing"
"time"
"overlord-client/cmd/agent/h264util"
)
type blockingVideoWriter struct {
@@ -25,7 +27,15 @@ func (w *blockingVideoWriter) WriteH264(frame []byte, _ time.Duration) error {
return nil
}
func TestWriteH264DoesNotBlockAndKeepsLatestPendingFrame(t *testing.T) {
func annexBDelta(value byte) []byte {
return []byte{0, 0, 0, 1, 0x41, value}
}
func annexBKey(value byte) []byte {
return []byte{0, 0, 0, 1, 0x67, 1, 0, 0, 1, 0x68, 1, 0, 0, 1, 0x65, value}
}
func TestWriteH264DoesNotBlockAndRequestsRecoveryAfterDroppingDelta(t *testing.T) {
kind := Kind("queue-test")
id := "slow-writer"
writer := &blockingVideoWriter{
@@ -34,8 +44,9 @@ func TestWriteH264DoesNotBlockAndKeepsLatestPendingFrame(t *testing.T) {
}
registerVideoWriter(kind, id, writer)
defer unregisterWriter(kind, id)
_ = ConsumeKeyframeRequest(kind)
if err := WriteH264(kind, []byte{1}, time.Millisecond); err != nil {
if err := WriteH264(kind, annexBDelta(1), time.Millisecond); err != nil {
t.Fatal(err)
}
select {
@@ -45,11 +56,16 @@ func TestWriteH264DoesNotBlockAndKeepsLatestPendingFrame(t *testing.T) {
}
started := time.Now()
_ = WriteH264(kind, []byte{2}, time.Millisecond)
_ = WriteH264(kind, []byte{3}, time.Millisecond)
for frame := 2; frame <= maxPendingVideoFrames+2; frame++ {
_ = WriteH264(kind, annexBDelta(byte(frame)), time.Millisecond)
}
if elapsed := time.Since(started); elapsed > 100*time.Millisecond {
t.Fatalf("capture path blocked for %s", elapsed)
}
if !ConsumeKeyframeRequest(kind) {
t.Fatal("dropping a predictive frame did not request a keyframe")
}
_ = WriteH264(kind, annexBKey(9), time.Millisecond)
close(writer.release)
deadline := time.Now().Add(time.Second)
@@ -58,14 +74,14 @@ func TestWriteH264DoesNotBlockAndKeepsLatestPendingFrame(t *testing.T) {
frames := append([][]byte(nil), writer.frames...)
writer.mu.Unlock()
if len(frames) >= 2 {
if frames[0][0] != 1 || frames[1][0] != 3 {
t.Fatalf("expected first and latest frames, got %v", frames)
if frames[0][len(frames[0])-1] != 1 || !h264util.IsIDR(frames[1]) {
t.Fatalf("expected first frame followed by recovery IDR, got %v", frames)
}
return
}
time.Sleep(5 * time.Millisecond)
}
t.Fatal("latest pending frame was not delivered")
t.Fatal("recovery keyframe was not delivered")
}
func TestKeyframeRequestsAreIsolatedByStreamKind(t *testing.T) {
@@ -47,7 +47,7 @@ func drainRTCP(sender *webrtc.RTPSender, kind Kind) {
}
}
const h264SDPFmtpLine = "level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=640034"
const h264SDPFmtpLine = "level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=4d0034"
var rtcpKeyframeLogOnce sync.Once
var (
+7 -7
View File
@@ -26,7 +26,7 @@ export async function showCertBannerIfNeeded(anchor) {
} catch { }
}
const os = detectOS();
const os = getCertificateTrustGuide();
const banner = document.createElement("div");
banner.id = "cert-trust-banner";
@@ -45,7 +45,7 @@ export async function showCertBannerIfNeeded(anchor) {
</p>
<div class="flex flex-wrap items-center gap-2">
<a href="/api/cert/download"
download="overlord-ca.crt"
download="overlord-server.crt"
class="inline-flex items-center gap-1.5 rounded bg-amber-600 hover:bg-amber-500
px-3 py-1 text-xs font-medium text-white transition-colors">
<svg class="w-3.5 h-3.5" fill="none" stroke="currentColor" stroke-width="2"
@@ -80,13 +80,13 @@ export async function showCertBannerIfNeeded(anchor) {
});
}
function detectOS() {
export function getCertificateTrustGuide() {
const ua = navigator.userAgent.toLowerCase();
if (ua.includes("win")) {
return {
label: "Windows",
instructions:
`1. Double-click the downloaded <strong>overlord-ca.crt</strong> file.
`1. Double-click the downloaded <strong>overlord-server.crt</strong> file.
2. Click <strong>Install Certificate...</strong>
3. Choose <strong>Current User</strong> or <strong>Local Machine</strong>.
4. Select <strong>"Place all certificates in the following store"</strong>.
@@ -99,7 +99,7 @@ function detectOS() {
return {
label: "macOS",
instructions:
`1. Double-click the downloaded <strong>overlord-ca.crt</strong> file — it opens in Keychain Access.
`1. Double-click the downloaded <strong>overlord-server.crt</strong> file — it opens in Keychain Access.
2. If prompted, add it to the <strong>login</strong> or <strong>System</strong> keychain.
3. Find the certificate in the list, double-click it.
4. Expand <strong>Trust</strong> and set <strong>"When using this certificate"</strong> to <strong>Always Trust</strong>.
@@ -111,11 +111,11 @@ function detectOS() {
label: "Linux",
instructions:
`<strong>Debian / Ubuntu:</strong>
sudo cp overlord-ca.crt /usr/local/share/ca-certificates/overlord-ca.crt
sudo cp overlord-server.crt /usr/local/share/ca-certificates/overlord-server.crt
sudo update-ca-certificates
<strong>Fedora / RHEL:</strong>
sudo cp overlord-ca.crt /etc/pki/ca-trust/source/anchors/overlord-ca.crt
sudo cp overlord-server.crt /etc/pki/ca-trust/source/anchors/overlord-server.crt
sudo update-ca-trust
Then <strong>restart your browser</strong>.
+93 -32
View File
@@ -153,6 +153,8 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
let pendingFrame = null;
let videoDecoder = null;
let videoDecoderConfigKey = "";
let pendingDecodedVideoFrame = null;
let decodedVideoPresentationFrame = 0;
const disabledDecoderCodecs = new Set();
let h264StreamCodec = "";
let canvasDecodePressure = false;
@@ -167,6 +169,7 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
let h264KeyframeErrorStreak = 0;
let h264RecoveryAttempts = 0;
let h264LastDecodeWarnAt = 0;
let h264WaitingForKeyframe = true;
const H264_LOW_FPS_THRESHOLD = 6;
const H264_FALLBACK_WARMUP_MS = 10000;
const H264_MIN_FRAMES_BEFORE_FALLBACK = 120;
@@ -175,9 +178,8 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
const H264_MAX_RECOVERY_ATTEMPTS = 1;
const H264_DECODE_WARN_THROTTLE_MS = 2000;
const inputBackpressureBytes = 256 * 1024;
const VIEWER_FRAME_GAP_KEYFRAME_MS = 500;
const VIEWER_FRAME_GAP_KEYFRAME_THROTTLE_MS = 1000;
let lastViewerFrameGapKeyframeAt = 0;
let lastViewerKeyframeRequestAt = 0;
const diagnostics = {
agent: null,
network: null,
@@ -240,6 +242,7 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
h264FirstFrameAt = 0;
h264FramesSeen = 0;
h264KeyframeErrorStreak = 0;
h264WaitingForKeyframe = true;
}
/* ── Remote Desktop Audio (system audio from client) ── */
@@ -1139,6 +1142,15 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
} else if ((finite(media.lossPercent) ?? 0) > 3 || (finite(network.rttMs) ?? 0) > 150 || (finite(media.jitterMs) ?? 0) > 35) {
summary = "Network conditions are causing delay";
severity = "bad";
} else if (
mode === "off" &&
fps != null &&
viewerRate != null &&
viewerRate < fps * 0.8 &&
diagnostics.coalescedFrames > 0
) {
summary = `Display is presenting ${Math.round(viewerRate)} of ${Math.round(fps)} decoded FPS`;
severity = "warn";
} else if ((queue ?? 0) > 2 || (renderMs != null && renderMs > frameBudget)) {
summary = "Viewer render queue is backing up";
severity = "warn";
@@ -1969,7 +1981,8 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
pushBitrate();
desiredStreaming = true;
lastFrameAt = 0;
lastViewerFrameGapKeyframeAt = 0;
lastViewerKeyframeRequestAt = 0;
diagnostics.coalescedFrames = 0;
firstFrameLogged = false;
resetH264SessionState();
setStreamState("starting", "Starting stream");
@@ -2322,17 +2335,8 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
function markFrameReceived() {
const now = performance.now();
const frameGapMs = lastFrameAt ? now - lastFrameAt : 0;
lastFrameAt = now;
clearOfflineTimer();
if (
desiredStreaming &&
frameGapMs >= VIEWER_FRAME_GAP_KEYFRAME_MS &&
(!lastViewerFrameGapKeyframeAt || now - lastViewerFrameGapKeyframeAt >= VIEWER_FRAME_GAP_KEYFRAME_THROTTLE_MS)
) {
lastViewerFrameGapKeyframeAt = now;
sendCmd("desktop_request_keyframe", { reason: "viewer_frame_gap" });
}
if (!firstFrameLogged) {
firstFrameLogged = true;
rdDebug("first frame received", {
@@ -2394,6 +2398,14 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
function destroyVideoDecoder() {
updateCanvasDecodePressure(true);
if (decodedVideoPresentationFrame) {
cancelAnimationFrame(decodedVideoPresentationFrame);
decodedVideoPresentationFrame = 0;
}
if (pendingDecodedVideoFrame) {
pendingDecodedVideoFrame.frame.close();
pendingDecodedVideoFrame = null;
}
if (videoDecoder) {
try {
videoDecoder.close();
@@ -2406,6 +2418,47 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
resetH264RuntimeState();
}
function presentLatestDecodedVideoFrame() {
decodedVideoPresentationFrame = 0;
const pending = pendingDecodedVideoFrame;
pendingDecodedVideoFrame = null;
if (!pending) return;
const { frame, timing, width, height } = pending;
if (width > 0 && height > 0 && (canvas.width !== width || canvas.height !== height)) {
canvas.width = width;
canvas.height = height;
frameWidth = width;
frameHeight = height;
}
try {
ctx.drawImage(frame, 0, 0, canvas.width, canvas.height);
} finally {
frame.close();
}
const renderedAt = performance.now();
if (timing) {
diagnostics.renderMs = smoothed(diagnostics.renderMs, Math.max(0, renderedAt - timing.receivedAt));
}
diagnostics.width = width;
diagnostics.height = height;
updateFpsDisplay();
}
function queueDecodedVideoFrame(frame, timing) {
const width = frame.displayWidth || frame.codedWidth || frameWidth;
const height = frame.displayHeight || frame.codedHeight || frameHeight;
if (pendingDecodedVideoFrame) {
pendingDecodedVideoFrame.frame.close();
diagnostics.coalescedFrames += 1;
}
pendingDecodedVideoFrame = { frame, timing, width, height };
if (!decodedVideoPresentationFrame) {
decodedVideoPresentationFrame = requestAnimationFrame(presentLatestDecodedVideoFrame);
}
}
function normalizeFallbackReason(reason) {
if (!reason) return "unspecified";
if (typeof reason === "string") return reason;
@@ -2458,6 +2511,7 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
h264RecoveryAttempts += 1;
h264KeyframeErrorStreak = 0;
destroyVideoDecoder();
console.warn("rd: h264 decode stuck waiting for keyframe; auto-restarting stream once", {
reason,
@@ -2578,34 +2632,24 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
output: (frame) => {
const outputStartedAt = performance.now();
const timing = h264PendingTimings.shift();
const width = frame.displayWidth || frame.codedWidth || frameWidth;
const height = frame.displayHeight || frame.codedHeight || frameHeight;
if (width > 0 && height > 0 && (canvas.width !== width || canvas.height !== height)) {
canvas.width = width;
canvas.height = height;
frameWidth = width;
frameHeight = height;
}
try {
ctx.drawImage(frame, 0, 0, canvas.width, canvas.height);
} finally {
frame.close();
}
const renderedAt = performance.now();
h264KeyframeErrorStreak = 0;
if (timing) {
diagnostics.decodeMs = smoothed(diagnostics.decodeMs, Math.max(0, outputStartedAt - timing.decodeStartedAt));
diagnostics.renderMs = smoothed(diagnostics.renderMs, Math.max(0, renderedAt - timing.receivedAt));
}
diagnostics.decodeQueue = videoDecoder?.decodeQueueSize || h264PendingTimings.length;
diagnostics.width = width;
diagnostics.height = height;
updateFpsDisplay();
queueDecodedVideoFrame(frame, timing);
updateCanvasDecodePressure();
},
error: (err) => {
console.warn(`rd: ${codecName} decoder error`, err);
if (codecName === "h264") h264WaitingForKeyframe = true;
updateCanvasDecodePressure(true);
setTimeout(() => fallbackFromVideoCodec(codecName, err), 0);
setTimeout(() => {
if (codecName === "h264" && tryRecoverH264Stream("h264_async_decoder_error")) {
return;
}
fallbackFromVideoCodec(codecName, err);
}, 0);
},
});
videoDecoder.addEventListener("dequeue", () => {
@@ -2795,6 +2839,23 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
h264FramesSeen += 1;
const isKey = codecName === "hevc" ? isHEVCKeyFrame(videoBytes) : isH264KeyFrame(videoBytes);
if (codecName === "h264" && h264WaitingForKeyframe && !isKey) {
h264KeyframeErrorStreak += 1;
const now = performance.now();
if (!lastViewerKeyframeRequestAt || now - lastViewerKeyframeRequestAt >= VIEWER_FRAME_GAP_KEYFRAME_THROTTLE_MS) {
lastViewerKeyframeRequestAt = now;
sendCmd("desktop_request_keyframe", { reason: "h264_decoder_keyframe_required" });
}
if (h264KeyframeErrorStreak >= H264_KEYFRAME_ERROR_RESTART_THRESHOLD) {
const restarted = tryRecoverH264Stream("h264_keyframe_timeout");
if (!restarted) fallbackToJpegCodec("h264_keyframe_timeout_loop");
}
updateCanvasDecodePressure(true);
return;
}
if (codecName === "h264" && isKey) {
h264WaitingForKeyframe = false;
}
// If software H264 encode on the agent cannot keep up, automatically
// fall back to JPEG blocks for a smoother interactive stream.
@@ -2827,10 +2888,10 @@ import { createSharedUiSettingsSaver, loadSharedUiSettings } from "./shared-ui-s
videoDecoder.decode(chunk);
diagnostics.decodeQueue = videoDecoder.decodeQueueSize;
updateCanvasDecodePressure();
h264KeyframeErrorStreak = 0;
} catch (err) {
h264PendingTimings.pop();
if (isKeyframeRequiredError(err)) {
if (codecName === "h264") h264WaitingForKeyframe = true;
h264KeyframeErrorStreak += 1;
const now = Date.now();
if (now - h264LastDecodeWarnAt >= H264_DECODE_WARN_THROTTLE_MS) {
+45
View File
@@ -6,6 +6,7 @@ import {
requestDesktopNotificationPermission,
} from "./notify-client.js";
import { escapeHtml, formatBytes as formatSharedBytes, formatDate as formatSharedDate } from "./format.js";
import { getCertificateTrustGuide } from "./cert-banner.js";
const PREF_REFRESH_KEY = "overlord_refresh_interval_seconds";
const NAV_MODE_KEY = "sb_mode";
@@ -81,6 +82,10 @@ const tlsCertbotDomainInput = document.getElementById("tls-certbot-domain");
const tlsCertbotCertFileInput = document.getElementById("tls-certbot-cert-file");
const tlsCertbotKeyFileInput = document.getElementById("tls-certbot-key-file");
const tlsCertbotCaFileInput = document.getElementById("tls-certbot-ca-file");
const tlsActiveCertSource = document.getElementById("tls-active-cert-source");
const tlsDownloadCertBtn = document.getElementById("tls-download-cert-btn");
const tlsTrustHelpBtn = document.getElementById("tls-trust-help-btn");
const tlsTrustInstructions = document.getElementById("tls-trust-instructions");
const oidcForm = document.getElementById("oidc-form");
const oidcPermissionNote = document.getElementById("oidc-permission-note");
@@ -457,6 +462,45 @@ function applyTlsForm() {
tlsCertbotCaFileInput.value = certbot.caFileName || "chain.pem";
}
tlsTrustHelpBtn?.addEventListener("click", () => {
tlsTrustInstructions?.classList.toggle("hidden");
});
async function loadActiveTlsCertificate() {
const guide = getCertificateTrustGuide();
if (tlsTrustHelpBtn) {
tlsTrustHelpBtn.innerHTML = `<i class="fa-solid fa-shield-halved"></i>Trust on ${guide.label}`;
}
if (tlsTrustInstructions) {
tlsTrustInstructions.innerHTML = guide.instructions;
}
try {
const res = await fetch("/api/cert/info", { credentials: "include" });
if (!res.ok) throw new Error(`HTTP ${res.status}`);
const data = await res.json();
const source = String(data.source || "unknown");
if (tlsActiveCertSource) {
tlsActiveCertSource.textContent = source === "self-signed"
? "Self-signed"
: source === "certbot"
? "Certbot / Let's Encrypt"
: source === "configured"
? "Configured certificate"
: "Unknown source";
tlsActiveCertSource.classList.toggle("border-amber-600", source === "self-signed");
tlsActiveCertSource.classList.toggle("bg-amber-950", source === "self-signed");
tlsActiveCertSource.classList.toggle("text-amber-200", source === "self-signed");
}
} catch {
if (tlsActiveCertSource) tlsActiveCertSource.textContent = "Unavailable";
if (tlsDownloadCertBtn) {
tlsDownloadCertBtn.setAttribute("aria-disabled", "true");
tlsDownloadCertBtn.classList.add("pointer-events-none", "opacity-50");
}
}
}
async function loadTlsSettings() {
if (!currentUser) return;
@@ -489,6 +533,7 @@ async function loadTlsSettings() {
tlsConfig = data.tls || null;
applyTlsForm();
setTlsFormDisabled(false);
await loadActiveTlsCertificate();
}
function listToCsv(value) {
+40
View File
@@ -788,6 +788,46 @@
Your permissions do not allow TLS setting changes.
</div>
<div class="rounded-lg border border-cyan-800/70 bg-cyan-950/20 px-4 py-4 space-y-3">
<div class="flex flex-col sm:flex-row sm:items-center gap-3">
<div class="flex-1">
<div class="flex flex-wrap items-center gap-2">
<p class="text-sm font-medium text-cyan-100">Active server certificate</p>
<span id="tls-active-cert-source" class="rounded-full border border-slate-600 bg-slate-800 px-2 py-0.5 text-xs text-slate-300">
Checking…
</span>
</div>
<p class="mt-1 text-xs text-slate-400">
Download and trust this certificate when a locally generated certificate causes HTTPS or WebSocket trust errors.
</p>
</div>
<div class="flex flex-wrap gap-2">
<a
id="tls-download-cert-btn"
href="/api/cert/download"
download="overlord-server.crt"
class="inline-flex items-center gap-2 px-3 py-2 rounded-lg bg-cyan-700 hover:bg-cyan-600 transition-colors text-white text-sm font-medium"
>
<i class="fa-solid fa-download"></i>Download Certificate
</a>
<button
type="button"
id="tls-trust-help-btn"
class="inline-flex items-center gap-2 px-3 py-2 rounded-lg border border-slate-600 bg-slate-800 hover:bg-slate-700 transition-colors text-slate-100 text-sm font-medium"
>
<i class="fa-solid fa-shield-halved"></i>Trust Instructions
</button>
</div>
</div>
<div
id="tls-trust-instructions"
class="hidden rounded-lg border border-slate-700 bg-slate-950/80 p-3 text-xs text-slate-300 leading-relaxed whitespace-pre-line"
></div>
<p class="text-xs text-amber-300/90">
Browsers cannot install trusted certificates automatically. Your operating system will require confirmation, and the browser must be restarted afterward.
</p>
</div>
<label class="flex items-center gap-2 text-sm">
<input id="tls-certbot-enabled" type="checkbox" class="h-4 w-4" />
<span>Use certbot certificates in production runtime (NODE_ENV=production)</span>
@@ -0,0 +1,15 @@
import { describe, expect, test } from "bun:test";
import { assetCacheControl } from "./assets-routes";
describe("asset cache policy", () => {
test("revalidates stable JavaScript and stylesheet filenames after a deployment", () => {
expect(assetCacheControl("remotedesktop.js")).toBe("no-cache");
expect(assetCacheControl("main.min.js")).toBe("no-cache");
expect(assetCacheControl("tailwind.css")).toBe("no-cache");
});
test("keeps binary and font assets immutable", () => {
expect(assetCacheControl("logo.png")).toContain("immutable");
expect(assetCacheControl("inter.woff2")).toContain("immutable");
});
});
@@ -22,7 +22,6 @@ function acceptsGzip(req: Request): boolean {
}
const STATIC_ASSET_CACHE = "public, max-age=31536000, immutable";
const MUTABLE_ASSET_CACHE = "public, max-age=86400, stale-while-revalidate=604800";
const NO_CACHE = "no-cache";
const MAX_GZIP_CACHE_ENTRIES = 128;
const MAX_GZIP_CACHE_BYTES = 16 * 1024 * 1024;
@@ -35,16 +34,16 @@ type GzipCacheEntry = {
const gzipAssetCache = new Map<string, GzipCacheEntry>();
let gzipAssetCacheBytes = 0;
function assetCacheControl(relativePath: string): string {
export function assetCacheControl(relativePath: string): string {
if (relativePath === "custom.css") return NO_CACHE;
if (relativePath === "notification-sw.js") return NO_CACHE;
if (relativePath.endsWith(".min.js") || relativePath.endsWith(".min.css")) {
return STATIC_ASSET_CACHE;
}
if (/\.(ico|png|jpg|jpeg|gif|webp|woff2?|ttf|eot|svg)$/.test(relativePath)) {
return STATIC_ASSET_CACHE;
}
return MUTABLE_ASSET_CACHE;
// Script and stylesheet filenames are stable across releases. Revalidate
// them so a rebuilt Docker image cannot leave the previous UI cached for a
// day (or stale-served for a week). ETags keep unchanged requests cheap.
return NO_CACHE;
}
function toExactArrayBuffer(bytes: Uint8Array): ArrayBuffer {
@@ -0,0 +1,70 @@
import { afterAll, beforeAll, describe, expect, test } from "bun:test";
import { mkdtempSync, rmSync, writeFileSync } from "fs";
import { tmpdir } from "os";
import path from "path";
import { generateToken } from "../../auth";
import { createUser, deleteUser, getUserById } from "../../users";
import { handleMiscRoutes } from "./misc-routes";
const password = "Aa1!CertificateDownload_2026";
const tempRoot = mkdtempSync(path.join(tmpdir(), "overlord-cert-download-"));
const certPath = path.join(tempRoot, "server.crt");
const certBody = "-----BEGIN CERTIFICATE-----\ntest\n-----END CERTIFICATE-----\n";
let userId = 0;
let token = "";
const deps = {
CORS_HEADERS: {},
SERVER_VERSION: "test",
PUBLIC_ROOT: ".",
requestIP: () => ({ address: "127.0.0.1" }),
getConsoleSessionCount: () => 0,
getRdSessionCount: () => 0,
getFileBrowserSessionCount: () => 0,
getProcessSessionCount: () => 0,
tlsCertPath: certPath,
tlsSource: "self-signed" as const,
};
beforeAll(async () => {
writeFileSync(certPath, certBody);
const created = await createUser(
`cert_download_${Date.now().toString(36)}`,
password,
"admin",
"test",
);
if (!created.success || !created.userId) throw new Error("failed to create certificate test user");
userId = created.userId;
token = await generateToken(getUserById(userId)!);
});
afterAll(() => {
if (userId) deleteUser(userId);
rmSync(tempRoot, { recursive: true, force: true });
});
describe("active TLS certificate download", () => {
test("requires authentication", async () => {
const url = new URL("https://localhost/api/cert/download");
const response = await handleMiscRoutes(new Request(url), url, deps);
expect(response?.status).toBe(401);
});
test("downloads the active certificate with safe headers", async () => {
const url = new URL("https://localhost/api/cert/download");
const response = await handleMiscRoutes(
new Request(url, { headers: { Cookie: `overlord_token=${token}` } }),
url,
deps,
);
expect(response?.status).toBe(200);
expect(response?.headers.get("content-disposition")).toBe(
'attachment; filename="overlord-server.crt"',
);
expect(response?.headers.get("cache-control")).toBe("no-store");
expect(response?.headers.get("x-content-type-options")).toBe("nosniff");
expect(await response?.text()).toBe(certBody);
});
});
@@ -1380,7 +1380,9 @@ export async function handleMiscRoutes(
return new Response(file, {
headers: {
"Content-Type": "application/x-pem-file",
"Content-Disposition": 'attachment; filename="overlord-ca.crt"',
"Content-Disposition": 'attachment; filename="overlord-server.crt"',
"Cache-Control": "no-store",
"X-Content-Type-Options": "nosniff",
...deps.CORS_HEADERS,
},
});
@@ -146,12 +146,12 @@ describe("remote desktop viewer control", () => {
handleRemoteDesktopViewerMessage(viewerSocket, JSON.stringify({
type: "desktop_request_keyframe",
reason: "viewer_frame_gap",
reason: "h264_decoder_keyframe_required",
}));
const automaticCommand = agentCommands(agentWs)
.filter((msg) => msg.commandType === "desktop_request_keyframe")
.at(-1);
expect(automaticCommand?.payload).toEqual({ reason: "viewer_frame_gap" });
expect(automaticCommand?.payload).toEqual({ reason: "h264_decoder_keyframe_required" });
});
test("requests HEVC recovery after a screenshot only while streaming", () => {
@@ -381,9 +381,39 @@ describe("remote desktop viewer control", () => {
{ format: "h264", fps: 60, width: 2560, height: 1440 },
);
expect(pressuredAck).toBe(false);
for (let frameNumber = 0; frameNumber < 3; frameNumber++) {
const additionalAck = (globalThis as any).__rdBroadcast(
clientId,
new Uint8Array([7 + frameNumber]),
{ format: "h264", fps: 60, width: 2560, height: 1440 },
);
expect(additionalAck).toBe(false);
}
handleRemoteDesktopViewerMessage(viewer as any, JSON.stringify({ type: "desktop_decode_pressure", active: false }));
expect(agentCommands(agentWs).filter((msg) => msg.type === "frame_ack")).toHaveLength(1);
expect(agentCommands(agentWs).filter((msg) => msg.type === "frame_ack")).toHaveLength(4);
});
test("coalesces keyframe requests while a viewer remains backpressured", () => {
const clientId = `rd-backpressure-${Date.now().toString(36)}`;
const { agentWs } = createClient(clientId);
const viewer = createMockWs({ clientId });
viewer.getBufferedAmount = () => 2 * 1024 * 1024;
handleRemoteDesktopViewerOpen(viewer as any);
for (let frame = 0; frame < 3; frame++) {
const shouldAck = (globalThis as any).__rdBroadcast(
clientId,
new Uint8Array([frame]),
{ format: "h264", fps: 60, width: 1920, height: 1080 },
);
expect(shouldAck).toBe(true);
}
const requests = agentCommands(agentWs)
.filter((msg) => msg.commandType === "desktop_request_keyframe");
expect(requests).toHaveLength(1);
expect(requests[0]?.payload?.reason).toBe("viewer_backpressure");
});
});
@@ -138,6 +138,7 @@ type FrameBroadcastResult = {
sent: boolean;
dropped: boolean;
viewers: number;
sentViewers: Set<ServerWebSocket<SocketData>>;
};
function broadcastFrameToViewers(
@@ -148,6 +149,7 @@ function broadcastFrameToViewers(
let sent = false;
let dropped = false;
let viewers = 0;
const sentViewers = new Set<ServerWebSocket<SocketData>>();
const t0 = performance.now();
const byteLen = buf.length;
for (const session of sessions) {
@@ -161,6 +163,7 @@ function broadcastFrameToViewers(
session.viewer.send(buf);
metrics.recordBytesSent(byteLen);
sent = true;
sentViewers.add(session.viewer);
} catch (err) {
logger.error("[rd] viewer frame send failed", err);
}
@@ -172,14 +175,15 @@ function broadcastFrameToViewers(
rdSendStats.sendMs += elapsed;
}
logRdSend(header);
return { sent, dropped, viewers };
return { sent, dropped, viewers, sentViewers };
}
const rdSendStats = { lastLog: 0, frames: 0, sendMs: 0, bytes: 0 };
const rdDebugFrameLogAt = new Map<string, number>();
const rdCanvasFrameAckPending = new Map<string, string>();
const rdCanvasFrameAckPending = new Map<string, { sessionId: string; count: number }>();
const rdBackpressureKeyframeAt = new Map<string, number>();
const RD_BACKPRESSURE_KEYFRAME_INTERVAL_MS = 1_000;
const AUTOMATIC_DESKTOP_KEYFRAME_REASONS: Record<string, true> = {
viewer_frame_gap: true,
h264_decoder_keyframe_required: true,
hevc_decoder_keyframe_required: true,
};
@@ -487,6 +491,7 @@ export function handleRemoteDesktopViewerMessage(ws: ServerWebSocket<SocketData>
.filter(s => s.id !== ws.data.sessionId);
logger.debug(`[rd-debug] desktop_stop requested client=${clientId} session=${ws.data.sessionId || ""} otherViewers=${otherViewers.length} state=${JSON.stringify(state)}`);
if (otherViewers.length === 0) {
rdBackpressureKeyframeAt.delete(clientId);
stopRemoteDesktopRecording(clientId, "desktop stopped");
sendDesktopCommand(target, "desktop_stop", {});
sendDesktopCommand(target, "webrtc_stop", { kind: "desktop" });
@@ -863,23 +868,32 @@ function broadcastRemoteDesktopFrame(clientId: string, bytes: Uint8Array, header
const result = broadcastFrameToViewers(sessions, buf, header);
if (result.sent) {
const controller = sessions.find((session) =>
result.sentViewers.has(session.viewer) &&
(session.viewer.data as any).rdCanvasFlowControl === true &&
(session.viewer.data as any).rdCanvasBackpressure === true
);
if (controller?.viewer.data.sessionId) {
rdCanvasFrameAckPending.set(clientId, controller.viewer.data.sessionId);
const sessionId = controller.viewer.data.sessionId;
const pending = rdCanvasFrameAckPending.get(clientId);
rdCanvasFrameAckPending.set(clientId, {
sessionId,
count: pending?.sessionId === sessionId ? pending.count + 1 : 1,
});
}
}
if (result.dropped) {
const target = clientManager.getClient(clientId);
if (target) {
const now = Date.now();
const lastRequestAt = rdBackpressureKeyframeAt.get(clientId) || 0;
if (target && now - lastRequestAt >= RD_BACKPRESSURE_KEYFRAME_INTERVAL_MS) {
rdBackpressureKeyframeAt.set(clientId, now);
sendDesktopCommand(target, "desktop_request_keyframe", {
reason: "viewer_backpressure",
format: String(header?.format || ""),
});
}
}
return (result.sent && !rdCanvasFrameAckPending.has(clientId)) || result.viewers === 0;
return ((result.sent || result.dropped) && !rdCanvasFrameAckPending.has(clientId)) || result.viewers === 0;
}
(globalThis as any).__rdBroadcast = (clientId: string, bytes: Uint8Array, header?: any): boolean => {
@@ -1588,13 +1602,16 @@ export function handleDesktopEncoderCapabilities(clientId: string, payload: any)
}
function releaseCanvasFrameAck(clientId: string, sessionId?: string): boolean {
const controllerSessionId = rdCanvasFrameAckPending.get(clientId);
if (!controllerSessionId || (sessionId && controllerSessionId !== sessionId)) return false;
const pending = rdCanvasFrameAckPending.get(clientId);
if (!pending || (sessionId && pending.sessionId !== sessionId)) return false;
rdCanvasFrameAckPending.delete(clientId);
const target = clientManager.getClient(clientId);
if (!target) return false;
try {
target.ws.send(encodeMessage({ type: "frame_ack" }));
const ack = encodeMessage({ type: "frame_ack" });
for (let i = 0; i < pending.count; i++) {
target.ws.send(ack);
}
return true;
} catch (err) {
logger.debug(`[rd] canvas frame ack failed client=${clientId}: ${(err as Error).message}`);
@@ -0,0 +1,118 @@
import { expect, test } from "@playwright/test";
import { login } from "./helpers";
test("Canvas presents only the latest decoded video frame per browser refresh", async ({ page }) => {
await login(page);
await page.addInitScript(() => {
const counters = { decoded: 0, drawn: 0, closed: 0 };
Object.defineProperty(window, "__rdPresentationCounters", { value: counters, configurable: true });
class FakeWebSocket extends EventTarget {
static readonly CONNECTING = 0;
static readonly OPEN = 1;
static readonly CLOSING = 2;
static readonly CLOSED = 3;
readonly CONNECTING = 0;
readonly OPEN = 1;
readonly CLOSING = 2;
readonly CLOSED = 3;
readyState = FakeWebSocket.OPEN;
bufferedAmount = 0;
binaryType: BinaryType = "blob";
constructor(_url: string | URL) {
super();
Object.defineProperty(window, "__rdSocket", { value: this, configurable: true });
queueMicrotask(() => this.dispatchEvent(new Event("open")));
}
send() {}
close() {
this.readyState = FakeWebSocket.CLOSED;
this.dispatchEvent(new CloseEvent("close"));
}
}
class FakeVideoDecoder extends EventTarget {
static async isConfigSupported(config: VideoDecoderConfig) {
return { supported: true, config };
}
decodeQueueSize = 0;
private output: (frame: VideoFrame) => void;
constructor(init: VideoDecoderInit) {
super();
this.output = init.output;
}
configure() {}
decode() {
counters.decoded += 1;
const frame = {
displayWidth: 1920,
displayHeight: 1080,
codedWidth: 1920,
codedHeight: 1080,
close() {
counters.closed += 1;
},
} as unknown as VideoFrame;
this.output(frame);
}
close() {}
}
class FakeEncodedVideoChunk {
constructor(_init: EncodedVideoChunkInit) {}
}
const originalGetContext = HTMLCanvasElement.prototype.getContext;
HTMLCanvasElement.prototype.getContext = function (contextId: string, ...args: unknown[]) {
if (this.id === "frameCanvas" && contextId === "2d") {
return {
drawImage() {
counters.drawn += 1;
},
putImageData() {},
} as unknown as CanvasRenderingContext2D;
}
return originalGetContext.call(this, contextId as "2d", ...args as []) as CanvasRenderingContext2D;
} as typeof HTMLCanvasElement.prototype.getContext;
Object.defineProperty(window, "WebSocket", { value: FakeWebSocket, configurable: true });
Object.defineProperty(window, "VideoDecoder", { value: FakeVideoDecoder, configurable: true });
Object.defineProperty(window, "EncodedVideoChunk", { value: FakeEncodedVideoChunk, configurable: true });
});
await page.goto("/remotedesktop?clientId=canvas-presentation-test");
await page.evaluate(async () => {
const packet = new Uint8Array(18);
packet.set([0x46, 0x52, 0x4d, 2, 0, 240, 5, 0]);
new DataView(packet.buffer).setUint16(8, 1920, true);
new DataView(packet.buffer).setUint16(10, 1080, true);
packet.set([0, 0, 0, 1, 38, 1], 12);
const socket = (window as typeof window & { __rdSocket: EventTarget }).__rdSocket;
for (let i = 0; i < 4; i++) {
socket.dispatchEvent(new MessageEvent("message", { data: packet.buffer.slice(0) }));
await Promise.resolve();
await Promise.resolve();
}
});
await expect.poll(() => page.evaluate(() => (
window as typeof window & {
__rdPresentationCounters: { decoded: number; drawn: number; closed: number };
}
).__rdPresentationCounters)).toEqual({
decoded: 4,
drawn: 1,
closed: 4,
});
await expect(page.locator("#diagDropped")).toHaveText("0 / 3");
});
@@ -219,9 +219,7 @@ test("WebRTC input stays inactive until start and then forwards mouse and keyboa
const { decodeMsgpack } = await import("/assets/msgpack-helpers.js");
return sent.map((message) => decodeMsgpack(message))
.filter((message) => message.type === "desktop_request_keyframe");
})).toEqual([
expect.objectContaining({ type: "desktop_request_keyframe", reason: "viewer_frame_gap" }),
]);
})).toEqual([]);
await page.locator("#rdSettingsBtn").click();
await page.locator("#requestKeyframeBtn").click();
await expect.poll(async () => page.evaluate(async () => {
+4 -1
View File
@@ -378,7 +378,10 @@ OVERLORD_TURN_EXTERNAL_IP=203.0.113.10
Allow and forward these inbound ports to the Coturn host:
- `3478/udp` and `3478/tcp` for STUN and TURN client connections.
- `49160-49200/udp` for TURN relay allocations.
- `49160-49200/udp` for TURN relay allocations with the Linux Compose file.
- `40000-40040/udp` with `docker-compose.windows.yml`, avoiding Windows'
commonly excluded dynamic UDP range. Override it with
`OVERLORD_TURN_MIN_PORT` and `OVERLORD_TURN_MAX_PORT` if necessary.
The bundled setup supports ordinary TURN over UDP and TCP. It intentionally does not enable `turns:` until a trusted Coturn TLS certificate and public hostname are configured.
+5 -2
View File
@@ -99,17 +99,20 @@ services:
ports:
- "3478:3478/udp"
- "3478:3478/tcp"
- "49160-49200:49160-49200/udp"
# Stay below Windows' default dynamic/excluded UDP range (49152+).
- "${OVERLORD_TURN_MIN_PORT:-40000}-${OVERLORD_TURN_MAX_PORT:-40040}:${OVERLORD_TURN_MIN_PORT:-40000}-${OVERLORD_TURN_MAX_PORT:-40040}/udp"
entrypoint: ["/bin/sh", "-ec"]
command:
- |
secret="$$(cat /run/overlord-turn/secret)"
external=""
if [ -n "$${OVERLORD_TURN_EXTERNAL_IP:-}" ]; then external="--external-ip=$${OVERLORD_TURN_EXTERNAL_IP}"; fi
exec turnserver --fingerprint --use-auth-secret --static-auth-secret="$$secret" --realm="$${OVERLORD_TURN_REALM:-overlord}" --listening-port=3478 --min-port=49160 --max-port=49200 --no-tls --no-dtls --no-multicast-peers --log-file=stdout $$external
exec turnserver --fingerprint --use-auth-secret --static-auth-secret="$$secret" --realm="$${OVERLORD_TURN_REALM:-overlord}" --listening-port=3478 --min-port="$${OVERLORD_TURN_MIN_PORT}" --max-port="$${OVERLORD_TURN_MAX_PORT}" --no-tls --no-dtls --no-multicast-peers --log-file=stdout $$external
environment:
OVERLORD_TURN_REALM: ${OVERLORD_TURN_REALM:-overlord}
OVERLORD_TURN_EXTERNAL_IP: ${OVERLORD_TURN_EXTERNAL_IP:-127.0.0.1}
OVERLORD_TURN_MIN_PORT: ${OVERLORD_TURN_MIN_PORT:-40000}
OVERLORD_TURN_MAX_PORT: ${OVERLORD_TURN_MAX_PORT:-40040}
volumes:
- overlord-turn-secret:/run/overlord-turn:ro
depends_on: