enricobuehlerandClaude Opus 5 e38e3c44c9 feat(client/present): V-Sync and VRR become real settings, and VRR is measured
WP3 of design/desktop-presentation-rebuild.md. The `vsync` and `allow_vrr`
settings have existed since WP1 but nothing consumed them — the swapchain picked
MAILBOX-or-FIFO once, from an env var, and froze. This makes them mean
something, which is also what unblocks their settings rows (deliberately
withheld from WP5 rather than shipped as dead switches).

Present-mode selection is now a preference ladder, not a constant:

* V-Sync off — IMMEDIATE, then FIFO_RELAXED, then the tear-free modes. Asking
  to tear and silently getting vsync is a lie, so the mode that actually took is
  named in the stats line and a refused preference is logged requested-vs-active.
* V-Sync on + VRR allowed + fullscreen — FIFO first. On a variable-refresh panel
  with direct scanout the FIFO present IS the flip, so the panel follows the
  stream's cadence instead of a fixed grid; MAILBOX would decouple presents from
  scanout and re-quantize to the compositor's clock. This is only safe because
  WP2's glass gate bounds the standing queue that historically made FIFO costly.
* Otherwise — MAILBOX then FIFO, the shipped default, unchanged.

`PUNKTFUNK_PRESENT_MODE` still pins a mode outright and now falls back to the
settings (rather than to mailbox) when the name is unknown.

VRR detection is MEASURED, never queried. No portable query exists — SDL exposes
none, Wayland does not report adaptive-sync state, Windows surfaces nothing
through Vulkan — and the platforms that do answer have been caught lying (see
the Android per-uid refresh-rate finding). The discriminator is quantization: on
a fixed-refresh panel every on-glass instant lands on the vblank grid, so the
spacing between presents is ~k×period for whole k even when the stream runs
slower than the panel (it just picks a larger k); under real VRR the panel
refreshes when we present, so the spacing follows our own cadence and sits off
the grid. `CadenceProbe` folds each delta to its distance from the nearest
multiple of the learned period and takes the median. Tri-state: it stays Unknown
below 24 deltas and after a display change, so `vrr` is reported only when it
has been measured — never inferred from what the display claims.

Also fixes the read-once refresh rate: `native.refresh_hz` was sampled at
startup and never revisited, so dragging the window to another monitor left a
60 Hz-seeded clock pacing a 144 Hz panel. `WindowEvent::DisplayChanged` now
relearns the latch grid, resets the cadence verdict, and clears the served-slot
latch.

Settings rows for both, on all three surfaces (GTK, WinUI, console). The
console's V-Sync row is reachable in Gaming Mode, which is the only editor a
Deck user has.

Gates: punktfunk-rust-ci linux/amd64 — fmt, clippy -D warnings over
pf-client-core, pf-presenter, pf-console-ui, the session binary and the GTK
client, 160 tests (the two new ones cover every ladder and both cadence
regimes, including the case that matters most: a stream slower than a FIXED
panel must still read as fixed). WinUI leg on the Windows runner .133:
clippy=0 tests=0, against a tree proven by content to contain the edit.

⚠ On-glass validation is still owed and is NOT claimed here: every box with a
real display was powered off when this landed, so the VRR ladder and the
detector have been exercised only against synthetic stamps in unit tests.

Rebase follow-up: `20de58a7` landed the same "panel grid can be wrong in both
directions" defect fix on Android and extracted the corrected learner into
`punktfunk_core::phase::PanelGrid` for the iOS and desktop presenters to share.
This clock had the identical bug — it capped the learned period at the display
mode's refresh, and the mode is only a CLAIM, so a display really running slower
than it advertises pinned a grid whose instants never arrive, for the session,
with no way back. Adopted the shared learner rather than carrying a second,
buggier copy; still fed the window's MIN spacing, which preserves the k×period
resistance the cap was actually aimed at while the streak requirement lets a
genuinely slower panel be discovered. New test: seed 120 Hz, real panel 60 Hz,
the clock must climb back out.

Took the same commit's third lesson too: the adaptive margin widened on a
latch over 1.5×period (a number picked here), and now widens on the latch
exceeding one period plus the lead already applied — the slot actually aimed at.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-03 00:01:56 +02:00
2026-06-19 15:49:48 +02:00

Punktfunk

Low-latency desktop and game streaming with first-class Linux and Windows hosts.

Run the host on a Linux machine or a Windows PC, connect from a Mac, PC, phone, tablet, or TV, and stream your desktop or games — each device at its own native resolution and refresh rate, over your local network.

📖 Documentation: docs.punktfunk.unom.io — start with How It Works or the Quick Start.

💬 Community: Discord — chat, support, and Android beta access · r/Punktfunk.

🔒 Security: found a vulnerability? Report it privately to security@punktfunk.com — see SECURITY.md. Please don't open a public issue.

Punktfunk pairs a virtual-display streaming host with native clients on every platform. It speaks the existing GameStream protocol, so any Moonlight client works day one — and adds its own faster punktfunk/1 protocol that breaks the ~1 Gbps FEC wall with a GF(2¹⁶) Leopard-RS transport. A single shared Rust core (punktfunk-core) holds the protocol, FEC, and crypto, linked into the host and every native client — directly as a Rust crate on Linux and Windows, and over a stable C ABI from the Apple and Android apps.

What makes it different

  • Your device's exact mode. For each client that connects, the host spins up a virtual display sized to that device — 1080p60 to a laptop, 1440p120 to a desktop, 4K to a TV, all at once. No letterboxing, no scaling, no rearranging your real monitors.
  • Displays you configure, not just create. Keep a game's display (and the game) alive across disconnects so a reconnect drops straight back in; make the stream your sole desktop or extend alongside your monitors; let several devices become monitors of one desktop; keep each client's scaling. One-click presets in the console — a dedicated couch box, a shared desktop, a multi-monitor workstation. See Virtual displays.
  • A real virtual display on Windows, too. On Linux the host uses per-compositor virtual outputs; on Windows you get the same on-the-fly virtual display — at the client's exact mode, no physical monitor or dummy HDMI plug, even on the secure desktop (UAC / lock screen). It also has its own indirect display driver (IDD) the host pushes finished frames straight into, rather than scraping a screen — tight, push-based integration that's unusual for a Windows streaming host.
  • Low latency, GPU end to end. Frames go straight from the compositor to the NVENC encoder with zero CPU copies (dmabuf → CUDA/Vulkan → NVENC), over a transport tuned for responsiveness rather than throughput. Stable 240 fps at 5120×1440; sub-millisecond capture-to-reassembly on-box, ~1.3 ms cross-machine on a LAN. (On Linux AMD/Intel, Vulkan Video for HEVC and AV1 with VAAPI for H.264 and as the fallback; a GPU-less software H.264 encoder exists as a last resort.)
  • A library that fills itself. Steam and non-Steam titles show up as a grid on every client, and plugins add their own sources — ROM Manager (your ROM collection, matched to installed emulators), Playnite, VirtualHere. Install them from the console's Plugins page or with punktfunk-host plugins add. See Plugins.
  • Works with what you already have. Any Moonlight/Artemis client connects over GameStream — and native apps for macOS, Linux, Windows, and Android use the lower-latency punktfunk/1 protocol.
  • Secure by default. Hosts require a one-time SPAKE2 PIN pairing; after that, devices reconnect on a pinned identity. No accounts, no cloud. Hosts auto-advertise over mDNS, so clients find them on the network without typing an IP.

Status

Component State
Corepunktfunk-core + C ABI (protocol · FEC · crypto · QUIC) Complete & hardened
GameStream host → stock Moonlight Live end-to-end: pairing, RTSP, audio, per-client virtual output at native resolution, GPU zero-copy NVENC, gamepads
Native protocolpunktfunk/1 Validated live: QUIC control + GF(2¹⁶) FEC/AES-GCM data plane, PIN pairing, mDNS discovery, mid-stream mode renegotiation
Windows host (Windows 11 22H2+, x64) Beta — shipping as a signed installer: its own all-Rust IddCx virtual display (secure-desktop capable) with a sealed IDD-push capture path — finished frames pushed straight into its own driver, not screen-scraped (no DDA/WGC) · GPU encode (NVENC on NVIDIA, AMF/QSV on AMD/Intel, software H.264 without a GPU) · WASAPI audio · bundled virtual-gamepad drivers (no ViGEmBus) · HDR incl. Vulkan-game HDR. NVIDIA live-validated; AMD/Intel CI-green
macOS / iOS / tvOS client (clients/apple) Streaming live: VideoToolbox decode (HEVC, and AV1 on hardware that decodes it), controllers incl. DualSense, discovery, pairing, speed test
Linux client (clients/linux + clients/session) Streaming live: relm4/GTK4 launcher shell that spawns a Vulkan session binary — Vulkan Video / VAAPI / software decode, PipeWire audio, SDL3 controllers, Skia console UI; ships as Flatpak/apt/rpm/Arch
Android client (clients/android, phone + TV) Streaming live: AMediaCodec decode + HDR10, AAudio audio, controllers, discovery, pairing
Windows client (clients/windows, WinUI 3) Streaming live: WinUI 3 shell + Vulkan session presenter, hardware decode on all GPU vendors via Vulkan Video → D3D11VA → software (NVIDIA + Intel validated on glass), WASAPI audio, SDL3 controllers, discovery, pairing; ships as signed MSIX (x64 + ARM64). Hardware decode and HDR10 present validated on glass on NVIDIA and Intel, including HDR pass-through on the Intel D3D11VA path
Web console + management API (web/) TanStack console over the OpenAPI mgmt API: host status, paired devices, on-demand PIN pairing, game library, virtual-display presets, plugin store, GPU selection, performance capture graphs, live host logs, host updates

Every native client also ships a tiered stats overlay (Compact / Normal / Detailed) with a shared vocabulary across platforms, and the session client carries a full gamepad-driven console shell (pf-console-ui): host list, PIN pairing, settings, and an on-screen keyboard.

The GameStream host works with a stock Moonlight client — validated live on NVIDIA hardware (RTX 5070 Ti, RTX 4090): PIN pairing that persists across restarts, an app catalog, RTSP/ENet/audio, and video at the client's exact resolution and refresh via a per-session virtual output (KWin, gamescope, Mutter, and Sway/wlroots backends), encoded with GPU zero-copy (dmabuf → CUDA/Vulkan → NVENC) up to 5120×1440@240. The native punktfunk/1 protocol adds a QUIC control plane and a GF(2¹⁶) Leopard-FEC + AES-GCM data plane (p50 ~0.8 ms capture→received at 720p120), with mid-stream mode renegotiation and a wall-clock skew handshake so latency stays valid across machines. Both run from one process: bare punktfunk-host serve is the secure native-only default (punktfunk/1 + the management API/web console), and serve --gamestream additionally enables the GameStream/Moonlight-compat planes (opt-in, trusted-LAN only — GameStream has inherent on-path weaknesses). The host is managed through a REST API and web console. Builds against FFmpeg 7 or 8.

What works where: the support matrix · where it's heading: the roadmap.

Install the host

Pick your platform and install from its package registry — the per-platform guide covers adding the repo, first run, and the web console. The Linux host is the primary, most battle-tested path; on SteamOS the host is built on-device by a script instead, and a Windows host ships as a signed installer (all-vendor: NVIDIA, AMD, Intel).

Platform Install Guide
Ubuntu / Debian (apt) sudo apt install punktfunk-host (after adding the repo) Ubuntu / Debian · packaging/debian
Bazzite / Fedora Atomic (systemd-sysext) curl -fsSLO https://git.unom.io/unom/punktfunk/raw/branch/main/packaging/bazzite/punktfunk-sysext.sh && sudo bash punktfunk-sysext.sh install (no layering, no reboot; rpm-ostree + bootc also supported) Bazzite
Fedora (dnf) sudo dnf install punktfunk (after adding the repo; the console comes with it) Fedora · packaging/rpm
Arch / CachyOS (pacman) sudo pacman -Syu punktfunk-host (binary repo — always a full -Syu) Arch Linux · packaging/arch
SteamOS / Steam Deck (on-device build) bash ~/punktfunk/scripts/steamdeck/install.sh (after cloning this repo to ~/punktfunk) SteamOS (Host)
Windows (11 22H2+, x64) winget install unom.PunktfunkHost (after winget source add -n punktfunk https://winget.punktfunk.unom.io -t Microsoft.Rest) · or the signed setup.exe from the package registry Windows Host · packaging/winget

punktfunk-host is the streaming host; punktfunk-web is the browser console (pairing + status).

Linux: every package ships systemd user units, so you don't launch the host by hand. The host unit won't start until ~/.config/punktfunk/host.env exists, so copy the template your package installed first:

mkdir -p ~/.config/punktfunk
# /usr/share/punktfunk/ on Fedora/Arch/Bazzite, /usr/share/punktfunk-host/ on Debian/Ubuntu
# (on Bazzite take host.env.bazzite instead)
cp /usr/share/punktfunk/host.env.example ~/.config/punktfunk/host.env

systemctl --user enable --now punktfunk-host   # the streaming host
systemctl --user enable --now punktfunk-web    # the web console (Arch: install punktfunk-web first)

The shipped host unit runs serve --gamestream — the native punktfunk/1 plane plus the GameStream/Moonlight-compat planes, which belong on a trusted LAN only; for a native-only host drop the flag with a systemctl --user edit punktfunk-host drop-in (which needs an empty ExecStart= line before the replacement — the install guide has the snippet). Then open https://<host-ip>:47992 and pair.

How the virtual display and input are wired up depends on your desktop — see KDE · GNOME · Steam / gamescope · Sway.

Windows: the installer registers and starts the host as a LocalSystem service, so there is nothing to run by hand — open the web console and pair. Use punktfunk-host service start|stop|restart|status if you need to control it. Upgrades happen in place — the console's Updates card, winget upgrade unom.PunktfunkHost, or the newer setup.exe over the old install; uninstall from Add/Remove Programs.

Full instructions: docs.punktfunk.unom.io/docs/install.

The console's Host page also shows when a newer host is out, along with the exact command for how this box was installed (or a one-click Update now on Windows) — see Updating the host. To remove it again, or to go back to an earlier version, see Uninstalling and Release Channels.

Connect a client

Streaming to… Use
Mac, iPhone, iPad, Apple TV The Apple app (clients/apple) — also on TestFlight
Linux desktop / laptop punktfunk-client (Flatpak / apt / rpm / Arch)
Steam Deck The Decky plugin in Gaming Mode — it launches the client for you (Steam Deck); in Desktop Mode, the Flatpak directly
Android phone or TV The Android app (clients/android)
Windows Native punktfunk-client (signed MSIX) or Moonlight
Scripts, automation, another launcher punktfunk — the headless CLI shipped in the Linux client packages (punktfunk pair, punktfunk hosts list --json, punktfunk launch <host>)
Anything else (browser, old phone, smart TV) Moonlight over GameStream

Each client discovers hosts on the network automatically and does a one-time PIN pairing. Per-device install steps: /docs/install-client.

Build & test (from source)

For development, or as an install fallback where no package is available:

cargo build --workspace          # core, host, tray, shared client crates, Linux shell + session client, the `punktfunk` CLI, probe (Linux & macOS)
cargo test  --workspace          # unit + loopback + proptest + C ABI harness
cargo clippy --workspace --all-targets -- -D warnings
cargo fmt --all --check

cargo run -p loss-harness        # FEC loss-resilience sweep (no network needed)
bash crates/punktfunk-core/tests/c/run.sh   # standalone C-ABI link + round-trip proof

The C header regenerates from crates/punktfunk-core/src/abi.rs on every build (cbindgen via build.rs) into include/punktfunk_core.h. The Apple, Android, and Windows clients have their own toolchains (Xcode/swift build, Gradle, and cargo on the MSVC target) — see each client's README and the docs site.

Layout

crates/
  punktfunk-core/   protocol · FEC · pacing · crypto · QUIC control plane — the C ABI (lib + cdylib + staticlib)
  punktfunk-host/   the host (Linux + Windows): virtual displays · capture · encode · input · GameStream · punktfunk/1 · mgmt
  pf-client-core/   shared client plumbing (Linux + Windows): session pump · FFmpeg decode · audio · SDL3 gamepads · trust · discovery
  pf-presenter/     Vulkan session presenter: SDL3 window · ash swapchain · frame present · input capture
  pf-console-ui/    Skia console UI for the session client: gamepad shell · stats OSD · pairing · on-screen keyboard
  pf-ffvk/          FFmpeg Vulkan hwcontext bindings (AVVkFrame) for Vulkan Video decode on the presenter's device
  pf-driver-proto/  host ↔ pf-vdisplay driver contract: control IOCTLs + IDD-push frame transport (no_std)
  punktfunk-tray/   host tray icon (Windows notification area / Linux StatusNotifierItem)
clients/
  apple/    macOS / iOS / tvOS app (Swift · VideoToolbox · Metal · GameController)
  linux/    Linux launcher shell (Rust · relm4 / GTK4 / libadwaita) — spawns the session client to stream
  session/  punktfunk-session, the Vulkan streaming session (Rust · SDL3 · ash · Skia console UI) — also runs standalone (gamescope, Decky)
  windows/  Windows desktop app (Rust · WinUI 3 · D3D11 · WASAPI · SDL3)
  android/  Android phone + TV app (Kotlin · Rust JNI core · AMediaCodec · AAudio)
  cli/      punktfunk, the headless client CLI — pair · hosts · wake · library · launch · punktfunk:// links
  probe/    headless reference / measurement client for punktfunk/1
  decky/    Steam Deck Decky plugin
web/                         web console (TanStack) over the management API — status · devices · pairing · library · displays · plugins · GPUs · performance · logs · updates
api/openapi.json             management-API OpenAPI spec (regenerated via `punktfunk-host openapi`, checked in)
sdk/                         `@punktfunk/host` — TypeScript management-API client + event stream (Effect)
plugin-kit/                  `@punktfunk/plugin-kit` — the plugin authoring kit (bun / TypeScript)
packaging/                   apt · rpm / COPR · Arch · Flatpak · Bazzite sysext + bootc · Windows installer + drivers · winget · Nix · gamescope
docs-site/                   public documentation site (Fumadocs) — https://docs.punktfunk.unom.io
include/punktfunk_core.h     cbindgen-generated C header (checked in)
tools/                       latency-probe · loss-harness (measurement)
ci/                          CI container images (rust-ci · fedora-rpm)

Design invariants

  • One core, linked everywhere. Protocol, FEC, and crypto live in punktfunk-core exactly once, exposed over a stable, versioned C ABI (punktfunk_abi_version(), PunktfunkConfig carries its own struct_size). Every native client links the same core.
  • No async on the hot path. The per-frame pipeline uses native threads only; tokio/quinn are gated behind the off-by-default quic feature (control plane only).
  • Native client resolution, no scaling. Each session gets a virtual output at exactly the client's WxH@Hz; each compositor keeps its own backend behind a shared VirtualDisplay trait.
  • FEC is the wall-breaker. GF(2⁸) (≤255 shards/block) for Moonlight compatibility; GF(2¹⁶) (≤65535 shards/block, SIMD, O(n log n)) for punktfunk/1 to push past ~1 Gbps.

License

Licensed under either of

at your option — SPDX-License-Identifier: MIT OR Apache-2.0.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. See CONTRIBUTING.md.

Third-party components

Punktfunk's own source is MIT/Apache-2.0. Shipped binaries additionally link third-party components under their own (permissive) licenses — see THIRD-PARTY-NOTICES.txt (regenerate with scripts/gen-third-party-notices.sh). The Windows host and client builds also bundle FFmpeg under the LGPL v2.1+ (dynamically linked, replaceable DLLs; the license text and notice ship in the installed licenses/ folder).

Trademarks

Punktfunk is an independent project and is not affiliated with, endorsed by, or sponsored by NVIDIA, Microsoft, Sony, Valve, or the Moonlight project. "GameStream", "Moonlight", "Xbox", "DualSense", "DualShock", and "PlayStation" are trademarks of their respective owners and are used here only to describe interoperability.

S
Description
next gen game streaming - built using rust, back compatible with game stream clients, and supporting virtual displays for kde/kwin, gnome and gamescope.
Readme
25 MiB
Languages
Rust 71%
Swift 11%
TypeScript 5.8%
Kotlin 4.1%
Nix 2.4%
Other 5.5%