T

dailz bcfbd93f5a refactor(state_portal): extract bitrate helpers + thread loops to submodules

Step 3: split state_portal.rs (1241 -> 829 LOC) into three modules.

- src/state_portal.rs (829 LOC): keeps StatePortal struct + impl (with
  poll_and_encode / handle_pw_frame / shutdown / etc.) + Drop + PortalStage
  enum + DRM helpers + DRM tests. Per Oracle/Explore audit, all 21
  StatePortal fields are private and poll_and_encode interleaves three
  channel reads with state-machine transitions; moving it would force
  pub(crate) on every field, so it stays in mod.rs.
- src/state_portal/bitrate.rs (144 LOC): RESOLUTION_TIERS + 4 pure fns
  (resolution_bitrate_bps / webrtc_startup_bitrate_bps / select_resolution /
  next_upscale_tier) + 10 tests that exercise them. Pure fns with no
  StatePortal field access — the cleanest possible extract.
- src/state_portal/threads.rs (287 LOC): the 5 thread-related types
  (EncodeThreadTiming / EncodeThread / WebrtcThread / WebRtcThreadConfig /
  WebRtcThreadChannels) + the two free fns encode_thread_loop /
  webrtc_thread_loop + the 3 channel-semantics regression tests
  (try_send_* / shutdown_rx_drop_*) that document crossbeam invariants
  the shutdown logic relies on. Struct fields widened to pub(super) so
  StatePortal in mod.rs can construct and join them.

Test preservation:
- state_portal test count: 17 (mod.rs=4 drm tests + bitrate.rs=10 +
  threads.rs=3 channel tests) — matches baseline.

Verification (all green):
- cargo build / cargo build --release
- cargo test (79 lib + 3 integration = 82 pass, 1 ignored — unchanged)
- cargo clippy --all-targets -- -D warnings
- cargo fmt --check

2026-07-13 16:35:44 +08:00

.cargo

chore(deps): address cargo audit findings

2026-07-03 11:23:48 +08:00

.github/workflows

ci(gitea): retry apt setup

2026-07-03 13:55:46 +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

refactor(state_portal): extract bitrate helpers + thread loops to submodules

2026-07-13 16:35:44 +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(avhw): fix misleading Send soundness reasoning

2026-07-09 15:20:16 +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

chore(deps): address cargo audit findings

2026-07-03 11:23:48 +08:00

Cargo.toml

chore: bump MSRV to 1.87 to match actual API usage

2026-06-28 14:39:00 +08:00

README.md

chore: bump MSRV to 1.87 to match actual API usage

2026-06-28 14:39:00 +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.87+; MSRV pinned to match u32::is_multiple_of / Option::is_none_or usage): 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).