enricobuehler
5c05246098
cargo tree -p punktfunk-client-session finds no ffmpeg. The host still does, which is the whole point: pf-encode keeps libavcodec unconditionally and no host workflow, packaging script or licence file was touched. Deleted: crates/pf-ffvk, video_vulkan.rs, video_vaapi.rs, video_libav.rs, the libavcodec half of video_d3d11.rs, the av_log machinery, ffmpeg::codec::Id as the decoder's vocabulary (the quic CODEC_* wire constants now serve, which is why the evidence table was keyed on them), DecodedImage::VkFrame and ::Dmabuf, the presenter's AVVkFrame lane, and the ffmpeg-fallback feature with everything behind it. DrmFrameGuard collapses from an enum to a newtype, which removes an unsafe impl Send. Roughly 25,000 lines. Then the CI, packaging, licensing and docs work the plan's §6 lists: the Windows workflows lose FFMPEG_DIR, PF_FFVK_VULKAN_INCLUDE and their PATH prepend; the MSIX loses its DLL wildcard; the client .deb stops emitting libav sonames on its own because depends come from dpkg-shlibdeps; arch, flatpak and nix drop the dependency; and the README's "FFmpeg 7 or 8" contract narrows to the host. Three defects reached users' machines in the first cut, and none was in the deletion itself. All three desktop Settings UIs offer vulkan, vaapi and d3d11va as stored decoder values, so those strings sit in shipped settings files today. Refusing them by name — which is the correct rule for a stale pin — would have bricked every upgraded client whose owner ever touched that dropdown. They now migrate onto the native rung for the same hardware family, at decoder construction AND at each dialog's lookup, because a legacy value that matches no preset displays as "Automatic" and silently rewrites the user's preference on the next save. M9's evidence filter was deleted on the argument that with no libavcodec twin below, barring an unproven rung removes hardware decode rather than moving down one rung. That is true on Windows and false on Linux for Intel and every unknown vendor id, where prefer_vulkan_first is false and the order is native-vaapi → native-vk: a rung that has decoded nothing anywhere sitting above one that is 250/250 on three drivers. Every Intel Linux desktop would have moved from libavcodec VAAPI, shipping for years, onto pf-vaadec by default — and a rung that constructs and then produces wrong pixels leaves only by the error-streak demotion, which this codebase already documents as not tripping on the B580's strobing. The filter is restored as a narrow, pure, testable rule: an unproven rung yields to a proven one, and to nothing else. Windows deliberately passes no rung below, because that vendor family is the one with a measured wrong-pixel report against Vulkan decode, and trading no evidence for evidence of corruption is the wrong direction. And the notices still said FFmpeg was bundled. The root file is what both desktop clients include_str! and what the MSIX ships, three lines under the new card saying no FFmpeg is bundled; Apple's Acknowledgements said it too, on iOS, tvOS and macOS. The generator now emits four per-client files scoped by transitive closure — 0 FFmpeg mentions in each, verified — while the root file keeps it for the host. That also ends the standing false attribution of ffmpeg-next, GTK4, windows-rs and the NVENC SDK to an iPhone. Windows has no reachable box, so it was compiled instead: a cross clippy at -D warnings on x86_64 and aarch64-pc-windows-msvc with the C toolchain stubbed so build scripts run without linking. That gate immediately caught an include_str! path one directory too deep, which nothing else could have. Gates: container clippy -D warnings, 160 tests, workspace check, both Windows targets clean, client ffmpeg count 0 and host 2. The four decode crates are untouched, so the hardware rungs' 250/250 stands. ⚠ Owed and unrun: no GPU has executed any of this milestone. M8's on-glass software check, M7's D3D11 and VAAPI AV1 hardware legs, and M9's field bake all still want hardware, and the bake window and criteria remain the user's.
102 lines
6.1 KiB
Markdown
102 lines
6.1 KiB
Markdown
# punktfunk — Linux client
|
|
|
|
The native **Linux** app for streaming a punktfunk host to your desktop, laptop, or Steam Deck.
|
|
It's a clean relm4/GTK4/libadwaita **shell** that finds hosts on your network, pairs with a PIN,
|
|
and manages your settings and library — the stream itself runs in the sibling
|
|
**`punktfunk-session`** Vulkan binary ([`clients/session`](../session/README.md)), which the shell
|
|
spawns, putting the picture on glass at your display's own resolution and refresh rate.
|
|
|
|
Built in Rust end to end (no C ABI): the shell shares its plumbing with the session binary through
|
|
**`crates/pf-client-core`**, which links the **`punktfunk-core`** protocol crate and speaks the fast
|
|
**`punktfunk/1`** protocol — QUIC control plane, GF(2¹⁶) FEC + AES-GCM data plane.
|
|
|
|
## Features
|
|
|
|
- **Zero-copy hardware decode, and it's ours** — the session presenter decodes with Punktfunk's own
|
|
decoders; no FFmpeg is linked or bundled. **Vulkan Video** (`pf-vkdecode`, decoding onto the
|
|
presenter's own device) leads on NVIDIA and AMD, **VAAPI** (`pf-vaadec` driving a dlopen'd libva,
|
|
exporting DRM-PRIME dmabufs) leads on Intel, whichever isn't first is the fallback, and an
|
|
OpenH264/rav1d CPU rung is last.
|
|
- **Your display's native mode** — the host builds a virtual output at exactly your WxH@Hz; no
|
|
scaling, no letterboxing. Steady 60 fps at 1080p60, ~6 ms capture→decoded on the LAN.
|
|
- **Audio both ways** — PipeWire playback with a jitter ring, plus mic uplink to the host.
|
|
- **Full controller support** — SDL3 gamepads with rumble and DualSense fidelity (lightbar, player
|
|
LEDs, touchpad, motion, adaptive-trigger replay). Click-to-capture keyboard and mouse, with a
|
|
release chord (Ctrl+Alt+Shift+Q) and focus-loss release.
|
|
- **Find hosts automatically** — mDNS discovery lists hosts on your LAN; saved hosts persist.
|
|
First connect does a one-time **SPAKE2 PIN pairing** (or TOFU on trusted LANs), then reconnects on
|
|
a pinned identity.
|
|
- **Per-host speed test** to pick a bitrate, plus compositor and mode preferences in Settings.
|
|
- **Game library browser** *(experimental, off by default)* — "Browse library…" on a saved host
|
|
shows its games (Steam + custom) as a poster grid; click one to launch it in the session.
|
|
Fetched from the host's management API over mTLS — paired devices are authorized by their
|
|
certificate, no extra host setup.
|
|
- **Gamepad library launcher** (`--browse host`) — a console-style, controller-driven library view
|
|
of a paired host's games, rendered by the session binary's Skia console UI: A plays the focused
|
|
title, B quits, L1/R1 jump. Built for the Steam Deck plugin's "Open library" launch; session end
|
|
returns to the launcher. Arrow keys/Enter/Esc drive it too (no pad needed).
|
|
|
|
## Get it
|
|
|
|
Most people should install a package rather than build from source:
|
|
|
|
| Distro | Install |
|
|
|--------|---------|
|
|
| **Flatpak** (any distro, Steam Deck) | `io.unom.Punktfunk` — see [`packaging/flatpak`](../../packaging/flatpak/README.md) |
|
|
| **Ubuntu / Debian** (apt) | `sudo apt install punktfunk-client` *(after adding the repo)* |
|
|
| **Fedora / Bazzite** (rpm) | `rpm-ostree install punktfunk-client` |
|
|
| **Arch** (PKGBUILD) | see [`packaging/arch`](../../packaging/arch/README.md) |
|
|
|
|
Per-device install steps and pairing walkthrough:
|
|
**[docs.punktfunk.unom.io/docs/install-client](https://docs.punktfunk.unom.io/docs/install-client)**.
|
|
|
|
## Build & run from source
|
|
|
|
Requires GTK ≥ 4.16, libadwaita ≥ 1.5, PipeWire, and SDL3 (with hidapi) development packages,
|
|
plus a C compiler (the CPU rung builds OpenH264 from source). No *decoder* development package
|
|
is needed: libva and the Vulkan loader are both opened at runtime rather than linked, so
|
|
hardware decode is a fact about the box you **run** on — a Vulkan loader and your GPU's driver,
|
|
and libva for the VAAPI rung — not about the one you build on.
|
|
|
|
```sh
|
|
# from the repo root
|
|
cargo run -p punktfunk-client-linux # launch the app
|
|
cargo run -p punktfunk-client-linux -- --connect HOST[:PORT] # skip the host list and connect
|
|
cargo run -p punktfunk-client-linux -- --browse HOST # the gamepad library launcher
|
|
```
|
|
|
|
The binary is named **`punktfunk-client`** — the relm4/libadwaita desktop shell (hosts,
|
|
pairing/trust, settings, the desktop library page). Every stream and the console game
|
|
library run in the sibling **`punktfunk-session`** Vulkan binary; the shell spawns it
|
|
for connects, and `--connect`/`--browse` on the shell exec it directly (so the Decky
|
|
wrapper keeps working unchanged). Headless flags stay in the shell:
|
|
`--pair <PIN> --connect host[:port]` (pairing ceremony), `--wake host[:port]`, and
|
|
`--library host[:mgmt_port]` (print a host's game library).
|
|
|
|
## Layout
|
|
|
|
```
|
|
src/
|
|
main.rs · app.rs entry point, relm4 AppModel (window, trust gate, session child
|
|
lifecycle, typed messages), primary menu, CSS
|
|
cli.rs headless paths (--pair/--wake/--library), the --connect/--browse
|
|
exec handoff to punktfunk-session, screenshot scenes
|
|
ui_hosts.rs hosts page component (FactoryVecDeque cards, saved + discovered
|
|
grids, add-host dialog, banner)
|
|
ui_library.rs game-library poster grid (per-host, launches titles)
|
|
ui_trust.rs TOFU / PIN-pairing / request-access dialogs
|
|
ui_settings.rs resolution · refresh · decoder · bitrate · compositor · mic
|
|
spawn.rs the session-child plumbing (stdout contract → AppMsg)
|
|
tools/screenshots.sh store screenshot capture (app self-capture; Xvfb fallback)
|
|
```
|
|
|
|
The UI-agnostic plumbing — session pump, the native decode ladder (Vulkan Video · VAAPI ·
|
|
OpenH264/rav1d), PipeWire audio, SDL3 gamepads + keymap, trust store, mDNS discovery, library
|
|
client, Wake-on-LAN — lives in `crates/pf-client-core`, shared with the Vulkan session binary.
|
|
|
|
## Related
|
|
|
|
- **[Documentation](https://docs.punktfunk.unom.io)** — quick start, pairing, troubleshooting
|
|
- **[Steam Deck plugin](../decky/README.md)** — launches this client fullscreen in Gaming Mode
|
|
- **[Project README](../../README.md)** — the host, the other clients, and how it all fits together
|