forked from unom/punktfunk
enricobuehler
2718b7d4bd
One commit because splitting them accomplishes nothing: mdns-sd 0.20 ALREADY
depends on if-addrs 0.15, so while our own five crates declared 0.13 the tree
carried both copies no matter which of the two moved first. Moving them together
is what collapses it:
$ cargo tree -d | grep '^if-addrs'
(no output)
Neither needed a source change. mdns-sd 0.21's public API is purely additive
over 0.20.3 — the sole new item is `ServiceDaemon::set_max_packet_size`, and
`ServiceInfo`'s surface is byte-identical — so `ServiceDaemon`/`ServiceInfo`/
`ServiceEvent`/`ResolvedService` behave as before at all six call sites
(host discovery + gamestream mdns, pf-client-core, and the Android, Windows and
probe clients). if-addrs 0.15 keeps 0.13's `Interface`/`IfAddr` shape, and we
only ever read those.
The one real change is a FEATURE, not a version. if-addrs has `link-local`, and
mdns-sd declares if-addrs with it on. Once our crates share that single copy,
unification turns it on for our calls too — meaning `get_if_addrs()` now also
reports fe80:: interfaces (and, on Windows, 169.254.x.x). Rather than inherit
that silently, punktfunk-core and punktfunk-host now NAME the feature. Two
reasons: it is what every real build gets anyway, so a standalone `cargo test -p
punktfunk-core` should not enumerate a different set of NICs than the host does;
and for the consumer here — Wake-on-LAN — it is the behaviour we want, since a
NIC is wake-capable whether or not it currently holds a routable address.
Verified on CachyOS (rustc 1.96.0):
cargo clippy --workspace --all-targets --locked -- -D warnings OK
cargo test --workspace --locked OK, 0 failed
cargo test -p punktfunk-host --bins --locked 501 passed, 0 failed, 2 ignored
cargo test ... gamestream::cert 3 passed
cargo fmt --all --check clean
(One `cargo test --workspace` attempt failed with E0463 "can't find crate for
pf_frame" in a doc-test. That is the target dir having only clippy's .rmeta for
a crate a doc-test wants to LINK, not anything in this change; a plain re-run
after cargo test built the rlibs was green.)
punktfunk — probe (reference client)
punktfunk-probe is the headless reference client for the punktfunk/1 protocol — a
command-line tool for testing, latency measurement, and validating host behavior. It's not a
streaming app you'd watch on; it connects, exercises a plane, and reports numbers. If you want to
actually stream, use the Linux, Windows,
Apple, or Android clients.
Because it links the same punktfunk-core as every other client, it's also the canonical
example of driving the protocol end to end: QUIC control plane, UDP data plane, and the side planes
(input, audio, rumble) over QUIC datagrams.
What it does
- Receives a real stream, writes a playable elementary stream (
.h265/.h264/.av1— the extension tracks the negotiated codec; the probe advertises all three and the host picks), and reports per-frame capture→received latency percentiles (the host stamps each frame with its capture clock). - Verification mode against a synthetic host — byte-checks deterministic test frames.
- Exercises every plane with scripted test traffic:
--input-test(mouse/keyboard),--mic-test(a 440 Hz Opus tone up to the host mic),--touch-test(a synthetic finger),--rich-input-test(DualSense touchpad + motion, logging the HID-output feedback that comes back). - Trust —
--pin <64-hex>pins the host fingerprint;--pair <PIN>runs the SPAKE2 pairing ceremony and prints the verified fingerprint to pin from then on. Without a pin it trusts on first use. - Discovery —
--discover [secs]browses the LAN for_punktfunk._udphosts and prints each (name, addr:port, pairing requirement, cert fingerprint), then exits. - Negotiation knobs —
--mode WxHxFPS,--remode(mid-stream mode change),--bitrate,--codec auto|h264|hevc|av1(preference; the host resolves),--audio-channels(stereo / 5.1 / 7.1),--compositor,--gamepad,--launch,--speed-test. Env:PUNKTFUNK_CLIENT_10BIT=1/PUNKTFUNK_CLIENT_444=1advertise the 10-bit / 4:4:4 client caps (for testing a host'sPUNKTFUNK_10BIT/PUNKTFUNK_444).
Usage
# stream 720p120 from a host, save the video, and print latency percentiles:
cargo run -p punktfunk-probe -- --mode 1280x720x120 --connect HOST:PORT --out /tmp/a.h265
# list hosts on the LAN:
cargo run -p punktfunk-probe -- --discover
# pair with a host that requires it (read the PIN off the host), then stream:
cargo run -p punktfunk-probe -- --connect HOST:PORT --pair 1234
cargo run -p punktfunk-probe -- --connect HOST:PORT --pin <64-hex> --input-test
Full flag reference is in the module doc-comment at the top of src/main.rs.
Related
- Project README — the host, the streaming clients, and the protocol
punktfunk-host punktfunk1-host— the persistent native-protocol listener to probe against (see the "Running on this box" section of the repo README /CLAUDE.md)