enricobuehler
d6596ff81b
windows-drivers / probe-and-proto (push) Successful in 24s
windows-drivers / driver-build (push) Successful in 1m18s
apple / swift (push) Successful in 1m5s
android / android (push) Successful in 4m21s
ci / rust (push) Successful in 5m3s
ci / web (push) Successful in 54s
ci / docs-site (push) Successful in 1m2s
deb / build-publish (push) Successful in 2m48s
windows-host / package (push) Successful in 7m10s
decky / build-publish (push) Successful in 24s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 5s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 6s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 4s
ci / bench (push) Successful in 4m38s
release / apple (push) Successful in 9m1s
windows-msix / package (arm64, C:\Users\Public\ffmpeg-arm64, aarch64-pc-windows-msvc, C:\t-a64) (push) Successful in 1m13s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 51s
windows-msix / package (x64, C:\Users\Public\ffmpeg, x86_64-pc-windows-msvc, C:\t) (push) Successful in 1m10s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 2m42s
windows / build (aarch64-pc-windows-msvc) (push) Successful in 1m0s
windows / build (x86_64-pc-windows-msvc) (push) Successful in 1m0s
apple / screenshots (push) Successful in 5m32s
flatpak / build-publish (push) Successful in 4m59s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 9m7s
docker / deploy-docs (push) Successful in 25s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Successful in 8m49s
Rework the client READMEs to be accurate and inviting to first-time
visitors, and fill in the gaps where crates and tools had none.
- Rewrite clients/{apple,android,decky} READMEs (features-first, trim
dense internal narrative; drop the stale "one session at a time" /
"renegotiation not implemented" section from the Apple README).
- Add READMEs for clients/{linux,windows,probe}, which had none.
- Add crate READMEs for punktfunk-host, punktfunk-core, pf-driver-proto.
- Add brief READMEs for tools/{loss-harness,latency-probe}.
- Fix packaging/README duplicate "Option B" heading (bootc -> Option C).
- Fix docs-site/README stale docs/ -> design/ reference.
- De-stale packaging/windows/drivers/pf-dualsense README (drop "M0 spike"
/ external-checkout framing; reflect in-tree workspace + shipped +
installer-bundled + multi-pad), keeping the driver-authoring lore.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
79 lines
4.2 KiB
Markdown
79 lines
4.2 KiB
Markdown
# punktfunk — Android client (phone & TV)
|
||
|
||
The native **Android** app for streaming a punktfunk host to your phone, tablet, or Android TV. A
|
||
Compose app that finds hosts on your network, pairs with a PIN, and streams at the display's own
|
||
resolution — with hardware HEVC decode, HDR10, and controller support, built for both touch and the
|
||
couch (D-pad / gamepad focus navigation).
|
||
|
||
## Features
|
||
|
||
- **Hardware decode** — NDK `AMediaCodec` HEVC → `SurfaceView`, including **HDR10** (Main10 /
|
||
BT.2020 PQ), with low-latency tuning and a live stats HUD.
|
||
- **Audio both ways** — Opus + Oboe playback with a jitter ring, plus mic uplink to the host.
|
||
- **Controller support** — buttons + axes with rumble and HID feedback (lightbar / adaptive
|
||
triggers); D-pad / gamepad focus navigation for TV and phone.
|
||
- **Find hosts automatically** — native mDNS discovery; first connect does a one-time **SPAKE2 PIN
|
||
pairing** (or TOFU on trusted LANs), then reconnects on a Keystore-wrapped, pinned identity.
|
||
- **Compose UI** — Connect / Settings / Stream screens with Material You theming.
|
||
|
||
Built for `arm64-v8a` + `x86_64`.
|
||
|
||
## Get it
|
||
|
||
Published to **Google Play (Internal Testing)** — join the beta via the
|
||
[Discord](https://discord.gg/kaPNvzMuGU). Per-device setup and pairing:
|
||
**[docs.punktfunk.unom.io/docs/install-client](https://docs.punktfunk.unom.io/docs/install-client)**.
|
||
|
||
## How it's built — Rust-heavy
|
||
|
||
Kotlin can't `import` the cbindgen C header the way Swift can, so a native bridge is unavoidable. We
|
||
write it in **Rust** and link `punktfunk-core` directly — so the Android client reuses the Linux
|
||
client's orchestration (audio jitter ring, VK keymap inverse, latency/skew math, capture state
|
||
machine, trust logic) instead of re-porting it into Kotlin.
|
||
|
||
| Side | Owns |
|
||
|------|------|
|
||
| **Rust** (`native/` → `libpunktfunk_android.so`) | the JNI seam, `NativeClient` (QUIC control + UDP data plane), AnnexB → `AMediaCodec` decode (incl. HDR10), Opus + Oboe audio + mic, controller feedback, latency math, trust/pairing, `mdns-sd` discovery |
|
||
| **Kotlin** (`app/`, `kit/`) | Compose UI, `SurfaceView` lifecycle, input capture, the Wi-Fi `MulticastLock` + permission UX, Keystore identity |
|
||
|
||
The single seam is `io.unom.punktfunk.kit.NativeBridge` ⇄ `Java_io_unom_punktfunk_kit_NativeBridge_*`.
|
||
|
||
```
|
||
native/ Rust cdylib (workspace member) — links punktfunk-core directly
|
||
src/lib.rs JNI seam (connect/pair, input, plane getters, versions)
|
||
src/session.rs session lifecycle + plane pumps
|
||
src/decode.rs AnnexB → AMediaCodec HEVC hardware decode → SurfaceView (incl. HDR10)
|
||
src/audio.rs · src/mic.rs Opus + Oboe playback / mic uplink
|
||
src/feedback.rs · src/stats.rs rumble + HID feedback; live video stats
|
||
app/ :app — Compose UI: Connect / Settings / Stream (phone + TV)
|
||
kit/ :kit — NativeBridge · native mDNS discovery · Gamepad · Keymap · Keystore identity
|
||
```
|
||
|
||
## Build & run
|
||
|
||
**Prerequisites:** Android SDK + **NDK r30** (`30.0.14904198`), `platforms;android-37.0`,
|
||
`build-tools;37.0.0`, **`cmake;3.22.1`** (builds libopus); **JDK 21** (AGP 9.2 runs on JDK 17–21, not
|
||
a newer default); Rust with `rustup target add aarch64-linux-android x86_64-linux-android` and
|
||
`cargo install cargo-ndk`. Toolchain is pinned (AGP 9.2 · Gradle 9.4.1 · Kotlin 2.3.21 · Compose BOM
|
||
2026.05.01 · compileSdk 37 · minSdk 31).
|
||
|
||
**Android Studio:** open `clients/android` — it uses its bundled JBR 21, and the `cargoNdk*` task
|
||
builds the `.so` as part of the normal build.
|
||
|
||
**CLI** (point Gradle at JDK 21 if your machine default is newer):
|
||
|
||
```sh
|
||
export JAVA_HOME="$(/usr/libexec/java_home -v 21)" # or your Temurin 21 path
|
||
cd clients/android
|
||
./gradlew :app:assembleDebug # cargo-ndk cross-compiles libpunktfunk_android.so first
|
||
./gradlew :app:installDebug # onto a running emulator/device
|
||
# emulators from env setup: emulator -avd pf_phone | emulator -avd pf_tv
|
||
```
|
||
|
||
The debug APK lands in `app/build/outputs/apk/debug/`. Launch it, pick a host, pair, and stream.
|
||
|
||
## Related
|
||
|
||
- **[Documentation](https://docs.punktfunk.unom.io)** — quick start, pairing, troubleshooting
|
||
- **[Project README](../../README.md)** — the host, the other clients, and how it all fits together
|