Compare commits

...
62 Commits
Author SHA1 Message Date
VallierDevandClaude Opus 5.5 b636f1b278 Release v0.2.38
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:22:03 +08:00
VallierDevandClaude Opus 5.5 64d2ffbdd3 ICE: trust the system certificate store for TURN over TLS
A TLS-inspecting HTTP proxy re-signs the TURN certificate with a CA that the
host's administrator installed in the system store; OpenSSL accepts it while
the bundled Mozilla roots alone fail with UnknownIssuer.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:21:37 +08:00
VallierDevandClaude Opus 5.5 5656f33d86 Release v0.2.37
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 19:35:12 +08:00
VallierDevandClaude Opus 5.5 6a633e1bc4 ICE: gather TURN relays over TCP/TLS through the HTTP proxy with UU_USE_PROXY=1
Upstream webrtc-ice only gathers UDP relays. Forced-relay sessions also offer
turns:<ip>:<port>?transport=tcp, the only media path on hosts whose UDP cannot
reach the TURN servers but whose TCP goes through an HTTP proxy. Vendor
webrtc-ice 0.10.1 with a TCP/TLS dialer (optional HTTP CONNECT) that frames
STUN/ChannelData for the unchanged turn client. Certificates are chain-verified;
a name mismatch is accepted only for IP-literal TURN URLs. Enabled only with
UU_USE_PROXY=1; default UDP gathering is unchanged.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 19:34:24 +08:00
VallierDevandClaude Opus 5.5 ab137a1b20 Release v0.2.36
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 17:27:17 +08:00
VallierDevandClaude Opus 5.5 092ea713f8 X11: fall back to XGetImage when MIT-SHM attach is refused
XShmAttach fails asynchronously with BadAccess when the X server cannot reach
the segment (for example a server in another container); Xlib's default error
handler exited the host before the existing XGetImage fallback could run.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 17:26:01 +08:00
VallierDevandClaude Opus 5.5 53d5f0e144 viewer: request key frames until the first frame is shown (#124)
A session that joins a host already streaming to another viewer can receive a
clean stream with no IDR in flight, so the loss-driven PLI never fired. Ask
every 30 access units until something is presented, and warn after 300.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 16:36:35 +08:00
VallierDevandClaude Opus 5.5 6b5216df35 Release v0.2.35
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 15:21:34 +08:00
VallierDevandClaude Opus 5.5 d66937a01c Signaling: honor the REST client's opt-in HTTP proxy policy (#123)
Route host and viewer WebSocket signaling through the shared reqwest client so UU_USE_PROXY=1 applies to signaling as well (HTTP/HTTPS proxies only, no direct fallback, no redirects, strict upgrade validation). ICE/WebRTC media is not proxied.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:42:12 +08:00
VallierDevandClaude Opus 5.5 825f964f7d doctor: warn about extra host instances; README: never share config.json (#122)
Count only top-level hosts (helpers such as the Wayland capture process and
the login window are children) and explain that two instances with one
identity kick each other out of the room.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:32:37 +08:00
VallierDevandClaude Opus 5.5 3f2da6f587 doctor: count re-executed host processes by executable (#122)
The host re-execs through /proc/self/exe, so its process name becomes "exe"
and pgrep -x uuremote-server missed duplicate hosts.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:26:34 +08:00
VallierDevandClaude Opus 5.5 027abba44d Signaling: log the shape of cloud room leaves without a peer id (#122)
Keys, value types and lengths only, as for SOAC offers.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:02:10 +08:00
VallierDevandClaude Opus 5.5 ef86019b39 Login: distinguish QR polling failures from expiry with safe diagnostics (#121)
Classify QR request failures (timeout/connect/decode/body/request) with phase, elapsed time and HTTP/API status only; never print tickets, URLs or server content. Extract and test the polling decisions; keep the 60 s timeout and official refresh behaviour.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 13:28:50 +08:00
shofukantktsandshofukantkts 003da254a6 Wayland: type mobile text_input via clipboard paste on Portal and compositors without spare keycodes (#119)
* Wayland: type mobile text_input via clipboard paste on Portal and compositors without spare keycodes

* Wayland: address review comments for mobile text_input clipboard fallback

- Guard external clipboard commands in unit tests to eliminate desktop side effects
- Narrow paste fallback to Wayland and Portal backends only
- Document clipboard override and two-way sync behavior in README (both zh and en)
- Unify disable switch via UU_WAYLAND_TEXT=0

---------

Co-authored-by: shofukantkts <[email protected]>
2026-10-27 22:14:56 +08:00
VallierDevandClaude Opus 5.5 7a86fab340 Release v0.2.34
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-27 13:10:49 +08:00
VallierDevandClaude Opus 5.5 d631849f1d Viewer: map the desktop window before the first decoded frame (#118)
Wayland shows a toplevel only after its first buffer, so a stream that never
yields a picture left no window at all. Present a black buffer on creation and
on resize/expose while no frame has arrived.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-27 12:10:35 +08:00
VallierDevandClaude Opus 5.5 d04d241411 Viewer: repaint the last frame after a compositor resize (#118)
Tiling or maximizing the SDL viewer resized the surface, but nothing was
drawn until the next decoded frame, so a static remote desktop stayed blank.
Repaint the last frame on SizeChanged/Resized/Exposed/Maximized/Restored.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-27 11:10:53 +08:00
VallierDevandClaude Opus 5.5 2eece30287 Signaling: bound the WebSocket handshake so reconnect retries after a stall (#115)
After a network change the DNS/TCP/TLS/upgrade could stall forever after
room credentials were acquired; the reconnect loop never retried. The
handshake now fails after 20s and the existing 5s retry takes over.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 20:03:54 +08:00
VallierDevandClaude Opus 5.5 1e94175414 Release v0.2.33
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 19:02:33 +08:00
VallierDevandClaude Opus 5.5 cfe9601874 WebRTC: restart a promoted desktop's video after its stream ended (#114)
A tool peer promoted by capture_desktop stayed marked as the desktop after its
encoder exited on its own (Wayland capture failing while locked/DPMS off), so a
later capture_desktop on the same peer only logged and never restarted the
video. Treat a finished stream task as ended: capture_desktop asks for the
desktop again and promote() restarts the video on the existing input lease.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 18:02:56 +08:00
VallierDevandClaude Opus 5.5 ab5d0a656b Release v0.2.32
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-25 22:54:59 +08:00
VallierDevandClaude Opus 5.5 dcc67ed550 WebRTC: recompute the peer state from the real DTLS transport after ICE recovers
The ICE transport state callback was created before the DTLS transport and
captured the default placeholder, whose state never leaves New. Every later
ICE change therefore computed the peer state against a "New" DTLS: after a
brief ICE Disconnected -> Connected the PeerConnection settled on New instead
of Connected, so the idle room renewal treated the still-working
port-mapping peer as idle and tore the room down.

Wire the callback to the real DTLS transport through a weak slot filled right
after it is created.

Fixes #109

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-25 22:53:22 +08:00
liuyanghejerry bf7bd50062 viewer: forward mouse wheel events as mouse_scroll (#108)
SDL MouseWheel events had no arm in the event translator, so wheel input was dropped. Send one notch as 120 wire units (the Mac convention), use SDL's precise deltas for trackpads, honour the flipped direction for natural scrolling, and keep the existing focus and view-only gating.
2026-10-24 22:42:53 +08:00
liuyanghejerry 287b21a622 viewer: map pointer input to the content rectangle of the padded canvas (#107)
The CLI decoder pads every frame into a fixed 1920x1080 canvas so rawvideo frames have a known byte length. Input mapping and the SDL viewport treated that padded canvas as the picture, so non-16:9 hosts (official Macs are usually 16:10) had the pillarbox bars inside the 0..1 range: the remote pointer lagged inward and the error grew towards the screen edges.

Parse the coded picture size from ffmpeg's one-time "Video:" stream line, carry it on Frame.content, and render/map only the content sub-rectangle. 16:9 streams are unchanged; UU_VIEWER_SIZE keeps working.
2026-10-24 21:41:48 +08:00
Mr. ErrorandClaude Code bcde9f967c Signaling: keep heartbeat detection alive when delivery stalls (#104)
* Signaling: keep heartbeat detection alive when delivery stalls

The receive loop awaited event_sender.send() without a bound. When the main loop was parked in PeerConnection::close after a released peer, the 64-slot event queue filled and the receiver blocked inside the loop body, so the Engine.IO deadline in the same select! never ran. The host stayed online with a half-closed socket for hours.

- add a watchdog over the last inbound frame, independent of the receive loop
- bound event, pong and control sends with a timeout or try_send
- timeout PeerConnection::close so one dead peer cannot stall signaling
- regression test with a blocked event consumer

Co-Authored-By: Claude Code <[email protected]>

* Signaling: always report Disconnected when the receiver stops

The receive loop can break without enqueueing Disconnected: event delivery exceeded SEND_STALL_TIMEOUT, or the writer already stopped. receiver_done then lets the watchdog exit, while the main loop's rx_event stays open because the idle-renewal timer holds a sender. The host stays in a dead room until the 15-minute renewal, which is deferred while a peer is connected.

Hand a Disconnected off from a detached task after every loop exit. Duplicates are harmless: the main loop breaks on the first one and drops the old receiver.

The new test keeps the consumer blocked past SEND_STALL_TIMEOUT, then drains the queue and expects Disconnected.

Co-Authored-By: Claude Code <[email protected]>

---------

Co-authored-by: Claude Code <[email protected]>
2026-10-24 16:38:43 +08:00
VallierDevandClaude Opus 5.5 df9429495f Release v0.2.31
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-24 11:15:00 +08:00
VallierDevandClaude Opus 5.5 ba82bc432a nvenc: opt-in UU_NVENC_BUFFER_MS VBV buffer for high-resolution keyframes (#103)
The 100-500 kbit NVENC default squeezes a 1440p IDR into ~62 KB, so the
picture blurs and sharpens once per GOP. Share the VAAPI buffer parser so
UU_NVENC_BUFFER_MS (10-1000 ms of the bitrate cap) applies to the FFmpeg
pipeline and the in-process engine; default unchanged.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-24 10:44:59 +08:00
VallierDevandClaude Opus 5.5 648eeca03d Release v0.2.30
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-24 04:41:03 +08:00
VallierDevandClaude Opus 5.5 f97370782f Start the desktop on a tool connection when the viewer sends capture_desktop (#99) (#101)
When a port-mapping connection is already open, the Mac viewer opens the desktop by sending SimpleAction 4 (capture_desktop) on that connection's CONTROL channel instead of a new offer. The host now promotes that tool connection to the desktop: video, cursor, TEXT clipboard (with the capability echo replayed) and session counting follow a per-peer active flag. A later desktop demotes it without closing its port mappings. Stream tasks are fenced by an abort handle, and the X11 capture is rebuilt if the screen size changed.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 13:40:14 -07:00
Jeff Zhangandferstar 8792fb4eca vaapi: raise the in-process RC max_qp to 51 so capped presets reach the QP 51 floor (#102)
Co-authored-by: ferstar <[email protected]>
2026-10-23 11:24:15 -07:00
VallierDevandClaude Opus 5.5 c041160d6d Release v0.2.29
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 21:52:30 +08:00
VallierDevandClaude Opus 5.5 69aecf0269 X11: select one monitor with UU_X11_MULTISCREEN=1 (#100)
Opt-in X11 monitor selection for #98: RandR monitors from xrandr --listmonitors through the existing screen-switch path; x11grab reads display+x,y at the monitor size, absolute input adds the monitor offset, in-process engine and xrandr resize are skipped while a region is captured.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 06:51:42 -07:00
VallierDevandClaude Opus 5.5 979b62d271 Issue template: keep peer and port-mapping log lines, drop webrtc noise, mask IPv6/MAC
The WARN filter let webrtc_ice/dtls lines push the useful ones out of the
last 80 lines (#99). Also mask IPv6 and MAC addresses, and ask for the
graphical session terminal: doctor from SSH/tty reports no DISPLAY.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 21:20:42 +08:00
Jeff Zhangandferstar 6a3da14961 Switch the desktop encoder on SIGUSR2 without dropping the session (#96)
set-encoder / set-codec signal the running host (only when /proc/<pid>/exe is this exact binary); the live desktop stream re-plans its encoder at the next frame boundary, sends CaptureSettingSync when 4:4:4 falls back, and prints a note when no host was notified. Step 3 of #85.

Co-authored-by: ferstar <[email protected]>
2026-10-23 03:24:29 -07:00
VallierDevandClaude Opus 5.5 792408e6f5 Release v0.2.28
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 16:22:37 +08:00
VallierDevandClaude Opus 5.5 61c3f91e9e Install: install.sh installs FFmpeg; host notifies the desktop user when it is missing (#97)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 01:21:57 -07:00
VallierDevandClaude Opus 5.5 1bb43a9426 Release v0.2.27
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-23 15:25:54 +08:00
Jeff Zhang 9d3b3da3f5 Video: probe the auto encoder in the background (NVENC then CPU) (#93)
Refs #85 (step 2).
2026-10-23 00:24:31 -07:00
阿夜 1009bdeaf2 fix(video): keep streaming after display wake failures (#95)
Fixes #94.
2026-10-22 21:24:51 -07:00
212duoand212duo fa7606894f feat(viewer): secure type input that reuses the open desktop session (#70)
Co-authored-by: 212duo <[email protected]>
2026-10-22 20:24:18 -07:00
963875516a Video: encoder and codec selection settings (set-encoder / set-codec) (#92)
Step 1 of #85: unified encoder/codec selection (host_settings.json > UU_VIDEO_* > auto), set-encoder / set-codec subcommands with locked merge writes, per-connection selection snapshot, doctor shows sources.

Co-authored-by: ferstar <[email protected]>
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-22 16:24:22 -07:00
VallierDevandClaude Opus 5.5 b6703b19df Release v0.2.26
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-22 23:54:56 +08:00
76a225a235 Tray: install the symbolic icon into the user hicolor theme (#90)
v0.2.25 showed KDE's unknown icon on Plasma 6.8 (#87). Plasma resolves
SNI icons theme by theme, trying dash-trimmed names in each theme before
the IconThemePath app theme, which comes last, so a cache-only icon is
easy to lose. Write it to $XDG_DATA_HOME/icons/hicolor (found by every
panel's default lookup; only when changed) and keep that as the theme
path. The new name "uuremote-tray-symbolic" cannot trim into the colored
"uu-remote-linux" app icon and avoids entries cached under the old name.

Checked with KIconLoader on Plasma 6.7 (Plasma's IconThemePath setup and
the global loader both resolve it, with the colored icon installed too).

Co-authored-by: VallierDev <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-22 08:54:23 -07:00
da99c1ceb4 NVENC: skip direct BGRA input when NVIDIA drives the display (#89)
#16: with display, capture and encode all on an RTX 5070 the packed-RGB
input path is 19% slower in the probe and 25% end to end than CPU
swscale, while on an iGPU-composited desktop it was neutral to faster.
Keep it on by default only when no connected DRM connector belongs to an
nvidia-bound card; UU_NVENC_RGB=1 forces it, =0 still disables it.

Co-authored-by: VallierDev <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-22 08:12:31 -07:00
VallierDevandClaude Opus 5.5 0fe9b979e5 Release v0.2.25
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-22 21:05:37 +08:00
cb4850d296 Tray: monochrome icon that follows light/dark panels (#88)
* Tray: monochrome icon that follows light/dark panels

The tray used the colored app icon (or the theme's "computer" when it was
not installed), which is hard to see on dark panels. Ship a 16px symbolic
icon embedded in the binary, write it to the user cache and pass that
directory as the indicator's icon theme path: GTK and the GNOME
AppIndicator extension recolor "-symbolic" names, KDE recolors the
ColorScheme-Text class. Fixes #87.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* AGENTS: config.json is parsed once, re-read only on LoginExpired

Reported in #85: the 60 s sleep is the room renewal poll, not a config reload.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: VallierDev <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-22 06:04:54 -07:00
VallierDevandClaude Opus 5.5 16ded48a99 Release v0.2.24
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-22 17:45:03 +08:00
d95053d490 X11: change the desktop resolution for the viewer's choice; survive live resizes (#86)
* Restart X11 capture at the new size when the desktop is resized mid-stream

A RandR resize during a session made x11grab fail with BadMatch on the old
size. read_encoder treated that as an encoder failure and walked the whole
fallback chain (NVENC -> CPU, HEVC -> H.264) with the stale size, then the
stream stopped ("Encoder output ended") and the viewer froze. New connections
already re-probed the geometry (#18); live ones did not.

- When an X11 stream fails and the root size differs, skip the encoder
  fallback and restart capture at the new size with the same settings.
- Absolute pointer mapping follows the refreshed X11 size.
- New connections compare the root size with their capture instead of the
  engine's change flag, which a live stream may already have consumed.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

* Change the X11 desktop resolution when the viewer picks one

The official Windows host changes its display resolution for the viewer's
分辨率 choice; this host only scaled the encoded stream, so a smaller choice
made text smaller and blurrier instead of larger.

On X11 the capture/resolution RPC now switches the primary output's mode with
xrandr (an existing mode of that size, else a CVT reduced-blanking mode at
60 Hz, or 30 Hz above an HDMI 2.0 pixel clock), re-applying it when mutter
resets the mode after the list changes. resolution_type 3 (original) and the
end of the last desktop stream restore the mode in use before the first
change. The stream restarts capture at the new native size and reports it in
the screen sources and CaptureSettingSync. UU_DESKTOP_RESIZE=0 keeps the old
encoder scaling; Wayland is unchanged.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

---------

Co-authored-by: VallierDev <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-22 02:44:18 -07:00
VallierDevandClaude Opus 5.5 50ed54d77a Release v0.2.23
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-22 16:34:37 +08:00
d6752e77c8 Fix SRTP rollover counter rewinding on delayed NACK retransmissions (#83) (#84)
webrtc-srtp 0.12.0 stored every sequence number and used a 100-packet window to
guess the rollover counter. A NACK retransmission of a pre-wrap packet sent after
the wrap (65000 after 85) rewound that state, so the next new packets were
protected with ROC+1 and the viewer failed authentication on all of them: frozen
video after the Windows viewer returned from the background.

Vendor webrtc-srtp 0.12.0 with the RFC 3711 Appendix A half-space estimate and a
high-water index that retransmissions cannot move back. Regression tests fail on
upstream (65000 != 85) and pass with the fix for AES-CM/HMAC and AES-GCM.

Co-authored-by: VallierDev <[email protected]>
Co-authored-by: AYssu <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-22 01:34:07 -07:00
VallierDevandClaude Opus 5.5 9906dd4767 Release v0.2.22
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-22 15:14:55 +08:00
Jeff Zhang 9e2198b03d docs: AMD VAAPI verified on the in-process engine; CPU cost figures (#81)
README/README.en/AGENTS: AMD iGPUs (HawkPoint, Cezanne) are accepted on the inproc-av VAAPI engine with the official
Mac viewer; the FFmpeg process pipeline on AMD is not separately verified. inproc-av now covers VAAPI in process;
build headers listed. Thanks @ferstar.
2026-10-21 22:24:42 -07:00
Jeff Zhang 21c01d2e18 inproc-av: native VAAPI H.264/HEVC through DRI3 DMA-BUF, VPP and VCN (#80)
With --features inproc-av on X11 and UU_VIDEO_ENCODER=vaapi, VAAPI runs in process: a DRI3 DMA-BUF of the root
(XShm upload without DRI3) goes through VPP to NV12 and the hardware encoder. SPS/PPS(/VPS) and slice headers are
packed by the host because radeonsi (Mesa 26) does not write them. libva/libva-drm are dlopen'ed; release builds do
not enable inproc-av. The NVENC path is unchanged.

Accepted by the contributor on AMD HawkPoint1 (Mesa 26.2.3), 1920x1200@60, with the official Mac viewer
(HEVC, presets, fps, scaling). Intel iHD and 4K are not verified. Thanks @ferstar.
2026-10-21 15:25:13 -07:00
059a3b1bb8 inproc-av: 4:4:4 on the native NVENC engine (#76, #77)
H.264 High 4:4:4 / HEVC FRExt with chromaFormatIDC 3 and AQ off when 真彩 is requested; GPUs without YUV444 encode fail the capability check and fall back. full_chroma_available() no longer excludes the in-process path. UU_PROBE_CHROMA=444 for the probe.

Co-authored-by: ferstar <[email protected]>
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-21 08:24:32 -07:00
76941459cc inproc-av: native in-process NVENC reading XShm directly (#74, #75)
Replaces the FFmpeg-based in-process encoder with a native NVENC engine (vendored nv-codec-headers n12.1.14.0, libcuda/libnvidia-encode dlopen'ed at runtime, primary context reuse). Fallback: native NVENC -> FFmpeg NVENC process -> libx264. inproc-av no longer links FFmpeg; VAAPI/CPU always use the process pipeline. Default builds are unchanged.

Co-authored-by: ferstar <[email protected]>
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-21 07:26:45 -07:00
1fa346fd1f device_capability: list every supported format with its size, not 0x0 (#79)
The official viewer (libstreamer, Mac 4.43) treats a video_codec_capability entry
with width or height 0 as unsupported. The 4.37 Windows host we copied in #49 ran on
a GTX 660 without HEVC/4:4:4, so its 0x0 entries meant exactly that. Evidence by
@ferstar in #77.

Co-authored-by: VallierDev <[email protected]>
Co-authored-by: ferstar <[email protected]>
Co-authored-by: Claude Opus 5.5 <[email protected]>
2026-10-21 21:29:23 +08:00
VallierDevandClaude Opus 5.5 e09778cc94 Release v0.2.21: Wayland without virtual pointer/keyboard, systemd unit docs
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-21 21:05:58 +08:00
VallierDevandClaude Opus 5.5 b1da297e42 Wayland: only a missing virtual pointer falls back to uinput (#78)
uu_wl_move returns -2 only when the compositor has no wlr-virtual-pointer; other failures are returned as before. Document UU_WAYLAND_NO_VIRTUAL_KEYBOARD.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-21 21:05:11 +08:00
ossSBandClaude Opus 5.5 c739036301 Wayland: virtual pointer and keyboard are optional; capture still starts (#72, #73)
Compositors without wlr-virtual-pointer, or that restrict the virtual keyboard to their input method (Denial), now bring up capture and fall back to uinput for input. UU_WAYLAND_NO_VIRTUAL_KEYBOARD=1 skips the virtual keyboard.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-21 16:29:19 +08:00
25893cd4ab docs: align the user systemd unit with the deb package unit (#69)
Drop the hard-coded DISPLAY=:0 and install under graphical-session.target like packaging/deb; Xfce/i3, headless and the virtual desktop keep WantedBy=default.target. AGENTS.md recipe aligned.

Co-authored-by: ferstar <[email protected]>
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 22:42:11 +08:00
VallierDevandClaude Opus 5.5 5089c0343c Release v0.2.20: QR sign-in matches the official client (#68)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 17:03:13 +08:00
VallierDevandClaude Opus 5.5 5fdb98b0f5 QR login follows the official client: status_query_ticket, 60 s long poll, stop on failure (#68)
From the official Mac client (UURemote 4.42; QRCodeGenLoginResponse decodes only qrcode_jump_url
and status_query_ticket, the status/by_qrcode bodies carry that ticket under "token"):
- gen/login is sent without a body; the status ticket is status_query_ticket (older token as fallback).
- The status long poll re-asks right after each answer with a 60 s request timeout (was 12 s).
- Status 3 regenerates at once, status 0 after 0.35 s, 4 logs in (3 no longer calls by_qrcode).
- Errors such as HTTP 400 code 1190 and timeouts stop polling until the user clicks the new
  刷新二维码 button (Enter in a terminal; one minute when neither exists). This replaces the
  v0.2.19 backoff and the re-register hint.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 16:58:00 +08:00
178 changed files with 33281 additions and 1073 deletions

No files matched your search

+5 -4
View File
@@ -32,8 +32,8 @@ body:
attributes: attributes:
label: 诊断信息 / Diagnostics label: 诊断信息 / Diagnostics
description: | description: |
先复现一次问题,然后在被控的 Linux 上运行下面的命令,把输出粘贴到这里(IP 会被自动抹掉,不包含密码、令牌或剪贴板内容)。 先复现一次问题,然后在被控 Linux 的**图形桌面里打开的终端**中运行下面的命令(SSH 或 tty 里缺少桌面环境变量,doctor 结果不准),把输出粘贴到这里(IPv4/IPv6/MAC 地址会被自动抹掉,不包含密码、令牌或剪贴板内容)。
Reproduce the problem, then run this on the Linux host and paste the output (IPs are masked; no passwords, tokens or clipboard data). Reproduce the problem, then run this in a terminal **inside the Linux graphical session** (SSH/tty lacks the desktop environment, so doctor would be misleading) and paste the output (IPv4/IPv6/MAC addresses are masked; no passwords, tokens or clipboard data).
```sh ```sh
{ {
@@ -45,8 +45,9 @@ body:
echo "== 显卡"; lspci 2>/dev/null | grep -iE 'vga|3d' echo "== 显卡"; lspci 2>/dev/null | grep -iE 'vga|3d'
echo "== FFmpeg"; ffmpeg -hide_banner -encoders 2>/dev/null | grep -E 'h264_nvenc|libx264' echo "== FFmpeg"; ffmpeg -hide_banner -encoders 2>/dev/null | grep -E 'h264_nvenc|libx264'
echo "== 日志"; journalctl --user -u uuremote-native.service --since "-30min" --no-pager -o cat \ echo "== 日志"; journalctl --user -u uuremote-native.service --since "-30min" --no-pager -o cat \
| grep -E 'Starting|backend|Selected capture|Desktop encoder|Capture setting request|Desktop video settings|Offer for connection|WARN|ERROR' | tail -n 80 | grep -E 'Starting|backend|Selected capture|Desktop encoder|Capture setting request|Desktop video settings|Offer for connection|PeerConnection State|Remote controller disconnected|ICE path|Port mapping|WARN|ERROR' \
} 2>&1 | sed -E 's/[0-9]{1,3}(\.[0-9]{1,3}){3}/x.x.x.x/g' | grep -vE 'webrtc_ice|webrtc_dtls|webrtc::mux' | tail -n 120
} 2>&1 | sed -E 's/[0-9]{1,3}(\.[0-9]{1,3}){3}/x.x.x.x/g; s/([0-9a-fA-F]{1,4}:){4,7}[0-9a-fA-F]{1,4}|[0-9a-fA-F]{0,4}::[0-9a-fA-F:]*[0-9a-fA-F]/x:x::x/g'
``` ```
render: text render: text
validations: validations:
+17 -2
View File
@@ -43,6 +43,21 @@ jobs:
uuremote-server --help | head -1 uuremote-server --help | head -1
test -f /usr/lib/uu-remote-linux/libuu-wayland.so test -f /usr/lib/uu-remote-linux/libuu-wayland.so
systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service
# The tarball installer must bring FFmpeg back on a machine without it (no FFmpeg = no picture).
- name: Tarball install script
run: |
shellcheck packaging/tarball/install.sh
sudo apt-get remove -y ffmpeg || true
if command -v ffmpeg; then echo "ffmpeg still present"; exit 1; fi
pkg=$(mktemp -d)
cp target/debug/uuremote-server target/debug/libuu-wayland.so packaging/tarball/install.sh "$pkg/"
cp -r contrib "$pkg/"
home=$(mktemp -d)
HOME=$home XDG_CONFIG_HOME=$home/.config "$pkg/install.sh" --yes
ffmpeg -hide_banner -encoders | grep -qw libx264
test -x "$home/.local/bin/uuremote-server" && test -f "$home/.local/lib/uu-remote-linux/libuu-wayland.so"
grep -q '^ExecStart=%h/.local/bin/uuremote-server$' "$home/.config/systemd/user/uuremote-native.service"
HOME=$home XDG_CONFIG_HOME=$home/.config "$pkg/install.sh" --yes | grep -q 'Kept existing'
test-viewer: test-viewer:
runs-on: ubuntu-22.04 runs-on: ubuntu-22.04
@@ -94,12 +109,12 @@ jobs:
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Install build dependencies (X11 + FFmpeg 6 for the inproc-av feature) - name: Install build dependencies (X11; inproc-av vendors the NVENC headers; the VAAPI/DRI3 engines need libva/gbm/xcb-dri3 headers, libva itself is dlopen'ed at runtime)
run: | run: |
sudo apt-get update sudo apt-get update
sudo apt-get install -y build-essential pkg-config \ sudo apt-get install -y build-essential pkg-config \
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \ libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage0-dev
- uses: dtolnay/rust-toolchain@stable - uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2 - uses: Swatinem/rust-cache@v2
- run: cargo test --locked --features inproc-av - run: cargo test --locked --features inproc-av
+1 -1
View File
@@ -65,7 +65,7 @@ jobs:
name=uu-remote-linux-${GITHUB_REF_NAME}-${{ matrix.arch }}-linux name=uu-remote-linux-${GITHUB_REF_NAME}-${{ matrix.arch }}-linux
mkdir -p "$name" mkdir -p "$name"
cp target/release/uuremote-server target/release/uuremote-viewer target/release/libuu-wayland.so target/release/libuu-portal.so \ cp target/release/uuremote-server target/release/uuremote-viewer target/release/libuu-wayland.so target/release/libuu-portal.so \
LICENSE README.md README.en.md config.example.json "$name/" packaging/tarball/install.sh LICENSE README.md README.en.md config.example.json "$name/"
cp -r contrib "$name/" cp -r contrib "$name/"
tar czf "$name.tar.gz" "$name" tar czf "$name.tar.gz" "$name"
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256" sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
+47 -24
View File
@@ -38,9 +38,13 @@ Dependencies (Ubuntu/Debian):
```sh ```sh
sudo apt install build-essential pkg-config \ sudo apt install build-essential pkg-config \
libx11-dev libxext-dev libxtst-dev libxfixes-dev libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev libgtk-3-dev ffmpeg libx11-dev libxext-dev libxtst-dev libxfixes-dev libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev libgtk-3-dev ffmpeg
# --features inproc-av: libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev # --features inproc-av: X11 in-process capture + native NVENC/VAAPI. NVENC headers are vendored and
# (FFmpeg 6.x only; in-process capture/encoding, Ubuntu 24.04 ships it. FFmpeg >= 7 # libcuda/libnvidia-encode dlopen'ed at runtime (NVENC API 12.1, driver >= 530).
# fails in ffmpeg-sys-next with "avfft.h file not found", before our build.rs runs) # The VAAPI/DRI3 engines compile against
# libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage-dev;
# libva/libva-drm themselves are dlopen'ed at runtime (no hard libva dependency)
# --features viewer-ffmpeg: libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev
# (FFmpeg 6.x only. FFmpeg >= 7 fails in ffmpeg-sys-next with "avfft.h file not found")
# --features wayland: libwayland-dev libxkbcommon-dev wl-clipboard # --features wayland: libwayland-dev libxkbcommon-dev wl-clipboard
# --features wayland,portal: + libglib2.0-dev libpipewire-0.3-dev libei-dev (libei >= 1.1) # --features wayland,portal: + libglib2.0-dev libpipewire-0.3-dev libei-dev (libei >= 1.1)
``` ```
@@ -69,6 +73,9 @@ cargo build --release --features native-viewer,viewer-sdl --bin uuremote-viewer
X11 → default build. Hyprland → `--features wayland`. GNOME/KDE on Wayland → `--features wayland,portal` X11 → default build. Hyprland → `--features wayland`. GNOME/KDE on Wayland → `--features wayland,portal`
(or advise the user to pick the "on Xorg" session at the login screen, which is the best-supported path). (or advise the user to pick the "on Xorg" session at the login screen, which is the best-supported path).
2. Install dependencies and build (section 3). Copy the binary: `install -Dm755 target/release/uuremote-server ~/.local/bin/uuremote-server`. 2. Install dependencies and build (section 3). Copy the binary: `install -Dm755 target/release/uuremote-server ~/.local/bin/uuremote-server`.
From a release tarball run its `./install.sh` as the desktop user instead: it installs into `~/.local`, writes the user unit
(keeps an existing one) and installs FFmpeg with libx264 via sudo apt/pacman when missing (Fedora/openSUSE: prints the command).
The .deb depends on `ffmpeg`. Without FFmpeg the viewer waits on 正在传输画面; the host checks at startup and on each desktop offer, logs an error and tells the desktop user (freedesktop notification, else opens its window with a red line; `assist::show_problem`).
3. **Login (needs the human).** Run `uuremote-server login` inside the graphical session. A GTK window shows a QR 3. **Login (needs the human).** Run `uuremote-server login` inside the graphical session. A GTK window shows a QR
code; the user scans it with the UU Remote mobile app and confirms. Without a display use code; the user scans it with the UU Remote mobile app and confirms. Without a display use
`uuremote-server login --no-gui` (terminal QR). Credentials are written to `~/.config/uuremote/config.json` `uuremote-server login --no-gui` (terminal QR). Credentials are written to `~/.config/uuremote/config.json`
@@ -79,17 +86,21 @@ cargo build --release --features native-viewer,viewer-sdl --bin uuremote-viewer
[Unit] [Unit]
Description=UU Remote Linux host (unofficial) Description=UU Remote Linux host (unofficial)
After=graphical-session.target After=graphical-session.target
PartOf=graphical-session.target
[Service] [Service]
Environment=RUST_LOG=info Environment=RUST_LOG=info
Environment=DISPLAY=:0
# GNOME on Xorg usually needs: Environment=XAUTHORITY=/run/user/<uid>/gdm/Xauthority
ExecStart=%h/.local/bin/uuremote-server ExecStart=%h/.local/bin/uuremote-server
Restart=always Restart=always
RestartSec=5 RestartSec=5
[Install] [Install]
WantedBy=default.target WantedBy=graphical-session.target
``` ```
Same as packaging/deb. GNOME/KDE import DISPLAY / WAYLAND_DISPLAY and start graphical-session.target; do not hard-code
DISPLAY there (it overrides the session's real one, XWayland is often :1); under default.target the unit can
start before WAYLAND_DISPLAY is imported and fall back to X11. Desktops without that target (Xfce, i3) and the Xvfb
virtual desktop need `WantedBy=default.target` plus an explicit `Environment=DISPLAY=...`; headless
(`UU_DESKTOP_BACKEND=none` + linger) needs `WantedBy=default.target` only (GNOME on Xorg outside the session: `XAUTHORITY=/run/user/<uid>/gdm/Xauthority`).
Find the real display/Xauthority with `loginctl show-session <id> -p Display` / `ps -o args -C Xorg`. Find the real display/Xauthority with `loginctl show-session <id> -p Display` / `ps -o args -C Xorg`.
5. `systemctl --user daemon-reload && systemctl --user enable --now uuremote-native.service` 5. `systemctl --user daemon-reload && systemctl --user enable --now uuremote-native.service`
6. Verify: `journalctl --user -u uuremote-native.service -f` must show 6. Verify: `journalctl --user -u uuremote-native.service -f` must show
@@ -106,24 +117,28 @@ viewer does not reconnect them automatically.
| Item | Meaning | | Item | Meaning |
|---|---| |---|---|
| `~/.config/uuremote/config.json` | user_id, device_id, client_id, system_id, machine_guid, token, csrf; optional `sign_key`, `ffmpeg_root`. `$UU_CONFIG` overrides the path | | `~/.config/uuremote/config.json` | user_id, device_id, client_id, system_id, machine_guid, token, csrf; optional `sign_key`, `ffmpeg_root`. `$UU_CONFIG` overrides the path |
| `~/.config/uuremote/host_settings.json` | persisted 安全 settings: auto_lock, keep_mute, mute_permanent | | `~/.config/uuremote/host_settings.json` | persisted 安全 settings: auto_lock, keep_mute, mute_permanent; optional `video_encoder` (`auto`/`cpu`/`vaapi`/`nvenc`) and `video_codec` (`auto`/`h264`/`h265`), written by `set-encoder` / `set-codec` (0600, merge write). Non-`auto` beats `UU_VIDEO_ENCODER` / `UU_VIDEO_CODEC`. `set-encoder` and `set-codec` both send `SIGUSR2` to the pid in `host.pid` (same binary). Live desktop streams restart the encoder (`EncoderTask::restart`, sequence kept, first frame IDR) without dropping the peer. Codec preference is logged and applies on the next desktop stream. `SIGUSR2` does not re-probe. Hand edits: `kill -USR2 $(cat ~/.config/uuremote/host.pid)` |
| `UU_DESKTOP_BACKEND` | `auto` (default) / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless: no display; desktop offers ignored; tool peers get a nominal 1920x1080 screen + Allow permissions, which the port-mapping viewer requires) | | `UU_DESKTOP_BACKEND` | `auto` (default) / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless: no display; desktop offers ignored; tool peers get a nominal 1920x1080 screen + Allow permissions, which the port-mapping viewer requires) |
| `UU_X11_MULTISCREEN=1`, `UU_X11_OUTPUT` | X11: advertise each RandR monitor (`xrandr --listmonitors`, read once at start; primary or `UU_X11_OUTPUT` is id 0) through the same screen-switch path as `UU_WAYLAND_MULTISCREEN` (`wayland::outputs`/`select`). x11grab reads `display+x,y` at the monitor size, XTest/uinput absolute input adds the monitor offset, the in-process engine and `desktop_mode` resize are skipped (分辨率 scales). Needs two or more monitors |
| `UU_DESKTOP_RESIZE=0` | X11: the viewer's 分辨率 choice scales the encoded stream instead of changing the display mode. Default: `src/desktop_mode.rs` switches the primary output via xrandr (adds a CVT-RB mode when missing, re-applies once if mutter resets it), restores the original mode for resolution_type 3 and 2 s after the last desktop stream ends |
| `UU_NVENC_RGB=0` / `=1` | NVENC 4:2:0 without scaling takes packed BGRA/BGR0 directly (no CPU swscale). Default: on, except when a connected DRM connector belongs to an nvidia-bound card (desktop composited on the encoding GPU; #16 measured 82.6 vs 98 fps at 4K). `0` forces CPU conversion, `1` forces the direct path |
| `UU_INPUT_BACKEND` | `auto` (uinput on Wayland/portal when `/dev/uinput` is accessible, udev `uaccess` rule in README) / `uinput` / `native`. X11 keeps XTest (held-key autorepeat handling) | | `UU_INPUT_BACKEND` | `auto` (uinput on Wayland/portal when `/dev/uinput` is accessible, udev `uaccess` rule in README) / `uinput` / `native`. X11 keeps XTest (held-key autorepeat handling) |
| Mac viewer Cmd | With 「使用 macOS 快捷键」 off the Mac viewer sends Cmd=VK_LWIN 0x5B, Option=0xA4, Ctrl=0xA2; connect header `controller_platform`=4 is macOS. For Mac controllers Cmd is held back: Cmd+C/V/A/F/X/Z → Ctrl+key (terminal: Cmd+C/V → Ctrl+Shift+C/V), other combos/alone → Super | | Mac viewer Cmd | With 「使用 macOS 快捷键」 off the Mac viewer sends Cmd=VK_LWIN 0x5B, Option=0xA4, Ctrl=0xA2; connect header `controller_platform`=4 is macOS. For Mac controllers Cmd is held back: Cmd+C/V/A/F/X/Z → Ctrl+key (terminal: Cmd+C/V → Ctrl+Shift+C/V), other combos/alone → Super |
| `UU_TERMINAL_SHORTCUTS=0` | disable Ctrl+V → Ctrl+Shift+V in focused X11 terminals (Mac Cmd and Ctrl both arrive as VK_LCONTROL) | | `UU_TERMINAL_SHORTCUTS=0` | disable Ctrl+V → Ctrl+Shift+V in focused X11 terminals (Mac Cmd and Ctrl both arrive as VK_LCONTROL) |
| `contrib/virtual-desktop/` | Xvfb + session (`UU_VIRTUAL_SESSION`, `UU_VIRTUAL_BUS=user|private`) for monitorless hosts; serve it with `DISPLAY=:99` | | `contrib/virtual-desktop/` | Xvfb + session (`UU_VIRTUAL_SESSION`, `UU_VIRTUAL_BUS=user|private`) for monitorless hosts; serve it with `DISPLAY=:99` |
| `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: explicit Intel/AMD; `nvenc`: force; unset: NVENC→CPU only if `/proc/driver/nvidia/version` or `/dev/nvidia0` exists, else CPU (#10) | | `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: explicit Intel/AMD; `nvenc`: force; unset/`auto`: background probe, one synthetic IDR per candidate, 3 s each. While #33 is open, auto is NVENC then CPU when `/proc/driver/nvidia/version` or `/dev/nvidia0` exists; with no NVIDIA the only candidate is CPU and the probe is skipped. A session that starts before the probe finishes uses the legacy rule (NVENC if NVIDIA is present, else CPU). On `--features inproc-av`, a process-only failure of NVENC when the native engine would try it first on X11 is `native_unprobed` and keeps that legacy NVENC choice (Wayland, portal, and KMS fall back to CPU). The skipped CPU-only probe is logged `not probed (only candidate)`. A successful probe and that CPU-only skip stay cached while NVIDIA presence (`/proc/driver/nvidia/version` or `/dev/nvidia0`) matches the report. A later desktop connection whose presence differs treats the report as stale and starts one background re-probe (`warm_auto_probe`, non-blocking, one at a time) and still uses the cached encoder. A hardware-candidate failure (NVENC failed, chosen CPU) is cached for 10 minutes (`PROBE_FAILURE_TTL`); the next desktop connection after that starts the same re-probe and still uses the cached encoder. Explicit `cpu` / `vaapi` / `nvenc` (setting file or `UU_VIDEO_ENCODER`) does not start the probe. A later success selects NVENC again; another failure restarts the 10 minutes. `native_unprobed` is not a failure cache. Ignored when `host_settings.json` `video_encoder` is not `auto`. Explicit `vaapi` with 真彩 encodes 4:2:0 and reports that in CaptureSettingSync (field 3). VAAPI is not an auto candidate until #33 |
| `UU_VIDEO_CODEC=h264` | force H.264 even when the viewer negotiated H.265 (default: H.265 when both sides support it) | | `UU_VIDEO_CODEC=h264` | force H.264 even when the viewer negotiated H.265 (default: H.265 when both sides support it and the encoder is hardware). Same precedence as the encoder: setting file, then this variable, then auto |
| `UU_FFMPEG_ROOT` | FFmpeg prefix (`bin/ffmpeg`, libs in `lib/x86_64-linux-gnu`) | | `UU_FFMPEG_ROOT` | FFmpeg prefix (`bin/ffmpeg`, libs in `lib/x86_64-linux-gnu`) |
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) | | `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window | | `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) | | `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
| `UU_WOL_HELPER=1` | experimental: report LAN info (`api-ipv4…/api/v1/device/wake_on_lan/info` {mac, ip, subnet_mask}) after sign-in and answer `wake_on_lan` pushes (`target_device` {mac, ip, subnet_mask}) with a magic packet, like the official Windows host (field names from its log strings; not verified end to end). `wake_on_lan` push key names are always logged | | `UU_WOL_HELPER=1` | experimental: report LAN info (`api-ipv4…/api/v1/device/wake_on_lan/info` {mac, ip, subnet_mask}) after sign-in and answer `wake_on_lan` pushes (`target_device` {mac, ip, subnet_mask}) with a magic packet, like the official Windows host (field names from its log strings; not verified end to end). `wake_on_lan` push key names are always logged |
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default | | `UU_USE_PROXY=1` | honor HTTP/HTTPS proxy env vars for REST and WebSocket signaling, and also gather TURN relays over TCP/TLS through that proxy (`vendor/webrtc-ice/PATCHES.md`; chain-verified, name mismatch tolerated for IP TURN URLs); clients bypass env proxies by default |
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors | | `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. The config is re-read Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. `config.json` is parsed once
every 60 s. (`config::file()`); only a `LoginExpired` room answer re-reads it from disk (`config::read_fresh()`) before waiting
for a new QR login.
## 6. Code map ## 6. Code map
@@ -154,9 +169,8 @@ every 60 s.
| `src/viewer_main.rs`, `src/viewer/` | experimental viewer (`--features native-viewer,viewer-sdl`): cloud join, WebRTC offer side, SDL desktop window (ffmpeg CLI decode), files/terminal/portmap/power/assist tools, device removal (`POST /api/v1/device/{id}/unbind`, verified live; shared devices use `/api/v1/device/share/{id}/unbind`, strings only), GTK launcher | | `src/viewer_main.rs`, `src/viewer/` | experimental viewer (`--features native-viewer,viewer-sdl`): cloud join, WebRTC offer side, SDL desktop window (ffmpeg CLI decode), files/terminal/portmap/power/assist tools, device removal (`POST /api/v1/device/{id}/unbind`, verified live; shared devices use `/api/v1/device/share/{id}/unbind`, strings only), GTK launcher |
| `c_engine/viewer_window.c`, `c_engine/viewer_tools.c` | viewer GTK launcher and tool windows (files, port mapping, terminal list) | | `c_engine/viewer_window.c`, `c_engine/viewer_tools.c` | viewer GTK launcher and tool windows (files, port mapping, terminal list) |
Diagnostic subcommands: `doctor` (paste-safe report: session, selected backend, engine plugins, uinput, encoders, Diagnostic subcommands: `doctor` (paste-safe report: session, selected backend, engine plugins, uinput, encoder and codec with source, sign-in/service state; booleans and names only), `set-encoder auto|cpu|vaapi|nvenc` and `set-codec auto|h264|h265` (both notify a running host with SIGUSR2; live encoder switch, negotiated codec unchanged, codec preference on the next desktop stream; illegal values exit 2), `login [--no-gui]`, `unlock-check` (password on stdin, prints only accepted/rejected),
default codec, sign-in/service state; booleans and names only), `login [--no-gui]`, `unlock-check` (password on stdin, prints only accepted/rejected), `desktop-probe [new.png]`, `desktop-video-probe` (`UU_PROBE_FPS`, `UU_PROBE_FRAMES`, `UU_PROBE_QUALITY` 1-5 = viewer bitrate preset, 5 auto; `UU_PROBE_CHROMA=444` 真彩; `UU_PROBE_INPUT` fixed video/image sequence, `UU_PROBE_LOOP=1` repeats), `wayland-input-probe`, `clipboard-acceptance`,
`desktop-probe [new.png]`, `desktop-video-probe` (`UU_PROBE_FPS`, `UU_PROBE_FRAMES`, `UU_PROBE_QUALITY` 1-5 = viewer bitrate preset, 5 auto; `UU_PROBE_INPUT` fixed video/image sequence, `UU_PROBE_LOOP=1` repeats), `wayland-input-probe`, `clipboard-acceptance`,
`portal-acceptance`, `help`. Unknown arguments exit with code 2. Builds up to v0.1.0 did **not** reject them and `portal-acceptance`, `help`. Unknown arguments exit with code 2. Builds up to v0.1.0 did **not** reject them and
started a second full host server instead, so check that a subcommand exists in the binary you run. started a second full host server instead, so check that a subcommand exists in the binary you run.
@@ -179,7 +193,7 @@ started a second full host server instead, so check that a subcommand exists in
5 Auto, 6 Custom. Resolution: 16/17 pixel size or 5/6, 10 resolution_type (3 = follow remote). 5 Auto, 6 Custom. Resolution: 16/17 pixel size or 5/6, 10 resolution_type (3 = follow remote).
Field 7 `chorma_format` (ChromaFormat 1 = 4:2:0, 3 = 4:4:4) is sent when 真彩 is toggled; ff_capture_setting versions Field 7 `chorma_format` (ChromaFormat 1 = 4:2:0, 3 = 4:4:4) is sent when 真彩 is toggled; ff_capture_setting versions
are cumulative (3 CHROMA_SAMPLING, 4 CUSTOM_BITRATE, 5 DPI_SCALE, 6 HDR). 4:4:4 = NVENC `high444p` / x264 `high444` are cumulative (3 CHROMA_SAMPLING, 4 CUSTOM_BITRATE, 5 DPI_SCALE, 6 HDR). 4:4:4 = NVENC `high444p` / x264 `high444`
with `yuv444p`; VAAPI and inproc stay 4:2:0. with `yuv444p`; the in-process NVENC engine uses High 4:4:4 / HEVC FRExt (AQ off); VAAPI stays 4:2:0.
Reply `RpcResponse{2 CaptureSettingResponse{}}` (no errors = applied) and send Message 25 CaptureSettingSync Reply `RpcResponse{2 CaptureSettingResponse{}}` (no errors = applied) and send Message 25 CaptureSettingSync
(field 3 = the chroma actually encoded). (field 3 = the chroma actually encoded).
- ConnectOptions field 4 `decoder_cap_list` = DecoderCap {1 fps, 2 codec_type (1 H264, 2 H265), 3 width, 4 height, - ConnectOptions field 4 `decoder_cap_list` = DecoderCap {1 fps, 2 codec_type (1 H264, 2 H265), 3 width, 4 height,
@@ -267,16 +281,25 @@ started a second full host server instead, so check that a subcommand exists in
- Update README.md / README.en.md when user-visible features or limitations change, and add - Update README.md / README.en.md when user-visible features or limitations change, and add
`docs/release-notes/<tag>.md` before tagging a release. `docs/release-notes/<tag>.md` before tagging a release.
### VAAPI (opt-in / 显式启用) ### VAAPI
`UU_VIDEO_ENCODER=vaapi` selects Intel/AMD H.264 VAAPI; `UU_VAAPI_DEVICE` defaults to `UU_VIDEO_ENCODER=vaapi` or `set-encoder vaapi` selects Intel/AMD H.264 VAAPI explicitly.
`/dev/dri/renderD128` (render-node permissions required). No automatic VAAPI selection. `UU_VAAPI_DEVICE` defaults to `/dev/dri/renderD128` (render-node permissions required).
Both FFmpeg process and `--features inproc-av` upload NV12 frames to a VAAPI frame pool. Auto is NVENC then CPU when an NVIDIA driver is present, otherwise CPU. VAAPI is not an
auto candidate until #33.
The FFmpeg process pipeline uploads NV12 frames to a VAAPI frame pool. With `--features inproc-av` on X11, VAAPI
H.264/HEVC Main runs in process: a DRI3 DMA-BUF of the root (XShm upload without DRI3) goes through VPP to NV12
and VCN, with SPS/PPS(/VPS) and slice headers packed by the host as radeonsi (Mesa 26) needs; parameters follow
FFmpeg's hevc_vaapi/h264_vaapi on that driver. Accepted on AMD HawkPoint1 (Mesa 26.2.3) and Cezanne
(Mesa 26.2.5; XShm-upload and DRI3 zero-copy probes plus a full HEVC Mac-viewer session) with the official
Mac viewer (presets, fps, scaling); Intel iHD is not verified. Measured on Cezanne + RTX 3050 Ti
(1920x1200, desktop-video-probe, 300 frames): in-process VAAPI ~1.5 ms CPU/frame vs in-process NVENC
~7.1 ms vs libx264 process pipeline ~19 ms.
VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1, VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1,
AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264 AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264
with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av` viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). The process pipeline on
VAAPI path are not hardware-verified. AMD is not separately verified (AMD acceptance is the in-process engine above).
### Virtual audio / 虚拟声卡 ### Virtual audio / 虚拟声卡
@@ -317,8 +340,8 @@ This permission can inject into the whole seat, including lock/greeter screens.
Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils` Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils`
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`. xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`.
Rolling Arch FFmpeg may be newer than supported `inproc-av` (FFmpeg 6.x); use the default process Rolling Arch FFmpeg may be newer than supported `viewer-ffmpeg` (FFmpeg 6.x); build it against a separate
pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg. FFmpeg 6 prefix. Do not downgrade the system FFmpeg. The host's `inproc-av` does not link FFmpeg.
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md). User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
### Experimental KMS / 实验后端 ### Experimental KMS / 实验后端
Generated
+6 -5
View File
@@ -2741,7 +2741,7 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
[[package]] [[package]]
name = "uu-remote-linux" name = "uu-remote-linux"
version = "0.2.19" version = "0.2.38"
dependencies = [ dependencies = [
"async-trait", "async-trait",
"base64 0.22.1", "base64 0.22.1",
@@ -2758,12 +2758,14 @@ dependencies = [
"nix 0.29.0", "nix 0.29.0",
"qrcode", "qrcode",
"rand 0.8.8", "rand 0.8.8",
"rcgen",
"reqwest", "reqwest",
"sdl2", "sdl2",
"serde", "serde",
"serde_json", "serde_json",
"sha2", "sha2",
"tokio", "tokio",
"tokio-rustls",
"tokio-tungstenite", "tokio-tungstenite",
"webrtc", "webrtc",
"x11rb", "x11rb",
@@ -3008,23 +3010,24 @@ dependencies = [
[[package]] [[package]]
name = "webrtc-ice" name = "webrtc-ice"
version = "0.10.1" version = "0.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a1bbd6b3dea22cc6e961e22b012e843d8869e2ac8e76b96e54d4a25e311857ad"
dependencies = [ dependencies = [
"arc-swap", "arc-swap",
"async-trait", "async-trait",
"crc", "crc",
"log", "log",
"rand 0.8.8", "rand 0.8.8",
"rustls-native-certs",
"serde", "serde",
"serde_json", "serde_json",
"stun", "stun",
"thiserror 1.0.69", "thiserror 1.0.69",
"tokio", "tokio",
"tokio-rustls",
"turn", "turn",
"url", "url",
"uuid", "uuid",
"waitgroup", "waitgroup",
"webpki-roots 1.0.9",
"webrtc-mdns", "webrtc-mdns",
"webrtc-util", "webrtc-util",
] ]
@@ -3075,8 +3078,6 @@ dependencies = [
[[package]] [[package]]
name = "webrtc-srtp" name = "webrtc-srtp"
version = "0.12.0" version = "0.12.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "383b0f0f73ee6cce396bdbc4d54ec661861a59eae9fc988914c1a8d82c5ac272"
dependencies = [ dependencies = [
"aead", "aead",
"aes", "aes",
+18 -4
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "uu-remote-linux" name = "uu-remote-linux"
version = "0.2.19" version = "0.2.38"
edition = "2021" edition = "2021"
default-run = "uuremote-server" default-run = "uuremote-server"
authors = ["uu-remote-linux contributors"] authors = ["uu-remote-linux contributors"]
@@ -30,9 +30,9 @@ kms = []
portal = [] portal = []
# Build the wayland/portal engines as runtime-loaded libuu-wayland.so / libuu-portal.so (release packages). # Build the wayland/portal engines as runtime-loaded libuu-wayland.so / libuu-portal.so (release packages).
engine-plugins = [] engine-plugins = []
# In-process capture and encoding through FFmpeg 6 libraries (libavcodec/libavdevice dev packages). # In-process X11 capture and NVENC encoding: vendored NVENC headers, NVIDIA driver libraries loaded at runtime.
# Off by default so release binaries do not link the build machine's libav. # Other encoders keep the FFmpeg process pipeline. Off by default.
inproc-av = ["dep:ffmpeg-next", "dep:x11rb"] inproc-av = ["dep:x11rb"]
[dependencies] [dependencies]
tokio = { version = "1", features = ["full"] } tokio = { version = "1", features = ["full"] }
@@ -60,10 +60,24 @@ x11rb = { version = "0.13", features = ["damage", "shm", "allow-unsafe-code"], o
sdl2 = { version = "0.37", optional = true, features = ["use-pkgconfig"] } sdl2 = { version = "0.37", optional = true, features = ["use-pkgconfig"] }
[dev-dependencies]
# Synthetic loopback WSS certificates only; both crates already occur in Cargo.lock.
rcgen = "0.11.3"
tokio-rustls = { version = "0.26.6", default-features = false, features = ["ring", "tls12"] }
[build-dependencies] [build-dependencies]
cc = "1.0" cc = "1.0"
[patch.crates-io] [patch.crates-io]
# RTP rollover counter survives delayed NACK retransmissions (vendor/webrtc-srtp/PATCHES.md).
webrtc-srtp = { path = "vendor/webrtc-srtp" }
webrtc-dtls = { path = "vendor/webrtc-dtls" } webrtc-dtls = { path = "vendor/webrtc-dtls" }
# Larger data-channel receive buffer (see vendor/webrtc/src/data_channel/mod.rs). # Larger data-channel receive buffer (see vendor/webrtc/src/data_channel/mod.rs).
webrtc = { path = "vendor/webrtc" } webrtc = { path = "vendor/webrtc" }
# TURN over TCP/TLS through an HTTP CONNECT proxy (vendor/webrtc-ice/PATCHES.md).
webrtc-ice = { path = "vendor/webrtc-ice" }
[[bench]]
name = "nvenc_pipeline_bench"
harness = false
required-features = ["inproc-av"]
+100 -29
View File
@@ -45,8 +45,8 @@
| Mouse / keyboard | Absolute and relative motion, clicks, wheel, keys; no spurious key repeat on high-latency links; optional uinput virtual devices on Wayland (layout independent, see below) | | Mouse / keyboard | Absolute and relative motion, clicks, wheel, keys; no spurious key repeat on high-latency links; optional uinput virtual devices on Wayland (layout independent, see below) |
| Mac shortcuts | **Recommended**: turn off 「使用 macOS 快捷键」 (use macOS shortcuts) in the Mac viewer's remote-window menu; then Cmd+C/V/A/F/X/Z work as on a Mac (Cmd+C/V become Ctrl+Shift+C/V in terminals) and Ctrl+C always interrupts. With the option on, the viewer sends Cmd as Ctrl: in a terminal Ctrl+V / Cmd+V paste, Ctrl+C interrupts, copy is Cmd+Shift+C (X11) | | Mac shortcuts | **Recommended**: turn off 「使用 macOS 快捷键」 (use macOS shortcuts) in the Mac viewer's remote-window menu; then Cmd+C/V/A/F/X/Z work as on a Mac (Cmd+C/V become Ctrl+Shift+C/V in terminals) and Ctrl+C always interrupts. With the option on, the viewer sends Cmd as Ctrl: in a terminal Ctrl+V / Cmd+V paste, Ctrl+C interrupts, copy is Cmd+Shift+C (X11) |
| Pointer shape | Remote cursor shape is mirrored to the viewer (X11) | | Pointer shape | Remote cursor shape is mirrored to the viewer (X11) |
| Clipboard | Two-way text sync | | Clipboard | Two-way text sync; Wayland mobile IME text inputs use clipboard paste fallback (see below) |
| Quality / frame rate / resolution | Auto, Original 20M, Ultra 8M, HD 2M, custom; 30/60/90/144 fps; "other resolutions" are scaled by the encoder, the host monitor is left untouched | | Quality / frame rate / resolution | Auto, Original 20M, Ultra 8M, HD 2M, custom; 30/60/90/144 fps; on X11 a resolution choice changes the desktop resolution itself like the official Windows host (xrandr, adding the mode when missing; restored for "original" or on disconnect), `UU_DESKTOP_RESIZE=0` scales in the encoder instead; Wayland scales in the encoder |
| Sound | System audio captured from PulseAudio / PipeWire and sent as Opus | | Sound | System audio captured from PulseAudio / PipeWire and sent as Opus |
| File transfer | Upload, download (including folders), create folder, rename, delete | | File transfer | Upload, download (including folders), create folder, rename, delete |
| Terminal | The official "Terminal" tool, PTY sessions, multiple sessions, rename | | Terminal | The official "Terminal" tool, PTY sessions, multiple sessions, rename |
@@ -84,6 +84,8 @@ plugins, permissions and encoders only, no account data, tokens or addresses) an
Wayland limits: captures one screen by default; Hyprland can enable monitor switching as described below. Resolution is fixed. The native Hyprland backend now pipelines two shm screencopy buffers and passes the viewer's requested fps to both capture pacing and the encoder. Actual fps remains limited by the compositor, rendering and readback (the old serial path measured about 16–22 fps at 2560x1600; the pipeline is VM-measured only, not a hardware guarantee). The portal backend does not support dynamic resolution; see below for GNOME wake and lock recovery; the clipboard syncs while the viewer's remote window has focus. On the first connection the desktop asks for "Remote Desktop / Screen Sharing" Wayland limits: captures one screen by default; Hyprland can enable monitor switching as described below. Resolution is fixed. The native Hyprland backend now pipelines two shm screencopy buffers and passes the viewer's requested fps to both capture pacing and the encoder. Actual fps remains limited by the compositor, rendering and readback (the old serial path measured about 16–22 fps at 2560x1600; the pipeline is VM-measured only, not a hardware guarantee). The portal backend does not support dynamic resolution; see below for GNOME wake and lock recovery; the clipboard syncs while the viewer's remote window has focus. On the first connection the desktop asks for "Remote Desktop / Screen Sharing"
permission; the permission is remembered once granted. permission; the permission is remembered once granted.
**Mobile IME typing and clipboard on Wayland**: Mobile IME text (`text_input`) on Wayland is typed through spare keycodes on wlroots compositors. On Portal (GNOME / KDE) or compositors where keycodes are exhausted, it automatically falls back to typing via "system clipboard write + `Shift+Insert` (or `UU_WAYLAND_PASTE_KEY=ctrl_v`)". **Note**: This fallback replaces the host's existing clipboard contents and may echo back to the viewer's clipboard via two-way sync; set `UU_WAYLAND_TEXT=0` to completely disable Wayland mobile text input and clipboard paste fallback.
Scaled GNOME desktops using native Portal input use EIS on the same authorized session when `ConnectToEIS` and a screen `mapping_id` are available. Each axis is mapped using the matched region and actual frame dimensions, with no fixed resolution or scale factor. This avoids scaled-coordinate rejection by `NotifyPointerMotionAbsolute`. Portal builds require libei >= 1.1. Missing EIS support retains the legacy input path and its existing scaling limitations; other initialization failures are reported and trigger session recovery. After a successful EIS connection, all input uses EIS. Capture alone and uinput do not initialize EIS; missing optional logical dimensions do not block capture. Keyboard input uses the existing Windows VK to evdev mapping. Recovery keeps the encoder frame dimensions fixed but accepts logical-size changes after scaling. On GNOME, a display-change notification enables earlier recovery when previously streaming Portal capture remains paused without a valid format for a 200 ms grace after both conditions are present. Healthy renegotiation cancels the early check; repeated notifications do not postpone the same interruption. The five-second fallback remains without a related notification. Static video and valid-format pauses do not trigger recovery. Tested while connected on Ubuntu 26.04, GNOME Wayland, one 3840x2160 display: 200% -> 166.67% -> 200%, with continuously updating video and full-screen pointer control after recovery. Switching briefly freezes and goes black before recovering; five seconds is the fallback threshold, not total recovery time. See [#35](../../pull/35) for timing measurements and validation limits. Lock recovery still needs hardware acceptance testing; multi-monitor support, live resolution changes, and rotation/reflection transforms are outside this fix's scope. Capture settings remain at protocol version 4: advertised resolutions use pixel coordinates and DPR 1; Portal logical dimensions are used only for local input mapping. Scaled GNOME desktops using native Portal input use EIS on the same authorized session when `ConnectToEIS` and a screen `mapping_id` are available. Each axis is mapped using the matched region and actual frame dimensions, with no fixed resolution or scale factor. This avoids scaled-coordinate rejection by `NotifyPointerMotionAbsolute`. Portal builds require libei >= 1.1. Missing EIS support retains the legacy input path and its existing scaling limitations; other initialization failures are reported and trigger session recovery. After a successful EIS connection, all input uses EIS. Capture alone and uinput do not initialize EIS; missing optional logical dimensions do not block capture. Keyboard input uses the existing Windows VK to evdev mapping. Recovery keeps the encoder frame dimensions fixed but accepts logical-size changes after scaling. On GNOME, a display-change notification enables earlier recovery when previously streaming Portal capture remains paused without a valid format for a 200 ms grace after both conditions are present. Healthy renegotiation cancels the early check; repeated notifications do not postpone the same interruption. The five-second fallback remains without a related notification. Static video and valid-format pauses do not trigger recovery. Tested while connected on Ubuntu 26.04, GNOME Wayland, one 3840x2160 display: 200% -> 166.67% -> 200%, with continuously updating video and full-screen pointer control after recovery. Switching briefly freezes and goes black before recovering; five seconds is the fallback threshold, not total recovery time. See [#35](../../pull/35) for timing measurements and validation limits. Lock recovery still needs hardware acceptance testing; multi-monitor support, live resolution changes, and rotation/reflection transforms are outside this fix's scope. Capture settings remain at protocol version 4: advertised resolutions use pixel coordinates and DPR 1; Portal logical dimensions are used only for local input mapping.
GNOME Portal CONTROL no longer waits for a consent dialog or the first video frame. It announces the selected desktop before reporting secure-desktop state and receiving the official viewer's “auto unlock host” request. The official Android viewer requires this desktop selection before entering its auto-unlock flow, so the notification must precede capture readiness; actual screen dimensions, codec information and capture permissions still follow their real readiness state. Enable auto unlock in the viewer and use the current Linux user's login password. The host verifies it with PAM, unlocks the existing GNOME session, requests display wake, and restores capture, input and clipboard through the shared Portal session. Initial consent or revoked permissions still require local approval. Reconnect if physical or logical dimensions change. GNOME Portal CONTROL no longer waits for a consent dialog or the first video frame. It announces the selected desktop before reporting secure-desktop state and receiving the official viewer's “auto unlock host” request. The official Android viewer requires this desktop selection before entering its auto-unlock flow, so the notification must precede capture readiness; actual screen dimensions, codec information and capture permissions still follow their real readiness state. Enable auto unlock in the viewer and use the current Linux user's login password. The host verifies it with PAM, unlocks the existing GNOME session, requests display wake, and restores capture, input and clipboard through the shared Portal session. Initial consent or revoked permissions still require local approval. Reconnect if physical or logical dimensions change.
@@ -94,7 +96,7 @@ Existing screen-off and lock settings remain unchanged. Only capture recovery in
Locked black video requires FFmpeg's libx264/libx265 encoder for the negotiated H.264/H.265 codec; hardware encoding support alone does not satisfy this dependency. Encoder failures are logged explicitly. Synthetic video does not change capture permissions or advertised monitor dimensions. It pauses on unlock or unknown lock state, ends when capture is ready/rejected or the connection closes, and then hands the same video track to real capture. See [#29](../../issues/29) and [#34](../../pull/34) for the controlled experiment and validation scope. Locked black video requires FFmpeg's libx264/libx265 encoder for the negotiated H.264/H.265 codec; hardware encoding support alone does not satisfy this dependency. Encoder failures are logged explicitly. Synthetic video does not change capture permissions or advertised monitor dimensions. It pauses on unlock or unknown lock state, ends when capture is ready/rejected or the connection closes, and then hands the same video track to real capture. See [#29](../../issues/29) and [#34](../../pull/34) for the controlled experiment and validation scope.
The native Wayland backend needs `wlr-output-power-management` from the compositor to wake a turned-off screen; without it only wake is unavailable — capture and encoding are unaffected. The native Wayland backend needs `wlr-output-power-management` from the compositor to wake a turned-off screen; without it only wake is unavailable — capture and encoding are unaffected. Display-wake failures at video startup or during streaming are logged and retried at the next interval without ending the video stream; capture, encoder and send errors retain their existing handling.
Native Wayland experiments: `UU_WAYLAND_PIPELINE=0` disables pipelining for comparison. Native Wayland experiments: `UU_WAYLAND_PIPELINE=0` disables pipelining for comparison.
`UU_WAYLAND_DMABUF=1` explicitly tries dma-buf → GBM CPU mapping (off by default; `UU_WAYLAND_DMABUF=1` explicitly tries dma-buf → GBM CPU mapping (off by default;
@@ -104,20 +106,22 @@ failure falls back to SHM. The virgl VM verified fallback only: successful impor
mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI; mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI;
`UU_VIDEO_ENCODER=vaapi` still uploads CPU frames through FFmpeg. `UU_VIDEO_ENCODER=vaapi` still uploads CPU frames through FFmpeg.
### Hyprland monitor switching (experimental) ### Monitor switching (experimental)
Native Wayland absolute pointer motion now targets the captured output by default, fixing multi-monitor click offsets. uinput may still handle keyboard, buttons and relative motion. Native Wayland absolute pointer motion now targets the captured output by default, fixing multi-monitor click offsets. uinput may still handle keyboard, buttons and relative motion.
Set `UU_WAYLAND_MULTISCREEN=1` to select physical monitors from the phone client. `UU_WAYLAND_OUTPUT` chooses the initial output. Capture and absolute pointer targeting switch together across different resolutions, scales and desktop positions. Set `UU_WAYLAND_MULTISCREEN=1` to select physical monitors from the phone client. `UU_WAYLAND_OUTPUT` chooses the initial output. Capture and absolute pointer targeting switch together across different resolutions, scales and desktop positions.
X11 sessions send all monitors as one combined picture by default. With `UU_X11_MULTISCREEN=1` the host lists the monitors from `xrandr --listmonitors`; the viewer selects one, only that region is captured, and absolute pointer positions are offset to that monitor. The primary monitor is the default; `UU_X11_OUTPUT` picks another (e.g. `HDMI-1`). The layout is read when the host starts; restart the service after changing it. In this mode the viewer's resolution setting scales the stream instead of changing the display mode. Experimental: unit tests and Xvfb virtual monitors only, not yet accepted with the official clients.
Switching reuses one video track and pauses input until the new source sends a frame. Capture/encoder failure or a first-frame timeout requests restoration of the previous source. The inventory uses `hyprctl` and supports unrotated outputs; restart the host after monitor hotplug or layout changes. Phone-side switching and clicks were tested on Omarchy / Hyprland with 2560×1440 at 125% and 1920×1080 at 133.33%. Switching reuses one video track and pauses input until the new source sends a frame. Capture/encoder failure or a first-frame timeout requests restoration of the previous source. The inventory uses `hyprctl` and supports unrotated outputs; restart the host after monitor hotplug or layout changes. Phone-side switching and clicks were tested on Omarchy / Hyprland with 2560×1440 at 125% and 1920×1080 at 133.33%.
## Not implemented / not supported ## Not implemented / not supported
| Feature | Status | | Feature | Status |
|---|---| |---|---|
| Switching between multiple monitors | Experimental on native Hyprland Wayland; see above | | Switching between multiple monitors | Experimental on native Hyprland Wayland and on X11 (`UU_X11_MULTISCREEN=1`); see above |
| True color (4:4:4) | Supported (v0.1.15): the default FFmpeg pipeline with NVENC / libx264 encodes H.264 High 4:4:4; VAAPI and `inproc-av` stay 4:2:0 and report that to the client | | True color (4:4:4) | Supported (v0.1.15): the default FFmpeg pipeline with NVENC / libx264 encodes H.264 High 4:4:4; `inproc-av` native NVENC encodes H.264 High 4:4:4 / HEVC FRExt; VAAPI stays 4:2:0 and reports that to the client |
| HDR | Not implemented | | HDR | Not implemented |
| Super screen / virtual display | Not implemented | | Super screen / virtual display | Not implemented |
| Privacy screen on the host | Not implemented | | Privacy screen on the host | Not implemented |
@@ -139,16 +143,21 @@ uuremote-server login # scan the QR code with
systemctl --user enable --now uuremote-native.service # start with the graphical session systemctl --user enable --now uuremote-native.service # start with the graphical session
``` ```
The deb installs the binaries, plugins, a systemd user unit and menu entries; uinput access stays opt-in (step 5). The deb installs the binaries, plugins, a systemd user unit and menu entries, and pulls in FFmpeg as a dependency; uinput access stays opt-in (step 5).
GNOME and KDE pass the display environment to the unit; on desktops that don't (e.g. Xfce) add `DISPLAY` as in step 4. GNOME and KDE pass the display environment to the unit; on desktops that don't (e.g. Xfce) add `DISPLAY` as in step 4.
**Other distributions**: download `uu-remote-linux-<version>-x86_64-linux.tar.gz` (ARM64: `aarch64-linux`) from [Releases](../../releases/latest), extract it, then: **Other distributions**: download `uu-remote-linux-<version>-x86_64-linux.tar.gz` (ARM64: `aarch64-linux`) from [Releases](../../releases/latest), extract it, then run as your desktop user (not root):
```sh ```sh
install -Dm755 uuremote-server ~/.local/bin/uuremote-server cd uu-remote-linux-<version>-x86_64-linux
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/ ./install.sh # --yes: don't ask; --no-ffmpeg: check only
``` ```
The script installs the binaries and plugins under `~/.local`, writes the systemd user unit (an existing one is kept) and checks
FFmpeg with libx264 (without it the viewer stays on 正在传输画面). A missing FFmpeg is installed through sudo with apt or pacman;
Fedora needs RPM Fusion and openSUSE needs Packman first, and the script only prints the command instead of adding third-party repositories.
The host also checks FFmpeg at startup and on every desktop connection: when it is not runnable it logs an error and shows a desktop notification (without a notification daemon it opens its window with a red hint), at most every 5 minutes. Install it and reconnect; no restart is needed.
One package covers X11, wlroots compositors (Hyprland, Sway, niri) and GNOME/KDE Wayland: the backend is chosen from the One package covers X11, wlroots compositors (Hyprland, Sway, niri) and GNOME/KDE Wayland: the backend is chosen from the
running session at startup, and the matching `libuu-*.so` is loaded only on Wayland, so X11 hosts need no Wayland libraries. running session at startup, and the matching `libuu-*.so` is loaded only on Wayland, so X11 hosts need no Wayland libraries.
@@ -172,6 +181,8 @@ sudo apt install build-essential pkg-config \
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
# optional: GNOME/KDE portal backend # optional: GNOME/KDE portal backend
sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev
# optional: headers for the inproc-av VAAPI/DRI3 engines (libva itself is loaded at runtime)
sudo apt install libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage0-dev
``` ```
- A Rust toolchain is required (<https://rustup.rs>). - A Rust toolchain is required (<https://rustup.rs>).
@@ -187,10 +198,8 @@ cargo build --release --features wayland # + Hyprland
cargo build --release --features wayland,portal # + GNOME/KDE on Wayland cargo build --release --features wayland,portal # + GNOME/KDE on Wayland
``` ```
The optional `--features inproc-av` (in-process encoding) and the viewer's `viewer-ffmpeg` support **FFmpeg 6.x only** The viewer's `viewer-ffmpeg` feature supports **FFmpeg 6.x only** (`pkg-config --modversion libavcodec` = 60.x); FFmpeg 7+ fails inside `ffmpeg-sys-next` with `avfft.h file not found` (#63).
(`pkg-config --modversion libavcodec` = 60.x). FFmpeg 7+ fails inside the `ffmpeg-sys-next` dependency with The host's optional `--features inproc-av` encodes with hardware inside the process on X11. It does not link FFmpeg development libraries; it loads the NVIDIA driver libraries (`libcuda.so.1`, `libnvidia-encode.so.1`) at runtime for NVENC (needs a driver with NVENC API 12.1, 530 or newer) and `libva.so.2`/`libva-drm.so.2` for VAAPI. When the capture and encoder sizes match, NVENC reads the XShm buffer directly, saving one host-to-device copy; VAAPI runs in process under the same feature (DRI3 DMA-BUF zero copy, or XShm upload without DRI3, then VPP to NV12 and VCN; H.264/HEVC). CPU encoding and `UU_CAPTURE=grab` keep the FFmpeg process; if the in-process hardware session fails it falls back to the matching FFmpeg process pipeline, then to the CPU. The default build and the release packages need neither feature.
`avfft.h file not found`; its build script runs before this project's, so no clearer check is possible (#63). The default
build and the release packages need neither feature.
### 3. Log in ### 3. Log in
@@ -203,6 +212,10 @@ Run inside your graphical session:
Scan the code with the **NetEase UU Remote mobile app** and confirm. Credentials are stored only on this Scan the code with the **NetEase UU Remote mobile app** and confirm. Credentials are stored only on this
machine, in `~/.config/uuremote/config.json` (mode 0600). machine, in `~/.config/uuremote/config.json` (mode 0600).
A failed status query or the 60-second request timeout does not prove that the QR expired or that the phone confirmed login. The official-client refresh policy is unchanged: after a query error, click Refresh QR (Enter in a terminal; refresh after 60 seconds with neither a window nor a terminal). QR request diagnostics contain only the request phase, error category, elapsed time, HTTP/API status and last known scan state—not tickets, URLs or response content. A `connect` category alone does not identify a DNS, TLS or proxy cause.
The same file holds this machine's device identity (`device_id`, `client_id`, `system_id`), which reinstalls and new QR logins keep. **Do not copy `config.json` between machines or clone a second host from a snapshot/disk that includes the home directory**: two host instances with one identity, on the same or different machines, kick each other out of the room. The log then shows `Cloud room leave without peer identifier` every few seconds with reconnects, and viewers disconnect right after connecting. On a cloned or copied machine, stop the service, remove those three keys plus `token`, `csrf` and `user_id`, and run `uuremote-server login` to register a new device. A leftover instance on the same machine (for example an old `~/.local/bin/uuremote-server` started by hand) has the same effect; `uuremote-server doctor` warns when more than one host instance is running.
### 4. Run as a user service ### 4. Run as a user service
`~/.config/systemd/user/uuremote-native.service`: `~/.config/systemd/user/uuremote-native.service`:
@@ -211,17 +224,17 @@ machine, in `~/.config/uuremote/config.json` (mode 0600).
[Unit] [Unit]
Description=UU Remote Linux host (unofficial) Description=UU Remote Linux host (unofficial)
After=graphical-session.target After=graphical-session.target
PartOf=graphical-session.target
[Service] [Service]
Environment=RUST_LOG=info Environment=RUST_LOG=info
# X11 desktops need the display; on GNOME, XAUTHORITY is usually /run/user/<uid>/gdm/Xauthority # GNOME/KDE import DISPLAY / WAYLAND_DISPLAY into the user manager and start graphical-session.target
Environment=DISPLAY=:0
ExecStart=%h/.local/bin/uuremote-server ExecStart=%h/.local/bin/uuremote-server
Restart=always Restart=always
RestartSec=5 RestartSec=5
[Install] [Install]
WantedBy=default.target WantedBy=graphical-session.target
``` ```
```sh ```sh
@@ -233,6 +246,10 @@ journalctl --user -u uuremote-native.service -f # online once you see availabi
If you have not logged in yet, the service opens the QR login window on your desktop. If you have not logged in yet, the service opens the QR login window on your desktop.
Desktops that never start `graphical-session.target` (e.g. Xfce, i3) will not autostart this unit: change `[Install]` to
`WantedBy=default.target`, add `Environment=DISPLAY=:0` (your actual display) and `enable` again. Headless mode and the
virtual desktop below also need `default.target`.
### 5. uinput virtual keyboard/mouse on Wayland (recommended) ### 5. uinput virtual keyboard/mouse on Wayland (recommended)
On Wayland (especially GNOME/KDE via the portal) the default input path needs portal consent and some keyboard layouts On Wayland (especially GNOME/KDE via the portal) the default input path needs portal consent and some keyboard layouts
@@ -283,7 +300,7 @@ the same account cannot assist each other, an official restriction).
## Servers without a monitor ## Servers without a monitor
**Headless mode** (terminal, file transfer and port mapping only): add `Environment=UU_DESKTOP_BACKEND=none` to the **Headless mode** (terminal, file transfer and port mapping only): add `Environment=UU_DESKTOP_BACKEND=none` to the
service and run `loginctl enable-linger $USER`, so the systemd user manager (with `XDG_RUNTIME_DIR` and the user D-Bus) service, change `[Install]` to `WantedBy=default.target` (`graphical-session.target` never starts without a login), and run `loginctl enable-linger $USER`, so the systemd user manager (with `XDG_RUNTIME_DIR` and the user D-Bus)
starts at boot without a login. The viewer's remote desktop keeps showing "connecting" in this mode; that is expected. starts at boot without a login. The viewer's remote desktop keeps showing "connecting" in this mode; that is expected.
Log in once with `uuremote-server login --no-gui` (QR in the terminal). Log in once with `uuremote-server login --no-gui` (QR in the terminal).
@@ -326,12 +343,18 @@ Common environment variables:
|---|---| |---|---|
| `UU_CONFIG` | Config file path (default `~/.config/uuremote/config.json`) | | `UU_CONFIG` | Config file path (default `~/.config/uuremote/config.json`) |
| `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless) | | `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless) |
| `UU_DESKTOP_RESIZE=0` | on X11, keep the desktop resolution and only scale the encoded stream when the viewer picks a resolution |
| `UU_NVENC_RGB=0` / `=1` | NVENC encodes BGRA directly (saves CPU). Off by default when a monitor is connected to the NVIDIA card (slower when the desktop is composited on the same GPU); `0` forces off, `1` forces on |
| `UU_WAYLAND_MULTISCREEN=1` | Enable Hyprland physical monitor switching (off by default) | | `UU_WAYLAND_MULTISCREEN=1` | Enable Hyprland physical monitor switching (off by default) |
| `UU_WAYLAND_OUTPUT` | Initial native Wayland output name, e.g. `HDMI-A-1` | | `UU_WAYLAND_OUTPUT` | Initial native Wayland output name, e.g. `HDMI-A-1` |
| `UU_X11_MULTISCREEN=1` | Select and capture X11 monitors separately (experimental, off by default, needs `xrandr`) |
| `UU_X11_OUTPUT` | Initial X11 monitor name (`xrandr --listmonitors`); default: the primary |
| `UU_WAYLAND_NO_VIRTUAL_KEYBOARD=1` | Native Wayland skips the virtual keyboard (e.g. Denial reserves it for its input method); keys go through uinput. Without wlr-virtual-pointer the pointer also uses uinput (#72) |
| `UU_INPUT_BACKEND` | `auto` (default: uinput on Wayland when accessible) / `uinput` / `native` | | `UU_INPUT_BACKEND` | `auto` (default: uinput on Wayland when accessible) / `uinput` / `native` |
| `UU_TERMINAL_SHORTCUTS=0` | Disable the Ctrl+V paste rewrite in terminal windows | | `UU_TERMINAL_SHORTCUTS=0` | Disable the Ctrl+V paste rewrite in terminal windows |
| `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: opt-in Intel/AMD; `nvenc`: force NVENC; unset: NVENC only when an NVIDIA driver is loaded, else CPU | | `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: opt-in Intel/AMD; `nvenc`: force NVENC; unset or `auto`: a background probe (one synthetic IDR per candidate, 3 s each). With an NVIDIA driver the order is NVENC then CPU; without one the only candidate is CPU and the probe is skipped. A session that starts before the probe finishes uses the previous rule (NVENC if NVIDIA is present, else CPU). On a self-built `--features inproc-av` binary, a process-only failure of NVENC when the in-process engine would try it first on X11 is logged `native_unprobed` and keeps the previous NVENC choice (Wayland, portal, and KMS fall back to CPU). The skipped CPU-only probe is logged `not probed (only candidate)`. A successful probe and that CPU-only skip stay cached while NVIDIA presence matches the report. A later desktop connection whose presence differs starts one background re-probe and still uses the cached encoder until the new result is stored. A hardware-candidate failure (NVENC failed, CPU chosen) is kept for 10 minutes; the next desktop connection after that starts the same re-probe and still uses the cached encoder until the new result is stored. Explicit `cpu` / `vaapi` / `nvenc` does not start the probe. Another failure restarts the 10 minutes. `native_unprobed` is not a temporary failure. A non-`auto` `video_encoder` in `host_settings.json` wins. VAAPI stays out of auto until #33 |
| `UU_VAAPI_BUFFER_MS` | VAAPI VBV buffer in ms (10-1000, VAAPI only); raise it when keyframes are squeezed into a blur at high resolution | | `UU_VAAPI_BUFFER_MS` | VAAPI VBV buffer in ms (10-1000, VAAPI only); raise it when keyframes are squeezed into a blur at high resolution |
| `UU_NVENC_BUFFER_MS` | NVENC VBV buffer in ms (10-1000, NVENC only, including the in-process engine); the default is 100-500 kbit, set `1000` when high-resolution keyframes blur and flicker once per GOP (#103) |
| `UU_FFMPEG_ROOT` | Use FFmpeg from this prefix | | `UU_FFMPEG_ROOT` | Use FFmpeg from this prefix |
| `UU_AUDIO=0` | Disable sound; `UU_AUDIO_SOURCE` picks the PulseAudio source | | `UU_AUDIO=0` | Disable sound; `UU_AUDIO_SOURCE` picks the PulseAudio source |
| `UU_REMOTE_ASSIST=0` | Disable remote assistance (no guest assistance before sign-in either) | | `UU_REMOTE_ASSIST=0` | Disable remote assistance (no guest assistance before sign-in either) |
@@ -339,10 +362,35 @@ Common environment variables:
| `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing | | `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing |
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) | | `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
| `UU_WOL_HELPER=1` | Experimental: act as a remote-boot helper like the official Windows host — report this host's LAN info after sign-in and send a magic packet to the LAN when the cloud asks to wake a PC (not verified end to end) | | `UU_WOL_HELPER=1` | Experimental: act as a remote-boot helper like the official Windows host — report this host's LAN info after sign-in and send a magic packet to the LAN when the cloud asks to wake a PC (not verified end to end) |
| `UU_USE_PROXY=1` | Honor HTTP/SOCKS proxy environment variables; by default proxies are ignored and NetEase servers are reached directly | | `UU_USE_PROXY=1` | Share environment HTTP/HTTPS proxy policy between REST and host/viewer WebSocket signaling; proxies are ignored by default |
`UU_USE_PROXY=1` uses only proxy settings already available to the current process. `HTTP_PROXY` / `HTTPS_PROXY` / `ALL_PROXY` (and lowercase forms) and `NO_PROXY` follow reqwest's standard selection, with uppercase taking precedence. Signaling rejects invalid/unsupported values in the selected variables (HTTP/HTTPS only, not SOCKS), proxy URLs with paths/queries/fragments, and CGI environments that would ignore proxies; this validation is intentionally stricter than silently ignoring bad values. No matching proxy or a `NO_PROXY` match still means direct access; a selected proxy failing does not trigger direct fallback. Certificate verification remains enabled and redirects are not followed, so room authentication is not forwarded to a redirect target.
With it the host also reaches the cloud TURN relays over TCP/TLS (CONNECT through the unauthenticated `http://` proxy in `HTTPS_PROXY`/`ALL_PROXY`, or directly without one), for hosts whose UDP cannot reach the TURN servers but whose TCP/proxy can. TURN certificates are chain-verified; a name mismatch is tolerated only when the cloud-supplied TURN address is an IP (media itself is end-to-end DTLS-SRTP). Without the setting only UDP relays are used, as before. **This creates no new network access**: login, signaling and media each still need an allowed network path. Connector errors expose only fixed categories/HTTP status; do not enable dependency TRACE logs that may record URLs or authentication information.
Host settings such as "lock after remote session" and "mute host" are stored in Host settings such as "lock after remote session" and "mute host" are stored in
`~/.config/uuremote/host_settings.json`. `~/.config/uuremote/host_settings.json`. The same file stores `video_encoder`
(`auto`/`cpu`/`vaapi`/`nvenc`) and `video_codec` (`auto`/`h264`/`h265`), written by
`uuremote-server set-encoder` and `uuremote-server set-codec` (illegal arguments exit 2).
A value other than `auto` beats `UU_VIDEO_ENCODER` / `UU_VIDEO_CODEC`; `auto` or a missing
field falls through to the environment, then to auto (NVENC then CPU when an NVIDIA driver
is loaded; CPU with no probe when it is not; codec stays H.265 on hardware and H.264 on CPU).
The probe runs in the background at startup and does not delay the first picture. A success
stays cached until the process exits, except when NVIDIA presence (`/proc/driver/nvidia/version`
or `/dev/nvidia0`) no longer matches the report: the next desktop connection then starts one
background re-probe (`warm_auto_probe`) and still uses the cached encoder until the new result
is stored. An NVENC failure is kept for 10 minutes, and the next desktop connection after that
starts the same background re-probe while still using the cached encoder. `set-encoder` and
`set-codec` both send `SIGUSR2` to the host in `host.pid` when that process is this program.
An encoder change switches each live desktop stream without disconnecting and keeps the codec
negotiated for that session. A failed start follows the existing fallback (in-process, then the
FFmpeg process, then CPU). After a hand edit, `kill -USR2 $(cat ~/.config/uuremote/host.pid)`
does the same. `SIGUSR2` does not re-probe. A codec change takes effect the next time a desktop
connection starts; the running host only logs it. Explicit `vaapi` with 真彩 stays on VAAPI,
encodes 4:2:0, and reports chroma 4:2:0 in CaptureSettingSync field 3. If the chosen encoder
cannot start, the stream falls back to CPU and logs a warning. VAAPI is not an auto candidate
until #33.
Custom bitrate follows the Mbps value selected in the client; for example, 1 Mbps sets an encoder cap of 1000 kbit/s. Custom bitrate follows the Mbps value selected in the client; for example, 1 Mbps sets an encoder cap of 1000 kbit/s.
@@ -420,16 +468,27 @@ AUD only at IRAPs and drops every other picture from the bitstream, so an AUD-ba
one "frame" and the IRAP gate then rejects all of them: the connection stalls at "transferring" while the host one "frame" and the IRAP gate then rejects all of them: the connection stalls at "transferring" while the host
sends about 12 kbit/s. `UU_VIDEO_CODEC=h265` selects H.265 explicitly for A/B diagnosis. sends about 12 kbit/s. `UU_VIDEO_CODEC=h265` selects H.265 explicitly for A/B diagnosis.
### VAAPI (opt-in / 显式启用) ### VAAPI
`UU_VIDEO_ENCODER=vaapi` selects Intel/AMD H.264 VAAPI; `UU_VAAPI_DEVICE` defaults to `UU_VIDEO_ENCODER=vaapi` or `set-encoder vaapi` selects Intel/AMD H.264 VAAPI explicitly.
`/dev/dri/renderD128` (render-node permissions required). No automatic VAAPI selection. `UU_VAAPI_DEVICE` defaults to `/dev/dri/renderD128` (render-node permissions required).
Both FFmpeg process and `--features inproc-av` upload NV12 frames to a VAAPI frame pool. `auto` is NVENC then CPU when an NVIDIA driver is present, and CPU otherwise. VAAPI is
selected only explicitly; putting it in auto waits on #33.
The FFmpeg process uploads NV12 frames to a VAAPI frame pool; a self-built `--features inproc-av`
binary instead runs VAAPI in process on X11 (a DRI3 DMA-BUF of the root window zero-copy, or XShm
upload without DRI3, then VPP to NV12 and VCN; H.264/HEVC).
VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1, VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1,
AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264 AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264
with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av` viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264 — a figure from the
VAAPI path are not hardware-verified. FFmpeg-process-pipeline era). AMD iGPUs are verified on
the **in-process engine** (`--features inproc-av`): end-to-end sessions with the official Mac viewer passed
acceptance on HawkPoint (Mesa 26.2.3) and Cezanne (Mesa 26.2.5) — HEVC, presets, fps, scaling; on Cezanne,
H.264 and both capture paths were additionally probe-verified: the XShm upload (decodable bitstream, correct
picture) and the DRI3 zero-copy import. Measured on one machine (1920x1200@60, Cezanne iGPU + RTX 3050 Ti):
in-process VAAPI costs about **1/12** of the per-frame encode CPU of libx264 (FFmpeg pipeline, superfast)
and about **1/5** of in-process NVENC. The FFmpeg process pipeline (what the release packages use) is not
separately verified on AMD.
The default VAAPI VBV buffer (100-500 kbit) squeezes keyframes hard at high resolution: on a 2560x1440 The default VAAPI VBV buffer (100-500 kbit) squeezes keyframes hard at high resolution: on a 2560x1440
H.264 VAAPI stream capped at 30 Mbit/s the first IDR measured 59,910 bytes and the picture blurred at H.264 VAAPI stream capped at 30 Mbit/s the first IDR measured 59,910 bytes and the picture blurred at
@@ -485,8 +544,7 @@ Keep the unit name `uuremote-native.service` (not a template `[email protected]
Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils` Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils`
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`. xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`.
Rolling Arch FFmpeg may be newer than supported `inproc-av` (FFmpeg 6.x); use the default process If building `viewer-ffmpeg`, rolling Arch FFmpeg may be newer than supported 6.x; use a separate FFmpeg 6 prefix rather than downgrading system FFmpeg (`inproc-av` native NVENC on the host does not depend on FFmpeg).
pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg.
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md). User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
### Experimental KMS / 实验后端 ### Experimental KMS / 实验后端
@@ -524,6 +582,19 @@ GNOME-to-official-Mac bidirectional clipboard synchronization is still unverifie
- CLI: `connect DEVICE false - echo legacy [--view-only]` (desktop), `files DEVICE ls|get|put …`, `terminal DEVICE [SESSION]`, - CLI: `connect DEVICE false - echo legacy [--view-only]` (desktop), `files DEVICE ls|get|put …`, `terminal DEVICE [SESSION]`,
`terminal-ui DEVICE NAME`, `portmap DEVICE LOCAL_PORT HOST PORT` (listens on 127.0.0.1 only), `power DEVICE reboot|shutdown`, `unbind DEVICE` (remove a device from the account; also under "More tools" in the launcher), `terminal-ui DEVICE NAME`, `portmap DEVICE LOCAL_PORT HOST PORT` (listens on 127.0.0.1 only), `power DEVICE reboot|shutdown`, `unbind DEVICE` (remove a device from the account; also under "More tools" in the launcher),
`assist CONNECT_ID` (the code is read from one stdin line, never an argument). See `uuremote-viewer --help`. `assist CONNECT_ID` (the code is read from one stdin line, never an argument). See `uuremote-viewer --help`.
- **Secure `type` input** (inject keystrokes into an open desktop session — lock-screen PIN/password; never put secrets on argv):
```sh
# Preferred: open desktop via ui/connect first, then type (reuses the session; does not kick the live view)
UU_INPUT_ENV=UU_SECRET UU_SECRET='…' \
uuremote-viewer type DEVICE [--delay-ms 40] [--omit-last 1] [--snapshot /path/out.png]
# Or: printf '%s' '…' | uuremote-viewer type DEVICE
# Validate only, no network: uuremote-viewer type DEVICE --dry-run
# If no desktop viewer is running you must pass --new-session (opens a new peer and replaces any already-open desktop window; upstream #30)
```
Brace tokens: `{Enter}` `{Tab}` `{Esc}` `{Backspace}` `{Ctrl+Alt+Del}` …; `{{` is a literal `{`.
**Layout**: characters are mapped for **US QWERTY** only (non-US layouts may mistype symbols/letters).
**Windows numeric PIN**: Windows often submits automatically once enough digits are entered — usually no `{Enter}` needed. Use `--omit-last N` to omit the last N characters when you want to fill without signing in.
Logs and `--dry-run` report lengths/event counts only. When reusing a session, about one second after sending, a PNG frame is saved (default under `$XDG_RUNTIME_DIR/uu-viewer-type/`, mode 0600); the path is logged and printed as `snapshot=…`.
- Ctrl+Alt+F in the desktop window opens the files window on the same connection. `UU_VIEWER_AUDIO=0` disables sound, - Ctrl+Alt+F in the desktop window opens the files window on the same connection. `UU_VIEWER_AUDIO=0` disables sound,
`UU_VIEWER_CLIPBOARD=0` the clipboard, `UU_VIEWER_VIEW_ONLY=1` input; `UU_VIEWER_FFMPEG` selects the ffmpeg binary. `UU_VIEWER_CLIPBOARD=0` the clipboard, `UU_VIEWER_VIEW_ONLY=1` input; `UU_VIEWER_FFMPEG` selects the ffmpeg binary.
- Desktop offers H.264 / H.265; the host chooses the codec. `UU_VIEWER_CODEC=h264` limits both SDP and decoder capabilities to H.264. - Desktop offers H.264 / H.265; the host chooses the codec. `UU_VIEWER_CODEC=h264` limits both SDP and decoder capabilities to H.264.
+67 -27
View File
@@ -39,8 +39,8 @@
| 鼠标 / 键盘 | 绝对/相对移动、点击、滚轮、按键;修复了网络延迟导致的按键连发;Wayland 下可用 uinput 虚拟键鼠(不依赖键盘布局,见下文) | | 鼠标 / 键盘 | 绝对/相对移动、点击、滚轮、按键;修复了网络延迟导致的按键连发;Wayland 下可用 uinput 虚拟键鼠(不依赖键盘布局,见下文) |
| Mac 快捷键 | **推荐**:在 Mac 远控窗口菜单里关闭「使用 macOS 快捷键」,之后和在 Mac 上一样:Cmd+C/V/A/F/X/Z 是复制、粘贴、全选、查找、剪切、撤销(终端里 Cmd+C/V 自动变成 Ctrl+Shift+C/V),Ctrl+C 在终端里始终是中断。保持开启时,客户端会把 Cmd 和 Ctrl 都当成 Ctrl 发送:终端里 Ctrl+V / Cmd+V 自动转成粘贴,Ctrl+C 是中断,复制用 Cmd+Shift+C(X11) | | Mac 快捷键 | **推荐**:在 Mac 远控窗口菜单里关闭「使用 macOS 快捷键」,之后和在 Mac 上一样:Cmd+C/V/A/F/X/Z 是复制、粘贴、全选、查找、剪切、撤销(终端里 Cmd+C/V 自动变成 Ctrl+Shift+C/V),Ctrl+C 在终端里始终是中断。保持开启时,客户端会把 Cmd 和 Ctrl 都当成 Ctrl 发送:终端里 Ctrl+V / Cmd+V 自动转成粘贴,Ctrl+C 是中断,复制用 Cmd+Shift+C(X11) |
| 鼠标指针样式 | 远端指针形状实时同步(X11) | | 鼠标指针样式 | 远端指针形状实时同步(X11) |
| 剪贴板 | 双向文本同步 | | 剪贴板 | 双向文本同步;Wayland 手机输入法输入通过剪贴板兜底粘贴,见下文 |
| 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;「其他分辨率」由编码器缩放,不改动主机显示器 | | 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;X11 下切换分辨率会像官方 Windows 被控端一样真正修改桌面分辨率(xrandr,缺少该模式时自动添加;选「原始」或断开后恢复),`UU_DESKTOP_RESIZE=0` 改为仅由编码器缩放;Wayland 仍由编码器缩放 |
| 声音 | 采集系统声音(PulseAudio / PipeWire),Opus 编码传到控制端 | | 声音 | 采集系统声音(PulseAudio / PipeWire),Opus 编码传到控制端 |
| 文件传输 | 上传、下载(含文件夹)、新建文件夹、重命名、删除 | | 文件传输 | 上传、下载(含文件夹)、新建文件夹、重命名、删除 |
| 终端 | 官方「终端」工具,PTY 会话,支持多会话和重命名 | | 终端 | 官方「终端」工具,PTY 会话,支持多会话和重命名 |
@@ -75,6 +75,8 @@ GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/20
Wayland 下的限制:默认采集单屏,Hyprland 可按上文启用切屏;分辨率固定;Hyprland 原生后端默认使用双缓冲流水线 shm screencopy,控制端帧率设置会同步到采集节拍和编码器,但实际帧率仍受合成器、渲染和读回速度限制(旧串行路径在 2560x1600 曾测得约 16~22 帧;流水线只在虚拟机里测量过,不代表实机保证);portal 后端暂不支持动态分辨率;GNOME 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。 Wayland 下的限制:默认采集单屏,Hyprland 可按上文启用切屏;分辨率固定;Hyprland 原生后端默认使用双缓冲流水线 shm screencopy,控制端帧率设置会同步到采集节拍和编码器,但实际帧率仍受合成器、渲染和读回速度限制(旧串行路径在 2560x1600 曾测得约 16~22 帧;流水线只在虚拟机里测量过,不代表实机保证);portal 后端暂不支持动态分辨率;GNOME 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。
**Wayland 手机输入法打字与剪贴板**:Wayland 下手机端输入法提交的文字(`text_input`)优先通过虚拟键盘空闲键码上屏;在 Portal(GNOME / KDE)或键码耗尽的环境下,自动通过「写系统剪贴板 + 触发 `Shift+Insert`(或 `UU_WAYLAND_PASTE_KEY=ctrl_v`)」兜底粘贴。**注意**:此兜底过程会覆盖被控端原有的剪贴板内容,且会被双向同步回传到控制端剪贴板;设置 `UU_WAYLAND_TEXT=0` 可完全关闭 Wayland 文字输入及该粘贴兜底。
GNOME 缩放桌面在使用 Portal 原生键鼠时,若支持 `ConnectToEIS` 和屏幕 `mapping_id`,通过同一授权会话的 EIS 接口注入输入,按匹配的区域与实际帧尺寸分别映射横纵坐标,没有固定分辨率或缩放倍率,可避免 `NotifyPointerMotionAbsolute` 在缩放时拒绝坐标。Portal 构建需要 libei ≥ 1.1。缺少 EIS 支持时保留旧输入路径及其既有缩放限制;其他初始化错误会明确报告并触发会话恢复。EIS 连接成功后全部输入统一使用 EIS。只采集画面或使用 uinput 时不会初始化 EIS;缺少可选的逻辑尺寸也不阻断采集。键盘沿用项目现有的 Windows VK → evdev 映射。恢复时保持编码器的采集帧尺寸不变,允许缩放后的逻辑尺寸变化。GNOME 显示配置变化后,已推流的 Portal 采集若持续「暂停且无有效格式」,会在关联通知后的 200 毫秒宽限结束后提前进入现有恢复流程;正常重协商恢复会取消提前判定,连续通知不会推迟同次异常的判定。未收到相关通知时保留五秒兜底;静态画面或有效格式下的暂停不会触发恢复。Ubuntu 26.04、GNOME Wayland 单屏 3840×2160 已实测保持连接切换 200%→166.67%→200%,恢复后画面持续更新且鼠标可控制全屏;切换期间会短暂停顿、黑屏后恢复,五秒是兜底判定阈值,并非总恢复时间。提前恢复的测量结果和验证范围见 [#35](../../pull/35)。此路径仍需实机验证锁屏恢复;多屏、连接中改变分辨率及旋转/镜像变换不属于本次修复范围。 捕获设置协议仍为版本 4:对客户端上报的分辨率统一使用像素坐标、DPR 为 1;Portal 逻辑尺寸仅用于本地输入映射。 GNOME 缩放桌面在使用 Portal 原生键鼠时,若支持 `ConnectToEIS` 和屏幕 `mapping_id`,通过同一授权会话的 EIS 接口注入输入,按匹配的区域与实际帧尺寸分别映射横纵坐标,没有固定分辨率或缩放倍率,可避免 `NotifyPointerMotionAbsolute` 在缩放时拒绝坐标。Portal 构建需要 libei ≥ 1.1。缺少 EIS 支持时保留旧输入路径及其既有缩放限制;其他初始化错误会明确报告并触发会话恢复。EIS 连接成功后全部输入统一使用 EIS。只采集画面或使用 uinput 时不会初始化 EIS;缺少可选的逻辑尺寸也不阻断采集。键盘沿用项目现有的 Windows VK → evdev 映射。恢复时保持编码器的采集帧尺寸不变,允许缩放后的逻辑尺寸变化。GNOME 显示配置变化后,已推流的 Portal 采集若持续「暂停且无有效格式」,会在关联通知后的 200 毫秒宽限结束后提前进入现有恢复流程;正常重协商恢复会取消提前判定,连续通知不会推迟同次异常的判定。未收到相关通知时保留五秒兜底;静态画面或有效格式下的暂停不会触发恢复。Ubuntu 26.04、GNOME Wayland 单屏 3840×2160 已实测保持连接切换 200%→166.67%→200%,恢复后画面持续更新且鼠标可控制全屏;切换期间会短暂停顿、黑屏后恢复,五秒是兜底判定阈值,并非总恢复时间。提前恢复的测量结果和验证范围见 [#35](../../pull/35)。此路径仍需实机验证锁屏恢复;多屏、连接中改变分辨率及旋转/镜像变换不属于本次修复范围。 捕获设置协议仍为版本 4:对客户端上报的分辨率统一使用像素坐标、DPR 为 1;Portal 逻辑尺寸仅用于本地输入映射。
GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通知客户端当前选择桌面,再上报锁屏状态、接收官方客户端的「自动解锁被控端」请求。官方 Android 客户端需要桌面目标通知才会进入自动解锁流程,因此该通知不能等待采集就绪;真实屏幕尺寸、编码信息及采集权限仍按实际就绪状态上报。请在客户端启用自动解锁,使用当前 Linux 用户的登录密码;主机通过 PAM 验证后解锁当前 GNOME 会话、请求点亮屏幕,并恢复同一 Portal 会话中的画面、键鼠和剪贴板。首次授权或权限被撤销时仍需本机确认。物理或逻辑分辨率变化后需要重连。 GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通知客户端当前选择桌面,再上报锁屏状态、接收官方客户端的「自动解锁被控端」请求。官方 Android 客户端需要桌面目标通知才会进入自动解锁流程,因此该通知不能等待采集就绪;真实屏幕尺寸、编码信息及采集权限仍按实际就绪状态上报。请在客户端启用自动解锁,使用当前 Linux 用户的登录密码;主机通过 PAM 验证后解锁当前 GNOME 会话、请求点亮屏幕,并恢复同一 Portal 会话中的画面、键鼠和剪贴板。首次授权或权限被撤销时仍需本机确认。物理或逻辑分辨率变化后需要重连。
@@ -85,25 +87,27 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
锁屏黑帧使用 FFmpeg 的 libx264/libx265 编码器(按已协商的 H.264/H.265 选择),硬件编码器可用并不代表这些软件编码器已安装。编码失败会明确记录日志。黑帧不改变采集权限或上报的真实屏幕尺寸;解锁或锁状态未知时暂停,采集就绪、拒绝或连接关闭时结束,再由真实视频接续同一条视频轨。对照实验与验证范围见 [#29](../../issues/29)、[#34](../../pull/34)。 锁屏黑帧使用 FFmpeg 的 libx264/libx265 编码器(按已协商的 H.264/H.265 选择),硬件编码器可用并不代表这些软件编码器已安装。编码失败会明确记录日志。黑帧不改变采集权限或上报的真实屏幕尺寸;解锁或锁状态未知时暂停,采集就绪、拒绝或连接关闭时结束,再由真实视频接续同一条视频轨。对照实验与验证范围见 [#29](../../issues/29)、[#34](../../pull/34)。
原生 Wayland 后端需要合成器提供 `wlr-output-power-management` 才能唤醒已关闭的屏幕;缺少该协议不影响采集和编码。 原生 Wayland 后端需要合成器提供 `wlr-output-power-management` 才能唤醒已关闭的屏幕;缺少该协议不影响采集和编码。视频启动及运行期间,屏幕保活失败仅记录警告并在下轮重试,不终止视频;实际采集、编码或发送错误仍按原逻辑处理。
原生 Wayland 实验选项:`UU_WAYLAND_PIPELINE=0` 可关闭流水线做对照。`UU_WAYLAND_DMABUF=1` 显式尝试 dma-buf→GBM CPU 映射(默认关闭,需要运行时 libgbm;可用 `UU_WAYLAND_DMABUF_DEVICE` 指定 render node,默认 `/dev/dri/renderD128`)。仅支持显式线性修饰符、单平面 8-bit RGB,失败回退 SHM;virgl VM 中只验证了回退,成功导入/映射和硬件加速均未验证。这不是零拷贝 VAAPI 路径;选择 `UU_VIDEO_ENCODER=vaapi` 时仍由 FFmpeg 上传 CPU 帧。 原生 Wayland 实验选项:`UU_WAYLAND_PIPELINE=0` 可关闭流水线做对照。`UU_WAYLAND_DMABUF=1` 显式尝试 dma-buf→GBM CPU 映射(默认关闭,需要运行时 libgbm;可用 `UU_WAYLAND_DMABUF_DEVICE` 指定 render node,默认 `/dev/dri/renderD128`)。仅支持显式线性修饰符、单平面 8-bit RGB,失败回退 SHM;virgl VM 中只验证了回退,成功导入/映射和硬件加速均未验证。这不是零拷贝 VAAPI 路径;选择 `UU_VIDEO_ENCODER=vaapi` 时仍由 FFmpeg 上传 CPU 帧。
首次连接时,桌面会弹窗请求「远程桌面 / 屏幕共享」授权,同意后会记住授权。 首次连接时,桌面会弹窗请求「远程桌面 / 屏幕共享」授权,同意后会记住授权。
### Hyprland 多显示器切换(实验性) ### 多显示器切换(实验性)
原生 Wayland 的绝对鼠标定位默认绑定正在采集的输出,修复双屏桌面下的点击偏移。uinput 可继续用于键盘、按键和相对移动。 原生 Wayland 的绝对鼠标定位默认绑定正在采集的输出,修复双屏桌面下的点击偏移。uinput 可继续用于键盘、按键和相对移动。
设置 `UU_WAYLAND_MULTISCREEN=1` 后,手机端可选择并切换物理显示器;`UU_WAYLAND_OUTPUT` 指定默认屏幕。画面与绝对鼠标定位同步切换,支持不同分辨率、缩放和桌面位置。 设置 `UU_WAYLAND_MULTISCREEN=1` 后,手机端可选择并切换物理显示器;`UU_WAYLAND_OUTPUT` 指定默认屏幕。画面与绝对鼠标定位同步切换,支持不同分辨率、缩放和桌面位置。
X11 会话默认把所有显示器拼成一张画面。设置 `UU_X11_MULTISCREEN=1` 后,主机按 `xrandr --listmonitors` 列出各个显示器,控制端可选择其中一块,只采集该区域,绝对鼠标坐标加上该屏幕在桌面中的偏移;默认屏幕为主显示器,`UU_X11_OUTPUT` 可指定其他屏幕(如 `HDMI-1`)。显示器布局在主机启动时读取,改动后需重启服务。此模式下控制端的「分辨率」改为缩放画面,不再修改显示模式。实验性:目前只有单元测试与 Xvfb 虚拟显示器实测,尚未经官方客户端实机验收。
切屏复用同一条视频轨道,过渡期间暂停输入,发送新屏首帧后恢复;采集或编码失败、等待首帧超时会请求恢复原屏。当前通过 `hyprctl` 枚举未旋转的显示器,显示器插拔或布局变化后需重启服务。已在 Omarchy / Hyprland 上用官方手机客户端实测 2560×1440(125%)与 1920×1080(133.33%)双屏切换及点击。 切屏复用同一条视频轨道,过渡期间暂停输入,发送新屏首帧后恢复;采集或编码失败、等待首帧超时会请求恢复原屏。当前通过 `hyprctl` 枚举未旋转的显示器,显示器插拔或布局变化后需重启服务。已在 Omarchy / Hyprland 上用官方手机客户端实测 2560×1440(125%)与 1920×1080(133.33%)双屏切换及点击。
## 尚未实现 / 不支持 ## 尚未实现 / 不支持
| 功能 | 状态 | | 功能 | 状态 |
|---|---| |---|---|
| 多显示器切换 | Hyprland 原生 Wayland 后端实验性支持,见上文 | | 多显示器切换 | Hyprland 原生 Wayland 后端与 X11(`UU_X11_MULTISCREEN=1`)实验性支持,见上文 |
| 真彩(4:4:4) | 支持(v0.1.15):NVENC / libx264 的默认 FFmpeg 管线输出 H.264 High 4:4:4;VAAPI 和 `inproc-av` 管线仍为 4:2:0,并如实回报给客户端 | | 真彩(4:4:4) | 支持(v0.1.15):NVENC / libx264 的默认 FFmpeg 管线输出 H.264 High 4:4:4;`inproc-av` 原生 NVENC 输出 H.264 High 4:4:4 / HEVC FRExt;VAAPI 管线仍为 4:2:0,并如实回报给客户端 |
| HDR | 未实现 | | HDR | 未实现 |
| 超级屏 / 虚拟显示器 | 未实现 | | 超级屏 / 虚拟显示器 | 未实现 |
| 被控端防窥模式 | 未实现 | | 被控端防窥模式 | 未实现 |
@@ -125,16 +129,20 @@ uuremote-server login # 用 UU 远程 App 扫
systemctl --user enable --now uuremote-native.service # 随图形会话启动 systemctl --user enable --now uuremote-native.service # 随图形会话启动
``` ```
deb 会安装程序、插件、用户级 systemd 服务和应用菜单图标;uinput 权限不会自动开启(见第 5 步)。 deb 会安装程序、插件、用户级 systemd 服务和应用菜单图标,并通过依赖自动装上 FFmpeg;uinput 权限不会自动开启(见第 5 步)。
GNOME / KDE 会把显示环境自动传给服务;Xfce 等不传的桌面需按第 4 步补 `DISPLAY`。 GNOME / KDE 会把显示环境自动传给服务;Xfce 等不传的桌面需按第 4 步补 `DISPLAY`。
**其他发行版**:从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后: **其他发行版**:从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后用普通桌面用户(不要 root)运行:
```sh ```sh
install -Dm755 uuremote-server ~/.local/bin/uuremote-server cd uu-remote-linux-<版本>-x86_64-linux
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/ ./install.sh # 加 --yes 不询问;--no-ffmpeg 只检查不安装
``` ```
脚本把程序和插件装到 `~/.local`,写入用户级 systemd 服务(已有则保留),并检查 FFmpeg(需带 libx264,否则客户端会一直停在「正在传输画面」)。
缺 FFmpeg 时经 sudo 用 apt / pacman 安装;Fedora 需先启用 RPM Fusion,openSUSE 需 Packman 源,脚本只提示命令、不替你添加第三方源。
服务启动时和每次有人连接桌面时都会检查 FFmpeg:不可用就记 error,并弹桌面通知(没有通知服务时打开主窗口,顶部红字提示安装方法,最多每 5 分钟一次);装好后重新连接即可,不用重启服务。
同一个包支持 X11、Hyprland 等 wlroots 合成器和 GNOME/KDE Wayland:程序启动时按当前会话自动选择后端,只在 Wayland 会话里 同一个包支持 X11、Hyprland 等 wlroots 合成器和 GNOME/KDE Wayland:程序启动时按当前会话自动选择后端,只在 Wayland 会话里
才加载对应的 `libuu-*.so`,X11 用户不需要任何 Wayland 库。系统要求: 才加载对应的 `libuu-*.so`,X11 用户不需要任何 Wayland 库。系统要求:
@@ -157,6 +165,8 @@ sudo apt install build-essential pkg-config \
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
# 可选:GNOME/KDE portal 后端 # 可选:GNOME/KDE portal 后端
sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev
# 可选:inproc-av 的 VAAPI/DRI3 引擎编译所需(libva 本体运行时加载)
sudo apt install libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage0-dev
``` ```
- 需要 Rust 工具链(<https://rustup.rs>)。 - 需要 Rust 工具链(<https://rustup.rs>)。
@@ -171,9 +181,8 @@ cargo build --release --features wayland # + Hyprland
cargo build --release --features wayland,portal # + GNOME/KDE Wayland cargo build --release --features wayland,portal # + GNOME/KDE Wayland
``` ```
可选的 `--features inproc-av`(进程内编码)和控制端的 `viewer-ffmpeg` 只支持 **FFmpeg 6.x**(`pkg-config --modversion libavcodec` 为 60.x)。 控制端的 `viewer-ffmpeg` 只支持 **FFmpeg 6.x**(`pkg-config --modversion libavcodec` 为 60.x);FFmpeg 7 及以上会在依赖 `ffmpeg-sys-next` 里报 `avfft.h file not found`(#63)。
FFmpeg 7 及以上会在依赖 `ffmpeg-sys-next` 里报 `avfft.h file not found`——它的构建脚本先于本项目运行,所以无法提前给出更清楚的提示(#63)。 服务端可选的 `--features inproc-av` 是 X11 下的进程内硬件编码:不链接 FFmpeg 开发库,NVENC 运行时加载 NVIDIA 驱动库(`libcuda.so.1`、`libnvidia-encode.so.1`,需要支持 NVENC API 12.1 的驱动,530 及以上),VAAPI 运行时加载 `libva.so.2`/`libva-drm.so.2`。截屏与编码尺寸一致时 NVENC 直接读取 XShm 缓冲,省去一次主机到显存的拷贝;VAAPI 在同一特性下也进程内运行(DRI3 DMA-BUF 零拷贝,无 DRI3 时 XShm 上传,VPP 转 NV12 后送 VCN,支持 H.264/H.265)。CPU 编码或 `UU_CAPTURE=grab` 仍走外部 FFmpeg 进程;进程内硬件编码启动失败时先回退到对应的 FFmpeg 进程管线,再回退到 CPU。默认构建和预编译包都不需要该特性。
默认构建和预编译包都不需要这两个特性。
### 3. 登录 ### 3. 登录
@@ -186,6 +195,10 @@ FFmpeg 7 及以上会在依赖 `ffmpeg-sys-next` 里报 `avfft.h file not found`
用手机上的 **网易 UU 远程 App** 扫码并确认即可。登录信息只保存在本机的 用手机上的 **网易 UU 远程 App** 扫码并确认即可。登录信息只保存在本机的
`~/.config/uuremote/config.json`(权限 0600)里。 `~/.config/uuremote/config.json`(权限 0600)里。
登录状态查询失败或达到 60 秒请求超时不代表二维码已过期,也不代表手机已经确认。程序保留官方客户端的刷新策略:查询出错后点击「刷新二维码」(终端按回车;无窗口且无终端时 60 秒后刷新)。二维码请求诊断只包含请求阶段、错误类别、耗时、HTTP/API 状态及最后已知扫码状态,不输出票据、URL 或响应内容;`connect` 类别本身不能确定是 DNS、TLS 还是代理问题。
这个文件里还有本机的设备身份(`device_id`、`client_id`、`system_id`),重装软件和重新扫码登录都会沿用它。**不要在机器之间拷贝 `config.json`,也不要从带着家目录的快照/数据盘克隆出第二台主机**:同一身份的两个主机实例(不论在同一台还是不同机器上)会互相把对方踢出房间,日志表现为每隔几秒出现 `Cloud room leave without peer identifier` 并反复重连,控制端一连就断。克隆或拷贝出来的机器先停掉服务,删掉配置里这三个键和 `token`、`csrf`、`user_id`,再运行 `uuremote-server login` 注册为新设备。同一台机器上残留的旧实例(例如以前手动启动的 `~/.local/bin/uuremote-server`)也会这样,`uuremote-server doctor` 发现多个主机实例时会提示。
### 4. 作为用户服务常驻 ### 4. 作为用户服务常驻
`~/.config/systemd/user/uuremote-native.service`: `~/.config/systemd/user/uuremote-native.service`:
@@ -194,17 +207,17 @@ FFmpeg 7 及以上会在依赖 `ffmpeg-sys-next` 里报 `avfft.h file not found`
[Unit] [Unit]
Description=UU Remote Linux host (unofficial) Description=UU Remote Linux host (unofficial)
After=graphical-session.target After=graphical-session.target
PartOf=graphical-session.target
[Service] [Service]
Environment=RUST_LOG=info Environment=RUST_LOG=info
# X11 桌面需要指明显示器;GNOME 的 XAUTHORITY 一般在 /run/user/<uid>/gdm/Xauthority # GNOME/KDE 等桌面会把 DISPLAY / WAYLAND_DISPLAY 导入用户管理器,并启动 graphical-session.target
Environment=DISPLAY=:0
ExecStart=%h/.local/bin/uuremote-server ExecStart=%h/.local/bin/uuremote-server
Restart=always Restart=always
RestartSec=5 RestartSec=5
[Install] [Install]
WantedBy=default.target WantedBy=graphical-session.target
``` ```
```sh ```sh
@@ -216,6 +229,9 @@ journalctl --user -u uuremote-native.service -f # 看到 availability=Some("re
如果还没有登录,服务会自动在桌面上弹出扫码窗口。 如果还没有登录,服务会自动在桌面上弹出扫码窗口。
Xfce、i3 等不启动 `graphical-session.target` 的桌面,按上面的写法开机不会自启:把 `[Install]` 改成 `WantedBy=default.target`,
并加上 `Environment=DISPLAY=:0`(按实际显示器填写),再重新 `enable`。下文的无头模式、虚拟桌面也要用 `default.target`。
### 5. Wayland 下使用 uinput 虚拟键鼠(推荐) ### 5. Wayland 下使用 uinput 虚拟键鼠(推荐)
Wayland(尤其是 GNOME/KDE portal)下,默认的键鼠注入要经过 portal 授权,部分键盘布局下还会丢符号(比如下划线)。 Wayland(尤其是 GNOME/KDE portal)下,默认的键鼠注入要经过 portal 授权,部分键盘布局下还会丢符号(比如下划线)。
@@ -255,7 +271,7 @@ install -Dm644 contrib/desktop/uu-remote-linux-viewer.desktop ~/.local/share/app
## 没有显示器的服务器 ## 没有显示器的服务器
**无头模式**:只要终端、文件传输和端口映射,不需要图形界面。在服务里加 `Environment=UU_DESKTOP_BACKEND=none`, **无头模式**:只要终端、文件传输和端口映射,不需要图形界面。在服务里加 `Environment=UU_DESKTOP_BACKEND=none`,
再执行 `loginctl enable-linger $USER`,这样开机后不用登录,systemd 用户服务(以及 `XDG_RUNTIME_DIR`、用户 D-Bus)也会自动启动。 把 `[Install]` 改成 `WantedBy=default.target`(无人登录时 `graphical-session.target` 不会启动),再执行 `loginctl enable-linger $USER`,这样开机后不用登录,systemd 用户服务(以及 `XDG_RUNTIME_DIR`、用户 D-Bus)也会自动启动。
无头模式下控制端点「远程桌面」会一直显示正在连接,这是正常的。首次登录用 `uuremote-server login --no-gui` 在终端里扫码。 无头模式下控制端点「远程桌面」会一直显示正在连接,这是正常的。首次登录用 `uuremote-server login --no-gui` 在终端里扫码。
**群晖 / NAS(Docker)**:没有桌面的 NAS 可以用容器运行无头模式(文件传输、终端、端口映射)。 **群晖 / NAS(Docker)**:没有桌面的 NAS 可以用容器运行无头模式(文件传输、终端、端口映射)。
@@ -295,12 +311,18 @@ systemctl --user restart uuremote-native.service
|---|---| |---|---|
| `UU_CONFIG` | 配置文件路径(默认 `~/.config/uuremote/config.json`) | | `UU_CONFIG` | 配置文件路径(默认 `~/.config/uuremote/config.json`) |
| `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms`(实验性特性) / `none`(无头模式) | | `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms`(实验性特性) / `none`(无头模式) |
| `UU_DESKTOP_RESIZE=0` | X11 下控制端切换分辨率时不改桌面分辨率,只缩放编码画面 |
| `UU_NVENC_RGB=0` / `=1` | NVENC 直接编码 BGRA(省 CPU)。显示器接在 NVIDIA 卡上时默认关闭(同卡合成时直吃反而更慢),`0` 强制关,`1` 强制开 |
| `UU_WAYLAND_MULTISCREEN=1` | 启用 Hyprland 物理显示器切换(默认关闭) | | `UU_WAYLAND_MULTISCREEN=1` | 启用 Hyprland 物理显示器切换(默认关闭) |
| `UU_WAYLAND_OUTPUT` | 原生 Wayland 默认采集输出名称,例如 `HDMI-A-1` | | `UU_WAYLAND_OUTPUT` | 原生 Wayland 默认采集输出名称,例如 `HDMI-A-1` |
| `UU_X11_MULTISCREEN=1` | X11 下按显示器分别选择和采集(实验性,默认关闭,需要 `xrandr`) |
| `UU_X11_OUTPUT` | X11 默认采集的显示器名称(`xrandr --listmonitors`),默认主显示器 |
| `UU_WAYLAND_NO_VIRTUAL_KEYBOARD=1` | 原生 Wayland 不创建虚拟键盘(如 Denial 只把它给自己的输入法),键盘改走 uinput。合成器没有 wlr-virtual-pointer 时鼠标也自动改走 uinput(#72) |
| `UU_INPUT_BACKEND` | `auto`(默认,Wayland 下可用时用 uinput)/ `uinput` / `native` | | `UU_INPUT_BACKEND` | `auto`(默认,Wayland 下可用时用 uinput)/ `uinput` / `native` |
| `UU_TERMINAL_SHORTCUTS=0` | 关闭终端窗口里的 Ctrl+V 粘贴转换 | | `UU_TERMINAL_SHORTCUTS=0` | 关闭终端窗口里的 Ctrl+V 粘贴转换 |
| `UU_VIDEO_ENCODER` | `cpu` 强制 CPU;`vaapi` 显式启用 Intel/AMD 硬编;`nvenc` 强制 NVENC;未设置时检测到 NVIDIA 驱动才用 NVENC,否则用 CPU | | `UU_VIDEO_ENCODER` | `cpu` 强制 CPU;`vaapi` 显式启用 Intel/AMD 硬编;`nvenc` 强制 NVENC;未设置或 `auto` 时后台探测(每个候选编码一帧,限时 3 秒)。有 NVIDIA 驱动时顺序是 NVENC → CPU;没有 NVIDIA 时只有 CPU,不探测。探测未完成就建流则沿用旧规则(有 NVIDIA 用 NVENC,否则 CPU)。自行编译的 `--features inproc-av` 上,仅 X11 会先走进程内引擎:外部 FFmpeg 探测失败时记为 `native_unprobed`,沿用旧规则(NVENC);Wayland、portal、KMS 回退 CPU。只有 CPU 时跳过探测,记为 `not probed (only candidate)`。探测成功和这种只含 CPU 的跳过会缓存到 NVIDIA 是否存在发生变化为止(`/proc/driver/nvidia/version` 或 `/dev/nvidia0`)。之后的桌面连接在后台再探测一次(不挡住这一路,仍用缓存的编码器)。NVENC 探测失败、选用 CPU 时只缓存 10 分钟;到期后下一次桌面连接同样在后台再探测一次,再次失败则重新计 10 分钟。显式 `cpu` / `vaapi` / `nvenc` 不启动探测。`native_unprobed` 不算失败缓存。优先级低于 `host_settings.json` 里非 `auto` 的 `video_encoder`。VAAPI 要等 #33 解决后才会进入 auto |
| `UU_VAAPI_BUFFER_MS` | VAAPI 的 VBV 缓冲(10–1000 ms,仅 `UU_VIDEO_ENCODER=vaapi` 时生效);高分辨率下关键帧被压糊时用它换稳定画质 | | `UU_VAAPI_BUFFER_MS` | VAAPI 的 VBV 缓冲(10–1000 ms,仅 `UU_VIDEO_ENCODER=vaapi` 时生效);高分辨率下关键帧被压糊时用它换稳定画质 |
| `UU_NVENC_BUFFER_MS` | NVENC 的 VBV 缓冲(10–1000 ms,仅 NVENC 生效,含进程内引擎);默认 100–500 kbit,1440p 等高分辨率下关键帧被压糊、按 GOP 周期闪烁时设 `1000`(#103) |
| `UU_FFMPEG_ROOT` | 使用指定目录下的 FFmpeg | | `UU_FFMPEG_ROOT` | 使用指定目录下的 FFmpeg |
| `UU_AUDIO=0` | 关闭声音转发;`UU_AUDIO_SOURCE` 指定 PulseAudio 采集源 | | `UU_AUDIO=0` | 关闭声音转发;`UU_AUDIO_SOURCE` 指定 PulseAudio 采集源 |
| `UU_LOGIN_WINDOW=0` | 凭证缺失时不自动弹出登录窗口 | | `UU_LOGIN_WINDOW=0` | 凭证缺失时不自动弹出登录窗口 |
@@ -308,9 +330,14 @@ systemctl --user restart uuremote-native.service
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) | | `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) | | `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
| `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) | | `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) |
| `UU_USE_PROXY=1` | 使用环境变量里的 HTTP/SOCKS 代理;默认忽略代理、直连网易服务器 | | `UU_USE_PROXY=1` | REST API 与 host/viewer WebSocket 信令共用环境 HTTP/HTTPS 代理策略;默认忽略代理、直连 |
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。
`UU_USE_PROXY=1` 仅使用当前进程已有的代理配置;`HTTP_PROXY` / `HTTPS_PROXY` / `ALL_PROXY`(及小写形式)和 `NO_PROXY` 按 reqwest 的标准规则选择,大写优先。信令拒绝选定变量中的无效/不支持的代理 URL(仅 HTTP/HTTPS;不支持 SOCKS)、带路径/查询/片段的代理 URL,以及会忽略代理的 CGI 环境;此校验比 reqwest 默默忽略坏值更严格。未配置匹配代理或命中 `NO_PROXY` 时仍正常直连,选中代理后连接失败不会改为直连。信令保留 TLS 证书校验,不跟随重定向,也不转发认证头到重定向目标。
开启后主机还会经 TCP/TLS 连接云端 TURN 中继(使用 `HTTPS_PROXY`/`ALL_PROXY` 里的无认证 `http://` 代理做 CONNECT,没有代理则直连),适用于 UDP 到不了 TURN 服务器、只有 TCP/代理能出网的主机;TURN 证书按 CA 链校验,云端下发的 TURN 地址是 IP 时容忍名称不匹配(媒体本身由 DTLS-SRTP 端到端加密)。默认(不开代理)只用 UDP 中继,行为不变。**这不创建任何新的网络出口**:登录、信令和媒体仍需各自有允许使用的网络路径。连接器只返回固定错误类别/HTTP 状态;不要为诊断开启会记录 URL/认证信息的依赖库 TRACE 日志。
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。同一文件里的 `video_encoder`(`auto`/`cpu`/`vaapi`/`nvenc`)和 `video_codec`(`auto`/`h264`/`h265`)用 `uuremote-server set-encoder`、`uuremote-server set-codec` 写入(非法参数退出码 2)。非 `auto` 的值优先于 `UU_VIDEO_ENCODER` / `UU_VIDEO_CODEC`;`auto` 或留空则落到环境变量,再落到 auto(有 NVIDIA 时 NVENC 优先,失败再 CPU;没有 NVIDIA 时就是 CPU,不探测;codec 仍是硬件优先 H.265、CPU 用 H.264)。探测在启动时后台进行,不挡住第一路出图。成功结果缓存到进程退出,但 NVIDIA 是否存在(`/proc/driver/nvidia/version` 或 `/dev/nvidia0`)与报告不一致时,下一次桌面连接会在后台再探测一次(`warm_auto_probe`),这一路仍用缓存的编码器,直到新结果写入。NVENC 失败只缓存 10 分钟,到期后的桌面连接同样在后台再探测一次,这一路仍用当前结果。`set-encoder` 和 `set-codec` 写完后若 `host.pid` 指向正在运行的本程序,都会发 `SIGUSR2`:编码器变化时进行中的桌面流立刻换编码器(不断开,沿用本会话已协商的 codec;新编码器起不来时按进程内 → FFmpeg 进程 → CPU 回退)。手改文件后可 `kill -USR2 $(cat ~/.config/uuremote/host.pid)`。`SIGUSR2` 不重新探测。codec 偏好仍在下次建立桌面连接时生效(运行中的 host 只记日志,不重开编码)。显式 `vaapi` 请求真彩时仍用 VAAPI、编码 4:2:0,并在 CaptureSettingSync 的 field 3 回报 4:2:0。所选编码器在本机不可用时,建流回退 CPU 并记 warning。VAAPI 进入 auto 要等 #33。
自定义码率按客户端选择的 Mbps 生效,例如 1 Mbps 对应 1000 kbit/s 的编码上限。 自定义码率按客户端选择的 Mbps 生效,例如 1 Mbps 对应 1000 kbit/s 的编码上限。
@@ -376,13 +403,14 @@ HEVC 的访问单元按 RFC 7798 的图片边界切分,不依赖 AUD:`hevc_v
画面从码流里丢掉,读取端按 AUD 切分就会把整个 GOP 当成一帧,再被 IRAP 门控全部拒绝——对外表现为连接停在 画面从码流里丢掉,读取端按 AUD 切分就会把整个 GOP 当成一帧,再被 IRAP 门控全部拒绝——对外表现为连接停在
「正在传输画面」,而主机侧只有约 12 kbit/s。`UU_VIDEO_CODEC=h265` 可显式选中 H.265,便于对照排查。 「正在传输画面」,而主机侧只有约 12 kbit/s。`UU_VIDEO_CODEC=h265` 可显式选中 H.265,便于对照排查。
### VAAPI 硬件编码(显式启用) ### VAAPI 硬件编码
设置 `UU_VIDEO_ENCODER=vaapi` 使用 Intel/AMD H.264 VAAPI;`UU_VAAPI_DEVICE` 默认 `UU_VIDEO_ENCODER=vaapi` 或 `set-encoder vaapi` 显式选择 Intel/AMD H.264 VAAPI。
`/dev/dri/renderD128`,运行用户需要 render 节点权限。不会自动选择 VAAPI;设备或驱动初始化 `UU_VAAPI_DEVICE` 默认 `/dev/dri/renderD128`,运行用户需要 render 节点权限。
失败会明确警告并回退 libx264。外部 FFmpeg 和 `--features inproc-av` 均先转 NV12 再上传硬件帧。 `auto` 有 NVIDIA 驱动时是 NVENC → CPU,没有 NVIDIA 时是 CPU。VAAPI 只通过显式选择启用,进入 auto 要等 #33。
设备或驱动初始化失败会明确警告并回退 libx264。外部 FFmpeg 先转 NV12 再上传硬件帧。
VBR 使用控制端码率预设及 CQ 对应的最小 QP,无 B 帧、async depth=1,并保留现有 GOP/VFR 规则。 VBR 使用控制端码率预设及 CQ 对应的最小 QP,无 B 帧、async depth=1,并保留现有 GOP/VFR 规则。
Intel 核显(UHD 770,iHD 驱动)已实机验收:默认的外部 FFmpeg 管线用官方 Mac 控制端测试了各档画质、帧率、缩放和重连,全程硬件编码、无回退,CPU 占用比 libx264 低约 40%。**AMD 显卡和 `--features inproc-av` 管线的 VAAPI 尚未实机验证。** Intel 核显(UHD 770,iHD 驱动)已实机验收:默认的外部 FFmpeg 管线用官方 Mac 控制端测试了各档画质、帧率、缩放和重连,全程硬件编码、无回退,CPU 占用比 libx264 低约 40%(该数字为 FFmpeg 进程管线时代的测量)。AMD 核显已在**进程内原生引擎**上实机验收(`--features inproc-av`):官方 Mac 客户端的端到端会话在 HawkPoint(Mesa 26.2.3)与 Cezanne(Mesa 26.2.5)上通过验收(HEVC,含画质档、帧率、缩放);Cezanne 上另以探测验证了 H.264 与两条采集路径——XShm 上传(码流可解码、画面正确)与 DRI3 DMA-BUF 零拷贝导入。同机实测(1920×1200@60,Cezanne iGPU + RTX 3050 Ti 双显卡):进程内 VAAPI 每帧编码 CPU 约为 libx264(FFmpeg 管线 superfast)的 **1/12**、进程内 NVENC 的 **1/5**;外部 FFmpeg 进程管线(预编译包使用)在 AMD 上未单独验证。
高分辨率下 VAAPI 的默认 VBV 缓冲(100–500 kbit)会把关键帧压得过狠:2560×1440 H.264 VAAPI、30M 高分辨率下 VAAPI 的默认 VBV 缓冲(100–500 kbit)会把关键帧压得过狠:2560×1440 H.264 VAAPI、30M
上限、静止画面上实测首个 IDR 只有 59,910 字节,画面每隔一个 GOP 糊一下再慢慢恢复。设 上限、静止画面上实测首个 IDR 只有 59,910 字节,画面每隔一个 GOP 糊一下再慢慢恢复。设
@@ -447,8 +475,7 @@ WantedBy=graphical-session.target
VAAPI 可选包:Intel 新显卡用 `intel-media-driver`,AMD 用 `libva-mesa-driver`,`libva-utils` 提供 VAAPI 可选包:Intel 新显卡用 `intel-media-driver`,AMD 用 `libva-mesa-driver`,`libva-utils` 提供
`vainfo`。KMS 依赖 `libdrm`。虚拟 Xfce 依赖 `xorg-server-xvfb xorg-xauth xorg-xdpyinfo `vainfo`。KMS 依赖 `libdrm`。虚拟 Xfce 依赖 `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`。 xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`。
滚动 Arch 的 FFmpeg 可能超出 `inproc-av` 支持的 6.x;请使用默认进程方案或独立的 FFmpeg 6 前缀, 若编译包含 `viewer-ffmpeg`,滚动 Arch 的 FFmpeg 可能超出其支持的 6.x;请使用独立的 FFmpeg 6 前缀,不要降级系统 FFmpeg(服务端的 `--features inproc-av` 原生 NVENC 不依赖 FFmpeg)。
不要降级系统 FFmpeg。
### 实验性 KMS 截屏 ### 实验性 KMS 截屏
@@ -480,6 +507,19 @@ GNOME 与官方 Mac 被控端的双向剪贴板尚未验证通过;此修改不
- 命令行:`connect DEVICE false - echo legacy [--view-only]`(桌面)、`files DEVICE ls|get|put …`、`terminal DEVICE [SESSION]`、 - 命令行:`connect DEVICE false - echo legacy [--view-only]`(桌面)、`files DEVICE ls|get|put …`、`terminal DEVICE [SESSION]`、
`terminal-ui DEVICE NAME`、`portmap DEVICE LOCAL_PORT HOST PORT`(只监听 127.0.0.1)、`power DEVICE reboot|shutdown`、`unbind DEVICE`(从账号删除设备,启动窗口「更多工具」里也有)、 `terminal-ui DEVICE NAME`、`portmap DEVICE LOCAL_PORT HOST PORT`(只监听 127.0.0.1)、`power DEVICE reboot|shutdown`、`unbind DEVICE`(从账号删除设备,启动窗口「更多工具」里也有)、
`assist CONNECT_ID`(验证码从 stdin 读取一行,不能作为参数传入)。`uuremote-viewer --help` 查看全部参数。 `assist CONNECT_ID`(验证码从 stdin 读取一行,不能作为参数传入)。`uuremote-viewer --help` 查看全部参数。
- **安全输入 `type`**(向已打开的桌面会话注入键盘,适合锁屏 PIN / 密码;文本永不进 argv):
```sh
# 推荐:先 ui/connect 打开桌面,再 type(复用会话,不顶掉当前画面)
UU_INPUT_ENV=UU_SECRET UU_SECRET='……' \
uuremote-viewer type DEVICE [--delay-ms 40] [--omit-last 1] [--snapshot /path/out.png]
# 或:printf '%s' '……' | uuremote-viewer type DEVICE
# 只检查、不连网:uuremote-viewer type DEVICE --dry-run
# 没有正在运行的桌面会话时必须显式:--new-session(会新开连接,并顶掉已打开的桌面窗口,见上游 #30)
```
特殊键用花括号:`{Enter}` `{Tab}` `{Esc}` `{Backspace}` `{Ctrl+Alt+Del}` 等;`{{` 表示字面 `{`。
**布局**:字符按 **US QWERTY** 物理键位映射(非美式布局的符号/字母可能对不上)。
**Windows 数字 PIN**:输满位数后系统常会自动提交,一般不必再发 `{Enter}`;若只想填入、不登录,用 `--omit-last N` 省略最后 N 个字符。
日志与 `--dry-run` 输出只含长度/事件数,不含明文。复用会话时,发送约 1 秒后会保存一帧 PNG(默认写在 `$XDG_RUNTIME_DIR/uu-viewer-type/`,权限 0600),路径打在日志并打印 `snapshot=…`。
- 桌面窗口中按 Ctrl+Alt+F 打开文件窗口(复用同一连接)。`UU_VIEWER_AUDIO=0` 关闭声音,`UU_VIEWER_CLIPBOARD=0` 关闭剪贴板, - 桌面窗口中按 Ctrl+Alt+F 打开文件窗口(复用同一连接)。`UU_VIEWER_AUDIO=0` 关闭声音,`UU_VIEWER_CLIPBOARD=0` 关闭剪贴板,
`UU_VIEWER_VIEW_ONLY=1` 只看不控,`UU_VIEWER_FFMPEG` 指定 ffmpeg 路径。 `UU_VIEWER_VIEW_ONLY=1` 只看不控,`UU_VIEWER_FFMPEG` 指定 ffmpeg 路径。
- 桌面同时提供 H.264 / H.265,由主机协商选择;`UU_VIEWER_CODEC=h264` 将 SDP 和解码能力限制为 H.264。 - 桌面同时提供 H.264 / H.265,由主机协商选择;`UU_VIEWER_CODEC=h264` 将 SDP 和解码能力限制为 H.264。
+133
View File
@@ -0,0 +1,133 @@
//! Standalone benchmark tool measuring:
//! 1. Host Memory Copy Bandwidth & CPU Cost (What FFmpeg/Sway CPU swizzling does)
//! 2. NVENC H.265 Hardware Throughput & Latency (1920x1200 @ ultra-low-latency)
//! 3. NVENC reading a registered (pinned) host buffer
use std::time::Instant;
fn main() {
println!("=========================================================");
println!(" UU Remote Linux: Encoder Pipeline Benchmark Suite ");
println!("=========================================================");
println!();
let width: u32 = 1920;
let height: u32 = 1200;
let frames: usize = 300; // 5 seconds of 60fps video
let frame_bytes: usize = (width * height * 4) as usize;
println!("Test Configuration:");
println!(" Resolution : {}x{}", width, height);
println!(" Frame Size : {:.2} MB (ARGB32)", frame_bytes as f64 / 1024.0 / 1024.0);
println!(" Iterations : {} frames (Equivalent to 5.0s @ 60 FPS)", frames);
println!();
// Simulating XShm framebuffer
let mut host_pixels = vec![0x55u8; frame_bytes];
// Benchmark 1: CPU Memcpy (External FFmpeg stdin / Sway wlr-screencopy CPU copy baseline)
println!("[1] Baseline: CPU Frame Memcpy Overhead (IPC / Process Pipe Cost)");
let mut sink = vec![0u8; frame_bytes];
let start_memcpy = Instant::now();
for _ in 0..frames {
sink.copy_from_slice(&host_pixels);
std::hint::black_box(&sink);
}
let duration_memcpy = start_memcpy.elapsed();
let memcpy_per_frame = duration_memcpy.as_secs_f64() * 1000.0 / frames as f64;
let memcpy_gbps = (frame_bytes * frames) as f64 / duration_memcpy.as_secs_f64() / 1e9;
let cpu_load_60fps = (memcpy_per_frame / (1000.0 / 60.0)) * 100.0;
println!(" -> Total CPU copy time : {:.2?}", duration_memcpy);
println!(" -> Per-frame copy time : {:.3} ms", memcpy_per_frame);
println!(" -> Memory Bus Bandwidth : {:.2} GB/s", memcpy_gbps);
println!(" -> CPU Core Saturation : {:.1}% of 1 core consumed solely by memcpy at 60 FPS", cpu_load_60fps);
println!();
// Benchmark 2: in-process NVENC reading a registered host buffer (device copy when registration fails)
#[cfg(feature = "inproc-av")]
{
extern "C" {
fn nvenc_create(config: *const NvencConfigFFI) -> *mut std::ffi::c_void;
fn nvenc_register_host_buffer(
engine: *mut std::ffi::c_void,
host_ptr: *mut std::ffi::c_void,
size: usize,
) -> i32;
fn nvenc_encode_frame(
engine: *mut std::ffi::c_void,
input_argb: *const u8,
pitch: u32,
force_idr: i32,
out_data: *mut *const u8,
out_len: *mut u32,
) -> i32;
fn nvenc_destroy(engine: *mut std::ffi::c_void);
}
// Must match NvencConfig in c_engine/nvenc_engine.h.
#[repr(C)]
struct NvencConfigFFI {
width: u32,
height: u32,
fps: u32,
gop: u32,
cq: u32,
target_bps: i64,
max_bps: i64,
buffer_bits: i64,
is_hevc: i32,
chroma_444: i32,
}
let cfg = NvencConfigFFI {
width,
height,
fps: 60,
gop: 120,
cq: 18,
target_bps: 16_000_000,
max_bps: 30_000_000,
buffer_bits: 500_000,
is_hevc: 1, // H.265 / HEVC
chroma_444: i32::from(std::env::var("UU_BENCH_CHROMA").as_deref() == Ok("444")),
};
println!("[2] In-process NVENC H.265 encoding");
unsafe {
let engine = nvenc_create(&cfg);
if engine.is_null() {
println!(" [SKIP] NVENC driver not available on this system.");
} else {
let registered = nvenc_register_host_buffer(engine, host_pixels.as_mut_ptr() as *mut _, frame_bytes) == 0;
println!(" -> Input path : {}", if registered { "registered host buffer (DMA)" } else { "cuMemcpyHtoD copy" });
let input = if registered { std::ptr::null() } else { host_pixels.as_ptr() };
let mut out_data: *const u8 = std::ptr::null();
let mut out_len: u32 = 0;
// Warmup
let _ = nvenc_encode_frame(engine, input, width * 4, 1, &mut out_data, &mut out_len);
let start = Instant::now();
let (mut encoded_bytes, mut encoded_frames) = (0u64, 0usize);
for i in 0..frames {
if nvenc_encode_frame(engine, input, width * 4, i32::from(i == 0), &mut out_data, &mut out_len) == 0 {
encoded_bytes += u64::from(out_len);
encoded_frames += 1;
}
}
let elapsed = start.elapsed();
if encoded_frames == 0 {
println!(" [FAIL] no frame was encoded");
} else {
let per_frame = elapsed.as_secs_f64() * 1000.0 / encoded_frames as f64;
println!(" -> Encoded frames : {encoded_frames}/{frames} in {elapsed:.2?}");
println!(" -> Per-frame latency : {per_frame:.3} ms ({:.1} FPS max)", 1000.0 / per_frame);
println!(" -> Output bitrate : {:.2} Mbps average", encoded_bytes as f64 * 8.0 / elapsed.as_secs_f64() / 1e6);
if registered {
println!(" -> Host-to-device copy : none ({:.0} MB/s at 60 fps avoided)", frame_bytes as f64 * 60.0 / 1024.0 / 1024.0);
}
}
nvenc_destroy(engine);
}
}
}
}
+24 -4
View File
@@ -1,6 +1,10 @@
fn main() { fn main() {
println!("cargo:rerun-if-changed=c_engine/portal_clipboard.inc"); println!("cargo:rerun-if-changed=c_engine/portal_clipboard.inc");
println!("cargo:rerun-if-changed=c_engine/x11_engine.c"); println!("cargo:rerun-if-changed=c_engine/x11_engine.c");
println!("cargo:rerun-if-changed=c_engine/nvenc_engine.c");
println!("cargo:rerun-if-changed=c_engine/nvenc_engine.h");
println!("cargo:rerun-if-changed=vendor/ffnvcodec/ffnvcodec/dynlink_cuda.h");
println!("cargo:rerun-if-changed=vendor/ffnvcodec/ffnvcodec/nvEncodeAPI.h");
println!("cargo:rerun-if-changed=c_engine/clipboard.c"); println!("cargo:rerun-if-changed=c_engine/clipboard.c");
println!("cargo:rerun-if-changed=c_engine/assist_window.c"); println!("cargo:rerun-if-changed=c_engine/assist_window.c");
println!("cargo:rerun-if-changed=c_engine/viewer_window.c"); println!("cargo:rerun-if-changed=c_engine/viewer_window.c");
@@ -21,11 +25,27 @@ fn main() {
build.compile("uu_kms_engine"); build.compile("uu_kms_engine");
println!("cargo:rustc-link-lib=drm"); println!("cargo:rustc-link-lib=drm");
} }
cc::Build::new() let mut x11_build = cc::Build::new();
.file("c_engine/x11_engine.c") x11_build.file("c_engine/x11_engine.c")
.file("c_engine/clipboard.c") .file("c_engine/clipboard.c")
.file("c_engine/pam_check.c") .file("c_engine/pam_check.c");
.compile("x11_engine"); if std::env::var_os("CARGO_FEATURE_INPROC_AV").is_some() {
x11_build.file("c_engine/nvenc_engine.c");
x11_build.file("c_engine/vaapi_engine.c");
x11_build.file("c_engine/dri3_capture.c");
for f in ["c_engine/vaapi_engine.c", "c_engine/vaapi_engine.h", "c_engine/dri3_capture.c", "c_engine/dri3_capture.h"] {
println!("cargo:rerun-if-changed={f}");
}
x11_build.include("vendor/ffnvcodec");
// libva/libva-drm are dlopen'ed at runtime (like NVENC's libcuda); these are
// link-time-only deps of the DRI3/VAAPI engines and must stay out of default builds.
println!("cargo:rustc-link-lib=gbm");
println!("cargo:rustc-link-lib=X11-xcb");
println!("cargo:rustc-link-lib=xcb");
println!("cargo:rustc-link-lib=xcb-dri3");
println!("cargo:rustc-link-lib=xcb-damage");
}
x11_build.compile("x11_engine");
println!("cargo:rustc-link-lib=X11"); println!("cargo:rustc-link-lib=X11");
println!("cargo:rustc-link-lib=Xext"); println!("cargo:rustc-link-lib=Xext");
+110 -3
View File
@@ -46,7 +46,10 @@ static pthread_cond_t init_cond = PTHREAD_COND_INITIALIZER;
static GtkWidget *window, *allow_switch, *id_label, *code_label, *eye_button, *share_button, *hint_label, *verify_combo, *note_label; static GtkWidget *window, *allow_switch, *id_label, *code_label, *eye_button, *share_button, *hint_label, *verify_combo, *note_label;
static GtkWidget *refresh_items[5], *footer_label; static GtkWidget *refresh_items[5], *footer_label;
// Account card: QR login before sign-in, user info (+ logout) after. // Account card: QR login before sign-in, user info (+ logout) after.
static GtkWidget *assist_card, *account_card, *account_stack, *qr_stack, *qr_image, *login_status, *user_label; static GtkWidget *assist_card, *account_card, *account_stack, *qr_stack, *qr_image, *login_status, *user_label, *qr_refresh;
/* Like the official client, a failed or timed-out QR stays until the user asks for a new one. */
static atomic_int qr_refresh_requested;
static void on_qr_refresh(GtkButton *b, gpointer d) { (void)b; (void)d; atomic_store(&qr_refresh_requested, 1); gtk_widget_hide(qr_refresh); }
static int show_assist = 1, show_account; static int show_assist = 1, show_account;
// Tray (host service only): AppIndicator via dlopen (no build dependency), else GtkStatusIcon. // Tray (host service only): AppIndicator via dlopen (no build dependency), else GtkStatusIcon.
static GtkWidget *tray_menu, *tray_allow; static GtkWidget *tray_menu, *tray_allow;
@@ -54,6 +57,10 @@ static int suppress_tray;
static int cur_verify, cur_refresh, cur_has_custom; static int cur_verify, cur_refresh, cur_has_custom;
static char current_id[64], current_code[64]; static char current_id[64], current_code[64];
static int code_visible = 1, suppress_switch, start_hidden, close_hides; static int code_visible = 1, suppress_switch, start_hidden, close_hides;
// A problem only the person at the desktop can fix (e.g. FFmpeg missing): red line at the top.
static GtkWidget *problem_label;
static gchar *problem_text;
static pthread_mutex_t problem_lock = PTHREAD_MUTEX_INITIALIZER;
static GtkWidget *label(const char *text, const char *cls) { static GtkWidget *label(const char *text, const char *cls) {
GtkWidget *l = gtk_label_new(text); GtkWidget *l = gtk_label_new(text);
@@ -250,6 +257,11 @@ static GtkWidget *build_account_card(void) {
login_status = label("", "status"); login_status = label("", "status");
gtk_label_set_line_wrap(GTK_LABEL(login_status), TRUE); gtk_label_set_line_wrap(GTK_LABEL(login_status), TRUE);
gtk_box_pack_start(GTK_BOX(qr_text), login_status, FALSE, FALSE, 0); gtk_box_pack_start(GTK_BOX(qr_text), login_status, FALSE, FALSE, 0);
qr_refresh = gtk_button_new_with_label("刷新二维码");
gtk_widget_set_halign(qr_refresh, GTK_ALIGN_START);
gtk_widget_set_no_show_all(qr_refresh, TRUE);
g_signal_connect(qr_refresh, "clicked", G_CALLBACK(on_qr_refresh), NULL);
gtk_box_pack_start(GTK_BOX(qr_text), qr_refresh, FALSE, FALSE, 0);
gtk_box_pack_start(GTK_BOX(qr_page), qr_text, TRUE, TRUE, 0); gtk_box_pack_start(GTK_BOX(qr_page), qr_text, TRUE, TRUE, 0);
gtk_stack_add_named(GTK_STACK(account_stack), qr_page, "qr"); gtk_stack_add_named(GTK_STACK(account_stack), qr_page, "qr");
@@ -297,6 +309,32 @@ static void on_status_menu(GtkStatusIcon *i, guint button, guint time, gpointer
(void)i; (void)button; (void)time; (void)d; (void)i; (void)button; (void)time; (void)d;
gtk_menu_popup_at_pointer(GTK_MENU(tray_menu), NULL); gtk_menu_popup_at_pointer(GTK_MENU(tray_menu), NULL);
} }
// Monochrome tray icon that follows light/dark panels: GTK and the GNOME AppIndicator extension
// recolor "-symbolic" names, KDE recolors the ColorScheme-Text class. Installed into the user's
// hicolor theme (found by every panel's default lookup) and also offered as the icon theme path,
// so it needs no package install. KDE tries dash-trimmed names ("uu-remote-linux") in each theme
// before the next one, so the name must not trim into the colored app icon (#87).
static const char TRAY_ICON_NAME[] = "uuremote-tray-symbolic";
static const char TRAY_ICON_SVG[] =
"<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\">"
"<style id=\"current-color-scheme\">.ColorScheme-Text{color:#232629}</style>"
"<path class=\"ColorScheme-Text\" fill=\"currentColor\" fill-rule=\"evenodd\" d=\"M2.5 2h11A1.5 1.5 0 0 1 15 3.5v7a1.5 1.5 0 0 1-1.5 1.5h-11"
"A1.5 1.5 0 0 1 1 10.5v-7A1.5 1.5 0 0 1 2.5 2zm0 1.5v7h11v-7z\"/>"
"<path class=\"ColorScheme-Text\" fill=\"currentColor\" d=\"M7.25 12h1.5v1.5H11a.75.75 0 0 1 0 1.5H5a.75.75 0 0 1 0-1.5h2.25z"
"M11.5 4.5v4l-1.35-1.35-3.1 3.1-1.2-1.2 3.1-3.1L7.5 4.5z\"/></svg>\n";
// Returns the icon theme root holding the icon ($XDG_DATA_HOME/icons), or NULL.
static gchar *write_tray_icon(void) {
gchar *root = g_build_filename(g_get_user_data_dir(), "icons", NULL);
gchar *apps = g_build_filename(root, "hicolor", "scalable", "apps", NULL);
gchar *file = g_strconcat(TRAY_ICON_NAME, ".svg", NULL);
gchar *path = g_build_filename(apps, file, NULL), *current = NULL;
// Rewriting an unchanged file would only make icon caches rescan.
int ok = g_file_get_contents(path, &current, NULL, NULL) && strcmp(current, TRAY_ICON_SVG) == 0;
if (!ok) ok = g_mkdir_with_parents(apps, 0755) == 0 && g_file_set_contents(path, TRAY_ICON_SVG, -1, NULL);
g_free(apps); g_free(file); g_free(path); g_free(current);
if (!ok) { g_free(root); return NULL; }
return root;
}
static void build_tray(void) { static void build_tray(void) {
tray_menu = gtk_menu_new(); tray_menu = gtk_menu_new();
GtkWidget *open = gtk_menu_item_new_with_label("打开主窗口"); GtkWidget *open = gtk_menu_item_new_with_label("打开主窗口");
@@ -310,7 +348,10 @@ static void build_tray(void) {
gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), gtk_separator_menu_item_new()); gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), gtk_separator_menu_item_new());
gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), quit); gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), quit);
gtk_widget_show_all(tray_menu); gtk_widget_show_all(tray_menu);
const char *icon = gtk_icon_theme_has_icon(gtk_icon_theme_get_default(), "uu-remote-linux") ? "uu-remote-linux" : "computer"; gchar *icon_path = write_tray_icon();
if (icon_path) gtk_icon_theme_append_search_path(gtk_icon_theme_get_default(), icon_path);
const char *fallback = gtk_icon_theme_has_icon(gtk_icon_theme_get_default(), "uu-remote-linux") ? "uu-remote-linux" : "computer";
const char *icon = icon_path ? TRAY_ICON_NAME : fallback;
// StatusNotifierItem (GNOME AppIndicator extension, KDE): libayatana-appindicator3 / libappindicator3. // StatusNotifierItem (GNOME AppIndicator extension, KDE): libayatana-appindicator3 / libappindicator3.
const char *libs[] = { "libayatana-appindicator3.so.1", "libappindicator3.so.1" }; const char *libs[] = { "libayatana-appindicator3.so.1", "libappindicator3.so.1" };
@@ -321,8 +362,11 @@ static void build_tray(void) {
void (*set_status)(void *, int) = (void (*)(void *, int))dlsym(h, "app_indicator_set_status"); void (*set_status)(void *, int) = (void (*)(void *, int))dlsym(h, "app_indicator_set_status");
void (*set_menu)(void *, GtkMenu *) = (void (*)(void *, GtkMenu *))dlsym(h, "app_indicator_set_menu"); void (*set_menu)(void *, GtkMenu *) = (void (*)(void *, GtkMenu *))dlsym(h, "app_indicator_set_menu");
void (*set_title)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_title"); void (*set_title)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_title");
void (*set_theme_path)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_icon_theme_path");
if (ind_new && set_status && set_menu) { if (ind_new && set_status && set_menu) {
void *ind = ind_new("uu-remote-linux", icon, 0 /* APPLICATION_STATUS */); // Without a theme path the panel cannot find the cached icon; keep the installed one.
void *ind = ind_new("uu-remote-linux", set_theme_path ? icon : fallback, 0 /* APPLICATION_STATUS */);
if (icon_path && set_theme_path) set_theme_path(ind, icon_path);
if (set_title) set_title(ind, "UU 远程 Linux 主机"); if (set_title) set_title(ind, "UU 远程 Linux 主机");
set_menu(ind, GTK_MENU(tray_menu)); set_menu(ind, GTK_MENU(tray_menu));
set_status(ind, 1 /* ACTIVE */); set_status(ind, 1 /* ACTIVE */);
@@ -359,6 +403,11 @@ static void build_window(void) {
GtkWidget *root = gtk_box_new(GTK_ORIENTATION_VERTICAL, 10); GtkWidget *root = gtk_box_new(GTK_ORIENTATION_VERTICAL, 10);
gtk_container_set_border_width(GTK_CONTAINER(root), 24); gtk_container_set_border_width(GTK_CONTAINER(root), 24);
gtk_container_add(GTK_CONTAINER(window), root); gtk_container_add(GTK_CONTAINER(window), root);
problem_label = label("", "status");
gtk_style_context_add_class(gtk_widget_get_style_context(problem_label), "error");
gtk_label_set_line_wrap(GTK_LABEL(problem_label), TRUE);
gtk_label_set_max_width_chars(GTK_LABEL(problem_label), 40);
gtk_box_pack_start(GTK_BOX(root), problem_label, FALSE, FALSE, 0);
GtkWidget *card = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0); GtkWidget *card = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
gtk_style_context_add_class(gtk_widget_get_style_context(card), "card"); gtk_style_context_add_class(gtk_widget_get_style_context(card), "card");
@@ -469,6 +518,10 @@ static void build_window(void) {
gtk_widget_set_visible(assist_card, show_assist); gtk_widget_set_visible(assist_card, show_assist);
gtk_widget_set_visible(hint_label, show_assist); gtk_widget_set_visible(hint_label, show_assist);
gtk_widget_set_visible(account_card, show_account); gtk_widget_set_visible(account_card, show_account);
pthread_mutex_lock(&problem_lock);
gtk_label_set_text(GTK_LABEL(problem_label), problem_text ? problem_text : "");
gtk_widget_set_visible(problem_label, problem_text != NULL);
pthread_mutex_unlock(&problem_lock);
if (!start_hidden) gtk_widget_show(window); if (!start_hidden) gtk_widget_show(window);
} }
@@ -641,6 +694,60 @@ void uu_ui_set_user(const char *name) {
if (!ui_started || init_state != 1) return; if (!ui_started || init_state != 1) return;
g_idle_add(apply_user, g_strdup(name ? name : "")); g_idle_add(apply_user, g_strdup(name ? name : ""));
} }
static gboolean apply_qr_refresh(gpointer data) {
if (window && qr_refresh) { if (GPOINTER_TO_INT(data)) gtk_widget_show(qr_refresh); else gtk_widget_hide(qr_refresh); }
return G_SOURCE_REMOVE;
}
void uu_login_ui_offer_refresh(int visible) {
if (!ui_started || init_state != 1 || atomic_load(&closed)) return;
atomic_store(&qr_refresh_requested, 0);
g_idle_add(apply_qr_refresh, GINT_TO_POINTER(visible != 0));
}
int uu_login_ui_take_refresh(void) { return atomic_exchange(&qr_refresh_requested, 0); }
static gboolean apply_problem(gpointer data) {
(void)data;
if (window && problem_label) {
pthread_mutex_lock(&problem_lock);
gtk_label_set_text(GTK_LABEL(problem_label), problem_text ? problem_text : "");
gtk_widget_set_visible(problem_label, problem_text != NULL);
pthread_mutex_unlock(&problem_lock);
}
return G_SOURCE_REMOVE;
}
// Freedesktop notification through the session bus (no GTK main loop needed). Returns 0 when delivered.
static int notify_desktop(const char *summary, const char *body) {
GDBusConnection *bus = g_bus_get_sync(G_BUS_TYPE_SESSION, NULL, NULL);
if (!bus) return -1;
GVariantBuilder actions, hints;
g_variant_builder_init(&actions, G_VARIANT_TYPE("as"));
g_variant_builder_init(&hints, G_VARIANT_TYPE("a{sv}"));
g_variant_builder_add(&hints, "{sv}", "urgency", g_variant_new_byte(2)); // critical: stays until dismissed
GVariant *reply = g_dbus_connection_call_sync(bus, "org.freedesktop.Notifications", "/org/freedesktop/Notifications",
"org.freedesktop.Notifications", "Notify",
g_variant_new("(susssasa{sv}i)", "UU 远程 Linux 主机", 0u, "uu-remote-linux", summary, body, &actions, &hints, -1),
G_VARIANT_TYPE("(u)"), G_DBUS_CALL_FLAGS_NONE, 3000, NULL, NULL);
g_object_unref(bus);
if (!reply) return -1;
g_variant_unref(reply);
return 0;
}
// text NULL clears the window line. notify: also tell the person now, by a desktop notification or,
// without a notification daemon (e.g. bare Xfce), by opening the host window that shows the line.
// Returns 0 notified, 1 window opened, -1 neither (no notify requested, or no daemon and no window).
int uu_ui_set_problem(const char *summary, const char *text, int notify) {
pthread_mutex_lock(&problem_lock);
g_free(problem_text);
problem_text = text ? g_strdup(text) : NULL;
pthread_mutex_unlock(&problem_lock);
int window_ready = ui_started && init_state == 1 && !atomic_load(&closed);
if (window_ready) g_idle_add(apply_problem, NULL);
if (!notify || !text) return -1;
if (notify_desktop(summary ? summary : "", text) == 0) return 0;
if (!window_ready) return -1;
uu_assist_ui_present();
return 1;
}
void uu_login_ui_set_done(const char *text) { uu_ui_set_user(text); } void uu_login_ui_set_done(const char *text) { uu_ui_set_user(text); }
int uu_login_ui_closed(void) { return atomic_load(&closed); } int uu_login_ui_closed(void) { return atomic_load(&closed); }
void uu_login_ui_close(void) { uu_assist_ui_close(); } void uu_login_ui_close(void) { uu_assist_ui_close(); }
+242
View File
@@ -0,0 +1,242 @@
#include "dri3_capture.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <poll.h>
#include <X11/Xlib.h>
#include <X11/Xlib-xcb.h>
#include <xcb/xcb.h>
#include <xcb/dri3.h>
#include <xcb/damage.h>
#include <gbm.h>
struct Dri3Capture {
Display *dpy;
xcb_connection_t *conn;
xcb_screen_t *screen;
uint32_t width;
uint32_t height;
int drm_fd;
struct gbm_device *gbm;
struct gbm_bo *bo;
int bo_fd;
uint32_t stride;
xcb_pixmap_t pix;
xcb_gcontext_t gc;
xcb_damage_damage_t damage;
uint8_t damage_event_code;
};
Dri3Capture* dri3_capture_create(const char* display_name, uint32_t width, uint32_t height) {
Display *dpy = XOpenDisplay(display_name);
if (!dpy) {
fprintf(stderr, "[dri3_capture] failed to open display %s\n", display_name ? display_name : "default");
return NULL;
}
// Events are read with xcb_poll_for_event below, so XCB, not Xlib, must own the queue
XSetEventQueueOwner(dpy, XCBOwnsEventQueue);
xcb_connection_t *conn = XGetXCBConnection(dpy);
const xcb_setup_t *setup = xcb_get_setup(conn);
xcb_screen_t *screen = xcb_setup_roots_iterator(setup).data;
if (!screen) {
XCloseDisplay(dpy);
return NULL;
}
// Check the extension first: a DRI3 request on a server without it breaks the connection,
// and the Xlib cleanup below then exits the process.
const xcb_query_extension_reply_t *dri3_ext = xcb_get_extension_data(conn, &xcb_dri3_id);
if (!dri3_ext || !dri3_ext->present) {
fprintf(stderr, "[dri3_capture] DRI3 extension not supported on display\n");
XCloseDisplay(dpy);
return NULL;
}
// Query DRI3
xcb_dri3_query_version_cookie_t qvc = xcb_dri3_query_version(conn, 1, 2);
xcb_dri3_query_version_reply_t *qvr = xcb_dri3_query_version_reply(conn, qvc, NULL);
if (!qvr) {
fprintf(stderr, "[dri3_capture] DRI3 extension not supported on display\n");
XCloseDisplay(dpy);
return NULL;
}
free(qvr);
// Open DRM device via DRI3
xcb_dri3_open_cookie_t oc = xcb_dri3_open(conn, screen->root, 0);
xcb_dri3_open_reply_t *or = xcb_dri3_open_reply(conn, oc, NULL);
if (!or) {
fprintf(stderr, "[dri3_capture] xcb_dri3_open failed\n");
XCloseDisplay(dpy);
return NULL;
}
int drm_fd = xcb_dri3_open_reply_fds(conn, or)[0];
free(or);
uint32_t w = width > 0 ? width : screen->width_in_pixels;
uint32_t h = height > 0 ? height : screen->height_in_pixels;
struct gbm_device *gbm = gbm_create_device(drm_fd);
if (!gbm) {
fprintf(stderr, "[dri3_capture] gbm_create_device failed\n");
close(drm_fd);
XCloseDisplay(dpy);
return NULL;
}
struct gbm_bo *bo = gbm_bo_create(gbm, w, h, GBM_FORMAT_XRGB8888, GBM_BO_USE_RENDERING | GBM_BO_USE_LINEAR);
if (!bo) {
fprintf(stderr, "[dri3_capture] gbm_bo_create failed\n");
gbm_device_destroy(gbm);
close(drm_fd);
XCloseDisplay(dpy);
return NULL;
}
int bo_fd = gbm_bo_get_fd(bo);
uint32_t stride = gbm_bo_get_stride(bo);
xcb_pixmap_t pix = xcb_generate_id(conn);
xcb_generic_error_t *err = NULL;
// XCB takes ownership of the fd it sends and closes it after transmission; only a
// duplicate goes to X11, bo_fd stays ours for the VAAPI import and teardown.
int send_fd = fcntl(bo_fd, F_DUPFD_CLOEXEC, 3);
if (send_fd < 0) {
close(bo_fd);
gbm_bo_destroy(bo);
gbm_device_destroy(gbm);
close(drm_fd);
XCloseDisplay(dpy);
return NULL;
}
xcb_void_cookie_t pc = xcb_dri3_pixmap_from_buffer_checked(
conn, pix, screen->root, stride * h, w, h, stride, screen->root_depth, 32, send_fd
);
err = xcb_request_check(conn, pc);
if (err) {
fprintf(stderr, "[dri3_capture] xcb_dri3_pixmap_from_buffer failed: %d\n", err->error_code);
free(err);
close(bo_fd);
gbm_bo_destroy(bo);
gbm_device_destroy(gbm);
close(drm_fd);
XCloseDisplay(dpy);
return NULL;
}
xcb_gcontext_t gc = xcb_generate_id(conn);
// The default ClipByChildren copies only the root background (solid black); XShmGetImage on the root
// includes child windows, so the blit must too.
uint32_t gc_mode = XCB_SUBWINDOW_MODE_INCLUDE_INFERIORS;
xcb_create_gc(conn, gc, pix, XCB_GC_SUBWINDOW_MODE, &gc_mode);
// Setup XDamage on root window
const xcb_query_extension_reply_t *ext = xcb_get_extension_data(conn, &xcb_damage_id);
uint8_t damage_event_code = 0;
xcb_damage_damage_t damage = 0;
if (ext && ext->present) {
damage_event_code = ext->first_event;
xcb_damage_query_version(conn, 1, 1);
damage = xcb_generate_id(conn);
xcb_damage_create(conn, damage, screen->root, XCB_DAMAGE_REPORT_LEVEL_NON_EMPTY);
}
Dri3Capture* cap = (Dri3Capture*)calloc(1, sizeof(Dri3Capture));
cap->dpy = dpy;
cap->conn = conn;
cap->screen = screen;
cap->width = w;
cap->height = h;
cap->drm_fd = drm_fd;
cap->gbm = gbm;
cap->bo = bo;
cap->bo_fd = bo_fd;
cap->stride = stride;
cap->pix = pix;
cap->gc = gc;
cap->damage = damage;
cap->damage_event_code = damage_event_code;
fprintf(stderr, "[dri3_capture] Initialized: %ux%u (stride: %u, dma_fd: %d) Pure GPU Blit ready!\n",
w, h, stride, bo_fd);
return cap;
}
int dri3_capture_blit(Dri3Capture* cap) {
if (!cap) return -1;
xcb_copy_area(cap->conn, cap->screen->root, cap->pix, cap->gc, 0, 0, 0, 0, cap->width, cap->height);
// Round trip: the server has executed (and flushed to the GPU) the copy before VAAPI reads the BO;
// xcb_flush alone only sends the request.
xcb_get_input_focus_reply_t *r = xcb_get_input_focus_reply(cap->conn, xcb_get_input_focus(cap->conn), NULL);
if (!r) return -1;
free(r);
return 0;
}
int dri3_capture_wait_damage(Dri3Capture* cap, int timeout_ms) {
if (!cap) return -1;
// Check queued events
xcb_generic_event_t *ev = NULL;
int damaged = 0;
while ((ev = xcb_poll_for_event(cap->conn)) != NULL) {
if ((ev->response_type & 0x7f) == (cap->damage_event_code + XCB_DAMAGE_NOTIFY)) {
damaged = 1;
}
free(ev);
}
if (damaged) {
xcb_damage_subtract(cap->conn, cap->damage, XCB_NONE, XCB_NONE);
xcb_flush(cap->conn);
return 1;
}
int fd = xcb_get_file_descriptor(cap->conn);
struct pollfd pfd = { .fd = fd, .events = POLLIN, .revents = 0 };
int ret = poll(&pfd, 1, timeout_ms);
if (ret > 0 && (pfd.revents & POLLIN)) {
// Readable but not yet a whole event: polling again would return at once and spin a core
ev = xcb_poll_for_event(cap->conn);
if (!ev) ev = xcb_wait_for_event(cap->conn);
if (!ev) return -1;
do {
if ((ev->response_type & 0x7f) == (cap->damage_event_code + XCB_DAMAGE_NOTIFY)) {
damaged = 1;
}
free(ev);
} while ((ev = xcb_poll_for_event(cap->conn)) != NULL);
if (damaged) {
xcb_damage_subtract(cap->conn, cap->damage, XCB_NONE, XCB_NONE);
xcb_flush(cap->conn);
return 1;
}
}
return ret < 0 ? -1 : 0;
}
int dri3_capture_get_dma_fd(Dri3Capture* cap) {
return cap ? cap->bo_fd : -1;
}
uint32_t dri3_capture_get_stride(Dri3Capture* cap) {
return cap ? cap->stride : 0;
}
void dri3_capture_destroy(Dri3Capture* cap) {
if (!cap) return;
if (cap->damage) xcb_damage_destroy(cap->conn, cap->damage);
if (cap->gc) xcb_free_gc(cap->conn, cap->gc);
if (cap->pix) xcb_free_pixmap(cap->conn, cap->pix);
if (cap->bo_fd >= 0) close(cap->bo_fd);
if (cap->bo) gbm_bo_destroy(cap->bo);
if (cap->gbm) gbm_device_destroy(cap->gbm);
if (cap->drm_fd >= 0) close(cap->drm_fd);
if (cap->dpy) XCloseDisplay(cap->dpy);
free(cap);
}
+33
View File
@@ -0,0 +1,33 @@
#ifndef UU_DRI3_CAPTURE_H
#define UU_DRI3_CAPTURE_H
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct Dri3Capture Dri3Capture;
Dri3Capture* dri3_capture_create(const char* display_name, uint32_t width, uint32_t height);
// Trigger GPU blit from Root Window to the DRI3 DMA-BUF Pixmap.
// Returns 0 on success, negative on error.
int dri3_capture_blit(Dri3Capture* cap);
// Wait for next XDamage event or timeout (ms).
// Returns 1 if damaged, 0 if timeout, negative on error.
int dri3_capture_wait_damage(Dri3Capture* cap, int timeout_ms);
// Get the exported DMA-BUF file descriptor and stride
int dri3_capture_get_dma_fd(Dri3Capture* cap);
uint32_t dri3_capture_get_stride(Dri3Capture* cap);
void dri3_capture_destroy(Dri3Capture* cap);
#ifdef __cplusplus
}
#endif
#endif // UU_DRI3_CAPTURE_H
+580
View File
@@ -0,0 +1,580 @@
#include "nvenc_engine.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <dlfcn.h>
#include <ffnvcodec/dynlink_cuda.h>
#include <ffnvcodec/nvEncodeAPI.h>
// Struct revisions come from the vendored nvEncodeAPI.h (*_VER macros), so the session must be
// opened with that header's NVENCAPI_VERSION; older drivers are rejected in nvenc_create.
#define CU_MEMHOSTREGISTER_DEVICEMAP 0x02
typedef CUresult CUDAAPI (*tcuMemHostRegister)(void *p, size_t bytesize, unsigned int Flags);
typedef CUresult CUDAAPI (*tcuMemHostGetDevicePointer)(CUdeviceptr *pdptr, void *p, unsigned int Flags);
typedef CUresult CUDAAPI (*tcuMemHostUnregister)(void *p);
typedef NVENCSTATUS NVENCAPI (*tNvEncodeAPICreateInstance)(NV_ENCODE_API_FUNCTION_LIST *functionList);
typedef NVENCSTATUS NVENCAPI (*tNvEncodeAPIGetMaxSupportedVersion)(uint32_t *version);
struct NvencEngine {
void *cuda_lib;
void *nvenc_lib;
tcuInit *cuInit;
tcuDeviceGet *cuDeviceGet;
tcuDevicePrimaryCtxRetain *cuDevicePrimaryCtxRetain;
tcuDevicePrimaryCtxRelease *cuDevicePrimaryCtxRelease;
tcuCtxCreate_v2 *cuCtxCreate;
tcuCtxDestroy_v2 *cuCtxDestroy;
tcuCtxPushCurrent_v2 *cuCtxPushCurrent;
tcuCtxPopCurrent_v2 *cuCtxPopCurrent;
tcuMemAlloc_v2 *cuMemAlloc;
tcuMemFree_v2 *cuMemFree;
tcuMemcpyHtoD_v2 *cuMemcpyHtoD;
tcuMemHostRegister cuMemHostRegister;
tcuMemHostGetDevicePointer cuMemHostGetDevicePointer;
tcuMemHostUnregister cuMemHostUnregister;
CUdevice dev;
CUcontext cu_ctx;
int is_standalone_ctx; // cuCtxCreate fallback (primary context unavailable, seen on GB10)
CUdeviceptr cu_dptr;
size_t frame_bytes;
// Pinned XShm buffer registered for direct DMA reads
void *registered_host_ptr;
int is_zero_copy;
NV_ENCODE_API_FUNCTION_LIST fn;
void *encoder;
NV_ENC_REGISTER_RESOURCE reg_res;
NV_ENC_OUTPUT_PTR bitstream_buf;
uint32_t width;
uint32_t height;
int is_hevc;
uint8_t *output_staging;
size_t output_staging_cap;
};
// Returns 1 when the context was pushed; pop only in that case.
static int ctx_push(NvencEngine *engine) {
return engine->cuCtxPushCurrent && engine->cu_ctx && engine->cuCtxPushCurrent(engine->cu_ctx) == CUDA_SUCCESS;
}
static void ctx_pop(NvencEngine *engine, int pushed) {
if (pushed && engine->cuCtxPopCurrent) {
CUcontext dummy = NULL;
engine->cuCtxPopCurrent(&dummy);
}
}
NvencEngine* nvenc_create(const NvencConfig* config) {
if (!config || config->width == 0 || config->height == 0) {
return NULL;
}
NvencEngine *engine = (NvencEngine*)calloc(1, sizeof(NvencEngine));
if (!engine) return NULL;
engine->width = config->width;
engine->height = config->height;
engine->is_hevc = config->is_hevc;
// 1. Load CUDA driver
engine->cuda_lib = dlopen("libcuda.so.1", RTLD_NOW);
if (!engine->cuda_lib) {
fprintf(stderr, "[nvenc] dlopen libcuda.so.1 failed\n");
free(engine);
return NULL;
}
engine->cuInit = (tcuInit*)dlsym(engine->cuda_lib, "cuInit");
engine->cuDeviceGet = (tcuDeviceGet*)dlsym(engine->cuda_lib, "cuDeviceGet");
engine->cuDevicePrimaryCtxRetain = (tcuDevicePrimaryCtxRetain*)dlsym(engine->cuda_lib, "cuDevicePrimaryCtxRetain");
engine->cuDevicePrimaryCtxRelease = (tcuDevicePrimaryCtxRelease*)dlsym(engine->cuda_lib, "cuDevicePrimaryCtxRelease_v2");
if (!engine->cuDevicePrimaryCtxRelease)
engine->cuDevicePrimaryCtxRelease = (tcuDevicePrimaryCtxRelease*)dlsym(engine->cuda_lib, "cuDevicePrimaryCtxRelease");
engine->cuCtxCreate = (tcuCtxCreate_v2*)dlsym(engine->cuda_lib, "cuCtxCreate_v2");
engine->cuCtxDestroy = (tcuCtxDestroy_v2*)dlsym(engine->cuda_lib, "cuCtxDestroy_v2");
engine->cuCtxPushCurrent = (tcuCtxPushCurrent_v2*)dlsym(engine->cuda_lib, "cuCtxPushCurrent_v2");
engine->cuCtxPopCurrent = (tcuCtxPopCurrent_v2*)dlsym(engine->cuda_lib, "cuCtxPopCurrent_v2");
engine->cuMemAlloc = (tcuMemAlloc_v2*)dlsym(engine->cuda_lib, "cuMemAlloc_v2");
engine->cuMemFree = (tcuMemFree_v2*)dlsym(engine->cuda_lib, "cuMemFree_v2");
engine->cuMemcpyHtoD = (tcuMemcpyHtoD_v2*)dlsym(engine->cuda_lib, "cuMemcpyHtoD_v2");
engine->cuMemHostRegister = (tcuMemHostRegister)dlsym(engine->cuda_lib, "cuMemHostRegister_v2");
engine->cuMemHostGetDevicePointer = (tcuMemHostGetDevicePointer)dlsym(engine->cuda_lib, "cuMemHostGetDevicePointer_v2");
engine->cuMemHostUnregister = (tcuMemHostUnregister)dlsym(engine->cuda_lib, "cuMemHostUnregister");
if (!engine->cuInit || !engine->cuDeviceGet || !engine->cuDevicePrimaryCtxRetain ||
!engine->cuDevicePrimaryCtxRelease || !engine->cuCtxPushCurrent || !engine->cuCtxPopCurrent ||
!engine->cuMemAlloc || !engine->cuMemFree || !engine->cuMemcpyHtoD) {
fprintf(stderr, "[nvenc] Missing CUDA driver symbols\n");
nvenc_destroy(engine);
return NULL;
}
CUresult cures = engine->cuInit(0);
if (cures != CUDA_SUCCESS) {
fprintf(stderr, "[nvenc] cuInit failed: %d\n", cures);
nvenc_destroy(engine);
return NULL;
}
cures = engine->cuDeviceGet(&engine->dev, 0);
if (cures != CUDA_SUCCESS) {
fprintf(stderr, "[nvenc] cuDeviceGet failed: %d\n", cures);
nvenc_destroy(engine);
return NULL;
}
cures = engine->cuDevicePrimaryCtxRetain(&engine->cu_ctx, engine->dev);
if ((cures != CUDA_SUCCESS || !engine->cu_ctx) && engine->cuCtxCreate && engine->cuCtxDestroy) {
engine->cu_ctx = NULL;
// cuCtxCreate makes the new context current; the push below makes it current again
cures = engine->cuCtxCreate(&engine->cu_ctx, 0, engine->dev);
if (cures == CUDA_SUCCESS && engine->cu_ctx) {
CUcontext dummy = NULL;
engine->cuCtxPopCurrent(&dummy);
engine->is_standalone_ctx = 1;
}
}
if (cures != CUDA_SUCCESS || !engine->cu_ctx) {
fprintf(stderr, "[nvenc] CUDA context creation failed: %d\n", cures);
engine->cu_ctx = NULL;
nvenc_destroy(engine);
return NULL;
}
int pushed = ctx_push(engine);
if (!pushed) {
fprintf(stderr, "[nvenc] cuCtxPushCurrent failed\n");
nvenc_destroy(engine);
return NULL;
}
// 2. Load NVENC
engine->nvenc_lib = dlopen("libnvidia-encode.so.1", RTLD_NOW);
if (!engine->nvenc_lib) {
fprintf(stderr, "[nvenc] dlopen libnvidia-encode.so.1 failed\n");
goto fail;
}
// Like FFmpeg: the driver must support the header's API version, otherwise fall back.
tNvEncodeAPIGetMaxSupportedVersion get_max_ver = (tNvEncodeAPIGetMaxSupportedVersion)dlsym(
engine->nvenc_lib, "NvEncodeAPIGetMaxSupportedVersion");
uint32_t max_supported_ver = 0;
if (!get_max_ver || get_max_ver(&max_supported_ver) != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] NvEncodeAPIGetMaxSupportedVersion failed\n");
goto fail;
}
if (max_supported_ver < ((NVENCAPI_MAJOR_VERSION << 4) | NVENCAPI_MINOR_VERSION)) {
fprintf(stderr, "[nvenc] Driver NVENC API %u.%u is older than required %d.%d; update the NVIDIA driver\n",
max_supported_ver >> 4, max_supported_ver & 0xf, NVENCAPI_MAJOR_VERSION, NVENCAPI_MINOR_VERSION);
goto fail;
}
tNvEncodeAPICreateInstance create_inst = (tNvEncodeAPICreateInstance)dlsym(engine->nvenc_lib, "NvEncodeAPICreateInstance");
if (!create_inst) {
fprintf(stderr, "[nvenc] dlsym NvEncodeAPICreateInstance failed\n");
goto fail;
}
memset(&engine->fn, 0, sizeof(engine->fn));
engine->fn.version = NV_ENCODE_API_FUNCTION_LIST_VER;
NVENCSTATUS nvres = create_inst(&engine->fn);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] NvEncodeAPICreateInstance failed: %d\n", nvres);
goto fail;
}
// 3. Open Encode Session
NV_ENC_OPEN_ENCODE_SESSION_EX_PARAMS open_params;
memset(&open_params, 0, sizeof(open_params));
open_params.version = NV_ENC_OPEN_ENCODE_SESSION_EX_PARAMS_VER;
open_params.deviceType = NV_ENC_DEVICE_TYPE_CUDA;
open_params.device = engine->cu_ctx;
open_params.apiVersion = NVENCAPI_VERSION;
nvres = engine->fn.nvEncOpenEncodeSessionEx(&open_params, &engine->encoder);
if (nvres != NV_ENC_SUCCESS || !engine->encoder) {
fprintf(stderr, "[nvenc] nvEncOpenEncodeSessionEx failed: %d\n", nvres);
engine->encoder = NULL;
goto fail;
}
// 4. Query Preset Config
GUID codec_guid = engine->is_hevc ? NV_ENC_CODEC_HEVC_GUID : NV_ENC_CODEC_H264_GUID;
NV_ENC_PRESET_CONFIG preset_cfg;
memset(&preset_cfg, 0, sizeof(preset_cfg));
preset_cfg.version = NV_ENC_PRESET_CONFIG_VER;
preset_cfg.presetCfg.version = NV_ENC_CONFIG_VER;
nvres = engine->fn.nvEncGetEncodePresetConfigEx(
engine->encoder,
codec_guid,
NV_ENC_PRESET_P4_GUID,
NV_ENC_TUNING_INFO_ULTRA_LOW_LATENCY,
&preset_cfg
);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncGetEncodePresetConfigEx failed: %d\n", nvres);
goto fail;
}
NV_ENC_CONFIG enc_cfg;
memcpy(&enc_cfg, &preset_cfg.presetCfg, sizeof(NV_ENC_CONFIG));
enc_cfg.gopLength = config->gop > 0 ? config->gop : NVENC_INFINITE_GOPLENGTH;
enc_cfg.frameIntervalP = 1; // Strict low-latency: zero B-frames
enc_cfg.rcParams.rateControlMode = NV_ENC_PARAMS_RC_VBR;
enc_cfg.rcParams.averageBitRate = (uint32_t)(config->target_bps > 0 ? config->target_bps : 10000000);
enc_cfg.rcParams.maxBitRate = (uint32_t)(config->max_bps > 0 ? config->max_bps : 15000000);
enc_cfg.rcParams.vbvBufferSize = (uint32_t)(config->buffer_bits > 0 ? config->buffer_bits : (config->max_bps > 0 ? config->max_bps / 10 : 1500000));
enc_cfg.rcParams.targetQuality = (uint8_t)(config->cq > 0 ? config->cq : 28);
NV_ENC_CAPS_PARAM caps_param;
memset(&caps_param, 0, sizeof(caps_param));
caps_param.version = NV_ENC_CAPS_PARAM_VER;
int caps_val = 0;
if (config->chroma_444) {
// GPUs without 4:4:4 encode fail here; the caller falls back to FFmpeg/libx264, which keep 4:4:4.
caps_param.capsToQuery = NV_ENC_CAPS_SUPPORT_YUV444_ENCODE;
if (engine->fn.nvEncGetEncodeCaps(engine->encoder, codec_guid, &caps_param, &caps_val) != NV_ENC_SUCCESS || caps_val <= 0) {
fprintf(stderr, "[nvenc] 4:4:4 encoding not supported for this codec\n");
goto fail;
}
// NVENC rejects AQ / temporal AQ in 4:4:4 mode.
enc_cfg.rcParams.enableAQ = 0;
enc_cfg.rcParams.enableTemporalAQ = 0;
} else {
enc_cfg.rcParams.enableAQ = 1;
// Temporal AQ only where the hardware/codec reports it
caps_param.capsToQuery = NV_ENC_CAPS_SUPPORT_TEMPORAL_AQ;
caps_val = 0;
enc_cfg.rcParams.enableTemporalAQ =
engine->fn.nvEncGetEncodeCaps(engine->encoder, codec_guid, &caps_param, &caps_val) == NV_ENC_SUCCESS && caps_val > 0;
}
if (engine->is_hevc) {
enc_cfg.profileGUID = config->chroma_444 ? NV_ENC_HEVC_PROFILE_FREXT_GUID : NV_ENC_HEVC_PROFILE_MAIN_GUID;
enc_cfg.encodeCodecConfig.hevcConfig.chromaFormatIDC = config->chroma_444 ? 3 : 1;
enc_cfg.encodeCodecConfig.hevcConfig.idrPeriod = enc_cfg.gopLength;
enc_cfg.encodeCodecConfig.hevcConfig.repeatSPSPPS = 1;
enc_cfg.encodeCodecConfig.hevcConfig.outputAUD = 1;
} else {
enc_cfg.profileGUID = config->chroma_444 ? NV_ENC_H264_PROFILE_HIGH_444_GUID : NV_ENC_H264_PROFILE_BASELINE_GUID;
enc_cfg.encodeCodecConfig.h264Config.chromaFormatIDC = config->chroma_444 ? 3 : 1;
enc_cfg.encodeCodecConfig.h264Config.idrPeriod = enc_cfg.gopLength;
enc_cfg.encodeCodecConfig.h264Config.repeatSPSPPS = 1;
enc_cfg.encodeCodecConfig.h264Config.outputAUD = 1;
}
// 5. Initialize Encoder
NV_ENC_INITIALIZE_PARAMS init_params;
memset(&init_params, 0, sizeof(init_params));
init_params.version = NV_ENC_INITIALIZE_PARAMS_VER;
init_params.encodeGUID = codec_guid;
init_params.presetGUID = NV_ENC_PRESET_P4_GUID;
init_params.encodeWidth = engine->width;
init_params.encodeHeight = engine->height;
init_params.darWidth = engine->width;
init_params.darHeight = engine->height;
init_params.frameRateNum = config->fps > 0 ? config->fps : 60;
init_params.frameRateDen = 1;
init_params.enablePTD = 1;
init_params.tuningInfo = NV_ENC_TUNING_INFO_ULTRA_LOW_LATENCY;
init_params.encodeConfig = &enc_cfg;
nvres = engine->fn.nvEncInitializeEncoder(engine->encoder, &init_params);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncInitializeEncoder failed: %d\n", nvres);
goto fail;
}
// 6. Device input buffer (ARGB32), used until a host buffer is registered
engine->frame_bytes = (size_t)engine->width * engine->height * 4;
cures = engine->cuMemAlloc(&engine->cu_dptr, engine->frame_bytes);
if (cures != CUDA_SUCCESS) {
fprintf(stderr, "[nvenc] cuMemAlloc failed: %d\n", cures);
engine->cu_dptr = 0;
goto fail;
}
memset(&engine->reg_res, 0, sizeof(engine->reg_res));
engine->reg_res.version = NV_ENC_REGISTER_RESOURCE_VER;
engine->reg_res.resourceType = NV_ENC_INPUT_RESOURCE_TYPE_CUDADEVICEPTR;
engine->reg_res.width = engine->width;
engine->reg_res.height = engine->height;
engine->reg_res.pitch = engine->width * 4;
engine->reg_res.resourceToRegister = (void*)engine->cu_dptr;
engine->reg_res.bufferFormat = NV_ENC_BUFFER_FORMAT_ARGB;
nvres = engine->fn.nvEncRegisterResource(engine->encoder, &engine->reg_res);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncRegisterResource failed: %d\n", nvres);
engine->reg_res.registeredResource = NULL;
goto fail;
}
// 7. Create bitstream output buffer
NV_ENC_CREATE_BITSTREAM_BUFFER bs_buf;
memset(&bs_buf, 0, sizeof(bs_buf));
bs_buf.version = NV_ENC_CREATE_BITSTREAM_BUFFER_VER;
nvres = engine->fn.nvEncCreateBitstreamBuffer(engine->encoder, &bs_buf);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncCreateBitstreamBuffer failed: %d\n", nvres);
goto fail;
}
engine->bitstream_buf = bs_buf.bitstreamBuffer;
engine->output_staging_cap = 2 * 1024 * 1024;
engine->output_staging = (uint8_t*)malloc(engine->output_staging_cap);
if (!engine->output_staging) {
fprintf(stderr, "[nvenc] output buffer allocation failed\n");
goto fail;
}
ctx_pop(engine, pushed);
return engine;
fail:
// Pop the creation push first; nvenc_destroy pushes and pops on its own.
ctx_pop(engine, pushed);
nvenc_destroy(engine);
return NULL;
}
int nvenc_register_host_buffer(NvencEngine* engine, void* host_ptr, size_t size) {
if (!engine || !host_ptr || size < engine->frame_bytes) {
return -1;
}
if (!engine->cuMemHostRegister || !engine->cuMemHostGetDevicePointer || !engine->cuMemHostUnregister) {
return -2;
}
int pushed = ctx_push(engine);
if (!pushed) return -2;
// If already registered, unregister first
nvenc_unregister_host_buffer(engine);
CUresult cures = engine->cuMemHostRegister(host_ptr, size, CU_MEMHOSTREGISTER_DEVICEMAP);
if (cures != CUDA_SUCCESS) {
fprintf(stderr, "[nvenc] cuMemHostRegister failed: %d\n", cures);
ctx_pop(engine, pushed);
return -3;
}
CUdeviceptr dev_ptr = 0;
cures = engine->cuMemHostGetDevicePointer(&dev_ptr, host_ptr, 0);
if (cures != CUDA_SUCCESS || dev_ptr == 0) {
fprintf(stderr, "[nvenc] cuMemHostGetDevicePointer failed: %d\n", cures);
engine->cuMemHostUnregister(host_ptr);
ctx_pop(engine, pushed);
return -4;
}
// Register the pinned buffer before releasing the device buffer, so a failure keeps the copy path working
NV_ENC_REGISTER_RESOURCE new_reg;
memset(&new_reg, 0, sizeof(new_reg));
new_reg.version = NV_ENC_REGISTER_RESOURCE_VER;
new_reg.resourceType = NV_ENC_INPUT_RESOURCE_TYPE_CUDADEVICEPTR;
new_reg.width = engine->width;
new_reg.height = engine->height;
new_reg.pitch = engine->width * 4;
new_reg.resourceToRegister = (void*)dev_ptr;
new_reg.bufferFormat = NV_ENC_BUFFER_FORMAT_ARGB;
NVENCSTATUS nvres = engine->fn.nvEncRegisterResource(engine->encoder, &new_reg);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncRegisterResource (pinned host) failed: %d\n", nvres);
engine->cuMemHostUnregister(host_ptr);
ctx_pop(engine, pushed);
return -5;
}
if (engine->reg_res.registeredResource) {
engine->fn.nvEncUnregisterResource(engine->encoder, engine->reg_res.registeredResource);
}
if (engine->cu_dptr) {
engine->cuMemFree(engine->cu_dptr);
engine->cu_dptr = 0;
}
engine->reg_res = new_reg;
engine->registered_host_ptr = host_ptr;
engine->is_zero_copy = 1;
ctx_pop(engine, pushed);
return 0;
}
// Caller has the context current.
void nvenc_unregister_host_buffer(NvencEngine* engine) {
if (!engine || !engine->is_zero_copy) return;
if (engine->reg_res.registeredResource && engine->encoder) {
engine->fn.nvEncUnregisterResource(engine->encoder, engine->reg_res.registeredResource);
memset(&engine->reg_res, 0, sizeof(engine->reg_res));
}
if (engine->registered_host_ptr && engine->cuMemHostUnregister) {
engine->cuMemHostUnregister(engine->registered_host_ptr);
engine->registered_host_ptr = NULL;
}
engine->is_zero_copy = 0;
}
int nvenc_encode_frame(
NvencEngine* engine,
const uint8_t* input_argb,
uint32_t pitch,
int force_idr,
const uint8_t** out_data,
uint32_t* out_len
) {
if (!engine || !out_data || !out_len || !engine->reg_res.registeredResource) {
return -1;
}
*out_data = NULL;
*out_len = 0;
int pushed = ctx_push(engine);
if (!pushed) return -1;
// Without a registered host buffer, copy the frame into the device buffer
if (!engine->is_zero_copy) {
if (!input_argb) {
ctx_pop(engine, pushed);
return -1;
}
CUresult cures = CUDA_SUCCESS;
if (pitch == engine->width * 4) {
cures = engine->cuMemcpyHtoD(engine->cu_dptr, input_argb, engine->frame_bytes);
} else {
for (uint32_t y = 0; y < engine->height && cures == CUDA_SUCCESS; y++) {
cures = engine->cuMemcpyHtoD(
engine->cu_dptr + (size_t)y * engine->width * 4,
input_argb + (size_t)y * pitch,
engine->width * 4
);
}
}
if (cures != CUDA_SUCCESS) {
fprintf(stderr, "[nvenc] cuMemcpyHtoD failed: %d\n", cures);
ctx_pop(engine, pushed);
return -2;
}
}
NV_ENC_MAP_INPUT_RESOURCE map_res;
memset(&map_res, 0, sizeof(map_res));
map_res.version = NV_ENC_MAP_INPUT_RESOURCE_VER;
map_res.registeredResource = engine->reg_res.registeredResource;
NVENCSTATUS nvres = engine->fn.nvEncMapInputResource(engine->encoder, &map_res);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncMapInputResource failed: %d\n", nvres);
ctx_pop(engine, pushed);
return -3;
}
NV_ENC_PIC_PARAMS pic_params;
memset(&pic_params, 0, sizeof(pic_params));
pic_params.version = NV_ENC_PIC_PARAMS_VER;
pic_params.inputWidth = engine->width;
pic_params.inputHeight = engine->height;
pic_params.inputPitch = engine->width * 4;
pic_params.inputBuffer = map_res.mappedResource;
pic_params.outputBitstream = engine->bitstream_buf;
pic_params.bufferFmt = NV_ENC_BUFFER_FORMAT_ARGB;
pic_params.pictureStruct = NV_ENC_PIC_STRUCT_FRAME;
if (force_idr) {
pic_params.encodePicFlags = NV_ENC_PIC_FLAG_FORCEIDR;
}
nvres = engine->fn.nvEncEncodePicture(engine->encoder, &pic_params);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncEncodePicture failed: %d\n", nvres);
engine->fn.nvEncUnmapInputResource(engine->encoder, map_res.mappedResource);
ctx_pop(engine, pushed);
return -4;
}
NV_ENC_LOCK_BITSTREAM lock_bs;
memset(&lock_bs, 0, sizeof(lock_bs));
lock_bs.version = NV_ENC_LOCK_BITSTREAM_VER;
lock_bs.outputBitstream = engine->bitstream_buf;
lock_bs.doNotWait = 0;
nvres = engine->fn.nvEncLockBitstream(engine->encoder, &lock_bs);
if (nvres != NV_ENC_SUCCESS) {
fprintf(stderr, "[nvenc] nvEncLockBitstream failed: %d\n", nvres);
engine->fn.nvEncUnmapInputResource(engine->encoder, map_res.mappedResource);
ctx_pop(engine, pushed);
return -5;
}
int rc = 0;
uint32_t size = lock_bs.bitstreamSizeInBytes;
if (size > engine->output_staging_cap) {
size_t cap = (size_t)size + 64 * 1024;
uint8_t *grown = (uint8_t*)realloc(engine->output_staging, cap);
if (grown) {
engine->output_staging = grown;
engine->output_staging_cap = cap;
} else {
fprintf(stderr, "[nvenc] output buffer allocation failed: %u bytes\n", size);
rc = -6;
}
}
if (rc == 0 && size > 0 && lock_bs.bitstreamBufferPtr) {
memcpy(engine->output_staging, lock_bs.bitstreamBufferPtr, size);
*out_data = engine->output_staging;
*out_len = size;
}
engine->fn.nvEncUnlockBitstream(engine->encoder, engine->bitstream_buf);
// The SDK allows unmapping only after the bitstream lock returned for this picture
engine->fn.nvEncUnmapInputResource(engine->encoder, map_res.mappedResource);
ctx_pop(engine, pushed);
return rc;
}
void nvenc_destroy(NvencEngine* engine) {
if (!engine) return;
int pushed = ctx_push(engine);
// Without a current context the NVENC/CUDA objects cannot be released safely; leak them.
if (pushed) {
if (engine->bitstream_buf && engine->encoder) {
engine->fn.nvEncDestroyBitstreamBuffer(engine->encoder, engine->bitstream_buf);
engine->bitstream_buf = NULL;
}
nvenc_unregister_host_buffer(engine);
if (engine->reg_res.registeredResource && engine->encoder) {
engine->fn.nvEncUnregisterResource(engine->encoder, engine->reg_res.registeredResource);
memset(&engine->reg_res, 0, sizeof(engine->reg_res));
}
if (engine->cu_dptr) {
engine->cuMemFree(engine->cu_dptr);
engine->cu_dptr = 0;
}
if (engine->encoder) {
engine->fn.nvEncDestroyEncoder(engine->encoder);
engine->encoder = NULL;
}
ctx_pop(engine, pushed);
}
if (engine->cu_ctx) {
if (engine->is_standalone_ctx) engine->cuCtxDestroy(engine->cu_ctx);
else engine->cuDevicePrimaryCtxRelease(engine->dev);
engine->cu_ctx = NULL;
}
free(engine->output_staging);
// libcuda/libnvidia-encode stay loaded: their driver threads outlive the session, and
// dlclose crashed them on the next encoder start (SEGV_MAPERR in libnvcuvid).
free(engine);
}
+59
View File
@@ -0,0 +1,59 @@
#ifndef UU_NVENC_ENGINE_H
#define UU_NVENC_ENGINE_H
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct NvencEngine NvencEngine;
typedef struct {
uint32_t width;
uint32_t height;
uint32_t fps;
uint32_t gop;
uint32_t cq;
int64_t target_bps;
int64_t max_bps;
int64_t buffer_bits;
int is_hevc; // 1 = H.265, 0 = H.264
int chroma_444; // 1 = 4:4:4 (H.264 High 4:4:4 / HEVC FRExt), 0 = 4:2:0
} NvencConfig;
// Initialize and open an NVENC encoding session. Returns NULL on error.
NvencEngine* nvenc_create(const NvencConfig* config);
// Register host shared memory (XShm buffer) as CUDA pinned memory that NVENC reads by DMA.
// Returns 0 on success, negative value on error.
int nvenc_register_host_buffer(NvencEngine* engine, void* host_ptr, size_t size);
// Unregister a previously registered host buffer (the CUDA context must be current).
void nvenc_unregister_host_buffer(NvencEngine* engine);
// Encode one frame.
// If host buffer was registered via nvenc_register_host_buffer, input_argb can be NULL
// and the encoder reads the registered host memory directly (no host-to-device copy).
// force_idr: 1 to force keyframe/IDR, 0 otherwise
// out_data: pointer to receive the bitstream buffer (valid until next encode call or destroy)
// out_len: pointer to receive the bitstream size in bytes
// Returns 0 on success, negative value on error.
int nvenc_encode_frame(
NvencEngine* engine,
const uint8_t* input_argb,
uint32_t pitch,
int force_idr,
const uint8_t** out_data,
uint32_t* out_len
);
// Destroy the NVENC engine and free all CUDA/NVENC resources.
void nvenc_destroy(NvencEngine* engine);
#ifdef __cplusplus
}
#endif
#endif // UU_NVENC_ENGINE_H
+837
View File
@@ -0,0 +1,837 @@
#include "vaapi_engine.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <dlfcn.h>
#include <va/va.h>
#include <va/va_drm.h>
#include <va/va_drmcommon.h>
#include <va/va_vpp.h>
#include <va/va_enc_h264.h>
// Runtime-loaded libva, like the NVENC engine's libcuda/libnvidia-encode: an inproc-av build
// must not add a hard DT_NEEDED on libva for users who never touch VAAPI.
// Signatures come from the installed headers via __typeof__ so they cannot drift.
static struct {
void *libva, *libva_drm;
__typeof__(vaGetDisplayDRM) *vaGetDisplayDRM;
__typeof__(vaInitialize) *vaInitialize;
__typeof__(vaTerminate) *vaTerminate;
__typeof__(vaErrorStr) *vaErrorStr;
__typeof__(vaCreateSurfaces) *vaCreateSurfaces;
__typeof__(vaDestroySurfaces) *vaDestroySurfaces;
__typeof__(vaCreateConfig) *vaCreateConfig;
__typeof__(vaDestroyConfig) *vaDestroyConfig;
__typeof__(vaCreateContext) *vaCreateContext;
__typeof__(vaDestroyContext) *vaDestroyContext;
__typeof__(vaCreateBuffer) *vaCreateBuffer;
__typeof__(vaDestroyBuffer) *vaDestroyBuffer;
__typeof__(vaMapBuffer) *vaMapBuffer;
__typeof__(vaUnmapBuffer) *vaUnmapBuffer;
__typeof__(vaCreateImage) *vaCreateImage;
__typeof__(vaDestroyImage) *vaDestroyImage;
__typeof__(vaPutImage) *vaPutImage;
__typeof__(vaBeginPicture) *vaBeginPicture;
__typeof__(vaRenderPicture) *vaRenderPicture;
__typeof__(vaEndPicture) *vaEndPicture;
__typeof__(vaSyncSurface) *vaSyncSurface;
} RT;
static int vaapi_load_runtime(void) {
if (RT.libva) return 0;
RT.libva = dlopen("libva.so.2", RTLD_NOW | RTLD_GLOBAL);
RT.libva_drm = dlopen("libva-drm.so.2", RTLD_NOW);
if (!RT.libva || !RT.libva_drm) {
fprintf(stderr, "[vaapi] dlopen libva/libva-drm failed\n");
return -1;
}
// libva-drm depends on libva, so one lookup covers both libraries
#define VA_LOAD(sym) do { \
*(void**)&RT.sym = dlsym(RT.libva_drm, #sym) ? dlsym(RT.libva_drm, #sym) : dlsym(RT.libva, #sym); \
if (!RT.sym) { dlclose(RT.libva_drm); dlclose(RT.libva); RT.libva = RT.libva_drm = NULL; return -1; } \
} while (0)
VA_LOAD(vaGetDisplayDRM);
VA_LOAD(vaInitialize);
VA_LOAD(vaTerminate);
VA_LOAD(vaErrorStr);
VA_LOAD(vaCreateSurfaces);
VA_LOAD(vaDestroySurfaces);
VA_LOAD(vaCreateConfig);
VA_LOAD(vaDestroyConfig);
VA_LOAD(vaCreateContext);
VA_LOAD(vaDestroyContext);
VA_LOAD(vaCreateBuffer);
VA_LOAD(vaDestroyBuffer);
VA_LOAD(vaMapBuffer);
VA_LOAD(vaUnmapBuffer);
VA_LOAD(vaCreateImage);
VA_LOAD(vaDestroyImage);
VA_LOAD(vaPutImage);
VA_LOAD(vaBeginPicture);
VA_LOAD(vaRenderPicture);
VA_LOAD(vaEndPicture);
VA_LOAD(vaSyncSurface);
#undef VA_LOAD
return 0;
}
struct VaapiEngine {
int drm_fd;
VADisplay va_dpy;
uint32_t cap_width; // capture (RGB input) size
uint32_t cap_height;
uint32_t width; // encode (output) size
uint32_t height;
uint32_t fps;
uint32_t gop;
int64_t target_bps;
int64_t max_bps;
int64_t buffer_bits;
int is_hevc;
uint32_t frame_count;
// frames since the last IDR (periodic GOP), the alternating idr_pic_id, and an IDR owed after a lost frame
uint32_t since_idr;
uint32_t idr_pic_id;
int idr_pending;
// frame_num / POC bookkeeping since the last IDR; H264 state the driver does not derive itself
uint32_t frame_num;
uint32_t rc_mode;
// DMA-BUF backing
int dma_fd;
uint32_t stride;
// Surfaces & Contexts
VASurfaceID in_rgb_surf;
VASurfaceID nv12_surf;
VASurfaceID recon_surfs[2];
VAConfigID vpp_cfg;
VAContextID vpp_ctx;
VABufferID vpp_buf;
VARectangle src_rect, dst_rect;
VAConfigID enc_cfg;
VAContextID enc_ctx;
VABufferID coded_buf;
uint8_t *output_staging;
uint32_t output_staging_cap;
// Host upload path: a VAImage the CPU writes, then vaPutImage into in_rgb_surf
VAImage upload_img;
int upload_ready;
};
// The VPP pipeline buffer points at the engine-owned rects, so VPP scales cap -> output
static int vaapi_make_vpp_buffer(VaapiEngine* engine) {
VAProcPipelineParameterBuffer vpp_param;
memset(&vpp_param, 0, sizeof(vpp_param));
vpp_param.surface = engine->in_rgb_surf;
vpp_param.surface_region = &engine->src_rect;
vpp_param.output_region = &engine->dst_rect;
return RT.vaCreateBuffer(engine->va_dpy, engine->vpp_ctx, VAProcPipelineParameterBufferType,
sizeof(vpp_param), 1, &vpp_param, &engine->vpp_buf) == VA_STATUS_SUCCESS ? 0 : -1;
}
VaapiEngine* vaapi_create(const VaapiConfig* config) {
if (!config || config->width == 0 || config->height == 0 || config->cap_width == 0 || config->cap_height == 0) return NULL;
if (vaapi_load_runtime() != 0) return NULL;
VaapiEngine* engine = (VaapiEngine*)calloc(1, sizeof(VaapiEngine));
if (!engine) return NULL;
engine->cap_width = config->cap_width;
engine->cap_height = config->cap_height;
engine->width = config->width;
engine->height = config->height;
engine->fps = config->fps > 0 ? config->fps : 60;
engine->gop = config->gop > 0 ? config->gop : 30;
engine->target_bps = config->target_bps > 0 ? config->target_bps : 6000000;
engine->max_bps = config->max_bps > engine->target_bps ? config->max_bps : engine->target_bps;
engine->buffer_bits = config->buffer_bits > 0 ? config->buffer_bits : engine->max_bps;
engine->is_hevc = config->is_hevc;
engine->dma_fd = -1;
// calloc leaves surface/context IDs at 0, which is a valid VA ID; mark them unset.
engine->in_rgb_surf = VA_INVALID_ID;
engine->nv12_surf = VA_INVALID_ID;
engine->recon_surfs[0] = VA_INVALID_ID;
engine->recon_surfs[1] = VA_INVALID_ID;
engine->vpp_cfg = VA_INVALID_ID;
engine->vpp_ctx = VA_INVALID_ID;
engine->vpp_buf = VA_INVALID_ID;
engine->enc_cfg = VA_INVALID_ID;
engine->enc_ctx = VA_INVALID_ID;
engine->coded_buf = VA_INVALID_ID;
engine->src_rect.width = config->cap_width;
engine->src_rect.height = config->cap_height;
engine->dst_rect.width = config->width;
engine->dst_rect.height = config->height;
engine->drm_fd = open(config->device ? config->device : "/dev/dri/renderD128", O_RDWR);
if (engine->drm_fd < 0) {
fprintf(stderr, "[vaapi] failed to open %s\n", config->device ? config->device : "/dev/dri/renderD128");
free(engine);
return NULL;
}
engine->va_dpy = RT.vaGetDisplayDRM(engine->drm_fd);
if (!engine->va_dpy) {
close(engine->drm_fd);
free(engine);
return NULL;
}
int maj, min;
VAStatus st = RT.vaInitialize(engine->va_dpy, &maj, &min);
if (st != VA_STATUS_SUCCESS) {
fprintf(stderr, "[vaapi] vaInitialize failed: %s\n", RT.vaErrorStr(st));
close(engine->drm_fd);
free(engine);
return NULL;
}
// 1. NV12 intermediate + two Recon surfaces at the encode size (ping-pong: a P frame must
// not reference the surface its own reconstruction is being written into)
st = RT.vaCreateSurfaces(engine->va_dpy, VA_RT_FORMAT_YUV420, engine->width, engine->height, &engine->nv12_surf, 1, NULL, 0);
if (st != VA_STATUS_SUCCESS) {
vaapi_destroy(engine);
return NULL;
}
st = RT.vaCreateSurfaces(engine->va_dpy, VA_RT_FORMAT_YUV420, engine->width, engine->height, engine->recon_surfs, 2, NULL, 0);
if (st != VA_STATUS_SUCCESS) {
vaapi_destroy(engine);
return NULL;
}
// 2. Setup VPP (Video Processing Pipeline for Hardware RGB->NV12 with scaling)
uint32_t vpp_w = engine->cap_width > engine->width ? engine->cap_width : engine->width;
uint32_t vpp_h = engine->cap_height > engine->height ? engine->cap_height : engine->height;
st = RT.vaCreateConfig(engine->va_dpy, VAProfileNone, VAEntrypointVideoProc, NULL, 0, &engine->vpp_cfg);
if (st != VA_STATUS_SUCCESS) {
vaapi_destroy(engine);
return NULL;
}
st = RT.vaCreateContext(engine->va_dpy, engine->vpp_cfg, vpp_w, vpp_h, 0, NULL, 0, &engine->vpp_ctx);
if (st != VA_STATUS_SUCCESS) {
vaapi_destroy(engine);
return NULL;
}
// 3. Setup H.264 / HEVC EncSlice
VAProfile profile = engine->is_hevc ? VAProfileHEVCMain : VAProfileH264Main;
VAConfigAttrib enc_attrib[3];
enc_attrib[0].type = VAConfigAttribRTFormat;
enc_attrib[0].value = VA_RT_FORMAT_YUV420;
enc_attrib[1].type = VAConfigAttribRateControl;
// The engine writes SPS, PPS and slice headers itself (see BitWriter)
enc_attrib[2].type = VAConfigAttribEncPackedHeaders;
enc_attrib[2].value = VA_ENC_PACKED_HEADER_SEQUENCE | VA_ENC_PACKED_HEADER_SLICE;
// VBR like the FFmpeg VAAPI pipeline (target + maxrate), then CBR, then CQP
enc_attrib[1].value = VA_RC_VBR;
engine->rc_mode = VA_RC_VBR;
st = RT.vaCreateConfig(engine->va_dpy, profile, VAEntrypointEncSlice, enc_attrib, 3, &engine->enc_cfg);
if (st != VA_STATUS_SUCCESS) {
enc_attrib[1].value = VA_RC_CBR;
engine->rc_mode = VA_RC_CBR;
st = RT.vaCreateConfig(engine->va_dpy, profile, VAEntrypointEncSlice, enc_attrib, 3, &engine->enc_cfg);
}
if (st != VA_STATUS_SUCCESS) {
// Fallback to CQP if CBR unsupported
enc_attrib[1].value = VA_RC_CQP;
st = RT.vaCreateConfig(engine->va_dpy, profile, VAEntrypointEncSlice, enc_attrib, 3, &engine->enc_cfg);
if (st != VA_STATUS_SUCCESS) {
fprintf(stderr, "[vaapi] vaCreateConfig EncSlice failed: %s\n", RT.vaErrorStr(st));
vaapi_destroy(engine);
return NULL;
}
engine->rc_mode = VA_RC_CQP;
}
st = RT.vaCreateContext(engine->va_dpy, engine->enc_cfg, engine->width, engine->height, VA_PROGRESSIVE, engine->recon_surfs, 2, &engine->enc_ctx);
if (st != VA_STATUS_SUCCESS) {
fprintf(stderr, "[vaapi] vaCreateContext EncSlice failed: %s\n", RT.vaErrorStr(st));
vaapi_destroy(engine);
return NULL;
}
// Coded bitstream buffer: generous, a 20M-preset intra frame can burst past 4MB
st = RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncCodedBufferType, 16 * 1024 * 1024, 1, NULL, &engine->coded_buf);
if (st != VA_STATUS_SUCCESS) {
vaapi_destroy(engine);
return NULL;
}
return engine;
}
int vaapi_import_dma_buffer(VaapiEngine* engine, int dma_fd, uint32_t stride) {
if (!engine || dma_fd < 0) return -1;
if (engine->in_rgb_surf != VA_INVALID_ID) {
RT.vaDestroySurfaces(engine->va_dpy, &engine->in_rgb_surf, 1);
engine->in_rgb_surf = VA_INVALID_ID;
}
if (engine->vpp_buf != VA_INVALID_ID) {
RT.vaDestroyBuffer(engine->va_dpy, engine->vpp_buf);
engine->vpp_buf = VA_INVALID_ID;
}
engine->dma_fd = dma_fd;
engine->stride = stride;
VADRMPRIMESurfaceDescriptor prime_desc;
memset(&prime_desc, 0, sizeof(prime_desc));
prime_desc.fourcc = VA_FOURCC_BGRX;
prime_desc.width = engine->cap_width;
prime_desc.height = engine->cap_height;
prime_desc.num_objects = 1;
prime_desc.objects[0].fd = dma_fd;
prime_desc.objects[0].size = stride * engine->cap_height;
prime_desc.objects[0].drm_format_modifier = 0;
prime_desc.num_layers = 1;
prime_desc.layers[0].drm_format = 0x34325258; // DRM_FORMAT_XRGB8888
prime_desc.layers[0].num_planes = 1;
prime_desc.layers[0].pitch[0] = stride;
VASurfaceAttrib attribs[2];
attribs[0].type = VASurfaceAttribMemoryType;
attribs[0].flags = VA_SURFACE_ATTRIB_SETTABLE;
attribs[0].value.type = VAGenericValueTypeInteger;
attribs[0].value.value.i = VA_SURFACE_ATTRIB_MEM_TYPE_DRM_PRIME_2;
attribs[1].type = VASurfaceAttribExternalBufferDescriptor;
attribs[1].flags = VA_SURFACE_ATTRIB_SETTABLE;
attribs[1].value.type = VAGenericValueTypePointer;
attribs[1].value.value.p = &prime_desc;
VAStatus st = RT.vaCreateSurfaces(engine->va_dpy, VA_RT_FORMAT_RGB32, engine->cap_width, engine->cap_height, &engine->in_rgb_surf, 1, attribs, 2);
if (st != VA_STATUS_SUCCESS) {
fprintf(stderr, "[vaapi] vaCreateSurfaces DRM_PRIME_2 failed: %s\n", RT.vaErrorStr(st));
return -1;
}
if (vaapi_make_vpp_buffer(engine) != 0) {
fprintf(stderr, "[vaapi] vaCreateBuffer VPP failed\n");
return -2;
}
return 0;
}
int vaapi_upload_host_buffer(VaapiEngine* engine, const uint8_t* host_ptr, uint32_t pitch) {
if (!engine || !host_ptr) return -1;
if (engine->in_rgb_surf == VA_INVALID_ID) {
VAStatus st = RT.vaCreateSurfaces(engine->va_dpy, VA_RT_FORMAT_RGB32, engine->cap_width, engine->cap_height, &engine->in_rgb_surf, 1, NULL, 0);
if (st != VA_STATUS_SUCCESS) return -2;
if (vaapi_make_vpp_buffer(engine) != 0) return -3;
}
if (!engine->upload_ready) {
VAImageFormat fmt;
memset(&fmt, 0, sizeof(fmt));
fmt.fourcc = VA_FOURCC_BGRX;
fmt.byte_order = VA_LSB_FIRST;
fmt.bits_per_pixel = 32;
fmt.depth = 24;
fmt.red_mask = 0x00ff0000;
fmt.green_mask = 0x0000ff00;
fmt.blue_mask = 0x000000ff;
// vaDeriveImage on the RGB32 surface is refused by some drivers
VAStatus st = RT.vaCreateImage(engine->va_dpy, &fmt, engine->cap_width, engine->cap_height, &engine->upload_img);
if (st != VA_STATUS_SUCCESS) return -4;
engine->upload_ready = 1;
}
void* p = NULL;
VAStatus st = RT.vaMapBuffer(engine->va_dpy, engine->upload_img.buf, &p);
if (st != VA_STATUS_SUCCESS || !p) return -5;
uint32_t copy_bytes = engine->cap_width * 4;
for (uint32_t y = 0; y < engine->cap_height; y++) {
memcpy((uint8_t*)p + y * engine->upload_img.pitches[0], host_ptr + y * pitch, copy_bytes);
}
RT.vaUnmapBuffer(engine->va_dpy, engine->upload_img.buf);
st = RT.vaPutImage(engine->va_dpy, engine->in_rgb_surf, engine->upload_img.image_id,
0, 0, engine->cap_width, engine->cap_height, 0, 0, engine->cap_width, engine->cap_height);
if (st != VA_STATUS_SUCCESS) return -6;
return 0;
}
// Sequence-level misc parameter. AMD's Mesa driver feeds the VCN ring message from these;
// a CBR config that never gets its rate-control/HRD parameters submits garbage and the
// encode job wedges the ring until a GPU reset.
// Packed H.264 / HEVC headers. Current radeonsi (Mesa 26) writes neither SPS/PPS nor the NAL/slice header from the
// parameter buffers alone (output began 00 00 00 01 00 ..., no SPS), so the host writes them like FFmpeg does.
// Every field here must match the sequence/picture/slice parameters submitted with it.
typedef struct { uint8_t buf[128]; uint32_t bits; } BitWriter;
static void bw_put(BitWriter* w, uint32_t value, int n) {
for (int i = n - 1; i >= 0; i--, w->bits++) {
if (w->bits / 8 >= sizeof(w->buf)) return;
if ((value >> i) & 1) w->buf[w->bits / 8] |= 0x80 >> (w->bits % 8);
}
}
static void bw_ue(BitWriter* w, uint32_t value) {
int len = 0;
for (uint32_t v = value + 1; v > 1; v >>= 1) len++;
bw_put(w, 0, len);
bw_put(w, value + 1, len + 1);
}
static void bw_se(BitWriter* w, int32_t value) { bw_ue(w, value > 0 ? 2 * (uint32_t)value - 1 : 2 * (uint32_t)(-value)); }
static void bw_trailing(BitWriter* w) { bw_put(w, 1, 1); if (w->bits % 8) bw_put(w, 0, 8 - w->bits % 8); }
// Start code + NAL header; the payload follows unescaped, emulation prevention is applied by bw_escape.
static void bw_nal(BitWriter* w, int ref_idc, int type) { bw_put(w, 1, 32); bw_put(w, (ref_idc << 5) | type, 8); }
// Insert emulation prevention bytes after the start code + NAL header (byte 5 on). Returns the byte length.
static uint32_t bw_escape(const BitWriter* w, uint8_t* out, uint32_t cap) {
uint32_t len = (w->bits + 7) / 8, n = 0, zeros = 0;
for (uint32_t i = 0; i < len && n < cap; i++) {
if (i >= 5 && zeros >= 2 && w->buf[i] <= 3) { out[n++] = 3; zeros = 0; if (n >= cap) break; }
zeros = w->buf[i] == 0 && i >= 5 ? zeros + 1 : 0;
out[n++] = w->buf[i];
}
return n;
}
// Each NAL is escaped on its own, so the next NAL's start code stays intact.
static int vaapi_add_packed(VaapiEngine* engine, VAEncPackedHeaderType type, const BitWriter* nals, int count,
VABufferID* ids, int* n) {
uint8_t data[320];
uint32_t bytes = 0;
for (int i = 0; i < count; i++) bytes += bw_escape(&nals[i], data + bytes, sizeof(data) - bytes);
VAEncPackedHeaderParameterBuffer param = { .type = type, .bit_length = bytes * 8, .has_emulation_bytes = 1 };
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncPackedHeaderParameterBufferType, sizeof(param), 1, &param, &ids[*n]) != VA_STATUS_SUCCESS)
return -1;
(*n)++;
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncPackedHeaderDataBufferType, bytes, 1, data, &ids[*n]) != VA_STATUS_SUCCESS)
return -1;
(*n)++;
return 0;
}
static VABufferID vaapi_create_misc_buffer(VaapiEngine* engine, VAEncMiscParameterType type, const void* param, uint32_t param_size) {
uint8_t buf[sizeof(VAEncMiscParameterBuffer) + 64];
VAEncMiscParameterBuffer* misc = (VAEncMiscParameterBuffer*)buf;
misc->type = type;
memcpy(misc->data, param, param_size);
VABufferID id = VA_INVALID_ID;
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncMiscParameterBufferType,
sizeof(VAEncMiscParameterBuffer) + param_size, 1, buf, &id) != VA_STATUS_SUCCESS) {
return VA_INVALID_ID;
}
return id;
}
// Buffers for one encoded picture; every created ID is destroyed after the picture, success or not.
typedef struct {
VABufferID seq, misc[3], pic, slice, packed[6];
int misc_n, packed_n;
} EncBuffers;
static int vaapi_h264_params(VaapiEngine* engine, int is_idr, VASurfaceID curr_recon, VASurfaceID prev_recon, EncBuffers* b) {
uint32_t mb_w = (engine->width + 15) / 16;
uint32_t mb_h = (engine->height + 15) / 16;
uint32_t frame_num = is_idr ? 0 : engine->frame_num;
uint32_t crop_right = (mb_w * 16 - engine->width) / 2, crop_bottom = (mb_h * 16 - engine->height) / 2;
if (is_idr) {
VAEncSequenceParameterBufferH264 seq_p;
memset(&seq_p, 0, sizeof(seq_p));
seq_p.seq_parameter_set_id = 0;
seq_p.level_idc = 51;
seq_p.intra_period = engine->gop;
seq_p.intra_idr_period = engine->gop;
seq_p.ip_period = 1;
seq_p.bits_per_second = (uint32_t)engine->max_bps;
seq_p.max_num_ref_frames = 1;
seq_p.picture_width_in_mbs = mb_w;
seq_p.picture_height_in_mbs = mb_h;
seq_p.seq_fields.bits.direct_8x8_inference_flag = 1;
seq_p.seq_fields.bits.frame_mbs_only_flag = 1;
seq_p.seq_fields.bits.pic_order_cnt_type = 0;
seq_p.frame_cropping_flag = crop_right || crop_bottom;
seq_p.frame_crop_right_offset = crop_right;
seq_p.frame_crop_bottom_offset = crop_bottom;
// An IDR without its SPS is undecodable: fail rather than submit pic + slice alone
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncSequenceParameterBufferType, sizeof(seq_p), 1, &seq_p, &b->seq) != VA_STATUS_SUCCESS)
return -1;
// SPS: Main, level 5.1, frame_num and POC lsb 4 bits (both wrap & 15 above), one reference
BitWriter sps = {0};
bw_nal(&sps, 3, 7);
bw_put(&sps, 77, 8); bw_put(&sps, 0x40, 8); bw_put(&sps, 51, 8); // constraint_set1: Main
bw_ue(&sps, 0); bw_ue(&sps, 0); bw_ue(&sps, 0); bw_ue(&sps, 0); // sps id, log2_max_frame_num-4, poc type 0, log2_max_poc_lsb-4
bw_ue(&sps, 1); bw_put(&sps, 0, 1); // max_num_ref_frames, gaps
bw_ue(&sps, mb_w - 1); bw_ue(&sps, mb_h - 1);
bw_put(&sps, 1, 1); bw_put(&sps, 1, 1); // frame_mbs_only, direct_8x8_inference
bw_put(&sps, seq_p.frame_cropping_flag, 1);
if (seq_p.frame_cropping_flag) { bw_ue(&sps, 0); bw_ue(&sps, crop_right); bw_ue(&sps, 0); bw_ue(&sps, crop_bottom); }
bw_put(&sps, 0, 1); // no VUI
bw_trailing(&sps);
// PPS: CABAC, one L0 reference, QP 26, default deblocking
BitWriter pps = {0};
bw_nal(&pps, 3, 8);
bw_ue(&pps, 0); bw_ue(&pps, 0); bw_put(&pps, 1, 1); bw_put(&pps, 0, 1);
bw_ue(&pps, 0); bw_ue(&pps, 0); bw_ue(&pps, 0); // slice groups, num_ref_idx l0/l1 - 1
bw_put(&pps, 0, 1); bw_put(&pps, 0, 2); // weighted pred / bipred
bw_se(&pps, 0); bw_se(&pps, 0); bw_se(&pps, 0); // pic_init_qp-26, qs, chroma offset
bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); // deblocking control, constrained intra, redundant
bw_trailing(&pps);
// SPS and PPS go out as one Sequence header, like FFmpeg
BitWriter headers[2] = { sps, pps };
if (vaapi_add_packed(engine, VAEncPackedHeaderSequence, headers, 2, b->packed, &b->packed_n) != 0) return -1;
}
VAEncPictureParameterBufferH264 pic_p;
memset(&pic_p, 0, sizeof(pic_p));
pic_p.CurrPic.picture_id = curr_recon;
pic_p.CurrPic.flags = VA_PICTURE_H264_SHORT_TERM_REFERENCE;
pic_p.CurrPic.frame_idx = frame_num;
pic_p.CurrPic.TopFieldOrderCnt = pic_p.CurrPic.BottomFieldOrderCnt = (2 * frame_num) & 15;
for (int i = 0; i < 16; i++) pic_p.ReferenceFrames[i].picture_id = VA_INVALID_ID;
if (!is_idr) {
pic_p.ReferenceFrames[0].picture_id = prev_recon;
pic_p.ReferenceFrames[0].flags = VA_PICTURE_H264_SHORT_TERM_REFERENCE;
pic_p.ReferenceFrames[0].frame_idx = (frame_num - 1) & 15;
pic_p.ReferenceFrames[0].TopFieldOrderCnt = pic_p.ReferenceFrames[0].BottomFieldOrderCnt = (2 * (frame_num - 1)) & 15;
}
pic_p.coded_buf = engine->coded_buf;
pic_p.frame_num = frame_num;
pic_p.pic_init_qp = 26;
pic_p.seq_parameter_set_id = 0;
pic_p.pic_parameter_set_id = 0;
pic_p.pic_fields.bits.idr_pic_flag = is_idr ? 1 : 0;
pic_p.pic_fields.bits.reference_pic_flag = 1;
pic_p.pic_fields.bits.entropy_coding_mode_flag = 1;
pic_p.pic_fields.bits.deblocking_filter_control_present_flag = 0;
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncPictureParameterBufferType, sizeof(pic_p), 1, &pic_p, &b->pic) != VA_STATUS_SUCCESS)
return -1;
VAEncSliceParameterBufferH264 slice_p;
memset(&slice_p, 0, sizeof(slice_p));
slice_p.macroblock_address = 0;
slice_p.num_macroblocks = mb_w * mb_h;
slice_p.macroblock_info = VA_INVALID_ID;
slice_p.slice_type = is_idr ? 2 : 0; // 2 = I-Slice, 0 = P-Slice
slice_p.direct_spatial_mv_pred_flag = 1;
// Consecutive IDRs must differ in idr_pic_id (7.4.3); flip it on every IDR
if (is_idr) engine->idr_pic_id ^= 1;
slice_p.idr_pic_id = engine->idr_pic_id;
slice_p.pic_order_cnt_lsb = pic_p.CurrPic.TopFieldOrderCnt;
for (int i = 0; i < 32; i++) slice_p.RefPicList0[i].picture_id = VA_INVALID_ID;
if (!is_idr) {
slice_p.RefPicList0[0].picture_id = prev_recon;
slice_p.RefPicList0[0].flags = VA_PICTURE_H264_SHORT_TERM_REFERENCE;
slice_p.RefPicList0[0].frame_idx = (frame_num - 1) & 15;
}
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncSliceParameterBufferType, sizeof(slice_p), 1, &slice_p, &b->slice) != VA_STATUS_SUCCESS)
return -1;
// Slice header including cabac_alignment_one_bit, byte aligned and escaped as FFmpeg submits it
BitWriter sh = {0};
bw_nal(&sh, 3, is_idr ? 5 : 1);
bw_ue(&sh, 0); bw_ue(&sh, is_idr ? 7 : 5); bw_ue(&sh, 0); // first_mb, slice_type I/P (all slices), pps id
bw_put(&sh, frame_num & 15, 4);
if (is_idr) bw_ue(&sh, slice_p.idr_pic_id);
bw_put(&sh, slice_p.pic_order_cnt_lsb & 15, 4);
if (!is_idr) { bw_put(&sh, 0, 1); bw_put(&sh, 0, 1); } // num_ref_idx override, ref list modification
if (is_idr) { bw_put(&sh, 0, 1); bw_put(&sh, 0, 1); } // no_output_of_prior_pics, long_term_reference
else bw_put(&sh, 0, 1); // adaptive_ref_pic_marking
if (!is_idr) bw_ue(&sh, 0); // cabac_init_idc
bw_se(&sh, 0); // slice_qp_delta (no deblocking fields)
while (sh.bits % 8) bw_put(&sh, 1, 1);
return vaapi_add_packed(engine, VAEncPackedHeaderSlice, &sh, 1, b->packed, &b->packed_n);
}
// HEVC NAL header: forbidden 0, nal_unit_type, nuh_layer_id 0, nuh_temporal_id_plus1 1.
static void bw_hevc_nal(BitWriter* w, int type) { bw_put(w, 1, 32); bw_put(w, (type << 9) | 1, 16); }
// profile_tier_level(1, 0): Main, Main 10 compatible like FFmpeg, progressive frames only.
static void bw_hevc_ptl(BitWriter* w, uint32_t level) {
bw_put(w, 0, 2); bw_put(w, 0, 1); bw_put(w, 1, 5); // profile space, tier, general_profile_idc Main
bw_put(w, 0x60000000, 32); // compatibility flags 1 and 2
bw_put(w, 1, 1); bw_put(w, 0, 1); bw_put(w, 1, 1); bw_put(w, 1, 1); // progressive, interlaced, non_packed, frame_only
bw_put(w, 0, 32); bw_put(w, 0, 12); // reserved_zero_43bits + inbld_flag
bw_put(w, level, 8);
}
// HEVC Main with FFmpeg's hevc_vaapi parameters on radeonsi (LIBVA_TRACE + trace_headers of its output):
// 64x64 CTB, 8x8 min CB, 4x4..32x32 TB, AMP and SAO on, one short-term reference, POC lsb 12 bits.
// FFmpeg also sends VA max_transform_hierarchy_depth 0 / diff_cu_qp_delta_depth 3 while its SPS/PPS
// say 4 / 0; both copies are kept as FFmpeg has them, since that is what decodes on this driver.
static int vaapi_hevc_params(VaapiEngine* engine, int is_idr, VASurfaceID curr_recon, VASurfaceID prev_recon, EncBuffers* b) {
// pic size must be a multiple of the 8x8 min CB; the conformance window (in chroma units) crops the rest
uint32_t w = (engine->width + 7) & ~7u, h = (engine->height + 7) & ~7u;
uint32_t crop_right = (w - engine->width) / 2, crop_bottom = (h - engine->height) / 2;
uint32_t poc = is_idr ? 0 : engine->since_idr;
// Level from luma picture size and sample rate (Table A.8): 4.1, 5.0, 5.1, 5.2
uint64_t size = (uint64_t)w * h, rate = size * engine->fps;
uint32_t level = rate > 534773760 ? 156 : rate > 267386880 ? 153 : (size > 2228224 || rate > 133693440) ? 150 : 123;
if (is_idr) {
VAEncSequenceParameterBufferHEVC seq_p;
memset(&seq_p, 0, sizeof(seq_p));
seq_p.general_profile_idc = 1;
seq_p.general_level_idc = level;
seq_p.intra_period = engine->gop;
seq_p.intra_idr_period = engine->gop;
seq_p.ip_period = 1;
seq_p.bits_per_second = (uint32_t)engine->max_bps;
seq_p.pic_width_in_luma_samples = w;
seq_p.pic_height_in_luma_samples = h;
seq_p.seq_fields.bits.chroma_format_idc = 1;
seq_p.seq_fields.bits.amp_enabled_flag = 1;
seq_p.seq_fields.bits.sample_adaptive_offset_enabled_flag = 1;
seq_p.log2_diff_max_min_luma_coding_block_size = 3;
seq_p.log2_diff_max_min_transform_block_size = 3;
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncSequenceParameterBufferType, sizeof(seq_p), 1, &seq_p, &b->seq) != VA_STATUS_SUCCESS)
return -1;
BitWriter vps = {0};
bw_hevc_nal(&vps, 32);
bw_put(&vps, 0, 4); bw_put(&vps, 1, 1); bw_put(&vps, 1, 1); // vps id, base layer internal / available
bw_put(&vps, 0, 6); bw_put(&vps, 0, 3); bw_put(&vps, 1, 1); // max layers-1, max sub layers-1, temporal id nesting
bw_put(&vps, 0xffff, 16);
bw_hevc_ptl(&vps, level);
bw_put(&vps, 0, 1); bw_ue(&vps, 1); bw_ue(&vps, 0); bw_ue(&vps, 0); // ordering info: dec buffering-1, reorder, latency
bw_put(&vps, 0, 6); bw_ue(&vps, 0); // max layer id, num layer sets-1
bw_put(&vps, 0, 1); bw_put(&vps, 0, 1); // no timing info, no extension
bw_trailing(&vps);
BitWriter sps = {0};
bw_hevc_nal(&sps, 33);
bw_put(&sps, 0, 4); bw_put(&sps, 0, 3); bw_put(&sps, 1, 1); // vps id, max sub layers-1, temporal id nesting
bw_hevc_ptl(&sps, level);
bw_ue(&sps, 0); bw_ue(&sps, 1); bw_ue(&sps, w); bw_ue(&sps, h); // sps id, 4:2:0, size
bw_put(&sps, crop_right || crop_bottom, 1);
if (crop_right || crop_bottom) { bw_ue(&sps, 0); bw_ue(&sps, crop_right); bw_ue(&sps, 0); bw_ue(&sps, crop_bottom); }
bw_ue(&sps, 0); bw_ue(&sps, 0); bw_ue(&sps, 8); // 8-bit luma/chroma, log2_max_poc_lsb-4
bw_put(&sps, 0, 1); bw_ue(&sps, 1); bw_ue(&sps, 0); bw_ue(&sps, 0);
bw_ue(&sps, 0); bw_ue(&sps, 3); bw_ue(&sps, 0); bw_ue(&sps, 3); // CB 8..64, TB 4..32
bw_ue(&sps, 4); bw_ue(&sps, 4); // max transform hierarchy depth inter/intra
bw_put(&sps, 0, 1); bw_put(&sps, 1, 1); bw_put(&sps, 1, 1); bw_put(&sps, 0, 1); // scaling list, AMP, SAO, PCM
bw_ue(&sps, 0); bw_put(&sps, 0, 1); // RPS in slice headers, no long-term refs
bw_put(&sps, 0, 1); bw_put(&sps, 0, 1); // temporal MVP, strong intra smoothing
bw_put(&sps, 0, 1); bw_put(&sps, 0, 1); // no VUI, no extension
bw_trailing(&sps);
BitWriter pps = {0};
bw_hevc_nal(&pps, 34);
bw_ue(&pps, 0); bw_ue(&pps, 0);
bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); bw_put(&pps, 0, 3); // dependent slices, output flag, extra bits
bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); // sign data hiding, cabac init present
bw_ue(&pps, 0); bw_ue(&pps, 0); bw_se(&pps, 0); // num_ref_idx l0/l1 default-1, init_qp-26
bw_put(&pps, 0, 1); bw_put(&pps, 1, 1); bw_put(&pps, 1, 1); // constrained intra, transform skip, cu_qp_delta
bw_ue(&pps, 0); bw_se(&pps, 0); bw_se(&pps, 0); // diff_cu_qp_delta_depth, cb/cr offsets
bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); // slice chroma offsets, weighted pred/bipred
bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); // transquant bypass, tiles, entropy sync
bw_put(&pps, 1, 1); bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); // loop filter across slices, deblocking ctl, scaling
bw_put(&pps, 0, 1); bw_ue(&pps, 0); bw_put(&pps, 0, 1); bw_put(&pps, 0, 1); // list mod, merge level-2, ext
bw_trailing(&pps);
BitWriter headers[3] = { vps, sps, pps };
if (vaapi_add_packed(engine, VAEncPackedHeaderSequence, headers, 3, b->packed, &b->packed_n) != 0) return -1;
}
VAEncPictureParameterBufferHEVC pic_p;
memset(&pic_p, 0, sizeof(pic_p));
pic_p.decoded_curr_pic.picture_id = curr_recon;
pic_p.decoded_curr_pic.pic_order_cnt = poc;
for (int i = 0; i < 15; i++) {
pic_p.reference_frames[i].picture_id = VA_INVALID_ID;
pic_p.reference_frames[i].flags = VA_PICTURE_HEVC_INVALID;
}
if (!is_idr) {
pic_p.reference_frames[0].picture_id = prev_recon;
pic_p.reference_frames[0].pic_order_cnt = poc - 1;
pic_p.reference_frames[0].flags = VA_PICTURE_HEVC_RPS_ST_CURR_BEFORE;
}
pic_p.coded_buf = engine->coded_buf;
pic_p.collocated_ref_pic_index = 0xff;
pic_p.pic_init_qp = 30;
pic_p.diff_cu_qp_delta_depth = 3;
pic_p.nal_unit_type = is_idr ? 19 : 1; // IDR_W_RADL / TRAIL_R
pic_p.pic_fields.bits.idr_pic_flag = is_idr;
pic_p.pic_fields.bits.coding_type = is_idr ? 1 : 2;
pic_p.pic_fields.bits.reference_pic_flag = 1;
pic_p.pic_fields.bits.transform_skip_enabled_flag = 1;
pic_p.pic_fields.bits.cu_qp_delta_enabled_flag = 1;
pic_p.pic_fields.bits.pps_loop_filter_across_slices_enabled_flag = 1;
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncPictureParameterBufferType, sizeof(pic_p), 1, &pic_p, &b->pic) != VA_STATUS_SUCCESS)
return -1;
VAEncSliceParameterBufferHEVC slice_p;
memset(&slice_p, 0, sizeof(slice_p));
slice_p.num_ctu_in_slice = ((w + 63) / 64) * ((h + 63) / 64);
slice_p.slice_type = is_idr ? 2 : 1; // I / P
for (int i = 0; i < 15; i++) {
slice_p.ref_pic_list0[i].picture_id = slice_p.ref_pic_list1[i].picture_id = VA_INVALID_ID;
slice_p.ref_pic_list0[i].flags = slice_p.ref_pic_list1[i].flags = VA_PICTURE_HEVC_INVALID;
}
if (!is_idr) slice_p.ref_pic_list0[0] = pic_p.reference_frames[0];
slice_p.max_num_merge_cand = 5;
slice_p.slice_fields.bits.last_slice_of_pic_flag = 1;
slice_p.slice_fields.bits.slice_sao_luma_flag = 1;
slice_p.slice_fields.bits.slice_sao_chroma_flag = 1;
slice_p.slice_fields.bits.collocated_from_l0_flag = !is_idr;
if (RT.vaCreateBuffer(engine->va_dpy, engine->enc_ctx, VAEncSliceParameterBufferType, sizeof(slice_p), 1, &slice_p, &b->slice) != VA_STATUS_SUCCESS)
return -1;
BitWriter sh = {0};
bw_hevc_nal(&sh, pic_p.nal_unit_type);
bw_put(&sh, 1, 1); // first slice segment
if (is_idr) bw_put(&sh, 0, 1); // no_output_of_prior_pics
bw_ue(&sh, 0); bw_ue(&sh, slice_p.slice_type); // pps id, slice type
if (!is_idr) {
bw_put(&sh, poc & 0xfff, 12);
bw_put(&sh, 0, 1); // RPS coded here: one previous picture
bw_ue(&sh, 1); bw_ue(&sh, 0); bw_ue(&sh, 0); bw_put(&sh, 1, 1); // negative 1, positive 0, delta-1 0, used
}
bw_put(&sh, 1, 1); bw_put(&sh, 1, 1); // SAO luma, chroma
if (!is_idr) { bw_put(&sh, 0, 1); bw_ue(&sh, 0); } // num_ref_idx override, five_minus_max_merge
bw_se(&sh, 0); // slice_qp_delta (the driver writes the real one)
bw_put(&sh, 0, 1); // loop filter across slices
bw_put(&sh, 1, 1); // byte_alignment()
while (sh.bits % 8) bw_put(&sh, 0, 1);
return vaapi_add_packed(engine, VAEncPackedHeaderSlice, &sh, 1, b->packed, &b->packed_n);
}
int vaapi_encode_frame(
VaapiEngine* engine,
int force_idr,
const uint8_t** out_data,
uint32_t* out_len
) {
if (out_data) *out_data = NULL;
if (out_len) *out_len = 0;
if (!engine || engine->in_rgb_surf == VA_INVALID_ID) return -1;
int is_idr = force_idr || engine->idr_pending || engine->frame_count == 0 || engine->since_idr >= engine->gop;
// Recon ping-pong: a P frame must reference the previous recon surface, not its own
VASurfaceID curr_recon = engine->recon_surfs[engine->frame_count & 1];
VASurfaceID prev_recon = engine->recon_surfs[(engine->frame_count + 1) & 1];
// 1. Hardware VPP Color Conversion + scaling (RGB -> NV12 entirely inside VRAM)
VAStatus st = RT.vaBeginPicture(engine->va_dpy, engine->vpp_ctx, engine->nv12_surf);
if (st != VA_STATUS_SUCCESS) return -10;
st = RT.vaRenderPicture(engine->va_dpy, engine->vpp_ctx, &engine->vpp_buf, 1);
if (st != VA_STATUS_SUCCESS) return -10;
st = RT.vaEndPicture(engine->va_dpy, engine->vpp_ctx);
if (st != VA_STATUS_SUCCESS) return -10;
// 2. Rate control (every IDR) and the codec's sequence / picture / slice parameters + packed headers
EncBuffers b = { .seq = VA_INVALID_ID, .pic = VA_INVALID_ID, .slice = VA_INVALID_ID };
int ret = -11;
if (is_idr) {
VAEncMiscParameterRateControl rc;
memset(&rc, 0, sizeof(rc));
// VBR: bits_per_second is the ceiling (maxrate) and target_percentage the average (#33)
rc.bits_per_second = (uint32_t)engine->max_bps;
rc.target_percentage = engine->rc_mode == VA_RC_VBR ? (uint32_t)(engine->target_bps * 100 / engine->max_bps) : 100;
rc.window_size = 1000;
rc.initial_qp = 28;
rc.min_qp = 16;
// The driver's VBR raises QP only up to max_qp; 44 blocked the capped presets from reaching
// the QP 51 hardware floor on hard content (2560x1600 testsrc2: 4.16 -> 2.60 Mbps, #33)
rc.max_qp = 51;
rc.rc_flags.bits.disable_frame_skip = 1; // a remote desktop must not drop frames silently
b.misc[b.misc_n++] = vaapi_create_misc_buffer(engine, VAEncMiscParameterTypeRateControl, &rc, sizeof(rc));
VAEncMiscParameterHRD hrd;
memset(&hrd, 0, sizeof(hrd));
hrd.buffer_size = (uint32_t)engine->buffer_bits; // the viewer preset's bufsize
hrd.initial_buffer_fullness = hrd.buffer_size / 2;
b.misc[b.misc_n++] = vaapi_create_misc_buffer(engine, VAEncMiscParameterTypeHRD, &hrd, sizeof(hrd));
// numerator in the low 16 bits, denominator in the high 16 bits
VAEncMiscParameterFrameRate fr = { .framerate = (1u << 16) | engine->fps };
b.misc[b.misc_n++] = vaapi_create_misc_buffer(engine, VAEncMiscParameterTypeFrameRate, &fr, sizeof(fr));
}
if ((engine->is_hevc ? vaapi_hevc_params : vaapi_h264_params)(engine, is_idr, curr_recon, prev_recon, &b) != 0) goto done;
// 3. Render and Encode on AMD VCN hardware
VABufferID render_b[12];
int render_n = 0;
// FFmpeg's order: sequence, rate control misc, picture, packed headers (parameter sets, slice header), slice.
// With misc first, radeonsi (Mesa 26) ignored the VBR target: the 1M preset ran at 1.6 Mbps, 0.96 after.
if (b.seq != VA_INVALID_ID) render_b[render_n++] = b.seq;
for (int i = 0; i < b.misc_n; i++) {
if (b.misc[i] != VA_INVALID_ID) render_b[render_n++] = b.misc[i];
}
render_b[render_n++] = b.pic;
for (int i = 0; i < b.packed_n; i++) render_b[render_n++] = b.packed[i];
render_b[render_n++] = b.slice;
st = RT.vaBeginPicture(engine->va_dpy, engine->enc_ctx, engine->nv12_surf);
if (st != VA_STATUS_SUCCESS) goto done;
st = RT.vaRenderPicture(engine->va_dpy, engine->enc_ctx, render_b, render_n);
if (st != VA_STATUS_SUCCESS) goto done;
st = RT.vaEndPicture(engine->va_dpy, engine->enc_ctx);
if (st != VA_STATUS_SUCCESS) goto done;
st = RT.vaSyncSurface(engine->va_dpy, curr_recon);
if (st != VA_STATUS_SUCCESS) goto done;
// 4. Map Bitstream Output; an access unit may arrive as several linked segments
VACodedBufferSegment *segment = NULL;
st = RT.vaMapBuffer(engine->va_dpy, engine->coded_buf, (void**)&segment);
if (st != VA_STATUS_SUCCESS || !segment) goto done;
uint32_t total = 0;
for (VACodedBufferSegment *seg = segment; seg; seg = seg->next) total += seg->size;
if (total > 0 && !(segment->status & VA_CODED_BUF_STATUS_SLICE_OVERFLOW_MASK)) {
if (total > engine->output_staging_cap) {
engine->output_staging_cap = total + 64 * 1024;
engine->output_staging = (uint8_t*)realloc(engine->output_staging, engine->output_staging_cap);
}
uint32_t off = 0;
for (VACodedBufferSegment *seg = segment; seg; seg = seg->next) {
memcpy(engine->output_staging + off, seg->buf, seg->size);
off += seg->size;
}
*out_data = engine->output_staging;
*out_len = total;
}
RT.vaUnmapBuffer(engine->va_dpy, engine->coded_buf);
engine->frame_num = is_idr ? 1 : ((engine->frame_num + 1) & 15);
engine->since_idr = is_idr ? 1 : engine->since_idr + 1;
engine->frame_count++;
ret = 0;
done:
// No bitstream (failure, empty or slice overflow): the next frame_num / POC would skip, so restart with an IDR
engine->idr_pending = ret != 0 || *out_len == 0;
for (int i = 0; i < b.misc_n; i++) {
if (b.misc[i] != VA_INVALID_ID) RT.vaDestroyBuffer(engine->va_dpy, b.misc[i]);
}
if (b.seq != VA_INVALID_ID) RT.vaDestroyBuffer(engine->va_dpy, b.seq);
if (b.pic != VA_INVALID_ID) RT.vaDestroyBuffer(engine->va_dpy, b.pic);
if (b.slice != VA_INVALID_ID) RT.vaDestroyBuffer(engine->va_dpy, b.slice);
for (int i = 0; i < b.packed_n; i++) RT.vaDestroyBuffer(engine->va_dpy, b.packed[i]);
return ret;
}
void vaapi_destroy(VaapiEngine* engine) {
if (!engine) return;
if (engine->coded_buf != VA_INVALID_ID) RT.vaDestroyBuffer(engine->va_dpy, engine->coded_buf);
if (engine->enc_ctx != VA_INVALID_ID) RT.vaDestroyContext(engine->va_dpy, engine->enc_ctx);
if (engine->enc_cfg != VA_INVALID_ID) RT.vaDestroyConfig(engine->va_dpy, engine->enc_cfg);
if (engine->vpp_buf != VA_INVALID_ID) RT.vaDestroyBuffer(engine->va_dpy, engine->vpp_buf);
if (engine->vpp_ctx != VA_INVALID_ID) RT.vaDestroyContext(engine->va_dpy, engine->vpp_ctx);
if (engine->vpp_cfg != VA_INVALID_ID) RT.vaDestroyConfig(engine->va_dpy, engine->vpp_cfg);
if (engine->upload_ready) RT.vaDestroyImage(engine->va_dpy, engine->upload_img.image_id);
if (engine->in_rgb_surf != VA_INVALID_ID) RT.vaDestroySurfaces(engine->va_dpy, &engine->in_rgb_surf, 1);
if (engine->nv12_surf != VA_INVALID_ID) RT.vaDestroySurfaces(engine->va_dpy, &engine->nv12_surf, 1);
if (engine->recon_surfs[0] != VA_INVALID_ID || engine->recon_surfs[1] != VA_INVALID_ID) {
RT.vaDestroySurfaces(engine->va_dpy, engine->recon_surfs, 2);
}
if (engine->va_dpy) RT.vaTerminate(engine->va_dpy);
if (engine->drm_fd >= 0) close(engine->drm_fd);
if (engine->output_staging) free(engine->output_staging);
free(engine);
}
+49
View File
@@ -0,0 +1,49 @@
#ifndef UU_VAAPI_ENGINE_H
#define UU_VAAPI_ENGINE_H
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct VaapiEngine VaapiEngine;
typedef struct {
uint32_t width; // encode (output) size
uint32_t height;
uint32_t cap_width; // capture (input) size; VPP scales cap -> width
uint32_t cap_height;
uint32_t fps;
uint32_t gop;
int64_t target_bps;
int64_t max_bps; // VBR ceiling (viewer preset maxrate)
int64_t buffer_bits; // HRD buffer size
int is_hevc;
const char *device; // DRM render node (UU_VAAPI_DEVICE); NULL = /dev/dri/renderD128
} VaapiConfig;
VaapiEngine* vaapi_create(const VaapiConfig* config);
// Import a DRI3 / GBM DMA-BUF fd as the zero-copy input surface
int vaapi_import_dma_buffer(VaapiEngine* engine, int dma_fd, uint32_t stride);
// Host fallback: upload ARGB host memory if DMA-BUF is unavailable
int vaapi_upload_host_buffer(VaapiEngine* engine, const uint8_t* host_ptr, uint32_t pitch);
// Encode one frame
int vaapi_encode_frame(
VaapiEngine* engine,
int force_idr,
const uint8_t** out_data,
uint32_t* out_len
);
void vaapi_destroy(VaapiEngine* engine);
#ifdef __cplusplus
}
#endif
#endif // UU_VAAPI_ENGINE_H
+54 -33
View File
@@ -535,7 +535,10 @@ int uu_wl_init(int32_t *w,int32_t *h) {
wl_registry_add_listener(registry,&registry_listener,NULL); wl_registry_add_listener(registry,&registry_listener,NULL);
if(sync_display()!=0 || sync_display()!=0) goto end; if(sync_display()!=0 || sync_display()!=0) goto end;
dma_init(); dma_init();
if(!shm || !seat || !copy_manager || !pointer_manager || !keyboard_manager || !output_count) goto end; /* wlr-virtual-pointer is an optional input path. When the compositor does not
advertise it, pointer injection is skipped and the caller may drive input
through uinput; screencopy + virtual keyboard are still enough to capture. */
if(!shm || !seat || !copy_manager || !output_count) goto end;
const char *name=getenv("UU_WAYLAND_OUTPUT"); selected=0; const char *name=getenv("UU_WAYLAND_OUTPUT"); selected=0;
if(name && *name) { if(name && *name) {
for(selected=0;selected<output_count;selected++) if(!strcmp(outputs[selected].name,name)) break; for(selected=0;selected<output_count;selected++) if(!strcmp(outputs[selected].name,name)) break;
@@ -549,23 +552,30 @@ int uu_wl_init(int32_t *w,int32_t *h) {
power=zwlr_output_power_manager_v1_get_output_power(power_manager,outputs[selected].handle); power=zwlr_output_power_manager_v1_get_output_power(power_manager,outputs[selected].handle);
zwlr_output_power_v1_add_listener(power,&power_listener,NULL); zwlr_output_power_v1_add_listener(power,&power_listener,NULL);
} }
pointer=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[selected].handle); if(pointer_manager) pointer=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[selected].handle);
keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat); /* Some compositors reject a virtual keyboard from anything that is not their active
xkb=xkb_context_new(XKB_CONTEXT_NO_FLAGS); input method (Denial does), and a rejected proxy poisons later requests. Allow the
if(!xkb) goto end; caller to opt out and rely on uinput for key input instead. */
struct xkb_rule_names names={.layout="us"}; const char *skip_kbd=getenv("UU_WAYLAND_NO_VIRTUAL_KEYBOARD");
keymap=xkb_keymap_new_from_names(xkb,&names,XKB_KEYMAP_COMPILE_NO_FLAGS); if(keyboard_manager && !(skip_kbd && *skip_kbd && strcmp(skip_kbd,"0")))
if(!keymap) goto end; keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat);
key_state=xkb_state_new(keymap); if(!key_state) goto end; if(keyboard) {
keymap_text=xkb_keymap_get_as_string(keymap,XKB_KEYMAP_FORMAT_TEXT_V1); xkb=xkb_context_new(XKB_CONTEXT_NO_FLAGS);
if(!keymap_text) goto end; if(!xkb) goto end;
keymap_text_len=strlen(keymap_text)+1; struct xkb_rule_names names={.layout="us"};
if(upload_keymap(keymap_text,keymap_text_len)!=0) goto end; keymap=xkb_keymap_new_from_names(xkb,&names,XKB_KEYMAP_COMPILE_NO_FLAGS);
if(sync_display()!=0) goto end; if(!keymap) goto end;
/* Text typing needs unmapped keycodes and a place to declare them. A keymap without either key_state=xkb_state_new(keymap); if(!key_state) goto end;
only costs that path - uu_wl_type_utf8 refuses and the caller keeps its own fallback. */ keymap_text=xkb_keymap_get_as_string(keymap,XKB_KEYMAP_FORMAT_TEXT_V1);
keymap_insert=symbols_close(keymap_text); if(!keymap_text) goto end;
spare_count=find_spare_codes(spare_codes,sizeof(spare_codes)/sizeof(spare_codes[0])); keymap_text_len=strlen(keymap_text)+1;
if(upload_keymap(keymap_text,keymap_text_len)!=0) goto end;
if(sync_display()!=0) goto end;
/* Text typing needs unmapped keycodes and a place to declare them. A keymap without either
only costs that path - uu_wl_type_utf8 refuses and the caller keeps its own fallback. */
keymap_insert=symbols_close(keymap_text);
spare_count=find_spare_codes(spare_codes,sizeof(spare_codes)/sizeof(spare_codes[0]));
}
initialized=1; *w=width; *h=height; result=0; initialized=1; *w=width; *h=height; result=0;
end: end:
if(result!=0) reset(); if(result!=0) reset();
@@ -581,9 +591,12 @@ int uu_wl_select_output(const char *name,uint32_t expected_w,uint32_t expected_h
if(target==output_count || outputs[target].transform!=WL_OUTPUT_TRANSFORM_NORMAL) goto end; if(target==output_count || outputs[target].transform!=WL_OUTPUT_TRANSFORM_NORMAL) goto end;
uint32_t w=outputs[target].width,h=outputs[target].height; uint32_t w=outputs[target].width,h=outputs[target].height;
if(w!=expected_w || h!=expected_h || !w || !h || w>16384 || h>16384 || (uint64_t)w*h*4>256*1024*1024) goto end; if(w!=expected_w || h!=expected_h || !w || !h || w>16384 || h>16384 || (uint64_t)w*h*4>256*1024*1024) goto end;
struct zwlr_virtual_pointer_v1 *next=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[target].handle); struct zwlr_virtual_pointer_v1 *next=NULL;
if(!next) goto end; if(pointer_manager) {
if(sync_display()!=0) {zwlr_virtual_pointer_v1_destroy(next);goto end;} next=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[target].handle);
if(!next) goto end;
if(sync_display()!=0) {zwlr_virtual_pointer_v1_destroy(next);goto end;}
}
for(unsigned i=0;i<2;i++) { frame_clear(&frames[i]); dma_clear(&frames[i]); shm_clear(&frames[i]); } for(unsigned i=0;i<2;i++) { frame_clear(&frames[i]); dma_clear(&frames[i]); shm_clear(&frames[i]); }
pending=0; pending=0;
if(pointer) zwlr_virtual_pointer_v1_destroy(pointer); if(pointer) zwlr_virtual_pointer_v1_destroy(pointer);
@@ -654,6 +667,8 @@ end:
} }
int uu_wl_move(int32_t x,int32_t y,int relative) { int uu_wl_move(int32_t x,int32_t y,int relative) {
pthread_mutex_lock(&lock); int result=-1; pthread_mutex_lock(&lock); int result=-1;
/* -2: no virtual pointer at all, so the caller may use uinput; -1 stays a real failure. */
if(initialized && !pointer) { result=-2; goto end; }
if(initialized) { if(initialized) {
if(relative) { if(relative) {
/* UU reports pixels (source DPR=1); Wayland motion is in logical points. */ /* UU reports pixels (source DPR=1); Wayland motion is in logical points. */
@@ -668,6 +683,7 @@ end: pthread_mutex_unlock(&lock); return result;
} }
int uu_wl_button(int button,int pressed) { int uu_wl_button(int button,int pressed) {
pthread_mutex_lock(&lock); int result=-1; pthread_mutex_lock(&lock); int result=-1;
if(initialized && !pointer) { goto end; } /* no virtual pointer: report failure so the caller falls back to uinput */
if(initialized) { if(initialized) {
if(button>=4 && button<=7) { if(button>=4 && button<=7) {
if(pressed) { if(pressed) {
@@ -687,6 +703,7 @@ end: pthread_mutex_unlock(&lock); return result;
} }
int uu_wl_key(uint64_t symbol,int pressed) { int uu_wl_key(uint64_t symbol,int pressed) {
pthread_mutex_lock(&lock); int result=-1; pthread_mutex_lock(&lock); int result=-1;
if(initialized && !keyboard) { pthread_mutex_unlock(&lock); return -1; } /* no virtual keyboard: caller falls back to uinput */
if(initialized) { if(initialized) {
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) { for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
int matches=0; int matches=0;
@@ -717,20 +734,24 @@ int uu_wl_release_all(void) {
if(initialized) { if(initialized) {
/* Sweep this client's virtual keyboard directly: a keysym lookup can /* Sweep this client's virtual keyboard directly: a keysym lookup can
fail for unmapped OEM/keypad symbols before reaching held modifiers. */ fail for unmapped OEM/keypad symbols before reaching held modifiers. */
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) { if(keyboard) {
if(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue; for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_RELEASED); if(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue;
if(held_keys[code]) xkb_state_update_key(key_state,code,XKB_KEY_UP); zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_RELEASED);
if(held_keys[code]) xkb_state_update_key(key_state,code,XKB_KEY_UP);
}
zwp_virtual_keyboard_v1_modifiers(keyboard,
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_DEPRESSED),
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LATCHED),
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LOCKED),
xkb_state_serialize_layout(key_state,XKB_STATE_LAYOUT_EFFECTIVE));
} }
memset(held_keys,0,sizeof(held_keys)); memset(held_keys,0,sizeof(held_keys));
zwp_virtual_keyboard_v1_modifiers(keyboard, if(pointer) {
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_DEPRESSED), for(unsigned code=0x110;code<=0x114;code++)
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LATCHED), zwlr_virtual_pointer_v1_button(pointer,timestamp(),code,WL_POINTER_BUTTON_STATE_RELEASED);
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LOCKED), zwlr_virtual_pointer_v1_frame(pointer);
xkb_state_serialize_layout(key_state,XKB_STATE_LAYOUT_EFFECTIVE)); }
for(unsigned code=0x110;code<=0x114;code++)
zwlr_virtual_pointer_v1_button(pointer,timestamp(),code,WL_POINTER_BUTTON_STATE_RELEASED);
zwlr_virtual_pointer_v1_frame(pointer);
result=wl_display_flush(display)<0?-1:0; result=wl_display_flush(display)<0?-1:0;
} }
pthread_mutex_unlock(&lock);return result; pthread_mutex_unlock(&lock);return result;
+17 -2
View File
@@ -56,6 +56,15 @@ static void track_injected_key(int keycode, int is_press) {
} }
} }
/* XShmAttach fails asynchronously (BadAccess when the X server cannot reach our segment, e.g. a
* server in another container); Xlib's default handler would exit the process before the XGetImage fallback. */
static volatile int g_shm_attach_failed = 0;
static int shm_attach_error(Display *display, XErrorEvent *event) {
(void)display; (void)event;
g_shm_attach_failed = 1;
return 0;
}
static void shm_open_image(void) { static void shm_open_image(void) {
g_use_shm = 0; g_use_shm = 0;
if (!XShmQueryExtension(g_display)) return; if (!XShmQueryExtension(g_display)) return;
@@ -66,9 +75,15 @@ static void shm_open_image(void) {
if (g_shminfo.shmid == -1) return; if (g_shminfo.shmid == -1) return;
g_shminfo.shmaddr = g_shm_image->data = (char *)shmat(g_shminfo.shmid, 0, 0); g_shminfo.shmaddr = g_shm_image->data = (char *)shmat(g_shminfo.shmid, 0, 0);
g_shminfo.readOnly = False; g_shminfo.readOnly = False;
if (g_shminfo.shmaddr != (char *)-1 && XShmAttach(g_display, &g_shminfo)) { if (g_shminfo.shmaddr != (char *)-1) {
XSync(g_display, False); XSync(g_display, False);
g_use_shm = 1; g_shm_attach_failed = 0;
int (*previous)(Display *, XErrorEvent *) = XSetErrorHandler(shm_attach_error);
Status attached = XShmAttach(g_display, &g_shminfo);
XSync(g_display, False);
XSetErrorHandler(previous);
if (attached && !g_shm_attach_failed) g_use_shm = 1;
else fprintf(stderr, "X11 shared-memory capture unavailable; using XGetImage\n");
} }
shmctl(g_shminfo.shmid, IPC_RMID, 0); // 标记删除,进程退出时自动回收;失败时也不遗留段 shmctl(g_shminfo.shmid, IPC_RMID, 0); // 标记删除,进程退出时自动回收;失败时也不遗留段
} }
+1 -1
View File
@@ -1,7 +1,7 @@
# Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop. # Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop.
# Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary. # Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary.
FROM ubuntu:24.04 FROM ubuntu:24.04
ARG VERSION=v0.2.19 ARG VERSION=v0.2.20
LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \ LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \
org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \ org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \
org.opencontainers.image.licenses="GPL-3.0" org.opencontainers.image.licenses="GPL-3.0"
+18
View File
@@ -0,0 +1,18 @@
扫码登录改为与官方客户端一致,修复二维码刚生成就失效。/ QR sign-in now matches the official client.
### 修复 / Fixed
- **登录二维码反复立即失效(1190)**(#68,感谢 @axlrose 的详细排查):逆向官方 Mac 客户端(4.42)后确认,新版服务端在生成二维码时
返回 `status_query_ticket`,官方客户端查询扫码状态和确认登录时都用它(放在 `token` 键下);我们此前优先发送旧的 `token` 字段。现在与官方一致:
- 生成二维码不带请求体;状态查询用 `status_query_ticket`(服务端没有时才用旧 `token`);
- 状态查询是长轮询,每次应答后立即再问,单次超时 60 秒(此前 12 秒);
- 状态 3 立即换新码、状态 0 在 0.35 秒后换新码、状态 4 登录(状态 3 不再去调确认登录);
- 出错(如 HTTP 400 / 1190)或超时时停止轮询,等用户点击登录窗口新增的「刷新二维码」按钮(终端里按回车;既无窗口也无终端时 60 秒后自动换码)。
取代 v0.2.19 的临时退避和「重新注册设备」提示。已用全新设备身份实测:状态查询正常挂起,60 秒后按官方行为停止并等待刷新;
未在 #68 那台被标记的设备上实测,「刷新二维码」按钮的界面尚未在桌面上目视验收。
- QR sign-in mirrors the official Mac client: `status_query_ticket` as the status ticket, 60 s long poll, regenerate on status 3/0,
stop on errors (e.g. code 1190) until the user clicks the new “refresh QR” button.
### 下载 / Download
`uu-remote-linux_0.2.20_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.20-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.20`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+19
View File
@@ -0,0 +1,19 @@
Wayland 合成器缺少虚拟指针或虚拟键盘时,桌面仍可使用;systemd 单元示例与 deb 包一致。/ Wayland desktops without virtual pointer/keyboard protocols still come up.
### 修复 / Fixed
- **只缺 wlr-virtual-pointer 或虚拟键盘受限的合成器整个桌面不可用**(#72、#73,感谢 @clionertr):Denial 等合成器不提供
`zwlr_virtual_pointer_manager_v1`,或只把虚拟键盘给它自己的输入法。现在这两个协议都是可选的:画面采集照常启动,
缺指针时绝对移动改走 uinput(需能访问 `/dev/uinput`,见 README);`UU_WAYLAND_NO_VIRTUAL_KEYBOARD=1` 可跳过虚拟键盘。
只有「完全没有虚拟指针」才回退 uinput;坐标超出当前采集输出等其他失败照旧返回,不会把指针移到别的屏幕(#78)。
CI 构建与测试通过,**未在 Denial 上实机验证**;Hyprland 等已有虚拟指针的合成器行为不变。
- Virtual pointer and keyboard are optional on Wayland; capture still starts and pointer motion falls back to uinput only when
the compositor has no wlr-virtual-pointer. Not tested on Denial.
### 文档 / Docs
- README 的用户 systemd 单元与 deb 包一致:不再写死 `DISPLAY=:0`,随 `graphical-session.target` 启动;无头模式、虚拟桌面和
Xfce/i3 等不启动该 target 的桌面改用 `WantedBy=default.target`(#69,感谢 @ferstar)。
### 下载 / Download
`uu-remote-linux_0.2.21_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.21-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.21`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+20
View File
@@ -0,0 +1,20 @@
官方控制端能选「真彩」(4:4:4) 了;自行编译的 `inproc-av` 新增进程内 NVENC 与 AMD/Intel VAAPI。/ The official viewer can select true color (4:4:4); self-built `inproc-av` gains in-process NVENC and VAAPI.
### 修复 / Fixed
- **官方控制端里「真彩」不可选或打开后马上被切回**(#77、#79):设备能力里 HEVC/4:4:4 等格式的宽高原来填的是 0x0,官方控制端会把这样的条目当作不支持。现在每种格式都带上最大尺寸 3840x2160。
已实机验收:官方 Mac 控制端连 X11 + NVIDIA 主机,打开真彩后切到 HEVC 4:4:4,持续 30 秒以上没有被切回,也没有请求关键帧(PLI)。
- The device capability listed HEVC/4:4:4 formats as 0x0, which the official viewer treats as unsupported; each format now
carries its maximum size. Verified with the official Mac viewer: true color stays on (HEVC 4:4:4) for 30+ s, no PLI.
### 新增(需自行编译,预编译包不受影响)/ Added (self-built only; release packages unchanged)
- `--features inproc-av`(仅 X11):
- **NVENC 进程内编码**(#75、#77,感谢 @ferstar):直接读取 XShm,支持 4:4:4,不再经过 FFmpeg 进程;失败时依次回退到 FFmpeg 的 NVENC 管线、CPU。我方 NVIDIA 机器未单独验收这条进程内路径。
- **VAAPI 进程内编码**(#80、#81,感谢 @ferstar):通过 DRI3 DMA-BUF 零拷贝取屏(没有 DRI3 时改用 XShm 上传),经 VPP 转成 NV12 后送入硬件编码,支持 H.264 和 H.265。贡献者已在 AMD HawkPoint、Cezanne 上用官方 Mac 控制端实机验收;Intel 与 4K 尚未验证。需设置 `UU_VIDEO_ENCODER=vaapi`。
- libcuda、libva 都在运行时加载;编译所需的头文件见 README。
- In-process NVENC (XShm, 4:4:4) and VAAPI (DRI3 DMA-BUF zero copy, H.264/H.265) under `--features inproc-av` on X11,
each falling back to the FFmpeg process pipeline. VAAPI accepted by the contributor on AMD HawkPoint/Cezanne; Intel and 4K untested.
### 下载 / Download
`uu-remote-linux_0.2.22_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.22-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.22`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+13
View File
@@ -0,0 +1,13 @@
长时间连接后画面冻结的修复。/ Fixes video freezing after long sessions.
### 修复 / Fixed
- **控制端切到后台再恢复后画面冻结、延迟显示 0**(#83,感谢 @AYssu 定位并提供补丁):RTP 序号每 65536 包回绕一次;
回绕后如果控制端补要(NACK)回绕前的旧包,webrtc-srtp 0.12.0 会把加密状态退回旧值,之后的新包都用错误的回绕计数加密,
控制端全部认证失败,画面停住且不再恢复。现按 RFC 3711 附录 A 估算回绕计数,重传不再让状态倒退。加密算法和报文格式不变。
回归测试在原库上失败、修复后通过(AES-CM/HMAC 与 AES-GCM);报告者在 Windows 控制端实测后台放置恢复正常,跨过两次回绕。
- SRTP rollover counter no longer rewinds when a pre-wrap packet is retransmitted after the wrap (frozen video, #83).
### 下载 / Download
`uu-remote-linux_0.2.23_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.23-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.23`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+17
View File
@@ -0,0 +1,17 @@
X11 下切换分辨率会真正修改桌面分辨率。/ On X11 the viewer's resolution choice now changes the desktop resolution.
### 新增 / Added
- **控制端切换分辨率时真正修改桌面分辨率**,与官方 Windows 被控端一致:以前「其他分辨率」只缩放编码画面,选小分辨率反而让字更小更糊。
现在 X11 下用 xrandr 切换主显示器模式,列表里没有的分辨率会自动添加;选「原始」或断开连接后恢复原分辨率。
已用官方 Mac 控制端在 GNOME(X11)上实测切换与恢复。设置 `UU_DESKTOP_RESIZE=0` 可回到只缩放画面的旧行为;Wayland 不变。
- On X11 the resolution choice switches the display mode via xrandr (adding the mode when missing) and restores it for
"original" or on disconnect, like the official Windows host. `UU_DESKTOP_RESIZE=0` restores encoder scaling.
### 修复 / Fixed
- **连接中桌面分辨率变化后画面中断**:以前会把采集失败当成编码器故障,逐个换编码器后停止推流。现在按新尺寸重新采集,鼠标坐标随之更新。
- A desktop resize during a session no longer stops the stream; capture restarts at the new size and pointer mapping follows.
### 下载 / Download
`uu-remote-linux_0.2.24_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.24-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.24`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+12
View File
@@ -0,0 +1,12 @@
托盘图标随深色/浅色模式自动变色。/ The tray icon now follows light and dark panels.
### 修复 / Fixed
- **深色模式下托盘图标看不清**(#87):托盘改用内置单色符号图标,GNOME(AppIndicator 扩展)和 KDE 会按面板主题自动着色,
tarball 安装也不用另装图标。旧版 AppIndicator 库或缓存目录不可写时沿用原图标。目前只经过 CI 编译,尚未在 KDE / GNOME 面板上实机确认。
- The tray uses a built-in monochrome symbolic icon (written to the user cache and offered as the indicator's icon theme
path) that GNOME's AppIndicator extension and KDE recolor for the panel theme. Built in CI; not yet checked on a real panel.
### 下载 / Download
`uu-remote-linux_0.2.25_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.25-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.25`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+16
View File
@@ -0,0 +1,16 @@
修复 KDE 托盘图标显示为未知图标;显示器接在 NVIDIA 卡上时默认不再让 NVENC 直接编码 BGRA。/ Fixes the KDE tray icon; NVENC skips direct BGRA input when NVIDIA drives the display.
### 修复 / Fixed
- **KDE 托盘显示成未知(空白页)图标**(#87,v0.2.25 引入):单色托盘图标改名为 `uuremote-tray-symbolic`,写到 `~/.local/share/icons/hicolor`,
各家面板的默认图标查找都能找到,仍会随深色/浅色面板着色。已在 Plasma 6.7 / KF6 上用 KIconLoader 按 Plasma 的查找方式验证,Plasma 6.8 面板待报告者确认。
v0.2.25 留下的 `~/.cache/uu-remote-linux/icons` 不再使用,可以删除。
- **同一张 NVIDIA 卡负责显示时编码变慢**(#16):显示、采集、编码都在同一张 NVIDIA 卡上时,NVENC 直接编码 BGRA 反而比 CPU 转换慢
(RTX 5070 4K:探针 82.6 vs 98 fps)。现在只要有显示器接在 NVIDIA 卡上就改用 CPU 转换;核显接显示器的机器不变。`UU_NVENC_RGB=1` 强制直接编码,`=0` 强制 CPU 转换。
- The tray icon is installed as `uuremote-tray-symbolic` in the user hicolor theme, so KDE's default lookup finds it
(v0.2.25 showed the unknown icon on Plasma 6.8). NVENC no longer takes packed BGRA when a connected monitor hangs off
an NVIDIA card (slower when the desktop is composited on the encoding GPU); `UU_NVENC_RGB=1` forces it.
### 下载 / Download
`uu-remote-linux_0.2.26_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.26-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.26`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+26
View File
@@ -0,0 +1,26 @@
可手动选择视频编码器和 codec,auto 改为后台探测;Wayland 屏幕保活失败不再中断画面;viewer 新增安全输入 `type`。/ Encoder and codec settings, background auto probe, display-wake failures no longer stop video, and a secure `type` command in the viewer.
### 新增 / Added
- **编码器与 codec 设置**(#85 第①②步,#92、#93,感谢 @ferstar):`uuremote-server set-encoder auto|cpu|vaapi|nvenc`、
`uuremote-server set-codec auto|h264|h265` 写入 `~/.config/uuremote/host_settings.json`,优先级高于 `UU_VIDEO_ENCODER` / `UU_VIDEO_CODEC`,
下次建立桌面连接时生效;`doctor` 显示来源和最终 codec。auto 在启动时后台探测(每个候选编码一帧合成画面,限时 3 秒,不挡第一路出图):
有 NVIDIA 时 NVENC → CPU,没有 NVIDIA 时直接用 CPU 不探测。NVENC 探测失败只缓存 10 分钟,之后的桌面连接会在后台重探;
NVIDIA 驱动或设备中途出现/消失也会重探。显式指定编码器时不探测。VAAPI 要等 #33 解决后才进入 auto。
- **viewer 安全输入 `uuremote-viewer type`**(#70,感谢 @212duo):向已打开的桌面会话注入键盘(锁屏 PIN / 密码),文本不进 argv,
日志只记长度;按 US QWERTY 键位映射。本机 IPC 用私有目录和对端 uid 校验。
- `set-encoder` / `set-codec` write the video settings to `host_settings.json`; auto now probes NVENC then CPU in the background
(CPU only without NVIDIA, NVENC failures retried after 10 minutes). The viewer gains `type`, a secure key-injection command that
reuses the open desktop session.
### 修复 / Fixed
- **Wayland 运行中屏幕保活失败会停掉视频**(#94、#95,感谢 @AYssu):启动时和每 30 秒的屏幕保活改为尽力而为,失败只记警告、下轮重试,
画面继续发送;采集、编码、发送错误仍按原逻辑处理。
- A failed display wake at stream start or during the 30-second refresh is logged and retried instead of ending the video.
### 验证范围 / Validation
单元测试与 CI(x86_64、arm64、Wayland、inproc-av、viewer)通过;以上改动尚未在报告者现场或 NVIDIA 机器上实机验收。
### 下载 / Download
`uu-remote-linux_0.2.27_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.27-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.27`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+19
View File
@@ -0,0 +1,19 @@
tar 包新增 `install.sh`,缺 FFmpeg 时自动安装;宿主缺 FFmpeg 时弹桌面提示,不再让客户端一直停在「正在传输画面」。/ The tarball gains `install.sh`, which installs FFmpeg when missing; the host tells the desktop user when FFmpeg is missing.
### 新增 / Added
- **tar 包安装脚本 `install.sh`**:解压后用普通桌面用户运行 `./install.sh`。程序和插件装到 `~/.local`,写入用户级 systemd 服务(已有则保留),
并检查 FFmpeg(需带 libx264)。缺失时询问后经 sudo 用 apt / pacman 安装(`--yes` 不询问,`--no-ffmpeg` 只检查);Fedora 需先启用 RPM Fusion,
openSUSE 需 Packman 源,脚本只打印命令、不替你添加第三方源。.deb 包本来就依赖 `ffmpeg`,不受影响。
- **缺 FFmpeg 时的桌面提示**:宿主在启动时和每次有人连接桌面时检查 FFmpeg。不可用时记 error,弹出「无法传输远程画面」桌面通知并给出安装命令;
没有通知服务的桌面(如精简 Xfce)改为打开宿主窗口,顶部红字提示。最多每 5 分钟一次;装好后重新连接即可,不用重启服务。
- `install.sh` installs into `~/.local`, writes the systemd user unit and installs FFmpeg with libx264 through apt or pacman when missing.
The host checks FFmpeg at startup and on every desktop connection and shows a desktop notification (or opens its window) when it is missing.
### 验证范围 / Validation
`install.sh` 在 Debian 13(Xfce)上实测:卸掉 FFmpeg 后 `--yes` 自动装回;CI 在 Ubuntu 22.04 上做同样的测试。通知和窗口红字用测试程序在 Xfce 上实测
(有/无通知服务两种情况);宿主内的完整流程只有编译与 CI 覆盖。
### 下载 / Download
`uu-remote-linux_0.2.28_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.28-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.28`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+22
View File
@@ -0,0 +1,22 @@
运行中切换编码器不再断开连接;X11 双屏/多屏可以只看其中一块屏幕(实验性)。/ Switch the encoder without dropping the session; select one monitor on X11 (experimental).
### 新增 / Added
- **运行中切换编码器(#85 第③步,#96,感谢 @ferstar)**:`uuremote-server set-encoder auto|cpu|vaapi|nvenc` 和 `set-codec` 写入设置后会通知正在运行的宿主(`SIGUSR2`),
已连接的桌面在下一帧边界换用新编码器,不用断开重连;VAAPI 不支持真彩 4:4:4 时自动降为 4:2:0 并通知客户端。只通知完整路径相同的宿主程序,
避免误杀旧版本宿主;没有通知到宿主时会打印提示(下次连接或重启服务后生效)。编码格式(H.264/H.265)偏好仍在下次连接时生效。
- **X11 单屏选择(#98,实验性)**:设置 `UU_X11_MULTISCREEN=1` 后,主机按 `xrandr --listmonitors` 列出各显示器,控制端可选择其中一块,只采集该区域,
鼠标绝对坐标加上该屏幕的偏移;默认主显示器,`UU_X11_OUTPUT` 可指定其他屏幕。显示器布局在启动时读取,改动后需重启服务;此模式下「分辨率」改为缩放画面。默认关闭,单屏用户不受影响。
- `set-encoder` / `set-codec` now switch a live desktop stream's encoder via `SIGUSR2` (same binary only) without reconnecting.
`UU_X11_MULTISCREEN=1` lets the viewer pick one X11 monitor (RandR monitors; capture and absolute input follow the selected monitor).
### 其他 / Other
- Issue 模板的诊断命令:保留连接状态和端口映射日志、过滤 WebRTC 内部噪音,并抹掉 IPv6 和 MAC 地址。
### 验证范围 / Validation
运行中切换编码器:单元测试与 CI,官方客户端下的切换时序尚未实机验证。X11 单屏选择:单元测试;在 Debian 13 上用两块 RandR 虚拟显示器实测,
鼠标落点与按区域采集正确;官方客户端在真实双屏上的切换尚未实机验证,欢迎反馈。
### 下载 / Download
`uu-remote-linux_0.2.29_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.29-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.29`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+18
View File
@@ -0,0 +1,18 @@
先开端口映射再打开桌面时不再黑屏;VAAPI 低码率档能压到更低码率。/ Opening the desktop after a port mapping no longer shows a black screen; VAAPI low-bitrate presets go lower.
### 修复 / Fixed
- **端口映射后打开桌面黑屏(#99)**:已有端口映射连接时,Mac 控制端打开桌面不会新建连接,而是在原连接上发送 `capture_desktop`。
宿主现在会把这条连接转为桌面:画面、光标、剪贴板和会话计数都会启动,剪贴板能力也会重新通告。之后再打开新的桌面时,旧连接只停掉桌面,
端口映射照常可用。若此前 X11 分辨率有变化,会按新尺寸重建采集。限制:Wayland Portal 后端暂不支持这种方式;这条连接上没有声音。
- **VAAPI 低档码率(#33,#102,感谢 @ferstar)**:in-process VAAPI 编码的最大 QP 从 44 放宽到 51,复杂画面下低档可降到硬件能达到的最低码率;中高档不受影响。
- A viewer that opens the desktop on an existing port-mapping connection (`capture_desktop`) now gets video, cursor, clipboard and session handling on that connection;
a later desktop stops it without closing the port mappings. In-process VAAPI `max_qp` raised from 44 to 51.
### 验证范围 / Validation
#99:根因由报告者日志证实;修复只有单元测试与 CI,官方 Mac 控制端下尚未实机验证,欢迎反馈。#102:贡献者在 AMD 核显上实测(2560×1600 复杂画面最低档 4.16→2.60 Mbps,
中高档输出一致),我们这边仅 CI。
### 下载 / Download
`uu-remote-linux_0.2.30_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.30-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.30`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+14
View File
@@ -0,0 +1,14 @@
NVENC 新增可选 VBV 缓冲开关,缓解高分辨率下关键帧按 GOP 周期闪烁。/ Opt-in NVENC VBV buffer for high-resolution keyframe pulsing.
### 新增 / Added
- **`UU_NVENC_BUFFER_MS`(#103,感谢 @zhl-HFUT 的分析)**:NVENC 的 VBV 缓冲(10–1000 ms,缓冲 = 码率上限 × 毫秒 / 1000),FFmpeg 进程管线和进程内引擎都生效。
默认缓冲(100–500 kbit)在 1440p 等高分辨率下会把关键帧压糊,画面按 GOP 周期“糊一下再变清”;遇到时可设 `UU_NVENC_BUFFER_MS=1000`。默认行为不变。
- New `UU_NVENC_BUFFER_MS` (10–1000 ms of the bitrate cap) for NVENC, applied to both the FFmpeg pipeline and the in-process engine. Default unchanged.
### 验证范围 / Validation
仅单元测试与 CI,尚未在 NVENC 实机上验证,欢迎反馈。
### 下载 / Download
`uu-remote-linux_0.2.31_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.31-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.31`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+17
View File
@@ -0,0 +1,17 @@
修复端口映射在 ICE 瞬断恢复后被续房拆掉、信令卡死后长时间假在线,以及查看器 CLI 的指针偏移与滚轮。/ Fixes port-mapping teardown after ICE recovery, stalled signaling, and viewer CLI pointer/wheel input.
### 修复 / Fixed
- **ICE 瞬断恢复后连接被拆(#109,感谢 @sinoyster 的细致分析)**:WebRTC 的 ICE 状态回调读到的是占位 DTLS 对象,ICE `Disconnected → Connected` 恢复后 PeerConnection 停在 `New`,15 分钟续房把仍在使用的端口映射当成空闲,拆房并断开所有映射 TCP 流。现在恢复后会回到 `Connected`。
After a brief ICE drop the peer state settled on `New` instead of `Connected`, so the idle room renewal tore down live port-mapping streams.
- **信令投递卡住时心跳检测失效(#104,感谢 @RiverOnVenus)**:事件队列阻塞时 Engine.IO 超时不再执行,主机可能带着半关闭的连接“在线”数小时。现在有独立看门狗、发送超时和关闭超时。
Heartbeat detection keeps running when event delivery stalls; the host reconnects instead of staying half-online.
- **查看器 CLI**:16:10 等非 16:9 主机的指针按内容区域映射,不再内偏(#107,感谢 @liuyanghejerry);鼠标滚轮/触控板转发为滚动(#108,感谢 @liuyanghejerry)。
Viewer CLI: pointer mapped to the content rectangle of the padded canvas; mouse wheel forwarded.
### 验证范围 / Validation
单元测试与 CI;#109 的 ICE 恢复场景尚未实机复现,欢迎反馈。
### 下载 / Download
`uu-remote-linux_0.2.32_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.32-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.32`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+13
View File
@@ -0,0 +1,13 @@
修复 Wayland 锁屏或熄屏后,由工具连接(端口映射)升级的桌面视频结束后无法再次打开。/ Fixes a promoted tool connection whose desktop video could not be reopened after the screen locked or blanked.
### 修复 / Fixed
- **锁屏/熄屏后桌面无法重新打开(#114,感谢 @sinoyster 的完整报告)**:通过 capture_desktop 升级为桌面的工具连接上,若 Wayland 采集因锁屏或 DPMS 关闭而结束,再次 capture_desktop 不会重建视频,查看器只剩黑屏。现在会重新请求桌面并在原连接上重启视频,保留原输入租约。
On a tool connection promoted with capture_desktop, a desktop stream that ended (e.g. Wayland capture failing on lock/DPMS) is now restarted on the next capture_desktop, keeping the original input lease.
### 验证范围 / Validation
单元测试与 CI;#114 的锁屏场景尚未实机复现,欢迎反馈。
### 下载 / Download
`uu-remote-linux_0.2.33_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.33-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.33`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+15
View File
@@ -0,0 +1,15 @@
修复网络波动后信令重连卡住,以及 Linux 控制端在平铺窗口管理器下画面空白。/ Fixes signaling reconnect stalling after a network hiccup, and the Linux viewer showing a blank window under tiling compositors.
### 修复 / Fixed
- **网络异常后停在 Acquired room signaling credentials(#115,感谢 @Changxi-M)**:信令 WebSocket 握手没有超时,网络半断时会无限等待,重连不再重试。现在握手限时 20 秒,超时后按原有退避重试。
The signaling WebSocket handshake is now bounded to 20 s, so a stalled handshake falls back to the normal reconnect retry instead of hanging forever.
- **控制端窗口平铺后画面空白(#118,感谢 @shao-zhijie)**:Linux 控制端只在收到新解码帧时绘制,合成器调整窗口尺寸后静止画面不会重绘;在尚未收到首帧时,Wayland 也不会映射没有提交缓冲的窗口。现在窗口尺寸变化/重新显示时用最后一帧重绘,无帧时先画黑底。
The Linux viewer now repaints the last frame after a compositor resize/expose, and paints a black frame before the first decoded frame so Wayland maps the window.
### 验证范围 / Validation
单元测试与 CI;#115、#118 的场景尚未实机复现,欢迎反馈。
### 下载 / Download
`uu-remote-linux_0.2.34_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.34-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.34`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+21
View File
@@ -0,0 +1,21 @@
信令可走 HTTP 代理、二维码登录错误分类、重复主机实例诊断,以及 Wayland 手机端文字输入兜底。/ Signaling through an opt-in HTTP proxy, clearer QR login errors, duplicate-host diagnostics, and a Wayland fallback for mobile text input.
### 新增 / Added
- **信令遵循 `UU_USE_PROXY=1`(#123)**:主机和 Linux 控制端的 WebSocket 信令改用与 REST 接口相同的 HTTP 客户端,开启 `UU_USE_PROXY=1` 后也走环境里的 HTTP/HTTPS 代理(不支持 SOCKS;选中的代理失败不会改为直连;不跟随重定向)。不代理 ICE/WebRTC 媒体。默认(不开代理)行为不变。
Host and viewer signaling now use the same HTTP client as the REST API, so `UU_USE_PROXY=1` applies to signaling too (HTTP/HTTPS proxies only, no direct fallback, no redirects). Media is not proxied; the default is unchanged.
- **Wayland/Portal 手机端文字输入兜底(#119,感谢 @shofukantkts)**:没有空闲键码的合成器和 Portal 后端上,手机端输入的文字经剪贴板 + Shift+Insert 粘贴;`UU_WAYLAND_TEXT=0` 可关闭。
Mobile text input on Portal and compositors without spare keycodes is pasted via the clipboard and Shift+Insert; `UU_WAYLAND_TEXT=0` disables it.
### 修复 / Fixed
- **二维码登录错误分类(#121)**:状态查询失败不再一律提示「网络超时」,区分超时、连接失败、响应异常与二维码过期;诊断只含阶段、类别、耗时和状态码,不输出票据、URL 或服务器内容。
QR polling failures are no longer all reported as a network timeout; timeouts, connection failures, bad responses and expiry are distinguished, with diagnostics that never include tickets, URLs or server content.
- **重复主机实例(#122)**:同一身份的两个主机实例(拷贝了 `config.json`,或残留的旧手动实例)会互相把对方踢出房间,表现为控制端一连就断。`doctor` 现在能数到重新执行后进程名为 `exe` 的实例并给出提示;README 说明不要在机器之间拷贝 `config.json`;日志会记录无 peer id 的 leave 事件结构(仅键名/类型/长度)。
Two host instances sharing one identity kick each other out of the room. `doctor` now counts re-executed instances and warns about extras, the README explains not to copy `config.json` between machines, and leave events without a peer id log their shape (keys/types/lengths only).
### 验证范围 / Validation
单元测试与 CI。#123 在真实 Linux X11 主机上实测不开代理时信令与 iPhone 桌面连接正常;经真实代理的信令尚未实测。#122 的修复在报告环境实机验证。
### 下载 / Download
`uu-remote-linux_0.2.35_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.35-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.35`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+15
View File
@@ -0,0 +1,15 @@
修复 X11 共享内存被拒时主机直接退出,以及 Linux 控制端加入已有会话时可能永久黑屏。/ Fixes the host exiting when X11 refuses shared memory, and a possible black screen when the Linux viewer joins a host that already streams to another session.
### 修复 / Fixed
- **X11 MIT-SHM 被拒时直接退出**:X 服务器无法访问本程序的共享内存段时(例如 X 服务器在另一个容器里),`XShmAttach` 返回 BadAccess,Xlib 默认错误处理直接结束了进程,原有的 `XGetImage` 退路没有机会执行。现在捕获该错误并改用 `XGetImage` 抓屏。
When `XShmAttach` is refused (BadAccess, e.g. an X server in another container), the host now falls back to `XGetImage` instead of being terminated by Xlib's default error handler.
- **控制端加入已有会话时黑屏(#124,感谢 @shao-zhijie)**:Linux 控制端过去只在丢包或解码出错时请求关键帧;加入一条已在推流的干净 H.264 流时永远等不到 IDR。现在首帧显示前每 30 个访问单元请求一次关键帧(PLI),300 个仍无画面时日志给出提示。
The Linux viewer now requests key frames (PLI) every 30 access units until the first frame is shown, and logs a warning after 300.
### 验证范围 / Validation
单元测试与 CI。共享内存退路尚待在报告环境实机确认;#124 中官方 Mac 主机是否响应 PLI 尚未实测。
### 下载 / Download
`uu-remote-linux_0.2.36_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.36-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.36`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+13
View File
@@ -0,0 +1,13 @@
`UU_USE_PROXY=1` 时经 TCP/TLS(可走 HTTP 代理)连接 TURN 中继,供 UDP 到不了中继服务器的主机使用。/ With `UU_USE_PROXY=1`, TURN relays are also reached over TCP/TLS (optionally through the HTTP proxy) for hosts whose UDP cannot reach the relay servers.
### 新增 / Added
- **TURN over TCP/TLS**:云端在强制中继的会话里也会下发 `turns:<IP>:<端口>?transport=tcp`,原来使用的 webrtc-ice 只支持 UDP 中继,UDP 被限制、只能经 HTTP 代理出网的主机因此拿不到任何中继候选,控制端一直"正在尝试重连"。现在开启 `UU_USE_PROXY=1` 后,主机会经 `HTTPS_PROXY`/`ALL_PROXY` 中的无认证 `http://` 代理(没有则直连)建立 TCP/TLS 中继连接。TURN 证书按 CA 链校验,仅在云端下发的地址为 IP 时容忍名称不匹配;媒体仍由 DTLS-SRTP 端到端加密。未开启时只用 UDP 中继,行为不变(`vendor/webrtc-ice/PATCHES.md`)。
With `UU_USE_PROXY=1` the host also opens TURN relays over TCP/TLS through the unauthenticated `http://` proxy (or directly), chain-verifying certificates and tolerating a name mismatch only for IP TURN URLs. The default stays UDP-only.
### 验证范围 / Validation
单元测试(经模拟代理的 CONNECT 与 STUN/ChannelData 分帧)与 CI;与真实 TURN 服务器的 TCP/TLS 分配尚待在报告环境实机确认。
### 下载 / Download
`uu-remote-linux_0.2.37_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.37-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.37`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+13
View File
@@ -0,0 +1,13 @@
TURN over TLS 改为同时信任系统证书库。/ TURN over TLS now also trusts the system certificate store.
### 修复 / Fixed
- **TURN over TLS 报 UnknownIssuer**:v0.2.37 的 TCP/TLS 中继只信任内置的 Mozilla 根证书;在会检查 TLS 的 HTTP 代理后面,中继证书由主机管理员装在系统证书库里的 CA 重新签发,OpenSSL 能通过、我们却报 `UnknownIssuer`。现在同时信任系统证书库(与 OpenSSL 一致)和内置根证书。仅影响 `UU_USE_PROXY=1` 时的 TCP/TLS 中继。
TCP/TLS relays (only with `UU_USE_PROXY=1`) now trust the system certificate store as well as the bundled Mozilla roots, so CAs added for TLS-inspecting proxies are honoured.
### 验证范围 / Validation
单元测试与 CI;报告环境实机验证进行中。
### 下载 / Download
`uu-remote-linux_0.2.38_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.38-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.38`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+131
View File
@@ -0,0 +1,131 @@
#!/bin/sh
# Install uu-remote-linux from the release tarball for the current desktop user, and install FFmpeg
# (needed for desktop video) through the system package manager when it is missing.
# usage: ./install.sh [--yes] [--no-ffmpeg]
# --yes install FFmpeg without asking
# --no-ffmpeg only check FFmpeg, never install it
set -eu
assume_yes=0 ffmpeg_install=1
for arg in "$@"; do
case $arg in
-y|--yes) assume_yes=1 ;;
--no-ffmpeg) ffmpeg_install=0 ;;
-h|--help) sed -n '2,6p' "$0" | sed 's/^# \{0,1\}//'; exit 0 ;;
*) echo "unknown option: $arg (see --help)" >&2; exit 2 ;;
esac
done
if [ "$(id -u)" = 0 ]; then
echo "Run this as your desktop user, not root: the host is a per-user service. It asks for sudo only to install FFmpeg." >&2
exit 1
fi
src=$(cd "$(dirname "$0")" && pwd)
bin=$HOME/.local/bin lib=$HOME/.local/lib/uu-remote-linux share=$HOME/.local/share
unit_dir=${XDG_CONFIG_HOME:-$HOME/.config}/systemd/user
# A running binary cannot be overwritten in place ("text file busy"): copy, then rename.
put() { install -Dm"$1" "$2" "$3.new" && mv -f "$3.new" "$3"; }
[ -f "$src/uuremote-server" ] || { echo "uuremote-server not found next to install.sh" >&2; exit 1; }
put 755 "$src/uuremote-server" "$bin/uuremote-server"
[ -f "$src/uuremote-viewer" ] && put 755 "$src/uuremote-viewer" "$bin/uuremote-viewer"
for so in libuu-wayland.so libuu-portal.so; do
[ -f "$src/$so" ] && put 644 "$src/$so" "$lib/$so"
done
if [ -d "$src/contrib/desktop" ]; then
put 644 "$src/contrib/desktop/uu-remote-linux.svg" "$share/icons/hicolor/scalable/apps/uu-remote-linux.svg"
put 644 "$src/contrib/desktop/uu-remote-linux.desktop" "$share/applications/uu-remote-linux.desktop"
[ -f "$bin/uuremote-viewer" ] && put 644 "$src/contrib/desktop/uu-remote-linux-viewer.desktop" "$share/applications/uu-remote-linux-viewer.desktop"
fi
echo "Installed uuremote-server to $bin"
# Same unit as the .deb, pointing at ~/.local/bin. An existing unit is the user's: leave it alone.
if [ -f "$unit_dir/uuremote-native.service" ]; then
echo "Kept existing $unit_dir/uuremote-native.service"
else
mkdir -p "$unit_dir"
cat > "$unit_dir/uuremote-native.service" <<'UNIT'
[Unit]
Description=UU Remote Linux host (unofficial)
After=graphical-session.target
PartOf=graphical-session.target
[Service]
Environment=RUST_LOG=info
ExecStart=%h/.local/bin/uuremote-server
Restart=always
RestartSec=5
[Install]
WantedBy=graphical-session.target
UNIT
echo "Created $unit_dir/uuremote-native.service"
fi
if command -v systemctl >/dev/null 2>&1; then systemctl --user daemon-reload 2>/dev/null || true; fi
# FFmpeg with libx264 is required: without it the viewer waits on 正在传输画面 forever.
ffmpeg_ok() { command -v ffmpeg >/dev/null 2>&1 && ffmpeg -hide_banner -encoders 2>/dev/null | grep -qw libx264; }
ffmpeg_cmd=""
ffmpeg_note=""
if command -v apt-get >/dev/null 2>&1; then
ffmpeg_cmd="apt-get update && apt-get install -y ffmpeg"
elif command -v pacman >/dev/null 2>&1; then
ffmpeg_cmd="pacman -S --needed --noconfirm ffmpeg"
elif command -v dnf >/dev/null 2>&1; then
# Fedora's own ffmpeg-free has no libx264; the full build is in RPM Fusion, which we do not enable for you.
if dnf repolist --enabled 2>/dev/null | grep -qi rpmfusion-free; then
ffmpeg_cmd="dnf install -y --allowerasing ffmpeg"
else
ffmpeg_note="Enable RPM Fusion (https://rpmfusion.org/Configuration), then: sudo dnf install --allowerasing ffmpeg"
fi
elif command -v zypper >/dev/null 2>&1; then
ffmpeg_note="openSUSE's ffmpeg has no libx264; add the Packman repository, then: sudo zypper install ffmpeg"
else
ffmpeg_note="Install FFmpeg with libx264 from your distribution, or set \"ffmpeg_root\" in ~/.config/uuremote/config.json"
fi
ffmpeg_ready=1
if ffmpeg_ok; then
echo "FFmpeg with libx264: found"
else
if command -v ffmpeg >/dev/null 2>&1; then echo "FFmpeg is installed but has no libx264."; else echo "FFmpeg is not installed."; fi
if [ "$ffmpeg_install" = 1 ] && [ -n "$ffmpeg_cmd" ]; then
answer=n
if [ "$assume_yes" = 1 ]; then
answer=y
elif [ -t 0 ]; then
printf 'Install it now with: sudo sh -c "%s"? [Y/n] ' "$ffmpeg_cmd"
read -r answer || answer=n
case $answer in ""|y|Y|yes|YES) answer=y ;; esac
fi
if [ "$answer" = y ]; then
if [ "$(id -u)" != 0 ] && ! command -v sudo >/dev/null 2>&1; then
echo "sudo is not available; run as root: $ffmpeg_cmd" >&2
else
sudo sh -c "$ffmpeg_cmd" || echo "FFmpeg installation failed." >&2
fi
fi
fi
if ffmpeg_ok; then
echo "FFmpeg with libx264: installed"
else
ffmpeg_ready=0
if [ -n "$ffmpeg_cmd" ]; then echo "Install it with: sudo sh -c \"$ffmpeg_cmd\""; else echo "$ffmpeg_note"; fi
fi
fi
case ":$PATH:" in *":$bin:"*) ;; *) echo "Note: $bin is not on PATH; add it or call $bin/uuremote-server directly." ;; esac
cat <<NEXT
Next steps (as this user, inside the graphical session):
uuremote-server login # scan the QR code with the UU Remote app
systemctl --user enable --now uuremote-native.service # start with the graphical session
Desktops that do not export DISPLAY to systemd (e.g. Xfce) need a drop-in; see README step 4.
NEXT
if [ "$ffmpeg_ready" = 0 ]; then
echo "WARNING: desktop video will not start until FFmpeg with libx264 is installed." >&2
exit 1
fi
+14
View File
@@ -78,6 +78,20 @@ extern "C" {
fn uu_assist_ui_set(id: *const libc::c_char, code: *const libc::c_char, allowed: libc::c_int, verify: libc::c_int, refresh: libc::c_int, has_custom: libc::c_int); fn uu_assist_ui_set(id: *const libc::c_char, code: *const libc::c_char, allowed: libc::c_int, verify: libc::c_int, refresh: libc::c_int, has_custom: libc::c_int);
fn uu_assist_ui_take_command(arg: *mut libc::c_char, len: libc::size_t) -> libc::c_int; fn uu_assist_ui_take_command(arg: *mut libc::c_char, len: libc::size_t) -> libc::c_int;
fn uu_assist_ui_close(); fn uu_assist_ui_close();
fn uu_ui_set_problem(summary: *const libc::c_char, text: *const libc::c_char, notify: libc::c_int) -> libc::c_int;
}
/// A problem only the person at the desktop can fix: a red line in the host window (`None` clears it)
/// and, with `notify`, a desktop notification, or the host window opened when no notification daemon
/// answers. Returns whether the person was told now.
pub fn show_problem(summary: &str, text: Option<&str>, notify: bool) -> bool {
#[cfg(uu_gtk)] {
let summary = std::ffi::CString::new(summary).unwrap_or_default();
let text = text.map(|t| std::ffi::CString::new(t).unwrap_or_default());
let text = text.as_ref().map_or(std::ptr::null(), |t| t.as_ptr());
unsafe { uu_ui_set_problem(summary.as_ptr(), text, i32::from(notify)) >= 0 }
}
#[cfg(not(uu_gtk))] { let _ = (summary, text, notify); false }
} }
/// "243829726" -> "243 829 726", as the official client shows device IDs. /// "243829726" -> "243 829 726", as the official client shows device IDs.
+1 -10
View File
@@ -1,7 +1,6 @@
//! Desktop sound for the viewer's 声音 menu: the default output's monitor (PulseAudio or //! Desktop sound for the viewer's 声音 menu: the default output's monitor (PulseAudio or
//! PipeWire-pulse) is encoded to Opus and sent on the negotiated audio m-line. //! PipeWire-pulse) is encoded to Opus and sent on the negotiated audio m-line.
//! Encoding runs in this process with the `inproc-av` feature (unless `UU_FFMPEG_ROOT` is set), //! An FFmpeg child process does the encoding.
//! otherwise an FFmpeg child process does it.
//! PipeWire monitors ignore the sink's mute by default, so 被控端静音运行 keeps the stream audible. //! PipeWire monitors ignore the sink's mute by default, so 被控端静音运行 keeps the stream audible.
//! `UU_AUDIO=0` disables it; `UU_AUDIO_SOURCE` picks another Pulse source. //! `UU_AUDIO=0` disables it; `UU_AUDIO_SOURCE` picks another Pulse source.
@@ -57,14 +56,6 @@ fn read_packets(stdout: impl Read, tx: &tokio::sync::mpsc::Sender<bytes::Bytes>)
fn start(source: &str, tx: tokio::sync::mpsc::Sender<bytes::Bytes>) fn start(source: &str, tx: tokio::sync::mpsc::Sender<bytes::Bytes>)
-> Result<(Stopper, tokio::task::JoinHandle<Result<(), String>>), String> { -> Result<(Stopper, tokio::task::JoinHandle<Result<(), String>>), String> {
let stop = Arc::new(AtomicBool::new(false)); let stop = Arc::new(AtomicBool::new(false));
#[cfg(feature = "inproc-av")]
if crate::inproc_encoder::selected() {
let job = tokio::task::spawn_blocking({
let (stop, source) = (stop.clone(), source.to_owned());
move || crate::inproc_encoder::run_audio(&source, tx, stop)
});
return Ok((Stopper { stop, child: None }, job));
}
let mut child = spawn_encoder(source)?; let mut child = spawn_encoder(source)?;
let stdout = child.stdout.take().ok_or("Encoder stdout missing")?; let stdout = child.stdout.take().ok_or("Encoder stdout missing")?;
let job = tokio::task::spawn_blocking(move || read_packets(stdout, &tx)); let job = tokio::task::spawn_blocking(move || read_packets(stdout, &tx));
+113 -2
View File
@@ -91,6 +91,48 @@ pub struct UUAuthClient {
guest_id: Option<String>, guest_id: Option<String>,
} }
/// QR failures are safe to display: never retain a URL, source error or response body.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum QrRequestErrorKind { Timeout, Connect, Decode, Body, Request }
impl QrRequestErrorKind {
fn from_reqwest(error: &reqwest::Error) -> Self {
if error.is_timeout() { Self::Timeout }
else if error.is_connect() { Self::Connect }
else if error.is_decode() { Self::Decode }
else if error.is_body() { Self::Body }
else { Self::Request }
}
fn label(self) -> &'static str {
match self { Self::Timeout => "timeout", Self::Connect => "connect", Self::Decode => "decode",
Self::Body => "body", Self::Request => "request" }
}
}
#[derive(Debug)]
pub struct QrRequestError {
pub kind: QrRequestErrorKind,
phase: &'static str,
elapsed_ms: u128,
http_status: Option<u16>,
}
impl std::fmt::Display for QrRequestError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "phase={} kind={} elapsed_ms={} http_status={:?}",
self.phase, self.kind.label(), self.elapsed_ms, self.http_status)
}
}
impl QrRequestError {
pub fn response_received(&self) -> bool { self.http_status.is_some() }
fn new(kind: QrRequestErrorKind, phase: &'static str, started: std::time::Instant, http_status: Option<u16>) -> Self {
Self { kind, phase, elapsed_ms: started.elapsed().as_millis(), http_status }
}
}
async fn send_qr_request(request: reqwest::RequestBuilder, started: std::time::Instant) -> Result<(u16, serde_json::Value), QrRequestError> {
let resp = request.send().await.map_err(|e| QrRequestError::new(QrRequestErrorKind::from_reqwest(&e), "send", started, None))?;
let status = resp.status().as_u16();
let value = resp.json().await.map_err(|e| QrRequestError::new(QrRequestErrorKind::from_reqwest(&e), "response", started, Some(status)))?;
Ok((status, value))
}
/// Transport failures name only the outer request; the cause (certificate, proxy, DNS, /// Transport failures name only the outer request; the cause (certificate, proxy, DNS,
/// timeout) lives in the source chain. URL user-info (proxy credentials) and query /// timeout) lives in the source chain. URL user-info (proxy credentials) and query
/// strings are removed before the chain is shown. /// strings are removed before the chain is shown.
@@ -121,17 +163,20 @@ fn redact_urls(text: &str) -> String {
out out
} }
/// Cloud API clients ignore ambient HTTP/SOCKS proxy settings by default: a local /// Cloud API and signaling clients ignore ambient HTTP/HTTPS proxy settings by default: a local
/// proxy that intercepts TLS breaks login and signaling. `UU_USE_PROXY=1` opts back /// proxy that intercepts TLS breaks login and signaling. `UU_USE_PROXY=1` opts back
/// into reqwest's standard proxy environment handling. /// into reqwest's standard proxy environment handling.
pub fn http_client_builder() -> reqwest::ClientBuilder { pub fn http_client_builder() -> reqwest::ClientBuilder {
let builder = reqwest::Client::builder(); let builder = reqwest::Client::builder();
if std::env::var("UU_USE_PROXY").ok().as_deref().is_some_and(proxy_requested) { if proxy_enabled() {
builder builder
} else { } else {
builder.no_proxy() builder.no_proxy()
} }
} }
pub(crate) fn proxy_enabled() -> bool {
std::env::var("UU_USE_PROXY").ok().as_deref().is_some_and(proxy_requested)
}
fn proxy_requested(value: &str) -> bool { fn proxy_requested(value: &str) -> bool {
matches!(value.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on") matches!(value.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on")
} }
@@ -251,6 +296,17 @@ impl UUAuthClient {
Ok((status, value)) Ok((status, value))
} }
/// Signed POST with an optional JSON body (None = empty body, like Moya `requestPlain`) and an
/// explicit timeout. The official clients long-poll the QR status with a 60 s request timeout.
pub async fn post_with_timeout(&self, path: &str, body: Option<&serde_json::Value>, timeout: std::time::Duration) -> Result<(u16, serde_json::Value), QrRequestError> {
let started = std::time::Instant::now();
let body_str = body.map(serde_json::to_string).transpose()
.map_err(|_| QrRequestError::new(QrRequestErrorKind::Request, "encode", started, None))?.unwrap_or_default();
let request = self.http.post(format!("{}{}", BASE_URL, path)).timeout(timeout)
.headers(self.build_headers("POST", path, &body_str)).body(body_str);
send_qr_request(request, started).await
}
/// Signed JSON POST to another API host (the signature covers the path only). /// Signed JSON POST to another API host (the signature covers the path only).
pub async fn post_json_url(&self, base: &str, path: &str, body: &serde_json::Value) -> Result<(u16, serde_json::Value), String> { pub async fn post_json_url(&self, base: &str, path: &str, body: &serde_json::Value) -> Result<(u16, serde_json::Value), String> {
let body_str = serde_json::to_string(body).map_err(|e| e.to_string())?; let body_str = serde_json::to_string(body).map_err(|e| e.to_string())?;
@@ -378,3 +434,58 @@ mod guest_tests {
for value in ["", "0", "false", "no", "off", "2"] { assert!(!super::proxy_requested(value)); } for value in ["", "0", "false", "no", "off", "2"] { assert!(!super::proxy_requested(value)); }
} }
} }
#[cfg(test)]
mod qr_request_tests {
use super::*;
use std::time::{Duration, Instant};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
// Synthetic, loopback-only responses: no account, device, proxy or live login API.
async fn response(reply: &'static [u8], stall: bool) -> QrRequestError {
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let addr = listener.local_addr().unwrap();
let server = tokio::spawn(async move {
let (mut socket, _) = listener.accept().await.unwrap();
let mut request = [0u8; 4096];
let _ = socket.read(&mut request).await.unwrap();
socket.write_all(reply).await.unwrap();
if stall { std::future::pending::<()>().await; }
});
let request = reqwest::Client::builder().no_proxy().build().unwrap()
.post(format!("http://fixture-user:fixture-password@{addr}/fixture-path?token=fixture-ticket"))
.timeout(Duration::from_secs(2));
let error = send_qr_request(request, Instant::now()).await.unwrap_err();
server.abort();
let output = format!("{error} {error:?}");
for secret in ["fixture-user", "fixture-password", "fixture-path", "fixture-ticket", "fixture-body", "127.0.0.1", "http://"] {
assert!(!output.contains(secret));
}
error
}
#[tokio::test]
async fn qr_request_distinguishes_send_timeout_body_timeout_and_bad_json_without_secrets() {
let error = response(b"", true).await;
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Timeout, "send", None));
assert!(!error.response_received());
let error = response(b"HTTP/1.1 200 OK\r\nContent-Length: 100\r\n\r\n", true).await;
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Timeout, "response", Some(200)));
assert!(error.response_received());
let error = response(b"HTTP/1.1 502 Bad Gateway\r\nContent-Length: 12\r\n\r\nfixture-body", false).await;
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Decode, "response", Some(502)));
assert!(error.response_received());
}
#[tokio::test]
async fn qr_connection_failure_is_not_a_timeout() {
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let addr = listener.local_addr().unwrap();
drop(listener);
let request = reqwest::Client::builder().no_proxy().build().unwrap()
.post(format!("http://{addr}/fixture-ticket")).timeout(Duration::from_secs(2));
let error = send_qr_request(request, Instant::now()).await.unwrap_err();
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Connect, "send", None));
assert!(!format!("{error} {error:?}").contains("fixture-ticket"));
}
}
+4 -3
View File
@@ -35,12 +35,13 @@ pub fn h264_device_capability(
/// The payload sits under `data.device_capability` with `type` beside it. The earlier flat shape /// The payload sits under `data.device_capability` with `type` beside it. The earlier flat shape
/// (`type` at the top, fields directly in `data`) was not recognised by the iPhone client, which /// (`type` at the top, fields directly in `data`) was not recognised by the iPhone client, which
/// then kept quality and chroma locked at their defaults (#49). Only 8-bit and the chroma formats /// then kept quality and chroma locked at their defaults (#49). Only 8-bit and the chroma formats
/// the encoder really produces are listed; the first entry carries the maximum size as officially. /// the encoder really produces are listed, each with its maximum size: the official viewer treats a
/// 0x0 entry as unsupported (#77; the 4.37 host we copied had a GTX 660 without HEVC/4:4:4).
pub fn device_capability(client_id: &str, ice_id: &str, display_id: i32, fps: i32, codec_impl: i32, hevc: bool, full_chroma: bool) -> Value { pub fn device_capability(client_id: &str, ice_id: &str, display_id: i32, fps: i32, codec_impl: i32, hevc: bool, full_chroma: bool) -> Value {
let mut codecs = Vec::new(); let mut codecs = Vec::new();
for codec in [VIDEO_CODEC_H264].into_iter().chain(hevc.then_some(2)) { for codec in [VIDEO_CODEC_H264].into_iter().chain(hevc.then_some(2)) {
for chroma in [1].into_iter().chain(full_chroma.then_some(3)) { for chroma in [1].into_iter().chain(full_chroma.then_some(3)) {
let (width, height) = if codecs.is_empty() { (3840, 2160) } else { (0, 0) }; let (width, height) = (3840, 2160);
codecs.push(json!({"video_codec": codec, "chroma_sampling": chroma, "codec_impl": codec_impl, codecs.push(json!({"video_codec": codec, "chroma_sampling": chroma, "codec_impl": codec_impl,
"bit_depth": 8, "width": width, "height": height})); "bit_depth": 8, "width": width, "height": height}));
} }
@@ -86,7 +87,7 @@ mod tests {
let caps = &payload["data"]["device_capability"]["video_codec_capability"]; let caps = &payload["data"]["device_capability"]["video_codec_capability"];
assert_eq!(caps.as_array().unwrap().len(), 4); assert_eq!(caps.as_array().unwrap().len(), 4);
assert_eq!(caps[0], json!({"video_codec":1,"chroma_sampling":1,"codec_impl":5,"bit_depth":8,"width":3840,"height":2160})); assert_eq!(caps[0], json!({"video_codec":1,"chroma_sampling":1,"codec_impl":5,"bit_depth":8,"width":3840,"height":2160}));
assert_eq!(caps[3], json!({"video_codec":2,"chroma_sampling":3,"codec_impl":5,"bit_depth":8,"width":0,"height":0})); assert_eq!(caps[3], json!({"video_codec":2,"chroma_sampling":3,"codec_impl":5,"bit_depth":8,"width":3840,"height":2160}));
assert_eq!(payload["data"]["device_capability"]["display_info"][0]["hdr"], -1); assert_eq!(payload["data"]["device_capability"]["display_info"][0]["hdr"], -1);
let h264_420 = device_capability("c", "i", 0, 60, 5, false, false); let h264_420 = device_capability("c", "i", 0, 60, 5, false, false);
assert_eq!(h264_420["data"]["device_capability"]["video_codec_capability"].as_array().unwrap().len(), 1); assert_eq!(h264_420["data"]["device_capability"]["video_codec_capability"].as_array().unwrap().len(), 1);
+18 -4
View File
@@ -46,14 +46,28 @@ unsafe fn x11_display_name() -> *const libc::c_char { b":0\0".as_ptr().cast() }
/// The X11 root can be resized while the host runs (RandR, xrdp reconnects); the /// The X11 root can be resized while the host runs (RandR, xrdp reconnects); the
/// geometry read at startup then makes x11grab reject every new connection. /// geometry read at startup then makes x11grab reject every new connection.
pub fn x11_resized() -> bool { /// Re-reads the root size; None when the X11 engine is not in use or the query fails.
pub fn x11_size() -> Option<(u32, u32)> {
match unsafe { x11_refresh_geometry() } { match unsafe { x11_refresh_geometry() } {
1 => true, 0 | 1 => x11_last_size(),
0 => false, -1 => None,
code => { log::warn!("X11 geometry query failed with code {code}"); false } code => { log::warn!("X11 geometry query failed with code {code}"); None }
} }
} }
/// The root size from the last refresh, without an X round trip (pointer mapping).
/// Display the X11 engine opened, once a capture has initialized it.
pub fn x11_display() -> Option<String> {
let name = unsafe { x11_display_name() };
if name.is_null() { None } else { Some(unsafe { std::ffi::CStr::from_ptr(name) }.to_string_lossy().into_owned()) }
}
pub fn x11_last_size() -> Option<(u32, u32)> {
let (mut w, mut h): (libc::c_int, libc::c_int) = (0, 0);
if unsafe { x11_get_dimensions(&mut w, &mut h) } != 0 || w <= 0 || h <= 0 { return None; }
Some((w as u32, h as u32))
}
pub struct ScreenCapture { pub struct ScreenCapture {
pub backend: crate::desktop_backend::DesktopBackend, pub backend: crate::desktop_backend::DesktopBackend,
pub init_error: Option<String>, pub init_error: Option<String>,
+76 -10
View File
@@ -120,6 +120,7 @@ fn custom_bitrate_bps(value: u64) -> u32 {
bps.min(u64::from(u32::MAX)) as u32 bps.min(u64::from(u32::MAX)) as u32
} }
#[cfg(test)]
pub fn handle_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32)) -> Option<Vec<u8>> { pub fn handle_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32)) -> Option<Vec<u8>> {
handle_rpc_with_codecs(rpc, settings, native, true, false) handle_rpc_with_codecs(rpc, settings, native, true, false)
} }
@@ -128,20 +129,50 @@ pub fn handle_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, na
/// lists H265 first in its offer) and a hardware encoder is selected. Software libx265 is about ten /// lists H265 first in its offer) and a hardware encoder is selected. Software libx265 is about ten
/// times slower than libx264 (measured 15 vs 155 fps at 1080p on a 4-core ARM host, #59), so CPU /// times slower than libx264 (measured 15 vs 155 fps at 1080p on a 4-core ARM host, #59), so CPU
/// hosts default to H.264. UU_VIDEO_CODEC=h264 / h265 overrides. /// hosts default to H.264. UU_VIDEO_CODEC=h264 / h265 overrides.
pub fn preferred_codec(h264: bool, h265: bool) -> VideoCodec { #[cfg(test)]
let forced = std::env::var("UU_VIDEO_CODEC").ok().map(|v| v.to_ascii_lowercase()); fn test_selection() -> crate::video_select::Selection {
pick_codec(h264, h265, forced.as_deref(), crate::video::Encoder::requested() != crate::video::Encoder::Cpu) crate::video_select::resolve_pair(Some("auto"), None, Some("auto"), None, false, None)
} }
fn pick_codec(h264: bool, h265: bool, forced: Option<&str>, hardware: bool) -> VideoCodec {
#[cfg(test)]
pub fn preferred_codec(h264: bool, h265: bool) -> VideoCodec {
preferred_codec_for(h264, h265, test_selection())
}
pub fn preferred_codec_for(h264: bool, h265: bool, selection: crate::video_select::Selection) -> VideoCodec {
pick_codec(h264, h265, crate::video_select::codec_force(selection.codec_pref), crate::video_select::hardware(selection.encoder))
}
pub(crate) fn pick_codec(h264: bool, h265: bool, forced: Option<&str>, hardware: bool) -> VideoCodec {
let wants_h265 = match forced { Some("h264") => false, Some("h265" | "hevc") => true, _ => hardware }; let wants_h265 = match forced { Some("h264") => false, Some("h265" | "hevc") => true, _ => hardware };
if h265 && (wants_h265 || !h264) { VideoCodec::H265 } else { VideoCodec::H264 } if h265 && (wants_h265 || !h264) { VideoCodec::H265 } else { VideoCodec::H264 }
} }
#[cfg(test)]
pub fn handle_rpc_with_codecs(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool) -> Option<Vec<u8>> { pub fn handle_rpc_with_codecs(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool) -> Option<Vec<u8>> {
apply_rpc(rpc, settings, native, h264, h265, crate::video::full_chroma_available()) handle_rpc_for(rpc, settings, native, h264, h265, test_selection())
} }
fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool, full_chroma: bool) -> Option<Vec<u8>> { pub fn handle_rpc_for(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool, selection: crate::video_select::Selection) -> Option<Vec<u8>> {
apply_rpc(rpc, settings, native, h264, h265, crate::video::full_chroma_for(selection.encoder), crate::video_select::codec_force(selection.codec_pref))
}
/// The resolution a capture/resolution RPC asks for, parsed like apply_rpc: X11 hosts apply it
/// to the display mode itself (desktop_mode), as the official Windows host changes its resolution.
pub fn requested_resolution(rpc: &[WireField]) -> Option<crate::desktop_mode::Request> {
use crate::desktop_mode::Request;
if let Some(request) = message(rpc, 2) {
let fields = decode_wire(request).ok()?;
if number(&fields, 10) == Some(3) { return Some(Request::Native); }
let (w, h) = number(&fields, 16).zip(number(&fields, 17)).or_else(|| number(&fields, 5).zip(number(&fields, 6)))?;
Some(Request::Size(u32::try_from(w).ok()?, u32::try_from(h).ok()?))
} else if let Some(request) = message(rpc, 6) {
let fields = decode_wire(request).ok()?;
Some(Request::Size(u32::try_from(number(&fields, 1)?).ok()?, u32::try_from(number(&fields, 2)?).ok()?))
} else { None }
}
fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), _h264: bool, h265: bool, full_chroma: bool, forced: Option<&str>) -> Option<Vec<u8>> {
let header = message(rpc, 1).unwrap_or(&[]); let header = message(rpc, 1).unwrap_or(&[]);
let mut next = *settings.borrow(); let mut next = *settings.borrow();
if let Some(request) = message(rpc, 2) { if let Some(request) = message(rpc, 2) {
@@ -152,7 +183,9 @@ fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native:
// codec_type 13 (1 H264, 2 H265): like the official host (negotiateCodec), the host picks the // codec_type 13 (1 H264, 2 H265): like the official host (negotiateCodec), the host picks the
// codec from both capability lists; the Mac viewer sends its current codec (1 while receiving // codec from both capability lists; the Mac viewer sends its current codec (1 while receiving
// H.264), so only an explicit H.265 request switches, never one absent from the m-line. // H.264), so only an explicit H.265 request switches, never one absent from the m-line.
if number(&fields, 13) == Some(2) && h265 { next.codec = VideoCodec::H265; } // A forced codec (host_settings video_codec or UU_VIDEO_CODEC) wins over that switch, same
// rule as pick_codec at stream start: h264 stays H.264; auto/h265 still follow the request.
if number(&fields, 13) == Some(2) && h265 && forced != Some("h264") { next.codec = VideoCodec::H265; }
// Field 1 is the viewer's fps option index (1 = 30, 2 = 60, ...); 18 fpsCount is the frame rate. // Field 1 is the viewer's fps option index (1 = 30, 2 = 60, ...); 18 fpsCount is the frame rate.
if let Some(fps) = number(&fields, 18).filter(|v| *v > 0).or_else(|| number(&fields, 1).and_then(fps_from_option)) { next.fps = fps as u32; } if let Some(fps) = number(&fields, 18).filter(|v| *v > 0).or_else(|| number(&fields, 1).and_then(fps_from_option)) { next.fps = fps as u32; }
if let Some(quality) = number(&fields, 2).filter(|v| *v > 0) { next.quality = quality; } if let Some(quality) = number(&fields, 2).filter(|v| *v > 0) { next.quality = quality; }
@@ -318,12 +351,12 @@ mod tests {
let (tx, rx) = watch::channel(VideoSettings::default()); let (tx, rx) = watch::channel(VideoSettings::default());
// Observed Mac viewer request with 真彩 on: field 7 = 3. // Observed Mac viewer request with 真彩 on: field 7 = 3.
let request = rpc(5, 2, &[8, 2, 16, 4, 56, 3, 144, 1, 60]); let request = rpc(5, 2, &[8, 2, 16, 4, 56, 3, 144, 1, 60]);
apply_rpc(&decode_wire(&request).unwrap(), &tx, (1920, 1080), true, false, false).unwrap(); apply_rpc(&decode_wire(&request).unwrap(), &tx, (1920, 1080), true, false, false, None).unwrap();
assert_eq!(rx.borrow().chroma, CHROMA_420); assert_eq!(rx.borrow().chroma, CHROMA_420);
apply_rpc(&decode_wire(&request).unwrap(), &tx, (1920, 1080), true, false, true).unwrap(); apply_rpc(&decode_wire(&request).unwrap(), &tx, (1920, 1080), true, false, true, None).unwrap();
assert_eq!(rx.borrow().chroma, CHROMA_444); assert_eq!(rx.borrow().chroma, CHROMA_444);
assert_eq!(number(&decode_wire(&sync_payload(&rx.borrow(), (1920, 1080))).unwrap(), 3), Some(CHROMA_444)); assert_eq!(number(&decode_wire(&sync_payload(&rx.borrow(), (1920, 1080))).unwrap(), 3), Some(CHROMA_444));
apply_rpc(&decode_wire(&rpc(6, 2, &[56, 1])).unwrap(), &tx, (1920, 1080), true, false, true).unwrap(); apply_rpc(&decode_wire(&rpc(6, 2, &[56, 1])).unwrap(), &tx, (1920, 1080), true, false, true, None).unwrap();
assert_eq!(rx.borrow().chroma, CHROMA_420); assert_eq!(rx.borrow().chroma, CHROMA_420);
} }
@@ -555,6 +588,39 @@ mod codec_tests {
assert_eq!(pick_codec(false, true, None, false), VideoCodec::H265); assert_eq!(pick_codec(false, true, None, false), VideoCodec::H265);
assert_eq!(pick_codec(true, false, Some("h265"), true), VideoCodec::H264); assert_eq!(pick_codec(true, false, Some("h265"), true), VideoCodec::H264);
} }
#[test]
fn forced_h264_ignores_later_h265_capture_request() {
let (tx, rx) = watch::channel(VideoSettings::default());
// Field 13 = 2 on a peer that negotiated both codecs.
let request = decode_wire(&[18, 2, 104, 2]).unwrap();
apply_rpc(&request, &tx, (1920, 1080), true, true, false, Some("h264")).unwrap();
assert_eq!(rx.borrow().codec, VideoCodec::H264);
apply_rpc(&request, &tx, (1920, 1080), true, true, false, None).unwrap();
assert_eq!(rx.borrow().codec, VideoCodec::H265);
let (tx, rx) = watch::channel(VideoSettings::default());
apply_rpc(&request, &tx, (1920, 1080), true, true, false, Some("h265")).unwrap();
assert_eq!(rx.borrow().codec, VideoCodec::H265);
}
#[test]
fn true_color_keeps_codec_and_vaapi_reports_420() {
// Field 7 = 3 (真彩). full_chroma false is the VAAPI 4:2:0 drop; true encodes 4:4:4.
let request = decode_wire(&[18, 2, 56, 3]).unwrap();
let (tx, rx) = watch::channel(VideoSettings { codec: VideoCodec::H265, ..Default::default() });
apply_rpc(&request, &tx, (1920, 1080), true, true, true, None).unwrap();
assert_eq!((rx.borrow().chroma, rx.borrow().codec), (CHROMA_444, VideoCodec::H265));
// NVENC session (full chroma) that already chose H.265 stays H.265 when 真彩 is requested.
let nvenc = crate::video_select::resolve_pair(None, None, None, None, true, None);
assert_eq!(nvenc.encoder, crate::video::Encoder::Nvenc);
let (tx, rx) = watch::channel(VideoSettings { codec: preferred_codec_for(true, true, nvenc), ..VideoSettings::default() });
assert_eq!(rx.borrow().codec, VideoCodec::H265);
handle_rpc_for(&request, &tx, (1920, 1080), true, true, nvenc).unwrap();
assert_eq!((rx.borrow().chroma, rx.borrow().codec), (CHROMA_444, VideoCodec::H265));
let (tx, rx) = watch::channel(VideoSettings { codec: VideoCodec::H265, ..Default::default() });
apply_rpc(&request, &tx, (1920, 1080), true, true, false, None).unwrap();
assert_eq!((rx.borrow().chroma, rx.borrow().codec), (CHROMA_420, VideoCodec::H265));
assert_eq!(number(&decode_wire(&sync_payload(&rx.borrow(), (1920, 1080))).unwrap(), 3), Some(CHROMA_420));
assert!(decode_wire(&sync_payload(&rx.borrow(), (1920, 1080))).unwrap().iter().all(|f| f.number != 13));
}
} }
#[cfg(test)] #[cfg(test)]
+7
View File
@@ -5,6 +5,13 @@
use std::path::PathBuf; use std::path::PathBuf;
use std::sync::OnceLock; use std::sync::OnceLock;
/// Tests that point UU_CONFIG at a temp file must take this, or they race.
#[cfg(test)]
pub(crate) fn test_env_lock() -> &'static std::sync::Mutex<()> {
static LOCK: std::sync::Mutex<()> = std::sync::Mutex::new(());
&LOCK
}
pub fn path() -> PathBuf { pub fn path() -> PathBuf {
if let Some(p) = std::env::var_os("UU_CONFIG") { return PathBuf::from(p); } if let Some(p) = std::env::var_os("UU_CONFIG") { return PathBuf::from(p); }
let base = std::env::var_os("XDG_CONFIG_HOME").map(PathBuf::from) let base = std::env::var_os("XDG_CONFIG_HOME").map(PathBuf::from)
+10
View File
@@ -70,6 +70,16 @@ impl DamageCapture {
pub fn size(&self) -> (u32, u32) { (self.width as u32, self.height as u32) } pub fn size(&self) -> (u32, u32) { (self.width as u32, self.height as u32) }
pub fn shm_raw_ptr(&self) -> *mut u8 { self.shm_ptr }
pub fn shm_size(&self) -> usize { self.len }
pub fn refresh(&mut self) -> Result<(), String> {
self.conn.shm_get_image(self.root, 0, 0, self.width, self.height, !0, Z_PIXMAP, self.seg, 0)
.map_err(text)?.reply().map_err(text)?;
Ok(())
}
/// Waits up to `timeout` for the screen to change. Returns `true` on change, `false` on timeout. /// Waits up to `timeout` for the screen to change. Returns `true` on change, `false` on timeout.
pub fn wait(&mut self, timeout: Duration) -> Result<bool, String> { pub fn wait(&mut self, timeout: Duration) -> Result<bool, String> {
let deadline = Instant::now() + timeout; let deadline = Instant::now() + timeout;
+53
View File
@@ -215,3 +215,56 @@ async fn locked_control_unlock_requests_and_tools_work_without_a_video_frame() {
drop(lock); drop(lock);
}).await.expect("locked bootstrap/tool regression exceeded deadline"); }).await.expect("locked bootstrap/tool regression exceeded deadline");
} }
#[tokio::test]
async fn capture_desktop_on_a_port_mapping_peer_promotes_it_once() {
tokio::time::timeout(Duration::from_secs(25), async {
let input = Arc::new(InputInjector::without_desktop());
let (host, mut viewer) = connect(input.clone(), false, None, &["CONTROL_DATA_CHANNEL", "FILE_DATA_CHANNEL"]).await;
let (requests, mut requested) = mpsc::unbounded_channel();
host.on_desktop_request(move || { let _ = requests.send(()); });
receive(&mut viewer.messages, "CONTROL_DATA_CHANNEL", 13).await;
assert!(!host.role.is_desktop() && host.role.input().is_none());
// The Mac viewer opens the desktop on its existing port-mapping peer (#99).
send(&viewer, "CONTROL_DATA_CHANNEL", crate::initialization::envelope(5, 0, 3, &[8, 4])).await;
tokio::time::timeout(Duration::from_secs(5), requested.recv()).await.unwrap().unwrap();
host.promote(None);
assert!(host.role.is_desktop());
assert!(host.role.input().is_some_and(|session| session.is_current()));
// CONTROL repeats the desktop initialization for the same viewer.
receive(&mut viewer.messages, "CONTROL_DATA_CHANNEL", 13).await;
// The port-mapping session on this peer still answers.
send(&viewer, "FILE_DATA_CHANNEL", mapping(2, b"still mapped")).await;
receive(&mut viewer.messages, "FILE_DATA_CHANNEL", 27).await;
// A repeated capture_desktop does not ask again, and a later promote is a no-op.
send(&viewer, "CONTROL_DATA_CHANNEL", crate::initialization::envelope(6, 0, 3, &[8, 4])).await;
send(&viewer, "CONTROL_DATA_CHANNEL", crate::initialization::envelope(7, 0, 3, &[8, 0])).await;
receive(&mut viewer.messages, "CONTROL_DATA_CHANNEL", 3).await;
assert!(requested.try_recv().is_err());
let lease = host.role.input().unwrap();
host.promote(None);
assert!(lease.is_current());
// Its video ended on its own (capture failed while locked, #114): capture_desktop restarts it
// on the same input lease.
let ended = tokio::spawn(async {});
*host.role.stream_task.lock().unwrap() = Some(ended.abort_handle());
ended.await.unwrap();
send(&viewer, "CONTROL_DATA_CHANNEL", crate::initialization::envelope(9, 0, 3, &[8, 4])).await;
tokio::time::timeout(Duration::from_secs(5), requested.recv()).await.unwrap().unwrap();
host.promote(None);
assert!(host.role.is_desktop() && !host.role.stream_ended() && lease.is_current());
// A newer desktop demotes it; the port mapping stays, and capture_desktop promotes it again.
host.demote();
assert!(!host.role.is_desktop() && host.role.input().is_none());
send(&viewer, "FILE_DATA_CHANNEL", mapping(2, b"after demotion")).await;
receive(&mut viewer.messages, "FILE_DATA_CHANNEL", 27).await;
send(&viewer, "CONTROL_DATA_CHANNEL", crate::initialization::envelope(8, 0, 3, &[8, 4])).await;
tokio::time::timeout(Duration::from_secs(5), requested.recv()).await.unwrap().unwrap();
host.promote(None);
assert!(host.role.is_desktop() && host.role.input().is_some_and(|session| session.is_current()));
receive(&mut viewer.messages, "CONTROL_DATA_CHANNEL", 13).await;
host.pc.close().await.unwrap();
viewer.pc.close().await.unwrap();
viewer.router.lock().await.stop().await.unwrap();
}).await.expect("capture_desktop promotion exceeded deadline");
}
+222
View File
@@ -0,0 +1,222 @@
//! X11 desktop resolution follows the viewer's 分辨率 choice, like the official Windows host:
//! the display mode itself changes (xrandr), not just the encoded size. The mode in use before
//! the first change is restored for 原始/follow-remote and when the last desktop stream ends.
//! Disable with UU_DESKTOP_RESIZE=0 (the viewer choice then scales the encoded stream instead).
use std::process::Command;
use std::sync::Mutex;
use std::sync::atomic::{AtomicUsize, Ordering};
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Request { Native, Size(u32, u32) }
struct Original { display: String, output: String, mode: String }
static ORIGINAL: Mutex<Option<Original>> = Mutex::new(None);
static STREAMS: AtomicUsize = AtomicUsize::new(0);
/// Upper bound per side (H.264 NVENC/VAAPI limit) and lower bound for a usable desktop.
const MAX_SIDE: u32 = 4096;
const MIN_SIZE: (u32, u32) = (640, 480);
pub fn enabled() -> bool { std::env::var("UU_DESKTOP_RESIZE").map_or(true, |v| v != "0") }
/// Keeps the changed mode while any desktop stream runs; the last one restores it.
pub struct StreamGuard;
impl StreamGuard {
pub fn new() -> Self { STREAMS.fetch_add(1, Ordering::SeqCst); Self }
}
impl Drop for StreamGuard {
fn drop(&mut self) {
if STREAMS.fetch_sub(1, Ordering::SeqCst) == 1 && ORIGINAL.lock().unwrap().is_some() {
// xrandr blocks; never run it on the async runtime thread dropping the stream.
std::thread::spawn(|| {
std::thread::sleep(std::time::Duration::from_secs(2));
if STREAMS.load(Ordering::SeqCst) == 0 { restore(); }
});
}
}
}
/// Applies the viewer's resolution request to the X11 display; returns the desktop size now in
/// use, or None when nothing changed hands (the caller keeps encoder scaling as the fallback).
pub fn apply(display: &str, request: Request) -> Option<(u32, u32)> {
match request {
Request::Native => { restore(); crate::capture::x11_size() },
Request::Size(w, h) => {
let target = fit(w, h)?;
match switch(display, target) {
Ok(()) => crate::capture::x11_size(),
Err(error) => { log::warn!("Desktop resolution change to {}x{} failed: {}", target.0, target.1, error); None },
}
},
}
}
/// Even sides within MIN_SIZE..=MAX_SIDE, keeping the aspect ratio when scaled down.
fn fit(w: u32, h: u32) -> Option<(u32, u32)> {
if w == 0 || h == 0 { return None; }
let scale = (f64::from(MAX_SIDE) / f64::from(w.max(h))).min(1.0);
let (w, h) = ((f64::from(w) * scale).round() as u32, (f64::from(h) * scale).round() as u32);
Some((w.max(MIN_SIZE.0) & !1, h.max(MIN_SIZE.1) & !1))
}
fn switch(display: &str, target: (u32, u32)) -> Result<(), String> {
let state = query(display)?;
if state.current == Some(target) { return Ok(()); }
{
let mut original = ORIGINAL.lock().unwrap();
if original.is_none() {
let mode = state.current_mode.clone().ok_or("current mode unknown")?;
log::info!("Desktop resolution: saving original mode {} on {}", mode, state.output);
*original = Some(Original { display: display.into(), output: state.output.clone(), mode });
}
}
let mode = match state.modes.iter().find(|(_, size)| *size == target) {
Some((name, _)) => name.clone(),
None => {
let (name, timings) = cvt_reduced(target.0, target.1);
// An existing mode of this name (earlier session) makes --newmode fail harmlessly.
let mut args = vec!["--newmode", name.as_str()];
args.extend(timings.iter().map(String::as_str));
let _ = xrandr(display, &args);
xrandr(display, &["--addmode", &state.output, &name])?;
name
},
};
set_mode(display, &state.output, &mode, target)?;
log::info!("Desktop resolution changed to {}x{} ({})", target.0, target.1, mode);
Ok(())
}
/// Restores the mode saved before the first change, if any.
pub fn restore() {
let Some(original) = ORIGINAL.lock().unwrap().take() else { return; };
let size = query(&original.display).ok().and_then(|state| state.modes.into_iter().find(|(name, _)| *name == original.mode).map(|(_, size)| size));
match size.ok_or_else(|| "original mode no longer listed".to_owned())
.and_then(|size| set_mode(&original.display, &original.output, &original.mode, size)) {
Ok(()) => log::info!("Desktop resolution restored to {}", original.mode),
Err(error) => log::warn!("Desktop resolution restore failed: {}", error),
}
let _ = crate::capture::x11_size();
}
/// GNOME/mutter may answer a mode list change by re-applying its preferred mode; set it again.
fn set_mode(display: &str, output: &str, mode: &str, size: (u32, u32)) -> Result<(), String> {
for _ in 0..3 {
xrandr(display, &["--output", output, "--mode", mode])?;
std::thread::sleep(std::time::Duration::from_millis(1500));
if query(display)?.current == Some(size) { return Ok(()); }
}
Err(format!("{output} did not keep {mode}"))
}
fn xrandr(display: &str, args: &[&str]) -> Result<String, String> {
let output = Command::new("xrandr").arg("--display").arg(display).args(args).output()
.map_err(|e| format!("xrandr unavailable: {}", e.kind()))?;
if !output.status.success() { return Err(format!("xrandr {} exited with {}", args.first().unwrap_or(&""), output.status)); }
Ok(String::from_utf8_lossy(&output.stdout).into_owned())
}
struct State { output: String, current: Option<(u32, u32)>, current_mode: Option<String>, modes: Vec<(String, (u32, u32))> }
fn query(display: &str) -> Result<State, String> { parse(&xrandr(display, &["--query"])?).ok_or_else(|| "no connected output".into()) }
/// The primary connected output (else the first connected one with a mode) and its mode list.
fn parse(text: &str) -> Option<State> {
let mut outputs: Vec<(bool, State)> = Vec::new();
for line in text.lines() {
if let Some(rest) = line.strip_prefix(" ") {
let Some((_, state)) = outputs.last_mut() else { continue; };
let mut parts = rest.split_whitespace();
let Some(name) = parts.next() else { continue; };
let Some(size) = mode_size(name) else { continue; };
if parts.any(|rate| rate.contains('*')) { state.current = Some(size); state.current_mode = Some(name.into()); }
state.modes.push((name.into(), size));
} else if !line.starts_with(' ') {
let mut parts = line.split_whitespace();
let (Some(name), Some("connected")) = (parts.next(), parts.next()) else { outputs.push((false, State { output: String::new(), current: None, current_mode: None, modes: Vec::new() })); continue; };
let primary = line.contains(" connected primary ");
outputs.push((primary, State { output: name.into(), current: None, current_mode: None, modes: Vec::new() }));
}
}
let mut connected: Vec<(bool, State)> = outputs.into_iter().filter(|(_, s)| !s.output.is_empty() && s.current.is_some()).collect();
let index = connected.iter().position(|(primary, _)| *primary).unwrap_or(0);
(index < connected.len()).then(|| connected.swap_remove(index).1)
}
/// "1920x1080", "1920x1080R", "1920x1080_60.00", "1920x1080i" → (1920, 1080).
fn mode_size(name: &str) -> Option<(u32, u32)> {
let (w, rest) = name.split_once('x')?;
let h: String = rest.chars().take_while(char::is_ascii_digit).collect();
Some((w.parse().ok()?, h.parse().ok()?))
}
/// VESA CVT reduced-blanking (v1) timings: 60 Hz, or 30 Hz when 60 Hz exceeds an HDMI 2.0
/// pixel clock (virtual/forced connectors on integrated GPUs reject faster modes).
fn cvt_reduced(w: u32, h: u32) -> (String, Vec<String>) {
const H_BLANK: u32 = 160; const H_SYNC: u32 = 32; const H_FRONT: u32 = 48;
const V_FRONT: u32 = 3; const MIN_V_BACK: u32 = 6; const MIN_VBLANK_US: f64 = 460.0;
let v_sync = match (w * 3 == h * 4, w * 9 == h * 16, w * 10 == h * 16, w * 4 == h * 5, w * 9 == h * 15) {
(true, ..) => 4, (_, true, ..) => 5, (_, _, true, ..) => 6, (_, _, _, true, _) | (.., true) => 7, _ => 10,
};
let timing = |refresh: f64| {
let h_period = (1_000_000.0 / refresh - MIN_VBLANK_US) / f64::from(h);
let vbi = ((MIN_VBLANK_US / h_period) as u32 + 1).max(V_FRONT + v_sync + MIN_V_BACK);
let (total_h, total_v) = (w + H_BLANK, h + vbi);
let clock = (refresh * f64::from(total_h) * f64::from(total_v) / 1_000_000.0 / 0.25).floor() * 0.25;
(clock, total_h, total_v)
};
let (mut refresh, mut t) = (60, timing(60.0));
if t.0 > 590.0 { refresh = 30; t = timing(30.0); }
let (clock, total_h, total_v) = t;
let name = format!("{w}x{h}_{refresh}R");
let timings = [format!("{clock:.2}"), w.to_string(), (w + H_FRONT).to_string(), (w + H_FRONT + H_SYNC).to_string(), total_h.to_string(),
h.to_string(), (h + V_FRONT).to_string(), (h + V_FRONT + v_sync).to_string(), total_v.to_string(), "+hsync".into(), "-vsync".into()];
(name, timings.into())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn reduced_blanking_matches_the_cvt_tool() {
// `cvt -r 1920 1080`: 138.50 1920 1968 2000 2080 1080 1083 1088 1111 +hsync -vsync
let (name, t) = cvt_reduced(1920, 1080);
assert_eq!(name, "1920x1080_60R");
assert_eq!(t.join(" "), "138.50 1920 1968 2000 2080 1080 1083 1088 1111 +hsync -vsync");
// `cvt -r 2560 1600`: 268.50 2560 2608 2640 2720 1600 1603 1609 1646
assert_eq!(cvt_reduced(2560, 1600).1.join(" "), "268.50 2560 2608 2640 2720 1600 1603 1609 1646 +hsync -vsync");
// 4K at 60 Hz needs 533 MHz (under the cap); a larger desktop drops to 30 Hz.
assert_eq!(cvt_reduced(3840, 2160).0, "3840x2160_60R");
assert_eq!(cvt_reduced(4096, 2560).0, "4096x2560_30R");
}
#[test]
fn requested_sizes_are_even_and_bounded() {
assert_eq!(fit(1280, 720), Some((1280, 720)));
assert_eq!(fit(4112, 2580), Some((4096, 2570)));
assert_eq!(fit(301, 201), Some((640, 480)));
assert_eq!(fit(0, 1080), None);
}
#[test]
fn parses_primary_output_modes_and_current_mode() {
let text = r"Screen 0: minimum 320 x 200, current 1920 x 1080, maximum 16384 x 16384
DP-1 disconnected (normal left inverted right x axis y axis)
HDMI-1 connected primary 1920x1080+0+0 (normal left inverted right x axis y axis) 0mm x 0mm
1024x768 60.00
3840x2160R 29.98
1920x1080R 59.93*+
HDMI-2 disconnected (normal left inverted right x axis y axis)
";
let state = parse(text).unwrap();
assert_eq!(state.output, "HDMI-1");
assert_eq!(state.current, Some((1920, 1080)));
assert_eq!(state.current_mode.as_deref(), Some("1920x1080R"));
assert_eq!(state.modes.len(), 3);
assert_eq!(state.modes[1], ("3840x2160R".to_owned(), (3840, 2160)));
assert!(parse("Screen 0: minimum 320 x 200\nDP-1 disconnected (normal)\n").is_none());
}
}
+75 -15
View File
@@ -16,6 +16,13 @@ fn env_state(name: &str) -> String {
fn line(key: &str, value: impl std::fmt::Display) { println!("{key:<22} {}", redact(&value.to_string())); } fn line(key: &str, value: impl std::fmt::Display) { println!("{key:<22} {}", redact(&value.to_string())); }
fn format_probe(probe: &crate::video_select::ProbeReport) -> String {
let body = probe.order.iter().zip(probe.outcomes.iter())
.map(|(e, o)| format!("{}={}", format!("{e:?}").to_ascii_lowercase(), o.label()))
.collect::<Vec<_>>().join(" ");
if probe.expires_at.is_some() { format!("{body} (failure result, retried after 10 min)") } else { body }
}
fn glibc() -> String { fn glibc() -> String {
#[cfg(all(target_os = "linux", target_env = "gnu"))] #[cfg(all(target_os = "linux", target_env = "gnu"))]
{ {
@@ -92,19 +99,24 @@ pub async fn run() -> Result<(), String> {
line("UU_INPUT_BACKEND", std::env::var("UU_INPUT_BACKEND").unwrap_or_else(|_| "auto".into())); line("UU_INPUT_BACKEND", std::env::var("UU_INPUT_BACKEND").unwrap_or_else(|_| "auto".into()));
println!("-- video"); println!("-- video");
let encoder = crate::video::Encoder::requested(); let selection = crate::video_select::selection();
line("encoder", format!("{encoder:?} (UU_VIDEO_ENCODER={})", std::env::var("UU_VIDEO_ENCODER").unwrap_or_else(|_| "auto".into()))); let env_enc = std::env::var("UU_VIDEO_ENCODER").unwrap_or_else(|_| "unset".into());
line("default codec", format!("{:?}", crate::capture_setting::preferred_codec(true, true))); let codec = match selection.codec_pref { crate::video_select::CodecPref::Auto => "auto", crate::video_select::CodecPref::H264 => "h264", crate::video_select::CodecPref::H265 => "h265" };
let mut ffmpeg = crate::video::ffmpeg_command(); let probe_text = if selection.encoder_source == crate::video_select::Source::Auto {
ffmpeg.args(["-hide_banner", "-encoders"]).kill_on_drop(true); format_probe(&crate::video::run_auto_probe().await)
match tokio::time::timeout(std::time::Duration::from_secs(5), ffmpeg.output()).await { } else {
Ok(Ok(output)) => { crate::video_select::cached_probe().as_ref().map(format_probe).unwrap_or_else(|| "not yet run".to_owned())
let text = String::from_utf8_lossy(&output.stdout); };
let found: Vec<&str> = ["libx264", "libx265", "h264_nvenc", "hevc_nvenc", "h264_vaapi", "hevc_vaapi"].into_iter() let selection = if selection.encoder_source == crate::video_select::Source::Auto { crate::video_select::selection() } else { selection };
.filter(|name| text.split_whitespace().any(|word| word == *name)).collect(); line("encoder probe", probe_text);
line("ffmpeg encoders", if found.is_empty() { "none of libx264/libx265/nvenc/vaapi".to_owned() } else { found.join(", ") }); line("encoder", format!("{:?} (source={}; UU_VIDEO_ENCODER={env_enc})", selection.encoder, crate::video_select::encoder_source_label(selection.encoder_source)));
} line("codec", format!("{codec} (source={})", crate::video_select::source_label(selection.codec_source)));
_ => line("ffmpeg encoders", "ffmpeg not runnable (install ffmpeg or set ffmpeg_root)"), // Both codecs offered: hardware prefers H.265, CPU stays H.264 unless the preference forces one.
let resolved = crate::capture_setting::pick_codec(true, true, crate::video_select::codec_force(selection.codec_pref), crate::video_select::hardware(selection.encoder));
line("resolved codec", format!("{resolved:?}"));
match crate::video::ffmpeg_encoders().await {
Some(found) => line("ffmpeg encoders", if found.is_empty() { "none of libx264/libx265/nvenc/vaapi".to_owned() } else { found.join(", ") }),
None => line("ffmpeg encoders", "ffmpeg not runnable (install ffmpeg or set ffmpeg_root)"),
} }
let mut version = crate::video::ffmpeg_command(); let mut version = crate::video::ffmpeg_command();
version.arg("-version").kill_on_drop(true); version.arg("-version").kill_on_drop(true);
@@ -135,11 +147,39 @@ pub async fn run() -> Result<(), String> {
Err(_) => line("config mode", "missing (run `uuremote-server login`)"), Err(_) => line("config mode", "missing (run `uuremote-server login`)"),
} }
line("service", command_output("systemctl", &["--user", "is-active", "uuremote-native.service"]).await.unwrap_or_else(|| "systemctl unavailable".into())); line("service", command_output("systemctl", &["--user", "is-active", "uuremote-native.service"]).await.unwrap_or_else(|| "systemctl unavailable".into()));
let running = command_output("pgrep", &["-c", "-x", "uuremote-server"]).await.filter(|n| !n.is_empty()).unwrap_or_else(|| "unknown".into()); let running = host_processes();
line("uuremote-server procs", format!("{running} (including this one; more than 2 means duplicates)")); line("uuremote-server procs", format!("{} (including this one; more than 2 means duplicates)", running.map_or_else(|| "unknown".into(), |n| n.to_string())));
if running.is_some_and(|n| n > 2) {
println!(" ! another host instance is running (check `pgrep -af uuremote`); stop the extra one, e.g. an old copy started by hand");
println!(" instances sharing one identity, on this or another machine, kick each other out of the room: never copy config.json between machines");
}
Ok(()) Ok(())
} }
/// Hosts re-exec through /proc/self/exe (comm "exe"), so match the executable's file name, not the process name.
/// Helpers a host spawns (Wayland capture, login window) are its children and are not separate instances.
fn host_processes() -> Option<usize> {
let hosts: Vec<(u32, u32)> = std::fs::read_dir("/proc").ok()?.flatten()
.filter_map(|entry| Some((entry.file_name().to_str()?.parse::<u32>().ok()?, entry.path())))
.filter(|(_, dir)| std::fs::read_link(dir.join("exe")).is_ok_and(|exe| is_host_executable(&exe)))
.filter_map(|(pid, dir)| Some((pid, parent_pid(&std::fs::read_to_string(dir.join("stat")).ok()?)?)))
.collect();
Some(top_level(&hosts))
}
/// Field 4 of /proc/<pid>/stat; the command name in field 2 may contain spaces and parentheses.
fn parent_pid(stat: &str) -> Option<u32> {
stat.rsplit_once(')')?.1.split_whitespace().nth(1)?.parse().ok()
}
fn top_level(hosts: &[(u32, u32)]) -> usize {
hosts.iter().filter(|(_, parent)| !hosts.iter().any(|(pid, _)| pid == parent)).count()
}
fn is_host_executable(exe: &std::path::Path) -> bool {
exe.file_name().and_then(|name| name.to_str()).is_some_and(|name| name.trim_end_matches(" (deleted)") == "uuremote-server")
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
#[test] #[test]
@@ -162,4 +202,24 @@ mod tests {
assert!(!super::missing_display(DesktopBackend::Wayland, false, None, None)); assert!(!super::missing_display(DesktopBackend::Wayland, false, None, None));
assert!(!super::missing_display(DesktopBackend::X11, true, None, None)); assert!(!super::missing_display(DesktopBackend::X11, true, None, None));
} }
#[test]
fn host_processes_match_the_executable_even_after_reexec() {
use std::path::Path;
for exe in ["/usr/bin/uuremote-server", "/home/u/.local/bin/uuremote-server", "/usr/bin/uuremote-server (deleted)"] {
assert!(super::is_host_executable(Path::new(exe)));
}
for exe in ["/usr/bin/uuremote-viewer", "/usr/bin/bash", "/usr/bin/uuremote-server-old"] {
assert!(!super::is_host_executable(Path::new(exe)));
}
}
#[test]
fn host_helpers_are_not_counted_as_instances() {
assert_eq!(super::parent_pid("8943 (exe) S 1699 8943 1699 0 -1"), Some(1699));
assert_eq!(super::parent_pid("12 (a) b (c) R 7 12"), Some(7));
// service 10 with a login window 11, a stale copy 20, doctor 30
assert_eq!(super::top_level(&[(10, 1), (11, 10), (20, 5), (30, 9)]), 3);
assert_eq!(super::top_level(&[(10, 1), (11, 10), (30, 9)]), 2);
}
} }
+671 -397
View File
File diff suppressed because it is too large. Load diff
+167 -6
View File
@@ -328,12 +328,18 @@ impl InputInjector {
// uinput ABS axes span the compositor's whole desktop. A captured output // uinput ABS axes span the compositor's whole desktop. A captured output
// uses its own pixel space; bind absolute motion to that Wayland output, // uses its own pixel space; bind absolute motion to that Wayland output,
// including when uinput remains in use for keyboard/buttons/relative input. // including when uinput remains in use for keyboard/buttons/relative input.
// Only a compositor without wlr-virtual-pointer (-2) falls through to the uinput
// absolute pointer; an out-of-range point must not land on another output.
if !relative && self.backend==crate::desktop_backend::DesktopBackend::Wayland { if !relative && self.backend==crate::desktop_backend::DesktopBackend::Wayland {
return crate::wayland::move_pointer(x,y,false); let result=crate::wayland::move_pointer(x,y,false);
if result!=-2 { return result; }
} }
// X11 multi-screen: the point is inside the selected monitor; XTest and uinput span the root.
let placement=if relative || self.backend!=crate::desktop_backend::DesktopBackend::X11 {None} else {crate::wayland::x11_placement()};
let (x,y)=placement.map_or((x,y),|(ox,oy)|(x+ox,y+oy));
if let Some(uinput)=&self.uinput { if let Some(uinput)=&self.uinput {
if relative { return Self::uinput_result(uinput.move_relative(x,y)); } if relative { return Self::uinput_result(uinput.move_relative(x,y)); }
let (w,h)=*self.screen.lock().unwrap(); let (w,h)=placement.and_then(|_|crate::capture::x11_last_size()).unwrap_or(*self.screen.lock().unwrap());
if w > 1 && h > 1 { if w > 1 && h > 1 {
let scale = |v: i32, extent: u32| (i64::from(v) * i64::from(crate::uinput::ABS_MAX) / i64::from(extent - 1)) as i32; let scale = |v: i32, extent: u32| (i64::from(v) * i64::from(crate::uinput::ABS_MAX) / i64::from(extent - 1)) as i32;
return Self::uinput_result(uinput.move_absolute(scale(x,w),scale(y,h))); return Self::uinput_result(uinput.move_absolute(scale(x,w),scale(y,h)));
@@ -366,8 +372,93 @@ impl InputInjector {
if self.backend==crate::desktop_backend::DesktopBackend::Wayland { crate::wayland::key(symbol,pressed) } if self.backend==crate::desktop_backend::DesktopBackend::Wayland { crate::wayland::key(symbol,pressed) }
else { unsafe { x11_key_symbol(symbol as libc::c_ulong,i32::from(pressed)) } } else { unsafe { x11_key_symbol(symbol as libc::c_ulong,i32::from(pressed)) } }
} }
/// Set clipboard content for text injection on Wayland / Portal.
/// Tries Portal RemoteDesktop.SetSelection first, then wl-copy as fallback.
fn set_clipboard_text(&self, text: &str) -> bool {
if text.is_empty() || text.len() > crate::clipboard::MAX_TEXT {
return false;
}
// In unit tests, never invoke external clipboard binaries (wl-copy)
// or alter the system clipboard to prevent side effects on developer desktops.
#[cfg(test)]
{
let _ = text;
false
}
#[cfg(not(test))]
{
// 1. Try Portal clipboard if session is bound and active
if let Some(portal) = self.portal.lock().unwrap().as_ref() {
if portal.clipboard_set(text).is_ok() {
return true;
}
}
// 2. Try wl-copy in Wayland session
if std::env::var_os("WAYLAND_DISPLAY").is_some() {
if let Ok(mut child) = std::process::Command::new("wl-copy")
.args(["--type", "text/plain;charset=utf-8"])
.stdin(std::process::Stdio::piped())
.stdout(std::process::Stdio::null())
.stderr(std::process::Stdio::null())
.spawn()
{
if let Some(mut stdin) = child.stdin.take() {
use std::io::Write;
let _ = stdin.write_all(text.as_bytes());
}
if let Ok(status) = child.wait() {
if status.success() {
return true;
}
}
}
}
false
}
}
/// Injects text by copying it to the clipboard and simulating a paste shortcut.
/// Uses Shift+Insert by default (broadest Linux compatibility across GUI apps and terminals),
/// or Ctrl+V if configured via UU_WAYLAND_PASTE_KEY=ctrl_v.
fn paste_text_via_clipboard(&self, text: &str) -> bool {
if !self.set_clipboard_text(text) {
return false;
}
// Give the clipboard daemon / compositor a brief moment to register the selection.
std::thread::sleep(std::time::Duration::from_millis(25));
let use_ctrl_v = std::env::var("UU_WAYLAND_PASTE_KEY")
.is_ok_and(|v| v.eq_ignore_ascii_case("ctrl_v") || v.eq_ignore_ascii_case("ctrl+v"));
if use_ctrl_v {
// Control_L (0xffe3) + 'v' (0x76)
self.inject_key(0xffe3, true);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0x76, true);
std::thread::sleep(std::time::Duration::from_millis(20));
self.inject_key(0x76, false);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0xffe3, false);
} else {
// Shift_L (0xffe1) + Insert (0xff63)
self.inject_key(0xffe1, true);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0xff63, true);
std::thread::sleep(std::time::Duration::from_millis(20));
self.inject_key(0xff63, false);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0xffe1, false);
}
// Brief delay allowing the target application to consume the paste event
std::thread::sleep(std::time::Duration::from_millis(25));
true
}
/// Mobile input-method text (`text_input`). X11 types it directly; Wayland re-maps a spare /// Mobile input-method text (`text_input`). X11 types it directly; Wayland re-maps a spare
/// keycode in the virtual keyboard's keymap. Other backends log once. /// keycode in the virtual keyboard's keymap. Portal and other Wayland environments inject
/// via clipboard paste (Shift+Insert). Set UU_WAYLAND_TEXT=0 to disable Wayland text injection.
pub fn text_input(&self, text: &str) { pub fn text_input(&self, text: &str) {
let _serial=self.serial.lock().unwrap(); let _serial=self.serial.lock().unwrap();
let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return }; let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return };
@@ -375,17 +466,31 @@ impl InputInjector {
let typed=unsafe { x11_type_utf8(c_text.as_ptr()) }; let typed=unsafe { x11_type_utf8(c_text.as_ptr()) };
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed); log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
} else if self.backend==crate::desktop_backend::DesktopBackend::Wayland { } else if self.backend==crate::desktop_backend::DesktopBackend::Wayland {
// Escape hatch: keep the old behaviour without rebuilding. // Escape hatch: disable Wayland text typing/pasting entirely without rebuilding.
if std::env::var("UU_WAYLAND_TEXT").is_ok_and(|v|v=="0") { return; } if std::env::var("UU_WAYLAND_TEXT").is_ok_and(|v|v=="0") { return; }
let typed=crate::wayland::type_utf8(text); let typed=crate::wayland::type_utf8(text);
if typed>=0 { if typed>=0 {
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed); log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
return; return;
} }
// A keymap whose keycodes are all mapped cannot carry text; report it once. // Fallback to clipboard paste if keymap has no spare keycodes or native typing failed
if self.paste_text_via_clipboard(text) {
log::info!("Desktop text input (Wayland clipboard paste fallback): chars={} result=ok", text.chars().count());
return;
}
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false); static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) { if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
log::warn!("Mobile text input unavailable on the Wayland backend (no spare keycode in this keymap)"); log::warn!("Mobile text input unavailable on the Wayland backend (native and clipboard fallback failed)");
}
} else if self.backend==crate::desktop_backend::DesktopBackend::Portal {
if std::env::var("UU_WAYLAND_TEXT").is_ok_and(|v|v=="0") { return; }
if self.paste_text_via_clipboard(text) {
log::info!("Desktop text input (Portal clipboard paste): chars={} result=ok", text.chars().count());
return;
}
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
log::warn!("Portal clipboard text paste failed: ensure clipboard permission or wl-copy is available");
} }
} else { } else {
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false); static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
@@ -697,3 +802,59 @@ mod output_pointer_tests {
} }
} }
} }
#[cfg(all(test,target_os="linux"))]
mod x11_monitor_pointer_tests {
use super::*;
#[test]
#[ignore="requires an X11 display with two or more RandR monitors and UU_X11_MULTISCREEN=1; moves pointer only"]
fn absolute_pointer_lands_on_the_selected_x11_monitor() {
let _capture=crate::capture::ScreenCapture::new().unwrap();
let input=InputInjector::new();
assert_eq!(input.backend,crate::desktop_backend::DesktopBackend::X11);
let outputs=crate::wayland::outputs();assert!(crate::wayland::x11_multiscreen() && outputs.len()>=2,"needs two X11 monitors");
for (id,output) in outputs.iter().enumerate().chain(outputs.iter().enumerate().rev()) {
crate::wayland::select(id).unwrap();
for (x,y) in [(0.0,0.0),(0.5,0.5),(0.999,0.999),(0.1,0.9)] {
let size=(output.width,output.height);
let pixels=crate::input_mapping::normalized_pointer(x,y,size.0,size.1).unwrap();
input.mouse_absolute_normalized(x,y,size);input.flush_pointer();
let (mut ax,mut ay,mut mask)=(0,0,0);
assert_eq!(unsafe {x11_pointer_state(&mut ax,&mut ay,&mut mask)},0);
assert_eq!((ax,ay),(output.x+pixels.0,output.y+pixels.1),"monitor={} normalized=({x},{y})",output.name);
}
}
crate::wayland::select(0).unwrap();
}
}
#[cfg(test)]
mod clipboard_paste_text_tests {
use super::*;
#[test]
fn rejects_empty_and_oversized_text() {
let input = InputInjector::new();
assert!(!input.set_clipboard_text(""));
let oversized = "a".repeat(crate::clipboard::MAX_TEXT + 1);
assert!(!input.set_clipboard_text(&oversized));
}
#[test]
fn text_input_handles_portal_backend_safely_without_side_effects() {
let mut input = InputInjector::new();
input.backend = crate::desktop_backend::DesktopBackend::Portal;
// In unit tests, set_clipboard_text avoids external commands so this
// will not mutate the host's actual clipboard.
input.text_input("测试输入法文字");
}
#[test]
fn text_input_respects_disable_env() {
let mut input = InputInjector::new();
input.backend = crate::desktop_backend::DesktopBackend::Portal;
std::env::set_var("UU_WAYLAND_TEXT", "0");
input.text_input("测试输入法文字");
std::env::remove_var("UU_WAYLAND_TEXT");
}
}
+5 -5
View File
@@ -25,11 +25,11 @@ async fn black_frame(codec: VideoCodec) -> Result<Bytes, String> {
Ok(output.stdout.into()) Ok(output.stdout.into())
} }
pub async fn run(pc: &RTCPeerConnection, track: &VideoTrack, desktop: &PortalDesktop) -> Result<(), String> { pub async fn run(pc: &RTCPeerConnection, track: &VideoTrack, desktop: &PortalDesktop, selection: crate::video_select::Selection) -> Result<(), String> {
run_with_encoder(pc, track, desktop, black_frame).await run_with_encoder(pc, track, desktop, selection, black_frame).await
} }
async fn run_with_encoder<F, Fut>(pc: &RTCPeerConnection, track: &VideoTrack, desktop: &PortalDesktop, mut encode: F) -> Result<(), String> async fn run_with_encoder<F, Fut>(pc: &RTCPeerConnection, track: &VideoTrack, desktop: &PortalDesktop, selection: crate::video_select::Selection, mut encode: F) -> Result<(), String>
where F: FnMut(VideoCodec) -> Fut, Fut: std::future::Future<Output = Result<Bytes, String>> { where F: FnMut(VideoCodec) -> Fut, Fut: std::future::Future<Output = Result<Bytes, String>> {
// #29: iPhone 4.42.0 cold ON/OFF/ON tests only sent action15 after black video. // #29: iPhone 4.42.0 cold ON/OFF/ON tests only sent action15 after black video.
// Keep CONTROL permissions truthful and use the existing video track until real capture is ready. // Keep CONTROL permissions truthful and use the existing video track until real capture is ready.
@@ -55,8 +55,8 @@ where F: FnMut(VideoCodec) -> Fut, Fut: std::future::Future<Output = Result<Byte
if !updates.borrow().waiting || *locked.borrow() != Some(true) if !updates.borrow().waiting || *locked.borrow() != Some(true)
|| pc.connection_state() != RTCPeerConnectionState::Connected { continue; } || pc.connection_state() != RTCPeerConnectionState::Connected { continue; }
if frame.is_none() { if frame.is_none() {
let codec = crate::capture_setting::preferred_codec( let codec = crate::capture_setting::preferred_codec_for(
track.supports(VideoCodec::H264), track.supports(VideoCodec::H265)); track.supports(VideoCodec::H264), track.supports(VideoCodec::H265), selection);
let encoded = tokio::select! { let encoded = tokio::select! {
biased; biased;
_ = updates.changed() => continue, _ = updates.changed() => continue,
+4 -4
View File
@@ -206,7 +206,7 @@ async fn exercise_locked_video(codec: VideoCodec) {
let run_host = peers.host.clone(); let run_host = peers.host.clone();
let run_track = peers.track.clone(); let run_track = peers.track.clone();
let run_desktop = desktop.clone(); let run_desktop = desktop.clone();
let task = tokio::spawn(async move { run(&run_host, &run_track, &run_desktop).await }); let task = tokio::spawn(async move { run(&run_host, &run_track, &run_desktop, crate::video_select::selection()).await });
assert_ne!(peers.host.connection_state(), RTCPeerConnectionState::Connected); assert_ne!(peers.host.connection_state(), RTCPeerConnectionState::Connected);
assert_no_rtp(&mut peers.packets, Duration::from_millis(150)).await; assert_no_rtp(&mut peers.packets, Duration::from_millis(150)).await;
@@ -273,7 +273,7 @@ async fn locked_video_rechecks_state_when_encoding_finishes() {
let (encoded_tx, mut encoded_rx) = mpsc::unbounded_channel(); let (encoded_tx, mut encoded_rx) = mpsc::unbounded_channel();
let revision = peers.track.revision(); let revision = peers.track.revision();
let task = tokio::spawn(async move { let task = tokio::spawn(async move {
run_with_encoder(&run_host, &run_track, &run_desktop, |_| { run_with_encoder(&run_host, &run_track, &run_desktop, crate::video_select::selection(), |_| {
let desktop = run_desktop.clone(); let desktop = run_desktop.clone();
let lock_tx = lock_tx.clone(); let lock_tx = lock_tx.clone();
let encoded_tx = encoded_tx.clone(); let encoded_tx = encoded_tx.clone();
@@ -317,7 +317,7 @@ async fn locked_video_stops_on_capture_rejection_and_terminal_peer_close() {
let run_host = peers.host.clone(); let run_host = peers.host.clone();
let run_track = peers.track.clone(); let run_track = peers.track.clone();
let run_desktop = rejected_desktop.clone(); let run_desktop = rejected_desktop.clone();
let rejection_task = tokio::spawn(async move { run(&run_host, &run_track, &run_desktop).await }); let rejection_task = tokio::spawn(async move { run(&run_host, &run_track, &run_desktop, crate::video_select::selection()).await });
rejected_desktop.publish_test_screen( rejected_desktop.publish_test_screen(
Arc::new(ScreenCapture::unavailable("synthetic capture rejection".into())), Arc::new(ScreenCapture::unavailable("synthetic capture rejection".into())),
); );
@@ -335,7 +335,7 @@ async fn locked_video_stops_on_capture_rejection_and_terminal_peer_close() {
let run_host = peers.host.clone(); let run_host = peers.host.clone();
let run_track = peers.track.clone(); let run_track = peers.track.clone();
let run_desktop = pending_desktop; let run_desktop = pending_desktop;
let close_task = tokio::spawn(async move { run(&run_host, &run_track, &run_desktop).await }); let close_task = tokio::spawn(async move { run(&run_host, &run_track, &run_desktop, crate::video_select::selection()).await });
peers.host.close().await.unwrap(); peers.host.close().await.unwrap();
tokio::time::timeout(Duration::from_secs(2), close_task).await tokio::time::timeout(Duration::from_secs(2), close_task).await
.expect("locked video task did not stop after terminal peer close") .expect("locked video task did not stop after terminal peer close")
+162 -54
View File
@@ -8,7 +8,7 @@
//! (analysis/tools-fix-20261013/viewer-fieldmd.json). Results are written to the private //! (analysis/tools-fix-20261013/viewer-fieldmd.json). Results are written to the private
//! config file (chmod 600). Tokens and tickets are never printed or logged. //! config file (chmod 600). Tokens and tickets are never printed or logged.
use crate::auth::{Credentials, UUAuthClient}; use crate::auth::{Credentials, QrRequestErrorKind, UUAuthClient};
use crate::login_ui::{LoginUi, Tone}; use crate::login_ui::{LoginUi, Tone};
use serde_json::{json, Value}; use serde_json::{json, Value};
use std::time::Duration; use std::time::Duration;
@@ -127,6 +127,35 @@ fn render_qr(content: &str) -> Result<String, String> {
/// API code for an expired login QR code. /// API code for an expired login QR code.
const QR_EXPIRED: i64 = 1190; const QR_EXPIRED: i64 = 1190;
/// QR API errors must not echo server messages/validation fields: they may contain credentials.
fn qr_data<'a>(stage: &str, status: u16, body: &'a Value) -> Result<&'a Value, String> {
let code = body.get("code").and_then(Value::as_i64);
if status == 200 && code == Some(0) { return Ok(body.get("data").unwrap_or(&Value::Null)); }
Err(format!("{stage}: http_status={status} api_code={code:?}"))
}
#[derive(Debug, PartialEq, Eq)]
enum QrPollAction { Wait(i64), Scanned, Confirmed, Refresh(Duration), Failed(&'static str) }
/// Preserve the official refresh policy; a failed query says nothing about QR expiry.
fn qr_poll_action(last_status: i64, http_status: u16, body: &Value) -> QrPollAction {
if body.get("code").and_then(Value::as_i64) == Some(QR_EXPIRED) {
return QrPollAction::Failed("二维码已失效");
}
let Ok(data) = qr_data("qrcode status", http_status, body) else {
return QrPollAction::Failed("二维码状态查询失败");
};
match data.get("status").and_then(Value::as_i64) {
Some(1) => QrPollAction::Wait(1),
Some(2) if last_status != 2 => QrPollAction::Scanned,
Some(2) => QrPollAction::Wait(2),
Some(0) => QrPollAction::Refresh(Duration::from_millis(350)),
Some(3) => QrPollAction::Refresh(Duration::ZERO),
Some(4) => QrPollAction::Confirmed,
_ => QrPollAction::Failed("二维码状态响应异常"),
}
}
/// QR modules as RGBA pixels: `scale` pixels per module, `quiet` light modules around the code. /// QR modules as RGBA pixels: `scale` pixels per module, `quiet` light modules around the code.
fn qr_rgba(content: &str, scale: usize, quiet: usize) -> Result<(Vec<u8>, usize), String> { fn qr_rgba(content: &str, scale: usize, quiet: usize) -> Result<(Vec<u8>, usize), String> {
let code = qrcode::QrCode::new(content.as_bytes()).map_err(|e| format!("QR encode failed: {e}"))?; let code = qrcode::QrCode::new(content.as_bytes()).map_err(|e| format!("QR encode failed: {e}"))?;
@@ -268,14 +297,30 @@ pub async fn prepare_device() -> Result<(Value, Credentials), String> {
pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> { pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
let (mut cfg, creds) = prepare_device().await?; let (mut cfg, creds) = prepare_device().await?;
let client = UUAuthClient::new(creds.clone()); let client = UUAuthClient::new(creds.clone());
let mut instant_expiries = 0u32; // Mirrors the official Mac client (LoginViewController / LoginManager, UURemote 4.42): gen/login has
// no body; the status long poll sends gen's `status_query_ticket` under `token` with the last
// status, re-asks as soon as an answer arrives (60 s request timeout), regenerates on status 3
// at once and on status 0 after 0.35 s, logs in on 4, and on any error (e.g. HTTP 400 code 1190)
// stops until the user asks for a new QR. Sending gen's older `token` field made the cloud reject
// every QR within seconds (#68).
let timeout = Duration::from_secs(60);
loop { loop {
let (status, resp) = client.post_json("/api/v1/qrcode/gen/login", &json!({})).await?; let (status, resp) = match client.post_with_timeout("/api/v1/qrcode/gen/login", None, timeout).await {
let d = data("qrcode gen", status, &resp)?; Ok(r) => r,
Err(e) if e.response_received() => {
eprintln!("QR generation response failed: {e}");
wait_for_refresh(ui, "二维码加载失败").await;
continue;
}
Err(e) => return Err(format!("QR generation failed: {e}")),
};
let d = match qr_data("qrcode gen", status, &resp) {
Ok(d) => d.clone(),
Err(e) => { println!("QR code could not be loaded ({e})"); wait_for_refresh(ui, "二维码加载失败").await; continue; }
};
let url = d.get("qrcode_jump_url").and_then(|v| v.as_str()).ok_or("qrcode gen returned no qrcode_jump_url")?.to_string(); let url = d.get("qrcode_jump_url").and_then(|v| v.as_str()).ok_or("qrcode gen returned no qrcode_jump_url")?.to_string();
let ticket = d.get("token").or_else(|| d.get("status_query_ticket")).and_then(|v| v.as_str()) let ticket = qr_ticket(&d).ok_or("qrcode gen returned no status ticket")?.to_string();
.ok_or("qrcode gen returned no token")?.to_string(); ui.offer_refresh(false);
if ui.shown() { if ui.shown() {
let modules = qrcode::QrCode::new(url.as_bytes()).map_err(|e| e.to_string())?.width() + 2; let modules = qrcode::QrCode::new(url.as_bytes()).map_err(|e| e.to_string())?.width() + 2;
let (rgba, edge) = qr_rgba(&url, (224 / modules).max(2), 1)?; let (rgba, edge) = qr_rgba(&url, (224 / modules).max(2), 1)?;
@@ -290,48 +335,49 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
file.write_all(&crate::cursor::encode_png(edge as u32,edge as u32,&rgba)).map_err(|e|e.to_string())?; file.write_all(&crate::cursor::encode_png(edge as u32,edge as u32,&rgba)).map_err(|e|e.to_string())?;
} }
if !ui.quiet() { println!("\nScan with the UU Remote mobile app (网易UU远程 App 扫码登录):\n{}", render_qr(&url)?); } if !ui.quiet() { println!("\nScan with the UU Remote mobile app (网易UU远程 App 扫码登录):\n{}", render_qr(&url)?); }
// Status is a long poll: send the state already shown (server enum 1..4; observed:
// 1 waiting, 2 scanned, 4 after the phone confirmed); the server answers when it changes.
let mut login_status = 1i64; let mut login_status = 1i64;
let mut expired = false; let failure = loop {
let generated = std::time::Instant::now();
for _ in 0..150 {
let query = json!({"token": ticket, "qrcode_jump_url": url, "login_status": login_status}); let query = json!({"token": ticket, "qrcode_jump_url": url, "login_status": login_status});
let asked = std::time::Instant::now(); let (status, resp) = match client.post_with_timeout("/api/v1/qrcode/login/status", Some(&query), timeout).await {
let (status, resp) = match client.post_json("/api/v1/qrcode/login/status", &query).await {
Ok(r) => r, Ok(r) => r,
// Long-poll timeout: ask again, but never spin on transport errors (#68). Err(e) => {
Err(_) => { if asked.elapsed() < Duration::from_secs(1) { tokio::time::sleep(Duration::from_secs(2)).await; } continue; } eprintln!("QR status query failed: {e}; last_status={login_status}");
break match e.kind {
QrRequestErrorKind::Timeout => "二维码状态查询超时(不代表二维码已失效)",
_ => "二维码状态查询失败(不代表二维码已失效)",
};
}
}; };
// Code 1190 (HTTP 400, "二维码已失效"): the QR expired; generate a new one. match qr_poll_action(login_status, status, &resp) {
if resp.get("code").and_then(|c| c.as_i64()) == Some(QR_EXPIRED) { QrPollAction::Wait(st) => {
ui.status("二维码已过期,正在刷新…", Tone::Info); if st == 1 && login_status != 1 { ui.status("等待扫码…", Tone::Info); }
expired = true; break; login_status = st;
} }
let st = data("qrcode status", status, &resp)?.get("status").and_then(|v| v.as_i64()).unwrap_or(login_status); QrPollAction::Scanned => {
if st == login_status { login_status = 2;
// The server normally holds this request; an immediate unchanged answer must not
// turn into a tight loop of dozens of requests per second (#68).
if asked.elapsed() < Duration::from_secs(1) { tokio::time::sleep(Duration::from_secs(2)).await; }
continue;
}
login_status = st;
match st {
2 => {
println!("已扫码,请在手机上确认 (scanned, confirm on the phone)"); println!("已扫码,请在手机上确认 (scanned, confirm on the phone)");
ui.status("已扫码,请在手机上确认登录", Tone::Ok); ui.status("已扫码,请在手机上确认登录", Tone::Ok);
} }
3 | 4 => { QrPollAction::Refresh(delay) => {
// A final state: confirmed logs in; cancelled/expired is refused and a new QR follows. if delay.is_zero() { println!("QR code expired; generating a new one"); }
else { tokio::time::sleep(delay).await; }
break "";
}
QrPollAction::Confirmed => {
println!("已确认,正在完成登录 (confirmed, completing login)");
ui.status("已确认,正在完成登录…", Tone::Info);
let body = json!({"token": ticket, "qrcode_jump_url": url}); let body = json!({"token": ticket, "qrcode_jump_url": url});
let (status, resp) = client.post_json("/api/v1/login/by_qrcode", &body).await?; let (status, resp) = match client.post_with_timeout("/api/v1/login/by_qrcode", Some(&body), timeout).await {
let d = match data("qrcode login", status, &resp) { Ok(r) => r,
Ok(d) => d, Err(e) if e.response_received() => {
Err(e) => { eprintln!("QR login exchange response failed: {e}");
println!("QR status {st}: login not granted ({e})"); break "登录失败";
ui.status("手机端未确认登录,正在刷新二维码…", Tone::Error);
expired = true; break;
} }
Err(e) => return Err(format!("QR login exchange failed: {e}")),
};
let d = match qr_data("qrcode login", status, &resp) {
Ok(d) => d,
Err(e) => { println!("QR login not granted ({e})"); break "登录失败"; }
}; };
let token = d.get("token").and_then(|v| v.as_str()).ok_or("login returned no token")?; let token = d.get("token").and_then(|v| v.as_str()).ok_or("login returned no token")?;
let user = d.get("user_id").and_then(|v| v.as_str()).ok_or("login returned no user_id")?; let user = d.get("user_id").and_then(|v| v.as_str()).ok_or("login returned no user_id")?;
@@ -348,27 +394,88 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
println!("Logged in as {} ({}); saved to {}", nickname, user, path.display()); println!("Logged in as {} ({}); saved to {}", nickname, user, path.display());
return Ok(if nickname.is_empty() { user.to_string() } else { nickname.to_string() }); return Ok(if nickname.is_empty() { user.to_string() } else { nickname.to_string() });
} }
_ => { println!("QR status: {st}"); ui.status("二维码已失效,正在刷新…", Tone::Error); expired = true; break; } QrPollAction::Failed(reason) => {
eprintln!("QR status query stopped: http_status={status} api_code={:?} status={:?} last_status={login_status}",
resp.get("code").and_then(Value::as_i64), resp.get("data").and_then(|d| d.get("status")).and_then(Value::as_i64));
break reason;
}
} }
} };
println!("{}", if expired { "QR code expired; generating a new one" } else { "QR code timed out; generating a new one" }); if !failure.is_empty() { wait_for_refresh(ui, failure).await; }
// A QR rejected within seconds of being generated, again and again, was seen when the cloud
// flagged this device identity (#68): back off and say how to recover.
if expired && generated.elapsed() < Duration::from_secs(10) { instant_expiries += 1; } else { instant_expiries = 0; }
if instant_expiries == 3 {
eprintln!("The QR code keeps expiring immediately. If this persists, the cloud may reject this device identity: \
back up and remove ~/.config/uuremote/config.json, then run `uuremote-server login` again to register a new device.");
ui.status("二维码反复立即失效:可备份并删除 ~/.config/uuremote/config.json 后重新登录(会注册新设备)", Tone::Error);
}
tokio::time::sleep(Duration::from_secs(1u64 << instant_expiries.min(5))).await; // never spin if the server keeps refusing
} }
} }
/// gen/login's status ticket: `status_query_ticket` (current cloud and official clients), else the
/// older `token` field for servers that do not send it.
fn qr_ticket(gen: &Value) -> Option<&str> {
gen.get("status_query_ticket").or_else(|| gen.get("token")).and_then(|v| v.as_str()).filter(|t| !t.is_empty())
}
/// Stop like the official client and wait for the user: the 刷新二维码 button, Enter in a terminal,
/// or (no window and no terminal, e.g. a service) one minute.
async fn wait_for_refresh(ui: &LoginUi, reason: &str) {
use std::io::IsTerminal;
ui.status(&format!("{reason},请点击「刷新二维码」"), Tone::Error);
ui.offer_refresh(true);
let terminal = !ui.quiet() && std::io::stdin().is_terminal();
if terminal { println!("{reason}. Press Enter to show a new QR code (按回车刷新二维码)"); }
else { println!("{reason}; waiting for 刷新二维码{}", if ui.shown() { "" } else { " (a new QR code follows in 60 s)" }); }
let mut line = terminal.then(|| tokio::task::spawn_blocking(|| { let mut s = String::new(); let _ = std::io::stdin().read_line(&mut s); }));
let started = std::time::Instant::now();
loop {
if ui.take_refresh() || (ui.shown() && ui.closed()) { break; }
if let Some(handle) = line.as_mut() { if handle.is_finished() { break; } }
if !ui.shown() && !terminal && started.elapsed() >= Duration::from_secs(60) { break; }
tokio::time::sleep(Duration::from_millis(200)).await;
}
ui.offer_refresh(false);
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
#[tokio::test] #[test]
async fn service_waits_until_a_new_token_is_saved() { fn qr_poll_keeps_waiting_scanned_and_confirmed_distinct() {
let reply = |status| json!({"code": 0, "data": {"status": status}});
assert_eq!(qr_poll_action(1, 200, &reply(1)), QrPollAction::Wait(1));
assert_eq!(qr_poll_action(1, 200, &reply(2)), QrPollAction::Scanned);
assert_eq!(qr_poll_action(2, 200, &reply(2)), QrPollAction::Wait(2));
assert_eq!(qr_poll_action(2, 200, &reply(4)), QrPollAction::Confirmed);
assert_eq!(qr_poll_action(1, 200, &reply(0)), QrPollAction::Refresh(Duration::from_millis(350)));
assert_eq!(qr_poll_action(2, 200, &reply(3)), QrPollAction::Refresh(Duration::ZERO));
assert_eq!(qr_poll_action(2, 400, &json!({"code": 1190})), QrPollAction::Failed("二维码已失效"));
}
#[test]
fn qr_poll_failures_do_not_imply_expiry_or_confirmation() {
for last in [1, 2] {
for body in [json!(null), json!({"code": 1}), json!({"code": 0, "data": {"status": 4}})] {
assert_eq!(qr_poll_action(last, 503, &body), QrPollAction::Failed("二维码状态查询失败"));
}
assert_eq!(qr_poll_action(last, 200, &json!({"code": 1})), QrPollAction::Failed("二维码状态查询失败"));
for data in [json!(null), json!({}), json!({"status": "4"}), json!({"status": 99}), json!({"status": -1})] {
assert_eq!(qr_poll_action(last, 200, &json!({"code": 0, "data": data})), QrPollAction::Failed("二维码状态响应异常"));
}
}
}
#[test]
fn qr_api_errors_do_not_echo_server_content() {
let body = json!({"code": 1001, "msg": "fixture-token", "data": [{"loc": "fixture-ticket"}]});
assert_eq!(qr_data("qrcode gen", 400, &body).unwrap_err(), "qrcode gen: http_status=400 api_code=Some(1001)");
}
#[test]
fn status_ticket_prefers_status_query_ticket() {
assert_eq!(qr_ticket(&json!({"token": "old", "status_query_ticket": "new"})), Some("new"));
assert_eq!(qr_ticket(&json!({"token": "old"})), Some("old"));
assert_eq!(qr_ticket(&json!({"status_query_ticket": ""})), None);
}
#[test]
fn service_waits_until_a_new_token_is_saved() {
let _env = crate::config::test_env_lock().lock().unwrap();
let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().unwrap();
rt.block_on(async {
let dir = std::env::temp_dir().join(format!("uu-login-wait-{}", std::process::id())); let dir = std::env::temp_dir().join(format!("uu-login-wait-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap(); std::fs::create_dir_all(&dir).unwrap();
let path = dir.join("config.json"); let path = dir.join("config.json");
@@ -384,6 +491,7 @@ mod tests {
let got = tokio::time::timeout(Duration::from_secs(10), wait_for_credentials(Some("old".into()))).await.unwrap(); let got = tokio::time::timeout(Duration::from_secs(10), wait_for_credentials(Some("old".into()))).await.unwrap();
assert_eq!(got.token, "new"); // the expired token in the file is not accepted assert_eq!(got.token, "new"); // the expired token in the file is not accepted
let _ = std::fs::remove_dir_all(&dir); let _ = std::fs::remove_dir_all(&dir);
});
} }
#[test] #[test]
+15
View File
@@ -10,6 +10,8 @@ extern "C" {
fn uu_login_ui_set_done(text: *const libc::c_char); fn uu_login_ui_set_done(text: *const libc::c_char);
fn uu_login_ui_closed() -> libc::c_int; fn uu_login_ui_closed() -> libc::c_int;
fn uu_login_ui_close(); fn uu_login_ui_close();
fn uu_login_ui_offer_refresh(visible: libc::c_int);
fn uu_login_ui_take_refresh() -> libc::c_int;
} }
#[derive(Clone, Copy)] #[derive(Clone, Copy)]
@@ -56,6 +58,19 @@ impl LoginUi {
} }
#[allow(unused_variables)] #[allow(unused_variables)]
/// Show or hide the 刷新二维码 button (a failed QR waits for the user, like the official client).
pub fn offer_refresh(&self, visible: bool) {
#[cfg(uu_gtk)]
if self.shown { unsafe { uu_login_ui_offer_refresh(libc::c_int::from(visible)) } }
#[cfg(not(uu_gtk))]
let _ = visible;
}
/// The user clicked 刷新二维码 since the last call.
pub fn take_refresh(&self) -> bool {
#[cfg(uu_gtk)]
if self.shown { return unsafe { uu_login_ui_take_refresh() } != 0; }
false
}
pub fn status(&self, text: &str, tone: Tone) { pub fn status(&self, text: &str, tone: Tone) {
#[cfg(uu_gtk)] #[cfg(uu_gtk)]
if self.shown { let t = cstr(text); unsafe { uu_login_ui_set_status(t.as_ptr(), tone as libc::c_int) } } if self.shown { let t = cstr(text); unsafe { uu_login_ui_set_status(t.as_ptr(), tone as libc::c_int) } }
+261 -22
View File
@@ -1,10 +1,12 @@
//! UU Remote Pure Native Linux Server (Rust Edition) //! UU Remote Pure Native Linux Server (Rust Edition)
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated //! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
mod ws_transport;
mod engine_plugin; mod engine_plugin;
mod doctor; mod doctor;
mod wol; mod wol;
mod desktop_backend; mod desktop_backend;
mod desktop_mode;
mod desktop_session; mod desktop_session;
mod desktop_power; mod desktop_power;
mod portal; mod portal;
@@ -29,6 +31,7 @@ mod signaling;
mod terminal; mod terminal;
mod webrtc; mod webrtc;
mod video; mod video;
mod video_select;
mod video_track; mod video_track;
mod locked_video; mod locked_video;
#[cfg(test)] #[cfg(test)]
@@ -71,6 +74,14 @@ fn superseded_peer_ids(sessions: &HashMap<String, WebRtcSession>, ice: &str, des
sessions.iter().filter(|(id, peer)| id.as_str() == ice || (desktop && peer.desktop)) sessions.iter().filter(|(id, peer)| id.as_str() == ice || (desktop && peer.desktop))
.map(|(id, _)| id.clone()).collect() .map(|(id, _)| id.clone()).collect()
} }
/// A peer whose transport is already broken can leave `PeerConnection::close`
/// waiting indefinitely; signaling must keep flowing without it.
async fn close_peer(pc: &::webrtc::peer_connection::RTCPeerConnection) {
if tokio::time::timeout(std::time::Duration::from_secs(5), pc.close()).await.is_err() {
log::warn!("Peer connection close timed out; continuing");
}
}
fn released_peer_ids<T>(sessions: &HashMap<String, T>, ice: Option<&serde_json::Value>) -> Vec<String> { fn released_peer_ids<T>(sessions: &HashMap<String, T>, ice: Option<&serde_json::Value>) -> Vec<String> {
let ice = ice.map(|id| id.as_str().map(str::to_owned).unwrap_or_else(|| id.to_string())); let ice = ice.map(|id| id.as_str().map(str::to_owned).unwrap_or_else(|| id.to_string()));
sessions.keys().filter(|id| ice.as_deref().map_or(true, |ice| id.as_str() == ice)).cloned().collect() sessions.keys().filter(|id| ice.as_deref().map_or(true, |ice| id.as_str() == ice)).cloned().collect()
@@ -126,12 +137,179 @@ fn systemd_unit() -> Option<String> {
cgroup.lines().find_map(|l| l.rsplit('/').next().filter(|u| u.ends_with(".service")).map(str::to_owned)) cgroup.lines().find_map(|l| l.rsplit('/').next().filter(|u| u.ends_with(".service")).map(str::to_owned))
} }
fn display_present() -> bool { std::env::var_os("DISPLAY").is_some() || std::env::var_os("WAYLAND_DISPLAY").is_some() } fn display_present() -> bool { std::env::var_os("DISPLAY").is_some() || std::env::var_os("WAYLAND_DISPLAY").is_some() }
fn set_video_pref() -> Result<(), Box<dyn std::error::Error>> {
let which = std::env::args().nth(1).unwrap_or_default();
let stored = std::env::args().nth(2).unwrap_or_default().trim().to_ascii_lowercase();
let stored = if stored == "hevc" { "h265".to_owned() } else { stored };
if let Err(e) = system_actions::merge_save(|settings| {
if which == "set-encoder" { settings.video_encoder = Some(stored.clone()); }
else { settings.video_codec = Some(stored.clone()); }
}) {
// Exit 2 is reserved for bad CLI input; a settings file that cannot be merged is exit 1.
eprintln!("{which}: {e}");
std::process::exit(1);
}
let selection = video_select::selection();
let codec = match selection.codec_pref { video_select::CodecPref::Auto => "auto", video_select::CodecPref::H264 => "h264", video_select::CodecPref::H265 => "h265" };
println!("encoder={:?} source={} codec_pref={codec} source={}", selection.encoder, video_select::encoder_source_label(selection.encoder_source), video_select::source_label(selection.codec_source));
// Both subcommands wake the host. Encoder changes restart live desktop streams; codec changes are logged only.
match notify_host(libc::SIGUSR2) {
Ok(()) => println!("notified the running host"),
Err(_) => println!(
"host not running, or the running host is not this binary: takes effect the next time a desktop connection starts, or after restarting the service"
),
}
if which == "set-codec" {
println!("takes effect the next time a desktop connection starts");
}
Ok(())
}
/// Signal the host recorded in host.pid only when `/proc/<pid>/exe` is exactly
/// `canonicalize(current_exe())`. A filename match is not enough: an older host
/// has no SIGUSR2 handler, and the default action terminates the process.
/// A replaced binary reads back as `… (deleted)` and does not match.
fn notify_host(signal: i32) -> Result<(), ()> {
let pid = std::fs::read_to_string(host_pid_path())
.ok()
.and_then(|s| s.trim().parse::<i32>().ok())
.filter(|p| *p > 1)
.ok_or(())?;
let exe = std::fs::read_link(format!("/proc/{pid}/exe")).map_err(|_| ())?;
let own = std::fs::canonicalize(std::env::current_exe().map_err(|_| ())?).map_err(|_| ())?;
if !same_host_binary(&exe, &own) {
return Err(());
}
if unsafe { libc::kill(pid, signal) } == 0 {
Ok(())
} else {
Err(())
}
}
/// `/proc/<pid>/exe` must equal the canonical path of this binary. A trailing ` (deleted)` does not match.
fn same_host_binary(proc_exe: &std::path::Path, own: &std::path::Path) -> bool {
proc_exe == own
}
/// Explicit command words for set-encoder / set-codec. Empty and whitespace are illegal.
pub(crate) fn cli_pref_ok(which: &str, value: &str) -> bool {
let value = value.trim();
if value.is_empty() { return false; }
let value = value.to_ascii_lowercase();
match which {
"set-encoder" => matches!(value.as_str(), "auto" | "cpu" | "vaapi" | "nvenc"),
"set-codec" => matches!(value.as_str(), "auto" | "h264" | "h265" | "hevc"),
_ => false,
}
}
const SUBCOMMANDS: [&str; 17] = ["doctor", "show", "assist", "set-encoder", "set-codec", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture",
"wayland-input-probe", "wayland-text-probe", "clipboard-acceptance", "portal-acceptance"];
/// Unknown arguments and illegal set-encoder / set-codec values exit 2 (never start a second host).
/// help / -h / --help exit 0 so main prints usage instead of starting the host.
pub(crate) fn reject_cli(arg: Option<&str>, argc: usize, value_ok: bool) -> Option<i32> {
if matches!(arg, Some("help" | "-h" | "--help")) { return Some(0); }
if arg.is_some_and(|a| !SUBCOMMANDS.contains(&a)) { return Some(2); }
if matches!(arg, Some("set-encoder" | "set-codec")) && (argc != 3 || !value_ok) { return Some(2); }
None
}
#[cfg(test)]
mod cli_exit_tests {
#[test]
fn unknown_and_illegal_subcommand_exit_2() {
assert_eq!(super::reject_cli(Some("not-a-command"), 2, true), Some(2));
assert_eq!(super::reject_cli(Some("set-encoder"), 3, false), Some(2));
assert_eq!(super::reject_cli(Some("set-encoder"), 2, true), Some(2));
assert_eq!(super::reject_cli(Some("set-codec"), 4, true), Some(2));
assert_eq!(super::reject_cli(Some("set-encoder"), 3, true), None);
assert_eq!(super::reject_cli(Some("set-codec"), 3, true), None);
assert_eq!(super::reject_cli(Some("help"), 2, true), Some(0));
assert_eq!(super::reject_cli(Some("-h"), 2, true), Some(0));
assert_eq!(super::reject_cli(Some("--help"), 2, true), Some(0));
assert_eq!(super::reject_cli(None, 1, true), None);
assert!(!super::cli_pref_ok("set-encoder", ""));
assert!(!super::cli_pref_ok("set-encoder", " "));
assert!(!super::cli_pref_ok("set-codec", ""));
assert!(!super::cli_pref_ok("set-codec", "\t"));
assert!(!super::cli_pref_ok("set-encoder", "bogus"));
assert!(super::cli_pref_ok("set-encoder", " NVENC "));
assert!(super::cli_pref_ok("set-codec", "hevc"));
assert_eq!(super::reject_cli(Some("set-encoder"), 3, super::cli_pref_ok("set-encoder", "")), Some(2));
assert_eq!(super::reject_cli(Some("set-codec"), 3, super::cli_pref_ok("set-codec", " ")), Some(2));
}
/// SIGUSR1 and SIGUSR2 are installed with no assist UI. `host.pid` is written only after both exist.
#[test]
fn signal_handlers_install_without_assist() {
let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().unwrap();
rt.block_on(async {
let _guard = crate::config::test_env_lock().lock().unwrap();
let dir =
std::env::temp_dir().join(format!("uuremote-signal-test-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::env::set_var("UU_CONFIG", dir.join("config.json"));
assert!(super::install_host_signals(None));
let pid = std::fs::read_to_string(super::host_pid_path()).unwrap();
assert_eq!(pid.trim(), std::process::id().to_string());
std::env::remove_var("UU_CONFIG");
let _ = std::fs::remove_dir_all(&dir);
});
}
#[test]
fn sigusr2_requires_the_same_canonical_binary() {
let own = std::path::Path::new("/home/user/.local/bin/uuremote-server");
assert!(super::same_host_binary(own, own));
assert!(!super::same_host_binary(
std::path::Path::new("/tmp/unpack/uuremote-server"),
own
));
assert!(!super::same_host_binary(
std::path::Path::new("/home/user/.local/bin/uuremote-server (deleted)"),
own
));
}
}
/// SIGUSR1 (`uuremote-server show`) opens the host window. /// SIGUSR1 (`uuremote-server show`) opens the host window.
fn present_on_usr1(ui: std::sync::Arc<assist::LocalUi>) { /// SIGUSR2 (set-encoder, set-codec, or `kill -USR2`) re-reads host_settings. Encoder changes switch live desktop streams; codec changes are logged for the next connection.
// Install the handler before publishing the pid: SIGUSR1's default action terminates the process. /// The default action of either signal terminates the process, so both handlers are installed before `host.pid` is written.
let Ok(mut usr1) = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::user_defined1()) else { return }; /// SIGUSR2 is independent of remote assistance: `UU_REMOTE_ASSIST=0` and a failed assist setup still switch live encoders.
/// SIGUSR1 is installed first as a no-op so `show` cannot terminate a host that has no assist window yet.
fn install_host_signals(ui: Option<std::sync::Arc<assist::LocalUi>>) -> bool {
static USR1: std::sync::Once = std::sync::Once::new();
static USR2: std::sync::Once = std::sync::Once::new();
let mut usr1_ok = true;
USR1.call_once(|| {
match tokio::signal::unix::signal(tokio::signal::unix::SignalKind::user_defined1()) {
Ok(mut usr1) => { tokio::spawn(async move { while usr1.recv().await.is_some() {} }); }
Err(_) => usr1_ok = false,
}
});
if !usr1_ok { return false; }
let mut usr2_ok = true;
USR2.call_once(|| {
match tokio::signal::unix::signal(tokio::signal::unix::SignalKind::user_defined2()) {
Ok(mut usr2) => { tokio::spawn(async move { while usr2.recv().await.is_some() { crate::video_select::publish_reload(); } }); }
Err(_) => usr2_ok = false,
}
});
if !usr2_ok { return false; }
// Assist attaches later and replaces the no-op with the window. A second registration replaces the first.
if let Some(ui) = ui {
if let Ok(mut usr1) = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::user_defined1()) {
tokio::spawn(async move { while usr1.recv().await.is_some() { ui.present(); } });
}
}
write_host_pid(); write_host_pid();
tokio::spawn(async move { while usr1.recv().await.is_some() { ui.present(); } }); true
}
fn present_on_usr1(ui: std::sync::Arc<assist::LocalUi>) {
let _ = install_host_signals(Some(ui));
} }
fn host_pid_path() -> std::path::PathBuf { config::path().with_file_name("host.pid") } fn host_pid_path() -> std::path::PathBuf { config::path().with_file_name("host.pid") }
@@ -139,7 +317,9 @@ fn host_pid_path() -> std::path::PathBuf { config::path().with_file_name("host.p
fn write_host_pid() { fn write_host_pid() {
use std::os::unix::fs::OpenOptionsExt; use std::os::unix::fs::OpenOptionsExt;
use std::io::Write; use std::io::Write;
if let Ok(mut f) = std::fs::OpenOptions::new().write(true).create(true).truncate(true).mode(0o600).open(host_pid_path()) { let path = host_pid_path();
if let Some(dir) = path.parent() { let _ = std::fs::create_dir_all(dir); }
if let Ok(mut f) = std::fs::OpenOptions::new().write(true).create(true).truncate(true).mode(0o600).open(path) {
let _ = write!(f, "{}", std::process::id()); let _ = write!(f, "{}", std::process::id());
} }
} }
@@ -225,16 +405,20 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
.filter_module("uuremote_server", log::LevelFilter::Info).init(); .filter_module("uuremote_server", log::LevelFilter::Info).init();
} else { env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); } } else { env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); }
// An unknown argument must never fall through to starting a second full host server. // An unknown argument must never fall through to starting a second full host server.
const SUBCOMMANDS: [&str; 15] = ["doctor", "show", "assist", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture", let arg1 = std::env::args().nth(1);
"wayland-input-probe", "wayland-text-probe", "clipboard-acceptance", "portal-acceptance"]; let value_ok = match arg1.as_deref() {
if let Some(arg) = std::env::args().nth(1).filter(|a| !SUBCOMMANDS.contains(&a.as_str())) { Some(which @ ("set-encoder" | "set-codec")) => cli_pref_ok(which, &std::env::args().nth(2).unwrap_or_default()),
_ => true,
};
if let Some(code) = reject_cli(arg1.as_deref(), std::env::args().len(), value_ok) {
let usage = format!("usage: uuremote-server [{}]\n (no argument: run the host)", SUBCOMMANDS.join(" | ")); let usage = format!("usage: uuremote-server [{}]\n (no argument: run the host)", SUBCOMMANDS.join(" | "));
if matches!(arg.as_str(), "help" | "-h" | "--help") { println!("{usage}"); return Ok(()); } if code == 0 { println!("{usage}"); return Ok(()); }
eprintln!("unknown argument\n{usage}"); eprintln!("unknown argument\n{usage}");
std::process::exit(2); std::process::exit(code);
} }
if std::env::args().nth(1).as_deref() == Some("show") { return show_running_host(); } if std::env::args().nth(1).as_deref() == Some("show") { return show_running_host(); }
if matches!(std::env::args().nth(1).as_deref(), Some("set-encoder") | Some("set-codec")) { return set_video_pref(); }
if assist_enabled && !unified { if assist_enabled && !unified {
if std::env::args().len() > 2 { return Err("assist accepts no additional arguments; configure it with a private UU_CONFIG".into()); } if std::env::args().len() > 2 { return Err("assist accepts no additional arguments; configure it with a private UU_CONFIG".into()); }
assist::configure()?; assist::configure()?;
@@ -446,6 +630,11 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
virtual_audio::init(); virtual_audio::init();
let _audio_cleanup=virtual_audio::Cleanup; let _audio_cleanup=virtual_audio::Cleanup;
log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION")); log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION"));
session_ice::configure_relay_transport();
// Before host.pid, and before assist: a missing or failed assist session must still handle SIGUSR2.
let _ = install_host_signals(None);
video::warm_auto_probe();
video::check_ffmpeg_usable();
if !desktop_backend::headless() && desktop_backend::detect()? == desktop_backend::DesktopBackend::X11 && desktop_backend::wayland_session_running() { if !desktop_backend::headless() && desktop_backend::detect()? == desktop_backend::DesktopBackend::X11 && desktop_backend::wayland_session_running() {
// X11 capture inside a Wayland session reads XWayland's root window: all black, no error (#61). // X11 capture inside a Wayland session reads XWayland's root window: all black, no error (#61).
@@ -506,7 +695,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
if let Some(task) = command_task { task.abort(); } if let Some(task) = command_task { task.abort(); }
// One exit path for commands, signals, transport failures and UI failures. // One exit path for commands, signals, transport failures and UI failures.
if let Some(session) = assist.as_mut() { session.allowed = false; } if let Some(session) = assist.as_mut() { session.allowed = false; }
for (_, old) in webrtc_sessions.lock().await.drain() { let _ = old.pc.close().await; } for (_, old) in webrtc_sessions.lock().await.drain() { close_peer(&old.pc).await; }
virtual_audio::disable(); input.shutdown(); terminal::shutdown_all(); virtual_audio::disable(); input.shutdown(); terminal::shutdown_all();
// Switching identity (signed in / out) restarts at once and the new identity republishes the same // Switching identity (signed in / out) restarts at once and the new identity republishes the same
// device share: logout already withdrew it, and after a QR login the cloud moved it to the account // device share: logout already withdrew it, and after a QR login the cloud moved it to the account
@@ -558,6 +747,8 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
let mut capture_types: HashMap<String, (u64,crate::session_ice::SessionIce)> = HashMap::new(); let mut capture_types: HashMap<String, (u64,crate::session_ice::SessionIce)> = HashMap::new();
let mut mac_by_ice: HashMap<String, bool> = HashMap::new(); let mut mac_by_ice: HashMap<String, bool> = HashMap::new();
let mut next_mac = false; let mut next_mac = false;
// Tool peers ask here to become the desktop (capture_desktop on an existing connection, #99).
let (desktop_requests, mut desktop_requested) = mpsc::unbounded_channel::<String>();
loop { loop {
if *shutdown.borrow() { if *shutdown.borrow() {
@@ -642,6 +833,7 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
_ = shutdown.changed() => Some(SignalingEvent::Stop), _ = shutdown.changed() => Some(SignalingEvent::Stop),
command = commands.recv(), if assist.is_some() => Some(SignalingEvent::AssistCommand(command.unwrap_or(assist::Command::Stop))), command = commands.recv(), if assist.is_some() => Some(SignalingEvent::AssistCommand(command.unwrap_or(assist::Command::Stop))),
_ = assist_tick.tick(), if assist.is_some() => Some(SignalingEvent::AssistTick), _ = assist_tick.tick(), if assist.is_some() => Some(SignalingEvent::AssistTick),
Some(ice) = desktop_requested.recv() => Some(SignalingEvent::DesktopRequested(ice)),
event = rx_event.recv() => event, event = rx_event.recv() => event,
}; };
let Some(evt) = event else { break; }; let Some(evt) = event else { break; };
@@ -676,8 +868,8 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Closed | ::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Closed |
::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Failed)).map(|(id, _)| id.clone()).collect(); ::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Failed)).map(|(id, _)| id.clone()).collect();
let mut desktop_ended = false; let mut desktop_ended = false;
for id in ended { if let Some(s) = sessions.remove(&id) { desktop_ended |= s.desktop; let _ = s.pc.close().await; } } for id in ended { if let Some(s) = sessions.remove(&id) { desktop_ended |= s.role.is_desktop(); close_peer(&s.pc).await; } }
if desktop_ended && !sessions.values().any(|s| s.desktop) { if let Some(s) = assist.as_mut() { s.session_ended()?; } } if desktop_ended && !sessions.values().any(|s| s.role.is_desktop()) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
if let Some(s) = assist.as_mut() { s.tick()?; } if let Some(s) = assist.as_mut() { s.tick()?; }
} }
SignalingEvent::Connected => { SignalingEvent::Connected => {
@@ -764,8 +956,8 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Closed | ::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Closed |
::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Failed)).map(|(k, _)| k.clone()).collect(); ::webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState::Failed)).map(|(k, _)| k.clone()).collect();
let mut desktop_ended = false; let mut desktop_ended = false;
for k in ended { if let Some(old) = sessions.remove(&k) { desktop_ended |= old.desktop; let _ = old.pc.close().await; } } for k in ended { if let Some(old) = sessions.remove(&k) { desktop_ended |= old.role.is_desktop(); close_peer(&old.pc).await; } }
if desktop_ended && !sessions.values().any(|s| s.desktop) { if let Some(s) = assist.as_mut() { s.session_ended()?; } } if desktop_ended && !sessions.values().any(|s| s.role.is_desktop()) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
if let Some(s) = assist.as_mut() { s.tick()?; } if let Some(s) = assist.as_mut() { s.tick()?; }
if soac.msg_type == "offer" { if soac.msg_type == "offer" {
@@ -775,16 +967,21 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
let controller_mac = mac_by_ice.remove(&ice).unwrap_or(next_mac); let controller_mac = mac_by_ice.remove(&ice).unwrap_or(next_mac);
if desktop { input.set_mac_controller(controller_mac); } if desktop { input.set_mac_controller(controller_mac); }
log::info!("Offer for connection: capture_type={} desktop={} active_peers={}", capture_type, desktop, sessions.len()); log::info!("Offer for connection: capture_type={} desktop={} active_peers={}", capture_type, desktop, sessions.len());
// An expired NVENC failure is re-probed in the background. This offer keeps the cached encoder.
if desktop { video::warm_auto_probe(); video::check_ffmpeg_usable(); }
// Replace only this ICE id or a previous desktop, never tool peers. // Replace only this ICE id or a previous desktop, never tool peers.
for id in superseded_peer_ids(&sessions, &ice, desktop) { for id in superseded_peer_ids(&sessions, &ice, desktop) {
if let Some(old) = sessions.remove(&id) { let _ = old.pc.close().await; } if let Some(old) = sessions.remove(&id) { close_peer(&old.pc).await; }
} }
// A tool peer promoted by capture_desktop stops its desktop but keeps its tools.
if desktop { for old in sessions.values() { old.demote(); } }
if desktop && desktop_backend::headless() { if desktop && desktop_backend::headless() {
log::info!("Desktop connection ignored: headless mode (terminal, file transfer and port mapping remain available)"); log::info!("Desktop connection ignored: headless mode (terminal, file transfer and port mapping remain available)");
continue; continue;
} }
let resized=desktop && capture.init_error.is_none() && capture.backend==desktop_backend::DesktopBackend::X11 let resized=desktop && capture.init_error.is_none() && capture.backend==desktop_backend::DesktopBackend::X11
&& tokio::task::spawn_blocking(crate::capture::x11_resized).await.unwrap_or(false); // Compare with this capture, not the engine: a live stream may already have refreshed it.
&& tokio::task::spawn_blocking(crate::capture::x11_size).await.ok().flatten().is_some_and(|size| size!=(capture.width,capture.height));
if resized { log::info!("Desktop geometry changed since startup; reinitializing capture"); } if resized { log::info!("Desktop geometry changed since startup; reinitializing capture"); }
let session_capture=if desktop && portal_desktop.is_none() && (capture.init_error.is_some() || resized) { let session_capture=if desktop && portal_desktop.is_none() && (capture.init_error.is_some() || resized) {
match tokio::task::spawn_blocking(ScreenCapture::new).await { match tokio::task::spawn_blocking(ScreenCapture::new).await {
@@ -799,7 +996,12 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
if desktop { if let Some(portal) = &portal_desktop { portal.begin(); } } if desktop { if let Some(portal) = &portal_desktop { portal.begin(); } }
match WebRtcSession::new(session_capture, input.clone(), signaling_client.clone(), desktop, transport, match WebRtcSession::new(session_capture, input.clone(), signaling_client.clone(), desktop, transport,
if desktop { portal_desktop.clone() } else { None }).await { if desktop { portal_desktop.clone() } else { None }).await {
Ok(sess) => { Ok(mut sess) => {
sess.controller_mac = controller_mac;
if !desktop {
let (requests, peer) = (desktop_requests.clone(), ice.clone());
sess.on_desktop_request(move || { let _ = requests.send(peer.clone()); });
}
// Register before awaiting SDP: shutdown can always close // Register before awaiting SDP: shutdown can always close
// a peer whose answer may already be queued to the viewer. // a peer whose answer may already be queued to the viewer.
sessions.insert(ice.clone(), sess); sessions.insert(ice.clone(), sess);
@@ -822,7 +1024,7 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
} }
Err(_) => { Err(_) => {
log::error!("Failed to handle offer (details omitted)"); log::error!("Failed to handle offer (details omitted)");
if let Some(session) = sessions.remove(&ice) { let _ = session.pc.close().await; } if let Some(session) = sessions.remove(&ice) { close_peer(&session.pc).await; }
} }
}}, }},
Err(_) => log::error!("Create peer failed (details omitted)"), Err(_) => log::error!("Create peer failed (details omitted)"),
@@ -844,13 +1046,50 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
let mut desktop_ended = false; let mut desktop_ended = false;
for k in targets { for k in targets {
if let Some(old) = sessions.remove(&k) { if let Some(old) = sessions.remove(&k) {
desktop_ended |= old.desktop; desktop_ended |= old.role.is_desktop();
if let Err(e) = old.pc.close().await { log::warn!("Close released peer failed: {}", e); } close_peer(&old.pc).await;
} }
} }
if desktop_ended && !sessions.values().any(|s| s.desktop) { if let Some(s) = assist.as_mut() { s.session_ended()?; } } if desktop_ended && !sessions.values().any(|s| s.role.is_desktop()) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
if let Some(s) = assist.as_mut() { s.tick()?; } if let Some(s) = assist.as_mut() { s.tick()?; }
} }
SignalingEvent::DesktopRequested(ice) => {
let mut sessions = webrtc_sessions.lock().await;
let Some(peer) = sessions.get(&ice).filter(|peer| !peer.role.is_desktop()) else { continue; };
if desktop_backend::headless() {
log::info!("Desktop request on a tool connection ignored: headless mode");
continue;
}
if portal_desktop.is_some() {
log::info!("Desktop request on a tool connection not supported with the Portal backend; open the desktop before port mapping");
continue;
}
let controller_mac = peer.controller_mac;
let current = peer.desktop_capture();
// Same recovery as a desktop offer: the display may have come up or been resized after this peer.
let resized = current.init_error.is_none() && current.backend == desktop_backend::DesktopBackend::X11
&& tokio::task::spawn_blocking(crate::capture::x11_size).await.ok().flatten().is_some_and(|size| size != (current.width, current.height));
if resized { log::info!("Desktop geometry changed since this connection opened; reinitializing capture"); }
let screen = if current.init_error.is_some() || resized {
match tokio::task::spawn_blocking(ScreenCapture::new).await {
Ok(Ok(screen)) => { capture = Arc::new(screen); Some(capture.clone()) },
Ok(Err(error)) => { log::info!("Desktop request on a tool connection ignored: {error}"); continue; },
Err(_) => { log::warn!("Desktop initialization worker failed"); continue; },
}
} else { None };
video::warm_auto_probe(); video::check_ffmpeg_usable();
input.set_mac_controller(controller_mac);
input.bind_portal(screen.as_ref().map_or_else(|| sessions[&ice].capture.portal.clone(), |screen| screen.portal.clone()));
// One desktop at a time, as for a new desktop offer. Peers offered as desktops
// close; a promoted tool peer only stops its desktop and keeps its tools.
let superseded: Vec<String> = sessions.iter().filter(|(id, old)| id.as_str() != ice && old.role.is_desktop())
.map(|(id, _)| id.clone()).collect();
for id in superseded {
if sessions[&id].desktop { if let Some(old) = sessions.remove(&id) { close_peer(&old.pc).await; } }
else { sessions[&id].demote(); }
}
if let Some(peer) = sessions.get(&ice) { peer.promote(screen); }
}
SignalingEvent::Disconnected => { SignalingEvent::Disconnected => {
capture_types.clear(); capture_types.clear();
next_capture_type=None; next_capture_type=None;
+75
View File
@@ -56,6 +56,31 @@ impl SessionIce {
} }
} }
/// With `UU_USE_PROXY=1`, also gather TURN relays over TCP/TLS (through the HTTP proxy when
/// one is configured); hosts whose UDP cannot reach the TURN servers then still get a relay.
pub fn configure_relay_transport() {
if !crate::auth::proxy_enabled() { return; }
let value = ["HTTPS_PROXY", "https_proxy", "ALL_PROXY", "all_proxy"].iter().find_map(|name| std::env::var(name).ok()).filter(|v| !v.is_empty());
let proxy = match value.as_deref().map(relay_proxy) {
Some(Ok(proxy)) => Some(proxy),
Some(Err(reason)) => { log::warn!("TURN over TCP/TLS disabled: {reason}"); return; }
None => None,
};
log::info!("TURN over TCP/TLS enabled: via_http_proxy={}", proxy.is_some());
webrtc::ice::agent::turn_tcp::set_relay_transport(webrtc::ice::agent::turn_tcp::RelayTransport { http_proxy: proxy });
}
/// `host:port` of an unauthenticated HTTP proxy URL; never echoes the value.
fn relay_proxy(value: &str) -> Result<String, &'static str> {
let url = reqwest::Url::parse(&if value.contains("://") { value.to_owned() } else { format!("http://{value}") })
.map_err(|_| "invalid proxy URL")?;
if url.scheme() != "http" { return Err("only http:// proxies are supported for TURN"); }
if !url.username().is_empty() || url.password().is_some() { return Err("proxy authentication is not supported for TURN"); }
let host = url.host_str().ok_or("invalid proxy URL")?;
let port = url.port_or_known_default().ok_or("invalid proxy URL")?;
Ok(format!("{host}:{port}")) // host_str() keeps IPv6 brackets
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
@@ -74,4 +99,54 @@ mod tests {
assert_eq!(config.ice_servers.len(),1); assert_eq!(config.ice_servers.len(),1);
assert!(config.ice_servers[0].urls.iter().all(|s|s.starts_with("stun:"))); assert!(config.ice_servers[0].urls.iter().all(|s|s.starts_with("stun:")));
} }
#[test]
fn relay_proxy_accepts_plain_http_only() {
assert_eq!(super::relay_proxy("http://proxy.invalid:8889").unwrap(), "proxy.invalid:8889");
assert_eq!(super::relay_proxy("proxy.invalid:8889/").unwrap(), "proxy.invalid:8889");
assert_eq!(super::relay_proxy("http://[::1]:3128").unwrap(), "[::1]:3128");
for bad in ["socks5://proxy.invalid:1080", "https://proxy.invalid:443", "http://user:[email protected]:8889", "::"] {
assert!(super::relay_proxy(bad).is_err());
}
}
#[test]
fn turn_tcp_frames_stun_and_padded_channel_data() {
use webrtc::ice::agent::turn_tcp::frame_len;
assert_eq!(frame_len([0x01, 0x01, 0x00, 0x08]), Some(28));
assert_eq!(frame_len([0x40, 0x00, 0x00, 0x05]), Some(12));
assert_eq!(frame_len([0x40, 0x00, 0x00, 0x08]), Some(12));
assert_eq!(frame_len([0x80, 0x00, 0x00, 0x00]), None);
}
#[tokio::test]
async fn turn_tcp_connects_through_the_proxy_and_frames_the_stream() {
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use webrtc::ice::agent::turn_tcp::{dial, set_relay_transport, RelayTransport};
use webrtc::util::Conn;
let proxy = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy_addr = proxy.local_addr().unwrap();
let server = tokio::spawn(async move {
let (mut socket, _) = proxy.accept().await.unwrap();
let mut head = Vec::new();
while !head.ends_with(b"\r\n\r\n") { let mut b = [0u8; 1]; socket.read_exact(&mut b).await.unwrap(); head.push(b[0]); }
assert!(String::from_utf8_lossy(&head).starts_with("CONNECT 192.0.2.1:2483 HTTP/1.1\r\n"));
socket.write_all(b"HTTP/1.1 200 Connection established\r\n\r\n").await.unwrap();
let mut frames = [0u8; 20 + 12];
socket.read_exact(&mut frames).await.unwrap();
socket.write_all(&frames).await.unwrap();
});
set_relay_transport(RelayTransport { http_proxy: Some(proxy_addr.to_string()) });
let target: std::net::SocketAddr = "192.0.2.1:2483".parse().unwrap();
let conn = dial("192.0.2.1", 2483, target, false).await.unwrap();
let mut stun = [0u8; 20]; stun[1] = 0x01;
let channel = [0x40, 0x00, 0x00, 0x05, 1, 2, 3, 4, 5, 0, 0, 0];
conn.send_to(&stun, target).await.unwrap();
conn.send_to(&channel, target).await.unwrap();
let mut buf = [0u8; 64];
assert_eq!(conn.recv_from(&mut buf).await.unwrap(), (20, target));
assert_eq!(conn.recv_from(&mut buf).await.unwrap(), (12, target));
assert_eq!(&buf[..12], &channel);
server.await.unwrap();
}
} }
+193 -41
View File
@@ -3,12 +3,22 @@
use futures_util::{SinkExt, StreamExt}; use futures_util::{SinkExt, StreamExt};
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use serde_json::Value; use serde_json::Value;
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::Arc; use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::sync::mpsc; use tokio::sync::mpsc;
use tokio_tungstenite::connect_async;
use tokio_tungstenite::tungstenite::client::IntoClientRequest; use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::Message; use tokio_tungstenite::tungstenite::Message;
/// A peer that stops reading must not park the heartbeat loop on a full queue.
/// Kept below the Engine.IO window so the protocol deadline still fires.
const SEND_STALL_TIMEOUT: Duration = Duration::from_secs(10);
// DNS/TCP/TLS/WebSocket upgrade must finish in bounded time: after a network
// change the handshake can stall forever and the reconnect loop never retries.
const CONNECT_TIMEOUT: Duration = Duration::from_secs(20);
/// How often the watchdog checks the last inbound frame.
const WATCHDOG_TICK: Duration = Duration::from_secs(1);
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SoacMessage { pub struct SoacMessage {
#[serde(rename = "type")] #[serde(rename = "type")]
@@ -46,6 +56,8 @@ pub enum SignalingEvent {
Released(Value), Released(Value),
Left(Value), Left(Value),
Disconnected, Disconnected,
/// capture_desktop on this tool peer (ice_id); raised by the peer, not by signaling.
DesktopRequested(String),
} }
pub struct SignalingClient { pub struct SignalingClient {
@@ -68,6 +80,11 @@ fn refreshed_key(ack:&Value)->Option<String> {
(!key.is_empty() && key.len()<=16384).then(||key.to_owned()) (!key.is_empty() && key.len()<=16384).then(||key.to_owned())
} }
/// Deliver an event without letting a stalled consumer hide a dead socket.
async fn send_event(sender: &mpsc::Sender<SignalingEvent>, event: SignalingEvent) -> bool {
matches!(tokio::time::timeout(SEND_STALL_TIMEOUT, sender.send(event)).await, Ok(Ok(())))
}
#[cfg(test)] #[cfg(test)]
mod refresh_tests { mod refresh_tests {
use super::refreshed_key; use super::refreshed_key;
@@ -126,6 +143,95 @@ mod refresh_tests {
assert!(disconnected.is_ok(),"a socket without pings must be reported dead"); assert!(disconnected.is_ok(),"a socket without pings must be reported dead");
drop(hold_tx); drop(hold_tx);
} }
#[tokio::test]
async fn blocked_event_consumer_does_not_hide_a_dead_socket() {
use futures_util::{SinkExt,StreamExt};
use tokio_tungstenite::tungstenite::Message;
let listener=tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let address=listener.local_addr().unwrap();
let (closed_tx,closed_rx)=tokio::sync::oneshot::channel::<()>();
tokio::spawn(async move {
let (tcp,_)=listener.accept().await.unwrap();
let socket=tokio_tungstenite::accept_async(tcp).await.unwrap();
let (mut sink,mut stream)=socket.split();
// Shortest accepted window (clamped to 5 s); never ping, only events.
sink.send(Message::Text(r#"0{"pingInterval":1000,"pingTimeout":1000}"#.into())).await.unwrap();
let _=stream.next().await;
sink.send(Message::Text("40{}".into())).await.unwrap();
loop {
tokio::select! {
r=stream.next()=>match r {
None|Some(Err(_))|Some(Ok(Message::Close(_)))=>{let _=closed_tx.send(());return;}
_=>{}
},
_=tokio::time::sleep(std::time::Duration::from_millis(50))=>{
if sink.send(Message::Text(r#"42["bmsg_push",{}]"#.into())).await.is_err() {
let _=closed_tx.send(());return;
}
}
}
}
});
// Capacity 1 and no reader: the first event fills the queue, so the
// receive loop would park inside `send().await` without the watchdog.
let (sender,_events)=tokio::sync::mpsc::channel(1);
let _client=super::SignalingClient::connect(&format!("ws://{address}"),"synthetic-only",sender).await.unwrap();
let closed=tokio::time::timeout(std::time::Duration::from_secs(15),closed_rx).await;
assert!(closed.is_ok(),"a blocked consumer must not keep a dead signaling socket open");
}
#[tokio::test]
async fn stalled_handshake_times_out() {
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
// Accepts TCP but never answers the upgrade, like a stalled path after a network change.
let listener=tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let address=listener.local_addr().unwrap();
tokio::spawn(async move {
let (_tcp,_)=listener.accept().await.unwrap();
tokio::time::sleep(std::time::Duration::from_secs(30)).await;
});
let req=format!("ws://{address}/socket.io/").into_client_request().unwrap();
let result=tokio::time::timeout(std::time::Duration::from_secs(5),super::open_socket(req,std::time::Duration::from_secs(1))).await;
assert!(matches!(result,Ok(Err(_))),"a stalled handshake must fail within the connect timeout");
}
#[tokio::test]
async fn stalled_event_delivery_still_reports_disconnected() {
use futures_util::{SinkExt,StreamExt};
use tokio_tungstenite::tungstenite::Message;
let listener=tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let address=listener.local_addr().unwrap();
tokio::spawn(async move {
let (tcp,_)=listener.accept().await.unwrap();
let socket=tokio_tungstenite::accept_async(tcp).await.unwrap();
let (mut sink,mut stream)=socket.split();
// A long window: the send stall must fire before the heartbeat deadline.
sink.send(Message::Text(r#"0{"pingInterval":30000,"pingTimeout":30000}"#.into())).await.unwrap();
let _=stream.next().await;
sink.send(Message::Text("40{}".into())).await.unwrap();
loop {
tokio::select! {
r=stream.next()=>{ if matches!(r,None|Some(Err(_))|Some(Ok(Message::Close(_)))){return} }
_=tokio::time::sleep(std::time::Duration::from_millis(50))=>{
if sink.send(Message::Text(r#"42["bmsg_push",{}]"#.into())).await.is_err(){return}
}
}
}
});
let (sender,mut events)=tokio::sync::mpsc::channel(1);
let _client=super::SignalingClient::connect(&format!("ws://{address}"),"synthetic-only",sender).await.unwrap();
// Let SEND_STALL_TIMEOUT expire while nothing drains the queue.
tokio::time::sleep(std::time::Duration::from_secs(12)).await;
assert!(matches!(events.recv().await,Some(super::SignalingEvent::Connected)));
let disconnected=tokio::time::timeout(std::time::Duration::from_secs(5),events.recv()).await;
assert!(matches!(disconnected,Ok(Some(super::SignalingEvent::Disconnected))),"a stalled delivery must still report Disconnected");
}
}
async fn open_socket(
req: tokio_tungstenite::tungstenite::handshake::client::Request,
limit: Duration,
) -> Result<crate::ws_transport::Socket, String> {
crate::ws_transport::connect(req, limit).await
} }
impl SignalingClient { impl SignalingClient {
@@ -149,24 +255,30 @@ impl SignalingClient {
room_token.parse().map_err(|_| "Invalid token header")?, room_token.parse().map_err(|_| "Invalid token header")?,
); );
let (ws_stream, _) = connect_async(req) let ws_stream = open_socket(req, CONNECT_TIMEOUT).await?;
.await
.map_err(|e| format!("WS connect failed: {}", e))?;
log::info!("Connected to Engine.IO / Socket.IO"); log::info!("Connected to Engine.IO / Socket.IO");
let (mut write, mut read) = ws_stream.split(); let (mut write, mut read) = ws_stream.split();
let (tx_outgoing, mut rx_outgoing) = mpsc::channel::<String>(32); let (tx_outgoing, mut rx_outgoing) = mpsc::channel::<String>(32);
let started = Instant::now();
let last_rx = Arc::new(AtomicU64::new(0));
let ping_window_ms = Arc::new(AtomicU64::new(45_000));
let receiver_done = Arc::new(AtomicBool::new(false));
// 发送协程 // 发送协程
let writer=tokio::spawn(async move { let writer=tokio::spawn(async move {
while let Some(msg) = rx_outgoing.recv().await { while let Some(msg) = rx_outgoing.recv().await {
if let Err(e) = write.send(Message::Text(msg)).await { match tokio::time::timeout(SEND_STALL_TIMEOUT, write.send(Message::Text(msg))).await {
let _ = e; Ok(Ok(())) => {}
log::warn!("WS send failed (details omitted)"); Ok(Err(_)) | Err(_) => {
break; // A peer that stopped reading must not park every producer.
log::warn!("WS send failed or stalled (details omitted)");
break;
}
} }
} }
}); });
let writer_abort = writer.abort_handle();
let tx_out_clone = tx_outgoing.clone(); let tx_out_clone = tx_outgoing.clone();
static GENERATION: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(1); static GENERATION: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(1);
@@ -175,9 +287,12 @@ impl SignalingClient {
let refreshed=reconnect_key.clone(); let refreshed=reconnect_key.clone();
// 接收与状态机协程 // 接收与状态机协程
tokio::spawn(async move { let watchdog_events = event_sender.clone();
let watchdog_last_rx = last_rx.clone();
let watchdog_ping_window_ms = ping_window_ms.clone();
let watchdog_done = receiver_done.clone();
let receiver = tokio::spawn(async move {
let mut req_counter = 10; let mut req_counter = 10;
let started=std::time::Instant::now();
let mut last_ping=started; let mut last_ping=started;
let mut pings=0u64; let mut pings=0u64;
let mut pong_queued=0u64; let mut pong_queued=0u64;
@@ -200,7 +315,7 @@ impl SignalingClient {
_=event_sender.closed()=>break, _=event_sender.closed()=>break,
_=tokio::time::sleep_until(ping_deadline) => { _=tokio::time::sleep_until(ping_deadline) => {
log::warn!("Signaling heartbeat lost: generation={} age_s={} pings={} last_ping_gap_s={}",generation,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs()); log::warn!("Signaling heartbeat lost: generation={} age_s={} pings={} last_ping_gap_s={}",generation,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs());
let _ = event_sender.send(SignalingEvent::Disconnected).await; let _ = send_event(&event_sender, SignalingEvent::Disconnected).await;
break; break;
}, },
// Official ControlledSession RefreshSignalTokenLoop: first // Official ControlledSession RefreshSignalTokenLoop: first
@@ -211,8 +326,8 @@ impl SignalingClient {
refresh_acks.push_back(req_counter); refresh_acks.push_back(req_counter);
if refresh_acks.len()>16 { refresh_acks.pop_front(); } if refresh_acks.len()>16 { refresh_acks.pop_front(); }
let packet=format!("42{}[\"refresh_reconnect_key\"]",req_counter); let packet=format!("42{}[\"refresh_reconnect_key\"]",req_counter);
if tx_out_clone.send(packet).await.is_err() { if tx_out_clone.try_send(packet).is_err() {
let _=event_sender.send(SignalingEvent::Disconnected).await;break; let _=send_event(&event_sender, SignalingEvent::Disconnected).await;break;
} }
next_refresh=tokio::time::Instant::now()+std::time::Duration::from_secs(30); next_refresh=tokio::time::Instant::now()+std::time::Duration::from_secs(30);
log::info!("Signaling reconnect-key refresh requested: generation={} age_s={}",generation,started.elapsed().as_secs()); log::info!("Signaling reconnect-key refresh requested: generation={} age_s={}",generation,started.elapsed().as_secs());
@@ -220,9 +335,14 @@ impl SignalingClient {
}, },
msg=read.next()=>match msg { msg=read.next()=>match msg {
Some(msg)=>msg, Some(msg)=>msg,
None=>{let _=event_sender.send(SignalingEvent::Disconnected).await;break;} None=>{let _=send_event(&event_sender, SignalingEvent::Disconnected).await;break;}
}, },
}; };
// Any inbound frame proves the socket is alive. A reader parked on
// event delivery stops updating this, which the watchdog catches.
if msg_res.is_ok() {
last_rx.store(started.elapsed().as_millis() as u64, Ordering::Relaxed);
}
match msg_res { match msg_res {
Ok(Message::Text(txt)) => { Ok(Message::Text(txt)) => {
// Engine.IO 报文处理 // Engine.IO 报文处理
@@ -231,16 +351,20 @@ impl SignalingClient {
log::info!("Signaling heartbeat config: generation={} ping_interval_ms={:?} ping_timeout_ms={:?}",generation,open.get("pingInterval").and_then(Value::as_u64),open.get("pingTimeout").and_then(Value::as_u64)); log::info!("Signaling heartbeat config: generation={} ping_interval_ms={:?} ping_timeout_ms={:?}",generation,open.get("pingInterval").and_then(Value::as_u64),open.get("pingTimeout").and_then(Value::as_u64));
if let (Some(interval),Some(timeout))=(open.get("pingInterval").and_then(Value::as_u64),open.get("pingTimeout").and_then(Value::as_u64)) { if let (Some(interval),Some(timeout))=(open.get("pingInterval").and_then(Value::as_u64),open.get("pingTimeout").and_then(Value::as_u64)) {
ping_window=std::time::Duration::from_millis(interval.saturating_add(timeout).clamp(5_000,300_000)); ping_window=std::time::Duration::from_millis(interval.saturating_add(timeout).clamp(5_000,300_000));
ping_window_ms.store(ping_window.as_millis() as u64, Ordering::Relaxed);
ping_deadline=tokio::time::Instant::now()+ping_window; ping_deadline=tokio::time::Instant::now()+ping_window;
} }
} }
// Open packet -> 发送 Socket.IO connect // Open packet -> 发送 Socket.IO connect
let _ = tx_out_clone.send("40".into()).await; if tx_out_clone.try_send("40".into()).is_err() {
let _=send_event(&event_sender, SignalingEvent::Disconnected).await;break;
}
} else if txt == "2" { } else if txt == "2" {
// Ping -> 回复 Pong // Ping -> 回复 Pong
let gap=last_ping.elapsed().as_secs();last_ping=std::time::Instant::now();pings+=1; let gap=last_ping.elapsed().as_secs();last_ping=std::time::Instant::now();pings+=1;
ping_deadline=tokio::time::Instant::now()+ping_window; ping_deadline=tokio::time::Instant::now()+ping_window;
if tx_out_clone.send("3".into()).await.is_ok() { pong_queued+=1; } if tx_out_clone.try_send("3".into()).is_ok() { pong_queued+=1; }
else { let _=send_event(&event_sender, SignalingEvent::Disconnected).await;break; }
if pings==1 || pings%12==0 { if pings==1 || pings%12==0 {
log::info!("Signaling heartbeat progress: generation={} age_s={} pings={} pong_queued={} gap_s={}",generation,started.elapsed().as_secs(),pings,pong_queued,gap); log::info!("Signaling heartbeat progress: generation={} age_s={} pings={} pong_queued={} gap_s={}",generation,started.elapsed().as_secs(),pings,pong_queued,gap);
} }
@@ -250,8 +374,10 @@ impl SignalingClient {
// Socket.IO connected -> 发送 room_info 请求 // Socket.IO connected -> 发送 room_info 请求
req_counter += 1; req_counter += 1;
let room_req = format!("42{}[\"room_info\"]", req_counter); let room_req = format!("42{}[\"room_info\"]", req_counter);
let _ = tx_out_clone.send(room_req).await; if tx_out_clone.try_send(room_req).is_err() {
let _ = event_sender.send(SignalingEvent::Connected).await; let _=send_event(&event_sender, SignalingEvent::Disconnected).await;break;
}
if !send_event(&event_sender, SignalingEvent::Connected).await { break; }
} else if txt.starts_with("43") { } else if txt.starts_with("43") {
// Socket.IO ack 回调 // Socket.IO ack 回调
let begin=txt.find('[').unwrap_or(2); let begin=txt.find('[').unwrap_or(2);
@@ -270,7 +396,7 @@ impl SignalingClient {
next_refresh=tokio::time::Instant::now()+std::time::Duration::from_secs(300); next_refresh=tokio::time::Instant::now()+std::time::Duration::from_secs(300);
} }
log::info!("Signaling reconnect-key refresh acknowledged: generation={} age_s={} success={}",generation,started.elapsed().as_secs(),success); log::info!("Signaling reconnect-key refresh acknowledged: generation={} age_s={} success={}",generation,started.elapsed().as_secs(),success);
} else { let _ = event_sender.send(SignalingEvent::RoomInfoAck(v)).await; } } else if !send_event(&event_sender, SignalingEvent::RoomInfoAck(v)).await { break; }
} }
} else if txt.starts_with("45") || txt.starts_with("46") { } else if txt.starts_with("45") || txt.starts_with("46") {
// Socket.IO binary event/ack: header text, attachments follow as binary frames. // Socket.IO binary event/ack: header text, attachments follow as binary frames.
@@ -294,14 +420,10 @@ impl SignalingClient {
match event_name { match event_name {
"bmsg_push" => { "bmsg_push" => {
let _ = event_sender if !send_event(&event_sender, SignalingEvent::DeviceInfoChanged(data.clone())).await { break; }
.send(SignalingEvent::DeviceInfoChanged(data.clone()))
.await;
} }
"be-controlled" => { "be-controlled" => {
let _ = event_sender if !send_event(&event_sender, SignalingEvent::BeControlled(data.clone())).await { break; }
.send(SignalingEvent::BeControlled(data.clone()))
.await;
} }
"soac" => { "soac" => {
// Offers only: structure (keys, types, lengths), never SDP text or ids. // Offers only: structure (keys, types, lengths), never SDP text or ids.
@@ -324,9 +446,7 @@ impl SignalingClient {
if soac.client_id.is_none() { if soac.client_id.is_none() {
soac.client_id = client_id_opt; soac.client_id = client_id_opt;
} }
let _ = event_sender if !send_event(&event_sender, SignalingEvent::Soac(soac)).await { break; }
.send(SignalingEvent::Soac(soac))
.await;
} }
Err(e) => { Err(e) => {
let _ = e; let _ = e;
@@ -336,20 +456,17 @@ impl SignalingClient {
} }
"released" => { "released" => {
log::info!("Cloud peer event: generation={} event=released age_s={} pings={} last_ping_gap_s={} ice_id_present={}",generation,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs(),data.get("ice_id").is_some()); log::info!("Cloud peer event: generation={} event=released age_s={} pings={} last_ping_gap_s={} ice_id_present={}",generation,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs(),data.get("ice_id").is_some());
let _ = event_sender if !send_event(&event_sender, SignalingEvent::Released(data.clone())).await { break; }
.send(SignalingEvent::Released(data.clone()))
.await;
} }
"left" | "leave" => { "left" | "leave" => {
log::info!("Cloud peer event: generation={} event={} age_s={} pings={} last_ping_gap_s={} ice_id_present={}",generation,event_name,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs(),data.get("ice_id").is_some()); log::info!("Cloud peer event: generation={} event={} age_s={} pings={} last_ping_gap_s={} ice_id_present={}",generation,event_name,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs(),data.get("ice_id").is_some());
let ice_id = data.get("ice_id").and_then(|v| v.as_str()).unwrap_or(""); let ice_id = data.get("ice_id").and_then(|v| v.as_str()).unwrap_or("");
if ice_id.is_empty() { if ice_id.is_empty() {
log::info!("Cloud room leave shape: {}", crate::protocol::json_shape(data, 3));
log::warn!("Cloud room leave without peer identifier; renewing signaling (expiry cause unknown)"); log::warn!("Cloud room leave without peer identifier; renewing signaling (expiry cause unknown)");
let _ = event_sender.send(SignalingEvent::Disconnected).await; if !send_event(&event_sender, SignalingEvent::Disconnected).await { break; }
} else { } else {
let _ = event_sender if !send_event(&event_sender, SignalingEvent::Left(data.clone())).await { break; }
.send(SignalingEvent::Left(data.clone()))
.await;
} }
} }
_ => { _ => {
@@ -399,28 +516,60 @@ impl SignalingClient {
let controller_mac = platform.is_some_and(|v| v.as_i64() == Some(4) let controller_mac = platform.is_some_and(|v| v.as_i64() == Some(4)
|| v.as_str().is_some_and(|s| s == "4" || s.to_ascii_lowercase().contains("mac") || s.to_ascii_lowercase().contains("darwin"))); || v.as_str().is_some_and(|s| s == "4" || s.to_ascii_lowercase().contains("mac") || s.to_ascii_lowercase().contains("darwin")));
log::info!("Controller platform: {} mac={}", platform.map(|v| v.to_string()).unwrap_or_default().chars().take(24).collect::<String>(), controller_mac); log::info!("Controller platform: {} mac={}", platform.map(|v| v.to_string()).unwrap_or_default().chars().take(24).collect::<String>(), controller_mac);
let _ = event_sender.send(SignalingEvent::ConnectRequest { capture_type, ice_id, transport:crate::session_ice::SessionIce::from_header(&header), controller_mac }).await; if !send_event(&event_sender, SignalingEvent::ConnectRequest { capture_type, ice_id, transport:crate::session_ice::SessionIce::from_header(&header), controller_mac }).await { break; }
} }
} }
} }
Ok(Message::Close(frame)) => { Ok(Message::Close(frame)) => {
log::warn!("Signaling socket closed: generation={} age_s={} close_code={:?} pings={} last_ping_gap_s={}",generation,started.elapsed().as_secs(),frame.map(|f|u16::from(f.code)),pings,last_ping.elapsed().as_secs()); log::warn!("Signaling socket closed: generation={} age_s={} close_code={:?} pings={} last_ping_gap_s={}",generation,started.elapsed().as_secs(),frame.map(|f|u16::from(f.code)),pings,last_ping.elapsed().as_secs());
let _ = event_sender.send(SignalingEvent::Disconnected).await; let _ = send_event(&event_sender, SignalingEvent::Disconnected).await;
break; break;
} }
Err(_) => { Err(_) => {
log::warn!("Signaling socket receive failed: generation={} age_s={} pings={} last_ping_gap_s={}",generation,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs()); log::warn!("Signaling socket receive failed: generation={} age_s={} pings={} last_ping_gap_s={}",generation,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs());
let _ = event_sender.send(SignalingEvent::Disconnected).await; let _ = send_event(&event_sender, SignalingEvent::Disconnected).await;
break; break;
} }
_ => {} _ => {}
} }
} }
// A stalled event queue or a writer that already stopped can end this
// loop without a delivered Disconnected. Hand one off from a detached
// task so the main loop always learns the room is dead; duplicates are
// harmless because it breaks on the first one.
let events = event_sender.clone();
tokio::spawn(async move { let _ = events.send(SignalingEvent::Disconnected).await; });
receiver_done.store(true, Ordering::Relaxed);
log::info!("Signaling receiver stopped: generation={} age_s={}",generation,started.elapsed().as_secs()); log::info!("Signaling receiver stopped: generation={} age_s={}",generation,started.elapsed().as_secs());
// Live peer callbacks can retain the old SignalingClient sender. // Live peer callbacks can retain the old SignalingClient sender.
// Explicitly drop its write half too when this room stops reading. // Explicitly drop its write half too when this room stops reading.
writer.abort(); writer.abort();
}); });
let receiver_abort = receiver.abort_handle();
// Independent of the receive loop: a consumer that stops draining events
// parks the loop inside an `.await`, where the ping deadline can no longer
// be observed. The watchdog closes the socket anyway.
tokio::spawn(async move {
let mut tick = tokio::time::interval(WATCHDOG_TICK);
tick.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
loop {
tick.tick().await;
if watchdog_done.load(Ordering::Relaxed) || watchdog_events.is_closed() { return; }
let window_ms = watchdog_ping_window_ms.load(Ordering::Relaxed);
let idle_ms = (started.elapsed().as_millis() as u64)
.saturating_sub(watchdog_last_rx.load(Ordering::Relaxed));
if idle_ms <= window_ms { continue; }
log::warn!("Signaling heartbeat lost (watchdog): idle_s={} window_ms={}", idle_ms/1000, window_ms);
// Deliver from a detached task: the receiver may be the one parked
// on a full queue, and the main loop still needs this event.
let events = watchdog_events.clone();
tokio::spawn(async move { let _ = events.send(SignalingEvent::Disconnected).await; });
receiver_abort.abort();
writer_abort.abort();
return;
}
});
Ok(Self { tx_outgoing, _reconnect_key:reconnect_key }) Ok(Self { tx_outgoing, _reconnect_key:reconnect_key })
} }
@@ -428,7 +577,10 @@ impl SignalingClient {
pub async fn emit_event(&self, event: &str, payload: serde_json::Value) -> Result<(), String> { pub async fn emit_event(&self, event: &str, payload: serde_json::Value) -> Result<(), String> {
let packet = format!("42{}", serde_json::json!([event, payload])); let packet = format!("42{}", serde_json::json!([event, payload]));
log::info!("Emitting signaling event: {}", event); log::info!("Emitting signaling event: {}", event);
self.tx_outgoing.send(packet).await.map_err(|e| e.to_string()) tokio::time::timeout(SEND_STALL_TIMEOUT, self.tx_outgoing.send(packet))
.await
.map_err(|_| "signaling send stalled".to_string())?
.map_err(|e| e.to_string())
} }
/// 发送 SOAC 消息(Answer 或 Candidate) /// 发送 SOAC 消息(Answer 或 Candidate)
@@ -443,9 +595,9 @@ impl SignalingClient {
}; };
let msg = format!("42[\"soac\",{}]", payload); let msg = format!("42[\"soac\",{}]", payload);
log::info!("Emitting soac packet: type={}", soac.msg_type); log::info!("Emitting soac packet: type={}", soac.msg_type);
self.tx_outgoing tokio::time::timeout(SEND_STALL_TIMEOUT, self.tx_outgoing.send(msg))
.send(msg)
.await .await
.map_err(|_| "Send soac timed out".to_string())?
.map_err(|e| format!("Send soac error: {}", e)) .map_err(|e| format!("Send soac error: {}", e))
} }
} }
+161 -12
View File
@@ -12,6 +12,8 @@ pub const FF_SIMPLE_ACTION: u8 = 2;
pub const FF_SYSTEM_METRICS: u8 = 2; pub const FF_SYSTEM_METRICS: u8 = 2;
pub const SHOW_DESKTOP: u64 = 2; pub const SHOW_DESKTOP: u64 = 2;
/// Opens the desktop on an existing connection (the viewer's port mapping reuses its peer, #99).
pub const CAPTURE_DESKTOP: u64 = 4;
pub const REBOOT_SYSTEM: u64 = 9; pub const REBOOT_SYSTEM: u64 = 9;
pub const LOCK_SYSTEM: u64 = 10; pub const LOCK_SYSTEM: u64 = 10;
pub const SHUTDOWN_SYSTEM: u64 = 12; pub const SHUTDOWN_SYSTEM: u64 = 12;
@@ -25,11 +27,27 @@ pub const SET_AUTO_LOCK: u64 = 19;
/// Host settings from the viewer's 安全 menu. The viewer sends them only when a switch is toggled /// Host settings from the viewer's 安全 menu. The viewer sends them only when a switch is toggled
/// and shows what SystemMetrics reports, so they are host-wide and persisted (like the official /// and shows what SystemMetrics reports, so they are host-wide and persisted (like the official
/// host), not per connection: a reconnect must still lock / mute. /// host), not per connection: a reconnect must still lock / mute.
#[derive(Debug, Default, Clone, Copy, PartialEq, serde::Serialize, serde::Deserialize)] #[derive(Debug, Default, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
struct Settings { pub(crate) struct Settings {
#[serde(default)] auto_lock: bool, #[serde(default)] auto_lock: bool,
#[serde(default)] keep_mute: bool, #[serde(default)] keep_mute: bool,
#[serde(default)] mute_permanent: bool, #[serde(default)] mute_permanent: bool,
/// "auto" or absent does not override the environment. A non-string value becomes None so a bad
/// video field cannot drop auto_lock / mute when the document is loaded.
#[serde(default, deserialize_with = "lenient_string")] pub(crate) video_encoder: Option<String>,
#[serde(default, deserialize_with = "lenient_string")] pub(crate) video_codec: Option<String>,
}
fn lenient_string<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<Option<String>, D::Error> {
use serde::Deserialize;
match Option::<serde_json::Value>::deserialize(deserializer)? {
Some(serde_json::Value::String(s)) => Ok(Some(s)),
Some(_) => {
log::warn!("Ignoring non-string video_encoder/video_codec in host settings");
Ok(None)
}
None => Ok(None),
}
} }
struct HostState { struct HostState {
@@ -39,22 +57,83 @@ struct HostState {
desktop_sessions: usize, desktop_sessions: usize,
} }
fn settings_path() -> std::path::PathBuf { crate::config::path().with_file_name("host_settings.json") } pub(crate) fn settings_path() -> std::path::PathBuf { crate::config::path().with_file_name("host_settings.json") }
pub(crate) fn load_settings() -> Settings {
std::fs::read(settings_path()).ok().and_then(|b| serde_json::from_slice(&b).ok()).unwrap_or_default()
}
/// Re-read, apply `patch`, write via a temp file and rename (mode 0600).
pub(crate) fn merge_save(patch: impl FnOnce(&mut Settings)) -> Result<Settings, String> {
merge_write(patch)?;
let settings = load_settings();
if let Ok(mut guard) = state().lock() { guard.settings = settings.clone(); }
Ok(settings)
}
fn state() -> &'static Mutex<HostState> { fn state() -> &'static Mutex<HostState> {
static STATE: std::sync::OnceLock<Mutex<HostState>> = std::sync::OnceLock::new(); static STATE: std::sync::OnceLock<Mutex<HostState>> = std::sync::OnceLock::new();
STATE.get_or_init(|| { STATE.get_or_init(|| {
let settings = std::fs::read(settings_path()).ok() let settings = load_settings();
.and_then(|b| serde_json::from_slice(&b).ok()).unwrap_or_default();
Mutex::new(HostState { settings, restore: None, desktop_sessions: 0 }) Mutex::new(HostState { settings, restore: None, desktop_sessions: 0 })
}) })
} }
fn save(settings: &Settings) { /// Re-read, copy only the security switches from `settings`, keep video_* from disk.
fn save(settings: &Settings) -> Result<(), String> {
merge_write(|disk| {
disk.auto_lock = settings.auto_lock;
disk.keep_mute = settings.keep_mute;
disk.mute_permanent = settings.mute_permanent;
})
}
/// Held across read-patch-write-rename so set-* and a security-toggle save cannot clobber each other.
struct SettingsLock { file: std::fs::File }
impl SettingsLock {
fn acquire(path: &std::path::Path) -> Result<Self, String> {
use std::os::unix::fs::OpenOptionsExt;
let lock_path = path.with_file_name("host_settings.json.lock");
let file = std::fs::OpenOptions::new().read(true).write(true).create(true).mode(0o600).open(&lock_path).map_err(|e| e.kind().to_string())?;
let rc = unsafe { libc::flock(std::os::unix::io::AsRawFd::as_raw_fd(&file), libc::LOCK_EX) };
if rc != 0 { return Err(std::io::Error::last_os_error().kind().to_string()); }
Ok(Self { file })
}
}
impl Drop for SettingsLock {
fn drop(&mut self) {
unsafe { libc::flock(std::os::unix::io::AsRawFd::as_raw_fd(&self.file), libc::LOCK_UN); }
}
}
/// NotFound starts from defaults. Any other read or parse error leaves the file untouched:
/// a bad document must not be rewritten with security switches forced off.
fn read_for_merge(path: &std::path::Path) -> Result<Settings, String> {
match std::fs::read(path) {
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(Settings::default()),
Err(e) => Err(format!("host settings unreadable: {}", e.kind())),
// serde_json::Error's Display quotes the offending value; the journal and set-* must not.
Ok(bytes) => serde_json::from_slice(&bytes).map_err(|e| match (e.line(), e.column()) {
(0, 0) => "host_settings.json is not valid".to_owned(),
(line, column) => format!("host_settings.json is not valid (line {line}, column {column})"),
}),
}
}
fn merge_write(patch: impl FnOnce(&mut Settings)) -> Result<(), String> {
use std::io::Write;
use std::os::unix::fs::OpenOptionsExt;
let path = settings_path(); let path = settings_path();
let result = serde_json::to_vec_pretty(settings).map_err(|e| e.to_string()) if let Some(dir) = path.parent() { std::fs::create_dir_all(dir).map_err(|e| e.kind().to_string())?; }
.and_then(|json| std::fs::write(&path, json).map_err(|e| e.to_string())); let _lock = SettingsLock::acquire(&path)?;
if let Err(e) = result { log::warn!("Host settings not saved: {}", e); } let mut disk = read_for_merge(&path)?;
patch(&mut disk);
let json = serde_json::to_vec_pretty(&disk).map_err(|e| e.to_string())?;
let tmp = path.with_extension(format!("json.{}.tmp", std::process::id()));
let mut file = std::fs::OpenOptions::new().write(true).create(true).truncate(true).mode(0o600).open(&tmp).map_err(|e| e.kind().to_string())?;
file.write_all(&json).map_err(|e| e.kind().to_string())?;
std::fs::rename(&tmp, &path).map_err(|e| e.kind().to_string())?;
Ok(())
} }
/// Handle for one desktop connection (system actions are host-wide). /// Handle for one desktop connection (system actions are host-wide).
@@ -142,7 +221,7 @@ impl PeerActions {
_ => {} _ => {}
} }
let mut state = state().lock().unwrap(); let mut state = state().lock().unwrap();
let before = state.settings; let before = state.settings.clone();
match action { match action {
// 静音运行 on: the viewer sends MUTE_SYSTEM + MUTE_TEMPORARY (observed), off: MUTE_RESTORE. // 静音运行 on: the viewer sends MUTE_SYSTEM + MUTE_TEMPORARY (observed), off: MUTE_RESTORE.
MUTE_SYSTEM | MUTE_TEMPORARY => { MUTE_SYSTEM | MUTE_TEMPORARY => {
@@ -172,7 +251,7 @@ impl PeerActions {
} }
_ => return false, _ => return false,
} }
if state.settings != before { save(&state.settings); } if state.settings != before { if let Err(e) = save(&state.settings) { log::warn!("Host settings not saved: {e}"); } }
true true
} }
@@ -205,7 +284,7 @@ impl PeerActions {
pub fn metrics_payload(&self, sound: bool, desktop: crate::system_metrics::Permission) -> Vec<u8> { pub fn metrics_payload(&self, sound: bool, desktop: crate::system_metrics::Permission) -> Vec<u8> {
use crate::system_metrics::payload_with_settings; use crate::system_metrics::payload_with_settings;
let home = std::env::var("HOME").unwrap_or_else(|_| "/".into()); let home = std::env::var("HOME").unwrap_or_else(|_| "/".into());
let current = state().lock().unwrap().settings; let current = state().lock().unwrap().settings.clone();
payload_with_settings(desktop, desktop, desktop, &home, &crate::system_metrics::Settings { payload_with_settings(desktop, desktop, desktop, &home, &crate::system_metrics::Settings {
sound, keep_mute: current.keep_mute, mute_permanent: current.mute_permanent, auto_lock: current.auto_lock, sound, keep_mute: current.keep_mute, mute_permanent: current.mute_permanent, auto_lock: current.auto_lock,
}) })
@@ -274,6 +353,76 @@ mod tests {
assert!(plugin_response(&decode_wire(&[10, 2, 8, 9]).unwrap()).is_none()); assert!(plugin_response(&decode_wire(&[10, 2, 8, 9]).unwrap()).is_none());
} }
#[test] #[test]
fn merge_save_keeps_security_fields_and_mode() {
let _guard = crate::config::test_env_lock().lock().unwrap();
let dir = std::env::temp_dir().join(format!("uu-settings-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::create_dir_all(&dir).unwrap();
let cfg = dir.join("config.json");
std::env::set_var("UU_CONFIG", &cfg);
let path = settings_path();
std::fs::write(&path, br#"{"auto_lock":true,"keep_mute":true,"mute_permanent":false}"#).unwrap();
let saved = merge_save(|s| s.video_encoder = Some("vaapi".into())).unwrap();
assert!(saved.auto_lock && saved.keep_mute && !saved.mute_permanent);
assert_eq!(saved.video_encoder.as_deref(), Some("vaapi"));
let again = merge_save(|s| s.video_codec = Some("h264".into())).unwrap();
assert_eq!(again.video_encoder.as_deref(), Some("vaapi"));
assert_eq!(again.video_codec.as_deref(), Some("h264"));
assert!(again.auto_lock);
let mode = { use std::os::unix::fs::PermissionsExt; std::fs::metadata(&path).unwrap().permissions().mode() & 0o777 };
assert_eq!(mode, 0o600);
// A mute/lock save must not drop video_* written after the in-memory copy was taken.
let mut memory = load_settings();
std::fs::write(&path, br#"{"auto_lock":true,"keep_mute":true,"mute_permanent":false,"video_encoder":"nvenc","video_codec":"h265"}"#).unwrap();
memory.keep_mute = false;
save(&memory).unwrap();
let disk: serde_json::Value = serde_json::from_slice(&std::fs::read(&path).unwrap()).unwrap();
assert_eq!(disk["video_encoder"], "nvenc");
assert_eq!(disk["video_codec"], "h265");
assert_eq!(disk["keep_mute"], false);
assert_eq!(disk["auto_lock"], true);
// A non-string video field must not fail the whole document (security switches survive).
std::fs::write(&path, br#"{"auto_lock":true,"keep_mute":false,"mute_permanent":true,"video_encoder":1,"video_codec":{"x":1}}"#).unwrap();
let loaded = load_settings();
assert!(loaded.auto_lock && !loaded.keep_mute && loaded.mute_permanent);
assert!(loaded.video_encoder.is_none() && loaded.video_codec.is_none());
merge_save(|s| s.video_encoder = Some("cpu".into())).unwrap();
let disk: serde_json::Value = serde_json::from_slice(&std::fs::read(&path).unwrap()).unwrap();
assert_eq!(disk["auto_lock"], true);
assert_eq!(disk["mute_permanent"], true);
assert_eq!(disk["video_encoder"], "cpu");
let _ = std::fs::remove_dir_all(&dir);
std::env::remove_var("UU_CONFIG");
}
#[test]
fn merge_write_refuses_malformed_or_unreadable_settings() {
let _guard = crate::config::test_env_lock().lock().unwrap();
let dir = std::env::temp_dir().join(format!("uu-settings-bad-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::create_dir_all(&dir).unwrap();
std::env::set_var("UU_CONFIG", dir.join("config.json"));
let path = settings_path();
let malformed = br#"{"auto_lock":true, "keep_mute":"#;
std::fs::write(&path, malformed).unwrap();
let err = merge_write(|s| s.video_encoder = Some("cpu".into())).unwrap_err();
assert!(err.contains("not valid"), "{err}");
assert_eq!(std::fs::read(&path).unwrap(), malformed);
let bad_type = br#"{"auto_lock":"yes","keep_mute":false,"mute_permanent":false}"#;
std::fs::write(&path, bad_type).unwrap();
let err = merge_write(|s| s.video_codec = Some("h265".into())).unwrap_err();
assert!(err.contains("not valid"), "{err}");
assert!(err.contains("line ") && err.contains("column "), "{err}");
assert!(!err.contains("yes"), "{err}");
assert_eq!(std::fs::read(&path).unwrap(), bad_type);
std::fs::remove_file(&path).unwrap();
std::fs::create_dir(&path).unwrap();
let err = merge_write(|s| s.video_encoder = Some("cpu".into())).unwrap_err();
assert!(err.contains("unreadable"), "{err}");
assert!(path.is_dir());
let _ = std::fs::remove_dir_all(&dir);
std::env::remove_var("UU_CONFIG");
}
#[test]
fn args_shape_never_contains_values() { fn args_shape_never_contains_values() {
let shape = args_shape(br#"{"enable":true,"secret":"abc"}"#); let shape = args_shape(br#"{"enable":true,"secret":"abc"}"#);
assert!(shape.contains("enable") && !shape.contains("abc")); assert!(shape.contains("enable") && !shape.contains("abc"));
+484 -104
View File
@@ -1,8 +1,12 @@
#[cfg(test)]
#[path = "video_wake_tests.rs"]
mod wake_tests;
use std::collections::HashMap; use std::collections::HashMap;
use std::ffi::OsString; use std::ffi::OsString;
use std::path::PathBuf; use std::path::PathBuf;
use std::sync::{Arc, Mutex, OnceLock}; use std::sync::{Arc, Mutex, OnceLock};
use std::sync::atomic::AtomicBool; use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use tokio::io::AsyncReadExt; use tokio::io::AsyncReadExt;
use tokio::process::Command; use tokio::process::Command;
@@ -177,16 +181,9 @@ impl CompleteFrame {
const RTP_CLOCK: u64 = 90_000; const RTP_CLOCK: u64 = 90_000;
#[derive(Clone, Copy, Debug, PartialEq, Eq)] #[derive(Clone, Copy, Debug, Hash, PartialEq, Eq)]
pub(crate) enum Encoder { Cpu, Nvenc, Vaapi } pub(crate) enum Encoder { Cpu, Nvenc, Vaapi }
impl Encoder { impl Encoder {
pub(crate) fn requested() -> Self { Self::from_setting(std::env::var("UU_VIDEO_ENCODER").ok().as_deref(), nvidia_present()) }
/// Unset/auto tries NVENC only with an NVIDIA driver loaded: `ffmpeg -encoders` lists h264_nvenc
/// on any machine, so without this every stream start first ran a doomed NVENC process (#10).
fn from_setting(value: Option<&str>, nvidia: bool) -> Self {
match value { Some("cpu") => Self::Cpu, Some("vaapi") => Self::Vaapi, Some("nvenc") => Self::Nvenc,
_ => if nvidia { Self::Nvenc } else { Self::Cpu } }
}
pub(crate) fn name_for(self, codec: VideoCodec) -> &'static str { pub(crate) fn name_for(self, codec: VideoCodec) -> &'static str {
match (self, codec) { match (self, codec) {
(Self::Cpu, VideoCodec::H264) => "libx264", (Self::Cpu, VideoCodec::H265) => "libx265", (Self::Cpu, VideoCodec::H264) => "libx264", (Self::Cpu, VideoCodec::H265) => "libx265",
@@ -195,16 +192,12 @@ impl Encoder {
} }
} }
} }
fn nvidia_present() -> bool { pub(crate) fn nvidia_present() -> bool {
std::path::Path::new("/proc/driver/nvidia/version").exists() || std::path::Path::new("/dev/nvidia0").exists() std::path::Path::new("/proc/driver/nvidia/version").exists() || std::path::Path::new("/dev/nvidia0").exists()
} }
/// 真彩 (4:4:4) needs the FFmpeg process pipeline with NVENC or libx264 (h264_vaapi and the /// 真彩 (4:4:4): NVENC (in-process or FFmpeg) and libx264; h264_vaapi is 4:2:0 only.
/// in-process encoder are 4:2:0 only). /// A GPU without 4:4:4 NVENC falls back to libx264, which keeps 4:4:4.
pub fn full_chroma_available() -> bool { pub(crate) fn full_chroma_for(encoder: Encoder) -> bool { encoder != Encoder::Vaapi }
#[cfg(feature = "inproc-av")]
if crate::inproc_encoder::selected() { return false; }
Encoder::requested() != Encoder::Vaapi
}
/// (-profile:v, -pix_fmt) for NVENC / libx264 / libx265: 4:4:4 (真彩) needs a 4:4:4 profile. /// (-profile:v, -pix_fmt) for NVENC / libx264 / libx265: 4:4:4 (真彩) needs a 4:4:4 profile.
fn chroma_args(settings: &VideoSettings, encoder: Encoder) -> (&'static str, &'static str) { fn chroma_args(settings: &VideoSettings, encoder: Encoder) -> (&'static str, &'static str) {
@@ -264,10 +257,29 @@ fn cpu_hevc_options(settings: &VideoSettings, gop: &str) -> Vec<String> {
/// NVENC converts packed RGB on the GPU (BT.601 limited range, tagged bt470bg like the swscale default; /// NVENC converts packed RGB on the GPU (BT.601 limited range, tagged bt470bg like the swscale default;
/// compared on the 3090), so 4:2:0 without scaling skips the CPU BGRA→YUV pass (#16: ~2 cores at 4K). /// compared on the 3090), so 4:2:0 without scaling skips the CPU BGRA→YUV pass (#16: ~2 cores at 4K).
/// `input` is the source pixel format; `UU_NVENC_RGB=0` restores CPU conversion. /// When the desktop is composited on the NVIDIA card itself, the packed-RGB path is slower than CPU
/// conversion (#16: RTX 5070 at 4K, 82.6 vs 98 fps), so it stays off unless `UU_NVENC_RGB=1`.
/// `input` is the source pixel format; `UU_NVENC_RGB=0` always restores CPU conversion.
fn nvenc_rgb_input(settings: &VideoSettings, encoder: Encoder, input: &'static str) -> Option<&'static str> { fn nvenc_rgb_input(settings: &VideoSettings, encoder: Encoder, input: &'static str) -> Option<&'static str> {
(encoder == Encoder::Nvenc && settings.chroma != crate::capture_setting::CHROMA_444 && settings.output.is_none() let wanted = match std::env::var("UU_NVENC_RGB").as_deref() {
&& std::env::var("UU_NVENC_RGB").as_deref() != Ok("0")).then_some(input) Ok("0") => false,
Ok("1") => true,
_ => !nvidia_drives_display(std::path::Path::new("/sys/class/drm")),
};
(encoder == Encoder::Nvenc && settings.chroma != crate::capture_setting::CHROMA_444 && settings.output.is_none() && wanted)
.then_some(input)
}
/// A connected DRM connector (`cardN-HDMI-A-1/status`) on a card bound to the nvidia driver.
/// Only visible with nvidia-drm modeset, which Wayland compositors require.
fn nvidia_drives_display(drm: &std::path::Path) -> bool {
std::fs::read_dir(drm).into_iter().flatten().flatten().any(|entry| {
let name = entry.file_name().to_string_lossy().into_owned();
let Some((card, _)) = name.split_once('-') else { return false; };
card.starts_with("card")
&& std::fs::read_to_string(entry.path().join("status")).is_ok_and(|s| s.trim() == "connected")
&& std::fs::read_link(drm.join(card).join("device/driver")).is_ok_and(|p| p.file_name().is_some_and(|n| n == "nvidia"))
})
} }
fn encoder_options(settings: &VideoSettings, encoder: Encoder, gop: &str, rgb: Option<&'static str>) -> Vec<String> { fn encoder_options(settings: &VideoSettings, encoder: Encoder, gop: &str, rgb: Option<&'static str>) -> Vec<String> {
@@ -346,6 +358,52 @@ fn ffmpeg_spec() -> FfmpegSpec {
pub(crate) fn ffmpeg_command() -> Command { ffmpeg_spec().command() } pub(crate) fn ffmpeg_command() -> Command { ffmpeg_spec().command() }
/// Encoders of interest that the configured FFmpeg lists; `None` when it cannot run (bounded to 5 s).
pub async fn ffmpeg_encoders() -> Option<Vec<&'static str>> {
let mut ffmpeg = ffmpeg_command();
ffmpeg.args(["-hide_banner", "-encoders"]).kill_on_drop(true);
let output = tokio::time::timeout(Duration::from_secs(5), ffmpeg.output()).await.ok()?.ok()?;
let text = String::from_utf8_lossy(&output.stdout);
Some(["libx264", "libx265", "h264_nvenc", "hevc_nvenc", "h264_vaapi", "hevc_vaapi"].into_iter()
.filter(|name| text.split_whitespace().any(|word| word == *name)).collect())
}
/// Without FFmpeg the desktop stream fails after the viewer connects and it waits on
/// 正在传输画面 with no message of its own. Checked at startup and on each desktop offer:
/// logged, shown in the host window, and sent as a desktop notification (at most every 5 minutes).
/// Installing FFmpeg clears the window line on the next check; no restart is needed.
pub fn check_ffmpeg_usable() {
if crate::desktop_backend::headless() { return; }
tokio::spawn(async {
static LAST_NOTICE: std::sync::Mutex<Option<Instant>> = std::sync::Mutex::new(None);
const SUMMARY: &str = "无法传输远程画面";
match ffmpeg_encoders().await {
None => {
log::error!("FFmpeg is not runnable: desktop video cannot start and viewers stay on 正在传输画面. Install ffmpeg (Debian/Ubuntu: sudo apt install ffmpeg; Arch: sudo pacman -S ffmpeg; Fedora: ffmpeg from RPM Fusion), or set ffmpeg_root, then check `uuremote-server doctor`");
let text = "未找到可运行的 FFmpeg,客户端会一直停在「正在传输画面」。\n请安装后重新连接:sudo apt install ffmpeg(Arch:sudo pacman -S ffmpeg;Fedora 需先启用 RPM Fusion)";
let previous = {
let mut last = LAST_NOTICE.lock().unwrap_or_else(|e| e.into_inner());
let previous = *last;
let due = previous.is_none_or(|at| at.elapsed() >= Duration::from_secs(300));
if due { *last = Some(Instant::now()); }
due.then_some(previous)
};
// The notification is a blocking D-Bus call (bounded to 3 s).
let told = tokio::task::spawn_blocking(move || crate::assist::show_problem(SUMMARY, Some(text), previous.is_some())).await.unwrap_or(false);
// Only a notice that reached the person starts the 5-minute quiet period.
if let (Some(previous), false) = (previous, told) {
*LAST_NOTICE.lock().unwrap_or_else(|e| e.into_inner()) = previous;
log::warn!("Missing FFmpeg: no desktop notification daemon and no host window to show it");
}
}
Some(found) => {
if !found.contains(&"libx264") { log::warn!("FFmpeg has no libx264: CPU encoding and the fallback after a hardware encoder failure are unavailable. Install a full ffmpeg build"); }
tokio::task::spawn_blocking(|| crate::assist::show_problem(SUMMARY, None, false));
}
}
});
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)] #[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum FfmpegTimingMode { Modern, Legacy } enum FfmpegTimingMode { Modern, Legacy }
@@ -413,33 +471,153 @@ async fn ffmpeg_timing_mode(spec: &FfmpegSpec) -> FfmpegTimingMode {
*cell.get_or_init(|| probe_timing_mode(spec)).await *cell.get_or_init(|| probe_timing_mode(spec)).await
} }
type HevcCache = Mutex<HashMap<(FfmpegSpec, Encoder), Arc<tokio::sync::OnceCell<bool>>>>;
fn hevc_cache() -> &'static HevcCache {
static CACHE: OnceLock<HevcCache> = OnceLock::new();
CACHE.get_or_init(|| Mutex::new(HashMap::new()))
}
fn hevc_cell(cache: &HevcCache, spec: &FfmpegSpec, encoder: Encoder) -> Arc<tokio::sync::OnceCell<bool>> {
let mut cache = cache.lock().expect("HEVC probe cache poisoned");
cache.entry((spec.clone(), encoder)).or_insert_with(|| Arc::new(tokio::sync::OnceCell::const_new())).clone()
}
/// A compiled-in encoder name does not prove that its driver can initialize. /// A compiled-in encoder name does not prove that its driver can initialize.
/// Probe one synthetic 4:2:0 frame once per process before advertising HEVC. /// Probe one synthetic 4:2:0 frame per resolved encoder and FFmpeg spec. The caller
pub async fn hevc_available() -> bool { /// passes the session's encoder so capability matches that snapshot. set-encoder
static AVAILABLE: tokio::sync::OnceCell<bool> = tokio::sync::OnceCell::const_new(); /// changes the snapshot for the next session, so a process-wide bool would keep advertising
*AVAILABLE.get_or_init(|| async { /// the first session's result.
let requested = Encoder::requested(); const AUTO_PROBE_BUDGET: Duration = Duration::from_secs(3);
let mut candidates = vec![requested];
if requested != Encoder::Cpu { candidates.push(Encoder::Cpu); } /// One synthetic H.264 IDR. Failure reasons stay enum values: stderr and device paths are not logged.
for encoder in candidates { pub(crate) async fn probe_encoder_idr(encoder: Encoder) -> crate::video_select::ProbeOutcome {
let settings = VideoSettings { codec: VideoCodec::H265, ..Default::default() }; use crate::video_select::{ProbeFail, ProbeOutcome};
let mut command = ffmpeg_command(); let settings = VideoSettings { codec: VideoCodec::H264, ..Default::default() };
command.args(["-hide_banner", "-loglevel", "error", "-nostdin"]); let mut command = ffmpeg_command();
if encoder == Encoder::Vaapi { command.args(["-vaapi_device", &vaapi_device()]); } command.args(["-hide_banner", "-loglevel", "error", "-nostdin"]);
command.args(["-f", "lavfi", "-i", "color=black:size=256x256:rate=1", "-frames:v", "1", "-an"]); if encoder == Encoder::Vaapi { command.args(["-vaapi_device", &vaapi_device()]); }
if encoder == Encoder::Vaapi { command.args(["-vf", &vaapi_filter(None)]); } command.args(["-f", "lavfi", "-i", "color=c=black:s=256x256:r=1", "-frames:v", "1", "-an"]);
command.args(encoder_options(&settings, encoder, "30", None)); if encoder == Encoder::Vaapi { command.args(["-vf", &vaapi_filter(None)]); }
command.args(["-f", "hevc", "pipe:1"]).kill_on_drop(true).stderr(std::process::Stdio::null()); command.args(encoder_options(&settings, encoder, "30", None));
if let Ok(Ok(output)) = tokio::time::timeout(Duration::from_secs(5), command.output()).await { command.args(["-f", "h264", "pipe:1"]).kill_on_drop(true).stderr(std::process::Stdio::null());
if output.status.success() && is_independent_frame_for(&output.stdout, VideoCodec::H265) { let process = match tokio::time::timeout(AUTO_PROBE_BUDGET, command.output()).await {
log::info!("HEVC encoder probe: {} ok", encoder.name_for(VideoCodec::H265)); Ok(Ok(output)) if output.status.success() && is_independent_frame_for(&output.stdout, VideoCodec::H264) => ProbeOutcome::Ok,
return true; Ok(Ok(output)) if output.status.success() => ProbeOutcome::Fail(ProbeFail::NoIdr),
} Ok(Ok(_)) => ProbeOutcome::Fail(ProbeFail::Exit),
Ok(Err(_)) => ProbeOutcome::Fail(ProbeFail::Spawn),
Err(_) => ProbeOutcome::Fail(ProbeFail::Timeout),
};
// The native engine opens against a real X display, so a synthetic lavfi frame cannot
// exercise it. When this build would try that engine first, a process-only failure must
// not drop the candidate (NativeUnprobed → legacy auto for it).
crate::video_select::outcome_for_candidate(process, native_engine_would_run(encoder))
}
/// True when `read_encoder_with` would open the in-process engine for this candidate
/// on the selected desktop backend (X11 only; not Wayland, portal, KMS, or headless).
fn native_engine_would_run(encoder: Encoder) -> bool {
native_engine_eligible(encoder, native_display_kind())
}
fn native_display_kind() -> NativeDisplayKind {
if crate::desktop_backend::headless() { return NativeDisplayKind::None; }
match crate::desktop_backend::detect() {
Ok(crate::desktop_backend::DesktopBackend::Wayland) => NativeDisplayKind::Wayland,
Ok(crate::desktop_backend::DesktopBackend::Kms) => NativeDisplayKind::Kms,
Ok(crate::desktop_backend::DesktopBackend::Portal) => NativeDisplayKind::Portal,
_ => NativeDisplayKind::X11,
}
}
fn auto_probe_flight() -> &'static tokio::sync::Mutex<()> {
static FLIGHT: std::sync::OnceLock<tokio::sync::Mutex<()>> = std::sync::OnceLock::new();
FLIGHT.get_or_init(|| tokio::sync::Mutex::new(()))
}
/// Start the auto probe when auto is selected and the cache is empty or stale
/// (TTL, or NVIDIA presence changed since the report). Returns immediately.
/// One probe runs at a time; an in-flight probe is left alone.
/// Explicit encoder (setting or `UU_VIDEO_ENCODER`) does not spawn a probe.
pub fn warm_auto_probe() {
if !crate::video_select::should_warm_auto_probe(crate::video_select::selection().encoder_source) { return; }
if !crate::video_select::probe_needs_run(std::time::Instant::now(), nvidia_present()) { return; }
tokio::spawn(async { let _ = run_auto_probe().await; });
}
/// Diagnostics that encode must see the same auto choice as a warmed-up host.
/// An explicit encoder (setting or env) skips the probe.
pub async fn ensure_auto_probed() {
if crate::video_select::selection().encoder_source == crate::video_select::Source::Auto {
let _ = run_auto_probe().await;
}
}
/// Run the probe to completion (doctor, or the background warm-up).
/// A success or a CPU-only skip stays cached. A hardware failure expires after
/// `PROBE_FAILURE_TTL`; the next `warm_auto_probe` starts one background retry.
pub async fn run_auto_probe() -> crate::video_select::ProbeReport {
let now = std::time::Instant::now();
let nvidia = nvidia_present();
if let Some(cached) = crate::video_select::cached_probe() {
if !crate::video_select::probe_stale(&cached, now, nvidia) { return cached; }
}
let _flight = auto_probe_flight().lock().await;
let now = std::time::Instant::now();
let nvidia = nvidia_present();
if let Some(cached) = crate::video_select::cached_probe() {
if !crate::video_select::probe_stale(&cached, now, nvidia) { return cached; }
}
let reason = crate::video_select::reprobe_reason(crate::video_select::cached_probe().as_ref(), nvidia);
let nvidia = nvidia_present();
let order = crate::video_select::auto_order(nvidia);
// One candidate (CPU, no NVIDIA) has nothing to choose; skip the synthetic IDR.
let mut outcomes = Vec::with_capacity(order.len());
if order.len() == 1 {
outcomes.push(crate::video_select::ProbeOutcome::NotProbed);
} else {
for encoder in &order { outcomes.push(probe_encoder_idr(*encoder).await); }
}
let probed = crate::video_select::choose_from_probe(&order, &outcomes);
let chosen = crate::video_select::chosen_after_native(nvidia, &order, &outcomes, probed);
let report = crate::video_select::ProbeReport::fresh(order, outcomes, chosen, now, nvidia);
let parts: Vec<String> = report.order.iter().zip(report.outcomes.iter()).map(|(e, o)| format!("{}={}", format!("{e:?}").to_ascii_lowercase(), o.label())).collect();
if let Some(reason) = reason {
log::info!("Encoder probe: {reason} {}", parts.join(" "));
} else {
log::info!("Encoder probe: {}", parts.join(" "));
}
crate::video_select::store_probe(report.clone());
report
}
pub async fn hevc_available(requested: Encoder) -> bool {
let spec = ffmpeg_spec();
let cell = hevc_cell(hevc_cache(), &spec, requested);
*cell.get_or_init(|| probe_hevc(spec, requested)).await
}
async fn probe_hevc(spec: FfmpegSpec, requested: Encoder) -> bool {
let mut candidates = vec![requested];
if requested != Encoder::Cpu { candidates.push(Encoder::Cpu); }
for encoder in candidates {
let settings = VideoSettings { codec: VideoCodec::H265, ..Default::default() };
let mut command = spec.command();
command.args(["-hide_banner", "-loglevel", "error", "-nostdin"]);
if encoder == Encoder::Vaapi { command.args(["-vaapi_device", &vaapi_device()]); }
command.args(["-f", "lavfi", "-i", "color=black:size=256x256:rate=1", "-frames:v", "1", "-an"]);
if encoder == Encoder::Vaapi { command.args(["-vf", &vaapi_filter(None)]); }
command.args(encoder_options(&settings, encoder, "30", None));
command.args(["-f", "hevc", "pipe:1"]).kill_on_drop(true).stderr(std::process::Stdio::null());
if let Ok(Ok(output)) = tokio::time::timeout(Duration::from_secs(5), command.output()).await {
if output.status.success() && is_independent_frame_for(&output.stdout, VideoCodec::H265) {
log::info!("HEVC encoder probe: {} ok", encoder.name_for(VideoCodec::H265));
return true;
} }
} }
log::info!("HEVC encoder probe: unavailable"); }
false log::info!("HEVC encoder probe: unavailable");
}).await false
} }
/// Round UP (+1ns float guard) so webrtc's floor(duration*90000) yields exactly `ticks`. /// Round UP (+1ns float guard) so webrtc's floor(duration*90000) yields exactly `ticks`.
@@ -502,21 +680,71 @@ impl Drop for StopOnDrop { fn drop(&mut self) { self.0.store(true, std::sync::at
async fn read_encoder( async fn read_encoder(
size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>, size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>,
latest: mpsc::Sender<Arc<CompleteFrame>>, latest: mpsc::Sender<Arc<CompleteFrame>>,
settings: VideoSettings, sequence: Arc<std::sync::atomic::AtomicU64>, idr: Arc<AtomicBool>, budget: Arc<Semaphore>, mut settings: VideoSettings, sequence: Arc<std::sync::atomic::AtomicU64>, idr: Arc<AtomicBool>, budget: Arc<Semaphore>,
selection: crate::video_select::Selection,
) -> Result<(), String> { ) -> Result<(), String> {
#[cfg(test)]
if display == wake_tests::DISPLAY { return wake_tests::encode(latest, settings, sequence, budget).await; }
// The sequence is shared so a CPU fallback or settings restart continues it (skip statistics stay correct). // The sequence is shared so a CPU fallback or settings restart continues it (skip statistics stay correct).
let encoder = Encoder::requested(); // `selection` is fixed for this desktop connection (taken where the codec is negotiated).
if encoder == Encoder::Cpu { return read_encoder_with(size,display,portal,latest,Encoder::Cpu,sequence,settings,idr,budget).await; } let encoder = selection.encoder;
match read_encoder_with(size,display.clone(),portal.clone(),latest.clone(),encoder,sequence.clone(),settings,idr.clone(),budget.clone()).await { if settings.chroma == crate::capture_setting::CHROMA_444 && !full_chroma_for(encoder) {
settings.chroma = crate::capture_setting::CHROMA_420;
log::info!("Chroma 4:4:4 requested; encoder={} source={} encodes 4:2:0", format!("{encoder:?}").to_ascii_lowercase(), crate::video_select::encoder_source_label(selection.encoder_source));
}
if encoder == Encoder::Cpu { return read_encoder_with(size,display,portal,latest,Encoder::Cpu,true,sequence,settings,idr,budget,selection).await; }
#[cfg_attr(not(feature = "inproc-av"), allow(unused_mut))]
let mut result = read_encoder_with(size,display.clone(),portal.clone(),latest.clone(),encoder,true,sequence.clone(),settings,idr.clone(),budget.clone(),selection).await;
// A failed native NVENC session (old driver, unsupported mode) still leaves FFmpeg's NVENC process pipeline.
#[cfg(feature = "inproc-av")]
if let Err(error) = &result {
if !latest.is_closed() && native_inproc(&display, portal.is_some(), encoder) && x11_resized(&display, portal.is_some(), size).is_none() {
log::warn!("In-process {} stream unavailable; switching to the FFmpeg process pipeline: {}",encoder.name_for(settings.codec),error);
result = read_encoder_with(size,display.clone(),portal.clone(),latest.clone(),encoder,false,sequence.clone(),settings,idr.clone(),budget.clone(),selection).await;
}
}
match result {
Ok(())=>Ok(()), Ok(())=>Ok(()),
Err(error) if !latest.is_closed()=>{ Err(error) if !latest.is_closed() && x11_resized(&display, portal.is_some(), size).is_none()=>{
log::warn!("{} stream unavailable; switching scoped encoder to CPU: {}",encoder.name_for(settings.codec),error); log::warn!("{} stream unavailable; switching scoped encoder to CPU: {}",encoder.name_for(settings.codec),error);
read_encoder_with(size,display,portal,latest,Encoder::Cpu,sequence,settings,idr,budget).await read_encoder_with(size,display,portal,latest,Encoder::Cpu,true,sequence,settings,idr,budget,selection).await
}, },
Err(error)=>Err(error), Err(error)=>Err(error),
} }
} }
/// A resized X11 root fails every encoder alike (x11grab BadMatch on the old size);
/// returns the new size so the stream restarts capture instead of walking the fallback chain.
fn x11_resized(display: &str, portal: bool, size: (u32, u32)) -> Option<(u32, u32)> {
if portal || display.starts_with("wayland:") || display.starts_with("kms:") { return None; }
crate::capture::x11_size().filter(|current| *current != size)
}
/// Same predicate `native_inproc` uses: X11 only, and the in-process engine is selected.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum NativeDisplayKind { X11, Wayland, Portal, Kms, None }
pub(crate) fn native_engine_eligible(encoder: Encoder, kind: NativeDisplayKind) -> bool {
#[cfg(feature = "inproc-av")]
{ kind == NativeDisplayKind::X11 && crate::inproc_encoder::selected(encoder) }
#[cfg(not(feature = "inproc-av"))]
{ let _ = (encoder, kind); false }
}
/// The native in-process NVENC path serves X11 only (not Wayland/KMS capture or a portal session).
#[cfg(feature = "inproc-av")]
fn native_inproc(display: &str, portal: bool, encoder: Encoder) -> bool {
native_engine_eligible(encoder, display_kind(display, portal))
}
#[cfg(feature = "inproc-av")]
fn display_kind(display: &str, portal: bool) -> NativeDisplayKind {
if portal { NativeDisplayKind::Portal }
else if display.starts_with("wayland:") { NativeDisplayKind::Wayland }
else if display.starts_with("kms:") { NativeDisplayKind::Kms }
else { NativeDisplayKind::X11 }
}
/// Capture and encode inside this process; each packet is one access unit. /// Capture and encode inside this process; each packet is one access unit.
#[cfg(feature = "inproc-av")] #[cfg(feature = "inproc-av")]
async fn read_inprocess( async fn read_inprocess(
@@ -528,9 +756,11 @@ async fn read_inprocess(
let stop = Arc::new(AtomicBool::new(false)); let stop = Arc::new(AtomicBool::new(false));
// If this future is dropped (reader task aborted), the blocking encoder stops at its next packet. // If this future is dropped (reader task aborted), the blocking encoder stops at its next packet.
let _stop_on_drop = StopOnDrop(stop.clone()); let _stop_on_drop = StopOnDrop(stop.clone());
// A restart aborts the previous reader without waiting for its blocking encoder; wait for it here.
let slot = crate::inproc_encoder::stream_slot(&idr).await;
let job = tokio::task::spawn_blocking({ let job = tokio::task::spawn_blocking({
let stop = stop.clone(); let stop = stop.clone();
move || crate::inproc_encoder::run(config, units_tx, stop, idr, budget) move || { let _slot = slot; crate::inproc_encoder::run(config, units_tx, stop, idr, budget) }
}); });
let mut gate = DependencyGate::default(); let mut gate = DependencyGate::default();
while let Some(unit) = units.recv().await { while let Some(unit) = units.recv().await {
@@ -550,19 +780,20 @@ async fn read_inprocess(
/// whole IDR frame, otherwise large desktops get near-grey keyframes that sharpen over the GOP (#8). /// whole IDR frame, otherwise large desktops get near-grey keyframes that sharpen over the GOP (#8).
/// Half a second of bitrate still starved repeated 0.5 s-GOP keyframes at 3296x2036/2M; one second did not. /// Half a second of bitrate still starved repeated 0.5 s-GOP keyframes at 3296x2036/2M; one second did not.
fn buffer_kbits(max_kbps: u32, encoder: Encoder) -> u32 { fn buffer_kbits(max_kbps: u32, encoder: Encoder) -> u32 {
if encoder == Encoder::Cpu { max_kbps.clamp(500, 8000) } let env = match encoder {
else if encoder == Encoder::Vaapi { Encoder::Cpu => return max_kbps.clamp(500, 8000),
let requested = std::env::var("UU_VAAPI_BUFFER_MS").ok(); Encoder::Vaapi => "UU_VAAPI_BUFFER_MS",
vaapi_buffer_kbits(max_kbps, requested.as_deref()).unwrap_or((max_kbps / 8).clamp(100, 500)) Encoder::Nvenc => "UU_NVENC_BUFFER_MS",
} };
else { (max_kbps / 8).clamp(100, 500) } let requested = std::env::var(env).ok();
buffer_ms_kbits(max_kbps, requested.as_deref()).unwrap_or((max_kbps / 8).clamp(100, 500))
} }
/// Opt-in VAAPI VBV buffer: `码率上限 × 毫秒 / 1000` for `UU_VAAPI_BUFFER_MS` in 10-1000 ms. /// Opt-in hardware VBV buffer: `码率上限 × 毫秒 / 1000` for `UU_VAAPI_BUFFER_MS` /
/// The 100-500 kbit default is sized for NVENC; VAAPI quantizes a whole desktop keyframe when /// `UU_NVENC_BUFFER_MS` in 10-1000 ms. With the 100-500 kbit default the encoder quantizes a
/// the buffer is that small, which reads as a blur that sharpens over each GOP (#42). /// whole desktop keyframe, which reads as a blur that sharpens over each GOP (#42 VAAPI, #103 NVENC).
/// Unset, out of range or unparsable values keep the default buffer. /// Unset, out of range or unparsable values keep the default buffer.
fn vaapi_buffer_kbits(max_kbps: u32, value: Option<&str>) -> Option<u32> { fn buffer_ms_kbits(max_kbps: u32, value: Option<&str>) -> Option<u32> {
let ms = value?.trim().parse::<u32>().ok().filter(|ms| (10..=1000).contains(ms))?; let ms = value?.trim().parse::<u32>().ok().filter(|ms| (10..=1000).contains(ms))?;
Some((max_kbps.saturating_mul(ms) / 1000).max(1)) Some((max_kbps.saturating_mul(ms) / 1000).max(1))
} }
@@ -579,13 +810,17 @@ fn rate_args(settings: &VideoSettings, encoder: Encoder) -> (String, String) {
} }
async fn read_encoder_with( async fn read_encoder_with(
size: (u32,u32),display:String,portal:Option<Arc<crate::portal::PortalSession>>,latest:mpsc::Sender<Arc<CompleteFrame>>,encoder:Encoder,sequence:Arc<std::sync::atomic::AtomicU64>, size: (u32,u32),display:String,portal:Option<Arc<crate::portal::PortalSession>>,latest:mpsc::Sender<Arc<CompleteFrame>>,encoder:Encoder,
#[cfg_attr(not(feature = "inproc-av"), allow(unused_variables))] allow_inproc: bool,sequence:Arc<std::sync::atomic::AtomicU64>,
settings: VideoSettings, #[cfg_attr(not(feature = "inproc-av"), allow(unused_variables))] idr: Arc<AtomicBool>, budget: Arc<Semaphore>, settings: VideoSettings, #[cfg_attr(not(feature = "inproc-av"), allow(unused_variables))] idr: Arc<AtomicBool>, budget: Arc<Semaphore>,
selection: crate::video_select::Selection,
)->Result<(),String>{ )->Result<(),String>{
let selected_output=if display.starts_with("wayland:") {crate::wayland::source(settings.source_id)} else {None}; let selected_output=crate::wayland::capture_source(&display,portal.is_some(),settings.source_id);
let size=selected_output.map_or(size,|s|(s.width,s.height)); let size=selected_output.map_or(size,|s|(s.width,s.height));
let kms=display.starts_with("kms:"); let kms=display.starts_with("kms:");
let wayland=kms || display.starts_with("wayland:"); let wayland=kms || display.starts_with("wayland:");
// X11 multi-screen: x11grab reads only the selected monitor's region of the root.
let x11_region=selected_output.filter(|_|!wayland);
let (permits_tx,mut permits_rx)=mpsc::channel::<OwnedSemaphorePermit>(4); let (permits_tx,mut permits_rx)=mpsc::channel::<OwnedSemaphorePermit>(4);
let kms_capture=if kms { let kms_capture=if kms {
let capture=tokio::task::spawn_blocking(crate::kms::Capture::open).await.map_err(|_|"KMS worker failed")??; let capture=tokio::task::spawn_blocking(crate::kms::Capture::open).await.map_err(|_|"KMS worker failed")??;
@@ -593,17 +828,18 @@ async fn read_encoder_with(
Some(Arc::new(capture)) Some(Arc::new(capture))
} else { None }; } else { None };
#[cfg(feature = "inproc-av")] #[cfg(feature = "inproc-av")]
if !wayland && portal.is_none() && crate::inproc_encoder::selected() { if allow_inproc && x11_region.is_none() && native_inproc(&display, portal.is_some(), encoder) {
let max_kbps = settings.max_kbps().unwrap_or(30_000) as i64; let max_kbps = settings.max_kbps().unwrap_or(30_000) as i64;
let config = crate::inproc_encoder::Config { let config = crate::inproc_encoder::Config {
display: display.clone(), input: size, output: settings.output, fps: u32::from(settings.fps), display: display.clone(), input: size, output: settings.output, fps: u32::from(settings.fps),
gop: gop_frames(settings.fps, true) as u32, cq: settings.cq() as u32, gop: gop_frames(settings.fps, true) as u32, cq: settings.cq() as u32,
target_bps: settings.max_kbps().map_or(16_000, |k| i64::from(k) * 3 / 4) * 1000, target_bps: settings.max_kbps().map_or(16_000, |k| i64::from(k) * 3 / 4) * 1000,
max_bps: max_kbps * 1000, buffer_bits: i64::from(buffer_for(&settings, encoder)) * 1000, encoder, codec: settings.codec, max_bps: max_kbps * 1000, buffer_bits: i64::from(buffer_for(&settings, encoder)) * 1000, codec: settings.codec, chroma: settings.chroma,
damage: crate::inproc_encoder::damage_enabled(), vaapi: encoder == Encoder::Vaapi,
}; };
log::info!("Desktop encoder: display={} source={}x{} output={:?} fps={} cq={} maxrate={}k encoder={} pipeline=in-process", log::info!("Desktop encoder: display={} source={}x{} output={:?} fps={} cq={} maxrate={}k encoder={} source={} pipeline=in-process",
display,size.0,size.1,settings.output,settings.fps,config.cq,max_kbps,encoder.name_for(settings.codec)); display,size.0,size.1,settings.output,settings.fps,config.cq,max_kbps,encoder.name_for(settings.codec),
crate::video_select::encoder_source_label(selection.encoder_source));
return read_inprocess(config, latest, sequence, idr, budget).await; return read_inprocess(config, latest, sequence, idr, budget).await;
} }
let source_size = size; let source_size = size;
@@ -615,7 +851,7 @@ async fn read_encoder_with(
let cq = settings.cq().to_string(); let cq = settings.cq().to_string();
// x11grab delivers bgr0; the Wayland/portal/KMS pipe is bgra. // x11grab delivers bgr0; the Wayland/portal/KMS pipe is bgra.
let rgb = nvenc_rgb_input(&settings, encoder, if wayland { "bgra" } else { "bgr0" }); let rgb = nvenc_rgb_input(&settings, encoder, if wayland { "bgra" } else { "bgr0" });
log::info!("Desktop encoder: display={} source={} output={:?} fps={} cq={} maxrate={} encoder={} pix_fmt={} low_latency=true",display,size,settings.output,settings.fps,cq,maxrate,encoder.name_for(settings.codec),if encoder == Encoder::Vaapi { "nv12" } else { rgb.unwrap_or(chroma_args(&settings, encoder).1) }); log::info!("Desktop encoder: display={} source={} output={:?} fps={} cq={} maxrate={} encoder={} source={} pix_fmt={} low_latency=true",display,size,settings.output,settings.fps,cq,maxrate,encoder.name_for(settings.codec),crate::video_select::encoder_source_label(selection.encoder_source),if encoder == Encoder::Vaapi { "nv12" } else { rgb.unwrap_or(chroma_args(&settings, encoder).1) });
// A bundled FFmpeg prefix (config ffmpeg_root / UU_FFMPEG_ROOT) or `ffmpeg` on PATH. // A bundled FFmpeg prefix (config ffmpeg_root / UU_FFMPEG_ROOT) or `ffmpeg` on PATH.
let ffmpeg = ffmpeg_spec(); let ffmpeg = ffmpeg_spec();
let mut command = ffmpeg.command(); let mut command = ffmpeg.command();
@@ -626,8 +862,9 @@ async fn read_encoder_with(
"-framerate",&fps,"-i","pipe:0","-an"]); "-framerate",&fps,"-i","pipe:0","-an"]);
} else { } else {
// The viewer draws its local pointer; do not bake a second into video. // The viewer draws its local pointer; do not bake a second into video.
let input=x11_region.map_or_else(||display.clone(),|o|format!("{display}+{},{}",o.x,o.y));
command.args(["-f","x11grab","-draw_mouse","0","-framerate",&fps, command.args(["-f","x11grab","-draw_mouse","0","-framerate",&fps,
"-video_size",&size,"-i",&display,"-an"]); "-video_size",&size,"-i",&input,"-an"]);
} }
// 其他分辨率: scale the captured desktop (the host display mode is left untouched). // 其他分辨率: scale the captured desktop (the host display mode is left untouched).
command.args(scale_options(&settings, encoder, Some(source_size))); command.args(scale_options(&settings, encoder, Some(source_size)));
@@ -767,7 +1004,9 @@ pub(crate) fn transport_closed(pc: &RTCPeerConnection) -> bool {
|| pc.sctp().state() == webrtc::sctp_transport::sctp_transport_state::RTCSctpTransportState::Closed || pc.sctp().state() == webrtc::sctp_transport::sctp_transport_state::RTCSctpTransportState::Closed
} }
fn probe_settings() -> Result<VideoSettings,String> { /// Encoder and settings for `desktop-video-probe` / `UU_PROBE_INPUT`.
/// `UU_PROBE_CHROMA=444` is the viewer's 真彩 request, applied when the selected encoder can do 4:4:4.
pub(crate) fn probe_plan() -> Result<(crate::video_select::Selection, VideoSettings), String> {
let fps=crate::wayland::capture_fps(std::env::var("UU_PROBE_FPS").ok().as_deref())?; let fps=crate::wayland::capture_fps(std::env::var("UU_PROBE_FPS").ok().as_deref())?;
// UU_PROBE_QUALITY selects a viewer preset (1 fast 1M, 2 general 2M, 3 HD 8M, 4 bluray 20M, // UU_PROBE_QUALITY selects a viewer preset (1 fast 1M, 2 general 2M, 3 HD 8M, 4 bluray 20M,
// 5 auto); bitrate presets exercise the capped/ABR encoder path instead of CRF. // 5 auto); bitrate presets exercise the capped/ABR encoder path instead of CRF.
@@ -775,16 +1014,15 @@ fn probe_settings() -> Result<VideoSettings,String> {
None=>crate::capture_setting::QUALITY_AUTO, None=>crate::capture_setting::QUALITY_AUTO,
Some(v)=>v.parse::<u64>().ok().filter(|q|(1..=5).contains(q)).ok_or("UU_PROBE_QUALITY must be 1-5")?, Some(v)=>v.parse::<u64>().ok().filter(|q|(1..=5).contains(q)).ok_or("UU_PROBE_QUALITY must be 1-5")?,
}; };
Ok(VideoSettings {fps,quality,codec:probe_codec(),..VideoSettings::default()}) let mut settings=VideoSettings {fps,quality,..VideoSettings::default()};
} let selection = crate::video_select::selection();
let chroma = if std::env::var("UU_PROBE_CHROMA").as_deref()==Ok("444") { crate::capture_setting::CHROMA_444 } else { crate::capture_setting::CHROMA_420 };
/// The probe follows `UU_VIDEO_CODEC` so the HEVC path can be measured at all (H.264 otherwise), settings.codec = match crate::video_select::codec_force(selection.codec_pref) {
/// and its first access unit is then checked against that codec instead of always H.264. Some("h265") => VideoCodec::H265,
fn probe_codec() -> VideoCodec {
match std::env::var("UU_VIDEO_CODEC").ok().as_deref().map(str::to_ascii_lowercase).as_deref() {
Some("h265") | Some("hevc") => VideoCodec::H265,
_ => VideoCodec::H264, _ => VideoCodec::H264,
} };
if chroma == crate::capture_setting::CHROMA_444 && full_chroma_for(selection.encoder) { settings.chroma = chroma; }
Ok((selection, settings))
} }
fn probe_input_command(spec:&FfmpegSpec,input:&std::ffi::OsStr,loop_input:bool,settings:&VideoSettings, fn probe_input_command(spec:&FfmpegSpec,input:&std::ffi::OsStr,loop_input:bool,settings:&VideoSettings,
@@ -819,13 +1057,14 @@ async fn probe_input_size(spec:&FfmpegSpec,input:&std::ffi::OsStr)->Result<(u32,
/// Fixed input bypasses desktop initialization and always uses the FFmpeg process encoder. /// Fixed input bypasses desktop initialization and always uses the FFmpeg process encoder.
pub async fn probe_input(input:OsString,path:Option<String>)->Result<(),String> { pub async fn probe_input(input:OsString,path:Option<String>)->Result<(),String> {
ensure_auto_probed().await;
use std::io::Write; use std::io::Write;
let settings=probe_settings()?; let (selection, settings)=probe_plan()?;
let wanted:u64=std::env::var("UU_PROBE_FRAMES").ok().and_then(|v|v.parse().ok()).unwrap_or(5); let wanted:u64=std::env::var("UU_PROBE_FRAMES").ok().and_then(|v|v.parse().ok()).unwrap_or(5);
if wanted==0 { return Err("Fixed-input UU_PROBE_FRAMES must be positive".into()); } if wanted==0 { return Err("Fixed-input UU_PROBE_FRAMES must be positive".into()); }
let spec=ffmpeg_spec(); let spec=ffmpeg_spec();
let size=probe_input_size(&spec,&input).await?; let size=probe_input_size(&spec,&input).await?;
let encoder=Encoder::requested(); let encoder = selection.encoder;
let (maxrate,_)=rate_args(&settings,encoder); let (maxrate,_)=rate_args(&settings,encoder);
let output=settings.output.unwrap_or(size); let output=settings.output.unwrap_or(size);
println!("Fixed input probe: source={}x{} output={}x{} fps={} cq={} maxrate={} encoder={}", println!("Fixed input probe: source={}x{} output={}x{} fps={} cq={} maxrate={} encoder={}",
@@ -869,6 +1108,7 @@ pub async fn probe_input(input:OsString,path:Option<String>)->Result<(),String>
/// Exercise the real capture/encoder chain without UU auth or a network peer. /// Exercise the real capture/encoder chain without UU auth or a network peer.
pub async fn probe(size:(u32,u32),display:String,portal:Option<Arc<crate::portal::PortalSession>>,path:Option<String>)->Result<(),String> { pub async fn probe(size:(u32,u32),display:String,portal:Option<Arc<crate::portal::PortalSession>>,path:Option<String>)->Result<(),String> {
ensure_auto_probed().await;
use std::io::Write; use std::io::Write;
let mut file=match path { let mut file=match path {
Some(path)=>Some(std::fs::OpenOptions::new().write(true).create_new(true).open(path).map_err(|e|format!("Video probe file: {e}"))?), Some(path)=>Some(std::fs::OpenOptions::new().write(true).create_new(true).open(path).map_err(|e|format!("Video probe file: {e}"))?),
@@ -876,8 +1116,8 @@ pub async fn probe(size:(u32,u32),display:String,portal:Option<Arc<crate::portal
}; };
let (tx,mut rx)=mpsc::channel(4); let (tx,mut rx)=mpsc::channel(4);
let sequence=Arc::new(std::sync::atomic::AtomicU64::new(0)); let sequence=Arc::new(std::sync::atomic::AtomicU64::new(0));
let settings=probe_settings()?; let (selection, settings)=probe_plan()?;
let _reader=EncoderTask(tokio::spawn(read_encoder(size,display,portal,tx,settings,sequence,Arc::new(AtomicBool::new(false)),Arc::new(Semaphore::new(4))))); let _reader=EncoderTask(tokio::spawn(read_encoder(size,display,portal,tx,settings,sequence,Arc::new(AtomicBool::new(false)),Arc::new(Semaphore::new(4)),selection)));
let mut count=0; let mut count=0;
let mut bytes=0; let mut bytes=0;
// UU_PROBE_FRAMES lengthens the sample for baseline measurements; default is 5 frames. // UU_PROBE_FRAMES lengthens the sample for baseline measurements; default is 5 frames.
@@ -895,8 +1135,26 @@ pub async fn probe(size:(u32,u32),display:String,portal:Option<Arc<crate::portal
Ok(()) Ok(())
} }
fn keep_stream_display_awake() {
#[cfg(test)]
let result = wake_tests::wake().unwrap_or_else(crate::capture::keep_display_awake);
#[cfg(not(test))]
let result = crate::capture::keep_display_awake();
// Waking the output is optional; a transient failure does not mean capture failed.
if result.is_err() { log::warn!("Display wake failed; continuing desktop stream and retrying next interval"); }
}
/// `sync_tx` receives a Message 25 payload when a live encoder switch changes the encoded chroma.
pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_track::VideoTrack>, size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>, pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_track::VideoTrack>, size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>,
mut settings: tokio::sync::watch::Receiver<VideoSettings>, applied: Arc<tokio::sync::watch::Sender<VideoSettings>>, idr: Arc<AtomicBool>) -> Result<(), String> { settings: tokio::sync::watch::Receiver<VideoSettings>, applied: Arc<tokio::sync::watch::Sender<VideoSettings>>, idr: Arc<AtomicBool>,
selection: crate::video_select::Selection, sync_tx: Option<tokio::sync::mpsc::UnboundedSender<Vec<u8>>>) -> Result<(), String> {
stream_desktop_at(pc, track, size, display, portal, settings, applied, idr, selection, sync_tx, crate::video_select::reload_generation_value()).await
}
pub async fn stream_desktop_at(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_track::VideoTrack>, mut size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>,
mut settings: tokio::sync::watch::Receiver<VideoSettings>, applied: Arc<tokio::sync::watch::Sender<VideoSettings>>, idr: Arc<AtomicBool>,
selection: crate::video_select::Selection, sync_tx: Option<tokio::sync::mpsc::UnboundedSender<Vec<u8>>>, reload_at_session: u64) -> Result<(), String> {
let _desktop_mode = crate::desktop_mode::StreamGuard::new();
loop { loop {
if transport_closed(&pc) { return Ok(()); } if transport_closed(&pc) { return Ok(()); }
if pc.connection_state() == RTCPeerConnectionState::Connected if pc.connection_state() == RTCPeerConnectionState::Connected
@@ -905,7 +1163,7 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
} }
// Portal power/idle policy belongs to its CONTROL-scoped supervisor, // Portal power/idle policy belongs to its CONTROL-scoped supervisor,
// including when video has no frames or the user locks manually. // including when video has no frames or the user locks manually.
if portal.is_none() { crate::capture::keep_display_awake()?; } if portal.is_none() { keep_stream_display_awake(); }
let portal_stream = portal.is_some(); let portal_stream = portal.is_some();
let (latest, mut receiver) = mpsc::channel(4); let (latest, mut receiver) = mpsc::channel(4);
let budget=Arc::new(Semaphore::new(4)); let budget=Arc::new(Semaphore::new(4));
@@ -916,7 +1174,26 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
applied.send_replace(current); applied.send_replace(current);
settings.borrow_and_update(); settings.borrow_and_update();
} }
let mut reader = EncoderTask(tokio::spawn(read_encoder(size, display.clone(), portal.clone(), latest.clone(), current, sequence.clone(), idr.clone(), budget.clone()))); // SIGUSR2 re-reads host_settings and restarts this encoder when the effective encoder changes.
// The negotiated codec stays; a codec-only change is logged and applied on the next connection.
let mut live_selection = selection;
let mut seen_codec_pref = selection.codec_pref;
let mut reload = crate::video_select::subscribe_reload();
// Only a SIGUSR2 since the session snapshot. A probe that finishes during setup is not a reload
// (sessions started before the probe keep the legacy encoder for their lifetime).
let mut reload_pending = crate::video_select::reload_since_session(reload_at_session, *reload.borrow());
let open = {
let display = display.clone();
let portal = portal.clone();
let latest = latest.clone();
let sequence = sequence.clone();
let idr = idr.clone();
let budget = budget.clone();
move |size: (u32, u32), selection: crate::video_select::Selection, settings: VideoSettings| {
read_encoder(size, display.clone(), portal.clone(), latest.clone(), settings, sequence.clone(), idr.clone(), budget.clone(), selection)
}
};
let mut reader = EncoderTask(tokio::spawn(open(size, live_selection, current)));
let mut previous = None; let mut previous = None;
let mut timeline = RtpTimeline { fps: u64::from(current.fps), ..Default::default() }; let mut timeline = RtpTimeline { fps: u64::from(current.fps), ..Default::default() };
let mut settings_open = true; let mut settings_open = true;
@@ -931,30 +1208,76 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
let (mut window_frames, mut window_skipped) = (0u64, 0u64); let (mut window_frames, mut window_skipped) = (0u64, 0u64);
let mut send_interrupted=false; let mut send_interrupted=false;
'stream: loop { 'stream: loop {
if reload.has_changed().unwrap_or(false) || reload_pending {
reload_pending = false;
// Mark the watch seen. An unconsumed has_changed stays true and restarts every frame.
let _ = reload.borrow_and_update();
let fresh = crate::video_select::selection();
let plan = crate::video_select::plan_switch(live_selection.encoder, seen_codec_pref, &fresh, current.chroma);
if let Some(plan) = plan.filter(|plan| plan.encoder.is_some()) {
let encoder = plan.encoder.unwrap();
let chroma = if plan.chroma_downgraded { "420" } else if current.chroma == crate::capture_setting::CHROMA_444 { "444" } else { "420" };
log::info!("Encoder switch: {} -> {} reason={} chroma={chroma}",
format!("{:?}", live_selection.encoder).to_ascii_lowercase(),
format!("{encoder:?}").to_ascii_lowercase(),
crate::video_select::encoder_source_label(fresh.encoder_source));
live_selection.encoder = encoder;
live_selection.encoder_source = fresh.encoder_source;
seen_codec_pref = fresh.codec_pref;
if plan.chroma_downgraded {
applied.send_modify(|value| value.chroma = plan.chroma);
current.chroma = plan.chroma;
settings.borrow_and_update();
if let Some(sync) = sync_tx.as_ref() {
// Wayland: x11_resized is None, and the connection size can be a previous output.
let native = x11_resized(&display, portal_stream, size).unwrap_or_else(|| crate::wayland::sync_native(&display, current.source_id, size));
let payload = crate::capture_setting::sync_payload(&current, native);
let _ = sync.send(payload);
}
}
// In-process engines honor this on the first frame; the process pipeline starts on an IDR.
idr.store(true, std::sync::atomic::Ordering::Relaxed);
reader.restart(open(size, live_selection, current)).await;
} else if plan.is_some() {
log::info!("Codec preference changed; takes effect the next time a desktop connection starts");
seen_codec_pref = fresh.codec_pref;
live_selection.codec_pref = fresh.codec_pref;
live_selection.codec_source = fresh.codec_source;
}
}
let next = *settings.borrow_and_update(); let next = *settings.borrow_and_update();
if next != current || send_interrupted { if next != current || send_interrupted {
let discard = next.codec != current.codec || next.source_generation != current.source_generation || next.source_id != current.source_id || send_interrupted; let discard = next.codec != current.codec || next.source_generation != current.source_generation || next.source_id != current.source_id || send_interrupted;
current = next; current = next;
timeline.fps = u64::from(next.fps); timeline.fps = u64::from(next.fps);
// A viewer resolution choice may have changed the X11 display mode (desktop_mode).
if let Some(resized) = x11_resized(&display, portal_stream, size) { size = resized; }
if discard { if discard {
reader.0.abort(); reader.0.abort();
let _ = (&mut reader.0).await; let _ = (&mut reader.0).await;
while receiver.try_recv().is_ok() {} while receiver.try_recv().is_ok() {}
reader.0 = tokio::spawn(read_encoder(size, display.clone(), portal.clone(), latest.clone(), next, sequence.clone(), idr.clone(), budget.clone())); reader.0 = tokio::spawn(open(size, live_selection, next));
} else { } else {
reader.restart(read_encoder(size, display.clone(), portal.clone(), latest.clone(), next, sequence.clone(), idr.clone(), budget.clone())).await; reader.restart(open(size, live_selection, next)).await;
} }
send_interrupted=false; send_interrupted=false;
} }
tokio::select! { tokio::select! {
result = &mut reader.0 => { result = &mut reader.0 => {
let result = result.map_err(|e| format!("Encoder reader task: {e}"))?; let result = result.map_err(|e| format!("Encoder reader task: {e}"))?;
if let Some(resized) = result.as_ref().err().and_then(|_| x11_resized(&display, portal_stream, size)) {
log::info!("Desktop geometry changed during the stream ({}x{} -> {}x{}); restarting capture", size.0, size.1, resized.0, resized.1);
size = resized;
while receiver.try_recv().is_ok() {}
reader.0 = tokio::spawn(open(size, live_selection, current));
continue;
}
if let (Err(error), VideoCodec::H265, true) = (&result, current.codec, track.supports(VideoCodec::H264)) { if let (Err(error), VideoCodec::H265, true) = (&result, current.codec, track.supports(VideoCodec::H264)) {
log::warn!("HEVC stream failed ({error}); falling back to negotiated H264"); log::warn!("HEVC stream failed ({error}); falling back to negotiated H264");
applied.send_modify(|value| value.codec = VideoCodec::H264); applied.send_modify(|value| value.codec = VideoCodec::H264);
current = *settings.borrow_and_update(); current = *settings.borrow_and_update();
while receiver.try_recv().is_ok() {} while receiver.try_recv().is_ok() {}
reader.0 = tokio::spawn(read_encoder(size, display.clone(), portal.clone(), latest.clone(), current, sequence.clone(), idr.clone(), budget.clone())); reader.0 = tokio::spawn(open(size, live_selection, current));
continue; continue;
} }
if result.is_err() && !crate::wayland::outputs().is_empty() && !crate::wayland::input_ready() { if result.is_err() && !crate::wayland::outputs().is_empty() && !crate::wayland::input_ready() {
@@ -1009,8 +1332,10 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
previous = Some(frame.sequence); previous = Some(frame.sequence);
max_send_ms=max_send_ms.max(send_started.elapsed().as_millis()); max_send_ms=max_send_ms.max(send_started.elapsed().as_millis());
frames += 1; frames += 1;
#[cfg(test)]
if wake_tests::active() { stats = Instant::now() - Duration::from_secs(30); }
if stats.elapsed() >= Duration::from_secs(30) { if stats.elapsed() >= Duration::from_secs(30) {
if !portal_stream { crate::capture::keep_display_awake()?; } if !portal_stream { keep_stream_display_awake(); }
log::info!("Desktop latest-frame stats: sent={} skipped={} latest_seq={} window_s={} window_sent={} window_skipped={} max_slot_age_ms={} max_send_ms={}", log::info!("Desktop latest-frame stats: sent={} skipped={} latest_seq={} window_s={} window_sent={} window_skipped={} max_slot_age_ms={} max_send_ms={}",
frames, skipped, frame.sequence, stats.elapsed().as_secs(), frames - window_frames, skipped - window_skipped, max_age_ms, max_send_ms); frames, skipped, frame.sequence, stats.elapsed().as_secs(), frames - window_frames, skipped - window_skipped, max_age_ms, max_send_ms);
(window_frames, window_skipped) = (frames, skipped); (window_frames, window_skipped) = (frames, skipped);
@@ -1025,6 +1350,28 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
#[test]
fn nvidia_display_is_detected_from_connected_connectors() {
use std::os::unix::fs::symlink;
let root = std::env::temp_dir().join(format!("uu-drm-test-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&root);
let card = |n: &str, driver: &str, connector: &str, status: &str| {
std::fs::create_dir_all(root.join(format!("drivers/{driver}"))).unwrap();
std::fs::create_dir_all(root.join(format!("drm/{n}/device"))).unwrap();
let _ = symlink(root.join(format!("drivers/{driver}")), root.join(format!("drm/{n}/device/driver")));
std::fs::create_dir_all(root.join(format!("drm/{n}-{connector}"))).unwrap();
std::fs::write(root.join(format!("drm/{n}-{connector}/status")), format!("{status}\n")).unwrap();
};
let drm = root.join("drm");
card("card0", "i915", "HDMI-A-1", "connected");
card("card1", "nvidia", "DP-1", "disconnected");
assert!(!super::nvidia_drives_display(&drm), "iGPU drives the display");
card("card1", "nvidia", "DP-2", "connected");
assert!(super::nvidia_drives_display(&drm), "NVIDIA drives a display");
assert!(!super::nvidia_drives_display(&root.join("missing")));
let _ = std::fs::remove_dir_all(&root);
}
#[test] #[test]
fn native_frame_dimensions_are_padded_to_even() { fn native_frame_dimensions_are_padded_to_even() {
// A scaled compositor can report an odd logical desktop (e.g. two stacked 150% monitors → // A scaled compositor can report an odd logical desktop (e.g. two stacked 150% monitors →
@@ -1145,6 +1492,26 @@ mod tests {
assert!(!timing_args(FfmpegTimingMode::Modern, 60).contains(&"-r".to_owned())); assert!(!timing_args(FfmpegTimingMode::Modern, 60).contains(&"-r".to_owned()));
} }
#[test]
fn native_unprobed_only_when_x11_inproc_is_eligible() {
use crate::video_select::{outcome_for_candidate, ProbeFail, ProbeOutcome};
let exit = ProbeOutcome::Fail(ProbeFail::Exit);
for kind in [NativeDisplayKind::Wayland, NativeDisplayKind::Portal, NativeDisplayKind::Kms, NativeDisplayKind::None] {
assert!(!native_engine_eligible(Encoder::Nvenc, kind), "{kind:?}");
assert_eq!(outcome_for_candidate(exit, native_engine_eligible(Encoder::Nvenc, kind)), exit);
}
assert!(!native_engine_eligible(Encoder::Cpu, NativeDisplayKind::X11));
let x11 = native_engine_eligible(Encoder::Nvenc, NativeDisplayKind::X11);
let stored = outcome_for_candidate(exit, x11);
if cfg!(feature = "inproc-av") && native_engine_eligible(Encoder::Nvenc, NativeDisplayKind::X11) {
assert!(x11);
assert_eq!(stored, ProbeOutcome::NativeUnprobed);
} else {
assert!(!x11);
assert_eq!(stored, exit);
}
}
#[test] #[test]
fn timing_probe_failure_keeps_modern_args() { fn timing_probe_failure_keeps_modern_args() {
let modern = b" -fps_mode mode\n -enc_time_base ratio\n"; let modern = b" -fps_mode mode\n -enc_time_base ratio\n";
@@ -1204,26 +1571,21 @@ mod tests {
} }
#[test] #[test]
fn vaapi_buffer_env_is_opt_in_and_bounded() { fn hw_buffer_env_is_opt_in_and_bounded() {
assert_eq!(vaapi_buffer_kbits(30_000, None), None); assert_eq!(buffer_ms_kbits(30_000, None), None);
assert_eq!(vaapi_buffer_kbits(30_000, Some("250")), Some(7500)); assert_eq!(buffer_ms_kbits(30_000, Some("250")), Some(7500));
assert_eq!(vaapi_buffer_kbits(30_000, Some(" 10 ")), Some(300)); assert_eq!(buffer_ms_kbits(30_000, Some(" 10 ")), Some(300));
assert_eq!(vaapi_buffer_kbits(30_000, Some("1000")), Some(30_000)); assert_eq!(buffer_ms_kbits(30_000, Some("1000")), Some(30_000));
// Out of the documented range, empty or unparsable keeps the default buffer. // Out of the documented range, empty or unparsable keeps the default buffer.
for value in ["", "9", "1001", "0", "abc", "-250", "250ms"] { for value in ["", "9", "1001", "0", "abc", "-250", "250ms"] {
assert_eq!(vaapi_buffer_kbits(30_000, Some(value)), None, "{value}"); assert_eq!(buffer_ms_kbits(30_000, Some(value)), None, "{value}");
} }
// A tiny cap must not produce a zero-sized buffer. // A tiny cap must not produce a zero-sized buffer.
assert_eq!(vaapi_buffer_kbits(1, Some("10")), Some(1)); assert_eq!(buffer_ms_kbits(1, Some("10")), Some(1));
} }
#[test] #[test]
fn vaapi_is_explicit_and_upload_follows_scale() { fn vaapi_is_explicit_and_upload_follows_scale() {
assert_eq!(Encoder::from_setting(None, true), Encoder::Nvenc);
assert_eq!(Encoder::from_setting(None, false), Encoder::Cpu);
assert_eq!(Encoder::from_setting(Some("nvenc"), false), Encoder::Nvenc);
assert_eq!(Encoder::from_setting(Some("cpu"), true), Encoder::Cpu);
assert_eq!(Encoder::from_setting(Some("vaapi"), true), Encoder::Vaapi);
assert_eq!(vaapi_filter(None), "format=nv12,hwupload"); assert_eq!(vaapi_filter(None), "format=nv12,hwupload");
assert_eq!(vaapi_filter(Some((1280,720))), "scale=1280:720:flags=bilinear,format=nv12,hwupload"); assert_eq!(vaapi_filter(Some((1280,720))), "scale=1280:720:flags=bilinear,format=nv12,hwupload");
let options = vaapi_options(&VideoSettings::default(), "30"); let options = vaapi_options(&VideoSettings::default(), "30");
@@ -1353,7 +1715,25 @@ mod tests {
#[tokio::test] #[tokio::test]
#[ignore = "requires installed FFmpeg with a working HEVC encoder"] #[ignore = "requires installed FFmpeg with a working HEVC encoder"]
async fn hevc_capability_probe_initializes_real_encoder() { async fn hevc_capability_probe_initializes_real_encoder() {
assert!(hevc_available().await); assert!(hevc_available(crate::video_select::selection().encoder).await);
}
#[tokio::test]
async fn hevc_probe_cache_is_keyed_by_encoder_and_ffmpeg_spec() {
let cache = Mutex::new(HashMap::new());
let spec = FfmpegSpec { program: PathBuf::from("ffmpeg"), ld_library_path: None, path: None };
let other = FfmpegSpec { program: PathBuf::from("/opt/ffmpeg/bin/ffmpeg"), ld_library_path: None, path: None };
let calls = Arc::new(AtomicUsize::new(0));
let lookup = |spec: &FfmpegSpec, encoder: Encoder, result: bool| {
let cell = hevc_cell(&cache, spec, encoder);
let calls = calls.clone();
async move { *cell.get_or_init(|| async move { calls.fetch_add(1, Ordering::SeqCst); result }).await }
};
assert!(lookup(&spec, Encoder::Cpu, true).await);
assert!(lookup(&spec, Encoder::Cpu, false).await);
assert_eq!(calls.load(Ordering::SeqCst), 1);
assert!(!lookup(&spec, Encoder::Nvenc, false).await);
assert!(lookup(&other, Encoder::Cpu, true).await);
assert_eq!(calls.load(Ordering::SeqCst), 3);
} }
#[test] #[test]
fn hevc_annex_b_boundaries_and_irap_use_two_byte_headers() { fn hevc_annex_b_boundaries_and_irap_use_two_byte_headers() {
+897
View File
@@ -0,0 +1,897 @@
//! Runtime encoder / codec preference. host_settings.json beats the environment,
//! and "auto" or a missing field falls through. Illegal values are ignored.
//! Auto follows `auto_order` (NVENC then CPU when NVIDIA is present, else CPU).
//! A finished background probe can replace that choice; an unfinished probe keeps
//! the legacy NVIDIA/CPU result so the first connection is not delayed.
use crate::video::Encoder;
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Source {
Setting,
Env,
Auto,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum CodecPref {
Auto,
H264,
H265,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Selection {
pub encoder: Encoder,
pub encoder_source: Source,
pub codec_pref: CodecPref,
pub codec_source: Source,
}
pub fn parse_encoder(value: Option<&str>) -> Option<Option<Encoder>> {
match value
.map(str::trim)
.filter(|s| !s.is_empty())
.map(|s| s.to_ascii_lowercase())
{
None => Some(None),
Some(v) if v == "auto" => Some(None),
Some(v) if v == "cpu" => Some(Some(Encoder::Cpu)),
Some(v) if v == "vaapi" => Some(Some(Encoder::Vaapi)),
Some(v) if v == "nvenc" => Some(Some(Encoder::Nvenc)),
Some(_) => None,
}
}
pub fn parse_codec(value: Option<&str>) -> Option<Option<CodecPref>> {
match value
.map(str::trim)
.filter(|s| !s.is_empty())
.map(|s| s.to_ascii_lowercase())
{
None => Some(None),
Some(v) if v == "auto" => Some(None),
Some(v) if v == "h264" => Some(Some(CodecPref::H264)),
Some(v) if v == "h265" || v == "hevc" => Some(Some(CodecPref::H265)),
Some(_) => None,
}
}
fn file_fields() -> (Option<String>, Option<String>) {
let path = crate::system_actions::settings_path();
let Ok(bytes) = std::fs::read(path) else { return (None, None) };
let Ok(value) = serde_json::from_slice::<serde_json::Value>(&bytes) else { return (None, None) };
let field = |name: &str| value.get(name).and_then(|v| v.as_str()).map(str::to_owned);
(field("video_encoder"), field("video_codec"))
}
/// Unset/auto tries NVENC only with an NVIDIA driver loaded: `ffmpeg -encoders` lists h264_nvenc
/// on any machine, so without this every stream start first ran a doomed NVENC process (#10).
pub fn legacy_auto(nvidia: bool) -> Encoder {
if nvidia { Encoder::Nvenc } else { Encoder::Cpu }
}
/// Auto candidate order. NVIDIA present: NVENC then CPU. No NVIDIA: CPU only.
/// VAAPI is not an auto candidate until #33 (FFmpeg-process VAAPI ignores maxrate).
/// Explicit vaapi (setting or `UU_VIDEO_ENCODER`) is unchanged.
pub fn auto_order(nvidia: bool) -> Vec<Encoder> {
if nvidia { vec![Encoder::Nvenc, Encoder::Cpu] } else { vec![Encoder::Cpu] }
}
/// Why one candidate's synthetic IDR did not count. Logged as the variant name only.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ProbeFail { Timeout, NoIdr, Spawn, Exit }
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ProbeOutcome {
Ok,
Fail(ProbeFail),
/// inproc-av only: the FFmpeg process probe failed, but this session would try the native
/// engine first (`read_encoder_with`) on an X11 display (not Wayland, portal, or KMS).
/// Opening that engine needs a display, so the candidate is not failed here; auto falls
/// back to the pre-probe NVIDIA/CPU choice for it.
NativeUnprobed,
/// Single auto candidate (CPU, no NVIDIA): the synthetic IDR is skipped.
NotProbed,
}
impl ProbeOutcome {
/// Counts as a successful probe for `choose_from_probe`.
/// `NativeUnprobed` does not: that candidate was not shown to encode.
pub fn ok(self) -> bool { matches!(self, Self::Ok) }
pub fn label(self) -> &'static str {
match self {
Self::Ok => "ok",
Self::Fail(ProbeFail::Timeout) => "timeout",
Self::Fail(ProbeFail::NoIdr) => "no_idr",
Self::Fail(ProbeFail::Spawn) => "spawn",
Self::Fail(ProbeFail::Exit) => "exit",
Self::NativeUnprobed => "native_unprobed",
Self::NotProbed => "not probed (only candidate)",
}
}
}
/// How a process-probe result becomes the stored outcome.
/// `native_would_run` is true only on inproc-av when `inproc_encoder::selected` is true
/// (hardware, not `UU_VIDEO_PIPELINE=process` / `UU_CAPTURE=grab` / a bundled FFmpeg).
/// A process failure then becomes `NativeUnprobed` instead of disqualifying that candidate.
/// Default builds pass `native_would_run = false`, so the process result is unchanged.
pub fn outcome_for_candidate(process: ProbeOutcome, native_would_run: bool) -> ProbeOutcome {
if process.ok() || !native_would_run { process } else { ProbeOutcome::NativeUnprobed }
}
/// Encoder auto should use when a hardware candidate was left `NativeUnprobed`.
/// That candidate is skipped by `choose_from_probe`; if it was the legacy pick (NVENC when
/// NVIDIA is present), keep the legacy encoder. Otherwise use the probe choice.
pub fn chosen_after_native(nvidia: bool, order: &[Encoder], outcomes: &[ProbeOutcome], probed: Encoder) -> Encoder {
let legacy = legacy_auto(nvidia);
let native_legacy = order.iter().zip(outcomes.iter()).any(|(e, o)| {
*e == legacy && matches!(o, ProbeOutcome::NativeUnprobed)
});
if native_legacy { legacy } else { probed }
}
/// How long a hardware-candidate failure stays cached. A boot-time NVENC miss
/// (module not ready, GPU busy, consumer session limit) must not stick until exit.
pub const PROBE_FAILURE_TTL: std::time::Duration = std::time::Duration::from_secs(600);
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ProbeReport {
pub order: Vec<Encoder>,
pub outcomes: Vec<ProbeOutcome>,
pub chosen: Encoder,
/// `None` means the result does not expire (success, or CPU-only `NotProbed`).
pub expires_at: Option<std::time::Instant>,
/// `nvidia_present()` at the time the report was stored. A later desktop
/// connection whose presence differs treats the report as stale.
pub nvidia: bool,
}
impl ProbeReport {
pub fn fresh(order: Vec<Encoder>, outcomes: Vec<ProbeOutcome>, chosen: Encoder, now: std::time::Instant, nvidia: bool) -> Self {
let expires_at = probe_failure_deadline(&order, &outcomes, chosen, now);
Self { order, outcomes, chosen, expires_at, nvidia }
}
}
/// Expiry is only for the hardware candidate that caused the CPU fallback
/// (NVENC `Fail` and `chosen == Cpu`). A `Fail` on CPU while NVENC is `Ok`
/// does not expire, and doctor does not label that report a failure.
/// `NotProbed` and `Ok` do not. `NativeUnprobed` keeps the legacy encoder
/// and is not a failure cache.
pub fn probe_failure_deadline(
order: &[Encoder],
outcomes: &[ProbeOutcome],
chosen: Encoder,
now: std::time::Instant,
) -> Option<std::time::Instant> {
let hardware_failed = order.iter().zip(outcomes).any(|(encoder, outcome)| {
*encoder != Encoder::Cpu && matches!(outcome, ProbeOutcome::Fail(_))
});
(hardware_failed && chosen == Encoder::Cpu).then_some(now + PROBE_FAILURE_TTL)
}
pub fn probe_expired(report: &ProbeReport, now: std::time::Instant) -> bool {
report.expires_at.is_some_and(|at| now >= at)
}
/// Time-to-live elapsed, or NVIDIA presence no longer matches the report.
/// Presence is `nvidia_present()` (proc version or `/dev/nvidia0`).
pub fn probe_stale(report: &ProbeReport, now: std::time::Instant, nvidia: bool) -> bool {
probe_expired(report, now) || report.nvidia != nvidia
}
/// Log suffix for a probe that replaces `previous`. `None` is a first probe.
/// A failure deadline (`expires_at`) is "retry after failure". A presence
/// mismatch without that deadline is "NVIDIA availability changed".
pub fn reprobe_reason(previous: Option<&ProbeReport>, nvidia_now: bool) -> Option<&'static str> {
let previous = previous?;
if previous.expires_at.is_some() {
Some("retry after failure")
} else if previous.nvidia != nvidia_now {
Some("NVIDIA availability changed")
} else {
None
}
}
/// Empty cache, or the cached report is stale for `nvidia` at `now`.
/// Callers still use the cached encoder until the replacement probe is stored.
pub fn probe_needs_run(now: std::time::Instant, nvidia: bool) -> bool {
match cached_probe() {
None => true,
Some(report) => probe_stale(&report, now, nvidia),
}
}
/// Background warm-up (startup and each new desktop connection) runs only for auto.
/// Setting or `UU_VIDEO_ENCODER` (non-auto) matches v0.2.23: no GPU probe.
pub fn should_warm_auto_probe(source: Source) -> bool {
source == Source::Auto
}
/// First candidate that produced an IDR, else CPU.
pub fn choose_from_probe(order: &[Encoder], outcomes: &[ProbeOutcome]) -> Encoder {
order.iter().zip(outcomes.iter()).find_map(|(e, o)| o.ok().then_some(*e)).unwrap_or(Encoder::Cpu)
}
fn cache() -> &'static std::sync::Mutex<Option<ProbeReport>> {
static CACHE: std::sync::OnceLock<std::sync::Mutex<Option<ProbeReport>>> = std::sync::OnceLock::new();
CACHE.get_or_init(|| std::sync::Mutex::new(None))
}
pub fn store_probe(report: ProbeReport) {
if let Ok(mut slot) = cache().lock() { *slot = Some(report); }
}
pub fn cached_probe() -> Option<ProbeReport> {
cache().lock().ok().and_then(|g| g.clone())
}
/// Tests that call `clear_probe` / `store_probe` share this lock. The probe
/// cache is process-global and `cargo test` runs tests in parallel.
#[cfg(test)]
pub(crate) static PROBE_TEST_LOCK: std::sync::Mutex<()> = std::sync::Mutex::new(());
/// Tests that read or bump the process-global reload generation share this lock.
#[cfg(test)]
pub(crate) static RELOAD_TEST_LOCK:std::sync::Mutex<()> = std::sync::Mutex::new(());
#[cfg(test)]
pub fn clear_probe() {
if let Ok(mut slot) = cache().lock() { *slot = None; }
}
/// Why a live desktop encoder was asked to change.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum SwitchReason {
/// Effective encoder differs. The log line uses `Selection::encoder_source`, not this variant.
Encoder,
/// Codec preference changed. The negotiated codec stays until the next stream.
CodecDeferred,
}
/// What SIGUSR2 should do to one live desktop stream.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct SwitchPlan {
/// Restart the encoder. None keeps the running encoder (codec-only or no change).
pub encoder: Option<Encoder>,
pub reason: SwitchReason,
/// Chroma the restarted encoder can actually produce. VAAPI has no 4:4:4.
pub chroma: u64,
/// True when the request was 4:4:4 and the new encoder must report 4:2:0.
pub chroma_downgraded: bool,
}
/// Compare the selection this stream is using with a freshly read one.
/// Codec preference is the stored preference, not the negotiated m-line codec.
pub fn plan_switch(active_encoder: Encoder, previous_codec: CodecPref, next: &Selection, active_chroma: u64) -> Option<SwitchPlan> {
if next.encoder != active_encoder {
let chroma = if active_chroma == crate::capture_setting::CHROMA_444 && !crate::video::full_chroma_for(next.encoder) {
crate::capture_setting::CHROMA_420
} else {
active_chroma
};
return Some(SwitchPlan {
encoder: Some(next.encoder),
reason: SwitchReason::Encoder,
chroma,
chroma_downgraded: chroma != active_chroma,
});
}
if next.codec_pref != previous_codec {
return Some(SwitchPlan {
encoder: None,
reason: SwitchReason::CodecDeferred,
chroma: active_chroma,
chroma_downgraded: false,
});
}
None
}
/// Monotonic generation bumped by SIGUSR2. Streams watch it and re-read `selection()`.
fn reload_generation() -> &'static std::sync::atomic::AtomicU64 {
static GEN: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
&GEN
}
pub fn reload_generation_value() -> u64 {
reload_generation().load(std::sync::atomic::Ordering::Relaxed)
}
/// SIGUSR2: ask live desktop streams to re-read host_settings. Does not clear the probe cache.
pub fn notify_reload() {
reload_generation().fetch_add(1, std::sync::atomic::Ordering::Relaxed);
}
pub fn reload_watch() -> &'static tokio::sync::watch::Sender<u64> {
static WATCH: std::sync::OnceLock<tokio::sync::watch::Sender<u64>> = std::sync::OnceLock::new();
WATCH.get_or_init(|| {
let (tx, _) = tokio::sync::watch::channel(reload_generation_value());
tx
})
}
pub fn subscribe_reload() -> tokio::sync::watch::Receiver<u64> {
reload_watch().subscribe()
}
/// True when SIGUSR2 has bumped the generation since the session snapshot.
/// A background auto probe that finishes during setup does not bump it.
pub fn reload_since_session(at_session: u64, current: u64) -> bool {
current != at_session
}
/// Publish the generation so every subscribed desktop stream wakes.
pub fn publish_reload() {
notify_reload();
// send() drops the value when nobody is subscribed (the gap between desktop connections).
reload_watch().send_replace(reload_generation_value());
}
/// Setting (non-auto) beats the environment, which beats the NVIDIA/CPU default.
pub fn selection() -> Selection {
selection_with(cached_probe().as_ref())
}
/// Same as `selection`, but auto uses `report` when it is already cached.
/// `None` keeps the legacy NVIDIA/CPU result (the probe is still running or has not started).
pub fn selection_with(report: Option<&ProbeReport>) -> Selection {
let (file_enc, file_codec) = file_fields();
let env_enc = std::env::var("UU_VIDEO_ENCODER").ok();
let env_codec = std::env::var("UU_VIDEO_CODEC").ok();
resolve_pair(file_enc.as_deref(), env_enc.as_deref(), file_codec.as_deref(), env_codec.as_deref(), crate::video::nvidia_present(), report)
}
pub fn resolve_pair(
enc_setting: Option<&str>,
enc_env: Option<&str>,
codec_setting: Option<&str>,
codec_env: Option<&str>,
nvidia: bool,
probed: Option<&ProbeReport>,
) -> Selection {
let (encoder, encoder_source) = match parse_encoder(enc_setting) {
Some(Some(e)) => (e, Source::Setting),
None => {
log::warn!("Ignoring video_encoder value (not auto/cpu/vaapi/nvenc)");
pick_encoder(enc_env, nvidia, probed)
}
Some(None) => pick_encoder(enc_env, nvidia, probed),
};
let (codec_pref, codec_source) = match parse_codec(codec_setting) {
Some(Some(p)) => (p, Source::Setting),
None => {
log::warn!("Ignoring video_codec value (not auto/h264/h265)");
pick_codec(codec_env)
}
Some(None) => pick_codec(codec_env),
};
Selection {
encoder,
encoder_source,
codec_pref,
codec_source,
}
}
fn pick_encoder(env: Option<&str>, nvidia: bool, probed: Option<&ProbeReport>) -> (Encoder, Source) {
match parse_encoder(env) {
Some(Some(e)) => (e, Source::Env),
None => {
log::warn!("Ignoring UU_VIDEO_ENCODER value (not auto/cpu/vaapi/nvenc)");
(auto_encoder(nvidia, probed), Source::Auto)
}
Some(None) => (auto_encoder(nvidia, probed), Source::Auto),
}
}
fn auto_encoder(nvidia: bool, probed: Option<&ProbeReport>) -> Encoder {
probed.map(|p| p.chosen).unwrap_or_else(|| legacy_auto(nvidia))
}
fn pick_codec(env: Option<&str>) -> (CodecPref, Source) {
match parse_codec(env) {
Some(Some(p)) => (p, Source::Env),
None => {
log::warn!("Ignoring UU_VIDEO_CODEC value (not auto/h264/h265)");
(CodecPref::Auto, Source::Auto)
}
Some(None) => (CodecPref::Auto, Source::Auto),
}
}
pub fn codec_force(pref: CodecPref) -> Option<&'static str> {
match pref {
CodecPref::H264 => Some("h264"),
CodecPref::H265 => Some("h265"),
CodecPref::Auto => None,
}
}
/// Hardware (VAAPI / NVENC) prefers H.265 unless the preference forces a codec.
pub fn hardware(encoder: Encoder) -> bool {
encoder != Encoder::Cpu
}
pub fn source_label(source: Source) -> &'static str {
match source {
Source::Setting => "setting",
Source::Env => "env",
Source::Auto => "default",
}
}
pub fn encoder_source_label(source: Source) -> &'static str {
match source {
Source::Setting => "setting",
Source::Env => "env",
Source::Auto => "auto",
}
}
#[cfg(test)]
mod tests {
use super::*;
fn sel(
es: Option<&str>,
ee: Option<&str>,
cs: Option<&str>,
ce: Option<&str>,
nvidia: bool,
) -> Selection {
resolve_pair(es, ee, cs, ce, nvidia, None)
}
#[test]
fn priority_matrix_and_illegal_values() {
let encoders = [
None,
Some("auto"),
Some("cpu"),
Some("vaapi"),
Some("nvenc"),
Some("bogus"),
];
let codecs = [None, Some("auto"), Some("h264"), Some("h265"), Some("nope")];
for setting in encoders {
for env in encoders {
let got = sel(setting, env, None, None, true);
let expect_enc = match (parse_encoder(setting), parse_encoder(env)) {
(Some(Some(e)), _) => (e, Source::Setting),
(None, Some(Some(e))) | (Some(None), Some(Some(e))) => (e, Source::Env),
_ => (Encoder::Nvenc, Source::Auto),
};
assert_eq!(
(got.encoder, got.encoder_source),
expect_enc,
"{setting:?} {env:?}"
);
}
}
for setting in codecs {
for env in codecs {
let got = sel(None, None, setting, env, false);
let expect = match (parse_codec(setting), parse_codec(env)) {
(Some(Some(p)), _) => (p, Source::Setting),
(None, Some(Some(p))) | (Some(None), Some(Some(p))) => (p, Source::Env),
_ => (CodecPref::Auto, Source::Auto),
};
assert_eq!(
(got.codec_pref, got.codec_source),
expect,
"{setting:?} {env:?}"
);
}
}
assert_eq!(
sel(Some("auto"), Some("cpu"), Some("auto"), Some("h264"), true).encoder,
Encoder::Cpu
);
assert_eq!(
sel(Some("auto"), None, None, None, false).encoder,
Encoder::Cpu
);
assert_eq!(
sel(None, Some("auto"), None, None, true).encoder,
Encoder::Nvenc
);
assert_eq!(
sel(Some(" NVENC "), None, Some(" HEVC "), None, false).encoder,
Encoder::Nvenc
);
assert_eq!(
sel(None, None, Some(" HEVC "), None, false).codec_pref,
CodecPref::H265
);
}
#[test]
fn process_failure_keeps_native_candidate_unprobed() {
let exit = ProbeOutcome::Fail(ProbeFail::Exit);
assert_eq!(outcome_for_candidate(ProbeOutcome::Ok, true), ProbeOutcome::Ok);
assert_eq!(outcome_for_candidate(exit, false), exit, "default build keeps the process result");
assert_eq!(outcome_for_candidate(exit, true), ProbeOutcome::NativeUnprobed);
assert!(!ProbeOutcome::NativeUnprobed.ok());
assert_eq!(ProbeOutcome::NativeUnprobed.label(), "native_unprobed");
}
#[test]
fn native_unprobed_hardware_uses_legacy_choice() {
let order = auto_order(true);
let outcomes = [ProbeOutcome::NativeUnprobed, ProbeOutcome::Ok];
let probed = choose_from_probe(&order, &outcomes);
assert_eq!(probed, Encoder::Cpu);
assert_eq!(chosen_after_native(true, &order, &outcomes, probed), Encoder::Nvenc);
let cpu_only = auto_order(false);
assert_eq!(chosen_after_native(false, &cpu_only, &[ProbeOutcome::Ok], Encoder::Cpu), Encoder::Cpu);
let both_ok = [ProbeOutcome::Ok, ProbeOutcome::Ok];
assert_eq!(chosen_after_native(true, &order, &both_ok, Encoder::Nvenc), Encoder::Nvenc);
}
fn probe_report(nvidia: bool, outcomes: &[ProbeOutcome]) -> ProbeReport {
let order = auto_order(nvidia);
let chosen = choose_from_probe(&order, outcomes);
ProbeReport::fresh(order, outcomes.to_vec(), chosen, std::time::Instant::now(), nvidia)
}
#[test]
fn auto_order_keeps_nvenc_when_nvidia_is_present() {
assert_eq!(auto_order(true), vec![Encoder::Nvenc, Encoder::Cpu]);
assert_eq!(auto_order(false), vec![Encoder::Cpu]);
assert_eq!(legacy_auto(true), Encoder::Nvenc);
assert_eq!(legacy_auto(false), Encoder::Cpu);
}
#[test]
fn auto_falls_back_when_the_first_candidate_fails() {
let both = probe_report(true, &[ProbeOutcome::Fail(ProbeFail::NoIdr), ProbeOutcome::Fail(ProbeFail::Exit)]);
assert_eq!(both.chosen, Encoder::Cpu);
let nv = probe_report(true, &[ProbeOutcome::Ok, ProbeOutcome::Ok]);
assert_eq!(nv.chosen, Encoder::Nvenc);
let failed = probe_report(true, &[ProbeOutcome::Fail(ProbeFail::Timeout), ProbeOutcome::Ok]);
assert_eq!(failed.chosen, Encoder::Cpu);
assert_eq!(resolve_pair(None, None, None, None, true, Some(&nv)).encoder, Encoder::Nvenc);
assert_eq!(resolve_pair(None, None, None, None, true, Some(&failed)).encoder, Encoder::Cpu);
let cpu = probe_report(false, &[ProbeOutcome::Ok]);
assert_eq!(cpu.chosen, Encoder::Cpu);
assert_eq!(resolve_pair(None, None, None, None, false, Some(&cpu)).encoder, Encoder::Cpu);
let skipped = probe_report(false, &[ProbeOutcome::NotProbed]);
assert_eq!(skipped.chosen, Encoder::Cpu);
assert_eq!(ProbeOutcome::NotProbed.label(), "not probed (only candidate)");
assert!(!ProbeOutcome::NotProbed.ok());
assert_eq!(resolve_pair(None, None, None, None, false, Some(&skipped)).encoder, Encoder::Cpu);
}
#[test]
fn explicit_env_and_setting_ignore_the_probe() {
let va = probe_report(true, &[ProbeOutcome::Ok, ProbeOutcome::Ok]);
assert_eq!(resolve_pair(None, Some("nvenc"), None, None, false, Some(&va)).encoder, Encoder::Nvenc);
assert_eq!(resolve_pair(None, Some("cpu"), None, None, true, Some(&va)).encoder, Encoder::Cpu);
assert_eq!(resolve_pair(Some("vaapi"), Some("nvenc"), None, None, true, Some(&va)).encoder, Encoder::Vaapi);
assert_eq!(resolve_pair(Some("nvenc"), None, None, None, false, Some(&va)).encoder_source, Source::Setting);
assert_eq!(resolve_pair(None, Some("cpu"), None, None, false, Some(&va)).encoder_source, Source::Env);
assert_eq!(resolve_pair(Some("auto"), Some("vaapi"), None, None, false, None).encoder, Encoder::Vaapi);
assert_eq!(resolve_pair(None, None, None, Some("h264"), false, Some(&va)).codec_pref, CodecPref::H264);
}
fn selection_of(encoder: Encoder, codec: CodecPref) -> Selection {
Selection { encoder, encoder_source: Source::Setting, codec_pref: codec, codec_source: Source::Setting }
}
#[test]
fn live_switch_restarts_encoder_and_defers_codec() {
let nv = selection_of(Encoder::Nvenc, CodecPref::Auto);
assert!(plan_switch(Encoder::Nvenc, CodecPref::Auto, &nv, crate::capture_setting::CHROMA_420).is_none());
let to_cpu = plan_switch(Encoder::Nvenc, CodecPref::Auto, &selection_of(Encoder::Cpu, CodecPref::Auto), crate::capture_setting::CHROMA_444).unwrap();
assert_eq!(to_cpu.encoder, Some(Encoder::Cpu));
assert_eq!(to_cpu.reason, SwitchReason::Encoder);
assert!(!to_cpu.chroma_downgraded);
assert_eq!(to_cpu.chroma, crate::capture_setting::CHROMA_444);
let to_vaapi = plan_switch(Encoder::Nvenc, CodecPref::H265, &selection_of(Encoder::Vaapi, CodecPref::H265), crate::capture_setting::CHROMA_444).unwrap();
assert_eq!(to_vaapi.encoder, Some(Encoder::Vaapi));
assert!(to_vaapi.chroma_downgraded);
assert_eq!(to_vaapi.chroma, crate::capture_setting::CHROMA_420);
let codec = plan_switch(Encoder::Nvenc, CodecPref::Auto, &selection_of(Encoder::Nvenc, CodecPref::H264), crate::capture_setting::CHROMA_420).unwrap();
assert_eq!(codec.encoder, None);
assert_eq!(codec.reason, SwitchReason::CodecDeferred);
let both = plan_switch(Encoder::Cpu, CodecPref::Auto, &selection_of(Encoder::Nvenc, CodecPref::H264), crate::capture_setting::CHROMA_420).unwrap();
assert_eq!(both.encoder, Some(Encoder::Nvenc));
assert_eq!(both.reason, SwitchReason::Encoder);
// The log reason is the source of the new selection (setting / env / auto), not a fixed word.
for (source, label) in [(Source::Setting, "setting"), (Source::Env, "env"), (Source::Auto, "auto")] {
let mut next = selection_of(Encoder::Vaapi, CodecPref::Auto);
next.encoder_source = source;
let plan = plan_switch(Encoder::Nvenc, CodecPref::Auto, &next, crate::capture_setting::CHROMA_420).unwrap();
assert!(plan.encoder.is_some());
assert_eq!(encoder_source_label(next.encoder_source), label);
}
}
#[test]
fn reload_does_not_clear_the_probe_cache() {
let _reload = RELOAD_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
let _guard = PROBE_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
let report = probe_report(true, &[ProbeOutcome::Ok, ProbeOutcome::Ok]);
store_probe(report.clone());
let before = reload_generation_value();
notify_reload();
assert_eq!(reload_generation_value(), before + 1);
assert_eq!(cached_probe(), Some(report));
assert!(reload_since_session(before, reload_generation_value()));
assert!(!reload_since_session(reload_generation_value(), reload_generation_value()));
clear_probe();
}
#[test]
fn probe_finish_is_not_a_reload_since_the_session_snapshot() {
let _reload = RELOAD_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
let at_session = reload_generation_value();
// A finished background probe updates the cache only. It does not bump the generation.
assert!(!reload_since_session(at_session, reload_generation_value()));
notify_reload();
assert!(reload_since_session(at_session, reload_generation_value()));
}
#[test]
fn mark_reload_seen_clears_has_changed() {
let _reload = RELOAD_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().unwrap();
rt.block_on(async {
let mut watch = subscribe_reload();
let _ = watch.borrow_and_update();
publish_reload();
assert!(watch.has_changed().unwrap());
let _ = watch.borrow_and_update();
assert!(!watch.has_changed().unwrap());
});
}
/// Codec at CONTROL open is `preferred_codec_for` on the session snapshot.
/// Auto + CPU uses H.264 when both codecs are negotiated; auto + NVENC keeps H.265.
/// Forced codec ignores the encoder. 真彩 does not switch codec (true_color_keeps_codec_and_vaapi_reports_420).
#[test]
fn auto_codec_follows_the_encoder_chosen_at_session_setup() {
use crate::capture_setting::{preferred_codec_for, VideoCodec};
let cpu_fallback = probe_report(true, &[ProbeOutcome::Fail(ProbeFail::NoIdr), ProbeOutcome::Ok]);
let session = resolve_pair(None, None, None, None, true, Some(&cpu_fallback));
assert_eq!((session.encoder, session.encoder_source, session.codec_pref), (Encoder::Cpu, Source::Auto, CodecPref::Auto));
assert_eq!(preferred_codec_for(true, true, session), VideoCodec::H264);
// Not the H.265 an unfinished probe would pick for legacy NVENC.
let early_nvenc = resolve_pair(None, None, None, None, true, None);
assert_eq!(early_nvenc.encoder, Encoder::Nvenc);
assert_eq!(preferred_codec_for(true, true, early_nvenc), VideoCodec::H265);
let nvenc_ok = probe_report(true, &[ProbeOutcome::Ok, ProbeOutcome::Ok]);
let nvenc = resolve_pair(None, None, None, None, true, Some(&nvenc_ok));
assert_eq!(nvenc.encoder, Encoder::Nvenc);
assert_eq!(preferred_codec_for(true, true, nvenc), VideoCodec::H265);
let order = auto_order(true);
let unprobed = [ProbeOutcome::NativeUnprobed, ProbeOutcome::Ok];
let chosen = chosen_after_native(true, &order, &unprobed, choose_from_probe(&order, &unprobed));
let report = ProbeReport::fresh(order.clone(), unprobed.to_vec(), chosen, std::time::Instant::now(), true);
let native = resolve_pair(None, None, None, None, true, Some(&report));
assert_eq!(native.encoder, Encoder::Nvenc);
assert_eq!(preferred_codec_for(true, true, native), VideoCodec::H265);
let forced_h264 = resolve_pair(None, None, Some("h264"), None, true, Some(&nvenc_ok));
assert_eq!(forced_h264.encoder, Encoder::Nvenc);
assert_eq!(preferred_codec_for(true, true, forced_h264), VideoCodec::H264);
let forced_h265 = resolve_pair(None, None, None, Some("h265"), true, Some(&cpu_fallback));
assert_eq!(forced_h265.encoder, Encoder::Cpu);
assert_eq!(preferred_codec_for(true, true, forced_h265), VideoCodec::H265);
}
#[test]
fn session_before_probe_uses_legacy_auto() {
let _guard = PROBE_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
clear_probe();
assert!(cached_probe().is_none());
let early = resolve_pair(None, None, None, None, false, None);
assert_eq!((early.encoder, early.encoder_source), (Encoder::Cpu, Source::Auto));
assert_eq!(resolve_pair(None, None, None, None, true, None).encoder, Encoder::Nvenc);
store_probe(probe_report(true, &[ProbeOutcome::Fail(ProbeFail::Exit), ProbeOutcome::Ok]));
assert_eq!(cached_probe().unwrap().chosen, Encoder::Cpu);
assert_eq!(resolve_pair(None, None, None, None, true, cached_probe().as_ref()).encoder, Encoder::Cpu);
// A snapshot taken before the cache filled stays on the legacy encoder.
assert_eq!(early.encoder, Encoder::Cpu);
assert_eq!(resolve_pair(None, None, None, None, true, None).encoder, Encoder::Nvenc);
clear_probe();
}
#[test]
fn success_and_not_probed_do_not_expire() {
let now = std::time::Instant::now();
let later = now + PROBE_FAILURE_TTL + std::time::Duration::from_secs(1);
let ok = ProbeReport::fresh(auto_order(true), vec![ProbeOutcome::Ok, ProbeOutcome::Ok], Encoder::Nvenc, now, true);
assert!(ok.expires_at.is_none());
assert!(!probe_expired(&ok, later));
let skipped = ProbeReport::fresh(auto_order(false), vec![ProbeOutcome::NotProbed], Encoder::Cpu, now, false);
assert!(skipped.expires_at.is_none());
assert!(!probe_expired(&skipped, later));
let native = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::NativeUnprobed, ProbeOutcome::Ok],
Encoder::Nvenc,
now,
true,
);
assert!(native.expires_at.is_none(), "native_unprobed is not a recorded process failure");
assert!(!probe_expired(&native, later));
}
#[test]
fn hardware_failure_expires_after_ttl() {
let now = std::time::Instant::now();
let failed = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Fail(ProbeFail::Timeout), ProbeOutcome::Ok],
Encoder::Cpu,
now,
true,
);
assert!(!probe_expired(&failed, now + PROBE_FAILURE_TTL - std::time::Duration::from_secs(1)));
assert!(probe_expired(&failed, now + PROBE_FAILURE_TTL));
assert_eq!(failed.chosen, Encoder::Cpu);
}
/// NVENC produced an IDR and CPU failed: the session uses NVENC, so this is
/// not the hardware-fallback cache. No TTL, and doctor (which keys off
/// `expires_at`) does not append the failure label.
#[test]
fn nvenc_ok_cpu_fail_does_not_expire() {
let now = std::time::Instant::now();
let report = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Ok, ProbeOutcome::Fail(ProbeFail::Exit)],
Encoder::Nvenc,
now,
true,
);
assert_eq!(report.chosen, Encoder::Nvenc);
assert!(report.expires_at.is_none());
assert!(!probe_expired(&report, now + PROBE_FAILURE_TTL + std::time::Duration::from_secs(1)));
let cpu_only_fail = ProbeReport::fresh(
auto_order(false),
vec![ProbeOutcome::Fail(ProbeFail::Exit)],
Encoder::Cpu,
now,
false,
);
assert!(cpu_only_fail.expires_at.is_none(), "a CPU-only Fail is not a hardware fallback");
}
/// Failed NVENC stays CPU until `PROBE_FAILURE_TTL`. After that a desktop connection
/// asks for one background re-probe (`probe_needs_run`, what `warm_auto_probe` checks)
/// and still selects the cached CPU encoder. A successful re-probe selects NVENC and
/// does not expire. A second failure restarts the TTL.
#[test]
fn failure_then_reprobe_success_selects_nvenc() {
let _guard = PROBE_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
clear_probe();
let t0 = std::time::Instant::now();
let failed = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Fail(ProbeFail::Exit), ProbeOutcome::Ok],
Encoder::Cpu,
t0,
true,
);
store_probe(failed);
let before = t0 + PROBE_FAILURE_TTL - std::time::Duration::from_secs(1);
assert!(!probe_needs_run(before, true), "no re-probe before the failure expires");
assert_eq!(
resolve_pair(None, None, None, None, true, cached_probe().as_ref()).encoder,
Encoder::Cpu
);
let after = t0 + PROBE_FAILURE_TTL;
assert!(probe_expired(cached_probe().as_ref().unwrap(), after));
assert!(probe_needs_run(after, true), "desktop connection starts one background re-probe");
assert_eq!(
resolve_pair(None, None, None, None, true, cached_probe().as_ref()).encoder,
Encoder::Cpu,
"the connection that notices expiry still uses the cached encoder"
);
let retried = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Ok, ProbeOutcome::Ok],
Encoder::Nvenc,
after,
true,
);
store_probe(retried);
assert_eq!(
resolve_pair(None, None, None, None, true, cached_probe().as_ref()).encoder,
Encoder::Nvenc
);
assert!(!probe_needs_run(after + PROBE_FAILURE_TTL + std::time::Duration::from_secs(1), true));
let failed_again = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Fail(ProbeFail::Timeout), ProbeOutcome::Ok],
Encoder::Cpu,
after,
true,
);
store_probe(failed_again);
assert!(!probe_needs_run(after + PROBE_FAILURE_TTL - std::time::Duration::from_secs(1), true));
assert!(probe_needs_run(after + PROBE_FAILURE_TTL, true));
clear_probe();
}
/// A CPU-only `NotProbed` report does not expire by time. When NVIDIA appears
/// (module or device after the user service started), the next desktop
/// connection treats it as stale and `probe_needs_run` asks for one background
/// re-probe. The inverse (NVENC success, device gone) is stale the same way.
/// The connection that notices still selects the cached encoder.
#[test]
fn nvidia_presence_change_makes_probe_stale() {
let now = std::time::Instant::now();
let cpu_only = ProbeReport::fresh(auto_order(false), vec![ProbeOutcome::NotProbed], Encoder::Cpu, now, false);
assert!(!probe_stale(&cpu_only, now + PROBE_FAILURE_TTL + std::time::Duration::from_secs(1), false));
assert!(probe_stale(&cpu_only, now, true), "NVIDIA appeared after the CPU-only skip");
let nvenc_ok = ProbeReport::fresh(auto_order(true), vec![ProbeOutcome::Ok, ProbeOutcome::Ok], Encoder::Nvenc, now, true);
assert!(!probe_stale(&nvenc_ok, now, true));
assert!(probe_stale(&nvenc_ok, now, false), "NVIDIA gone after a successful NVENC probe");
let _guard = PROBE_TEST_LOCK.lock().unwrap_or_else(|e| e.into_inner());
clear_probe();
store_probe(cpu_only);
assert!(!probe_needs_run(now, false));
assert!(probe_needs_run(now, true));
assert_eq!(
resolve_pair(None, None, None, None, true, cached_probe().as_ref()).encoder,
Encoder::Cpu,
"the connection that notices the presence change still uses the cached encoder"
);
clear_probe();
}
#[test]
fn reprobe_reason_follows_previous_state() {
let now = std::time::Instant::now();
assert_eq!(reprobe_reason(None, false), None);
assert_eq!(reprobe_reason(None, true), None);
let failed = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Fail(ProbeFail::Exit), ProbeOutcome::Ok],
Encoder::Cpu,
now,
true,
);
assert!(failed.expires_at.is_some());
assert_eq!(reprobe_reason(Some(&failed), true), Some("retry after failure"));
assert_eq!(reprobe_reason(Some(&failed), false), Some("retry after failure"));
let nvenc_ok = ProbeReport::fresh(
auto_order(true),
vec![ProbeOutcome::Ok, ProbeOutcome::Ok],
Encoder::Nvenc,
now,
true,
);
assert_eq!(reprobe_reason(Some(&nvenc_ok), true), None);
assert_eq!(reprobe_reason(Some(&nvenc_ok), false), Some("NVIDIA availability changed"));
let skipped = ProbeReport::fresh(auto_order(false), vec![ProbeOutcome::NotProbed], Encoder::Cpu, now, false);
assert_eq!(reprobe_reason(Some(&skipped), false), None);
assert_eq!(reprobe_reason(Some(&skipped), true), Some("NVIDIA availability changed"));
assert_ne!(reprobe_reason(Some(&nvenc_ok), false), Some("retry after failure"));
assert_ne!(reprobe_reason(Some(&skipped), true), Some("retry after failure"));
}
#[test]
fn warm_probe_only_when_encoder_source_is_auto() {
assert!(should_warm_auto_probe(Source::Auto));
assert!(!should_warm_auto_probe(Source::Setting));
assert!(!should_warm_auto_probe(Source::Env));
assert_eq!(resolve_pair(Some("cpu"), None, None, None, true, None).encoder_source, Source::Setting);
assert_eq!(resolve_pair(None, Some("nvenc"), None, None, false, None).encoder_source, Source::Env);
assert_eq!(resolve_pair(None, Some("auto"), None, None, false, None).encoder_source, Source::Auto);
}
}
+123
View File
@@ -0,0 +1,123 @@
//! Exercise the real video loop and RTP transport without cloud or desktop access.
//! Thread-local faults are confined to each test's current-thread Tokio runtime.
use super::*;
use std::cell::RefCell;
use webrtc::{api::{APIBuilder, media_engine::MediaEngine},
peer_connection::configuration::RTCConfiguration,
rtp_transceiver::rtp_codec::RTPCodecType};
pub(super) const DISPLAY: &str = "wayland:test-wake";
struct Faults { wake_calls: AtomicUsize, fail_wake: usize, fail_capture: bool, stop: AtomicBool }
thread_local! { static FAULTS: RefCell<Option<Arc<Faults>>> = const { RefCell::new(None) }; }
struct Reset;
impl Drop for Reset { fn drop(&mut self) { FAULTS.with(|value| *value.borrow_mut() = None); } }
pub(super) fn active() -> bool { FAULTS.with(|value| value.borrow().is_some()) }
pub(super) fn wake() -> Option<Result<(), String>> {
FAULTS.with(|value| value.borrow().as_ref().map(|faults| {
let call = faults.wake_calls.fetch_add(1, Ordering::SeqCst) + 1;
if call == faults.fail_wake { Err("Wayland output power control unavailable".into()) } else { Ok(()) }
}))
}
pub(super) async fn encode(latest: mpsc::Sender<Arc<CompleteFrame>>, settings: VideoSettings,
sequence: Arc<std::sync::atomic::AtomicU64>, budget: Arc<Semaphore>) -> Result<(), String> {
let faults = FAULTS.with(|value| value.borrow().clone()).expect("test faults installed");
loop {
tokio::time::sleep(Duration::from_millis(10)).await;
if faults.stop.load(Ordering::SeqCst) { return Ok(()); }
if faults.fail_capture && sequence.load(Ordering::Relaxed) >= 4 {
return Err("synthetic capture failed".into());
}
let permit = budget.clone().acquire_owned().await.map_err(|_| "test budget closed")?;
let frame = Arc::new(CompleteFrame {
source_generation: settings.source_generation, source_id: settings.source_id,
codec: settings.codec, sequence: sequence.fetch_add(1, Ordering::Relaxed) + 1,
completed_at: Instant::now(), data: vec![0, 0, 1, 65, 1, 2], _permit: Some(permit),
});
if latest.send(frame).await.is_err() { return Ok(()); }
}
}
async fn exercise(fail_wake: usize, fail_capture: bool) {
tokio::time::timeout(Duration::from_secs(15), async {
let faults = Arc::new(Faults { wake_calls: AtomicUsize::new(0), fail_wake, fail_capture, stop: AtomicBool::new(false) });
FAULTS.with(|value| *value.borrow_mut() = Some(faults.clone()));
let _reset = Reset;
let (host_setting, remote_setting, router) = crate::test_network::virtual_network().await;
let mut media = MediaEngine::default();
media.register_default_codecs().unwrap();
let host = Arc::new(APIBuilder::new().with_setting_engine(host_setting).with_media_engine(media)
.build().new_peer_connection(RTCConfiguration::default()).await.unwrap());
let mut media = MediaEngine::default();
media.register_default_codecs().unwrap();
let remote = APIBuilder::new().with_setting_engine(remote_setting).with_media_engine(media)
.build().new_peer_connection(RTCConfiguration::default()).await.unwrap();
remote.add_transceiver_from_kind(RTPCodecType::Video, None).await.unwrap();
let _control = remote.create_data_channel("CONTROL_DATA_CHANNEL", None).await.unwrap();
let track = Arc::new(crate::video_track::VideoTrack::new());
host.add_track(track.clone()).await.unwrap();
let (packets, mut received) = mpsc::unbounded_channel();
remote.on_track(Box::new(move |track, _, _| {
let packets = packets.clone();
Box::pin(async move {
tokio::spawn(async move {
while let Ok((packet, _)) = track.read_rtp().await {
if packets.send(packet).is_err() { break; }
}
});
})
}));
let mut gathered = remote.gathering_complete_promise().await;
remote.set_local_description(remote.create_offer(None).await.unwrap()).await.unwrap();
gathered.recv().await;
host.set_remote_description(remote.local_description().await.unwrap()).await.unwrap();
let mut gathered = host.gathering_complete_promise().await;
host.set_local_description(host.create_answer(None).await.unwrap()).await.unwrap();
gathered.recv().await;
remote.set_remote_description(host.local_description().await.unwrap()).await.unwrap();
let settings = VideoSettings { source_id: 0, source_generation: 0, ..Default::default() };
let (settings_tx, settings_rx) = tokio::sync::watch::channel(settings);
let selection = crate::video_select::resolve_pair(Some("cpu"), None, Some("h264"), None, false, None);
let mut task = tokio::spawn(stream_desktop(host.clone(), track.clone(), (640, 480),
DISPLAY.into(), None, settings_rx, Arc::new(settings_tx), Arc::new(AtomicBool::new(false)), selection, None));
let result = if fail_capture {
Some((&mut task).await.unwrap())
} else {
let mut previous: Option<u16> = None;
for _ in 0..6 {
tokio::select! {
result = &mut task => panic!("video stopped after a recoverable wake failure: {result:?}"),
packet = received.recv() => {
let packet = packet.expect("RTP receiver closed");
if let Some(sequence) = previous {
assert_eq!(packet.header.sequence_number, sequence.wrapping_add(1));
}
previous = Some(packet.header.sequence_number);
}
}
}
assert!(faults.wake_calls.load(Ordering::SeqCst) > fail_wake, "wake was not retried");
None
};
assert!(track.revision() >= 4, "video must continue across wake failure");
let result = match result {
Some(result) => result,
None => {
faults.stop.store(true, Ordering::SeqCst);
task.await.unwrap()
},
};
host.close().await.unwrap();
remote.close().await.unwrap();
router.lock().await.stop().await.unwrap();
assert_eq!(result, if fail_capture { Err("synthetic capture failed".into()) } else { Ok(()) });
}).await.expect("video wake regression timed out");
}
#[tokio::test]
async fn startup_wake_failure_does_not_stop_video() { exercise(1, false).await; }
#[tokio::test]
async fn periodic_wake_failure_does_not_stop_video() { exercise(2, false).await; }
#[tokio::test]
async fn capture_failure_still_stops_video_after_wake_failure() { exercise(2, true).await; }
+2 -2
View File
@@ -1,4 +1,4 @@
//! Uses the same optional FFmpeg dependency as the host inproc-av feature. //! Uses the optional FFmpeg 6 libraries of the `viewer-ffmpeg` feature.
use super::desktop::{Decoder,Frame}; use super::desktop::{Decoder,Frame};
use ffmpeg_next as av; use ffmpeg_next as av;
use super::media::Codec; use super::media::Codec;
@@ -37,7 +37,7 @@ impl Decoder for Ffmpeg {
let mut rgb=av::frame::Video::empty();scaler.run(&decoded,&mut rgb).map_err(|_|"Frame conversion failed")?; let mut rgb=av::frame::Video::empty();scaler.run(&decoded,&mut rgb).map_err(|_|"Frame conversion failed")?;
let mut data=Vec::with_capacity(w as usize*h as usize*3); let mut data=Vec::with_capacity(w as usize*h as usize*3);
for row in 0..h as usize {let start=row*rgb.stride(0);data.extend_from_slice(&rgb.data(0)[start..start+w as usize*3]);} for row in 0..h as usize {let start=row*rgb.stride(0);data.extend_from_slice(&rgb.data(0)[start..start+w as usize*3]);}
frames.push(Frame{width:w,height:h,rgb:data}); frames.push(Frame{width:w,height:h,rgb:data,content:None});
} Ok(frames) } Ok(frames)
} }
} }
+46 -8
View File
@@ -1,13 +1,16 @@
//! H.264/H.265 decoding through an external `ffmpeg` process, like the host's encoder pipeline. //! H.264/H.265 decoding through an external `ffmpeg` process, like the host's encoder pipeline.
//! Needs only the ffmpeg CLI, not FFmpeg development libraries. //! Needs only the ffmpeg CLI, not FFmpeg development libraries.
//! Output is scaled into a fixed letterboxed size so every frame has a known byte length. //! Output is scaled into a fixed letterboxed canvas so every frame has a known byte length; the
//! source size from ffmpeg's stream line tells the window which sub-rectangle is picture content.
use super::desktop::{Decoder,Frame}; use super::desktop::{Decoder,Frame};
use super::media::Codec; use super::media::Codec;
use std::io::{Read,Write}; use std::io::{BufRead,Read,Write};
use std::process::{Child,ChildStdin,Command,Stdio}; use std::process::{Child,ChildStdin,Command,Stdio};
use std::sync::Arc;
use std::sync::atomic::{AtomicU64,Ordering};
use std::sync::mpsc::{Receiver,TryRecvError}; use std::sync::mpsc::{Receiver,TryRecvError};
pub struct Cli { child:Child, input:Option<ChildStdin>, codec:Codec, frames:Receiver<Vec<u8>>, width:u32, height:u32 } pub struct Cli { child:Child, input:Option<ChildStdin>, codec:Codec, frames:Receiver<Vec<u8>>, width:u32, height:u32, source:Arc<AtomicU64> }
impl Cli { impl Cli {
/// `UU_VIEWER_SIZE=WxH` picks the decoded size (default 1920x1080); `UU_VIEWER_FFMPEG` the binary. /// `UU_VIEWER_SIZE=WxH` picks the decoded size (default 1920x1080); `UU_VIEWER_FFMPEG` the binary.
@@ -23,16 +26,27 @@ impl Cli {
let filter=format!("scale={width}:{height}:force_original_aspect_ratio=decrease,pad={width}:{height}:(ow-iw)/2:(oh-ih)/2"); let filter=format!("scale={width}:{height}:force_original_aspect_ratio=decrease,pad={width}:{height}:(ow-iw)/2:(oh-ih)/2");
let passthrough=passthrough_args(&ffmpeg); let passthrough=passthrough_args(&ffmpeg);
let mut child=Command::new(&ffmpeg) let mut child=Command::new(&ffmpeg)
.args(["-hide_banner","-loglevel","error","-nostdin","-threads","1","-probesize","32","-analyzeduration","0", .args(["-hide_banner","-loglevel","info","-nostats","-nostdin","-threads","1","-probesize","32","-analyzeduration","0",
"-fflags","nobuffer","-flags","low_delay","-f",codec.demuxer(),"-i","pipe:0","-an","-vf",&filter, "-fflags","nobuffer","-flags","low_delay","-f",codec.demuxer(),"-i","pipe:0","-an","-vf",&filter,
"-pix_fmt","rgb24", "-pix_fmt","rgb24",
// Raw H.264/H.265 carries no timestamps; constant-rate output dropped almost every frame of // Raw H.264/H.265 carries no timestamps; constant-rate output dropped almost every frame of
// the official Mac host's stream (270 → 2). Pass frames through unchanged. // the official Mac host's stream (270 → 2). Pass frames through unchanged.
passthrough.0,passthrough.1,"-f","rawvideo","pipe:1"]) passthrough.0,passthrough.1,"-f","rawvideo","pipe:1"])
.stdin(Stdio::piped()).stdout(Stdio::piped()).stderr(Stdio::null()) .stdin(Stdio::piped()).stdout(Stdio::piped()).stderr(Stdio::piped())
.spawn().map_err(|e|format!("Start ffmpeg decoder: {e}"))?; .spawn().map_err(|e|format!("Start ffmpeg decoder: {e}"))?;
let input=child.stdin.take().ok_or("ffmpeg stdin missing")?; let input=child.stdin.take().ok_or("ffmpeg stdin missing")?;
let mut output=child.stdout.take().ok_or("ffmpeg stdout missing")?; let mut output=child.stdout.take().ok_or("ffmpeg stdout missing")?;
// Source picture size from the one-time stream line; 0 until parsed. Only the numbers are kept.
let source=Arc::new(AtomicU64::new(0));
if let Some(stderr)=child.stderr.take() {
let source=source.clone();
let _=std::thread::Builder::new().name("uu-viewer-ffmpeg-info".into()).spawn(move||{
for line in std::io::BufReader::new(stderr).lines().map_while(Result::ok) {
if source.load(Ordering::Relaxed)!=0 {continue}
if let Some((w,h))=parse_video_size(&line) {source.store((u64::from(w)<<32)|u64::from(h),Ordering::Relaxed);}
}
});
}
let size=width as usize*height as usize*3; let size=width as usize*height as usize*3;
// Bounded: a slow window drops decoded frames instead of growing memory. // Bounded: a slow window drops decoded frames instead of growing memory.
let (tx,frames)=std::sync::mpsc::sync_channel(2); let (tx,frames)=std::sync::mpsc::sync_channel(2);
@@ -43,10 +57,23 @@ impl Cli {
match tx.try_send(frame) { Ok(())|Err(std::sync::mpsc::TrySendError::Full(_))=>{}, Err(_)=>break } match tx.try_send(frame) { Ok(())|Err(std::sync::mpsc::TrySendError::Full(_))=>{}, Err(_)=>break }
} }
}).map_err(|e|format!("Decoder reader: {e}"))?; }).map_err(|e|format!("Decoder reader: {e}"))?;
Ok(Self{child,input:Some(input),codec,frames,width,height}) Ok(Self{child,input:Some(input),codec,frames,width,height,source})
} }
} }
/// `30000/1001`-style or display strings are irrelevant here: the first WxH on a `Video:` line is the
/// coded picture size, which is the aspect the scale+pad filter letterboxes into the canvas.
fn parse_video_size(line:&str)->Option<(u32,u32)> {
let rest=line.split_once("Video:")?.1;
rest.split(|c:char|c==','||c==' '||c=='('||c==')'||c=='['||c==']').find_map(|token|{
let token=token.trim_matches(|c:char|!c.is_ascii_digit()&&c!='x');
let (w,h)=token.split_once('x')?;
if w.is_empty()||h.is_empty()||!w.bytes().all(|b|b.is_ascii_digit())||!h.bytes().all(|b|b.is_ascii_digit()) {return None}
let (w,h)=(w.parse::<u32>().ok()?,h.parse::<u32>().ok()?);
((16..=16384).contains(&w)&&(16..=16384).contains(&h)).then_some((w,h))
})
}
/// FFmpeg ≥ 5.1 has `-fps_mode`; FFmpeg 8+ removed `-vsync`, and Ubuntu 22.04's 4.4 lacks `-fps_mode`. /// FFmpeg ≥ 5.1 has `-fps_mode`; FFmpeg 8+ removed `-vsync`, and Ubuntu 22.04's 4.4 lacks `-fps_mode`.
/// Probe once per binary with a one-frame null run instead of parsing version strings. /// Probe once per binary with a one-frame null run instead of parsing version strings.
fn passthrough_args(ffmpeg:&str)->(&'static str,&'static str) { fn passthrough_args(ffmpeg:&str)->(&'static str,&'static str) {
@@ -75,7 +102,11 @@ impl Decoder for Cli {
let mut out=Vec::new(); let mut out=Vec::new();
loop { loop {
match self.frames.try_recv() { match self.frames.try_recv() {
Ok(rgb)=>out.push(Frame{width:self.width,height:self.height,rgb}), Ok(rgb)=>{
let source=self.source.load(Ordering::Relaxed);
let content=(source!=0).then(||((source>>32) as u32,source as u32));
out.push(Frame{width:self.width,height:self.height,rgb,content})
},
Err(TryRecvError::Empty)=>break, Err(TryRecvError::Empty)=>break,
Err(TryRecvError::Disconnected)=>return Err("ffmpeg decoder exited".into()), Err(TryRecvError::Disconnected)=>return Err("ffmpeg decoder exited".into()),
} }
@@ -115,7 +146,7 @@ impl Drop for Cli { fn drop(&mut self) { let _=self.child.kill(); let _=self.chi
// Exercise the same streaming process and RGB conversion as SDL, then drain at EOF. // Exercise the same streaming process and RGB conversion as SDL, then drain at EOF.
let mut frames=cli.decode(data).unwrap();drop(cli.input.take()); let mut frames=cli.decode(data).unwrap();drop(cli.input.take());
loop {match cli.frames.recv_timeout(std::time::Duration::from_secs(5)) { loop {match cli.frames.recv_timeout(std::time::Duration::from_secs(5)) {
Ok(rgb)=>frames.push(Frame{width:32,height:32,rgb}), Ok(rgb)=>frames.push(Frame{width:32,height:32,rgb,content:None}),
Err(std::sync::mpsc::RecvTimeoutError::Disconnected)=>break, Err(std::sync::mpsc::RecvTimeoutError::Disconnected)=>break,
Err(e)=>panic!("{codec:?} decoder did not finish: {e}"), Err(e)=>panic!("{codec:?} decoder did not finish: {e}"),
}} }}
@@ -128,4 +159,11 @@ impl Drop for Cli { fn drop(&mut self) { let _=self.child.kill(); let _=self.chi
} }
} }
} }
#[test] fn source_size_is_read_from_the_ffmpeg_stream_line(){
assert_eq!(super::parse_video_size(" Stream #0:0: Video: h264 (High), yuv420p(progressive), 3024x1964, 25 fps"),Some((3024,1964)));
assert_eq!(super::parse_video_size("Stream #0:0: Video: hevc, yuv420p, 1920x1080 [SAR 1:1 DAR 16:9]"),Some((1920,1080)));
assert_eq!(super::parse_video_size("Stream #0:0: Audio: opus, 48000 Hz, stereo"),None);
assert_eq!(super::parse_video_size("frame= 1 fps=0.0 q=0.0"),None);
assert_eq!(super::parse_video_size("Stream #0:0: Video: h264, 1920xsynth"),None);
}
} }
+14 -3
View File
@@ -5,13 +5,20 @@ pub struct Desktop { pub units:Latest<super::media::AccessUnit>, pub pli:Arc<Ato
impl Default for Desktop { impl Default for Desktop {
fn default()->Self {Self{units:Latest::new(3),pli:Arc::new(AtomicBool::new(false)),reset:Arc::new(AtomicBool::new(false)),ssrc:Arc::new(AtomicU32::new(0))}} fn default()->Self {Self{units:Latest::new(3),pli:Arc::new(AtomicBool::new(false)),reset:Arc::new(AtomicBool::new(false)),ssrc:Arc::new(AtomicU32::new(0))}}
} }
pub struct Frame { pub width:u32, pub height:u32, pub rgb:Vec<u8> } /// `content` is the source picture size inside the (possibly padded) RGB canvas; None = full frame.
pub struct Frame { pub width:u32, pub height:u32, pub rgb:Vec<u8>, pub content:Option<(u32,u32)> }
pub trait Decoder { fn set_codec(&mut self,codec:super::media::Codec)->Result<(),String>; fn decode(&mut self, au:&[u8])->Result<Vec<Frame>,String>; fn reset(&mut self); } pub trait Decoder { fn set_codec(&mut self,codec:super::media::Codec)->Result<(),String>; fn decode(&mut self, au:&[u8])->Result<Vec<Frame>,String>; fn reset(&mut self); }
pub trait FrameSink { fn present(&mut self,frame:&Frame)->Result<(),String>; } pub trait FrameSink { fn present(&mut self,frame:&Frame)->Result<(),String>; }
/// Counts only (access units, presented frames, decode errors) for the periodic stats line. /// Counts only (access units, presented frames, decode errors) for the periodic stats line.
pub static STATS:[std::sync::atomic::AtomicU64;3]=[std::sync::atomic::AtomicU64::new(0),std::sync::atomic::AtomicU64::new(0),std::sync::atomic::AtomicU64::new(0)]; pub static STATS:[std::sync::atomic::AtomicU64;3]=[std::sync::atomic::AtomicU64::new(0),std::sync::atomic::AtomicU64::new(0),std::sync::atomic::AtomicU64::new(0)];
fn wants_key_frame(units:u64,presented:u64)->bool {presented==0 && units%30==0}
pub fn display(decoder:&mut dyn Decoder,sink:&mut dyn FrameSink,au:&[u8],codec:super::media::Codec,pli:&AtomicBool)->Result<(),String> { pub fn display(decoder:&mut dyn Decoder,sink:&mut dyn FrameSink,au:&[u8],codec:super::media::Codec,pli:&AtomicBool)->Result<(),String> {
STATS[0].fetch_add(1,Ordering::Relaxed); let units=STATS[0].fetch_add(1,Ordering::Relaxed)+1;
// A later session can join a clean stream with no IDR in flight (#124): keep asking until a frame shows.
if wants_key_frame(units,STATS[1].load(Ordering::Relaxed)) {
pli.store(true,Ordering::Release);
if units==300 { log::warn!("Viewer desktop: no decodable frame after {units} access units; requesting key frames (another session may hold the host)"); }
}
// Local diagnostic: UU_VIEWER_DUMP_H264=path appends the first 300 access units (owner's own stream). // Local diagnostic: UU_VIEWER_DUMP_H264=path appends the first 300 access units (owner's own stream).
if codec==super::media::Codec::H264 && STATS[0].load(Ordering::Relaxed)<=300 { if let Some(path)=std::env::var_os("UU_VIEWER_DUMP_H264") { if codec==super::media::Codec::H264 && STATS[0].load(Ordering::Relaxed)<=300 { if let Some(path)=std::env::var_os("UU_VIEWER_DUMP_H264") {
use std::io::Write; if let Ok(mut f)=std::fs::OpenOptions::new().create(true).append(true).open(path){let _=f.write_all(au);} use std::io::Write; if let Ok(mut f)=std::fs::OpenOptions::new().create(true).append(true).open(path){let _=f.write_all(au);}
@@ -29,7 +36,11 @@ pub fn display(decoder:&mut dyn Decoder,sink:&mut dyn FrameSink,au:&[u8],codec:s
} }
#[cfg(test)] mod tests { #[cfg(test)] mod tests {
use super::*; use super::*;
struct Mock(bool);impl Decoder for Mock {fn set_codec(&mut self,_:crate::viewer::media::Codec)->Result<(),String>{Ok(())} fn decode(&mut self,_:&[u8])->Result<Vec<Frame>,String>{if self.0{Err("synthetic".into())}else{Ok(vec![Frame{width:1,height:1,rgb:vec![0;3]}])}} fn reset(&mut self){self.0=false;}} struct Mock(bool);impl Decoder for Mock {fn set_codec(&mut self,_:crate::viewer::media::Codec)->Result<(),String>{Ok(())} fn decode(&mut self,_:&[u8])->Result<Vec<Frame>,String>{if self.0{Err("synthetic".into())}else{Ok(vec![Frame{width:1,height:1,rgb:vec![0;3],content:None}])}} fn reset(&mut self){self.0=false;}}
struct Sink(usize);impl FrameSink for Sink{fn present(&mut self,f:&Frame)->Result<(),String>{assert_eq!(f.rgb.len(),3);self.0+=1;Ok(())}} struct Sink(usize);impl FrameSink for Sink{fn present(&mut self,f:&Frame)->Result<(),String>{assert_eq!(f.rgb.len(),3);self.0+=1;Ok(())}}
#[test] fn requests_key_frames_until_the_first_frame(){
assert_eq!((1..=90).filter(|&n|wants_key_frame(n,0)).count(),3);
assert!(!(1..=90).any(|n|wants_key_frame(n,1)));
}
#[test] fn decode_error_requests_pli_and_recovers(){let mut d=Mock(true);let mut s=Sink(0);let p=AtomicBool::new(false);display(&mut d,&mut s,&[],crate::viewer::media::Codec::H264,&p).unwrap();assert!(p.load(Ordering::Acquire));display(&mut d,&mut s,&[],crate::viewer::media::Codec::H264,&p).unwrap();assert_eq!(s.0,1);} #[test] fn decode_error_requests_pli_and_recovers(){let mut d=Mock(true);let mut s=Sink(0);let p=AtomicBool::new(false);display(&mut d,&mut s,&[],crate::viewer::media::Codec::H264,&p).unwrap();assert!(p.load(Ordering::Acquire));display(&mut d,&mut s,&[],crate::viewer::media::Codec::H264,&p).unwrap();assert_eq!(s.0,1);}
} }
+43
View File
@@ -35,6 +35,15 @@ pub fn mac_keycode(scan:i32)->Option<i32>{
_=>return None, _=>return None,
}) })
} }
/// The content rectangle inside a decoder canvas padded to a fixed size (ffmpeg's scale+pad).
/// Mirrors `force_original_aspect_ratio=decrease,pad=…:(ow-iw)/2:(oh-ih)/2` so pointer input
/// ignores the padding instead of compressing the valid area.
pub fn content_rect(canvas:(u32,u32),content:(u32,u32))->Option<(f64,f64,f64,f64)> {
if canvas.0==0||canvas.1==0||content.0==0||content.1==0 {return None}
let scale=(canvas.0 as f64/content.0 as f64).min(canvas.1 as f64/content.1 as f64);
let(w,h)=(content.0 as f64*scale,content.1 as f64*scale);
Some(((canvas.0 as f64-w)/2.,(canvas.1 as f64-h)/2.,w,h))
}
#[derive(Clone,Copy,Debug,PartialEq)] #[derive(Clone,Copy,Debug,PartialEq)]
pub struct Viewport { pub x:f64, pub y:f64, pub width:f64, pub height:f64 } pub struct Viewport { pub x:f64, pub y:f64, pub width:f64, pub height:f64 }
impl Viewport { impl Viewport {
@@ -75,6 +84,14 @@ impl Input {
let changed=if down{self.buttons.insert(button)}else{self.buttons.remove(&button)}; let changed=if down{self.buttons.insert(button)}else{self.buttons.remove(&button)};
changed.then(||json!({"action":if down{"mouse_press"}else{"mouse_release"},"button":button})) changed.then(||json!({"action":if down{"mouse_press"}else{"mouse_release"},"button":button}))
} }
/// SDL wheel units are notches; the wire uses the Mac convention (one notch = 120).
/// Positive y is wheel-up, matching the host's `mouse_scroll` (button 4).
pub fn scroll(&mut self,x:f64,y:f64)->Option<Value> {
if self.view_only {return None}
let(dx,dy)=((x*120.).round() as i32,(y*120.).round() as i32);
if dx==0&&dy==0 {return None}
Some(json!({"action":"mouse_scroll","delta_x":dx,"delta_y":dy}))
}
pub fn release_all(&mut self)->Vec<Value> { pub fn release_all(&mut self)->Vec<Value> {
let mut out=Vec::new(); let mut out=Vec::new();
for key in std::mem::take(&mut self.keys).into_values().collect::<BTreeSet<_>>() {out.push(json!({"action":"kbd_release","key":key}));} for key in std::mem::take(&mut self.keys).into_values().collect::<BTreeSet<_>>() {out.push(json!({"action":"kbd_release","key":key}));}
@@ -117,6 +134,15 @@ impl Input {
assert!(view_only(None,Some("1")).unwrap());assert!(view_only(Some("--view-only"),Some("0")).unwrap()); assert!(view_only(None,Some("1")).unwrap());assert!(view_only(Some("--view-only"),Some("0")).unwrap());
assert!(view_only(Some("invalid"),None).is_err()); assert!(view_only(Some("invalid"),None).is_err());
} }
#[test] fn wheel_notches_use_mac_wire_units(){
let mut i=Input::default();
assert_eq!(i.scroll(0.,1.).unwrap(),json!({"action":"mouse_scroll","delta_x":0,"delta_y":120}));
assert_eq!(i.scroll(0.,-1.).unwrap()["delta_y"],-120);
assert_eq!(i.scroll(1.,-2.).unwrap(),json!({"action":"mouse_scroll","delta_x":120,"delta_y":-240}));
assert_eq!(i.scroll(0.,0.1).unwrap()["delta_y"],12); // precise trackpad deltas
assert!(i.scroll(0.,0.).is_none());
assert!(Input::new(true).scroll(0.,1.).is_none());
}
#[test] fn mappings_encoding_and_focus() { #[test] fn mappings_encoding_and_focus() {
for (scan,vk) in [(4,65),(29,90),(39,48),(58,112),(80,37),(224,162),(230,165),(52,222)] {assert_eq!(windows_vk(scan),Some(vk));} for (scan,vk) in [(4,65),(29,90),(39,48),(58,112),(80,37),(224,162),(230,165),(52,222)] {assert_eq!(windows_vk(scan),Some(vk));}
assert_eq!(windows_vk(100),None); assert_eq!(windows_vk(100),None);
@@ -138,4 +164,21 @@ assert!(i.release_all().is_empty());
assert_eq!(v.motion(1010.,1000.).unwrap()["abs_x"],1.0); assert_eq!(v.motion(1010.,1000.).unwrap()["abs_x"],1.0);
assert!(v.motion(f64::NAN,0.).is_none()); assert!(v.motion(f64::NAN,0.).is_none());
} }
#[test] fn padded_canvas_maps_only_its_content_rectangle(){
// 16:10 picture inside the default 16:9 canvas: 1728x1080 centred, 96 px pillarbox each side.
assert_eq!(content_rect((1920,1080),(1280,800)),Some((96.,0.,1728.,1080.)));
assert_eq!(content_rect((1920,1080),(1920,1080)),Some((0.,0.,1920.,1080.)));
// 4:3 picture: 1440x1080 centred, 240 px each side.
assert_eq!(content_rect((1920,1080),(640,480)),Some((240.,0.,1440.,1080.)));
assert_eq!(content_rect((0,1080),(640,480)),None);
// The content rectangle's edges are the screen edges, not the canvas edges.
let (x,y,w,h)=content_rect((1920,1080),(1280,800)).unwrap();
let v=Viewport::fit((1920,1080),(1280,800));
assert_eq!((x,y,w,h),(v.x,v.y,v.width,v.height));
let abs=|px:f64|v.motion(px,540.).unwrap();
assert_eq!(abs(96.)["abs_x"],0.0);
assert_eq!(abs(960.)["abs_x"],0.5);
assert_eq!(abs(1824.)["abs_x"],1.0);
assert_eq!(abs(0.)["abs_x"],0.0); // padding is clamped to the screen edge
}
} }
+2
View File
@@ -21,6 +21,8 @@ pub mod tools;
pub mod clipboard; pub mod clipboard;
pub mod power; pub mod power;
pub mod secure_input;
pub mod type_ipc;
fn device_label(name:Option<&str>)->&str{ fn device_label(name:Option<&str>)->&str{
name.filter(|name|!name.is_empty()).unwrap_or("远端设备") name.filter(|name|!name.is_empty()).unwrap_or("远端设备")
+275 -15
View File
@@ -1,15 +1,20 @@
use super::{desktop::{Frame,FrameSink},input::{Input,Viewport},session::Session}; use super::{desktop::{Frame,FrameSink},input::{Input,Viewport},session::Session};
use sdl2::{event::{Event,WindowEvent},mouse::MouseButton,pixels::PixelFormatEnum,rect::Rect}; use sdl2::{event::{Event,WindowEvent},mouse::MouseButton,pixels::PixelFormatEnum,rect::Rect};
#[derive(Debug)] enum Command { Files, Type }
pub struct Window { canvas:sdl2::render::Canvas<sdl2::video::Window>, events:sdl2::EventPump, _sdl:sdl2::Sdl, frame:(u32,u32), focused:bool, files:bool, mac:bool, pub struct Window { canvas:sdl2::render::Canvas<sdl2::video::Window>, events:sdl2::EventPump, _sdl:sdl2::Sdl, frame:(u32,u32), focused:bool, files:bool, mac:bool,
clipboard:sdl2::clipboard::ClipboardUtil, clipboard_dirty:bool, clipboard_tx:tokio::sync::mpsc::Sender<super::clipboard::ClipboardRequest>, clipboard_requests:tokio::sync::mpsc::Receiver<super::clipboard::ClipboardRequest> } clipboard:sdl2::clipboard::ClipboardUtil, clipboard_dirty:bool, clipboard_tx:tokio::sync::mpsc::Sender<super::clipboard::ClipboardRequest>, clipboard_requests:tokio::sync::mpsc::Receiver<super::clipboard::ClipboardRequest>,
pub last_frame:Option<Frame> }
impl Window { impl Window {
pub fn new()->Result<Self,String>{ pub fn new()->Result<Self,String>{
let sdl=sdl2::init()?;let video=sdl.video()?; let sdl=sdl2::init()?;let video=sdl.video()?;
let window=video.window("Native viewer (experimental)",1280,720).position_centered().resizable().build().map_err(|_|"Window creation failed")?; let window=video.window("Native viewer (experimental)",1280,720).position_centered().resizable().build().map_err(|_|"Window creation failed")?;
let canvas=window.into_canvas().build().map_err(|_|"Renderer creation failed")?; let mut canvas=window.into_canvas().build().map_err(|_|"Renderer creation failed")?;
// Wayland maps a toplevel only after its first buffer; without this the window stays
// invisible until the first decoded frame, which a stalled stream never delivers.
canvas.set_draw_color(sdl2::pixels::Color::BLACK);canvas.clear();canvas.present();
let events=sdl.event_pump()?;let clipboard=video.clipboard(); let events=sdl.event_pump()?;let clipboard=video.clipboard();
let(clipboard_tx,clipboard_requests)=tokio::sync::mpsc::channel(16); let(clipboard_tx,clipboard_requests)=tokio::sync::mpsc::channel(16);
Ok(Self{canvas,events,_sdl:sdl,frame:(1920,1080),focused:true,files:false,mac:false,clipboard,clipboard_dirty:true,clipboard_tx,clipboard_requests}) Ok(Self{canvas,events,_sdl:sdl,frame:(1920,1080),focused:true,files:false,mac:false,clipboard,clipboard_dirty:true,clipboard_tx,clipboard_requests,last_frame:None})
} }
pub fn clipboard_bridge(&self)->super::clipboard::Bridge{super::clipboard::Bridge::sdl(self.clipboard_tx.clone())} pub fn clipboard_bridge(&self)->super::clipboard::Bridge{super::clipboard::Bridge::sdl(self.clipboard_tx.clone())}
pub fn set_mac(&mut self,mac:bool){self.mac=mac;} pub fn set_mac(&mut self,mac:bool){self.mac=mac;}
@@ -36,11 +41,32 @@ impl Window {
} }
pub fn poll(&mut self,input:&mut Input)->(bool,Vec<serde_json::Value>){ pub fn poll(&mut self,input:&mut Input)->(bool,Vec<serde_json::Value>){
let viewport=self.viewport(); let viewport=self.viewport();
let dirty=&mut self.clipboard_dirty; let dirty=&mut self.clipboard_dirty;let mut redraw=false;
let events=self.events.poll_iter().inspect(|event|{ let events=self.events.poll_iter().inspect(|event|{
if matches!(event,Event::ClipboardUpdate{..}|Event::Window{win_event:WindowEvent::FocusGained,..}){*dirty=true;} if matches!(event,Event::ClipboardUpdate{..}|Event::Window{win_event:WindowEvent::FocusGained,..}){*dirty=true;}
redraw|=needs_redraw(event);
}); });
translate_actions(events,input,viewport,&mut self.focused,&mut self.files) let result=translate_actions(events,input,viewport,&mut self.focused,&mut self.files);
// A compositor resize (tiling, maximize) leaves the surface without a buffer of the new size
// until the next frame; a static remote desktop sends none, so repaint the last frame now.
if redraw {if let Some(frame)=self.last_frame.take(){
log::debug!("Viewer window resized: {:?}",self.canvas.window().size());
if let Err(e)=self.draw(&frame){log::warn!("Viewer redraw failed: {e}");}
self.last_frame=Some(frame);
}else{self.canvas.set_draw_color(sdl2::pixels::Color::BLACK);self.canvas.clear();self.canvas.present();}}
result
}
fn draw(&mut self,frame:&Frame)->Result<(),String>{
// Pad bars belong to the decoded canvas, not the remote picture: viewport and input use the
// content aspect, and only the content sub-rectangle of the texture is drawn.
let content=frame.content.unwrap_or((frame.width,frame.height));
self.frame=content;let v=self.viewport();let creator=self.canvas.texture_creator();
let mut texture=creator.create_texture_streaming(PixelFormatEnum::RGB24,frame.width,frame.height).map_err(|_|"Texture creation failed")?;
texture.update(None,&frame.rgb,frame.width as usize*3).map_err(|_|"Texture update failed")?;
self.canvas.set_draw_color(sdl2::pixels::Color::BLACK);self.canvas.clear();
let src=super::input::content_rect((frame.width,frame.height),content)
.map(|(x,y,w,h)|Rect::new(x.round() as i32,y.round() as i32,w.round().max(1.) as u32,h.round().max(1.) as u32));
self.canvas.copy(&texture,src,Some(Rect::new(v.x.round() as i32,v.y.round() as i32,v.width.round().max(1.) as u32,v.height.round().max(1.) as u32)))?;self.canvas.present();Ok(())
} }
} }
fn clipboard_text(bytes:&[u8])->Option<String>{ fn clipboard_text(bytes:&[u8])->Option<String>{
@@ -79,36 +105,54 @@ fn translate_actions(events:impl IntoIterator<Item=Event>,input:&mut Input,viewp
Event::MouseMotion{x,y,..}=>viewport.motion(x as f64,y as f64), Event::MouseMotion{x,y,..}=>viewport.motion(x as f64,y as f64),
Event::MouseButtonDown{mouse_btn,..}=>button(mouse_btn).and_then(|b|input.button(b,true)), Event::MouseButtonDown{mouse_btn,..}=>button(mouse_btn).and_then(|b|input.button(b,true)),
Event::MouseButtonUp{mouse_btn,..}=>button(mouse_btn).and_then(|b|input.button(b,false)), Event::MouseButtonUp{mouse_btn,..}=>button(mouse_btn).and_then(|b|input.button(b,false)),
Event::MouseWheel{x,y,precise_x,precise_y,direction,..}=>{
let(dx,dy)=if precise_x!=0.||precise_y!=0.{(f64::from(precise_x),f64::from(precise_y))}else{(f64::from(x),f64::from(y))};
let(dx,dy)=match direction{sdl2::mouse::MouseWheelDirection::Flipped=>(-dx,-dy),_=>(dx,dy)};
input.scroll(dx,dy)
},
_=>None, _=>None,
};if let Some(m)=message{messages.push(m);} };if let Some(m)=message{messages.push(m);}
} (quit,messages) } (quit,messages)
} }
fn needs_redraw(event:&Event)->bool{
matches!(event,Event::Window{win_event:WindowEvent::SizeChanged(..)|WindowEvent::Resized(..)|WindowEvent::Exposed|WindowEvent::Maximized|WindowEvent::Restored,..})
}
fn button(b:MouseButton)->Option<i32>{match b{MouseButton::Left=>Some(1),MouseButton::Right=>Some(2),MouseButton::Middle=>Some(4),_=>None}} fn button(b:MouseButton)->Option<i32>{match b{MouseButton::Left=>Some(1),MouseButton::Right=>Some(2),MouseButton::Middle=>Some(4),_=>None}}
impl FrameSink for Window { impl FrameSink for Window {
fn present(&mut self,frame:&Frame)->Result<(),String>{ fn present(&mut self,frame:&Frame)->Result<(),String>{
self.frame=(frame.width,frame.height);let v=self.viewport();let creator=self.canvas.texture_creator(); self.last_frame=Some(Frame{width:frame.width,height:frame.height,rgb:frame.rgb.clone(),content:frame.content});
let mut texture=creator.create_texture_streaming(PixelFormatEnum::RGB24,frame.width,frame.height).map_err(|_|"Texture creation failed")?; self.draw(frame)
texture.update(None,&frame.rgb,frame.width as usize*3).map_err(|_|"Texture update failed")?;
self.canvas.set_draw_color(sdl2::pixels::Color::BLACK);self.canvas.clear();
self.canvas.copy(&texture,None,Some(Rect::new(v.x as i32,v.y as i32,v.width as u32,v.height as u32)))?;self.canvas.present();Ok(())
} }
} }
pub async fn run(session:&mut Session,window:&mut Window,decoder:&mut dyn super::desktop::Decoder,view_only:bool)->Result<(),String>{ pub async fn run(session:&mut Session,window:&mut Window,decoder:&mut dyn super::desktop::Decoder,view_only:bool,device:&str)->Result<(),String>{
#[cfg(uu_gtk)] #[cfg(uu_gtk)]
let mut files:Option<tokio::task::JoinHandle<Result<(),String>>>=None; let mut files:Option<tokio::task::JoinHandle<Result<(),String>>>=None;
let(tx,mut commands)=tokio::sync::mpsc::channel(8); let(tx,mut commands)=tokio::sync::mpsc::channel::<Command>(8);
if std::env::var("UU_VIEWER_COMMANDS").as_deref()==Ok("1") { if std::env::var("UU_VIEWER_COMMANDS").as_deref()==Ok("1") {
std::thread::spawn(move||{ std::thread::spawn(move||{
use std::io::Read; use std::io::Read;
let mut input=std::io::stdin().lock();let mut line=Vec::new();let mut byte=[0]; let mut input=std::io::stdin().lock();let mut line=Vec::new();let mut byte=[0];
while input.read(&mut byte).ok()==Some(1){ while input.read(&mut byte).ok()==Some(1){
if byte[0]==b'\n'{if line==b"files" && tx.blocking_send(()).is_err(){break}line.clear();} if byte[0]==b'\n'{
let cmd=match line.as_slice(){b"files"=>Some(Command::Files),b"type"=>Some(Command::Type),_=>None};
line.clear();
if let Some(cmd)=cmd { if tx.blocking_send(cmd).is_err(){break} }
}
else if line.len()<32{line.push(byte[0]);}else{break} else if line.len()<32{line.push(byte[0]);}else{break}
} }
}); });
}else{drop(tx);} }else{drop(tx);}
let mut command_open=true;let mut requested=false; let(type_tx,mut type_rx)=tokio::sync::mpsc::channel::<super::type_ipc::PendingType>(4);
let type_ipc=match super::type_ipc::Server::bind(device).await {
Ok(server)=>{
log::info!("Type IPC ready for device key {}", &super::type_ipc::device_key(device)[..12]);
Some(tokio::spawn(async move { server.run(type_tx).await; }))
}
Err(e)=>{ log::warn!("Type IPC not started: {e}"); None }
};
let mut command_open=true;let mut requested=false;let mut type_requested=false;
let mut type_job:Option<TypeJob>=None;
let mut terminate=tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate()).map_err(|_|"Cannot watch termination")?; let mut terminate=tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate()).map_err(|_|"Cannot watch termination")?;
let mut audio=super::audio::Playback::new(&window._sdl,session.peer.audio.clone()); let mut audio=super::audio::Playback::new(&window._sdl,session.peer.audio.clone());
let mut input=Input::new(view_only);input.set_mac(window.mac);let mut tick=tokio::time::interval(std::time::Duration::from_millis(8)); let mut input=Input::new(view_only);input.set_mac(window.mac);let mut tick=tokio::time::interval(std::time::Duration::from_millis(8));
@@ -116,7 +160,32 @@ pub async fn run(session:&mut Session,window:&mut Window,decoder:&mut dyn super:
let deadline=tokio::time::sleep(std::time::Duration::from_secs(30));tokio::pin!(deadline); let deadline=tokio::time::sleep(std::time::Duration::from_secs(30));tokio::pin!(deadline);
let result=async { let result=async {
loop {tokio::select!{ loop {tokio::select!{
command=commands.recv(),if command_open=>{if command.is_some(){requested=true}else{command_open=false}}, command=commands.recv(),if command_open=>{
match command {
Some(Command::Files)=>{requested=true},
Some(Command::Type)=>{type_requested=true},
None=>{command_open=false},
}
},
pending=type_rx.recv()=>{
if let Some(mut pending)=pending {
if type_job.is_some() {
let _=pending.reply.send(super::type_ipc::TypeResponse{ok:false,events:0,chars:0,snapshot:None,error:Some("Secure input busy".into())});
} else {
let mut snapshot_create_new=false;
if pending.request.snapshot.as_ref().map_or(true, |s| s.is_empty()) {
if let Ok(path)=super::type_ipc::default_snapshot_path(device) {
pending.request.snapshot=Some(path.display().to_string());
snapshot_create_new=true;
}
}
match start_type_job(pending, window.mac, input.enabled(), snapshot_create_new) {
Ok(job)=>type_job=Some(job),
Err(())=>{},
}
}
}
},
_=terminate.recv()=>return Ok(()), _=terminate.recv()=>return Ok(()),
_=tokio::signal::ctrl_c()=>return Ok(()), _=tokio::signal::ctrl_c()=>return Ok(()),
result=session.step()=>result?, result=session.step()=>result?,
@@ -145,6 +214,34 @@ pub async fn run(session:&mut Session,window:&mut Window,decoder:&mut dyn super:
} }
} }
#[cfg(not(uu_gtk))] {if requested{log::warn!("File window requires GTK3");requested=false;}} #[cfg(not(uu_gtk))] {if requested{log::warn!("File window requires GTK3");requested=false;}}
if type_requested {
type_requested=false;
if type_job.is_some() {
log::warn!("Secure type command ignored: busy");
} else if !input.enabled() {
log::warn!("Secure type command ignored: view-only session");
} else if std::env::var_os("UU_INPUT_ENV").is_none() {
log::warn!("Secure type command ignored: set UU_INPUT_ENV (stdin is the command channel)");
} else {
match super::secure_input::load_secret(std::io::Cursor::new([] as [u8;0])) {
Ok(mut secret)=>{
match enqueue_local_type(&mut type_job, &mut secret, window.mac, None, 0, std::time::Duration::ZERO, None) {
Ok(())=>{},
Err(e)=>log::warn!("Secure type failed: {e}"),
}
}
Err(e)=>log::warn!("Secure type load failed: {e}"),
}
}
}
if let Some(job)=type_job.as_mut() {
if let Err(e)=pump_type_job(job, session, window).await {
log::warn!("Secure type job failed: {e}");
type_job=None;
} else if job.done {
type_job=None;
}
}
if session.peer.ready(super::rtc::ReadyPolicy::EchoOnly,false){for m in messages{session.peer.send_input(&m).await?;}} if session.peer.ready(super::rtc::ReadyPolicy::EchoOnly,false){for m in messages{session.peer.send_input(&m).await?;}}
else {input.release_all();} else {input.release_all();}
if quit{return Ok(())} if quit{return Ok(())}
@@ -157,10 +254,150 @@ pub async fn run(session:&mut Session,window:&mut Window,decoder:&mut dyn super:
}} }}
}.await; }.await;
#[cfg(uu_gtk)] if let Some(f)=files {f.abort();let _=f.await;super::tools_ui::hide();session.peer.tools.lock().unwrap().take();} #[cfg(uu_gtk)] if let Some(f)=files {f.abort();let _=f.await;super::tools_ui::hide();session.peer.tools.lock().unwrap().take();}
if let Some(t)=type_ipc {t.abort();let _=t.await;}
for m in input.release_all(){let _=session.peer.send_input(&m).await;} for m in input.release_all(){let _=session.peer.send_input(&m).await;}
result result
} }
struct TypeJob {
actions: super::secure_input::ActionList,
index: usize,
delay: std::time::Duration,
next_at: tokio::time::Instant,
chars: usize,
snapshot_path: Option<std::path::PathBuf>,
snapshot_create_new: bool,
phase: TypePhase,
reply: Option<tokio::sync::oneshot::Sender<super::type_ipc::TypeResponse>>,
done: bool,
}
enum TypePhase { Sending, WaitSnap(tokio::time::Instant) }
fn start_type_job(mut pending: super::type_ipc::PendingType, mac: bool, enabled: bool, snapshot_create_new: bool) -> Result<TypeJob, ()> {
let reply = pending.reply;
let respond_err = |reply: tokio::sync::oneshot::Sender<super::type_ipc::TypeResponse>, msg: String| {
let _ = reply.send(super::type_ipc::TypeResponse{ok:false,events:0,chars:0,snapshot:None,error:Some(msg)});
};
if !enabled {
respond_err(reply, "view-only session".into());
return Err(());
}
let mut secret = super::secure_input::Secret::new(std::mem::take(&mut pending.request.secret));
if let Err(e) = secret.omit_last_chars(pending.request.omit_last) {
respond_err(reply, e);
return Err(());
}
let chars = secret.chars_count();
let actions = match super::secure_input::expand(secret.as_str(), mac) {
Ok(a) => a,
Err(e) => { respond_err(reply, e); return Err(()); }
};
drop(secret);
log::info!("Secure input prepared: chars={} events={} delay_ms={}", chars, actions.len(), pending.request.delay_ms);
let snapshot_path = pending.request.snapshot.as_ref().filter(|s| !s.is_empty()).map(std::path::PathBuf::from);
Ok(TypeJob {
actions,
index: 0,
delay: std::time::Duration::from_millis(pending.request.delay_ms.min(5_000)),
next_at: tokio::time::Instant::now(),
chars,
snapshot_path,
snapshot_create_new,
phase: TypePhase::Sending,
reply: Some(reply),
done: false,
})
}
fn enqueue_local_type(
slot: &mut Option<TypeJob>,
secret: &mut super::secure_input::Secret,
mac: bool,
snapshot: Option<std::path::PathBuf>,
omit_last: usize,
delay: std::time::Duration,
reply: Option<tokio::sync::oneshot::Sender<super::type_ipc::TypeResponse>>,
) -> Result<(), String> {
secret.omit_last_chars(omit_last)?;
let chars = secret.chars_count();
let actions = super::secure_input::expand(secret.as_str(), mac)?;
drop(std::mem::replace(secret, super::secure_input::Secret::new(String::new())));
log::info!("Secure input prepared: chars={} events={}", chars, actions.len());
*slot = Some(TypeJob {
actions,
index: 0,
delay,
next_at: tokio::time::Instant::now(),
chars,
snapshot_path: snapshot,
snapshot_create_new: false,
phase: TypePhase::Sending,
reply,
done: false,
});
Ok(())
}
async fn pump_type_job(job: &mut TypeJob, session: &mut Session, window: &mut Window) -> Result<(), String> {
use super::type_ipc::TypeResponse;
match job.phase {
TypePhase::Sending => {
if !session.peer.ready(super::rtc::ReadyPolicy::EchoOnly, false) {
return Ok(());
}
if tokio::time::Instant::now() < job.next_at {
return Ok(());
}
if job.index >= job.actions.len() {
let wait = tokio::time::Instant::now() + std::time::Duration::from_secs(1);
job.phase = TypePhase::WaitSnap(wait);
return Ok(());
}
let action = &job.actions[job.index];
session.peer.send_input(&action.to_json()).await?;
job.index += 1;
if !job.delay.is_zero() {
job.next_at = tokio::time::Instant::now() + job.delay;
}
Ok(())
}
TypePhase::WaitSnap(deadline) => {
if tokio::time::Instant::now() < deadline {
return Ok(());
}
let mut snap = None;
if let Some(path) = job.snapshot_path.clone() {
if let Some(frame) = window.last_frame.as_ref() {
match super::type_ipc::write_png_rgb(&path, frame.width, frame.height, &frame.rgb, job.snapshot_create_new) {
Ok(()) => {
log::info!("Secure input snapshot written: {}", path.display());
snap = Some(path.display().to_string());
}
Err(e) => log::warn!("Secure input snapshot failed: {e}"),
}
} else {
log::warn!("Secure input snapshot skipped: no decoded frame yet");
}
}
let events = job.actions.len();
let chars = job.chars;
if let Some(reply) = job.reply.take() {
let _ = reply.send(TypeResponse {
ok: true,
events,
chars,
snapshot: snap,
error: None,
});
} else {
log::info!("Secure input finished: chars={} events={}", chars, events);
}
job.done = true;
Ok(())
}
}
}
#[cfg(test)] mod tests { #[cfg(test)] mod tests {
use super::*; use super::*;
// macOS: SDL video must start on the main thread, which the test harness does not use; CI runs it on Linux. // macOS: SDL video must start on the main thread, which the test harness does not use; CI runs it on Linux.
@@ -223,6 +460,29 @@ pub async fn run(session:&mut Session,window:&mut Window,decoder:&mut dyn super:
assert!(input.release_all().is_empty()); assert!(input.release_all().is_empty());
} }
} }
#[test] fn compositor_resize_and_expose_repaint_the_last_frame(){
let w=|win_event|Event::Window{timestamp:0,window_id:1,win_event};
for e in [WindowEvent::SizeChanged(1280,800),WindowEvent::Resized(1280,800),WindowEvent::Exposed,WindowEvent::Maximized,WindowEvent::Restored]{assert!(needs_redraw(&w(e)));}
for e in [WindowEvent::FocusGained,WindowEvent::Moved(0,0)]{assert!(!needs_redraw(&w(e)));}
}
#[test] fn wheel_events_become_scroll_messages(){
use sdl2::mouse::MouseWheelDirection;
let mut input=Input::default();let mut focused=true;
let v=Viewport::fit((800,600),(1920,1080));
let wheel=|direction,x,y|Event::MouseWheel{timestamp:0,window_id:1,which:0,mouse_x:0,mouse_y:0,x,y,precise_x:0.,precise_y:0.,direction};
let(_,out)=translate([wheel(MouseWheelDirection::Normal,0,1),wheel(MouseWheelDirection::Flipped,0,1),wheel(MouseWheelDirection::Normal,0,0)],&mut input,v,&mut focused);
assert_eq!(out.len(),2);
assert_eq!(out[0]["action"],"mouse_scroll");
assert_eq!(out[0]["delta_y"],120);
assert_eq!(out[1]["delta_y"],-120);
// Trackpads report fractional precise deltas; a quarter notch is 30 wire units.
let precise=Event::MouseWheel{timestamp:0,window_id:1,which:0,mouse_x:0,mouse_y:0,x:0,y:0,precise_x:0.,precise_y:-0.25,direction:MouseWheelDirection::Normal};
let(_,out)=translate([precise],&mut input,v,&mut focused);
assert_eq!(out[0]["delta_y"],-30);
let mut watch=Input::new(true);let mut watching=true;
let(_,out)=translate([wheel(MouseWheelDirection::Normal,0,1)],&mut watch,v,&mut watching);
assert!(out.is_empty());
}
#[test] fn watch_events_never_emit_input_and_still_close(){ #[test] fn watch_events_never_emit_input_and_still_close(){
let mut input=Input::new(true);let mut focused=true; let mut input=Input::new(true);let mut focused=true;
assert!(input.key(4,true).is_none());assert!(input.button(1,true).is_none());assert!(!input.enabled()); assert!(input.key(4,true).is_none());assert!(input.button(1,true).is_none());assert!(!input.enabled());
+731
View File
@@ -0,0 +1,731 @@
//! Compose CONTROL keyboard JSON for scripted typing. Secrets never appear in logs or Debug.
use serde_json::{json, Value};
use std::fmt;
use std::io::{BufRead, Read};
use std::ops::{Deref, DerefMut};
#[cfg(test)]
use std::sync::Mutex;
use std::time::Duration;
/// Serializes tests that mutate process environment.
#[cfg(test)]
pub static ENV_LOCK: Mutex<()> = Mutex::new(());
/// Holds secret text; Debug/Display only show length.
pub struct Secret(String);
impl Secret {
pub fn new(value: String) -> Self {
Self(value)
}
pub fn as_str(&self) -> &str {
&self.0
}
pub fn len(&self) -> usize {
self.0.len()
}
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
pub fn chars_count(&self) -> usize {
self.0.chars().count()
}
/// Drop the last `n` Unicode scalars (fill-without-submit for Windows PIN).
pub fn omit_last_chars(&mut self, n: usize) -> Result<(), String> {
let count = self.0.chars().count();
if n > count {
return Err("omit-last exceeds secret length".into());
}
if n == 0 {
return Ok(());
}
let keep = count - n;
let truncated: String = self.0.chars().take(keep).collect();
zeroize_str(&mut self.0);
self.0 = truncated;
Ok(())
}
}
impl fmt::Debug for Secret {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Secret(len={})", self.0.len())
}
}
impl fmt::Display for Secret {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "*** ({} bytes)", self.0.len())
}
}
impl Drop for Secret {
fn drop(&mut self) {
zeroize_str(&mut self.0);
}
}
fn zeroize_str(s: &mut String) {
let bytes = unsafe { s.as_bytes_mut() };
for b in bytes.iter_mut() {
*b = 0;
}
s.clear();
}
/// One CONTROL keyboard action (Windows VK or Mac keycode in `key`).
#[derive(Clone, Debug, PartialEq)]
pub enum KeyAction {
Press(i32),
Release(i32),
}
impl KeyAction {
pub fn to_json(&self) -> Value {
match self {
Self::Press(k) => json!({"action":"kbd_press","key":k}),
Self::Release(k) => json!({"action":"kbd_release","key":k}),
}
}
fn zeroize(&mut self) {
match self {
Self::Press(k) | Self::Release(k) => *k = 0,
}
}
}
/// Key event list that wipes key codes on drop.
pub struct ActionList(Vec<KeyAction>);
impl std::fmt::Debug for ActionList {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "ActionList(len={})", self.0.len())
}
}
impl ActionList {
pub fn new(actions: Vec<KeyAction>) -> Self {
Self(actions)
}
pub fn len(&self) -> usize {
self.0.len()
}
pub fn is_empty(&self) -> bool {
self.0.is_empty()
}
pub fn as_slice(&self) -> &[KeyAction] {
&self.0
}
}
impl Deref for ActionList {
type Target = [KeyAction];
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for ActionList {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl Drop for ActionList {
fn drop(&mut self) {
for a in &mut self.0 {
a.zeroize();
}
self.0.clear();
}
}
pub fn parse_delay_ms(raw: Option<&str>) -> Result<Duration, String> {
let Some(raw) = raw else {
return Ok(Duration::ZERO);
};
let ms: u64 = raw
.parse()
.map_err(|_| String::from("delay must be a non-negative integer (milliseconds)"))?;
if ms > 5_000 {
return Err("delay must be at most 5000 ms".into());
}
Ok(Duration::from_millis(ms))
}
pub fn parse_omit_last(raw: Option<&str>) -> Result<usize, String> {
let Some(raw) = raw else {
return Ok(0);
};
let n: usize = raw
.parse()
.map_err(|_| String::from("omit-last must be a non-negative integer"))?;
if n > 64 {
return Err("omit-last must be at most 64".into());
}
Ok(n)
}
/// `UU_INPUT_ENV` names another variable that holds the secret; otherwise one stdin line.
/// After reading a named secret variable, that variable is removed from the environment.
pub fn load_secret(stdin: impl BufRead) -> Result<Secret, String> {
if let Ok(name) = std::env::var("UU_INPUT_ENV") {
validate_env_name(&name)?;
let value = std::env::var(&name)
.map_err(|_| "Environment variable named by UU_INPUT_ENV is not set".to_string())?;
std::env::remove_var(&name);
if value.is_empty() {
return Err("Secret environment variable is empty".into());
}
if value.len() > 16 * 1024 {
return Err("Secret exceeds 16 KiB".into());
}
return Ok(Secret::new(value));
}
let mut line = String::new();
stdin
.take(16 * 1024 + 1)
.read_to_string(&mut line)
.map_err(|_| "Cannot read secret from stdin")?;
if line.len() > 16 * 1024 {
return Err("Secret exceeds 16 KiB".into());
}
if line.ends_with('\n') {
line.pop();
if line.ends_with('\r') {
line.pop();
}
}
if line.is_empty() {
return Err("Secret stdin is empty (set UU_INPUT_ENV or pipe text)".into());
}
Ok(Secret::new(line))
}
fn validate_env_name(name: &str) -> Result<(), String> {
if name.is_empty() || name.len() > 128 {
return Err("UU_INPUT_ENV must be a non-empty variable name".into());
}
if !name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
return Err("UU_INPUT_ENV must be an alphanumeric variable name".into());
}
Ok(())
}
/// Expand template text into key actions. Brace tokens: `{Enter}`, `{Tab}`, `{Esc}`,
/// `{Backspace}`, `{Delete}`, `{Space}`, `{Ctrl+Alt+Del}`, arrows, `{Home}`, `{End}`, `{F1}`…`{F12}`.
/// Plain characters use a US QWERTY VK/Mac mapping (Shift for uppercase/symbols).
/// Errors never include the offending character or token text — only a 0-based char index.
pub fn expand(text: &str, mac: bool) -> Result<ActionList, String> {
let mut out = Vec::new();
let mut chars = text.chars().peekable();
let mut index = 0usize;
while let Some(c) = chars.next() {
if c == '{' {
if chars.peek() == Some(&'{') {
chars.next();
push_char(&mut out, '{', mac, index)?;
index += 1;
continue;
}
let start = index;
let mut name = String::new();
let mut closed = false;
for n in chars.by_ref() {
if n == '}' {
closed = true;
break;
}
if n == '{' || name.len() > 32 {
zeroize_str(&mut name);
return Err(format!("Invalid special-key token at index {start}"));
}
name.push(n);
}
if !closed {
zeroize_str(&mut name);
return Err(format!("Unclosed special-key token at index {start}"));
}
// Advance index past '{' + name + '}'
index += 1 + name.chars().count() + 1;
let result = push_special(&mut out, &name, mac, start);
zeroize_str(&mut name);
result?;
continue;
}
if c.is_control() && c != '\t' && c != '\n' && c != '\r' {
return Err(format!("Control character at index {index}"));
}
match c {
'\n' | '\r' => push_special(&mut out, "Enter", mac, index)?,
'\t' => push_special(&mut out, "Tab", mac, index)?,
_ => push_char(&mut out, c, mac, index)?,
}
index += 1;
}
Ok(ActionList::new(out))
}
fn push_special(
out: &mut Vec<KeyAction>,
name: &str,
mac: bool,
index: usize,
) -> Result<(), String> {
let key = match name {
"Enter" | "Return" => Some(vk_or_mac(0x0d, 36, mac)),
"Tab" => Some(vk_or_mac(0x09, 48, mac)),
"Esc" | "Escape" => Some(vk_or_mac(0x1b, 53, mac)),
"Backspace" => Some(vk_or_mac(0x08, 51, mac)),
"Delete" | "Del" => Some(vk_or_mac(0x2e, 117, mac)),
"Space" => Some(vk_or_mac(0x20, 49, mac)),
"Up" => Some(vk_or_mac(0x26, 126, mac)),
"Down" => Some(vk_or_mac(0x28, 125, mac)),
"Left" => Some(vk_or_mac(0x25, 123, mac)),
"Right" => Some(vk_or_mac(0x27, 124, mac)),
"Home" => Some(vk_or_mac(0x24, 115, mac)),
"End" => Some(vk_or_mac(0x23, 119, mac)),
"Ctrl+Alt+Del" | "CAD" => {
let ctrl = vk_or_mac(0xa2, 59, mac);
let alt = vk_or_mac(0xa4, 58, mac);
let del = vk_or_mac(0x2e, 117, mac);
out.push(KeyAction::Press(ctrl));
out.push(KeyAction::Press(alt));
out.push(KeyAction::Press(del));
out.push(KeyAction::Release(del));
out.push(KeyAction::Release(alt));
out.push(KeyAction::Release(ctrl));
return Ok(());
}
other if other.len() >= 2 && other.as_bytes()[0] == b'F' => {
let n: u32 = other[1..]
.parse()
.map_err(|_| format!("Unknown special key at index {index}"))?;
if !(1..=12).contains(&n) {
return Err(format!("Unknown special key at index {index}"));
}
let vk = 0x70 + (n as i32 - 1);
let mac_code = match n {
1 => 122,
2 => 120,
3 => 99,
4 => 118,
5 => 96,
6 => 97,
7 => 98,
8 => 100,
9 => 101,
10 => 109,
11 => 103,
12 => 111,
_ => unreachable!(),
};
Some(vk_or_mac(vk, mac_code, mac))
}
_ => return Err(format!("Unknown special key at index {index}")),
};
let Some(key) = key else {
return Ok(());
};
out.push(KeyAction::Press(key));
out.push(KeyAction::Release(key));
Ok(())
}
fn vk_or_mac(vk: i32, mac: i32, is_mac: bool) -> i32 {
if is_mac {
mac
} else {
vk
}
}
fn push_char(out: &mut Vec<KeyAction>, c: char, mac: bool, index: usize) -> Result<(), String> {
let (vk, shift) = us_qwerty_vk(c)
.ok_or_else(|| format!("Unsupported character at index {index}"))?;
let key = if mac {
mac_from_vk(vk).ok_or_else(|| format!("Unsupported character at index {index}"))?
} else {
vk
};
let shift_key = vk_or_mac(0xa0, 56, mac);
if shift {
out.push(KeyAction::Press(shift_key));
}
out.push(KeyAction::Press(key));
out.push(KeyAction::Release(key));
if shift {
out.push(KeyAction::Release(shift_key));
}
Ok(())
}
fn us_qwerty_vk(c: char) -> Option<(i32, bool)> {
match c {
'a'..='z' => Some((0x41 + (c as i32 - 'a' as i32), false)),
'A'..='Z' => Some((0x41 + (c as i32 - 'A' as i32), true)),
'0' => Some((0x30, false)),
'1'..='9' => Some((0x30 + (c as i32 - '0' as i32), false)),
' ' => Some((0x20, false)),
'-' => Some((0xbd, false)),
'_' => Some((0xbd, true)),
'=' => Some((0xbb, false)),
'+' => Some((0xbb, true)),
'[' => Some((0xdb, false)),
'{' => Some((0xdb, true)),
']' => Some((0xdd, false)),
'}' => Some((0xdd, true)),
'\\' => Some((0xdc, false)),
'|' => Some((0xdc, true)),
';' => Some((0xba, false)),
':' => Some((0xba, true)),
'\'' => Some((0xde, false)),
'"' => Some((0xde, true)),
'`' => Some((0xc0, false)),
'~' => Some((0xc0, true)),
',' => Some((0xbc, false)),
'<' => Some((0xbc, true)),
'.' => Some((0xbe, false)),
'>' => Some((0xbe, true)),
'/' => Some((0xbf, false)),
'?' => Some((0xbf, true)),
'!' => Some((0x31, true)),
'@' => Some((0x32, true)),
'#' => Some((0x33, true)),
'$' => Some((0x34, true)),
'%' => Some((0x35, true)),
'^' => Some((0x36, true)),
'&' => Some((0x37, true)),
'*' => Some((0x38, true)),
'(' => Some((0x39, true)),
')' => Some((0x30, true)),
_ => None,
}
}
fn mac_from_vk(vk: i32) -> Option<i32> {
let scan = match vk {
0x41..=0x5a => 4 + (vk - 0x41),
0x31..=0x39 => 30 + (vk - 0x31),
0x30 => 39,
0x0d => 40,
0x1b => 41,
0x08 => 42,
0x09 => 43,
0x20 => 44,
0xbd => 45,
0xbb => 46,
0xdb => 47,
0xdd => 48,
0xdc => 49,
0xba => 51,
0xde => 52,
0xc0 => 53,
0xbc => 54,
0xbe => 55,
0xbf => 56,
0xa0 => 225,
_ => return None,
};
super::input::mac_keycode(scan)
}
pub async fn send_actions(
send: impl Fn(Value) -> std::pin::Pin<Box<dyn std::future::Future<Output = Result<(), String>> + Send>>,
actions: &[KeyAction],
delay: Duration,
) -> Result<(), String> {
for (i, action) in actions.iter().enumerate() {
send(action.to_json()).await?;
if !delay.is_zero() && i + 1 != actions.len() {
tokio::time::sleep(delay).await;
}
}
Ok(())
}
/// Wait for CONTROL echo on an open desktop session, then send key actions.
pub async fn run_session(
session: &mut super::session::Session,
actions: &[KeyAction],
delay: Duration,
) -> Result<(), String> {
use std::sync::atomic::Ordering;
let ready = async {
loop {
if session.peer.observed.control_open.load(Ordering::Acquire)
&& session.peer.observed.echo_received.load(Ordering::Acquire)
{
return Ok::<_, String>(());
}
tokio::select! {
r = session.step() => r?,
_ = tokio::time::sleep(Duration::from_millis(20)) => {}
}
}
};
tokio::time::timeout(Duration::from_secs(30), ready)
.await
.map_err(|_| "CONTROL echo timed out")??;
for (i, action) in actions.iter().enumerate() {
session.peer.send_input(&action.to_json()).await?;
if !delay.is_zero() && i + 1 != actions.len() {
tokio::time::sleep(delay).await;
}
}
Ok(())
}
/// Dry-run summary: lengths only, never the secret or key codes.
pub fn dry_run_report(secret: &Secret, omit_last: usize, mac: bool) -> Result<String, String> {
let mut owned = Secret::new(secret.as_str().to_owned());
owned.omit_last_chars(omit_last)?;
let actions = expand(owned.as_str(), mac)?;
Ok(format!(
"dry-run: chars={} omit_last={} events={} mac={}",
owned.chars_count(),
omit_last,
actions.len(),
mac
))
}
#[cfg(test)]
mod tests {
use super::*;
use std::io::Cursor;
#[test]
fn secret_debug_and_display_never_leak() {
let s = Secret::new("hunter2".into());
let d = format!("{s:?}");
let p = format!("{s}");
assert!(d.contains("len=7"));
assert!(!d.contains("hunter"));
assert!(!p.contains("hunter"));
assert!(p.contains("***"));
}
#[test]
fn action_list_debug_shows_len_only() {
let list = ActionList::new(vec![
KeyAction::Press(0x41),
KeyAction::Release(0x41),
KeyAction::Press(0x42),
KeyAction::Release(0x42),
]);
let d = format!("{list:?}");
assert_eq!(d, "ActionList(len=4)");
assert!(!d.contains("0x41"));
assert!(!d.contains("Press"));
assert!(!d.contains("41"));
}
#[test]
fn letters_digits_and_shift_symbols_map_to_windows_vk() {
let actions = expand("Ab1!", false).unwrap();
assert_eq!(
&actions[0..4],
&[
KeyAction::Press(0xa0),
KeyAction::Press(0x41),
KeyAction::Release(0x41),
KeyAction::Release(0xa0),
]
);
assert_eq!(
&actions[4..6],
&[KeyAction::Press(0x42), KeyAction::Release(0x42)]
);
assert_eq!(
&actions[6..8],
&[KeyAction::Press(0x31), KeyAction::Release(0x31)]
);
assert_eq!(
&actions[8..12],
&[
KeyAction::Press(0xa0),
KeyAction::Press(0x31),
KeyAction::Release(0x31),
KeyAction::Release(0xa0),
]
);
}
#[test]
fn special_keys_and_ctrl_alt_del() {
let a = expand("{Enter}{Tab}{Esc}{Backspace}{Ctrl+Alt+Del}", false).unwrap();
assert!(a
.windows(2)
.any(|w| w == [KeyAction::Press(0x0d), KeyAction::Release(0x0d)]));
let cad: Vec<_> = a.iter().rev().take(6).rev().cloned().collect();
assert_eq!(
cad,
vec![
KeyAction::Press(0xa2),
KeyAction::Press(0xa4),
KeyAction::Press(0x2e),
KeyAction::Release(0x2e),
KeyAction::Release(0xa4),
KeyAction::Release(0xa2),
]
);
}
#[test]
fn unknown_special_key_errors_without_echoing_payload() {
let err = expand("{NotAKey}", false).unwrap_err();
assert!(err.contains("Unknown special key at index"));
assert!(!err.contains("NotAKey"));
assert!(!err.contains("password"));
}
#[test]
fn unsupported_char_errors_without_codepoint_or_char() {
let err = expand("a中", false).unwrap_err();
assert!(err.contains("Unsupported character at index 1"));
assert!(!err.contains('中'));
assert!(!err.contains("4E2D"));
assert!(!err.contains("U+"));
}
#[test]
fn unclosed_token_and_control_char_rejected() {
assert!(expand("{Enter", false).is_err());
assert!(expand("a\u{0001}b", false).is_err());
}
#[test]
fn load_from_named_env_and_stdin() {
let _g = ENV_LOCK.lock().unwrap();
std::env::set_var("UU_INPUT_ENV", "UU_SECRET");
std::env::set_var("UU_SECRET", "pin-value");
let s = load_secret(Cursor::new(b"")).unwrap();
assert_eq!(s.as_str(), "pin-value");
assert!(!format!("{s:?}").contains("pin"));
assert!(std::env::var("UU_SECRET").is_err());
std::env::remove_var("UU_INPUT_ENV");
let s = load_secret(Cursor::new(b"from-stdin\n")).unwrap();
assert_eq!(s.as_str(), "from-stdin");
}
#[test]
fn invalid_env_name_and_empty_secret() {
let _g = ENV_LOCK.lock().unwrap();
std::env::set_var("UU_INPUT_ENV", "bad-name!");
assert!(load_secret(Cursor::new(b"")).is_err());
std::env::remove_var("UU_INPUT_ENV");
std::env::set_var("UU_INPUT_ENV", "EMPTY_SECRET_TEST");
std::env::set_var("EMPTY_SECRET_TEST", "");
assert!(load_secret(Cursor::new(b"")).is_err());
std::env::remove_var("UU_INPUT_ENV");
std::env::remove_var("EMPTY_SECRET_TEST");
assert!(load_secret(Cursor::new(b"\n")).is_err());
}
#[test]
fn delay_and_omit_bounds() {
assert_eq!(parse_delay_ms(None).unwrap(), Duration::ZERO);
assert_eq!(
parse_delay_ms(Some("50")).unwrap(),
Duration::from_millis(50)
);
assert!(parse_delay_ms(Some("-1")).is_err());
assert!(parse_delay_ms(Some("5001")).is_err());
assert_eq!(parse_omit_last(None).unwrap(), 0);
assert_eq!(parse_omit_last(Some("2")).unwrap(), 2);
assert!(parse_omit_last(Some("65")).is_err());
}
#[test]
fn omit_last_and_dry_run() {
let mut s = Secret::new("1234567".into());
s.omit_last_chars(1).unwrap();
assert_eq!(s.as_str(), "123456");
let report = dry_run_report(&Secret::new("1234567".into()), 1, false).unwrap();
assert!(report.contains("chars=6"));
assert!(report.contains("omit_last=1"));
assert!(report.contains("events="));
assert!(report.contains("omit_last=1"));
assert!(!report.contains("123456"));
assert!(!report.contains("1234567"));
}
#[test]
fn brace_escape_types_literal_brace() {
let a = expand("{{a", false).unwrap();
assert_eq!(
&a[0..4],
&[
KeyAction::Press(0xa0),
KeyAction::Press(0xdb),
KeyAction::Release(0xdb),
KeyAction::Release(0xa0),
]
);
assert_eq!(
&a[4..6],
&[KeyAction::Press(0x41), KeyAction::Release(0x41)]
);
}
#[test]
fn password_with_enter_suffix() {
let a = expand("secret{Enter}", false).unwrap();
assert_eq!(a.last(), Some(&KeyAction::Release(0x0d)));
assert_eq!(a[a.len() - 2], KeyAction::Press(0x0d));
}
#[test]
fn action_list_zeroizes_on_drop() {
let mut a = KeyAction::Press(0x41);
a.zeroize();
assert_eq!(a, KeyAction::Press(0));
let list = ActionList::new(vec![KeyAction::Press(7), KeyAction::Release(7)]);
assert_eq!(list.len(), 2);
drop(list);
}
#[tokio::test]
async fn send_actions_respects_delay_and_order() {
use std::sync::{Arc, Mutex};
let log = Arc::new(Mutex::new(Vec::new()));
let recorded = log.clone();
let actions = expand("a{Enter}", false).unwrap();
let start = std::time::Instant::now();
send_actions(
|v| {
let recorded = recorded.clone();
Box::pin(async move {
recorded.lock().unwrap().push(v);
Ok(())
})
},
actions.as_slice(),
Duration::from_millis(20),
)
.await
.unwrap();
assert!(start.elapsed() >= Duration::from_millis(50));
let keys: Vec<_> = log
.lock()
.unwrap()
.iter()
.map(|v| {
(
v["action"].as_str().unwrap().to_owned(),
v["key"].as_i64().unwrap(),
)
})
.collect();
assert_eq!(
keys,
vec![
("kbd_press".into(), 0x41),
("kbd_release".into(), 0x41),
("kbd_press".into(), 0x0d),
("kbd_release".into(), 0x0d),
]
);
}
}
+4 -6
View File
@@ -3,13 +3,11 @@
use base64::Engine as _; use base64::Engine as _;
use futures_util::{SinkExt, StreamExt}; use futures_util::{SinkExt, StreamExt};
use serde_json::Value; use serde_json::Value;
use tokio::net::TcpStream;
use tokio_tungstenite::{connect_async, MaybeTlsStream, WebSocketStream};
use tokio_tungstenite::tungstenite::{client::IntoClientRequest, Message}; use tokio_tungstenite::tungstenite::{client::IntoClientRequest, Message};
use std::{collections::VecDeque,time::Duration}; use std::{collections::VecDeque,time::Duration};
pub struct Signal { pub struct Signal {
ws: WebSocketStream<MaybeTlsStream<TcpStream>>, ws: crate::ws_transport::Socket,
next_ack:u64, next_ack:u64,
pending:VecDeque<Value>, pending:VecDeque<Value>,
legacy_prefix:bool, legacy_prefix:bool,
@@ -17,14 +15,14 @@ pub struct Signal {
impl Signal { impl Signal {
pub async fn connect(urls:&[String], token:&str, timeout:Duration, legacy_prefix:bool)->Result<Self,String> { pub async fn connect(urls:&[String], token:&str, timeout:Duration, legacy_prefix:bool)->Result<Self,String> {
for url in urls { for url in urls {
if let Ok(Ok(signal))=tokio::time::timeout(timeout,Self::one(url,token,legacy_prefix)).await {return Ok(signal)} if let Ok(Ok(signal))=tokio::time::timeout(timeout,Self::one(url,token,legacy_prefix,timeout)).await {return Ok(signal)}
} }
Err("Signaling connection failed (details omitted)".into()) Err("Signaling connection failed (details omitted)".into())
} }
async fn one(url:&str,token:&str,legacy_prefix:bool)->Result<Self,String> { async fn one(url:&str,token:&str,legacy_prefix:bool,timeout:Duration)->Result<Self,String> {
let mut request=format!("{}/socket.io/?transport=websocket&EIO=4",url.trim_end_matches('/')).into_client_request().map_err(|_|"Invalid signaling endpoint")?; let mut request=format!("{}/socket.io/?transport=websocket&EIO=4",url.trim_end_matches('/')).into_client_request().map_err(|_|"Invalid signaling endpoint")?;
request.headers_mut().insert("X-NRD-AUTH",token.parse().map_err(|_|"Invalid room authentication header")?); request.headers_mut().insert("X-NRD-AUTH",token.parse().map_err(|_|"Invalid room authentication header")?);
let (ws,_)=connect_async(request).await.map_err(|_|"Signaling transport failed")?; let ws=crate::ws_transport::connect(request,timeout).await?;
let mut s=Self{ws,next_ack:10,pending:VecDeque::new(),legacy_prefix}; let mut s=Self{ws,next_ack:10,pending:VecDeque::new(),legacy_prefix};
let mut opened=false; let mut opened=false;
loop { loop {
+627
View File
@@ -0,0 +1,627 @@
//! Local Unix-socket bridge: `uuremote-viewer type` hands secrets to a running desktop session.
//! Frames are length-prefixed JSON; secrets never appear in logs. Peer UID must match.
use serde::{Deserialize, Serialize};
use std::{
os::unix::fs::DirBuilderExt,
path::{Path, PathBuf},
};
use tokio::{
io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt},
net::{UnixListener, UnixStream},
sync::mpsc,
};
/// Max JSON frame (header + secret). 16 KiB secret + margin.
pub const MAX_FRAME: usize = 20 * 1024;
#[derive(Serialize, Deserialize)]
pub struct TypeRequest {
pub delay_ms: u64,
pub omit_last: usize,
pub snapshot: Option<String>,
/// Secret text; Debug only exposes length.
pub secret: String,
}
impl std::fmt::Debug for TypeRequest {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("TypeRequest")
.field("delay_ms", &self.delay_ms)
.field("omit_last", &self.omit_last)
.field(
"snapshot",
&self.snapshot.as_ref().map(|s| format!("len={}", s.len())),
)
.field("secret_len", &self.secret.len())
.finish()
}
}
impl Drop for TypeRequest {
fn drop(&mut self) {
zeroize_string(&mut self.secret);
if let Some(s) = self.snapshot.as_mut() {
zeroize_string(s);
}
}
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct TypeResponse {
pub ok: bool,
pub events: usize,
pub chars: usize,
pub snapshot: Option<String>,
pub error: Option<String>,
}
fn zeroize_string(s: &mut String) {
// Best-effort wipe before drop.
let bytes = unsafe { s.as_bytes_mut() };
for b in bytes.iter_mut() {
*b = 0;
}
s.clear();
}
/// Ensure `dir` is a real directory owned by us with mode & 0o077 == 0 (no symlink).
pub fn validate_private_dir(dir: &Path) -> Result<(), String> {
use std::os::unix::fs::{MetadataExt, PermissionsExt};
let meta = std::fs::symlink_metadata(dir).map_err(|_| "Cannot inspect type-ipc directory")?;
if meta.file_type().is_symlink() {
return Err("Type-ipc path is a symlink".into());
}
if !meta.file_type().is_dir() {
return Err("Type-ipc path is not a directory".into());
}
let me = unsafe { libc::getuid() };
if meta.uid() != me {
return Err("Type-ipc directory owner mismatch".into());
}
if meta.permissions().mode() & 0o077 != 0 {
return Err("Type-ipc directory permissions too open".into());
}
Ok(())
}
pub fn runtime_dir() -> Result<PathBuf, String> {
let base = std::env::var_os("XDG_RUNTIME_DIR")
.map(PathBuf::from)
.unwrap_or_else(|| {
PathBuf::from(format!(
"{}/uu-viewer-type-{}",
std::env::temp_dir().display(),
unsafe { libc::getuid() }
))
});
let dir = if base.ends_with("uu-viewer-type") || base.file_name().is_some_and(|n| {
n.to_string_lossy().starts_with("uu-viewer-type")
}) {
base
} else {
base.join("uu-viewer-type")
};
// Use symlink_metadata so a pre-planted symlink is not followed before we decide.
match std::fs::symlink_metadata(&dir) {
Ok(_) => {
validate_private_dir(&dir)?;
}
Err(e) if e.kind() == std::io::ErrorKind::NotFound => {
std::fs::DirBuilder::new()
.recursive(true)
.mode(0o700)
.create(&dir)
.map_err(|_| "Cannot create private type-ipc directory")?;
validate_private_dir(&dir)?;
}
Err(_) => return Err("Cannot inspect type-ipc directory".into()),
}
Ok(dir)
}
pub fn device_key(device: &str) -> String {
use sha2::{Digest, Sha256};
hex::encode(Sha256::digest(device.as_bytes()))
}
pub fn socket_path(device: &str) -> Result<PathBuf, String> {
Ok(runtime_dir()?.join(format!("{}.sock", device_key(device))))
}
pub fn default_snapshot_path(device: &str) -> Result<PathBuf, String> {
let ts = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_millis())
.unwrap_or(0);
Ok(runtime_dir()?.join(format!("snap-{}-{ts}.png", &device_key(device)[..12])))
}
pub async fn read_frame(r: &mut (impl AsyncRead + Unpin)) -> Result<Vec<u8>, String> {
let n = r.read_u32().await.map_err(|_| "Type IPC closed")? as usize;
if n > MAX_FRAME {
return Err("Type IPC frame exceeds size limit".into());
}
let mut b = vec![0; n];
r.read_exact(&mut b)
.await
.map_err(|_| "Type IPC closed")?;
Ok(b)
}
pub async fn write_frame(w: &mut (impl AsyncWrite + Unpin), body: &[u8]) -> Result<(), String> {
if body.len() > MAX_FRAME {
return Err("Type IPC frame exceeds size limit".into());
}
w.write_u32(body.len() as u32)
.await
.map_err(|_| "Type IPC closed")?;
w.write_all(body).await.map_err(|_| "Type IPC closed")?;
Ok(())
}
fn check_peer(stream: &UnixStream) -> Result<(), String> {
let cred = stream
.peer_cred()
.map_err(|_| "Type IPC peer credentials unavailable")?;
let uid = cred.uid();
let me = unsafe { libc::getuid() };
if uid != me {
return Err("Type IPC peer uid mismatch".into());
}
Ok(())
}
pub struct Server {
pub path: PathBuf,
listener: Option<UnixListener>,
}
impl Drop for Server {
fn drop(&mut self) {
let _ = std::fs::remove_file(&self.path);
}
}
impl Server {
pub async fn bind(device: &str) -> Result<Self, String> {
let path = socket_path(device)?;
if path.exists() {
match UnixStream::connect(&path).await {
Ok(_) => return Err("A desktop viewer is already listening for this device".into()),
Err(_) => {
let _ = std::fs::remove_file(&path);
}
}
}
let listener = UnixListener::bind(&path).map_err(|_| "Cannot bind type IPC socket")?;
use std::os::unix::fs::PermissionsExt;
let _ = std::fs::set_permissions(&path, std::fs::Permissions::from_mode(0o600));
Ok(Self { path, listener: Some(listener) })
}
/// Accept connections and forward validated TypeRequests to `tx`.
pub async fn run(mut self, tx: mpsc::Sender<PendingType>) {
let path = self.path.clone();
let listener = self.listener.take().expect("type IPC listener");
// Prevent Drop from removing the socket twice while we still hold `path` in a guard.
self.path = PathBuf::new();
struct Guard(PathBuf);
impl Drop for Guard {
fn drop(&mut self) {
if !self.0.as_os_str().is_empty() {
let _ = std::fs::remove_file(&self.0);
}
}
}
let _guard = Guard(path);
loop {
let accepted = listener.accept().await;
let Ok((stream, _)) = accepted else { break };
if check_peer(&stream).is_err() {
continue;
}
let tx = tx.clone();
tokio::spawn(async move {
let _ = serve_client(stream, tx).await;
});
}
}
}
pub struct PendingType {
pub request: TypeRequest,
pub reply: tokio::sync::oneshot::Sender<TypeResponse>,
}
async fn serve_client(mut stream: UnixStream, tx: mpsc::Sender<PendingType>) -> Result<(), String> {
let body = read_frame(&mut stream).await?;
let request: TypeRequest =
serde_json::from_slice(&body).map_err(|_| "Invalid type IPC request")?;
let mut body = body;
for b in &mut body {
*b = 0;
}
let (reply_tx, reply_rx) = tokio::sync::oneshot::channel();
// Move request into PendingType; zeroize on drop if send fails.
if tx
.send(PendingType {
request,
reply: reply_tx,
})
.await
.is_err()
{
return Err("Desktop session is gone".into());
}
let response = reply_rx.await.map_err(|_| "Desktop session is gone")?;
let out = serde_json::to_vec(&response).map_err(|_| "Type IPC encode failed")?;
write_frame(&mut stream, &out).await
}
/// Client: deliver a type request to a running viewer. Returns response or connection error.
pub async fn send_to_viewer(device: &str, mut request: TypeRequest) -> Result<TypeResponse, String> {
let path = socket_path(device)?;
let mut stream = UnixStream::connect(&path)
.await
.map_err(|_| "No running desktop viewer for this device")?;
check_peer(&stream)?;
let body = serde_json::to_vec(&request).map_err(|_| "Type IPC encode failed")?;
// Clear serde copy in request early — response path still needs omit metadata only.
zeroize_string(&mut request.secret);
write_frame(&mut stream, &body).await?;
// Wipe encoded body
let mut body = body;
for b in &mut body {
*b = 0;
}
let resp_body = read_frame(&mut stream).await?;
let response: TypeResponse =
serde_json::from_slice(&resp_body).map_err(|_| "Invalid type IPC response")?;
Ok(response)
}
/// Encode an RGB24 frame as a minimal PNG (8-bit RGB, no filtering beyond None).
/// Write RGB24 as PNG. Always uses O_NOFOLLOW + mode 0600.
/// `create_new`: true for default runtime paths (refuse overwrite); false for user `--snapshot`.
pub fn write_png_rgb(
path: &Path,
width: u32,
height: u32,
rgb: &[u8],
create_new: bool,
) -> Result<(), String> {
let expected = width as usize * height as usize * 3;
if rgb.len() != expected || width == 0 || height == 0 {
return Err("Snapshot frame size mismatch".into());
}
use flate2::{write::ZlibEncoder, Compression};
use std::io::Write;
let mut raw = Vec::with_capacity((width as usize * 3 + 1) * height as usize);
for row in 0..height as usize {
raw.push(0); // filter None
let start = row * width as usize * 3;
raw.extend_from_slice(&rgb[start..start + width as usize * 3]);
}
let mut enc = ZlibEncoder::new(Vec::new(), Compression::fast());
enc.write_all(&raw).map_err(|_| "Snapshot zlib failed")?;
for b in &mut raw {
*b = 0;
}
let compressed = enc.finish().map_err(|_| "Snapshot zlib failed")?;
fn chunk(tag: &[u8; 4], data: &[u8], out: &mut Vec<u8>) {
out.extend_from_slice(&(data.len() as u32).to_be_bytes());
out.extend_from_slice(tag);
out.extend_from_slice(data);
let mut crc = crc32_ieee_update(0xffff_ffff, tag);
crc = crc32_ieee_update(crc, data);
out.extend_from_slice(&(crc ^ 0xffff_ffff).to_be_bytes());
}
let mut png = Vec::with_capacity(compressed.len() + 128);
png.extend_from_slice(&[137, 80, 78, 71, 13, 10, 26, 10]);
let mut ihdr = Vec::with_capacity(13);
ihdr.extend_from_slice(&width.to_be_bytes());
ihdr.extend_from_slice(&height.to_be_bytes());
ihdr.extend_from_slice(&[8, 2, 0, 0, 0]); // 8-bit RGB
chunk(b"IHDR", &ihdr, &mut png);
chunk(b"IDAT", &compressed, &mut png);
chunk(b"IEND", &[], &mut png);
use std::os::unix::fs::OpenOptionsExt;
let mut opts = std::fs::OpenOptions::new();
opts.write(true).mode(0o600).custom_flags(libc::O_NOFOLLOW);
if create_new {
opts.create_new(true);
} else {
opts.create(true).truncate(true);
}
let mut file = opts
.open(path)
.map_err(|_| "Cannot write snapshot file")?;
file.write_all(&png).map_err(|_| "Cannot write snapshot file")?;
Ok(())
}
fn crc32_ieee(data: &[u8]) -> u32 {
crc32_ieee_update(0xffff_ffff, data) ^ 0xffff_ffff
}
fn crc32_ieee_update(mut crc: u32, data: &[u8]) -> u32 {
for &b in data {
crc ^= u32::from(b);
for _ in 0..8 {
let mask = (!(crc & 1)).wrapping_add(1); // 0 or 0xFFFFFFFF
crc = (crc >> 1) ^ (0xEDB8_8320 & mask);
}
}
crc
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn frame_limit_rejects_oversized_length() {
// Unit-level: MAX_FRAME constant is the contract used by read_frame.
assert!(MAX_FRAME >= 16 * 1024);
assert!(MAX_FRAME < 1024 * 1024);
}
#[test]
fn device_key_is_stable_hex() {
let a = device_key("device-1");
let b = device_key("device-1");
assert_eq!(a, b);
assert_eq!(a.len(), 64);
assert!(a.chars().all(|c| c.is_ascii_hexdigit()));
assert_ne!(device_key("device-1"), device_key("device-2"));
}
#[test]
fn png_roundtrip_header_and_mode() {
let dir = tempfile_dir();
let path = dir.join("t.png");
write_png_rgb(&path, 2, 2, &[255, 0, 0, 0, 255, 0, 0, 0, 255, 255, 255, 255], true).unwrap();
let meta = std::fs::metadata(&path).unwrap();
use std::os::unix::fs::PermissionsExt;
assert_eq!(meta.permissions().mode() & 0o777, 0o600);
let bytes = std::fs::read(&path).unwrap();
assert_eq!(&bytes[..8], &[137, 80, 78, 71, 13, 10, 26, 10]);
let _ = std::fs::remove_dir_all(dir);
}
fn tempfile_dir() -> PathBuf {
use std::os::unix::fs::DirBuilderExt;
let dir = std::env::temp_dir().join(format!("uu-type-ipc-test-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
std::fs::DirBuilder::new()
.mode(0o700)
.create(&dir)
.unwrap();
dir
}
#[tokio::test]
async fn server_client_roundtrip_and_uid_gate() {
let device = format!("ipc-test-{}", uuidish());
let server = Server::bind(&device).await.unwrap();
let path = server.path.clone();
let (tx, mut rx) = mpsc::channel::<PendingType>(4);
let run = tokio::spawn(async move { server.run(tx).await });
// Handle one request in background
let worker = tokio::spawn(async move {
if let Some(pending) = rx.recv().await {
assert_eq!(pending.request.secret, "sentinel-SECRET-9f3a");
assert_eq!(pending.request.delay_ms, 10);
assert_eq!(pending.request.omit_last, 1);
let _ = pending.reply.send(TypeResponse {
ok: true,
events: 12,
chars: 6,
snapshot: Some("/tmp/fake.png".into()),
error: None,
});
}
});
let response = send_to_viewer(
&device,
TypeRequest {
delay_ms: 10,
omit_last: 1,
snapshot: None,
secret: "sentinel-SECRET-9f3a".into(),
},
)
.await
.unwrap();
assert!(response.ok);
assert_eq!(response.events, 12);
assert_eq!(response.snapshot.as_deref(), Some("/tmp/fake.png"));
worker.abort();
run.abort();
let _ = std::fs::remove_file(path);
}
#[tokio::test]
async fn connect_without_server_errors_without_secret() {
let device = format!("missing-{}", uuidish());
let err = send_to_viewer(
&device,
TypeRequest {
delay_ms: 0,
omit_last: 0,
snapshot: None,
secret: "sentinel-SECRET-9f3a".into(),
},
)
.await
.unwrap_err();
assert!(err.contains("No running desktop viewer"));
assert!(!err.contains("sentinel"));
}
#[tokio::test]
async fn oversized_frame_rejected() {
let device = format!("oversize-{}", uuidish());
let server = Server::bind(&device).await.unwrap();
let path = server.path.clone();
let (tx, mut rx) = mpsc::channel::<PendingType>(1);
let run = tokio::spawn(async move { server.run(tx).await });
// Drain so accept happens
let _drain = tokio::spawn(async move { while rx.recv().await.is_some() {} });
let mut stream = UnixStream::connect(&path).await.unwrap();
let huge = vec![0u8; MAX_FRAME + 1];
let result = write_frame(&mut stream, &huge).await;
// Client-side write_frame rejects before send
assert!(result.is_err());
assert!(!format!("{result:?}").contains("sentinel"));
run.abort();
let _ = std::fs::remove_file(path);
}
#[test]
fn validate_private_dir_rejects_symlink_and_open_mode() {
use std::os::unix::fs::{DirBuilderExt, PermissionsExt};
let base = std::env::temp_dir().join(format!(
"uu-type-ipc-val-{}-{}",
std::process::id(),
uuidish()
));
let _ = std::fs::remove_dir_all(&base);
std::fs::DirBuilder::new().mode(0o700).create(&base).unwrap();
let open = base.join("open");
std::fs::DirBuilder::new().mode(0o755).create(&open).unwrap();
let err = validate_private_dir(&open).unwrap_err();
assert!(err.contains("permissions"), "{err}");
assert!(!err.contains("sentinel"));
let good = base.join("good");
std::fs::DirBuilder::new().mode(0o700).create(&good).unwrap();
validate_private_dir(&good).unwrap();
let link = base.join("link");
std::os::unix::fs::symlink(&good, &link).unwrap();
let err = validate_private_dir(&link).unwrap_err();
assert!(err.contains("symlink"), "{err}");
let file = base.join("file");
std::fs::write(&file, b"x").unwrap();
let err = validate_private_dir(&file).unwrap_err();
assert!(err.contains("not a directory"), "{err}");
let _ = std::fs::remove_dir_all(&base);
}
#[test]
fn runtime_dir_rejects_preexisting_open_or_symlink() {
use std::os::unix::fs::DirBuilderExt;
// Serialize against other tests that read/write process environment.
let _env = crate::viewer::secure_input::ENV_LOCK.lock().unwrap();
let base = std::env::temp_dir().join(format!(
"uu-type-ipc-rt-{}-{}",
std::process::id(),
uuidish()
));
let _ = std::fs::remove_dir_all(&base);
std::fs::DirBuilder::new().mode(0o700).create(&base).unwrap();
// Point XDG_RUNTIME_DIR at a private base; plant a bad uu-viewer-type child.
let child = base.join("uu-viewer-type");
std::fs::DirBuilder::new().mode(0o755).create(&child).unwrap();
let _guard = EnvGuard::set("XDG_RUNTIME_DIR", base.to_str().unwrap());
let err = runtime_dir().unwrap_err();
assert!(err.contains("permissions"), "{err}");
let _ = std::fs::remove_dir_all(&child);
let target = base.join("target");
std::fs::DirBuilder::new().mode(0o700).create(&target).unwrap();
std::os::unix::fs::symlink(&target, &child).unwrap();
let err = runtime_dir().unwrap_err();
assert!(err.contains("symlink"), "{err}");
let _ = std::fs::remove_file(&child);
// Fresh create succeeds and validates.
let dir = runtime_dir().unwrap();
assert!(dir.ends_with("uu-viewer-type"));
validate_private_dir(&dir).unwrap();
let _ = std::fs::remove_dir_all(&base);
}
#[test]
fn write_png_refuses_symlink_target() {
let dir = tempfile_dir();
let real = dir.join("real.png");
let link = dir.join("link.png");
std::fs::write(&real, b"old").unwrap();
std::os::unix::fs::symlink(&real, &link).unwrap();
let err = write_png_rgb(
&link,
1,
1,
&[1, 2, 3],
false,
)
.unwrap_err();
assert!(err.contains("Cannot write snapshot"), "{err}");
// Original untouched
assert_eq!(std::fs::read(&real).unwrap(), b"old");
let _ = std::fs::remove_dir_all(dir);
}
#[test]
fn write_png_create_new_refuses_existing() {
let dir = tempfile_dir();
let path = dir.join("exists.png");
std::fs::write(&path, b"old").unwrap();
let err = write_png_rgb(&path, 1, 1, &[1, 2, 3], true).unwrap_err();
assert!(err.contains("Cannot write snapshot"), "{err}");
assert_eq!(std::fs::read(&path).unwrap(), b"old");
let _ = std::fs::remove_dir_all(dir);
}
#[test]
fn type_request_debug_shows_secret_len_only() {
let req = TypeRequest {
delay_ms: 40,
omit_last: 1,
snapshot: Some("/tmp/out.png".into()),
secret: "sentinel-SECRET-9f3a".into(),
};
let d = format!("{req:?}");
assert!(d.contains("secret_len: 20") || d.contains("secret_len: 20,"), "{d}");
assert!(!d.contains("sentinel"));
assert!(!d.contains("SECRET"));
assert!(!d.contains("9f3a"));
}
struct EnvGuard {
key: &'static str,
prev: Option<std::ffi::OsString>,
}
impl EnvGuard {
fn set(key: &'static str, val: &str) -> Self {
let prev = std::env::var_os(key);
std::env::set_var(key, val);
Self { key, prev }
}
}
impl Drop for EnvGuard {
fn drop(&mut self) {
match &self.prev {
Some(v) => std::env::set_var(self.key, v),
None => std::env::remove_var(self.key),
}
}
}
fn uuidish() -> String {
format!(
"{:x}",
std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap()
.as_nanos()
)
}
}
+110 -3
View File
@@ -3,6 +3,7 @@
#[path = "auth.rs"] mod auth; #[path = "auth.rs"] mod auth;
#[path = "config.rs"] mod config; #[path = "config.rs"] mod config;
#[path = "protocol.rs"] mod protocol; #[path = "protocol.rs"] mod protocol;
mod ws_transport;
mod viewer; mod viewer;
#[cfg(test)] #[path="hevc.rs"] mod hevc; #[cfg(test)] #[path="hevc.rs"] mod hevc;
use viewer::clipboard; use viewer::clipboard;
@@ -13,7 +14,7 @@ use viewer::clipboard;
#[cfg(test)] #[path="initialization.rs"] mod initialization; #[cfg(test)] #[path="initialization.rs"] mod initialization;
use viewer::{api::Api,rtc::ReadyPolicy,session::{Options,Session},wire::Shape}; use viewer::{api::Api,rtc::ReadyPolicy,session::{Options,Session},wire::Shape};
use std::time::Duration; use std::time::Duration;
const HELP:&str="Experimental native viewer.\n uuremote-viewer ui (GTK window: sign-in, devices, sessions) Desktop UI requires viewer-sdl (decodes with the ffmpeg CLI, or FFmpeg 6.x libraries with viewer-ffmpeg).\n uuremote-viewer power DEVICE reboot|shutdown\n uuremote-viewer unbind DEVICE [--shared] (从账号删除设备 / remove a device from the account)\n uuremote-viewer terminal DEVICE [SESSION]\n uuremote-viewer files DEVICE ls PATH | get REMOTE LOCAL | put LOCAL REMOTE\n uuremote-viewer portmap DEVICE LOCAL_PORT HOST PORT\n uuremote-viewer files-ui|portmap-ui|terminal-ui DEVICE NAME (GTK tool windows)\n uuremote-viewer login [--no-gui]\n uuremote-viewer devices METHOD ARRAY_POINTER ID_POINTER NAME_POINTER\n uuremote-viewer assist CONNECT_ID (验证码从 stdin 读取一行)\n uuremote-viewer connect DEVICE true|false SHAPE_JSON echo|manual raw|legacy [--view-only]\nVideo: UU_VIEWER_CODEC=h264 forces H.264; UU_VIEWER_CHROMA=444 requests true color (default 4:2:0).\nAudio: UU_VIEWER_AUDIO=0 disables playback. UU_VIEWER_VIEW_ONLY=1 disables desktop input.\nDevice-list method/JSON pointers and compatibility shape require verified operator configuration.\nQR login reuses the sibling uuremote-server login command. Never run login in a captured log.\nEcho readiness is transport observation only; no sendVideoTrack RPC is emitted."; const HELP:&str="Experimental native viewer.\n uuremote-viewer ui (GTK window: sign-in, devices, sessions) Desktop UI requires viewer-sdl (decodes with the ffmpeg CLI, or FFmpeg 6.x libraries with viewer-ffmpeg).\n uuremote-viewer power DEVICE reboot|shutdown\n uuremote-viewer type DEVICE [options] (secret from UU_INPUT_ENV or stdin; reuses running viewer)\n options: --delay-ms MS --omit-last N --snapshot PATH --dry-run --new-session\n uuremote-viewer unbind DEVICE [--shared] (从账号删除设备 / remove a device from the account)\n uuremote-viewer terminal DEVICE [SESSION]\n uuremote-viewer files DEVICE ls PATH | get REMOTE LOCAL | put LOCAL REMOTE\n uuremote-viewer portmap DEVICE LOCAL_PORT HOST PORT\n uuremote-viewer files-ui|portmap-ui|terminal-ui DEVICE NAME (GTK tool windows)\n uuremote-viewer login [--no-gui]\n uuremote-viewer devices METHOD ARRAY_POINTER ID_POINTER NAME_POINTER\n uuremote-viewer assist CONNECT_ID (验证码从 stdin 读取一行)\n uuremote-viewer connect DEVICE true|false SHAPE_JSON echo|manual raw|legacy [--view-only]\nVideo: UU_VIEWER_CODEC=h264 forces H.264; UU_VIEWER_CHROMA=444 requests true color (default 4:2:0).\nAudio: UU_VIEWER_AUDIO=0 disables playback. UU_VIEWER_VIEW_ONLY=1 disables desktop input.\nDevice-list method/JSON pointers and compatibility shape require verified operator configuration.\nQR login reuses the sibling uuremote-server login command. Never run login in a captured log.\nEcho readiness is transport observation only; no sendVideoTrack RPC is emitted.";
const DEFAULT_SHAPE:&str=r#"{"capture_type":1,"platform":3,"client_version":"4.42.0","width":1920,"height":1080,"fps":60,"chroma":1, const DEFAULT_SHAPE:&str=r#"{"capture_type":1,"platform":3,"client_version":"4.42.0","width":1920,"height":1080,"fps":60,"chroma":1,
"decoders":[{"fps":60,"codec":1,"width":3840,"height":2160,"chroma":1}],"display_modes":[[1920,1080,60]], "decoders":[{"fps":60,"codec":1,"width":3840,"height":2160,"chroma":1}],"display_modes":[[1920,1080,60]],
"displays":[{"id":1,"fps":60,"type":0,"hdr":0}], "displays":[{"id":1,"fps":60,"type":0,"hdr":0}],
@@ -60,6 +61,7 @@ async fn run(args:&[String])->Result<(),String> {
println!("已从账号删除设备");Ok(()) println!("已从账号删除设备");Ok(())
} }
Some("power")=>power_command(args).await, Some("power")=>power_command(args).await,
Some("type")=>type_command(args).await,
Some("terminal-local") if args.len()==2 || args.len()==3=>{ Some("terminal-local") if args.len()==2 || args.len()==3=>{
let session=if args.len()==3{Some(args[2].parse::<u32>().ok().filter(|n|*n!=0).ok_or("Invalid terminal session id")?)}else{None}; let session=if args.len()==3{Some(args[2].parse::<u32>().ok().filter(|n|*n!=0).ok_or("Invalid terminal session id")?)}else{None};
viewer::tools::terminal_ipc::client(std::path::Path::new(&args[1]),session).await viewer::tools::terminal_ipc::client(std::path::Path::new(&args[1]),session).await
@@ -111,11 +113,93 @@ async fn desktop_command(args:&[String],code:Option<String>)->Result<(),String>
let options=Options{timeout:Duration::from_secs(12),legacy_prefix:legacy,ready_policy:policy,clipboard}; let options=Options{timeout:Duration::from_secs(12),legacy_prefix:legacy,ready_policy:policy,clipboard};
let mut session=Session::open(&room,&shape,&creds.device_id,&creds.client_id,options,Default::default()).await?; let mut session=Session::open(&room,&shape,&creds.device_id,&creds.client_id,options,Default::default()).await?;
#[cfg(feature="viewer-sdl")] #[cfg(feature="viewer-sdl")]
let result=if let Some((window,decoder))=desktop.as_mut(){viewer::sdl::run(&mut session,window,decoder.as_mut(),view_only).await}else{session.run().await}; let result=if let Some((window,decoder))=desktop.as_mut(){viewer::sdl::run(&mut session,window,decoder.as_mut(),view_only,&args[1]).await}else{session.run().await};
#[cfg(not(feature="viewer-sdl"))] #[cfg(not(feature="viewer-sdl"))]
let result=session.run().await; let result=session.run().await;
session.close().await;result session.close().await;result
} }
async fn type_command(args:&[String])->Result<(),String>{
// type DEVICE [--delay-ms MS] [--omit-last N] [--snapshot PATH] [--dry-run] [--new-session]
if args.len()<2 || args[1].trim().is_empty() { return Err(HELP.into()) }
let device=&args[1];
let mut delay_ms:Option<&str>=None;
let mut omit_last:Option<&str>=None;
let mut snapshot:Option<String>=None;
let mut dry_run=false;
let mut new_session=false;
let mut i=2;
while i<args.len() {
match args[i].as_str() {
"--delay-ms" => {
i+=1; delay_ms=Some(args.get(i).map(String::as_str).ok_or_else(||HELP.to_string())?);
}
"--omit-last" => {
i+=1; omit_last=Some(args.get(i).map(String::as_str).ok_or_else(||HELP.to_string())?);
}
"--snapshot" => {
i+=1; snapshot=Some(args.get(i).cloned().ok_or_else(||HELP.to_string())?);
}
"--dry-run" => { dry_run=true; }
"--new-session" => { new_session=true; }
_ => return Err(HELP.into()),
}
i+=1;
}
let delay=viewer::secure_input::parse_delay_ms(delay_ms)?;
let omit=viewer::secure_input::parse_omit_last(omit_last)?;
let mut secret=viewer::secure_input::load_secret(std::io::stdin().lock())?;
if dry_run {
let report=viewer::secure_input::dry_run_report(&secret, omit, false)?;
drop(secret);
println!("{report}");
return Ok(());
}
secret.omit_last_chars(omit)?;
// Prefer a running desktop viewer (avoids force-replacing the live session, upstream #30).
match viewer::type_ipc::socket_path(device) {
Ok(path) if path.exists() && !new_session => {
let req=viewer::type_ipc::TypeRequest{
delay_ms: delay.as_millis() as u64,
omit_last: 0, // already applied locally
snapshot,
secret: secret.as_str().to_owned(),
};
drop(secret);
let response=viewer::type_ipc::send_to_viewer(device, req).await?;
if !response.ok {
return Err(response.error.unwrap_or_else(||"Secure input failed on running viewer".into()));
}
println!("安全输入已发送({} 个按键事件,{} 字符)。", response.events, response.chars);
if let Some(path)=response.snapshot {
println!("snapshot={path}");
log::info!("Secure input snapshot: {path}");
}
return Ok(());
}
_ => {}
}
if !new_session {
drop(secret);
return Err("No running desktop viewer for this device; open a connect/ui session first, or pass --new-session".into());
}
let mut shape:Shape=serde_json::from_str(DEFAULT_SHAPE).map_err(|_|"Invalid built-in type shape")?;
shape.capture_type=1;
let creds=credentials()?;let api=Api::new(auth::UUAuthClient::new(creds.clone()),auth::BASE_URL);
let room=api.join(device,false,true).await.map_err(|e|e.to_string())?;
let mac=api.target_is_mac(&room,Some(device)).await.map_err(|e|e.to_string())?;
let actions=viewer::secure_input::expand(secret.as_str(),mac)?;
let event_count=actions.len();
let char_count=secret.chars_count();
drop(secret);
log::info!("Secure input prepared (new session): chars={} events={} delay_ms={} mac={}", char_count, event_count, delay.as_millis(), mac);
let options=Options{timeout:Duration::from_secs(12),legacy_prefix:true,ready_policy:ReadyPolicy::EchoOnly,clipboard:clipboard::Bridge::new(false)};
let mut session=Session::open(&room,&shape,&creds.device_id,&creds.client_id,options,Default::default()).await?;
let result=viewer::secure_input::run_session(&mut session,actions.as_slice(),delay).await;
session.close().await;
if result.is_ok(){println!("安全输入已发送({event_count} 个按键事件);新会话路径无截图。");}
result
}
fn credentials()->Result<auth::Credentials,String> {auth::Credentials::load(config::read_fresh().map_err(|_|"Cannot read credential configuration")?.as_ref())} fn credentials()->Result<auth::Credentials,String> {auth::Credentials::load(config::read_fresh().map_err(|_|"Cannot read credential configuration")?.as_ref())}
fn api()->Result<Api,String> {Ok(Api::new(auth::UUAuthClient::new(credentials()?),auth::BASE_URL))} fn api()->Result<Api,String> {Ok(Api::new(auth::UUAuthClient::new(credentials()?),auth::BASE_URL))}
@@ -128,11 +212,34 @@ mod cli_tests {
use super::*; use super::*;
#[tokio::test] #[tokio::test]
async fn invalid_commands_never_fall_through_to_login_or_host_service() { async fn invalid_commands_never_fall_through_to_login_or_host_service() {
for args in [vec!["invalid"],vec!["power"],vec!["power","device","logout"],vec!["power","device","reboot","extra"],vec!["login","--invalid"],vec!["connect"],vec!["assist"],vec!["assist","id","forbidden-code-argument"],vec!["terminal"],vec!["terminal","device","extra"],vec!["terminal","device","0"],vec!["terminal","device","4294967296"],vec!["terminal-ui","device"],vec!["files","device","bad","path"],vec!["portmap","device","bad","host","80"],vec!["portmap","device","8000","host","0"],vec!["devices","DELETE","/data","/id","/name"],vec!["unbind"],vec!["unbind",""],vec!["unbind","device","--other"],vec!["unbind","device","--shared","extra"]] { for args in [vec!["invalid"],vec!["power"],vec!["power","device","logout"],vec!["power","device","reboot","extra"],vec!["type"],vec!["type","device","--delay-ms"],vec!["type","device","--delay-ms","x"],vec!["type","device","extra"],vec!["type","device","--omit-last"],vec!["type","device","--snapshot"],vec!["login","--invalid"],vec!["connect"],vec!["assist"],vec!["assist","id","forbidden-code-argument"],vec!["terminal"],vec!["terminal","device","extra"],vec!["terminal","device","0"],vec!["terminal","device","4294967296"],vec!["terminal-ui","device"],vec!["files","device","bad","path"],vec!["portmap","device","bad","host","80"],vec!["portmap","device","8000","host","0"],vec!["devices","DELETE","/data","/id","/name"],vec!["unbind"],vec!["unbind",""],vec!["unbind","device","--other"],vec!["unbind","device","--shared","extra"]] {
assert!(run(&args.into_iter().map(str::to_owned).collect::<Vec<_>>()).await.is_err()); assert!(run(&args.into_iter().map(str::to_owned).collect::<Vec<_>>()).await.is_err());
} }
} }
#[tokio::test] #[tokio::test]
async fn type_dry_run_and_no_viewer_paths_are_redacted() {
let _g = viewer::secure_input::ENV_LOCK.lock().unwrap();
std::env::set_var("UU_INPUT_ENV", "UU_TYPE_SENTINEL_ENV");
std::env::set_var("UU_TYPE_SENTINEL_ENV", "sentinel-SECRET-9f3a");
let out = {
// dry-run
let args: Vec<String> = ["type","missing-device-id","--dry-run"].into_iter().map(str::to_owned).collect();
// reload env for dry-run — previous load_secret removed the var
std::env::set_var("UU_INPUT_ENV", "UU_TYPE_SENTINEL_ENV");
std::env::set_var("UU_TYPE_SENTINEL_ENV", "sentinel-SECRET-9f3a");
run(&args).await
};
assert!(out.is_ok(), "{out:?}");
std::env::set_var("UU_INPUT_ENV", "UU_TYPE_SENTINEL_ENV");
std::env::set_var("UU_TYPE_SENTINEL_ENV", "sentinel-SECRET-9f3a");
let err = run(&["type".into(),"missing-device-id".into()]).await.unwrap_err();
assert!(err.contains("No running desktop viewer") || err.contains("--new-session"), "{err}");
assert!(!err.contains("sentinel"));
assert!(!err.contains("SECRET"));
std::env::remove_var("UU_INPUT_ENV");
std::env::remove_var("UU_TYPE_SENTINEL_ENV");
}
#[tokio::test]
async fn login_reuses_companion_subcommand_with_a_local_process_mock() { async fn login_reuses_companion_subcommand_with_a_local_process_mock() {
use std::os::unix::fs::PermissionsExt; use std::os::unix::fs::PermissionsExt;
let path=std::env::temp_dir().join(format!("uu-viewer-login-mock-{}",viewer::wire::uuid())); let path=std::env::temp_dir().join(format!("uu-viewer-login-mock-{}",viewer::wire::uuid()));
+136 -9
View File
@@ -204,11 +204,13 @@ pub fn text_probe()->Result<(),String> {
Ok(()) Ok(())
} }
// Opt-in single-track monitor switching for Hyprland. The existing native engine owns // Opt-in single-track monitor switching: Hyprland outputs (UU_WAYLAND_MULTISCREEN) or X11 RandR
// capture/pointer binding; no compositor layout or user credentials are modified. // monitors (UU_X11_MULTISCREEN). The existing engines own capture/pointer binding; X11 crops the
// root to the selected monitor. No compositor layout or user credentials are modified.
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct Output { pub name:String, pub width:u32, pub height:u32, pub fps:i32 } pub struct Output { pub name:String, pub width:u32, pub height:u32, pub fps:i32, pub x:i32, pub y:i32 }
static OUTPUTS: std::sync::OnceLock<Vec<Output>> = std::sync::OnceLock::new(); struct Inventory { outputs:Vec<Output>, x11:bool }
static OUTPUTS: std::sync::OnceLock<Inventory> = std::sync::OnceLock::new();
#[derive(Default)] #[derive(Default)]
struct Selection { id:usize, generation:u64, presented:Option<u64>, failed:bool } struct Selection { id:usize, generation:u64, presented:Option<u64>, failed:bool }
impl Selection { impl Selection {
@@ -221,19 +223,77 @@ impl Selection {
fn ready(&self)->bool {self.presented==Some(self.generation)} fn ready(&self)->bool {self.presented==Some(self.generation)}
} }
static SELECTION:std::sync::Mutex<Selection>=std::sync::Mutex::new(Selection {id:0,generation:0,presented:None,failed:false}); static SELECTION:std::sync::Mutex<Selection>=std::sync::Mutex::new(Selection {id:0,generation:0,presented:None,failed:false});
pub fn outputs() -> &'static [Output] { fn inventory() -> &'static Inventory {
OUTPUTS.get_or_init(|| { OUTPUTS.get_or_init(|| {
let backend=crate::desktop_backend::detect().ok();
if backend==Some(crate::desktop_backend::DesktopBackend::X11) && !crate::desktop_backend::headless()
&& std::env::var("UU_X11_MULTISCREEN").ok().as_deref()==Some("1") {
let outputs=x11_outputs();
return Inventory {x11:!outputs.is_empty(),outputs};
}
if !cfg!(all(target_os="linux",feature="wayland")) if !cfg!(all(target_os="linux",feature="wayland"))
|| std::env::var("UU_WAYLAND_MULTISCREEN").ok().as_deref()!=Some("1") || std::env::var("UU_WAYLAND_MULTISCREEN").ok().as_deref()!=Some("1")
|| crate::desktop_backend::detect().ok()!=Some(crate::desktop_backend::DesktopBackend::Wayland) {return Vec::new();} || backend!=Some(crate::desktop_backend::DesktopBackend::Wayland) {return Inventory {outputs:Vec::new(),x11:false};}
let output=std::process::Command::new("hyprctl").args(["monitors","-j"]).output(); let output=std::process::Command::new("hyprctl").args(["monitors","-j"]).output();
let result=output.map_err(|_|"hyprctl unavailable").and_then(|output| { let result=output.map_err(|_|"hyprctl unavailable").and_then(|output| {
if !output.status.success() {return Err("hyprctl failed");} if !output.status.success() {return Err("hyprctl failed");}
parse_outputs(&output.stdout,&std::env::var("UU_WAYLAND_OUTPUT").unwrap_or_default()) parse_outputs(&output.stdout,&std::env::var("UU_WAYLAND_OUTPUT").unwrap_or_default())
}); });
match result {Ok(outputs)=>outputs,Err(reason)=>{log::warn!("Wayland multi-screen disabled: {}",reason);Vec::new()}} let outputs=match result {Ok(outputs)=>outputs,Err(reason)=>{log::warn!("Wayland multi-screen disabled: {}",reason);Vec::new()}};
Inventory {outputs,x11:false}
}) })
} }
pub fn outputs() -> &'static [Output] {&inventory().outputs}
/// X11 monitors are advertised: the stream captures the selected monitor's region of the root.
pub fn x11_multiscreen()->bool {inventory().x11}
/// Read once, like the Hyprland inventory: a changed monitor layout needs a host restart.
fn x11_outputs()->Vec<Output> {
let mut command=std::process::Command::new("xrandr");
if let Some(display)=crate::capture::x11_display().or_else(||std::env::var("DISPLAY").ok()).filter(|d|!d.is_empty()) {
command.arg("--display").arg(display);
}
let result=command.arg("--listmonitors").output().map_err(|_|"xrandr unavailable").and_then(|output| {
if !output.status.success() {return Err("xrandr failed");}
parse_x11_monitors(&String::from_utf8_lossy(&output.stdout),&std::env::var("UU_X11_OUTPUT").unwrap_or_default(),crate::video::display_fps() as i32)
});
match result {
Ok(outputs) if outputs.len()>=2=>{log::info!("X11 multi-screen: {} monitors",outputs.len());outputs},
Ok(_)=>{log::warn!("X11 multi-screen disabled: fewer than two monitors");Vec::new()},
Err(reason)=>{log::warn!("X11 multi-screen disabled: {}",reason);Vec::new()},
}
}
/// `xrandr --listmonitors`: ` 0: +*HDMI-0 1920/527x1080/296+1920+0 HDMI-0` (`*` = primary).
/// The preferred monitor (UU_X11_OUTPUT, else the primary) is id 0; the rest go left to right.
fn parse_x11_monitors(text:&str,preferred:&str,fps:i32)->Result<Vec<Output>,&'static str> {
fn geometry(text:&str)->Option<(u32,u32,i32,i32)> {
let (width,rest)=text.split_once('x')?;
let split=rest.find('+')?;
let (height,offsets)=rest.split_at(split);
let mut offsets=offsets[1..].split('+');
let size=|v:&str|v.split('/').next()?.parse::<u32>().ok();
let (x,y)=(offsets.next()?.parse::<i32>().ok()?,offsets.next()?.parse::<i32>().ok()?);
if offsets.next().is_some() || x<0 || y<0 {return None;}
Some((size(width)?,size(height)?,x,y))
}
let mut seen=std::collections::HashSet::new();
let mut primary=String::new();
let mut outputs=Vec::new();
for line in text.lines().skip(1) {
let mut fields=line.split_whitespace();
let (Some(_),Some(tag),Some(rect))=(fields.next(),fields.next(),fields.next()) else {continue};
let name=tag.trim_start_matches(['+','*']);
let Some((width,height,x,y))=geometry(rect) else {continue};
if name.is_empty() || name.len()>127 || !seen.insert(name.to_owned())
|| width<2 || height<2 || width>16384 || height>16384 || u64::from(width)*u64::from(height)*4>256*1024*1024 {continue;}
if tag.contains('*') {primary=name.to_owned();}
outputs.push(Output {name:name.into(),width,height,fps,x,y});
}
let first=if preferred.is_empty() {primary} else {preferred.to_owned()};
outputs.sort_by_key(|m| (m.name!=first,m.x,m.y));
outputs.truncate(16);
if outputs.is_empty() || (!preferred.is_empty() && outputs[0].name!=preferred) {return Err("No capturable preferred output");}
Ok(outputs)
}
fn parse_outputs(json:&[u8],preferred:&str)->Result<Vec<Output>,&'static str> { fn parse_outputs(json:&[u8],preferred:&str)->Result<Vec<Output>,&'static str> {
let monitors=serde_json::from_slice::<Vec<serde_json::Value>>(json).map_err(|_|"Invalid monitor inventory")?; let monitors=serde_json::from_slice::<Vec<serde_json::Value>>(json).map_err(|_|"Invalid monitor inventory")?;
let mut seen=std::collections::HashSet::new(); let mut seen=std::collections::HashSet::new();
@@ -244,7 +304,7 @@ fn parse_outputs(json:&[u8],preferred:&str)->Result<Vec<Output>,&'static str> {
let height=u32::try_from(m["height"].as_u64()?).ok()?; let height=u32::try_from(m["height"].as_u64()?).ok()?;
if name.is_empty() || name.len()>127 || name.contains('\0') || !seen.insert(name.to_owned()) if name.is_empty() || name.len()>127 || name.contains('\0') || !seen.insert(name.to_owned())
|| width<2 || height<2 || width>16384 || height>16384 || u64::from(width)*u64::from(height)*4>256*1024*1024 {return None;} || width<2 || height<2 || width>16384 || height>16384 || u64::from(width)*u64::from(height)*4>256*1024*1024 {return None;}
Some(Output {name:name.into(),width,height,fps:m["refreshRate"].as_f64()?.round().clamp(1.0,240.0) as i32}) Some(Output {name:name.into(),width,height,fps:m["refreshRate"].as_f64()?.round().clamp(1.0,240.0) as i32,x:0,y:0})
}).collect(); }).collect();
outputs.sort_by_key(|m| (m.name!=preferred,m.name.clone())); outputs.sort_by_key(|m| (m.name!=preferred,m.name.clone()));
outputs.truncate(16); outputs.truncate(16);
@@ -255,6 +315,35 @@ pub fn selection()->(usize,u64) {let s=SELECTION.lock().unwrap();(s.id,s.generat
pub fn selected()->usize {selection().0} pub fn selected()->usize {selection().0}
pub fn source(id:usize)->Option<&'static Output> {outputs().get(id)} pub fn source(id:usize)->Option<&'static Output> {outputs().get(id)}
pub fn input_size(fallback:(u32,u32))->(u32,u32) {source(selected()).map_or(fallback,|s|(s.width,s.height))} pub fn input_size(fallback:(u32,u32))->(u32,u32) {source(selected()).map_or(fallback,|s|(s.width,s.height))}
/// Region the encoder captures for this display: the Wayland output, or the selected X11 monitor.
pub fn capture_source(display:&str,portal:bool,id:usize)->Option<&'static Output> {
if display.starts_with("wayland:") || (!portal && !display.starts_with("kms:") && x11_multiscreen()) {source(id)} else {None}
}
/// Offset of the selected X11 monitor in the root: absolute input is relative to that monitor.
pub fn x11_placement()->Option<(i32,i32)> {
if !x11_multiscreen() {return None;}
source(selected()).map(|s|(s.x,s.y))
}
/// Pixel size of one advertised output. Unknown ids keep `fallback` (connection size).
pub fn source_size(id:usize,fallback:(u32,u32))->(u32,u32) {
#[cfg(test)]
if let Some(outputs)=*test_outputs().lock().unwrap_or_else(|e|e.into_inner()) {
return outputs.get(id).map_or(fallback,|s|(s.width,s.height));
}
source(id).map_or(fallback,|s|(s.width,s.height))
}
#[cfg(test)]
fn test_outputs()->&'static std::sync::Mutex<Option<&'static [Output]>> {
static SLOT:std::sync::OnceLock<std::sync::Mutex<Option<&'static [Output]>>>=std::sync::OnceLock::new();
SLOT.get_or_init(||std::sync::Mutex::new(None))
}
/// Native size written into CaptureSettingSync. Wayland uses the output the encoder is reading
/// (`source_id`), which can differ from the size captured when the connection opened; so does an
/// X11 monitor with UU_X11_MULTISCREEN. Otherwise X11, portal and KMS keep the connection size
/// (X11 mode changes go through `x11_resized`).
pub fn sync_native(display:&str,source_id:usize,connection:(u32,u32))->(u32,u32) {
if display.starts_with("wayland:") || (!display.starts_with("kms:") && x11_multiscreen()) {source_size(source_id,connection)} else {connection}
}
pub fn input_ready()->bool {outputs().is_empty() || SELECTION.lock().unwrap().ready()} pub fn input_ready()->bool {outputs().is_empty() || SELECTION.lock().unwrap().ready()}
pub fn switch_failed()->bool {SELECTION.lock().unwrap().failed} pub fn switch_failed()->bool {SELECTION.lock().unwrap().failed}
pub fn presented(id:usize,generation:u64) {SELECTION.lock().unwrap().sent(id,generation);} pub fn presented(id:usize,generation:u64) {SELECTION.lock().unwrap().sent(id,generation);}
@@ -263,7 +352,12 @@ pub fn failed(id:usize,generation:u64) {
if (state.id,state.generation)==(id,generation) {state.failed=true;} if (state.id,state.generation)==(id,generation) {state.failed=true;}
} }
pub fn select(id:usize)->Result<(),String> { pub fn select(id:usize)->Result<(),String> {
let output=source(id).ok_or("Unknown Wayland screen")?; let output=source(id).ok_or("Unknown screen")?;
if x11_multiscreen() {
SELECTION.lock().unwrap().begin(id);
log::info!("X11 screen selected: id={} source={}x{}+{}+{}",id,output.width,output.height,output.x,output.y);
return Ok(());
}
#[cfg(all(target_os="linux",feature="wayland"))] #[cfg(all(target_os="linux",feature="wayland"))]
{ {
let name=std::ffi::CString::new(output.name.as_str()).map_err(|_|"Invalid output name")?; let name=std::ffi::CString::new(output.name.as_str()).map_err(|_|"Invalid output name")?;
@@ -353,4 +447,37 @@ mod selection_regressions {
assert_eq!(outputs.len(),1);assert_eq!(outputs[0].name,"normal"); assert_eq!(outputs.len(),1);assert_eq!(outputs[0].name,"normal");
assert!(parse_outputs(b"not JSON","").is_err()); assert!(parse_outputs(b"not JSON","").is_err());
} }
#[test]
fn x11_monitors_keep_their_root_offsets() {
// #98: GNOME/X11, two 1920x1080 monitors side by side, primary on the right.
let text="Monitors: 2\n 0: +*HDMI-0 1920/527x1080/296+1920+0 HDMI-0\n 1: +HDMI-1 1920/521x1080/293+0+0 HDMI-1\n";
let outputs=parse_x11_monitors(text,"",60).unwrap();
assert_eq!(outputs.iter().map(|m|(m.name.as_str(),m.width,m.height,m.x,m.y)).collect::<Vec<_>>(),
vec![("HDMI-0",1920,1080,1920,0),("HDMI-1",1920,1080,0,0)]);
let outputs=parse_x11_monitors(text,"HDMI-1",60).unwrap();
assert_eq!((outputs[0].name.as_str(),outputs[1].name.as_str()),("HDMI-1","HDMI-0"));
assert!(parse_x11_monitors(text,"DP-9",60).is_err());
// xrandr --setmonitor virtual monitors (output "none"); no primary: left to right.
let virtual_monitors="Monitors: 3\n 0: +A 1280/338x1024/270+1280+0 none\n 1: +B 1280/338x1024/270+0+0 none\n 2: C 0/0x0/0+0+0 none\n";
let outputs=parse_x11_monitors(virtual_monitors,"",30).unwrap();
assert_eq!(outputs.iter().map(|m|(m.name.as_str(),m.x)).collect::<Vec<_>>(),vec![("B",0),("A",1280)]);
assert!(parse_x11_monitors("Monitors: 1\n 0: +*X 1920/1x1080/1-10+0 X\n","",60).is_err());
assert!(parse_x11_monitors("garbage","",60).is_err());
}
#[test]
fn sync_native_follows_the_wayland_source_id() {
assert_eq!(sync_native(":0",1,(1920,1080)),(1920,1080));
assert_eq!(sync_native("kms:/dev/dri/card0",1,(1920,1080)),(1920,1080));
let inventory:&'static [Output]=Box::leak(vec![
Output {name:"eDP-1".into(),width:1920,height:1080,fps:60,x:0,y:0},
Output {name:"HDMI-A-1".into(),width:2560,height:1440,fps:75,x:0,y:0},
].into_boxed_slice());
*test_outputs().lock().unwrap()=Some(inventory);
// Connection opened on the first output; the encoder is reading the second.
assert_eq!(sync_native("wayland:wayland-0",1,(1920,1080)),(2560,1440));
assert_eq!(source_size(0,(800,600)),(1920,1080));
assert_eq!(sync_native("wayland:wayland-0",9,(800,600)),(800,600));
assert_eq!(sync_native(":0",1,(1920,1080)),(1920,1080));
*test_outputs().lock().unwrap()=None;
}
} }
+482 -194
View File
@@ -42,12 +42,173 @@ pub struct SessionContext {
pub bundle_media: Option<(String, u16)>, pub bundle_media: Option<(String, u16)>,
} }
/// Desktop role of one peer. A tool peer (file transfer, terminal, port mapping) gains it
/// when the viewer opens the desktop on that same connection with SimpleAction 4
/// capture_desktop instead of a new desktop offer (#99).
pub struct DesktopRole {
active: tokio::sync::watch::Sender<bool>,
input: std::sync::Mutex<Option<Arc<crate::input::DesktopInputSession>>>,
stream: std::sync::Mutex<Option<DesktopStream>>,
/// The running stream of a promoted peer; aborted on demotion so a quick re-promotion
/// never leaves two encoders on one track.
stream_task: std::sync::Mutex<Option<tokio::task::AbortHandle>>,
/// Capture reinitialized at promotion; the peer's own capture was unavailable when offered.
screen: std::sync::Mutex<Option<Arc<ScreenCapture>>>,
/// One session tracker per peer follows every promotion and demotion.
tracking: std::sync::atomic::AtomicBool,
request: std::sync::OnceLock<Box<dyn Fn() + Send + Sync>>,
}
impl DesktopRole {
fn new(desktop: bool) -> Self {
Self { active: tokio::sync::watch::channel(desktop).0, input: Default::default(),
stream: Default::default(), stream_task: Default::default(), screen: Default::default(), tracking: Default::default(), request: Default::default() }
}
pub fn is_desktop(&self) -> bool { *self.active.borrow() }
/// A promoted peer whose video ended on its own (capture failed while locked or off, #114);
/// capture_desktop on it starts the video again.
fn stream_ended(&self) -> bool { self.stream_task.lock().unwrap().as_ref().is_some_and(|task| task.is_finished()) }
fn input(&self) -> Option<Arc<crate::input::DesktopInputSession>> { self.input.lock().unwrap().clone() }
fn screen_or(&self, screen: &Arc<ScreenCapture>) -> Arc<ScreenCapture> {
self.screen.lock().unwrap().clone().unwrap_or_else(|| screen.clone())
}
/// Waits until this peer is a desktop; false once the channel closes first.
async fn wait_desktop(&self, channel: &RTCDataChannel) -> bool {
let mut active = self.active.subscribe();
loop {
if *active.borrow_and_update() { return true; }
tokio::select! {
changed = active.changed() => if changed.is_err() { return false; },
_ = tokio::time::sleep(std::time::Duration::from_millis(200)) => {
if matches!(channel.ready_state(), webrtc::data_channel::data_channel_state::RTCDataChannelState::Closing
| webrtc::data_channel::data_channel_state::RTCDataChannelState::Closed) { return false; }
}
}
}
}
}
/// Live desktop video for one peer; a tool peer keeps it unstarted until it becomes a desktop.
#[derive(Clone)]
struct DesktopStream {
pc: std::sync::Weak<RTCPeerConnection>,
track: Arc<crate::video_track::VideoTrack>,
portal_desktop: Option<Arc<crate::desktop_session::PortalDesktop>>,
capture_size: (u32, u32),
capture_display: String,
portal: Option<Arc<crate::portal::PortalSession>>,
settings_rx: tokio::sync::watch::Receiver<crate::capture_setting::VideoSettings>,
settings: Arc<tokio::sync::watch::Sender<crate::capture_setting::VideoSettings>>,
idr_request: Arc<std::sync::atomic::AtomicBool>,
selection: crate::video_select::Selection,
chroma_sync: Option<tokio::sync::mpsc::UnboundedSender<Vec<u8>>>,
reload_at_session: u64,
}
pub struct WebRtcSession { pub struct WebRtcSession {
pub pc: Arc<RTCPeerConnection>, pub pc: Arc<RTCPeerConnection>,
pub capture: Arc<ScreenCapture>, pub capture: Arc<ScreenCapture>,
pub input: Arc<InputInjector>, pub input: Arc<InputInjector>,
/// The role this peer was offered with; `role` also covers a later capture_desktop.
pub desktop: bool, pub desktop: bool,
pub role: Arc<DesktopRole>,
pub controller_mac: bool,
pub context: Arc<Mutex<SessionContext>>, pub context: Arc<Mutex<SessionContext>>,
actions: Arc<crate::system_actions::PeerActions>,
}
/// Counts a desktop session once it is connected (a failed offer is not a session), while the
/// peer is the desktop. Started once per peer, so a quick demote and re-promote cannot end the
/// count of a session that is still streaming.
fn track_session(end_pc: Arc<RTCPeerConnection>, actions: Arc<crate::system_actions::PeerActions>, role: &DesktopRole) {
if role.tracking.swap(true, std::sync::atomic::Ordering::AcqRel) { return; }
let active = role.active.subscribe();
tokio::spawn(async move {
use webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState as State;
loop {
while end_pc.connection_state() != State::Connected || !*active.borrow() {
if matches!(end_pc.connection_state(), State::Closed | State::Failed) { return; }
tokio::time::sleep(std::time::Duration::from_millis(200)).await;
}
let starting = actions.clone();
let _ = tokio::task::spawn_blocking(move || starting.session_started()).await;
while !matches!(end_pc.connection_state(), State::Closed | State::Failed) && *active.borrow() {
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
}
let closed = matches!(end_pc.connection_state(), State::Closed | State::Failed);
let ending = actions.clone();
let _ = tokio::task::spawn_blocking(move || ending.session_ended()).await;
if closed { return; }
}
});
}
type EchoReplay = (Arc<std::sync::atomic::AtomicU64>, Arc<std::sync::atomic::AtomicBool>, Arc<std::sync::atomic::AtomicBool>);
/// A promoted tool peer starts its TEXT clipboard after the viewer's echo was answered without
/// ff_clipboard; declare it again on CONTROL once the bridge is ready, as the Portal path does.
fn replay_clipboard_echo(channel: Arc<RTCDataChannel>, sequence: Arc<std::sync::atomic::AtomicU64>,
(echo_request, echo_seen, clipboard_ready): EchoReplay, role: Arc<DesktopRole>) {
tokio::spawn(async move {
for _ in 0..100 {
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
if !role.is_desktop() || channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open { return; }
if !clipboard_ready.load(std::sync::atomic::Ordering::Acquire) { continue; }
// echo_seen is published after the request seq, so reading it first gives a current seq.
if echo_seen.load(std::sync::atomic::Ordering::Acquire) {
let request_seq = echo_request.load(std::sync::atomic::Ordering::Acquire);
let timestamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
let response = crate::control_protocol::encode_echo_response_with_clipboard(
sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed), timestamp, request_seq, true);
let _ = channel.send(&bytes::Bytes::from(response)).await;
log::info!("CONTROL clipboard capability declared after capture_desktop");
}
return;
}
});
}
impl DesktopStream {
/// Encode current frames only while the peer is connected and still the desktop.
fn spawn(self, screen: Option<Arc<ScreenCapture>>, mut active: tokio::sync::watch::Receiver<bool>) -> Option<tokio::task::AbortHandle> {
let streaming_pc = self.pc.upgrade()?;
let DesktopStream { track: video_track, portal_desktop, capture_size, capture_display, portal,
settings_rx, settings, idr_request, selection, chroma_sync, reload_at_session, .. } = self;
let (capture_size, capture_display, portal) = screen.map_or((capture_size, capture_display, portal),
|screen| ((screen.width, screen.height), screen.display.clone(), screen.portal.clone()));
Some(tokio::spawn(async move { tokio::select! {
_ = active.wait_for(|active| !*active) => log::info!("Live desktop stream stopped: a newer desktop took over"),
_ = async move {
let screen = if let Some(desktop) = portal_desktop {
if let Err(error) = crate::locked_video::run(&streaming_pc, &video_track, &desktop, selection).await {
log::warn!("Locked desktop video unavailable: {error}");
}
let mut updates = desktop.subscribe();
loop {
let state = updates.borrow_and_update().clone();
if state.ready() { break Some(state.screen); }
if !state.waiting { return; }
if crate::video::transport_closed(&streaming_pc) { return; }
tokio::select! {
changed = updates.changed() => if changed.is_err() { return; },
_ = tokio::time::sleep(std::time::Duration::from_millis(100)) => {},
}
}
} else { None };
let (capture_size, capture_display, portal) = screen.as_ref().map_or(
(capture_size, capture_display, portal),
|screen| ((screen.width, screen.height), screen.display.clone(), screen.portal.clone()));
let state_pc = streaming_pc.clone();
if let Err(e) = crate::video::stream_desktop_at(streaming_pc, video_track, capture_size, capture_display, portal, settings_rx, settings, idr_request, selection, chroma_sync, reload_at_session).await {
// A send racing the viewer's close fails with a misleading track error.
if matches!(state_pc.connection_state(), RTCPeerConnectionState::Closed | RTCPeerConnectionState::Failed) {
log::info!("Live desktop stream ended: peer connection closed ({})", e);
} else {
log::error!("Live desktop stream stopped: {}", e);
}
}
} => {},
} }).abort_handle())
}
} }
impl WebRtcSession { impl WebRtcSession {
@@ -63,7 +224,12 @@ impl WebRtcSession {
m.register_default_codecs() m.register_default_codecs()
.map_err(|e| format!("Register standard codecs failed: {}", e))?; .map_err(|e| format!("Register standard codecs failed: {}", e))?;
let hevc = desktop && crate::video::hevc_available().await; // Encoder, codec preference and 4:4:4 stay fixed for this peer (codec is negotiated at CONTROL open).
// Read once before the HEVC probe so a concurrent set-encoder/set-codec cannot split capability from CONTROL.
// reload_at_session is the generation at that snapshot. A probe that finishes later is not a reload.
let reload_at_session = crate::video_select::reload_generation_value();
let video_selection = crate::video_select::selection();
let hevc = desktop && crate::video::hevc_available(video_selection.encoder).await;
if hevc { crate::video_track::register_hevc(&mut m).map_err(|e| format!("Register HEVC failed: {e}"))?; } if hevc { crate::video_track::register_hevc(&mut m).map_err(|e| format!("Register HEVC failed: {e}"))?; }
m.register_header_extension( m.register_header_extension(
@@ -101,7 +267,8 @@ impl WebRtcSession {
.map_err(|e| format!("Create PeerConnection failed: {}", e))?, .map_err(|e| format!("Create PeerConnection failed: {}", e))?,
); );
let input_session=desktop.then(||input.desktop_session()); let role = Arc::new(DesktopRole::new(desktop));
if desktop { *role.input.lock().unwrap() = Some(input.desktop_session()); }
let context = Arc::new(Mutex::new(SessionContext::default())); let context = Arc::new(Mutex::new(SessionContext::default()));
crate::network_diagnostics::start(Arc::downgrade(&pc)); crate::network_diagnostics::start(Arc::downgrade(&pc));
@@ -159,14 +326,16 @@ impl WebRtcSession {
})); }));
let connected_context = context.clone(); let connected_context = context.clone();
let connection_input=input_session.clone(); let connection_role=role.clone();
let connected_signal = signaling_client.clone(); let connected_signal = signaling_client.clone();
let notified = Arc::new(std::sync::atomic::AtomicBool::new(false)); let notified = Arc::new(std::sync::atomic::AtomicBool::new(false));
let connected_selection = video_selection;
pc.on_peer_connection_state_change(Box::new(move |state| { pc.on_peer_connection_state_change(Box::new(move |state| {
let ctx = connected_context.clone(); let ctx = connected_context.clone();
let input=connection_input.clone(); let input=connection_role.input();
let sig = connected_signal.clone(); let sig = connected_signal.clone();
let notified = notified.clone(); let notified = notified.clone();
let video_selection = connected_selection;
Box::pin(async move { Box::pin(async move {
log::info!("PeerConnection State changed: {:?}", state); log::info!("PeerConnection State changed: {:?}", state);
if let Some(session)=input.as_ref() { if let Some(session)=input.as_ref() {
@@ -177,10 +346,10 @@ impl WebRtcSession {
tokio::spawn(async move { tokio::spawn(async move {
let ctx = ctx.lock().await.clone(); let ctx = ctx.lock().await.clone();
if let (Some(client), Some(ice)) = (&ctx.client_id, ctx.ice_id.as_ref().and_then(|v| v.as_str())) { if let (Some(client), Some(ice)) = (&ctx.client_id, ctx.ice_id.as_ref().and_then(|v| v.as_str())) {
let encoder = crate::video::Encoder::requested(); let encoder = video_selection.encoder;
let codec_impl = if encoder == crate::video::Encoder::Nvenc { crate::capability::CODEC_IMPL_NVENC } else { 5 }; let codec_impl = if encoder == crate::video::Encoder::Nvenc { crate::capability::CODEC_IMPL_NVENC } else { 5 };
let payload = crate::capability::device_capability(client, ice, 0, crate::video::display_fps() as i32, codec_impl, let payload = crate::capability::device_capability(client, ice, 0, crate::video::display_fps() as i32, codec_impl,
hevc, crate::video::full_chroma_available()); hevc, crate::video::full_chroma_for(encoder));
if let Err(e) = sig.emit_event(crate::capability::FORWARD_SETTING_EVENT, payload).await { if let Err(e) = sig.emit_event(crate::capability::FORWARD_SETTING_EVENT, payload).await {
log::error!("Device capability notification failed: {}", e); log::error!("Device capability notification failed: {}", e);
} }
@@ -275,67 +444,24 @@ impl WebRtcSession {
let video_settings = Arc::new(video_settings); let video_settings = Arc::new(video_settings);
// Per-connection mute / lock-after-session settings (安全 menu). // Per-connection mute / lock-after-session settings (安全 menu).
let peer_actions = Arc::new(crate::system_actions::PeerActions::default()); let peer_actions = Arc::new(crate::system_actions::PeerActions::default());
let session_actions = peer_actions.clone();
let desktop_sound = desktop && crate::audio::enabled(); let desktop_sound = desktop && crate::audio::enabled();
if desktop && !cfg!(test) { if desktop && !cfg!(test) { track_session(pc.clone(), peer_actions.clone(), &role); }
let (end_pc, actions) = (pc.clone(), peer_actions.clone()); // Live encoder switch (SIGUSR2) sends CaptureSettingSync when chroma is downgraded.
tokio::spawn(async move { let (chroma_sync_tx, chroma_sync_rx) = tokio::sync::mpsc::unbounded_channel::<Vec<u8>>();
{ let chroma_sync_rx = Arc::new(std::sync::Mutex::new((!cfg!(test)).then_some(chroma_sync_rx)));
use webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState as State; // File/terminal/port-mapping connections carry no desktop video until capture_desktop.
// Count the session once it is actually connected (a failed offer is not a session).
while end_pc.connection_state() != State::Connected {
if matches!(end_pc.connection_state(), State::Closed | State::Failed) { return; }
tokio::time::sleep(std::time::Duration::from_millis(200)).await;
}
let starting = actions.clone();
let _ = tokio::task::spawn_blocking(move || starting.session_started()).await;
}
use webrtc::peer_connection::peer_connection_state::RTCPeerConnectionState as State;
while !matches!(end_pc.connection_state(), State::Closed | State::Failed) {
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
}
drop(end_pc);
let _ = tokio::task::spawn_blocking(move || actions.session_ended()).await;
});
}
let portal=capture.portal.clone();
let stream_desktop = portal_desktop.clone();
// File/terminal/port-mapping connections carry no desktop video.
let control_video_track = video_track.clone(); let control_video_track = video_track.clone();
let stream_settings = video_settings.clone(); let stream = DesktopStream {
if desktop && !cfg!(test) { pc: Arc::downgrade(&streaming_pc), track: video_track, portal_desktop: portal_desktop.clone(),
let state_pc = streaming_pc.clone(); capture_size, capture_display, portal: capture.portal.clone(), settings_rx: video_settings_rx,
tokio::spawn(async move { settings: video_settings.clone(), idr_request, selection: video_selection,
let screen = if let Some(desktop) = stream_desktop { chroma_sync: (!cfg!(test)).then_some(chroma_sync_tx), reload_at_session,
if let Err(error) = crate::locked_video::run(&streaming_pc, &video_track, &desktop).await { };
log::warn!("Locked desktop video unavailable: {error}"); drop(streaming_pc);
} if cfg!(test) { drop(stream); }
let mut updates = desktop.subscribe(); else if desktop { let _ = stream.spawn(None, role.active.subscribe()); }
loop { else { *role.stream.lock().unwrap() = Some(stream); }
let state = updates.borrow_and_update().clone();
if state.ready() { break Some(state.screen); }
if !state.waiting { return; }
if crate::video::transport_closed(&streaming_pc) { return; }
tokio::select! {
changed = updates.changed() => if changed.is_err() { return; },
_ = tokio::time::sleep(std::time::Duration::from_millis(100)) => {},
}
}
} else { None };
let (capture_size, capture_display, portal) = screen.as_ref().map_or(
(capture_size, capture_display, portal),
|screen| ((screen.width, screen.height), screen.display.clone(), screen.portal.clone()));
if let Err(e) = crate::video::stream_desktop(streaming_pc, video_track, capture_size, capture_display, portal, video_settings_rx, stream_settings, idr_request).await {
// A send racing the viewer's close fails with a misleading track error.
if matches!(state_pc.connection_state(), RTCPeerConnectionState::Closed | RTCPeerConnectionState::Failed) {
log::info!("Live desktop stream ended: peer connection closed ({})", e);
} else {
log::error!("Live desktop stream stopped: {}", e);
}
}
});
} else {
drop((streaming_pc, video_track, capture_size, capture_display, video_settings_rx));
}
let input_clone = input.clone(); let input_clone = input.clone();
let control_capture = capture.clone(); let control_capture = capture.clone();
let desktop_pc = Arc::downgrade(&pc); let desktop_pc = Arc::downgrade(&pc);
@@ -393,6 +519,7 @@ impl WebRtcSession {
// Settings arrive on CONTROL or TEXT; serialize both queues for this peer. // Settings arrive on CONTROL or TEXT; serialize both queues for this peer.
let settings_serial=Arc::new(Mutex::new(())); let settings_serial=Arc::new(Mutex::new(()));
let data_role = role.clone();
// 监听 DataChannel // 监听 DataChannel
pc.on_data_channel(Box::new(move |d: Arc<RTCDataChannel>| { pc.on_data_channel(Box::new(move |d: Arc<RTCDataChannel>| {
let label = d.label().to_string(); let label = d.label().to_string();
@@ -400,7 +527,7 @@ impl WebRtcSession {
let peer_settings_serial=settings_serial.clone(); let peer_settings_serial=settings_serial.clone();
let input_inst = input_clone.clone(); let input_inst = input_clone.clone();
let channel_input_session=input_session.clone(); let channel_role=data_role.clone();
let screen = control_capture.clone(); let screen = control_capture.clone();
let portal_desktop = portal_desktop.clone(); let portal_desktop = portal_desktop.clone();
let desktop_pc = desktop_pc.clone(); let desktop_pc = desktop_pc.clone();
@@ -414,6 +541,8 @@ impl WebRtcSession {
let peer_video_settings = video_settings.clone(); let peer_video_settings = video_settings.clone();
let peer_video_track = control_video_track.clone(); let peer_video_track = control_video_track.clone();
let peer_actions = peer_actions.clone(); let peer_actions = peer_actions.clone();
let peer_selection = video_selection;
let chroma_sync_rx = chroma_sync_rx.clone();
if label == "FILE_DATA_CHANNEL" { *file_channel.lock().unwrap() = Some(d.clone()); } if label == "FILE_DATA_CHANNEL" { *file_channel.lock().unwrap() = Some(d.clone()); }
Box::pin(async move { Box::pin(async move {
@@ -428,24 +557,54 @@ impl WebRtcSession {
let rich_state=Arc::new(std::sync::Mutex::new(crate::clipboard_rich::State::default())); let rich_state=Arc::new(std::sync::Mutex::new(crate::clipboard_rich::State::default()));
let clipboard_enabled = shared_clipboard_ready.clone(); let clipboard_enabled = shared_clipboard_ready.clone();
if label=="CONTROL_DATA_CHANNEL" { if label=="CONTROL_DATA_CHANNEL" {
let closing=channel_input_session.clone(); let closing=channel_role.clone();
d.on_close(Box::new(move || { d.on_close(Box::new(move || {
let closing=closing.clone(); let closing=closing.input();
Box::pin(async move {if let Some(session)=closing {session.disconnected();}}) Box::pin(async move {if let Some(session)=closing {session.disconnected();}})
})); }));
} }
// Ordered outbound queue for protocol replies produced outside this callback. // Ordered outbound queue for protocol replies produced outside this callback.
let (outbound, mut outbound_rx) = tokio::sync::mpsc::unbounded_channel::<Vec<u8>>(); // webrtc-rs announces the channel before handle_open (ready_state Connecting);
// send() returns ErrClosedPipe until Open. Draining CONTROL here would drop
// Message 25 and every later reply. Start CONTROL from the on_open below
// (one handler; a second on_open replaces it). Receiver taken once.
let mut control_drain: Option<Box<dyn (FnOnce() -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>) + Send + Sync>> = None;
let (outbound, outbound_rx) = tokio::sync::mpsc::unbounded_channel::<Vec<u8>>();
let outbound_rx = Arc::new(tokio::sync::Mutex::new(Some(outbound_rx)));
if label == "CONTROL_DATA_CHANNEL" {
if let Some(mut chroma_sync_rx) = chroma_sync_rx.lock().unwrap().take() {
let sync_out = outbound.clone();
let sync_seq = reply_sequence.clone();
tokio::spawn(async move {
while let Some(payload) = chroma_sync_rx.recv().await {
let timestamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
let seq = sync_seq.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
let _ = sync_out.send(crate::initialization::envelope(seq, timestamp, 25, &payload));
}
});
}
}
{ {
let out_channel = d.clone(); let out_channel = d.clone();
let out_label = label.clone(); let out_label = label.clone();
tokio::spawn(async move { let outbound_rx = outbound_rx.clone();
while let Some(message) = outbound_rx.recv().await { let start_drain = move || {
if let Err(e) = out_channel.send(&bytes::Bytes::from(message)).await { let out_channel = out_channel.clone();
log::warn!("{} send failed: {}", out_label, e); break; let out_label = out_label.clone();
} let outbound_rx = outbound_rx.clone();
} Box::pin(async move {
}); let Some(mut outbound_rx) = take_outbound_once(&outbound_rx).await else { return; };
tokio::spawn(async move {
while let Some(message) = outbound_rx.recv().await {
if let Err(e) = out_channel.send(&bytes::Bytes::from(message)).await {
log::warn!("{} send failed: {}", out_label, e); break;
}
}
});
}) as std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
};
if label != "CONTROL_DATA_CHANNEL" { tokio::spawn(start_drain()); }
else { control_drain = Some(Box::new(start_drain)); }
} }
let (capture_tx, mut capture_rx) = tokio::sync::mpsc::channel::<Vec<u8>>(16); let (capture_tx, mut capture_rx) = tokio::sync::mpsc::channel::<Vec<u8>>(16);
if matches!(label.as_str(),"CONTROL_DATA_CHANNEL"|"TEXT_DATA_CHANNEL") { if matches!(label.as_str(),"CONTROL_DATA_CHANNEL"|"TEXT_DATA_CHANNEL") {
@@ -456,8 +615,9 @@ impl WebRtcSession {
let manager = portal_desktop.clone(); let manager = portal_desktop.clone();
let channel = Arc::downgrade(&d); let channel = Arc::downgrade(&d);
let initial_screen = screen.clone(); let initial_screen = screen.clone();
let switch_owner=channel_input_session.clone(); let capture_role=channel_role.clone();
let settings_serial=peer_settings_serial.clone(); let settings_serial=peer_settings_serial.clone();
let capture_selection = peer_selection;
tokio::spawn(async move { tokio::spawn(async move {
let mut health = tokio::time::interval(std::time::Duration::from_millis(100)); let mut health = tokio::time::interval(std::time::Duration::from_millis(100));
loop { loop {
@@ -473,6 +633,7 @@ impl WebRtcSession {
} }
}; };
let _serial=settings_serial.lock().await; let _serial=settings_serial.lock().await;
let (desktop,switch_owner)=(capture_role.is_desktop(),capture_role.input());
if desktop && switch_owner.as_ref().is_none_or(|owner|!owner.is_current()) {continue;} if desktop && switch_owner.as_ref().is_none_or(|owner|!owner.is_current()) {continue;}
let reject=|reason:&str| { let reject=|reason:&str| {
if let Some(response)=crate::capture_setting::rejected_request(&request,reason) { if let Some(response)=crate::capture_setting::rejected_request(&request,reason) {
@@ -518,10 +679,10 @@ impl WebRtcSession {
if channel.upgrade().is_none_or(|channel| channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open) { return; } if channel.upgrade().is_none_or(|channel| channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open) { return; }
} }
} else { } else {
Some(initial_screen.clone()) Some(capture_role.screen_or(&initial_screen))
} }
} else { } else {
Some(initial_screen.clone()) Some(capture_role.screen_or(&initial_screen))
}; };
let Some(active_screen) = active_screen else { continue; }; let Some(active_screen) = active_screen else { continue; };
let input_size = if active_screen.init_error.is_none() { let input_size = if active_screen.init_error.is_none() {
@@ -560,17 +721,35 @@ impl WebRtcSession {
(21, WireValue::Bytes(rpc)) => Some(*rpc), _ => None, (21, WireValue::Bytes(rpc)) => Some(*rpc), _ => None,
}) else { continue; }; }) else { continue; };
let Ok(rpc_fields) = crate::protocol::decode_wire(rpc) else { continue; }; let Ok(rpc_fields) = crate::protocol::decode_wire(rpc) else { continue; };
// X11: 分辨率 changes the display mode itself, like the official Windows host; the stream
// then carries the new native size instead of a scaled one (desktop_mode). With
// UU_X11_MULTISCREEN the monitor layout stays as it is and the stream is scaled.
let resized = if desktop && active_screen.init_error.is_none() && active_screen.portal.is_none()
&& active_screen.backend == crate::desktop_backend::DesktopBackend::X11 && crate::desktop_mode::enabled()
&& !crate::wayland::x11_multiscreen() {
match crate::capture_setting::requested_resolution(&rpc_fields) {
Some(request) => {
let display = active_screen.display.clone();
tokio::task::spawn_blocking(move || crate::desktop_mode::apply(&display, request)).await.ok().flatten()
.filter(|size| *size != input_size)
},
None => None,
}
} else { None };
let input_size = resized.unwrap_or(input_size);
let before = *settings.borrow(); let before = *settings.borrow();
let output_before = before.output; let output_before = before.output;
let revision = track.revision(); let revision = track.revision();
let apply=|| crate::capture_setting::handle_rpc_with_codecs( let apply=|| crate::capture_setting::handle_rpc_for(
&rpc_fields, &settings, input_size, &rpc_fields, &settings, input_size,
track.supports(crate::capture_setting::VideoCodec::H264), track.supports(crate::capture_setting::VideoCodec::H264),
track.supports(crate::capture_setting::VideoCodec::H265)); track.supports(crate::capture_setting::VideoCodec::H265), capture_selection);
let response=if let Some(owner)=&switch_owner { let response=if let Some(owner)=&switch_owner {
let mut response=None;owner.with_current(||response=apply());response let mut response=None;owner.with_current(||response=apply());response
} else {apply()}; } else {apply()};
let Some(response)=response else {continue;}; let Some(response)=response else {continue;};
// Restart capture even when the encoded settings are unchanged (native size, no scaling).
if resized.is_some() { settings.send_modify(|s| s.source_generation = s.source_generation.wrapping_add(1)); }
let codec_changed = settings.borrow().codec != before.codec; let codec_changed = settings.borrow().codec != before.codec;
if desktop && codec_changed && !track.wait_for_applied(revision, &settings).await { if desktop && codec_changed && !track.wait_for_applied(revision, &settings).await {
log::warn!("Codec switch did not produce a transmitted frame; success reply withheld"); log::warn!("Codec switch did not produce a transmitted frame; success reply withheld");
@@ -581,7 +760,7 @@ impl WebRtcSession {
let next = || sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let next = || sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
let _ = response_tx.send(crate::initialization::envelope(next(), timestamp, 22, &response)); let _ = response_tx.send(crate::initialization::envelope(next(), timestamp, 22, &response));
let current = *settings.borrow(); let current = *settings.borrow();
if current.output != output_before { if current.output != output_before || resized.is_some() {
match crate::capture_setting::screen_sources(next(), timestamp, input_size, current.output, "Linux desktop") { match crate::capture_setting::screen_sources(next(), timestamp, input_size, current.output, "Linux desktop") {
Ok(screens) => { let _ = response_tx.send(screens); } Ok(screens) => { let _ = response_tx.send(screens); }
Err(error) => log::warn!("Screen sources update failed: {}", error), Err(error) => log::warn!("Screen sources update failed: {}", error),
@@ -612,9 +791,12 @@ impl WebRtcSession {
let open_video = channel_video_settings.clone(); let open_video = channel_video_settings.clone();
let open_track = peer_video_track.clone(); let open_track = peer_video_track.clone();
let open_desktop = portal_desktop.clone(); let open_desktop = portal_desktop.clone();
let open_owner = channel_input_session.clone(); let open_owner = channel_role.input();
let open_role = channel_role.clone();
let open_screen = screen.clone(); let open_screen = screen.clone();
let open_selection = peer_selection;
d.on_open(Box::new(move || { d.on_open(Box::new(move || {
if let Some(start_drain) = control_drain { tokio::spawn(start_drain()); }
let init_actions = open_actions.clone(); let init_actions = open_actions.clone();
let init_video = open_video.clone(); let init_video = open_video.clone();
let init_track = open_track.clone(); let init_track = open_track.clone();
@@ -626,82 +808,91 @@ impl WebRtcSession {
let rich_outgoing=rich_outgoing.clone(); let rich_outgoing=rich_outgoing.clone();
let portal_desktop = open_desktop.clone(); let portal_desktop = open_desktop.clone();
let owner = open_owner.clone(); let owner = open_owner.clone();
let role = open_role.clone();
let pc = desktop_pc.upgrade(); let pc = desktop_pc.upgrade();
Box::pin(async move { Box::pin(async move {
// Permission dialogs and first-frame waits must not occupy the // Permission dialogs and first-frame waits must not occupy the
// channel-open callback or delay CONTROL message dispatch. // channel-open callback or delay CONTROL message dispatch.
tokio::spawn(async move { tokio::spawn(async move {
if channel.label() == "TEXT_DATA_CHANNEL" { if channel.label() == "TEXT_DATA_CHANNEL" {
if !desktop { return; } loop {
let screen = if let Some(desktop) = &portal_desktop { if !role.is_desktop() && !role.wait_desktop(&channel).await { return; }
let mut updates = desktop.subscribe(); let screen = if let Some(desktop) = &portal_desktop {
let Some(_) = crate::desktop_session::wait_ready(&mut updates, &channel).await else { return; }; let mut updates = desktop.subscribe();
let mut locked = desktop.lock_state(); let Some(_) = crate::desktop_session::wait_ready(&mut updates, &channel).await else { return; };
loop { let mut locked = desktop.lock_state();
let state = desktop.snapshot(); loop {
if !state.waiting && state.screen.init_error.is_some() { return; } let state = desktop.snapshot();
if let Some(session) = state.screen.portal.as_ref() { if !state.waiting && state.screen.init_error.is_some() { return; }
if session.is_alive() && *locked.borrow() == Some(false) { if let Some(session) = state.screen.portal.as_ref() {
break state.screen; if session.is_alive() && *locked.borrow() == Some(false) {
} break state.screen;
} }
tokio::select! { }
_ = tokio::time::sleep(std::time::Duration::from_millis(100)) => {}, tokio::select! {
changed = locked.changed() => if changed.is_err() { return; }, _ = tokio::time::sleep(std::time::Duration::from_millis(100)) => {},
_ = async { changed = locked.changed() => if changed.is_err() { return; },
loop { _ = async {
if matches!(channel.ready_state(), webrtc::data_channel::data_channel_state::RTCDataChannelState::Closing loop {
| webrtc::data_channel::data_channel_state::RTCDataChannelState::Closed) { return; } if matches!(channel.ready_state(), webrtc::data_channel::data_channel_state::RTCDataChannelState::Closing
tokio::time::sleep(std::time::Duration::from_millis(100)).await; | webrtc::data_channel::data_channel_state::RTCDataChannelState::Closed) { return; }
} tokio::time::sleep(std::time::Duration::from_millis(100)).await;
} => return, }
} } => return,
} }
} else { screen }; }
let bridge = if let Some(session)=screen.portal.clone() { crate::clipboard::start_portal(session) } else { crate::clipboard::start(screen.display.clone()) }; } else { role.screen_or(&screen) };
*clipboard_sink.lock().unwrap() = Some(bridge.incoming); let bridge = if let Some(session)=screen.portal.clone() { crate::clipboard::start_portal(session) } else { crate::clipboard::start(screen.display.clone()) };
let clipboard_channel = channel.clone(); *clipboard_sink.lock().unwrap() = Some(bridge.incoming);
let clipboard_sequence = sequence.clone(); let clipboard_channel = channel.clone();
let clipboard_cleanup = clipboard_sink.clone(); let clipboard_sequence = sequence.clone();
let ready = bridge.ready.await.unwrap_or(false); let clipboard_cleanup = clipboard_sink.clone();
clipboard_ready.store(ready,std::sync::atomic::Ordering::Relaxed); let rich_outgoing = rich_outgoing.clone();
tokio::spawn(async move { let ready = bridge.ready.await.unwrap_or(false);
if !ready { clipboard_ready.store(ready,std::sync::atomic::Ordering::Relaxed);
*clipboard_cleanup.lock().unwrap() = None; {
log::warn!("Native text clipboard unavailable"); return; if !ready {
} *clipboard_cleanup.lock().unwrap() = None;
log::info!("Native text clipboard bridge ready"); log::warn!("Native text clipboard unavailable"); return;
let mut updates = bridge.outgoing; }
let mut health = tokio::time::interval(std::time::Duration::from_millis(200)); log::info!("Native text clipboard bridge ready");
loop { let mut updates = bridge.outgoing;
tokio::select! { let mut health = tokio::time::interval(std::time::Duration::from_millis(200));
_ = health.tick() => { let mut active = role.active.subscribe();
if clipboard_channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open { break; } loop {
}, tokio::select! {
changed = updates.changed() => { _ = health.tick() => {
if changed.is_err() { break; } if clipboard_channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open { break; }
let text = updates.borrow_and_update().clone(); },
let Some(text) = text else { continue; }; _ = async { let _ = active.wait_for(|active| !*active).await; } => break,
{ changed = updates.changed() => {
let request_id=clipboard_sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed); if changed.is_err() { break; }
let payload = match rich_outgoing.lock().unwrap().offer(request_id,text.clone()) { let text = updates.borrow_and_update().clone();
Ok(payload)=>payload,Err(reason)=>{log::warn!("Clipboard offer rejected: {}",reason);continue;} let Some(text) = text else { continue; };
}; {
let timestamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs(); let request_id=clipboard_sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed);
let message = crate::initialization::envelope(clipboard_sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed),timestamp,21,&payload); let payload = match rich_outgoing.lock().unwrap().offer(request_id,text.clone()) {
if !matches!(tokio::time::timeout(std::time::Duration::from_secs(2),clipboard_channel.send(&bytes::Bytes::from(message))).await,Ok(Ok(_))) { Ok(payload)=>payload,Err(reason)=>{log::warn!("Clipboard offer rejected: {}",reason);continue;}
log::warn!("Native clipboard RPC send failed"); break; };
} let timestamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
} let message = crate::initialization::envelope(clipboard_sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed),timestamp,21,&payload);
log::info!("Native clipboard text format offered: bytes={}",text.len()); if !matches!(tokio::time::timeout(std::time::Duration::from_secs(2),clipboard_channel.send(&bytes::Bytes::from(message))).await,Ok(Ok(_))) {
} log::warn!("Native clipboard RPC send failed"); break;
} }
} }
*clipboard_cleanup.lock().unwrap() = None; log::info!("Native clipboard text format offered: bytes={}",text.len());
clipboard_ready.store(false,std::sync::atomic::Ordering::Relaxed); }
}); }
return; }
*clipboard_cleanup.lock().unwrap() = None;
clipboard_ready.store(false,std::sync::atomic::Ordering::Relaxed);
}
if channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open { return; }
// A newer desktop took over this promoted tool peer; capture_desktop restarts the clipboard.
log::info!("Native text clipboard stopped: a newer desktop took over");
}
} }
let replay = (last_echo_request.clone(), echo_seen.clone(), clipboard_ready.clone());
let early_desktop_selection = desktop && portal_desktop.is_some(); let early_desktop_selection = desktop && portal_desktop.is_some();
if early_desktop_selection { if early_desktop_selection {
// Android 4.43.0's unlock presenter requires CaptureChange // Android 4.43.0's unlock presenter requires CaptureChange
@@ -788,58 +979,75 @@ impl WebRtcSession {
} }
} else { snapshot.screen } } else { snapshot.screen }
} else { screen }; } else { screen };
let timestamp = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
let next_seq = || sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed); let next_seq = || sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
// Default file-transfer folder: the desktop user's home directory. // Default file-transfer folder: the desktop user's home directory.
let home = std::env::var("HOME").unwrap_or_else(|_| "/".into()); let home = std::env::var("HOME").unwrap_or_else(|_| "/".into());
// Tool peers are permitted without a desktop; the port-mapping viewer aborts on Reject. let (mut desktop, mut promoted, mut lock_reported) = (desktop, false, desktop);
let desktop_permission=if screen.init_error.is_none() || !desktop { let mut screen = screen;
crate::system_metrics::Permission::Allow loop {
} else { crate::system_metrics::Permission::Reject }; loop {
// Without a desktop (headless/portal before consent) the port-mapping tool still waits let timestamp = std::time::SystemTime::now()
// for ScreenSources/CaptureChange and aborts otherwise: tool peers get a nominal screen. .duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
let screen_size=crate::wayland::input_size(if screen.init_error.is_none() { (screen.width, screen.height) } else { (1920, 1080) }); // Tool peers are permitted without a desktop; the port-mapping viewer aborts on Reject.
let messages = [ let desktop_permission=if screen.init_error.is_none() || !desktop {
(8, crate::initialization::encode_capture_change(next_seq(), timestamp, 0, crate::wayland::selected() as i32, "Linux desktop")), crate::system_metrics::Permission::Allow
(13, Ok(crate::initialization::envelope(next_seq(), timestamp, 13, &init_actions.metrics_payload(desktop_sound, desktop_permission)))), } else { crate::system_metrics::Permission::Reject };
(26, Ok(crate::initialization::envelope(next_seq(), timestamp, 26, // Without a desktop (headless/portal before consent) the port-mapping tool still waits
&crate::system_metrics::remote_download_path(&home)))), // for ScreenSources/CaptureChange and aborts otherwise: tool peers get a nominal screen.
(18, Ok(crate::initialization::envelope(next_seq(), timestamp, 18, let screen_size=crate::wayland::input_size(if screen.init_error.is_none() { (screen.width, screen.height) } else { (1920, 1080) });
&crate::capture_setting::codec_negotiation(screen_size, crate::video::display_fps(), init_track.supports(crate::capture_setting::VideoCodec::H265))))), let messages = [
(7, crate::capture_setting::screen_sources(next_seq(), timestamp, screen_size, init_video.borrow().output, "Linux desktop")), (8, crate::initialization::encode_capture_change(next_seq(), timestamp, 0, crate::wayland::selected() as i32, "Linux desktop")),
]; (13, Ok(crate::initialization::envelope(next_seq(), timestamp, 13, &init_actions.metrics_payload(desktop_sound, desktop_permission)))),
if desktop && screen.init_error.is_none() { (26, Ok(crate::initialization::envelope(next_seq(), timestamp, 26,
let codec = crate::capture_setting::preferred_codec(init_track.supports(crate::capture_setting::VideoCodec::H264), &crate::system_metrics::remote_download_path(&home)))),
init_track.supports(crate::capture_setting::VideoCodec::H265)); (18, Ok(crate::initialization::envelope(next_seq(), timestamp, 18,
init_video.send_if_modified(|current| if current.codec != codec { &crate::capture_setting::codec_negotiation(screen_size, crate::video::display_fps(), init_track.supports(crate::capture_setting::VideoCodec::H265))))),
log::info!("Desktop codec selected: {:?}", codec); current.codec = codec; true } else { false }); (7, crate::capture_setting::screen_sources(next_seq(), timestamp, screen_size, init_video.borrow().output, "Linux desktop")),
} ];
for (field, message) in messages { if desktop && screen.init_error.is_none() {
if early_desktop_selection && field == 8 { continue; } let codec = crate::capture_setting::preferred_codec_for(init_track.supports(crate::capture_setting::VideoCodec::H264),
if (!desktop || screen.init_error.is_some()) && field == 18 { continue; } init_track.supports(crate::capture_setting::VideoCodec::H265), open_selection);
if desktop && screen.init_error.is_some() && matches!(field,7|8) { continue; } init_video.send_if_modified(|current| if current.codec != codec {
let message = match message { log::info!("Desktop codec selected: {:?}", codec); current.codec = codec; true } else { false });
Ok(message) => message,
Err(e) => { log::error!("CONTROL initialization encode failed: {}", e); return; }
};
if let Err(e) = channel.send(&bytes::Bytes::from(message)).await {
log::error!("CONTROL initialization field {} failed: {}", field, e);
return;
} }
log::info!("CONTROL initialization field {} sent", field); for (field, message) in messages {
if early_desktop_selection && field == 8 { continue; }
if promoted && field == 26 { continue; }
if (!desktop || screen.init_error.is_some()) && field == 18 { continue; }
if desktop && screen.init_error.is_some() && matches!(field,7|8) { continue; }
let message = match message {
Ok(message) => message,
Err(e) => { log::error!("CONTROL initialization encode failed: {}", e); return; }
};
if let Err(e) = channel.send(&bytes::Bytes::from(message)).await {
log::error!("CONTROL initialization field {} failed: {}", field, e);
return;
}
log::info!("CONTROL initialization field {} sent", field);
}
if desktop { break; }
// The viewer opened the desktop on this tool connection (#99): repeat the
// desktop initialization once the host has started its video and input.
if !role.wait_desktop(&channel).await { return; }
(desktop, promoted) = (true, true);
screen = role.screen_or(&screen);
replay_clipboard_echo(channel.clone(), sequence.clone(), replay.clone(), role.clone());
}
if !lock_reported {
lock_reported = true;
tokio::spawn(crate::session_lock::report_states(channel.clone(), sequence.clone(), crate::session_lock::watch_locked()));
} }
// Mirror the Linux pointer shape; the video itself carries no pointer. // Mirror the Linux pointer shape; the video itself carries no pointer.
if !desktop { return; }
let mut shapes = crate::cursor::monitor(&screen.display); let mut shapes = crate::cursor::monitor(&screen.display);
let mut health = tokio::time::interval(std::time::Duration::from_millis(200)); let mut health = tokio::time::interval(std::time::Duration::from_millis(200));
let mut sent = 0usize; let mut sent = 0usize;
loop { let mut active = role.active.subscribe();
'cursor: loop {
let current = shapes.borrow_and_update().clone(); let current = shapes.borrow_and_update().clone();
if let Some(cursor) = current { if let Some(cursor) = current {
let timestamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs(); let timestamp = std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
let message = crate::cursor::encode_cursor_shape(next_seq(), timestamp, &cursor); let message = crate::cursor::encode_cursor_shape(next_seq(), timestamp, &cursor);
if channel.send(&bytes::Bytes::from(message)).await.is_err() { break; } if channel.send(&bytes::Bytes::from(message)).await.is_err() { return; }
sent += 1; sent += 1;
if sent <= 3 || sent % 100 == 0 { if sent <= 3 || sent % 100 == 0 {
log::info!("Cursor shape sent: count={} size={}x{} hotspot={},{} png_bytes={}", sent, cursor.width, cursor.height, cursor.hot_x, cursor.hot_y, cursor.png.len()); log::info!("Cursor shape sent: count={} size={}x{} hotspot={},{} png_bytes={}", sent, cursor.width, cursor.height, cursor.hot_x, cursor.hot_y, cursor.png.len());
@@ -848,12 +1056,18 @@ impl WebRtcSession {
loop { loop {
tokio::select! { tokio::select! {
changed = shapes.changed() => { if changed.is_err() { return; } break; }, changed = shapes.changed() => { if changed.is_err() { return; } break; },
_ = active.wait_for(|active| !*active) => break 'cursor,
_ = health.tick() => { _ = health.tick() => {
if channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open { return; } if channel.ready_state() != webrtc::data_channel::data_channel_state::RTCDataChannelState::Open { return; }
}, },
} }
} }
} }
// A newer desktop took over this promoted tool peer; wait for capture_desktop again.
if !role.wait_desktop(&channel).await { return; }
screen = role.screen_or(&screen);
replay_clipboard_echo(channel.clone(), sequence.clone(), replay.clone(), role.clone());
}
}); });
}) })
})); }));
@@ -862,14 +1076,15 @@ impl WebRtcSession {
d.on_message(Box::new(move |msg: DataChannelMessage| { d.on_message(Box::new(move |msg: DataChannelMessage| {
// Keep the whole state: a cached screen waiting for a closed Portal is not ready for input. // Keep the whole state: a cached screen waiting for a closed Portal is not ready for input.
let (screen, desktop_ready) = portal_desktop.as_ref().map_or_else(|| (screen.clone(), true), |desktop| { let (screen, desktop_ready) = portal_desktop.as_ref().map_or_else(|| (channel_role.screen_or(&screen), true), |desktop| {
let state = desktop.snapshot(); let state = desktop.snapshot();
let ready = state.ready(); let ready = state.ready();
(state.screen, ready) (state.screen, ready)
}); });
let channel_name = lbl.clone(); let channel_name = lbl.clone();
let input_worker = inp.clone(); let input_worker = inp.clone();
let message_input_session=channel_input_session.clone(); let message_input_session=channel_role.input();
let message_role=channel_role.clone();
let terminal_worker = terminal_conn.clone(); let terminal_worker = terminal_conn.clone();
let rpc_out = outbound.clone(); let rpc_out = outbound.clone();
let reply_chan = d_reply.clone(); let reply_chan = d_reply.clone();
@@ -889,6 +1104,8 @@ impl WebRtcSession {
Box::pin(async move { Box::pin(async move {
let input_size = crate::wayland::input_size((screen.width, screen.height)); let input_size = crate::wayland::input_size((screen.width, screen.height));
// After a RandR resize the stream restarts capture at the new size; map the pointer to it.
let live_x11 = screen.init_error.is_none() && screen.portal.is_none() && screen.backend == crate::desktop_backend::DesktopBackend::X11;
if let Some(term) = &terminal_worker { if let Some(term) = &terminal_worker {
if crate::terminal::is_frame(&msg.data) { term.handle(&msg.data); return; } if crate::terminal::is_frame(&msg.data) { term.handle(&msg.data); return; }
} }
@@ -1101,6 +1318,19 @@ impl WebRtcSession {
if let Err(e) = chan.send(&bytes::Bytes::from(message)).await { log::warn!("Settings report failed: {}", e); } if let Err(e) = chan.send(&bytes::Bytes::from(message)).await { log::warn!("Settings report failed: {}", e); }
} }
}); });
} else if action == sa::CAPTURE_DESKTOP && channel_name == "CONTROL_DATA_CHANNEL" {
if message_role.is_desktop() && !message_role.stream_ended() {
log::info!("SimpleAction 4 (capture_desktop) received on a desktop connection");
} else if let Some(request) = message_role.request.get() {
if message_role.is_desktop() {
log::info!("SimpleAction 4 (capture_desktop) received on a tool connection whose desktop video ended; restarting it");
} else {
log::info!("SimpleAction 4 (capture_desktop) received on a tool connection; starting the desktop");
}
request();
} else {
log::info!("SimpleAction 4 (capture_desktop) not handled: tool connection without a desktop route");
}
} else if action > 1 && action != 15 { } else if action > 1 && action != 15 {
let args = action_fields.iter().find_map(|f| match (&f.value, f.number) { (WireValue::Bytes(v), 2) => Some(*v), _ => None }).unwrap_or(&[]); let args = action_fields.iter().find_map(|f| match (&f.value, f.number) { (WireValue::Bytes(v), 2) => Some(*v), _ => None }).unwrap_or(&[]);
log::info!("SimpleAction {} ({}) not handled: args={}", action, crate::control_protocol::simple_action_name(action).unwrap_or("?"), sa::args_shape(args)); log::info!("SimpleAction {} ({}) not handled: args={}", action, crate::control_protocol::simple_action_name(action).unwrap_or("?"), sa::args_shape(args));
@@ -1160,7 +1390,7 @@ impl WebRtcSession {
if let Some(session)=message_input_session.as_ref() {session.with_input(|| { if let Some(session)=message_input_session.as_ref() {session.with_input(|| {
if !crate::wayland::input_ready() {return;} if !crate::wayland::input_ready() {return;}
match &event { match &event {
ControlInput::MouseAbsolute {x,y} => input_worker.mouse_absolute_normalized(*x,*y,crate::wayland::input_size(input_size)), ControlInput::MouseAbsolute {x,y} => input_worker.mouse_absolute_normalized(*x,*y,crate::wayland::input_size(if live_x11 {crate::capture::x11_last_size().unwrap_or(input_size)} else {input_size})),
ControlInput::MouseRelative {dx,dy} => input_worker.mouse_relative(*dx,*dy), ControlInput::MouseRelative {dx,dy} => input_worker.mouse_relative(*dx,*dy),
ControlInput::MouseScroll {dx,dy} => input_worker.mouse_scroll(*dx,*dy), ControlInput::MouseScroll {dx,dy} => input_worker.mouse_scroll(*dx,*dy),
ControlInput::Keyboard {key, pressed} => input_worker.windows_key_event(*key, *pressed), ControlInput::Keyboard {key, pressed} => input_worker.windows_key_event(*key, *pressed),
@@ -1223,10 +1453,53 @@ impl WebRtcSession {
capture, capture,
input, input,
desktop, desktop,
role,
controller_mac: false,
context, context,
actions: session_actions,
}) })
} }
/// Route for capture_desktop on this tool peer; the caller decides whether it may become the desktop.
pub fn on_desktop_request(&self, request: impl Fn() + Send + Sync + 'static) {
let _ = self.role.request.set(Box::new(request));
}
/// Makes this tool peer the desktop: it takes the input lease, starts the video it negotiated
/// (H.264; audio was never negotiated) and repeats the desktop CONTROL initialization.
/// `screen` replaces a capture that was unavailable when the peer was offered.
/// A promoted peer whose video ended keeps its input lease and only restarts the video.
pub fn promote(&self, screen: Option<Arc<ScreenCapture>>) {
let restart = self.role.is_desktop();
if restart && !self.role.stream_ended() { return; }
if let Some(screen) = screen { *self.role.screen.lock().unwrap() = Some(screen); }
if !restart {
let session = self.input.desktop_session();
if self.pc.connection_state() == RTCPeerConnectionState::Connected { session.connected(); }
*self.role.input.lock().unwrap() = Some(session);
self.role.active.send_replace(true);
}
let stream = self.role.stream.lock().unwrap().clone();
let task = stream.and_then(|stream| stream.spawn(self.role.screen.lock().unwrap().clone(), self.role.active.subscribe()));
if let Some(old) = std::mem::replace(&mut *self.role.stream_task.lock().unwrap(), task) { old.abort(); }
if restart { log::info!("Desktop video restarted on a tool connection after its stream ended"); return; }
if !cfg!(test) { track_session(self.pc.clone(), self.actions.clone(), &self.role); }
log::info!("Desktop started on an existing tool connection");
}
/// The capture this peer's desktop uses: its own, or the one reinitialized at promotion.
pub fn desktop_capture(&self) -> Arc<ScreenCapture> { self.role.screen_or(&self.capture) }
/// A newer desktop took over a promoted tool peer: stop its video, input and session count,
/// keep the connection's tools. capture_desktop on it promotes it again.
pub fn demote(&self) {
if self.desktop || !self.role.is_desktop() { return; }
self.role.active.send_replace(false);
if let Some(task) = self.role.stream_task.lock().unwrap().take() { task.abort(); }
if let Some(session) = self.role.input.lock().unwrap().take() { session.disconnected(); }
log::info!("Desktop on a tool connection stopped: a newer desktop took over");
}
/// 应用远端 Offer,生成并返回 Answer /// 应用远端 Offer,生成并返回 Answer
pub async fn handle_offer(&self, soac: &SoacMessage) -> Result<String, String> { pub async fn handle_offer(&self, soac: &SoacMessage) -> Result<String, String> {
// 同步当前的客户端与房间会话上下文 // 同步当前的客户端与房间会话上下文
@@ -1395,6 +1668,11 @@ fn negotiated_bundle_media(sdp: &str) -> Option<(String, u16)> {
None None
} }
/// First drain owns the outbound receiver; a later open must not start another.
async fn take_outbound_once<T>(slot: &tokio::sync::Mutex<Option<tokio::sync::mpsc::UnboundedReceiver<T>>>) -> Option<tokio::sync::mpsc::UnboundedReceiver<T>> {
slot.lock().await.take()
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::negotiated_bundle_media; use super::negotiated_bundle_media;
@@ -1417,6 +1695,16 @@ mod tests {
let sdp = "a=group:BUNDLE data video\nm=video 9 RTP 98\na=mid:video\nm=application 9 SCTP 0\na=mid:data\n"; let sdp = "a=group:BUNDLE data video\nm=video 9 RTP 98\na=mid:video\nm=application 9 SCTP 0\na=mid:data\n";
assert_eq!(negotiated_bundle_media(sdp), Some(("data".into(), 1))); assert_eq!(negotiated_bundle_media(sdp), Some(("data".into(), 1)));
} }
#[tokio::test]
async fn outbound_receiver_is_taken_once() {
let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<Vec<u8>>();
let slot = std::sync::Arc::new(tokio::sync::Mutex::new(Some(rx)));
let first = super::take_outbound_once(&slot).await;
let second = super::take_outbound_once(&slot).await;
assert!(first.is_some());
assert!(second.is_none());
drop(tx);
}
} }
#[cfg(test)] #[cfg(test)]
+105
View File
@@ -0,0 +1,105 @@
//! Socket.IO's WebSocket transport uses the same opt-in proxy policy as the REST client.
//! No proxy addresses, room headers, response text or underlying errors are displayed.
use std::time::Duration;
use reqwest::header::{HeaderMap, CONNECTION, UPGRADE, SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_KEY,
SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_PROTOCOL};
use tokio_tungstenite::{WebSocketStream, tungstenite::{handshake::{client::Request, derive_accept_key}, protocol::Role}};
pub type Socket = WebSocketStream<reqwest::Upgraded>;
/// Validate configuration rather than let reqwest silently ignore an unsupported proxy URL.
/// Selection/NO_PROXY matching still belongs to reqwest, not a second proxy implementation.
fn validate_proxy_url(value: &str) -> Result<(), &'static str> {
if value.is_empty() { return Ok(()); }
// Match reqwest's system-proxy parser before URL normalization (which would accept
// whitespace/Unicode that http::Uri rejects and the connector would silently ignore).
let uri: tokio_tungstenite::tungstenite::http::Uri = value.parse().map_err(|_| "Invalid signaling proxy configuration")?;
if uri.authority().is_none() { return Err("Invalid signaling proxy configuration"); }
let url = if value.contains("://") { reqwest::Url::parse(value) }
else { reqwest::Url::parse(&format!("http://{value}")) }
.map_err(|_| "Invalid signaling proxy configuration")?;
if !matches!(url.scheme(), "http" | "https") || url.host_str().is_none()
|| url.port_or_known_default().is_none() || url.path() != "/" || url.query().is_some() || url.fragment().is_some() {
return Err("Unsupported signaling proxy configuration (HTTP/HTTPS only)");
}
Ok(())
}
fn client() -> Result<reqwest::Client, String> {
if crate::auth::proxy_enabled() {
let mut configured = false;
for names in [["HTTP_PROXY", "http_proxy"], ["HTTPS_PROXY", "https_proxy"], ["ALL_PROXY", "all_proxy"]] {
if let Some(value) = names.iter().find_map(std::env::var_os) {
let value = value.to_str().ok_or("Invalid signaling proxy configuration")?;
validate_proxy_url(value)?;
configured |= !value.is_empty();
}
}
// reqwest disables environment proxies in CGI contexts; don't silently ignore an opt-in.
if configured && std::env::var_os("REQUEST_METHOD").is_some() {
return Err("Signaling environment proxies are disabled in CGI contexts".into());
}
}
crate::auth::http_client_builder().http1_only().redirect(reqwest::redirect::Policy::none())
.retry(reqwest::retry::never()).build().map_err(|_| "Signaling HTTP client setup failed".into())
}
pub async fn connect(request: Request, timeout: Duration) -> Result<Socket, String> {
let client = client()?;
match tokio::time::timeout(timeout, connect_with_client(&client, request)).await {
Ok(result) => result,
Err(_) => Err("WS connect failed: timeout".into()),
}
}
async fn connect_with_client(client: &reqwest::Client, request: Request) -> Result<Socket, String> {
let (mut parts, _) = request.into_parts();
if parts.method != reqwest::Method::GET || parts.headers.contains_key(SEC_WEBSOCKET_EXTENSIONS)
|| parts.headers.contains_key(SEC_WEBSOCKET_PROTOCOL) || parts.headers.contains_key("proxy-authorization") {
return Err("Unsupported signaling WebSocket request".into());
}
let mut url = reqwest::Url::parse(&parts.uri.to_string()).map_err(|_| "Invalid signaling endpoint")?;
if !url.username().is_empty() || url.password().is_some() || url.fragment().is_some() {
return Err("Invalid signaling endpoint".into());
}
let scheme = match url.scheme() { "ws" => "http", "wss" => "https", _ => return Err("Unsupported signaling endpoint scheme".into()) };
url.set_scheme(scheme).map_err(|_| "Invalid signaling endpoint")?;
let key = parts.headers.get(SEC_WEBSOCKET_KEY).ok_or("Missing WebSocket handshake key")?;
let accept = derive_accept_key(key.as_bytes());
for name in ["x-nrd-auth", "authorization", "cookie"] {
if let Some(value) = parts.headers.get_mut(name) { value.set_sensitive(true); }
}
// reqwest owns DNS/TCP/proxy CONNECT/TLS. No custom relay, direct fallback or redirect.
let response = client.get(url).version(reqwest::Version::HTTP_11).headers(parts.headers).send().await
.map_err(|e| if e.is_timeout() { "WS connect failed: timeout" } else if e.is_connect() { "WS connect failed: connection" } else { "WS connect failed: request" })?;
if response.status() != reqwest::StatusCode::SWITCHING_PROTOCOLS {
return Err(format!("WS upgrade refused: http_status={}", response.status().as_u16()));
}
verify_upgrade(response.version(), response.headers(), &accept)?;
let stream = response.upgrade().await.map_err(|_| "WS upgrade failed")?;
Ok(WebSocketStream::from_raw_socket(stream, Role::Client, None).await)
}
/// RFC 6455 §4.1: validate before handing upgraded bytes to the frame codec. Socket.IO
/// requests no extensions/subprotocols. Unlike a generic HTTP client we never follow redirects.
fn verify_upgrade(version: reqwest::Version, headers: &HeaderMap, accept: &str) -> Result<(), &'static str> {
let single = |name: reqwest::header::HeaderName| {
let mut values = headers.get_all(name).iter();
let value = values.next()?.to_str().ok()?;
values.next().is_none().then_some(value)
};
let connection_upgrade = headers.get_all(CONNECTION).iter().all(|value| value.to_str().is_ok())
&& headers.get_all(CONNECTION).iter().any(|value|
value.to_str().is_ok_and(|value| value.split(',').any(|token| token.trim().eq_ignore_ascii_case("upgrade"))));
if version != reqwest::Version::HTTP_11 || !connection_upgrade
|| !single(UPGRADE).is_some_and(|v| v.eq_ignore_ascii_case("websocket"))
|| single(SEC_WEBSOCKET_ACCEPT) != Some(accept)
|| headers.contains_key(SEC_WEBSOCKET_EXTENSIONS) || headers.contains_key(SEC_WEBSOCKET_PROTOCOL) {
return Err("Invalid signaling WebSocket upgrade response");
}
Ok(())
}
#[cfg(test)]
#[path = "ws_transport_tests.rs"]
mod tests;
+245
View File
@@ -0,0 +1,245 @@
use super::*;
use futures_util::{SinkExt, StreamExt};
use tokio::{io::{AsyncRead, AsyncReadExt, AsyncWriteExt}, net::{TcpListener, TcpStream}};
use tokio_tungstenite::tungstenite::{client::IntoClientRequest, Message};
fn request(url: &str) -> Request {
let mut request = url.into_client_request().unwrap();
request.headers_mut().insert("x-nrd-auth", "fixture-room-secret".parse().unwrap());
request
}
fn test_client() -> reqwest::ClientBuilder {
reqwest::Client::builder().no_proxy().http1_only()
.redirect(reqwest::redirect::Policy::none()).retry(reqwest::retry::never())
}
async fn read_headers<S: AsyncRead + Unpin>(socket: &mut S) -> String {
let mut bytes = Vec::new();
while !bytes.ends_with(b"\r\n\r\n") {
let mut byte = [0];
socket.read_exact(&mut byte).await.unwrap();
bytes.push(byte[0]);
assert!(bytes.len() < 16384);
}
String::from_utf8(bytes).unwrap()
}
fn header<'a>(request: &'a str, name: &str) -> Option<&'a str> {
request.lines().filter_map(|line| line.split_once(':'))
.find(|(key, _)| key.eq_ignore_ascii_case(name)).map(|(_, value)| value.trim())
}
async fn accept_upgrade(listener: TcpListener, proxy: bool) -> TcpStream {
let (mut socket, _) = listener.accept().await.unwrap();
let received = read_headers(&mut socket).await;
assert!(received.starts_with(if proxy { "GET http://" } else { "GET /" }));
assert!(header(&received, "x-nrd-auth") == Some("fixture-room-secret"));
if !proxy { assert!(header(&received, "proxy-authorization").is_none()); }
let accept = derive_accept_key(header(&received, "sec-websocket-key").unwrap().as_bytes());
let mut response = format!("HTTP/1.1 101 Switching Protocols\r\nConnection: keep-alive, Upgrade\r\nUpgrade: websocket\r\nSec-WebSocket-Accept: {accept}\r\n\r\n").into_bytes();
// The first Engine.IO frame shares a single write with the HTTP response.
response.extend_from_slice(&[0x81, 3, b'0', b'{', b'}']);
socket.write_all(&response).await.unwrap();
socket
}
async fn no_connection(listener: &TcpListener) {
assert!(tokio::time::timeout(Duration::from_millis(150), listener.accept()).await.is_err());
}
#[test]
fn strict_upgrade_validation_accepts_tokens_and_rejects_unsolicited_or_ambiguous_headers() {
let mut headers = HeaderMap::new();
headers.insert(CONNECTION, "keep-alive, Upgrade".parse().unwrap());
headers.insert(UPGRADE, "WebSocket".parse().unwrap());
headers.insert(SEC_WEBSOCKET_ACCEPT, "fixture-accept".parse().unwrap());
assert!(verify_upgrade(reqwest::Version::HTTP_11, &headers, "fixture-accept").is_ok());
headers.append(CONNECTION, "keep-alive".parse().unwrap());
assert!(verify_upgrade(reqwest::Version::HTTP_11, &headers, "fixture-accept").is_ok());
assert!(verify_upgrade(reqwest::Version::HTTP_2, &headers, "fixture-accept").is_err());
assert!(verify_upgrade(reqwest::Version::HTTP_11, &headers, "wrong").is_err());
for name in [CONNECTION, UPGRADE, SEC_WEBSOCKET_ACCEPT] {
let mut missing = headers.clone(); missing.remove(name);
assert!(verify_upgrade(reqwest::Version::HTTP_11, &missing, "fixture-accept").is_err());
}
for name in [UPGRADE, SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_PROTOCOL] {
let mut invalid = headers.clone(); invalid.append(name, "fixture-server-secret".parse().unwrap());
let error = verify_upgrade(reqwest::Version::HTTP_11, &invalid, "fixture-accept").unwrap_err();
assert!(!error.contains("fixture"));
}
}
#[test]
fn proxy_configuration_errors_never_echo_proxy_values() {
for proxy in ["", "127.0.0.1:3128", "http://127.0.0.1:3128", "https://fixture-user:[email protected]:3128"] {
assert!(validate_proxy_url(proxy).is_ok());
}
for proxy in ["socks5://fixture-user:[email protected]:3128", "http://127.0.0.1:3128/?fixture-token", "http://127.0.0.1:3128/#fixture-token", "http://127.0.0.1:3128/fixture-secret", "http://[fixture-invalid", " http://127.0.0.1:3128", "http://127.0.0.1:3128 ", "http://例子.invalid:3128"] {
let error = validate_proxy_url(proxy).unwrap_err();
assert!(!error.contains("fixture"));
assert!(!error.contains("127.0.0.1"));
}
}
#[tokio::test]
async fn upgrade_keeps_prefetched_frame_and_does_not_limit_socket_lifetime() {
let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
let url = format!("ws://{}/socket.io/?fixture-query-secret", listener.local_addr().unwrap());
let server = tokio::spawn(async move {
let socket = accept_upgrade(listener, false).await;
let mut socket = WebSocketStream::from_raw_socket(socket, Role::Server, None).await;
tokio::time::sleep(Duration::from_millis(1200)).await;
assert!(matches!(socket.next().await, Some(Ok(Message::Text(value))) if value == "fixture-client-frame"));
socket.send(Message::Text("fixture-late-frame".into())).await.unwrap();
});
let http = test_client().build().unwrap();
let mut socket = tokio::time::timeout(Duration::from_secs(1), connect_with_client(&http, request(&url))).await.unwrap().unwrap();
assert!(matches!(socket.next().await, Some(Ok(Message::Text(value))) if value == "0{}"));
// A one-second establishment deadline must not remain attached to the upgraded stream.
tokio::time::sleep(Duration::from_millis(1300)).await;
socket.send(Message::Text("fixture-client-frame".into())).await.unwrap();
let message = tokio::time::timeout(Duration::from_secs(3), socket.next()).await.unwrap();
assert!(matches!(message, Some(Ok(Message::Text(value))) if value == "fixture-late-frame"));
server.await.unwrap();
}
#[tokio::test]
async fn proxy_refusal_never_falls_back_to_origin_or_echoes_server_content() {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy_url = format!("http://{}", proxy.local_addr().unwrap());
let server = tokio::spawn(async move {
let (mut socket, _) = proxy.accept().await.unwrap();
let received = read_headers(&mut socket).await;
assert!(received.starts_with("GET http://"));
assert!(header(&received, "proxy-authorization").is_some());
socket.write_all(b"HTTP/1.1 407 Proxy Authentication Required\r\nContent-Length: 19\r\n\r\nfixture-body-secret").await.unwrap();
});
let proxy = reqwest::Proxy::all(proxy_url).unwrap().basic_auth("fixture-user", "fixture-proxy-secret");
let http = test_client().proxy(proxy).build().unwrap();
let result = tokio::time::timeout(Duration::from_secs(5),
connect_with_client(&http, request(&format!("ws://{}/fixture-path-secret", origin.local_addr().unwrap()))))
.await.expect("proxy refusal must not wait on a fallback origin");
let error = result.err().expect("proxy refusal must fail");
assert!(error.contains("407")); assert!(!error.contains("fixture"));
no_connection(&origin).await;
server.await.unwrap();
}
#[tokio::test]
async fn redirects_are_not_followed_with_room_credentials() {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let destination = TcpListener::bind("127.0.0.1:0").await.unwrap();
let url = format!("ws://{}/socket.io/", origin.local_addr().unwrap());
let location = format!("http://{}/fixture-redirect-secret", destination.local_addr().unwrap());
let server = tokio::spawn(async move {
let (mut socket, _) = origin.accept().await.unwrap();
let _ = read_headers(&mut socket).await;
socket.write_all(format!("HTTP/1.1 302 Found\r\nLocation: {location}\r\nContent-Length: 0\r\n\r\n").as_bytes()).await.unwrap();
});
let result = tokio::time::timeout(Duration::from_secs(5),
connect_with_client(&test_client().build().unwrap(), request(&url)))
.await.expect("redirect must not wait on its destination");
let error = result.err().expect("redirect must fail");
assert!(error.contains("302")); assert!(!error.contains("fixture"));
no_connection(&destination).await;
server.await.unwrap();
}
// No global environment mutation: the subprocess has only synthetic loopback configuration.
#[test]
fn environment_policy_probe() {
let Ok(url) = std::env::var("UU_WS_TEST_ENDPOINT") else { return; };
assert!(url.starts_with("ws://127.0.0.1:"));
let runtime = tokio::runtime::Builder::new_current_thread().enable_all().build().unwrap();
runtime.block_on(async {
let mut socket = connect(request(&url), Duration::from_secs(5)).await.expect("fixture connection failed");
let message = tokio::time::timeout(Duration::from_secs(3), socket.next()).await.unwrap();
assert!(matches!(message, Some(Ok(Message::Text(value))) if value == "0{}"));
});
}
#[tokio::test]
async fn environment_proxy_opt_in_and_no_proxy_match_rest_policy() {
for (opt_in, bypass, via_proxy) in [(false, false, false), (true, false, true), (true, true, false)] {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy = TcpListener::bind("127.0.0.1:0").await.unwrap();
let url = format!("ws://{}/socket.io/", origin.local_addr().unwrap());
let proxy_url = format!("http://fixture-user:fixture-proxy-secret@{}", proxy.local_addr().unwrap());
let (selected, unused) = if via_proxy { (proxy, origin) } else { (origin, proxy) };
let server = tokio::spawn(async move { let _socket = accept_upgrade(selected, via_proxy).await; });
let mut child = tokio::process::Command::new(std::env::current_exe().unwrap());
child.args(["--exact", "ws_transport::tests::environment_policy_probe", "--nocapture"])
.env_clear().env("UU_WS_TEST_ENDPOINT", url).env("HTTP_PROXY", proxy_url);
if opt_in { child.env("UU_USE_PROXY", "1"); }
if bypass { child.env("NO_PROXY", "127.0.0.1"); }
let output = tokio::time::timeout(Duration::from_secs(10), child.output()).await.unwrap().unwrap();
assert!(output.status.success(), "isolated proxy-policy subprocess failed");
assert!(!output.stdout.windows(b"fixture-room-secret".len()).any(|s| s == b"fixture-room-secret"));
assert!(!output.stderr.windows(b"fixture-proxy-secret".len()).any(|s| s == b"fixture-proxy-secret"));
no_connection(&unused).await;
server.await.unwrap();
}
}
#[tokio::test]
async fn wss_connect_keeps_origin_auth_inside_tls_and_requires_trusted_certificate() {
use std::sync::Arc;
use tokio_rustls::{rustls, TlsAcceptor};
use rustls::pki_types::{CertificateDer, PrivateKeyDer, PrivatePkcs8KeyDer};
// A fresh test certificate/key, kept only in memory. The mock does not relay anywhere:
// it accepts CONNECT and then speaks TLS + WebSocket on that same loopback socket.
let cert = rcgen::generate_simple_self_signed(vec!["localhost".into()]).unwrap();
let cert_der = cert.serialize_der().unwrap();
let root = reqwest::Certificate::from_der(&cert_der).unwrap();
let config = rustls::ServerConfig::builder_with_provider(Arc::new(rustls::crypto::ring::default_provider()))
.with_safe_default_protocol_versions().unwrap().with_no_client_auth()
.with_single_cert(vec![CertificateDer::from(cert_der)],
PrivateKeyDer::Pkcs8(PrivatePkcs8KeyDer::from(cert.serialize_private_key_der()))).unwrap();
let acceptor = TlsAcceptor::from(Arc::new(config));
for trusted in [false, true] {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy = TcpListener::bind("127.0.0.1:0").await.unwrap();
let port = origin.local_addr().unwrap().port();
let proxy_url = format!("http://{}", proxy.local_addr().unwrap());
let acceptor = acceptor.clone();
let server = tokio::spawn(async move {
let (mut socket, _) = proxy.accept().await.unwrap();
let received = read_headers(&mut socket).await;
assert!(received.starts_with(&format!("CONNECT localhost:{port} HTTP/1.1\r\n")));
assert!(header(&received, "x-nrd-auth").is_none());
assert!(header(&received, "proxy-authorization").is_some());
assert!(!received.contains("fixture-room-secret"));
socket.write_all(b"HTTP/1.1 200 Connection Established\r\n\r\n").await.unwrap();
let tls = acceptor.accept(socket).await;
if !trusted { assert!(tls.is_err()); return; }
let mut tls = tls.expect("fixture TLS handshake failed");
let received = read_headers(&mut tls).await;
assert!(received.starts_with("GET /socket.io/"));
assert!(header(&received, "x-nrd-auth") == Some("fixture-room-secret"));
assert!(header(&received, "proxy-authorization").is_none());
assert!(!received.contains("fixture-proxy-secret"));
let accept = derive_accept_key(header(&received, "sec-websocket-key").unwrap().as_bytes());
let mut response = format!("HTTP/1.1 101 Switching Protocols\r\nConnection: Upgrade\r\nUpgrade: websocket\r\nSec-WebSocket-Accept: {accept}\r\n\r\n").into_bytes();
response.extend_from_slice(&[0x81, 3, b'0', b'{', b'}']);
tls.write_all(&response).await.unwrap();
});
let proxy = reqwest::Proxy::all(proxy_url).unwrap().basic_auth("fixture-user", "fixture-proxy-secret");
let mut builder = test_client().proxy(proxy);
if trusted { builder = builder.add_root_certificate(root.clone()); }
let client = builder.build().unwrap();
let result = tokio::time::timeout(Duration::from_secs(5),
connect_with_client(&client, request(&format!("wss://localhost:{port}/socket.io/?fixture-query-secret")))).await.unwrap();
if trusted {
let mut socket = result.expect("trusted fixture WebSocket failed");
let message = tokio::time::timeout(Duration::from_secs(3), socket.next()).await.unwrap();
assert!(matches!(message, Some(Ok(Message::Text(value))) if value == "0{}"));
} else {
let error = result.err().expect("untrusted fixture certificate must fail");
assert!(!error.contains("fixture")); assert!(!error.contains("localhost"));
}
no_connection(&origin).await;
tokio::time::timeout(Duration::from_secs(5), server).await.unwrap().unwrap();
}
}
+4
View File
@@ -0,0 +1,4 @@
`ffnvcodec/dynlink_cuda.h` and `ffnvcodec/nvEncodeAPI.h` are unmodified copies from
[nv-codec-headers](https://github.com/FFmpeg/nv-codec-headers) tag `n12.1.14.0`
(NVENC API 12.1, the version FFmpeg 6.1 builds against; NVIDIA Linux driver 530.41 or newer).
MIT licensed, see the header comments. Only the in-process NVENC engine (`--features inproc-av`) uses them.
+518
View File
@@ -0,0 +1,518 @@
/*
* This copyright notice applies to this header file only:
*
* Copyright (c) 2016
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the software, and to permit persons to whom the
* software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#if !defined(FFNV_DYNLINK_CUDA_H) && !defined(CUDA_VERSION)
#define FFNV_DYNLINK_CUDA_H
#include <stddef.h>
#include <stdint.h>
#define CUDA_VERSION 7050
#if defined(_WIN32) || defined(__CYGWIN__)
#define CUDAAPI __stdcall
#else
#define CUDAAPI
#endif
#define CU_CTX_SCHED_BLOCKING_SYNC 4
typedef int CUdevice;
#if defined(__x86_64) || defined(AMD64) || defined(_M_AMD64) || defined(__LP64__) || defined(__aarch64__)
typedef unsigned long long CUdeviceptr;
#else
typedef unsigned int CUdeviceptr;
#endif
typedef unsigned long long CUtexObject;
typedef struct CUarray_st *CUarray;
typedef struct CUctx_st *CUcontext;
typedef struct CUstream_st *CUstream;
typedef struct CUevent_st *CUevent;
typedef struct CUfunc_st *CUfunction;
typedef struct CUmod_st *CUmodule;
typedef struct CUmipmappedArray_st *CUmipmappedArray;
typedef struct CUgraphicsResource_st *CUgraphicsResource;
typedef struct CUextMemory_st *CUexternalMemory;
typedef struct CUextSemaphore_st *CUexternalSemaphore;
typedef struct CUeglStreamConnection_st *CUeglStreamConnection;
typedef struct CUlinkState_st *CUlinkState;
typedef enum cudaError_enum {
CUDA_SUCCESS = 0,
CUDA_ERROR_NOT_READY = 600,
CUDA_ERROR_LAUNCH_TIMEOUT = 702,
CUDA_ERROR_UNKNOWN = 999
} CUresult;
/**
* Device properties (subset)
*/
typedef enum CUdevice_attribute_enum {
CU_DEVICE_ATTRIBUTE_CLOCK_RATE = 13,
CU_DEVICE_ATTRIBUTE_TEXTURE_ALIGNMENT = 14,
CU_DEVICE_ATTRIBUTE_MULTIPROCESSOR_COUNT = 16,
CU_DEVICE_ATTRIBUTE_INTEGRATED = 18,
CU_DEVICE_ATTRIBUTE_CAN_MAP_HOST_MEMORY = 19,
CU_DEVICE_ATTRIBUTE_COMPUTE_MODE = 20,
CU_DEVICE_ATTRIBUTE_CONCURRENT_KERNELS = 31,
CU_DEVICE_ATTRIBUTE_PCI_BUS_ID = 33,
CU_DEVICE_ATTRIBUTE_PCI_DEVICE_ID = 34,
CU_DEVICE_ATTRIBUTE_TCC_DRIVER = 35,
CU_DEVICE_ATTRIBUTE_MEMORY_CLOCK_RATE = 36,
CU_DEVICE_ATTRIBUTE_GLOBAL_MEMORY_BUS_WIDTH = 37,
CU_DEVICE_ATTRIBUTE_ASYNC_ENGINE_COUNT = 40,
CU_DEVICE_ATTRIBUTE_UNIFIED_ADDRESSING = 41,
CU_DEVICE_ATTRIBUTE_PCI_DOMAIN_ID = 50,
CU_DEVICE_ATTRIBUTE_TEXTURE_PITCH_ALIGNMENT = 51,
CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MAJOR = 75,
CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MINOR = 76,
CU_DEVICE_ATTRIBUTE_MANAGED_MEMORY = 83,
CU_DEVICE_ATTRIBUTE_MULTI_GPU_BOARD = 84,
CU_DEVICE_ATTRIBUTE_MULTI_GPU_BOARD_GROUP_ID = 85,
} CUdevice_attribute;
typedef enum CUarray_format_enum {
CU_AD_FORMAT_UNSIGNED_INT8 = 0x01,
CU_AD_FORMAT_UNSIGNED_INT16 = 0x02,
CU_AD_FORMAT_UNSIGNED_INT32 = 0x03,
CU_AD_FORMAT_SIGNED_INT8 = 0x08,
CU_AD_FORMAT_SIGNED_INT16 = 0x09,
CU_AD_FORMAT_SIGNED_INT32 = 0x0a,
CU_AD_FORMAT_HALF = 0x10,
CU_AD_FORMAT_FLOAT = 0x20
} CUarray_format;
typedef enum CUmemorytype_enum {
CU_MEMORYTYPE_HOST = 1,
CU_MEMORYTYPE_DEVICE = 2,
CU_MEMORYTYPE_ARRAY = 3
} CUmemorytype;
typedef enum CUlimit_enum {
CU_LIMIT_STACK_SIZE = 0,
CU_LIMIT_PRINTF_FIFO_SIZE = 1,
CU_LIMIT_MALLOC_HEAP_SIZE = 2,
CU_LIMIT_DEV_RUNTIME_SYNC_DEPTH = 3,
CU_LIMIT_DEV_RUNTIME_PENDING_LAUNCH_COUNT = 4
} CUlimit;
typedef enum CUresourcetype_enum {
CU_RESOURCE_TYPE_ARRAY = 0x00,
CU_RESOURCE_TYPE_MIPMAPPED_ARRAY = 0x01,
CU_RESOURCE_TYPE_LINEAR = 0x02,
CU_RESOURCE_TYPE_PITCH2D = 0x03
} CUresourcetype;
typedef enum CUaddress_mode_enum {
CU_TR_ADDRESS_MODE_WRAP = 0,
CU_TR_ADDRESS_MODE_CLAMP = 1,
CU_TR_ADDRESS_MODE_MIRROR = 2,
CU_TR_ADDRESS_MODE_BORDER = 3
} CUaddress_mode;
typedef enum CUfilter_mode_enum {
CU_TR_FILTER_MODE_POINT = 0,
CU_TR_FILTER_MODE_LINEAR = 1
} CUfilter_mode;
typedef enum CUgraphicsRegisterFlags_enum {
CU_GRAPHICS_REGISTER_FLAGS_NONE = 0,
CU_GRAPHICS_REGISTER_FLAGS_READ_ONLY = 1,
CU_GRAPHICS_REGISTER_FLAGS_WRITE_DISCARD = 2,
CU_GRAPHICS_REGISTER_FLAGS_SURFACE_LDST = 4,
CU_GRAPHICS_REGISTER_FLAGS_TEXTURE_GATHER = 8
} CUgraphicsRegisterFlags;
typedef enum CUexternalMemoryHandleType_enum {
CU_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD = 1,
CU_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32 = 2,
CU_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT = 3,
CU_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP = 4,
CU_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE = 5,
} CUexternalMemoryHandleType;
typedef enum CUexternalSemaphoreHandleType_enum {
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD = 1,
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32 = 2,
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT = 3,
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE = 4,
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_TIMELINE_SEMAPHORE_FD = 9,
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_TIMELINE_SEMAPHORE_WIN32 = 10,
} CUexternalSemaphoreHandleType;
typedef enum CUjit_option_enum
{
CU_JIT_MAX_REGISTERS = 0,
CU_JIT_THREADS_PER_BLOCK = 1,
CU_JIT_WALL_TIME = 2,
CU_JIT_INFO_LOG_BUFFER = 3,
CU_JIT_INFO_LOG_BUFFER_SIZE_BYTES = 4,
CU_JIT_ERROR_LOG_BUFFER = 5,
CU_JIT_ERROR_LOG_BUFFER_SIZE_BYTES = 6,
CU_JIT_OPTIMIZATION_LEVEL = 7,
CU_JIT_TARGET_FROM_CUCONTEXT = 8,
CU_JIT_TARGET = 9,
CU_JIT_FALLBACK_STRATEGY = 10,
CU_JIT_GENERATE_DEBUG_INFO = 11,
CU_JIT_LOG_VERBOSE = 12,
CU_JIT_GENERATE_LINE_INFO = 13,
CU_JIT_CACHE_MODE = 14,
CU_JIT_NEW_SM3X_OPT = 15,
CU_JIT_FAST_COMPILE = 16,
CU_JIT_GLOBAL_SYMBOL_NAMES = 17,
CU_JIT_GLOBAL_SYMBOL_ADDRESSES = 18,
CU_JIT_GLOBAL_SYMBOL_COUNT = 19,
CU_JIT_NUM_OPTIONS
} CUjit_option;
typedef enum CUjitInputType_enum
{
CU_JIT_INPUT_CUBIN = 0,
CU_JIT_INPUT_PTX = 1,
CU_JIT_INPUT_FATBINARY = 2,
CU_JIT_INPUT_OBJECT = 3,
CU_JIT_INPUT_LIBRARY = 4,
CU_JIT_NUM_INPUT_TYPES
} CUjitInputType;
typedef enum CUeglFrameType
{
CU_EGL_FRAME_TYPE_ARRAY = 0,
CU_EGL_FRAME_TYPE_PITCH = 1,
} CUeglFrameType;
typedef enum CUeglColorFormat
{
CU_EGL_COLOR_FORMAT_YUV420_PLANAR = 0x00,
CU_EGL_COLOR_FORMAT_YUV420_SEMIPLANAR = 0x01,
CU_EGL_COLOR_FORMAT_YVU420_SEMIPLANAR = 0x15,
CU_EGL_COLOR_FORMAT_Y10V10U10_420_SEMIPLANAR = 0x17,
CU_EGL_COLOR_FORMAT_Y12V12U12_420_SEMIPLANAR = 0x19,
} CUeglColorFormat;
typedef enum CUd3d11DeviceList_enum
{
CU_D3D11_DEVICE_LIST_ALL = 1,
CU_D3D11_DEVICE_LIST_CURRENT_FRAME = 2,
CU_D3D11_DEVICE_LIST_NEXT_FRAME = 3,
} CUd3d11DeviceList;
#ifndef CU_UUID_HAS_BEEN_DEFINED
#define CU_UUID_HAS_BEEN_DEFINED
typedef struct CUuuid_st {
char bytes[16];
} CUuuid;
#endif
typedef struct CUDA_MEMCPY2D_st {
size_t srcXInBytes;
size_t srcY;
CUmemorytype srcMemoryType;
const void *srcHost;
CUdeviceptr srcDevice;
CUarray srcArray;
size_t srcPitch;
size_t dstXInBytes;
size_t dstY;
CUmemorytype dstMemoryType;
void *dstHost;
CUdeviceptr dstDevice;
CUarray dstArray;
size_t dstPitch;
size_t WidthInBytes;
size_t Height;
} CUDA_MEMCPY2D;
typedef struct CUDA_RESOURCE_DESC_st {
CUresourcetype resType;
union {
struct {
CUarray hArray;
} array;
struct {
CUmipmappedArray hMipmappedArray;
} mipmap;
struct {
CUdeviceptr devPtr;
CUarray_format format;
unsigned int numChannels;
size_t sizeInBytes;
} linear;
struct {
CUdeviceptr devPtr;
CUarray_format format;
unsigned int numChannels;
size_t width;
size_t height;
size_t pitchInBytes;
} pitch2D;
struct {
int reserved[32];
} reserved;
} res;
unsigned int flags;
} CUDA_RESOURCE_DESC;
typedef struct CUDA_TEXTURE_DESC_st {
CUaddress_mode addressMode[3];
CUfilter_mode filterMode;
unsigned int flags;
unsigned int maxAnisotropy;
CUfilter_mode mipmapFilterMode;
float mipmapLevelBias;
float minMipmapLevelClamp;
float maxMipmapLevelClamp;
float borderColor[4];
int reserved[12];
} CUDA_TEXTURE_DESC;
/* Unused type */
typedef struct CUDA_RESOURCE_VIEW_DESC_st CUDA_RESOURCE_VIEW_DESC;
typedef unsigned int GLenum;
typedef unsigned int GLuint;
/*
* Prefix type name to avoid collisions. Clients using these types
* will include the real headers with real definitions.
*/
typedef int32_t ffnv_EGLint;
typedef void *ffnv_EGLStreamKHR;
typedef enum CUGLDeviceList_enum {
CU_GL_DEVICE_LIST_ALL = 1,
CU_GL_DEVICE_LIST_CURRENT_FRAME = 2,
CU_GL_DEVICE_LIST_NEXT_FRAME = 3,
} CUGLDeviceList;
typedef struct CUDA_EXTERNAL_MEMORY_HANDLE_DESC_st {
CUexternalMemoryHandleType type;
union {
int fd;
struct {
void *handle;
const void *name;
} win32;
} handle;
unsigned long long size;
unsigned int flags;
unsigned int reserved[16];
} CUDA_EXTERNAL_MEMORY_HANDLE_DESC;
typedef struct CUDA_EXTERNAL_MEMORY_BUFFER_DESC_st {
unsigned long long offset;
unsigned long long size;
unsigned int flags;
unsigned int reserved[16];
} CUDA_EXTERNAL_MEMORY_BUFFER_DESC;
typedef struct CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC_st {
CUexternalSemaphoreHandleType type;
union {
int fd;
struct {
void *handle;
const void *name;
} win32;
} handle;
unsigned int flags;
unsigned int reserved[16];
} CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC;
typedef struct CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS_st {
struct {
struct {
unsigned long long value;
} fence;
unsigned int reserved[16];
} params;
unsigned int flags;
unsigned int reserved[16];
} CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS;
typedef CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS CUDA_EXTERNAL_SEMAPHORE_WAIT_PARAMS;
typedef struct CUDA_ARRAY_DESCRIPTOR_st {
size_t Width;
size_t Height;
CUarray_format Format;
unsigned int NumChannels;
} CUDA_ARRAY_DESCRIPTOR;
typedef struct CUDA_ARRAY3D_DESCRIPTOR_st {
size_t Width;
size_t Height;
size_t Depth;
CUarray_format Format;
unsigned int NumChannels;
unsigned int Flags;
} CUDA_ARRAY3D_DESCRIPTOR;
typedef struct CUDA_EXTERNAL_MEMORY_MIPMAPPED_ARRAY_DESC_st {
unsigned long long offset;
CUDA_ARRAY3D_DESCRIPTOR arrayDesc;
unsigned int numLevels;
unsigned int reserved[16];
} CUDA_EXTERNAL_MEMORY_MIPMAPPED_ARRAY_DESC;
#define CU_EGL_FRAME_MAX_PLANES 3
typedef struct CUeglFrame_st {
union {
CUarray pArray[CU_EGL_FRAME_MAX_PLANES];
void* pPitch[CU_EGL_FRAME_MAX_PLANES];
} frame;
unsigned int width;
unsigned int height;
unsigned int depth;
unsigned int pitch;
unsigned int planeCount;
unsigned int numChannels;
CUeglFrameType frameType;
CUeglColorFormat eglColorFormat;
CUarray_format cuFormat;
} CUeglFrame;
#define CU_STREAM_DEFAULT 0
#define CU_STREAM_NON_BLOCKING 1
#define CU_EVENT_DEFAULT 0
#define CU_EVENT_BLOCKING_SYNC 1
#define CU_EVENT_DISABLE_TIMING 2
#define CU_EVENT_WAIT_DEFAULT 0
#define CU_EVENT_WAIT_EXTERNAL 1
#define CU_TRSF_READ_AS_INTEGER 1
typedef void CUDAAPI CUstreamCallback(CUstream hStream, CUresult status, void *userdata);
typedef CUresult CUDAAPI tcuInit(unsigned int Flags);
typedef CUresult CUDAAPI tcuDriverGetVersion(int *driverVersion);
typedef CUresult CUDAAPI tcuDeviceGetCount(int *count);
typedef CUresult CUDAAPI tcuDeviceGet(CUdevice *device, int ordinal);
typedef CUresult CUDAAPI tcuDeviceGetAttribute(int *pi, CUdevice_attribute attrib, CUdevice dev);
typedef CUresult CUDAAPI tcuDeviceGetName(char *name, int len, CUdevice dev);
typedef CUresult CUDAAPI tcuDeviceGetUuid(CUuuid *uuid, CUdevice dev);
typedef CUresult CUDAAPI tcuDeviceGetUuid_v2(CUuuid *uuid, CUdevice dev);
typedef CUresult CUDAAPI tcuDeviceGetLuid(char* luid, unsigned int* deviceNodeMask, CUdevice dev);
typedef CUresult CUDAAPI tcuDeviceGetByPCIBusId(CUdevice* dev, const char* pciBusId);
typedef CUresult CUDAAPI tcuDeviceGetPCIBusId(char* pciBusId, int len, CUdevice dev);
typedef CUresult CUDAAPI tcuDeviceComputeCapability(int *major, int *minor, CUdevice dev);
typedef CUresult CUDAAPI tcuCtxCreate_v2(CUcontext *pctx, unsigned int flags, CUdevice dev);
typedef CUresult CUDAAPI tcuCtxGetCurrent(CUcontext *pctx);
typedef CUresult CUDAAPI tcuCtxSetLimit(CUlimit limit, size_t value);
typedef CUresult CUDAAPI tcuCtxPushCurrent_v2(CUcontext pctx);
typedef CUresult CUDAAPI tcuCtxPopCurrent_v2(CUcontext *pctx);
typedef CUresult CUDAAPI tcuCtxDestroy_v2(CUcontext ctx);
typedef CUresult CUDAAPI tcuMemAlloc_v2(CUdeviceptr *dptr, size_t bytesize);
typedef CUresult CUDAAPI tcuMemAllocPitch_v2(CUdeviceptr *dptr, size_t *pPitch, size_t WidthInBytes, size_t Height, unsigned int ElementSizeBytes);
typedef CUresult CUDAAPI tcuMemAllocManaged(CUdeviceptr *dptr, size_t bytesize, unsigned int flags);
typedef CUresult CUDAAPI tcuMemsetD8Async(CUdeviceptr dstDevice, unsigned char uc, size_t N, CUstream hStream);
typedef CUresult CUDAAPI tcuMemFree_v2(CUdeviceptr dptr);
typedef CUresult CUDAAPI tcuMemcpy(CUdeviceptr dst, CUdeviceptr src, size_t bytesize);
typedef CUresult CUDAAPI tcuMemcpyAsync(CUdeviceptr dst, CUdeviceptr src, size_t bytesize, CUstream hStream);
typedef CUresult CUDAAPI tcuMemcpy2D_v2(const CUDA_MEMCPY2D *pcopy);
typedef CUresult CUDAAPI tcuMemcpy2DAsync_v2(const CUDA_MEMCPY2D *pcopy, CUstream hStream);
typedef CUresult CUDAAPI tcuMemcpyHtoD_v2(CUdeviceptr dstDevice, const void *srcHost, size_t ByteCount);
typedef CUresult CUDAAPI tcuMemcpyHtoDAsync_v2(CUdeviceptr dstDevice, const void *srcHost, size_t ByteCount, CUstream hStream);
typedef CUresult CUDAAPI tcuMemcpyDtoH_v2(void *dstHost, CUdeviceptr srcDevice, size_t ByteCount);
typedef CUresult CUDAAPI tcuMemcpyDtoHAsync_v2(void *dstHost, CUdeviceptr srcDevice, size_t ByteCount, CUstream hStream);
typedef CUresult CUDAAPI tcuMemcpyDtoD_v2(CUdeviceptr dstDevice, CUdeviceptr srcDevice, size_t ByteCount);
typedef CUresult CUDAAPI tcuMemcpyDtoDAsync_v2(CUdeviceptr dstDevice, CUdeviceptr srcDevice, size_t ByteCount, CUstream hStream);
typedef CUresult CUDAAPI tcuGetErrorName(CUresult error, const char** pstr);
typedef CUresult CUDAAPI tcuGetErrorString(CUresult error, const char** pstr);
typedef CUresult CUDAAPI tcuCtxGetDevice(CUdevice *device);
typedef CUresult CUDAAPI tcuDevicePrimaryCtxRetain(CUcontext *pctx, CUdevice dev);
typedef CUresult CUDAAPI tcuDevicePrimaryCtxRelease(CUdevice dev);
typedef CUresult CUDAAPI tcuDevicePrimaryCtxSetFlags(CUdevice dev, unsigned int flags);
typedef CUresult CUDAAPI tcuDevicePrimaryCtxGetState(CUdevice dev, unsigned int *flags, int *active);
typedef CUresult CUDAAPI tcuDevicePrimaryCtxReset(CUdevice dev);
typedef CUresult CUDAAPI tcuStreamCreate(CUstream *phStream, unsigned int flags);
typedef CUresult CUDAAPI tcuStreamQuery(CUstream hStream);
typedef CUresult CUDAAPI tcuStreamSynchronize(CUstream hStream);
typedef CUresult CUDAAPI tcuStreamDestroy_v2(CUstream hStream);
typedef CUresult CUDAAPI tcuStreamAddCallback(CUstream hStream, CUstreamCallback *callback, void *userdata, unsigned int flags);
typedef CUresult CUDAAPI tcuStreamWaitEvent(CUstream hStream, CUevent hEvent, unsigned int flags);
typedef CUresult CUDAAPI tcuEventCreate(CUevent *phEvent, unsigned int flags);
typedef CUresult CUDAAPI tcuEventDestroy_v2(CUevent hEvent);
typedef CUresult CUDAAPI tcuEventSynchronize(CUevent hEvent);
typedef CUresult CUDAAPI tcuEventQuery(CUevent hEvent);
typedef CUresult CUDAAPI tcuEventRecord(CUevent hEvent, CUstream hStream);
typedef CUresult CUDAAPI tcuLaunchKernel(CUfunction f, unsigned int gridDimX, unsigned int gridDimY, unsigned int gridDimZ, unsigned int blockDimX, unsigned int blockDimY, unsigned int blockDimZ, unsigned int sharedMemBytes, CUstream hStream, void** kernelParams, void** extra);
typedef CUresult CUDAAPI tcuLinkCreate(unsigned int numOptions, CUjit_option* options, void** optionValues, CUlinkState* stateOut);
typedef CUresult CUDAAPI tcuLinkAddData(CUlinkState state, CUjitInputType type, void* data, size_t size, const char* name, unsigned int numOptions, CUjit_option* options, void** optionValues);
typedef CUresult CUDAAPI tcuLinkComplete(CUlinkState state, void** cubinOut, size_t* sizeOut);
typedef CUresult CUDAAPI tcuLinkDestroy(CUlinkState state);
typedef CUresult CUDAAPI tcuModuleLoadData(CUmodule* module, const void* image);
typedef CUresult CUDAAPI tcuModuleUnload(CUmodule hmod);
typedef CUresult CUDAAPI tcuModuleGetFunction(CUfunction* hfunc, CUmodule hmod, const char* name);
typedef CUresult CUDAAPI tcuModuleGetGlobal(CUdeviceptr *dptr, size_t *bytes, CUmodule hmod, const char* name);
typedef CUresult CUDAAPI tcuTexObjectCreate(CUtexObject* pTexObject, const CUDA_RESOURCE_DESC* pResDesc, const CUDA_TEXTURE_DESC* pTexDesc, const CUDA_RESOURCE_VIEW_DESC* pResViewDesc);
typedef CUresult CUDAAPI tcuTexObjectDestroy(CUtexObject texObject);
typedef CUresult CUDAAPI tcuGLGetDevices_v2(unsigned int* pCudaDeviceCount, CUdevice* pCudaDevices, unsigned int cudaDeviceCount, CUGLDeviceList deviceList);
typedef CUresult CUDAAPI tcuGraphicsGLRegisterImage(CUgraphicsResource* pCudaResource, GLuint image, GLenum target, unsigned int Flags);
typedef CUresult CUDAAPI tcuGraphicsUnregisterResource(CUgraphicsResource resource);
typedef CUresult CUDAAPI tcuGraphicsMapResources(unsigned int count, CUgraphicsResource* resources, CUstream hStream);
typedef CUresult CUDAAPI tcuGraphicsUnmapResources(unsigned int count, CUgraphicsResource* resources, CUstream hStream);
typedef CUresult CUDAAPI tcuGraphicsSubResourceGetMappedArray(CUarray* pArray, CUgraphicsResource resource, unsigned int arrayIndex, unsigned int mipLevel);
typedef CUresult CUDAAPI tcuGraphicsResourceGetMappedPointer(CUdeviceptr *devPtrOut, size_t *sizeOut, CUgraphicsResource resource);
typedef CUresult CUDAAPI tcuImportExternalMemory(CUexternalMemory* extMem_out, const CUDA_EXTERNAL_MEMORY_HANDLE_DESC* memHandleDesc);
typedef CUresult CUDAAPI tcuDestroyExternalMemory(CUexternalMemory extMem);
typedef CUresult CUDAAPI tcuExternalMemoryGetMappedBuffer(CUdeviceptr* devPtr, CUexternalMemory extMem, const CUDA_EXTERNAL_MEMORY_BUFFER_DESC* bufferDesc);
typedef CUresult CUDAAPI tcuExternalMemoryGetMappedMipmappedArray(CUmipmappedArray* mipmap, CUexternalMemory extMem, const CUDA_EXTERNAL_MEMORY_MIPMAPPED_ARRAY_DESC* mipmapDesc);
typedef CUresult CUDAAPI tcuMipmappedArrayGetLevel(CUarray* pLevelArray, CUmipmappedArray hMipmappedArray, unsigned int level);
typedef CUresult CUDAAPI tcuMipmappedArrayDestroy(CUmipmappedArray hMipmappedArray);
typedef CUresult CUDAAPI tcuImportExternalSemaphore(CUexternalSemaphore* extSem_out, const CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC* semHandleDesc);
typedef CUresult CUDAAPI tcuDestroyExternalSemaphore(CUexternalSemaphore extSem);
typedef CUresult CUDAAPI tcuSignalExternalSemaphoresAsync(const CUexternalSemaphore* extSemArray, const CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS* paramsArray, unsigned int numExtSems, CUstream stream);
typedef CUresult CUDAAPI tcuWaitExternalSemaphoresAsync(const CUexternalSemaphore* extSemArray, const CUDA_EXTERNAL_SEMAPHORE_WAIT_PARAMS* paramsArray, unsigned int numExtSems, CUstream stream);
typedef CUresult CUDAAPI tcuArrayCreate(CUarray *pHandle, const CUDA_ARRAY_DESCRIPTOR* pAllocateArray);
typedef CUresult CUDAAPI tcuArray3DCreate(CUarray *pHandle, const CUDA_ARRAY3D_DESCRIPTOR* pAllocateArray);
typedef CUresult CUDAAPI tcuArrayDestroy(CUarray hArray);
typedef CUresult CUDAAPI tcuEGLStreamProducerConnect(CUeglStreamConnection* conn, ffnv_EGLStreamKHR stream, ffnv_EGLint width, ffnv_EGLint height);
typedef CUresult CUDAAPI tcuEGLStreamProducerDisconnect(CUeglStreamConnection* conn);
typedef CUresult CUDAAPI tcuEGLStreamConsumerDisconnect(CUeglStreamConnection* conn);
typedef CUresult CUDAAPI tcuEGLStreamProducerPresentFrame(CUeglStreamConnection* conn, CUeglFrame eglframe, CUstream* pStream);
typedef CUresult CUDAAPI tcuEGLStreamProducerReturnFrame(CUeglStreamConnection* conn, CUeglFrame* eglframe, CUstream* pStream);
typedef CUresult CUDAAPI tcuD3D11GetDevice(CUdevice *device, void *dxgiAdapter);
typedef CUresult CUDAAPI tcuD3D11GetDevices(unsigned int *deviceCountOut, CUdevice *devices, unsigned int deviceCount, void *d3d11device, CUd3d11DeviceList listType);
typedef CUresult CUDAAPI tcuGraphicsD3D11RegisterResource(CUgraphicsResource *cudaResourceOut, void *d3d11Resource, unsigned int flags);
#endif
File diff suppressed because it is too large. Load diff
+11
View File
@@ -0,0 +1,11 @@
# Generated by Cargo
# will have compiled files and executables
/target/
/.idea/
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
Cargo.lock
# These are backup files generated by rustfmt
**/*.rs.bk
+49
View File
@@ -0,0 +1,49 @@
# webrtc-ice changelog
## Unreleased
### Breaking changes
* remove non used `MulticastDnsMode::Unspecified` variant [#404](https://github.com/webrtc-rs/webrtc/pull/404):
## v0.9.0
* Increased minimum support rust version to `1.60.0`.
### Breaking changes
* Make functions non-async [#338](https://github.com/webrtc-rs/webrtc/pull/338):
- `Agent`:
- `get_bytes_received`;
- `get_bytes_sent`;
- `on_connection_state_change`;
- `on_selected_candidate_pair_change`;
- `on_candidate`;
- `add_remote_candidate`;
- `gather_candidates`.
- `unmarshal_candidate`;
- `CandidateHostConfig::new_candidate_host`;
- `CandidatePeerReflexiveConfig::new_candidate_peer_reflexive`;
- `CandidateRelayConfig::new_candidate_relay`;
- `CandidateServerReflexiveConfig::new_candidate_server_reflexive`;
- `Candidate`:
- `addr`;
- `set_ip`.
## v0.8.2
* Add IP filter to ICE `AgentConfig` [#306](https://github.com/webrtc-rs/webrtc/pull/306) and [#318](https://github.com/webrtc-rs/webrtc/pull/318).
* Add `rust-version` at 1.57.0 to `Cargo.toml`. This was already the minimum version so does not constitute a change.
## v0.8.1
This release was released in error and contains no changes from 0.8.0.
## v0.8.0
* Increased min version of `log` dependency to `0.4.16`. [#250 Fix log at ^0.4.16 to make tests compile](https://github.com/webrtc-rs/webrtc/pull/250) by [@k0nserv](https://github.com/k0nserv).
* Increased serde's minimum version to 1.0.102 [#243 Fixes for cargo minimal-versions](https://github.com/webrtc-rs/webrtc/pull/243) contributed by [algesten](https://github.com/algesten)
## Prior to 0.8.0
Before 0.8.0 there was no changelog, previous changes are sometimes, but not always, available in the [GitHub Releases](https://github.com/webrtc-rs/ice/releases).
+125
View File
@@ -0,0 +1,125 @@
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.
[package]
edition = "2021"
name = "webrtc-ice"
version = "0.10.1"
authors = ["Rain Liu <[email protected]>"]
description = "A pure Rust implementation of ICE"
homepage = "https://webrtc.rs"
documentation = "https://docs.rs/webrtc-ice"
readme = "README.md"
license = "MIT OR Apache-2.0"
repository = "https://github.com/webrtc-rs/ice"
[[example]]
name = "ping_pong"
path = "examples/ping_pong.rs"
bench = false
[dependencies.arc-swap]
version = "1"
[dependencies.async-trait]
version = "0.1"
[dependencies.crc]
version = "3"
[dependencies.log]
version = "0.4"
[dependencies.mdns]
version = "0.6.1"
package = "webrtc-mdns"
[dependencies.rand]
version = "0.8"
[dependencies.rustls-native-certs]
version = "0.8"
[dependencies.serde]
version = "1"
features = ["derive"]
[dependencies.serde_json]
version = "1"
[dependencies.stun]
version = "0.5.1"
[dependencies.thiserror]
version = "1"
[dependencies.tokio]
version = "1.32.0"
features = ["full"]
[dependencies.tokio-rustls]
version = "0.26.6"
default-features = false
features = ["ring", "tls12"]
[dependencies.turn]
version = "0.7.1"
[dependencies.url]
version = "2"
[dependencies.util]
version = "0.8.1"
features = [
"conn",
"vnet",
"sync",
]
default-features = false
package = "webrtc-util"
[dependencies.uuid]
version = "1"
features = ["v4"]
[dependencies.waitgroup]
version = "0.1"
[dependencies.webpki-roots]
version = "1"
[dev-dependencies.chrono]
version = "0.4.28"
[dev-dependencies.clap]
version = "3"
[dev-dependencies.env_logger]
version = "0.10"
[dev-dependencies.hyper]
version = "0.14.27"
features = ["full"]
[dev-dependencies.ipnet]
version = "2"
[dev-dependencies.lazy_static]
version = "1"
[dev-dependencies.regex]
version = "1.9.5"
[dev-dependencies.sha1]
version = "0.10"
[dev-dependencies.tokio-test]
version = "0.4"
+45
View File
@@ -0,0 +1,45 @@
[package]
name = "webrtc-ice"
version = "0.10.1"
authors = ["Rain Liu <[email protected]>"]
edition = "2021"
description = "A pure Rust implementation of ICE"
license = "MIT OR Apache-2.0"
documentation = "https://docs.rs/webrtc-ice"
homepage = "https://webrtc.rs"
repository = "https://github.com/webrtc-rs/ice"
[dependencies]
util = { version = "0.8.1", path = "../util", package = "webrtc-util", default-features = false, features = ["conn", "vnet", "sync"] }
turn = { version = "0.7.1", path = "../turn" }
stun = { version = "0.5.1", path = "../stun" }
mdns = { version = "0.6.1", path = "../mdns", package = "webrtc-mdns" }
arc-swap = "1"
async-trait = "0.1"
crc = "3"
log = "0.4"
rand = "0.8"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
thiserror = "1"
tokio = { version = "1.32.0", features = ["full"] }
url = "2"
uuid = { version = "1", features = ["v4"] }
waitgroup = "0.1"
[dev-dependencies]
tokio-test = "0.4"
regex = "1.9.5"
env_logger = "0.10"
chrono = "0.4.28"
ipnet = "2"
clap = "3"
lazy_static = "1"
hyper = { version = "0.14.27", features = ["full"] }
sha1 = "0.10"
[[example]]
name = "ping_pong"
path = "examples/ping_pong.rs"
bench = false
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2021 WebRTC.rs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+16
View File
@@ -0,0 +1,16 @@
# Local patch to webrtc-ice 0.10.1
Source: crates.io webrtc-ice 0.10.1 (MIT / Apache-2.0; upstream licenses retained).
Upstream gathers relay candidates only for `turn:` over UDP and logs "Unable to handle URL" for
`turn:?transport=tcp` and `turns:`. NetEase sessions that force relaying also offer
`turns:<host>:<port>?transport=tcp`, which is the only media path on hosts whose UDP cannot reach
the TURN servers but whose TCP goes through an HTTP proxy.
`src/agent/turn_tcp.rs` opens TCP (directly, or through an HTTP CONNECT proxy set by the
application with `set_relay_transport`), adds TLS for `turns:`, and exposes the stream to the
unchanged `turn` client as datagrams: one STUN message or ChannelData frame (with its 4-byte TCP
padding) per read. `agent_gather.rs` uses it for `ProtoType::Tcp` URLs. UDP gathering is unchanged.
TLS trusts the system certificate store (`rustls-native-certs`, as OpenSSL does) plus the bundled
Mozilla roots. A name mismatch is accepted only when the TURN URL is an IP literal.
+30
View File
@@ -0,0 +1,30 @@
<h1 align="center">
<a href="https://webrtc.rs"><img src="./doc/webrtc.rs.png" alt="WebRTC.rs"></a>
<br>
</h1>
<p align="center">
<a href="https://github.com/webrtc-rs/ice/actions">
<img src="https://github.com/webrtc-rs/ice/workflows/cargo/badge.svg">
</a>
<a href="https://codecov.io/gh/webrtc-rs/ice">
<img src="https://codecov.io/gh/webrtc-rs/ice/branch/main/graph/badge.svg">
</a>
<a href="https://deps.rs/repo/github/webrtc-rs/ice">
<img src="https://deps.rs/repo/github/webrtc-rs/ice/status.svg">
</a>
<a href="https://crates.io/crates/webrtc-ice">
<img src="https://img.shields.io/crates/v/webrtc-ice.svg">
</a>
<a href="https://docs.rs/webrtc-ice">
<img src="https://docs.rs/webrtc-ice/badge.svg">
</a>
<a href="https://doc.rust-lang.org/1.6.0/complement-project-faq.html#why-dual-mitasl2-license">
<img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue" alt="License: MIT/Apache 2.0">
</a>
<a href="https://discord.gg/4Ju8UHdXMs">
<img src="https://img.shields.io/discord/800204819540869120?logo=discord" alt="Discord">
</a>
</p>
<p align="center">
A pure Rust implementation of ICE. Rewrite <a href="https://github.com/pion/ice/releases/tag/v2.0.14">Pion</a> ICE in Rust
</p>
+23
View File
@@ -0,0 +1,23 @@
codecov:
require_ci_to_pass: yes
max_report_age: off
token: 4bd5cec1-2807-4cd6-8430-d5f3efe32ce0
coverage:
precision: 2
round: down
range: 50..90
status:
project:
default:
enabled: no
threshold: 0.2
if_not_found: success
patch:
default:
enabled: no
if_not_found: success
changes:
default:
enabled: no
if_not_found: success
Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

+424
View File
@@ -0,0 +1,424 @@
use std::io;
use std::sync::Arc;
use std::time::Duration;
use clap::{App, AppSettings, Arg};
use hyper::service::{make_service_fn, service_fn};
use hyper::{Body, Client, Method, Request, Response, Server, StatusCode};
use ice::agent::agent_config::AgentConfig;
use ice::agent::Agent;
use ice::candidate::candidate_base::*;
use ice::candidate::*;
use ice::network_type::*;
use ice::state::*;
use ice::udp_network::UDPNetwork;
use ice::Error;
use rand::{thread_rng, Rng};
use tokio::net::UdpSocket;
use tokio::sync::{mpsc, watch, Mutex};
use util::Conn;
use webrtc_ice as ice;
#[macro_use]
extern crate lazy_static;
type SenderType = Arc<Mutex<mpsc::Sender<String>>>;
type ReceiverType = Arc<Mutex<mpsc::Receiver<String>>>;
lazy_static! {
// ErrUnknownType indicates an error with Unknown info.
static ref REMOTE_AUTH_CHANNEL: (SenderType, ReceiverType ) = {
let (tx, rx) = mpsc::channel::<String>(3);
(Arc::new(Mutex::new(tx)), Arc::new(Mutex::new(rx)))
};
static ref REMOTE_CAND_CHANNEL: (SenderType, ReceiverType) = {
let (tx, rx) = mpsc::channel::<String>(10);
(Arc::new(Mutex::new(tx)), Arc::new(Mutex::new(rx)))
};
}
// HTTP Listener to get ICE Credentials/Candidate from remote Peer
async fn remote_handler(req: Request<Body>) -> Result<Response<Body>, hyper::Error> {
//println!("received {:?}", req);
match (req.method(), req.uri().path()) {
(&Method::POST, "/remoteAuth") => {
let full_body =
match std::str::from_utf8(&hyper::body::to_bytes(req.into_body()).await?) {
Ok(s) => s.to_owned(),
Err(err) => panic!("{}", err),
};
let tx = REMOTE_AUTH_CHANNEL.0.lock().await;
//println!("body: {:?}", full_body);
let _ = tx.send(full_body).await;
let mut response = Response::new(Body::empty());
*response.status_mut() = StatusCode::OK;
Ok(response)
}
(&Method::POST, "/remoteCandidate") => {
let full_body =
match std::str::from_utf8(&hyper::body::to_bytes(req.into_body()).await?) {
Ok(s) => s.to_owned(),
Err(err) => panic!("{}", err),
};
let tx = REMOTE_CAND_CHANNEL.0.lock().await;
//println!("body: {:?}", full_body);
let _ = tx.send(full_body).await;
let mut response = Response::new(Body::empty());
*response.status_mut() = StatusCode::OK;
Ok(response)
}
// Return the 404 Not Found for other routes.
_ => {
let mut not_found = Response::default();
*not_found.status_mut() = StatusCode::NOT_FOUND;
Ok(not_found)
}
}
}
// Controlled Agent:
// cargo run --color=always --package webrtc-ice --example ping_pong
// Controlling Agent:
// cargo run --color=always --package webrtc-ice --example ping_pong -- --controlling
#[tokio::main]
async fn main() -> Result<(), Error> {
env_logger::init();
// .format(|buf, record| {
// writeln!(
// buf,
// "{}:{} [{}] {} - {}",
// record.file().unwrap_or("unknown"),
// record.line().unwrap_or(0),
// record.level(),
// chrono::Local::now().format("%H:%M:%S.%6f"),
// record.args()
// )
// })
// .filter(None, log::LevelFilter::Trace)
// .init();
let mut app = App::new("ICE Demo")
.version("0.1.0")
.author("Rain Liu <[email protected]>")
.about("An example of ICE")
.setting(AppSettings::DeriveDisplayOrder)
.setting(AppSettings::SubcommandsNegateReqs)
.arg(
Arg::with_name("use-mux")
.takes_value(false)
.long("use-mux")
.short('m')
.help("Use a muxed UDP connection over a single listening port"),
)
.arg(
Arg::with_name("FULLHELP")
.help("Prints more detailed help information")
.long("fullhelp"),
)
.arg(
Arg::with_name("controlling")
.takes_value(false)
.long("controlling")
.help("is ICE Agent controlling"),
);
let matches = app.clone().get_matches();
if matches.is_present("FULLHELP") {
app.print_long_help().unwrap();
std::process::exit(0);
}
let is_controlling = matches.is_present("controlling");
let use_mux = matches.is_present("use-mux");
let (local_http_port, remote_http_port) = if is_controlling {
(9000, 9001)
} else {
(9001, 9000)
};
let (weak_conn, weak_agent) = {
let (done_tx, done_rx) = watch::channel(());
println!("Listening on http://localhost:{local_http_port}");
let mut done_http_server = done_rx.clone();
tokio::spawn(async move {
let addr = ([0, 0, 0, 0], local_http_port).into();
let service =
make_service_fn(|_| async { Ok::<_, hyper::Error>(service_fn(remote_handler)) });
let server = Server::bind(&addr).serve(service);
tokio::select! {
_ = done_http_server.changed() => {
println!("receive cancel http server!");
}
result = server => {
// Run this server for... forever!
if let Err(e) = result {
eprintln!("server error: {e}");
}
println!("exit http server!");
}
};
});
if is_controlling {
println!("Local Agent is controlling");
} else {
println!("Local Agent is controlled");
};
println!("Press 'Enter' when both processes have started");
let mut input = String::new();
let _ = io::stdin().read_line(&mut input)?;
let udp_network = if use_mux {
use ice::udp_mux::*;
let port = if is_controlling { 4000 } else { 4001 };
let udp_socket = UdpSocket::bind(("0.0.0.0", port)).await?;
let udp_mux = UDPMuxDefault::new(UDPMuxParams::new(udp_socket));
UDPNetwork::Muxed(udp_mux)
} else {
UDPNetwork::Ephemeral(Default::default())
};
let ice_agent = Arc::new(
Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
udp_network,
..Default::default()
})
.await?,
);
let client = Arc::new(Client::new());
// When we have gathered a new ICE Candidate send it to the remote peer
let client2 = Arc::clone(&client);
ice_agent.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let client3 = Arc::clone(&client2);
Box::pin(async move {
if let Some(c) = c {
println!("posting remoteCandidate with {}", c.marshal());
let req = match Request::builder()
.method(Method::POST)
.uri(format!(
"http://localhost:{remote_http_port}/remoteCandidate"
))
.body(Body::from(c.marshal()))
{
Ok(req) => req,
Err(err) => {
println!("{err}");
return;
}
};
let resp = match client3.request(req).await {
Ok(resp) => resp,
Err(err) => {
println!("{err}");
return;
}
};
println!("Response from remoteCandidate: {}", resp.status());
}
})
},
));
let (ice_done_tx, mut ice_done_rx) = mpsc::channel::<()>(1);
// When ICE Connection state has change print to stdout
ice_agent.on_connection_state_change(Box::new(move |c: ConnectionState| {
println!("ICE Connection State has changed: {c}");
if c == ConnectionState::Failed {
let _ = ice_done_tx.try_send(());
}
Box::pin(async move {})
}));
// Get the local auth details and send to remote peer
let (local_ufrag, local_pwd) = ice_agent.get_local_user_credentials().await;
println!("posting remoteAuth with {local_ufrag}:{local_pwd}");
let req = match Request::builder()
.method(Method::POST)
.uri(format!("http://localhost:{remote_http_port}/remoteAuth"))
.body(Body::from(format!("{local_ufrag}:{local_pwd}")))
{
Ok(req) => req,
Err(err) => return Err(Error::Other(format!("{err}"))),
};
let resp = match client.request(req).await {
Ok(resp) => resp,
Err(err) => return Err(Error::Other(format!("{err}"))),
};
println!("Response from remoteAuth: {}", resp.status());
let (remote_ufrag, remote_pwd) = {
let mut rx = REMOTE_AUTH_CHANNEL.1.lock().await;
if let Some(s) = rx.recv().await {
println!("received: {s}");
let fields: Vec<String> = s.split(':').map(|s| s.to_string()).collect();
(fields[0].clone(), fields[1].clone())
} else {
panic!("rx.recv() empty");
}
};
println!("remote_ufrag: {remote_ufrag}, remote_pwd: {remote_pwd}");
let ice_agent2 = Arc::clone(&ice_agent);
let mut done_cand = done_rx.clone();
tokio::spawn(async move {
let mut rx = REMOTE_CAND_CHANNEL.1.lock().await;
loop {
tokio::select! {
_ = done_cand.changed() => {
println!("receive cancel remote cand!");
break;
}
result = rx.recv() => {
if let Some(s) = result {
if let Ok(c) = unmarshal_candidate(&s) {
println!("add_remote_candidate: {c}");
let c: Arc<dyn Candidate + Send + Sync> = Arc::new(c);
let _ = ice_agent2.add_remote_candidate(&c);
}else{
println!("unmarshal_candidate error!");
break;
}
}else{
println!("REMOTE_CAND_CHANNEL done!");
break;
}
}
};
}
});
ice_agent.gather_candidates()?;
println!("Connecting...");
let (_cancel_tx, cancel_rx) = mpsc::channel(1);
// Start the ICE Agent. One side must be controlled, and the other must be controlling
let conn: Arc<dyn Conn + Send + Sync> = if is_controlling {
ice_agent.dial(cancel_rx, remote_ufrag, remote_pwd).await?
} else {
ice_agent
.accept(cancel_rx, remote_ufrag, remote_pwd)
.await?
};
let weak_conn = Arc::downgrade(&conn);
// Send messages in a loop to the remote peer
let conn_tx = Arc::clone(&conn);
let mut done_send = done_rx.clone();
tokio::spawn(async move {
const RANDOM_STRING: &[u8] = b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
loop {
tokio::time::sleep(Duration::from_secs(3)).await;
let val: String = (0..15)
.map(|_| {
let idx = thread_rng().gen_range(0..RANDOM_STRING.len());
RANDOM_STRING[idx] as char
})
.collect();
tokio::select! {
_ = done_send.changed() => {
println!("receive cancel ice send!");
break;
}
result = conn_tx.send(val.as_bytes()) => {
if let Err(err) = result {
eprintln!("conn_tx send error: {err}");
break;
}else{
println!("Sent: '{val}'");
}
}
};
}
});
let mut done_recv = done_rx.clone();
tokio::spawn(async move {
// Receive messages in a loop from the remote peer
let mut buf = vec![0u8; 1500];
loop {
tokio::select! {
_ = done_recv.changed() => {
println!("receive cancel ice recv!");
break;
}
result = conn.recv(&mut buf) => {
match result {
Ok(n) => {
println!("Received: '{}'", std::str::from_utf8(&buf[..n]).unwrap());
}
Err(err) => {
eprintln!("conn_tx send error: {err}");
break;
}
};
}
};
}
});
println!("Press ctrl-c to stop");
/*let d = if is_controlling {
Duration::from_secs(500)
} else {
Duration::from_secs(5)
};
let timeout = tokio::time::sleep(d);
tokio::pin!(timeout);*/
tokio::select! {
/*_ = timeout.as_mut() => {
println!("received timeout signal!");
let _ = done_tx.send(());
}*/
_ = ice_done_rx.recv() => {
println!("ice_done_rx");
let _ = done_tx.send(());
}
_ = tokio::signal::ctrl_c() => {
println!();
let _ = done_tx.send(());
}
};
let _ = ice_agent.close().await;
(weak_conn, Arc::downgrade(&ice_agent))
};
let mut int = tokio::time::interval(Duration::from_secs(1));
loop {
int.tick().await;
println!(
"weak_conn: weak count = {}, strong count = {}, weak_agent: weak count = {}, strong count = {}",
weak_conn.weak_count(),
weak_conn.strong_count(),
weak_agent.weak_count(),
weak_agent.strong_count(),
);
if weak_conn.strong_count() == 0 && weak_agent.strong_count() == 0 {
break;
}
}
Ok(())
}
+255
View File
@@ -0,0 +1,255 @@
use std::net::IpAddr;
use std::time::Duration;
use util::vnet::net::*;
use super::*;
use crate::error::*;
use crate::mdns::*;
use crate::network_type::*;
use crate::udp_network::UDPNetwork;
use crate::url::*;
/// The interval at which the agent performs candidate checks in the connecting phase.
pub(crate) const DEFAULT_CHECK_INTERVAL: Duration = Duration::from_millis(200);
/// The interval used to keep candidates alive.
pub(crate) const DEFAULT_KEEPALIVE_INTERVAL: Duration = Duration::from_secs(2);
/// The default time till an Agent transitions disconnected.
pub(crate) const DEFAULT_DISCONNECTED_TIMEOUT: Duration = Duration::from_secs(5);
/// The default time till an Agent transitions to failed after disconnected.
pub(crate) const DEFAULT_FAILED_TIMEOUT: Duration = Duration::from_secs(25);
/// Wait time before nominating a host candidate.
pub(crate) const DEFAULT_HOST_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_secs(0);
/// Wait time before nominating a srflx candidate.
pub(crate) const DEFAULT_SRFLX_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(500);
/// Wait time before nominating a prflx candidate.
pub(crate) const DEFAULT_PRFLX_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(1000);
/// Wait time before nominating a relay candidate.
pub(crate) const DEFAULT_RELAY_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(2000);
/// Max binding request before considering a pair failed.
pub(crate) const DEFAULT_MAX_BINDING_REQUESTS: u16 = 7;
/// The number of bytes that can be buffered before we start to error.
pub(crate) const MAX_BUFFER_SIZE: usize = 1000 * 1000; // 1MB
/// Wait time before binding requests can be deleted.
pub(crate) const MAX_BINDING_REQUEST_TIMEOUT: Duration = Duration::from_millis(4000);
pub(crate) fn default_candidate_types() -> Vec<CandidateType> {
vec![
CandidateType::Host,
CandidateType::ServerReflexive,
CandidateType::Relay,
]
}
pub type InterfaceFilterFn = Box<dyn (Fn(&str) -> bool) + Send + Sync>;
pub type IpFilterFn = Box<dyn (Fn(IpAddr) -> bool) + Send + Sync>;
/// Collects the arguments to `ice::Agent` construction into a single structure, for
/// future-proofness of the interface.
#[derive(Default)]
pub struct AgentConfig {
pub urls: Vec<Url>,
/// Controls how the UDP network stack works.
/// See [`UDPNetwork`]
pub udp_network: UDPNetwork,
/// It is used to perform connectivity checks. The values MUST be unguessable, with at least
/// 128 bits of random number generator output used to generate the password, and at least 24
/// bits of output to generate the username fragment.
pub local_ufrag: String,
/// It is used to perform connectivity checks. The values MUST be unguessable, with at least
/// 128 bits of random number generator output used to generate the password, and at least 24
/// bits of output to generate the username fragment.
pub local_pwd: String,
/// Controls mDNS behavior for the ICE agent.
pub multicast_dns_mode: MulticastDnsMode,
/// Controls the hostname for this agent. If none is specified a random one will be generated.
pub multicast_dns_host_name: String,
/// Control mDNS destination address
pub multicast_dns_dest_addr: String,
/// Defaults to 5 seconds when this property is nil.
/// If the duration is 0, the ICE Agent will never go to disconnected.
pub disconnected_timeout: Option<Duration>,
/// Defaults to 25 seconds when this property is nil.
/// If the duration is 0, we will never go to failed.
pub failed_timeout: Option<Duration>,
/// Determines how often should we send ICE keepalives (should be less then connectiontimeout
/// above) when this is nil, it defaults to 10 seconds.
/// A keepalive interval of 0 means we never send keepalive packets
pub keepalive_interval: Option<Duration>,
/// An optional configuration for disabling or enabling support for specific network types.
pub network_types: Vec<NetworkType>,
/// An optional configuration for disabling or enabling support for specific candidate types.
pub candidate_types: Vec<CandidateType>,
//LoggerFactory logging.LoggerFactory
/// Controls how often our internal task loop runs when in the connecting state.
/// Only useful for testing.
pub check_interval: Duration,
/// The max amount of binding requests the agent will send over a candidate pair for validation
/// or nomination, if after max_binding_requests the candidate is yet to answer a binding
/// request or a nomination we set the pair as failed.
pub max_binding_requests: Option<u16>,
pub is_controlling: bool,
/// lite agents do not perform connectivity check and only provide host candidates.
pub lite: bool,
/// It is used along with nat1to1ips to specify which candidate type the 1:1 NAT IP addresses
/// should be mapped to. If unspecified or CandidateTypeHost, nat1to1ips are used to replace
/// host candidate IPs. If CandidateTypeServerReflexive, it will insert a srflx candidate (as
/// if it was derived from a STUN server) with its port number being the one for the actual host
/// candidate. Other values will result in an error.
pub nat_1to1_ip_candidate_type: CandidateType,
/// Contains a list of public IP addresses that are to be used as a host candidate or srflx
/// candidate. This is used typically for servers that are behind 1:1 D-NAT (e.g. AWS EC2
/// instances) and to eliminate the need of server reflexisive candidate gathering.
pub nat_1to1_ips: Vec<String>,
/// Specify a minimum wait time before selecting host candidates.
pub host_acceptance_min_wait: Option<Duration>,
/// Specify a minimum wait time before selecting srflx candidates.
pub srflx_acceptance_min_wait: Option<Duration>,
/// Specify a minimum wait time before selecting prflx candidates.
pub prflx_acceptance_min_wait: Option<Duration>,
/// Specify a minimum wait time before selecting relay candidates.
pub relay_acceptance_min_wait: Option<Duration>,
/// Net is the our abstracted network interface for internal development purpose only
/// (see (github.com/pion/transport/vnet)[github.com/pion/transport/vnet]).
pub net: Option<Arc<Net>>,
/// A function that you can use in order to whitelist or blacklist the interfaces which are
/// used to gather ICE candidates.
pub interface_filter: Arc<Option<InterfaceFilterFn>>,
/// A function that you can use in order to whitelist or blacklist
/// the ips which are used to gather ICE candidates.
pub ip_filter: Arc<Option<IpFilterFn>>,
/// Controls if self-signed certificates are accepted when connecting to TURN servers via TLS or
/// DTLS.
pub insecure_skip_verify: bool,
}
impl AgentConfig {
/// Populates an agent and falls back to defaults if fields are unset.
pub(crate) fn init_with_defaults(&self, a: &mut AgentInternal) {
if let Some(max_binding_requests) = self.max_binding_requests {
a.max_binding_requests = max_binding_requests;
} else {
a.max_binding_requests = DEFAULT_MAX_BINDING_REQUESTS;
}
if let Some(host_acceptance_min_wait) = self.host_acceptance_min_wait {
a.host_acceptance_min_wait = host_acceptance_min_wait;
} else {
a.host_acceptance_min_wait = DEFAULT_HOST_ACCEPTANCE_MIN_WAIT;
}
if let Some(srflx_acceptance_min_wait) = self.srflx_acceptance_min_wait {
a.srflx_acceptance_min_wait = srflx_acceptance_min_wait;
} else {
a.srflx_acceptance_min_wait = DEFAULT_SRFLX_ACCEPTANCE_MIN_WAIT;
}
if let Some(prflx_acceptance_min_wait) = self.prflx_acceptance_min_wait {
a.prflx_acceptance_min_wait = prflx_acceptance_min_wait;
} else {
a.prflx_acceptance_min_wait = DEFAULT_PRFLX_ACCEPTANCE_MIN_WAIT;
}
if let Some(relay_acceptance_min_wait) = self.relay_acceptance_min_wait {
a.relay_acceptance_min_wait = relay_acceptance_min_wait;
} else {
a.relay_acceptance_min_wait = DEFAULT_RELAY_ACCEPTANCE_MIN_WAIT;
}
if let Some(disconnected_timeout) = self.disconnected_timeout {
a.disconnected_timeout = disconnected_timeout;
} else {
a.disconnected_timeout = DEFAULT_DISCONNECTED_TIMEOUT;
}
if let Some(failed_timeout) = self.failed_timeout {
a.failed_timeout = failed_timeout;
} else {
a.failed_timeout = DEFAULT_FAILED_TIMEOUT;
}
if let Some(keepalive_interval) = self.keepalive_interval {
a.keepalive_interval = keepalive_interval;
} else {
a.keepalive_interval = DEFAULT_KEEPALIVE_INTERVAL;
}
if self.check_interval == Duration::from_secs(0) {
a.check_interval = DEFAULT_CHECK_INTERVAL;
} else {
a.check_interval = self.check_interval;
}
}
pub(crate) fn init_ext_ip_mapping(
&self,
mdns_mode: MulticastDnsMode,
candidate_types: &[CandidateType],
) -> Result<Option<ExternalIpMapper>> {
if let Some(ext_ip_mapper) =
ExternalIpMapper::new(self.nat_1to1_ip_candidate_type, &self.nat_1to1_ips)?
{
if ext_ip_mapper.candidate_type == CandidateType::Host {
if mdns_mode == MulticastDnsMode::QueryAndGather {
return Err(Error::ErrMulticastDnsWithNat1to1IpMapping);
}
let mut candi_host_enabled = false;
for candi_type in candidate_types {
if *candi_type == CandidateType::Host {
candi_host_enabled = true;
break;
}
}
if !candi_host_enabled {
return Err(Error::ErrIneffectiveNat1to1IpMappingHost);
}
} else if ext_ip_mapper.candidate_type == CandidateType::ServerReflexive {
let mut candi_srflx_enabled = false;
for candi_type in candidate_types {
if *candi_type == CandidateType::ServerReflexive {
candi_srflx_enabled = true;
break;
}
}
if !candi_srflx_enabled {
return Err(Error::ErrIneffectiveNat1to1IpMappingSrflx);
}
}
Ok(Some(ext_ip_mapper))
} else {
Ok(None)
}
}
}
+911
View File
@@ -0,0 +1,911 @@
use std::net::{Ipv4Addr, Ipv6Addr};
use std::str::FromStr;
use std::sync::Arc;
use util::vnet::net::*;
use util::Conn;
use waitgroup::WaitGroup;
use super::*;
use crate::candidate::candidate_base::CandidateBaseConfig;
use crate::candidate::candidate_host::CandidateHostConfig;
use crate::candidate::candidate_relay::CandidateRelayConfig;
use crate::candidate::candidate_server_reflexive::CandidateServerReflexiveConfig;
use crate::candidate::*;
use crate::error::*;
use crate::network_type::*;
use crate::udp_network::UDPNetwork;
use crate::url::{ProtoType, SchemeType, Url};
use crate::util::*;
const STUN_GATHER_TIMEOUT: Duration = Duration::from_secs(5);
pub(crate) struct GatherCandidatesInternalParams {
pub(crate) udp_network: UDPNetwork,
pub(crate) candidate_types: Vec<CandidateType>,
pub(crate) urls: Vec<Url>,
pub(crate) network_types: Vec<NetworkType>,
pub(crate) mdns_mode: MulticastDnsMode,
pub(crate) mdns_name: String,
pub(crate) net: Arc<Net>,
pub(crate) interface_filter: Arc<Option<InterfaceFilterFn>>,
pub(crate) ip_filter: Arc<Option<IpFilterFn>>,
pub(crate) ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
pub(crate) agent_internal: Arc<AgentInternal>,
pub(crate) gathering_state: Arc<AtomicU8>,
pub(crate) chan_candidate_tx: ChanCandidateTx,
}
struct GatherCandidatesLocalParams {
udp_network: UDPNetwork,
network_types: Vec<NetworkType>,
mdns_mode: MulticastDnsMode,
mdns_name: String,
interface_filter: Arc<Option<InterfaceFilterFn>>,
ip_filter: Arc<Option<IpFilterFn>>,
ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
}
struct GatherCandidatesLocalUDPMuxParams {
network_types: Vec<NetworkType>,
interface_filter: Arc<Option<InterfaceFilterFn>>,
ip_filter: Arc<Option<IpFilterFn>>,
ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
udp_mux: Arc<dyn UDPMux + Send + Sync>,
}
struct GatherCandidatesSrflxMappedParasm {
network_types: Vec<NetworkType>,
port_max: u16,
port_min: u16,
ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
}
struct GatherCandidatesSrflxParams {
urls: Vec<Url>,
network_types: Vec<NetworkType>,
port_max: u16,
port_min: u16,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
}
impl Agent {
pub(crate) async fn gather_candidates_internal(params: GatherCandidatesInternalParams) {
Self::set_gathering_state(
&params.chan_candidate_tx,
&params.gathering_state,
GatheringState::Gathering,
)
.await;
let wg = WaitGroup::new();
for t in &params.candidate_types {
match t {
CandidateType::Host => {
let local_params = GatherCandidatesLocalParams {
udp_network: params.udp_network.clone(),
network_types: params.network_types.clone(),
mdns_mode: params.mdns_mode,
mdns_name: params.mdns_name.clone(),
interface_filter: Arc::clone(&params.interface_filter),
ip_filter: Arc::clone(&params.ip_filter),
ext_ip_mapper: Arc::clone(&params.ext_ip_mapper),
net: Arc::clone(&params.net),
agent_internal: Arc::clone(&params.agent_internal),
};
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
Self::gather_candidates_local(local_params).await;
});
}
CandidateType::ServerReflexive => {
let ephemeral_config = match &params.udp_network {
UDPNetwork::Ephemeral(e) => e,
// No server reflexive for muxxed connections
UDPNetwork::Muxed(_) => continue,
};
let srflx_params = GatherCandidatesSrflxParams {
urls: params.urls.clone(),
network_types: params.network_types.clone(),
port_max: ephemeral_config.port_max(),
port_min: ephemeral_config.port_min(),
net: Arc::clone(&params.net),
agent_internal: Arc::clone(&params.agent_internal),
};
let w1 = wg.worker();
tokio::spawn(async move {
let _d = w1;
Self::gather_candidates_srflx(srflx_params).await;
});
if let Some(ext_ip_mapper) = &*params.ext_ip_mapper {
if ext_ip_mapper.candidate_type == CandidateType::ServerReflexive {
let srflx_mapped_params = GatherCandidatesSrflxMappedParasm {
network_types: params.network_types.clone(),
port_max: ephemeral_config.port_max(),
port_min: ephemeral_config.port_min(),
ext_ip_mapper: Arc::clone(&params.ext_ip_mapper),
net: Arc::clone(&params.net),
agent_internal: Arc::clone(&params.agent_internal),
};
let w2 = wg.worker();
tokio::spawn(async move {
let _d = w2;
Self::gather_candidates_srflx_mapped(srflx_mapped_params).await;
});
}
}
}
CandidateType::Relay => {
let urls = params.urls.clone();
let net = Arc::clone(&params.net);
let agent_internal = Arc::clone(&params.agent_internal);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
Self::gather_candidates_relay(urls, net, agent_internal).await;
});
}
_ => {}
}
}
// Block until all STUN and TURN URLs have been gathered (or timed out)
wg.wait().await;
Self::set_gathering_state(
&params.chan_candidate_tx,
&params.gathering_state,
GatheringState::Complete,
)
.await;
}
async fn set_gathering_state(
chan_candidate_tx: &ChanCandidateTx,
gathering_state: &Arc<AtomicU8>,
new_state: GatheringState,
) {
if GatheringState::from(gathering_state.load(Ordering::SeqCst)) != new_state
&& new_state == GatheringState::Complete
{
let cand_tx = chan_candidate_tx.lock().await;
if let Some(tx) = &*cand_tx {
let _ = tx.send(None).await;
}
}
gathering_state.store(new_state as u8, Ordering::SeqCst);
}
async fn gather_candidates_local(params: GatherCandidatesLocalParams) {
let GatherCandidatesLocalParams {
udp_network,
network_types,
mdns_mode,
mdns_name,
interface_filter,
ip_filter,
ext_ip_mapper,
net,
agent_internal,
} = params;
// If we wanna use UDP mux, do so
// FIXME: We still need to support TCP in combination with this option
if let UDPNetwork::Muxed(udp_mux) = udp_network {
let result = Self::gather_candidates_local_udp_mux(GatherCandidatesLocalUDPMuxParams {
network_types,
interface_filter,
ip_filter,
ext_ip_mapper,
net,
agent_internal,
udp_mux,
})
.await;
if let Err(err) = result {
log::error!("Failed to gather local candidates using UDP mux: {}", err);
}
return;
}
let ips = local_interfaces(&net, &interface_filter, &ip_filter, &network_types).await;
for ip in ips {
let mut mapped_ip = ip;
if mdns_mode != MulticastDnsMode::QueryAndGather && ext_ip_mapper.is_some() {
if let Some(ext_ip_mapper2) = ext_ip_mapper.as_ref() {
if ext_ip_mapper2.candidate_type == CandidateType::Host {
if let Ok(mi) = ext_ip_mapper2.find_external_ip(&ip.to_string()) {
mapped_ip = mi;
} else {
log::warn!(
"[{}]: 1:1 NAT mapping is enabled but no external IP is found for {}",
agent_internal.get_name(),
ip
);
}
}
}
}
let address = if mdns_mode == MulticastDnsMode::QueryAndGather {
mdns_name.clone()
} else {
mapped_ip.to_string()
};
//TODO: for network in networks
let network = UDP.to_owned();
if let UDPNetwork::Ephemeral(ephemeral_config) = &udp_network {
/*TODO:switch network {
case tcp:
// Handle ICE TCP passive mode
a.log.Debugf("GetConn by ufrag: %s\n", a.localUfrag)
conn, err = a.tcpMux.GetConnByUfrag(a.localUfrag)
if err != nil {
if !errors.Is(err, ErrTCPMuxNotInitialized) {
a.log.Warnf("error getting tcp conn by ufrag: %s %s %s\n", network, ip, a.localUfrag)
}
continue
}
port = conn.LocalAddr().(*net.TCPAddr).Port
tcpType = TCPTypePassive
// is there a way to verify that the listen address is even
// accessible from the current interface.
case udp:*/
let conn: Arc<dyn Conn + Send + Sync> = match listen_udp_in_port_range(
&net,
ephemeral_config.port_max(),
ephemeral_config.port_min(),
SocketAddr::new(ip, 0),
)
.await
{
Ok(conn) => conn,
Err(err) => {
log::warn!(
"[{}]: could not listen {} {}: {}",
agent_internal.get_name(),
network,
ip,
err
);
continue;
}
};
let port = match conn.local_addr() {
Ok(addr) => addr.port(),
Err(err) => {
log::warn!(
"[{}]: could not get local addr: {}",
agent_internal.get_name(),
err
);
continue;
}
};
let host_config = CandidateHostConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address,
port,
component: COMPONENT_RTP,
conn: Some(conn),
..CandidateBaseConfig::default()
},
..CandidateHostConfig::default()
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match host_config.new_candidate_host() {
Ok(candidate) => {
if mdns_mode == MulticastDnsMode::QueryAndGather {
if let Err(err) = candidate.set_ip(&ip) {
log::warn!(
"[{}]: Failed to create host candidate: {} {} {}: {:?}",
agent_internal.get_name(),
network,
mapped_ip,
port,
err
);
continue;
}
}
Arc::new(candidate)
}
Err(err) => {
log::warn!(
"[{}]: Failed to create host candidate: {} {} {}: {}",
agent_internal.get_name(),
network,
mapped_ip,
port,
err
);
continue;
}
};
{
if let Err(err) = agent_internal.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal.get_name(),
err
);
}
}
}
}
}
async fn gather_candidates_local_udp_mux(
params: GatherCandidatesLocalUDPMuxParams,
) -> Result<()> {
let GatherCandidatesLocalUDPMuxParams {
network_types,
interface_filter,
ip_filter,
ext_ip_mapper,
net,
agent_internal,
udp_mux,
} = params;
// Filter out non UDP network types
let relevant_network_types: Vec<_> =
network_types.into_iter().filter(|n| n.is_udp()).collect();
let udp_mux = Arc::clone(&udp_mux);
let local_ips =
local_interfaces(&net, &interface_filter, &ip_filter, &relevant_network_types).await;
let candidate_ips: Vec<std::net::IpAddr> = ext_ip_mapper
.as_ref() // Arc
.as_ref() // Option
.and_then(|mapper| {
if mapper.candidate_type != CandidateType::Host {
return None;
}
Some(
local_ips
.iter()
.filter_map(|ip| match mapper.find_external_ip(&ip.to_string()) {
Ok(ip) => Some(ip),
Err(err) => {
log::warn!(
"1:1 NAT mapping is enabled but not external IP is found for {}: {}",
ip,
err
);
None
}
})
.collect(),
)
})
.unwrap_or_else(|| local_ips.iter().copied().collect());
if candidate_ips.is_empty() {
return Err(Error::ErrCandidateIpNotFound);
}
let ufrag = {
let ufrag_pwd = agent_internal.ufrag_pwd.lock().await;
ufrag_pwd.local_ufrag.clone()
};
let conn = udp_mux.get_conn(&ufrag).await?;
let port = conn.local_addr()?.port();
for candidate_ip in candidate_ips {
let host_config = CandidateHostConfig {
base_config: CandidateBaseConfig {
network: UDP.to_owned(),
address: candidate_ip.to_string(),
port,
conn: Some(conn.clone()),
component: COMPONENT_RTP,
..Default::default()
},
tcp_type: TcpType::Unspecified,
};
let candidate: Arc<dyn Candidate + Send + Sync> =
Arc::new(host_config.new_candidate_host()?);
agent_internal.add_candidate(&candidate).await?;
}
Ok(())
}
async fn gather_candidates_srflx_mapped(params: GatherCandidatesSrflxMappedParasm) {
let GatherCandidatesSrflxMappedParasm {
network_types,
port_max,
port_min,
ext_ip_mapper,
net,
agent_internal,
} = params;
let wg = WaitGroup::new();
for network_type in network_types {
if network_type.is_tcp() {
continue;
}
let network = network_type.to_string();
let net2 = Arc::clone(&net);
let agent_internal2 = Arc::clone(&agent_internal);
let ext_ip_mapper2 = Arc::clone(&ext_ip_mapper);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let conn: Arc<dyn Conn + Send + Sync> = match listen_udp_in_port_range(
&net2,
port_max,
port_min,
if network_type.is_ipv4() {
SocketAddr::new(Ipv4Addr::new(0, 0, 0, 0).into(), 0)
} else {
SocketAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).into(), 0)
},
)
.await
{
Ok(conn) => conn,
Err(err) => {
log::warn!(
"[{}]: Failed to listen {}: {}",
agent_internal2.get_name(),
network,
err
);
return Ok(());
}
};
let laddr = conn.local_addr()?;
let mapped_ip = {
if let Some(ext_ip_mapper3) = &*ext_ip_mapper2 {
match ext_ip_mapper3.find_external_ip(&laddr.ip().to_string()) {
Ok(ip) => ip,
Err(err) => {
log::warn!(
"[{}]: 1:1 NAT mapping is enabled but no external IP is found for {}: {}",
agent_internal2.get_name(),
laddr,
err
);
return Ok(());
}
}
} else {
log::error!(
"[{}]: ext_ip_mapper is None in gather_candidates_srflx_mapped",
agent_internal2.get_name(),
);
return Ok(());
}
};
let srflx_config = CandidateServerReflexiveConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address: mapped_ip.to_string(),
port: laddr.port(),
component: COMPONENT_RTP,
conn: Some(conn),
..CandidateBaseConfig::default()
},
rel_addr: laddr.ip().to_string(),
rel_port: laddr.port(),
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match srflx_config.new_candidate_server_reflexive() {
Ok(candidate) => Arc::new(candidate),
Err(err) => {
log::warn!(
"[{}]: Failed to create server reflexive candidate: {} {} {}: {}",
agent_internal2.get_name(),
network,
mapped_ip,
laddr.port(),
err
);
return Ok(());
}
};
{
if let Err(err) = agent_internal2.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal2.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal2.get_name(),
err
);
}
}
Result::<()>::Ok(())
});
}
wg.wait().await;
}
async fn gather_candidates_srflx(params: GatherCandidatesSrflxParams) {
let GatherCandidatesSrflxParams {
urls,
network_types,
port_max,
port_min,
net,
agent_internal,
} = params;
let wg = WaitGroup::new();
for network_type in network_types {
if network_type.is_tcp() {
continue;
}
for url in &urls {
let network = network_type.to_string();
let is_ipv4 = network_type.is_ipv4();
let url = url.clone();
let net2 = Arc::clone(&net);
let agent_internal2 = Arc::clone(&agent_internal);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let host_port = format!("{}:{}", url.host, url.port);
let server_addr = match net2.resolve_addr(is_ipv4, &host_port).await {
Ok(addr) => addr,
Err(err) => {
log::warn!(
"[{}]: failed to resolve stun host: {}: {}",
agent_internal2.get_name(),
host_port,
err
);
return Ok(());
}
};
let conn: Arc<dyn Conn + Send + Sync> = match listen_udp_in_port_range(
&net2,
port_max,
port_min,
if is_ipv4 {
SocketAddr::new(Ipv4Addr::new(0, 0, 0, 0).into(), 0)
} else {
SocketAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).into(), 0)
},
)
.await
{
Ok(conn) => conn,
Err(err) => {
log::warn!(
"[{}]: Failed to listen for {}: {}",
agent_internal2.get_name(),
server_addr,
err
);
return Ok(());
}
};
let xoraddr =
match get_xormapped_addr(&conn, server_addr, STUN_GATHER_TIMEOUT).await {
Ok(xoraddr) => xoraddr,
Err(err) => {
log::warn!(
"[{}]: could not get server reflexive address {} {}: {}",
agent_internal2.get_name(),
network,
url,
err
);
return Ok(());
}
};
let (ip, port) = (xoraddr.ip, xoraddr.port);
let laddr = conn.local_addr()?;
let srflx_config = CandidateServerReflexiveConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address: ip.to_string(),
port,
component: COMPONENT_RTP,
conn: Some(conn),
..CandidateBaseConfig::default()
},
rel_addr: laddr.ip().to_string(),
rel_port: laddr.port(),
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match srflx_config.new_candidate_server_reflexive() {
Ok(candidate) => Arc::new(candidate),
Err(err) => {
log::warn!(
"[{}]: Failed to create server reflexive candidate: {} {} {}: {:?}",
agent_internal2.get_name(),
network,
ip,
port,
err
);
return Ok(());
}
};
{
if let Err(err) = agent_internal2.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal2.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal2.get_name(),
err
);
}
}
Result::<()>::Ok(())
});
}
}
wg.wait().await;
}
pub(crate) async fn gather_candidates_relay(
urls: Vec<Url>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
) {
let wg = WaitGroup::new();
for url in urls {
if url.scheme != SchemeType::Turn && url.scheme != SchemeType::Turns {
continue;
}
if url.username.is_empty() {
log::error!(
"[{}]:Failed to gather relay candidates: {:?}",
agent_internal.get_name(),
Error::ErrUsernameEmpty
);
return;
}
if url.password.is_empty() {
log::error!(
"[{}]: Failed to gather relay candidates: {:?}",
agent_internal.get_name(),
Error::ErrPasswordEmpty
);
return;
}
let network = NetworkType::Udp4.to_string();
let net2 = Arc::clone(&net);
let agent_internal2 = Arc::clone(&agent_internal);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let turn_server_addr = format!("{}:{}", url.host, url.port);
let (loc_conn, rel_addr, rel_port) =
if url.proto == ProtoType::Udp && url.scheme == SchemeType::Turn {
let loc_conn = match net2.bind(SocketAddr::from_str("0.0.0.0:0")?).await {
Ok(c) => c,
Err(err) => {
log::warn!(
"[{}]: Failed to listen due to error: {}",
agent_internal2.get_name(),
err
);
return Ok(());
}
};
let local_addr = loc_conn.local_addr()?;
let rel_addr = local_addr.ip().to_string();
let rel_port = local_addr.port();
(loc_conn, rel_addr, rel_port)
/*TODO: case url.proto == ProtoType::UDP && url.scheme == SchemeType::TURNS{*/
} else if url.proto == ProtoType::Tcp && super::turn_tcp::enabled() {
// uu-remote-linux patch: TURN over TCP/TLS, optionally via an HTTP proxy.
let server = tokio::net::lookup_host(turn_server_addr.as_str()).await.ok()
.and_then(|mut addrs| addrs.next())
.unwrap_or_else(|| SocketAddr::from(([0, 0, 0, 0], url.port)));
let tls = url.scheme == SchemeType::Turns;
match super::turn_tcp::dial(&url.host, url.port, server, tls).await {
Ok(conn) => {
let local_addr = conn.local_addr()?;
let loc_conn: Arc<dyn Conn + Send + Sync> = Arc::new(conn);
(loc_conn, local_addr.ip().to_string(), local_addr.port())
}
Err(err) => {
log::warn!(
"[{}]: Failed to open TURN {} connection: {}",
agent_internal2.get_name(),
if tls { "TLS" } else { "TCP" },
err
);
return Ok(());
}
}
} else {
log::warn!(
"[{}]: Unable to handle URL in gather_candidates_relay {}",
agent_internal2.get_name(),
url
);
return Ok(());
};
let cfg = turn::client::ClientConfig {
stun_serv_addr: String::new(),
turn_serv_addr: turn_server_addr.clone(),
username: url.username,
password: url.password,
realm: String::new(),
software: String::new(),
rto_in_ms: 0,
conn: loc_conn,
vnet: Some(Arc::clone(&net2)),
};
let client = match turn::client::Client::new(cfg).await {
Ok(client) => Arc::new(client),
Err(err) => {
log::warn!(
"[{}]: Failed to build new turn.Client {} {}\n",
agent_internal2.get_name(),
turn_server_addr,
err
);
return Ok(());
}
};
if let Err(err) = client.listen().await {
let _ = client.close().await;
log::warn!(
"[{}]: Failed to listen on turn.Client {} {}",
agent_internal2.get_name(),
turn_server_addr,
err
);
return Ok(());
}
let relay_conn: Arc<dyn Conn + Send + Sync> = match client.allocate().await {
Ok(conn) => Arc::new(conn),
Err(err) => {
let _ = client.close().await;
log::warn!(
"[{}]: Failed to allocate on turn.Client {} {}",
agent_internal2.get_name(),
turn_server_addr,
err
);
return Ok(());
}
};
let raddr = relay_conn.local_addr()?;
let relay_config = CandidateRelayConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address: raddr.ip().to_string(),
port: raddr.port(),
component: COMPONENT_RTP,
conn: Some(Arc::clone(&relay_conn)),
..CandidateBaseConfig::default()
},
rel_addr,
rel_port,
relay_client: Some(Arc::clone(&client)),
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match relay_config.new_candidate_relay() {
Ok(candidate) => Arc::new(candidate),
Err(err) => {
let _ = relay_conn.close().await;
let _ = client.close().await;
log::warn!(
"[{}]: Failed to create relay candidate: {} {}: {}",
agent_internal2.get_name(),
network,
raddr,
err
);
return Ok(());
}
};
{
if let Err(err) = agent_internal2.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal2.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal2.get_name(),
err
);
}
}
Result::<()>::Ok(())
});
}
wg.wait().await;
}
}
+490
View File
@@ -0,0 +1,490 @@
use std::str::FromStr;
use ipnet::IpNet;
use tokio::net::UdpSocket;
use util::vnet::*;
use super::agent_vnet_test::*;
use super::*;
use crate::udp_mux::{UDPMuxDefault, UDPMuxParams};
use crate::util::*;
#[tokio::test]
async fn test_vnet_gather_no_local_ip_address() -> Result<()> {
let vnet = Arc::new(net::Net::new(Some(net::NetConfig::default())));
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&vnet)),
..Default::default()
})
.await?;
let local_ips = local_interfaces(
&vnet,
&a.interface_filter,
&a.ip_filter,
&[NetworkType::Udp4],
)
.await;
assert!(local_ips.is_empty(), "should return no local IP");
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_dynamic_ip_address() -> Result<()> {
let cider = "1.2.3.0/24";
let ipnet = IpNet::from_str(cider).map_err(|e| Error::Other(e.to_string()))?;
let r = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: cider.to_owned(),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig::default())));
connect_net2router(&nw, &r).await?;
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert!(!local_ips.is_empty(), "should have one local IP");
for ip in &local_ips {
if ip.is_loopback() {
panic!("should not return loopback IP");
}
if !ipnet.contains(ip) {
panic!("{ip} should be contained in the CIDR {ipnet}");
}
}
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_listen_udp() -> Result<()> {
let cider = "1.2.3.0/24";
let r = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: cider.to_owned(),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig::default())));
connect_net2router(&nw, &r).await?;
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert!(!local_ips.is_empty(), "should have one local IP");
for ip in local_ips {
let _ = listen_udp_in_port_range(&nw, 0, 0, SocketAddr::new(ip, 0)).await?;
let result = listen_udp_in_port_range(&nw, 4999, 5000, SocketAddr::new(ip, 0)).await;
assert!(
result.is_err(),
"listenUDP with invalid port range did not return ErrPort"
);
let conn = listen_udp_in_port_range(&nw, 5000, 5000, SocketAddr::new(ip, 0)).await?;
let port = conn.local_addr()?.port();
assert_eq!(
port, 5000,
"listenUDP with port restriction of 5000 listened on incorrect port ({port})"
);
}
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_with_nat_1to1_as_host_candidates() -> Result<()> {
let external_ip0 = "1.2.3.4";
let external_ip1 = "1.2.3.5";
let local_ip0 = "10.0.0.1";
let local_ip1 = "10.0.0.2";
let map0 = format!("{external_ip0}/{local_ip0}");
let map1 = format!("{external_ip1}/{local_ip1}");
let wan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "1.2.3.0/24".to_owned(),
..Default::default()
})?));
let lan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "10.0.0.0/24".to_owned(),
static_ips: vec![map0.clone(), map1.clone()],
nat_type: Some(nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
}),
..Default::default()
})?));
connect_router2router(&lan, &wan).await?;
let nw = Arc::new(net::Net::new(Some(net::NetConfig {
static_ips: vec![local_ip0.to_owned(), local_ip1.to_owned()],
..Default::default()
})));
connect_net2router(&nw, &lan).await?;
let a = Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
nat_1to1_ips: vec![map0.clone(), map1.clone()],
net: Some(Arc::clone(&nw)),
..Default::default()
})
.await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
let candidates = a.get_local_candidates().await?;
assert_eq!(candidates.len(), 2, "There must be two candidates");
let mut laddrs = vec![];
for candi in &candidates {
if let Some(conn) = candi.get_conn() {
let laddr = conn.local_addr()?;
assert_eq!(
candi.port(),
laddr.port(),
"Unexpected candidate port: {}",
candi.port()
);
laddrs.push(laddr);
}
}
if candidates[0].address() == external_ip0 {
assert_eq!(
candidates[1].address(),
external_ip1,
"Unexpected candidate IP: {}",
candidates[1].address()
);
assert_eq!(
laddrs[0].ip().to_string(),
local_ip0,
"Unexpected listen IP: {}",
laddrs[0].ip()
);
assert_eq!(
laddrs[1].ip().to_string(),
local_ip1,
"Unexpected listen IP: {}",
laddrs[1].ip()
);
} else if candidates[0].address() == external_ip1 {
assert_eq!(
candidates[1].address(),
external_ip0,
"Unexpected candidate IP: {}",
candidates[1].address()
);
assert_eq!(
laddrs[0].ip().to_string(),
local_ip1,
"Unexpected listen IP: {}",
laddrs[0].ip(),
);
assert_eq!(
laddrs[1].ip().to_string(),
local_ip0,
"Unexpected listen IP: {}",
laddrs[1].ip(),
)
}
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_with_nat_1to1_as_srflx_candidates() -> Result<()> {
let wan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "1.2.3.0/24".to_owned(),
..Default::default()
})?));
let lan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "10.0.0.0/24".to_owned(),
static_ips: vec!["1.2.3.4/10.0.0.1".to_owned()],
nat_type: Some(nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
}),
..Default::default()
})?));
connect_router2router(&lan, &wan).await?;
let nw = Arc::new(net::Net::new(Some(net::NetConfig {
static_ips: vec!["10.0.0.1".to_owned()],
..Default::default()
})));
connect_net2router(&nw, &lan).await?;
let a = Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
nat_1to1_ips: vec!["1.2.3.4".to_owned()],
nat_1to1_ip_candidate_type: CandidateType::ServerReflexive,
net: Some(nw),
..Default::default()
})
.await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
let candidates = a.get_local_candidates().await?;
assert_eq!(candidates.len(), 2, "There must be two candidates");
let mut candi_host = None;
let mut candi_srflx = None;
for candidate in candidates {
match candidate.candidate_type() {
CandidateType::Host => {
candi_host = Some(candidate);
}
CandidateType::ServerReflexive => {
candi_srflx = Some(candidate);
}
_ => {
panic!("Unexpected candidate type");
}
}
}
assert!(candi_host.is_some(), "should not be nil");
assert_eq!("10.0.0.1", candi_host.unwrap().address(), "should match");
assert!(candi_srflx.is_some(), "should not be nil");
assert_eq!("1.2.3.4", candi_srflx.unwrap().address(), "should match");
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_with_interface_filter() -> Result<()> {
let r = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "1.2.3.0/24".to_owned(),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig::default())));
connect_net2router(&nw, &r).await?;
//"InterfaceFilter should exclude the interface"
{
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
interface_filter: Arc::new(Some(Box::new(|_: &str| -> bool {
//assert_eq!("eth0", interface_name);
false
}))),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert!(
local_ips.is_empty(),
"InterfaceFilter should have excluded everything"
);
a.close().await?;
}
//"InterfaceFilter should not exclude the interface"
{
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
interface_filter: Arc::new(Some(Box::new(|interface_name: &str| -> bool {
"eth0" == interface_name
}))),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert_eq!(
local_ips.len(),
1,
"InterfaceFilter should not have excluded everything"
);
a.close().await?;
}
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_turn_connection_leak() -> Result<()> {
let turn_server_url = Url {
scheme: SchemeType::Turn,
host: VNET_STUN_SERVER_IP.to_owned(),
port: VNET_STUN_SERVER_PORT,
username: "user".to_owned(),
password: "pass".to_owned(),
proto: ProtoType::Udp,
};
// buildVNet with a Symmetric NATs for both LANs
let nat_type = nat::NatType {
mapping_behavior: nat::EndpointDependencyType::EndpointAddrPortDependent,
filtering_behavior: nat::EndpointDependencyType::EndpointAddrPortDependent,
..Default::default()
};
let v = build_vnet(nat_type, nat_type).await?;
let cfg0 = AgentConfig {
urls: vec![turn_server_url.clone()],
network_types: supported_network_types(),
multicast_dns_mode: MulticastDnsMode::Disabled,
nat_1to1_ips: vec![VNET_GLOBAL_IPA.to_owned()],
net: Some(Arc::clone(&v.net0)),
..Default::default()
};
let a_agent = Agent::new(cfg0).await?;
{
let agent_internal = Arc::clone(&a_agent.internal);
Agent::gather_candidates_relay(
vec![turn_server_url.clone()],
Arc::clone(&v.net0),
agent_internal,
)
.await;
}
// Assert relay conn leak on close.
a_agent.close().await?;
v.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_muxed_udp() -> Result<()> {
let udp_socket = UdpSocket::bind("0.0.0.0:0").await?;
let udp_mux = UDPMuxDefault::new(UDPMuxParams::new(udp_socket));
let lan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "10.0.0.0/24".to_owned(),
nat_type: Some(nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
}),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig {
static_ips: vec!["10.0.0.1".to_owned()],
..Default::default()
})));
connect_net2router(&nw, &lan).await?;
let a = Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
nat_1to1_ips: vec!["1.2.3.4".to_owned()],
net: Some(nw),
udp_network: UDPNetwork::Muxed(udp_mux),
..Default::default()
})
.await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
let candidates = a.get_local_candidates().await?;
assert_eq!(candidates.len(), 1, "There must be a single candidate");
let candi = &candidates[0];
let laddr = candi.get_conn().unwrap().local_addr()?;
assert_eq!(candi.address(), "1.2.3.4");
assert_eq!(
candi.port(),
laddr.port(),
"Unexpected candidate port: {}",
candi.port()
);
Ok(())
}
File diff suppressed because it is too large. Load diff
+545
View File
@@ -0,0 +1,545 @@
use std::net::SocketAddr;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use async_trait::async_trait;
use stun::agent::*;
use stun::attributes::*;
use stun::fingerprint::*;
use stun::integrity::*;
use stun::message::*;
use stun::textattrs::*;
use tokio::time::{Duration, Instant};
use crate::agent::agent_internal::*;
use crate::candidate::*;
use crate::control::*;
use crate::priority::*;
use crate::use_candidate::*;
#[async_trait]
trait ControllingSelector {
async fn start(&self);
async fn contact_candidates(&self);
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
);
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
}
#[async_trait]
trait ControlledSelector {
async fn start(&self);
async fn contact_candidates(&self);
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
);
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
}
impl AgentInternal {
fn is_nominatable(&self, c: &Arc<dyn Candidate + Send + Sync>) -> bool {
let start_time = *self.start_time.lock();
match c.candidate_type() {
CandidateType::Host => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.host_acceptance_min_wait.as_nanos()
}
CandidateType::ServerReflexive => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.srflx_acceptance_min_wait.as_nanos()
}
CandidateType::PeerReflexive => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.prflx_acceptance_min_wait.as_nanos()
}
CandidateType::Relay => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.relay_acceptance_min_wait.as_nanos()
}
CandidateType::Unspecified => {
log::error!(
"is_nominatable invalid candidate type {}",
c.candidate_type()
);
false
}
}
}
async fn nominate_pair(&self) {
let result = {
let nominated_pair = self.nominated_pair.lock().await;
if let Some(pair) = &*nominated_pair {
// The controlling agent MUST include the USE-CANDIDATE attribute in
// order to nominate a candidate pair (Section 8.1.1). The controlled
// agent MUST NOT include the USE-CANDIDATE attribute in a Binding
// request.
let (msg, result) = {
let ufrag_pwd = self.ufrag_pwd.lock().await;
let username =
ufrag_pwd.remote_ufrag.clone() + ":" + ufrag_pwd.local_ufrag.as_str();
let mut msg = Message::new();
let result = msg.build(&[
Box::new(BINDING_REQUEST),
Box::new(TransactionId::new()),
Box::new(Username::new(ATTR_USERNAME, username)),
Box::<UseCandidateAttr>::default(),
Box::new(AttrControlling(self.tie_breaker.load(Ordering::SeqCst))),
Box::new(PriorityAttr(pair.local.priority())),
Box::new(MessageIntegrity::new_short_term_integrity(
ufrag_pwd.remote_pwd.clone(),
)),
Box::new(FINGERPRINT),
]);
(msg, result)
};
if let Err(err) = result {
log::error!("{}", err);
None
} else {
log::trace!(
"ping STUN (nominate candidate pair from {} to {}",
pair.local,
pair.remote
);
let local = pair.local.clone();
let remote = pair.remote.clone();
Some((msg, local, remote))
}
} else {
None
}
};
if let Some((msg, local, remote)) = result {
self.send_binding_request(&msg, &local, &remote).await;
}
}
pub(crate) async fn start(&self) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::start(self).await;
} else {
ControlledSelector::start(self).await;
}
}
pub(crate) async fn contact_candidates(&self) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::contact_candidates(self).await;
} else {
ControlledSelector::contact_candidates(self).await;
}
}
pub(crate) async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::ping_candidate(self, local, remote).await;
} else {
ControlledSelector::ping_candidate(self, local, remote).await;
}
}
pub(crate) async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::handle_success_response(self, m, local, remote, remote_addr).await;
} else {
ControlledSelector::handle_success_response(self, m, local, remote, remote_addr).await;
}
}
pub(crate) async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::handle_binding_request(self, m, local, remote).await;
} else {
ControlledSelector::handle_binding_request(self, m, local, remote).await;
}
}
}
#[async_trait]
impl ControllingSelector for AgentInternal {
async fn start(&self) {
{
let mut nominated_pair = self.nominated_pair.lock().await;
*nominated_pair = None;
}
*self.start_time.lock() = Instant::now();
}
async fn contact_candidates(&self) {
// A lite selector should not contact candidates
if self.lite.load(Ordering::SeqCst) {
// This only happens if both peers are lite. See RFC 8445 S6.1.1 and S6.2
log::trace!("now falling back to full agent");
}
let nominated_pair_is_some = {
let nominated_pair = self.nominated_pair.lock().await;
nominated_pair.is_some()
};
if self.agent_conn.get_selected_pair().is_some() {
if self.validate_selected_pair().await {
log::trace!("[{}]: checking keepalive", self.get_name());
self.check_keepalive().await;
}
} else if nominated_pair_is_some {
self.nominate_pair().await;
} else {
let has_nominated_pair =
if let Some(p) = self.agent_conn.get_best_valid_candidate_pair().await {
self.is_nominatable(&p.local) && self.is_nominatable(&p.remote)
} else {
false
};
if has_nominated_pair {
if let Some(p) = self.agent_conn.get_best_valid_candidate_pair().await {
log::trace!(
"Nominatable pair found, nominating ({}, {})",
p.local.to_string(),
p.remote.to_string()
);
p.nominated.store(true, Ordering::SeqCst);
{
let mut nominated_pair = self.nominated_pair.lock().await;
*nominated_pair = Some(p);
}
}
self.nominate_pair().await;
} else {
self.ping_all_candidates().await;
}
}
}
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
let (msg, result) = {
let ufrag_pwd = self.ufrag_pwd.lock().await;
let username = ufrag_pwd.remote_ufrag.clone() + ":" + ufrag_pwd.local_ufrag.as_str();
let mut msg = Message::new();
let result = msg.build(&[
Box::new(BINDING_REQUEST),
Box::new(TransactionId::new()),
Box::new(Username::new(ATTR_USERNAME, username)),
Box::new(AttrControlling(self.tie_breaker.load(Ordering::SeqCst))),
Box::new(PriorityAttr(local.priority())),
Box::new(MessageIntegrity::new_short_term_integrity(
ufrag_pwd.remote_pwd.clone(),
)),
Box::new(FINGERPRINT),
]);
(msg, result)
};
if let Err(err) = result {
log::error!("{}", err);
} else {
self.send_binding_request(&msg, local, remote).await;
}
}
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
) {
if let Some(pending_request) = self.handle_inbound_binding_success(m.transaction_id).await {
let transaction_addr = pending_request.destination;
// Assert that NAT is not symmetric
// https://tools.ietf.org/html/rfc8445#section-7.2.5.2.1
if transaction_addr != remote_addr {
log::debug!("discard message: transaction source and destination does not match expected({}), actual({})", transaction_addr, remote);
return;
}
log::trace!(
"inbound STUN (SuccessResponse) from {} to {}",
remote,
local
);
let selected_pair_is_none = self.agent_conn.get_selected_pair().is_none();
if let Some(p) = self.find_pair(local, remote).await {
p.state
.store(CandidatePairState::Succeeded as u8, Ordering::SeqCst);
log::trace!(
"Found valid candidate pair: {}, p.state: {}, isUseCandidate: {}, {}",
p,
p.state.load(Ordering::SeqCst),
pending_request.is_use_candidate,
selected_pair_is_none
);
if pending_request.is_use_candidate && selected_pair_is_none {
self.set_selected_pair(Some(Arc::clone(&p))).await;
}
} else {
// This shouldn't happen
log::error!("Success response from invalid candidate pair");
}
} else {
log::warn!(
"discard message from ({}), unknown TransactionID 0x{:?}",
remote,
m.transaction_id
);
}
}
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
self.send_binding_success(m, local, remote).await;
log::trace!("controllingSelector: sendBindingSuccess");
if let Some(p) = self.find_pair(local, remote).await {
let nominated_pair_is_none = {
let nominated_pair = self.nominated_pair.lock().await;
nominated_pair.is_none()
};
log::trace!(
"controllingSelector: after findPair {}, p.state: {}, {}",
p,
p.state.load(Ordering::SeqCst),
nominated_pair_is_none,
//self.agent_conn.get_selected_pair().await.is_none() //, {}
);
if p.state.load(Ordering::SeqCst) == CandidatePairState::Succeeded as u8
&& nominated_pair_is_none
&& self.agent_conn.get_selected_pair().is_none()
{
if let Some(best_pair) = self.agent_conn.get_best_available_candidate_pair().await {
log::trace!(
"controllingSelector: getBestAvailableCandidatePair {}",
best_pair
);
if best_pair == p
&& self.is_nominatable(&p.local)
&& self.is_nominatable(&p.remote)
{
log::trace!("The candidate ({}, {}) is the best candidate available, marking it as nominated",
p.local, p.remote);
{
let mut nominated_pair = self.nominated_pair.lock().await;
*nominated_pair = Some(p);
}
self.nominate_pair().await;
}
} else {
log::trace!("No best pair available");
}
}
} else {
log::trace!("controllingSelector: addPair");
self.add_pair(local.clone(), remote.clone()).await;
}
}
}
#[async_trait]
impl ControlledSelector for AgentInternal {
async fn start(&self) {}
async fn contact_candidates(&self) {
// A lite selector should not contact candidates
if self.lite.load(Ordering::SeqCst) {
self.validate_selected_pair().await;
} else if self.agent_conn.get_selected_pair().is_some() {
if self.validate_selected_pair().await {
log::trace!("[{}]: checking keepalive", self.get_name());
self.check_keepalive().await;
}
} else {
self.ping_all_candidates().await;
}
}
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
let (msg, result) = {
let ufrag_pwd = self.ufrag_pwd.lock().await;
let username = ufrag_pwd.remote_ufrag.clone() + ":" + ufrag_pwd.local_ufrag.as_str();
let mut msg = Message::new();
let result = msg.build(&[
Box::new(BINDING_REQUEST),
Box::new(TransactionId::new()),
Box::new(Username::new(ATTR_USERNAME, username)),
Box::new(AttrControlled(self.tie_breaker.load(Ordering::SeqCst))),
Box::new(PriorityAttr(local.priority())),
Box::new(MessageIntegrity::new_short_term_integrity(
ufrag_pwd.remote_pwd.clone(),
)),
Box::new(FINGERPRINT),
]);
(msg, result)
};
if let Err(err) = result {
log::error!("{}", err);
} else {
self.send_binding_request(&msg, local, remote).await;
}
}
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
) {
// https://tools.ietf.org/html/rfc8445#section-7.3.1.5
// If the controlled agent does not accept the request from the
// controlling agent, the controlled agent MUST reject the nomination
// request with an appropriate error code response (e.g., 400)
// [RFC5389].
if let Some(pending_request) = self.handle_inbound_binding_success(m.transaction_id).await {
let transaction_addr = pending_request.destination;
// Assert that NAT is not symmetric
// https://tools.ietf.org/html/rfc8445#section-7.2.5.2.1
if transaction_addr != remote_addr {
log::debug!("discard message: transaction source and destination does not match expected({}), actual({})", transaction_addr, remote);
return;
}
log::trace!(
"inbound STUN (SuccessResponse) from {} to {}",
remote,
local
);
if let Some(p) = self.find_pair(local, remote).await {
p.state
.store(CandidatePairState::Succeeded as u8, Ordering::SeqCst);
log::trace!("Found valid candidate pair: {}", p);
} else {
// This shouldn't happen
log::error!("Success response from invalid candidate pair");
}
} else {
log::warn!(
"discard message from ({}), unknown TransactionID 0x{:?}",
remote,
m.transaction_id
);
}
}
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
if self.find_pair(local, remote).await.is_none() {
self.add_pair(local.clone(), remote.clone()).await;
}
if let Some(p) = self.find_pair(local, remote).await {
let use_candidate = m.contains(ATTR_USE_CANDIDATE);
if use_candidate {
// https://tools.ietf.org/html/rfc8445#section-7.3.1.5
if p.state.load(Ordering::SeqCst) == CandidatePairState::Succeeded as u8 {
// If the state of this pair is Succeeded, it means that the check
// previously sent by this pair produced a successful response and
// generated a valid pair (Section 7.2.5.3.2). The agent sets the
// nominated flag value of the valid pair to true.
if self.agent_conn.get_selected_pair().is_none() {
self.set_selected_pair(Some(Arc::clone(&p))).await;
}
self.send_binding_success(m, local, remote).await;
} else {
// If the received Binding request triggered a new check to be
// enqueued in the triggered-check queue (Section 7.3.1.4), once the
// check is sent and if it generates a successful response, and
// generates a valid pair, the agent sets the nominated flag of the
// pair to true. If the request fails (Section 7.2.5.2), the agent
// MUST remove the candidate pair from the valid list, set the
// candidate pair state to Failed, and set the checklist state to
// Failed.
self.ping_candidate(local, remote).await;
}
} else {
self.send_binding_success(m, local, remote).await;
self.ping_candidate(local, remote).await;
}
}
}
}
+283
View File
@@ -0,0 +1,283 @@
use std::sync::atomic::Ordering;
use tokio::time::Instant;
use crate::agent::agent_internal::AgentInternal;
use crate::candidate::{CandidatePairState, CandidateType};
use crate::network_type::NetworkType;
/// Contains ICE candidate pair statistics.
pub struct CandidatePairStats {
/// The timestamp associated with this struct.
pub timestamp: Instant,
/// The id of the local candidate.
pub local_candidate_id: String,
/// The id of the remote candidate.
pub remote_candidate_id: String,
/// The state of the checklist for the local and remote candidates in a pair.
pub state: CandidatePairState,
/// It is true when this valid pair that should be used for media,
/// if it is the highest-priority one amongst those whose nominated flag is set.
pub nominated: bool,
/// The total number of packets sent on this candidate pair.
pub packets_sent: u32,
/// The total number of packets received on this candidate pair.
pub packets_received: u32,
/// The total number of payload bytes sent on this candidate pair not including headers or
/// padding.
pub bytes_sent: u64,
/// The total number of payload bytes received on this candidate pair not including headers or
/// padding.
pub bytes_received: u64,
/// The timestamp at which the last packet was sent on this particular candidate pair, excluding
/// STUN packets.
pub last_packet_sent_timestamp: Instant,
/// The timestamp at which the last packet was received on this particular candidate pair,
/// excluding STUN packets.
pub last_packet_received_timestamp: Instant,
/// The timestamp at which the first STUN request was sent on this particular candidate pair.
pub first_request_timestamp: Instant,
/// The timestamp at which the last STUN request was sent on this particular candidate pair.
/// The average interval between two consecutive connectivity checks sent can be calculated with
/// (last_request_timestamp - first_request_timestamp) / requests_sent.
pub last_request_timestamp: Instant,
/// Timestamp at which the last STUN response was received on this particular candidate pair.
pub last_response_timestamp: Instant,
/// The sum of all round trip time measurements in seconds since the beginning of the session,
/// based on STUN connectivity check responses (responses_received), including those that reply
/// to requests that are sent in order to verify consent. The average round trip time can be
/// computed from total_round_trip_time by dividing it by responses_received.
pub total_round_trip_time: f64,
/// The latest round trip time measured in seconds, computed from both STUN connectivity checks,
/// including those that are sent for consent verification.
pub current_round_trip_time: f64,
/// It is calculated by the underlying congestion control by combining the available bitrate for
/// all the outgoing RTP streams using this candidate pair. The bitrate measurement does not
/// count the size of the IP or other transport layers like TCP or UDP. It is similar to the
/// TIAS defined in RFC 3890, i.e., it is measured in bits per second and the bitrate is
/// calculated over a 1 second window.
pub available_outgoing_bitrate: f64,
/// It is calculated by the underlying congestion control by combining the available bitrate for
/// all the incoming RTP streams using this candidate pair. The bitrate measurement does not
/// count the size of the IP or other transport layers like TCP or UDP. It is similar to the
/// TIAS defined in RFC 3890, i.e., it is measured in bits per second and the bitrate is
/// calculated over a 1 second window.
pub available_incoming_bitrate: f64,
/// The number of times the circuit breaker is triggered for this particular 5-tuple,
/// ceasing transmission.
pub circuit_breaker_trigger_count: u32,
/// The total number of connectivity check requests received (including retransmissions).
/// It is impossible for the receiver to tell whether the request was sent in order to check
/// connectivity or check consent, so all connectivity checks requests are counted here.
pub requests_received: u64,
/// The total number of connectivity check requests sent (not including retransmissions).
pub requests_sent: u64,
/// The total number of connectivity check responses received.
pub responses_received: u64,
/// The total number of connectivity check responses sent. Since we cannot distinguish
/// connectivity check requests and consent requests, all responses are counted.
pub responses_sent: u64,
/// The total number of connectivity check request retransmissions received.
pub retransmissions_received: u64,
/// The total number of connectivity check request retransmissions sent.
pub retransmissions_sent: u64,
/// The total number of consent requests sent.
pub consent_requests_sent: u64,
/// The timestamp at which the latest valid STUN binding response expired.
pub consent_expired_timestamp: Instant,
}
impl Default for CandidatePairStats {
fn default() -> Self {
Self {
timestamp: Instant::now(),
local_candidate_id: String::new(),
remote_candidate_id: String::new(),
state: CandidatePairState::default(),
nominated: false,
packets_sent: 0,
packets_received: 0,
bytes_sent: 0,
bytes_received: 0,
last_packet_sent_timestamp: Instant::now(),
last_packet_received_timestamp: Instant::now(),
first_request_timestamp: Instant::now(),
last_request_timestamp: Instant::now(),
last_response_timestamp: Instant::now(),
total_round_trip_time: 0.0,
current_round_trip_time: 0.0,
available_outgoing_bitrate: 0.0,
available_incoming_bitrate: 0.0,
circuit_breaker_trigger_count: 0,
requests_received: 0,
requests_sent: 0,
responses_received: 0,
responses_sent: 0,
retransmissions_received: 0,
retransmissions_sent: 0,
consent_requests_sent: 0,
consent_expired_timestamp: Instant::now(),
}
}
}
/// Contains ICE candidate statistics related to the `ICETransport` objects.
#[derive(Debug, Clone)]
pub struct CandidateStats {
// The timestamp associated with this struct.
pub timestamp: Instant,
/// The candidate id.
pub id: String,
/// The type of network interface used by the base of a local candidate (the address the ICE
/// agent sends from). Only present for local candidates; it's not possible to know what type of
/// network interface a remote candidate is using.
///
/// Note: This stat only tells you about the network interface used by the first "hop"; it's
/// possible that a connection will be bottlenecked by another type of network. For example,
/// when using Wi-Fi tethering, the networkType of the relevant candidate would be "wifi", even
/// when the next hop is over a cellular connection.
pub network_type: NetworkType,
/// The IP address of the candidate, allowing for IPv4 addresses and IPv6 addresses, but fully
/// qualified domain names (FQDNs) are not allowed.
pub ip: String,
/// The port number of the candidate.
pub port: u16,
/// The `Type` field of the ICECandidate.
pub candidate_type: CandidateType,
/// The `priority` field of the ICECandidate.
pub priority: u32,
/// The url of the TURN or STUN server indicated in the that translated this IP address.
/// It is the url address surfaced in an PeerConnectionICEEvent.
pub url: String,
/// The protocol used by the endpoint to communicate with the TURN server. This is only present
/// for local candidates. Valid values for the TURN url protocol is one of udp, tcp, or tls.
pub relay_protocol: String,
/// It is true if the candidate has been deleted/freed. For host candidates, this means that any
/// network resources (typically a socket) associated with the candidate have been released. For
/// TURN candidates, this means the TURN allocation is no longer active.
///
/// Only defined for local candidates. For remote candidates, this property is not applicable.
pub deleted: bool,
}
impl Default for CandidateStats {
fn default() -> Self {
Self {
timestamp: Instant::now(),
id: String::new(),
network_type: NetworkType::default(),
ip: String::new(),
port: 0,
candidate_type: CandidateType::default(),
priority: 0,
url: String::new(),
relay_protocol: String::new(),
deleted: false,
}
}
}
impl AgentInternal {
/// Returns a list of candidate pair stats.
pub(crate) async fn get_candidate_pairs_stats(&self) -> Vec<CandidatePairStats> {
let checklist = self.agent_conn.checklist.lock().await;
let mut res = Vec::with_capacity(checklist.len());
for cp in &*checklist {
let stat = CandidatePairStats {
timestamp: Instant::now(),
local_candidate_id: cp.local.id(),
remote_candidate_id: cp.remote.id(),
state: cp.state.load(Ordering::SeqCst).into(),
nominated: cp.nominated.load(Ordering::SeqCst),
..CandidatePairStats::default()
};
res.push(stat);
}
res
}
/// Returns a list of local candidates stats.
pub(crate) async fn get_local_candidates_stats(&self) -> Vec<CandidateStats> {
let local_candidates = self.local_candidates.lock().await;
let mut res = Vec::with_capacity(local_candidates.len());
for (network_type, local_candidates) in &*local_candidates {
for c in local_candidates {
let stat = CandidateStats {
timestamp: Instant::now(),
id: c.id(),
network_type: *network_type,
ip: c.address(),
port: c.port(),
candidate_type: c.candidate_type(),
priority: c.priority(),
// URL string
relay_protocol: "udp".to_owned(),
// Deleted bool
..CandidateStats::default()
};
res.push(stat);
}
}
res
}
/// Returns a list of remote candidates stats.
pub(crate) async fn get_remote_candidates_stats(&self) -> Vec<CandidateStats> {
let remote_candidates = self.remote_candidates.lock().await;
let mut res = Vec::with_capacity(remote_candidates.len());
for (network_type, remote_candidates) in &*remote_candidates {
for c in remote_candidates {
let stat = CandidateStats {
timestamp: Instant::now(),
id: c.id(),
network_type: *network_type,
ip: c.address(),
port: c.port(),
candidate_type: c.candidate_type(),
priority: c.priority(),
// URL string
relay_protocol: "udp".to_owned(),
// Deleted bool
..CandidateStats::default()
};
res.push(stat);
}
}
res
}
}
File diff suppressed because it is too large. Load diff
+246
View File
@@ -0,0 +1,246 @@
use std::io;
use std::sync::atomic::{AtomicBool, Ordering};
use arc_swap::ArcSwapOption;
use async_trait::async_trait;
use util::Conn;
use super::*;
use crate::error::*;
impl Agent {
/// Connects to the remote agent, acting as the controlling ice agent.
/// The method blocks until at least one ice candidate pair has successfully connected.
///
/// The operation will be cancelled if `cancel_rx` either receives a message or its channel
/// closes.
pub async fn dial(
&self,
mut cancel_rx: mpsc::Receiver<()>,
remote_ufrag: String,
remote_pwd: String,
) -> Result<Arc<impl Conn>> {
let (on_connected_rx, agent_conn) = {
self.internal
.start_connectivity_checks(true, remote_ufrag, remote_pwd)
.await?;
let mut on_connected_rx = self.internal.on_connected_rx.lock().await;
(
on_connected_rx.take(),
Arc::clone(&self.internal.agent_conn),
)
};
if let Some(mut on_connected_rx) = on_connected_rx {
// block until pair selected
tokio::select! {
_ = on_connected_rx.recv() => {},
_ = cancel_rx.recv() => {
return Err(Error::ErrCanceledByCaller);
}
}
}
Ok(agent_conn)
}
/// Connects to the remote agent, acting as the controlled ice agent.
/// The method blocks until at least one ice candidate pair has successfully connected.
///
/// The operation will be cancelled if `cancel_rx` either receives a message or its channel
/// closes.
pub async fn accept(
&self,
mut cancel_rx: mpsc::Receiver<()>,
remote_ufrag: String,
remote_pwd: String,
) -> Result<Arc<impl Conn>> {
let (on_connected_rx, agent_conn) = {
self.internal
.start_connectivity_checks(false, remote_ufrag, remote_pwd)
.await?;
let mut on_connected_rx = self.internal.on_connected_rx.lock().await;
(
on_connected_rx.take(),
Arc::clone(&self.internal.agent_conn),
)
};
if let Some(mut on_connected_rx) = on_connected_rx {
// block until pair selected
tokio::select! {
_ = on_connected_rx.recv() => {},
_ = cancel_rx.recv() => {
return Err(Error::ErrCanceledByCaller);
}
}
}
Ok(agent_conn)
}
}
pub(crate) struct AgentConn {
pub(crate) selected_pair: ArcSwapOption<CandidatePair>,
pub(crate) checklist: Mutex<Vec<Arc<CandidatePair>>>,
pub(crate) buffer: Buffer,
pub(crate) bytes_received: AtomicUsize,
pub(crate) bytes_sent: AtomicUsize,
pub(crate) done: AtomicBool,
}
impl AgentConn {
pub(crate) fn new() -> Self {
Self {
selected_pair: ArcSwapOption::empty(),
checklist: Mutex::new(vec![]),
// Make sure the buffer doesn't grow indefinitely.
// NOTE: We actually won't get anywhere close to this limit.
// SRTP will constantly read from the endpoint and drop packets if it's full.
buffer: Buffer::new(0, MAX_BUFFER_SIZE),
bytes_received: AtomicUsize::new(0),
bytes_sent: AtomicUsize::new(0),
done: AtomicBool::new(false),
}
}
pub(crate) fn get_selected_pair(&self) -> Option<Arc<CandidatePair>> {
self.selected_pair.load().clone()
}
pub(crate) async fn get_best_available_candidate_pair(&self) -> Option<Arc<CandidatePair>> {
let mut best: Option<&Arc<CandidatePair>> = None;
let checklist = self.checklist.lock().await;
for p in &*checklist {
if p.state.load(Ordering::SeqCst) == CandidatePairState::Failed as u8 {
continue;
}
if let Some(b) = &mut best {
if b.priority() < p.priority() {
*b = p;
}
} else {
best = Some(p);
}
}
best.cloned()
}
pub(crate) async fn get_best_valid_candidate_pair(&self) -> Option<Arc<CandidatePair>> {
let mut best: Option<&Arc<CandidatePair>> = None;
let checklist = self.checklist.lock().await;
for p in &*checklist {
if p.state.load(Ordering::SeqCst) != CandidatePairState::Succeeded as u8 {
continue;
}
if let Some(b) = &mut best {
if b.priority() < p.priority() {
*b = p;
}
} else {
best = Some(p);
}
}
best.cloned()
}
/// Returns the number of bytes sent.
pub fn bytes_sent(&self) -> usize {
self.bytes_sent.load(Ordering::SeqCst)
}
/// Returns the number of bytes received.
pub fn bytes_received(&self) -> usize {
self.bytes_received.load(Ordering::SeqCst)
}
}
#[async_trait]
impl Conn for AgentConn {
async fn connect(&self, _addr: SocketAddr) -> std::result::Result<(), util::Error> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
async fn recv(&self, buf: &mut [u8]) -> std::result::Result<usize, util::Error> {
if self.done.load(Ordering::SeqCst) {
return Err(io::Error::new(io::ErrorKind::Other, "Conn is closed").into());
}
let n = match self.buffer.read(buf, None).await {
Ok(n) => n,
Err(err) => return Err(io::Error::new(io::ErrorKind::Other, err.to_string()).into()),
};
self.bytes_received.fetch_add(n, Ordering::SeqCst);
Ok(n)
}
async fn recv_from(
&self,
buf: &mut [u8],
) -> std::result::Result<(usize, SocketAddr), util::Error> {
if let Some(raddr) = self.remote_addr() {
let n = self.recv(buf).await?;
Ok((n, raddr))
} else {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
}
async fn send(&self, buf: &[u8]) -> std::result::Result<usize, util::Error> {
if self.done.load(Ordering::SeqCst) {
return Err(io::Error::new(io::ErrorKind::Other, "Conn is closed").into());
}
if is_message(buf) {
return Err(util::Error::Other("ErrIceWriteStunMessage".into()));
}
let result = if let Some(pair) = self.get_selected_pair() {
pair.write(buf).await
} else if let Some(pair) = self.get_best_available_candidate_pair().await {
pair.write(buf).await
} else {
Ok(0)
};
match result {
Ok(n) => {
self.bytes_sent.fetch_add(buf.len(), Ordering::SeqCst);
Ok(n)
}
Err(err) => Err(io::Error::new(io::ErrorKind::Other, err.to_string()).into()),
}
}
async fn send_to(
&self,
_buf: &[u8],
_target: SocketAddr,
) -> std::result::Result<usize, util::Error> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
fn local_addr(&self) -> std::result::Result<SocketAddr, util::Error> {
if let Some(pair) = self.get_selected_pair() {
Ok(pair.local.addr())
} else {
Err(io::Error::new(io::ErrorKind::AddrNotAvailable, "Addr Not Available").into())
}
}
fn remote_addr(&self) -> Option<SocketAddr> {
self.get_selected_pair().map(|pair| pair.remote.addr())
}
async fn close(&self) -> std::result::Result<(), util::Error> {
Ok(())
}
}
Loaded 100 of 178 files, more files were not shown because too many files have changed in this diff. Show more