T

dailz ed39d3d873 ci: add build/test/clippy gate + cargo audit; pin rust-version

Oracle P2 plan step 1+2+missed-fields. Locks in the audit cleanup so
future PRs can't regress the 0-errors / deny-unsafe / 79-tests baseline.

  - .github/workflows/ci.yml: two jobs on ubuntu-latest (Linux only —
    project is Wayland/VAAPI-specific, no macOS/Windows story).
      * build-test: installs ffmpeg + libavcodec/libavformat/libavutil/
        libswscale/libva dev + libwayland + libdrm + libpipewire-0.3-dev
        + libclang-dev/llvm-14 (LIBCLANG_PATH pinned); caches cargo +
        target; runs clippy -> build --release -> test --release.
        Release build before tests is mandatory because
        tests/integration_test.rs shells out to target/release/wl-webrtc.
      * audit: installs cargo-audit and runs 'cargo audit --deny warnings'
        as a separate job so a RUSTSEC advisory fails the build
        independently of compile state.
    No -D warnings on clippy yet — undocumented_unsafe_blocks is already
    deny via Cargo.toml; remaining warnings are advisory and can be
    tightened later.

  - Cargo.toml: pin rust-version = '1.70' to match README's claim.
    Without this, cargo builds silently on older toolchains and surfaces
    errors as cryptic parse failures instead of a clean version-mismatch
    message. Oracle flagged this as a missing field during P2 review.

License field intentionally omitted — repo has no LICENSE file and no
publication plan yet. Add when publication becomes a goal.

Verified locally: YAML parses, cargo build --release Finished in 9.82s,
cargo test --release 79 passed, cargo clippy 0 errors.

2026-06-28 14:31:42 +08:00

.github/workflows

ci: add build/test/clippy gate + cargo audit; pin rust-version

2026-06-28 14:31:42 +08:00

.sisyphus/evidence

chore: add .sisyphus/ to .gitignore, remove committed BUGS.md

2026-05-25 08:56:21 +08:00

docs/superpowers

fix: resolve 4 audit bugs (PTS, WlOutput, first_frame, DRM minor)

2026-04-06 16:25:02 +08:00

examples

fix(backend_detect): use raw zbus for portal check to avoid OnceLock connection poisoning

2026-05-27 22:07:11 +08:00

scripts

fix(state_portal): make shutdown() idempotent to prevent duplicate log lines (#22 )

2026-06-20 18:45:53 +08:00

src

feat(stats): wire real scale/transfer/encode timing from EncState

2026-06-28 14:22:45 +08:00

tests

feat: add KWin/KDE Plasma screen capture via xdg-desktop-portal ScreenCast + PipeWire

2026-05-11 08:49:08 +08:00

.gitignore

chore: design cleanup, dead-code purge, README/doc refresh

2026-06-28 13:58:52 +08:00

AGENTS.md

docs: add AGENTS.md project guide

2026-06-13 22:46:41 +08:00

analysis.md

feat: Phase 1 MVP with audit fixes — Wayland screen capture + VAAPI encoding

2026-04-05 23:35:00 +08:00

build.rs

feat: Phase 1 MVP with audit fixes — Wayland screen capture + VAAPI encoding

2026-04-05 23:35:00 +08:00

Cargo.lock

feat(portal): async encode pipeline - decouple capture from encoding

2026-06-07 16:55:28 +08:00

Cargo.toml

ci: add build/test/clippy gate + cargo audit; pin rust-version

2026-06-28 14:31:42 +08:00

README.md

chore: design cleanup, dead-code purge, README/doc refresh

2026-06-28 13:58:52 +08:00

shell.nix

feat: Phase 1 MVP with audit fixes — Wayland screen capture + VAAPI encoding

2026-04-05 23:35:00 +08:00

README.md

wl-webrtc

Wayland screen capture and encoding tool.

Prerequisites

Rust toolchain (1.70+): rustup default stable
FFmpeg 6.0+ dev libraries with VAAPI support:
- Arch: pacman -S ffmpeg
- Ubuntu/Debian: apt install libavcodec-dev libavformat-dev libavutil-dev libswscale-dev libva-dev
- Fedora: dnf install ffmpeg-devel libva-devel
Wayland dev libraries:
- Arch: pacman -S wayland-protocols
- Ubuntu/Debian: apt install libwayland-dev wayland-protocols
- Fedora: dnf install wayland-devel wayland-protocols-devel
DRM dev libraries:
- Arch: pacman -S libdrm
- Ubuntu/Debian: apt install libdrm-dev
- Fedora: dnf install libdrm-devel

Build

cargo build --release

Run

# Basic capture to file
wl-webrtc --output output.mp4

# With custom FPS and bitrate
wl-webrtc --output output.mp4 --fps 60 --bitrate 8000000

# Specify DRM device for hardware encoding
wl-webrtc --output output.mp4 --drm-device /dev/dri/renderD128

# Verbose mode
wl-webrtc --output output.mp4 -v

# WebRTC streaming mode (HTTP signaling server)
wl-webrtc --port 8080 -v

# Force a fresh portal authorization dialog (ignore saved restore token)
wl-webrtc --output output.mp4 --no-persist

# Pin the capture backend instead of auto-detecting
wl-webrtc --output output.mp4 --backend portal    # or: --backend screencopy

CLI Arguments

src/args.rs is the authoritative source. Run wl-webrtc --help for the live list.

Argument	Default	Description
`-o`, `--output`	(optional)	Output file path (e.g. output.mp4). Optional when using `--port` for WebRTC mode.
`--output-name`	auto	Wayland output name to capture
`--fps`	30	Target frames per second
`--codec`	h264	Video codec (h264 only for MVP)
`--hw-accel`	vaapi	Hardware acceleration method
`--drm-device`	auto	DRM render device path
`--bitrate`	auto	Target bitrate in bps
`--max-bitrate`	8000000	Max bitrate cap for WebRTC mode (caps BWE escalation; no effect in MP4 mode)
`--gop-size`	auto	Group of Pictures size
`-v`, `--verbose`	false	Enable verbose logging
`--backend`	auto	Capture backend: `screencopy` (wlroots) or `portal` (KWin/KDE). Auto-detected if omitted.
`--port`	0	WebRTC HTTP signaling server port. `0` keeps MP4 file output mode.
`--no-persist`	false	Force re-authorization (ignore saved portal restore token)
`--stats`	false	Print per-second pipeline statistics for stutter diagnosis

Capture backends

The tool supports two Wayland capture backends, auto-detected by default:

wlr-screencopy (preferred when zwlr_screencopy_manager_v1 is advertised): works on wlroots-based compositors (Sway, Hyprland, etc.).
XDG Portal / PipeWire (fallback when D-Bus ScreenCast is available): works on KWin/KDE and any compositor that implements the XDG Desktop Portal screen-cast protocol. The first run shows an authorization dialog; a restore token is cached under wl-webrtc/portal-restore-token so subsequent runs don't re-prompt (use --no-persist to force a fresh authorization).