Add pixelpass --doctor environment diagnostic
Screen-share failures are usually environment gaps, not pixelpass bugs — most often a GPU/driver with no working VA-API H.264 encoder, so the default vah264enc pipeline produces no video and the viewer "can't connect." doctor probes the whole chain and prints one actionable report so a remote tester can read it over a call instead of us guessing from logs, and it validates any X11/Wayland test environment we stand up. Checks (each a ✓/!/✗ line with a distro-aware install hint): - display server (Wayland/X11 + session env), and the X server vendor/ version so an xlibre server is distinguishable from stock Xorg - capture: gst tools + the backend's source element (pipewiresrc/ximagesrc) - encode: hardware H.264 (vah264enc + DRM render node + a VA-API H.264 *encode* entrypoint parsed from vainfo) and the software x264 fallback - mux/audio tail + pactl - viewer player (mpv/vlc) - network: binds a real endpoint and checks relay reachability Unlike deps::check_host_binaries (bails on first miss), doctor runs every check and reports them together. Closes with a specific hosting verdict and exits non-zero on any hard failure so scripts/CI can gate. Pure seams (vainfo entrypoint parse, summary tally, hosting verdict) are unit-tested; deps.rs gained pub(crate) which/gst_element_exists/install-hint/distro helpers so doctor reuses the same package-name knowledge. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -23,6 +23,8 @@ Working:
|
||||
- Audio capture of the default sink's monitor, with optional per-app
|
||||
routing (`--app <name>`)
|
||||
- `--repair` cleanup of orphaned PipeWire state left by a crashed host
|
||||
- `--doctor` environment diagnostic (capture/encode deps, VA-API H.264,
|
||||
viewer player, relay reachability) — see [Diagnostics](#diagnostics)
|
||||
- iroh QUIC bi-stream tunnel, direct-UDP and relay paths both verified
|
||||
- Interactive Host/View menu with clipboard auto-copy and mpv/VLC picker
|
||||
- Headless mode for scripts (`pixelpass <ticket>`)
|
||||
@@ -135,6 +137,35 @@ sudo pacman -S vlc vlc-plugin-dvb vlc-plugin-ffmpeg
|
||||
If the viewer is running on battery, set the CPU governor to performance
|
||||
or balanced — power-saver can choke even hardware-decoded 1080p H.264.
|
||||
|
||||
## Diagnostics
|
||||
|
||||
`pixelpass --doctor` prints a one-shot report of everything the above
|
||||
requirements cover and exits — run it on any machine before a real session:
|
||||
|
||||
```sh
|
||||
pixelpass --doctor
|
||||
```
|
||||
|
||||
It checks, and prints a `✓ / ! / ✗` line for each:
|
||||
|
||||
- **display server** — Wayland vs. X11 (autodetected), the raw session env
|
||||
vars, and the X server's vendor/version (so an xlibre server is visible)
|
||||
- **capture** — the GStreamer tools plus the source element for your backend
|
||||
(`pipewiresrc` on Wayland, `ximagesrc` on X11)
|
||||
- **encode** — whether hardware H.264 works (the `vah264enc` plugin, a DRM
|
||||
render node, and a VA-API H.264 *encode* entrypoint via `vainfo`), and
|
||||
whether the software `x264enc` fallback is available. This is the usual
|
||||
culprit when a viewer "can't connect": a GPU with no H.264 encode entrypoint
|
||||
produces no video under the default encoder — the report tells you to host
|
||||
with `--no-hwencode`
|
||||
- **mux / audio** — the TS mux + AAC + PulseAudio tail, and `pactl`
|
||||
- **viewer** — whether `mpv` or `vlc` is installed
|
||||
- **network** — binds a real endpoint and checks a relay is reachable
|
||||
|
||||
Each failing line includes a distro-aware install hint, and the closing summary
|
||||
says whether the machine can host and how. The exit code is non-zero if any
|
||||
hard requirement is missing, so it can gate a script or CI.
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
|
||||
Reference in New Issue
Block a user