Compare commits

..
115 Commits
Author SHA1 Message Date
VallierDevandClaude Opus 5.5 482c01a85d viewer tests: accept the video track RPC in the loopback session
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:45:43 +08:00
VallierDevandClaude Opus 5.5 7f6cf6e092 Release v0.2.39
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:39:58 +08:00
VallierDevandClaude Opus 5.5 c0c04a2c98 viewer: request the desktop video track like the official viewer (#124)
The official iPhone viewer sends RpcRequest case 15 SendVideoTrackReq (no
fields) right after CONTROL opens. Without it a second session only joins the
stream already encoded for another viewer: no SPS/PPS/IDR, so it stays black.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:37:43 +08:00
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
VallierDevandClaude Opus 5.5 89abae2369 Release v0.2.19: headless Wayland, custom bitrate, show and login fixes
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 16:34:37 +08:00
VallierDevandClaude Opus 5.5 0afc602e66 Login polling backoff and a hint for instantly expiring QR codes (#68); bitrate unit safeguard; doctor wording
- Never spin on immediate unchanged status answers or transport errors (2 s backoff); repeated
  QR codes that expire within seconds back off exponentially and point to re-registering the
  device identity, which recovered a flagged device in #68.
- Custom bitrate field 8 is bit/s (#67); values that can only be Mbit/s or kbit/s are scaled
  instead of capping the encoder at 1 kbit/s.
- doctor: without DISPLAY the X11 engine still tries :0/:1, so the #66 warning says that.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 16:29:57 +08:00
ZoranandJuanZoran 762cfccc44 Custom video bitrate is bits per second (#67)
Co-authored-by: JuanZoran <[email protected]>
2026-10-20 16:28:56 +08:00
axlrose 9520b69730 doctor: say so when the session has no screen to capture (#66)
Without DISPLAY and without WAYLAND_DISPLAY the desktop backend cannot
capture anything: the host logs 'Desktop unavailable ... x11_init failed'.
The report named X11 as the selected backend and nothing else, which reads
like a working setup. Name the missing display and note that the terminal,
file transfer and port mapping tools still work.
2026-10-20 16:28:51 +08:00
axlrose c45e4749b5 Wayland: a failed output-power handshake must not block screencopy (#65)
Output power management is optional: the engine comment already says so, but
uu_wl_wake() only tolerated a *missing* power manager. When the compositor
offers zwlr_output_power_manager_v1 and then refuses the mode (headless
outputs, outputs without DPMS), power_failed is set and the function
reported an error. capture::keep_display_awake() propagates that error and
video.rs aborts the whole capture task with '?', so a client could connect
but never received a frame.

Treat a failed power handshake like a missing one: skip waking the screen
and keep streaming.
2026-10-20 16:28:46 +08:00
VallierDevandClaude Opus 5.5 c1b8bfe1b3 show: report a skipped or crash-looping service instead of waiting 30 s (#62); document FFmpeg 6.x for inproc-av (#63)
systemctl start returns 0 when the unit is skipped by a Condition or keeps crashing under
Restart=; show now reads ActiveState/SubState/ConditionResult while waiting and names the real
problem. ffmpeg-sys-next's build script runs before ours, so FFmpeg >= 7 cannot be caught in
build.rs; the README and AGENTS state the 6.x requirement next to the build commands.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 15:24:33 +08:00
VallierDevandClaude Opus 5.5 03d2311649 Release v0.2.18: Debian packages, experimental WOL helper
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:48:13 +08:00
VallierDevandClaude Opus 5.5 5949314e55 Experimental WOL helper (UU_WOL_HELPER=1); doctor keeps logs quiet
Mirrors the official Windows host (GameViewerServer reportLanInfo / PushMessageHandler::wakeOnLan /
send_wol): report the LAN identity after sign-in and answer wake_on_lan pushes with a magic packet
to the target's subnet broadcast. Field names come from the official log strings; off by default
and unverified end to end. wake_on_lan push key names are always logged for evidence.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:43:13 +08:00
VallierDevandClaude Opus 5.5 8389fc4eed Debian package: binaries, engine plugins, systemd user unit, menu entries
Built and install-tested in the release workflow (and CI) with dependencies taken from the
binaries by dpkg-shlibdeps. The unit starts with graphical-session.target; uinput access stays
opt-in (the udev rule ships under /usr/share/doc).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:38:39 +08:00
VallierDevandClaude Opus 5.5 b8de665593 Release v0.2.17: doctor diagnostic report
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:34:06 +08:00
VallierDevandClaude Opus 5.5 554cbe806a doctor: one paste-safe diagnostic report for issues
Session, selected backend (and the X11-inside-Wayland trap), engine plugin load results, uinput
and render-node access, FFmpeg encoders/version, the default codec, sign-in and service state.
Prints booleans, names and versions only; home directory and user name are masked. The issue
template and READMEs ask for it.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:30:01 +08:00
VallierDevandClaude Opus 5.5 a91f0024d3 Release v0.2.16: KDE idle inhibition, lock hints (#60, #61)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:16:15 +08:00
VallierDevandClaude Opus 5.5 68ad9759bd KDE idle inhibition during remote sessions; lock and X11-in-Wayland hints (#61)
- KDE portal sessions hold an org.freedesktop.ScreenSaver inhibitor while a desktop connection
  is active (GNOME keeps SessionManager.Inhibit), so the idle timeout no longer locks mid-session.
- Log a hint when the desktop locks: viewers only see black frames until it is unlocked.
- Warn when the X11 backend is selected while a Wayland session is running (XWayland root
  capture is all black without any error).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 12:12:28 +08:00
Jeff Zhangandferstar 169edf2224 inproc: pad odd native captures to even for the in-process encoder (#60)
The in-process encoder opened its context at the raw capture size, so an
odd logical desktop (e.g. two stacked 150% monitors, 2560x2507) made every
H.264/HEVC/NVENC encoder fail to open. The encoder size is now rounded up to
even, and a native capture is copied into a zeroed frame of that size so the
extra row/column stays black. Scaled output paths are unchanged.

Co-authored-by: ferstar <[email protected]>
2026-10-20 07:23:54 +08:00
VallierDevandClaude Opus 5.5 9994279b29 Release v0.2.15: aarch64 package, H.264 default on CPU hosts (#58, #59)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 01:33:23 +08:00
VallierDevandClaude Opus 5.5 6733a117a2 CPU hosts default to H.264; aarch64 release package (#59)
libx265 is about ten times slower than libx264 (15 vs 155 fps at 1080p on a 4-core Ampere A1),
so without NVENC/VAAPI the host now picks H.264 even when both sides offer H.265;
UU_VIDEO_CODEC=h265 still forces it. The release workflow builds x86_64 and aarch64 packages
(each with both engine plugins) and publishes them from a single job.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 01:28:38 +08:00
Delicious233andCodex e3cab32c75 ci: build and test on linux/arm64 (#58)
Co-authored-by: Codex <[email protected]>
2026-10-20 01:28:17 +08:00
VallierDevandClaude Opus 5.5 57e1a5d07c Release v0.2.14: Hyprland output-bound pointer and monitor switching (#57)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-20 00:33:59 +08:00
ZoranandJuanZoran d90b4bccde Hyprland: bind absolute pointer to the captured output; opt-in monitor switching (#57)
Co-authored-by: JuanZoran <[email protected]>
2026-10-20 00:33:31 +08:00
VallierDevandClaude Opus 5.5 fa7fe733a6 Release v0.2.13: Wayland and portal engines in the release package
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-19 22:13:27 +08:00
VallierDevandClaude Opus 5.5 65c04e796a One release package for every desktop: Wayland and portal engines as runtime plugins
The release tarball was X11 only, so Hyprland/niri and GNOME/KDE Wayland users had to build from
source (#43, #54). With --features engine-plugins the wayland and portal engines are built as
libuu-wayland.so / libuu-portal.so and dlopen'ed only when the session selects them, so X11 hosts
need none of their libraries. The wayland plugin is built on Ubuntu 22.04 with the main binary;
the portal plugin needs libei >= 1.1 and is built on 24.04 (glibc >= 2.39). Source builds without
engine-plugins keep linking the engines statically.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-19 22:10:11 +08:00
VallierDevandClaude Opus 5.5 3480318089 portal: say how to get a picture when the build lacks portal support (#43)
Release packages are X11 only; on GNOME/KDE Wayland auto selection picks the
portal backend, which then failed every 5 s with the opaque "portal
unavailable (code 2)".

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-19 19:44:13 +08:00
VallierDevandClaude Opus 5.5 949acaac30 docs: niri row, non-template unit name, uinput dedicated-group example (#55)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-19 16:23:52 +08:00
VallierDevandClaude Opus 5.5 22fb6783a0 Release v0.2.12: pad odd capture sizes (#53)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-19 14:57:29 +08:00
wen0531andwen0531 10166c66e0 video: pad odd captured frame dimensions to even (#53)
The portal backend reports the compositor's logical desktop size, which is
odd when a scaled monitor's logical extent is odd: two stacked monitors at
150% scale capture 2560x2507. H.264/HEVC 4:2:0 encoders (and NVENC's surface
allocation) reject odd dimensions, so with such a desktop every encoder
failed to open:

  [libx264] height not divisible by 2 (2560x2507)
  [h264_nvenc] InitializeEncoder failed: out of memory (10)
  ERROR Live desktop stream stopped: Encoder output ended

and the official viewer stayed on 正在传输画面 while input still worked.

Pad the odd row/column in the filter chain when the native capture size is
known and no output scaling was requested (a no-op case omitted for even
sizes). The host display mode, the reported capture size and the explicit
分辨率 scaling path are unchanged; the fixed-input probe keeps its chain.

Co-authored-by: wen0531 <[email protected]>
2026-10-19 14:57:02 +08:00
VallierDevandClaude Opus 5.5 b7f9f2aa68 Release v0.2.11: wlroots text_input (#51), proxy bypass by default (#52)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-19 10:26:55 +08:00
aresbit 6416f75b7f auth: bypass ambient proxies by default; UU_USE_PROXY=1 opts in (#52)
A local HTTP/SOCKS proxy that intercepts TLS caused login to fail with
"tls handshake eof". Build all cloud API clients with no_proxy() unless
UU_USE_PROXY is explicitly truthy, so direct connections are the default
and environments that genuinely need a proxy can still enable it.
2026-10-19 10:25:58 +08:00
70cb5ad57e Wayland/wlroots: type mobile IME text through the virtual keyboard's spare keycodes (#51)
The mobile clients' input method sends `text_input {content}` over CONTROL. Upstream only
implements it for X11, so a Wayland host (Hyprland here) dropped the characters with a
warning. Wire it up: characters the session keymap already produces are pressed as
ordinary keycodes, and characters it cannot produce are carried by spare keycodes (the
keymap has ~33 named but unmapped ones) declared for the duration of one batch, in text
order, then removed again.

The focused client translates keycodes with the keymap the compositor last handed it, and
a keymap uploaded to a keyboard the seat already has is never handed on again: measured on
Hyprland 0.56.2, pressing the remapped keycodes then reproduces the previous message's
text (a space came out as the previous message's first character, and every message
repeated the one before it). Re-attaching the virtual keyboard is what makes the
compositor send the keymap to the client, so each batch does that, waits for the
compositor to install the keymap, and releases held keys first because the new keyboard
starts with none. No timing sleep is needed once the keyboard is re-attached, so there is
none. Plain latin text and spaces never touch the keymap at all. The pristine keymap is
restored after every call, so uu_wl_key keeps its own symbol map and the compositor is
never left with spare keys bound.

`wayland-text-probe` reports how many characters one upload can carry and types a sample;
UU_PROBE_SEQUENCE types one message per |-separated field, the way the phone's input
method sends them, which is what reproduced this locally.

Co-authored-by: Hey Claw <[email protected]>
Co-authored-by: Claude Code <[email protected]>
2026-10-18 21:07:23 +08:00
VallierDevandClaude Opus 5.5 7fcc674440 Release v0.2.10: official device_capability shape and sender_para_info (#49)
The iPhone client ignored our flat forward_setting device_capability and kept
quality and chroma locked. Send it nested under data.device_capability with
type beside it, list the formats the encoder really produces (4:4:4 when
available), and add sender_para_info, as the official Windows host does.
Verified with the UU iPhone app 4.42.0.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 20:54:34 +08:00
VallierDevandClaude Opus 5.5 19d0563781 desktop: viewer launcher entry and window icon; explicit StartupWMClass (#13)
The viewer's GTK windows had no icon and no desktop entry, so docks showed a
generic icon next to the host's. Add uu-remote-linux-viewer.desktop and use the
host icon for viewer windows.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 17:25:14 +08:00
VallierDevandClaude Opus 5.5 edd4c9250c Release v0.2.9: HEVC picture-boundary AUs (#48), VAAPI buffer (#47)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 16:33:33 +08:00
ca49232674 HEVC: split access units by picture boundaries; no -aud for hevc_vaapi (#48)
* HEVC: split access units by picture boundaries, and stop passing -aud to hevc_vaapi

hevc_vaapi with `-aud 1` writes an AUD only at IRAPs and drops every other picture from
the bitstream: a 90-frame 640x360 clip came out as 3 IDRs and no P-frames. The reader
splits access units on AUDs, so each "frame" became one IDR plus a whole GOP, and the
IRAP gate then rejected all of them - the H.265 path sent no video at all (measured
~12 kbit/s outbound against 4-6 Mbit/s for H.264).

HEVC now leaves AUD off and hevc_au_offsets() splits on RFC 7798 picture boundaries (an
AUD, or the first NAL after a VCL NAL that is non-VCL or starts a picture), which also
keeps multi-slice pictures in one unit and covers the libx265/NVENC shapes. Parameter
sets still repeat in-band ahead of every IDR, so no out-of-band sprop is needed.

The fixed-input probe hardcoded H.264 in three places (settings, output muxer, first-unit
check), which is why this path was never measurable; it now follows UU_VIDEO_CODEC.

Verified with desktop-video-probe (90-frame fixed input): hevc_vaapi and libx265 both
emit 90 frames, first unit an IRAP with its parameter sets.

Assisted-by: DeepSeek V4.1 Flash-1017

* HEVC: keep suffix SEI, filler and end markers with the preceding picture

RFC 7798 / H.265 7.4.2.4.4 lets only AUD, VPS/SPS/PPS, prefix SEI and types
41-44/48-55 open an access unit; trailing NALs stay with the picture. Verified on
an RTX 3090 with the fixed-input probe: hevc_nvenc and libx265 both yield 90/90
decodable units with an IRAP first.

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-18 16:32:35 +08:00
NuoFang cb8253febf VAAPI: opt-in UU_VAAPI_BUFFER_MS for the VBV buffer (#47)
The 100-500 kbit default keeps NVENC keyframes inside the buffer, but VAAPI quantizes a
whole desktop keyframe when the buffer is that small: on a 2560x1440 H.264 VAAPI stream
capped at 30 Mbit/s the first IDR measured 59,910 bytes and the picture blurred once per
GOP before sharpening back.

UU_VAAPI_BUFFER_MS (10-1000 ms, VAAPI only) sizes the buffer as bitrate x ms/1000. With
250 ms on the same input the first IDR measured 142,397 bytes and the worst-frame Y-SSIM
over 180 static frames went from 0.9492 to 0.9933, with no rise in average bitrate.

Opt-in: unset, out of range or unparsable keeps the old buffer.

Assisted-by: DeepSeek V4.1 Flash-1017
2026-10-18 15:31:00 +08:00
VallierDevandClaude Opus 5.5 696cf10e33 docs: NAS Docker deployment guide; link it and the ghcr image from the READMEs
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 11:52:36 +08:00
VallierDevandClaude Opus 5.5 a9433b73be Release v0.2.8: NAS Docker image
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 11:44:44 +08:00
VallierDevandClaude Opus 5.5 c9e5fec175 docker: headless NAS container (Synology); publish ghcr image on release
docker/Dockerfile installs the release binary on Ubuntu 24.04 with the X11/GTK runtime
libs, headless (UU_DESKTOP_BACKEND=none), config in /config, data in /data. Verified
on Synology DSM 7.3: file transfer (sha256 round trip), terminal and port mapping
to the DSM web UI. Release workflow now pushes ghcr.io/vallierdev/uu-remote-linux.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 11:43:58 +08:00
VallierDevandClaude Opus 5.5 380a08e293 docs: v0.2.7 notes — mobile text_input verified with a phone
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 09:54:53 +08:00
VallierDevandClaude Opus 5.5 63ebb3e78a Release v0.2.7: mobile text_input (#13, #46); platform-aware viewer clipboard
Host: accept the official text_input {content} action on any channel and type it on
X11 via spare-keycode Unicode keysyms (verified with xev); log non-CONTROL JSON
action names. Viewer: Windows-type hosts get only the case-10 text change (a rich
format list overwrote it and was never rendered), Mac gets only the rich offer.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 09:41:56 +08:00
jo32 e4a2cc4698 contrib: macOS SSH companion for Finder file paste uploads (#45)
* Add macOS SSH companion for Finder file paste uploads

* Show measured upload progress in Ghostty title and progress bar
2026-10-18 08:50:45 +08:00
VallierDevandClaude Opus 5.5 8fb57b421d Release v0.2.6: input diagnostics (#46), Mac terminal fix
Log unsupported CONTROL input actions (names only) and the server NumLock
state for numpad keys; skip the SDL window test on macOS (main-thread SDL).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 07:26:26 +08:00
VallierDevandClaude Opus 5.5 72c1e6101f docs: introduce the experimental viewer in the README title and intro (#44)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 01:23:46 +08:00
VallierDevandClaude Opus 5.5 a67731052f docs: show the viewer screenshot first; fix the host screenshot caption
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 00:04:58 +08:00
VallierDevandClaude Opus 5.5 e6089bfb46 docs: add the viewer launcher screenshot (device names redacted)
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-18 00:02:25 +08:00
VallierDevandClaude Opus 5.5 aa2a341d15 docs: refresh the host main window screenshot
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 23:50:44 +08:00
VallierDevandClaude Opus 5.5 9622bf4c1e fix(viewer): accept terminal RPC answers on the terminal channel
The official Mac host answers check_env on the BINARY terminal channel next
to TERM frames; the viewer parsed it as a TERM frame and closed. Verified
live: Mac host terminal opens and echoes input.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 23:30:13 +08:00
VallierDevandClaude Opus 5.5 d7e52a098b Release v0.2.5
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 23:15:28 +08:00
VallierDevandClaude Opus 5.5 94ff1f1c02 fix(viewer): exchange text clipboard with the official Mac host
The Mac host offers pasteboard text as format 0 "public.utf8-plain-text"
(UTF-8), not CF_UNICODETEXT, so the viewer never requested it. Accept and
request that format, and offer it next to CF_UNICODETEXT from the viewer.
Host-side offers to official clients are unchanged. Mac -> viewer verified
live; viewer -> Mac not yet. Adds format-name/echo diagnostics (no data).

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 23:14:13 +08:00
VallierDevandClaude Opus 5.5 aafc17e626 fix(ui): keep GTK windows on the light Adwaita theme (#43)
The CSS hard-codes a light palette; under a dark system theme unstyled
labels became white on white.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 22:45:34 +08:00
VallierDevandClaude Opus 5.5 cd6df7f03f fix(viewer): pick -fps_mode or -vsync by probing ffmpeg; Release v0.2.4
FFmpeg 9 removed -vsync, so v0.2.2/v0.2.3 decoders exited at start and every
frame failed. Verified against the official Mac host on FFmpeg 9.0.2.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 22:38:33 +08:00
VallierDevandClaude Opus 5.5 2815a01569 feat(viewer): remove a device from the account (unbind)
POST /api/v1/device/{id}/unbind, the path the official Windows host and Mac
viewer use for 「删除设备」. Verified live on a disposable test device; the
shared-device path (/api/v1/device/share/{id}/unbind) comes from strings only.
CLI: uuremote-viewer unbind DEVICE [--shared]; launcher: 更多工具 → 删除设备
with a confirmation dialog.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-17 22:26:14 +08:00
229 changed files with 37343 additions and 1132 deletions

No files matched your search

+6 -4
View File
@@ -32,11 +32,12 @@ body:
attributes:
label: 诊断信息 / Diagnostics
description: |
先复现一次问题,然后在被控的 Linux 上运行下面的命令,把输出粘贴到这里(IP 会被自动抹掉,不包含密码、令牌或剪贴板内容)。
Reproduce the problem, then run this on the Linux host and paste the output (IPs are masked; no passwords, tokens or clipboard data).
先复现一次问题,然后在被控 Linux 的**图形桌面里打开的终端**中运行下面的命令(SSH 或 tty 里缺少桌面环境变量,doctor 结果不准),把输出粘贴到这里(IPv4/IPv6/MAC 地址会被自动抹掉,不包含密码、令牌或剪贴板内容)。
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
{
echo "== doctor (v0.2.17+)"; uuremote-server doctor
echo "== 系统"; grep PRETTY_NAME /etc/os-release; uname -rm
echo "== 桌面"; echo "session=$XDG_SESSION_TYPE desktop=$XDG_CURRENT_DESKTOP"
echo "== 显示器"; xrandr --listmonitors 2>/dev/null
@@ -44,8 +45,9 @@ body:
echo "== 显卡"; lspci 2>/dev/null | grep -iE 'vga|3d'
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 \
| grep -E 'Starting|backend|Selected capture|Desktop encoder|Capture setting request|Desktop video settings|Offer for connection|WARN|ERROR' | tail -n 80
} 2>&1 | sed -E 's/[0-9]{1,3}(\.[0-9]{1,3}){3}/x.x.x.x/g'
| 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' \
| 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
validations:
+74 -3
View File
@@ -6,6 +6,16 @@ on:
pull_request:
jobs:
test-macos-ssh-paste:
runs-on: macos-latest
steps:
- uses: actions/checkout@v4
- run: python3 -m unittest discover -s contrib/macos-ssh -p 'test_*.py' -v
- name: Test file-URL clipboard reader on a private pasteboard
run: |
swiftc -O contrib/macos-ssh/clipboard-files.swift -o "$RUNNER_TEMP/clipboard-files"
"$RUNNER_TEMP/clipboard-files" --self-test
test:
runs-on: ubuntu-22.04
steps:
@@ -14,10 +24,40 @@ jobs:
run: |
sudo apt-get update
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 \
libwayland-dev libwayland-bin libxkbcommon-dev
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- run: cargo test --locked
# Same as the release job: the wayland plugin is built on 22.04; libei is unavailable here, so
# the portal plugin is skipped with a warning (release builds it on 24.04).
- name: Release feature set
run: |
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
test -f target/debug/libuu-wayland.so
- name: Debian package installs
run: |
packaging/deb/build-deb.sh 0.0.0~ci target/debug /tmp/deb
dpkg-deb -I /tmp/deb/*.deb | grep -E 'Depends|Recommends'
sudo apt-get install -y /tmp/deb/*.deb
uuremote-server --help | head -1
test -f /usr/lib/uu-remote-linux/libuu-wayland.so
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:
runs-on: ubuntu-22.04
@@ -46,6 +86,12 @@ jobs:
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- run: cargo test --locked --features wayland,portal
# Release layout: engines as runtime-loaded plugins; uuremote-server must not link them.
- name: Engine plugins
run: |
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
for lib in libuu-wayland.so libuu-portal.so; do test -f "target/debug/$lib"; done
! readelf -d target/debug/uuremote-server | grep NEEDED | grep -E 'libei|libpipewire|libwayland-client|libxkbcommon'
- name: Native portal and EIS regression tests (ASan/UBSan)
env:
ASAN_OPTIONS: detect_leaks=1
@@ -63,12 +109,37 @@ jobs:
runs-on: ubuntu-24.04
steps:
- 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: |
sudo apt-get update
sudo apt-get install -y build-essential pkg-config \
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: Swatinem/rust-cache@v2
- run: cargo test --locked --features inproc-av
test-linux-arm64:
# aarch64 hosts (Ampere A1, arm64 VMs, Apple-silicon VMs) build from source, so keep that
# build honest on a native arm64 runner instead of letting it rot between releases.
runs-on: ubuntu-24.04-arm
steps:
- uses: actions/checkout@v4
- name: Install build dependencies
run: |
sudo apt-get update
sudo apt-get install -y build-essential pkg-config \
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
libwayland-dev libwayland-bin libxkbcommon-dev libglib2.0-dev libpipewire-0.3-dev libei-dev
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- run: cargo test --locked
- name: Release binary
run: |
cargo build --locked --release --bin uuremote-server
file target/release/uuremote-server
# The aarch64 release package ships both engine plugins.
- name: Release feature set
run: |
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
for lib in libuu-wayland.so libuu-portal.so; do test -f "target/debug/$lib"; done
+93 -8
View File
@@ -6,34 +6,119 @@ on:
permissions:
contents: write
packages: write
jobs:
release:
# Built on 22.04 so the binary also runs on Ubuntu 22.04/24.04 and newer Debian (glibc >= 2.35).
runs-on: ubuntu-22.04
# GNOME/KDE Wayland engine: libei >= 1.1 first ships in Ubuntu 24.04, so this plugin needs
# glibc >= 2.39. It is only loaded on portal sessions; X11 and wlroots hosts never open it.
portal-plugin:
strategy:
matrix:
include:
- { arch: x86_64, runner: ubuntu-24.04 }
- { arch: aarch64, runner: ubuntu-24.04-arm }
runs-on: ${{ matrix.runner }}
steps:
- uses: actions/checkout@v4
- name: Install build dependencies
run: |
sudo apt-get update
sudo apt-get install -y build-essential pkg-config \
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev libsdl2-dev
libx11-dev libxext-dev libxtst-dev libxfixes-dev libglib2.0-dev libpipewire-0.3-dev libei-dev
- uses: dtolnay/rust-toolchain@stable
- run: UU_NO_GTK=1 cargo build --release --locked --features portal,engine-plugins --bin uuremote-server
- uses: actions/upload-artifact@v4
with:
name: libuu-portal-${{ matrix.arch }}
path: target/release/libuu-portal.so
build:
needs: portal-plugin
strategy:
matrix:
include:
- { arch: x86_64, runner: ubuntu-22.04 }
- { arch: aarch64, runner: ubuntu-22.04-arm }
# Built on 22.04 so the binary also runs on Ubuntu 22.04/24.04 and newer Debian (glibc >= 2.35).
runs-on: ${{ matrix.runner }}
steps:
- uses: actions/checkout@v4
- name: Install build dependencies
run: |
sudo apt-get update
sudo apt-get install -y build-essential pkg-config \
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev libsdl2-dev \
libwayland-dev libwayland-bin libxkbcommon-dev
- uses: dtolnay/rust-toolchain@stable
- run: cargo test --release --locked
- run: cargo build --release --locked
# Experimental viewer; built after the host so uuremote-server keeps the default features.
# One package for every desktop: Wayland (wlroots) and GNOME/KDE portal engines are plugins
# opened at runtime (engine-plugins), so X11 hosts need none of their libraries.
- run: cargo build --release --locked --features wayland,portal,engine-plugins
- uses: actions/download-artifact@v4
with:
name: libuu-portal-${{ matrix.arch }}
path: target/release
# Experimental viewer; built after the host so uuremote-server keeps the release features.
- run: cargo build --release --locked --features native-viewer,viewer-sdl --bin uuremote-viewer
- name: Package
run: |
name=uu-remote-linux-${GITHUB_REF_NAME}-x86_64-linux
name=uu-remote-linux-${GITHUB_REF_NAME}-${{ matrix.arch }}-linux
mkdir -p "$name"
cp target/release/uuremote-server target/release/uuremote-viewer LICENSE README.md README.en.md config.example.json "$name/"
cp target/release/uuremote-server target/release/uuremote-viewer target/release/libuu-wayland.so target/release/libuu-portal.so \
packaging/tarball/install.sh LICENSE README.md README.en.md config.example.json "$name/"
cp -r contrib "$name/"
tar czf "$name.tar.gz" "$name"
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
- name: Debian package
run: |
packaging/deb/build-deb.sh "${GITHUB_REF_NAME#v}" target/release .
deb=$(ls uu-remote-linux_*.deb)
sha256sum "$deb" > "$deb.sha256"
sudo apt-get install -y "./$deb"
uuremote-server --help | head -1
systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service
- uses: actions/upload-artifact@v4
with:
name: package-${{ matrix.arch }}
path: |
uu-remote-linux-*.tar.gz*
uu-remote-linux_*.deb*
# One publisher, so the matrix legs never race to create the release.
release:
needs: build
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
pattern: package-*
merge-multiple: true
- uses: softprops/action-gh-release@v2
with:
body_path: docs/release-notes/${{ github.ref_name }}.md
files: |
uu-remote-linux-*.tar.gz
uu-remote-linux-*.tar.gz.sha256
uu-remote-linux_*.deb
uu-remote-linux_*.deb.sha256
# Headless NAS image (docker/), built from the release tarball published by the job above.
docker:
needs: release
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- uses: docker/build-push-action@v6
with:
context: docker
build-args: VERSION=${{ github.ref_name }}
push: true
tags: |
ghcr.io/vallierdev/uu-remote-linux:${{ github.ref_name }}
ghcr.io/vallierdev/uu-remote-linux:latest
+51 -22
View File
@@ -38,8 +38,13 @@ Dependencies (Ubuntu/Debian):
```sh
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
# --features inproc-av: libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev
# (FFmpeg 6.x; in-process capture/encoding, Ubuntu 24.04 ships it)
# --features inproc-av: X11 in-process capture + native NVENC/VAAPI. NVENC headers are vendored and
# libcuda/libnvidia-encode dlopen'ed at runtime (NVENC API 12.1, driver >= 530).
# 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,portal: + libglib2.0-dev libpipewire-0.3-dev libei-dev (libei >= 1.1)
```
@@ -68,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`
(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`.
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
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`
@@ -78,17 +86,21 @@ cargo build --release --features native-viewer,viewer-sdl --bin uuremote-viewer
[Unit]
Description=UU Remote Linux host (unofficial)
After=graphical-session.target
PartOf=graphical-session.target
[Service]
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
Restart=always
RestartSec=5
[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`.
5. `systemctl --user daemon-reload && systemctl --user enable --now uuremote-native.service`
6. Verify: `journalctl --user -u uuremote-native.service -f` must show
@@ -105,21 +117,28 @@ viewer does not reconnect them automatically.
| 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/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_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) |
| 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) |
| `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_CODEC=h264` | force H.264 even when the viewer negotiated H.265 (default: H.265 when both sides support it) |
| `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 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_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_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_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 |
Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. The config is re-read
every 60 s.
Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. `config.json` is parsed once
(`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
@@ -142,15 +161,16 @@ every 60 s.
| `src/initialization.rs`, `src/control_protocol.rs`, `src/protocol.rs` | protobuf encoders/decoders for CONTROL |
| `src/session_ice.rs`, `src/network_diagnostics.rs` | cloud ICE servers, address-free path diagnostics |
| `src/desktop_backend.rs`, `src/wayland.rs`, `src/portal*.rs` | backend selection, Hyprland, GNOME/KDE portal |
| `src/engine_plugin.rs` | `engine_ffi!`: engine C functions linked statically, or dlsym-resolved from runtime plugins with `engine-plugins` |
| `c_engine/portal_eis.inc` | scaled GNOME input through the existing Portal session's EIS connection; all input must use EIS once connected |
| `c_engine/x11_engine.c`, `c_engine/clipboard.c` | X11 capture/input/selection |
| `c_engine/wayland_engine.c`, `c_engine/portal_engine.c` | Wayland and portal engines |
| `src/assist.rs`, `c_engine/assist_window.c` | remote assistance (guest + account) and the unified GTK main window (assist + account/QR card) |
| `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, 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) |
Diagnostic subcommands: `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_INPUT` fixed video/image sequence, `UU_PROBE_LOOP=1` repeats), `wayland-input-probe`, `clipboard-acceptance`,
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),
`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`,
`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.
@@ -173,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).
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`
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
(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,
@@ -261,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
`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
`/dev/dri/renderD128` (render-node permissions required). No automatic VAAPI selection.
Both FFmpeg process and `--features inproc-av` upload NV12 frames to a VAAPI frame pool.
`UU_VIDEO_ENCODER=vaapi` or `set-encoder vaapi` selects Intel/AMD H.264 VAAPI explicitly.
`UU_VAAPI_DEVICE` defaults to `/dev/dri/renderD128` (render-node permissions required).
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,
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
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av`
VAAPI path are not hardware-verified.
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). The process pipeline on
AMD is not separately verified (AMD acceptance is the in-process engine above).
### Virtual audio / 虚拟声卡
@@ -311,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`
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
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
pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg.
Rolling Arch FFmpeg may be newer than supported `viewer-ffmpeg` (FFmpeg 6.x); build it against a separate
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).
### Experimental KMS / 实验后端
Generated
+6 -5
View File
@@ -2741,7 +2741,7 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
[[package]]
name = "uu-remote-linux"
version = "0.2.3"
version = "0.2.39"
dependencies = [
"async-trait",
"base64 0.22.1",
@@ -2758,12 +2758,14 @@ dependencies = [
"nix 0.29.0",
"qrcode",
"rand 0.8.8",
"rcgen",
"reqwest",
"sdl2",
"serde",
"serde_json",
"sha2",
"tokio",
"tokio-rustls",
"tokio-tungstenite",
"webrtc",
"x11rb",
@@ -3008,23 +3010,24 @@ dependencies = [
[[package]]
name = "webrtc-ice"
version = "0.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a1bbd6b3dea22cc6e961e22b012e843d8869e2ac8e76b96e54d4a25e311857ad"
dependencies = [
"arc-swap",
"async-trait",
"crc",
"log",
"rand 0.8.8",
"rustls-native-certs",
"serde",
"serde_json",
"stun",
"thiserror 1.0.69",
"tokio",
"tokio-rustls",
"turn",
"url",
"uuid",
"waitgroup",
"webpki-roots 1.0.9",
"webrtc-mdns",
"webrtc-util",
]
@@ -3075,8 +3078,6 @@ dependencies = [
[[package]]
name = "webrtc-srtp"
version = "0.12.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "383b0f0f73ee6cce396bdbc4d54ec661861a59eae9fc988914c1a8d82c5ac272"
dependencies = [
"aead",
"aes",
+20 -4
View File
@@ -1,6 +1,6 @@
[package]
name = "uu-remote-linux"
version = "0.2.3"
version = "0.2.39"
edition = "2021"
default-run = "uuremote-server"
authors = ["uu-remote-linux contributors"]
@@ -28,9 +28,11 @@ wayland = []
# Experimental direct linear framebuffer capture; never enabled in release builds.
kms = []
portal = []
# In-process capture and encoding through FFmpeg 6 libraries (libavcodec/libavdevice dev packages).
# Off by default so release binaries do not link the build machine's libav.
inproc-av = ["dep:ffmpeg-next", "dep:x11rb"]
# Build the wayland/portal engines as runtime-loaded libuu-wayland.so / libuu-portal.so (release packages).
engine-plugins = []
# In-process X11 capture and NVENC encoding: vendored NVENC headers, NVIDIA driver libraries loaded at runtime.
# Other encoders keep the FFmpeg process pipeline. Off by default.
inproc-av = ["dep:x11rb"]
[dependencies]
tokio = { version = "1", features = ["full"] }
@@ -58,10 +60,24 @@ x11rb = { version = "0.13", features = ["damage", "shm", "allow-unsafe-code"], o
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]
cc = "1.0"
[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" }
# Larger data-channel receive buffer (see vendor/webrtc/src/data_channel/mod.rs).
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"]
+194 -28
View File
@@ -1,4 +1,4 @@
# uu-remote-linux · Unofficial Linux host for NetEase UU Remote
# uu-remote-linux · Unofficial Linux host and viewer for NetEase UU Remote
[简体中文](README.md) | **English**
@@ -7,13 +7,21 @@
> NetEase UU Remote (网易 UU 远程) is a great remote-desktop tool, but there is no Linux version on its
> official website. So, with the help of Claude and Codex, I wrote this open-source Linux host: install it,
> and you can control your Linux machine from the official Mac / Windows / mobile UU Remote clients.
> It now also ships an **experimental Linux viewer**, `uuremote-viewer`, that controls official Windows / Mac hosts or this
> project's host from Linux (desktop, file transfer, terminal, port mapping, remote assistance; see
> [below](#experimental-native-viewer-uuremote-viewer)).
> Desktop-less **Synology / NAS** boxes can run it in Docker: [deployment guide](docs/deploy-nas-docker.md#english), image
> [`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux).
>
> This is a personal hobby project. **It is not affiliated with NetEase and is not an official client.**
> If NetEase considers this project infringing or inappropriate, please DM me on X
> **[@ai_fengshou](https://x.com/ai_fengshou)** and I will take it down right away.
<p align="center"><img src="docs/images/viewer-window.png" width="720" alt="Linux viewer launcher: device list (device names redacted)"></p>
<p align="center"><sub>Linux viewer: device list (device names redacted)</sub></p>
<p align="center"><img src="docs/images/main-window.png" width="620" alt="Host main window: remote assistance and account"></p>
<p align="center"><sub>The QR login window shown on first run (QR code blurred). The UI is in Chinese, like the official app.</sub></p>
<p align="center"><sub>Linux host main window: remote assistance and account (device ID, code and account redacted). The UI is in Chinese, like the official app.</sub></p>
<!-- Screenshot placeholder: the Linux desktop controlled from the official client. Take your own
screenshot, remove account/device details and NetEase logos, save it as docs/images/remote-desktop.png
@@ -37,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) |
| 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) |
| Clipboard | Two-way text sync |
| 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 |
| 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; 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 |
| File transfer | Upload, download (including folders), create folder, rename, delete |
| Terminal | The official "Terminal" tool, PTY sessions, multiple sessions, rename |
@@ -65,15 +73,19 @@ authorized session. Independent file/terminal tool peers do not reset input.
| Xfce | X11 | ✅ Tested in a VM | default |
| Cinnamon / MATE | X11 | ✅ Tested in a VM | default |
| Hyprland | Wayland (native wlroots protocols) | 🧪 Experimental, tested in a VM (some features limited, see below) | `--features wayland` |
| niri | Wayland (native wlroots protocols) | 🧪 Experimental; protocol support confirmed from niri sources, not yet tested on hardware (#55) | `--features wayland` |
| GNOME / KDE Plasma | Wayland (xdg-desktop-portal) | 🧪 Experimental; validation scope and limits below | `--features wayland,portal` |
The GNOME Wayland Portal/EIS path has been checked for video and mouse/keyboard input on Ubuntu 26.04, GNOME 50, with one 4K screen at 200% scale; auto unlock after a cold locked connection is verified with the official Mac and iPhone 4.42.0 viewers, while other lock recovery and reconnection still need hardware acceptance testing. Apart from that path and GNOME on X11, desktop testing has primarily used virtual machines. If something goes wrong on
real hardware, please [open an issue](../../issues) with your distribution, desktop, GPU and the relevant lines from
real hardware, please [open an issue](../../issues) with the output of `uuremote-server doctor` (v0.2.17+; session, backend,
plugins, permissions and encoders only, no account data, tokens or addresses) and the relevant lines from
`journalctl --user -u uuremote-native.service`.
Wayland limits: single screen, fixed resolution. 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.
**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.
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.
@@ -84,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.
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.
`UU_WAYLAND_DMABUF=1` explicitly tries dma-buf → GBM CPU mapping (off by default;
@@ -94,12 +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;
`UU_VIDEO_ENCODER=vaapi` still uploads CPU frames through FFmpeg.
### 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.
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%.
## Not implemented / not supported
| Feature | Status |
|---|---|
| Switching between multiple monitors | In progress |
| 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 |
| 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; `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 |
| Super screen / virtual display | Not implemented |
| Privacy screen on the host | Not implemented |
@@ -111,6 +133,44 @@ mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI
## Installation
### 0. Prebuilt release package (recommended, x86_64 / aarch64)
**Ubuntu / Debian (v0.2.18+)**: download `uu-remote-linux_<version>_amd64.deb` (ARM64: `arm64`), then:
```sh
sudo apt install ./uu-remote-linux_<version>_amd64.deb
uuremote-server login # scan the QR code with the UU Remote app
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, 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.
**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
cd uu-remote-linux-<version>-x86_64-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
running session at startup, and the matching `libuu-*.so` is loaded only on Wayland, so X11 hosts need no Wayland libraries.
| Session | Requirements |
|---|---|
| X11 | glibc >= 2.35 (Ubuntu 22.04, Debian 12 and newer) |
| wlroots (Hyprland / Sway / niri) | the same, plus `libwayland-client` and `libxkbcommon` (present on Wayland desktops) |
| GNOME / KDE Wayland | glibc >= 2.39 (Ubuntu 24.04, Fedora 40, Debian 13 and newer), libei >= 1.1 and PipeWire |
Plugins are found next to `uuremote-server`, in `../lib/uu-remote-linux/`, `~/.local/lib/uu-remote-linux/` or
`/usr/lib/uu-remote-linux/` (`UU_ENGINE_DIR` overrides); a missing library or too old glibc is reported in the log.
Continue with step 3 (login). Other architectures: build from source below.
### 1. Dependencies (Ubuntu / Debian)
```sh
@@ -121,6 +181,8 @@ sudo apt install build-essential pkg-config \
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
# optional: GNOME/KDE portal backend
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>).
@@ -136,6 +198,9 @@ cargo build --release --features wayland # + Hyprland
cargo build --release --features wayland,portal # + GNOME/KDE on Wayland
```
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).
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.
### 3. Log in
Run inside your graphical session:
@@ -147,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
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
`~/.config/systemd/user/uuremote-native.service`:
@@ -155,17 +224,17 @@ machine, in `~/.config/uuremote/config.json` (mode 0600).
[Unit]
Description=UU Remote Linux host (unofficial)
After=graphical-session.target
PartOf=graphical-session.target
[Service]
Environment=RUST_LOG=info
# X11 desktops need the display; on GNOME, XAUTHORITY is usually /run/user/<uid>/gdm/Xauthority
Environment=DISPLAY=:0
# GNOME/KDE import DISPLAY / WAYLAND_DISPLAY into the user manager and start graphical-session.target
ExecStart=%h/.local/bin/uuremote-server
Restart=always
RestartSec=5
[Install]
WantedBy=default.target
WantedBy=graphical-session.target
```
```sh
@@ -177,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.
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)
On Wayland (especially GNOME/KDE via the portal) the default input path needs portal consent and some keyboard layouts
@@ -217,6 +290,7 @@ Optional launcher icon:
```sh
install -Dm644 contrib/desktop/uu-remote-linux.svg ~/.local/share/icons/hicolor/scalable/apps/uu-remote-linux.svg
install -Dm644 contrib/desktop/uu-remote-linux.desktop ~/.local/share/applications/uu-remote-linux.desktop
install -Dm644 contrib/desktop/uu-remote-linux-viewer.desktop ~/.local/share/applications/uu-remote-linux-viewer.desktop
```
Verified with the official Mac viewer: guest connections, wrong-code rejection, code rotation, switching assistance off,
@@ -226,10 +300,21 @@ the same account cannot assist each other, an official restriction).
## Servers without a monitor
**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.
Log in once with `uuremote-server login --no-gui` (QR in the terminal).
**Synology / NAS (Docker)**: run headless mode in a container on a desktop-less NAS (file transfer, terminal, port
mapping): image [`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux),
see the [NAS deployment guide](docs/deploy-nas-docker.md#english). Verified on Synology DSM 7.3 (x86_64).
**Paste files from a Mac terminal**: when using Ghostty over UU's SSH port mapping,
the optional [Mac SSH paste companion](contrib/macos-ssh/README.md) uploads files
copied in Finder before inserting their remote paths. Text and mouse reports pass
through. Ghostty's title and progress bar show upload progress, transferred size,
speed and elapsed time. It does not change the official UU terminal; folders, drag-and-drop and
raw screenshot clipboard data are not supported.
**Virtual desktop**: for a full remote desktop, run a desktop session (Xfce recommended) on an Xvfb screen:
```sh
@@ -258,18 +343,56 @@ Common environment variables:
|---|---|
| `UU_CONFIG` | Config file path (default `~/.config/uuremote/config.json`) |
| `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_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_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_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_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_ASSIST_ALLOW=1` | Allow remote assistance at start (overrides the saved switch) |
| `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_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` | 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
`~/.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.
With external FFmpeg CPU encoding, the bitrate presets (Original / Ultra / HD / custom) use average bitrate (ABR) to avoid gray keyframes at 4K and low bitrates; Auto keeps constant rate factor (CRF).
@@ -328,24 +451,51 @@ Released under the [GPL-3.0](LICENSE): you may use, modify and redistribute it,
### H.265 / HEVC
When both sides support H.265 the host uses it (as the official host does: the host picks the codec from both
When both sides support H.265 and the host has a hardware encoder (NVENC / explicit VAAPI), the host uses it (as the official host does: the host picks the codec from both
capability lists; the official Mac viewer lists H265 first in its SDP). The first desktop connection probes a
synthetic frame and announces encoder support with CodecNegotiation. `hevc_nvenc`, `libx265` and explicit
`UU_VIDEO_ENCODER=vaapi` (`hevc_vaapi`); hardware failure falls back to software HEVC, then to H.264.
`UU_VIDEO_CODEC=h264` forces H.264. 8-bit; true color 4:4:4 uses hevc_nvenc `rext` / libx265 `main444-8`.
Verified with the official Mac viewer on an RTX 3090 (hevc_nvenc, including 4:4:4); libx265, hevc_vaapi and
other viewers are not hardware-verified.
Verified with the official Mac viewer on an RTX 3090 (hevc_nvenc, including 4:4:4) and with the official Android
viewer on Intel Alder Lake-P (iHD): 2560x1440 fully hardware-encoded, 58 fps decoded at about 10 ms. libx265 is
still not verified against a real viewer.
With CPU-only encoding the default is H.264: libx265 is about ten times slower than libx264 (measured ~15 vs ~155 fps
at 1080p on a 4-core ARM host, #59); `UU_VIDEO_CODEC=h265` forces H.265. The applied frame rate comes from the viewer's
quality/fps menu; `UU_DISPLAY_FPS` only changes the reported display refresh rate.
### VAAPI (opt-in / 显式启用)
HEVC access units are split on RFC 7798 picture boundaries instead of AUDs: `hevc_vaapi` with `-aud 1` writes an
AUD only at IRAPs and drops every other picture from the bitstream, so an AUD-based reader turns a whole GOP into
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.
`UU_VIDEO_ENCODER=vaapi` selects Intel/AMD H.264 VAAPI; `UU_VAAPI_DEVICE` defaults to
`/dev/dri/renderD128` (render-node permissions required). No automatic VAAPI selection.
Both FFmpeg process and `--features inproc-av` upload NV12 frames to a VAAPI frame pool.
### VAAPI
`UU_VIDEO_ENCODER=vaapi` or `set-encoder vaapi` selects Intel/AMD H.264 VAAPI explicitly.
`UU_VAAPI_DEVICE` defaults to `/dev/dri/renderD128` (render-node permissions required).
`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,
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
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av`
VAAPI path are not hardware-verified.
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264 — a figure from the
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
H.264 VAAPI stream capped at 30 Mbit/s the first IDR measured 59,910 bytes and the picture blurred at
every GOP before sharpening back. `UU_VAAPI_BUFFER_MS=250` (buffer = bitrate cap x ms/1000) restored that
first IDR to 142,397 bytes and raised the worst-frame Y-SSIM from 0.9492 to 0.9933 without raising the
average bitrate. Off by default; unset or out of the 10-1000 ms range keeps the old buffer. Larger
keyframes can queue briefly on a weak link, so start at 250 ms.
### Virtual audio / 虚拟声卡
@@ -380,18 +530,21 @@ Omarchy uses Hyprland: run in its user session, select `UU_DESKTOP_BACKEND=wayla
and retain `WAYLAND_DISPLAY` / `XDG_RUNTIME_DIR`. This requires wlr-screencopy and the
virtual input protocols supported by Hyprland; other compositors may need `--features wayland,portal`.
For uinput, load `uinput` (at boot: `echo uinput | sudo tee /etc/modules-load.d/uinput.conf`) and apply the uaccess rule above; seat ACLs require an active login.
For unattended accounts, explicitly restrict `/dev/uinput` access to a dedicated group.
For unattended accounts, explicitly restrict `/dev/uinput` access to a dedicated group, e.g. `z /dev/uinput 0660 root uinput`
in `/etc/tmpfiles.d/uinput.conf` plus `sudo usermod -aG uinput <user>` (dedicated account only).
This permission can inject into the whole seat, including lock/greeter screens.
`UU_INPUT_BACKEND=uinput` requests kernel devices; verify startup actually reports uinput.
In Hyprland / uwsm sessions `default.target` may start before the compositor exports `WAYLAND_DISPLAY`;
tie the unit to the graphical session instead (community-verified autostart on Omarchy):
`After=` and `PartOf=graphical-session.target`, `ConditionEnvironment=WAYLAND_DISPLAY`,
`Environment=UU_DESKTOP_BACKEND=wayland` (no `DISPLAY`), and `WantedBy=graphical-session.target`.
Keep the unit name `uuremote-native.service` (not a template `[email protected]`): the desktop icon and
`uuremote-server show` always start that name (override with `UU_SERVICE_UNIT`). `niri --session` also imports
`WAYLAND_DISPLAY` before it is ready, so the same unit applies to niri (#55).
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
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
pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg.
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).
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
### Experimental KMS / 实验后端
@@ -427,8 +580,21 @@ GNOME-to-official-Mac bidirectional clipboard synchronization is still unverifie
machine with the same identity**; other devices are fine.
- `uuremote-viewer ui`: launcher listing your devices: desktop, view-only, files, terminal, port mapping, reboot/shutdown, assistance.
- 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`,
`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`.
- **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,
`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.
+156 -28
View File
@@ -1,4 +1,4 @@
# uu-remote-linux · UU 远程 Linux 被控端(非官方)
# uu-remote-linux · UU 远程 Linux 被控端 + 控制端(非官方)
**简体中文** | [English](README.en.md)
@@ -6,12 +6,18 @@
>
> 网易 UU 远程非常好用,但官网一直没有 Linux 版本。于是我借助 Claude 和 Codex,写了这个开源的 Linux 被控端:
> 装上之后,就能用官方的 Mac / Windows / 手机客户端远程控制你的 Linux 电脑。
> 现在还附带一个**实验性 Linux 控制端** `uuremote-viewer`:在 Linux 上用 UU 账号远控官方 Windows / Mac 被控端或本项目主机
> (桌面、文件传输、终端、端口映射、远程协助,详见[下文](#实验性原生控制端uuremote-viewer))。
> 没有桌面的**群晖 / NAS** 也能用 Docker 部署:[部署指南](docs/deploy-nas-docker.md),镜像 [`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux)。
>
> 这是个人兴趣项目,**与网易无关,也不是官方客户端**。如果网易认为本项目侵权或有不妥,
> 请在推特私信我 **[@ai_fengshou](https://x.com/ai_fengshou)**,我会第一时间自行下架。
<p align="center"><img src="docs/images/viewer-window.png" width="720" alt="Linux 控制端启动窗口:设备列表(设备名已打码)"></p>
<p align="center"><sub>Linux 控制端:设备列表(设备名已打码)</sub></p>
<p align="center"><img src="docs/images/main-window.png" width="620" alt="Linux 主机主窗口:远程协助与账号"></p>
<p align="center"><sub>首次运行时弹出的扫码登录窗口(二维码已打码)</sub></p>
<p align="center"><sub>Linux 被控端主窗口:远程协助与账号(设备 ID、验证码和账号已打码)</sub></p>
<!-- 截图占位:在官方客户端里远控 Linux 桌面的效果图。请自行截图并去掉账号、设备名等信息后放到
docs/images/remote-desktop.png,再取消下面这行的注释。注意不要截入网易的图标和品牌素材。 -->
@@ -33,8 +39,8 @@
| 鼠标 / 键盘 | 绝对/相对移动、点击、滚轮、按键;修复了网络延迟导致的按键连发;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) |
| 鼠标指针样式 | 远端指针形状实时同步(X11) |
| 剪贴板 | 双向文本同步 |
| 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;「其他分辨率」由编码器缩放,不改动主机显示器 |
| 剪贴板 | 双向文本同步;Wayland 手机输入法输入通过剪贴板兜底粘贴,见下文 |
| 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;X11 下切换分辨率会像官方 Windows 被控端一样真正修改桌面分辨率(xrandr,缺少该模式时自动添加;选「原始」或断开后恢复),`UU_DESKTOP_RESIZE=0` 改为仅由编码器缩放;Wayland 仍由编码器缩放 |
| 声音 | 采集系统声音(PulseAudio / PipeWire),Opus 编码传到控制端 |
| 文件传输 | 上传、下载(含文件夹)、新建文件夹、重命名、删除 |
| 终端 | 官方「终端」工具,PTY 会话,支持多会话和重命名 |
@@ -59,12 +65,17 @@ Portal 仅作用于本服务获授权的会话。文件传输、终端等独立
| Xfce | X11 | ✅ 虚拟机测试通过 | 默认 |
| Cinnamon / MATE | X11 | ✅ 虚拟机测试通过 | 默认 |
| Hyprland | Wayland(wlroots 原生协议) | 🧪 实验性,虚拟机测试(部分功能受限,见下) | `--features wayland` |
| niri | Wayland(wlroots 原生协议) | 🧪 实验性,协议支持已按 niri 源码确认,尚未实机验收(#55) | `--features wayland` |
| GNOME / KDE Plasma | Wayland(xdg-desktop-portal) | 🧪 实验性,验证范围与限制见下 | `--features wayland,portal` |
GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/200% 缩放下验证画面和键鼠;锁屏冷连接自动解锁已用 Mac 和 iPhone 4.42.0 客户端实机验证,其余锁屏恢复及重连仍待验收。除 GNOME 的上述路径和 X11 外,其余桌面目前主要在虚拟机里测试。如果你在真机上遇到问题,欢迎[提交 issue](../../issues),
请附上发行版、桌面环境、显卡型号和 `journalctl --user -u uuremote-native.service` 里的相关日志。
最后一列是源码编译方式;Release 预编译包已包含全部后端,直接使用即可(见[安装](#0-直接用-release-预编译包推荐x86_64))。
Wayland 下的限制:只支持单屏、固定分辨率;Hyprland 原生后端默认使用双缓冲流水线 shm screencopy,控制端帧率设置会同步到采集节拍和编码器,但实际帧率仍受合成器、渲染和读回速度限制(旧串行路径在 2560x1600 曾测得约 16~22 帧;流水线只在虚拟机里测量过,不代表实机保证);portal 后端暂不支持动态分辨率;GNOME 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。
GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/200% 缩放下验证画面和键鼠;锁屏冷连接自动解锁已用 Mac 和 iPhone 4.42.0 客户端实机验证,其余锁屏恢复及重连仍待验收。除 GNOME 的上述路径和 X11 外,其余桌面目前主要在虚拟机里测试。如果你在真机上遇到问题,欢迎[提交 issue](../../issues),
请附上 `uuremote-server doctor` 的输出(v0.2.17 起;只含会话、后端、插件、权限、编码器等状态,不含账号、令牌或地址,可直接粘贴)和 `journalctl --user -u uuremote-native.service` 里的相关日志。
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 逻辑尺寸仅用于本地输入映射。
@@ -76,17 +87,27 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
锁屏黑帧使用 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 的绝对鼠标定位默认绑定正在采集的输出,修复双屏桌面下的点击偏移。uinput 可继续用于键盘、按键和相对移动。
设置 `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%)双屏切换及点击。
## 尚未实现 / 不支持
| 功能 | 状态 |
|---|---|
| 多显示器切换 | 开发中 |
| 真彩(4:4:4) | 支持(v0.1.15):NVENC / libx264 的默认 FFmpeg 管线输出 H.264 High 4:4:4;VAAPI 和 `inproc-av` 管线仍为 4:2:0,并如实回报给客户端 |
| 多显示器切换 | Hyprland 原生 Wayland 后端与 X11(`UU_X11_MULTISCREEN=1`)实验性支持,见上文 |
| 真彩(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 | 未实现 |
| 超级屏 / 虚拟显示器 | 未实现 |
| 被控端防窥模式 | 未实现 |
@@ -98,6 +119,42 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
## 安装
### 0. 直接用 Release 预编译包(推荐,x86_64 / aarch64)
**Ubuntu / Debian(v0.2.18 起)**:下载 `uu-remote-linux_<版本>_amd64.deb`(ARM64 选 `arm64`)后:
```sh
sudo apt install ./uu-remote-linux_<版本>_amd64.deb
uuremote-server login # 用 UU 远程 App 扫码
systemctl --user enable --now uuremote-native.service # 随图形会话启动
```
deb 会安装程序、插件、用户级 systemd 服务和应用菜单图标,并通过依赖自动装上 FFmpeg;uinput 权限不会自动开启(见第 5 步)。
GNOME / KDE 会把显示环境自动传给服务;Xfce 等不传的桌面需按第 4 步补 `DISPLAY`。
**其他发行版**:从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后用普通桌面用户(不要 root)运行:
```sh
cd uu-remote-linux-<版本>-x86_64-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 会话里
才加载对应的 `libuu-*.so`,X11 用户不需要任何 Wayland 库。系统要求:
| 会话 | 要求 |
|---|---|
| X11 | glibc ≥ 2.35(Ubuntu 22.04、Debian 12 及更新) |
| Hyprland / Sway / niri 等 wlroots | 同上,另需 `libwayland-client`、`libxkbcommon`(Wayland 桌面自带) |
| GNOME / KDE Wayland | glibc ≥ 2.39(Ubuntu 24.04、Fedora 40、Debian 13 及更新),以及 libei ≥ 1.1、PipeWire |
插件放在 `uuremote-server` 同目录、`../lib/uu-remote-linux/`、`~/.local/lib/uu-remote-linux/` 或 `/usr/lib/uu-remote-linux/` 都能找到
(`UU_ENGINE_DIR` 可指定)。缺库或版本太旧时日志会写明原因。之后从第 3 步「登录」继续;其他架构请按下面源码编译。
### 1. 依赖(Ubuntu / Debian)
```sh
@@ -108,6 +165,8 @@ sudo apt install build-essential pkg-config \
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
# 可选:GNOME/KDE portal 后端
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>)。
@@ -122,6 +181,9 @@ cargo build --release --features wayland # + Hyprland
cargo build --release --features wayland,portal # + GNOME/KDE Wayland
```
控制端的 `viewer-ffmpeg` 只支持 **FFmpeg 6.x**(`pkg-config --modversion libavcodec` 为 60.x);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. 登录
在图形桌面里运行:
@@ -133,6 +195,10 @@ cargo build --release --features wayland,portal # + GNOME/KDE Wayland
用手机上的 **网易 UU 远程 App** 扫码并确认即可。登录信息只保存在本机的
`~/.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. 作为用户服务常驻
`~/.config/systemd/user/uuremote-native.service`:
@@ -141,17 +207,17 @@ cargo build --release --features wayland,portal # + GNOME/KDE Wayland
[Unit]
Description=UU Remote Linux host (unofficial)
After=graphical-session.target
PartOf=graphical-session.target
[Service]
Environment=RUST_LOG=info
# X11 桌面需要指明显示器;GNOME 的 XAUTHORITY 一般在 /run/user/<uid>/gdm/Xauthority
Environment=DISPLAY=:0
# GNOME/KDE 等桌面会把 DISPLAY / WAYLAND_DISPLAY 导入用户管理器,并启动 graphical-session.target
ExecStart=%h/.local/bin/uuremote-server
Restart=always
RestartSec=5
[Install]
WantedBy=default.target
WantedBy=graphical-session.target
```
```sh
@@ -163,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 虚拟键鼠(推荐)
Wayland(尤其是 GNOME/KDE portal)下,默认的键鼠注入要经过 portal 授权,部分键盘布局下还会丢符号(比如下划线)。
@@ -193,6 +262,7 @@ X11 默认继续用 XTest,因为它能正确处理网络延迟下按住不放
```sh
install -Dm644 contrib/desktop/uu-remote-linux.svg ~/.local/share/icons/hicolor/scalable/apps/uu-remote-linux.svg
install -Dm644 contrib/desktop/uu-remote-linux.desktop ~/.local/share/applications/uu-remote-linux.desktop
install -Dm644 contrib/desktop/uu-remote-linux-viewer.desktop ~/.local/share/applications/uu-remote-linux-viewer.desktop
```
验证情况:访客身份下的连接、错误验证码拒绝、用完换码、关闭后不可连接、登录与退出登录的切换,已用官方 Mac 客户端实测通过。
@@ -201,9 +271,19 @@ install -Dm644 contrib/desktop/uu-remote-linux.desktop ~/.local/share/applicatio
## 没有显示器的服务器
**无头模式**:只要终端、文件传输和端口映射,不需要图形界面。在服务里加 `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` 在终端里扫码。
**群晖 / NAS(Docker)**:没有桌面的 NAS 可以用容器运行无头模式(文件传输、终端、端口映射)。
镜像 [`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux),
**部署步骤见 [群晖 / NAS 部署指南](docs/deploy-nas-docker.md)**。已在群晖 DSM 7.3(x86_64)上实测三项功能。
**Mac 终端粘贴文件**:使用 Ghostty 通过 UU 端口映射连接 SSH 时,可安装
[Mac SSH 粘贴助手](contrib/macos-ssh/README.md)。在 Finder 复制文件后按 Command-V,
助手先通过同一个 SSH 别名上传文件,再插入服务器路径;普通文本和鼠标报告正常透传。
Ghostty 标题栏和进度条显示上传进度、已传大小、速度和耗时。
这是可选的 Mac 端工具,不会改变官方 UU 内置终端;暂不支持文件夹、拖放或原始截图剪贴板。
**虚拟桌面**:需要完整的远程桌面时,用 Xvfb 创建一块虚拟屏幕,再在上面跑一个桌面环境(推荐 Xfce):
```sh
@@ -231,17 +311,35 @@ systemctl --user restart uuremote-native.service
|---|---|
| `UU_CONFIG` | 配置文件路径(默认 `~/.config/uuremote/config.json`) |
| `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_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_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_NVENC_BUFFER_MS` | NVENC 的 VBV 缓冲(10–1000 ms,仅 NVENC 生效,含进程内引擎);默认 100–500 kbit,1440p 等高分辨率下关键帧被压糊、按 GOP 周期闪烁时设 `1000`(#103) |
| `UU_FFMPEG_ROOT` | 使用指定目录下的 FFmpeg |
| `UU_AUDIO=0` | 关闭声音转发;`UU_AUDIO_SOURCE` 指定 PulseAudio 采集源 |
| `UU_LOGIN_WINDOW=0` | 凭证缺失时不自动弹出登录窗口 |
| `UU_REMOTE_ASSIST=0` | 关闭远程协助(未登录时也不再以访客身份提供协助) |
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
| `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) |
| `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 的编码上限。
选择码率档(原画 / 超清 / 高清 / 自定义)时,外部 FFmpeg 的 CPU 编码以平均码率(ABR)为目标,避免 4K 低码率下关键帧发灰;「自动」档仍使用恒定质量(CRF)。
@@ -293,19 +391,32 @@ flowchart LR
### H.265 / HEVC
控制端和主机都支持 H.265 时,主机自动使用 H.265(与官方主机一致,由主机按双方能力选择;官方 Mac 客户端在 SDP
中优先列出 H.265)。首次桌面连接会用合成帧探测实际编码能力,并通过 CodecNegotiation 告知客户端。支持 `hevc_nvenc`、
控制端和主机都支持 H.265、且主机使用硬件编码器(NVENC / 显式 VAAPI)时,主机自动使用 H.265(与官方主机一致,由主机按双方能力选择;官方 Mac 客户端在 SDP
中优先列出 H.265)。**只有 CPU 编码时默认用 H.264**:libx265 比 libx264 慢约 10 倍(4 核 ARM 上 1080p 实测约 15 帧对 155 帧,#59),
可用 `UU_VIDEO_CODEC=h265` 强制 H.265。实际帧率由控制端的「画质/帧率」菜单决定;`UU_DISPLAY_FPS` 只改上报的显示器刷新率。首次桌面连接会用合成帧探测实际编码能力,并通过 CodecNegotiation 告知客户端。支持 `hevc_nvenc`、
`libx265`、显式 `UU_VIDEO_ENCODER=vaapi` 的 `hevc_vaapi`;硬件失败先回落软件 HEVC,再回落 H.264。
`UU_VIDEO_CODEC=h264` 强制使用 H.264。8-bit;真彩 4:4:4 使用 hevc_nvenc `rext` / libx265 `main444-8`。
已用官方 Mac 客户端在 RTX 3090(hevc_nvenc,含 4:4:4)实机验收;libx265、hevc_vaapi 及其他客户端尚未实机验证。
已用官方 Mac 客户端在 RTX 3090(hevc_nvenc,含 4:4:4)实机验收;`hevc_vaapi` 配官方 Android 客户端也已实机验收
(Intel Alder Lake-P / iHD,2560×1440 全程硬件编码,客户端 58 fps 解码、约 10 ms 延迟);`libx265` 仍未经控制端验收。
### VAAPI 硬件编码(显式启用)
HEVC 的访问单元按 RFC 7798 的图片边界切分,不依赖 AUD:`hevc_vaapi` 带 `-aud 1` 时只在 IRAP 处写 AUD,并把其余
画面从码流里丢掉,读取端按 AUD 切分就会把整个 GOP 当成一帧,再被 IRAP 门控全部拒绝——对外表现为连接停在
「正在传输画面」,而主机侧只有约 12 kbit/s。`UU_VIDEO_CODEC=h265` 可显式选中 H.265,便于对照排查。
设置 `UU_VIDEO_ENCODER=vaapi` 使用 Intel/AMD H.264 VAAPI;`UU_VAAPI_DEVICE` 默认
`/dev/dri/renderD128`,运行用户需要 render 节点权限。不会自动选择 VAAPI;设备或驱动初始化
失败会明确警告并回退 libx264。外部 FFmpeg 和 `--features inproc-av` 均先转 NV12 再上传硬件帧。
### VAAPI 硬件编码
`UU_VIDEO_ENCODER=vaapi` 或 `set-encoder vaapi` 显式选择 Intel/AMD H.264 VAAPI。
`UU_VAAPI_DEVICE` 默认 `/dev/dri/renderD128`,运行用户需要 render 节点权限。
`auto` 有 NVIDIA 驱动时是 NVENC → CPU,没有 NVIDIA 时是 CPU。VAAPI 只通过显式选择启用,进入 auto 要等 #33。
设备或驱动初始化失败会明确警告并回退 libx264。外部 FFmpeg 先转 NV12 再上传硬件帧。
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
上限、静止画面上实测首个 IDR 只有 59,910 字节,画面每隔一个 GOP 糊一下再慢慢恢复。设
`UU_VAAPI_BUFFER_MS=250`(按 `码率上限 × 毫秒 / 1000` 放大 VBV)后首个 IDR 为 142,397 字节,
最低帧 Y-SSIM 从 0.9492 升到 0.9933,平均码率没有上升。默认不启用,未设置或超出 10–1000 ms
仍用原缓冲;代价是关键帧变大,弱网下可能出现瞬时排队,建议从 250 ms 试起。
### 静音运行与虚拟声卡
@@ -335,7 +446,8 @@ cargo build --release --features wayland
Omarchy 使用 Hyprland:在其用户会话中运行,设置 `UU_DESKTOP_BACKEND=wayland`,保留
`WAYLAND_DISPLAY` 和 `XDG_RUNTIME_DIR`。其他合成器可能需要 `--features wayland,portal`。
uinput 需加载内核模块(开机自动加载:`echo uinput | sudo tee /etc/modules-load.d/uinput.conf`)并应用上文 uaccess 规则;无人登录账号需要专用组的受限授权。
uinput 需加载内核模块(开机自动加载:`echo uinput | sudo tee /etc/modules-load.d/uinput.conf`)并应用上文 uaccess 规则;无人登录账号需要专用组的受限授权,
例如 `/etc/tmpfiles.d/uinput.conf` 写入 `z /dev/uinput 0660 root uinput`,再 `sudo usermod -aG uinput <用户>`(只加专用账号)。
该权限能向整个 seat(包括锁屏/登录界面)注入输入。设置 `UU_INPUT_BACKEND=uinput` 后,
仍须确认启动日志实际选择了 uinput。
@@ -356,11 +468,14 @@ Environment=UU_DESKTOP_BACKEND=wayland
WantedBy=graphical-session.target
```
单元名请保持 `uuremote-native.service`,不要写成模板单元 `[email protected]`:桌面图标和 `uuremote-server show`
固定启动这个名字(`UU_SERVICE_UNIT` 可覆盖),systemd 不会把它解析到模板实例。niri 的 `niri --session` 同样会在就绪前导入
`WAYLAND_DISPLAY`,上面的写法也适用(#55)。
VAAPI 可选包:Intel 新显卡用 `intel-media-driver`,AMD 用 `libva-mesa-driver`,`libva-utils` 提供
`vainfo`。KMS 依赖 `libdrm`。虚拟 Xfce 依赖 `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`。
滚动 Arch 的 FFmpeg 可能超出 `inproc-av` 支持的 6.x;请使用默认进程方案或独立的 FFmpeg 6 前缀,
不要降级系统 FFmpeg。
若编译包含 `viewer-ffmpeg`,滚动 Arch 的 FFmpeg 可能超出其支持的 6.x;请使用独立的 FFmpeg 6 前缀,不要降级系统 FFmpeg(服务端的 `--features inproc-av` 原生 NVENC 不依赖 FFmpeg)。
### 实验性 KMS 截屏
@@ -390,8 +505,21 @@ GNOME 与官方 Mac 被控端的双向剪贴板尚未验证通过;此修改不
`~/.config/uuremote/config.json`(可用 `UU_CONFIG` 另指定),因此**不能用同一身份连接本机上的主机**;控制其他设备不受影响。
- `uuremote-viewer ui`:启动窗口,列出账号下的设备,可进入桌面、只看模式、文件传输、终端、端口映射、重启/关机、远程协助。
- 命令行:`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`、
`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` 查看全部参数。
- **安全输入 `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` 关闭剪贴板,
`UU_VIEWER_VIEW_ONLY=1` 只看不控,`UU_VIEWER_FFMPEG` 指定 ffmpeg 路径。
- 桌面同时提供 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);
}
}
}
}
+68 -9
View File
@@ -1,6 +1,10 @@
fn main() {
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/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/assist_window.c");
println!("cargo:rerun-if-changed=c_engine/viewer_window.c");
@@ -21,11 +25,27 @@ fn main() {
build.compile("uu_kms_engine");
println!("cargo:rustc-link-lib=drm");
}
cc::Build::new()
.file("c_engine/x11_engine.c")
let mut x11_build = cc::Build::new();
x11_build.file("c_engine/x11_engine.c")
.file("c_engine/clipboard.c")
.file("c_engine/pam_check.c")
.compile("x11_engine");
.file("c_engine/pam_check.c");
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=Xext");
@@ -50,7 +70,15 @@ fn main() {
}
None => println!("cargo:warning=gtk+-3.0 not found: building without the login window"),
}
if std::env::var_os("CARGO_FEATURE_PORTAL").is_some() {
let plugins = std::env::var_os("CARGO_FEATURE_ENGINE_PLUGINS").is_some();
if plugins && std::env::var_os("CARGO_FEATURE_PORTAL").is_some() {
// Runtime-loaded libuu-portal.so; skipped (with a warning) where libei >= 1.1 is unavailable.
for file in ["portal_engine.c", "portal_engine.h", "portal_eis.inc", "desktop_power.c"] { println!("cargo:rerun-if-changed=c_engine/{file}"); }
match pkg_config(&["gio-2.0", "gio-unix-2.0", "libpipewire-0.3", "libei-1.0 >= 1.1"]) {
Some((cflags, libs)) => shared_engine("libuu-portal.so", &["c_engine/portal_engine.c", "c_engine/desktop_power.c"], &[], &cflags, &libs),
None => println!("cargo:warning=GIO/PipeWire/libei >= 1.1 not found: libuu-portal.so not built"),
}
} else if std::env::var_os("CARGO_FEATURE_PORTAL").is_some() {
println!("cargo:rerun-if-changed=c_engine/portal_engine.c");
println!("cargo:rerun-if-changed=c_engine/portal_engine.h");
println!("cargo:rerun-if-changed=c_engine/portal_eis.inc");
@@ -76,6 +104,7 @@ fn main() {
let mut build = cc::Build::new();
build.flag_if_supported("-Wno-unused-parameter"); // protocol listener signatures
build.file("c_engine/wayland_engine.c").include(&out);
let mut sources = vec!["c_engine/wayland_engine.c".to_owned()];
for name in ["wlr-screencopy-unstable-v1", "wlr-virtual-pointer-unstable-v1", "virtual-keyboard-unstable-v1", "wlr-output-power-management-unstable-v1", "linux-dmabuf-unstable-v1"] {
let xml = format!("c_engine/wayland-protocols/{name}.xml");
println!("cargo:rerun-if-changed={xml}");
@@ -84,13 +113,43 @@ fn main() {
let status = std::process::Command::new("wayland-scanner").args([mode, &xml]).arg(&target).status()
.expect("Install wayland-scanner to build the Wayland backend");
assert!(status.success(), "wayland-scanner failed");
if mode == "private-code" { build.file(target); }
if mode == "private-code" { sources.push(target.to_string_lossy().into_owned()); build.file(target); }
}
}
println!("cargo:rerun-if-changed=c_engine/wayland_engine.c");
build.compile("uu_wayland_engine");
println!("cargo:rustc-link-lib=wayland-client");
println!("cargo:rustc-link-lib=xkbcommon");
if plugins {
let sources: Vec<&str> = sources.iter().map(String::as_str).collect();
match pkg_config(&["wayland-client", "xkbcommon"]) {
Some((cflags, libs)) => shared_engine("libuu-wayland.so", &sources, &[out.as_path()], &cflags, &libs),
None => println!("cargo:warning=wayland-client/xkbcommon not found: libuu-wayland.so not built"),
}
} else {
build.compile("uu_wayland_engine");
println!("cargo:rustc-link-lib=wayland-client");
println!("cargo:rustc-link-lib=xkbcommon");
}
}
}
}
/// `pkg-config --cflags` / `--libs` for `packages`, or None when any is missing.
fn pkg_config(packages: &[&str]) -> Option<(String, String)> {
let run = |kind: &str| std::process::Command::new("pkg-config").arg(kind).args(packages).output().ok()
.filter(|o| o.status.success()).map(|o| String::from_utf8_lossy(&o.stdout).into_owned());
run("--cflags").zip(run("--libs"))
}
/// Builds an engine as a shared library for engine-plugins and places it next to the binaries
/// (target/<profile>/), where the release workflow packages it. Not linked into uuremote-server.
fn shared_engine(name: &str, sources: &[&str], includes: &[&std::path::Path], cflags: &str, libs: &str) {
let out = std::path::PathBuf::from(std::env::var_os("OUT_DIR").unwrap());
let library = out.join(name);
let mut command = cc::Build::new().pic(true).opt_level(2).get_compiler().to_command();
command.args(["-shared", "-fPIC", "-Wno-unused-parameter", "-Wl,-z,defs"]).arg(format!("-Wl,-soname,{name}")).arg("-o").arg(&library);
for include in includes { command.arg("-I").arg(include); }
command.args(cflags.split_whitespace()).args(sources).args(libs.split_whitespace()).arg("-lpthread");
let status = command.status().expect("C compiler for the engine plugin");
assert!(status.success(), "building {name} failed");
// OUT_DIR = target/<profile>/build/<package>-<hash>/out
if let Some(profile) = out.ancestors().nth(3) { std::fs::copy(&library, profile.join(name)).expect("copy engine plugin"); }
}
+112 -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 *refresh_items[5], *footer_label;
// 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;
// Tray (host service only): AppIndicator via dlopen (no build dependency), else GtkStatusIcon.
static GtkWidget *tray_menu, *tray_allow;
@@ -54,6 +57,10 @@ static int suppress_tray;
static int cur_verify, cur_refresh, cur_has_custom;
static char current_id[64], current_code[64];
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) {
GtkWidget *l = gtk_label_new(text);
@@ -250,6 +257,11 @@ static GtkWidget *build_account_card(void) {
login_status = label("", "status");
gtk_label_set_line_wrap(GTK_LABEL(login_status), TRUE);
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_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;
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) {
tray_menu = gtk_menu_new();
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), quit);
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.
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_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_theme_path)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_icon_theme_path");
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 主机");
set_menu(ind, GTK_MENU(tray_menu));
set_status(ind, 1 /* ACTIVE */);
@@ -359,6 +403,11 @@ static void build_window(void) {
GtkWidget *root = gtk_box_new(GTK_ORIENTATION_VERTICAL, 10);
gtk_container_set_border_width(GTK_CONTAINER(root), 24);
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);
gtk_style_context_add_class(gtk_widget_get_style_context(card), "card");
@@ -469,12 +518,18 @@ static void build_window(void) {
gtk_widget_set_visible(assist_card, show_assist);
gtk_widget_set_visible(hint_label, show_assist);
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);
}
static void *ui_main(void *arg) {
(void)arg;
int ok = gtk_init_check(NULL, NULL);
// The CSS hard-codes a light palette; a dark system theme would turn unstyled text white on white (#43).
if (ok) g_object_set(gtk_settings_get_default(), "gtk-theme-name", "Adwaita", "gtk-application-prefer-dark-theme", FALSE, NULL);
if (ok) build_window();
pthread_mutex_lock(&init_lock);
init_state = ok ? 1 : -1;
@@ -639,6 +694,60 @@ void uu_ui_set_user(const char *name) {
if (!ui_started || init_state != 1) return;
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); }
int uu_login_ui_closed(void) { return atomic_load(&closed); }
void uu_login_ui_close(void) { uu_assist_ui_close(); }
+39 -4
View File
@@ -7,6 +7,8 @@
#define SESSION_DEST "org.gnome.SessionManager"
#define SESSION_PATH "/org/gnome/SessionManager"
#define SESSION_IFACE "org.gnome.SessionManager"
#define SCREENSAVER_DEST "org.freedesktop.ScreenSaver"
#define SCREENSAVER_PATH "/org/freedesktop/ScreenSaver"
enum {
UU_POWER_OK = 0,
@@ -17,6 +19,7 @@ enum {
struct uu_idle_inhibitor {
GDBusConnection *connection;
guint32 cookie;
int freedesktop; /* org.freedesktop.ScreenSaver (KDE) instead of org.gnome.SessionManager */
};
struct setup_timeout {
@@ -138,13 +141,45 @@ struct uu_idle_inhibitor *uu_desktop_idle_inhibitor_acquire(int *error_code) {
return inhibitor;
}
/* KDE (and other desktops implementing the freedesktop idle-inhibition spec): the inhibition is
also dropped by the screensaver when this private connection closes. */
struct uu_idle_inhibitor *uu_desktop_screensaver_inhibitor_acquire(int *error_code) {
if (!error_code) return NULL;
*error_code = UU_POWER_OK;
GDBusConnection *connection = private_session_bus(error_code);
if (!connection) return NULL;
GError *error = NULL;
GVariant *reply = g_dbus_connection_call_sync(
connection, SCREENSAVER_DEST, SCREENSAVER_PATH, SCREENSAVER_DEST, "Inhibit",
g_variant_new("(ss)", "uu-remote-linux", "Remote desktop session is active"),
G_VARIANT_TYPE("(u)"), G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
g_clear_error(&error);
struct uu_idle_inhibitor *inhibitor = reply ? calloc(1, sizeof(*inhibitor)) : NULL;
if (!inhibitor) {
*error_code = UU_POWER_CALL_FAILED;
if (reply) g_variant_unref(reply);
close_private_bus(connection);
return NULL;
}
g_variant_get(reply, "(u)", &inhibitor->cookie);
g_variant_unref(reply);
inhibitor->connection = connection;
inhibitor->freedesktop = 1;
return inhibitor;
}
void uu_desktop_idle_inhibitor_release(struct uu_idle_inhibitor *inhibitor) {
if (!inhibitor) return;
GError *error = NULL;
GVariant *reply = g_dbus_connection_call_sync(
inhibitor->connection, SESSION_DEST, SESSION_PATH, SESSION_IFACE, "Uninhibit",
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
GVariant *reply = inhibitor->freedesktop
? g_dbus_connection_call_sync(
inhibitor->connection, SCREENSAVER_DEST, SCREENSAVER_PATH, SCREENSAVER_DEST, "UnInhibit",
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error)
: g_dbus_connection_call_sync(
inhibitor->connection, SESSION_DEST, SESSION_PATH, SESSION_IFACE, "Uninhibit",
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
if (reply) g_variant_unref(reply);
g_clear_error(&error);
+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
+3
View File
@@ -474,6 +474,9 @@ static gboolean show_window(gpointer d) {
static void *ui_thread(void *d) {
(void)d;
if (!gtk_init_check(NULL, NULL)) { pthread_mutex_lock(&init_lock); init_state = -1; pthread_cond_signal(&init_cond); pthread_mutex_unlock(&init_lock); return NULL; }
gtk_window_set_default_icon_name("uu-remote-linux"); // same taskbar icon as the host (#13)
// Light palette in CSS; keep a dark system theme from making unstyled text white on white (#43).
g_object_set(gtk_settings_get_default(), "gtk-theme-name", "Adwaita", "gtk-application-prefer-dark-theme", FALSE, NULL);
show_window(NULL); gtk_main(); return NULL;
}
/* Hidden windows retain their widgets so queued idle callbacks stay valid. */
+15 -3
View File
@@ -117,6 +117,15 @@ static void more_item(GtkButton *b, gpointer kind) {
if (ok) { connect_kind(k); show_toast("正在发送电源指令…"); }
return;
}
if (!strcmp(k, "unbind")) {
GtkWidget *d = gtk_message_dialog_new(GTK_WINDOW(dialog), GTK_DIALOG_MODAL, GTK_MESSAGE_WARNING, GTK_BUTTONS_NONE,
"确定要从账号中删除该设备吗?");
gtk_message_dialog_format_secondary_text(GTK_MESSAGE_DIALOG(d), "删除后需要在该设备上重新登录才能再次远控。");
gtk_dialog_add_buttons(GTK_DIALOG(d), "取消", GTK_RESPONSE_CANCEL, "删除", GTK_RESPONSE_OK, NULL);
int ok = gtk_dialog_run(GTK_DIALOG(d)) == GTK_RESPONSE_OK; gtk_widget_destroy(d);
if (ok) { gtk_widget_destroy(dialog); connect_kind(k); show_toast("正在删除设备…"); }
return;
}
gtk_widget_destroy(dialog);
on_tool(NULL, kind);
}
@@ -126,9 +135,9 @@ static void open_more(void) {
GtkWidget *area = gtk_dialog_get_content_area(GTK_DIALOG(dialog)), *box = vbox(10);
gtk_container_set_border_width(GTK_CONTAINER(box), 22);
gtk_box_pack_start(GTK_BOX(box), label("更多工具", "h2"), FALSE, FALSE, 6);
const char *names[] = {"🗂 文件传输", "▶ 观看模式", "⌨ 终端", "⇄ 端口映射", "⏻ 远程开机", "↻ 重启", "⏻ 关机"};
const char *kinds[] = {"file", "watch", "terminal", "portmap", "wol", "reboot", "shutdown"};
for (int i = 0; i < 7; i++) {
const char *names[] = {"🗂 文件传输", "▶ 观看模式", "⌨ 终端", "⇄ 端口映射", "⏻ 远程开机", "↻ 重启", "⏻ 关机", "🗑 删除设备"};
const char *kinds[] = {"file", "watch", "terminal", "portmap", "wol", "reboot", "shutdown", "unbind"};
for (int i = 0; i < 8; i++) {
GtkWidget *b = gtk_button_new(), *line = hbox(10); add_class(b, "cardbtn");
gtk_box_pack_start(GTK_BOX(line), label(names[i], "devname"), TRUE, TRUE, 0);
gtk_box_pack_end(GTK_BOX(line), label("›", "hint"), FALSE, FALSE, 0);
@@ -581,6 +590,9 @@ static gboolean on_delete(GtkWidget *w, GdkEvent *e, gpointer d) { (void)w; (voi
static void *run(void *arg) {
(void)arg;
int ok = gtk_init_check(NULL, NULL);
if (ok) { gtk_window_set_default_icon_name("uu-remote-linux"); } // same taskbar icon as the host (#13)
// The CSS hard-codes a light palette; a dark system theme would turn unstyled text white on white (#43).
if (ok) g_object_set(gtk_settings_get_default(), "gtk-theme-name", "Adwaita", "gtk-application-prefer-dark-theme", FALSE, NULL);
if (ok) {
GtkCssProvider *css = gtk_css_provider_new();
gtk_css_provider_load_from_data(css, CSS, -1, NULL);
+250 -31
View File
@@ -58,6 +58,14 @@ static struct xkb_context *xkb;
static struct xkb_keymap *keymap;
static struct xkb_state *key_state;
static unsigned char held_keys[768];
/* Mobile input-method text (#13/#46). The protocol has no per-key remap request, but
zwp_virtual_keyboard_v1_keymap may be re-sent at any time, so the pristine keymap text is kept
and a spare keycode is pointed at one character's keysym at a time. Never logs the text. */
#define UU_TEXT_SPARE 32
static char *keymap_text;
static size_t keymap_text_len, keymap_insert;
static xkb_keycode_t spare_codes[UU_TEXT_SPARE];
static unsigned spare_count;
struct output { struct wl_output *handle; char name[128]; int transform,scale; uint32_t width,height; };
static struct output outputs[32];
static unsigned output_count, selected;
@@ -116,6 +124,164 @@ static int sync_display(void) {
if (!ready) wl_callback_destroy(cb);
return result;
}
/* Hand a keymap to the virtual keyboard. The compositor dups the fd, so it is closed here. */
static int upload_keymap(const char *text,size_t length) {
int fd=memfd_create("uuremote-keymap",MFD_CLOEXEC);
if(fd<0) return -1;
if(ftruncate(fd,(off_t)length)!=0 || write(fd,text,length)!=(ssize_t)length) { close(fd); return -1; }
zwp_virtual_keyboard_v1_keymap(keyboard,WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,fd,(uint32_t)length);
close(fd);
return 0;
}
/* A keymap uploaded to a keyboard the seat already has is never handed to the focused client again,
so pressing the remapped keycodes would still be translated with the keymap it has - which is how
every message came out as the one before it. Re-attaching the keyboard is what makes the
compositor send the keymap to the client (measured 2026-10-18 on Hyprland 0.56.2). */
static int rekey_keyboard(void) {
if(!keyboard_manager || !seat) return -1;
if(keyboard) zwp_virtual_keyboard_v1_destroy(keyboard);
keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat);
return keyboard?0:-1;
}
/* Offset of the '}' that closes the xkb_symbols section, so extra keys can be declared there.
Pairing the braces is enough because the bodies are balanced; looking for the last "};" is not,
the keymap's own brace follows, and an optional xkb_geometry section may too. */
static size_t symbols_close(const char *text) {
const char *section=strstr(text,"xkb_symbols");
if(!section) return 0;
const char *open=strchr(section,'{');
if(!open) return 0;
int depth=0;
for(const char *p=open;*p;p++) {
if(*p=='{') depth++;
else if(*p=='}' && --depth==0) return (size_t)(p-text);
}
return 0;
}
/* Named keycodes the keymap gives no symbol to. Reading the compositor's own list is the only
portable way: pressing an unmapped keycode types nothing, and uu_wl_key never matches one
because it searches by keysym. Highest first, since uu_wl_key takes the lowest match. */
static unsigned find_spare_codes(xkb_keycode_t *out,unsigned limit) {
unsigned count=0;
xkb_keycode_t min=xkb_keymap_min_keycode(keymap);
for(xkb_keycode_t code=xkb_keymap_max_keycode(keymap);code>min && count<limit;code--) {
if(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue;
int mapped=0;
for(xkb_level_index_t level=0;level<xkb_keymap_num_levels_for_key(keymap,code,0) && !mapped;level++) {
const xkb_keysym_t *syms;
if(xkb_keymap_key_get_syms_by_level(keymap,code,0,level,&syms)>0) mapped=1;
}
if(!mapped) out[count++]=code;
}
return count;
}
/* A keycode the session keymap already produces this symbol with, unshifted. Typing through it
needs no upload, so no client can mistranslate it - and it is how plain latin text and spaces
arrive without touching the keymap at all. Spares never match: the pristine keymap leaves them
unmapped. */
static xkb_keycode_t existing_keycode(xkb_keysym_t symbol) {
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
if(code<8 || code>=sizeof(held_keys)) continue;
const xkb_keysym_t *syms;
if(xkb_keymap_key_get_syms_by_level(keymap,code,0,0,&syms)==1 && syms[0]==symbol) return code;
}
return 0;
}
static void press_keycode(xkb_keycode_t code) {
zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_PRESSED);
zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_RELEASED);
held_keys[code]=0;
}
/* The replaced keyboard starts with nothing held, and a keycode held_keys still calls held would be
skipped by uu_wl_key's next press of it. */
static void release_held_keys_locked(void) {
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
if(code<8 || code>=sizeof(held_keys) || !held_keys[code]) continue;
zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_RELEASED);
xkb_state_update_key(key_state,code,XKB_KEY_UP);
}
memset(held_keys,0,sizeof(held_keys));
}
/* Upload one batch: re-attach the keyboard so the client takes the keymap, point spare keycodes at
these symbols, wait for the compositor to install it, then press them. Spares are left out of
key_state and held_keys: pressed and released here. */
static int flush_batch(char *buffer,size_t capacity,const char names[][64],const xkb_keycode_t *codes,unsigned count,int *typed) {
release_held_keys_locked();
if(rekey_keyboard()!=0) return -1;
size_t at=keymap_insert;
memcpy(buffer,keymap_text,at);
for(unsigned i=0;i<count;i++) {
int wrote=snprintf(buffer+at,capacity-at,"\tkey <%s> { [ %s ] };\n",xkb_keymap_key_get_name(keymap,codes[i]),names[i]);
if(wrote<0 || (size_t)wrote>=capacity-at) return -1;
at+=(size_t)wrote;
}
memcpy(buffer+at,keymap_text+keymap_insert,keymap_text_len-keymap_insert);
if(upload_keymap(buffer,at+(keymap_text_len-keymap_insert))!=0) return -1;
if(sync_display()!=0) return -1;
for(unsigned i=0;i<count;i++) { press_keycode(codes[i]); (*typed)++; }
return 0;
}
/* Type UTF-8 like xdotool type does on X11, but on Wayland: characters the session keymap already
has go out as ordinary keycodes, the rest share the spares of one keymap upload (~70 KB, so one
batch per upload), in text order. Never logs the text. */
static int type_utf8_locked(const char *text) {
size_t capacity=keymap_text_len+(size_t)UU_TEXT_SPARE*96+64;
char *buffer=malloc(capacity);
if(!buffer) return -1;
char names[UU_TEXT_SPARE][64];
xkb_keycode_t codes[UU_TEXT_SPARE];
unsigned count=0;
int typed=0, failed=0;
const unsigned char *p=(const unsigned char *)text;
while(*p && !failed) {
unsigned cp=0; int n=0;
if(*p<0x80) { cp=*p; n=1; }
else if((*p&0xE0)==0xC0 && (p[1]&0xC0)==0x80) { cp=((p[0]&0x1F)<<6)|(p[1]&0x3F); n=2; }
else if((*p&0xF0)==0xE0 && (p[1]&0xC0)==0x80 && (p[2]&0xC0)==0x80) { cp=((p[0]&0x0F)<<12)|((p[1]&0x3F)<<6)|(p[2]&0x3F); n=3; }
else if((*p&0xF8)==0xF0 && (p[1]&0xC0)==0x80 && (p[2]&0xC0)==0x80 && (p[3]&0xC0)==0x80) { cp=((p[0]&0x07)<<18)|((p[1]&0x3F)<<12)|((p[2]&0x3F)<<6)|(p[3]&0x3F); n=4; }
else { p++; continue; }
p+=n;
xkb_keysym_t sym;
if(cp=='\n') sym=0xff0d; /* Return */
else if(cp=='\t') sym=0xff09; /* Tab */
else if(cp<0x20 || cp==0x7f || (cp>=0x80 && cp<0xa0)) continue; /* controls carry no text */
else if(cp<0x100) sym=cp; /* Latin-1 keysyms equal the code point */
else sym=(xkb_keysym_t)(0x1000000|cp); /* Unicode keysym */
xkb_keycode_t existing=existing_keycode(sym);
if(existing) {
if(count && flush_batch(buffer,capacity,names,codes,count,&typed)!=0) { failed=1; break; }
count=0;
press_keycode(existing); typed++;
continue;
}
if(count==UU_TEXT_SPARE) {
if(flush_batch(buffer,capacity,names,codes,count,&typed)!=0) { failed=1; break; }
count=0;
}
/* The name is what the keymap parser reads back; an unnamed keysym cannot be spelled. */
if(xkb_keysym_get_name(sym,names[count],sizeof(names[count]))<=0) continue;
codes[count]=spare_codes[count];
count++;
}
if(!failed && count) failed=flush_batch(buffer,capacity,names,codes,count,&typed)!=0;
free(buffer);
/* Restore the pristine keymap whatever happened above, so uu_wl_key keeps its own symbol map. */
if(upload_keymap(keymap_text,keymap_text_len)!=0) return -1;
return failed && !typed?-1:typed;
}
int uu_wl_type_utf8(const char *text) {
pthread_mutex_lock(&lock);
int typed=-1;
if(initialized && text && keymap_text && keymap_insert && spare_count) typed=type_utf8_locked(text);
if(typed>=0 && wl_display_flush(display)<0) typed=-1;
pthread_mutex_unlock(&lock); return typed;
}
/* Diagnostic: how many characters one keymap upload can carry, 0 when this keymap has no spare. */
int uu_wl_text_ready(void) {
pthread_mutex_lock(&lock);
int ready=initialized && keymap_text && keymap_insert ? (int)spare_count : 0;
pthread_mutex_unlock(&lock); return ready;
}
static void output_geometry(void*d,struct wl_output*o,int32_t x,int32_t y,int32_t w,int32_t h,int32_t sub,const char*m,const char*model,int32_t transform) { ((struct output*)d)->transform=transform; }
static void output_mode(void*d,struct wl_output*o,uint32_t f,int32_t w,int32_t h,int32_t rate) {
if(f&WL_OUTPUT_MODE_CURRENT) { ((struct output*)d)->width=w; ((struct output*)d)->height=h; }
@@ -357,6 +523,7 @@ static void reset(void) {
dmabuf=NULL; dmabuf_requested=dmabuf_disabled=dmabuf_reported=0; dmabuf_linear_formats=0;
pending=0; output_count=0; initialized=0; memset(outputs,0,sizeof(outputs));
memset(held_keys,0,sizeof(held_keys));
free(keymap_text); keymap_text=NULL; keymap_text_len=keymap_insert=0; spare_count=0;
}
int uu_wl_init(int32_t *w,int32_t *h) {
pthread_mutex_lock(&lock);
@@ -368,7 +535,10 @@ int uu_wl_init(int32_t *w,int32_t *h) {
wl_registry_add_listener(registry,&registry_listener,NULL);
if(sync_display()!=0 || sync_display()!=0) goto end;
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;
if(name && *name) {
for(selected=0;selected<output_count;selected++) if(!strcmp(outputs[selected].name,name)) break;
@@ -382,32 +552,73 @@ int uu_wl_init(int32_t *w,int32_t *h) {
power=zwlr_output_power_manager_v1_get_output_power(power_manager,outputs[selected].handle);
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);
keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat);
xkb=xkb_context_new(XKB_CONTEXT_NO_FLAGS);
if(!xkb) goto end;
struct xkb_rule_names names={.layout="us"};
keymap=xkb_keymap_new_from_names(xkb,&names,XKB_KEYMAP_COMPILE_NO_FLAGS);
if(!keymap) goto end;
key_state=xkb_state_new(keymap); if(!key_state) goto end;
char *map=xkb_keymap_get_as_string(keymap,XKB_KEYMAP_FORMAT_TEXT_V1);
if(!map) goto end;
size_t length=strlen(map)+1;
int fd=memfd_create("uuremote-keymap",MFD_CLOEXEC);
if(fd<0) { free(map); goto end; }
if(ftruncate(fd,(off_t)length)!=0 || write(fd,map,length)!=(ssize_t)length) { free(map); close(fd); goto end; }
free(map);
zwp_virtual_keyboard_v1_keymap(keyboard,WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,fd,length); close(fd);
if(sync_display()!=0) goto end;
if(pointer_manager) pointer=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[selected].handle);
/* Some compositors reject a virtual keyboard from anything that is not their active
input method (Denial does), and a rejected proxy poisons later requests. Allow the
caller to opt out and rely on uinput for key input instead. */
const char *skip_kbd=getenv("UU_WAYLAND_NO_VIRTUAL_KEYBOARD");
if(keyboard_manager && !(skip_kbd && *skip_kbd && strcmp(skip_kbd,"0")))
keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat);
if(keyboard) {
xkb=xkb_context_new(XKB_CONTEXT_NO_FLAGS);
if(!xkb) goto end;
struct xkb_rule_names names={.layout="us"};
keymap=xkb_keymap_new_from_names(xkb,&names,XKB_KEYMAP_COMPILE_NO_FLAGS);
if(!keymap) goto end;
key_state=xkb_state_new(keymap); if(!key_state) goto end;
keymap_text=xkb_keymap_get_as_string(keymap,XKB_KEYMAP_FORMAT_TEXT_V1);
if(!keymap_text) goto end;
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;
end:
if(result!=0) reset();
pthread_mutex_unlock(&lock); return result;
}
/* Switch the pointer binding and main-process capture atomically; encoder subprocesses
select their own output via UU_WAYLAND_OUTPUT. Keyboard identity stays unchanged. */
int uu_wl_select_output(const char *name,uint32_t expected_w,uint32_t expected_h) {
pthread_mutex_lock(&lock); int result=-1;
if(!initialized || !name || sync_display()!=0) goto end;
unsigned target;
for(target=0;target<output_count;target++) if(!strcmp(outputs[target].name,name)) break;
if(target==output_count || outputs[target].transform!=WL_OUTPUT_TRANSFORM_NORMAL) goto end;
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;
struct zwlr_virtual_pointer_v1 *next=NULL;
if(pointer_manager) {
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]); }
pending=0;
if(pointer) zwlr_virtual_pointer_v1_destroy(pointer);
pointer=next; selected=target; width=w; height=h;
if(power) { zwlr_output_power_v1_destroy(power); power=NULL; }
power_failed=0;
if(power_manager) {
power=zwlr_output_power_manager_v1_get_output_power(power_manager,outputs[selected].handle);
zwlr_output_power_v1_add_listener(power,&power_listener,NULL);
}
result=0;
end:
pthread_mutex_unlock(&lock); return result;
}
int uu_wl_wake(void) {
pthread_mutex_lock(&lock); int result=-1;
/* Output power management is optional; missing it must not block screencopy. */
if(initialized && !power) result=0;
if(initialized && (!power || power_failed)) {
/* No power manager, or the compositor refused the mode (outputs without DPMS,
headless outputs): streaming continues, the screen simply stays as it is. */
result=0;
}
if(initialized && power && !power_failed) {
zwlr_output_power_v1_set_mode(power,ZWLR_OUTPUT_POWER_V1_MODE_ON);
if(sync_display()==0 && !power_failed) result=0;
@@ -456,6 +667,8 @@ end:
}
int uu_wl_move(int32_t x,int32_t y,int relative) {
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(relative) {
/* UU reports pixels (source DPR=1); Wayland motion is in logical points. */
@@ -470,6 +683,7 @@ end: pthread_mutex_unlock(&lock); return result;
}
int uu_wl_button(int button,int pressed) {
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(button>=4 && button<=7) {
if(pressed) {
@@ -489,6 +703,7 @@ end: pthread_mutex_unlock(&lock); return result;
}
int uu_wl_key(uint64_t symbol,int pressed) {
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) {
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
int matches=0;
@@ -519,20 +734,24 @@ int uu_wl_release_all(void) {
if(initialized) {
/* Sweep this client's virtual keyboard directly: a keysym lookup can
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(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue;
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);
if(keyboard) {
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
if(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue;
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));
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));
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);
if(pointer) {
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;
}
pthread_mutex_unlock(&lock);return result;
+66 -2
View File
@@ -3,6 +3,7 @@
* Zero-Wine dependency, zero-overhead, thread-safe.
*/
#include <stdio.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <sys/shm.h>
@@ -55,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) {
g_use_shm = 0;
if (!XShmQueryExtension(g_display)) return;
@@ -65,9 +75,15 @@ static void shm_open_image(void) {
if (g_shminfo.shmid == -1) return;
g_shminfo.shmaddr = g_shm_image->data = (char *)shmat(g_shminfo.shmid, 0, 0);
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);
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); // 标记删除,进程退出时自动回收;失败时也不遗留段
}
@@ -218,6 +234,54 @@ int x11_key_symbol(unsigned long symbol, int is_press) {
return 0;
}
/* Type UTF-8 text the way xdotool does: bind each character's keysym to a spare (unmapped) keycode, press it,
* then restore the keycode. Works for CJK text from mobile input methods. Never logs the text. */
int x11_type_utf8(const char *text) {
if (!g_display || !text) return -1;
int min_kc = 0, max_kc = 0, per = 0;
XDisplayKeycodes(g_display, &min_kc, &max_kc);
KeySym *map = XGetKeyboardMapping(g_display, (KeyCode)min_kc, max_kc - min_kc + 1, &per);
if (!map) return -2;
int spare = 0;
for (int kc = max_kc; kc >= min_kc && !spare; kc--) {
int empty = 1;
for (int i = 0; i < per; i++) if (map[(kc - min_kc) * per + i] != NoSymbol) { empty = 0; break; }
if (empty) spare = kc;
}
XFree(map);
if (!spare) return -3;
int typed = 0;
const unsigned char *p = (const unsigned char *)text;
while (*p) {
unsigned cp; int n;
if (*p < 0x80) { cp = *p; n = 1; }
else if ((*p & 0xE0) == 0xC0 && (p[1] & 0xC0) == 0x80) { cp = ((p[0] & 0x1F) << 6) | (p[1] & 0x3F); n = 2; }
else if ((*p & 0xF0) == 0xE0 && (p[1] & 0xC0) == 0x80 && (p[2] & 0xC0) == 0x80) { cp = ((p[0] & 0x0F) << 12) | ((p[1] & 0x3F) << 6) | (p[2] & 0x3F); n = 3; }
else if ((*p & 0xF8) == 0xF0 && (p[1] & 0xC0) == 0x80 && (p[2] & 0xC0) == 0x80 && (p[3] & 0xC0) == 0x80) { cp = ((p[0] & 0x07) << 18) | ((p[1] & 0x3F) << 12) | ((p[2] & 0x3F) << 6) | (p[3] & 0x3F); n = 4; }
else { p++; continue; }
p += n;
KeySym sym;
if (cp == '\n') sym = 0xff0d; /* Return */
else if (cp == '\t') sym = 0xff09; /* Tab */
else if (cp < 0x20 || cp == 0x7f || (cp >= 0x80 && cp < 0xa0)) continue;
else if (cp < 0x100) sym = cp; /* Latin-1 keysyms equal the code point */
else sym = 0x1000000 | cp; /* Unicode keysym */
KeySym syms[2] = { sym, sym };
XChangeKeyboardMapping(g_display, spare, 2, syms, 1);
XSync(g_display, False);
usleep(8000); /* let clients see the MappingNotify before the key */
XTestFakeKeyEvent(g_display, spare, True, CurrentTime);
XTestFakeKeyEvent(g_display, spare, False, CurrentTime);
XSync(g_display, False);
usleep(8000);
typed++;
}
KeySym none[2] = { NoSymbol, NoSymbol };
XChangeKeyboardMapping(g_display, spare, 2, none, 1);
XSync(g_display, False);
return typed;
}
int x11_key_event(int keycode, int is_press) {
if (!g_display) return -1;
if (is_press) track_injected_key(keycode, 1);
@@ -0,0 +1,14 @@
[Desktop Entry]
Type=Application
Name=UU 远程 Linux 控制端
Name[en]=UU Remote Linux Viewer
GenericName=Remote desktop viewer
Comment=非官方 UU 远程控制端(实验性):远控你的 Windows / Mac / Linux 设备
Comment[en]=Unofficial NetEase UU Remote viewer (experimental)
Exec=uuremote-viewer ui
Icon=uu-remote-linux
Terminal=false
Categories=Network;RemoteAccess;
Keywords=remote;desktop;viewer;UU;远程;控制;
StartupNotify=false
StartupWMClass=uuremote-viewer
+2
View File
@@ -11,3 +11,5 @@ Terminal=false
Categories=Network;RemoteAccess;
Keywords=remote;assist;UU;远程;协助;
StartupNotify=false
# Matches the GTK window class so docks/taskbars show this icon for the host window (#13).
StartupWMClass=uu-remote-linux
+1
View File
@@ -0,0 +1 @@
__pycache__/
+103
View File
@@ -0,0 +1,103 @@
# Paste copied files into a UU-mapped SSH terminal on macOS
This optional Mac companion uploads files copied in Finder when you paste them
into Ghostty, then inserts shell-quoted **remote** paths into the terminal.
For example, copy an image in Finder, connect with `uu-ssh-paste`, and press
Command-V at a remote shell prompt or in a terminal application's text field.
The file is available on the server before its path is inserted. No Enter is sent.
The connection is Ghostty → OpenSSH → your existing UU TCP mapping → the Linux
host's SSH server. Both terminal traffic and uploads use the same SSH alias.
The companion does not create a mapping or fall back to a public network route.
The official Mac UU application's built-in terminal is unaffected.
## Install and connect
On the controlling Mac, install Python 3 and Apple's command-line developer
tools (for `swiftc`), then run from this repository:
```sh
sh contrib/macos-ssh/install.sh
```
Enable port mapping on your Linux UU host (`UU_PORT_MAPPING=1`); in the official
Mac UU app, map a **local loopback** port to `127.0.0.1:22` on that host. Keep
the mapping connected. Configure an SSH alias for that local port, using your
existing key and the server's verified host key. For example:
```sshconfig
Host uu-server
HostName 127.0.0.1
Port 22243
User your-linux-user
IdentityFile ~/.ssh/id_ed25519
IdentitiesOnly yes
HostKeyAlias your-existing-server-host-key-name
StrictHostKeyChecking yes
ProxyCommand none
ProxyJump none
```
In Ghostty, connect using that alias:
```sh
uu-ssh-paste uu-server
# Or use a separate SSH config:
uu-ssh-paste -F ~/.config/your-uu-ssh.conf uu-server
```
Copy one or several files in Finder with Command-C, switch to the connected
terminal, and press Command-V. Each paste creates a unique mode-0700 directory
under `~/.local/share/uuremote/uploads/` on the server. Files remain there until
you remove them. Filenames with spaces, Unicode and shell metacharacters are
supported. Existing files are never overwritten by another paste batch.
Text paste, SSH exit statuses, terminal resizing and mouse reports pass through.
The remote application still controls whether it receives bracketed paste and
mouse movement. Ctrl-C during a transfer cancels that paste. Input typed while
the upload is running is queued, so Enter cannot overtake the uploaded path.
Ghostty's title bar shows the connection phase, upload percentage, transferred
size, transfer speed and elapsed time. Its progress indicator tracks the upload
too. Progress is derived from OpenSSH's transfer meter, aggregated across copied
files; it is not a simulated timer. The original terminal title is restored when
the upload finishes, fails or is cancelled, and no terminal cells are overwritten.
Filename and error output from SCP stays private; only numeric progress is shown.
## Scope and failure behavior
- Only file-URL clipboard entries copied in Finder are uploaded, and only when
they match the complete pasted path list. Pasting a textual local path or a
command does not upload anything. The clipboard is never modified or polled
in the background; file URLs are read only during a potential file paste.
- Folder paste, drag-and-drop and raw screenshot/image clipboard data are not
supported. Save an image as a file and copy that file in Finder first.
- The SSH server must support SFTP. Upload authentication is noninteractive
(`BatchMode=yes`); the alias must already work with a key or SSH agent.
- Missing files, duplicate basenames in a batch, control characters in filenames,
failed uploads and clipboard-reader failures do not insert a misleading path.
Failed transfer directories are removed on a best-effort basis. No file names,
clipboard contents, file contents, terminal input or SSH error text are logged.
- A paste is limited to 256 files and 8 MiB of pasted path/text data. Transfers
time out after five minutes. File sizes themselves are not limited to 8 MiB.
- The companion keeps local bracketed-paste framing enabled while the session
runs and removes framing for remote applications that have not requested it.
No global Ghostty configuration, remote desktop or Wine component is needed.
## Tests
```sh
python3 -m unittest discover -s contrib/macos-ssh -p 'test_*.py' -v
swiftc -O contrib/macos-ssh/clipboard-files.swift -o /tmp/clipboard-files
/tmp/clipboard-files --self-test
# Optional real SSH/SFTP acceptance test over an already connected UU mapping:
UU_PASTE_TEST_HOST=uu-server UU_PASTE_TEST_CONFIG="$HOME/.config/your-uu-ssh.conf" \
python3 -m unittest discover -s contrib/macos-ssh -p 'test_*.py' -v
```
The Swift test uses a private pasteboard and never touches the user's clipboard.
Python tests exercise fragmented paste framing, shell quoting, plain text,
mouse reports, failed uploads, queued Enter, PTY restoration and exit status.
The optional live tests transfer synthetic binary files and verify hashes,
including a throttled upload that must report intermediate byte progress.
Physical Command-C/Command-V behavior in Finder/Ghostty remains a manual check.
+29
View File
@@ -0,0 +1,29 @@
import AppKit
import Foundation
// Only file URLs are read. Text, images and the general pasteboard are never
// written, and the result is consumed privately by the SSH companion.
func filePaths(_ board: NSPasteboard) -> [String] {
let options: [NSPasteboard.ReadingOptionKey: Any] = [.urlReadingFileURLsOnly: true]
return (board.readObjects(forClasses: [NSURL.self], options: options) as? [URL] ?? [])
.filter { $0.isFileURL }.map { $0.path }
}
if CommandLine.arguments.dropFirst().first == "--self-test" {
// An isolated pasteboard: tests never read or overwrite the user's clipboard.
let board = NSPasteboard.withUniqueName()
defer { board.releaseGlobally() }
let paths = ["/tmp/space and 中文.png", "/tmp/quote'$(literal).txt"]
board.writeObjects(paths.map { NSURL(fileURLWithPath: $0) })
precondition(filePaths(board) == paths)
board.clearContents()
board.setString("/tmp/text-is-not-a-file", forType: .string)
precondition(filePaths(board).isEmpty)
board.clearContents()
board.writeObjects([NSURL(string: "https://example.invalid/file")!])
precondition(filePaths(board).isEmpty)
print("Private pasteboard tests passed")
} else {
let data = try JSONSerialization.data(withJSONObject: filePaths(.general))
FileHandle.standardOutput.write(data)
}
+27
View File
@@ -0,0 +1,27 @@
#!/bin/sh
set -eu
if [ "$(uname -s)" != Darwin ]; then
echo 'Install this companion on the controlling Mac.' >&2
exit 1
fi
command -v python3 >/dev/null
source_dir=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)
data_dir="$HOME/.local/share/uuremote/macos-ssh"
bin_dir="$HOME/.local/bin"
mkdir -p "$data_dir" "$bin_dir"
scratch=$(mktemp -d)
trap 'rm -rf "$scratch"' EXIT HUP INT TERM
swiftc -O "$source_dir/clipboard-files.swift" -o "$scratch/clipboard-files"
"$scratch/clipboard-files" --self-test
install -m 755 "$scratch/clipboard-files" "$data_dir/clipboard-files"
install -m 755 "$source_dir/uu-ssh-paste" "$data_dir/uu-ssh-paste"
if [ -e "$bin_dir/uu-ssh-paste" ] && [ ! -L "$bin_dir/uu-ssh-paste" ]; then
echo 'An existing uu-ssh-paste file was preserved; inspect it before replacing it.' >&2
exit 1
fi
if [ -L "$bin_dir/uu-ssh-paste" ] && [ "$(readlink "$bin_dir/uu-ssh-paste")" != "$data_dir/uu-ssh-paste" ]; then
echo 'An unrelated uu-ssh-paste symlink was preserved; inspect it before replacing it.' >&2
exit 1
fi
ln -sfn "$data_dir/uu-ssh-paste" "$bin_dir/uu-ssh-paste"
echo 'Installed uu-ssh-paste. Connect using your existing UU SSH alias.'
+472
View File
@@ -0,0 +1,472 @@
"""Synthetic fixtures only; never inspect or change the general pasteboard."""
import base64
import errno
import hashlib
import importlib.machinery
import importlib.util
import json
import os
from pathlib import Path
import pty
import select
import shlex
import signal
import struct
import subprocess
import sys
import tempfile
import termios
import threading
import time
import unittest
from unittest import mock
SCRIPT = Path(__file__).with_name("uu-ssh-paste")
loader = importlib.machinery.SourceFileLoader("uu_paste", str(SCRIPT))
spec = importlib.util.spec_from_loader(loader.name, loader)
paste = importlib.util.module_from_spec(spec)
loader.exec_module(paste)
class FramingTests(unittest.TestCase):
def test_paste_at_every_fragment_boundary_and_multiple_pastes(self):
wire = b"key" + paste.START + b"hello\nworld" + paste.END + b"\r"
expected = [("data", b"key"), ("paste", b"hello\nworld"), ("data", b"\r")]
for split in range(len(wire) + 1):
frames = paste.InputFrames()
events = frames.feed(wire[:split]) + frames.feed(wire[split:])
merged = []
for kind, data in events:
if kind == "data" and merged and merged[-1][0] == "data":
merged[-1] = (kind, merged[-1][1] + data)
else:
merged.append((kind, data))
self.assertEqual(merged, expected)
frames = paste.InputFrames()
self.assertEqual(frames.feed(paste.START + b"a" + paste.END + paste.START + b"b" + paste.END),
[("paste", b"a"), ("paste", b"b")])
def test_mouse_and_arrow_bytes_and_standalone_escape(self):
raw = b"\x1b[<2;12;4M\x1b[<2;12;4m\x1b[<35;13;5M\x1b[A\x1b"
frames = paste.InputFrames()
output = b"".join(data for kind, data in frames.feed(raw) if kind == "data")
self.assertEqual(output + frames.flush_key(), raw)
def test_oversized_paste_is_discarded_and_parser_recovers(self):
frames = paste.InputFrames()
with mock.patch.object(paste, "MAX_PASTE", 16):
self.assertEqual(frames.feed(paste.START + b"x" * 40), [])
self.assertEqual(frames.feed(paste.END + b"next")[-1], ("data", b"next"))
self.assertFalse(frames.pasting)
self.assertLess(len(frames.buffer), 16)
def test_remote_modes_track_split_sequences_without_disabling_local_framing(self):
for split in range(len(paste.DISABLE) + 1):
modes = paste.OutputModes()
modes.bracketed = True
result = modes.feed(paste.DISABLE[:split]) + modes.feed(paste.DISABLE[split:])
self.assertEqual(result, paste.ENABLE)
self.assertFalse(modes.bracketed)
modes = paste.OutputModes()
self.assertEqual(modes.feed(b"\x1b[?1;2004h"), b"\x1b[?1h" + paste.ENABLE)
self.assertTrue(modes.bracketed)
self.assertEqual(modes.feed(b"\x1b[?2004;25l"), b"\x1b[?25l" + paste.ENABLE)
self.assertFalse(modes.bracketed)
self.assertEqual(modes.feed(b"\x1bc"), b"\x1bc" + paste.ENABLE)
raw = b"\x1b[31mhello\x1b[0m\x1b]0;title\x07"
self.assertEqual(modes.feed(raw), raw)
class FileTests(unittest.TestCase):
def setUp(self):
self.temp = tempfile.TemporaryDirectory()
self.addCleanup(self.temp.cleanup)
self.root = Path(self.temp.name)
self.files = [self.root / "space 中文.png", self.root / "quote'$(literal);.txt"]
for path in self.files:
path.write_bytes(os.urandom(1025))
self.paths = [str(p) for p in self.files]
# Ghostty uses backslash escaping rather than POSIX single quotes.
escape = "\\ ()[]{}<>\"'`!#$&;|*?\t"
self.payload = " ".join("".join("\\" + c if c in escape else c for c in p)
for p in self.paths).encode()
def test_finder_files_match_ghostty_escaping(self):
self.assertEqual(paste.copied_files(self.payload, lambda: self.paths), self.paths)
def test_plain_text_and_pasted_commands_do_not_upload(self):
clipboard = mock.Mock(return_value=[])
for value in (b"hello\nworld", b"cat /tmp/file", b"\xff", b"'unterminated"):
self.assertIsNone(paste.copied_files(value, clipboard))
clipboard.assert_not_called()
self.assertIsNone(paste.copied_files(self.payload, lambda: []))
self.assertIsNone(paste.copied_files(self.payload, lambda: self.paths[::-1]))
def test_missing_files_folders_duplicate_names_and_control_characters_rejected(self):
cases = [[str(self.root)], [str(self.root / "missing")]]
newline = self.root / "bad\nname"
newline.write_text("synthetic")
cases.append([str(newline)])
folder = self.root / "another"
folder.mkdir()
duplicate = folder / self.files[0].name
duplicate.write_text("synthetic")
cases.append([self.paths[0], str(duplicate)])
for paths in cases:
with self.assertRaises(paste.PasteError):
paste.copied_files(shlex.join(paths).encode(), lambda: paths)
def test_upload_paths_are_quoted_and_failed_batch_is_cleaned(self):
uploader = paste.Uploader(self.root / "config with spaces", "uu-test")
directory = b"/home/test user/.local/share/uuremote/uploads/paste.ABCD1234\n"
with mock.patch.object(paste, "run_private", side_effect=[directory, b""]) as run:
result = uploader.upload(self.paths, threading.Event())
self.assertEqual(shlex.split(result.decode()),
[directory.decode().strip() + "/" + p.name for p in self.files])
self.assertEqual(run.call_args_list[1].args[0][-3:-1], self.paths)
self.assertNotIn("-O", run.call_args_list[1].args[0])
self.assertIn("BatchMode=yes", run.call_args_list[1].args[0])
with mock.patch.object(paste, "run_private", side_effect=[directory, paste.PasteError("failed"), b""]) as run:
with self.assertRaises(paste.PasteError):
uploader.upload(self.paths, threading.Event())
cleanup = run.call_args_list[2].args[0][-1]
self.assertEqual(shlex.split(cleanup), ["rm", "-rf", "--", directory.decode().strip()])
def test_bad_destination_and_bad_clipboard_fail_without_content_in_error(self):
uploader = paste.Uploader(None, "uu-test")
for output in (b"relative", b"/tmp/invalid", b"/tmp/paste.abc\nextra", b"\xff"):
with mock.patch.object(paste, "run_private", return_value=output):
with self.assertRaises(paste.PasteError):
uploader.upload(self.paths, threading.Event())
with mock.patch.object(paste.subprocess, "run", return_value=subprocess.CompletedProcess([], 0, b"{}")):
with self.assertRaises(paste.PasteError):
paste.clipboard_paths("helper")
def test_cancellation_stops_transfer(self):
cancel = threading.Event()
cancel.set()
with self.assertRaisesRegex(paste.PasteError, "cancelled"):
paste.run_private([sys.executable, "-c", "import time;time.sleep(30)"], cancel, 3)
class ProgressTests(unittest.TestCase):
def test_numeric_meter_handles_fragments_multiple_files_and_rounding(self):
for fragment in (1, 7, 9999):
reports = []
meter = paste.SCPMeter([1048576, 1025], lambda *args: reports.append(args))
wire = (b"\rprivate-file 0% 0 0.0KB/s --:-- ETA"
b"\rprivate-file 50% 512KB 128.0KB/s 00:04 ETA"
b"\rprivate-file 100% 1024KB 128.0KB/s 00:08\r\n"
b"\rsecret-other 0% 0 0.0KB/s --:-- ETA"
b"\rsecret-other 100% 1025 64.0KB/s 00:00\r\n")
for offset in range(0, len(wire), fragment):
meter.feed(wire[offset:offset + fragment])
self.assertIn(("uploading", 524288, 1049601, 131072), reports)
self.assertEqual(reports[-1], ("uploading", 1049601, 1049601, 65536))
self.assertEqual(meter.index, 2)
self.assertEqual([p[1] for p in reports], sorted(p[1] for p in reports))
self.assertNotIn("private-file", repr(reports))
self.assertNotIn("secret-other", repr(reports))
def test_unrecognized_output_is_not_displayed_and_buffer_is_bounded(self):
reports = []
meter = paste.SCPMeter([10], lambda *args: reports.append(args))
meter.feed(b"private error " * 10000 + b" 999% 5 1.0KB/s 00:00\n")
self.assertEqual(reports, [])
self.assertLessEqual(len(meter.buffer), 512)
def test_metered_process_captures_progress_privately_and_preserves_failure_cancellation(self):
reports = []
code = ("import os;assert os.isatty(1);assert os.tcgetpgrp(1)==os.getpgrp();"
"os.write(1,b'\\rprivate-file 100% 1025 64.0KB/s 00:00\\n')")
paste.run_metered([sys.executable, "-c", code], threading.Event(), 5,
paste.SCPMeter([1025], lambda *args: reports.append(args)))
self.assertEqual(reports[-1], ("uploading", 1025, 1025, 65536))
with self.assertRaises(paste.PasteError):
paste.run_metered([sys.executable, "-c", "raise SystemExit(2)"], threading.Event(), 5,
paste.SCPMeter([1], lambda *_: None))
cancel = threading.Event()
cancel.set()
with self.assertRaises(paste.PasteError):
paste.run_metered([sys.executable, "-c", "import time;time.sleep(30)"], cancel, 5,
paste.SCPMeter([1], lambda *_: None))
def test_display_restores_split_remote_title_and_never_changes_terminal_cells(self):
output = []
display = paste.UploadDisplay(output.append)
for byte in b"\x1b]2;remote app title\x1b\\":
display.observe(bytes([byte]))
with mock.patch.object(paste.time, "monotonic", return_value=10):
display.start(1048576)
with mock.patch.object(paste.time, "monotonic", return_value=13):
display.update("uploading", 524288, 1048576, 131072)
display.render()
display.render() # Throttled, not a second display update.
self.assertEqual(len(output), 2)
self.assertIn(b"Connecting", output[0])
self.assertIn(b"Uploading 50% | 512.0 KiB/1.0 MiB | 128.0 KiB/s | 3s", output[1])
self.assertIn(b"\x1b]9;4;1;50\x1b\\", output[1])
display.observe(b"\x1b]0;new remote title\x07")
display.finish()
self.assertEqual(output[-1], b"\x1b]9;4;0\x1b\\\x1b]2;new remote title\x1b\\")
display.finish()
self.assertEqual(len(output), 3)
self.assertTrue(all(b"\n" not in item and b"\r" not in item for item in output))
HARNESS = r'''
import os, runpy, sys, time, json
h = runpy.run_path(sys.argv[1])
paths, remote, mode, fail = json.loads(sys.argv[2])
class Upload:
def upload(self, files, cancel, progress):
assert files == paths
progress('uploading',512,1024,256)
time.sleep(0.1)
if fail == 'cancel':
assert cancel.wait(5)
if fail:
raise h['PasteError']('synthetic failure')
return remote.encode()
child = """import os,tty,base64
tty.setraw(0)
os.write(1, %r + b'CHILD_READY')
data=b''
while not data.endswith(b'\\r'):
part=os.read(0,65536)
if not part: break
data+=part
os.write(1,b'RECEIVED:' + base64.b64encode(data) + b':DONE')
raise SystemExit(7)
""" % (h['ENABLE'] if mode else h['DISABLE'])
raise SystemExit(h['relay']([sys.executable,'-c',child], lambda: paths, Upload()))
'''
class RelayTests(unittest.TestCase):
def test_resize_and_signal_shutdown_restore_terminal(self):
child = r'''
import fcntl,os,signal,struct,termios,tty
tty.setraw(0)
def resized(*_):
rows,cols,_,_=struct.unpack('HHHH',fcntl.ioctl(0,termios.TIOCGWINSZ,bytes(8)))
os.write(1,('SIZE:%d,%d;'%(rows,cols)).encode())
signal.signal(signal.SIGWINCH,resized)
resized()
while True: signal.pause()
'''
harness = "import runpy,sys;h=runpy.run_path(sys.argv[1]);h['relay']([sys.executable,'-c',sys.argv[2]],lambda:[],None)"
master, slave = pty.openpty()
original = termios.tcgetattr(slave)
import fcntl
fcntl.ioctl(slave, termios.TIOCSWINSZ, struct.pack("HHHH", 24, 80, 0, 0))
proc = subprocess.Popen([sys.executable, "-c", harness, str(SCRIPT), child],
stdin=slave, stdout=slave, stderr=slave)
output = bytearray()
def until(marker):
deadline = time.monotonic() + 5
while marker not in output:
self.assertLess(time.monotonic(), deadline, "Resize was not forwarded")
if select.select([master], [], [], 0.1)[0]:
output.extend(os.read(master, 65536))
try:
until(b"SIZE:24,80;")
fcntl.ioctl(slave, termios.TIOCSWINSZ, struct.pack("HHHH", 31, 110, 0, 0))
proc.send_signal(signal.SIGWINCH)
until(b"SIZE:31,110;")
proc.send_signal(signal.SIGTERM)
self.assertEqual(proc.wait(timeout=5), 128 + signal.SIGTERM)
restored = termios.tcgetattr(slave)
restored[3] &= ~getattr(termios, "PENDIN", 0)
original[3] &= ~getattr(termios, "PENDIN", 0)
self.assertEqual(restored, original)
finally:
if proc.poll() is None:
proc.kill()
proc.wait()
os.close(master)
os.close(slave)
def test_real_pty_upload_order_mouse_text_failure_exit_status_and_restoration(self):
with tempfile.TemporaryDirectory() as tmp:
file = Path(tmp) / "paste space 中文.txt"
file.write_text("synthetic fixture")
mouse = b"\x1b[<2;2;3M\x1b[<2;2;3m\x1b[<35;3;4M"
for mode, fail, ordinary in ((False, False, False), (True, False, False),
(True, True, False), (False, False, True),
(True, False, True), (True, 'cancel', False)):
with self.subTest(mode=mode, fail=fail, ordinary=ordinary):
master, slave = pty.openpty()
original = termios.tcgetattr(slave)
remote = shlex.quote("/home/test/.local/share/uuremote/uploads/paste.test/space 中文.txt")
config = json.dumps([[str(file)], remote, mode, fail])
proc = subprocess.Popen([sys.executable, "-c", HARNESS, str(SCRIPT), config],
stdin=slave, stdout=slave, stderr=slave)
output = bytearray()
try:
deadline = time.monotonic() + 10
while b"CHILD_READY" not in output:
self.assertLess(time.monotonic(), deadline, "PTY harness did not start")
if select.select([master], [], [], 0.1)[0]:
output.extend(os.read(master, 65536))
payload = b"ordinary\ntext" if ordinary else shlex.quote(str(file)).encode()
wire = mouse + paste.START + payload + paste.END
wire += b"\x03\r" if fail == 'cancel' else b"\r"
for byte in wire:
os.write(master, bytes([byte]))
while proc.poll() is None or select.select([master], [], [], 0)[0]:
self.assertLess(time.monotonic(), deadline, "PTY relay did not exit")
if select.select([master], [], [], 0.1)[0]:
try:
chunk = os.read(master, 65536)
except OSError as error:
if error.errno == errno.EIO:
break
raise
if not chunk:
break
output.extend(chunk)
self.assertEqual(proc.wait(timeout=2), 7)
encoded = bytes(output).split(b"RECEIVED:", 1)[1].split(b":DONE", 1)[0]
expected = b"" if fail else paste.paste_bytes(payload if ordinary else remote.encode(), mode)
interrupt = b"\x03" if fail == 'cancel' else b""
self.assertEqual(base64.b64decode(encoded), mouse + expected + interrupt + b"\r")
restored = termios.tcgetattr(slave)
# macOS sets PENDIN when restoring canonical input. It
# is kernel bookkeeping, not an unrestored user mode.
restored[3] &= ~getattr(termios, "PENDIN", 0)
original[3] &= ~getattr(termios, "PENDIN", 0)
self.assertEqual(restored, original)
if fail:
self.assertNotIn(str(file).encode(), output)
if not ordinary:
self.assertIn(b"UU upload: Connecting", output)
self.assertIn(b"\x1b]9;4;0\x1b\\", output)
if fail == 'cancel':
self.assertIn(b"UU upload: Cancelling", output)
finally:
if proc.poll() is None:
proc.kill()
proc.wait()
os.close(master)
os.close(slave)
@unittest.skipUnless(os.environ.get("UU_PASTE_TEST_HOST"), "set UU_PASTE_TEST_HOST for a real mapped SSH test")
class MappedSSHTests(unittest.TestCase):
def test_live_upload_reports_intermediate_progress_and_verified_completion(self):
host = os.environ["UU_PASTE_TEST_HOST"]
uploader = paste.Uploader(os.environ.get("UU_PASTE_TEST_CONFIG"), host)
uploader.scp.extend(["-l", "1024"]) # Deliberately slow a synthetic transfer.
reports = []
with tempfile.TemporaryDirectory() as tmp:
source = Path(tmp) / "private progress 中文.bin"
source.write_bytes(os.urandom(1024 * 1024))
paths = shlex.split(uploader.upload([str(source)], threading.Event(),
lambda *args: reports.append(args)).decode())
try:
total = source.stat().st_size
self.assertEqual(reports[0], ("connecting", 0, total, 0))
self.assertTrue(any(0 < done < total and speed > 0
for stage, done, size, speed in reports if stage == "uploading"))
self.assertEqual(reports[-1], ("finishing", total, total, 0))
self.assertNotIn(source.name, repr(reports))
remote = paste.run_private([*uploader.ssh, "sha256sum -- " + shlex.quote(paths[0])],
threading.Event(), 30)
self.assertEqual(remote.split()[0].decode(), hashlib.sha256(source.read_bytes()).hexdigest())
finally:
paste.run_private([*uploader.ssh, "rm -rf -- " + shlex.quote(str(Path(paths[0]).parent))],
threading.Event(), 30)
def test_paste_through_real_pty_and_uu_ssh_opens_uploaded_files(self):
host = os.environ["UU_PASTE_TEST_HOST"]
config = os.environ.get("UU_PASTE_TEST_CONFIG")
with tempfile.TemporaryDirectory() as tmp:
files = [Path(tmp) / "copied file 中文.bin", Path(tmp) / "literal'$(echo nope);.bin"]
for file in files:
file.write_bytes(os.urandom(65569))
hashes = [hashlib.sha256(f.read_bytes()).hexdigest() for f in files]
mouse = b"\x1b[<2;2;3M\x1b[<2;2;3m\x1b[<35;3;4M"
remote = r'''
import os,tty,shlex,hashlib,json,shutil
from pathlib import Path
tty.setraw(0)
os.write(1,b'\x1b[?2004hLIVE_READY')
data=b''
while not data.endswith(b'\r'):
data+=os.read(0,65536)
mouse=b'\x1b[<2;2;3M\x1b[<2;2;3m\x1b[<35;3;4M'
assert data.startswith(mouse+b'\x1b[200~') and data.endswith(b'\x1b[201~\r')
paths=shlex.split(data[len(mouse)+6:-7].decode())
assert len(paths)==2
hashes=[hashlib.sha256(Path(p).read_bytes()).hexdigest() for p in paths]
for directory in {Path(p).parent for p in paths}:
assert directory.parent==Path.home()/'.local/share/uuremote/uploads'
assert directory.name.startswith('paste.')
shutil.rmtree(directory)
os.write(1,b'LIVE_HASHES:'+json.dumps(hashes).encode()+b':DONE')
'''
harness = r'''
import runpy,sys,json
h=runpy.run_path(sys.argv[1])
host,config,paths,remote=json.loads(sys.argv[2])
uploader=h['Uploader'](config,host)
common=['-F',config] if config else []
raise SystemExit(h['relay'](['/usr/bin/ssh',*common,'-tt',host,remote],lambda:paths,uploader))
'''
args = json.dumps([host, config, [str(p) for p in files], "python3 -c " + shlex.quote(remote)])
master, slave = pty.openpty()
process = subprocess.Popen([sys.executable, "-c", harness, str(SCRIPT), args],
stdin=slave, stdout=slave, stderr=slave)
output = bytearray()
try:
deadline = time.monotonic() + 60
sent = False
while process.poll() is None or select.select([master], [], [], 0)[0]:
self.assertLess(time.monotonic(), deadline, "Live paste timed out")
if select.select([master], [], [], 0.1)[0]:
output.extend(os.read(master, 65536))
if b"LIVE_READY" in output and not sent:
payload = shlex.join([str(p) for p in files]).encode()
os.write(master, mouse + paste.START + payload + paste.END + b"\r")
sent = True
self.assertEqual(process.wait(timeout=2), 0)
received = bytes(output).split(b"LIVE_HASHES:", 1)[1].split(b":DONE", 1)[0]
self.assertEqual(json.loads(received), hashes)
finally:
if process.poll() is None:
process.kill()
process.wait()
os.close(master)
os.close(slave)
def test_real_upload_roundtrip_binary_unicode_and_shell_metacharacters(self):
host = os.environ["UU_PASTE_TEST_HOST"]
config = os.environ.get("UU_PASTE_TEST_CONFIG")
uploader = paste.Uploader(config, host)
with tempfile.TemporaryDirectory() as tmp:
root = Path(tmp)
files = [root / "space 中文.bin", root / "literal'$(echo nope);.bin"]
for file in files:
file.write_bytes(os.urandom(65569))
paths = shlex.split(uploader.upload([str(f) for f in files], threading.Event()).decode())
try:
for index, (source, remote) in enumerate(zip(files, paths)):
dest = root / ("download-" + str(index))
paste.run_private([*uploader.scp, f"{host}:{remote}", str(dest)], threading.Event(), 60)
self.assertEqual(hashlib.sha256(source.read_bytes()).digest(),
hashlib.sha256(dest.read_bytes()).digest())
directory = str(Path(paths[0]).parent)
mode = paste.run_private([*uploader.ssh, "stat -c %a -- " + shlex.quote(directory)],
threading.Event(), 30)
self.assertEqual(mode.strip(), b"700")
finally:
paste.run_private([*uploader.ssh, "rm -rf -- " + shlex.quote(str(Path(paths[0]).parent))],
threading.Event(), 30)
if __name__ == "__main__":
unittest.main()
+594
View File
@@ -0,0 +1,594 @@
#!/usr/bin/env python3
"""Paste Finder files into an SSH terminal through an existing UU TCP mapping."""
import argparse
import collections
import errno
import fcntl
import json
import os
from pathlib import Path
import pty
import queue
import re
import select
import shlex
import signal
import stat
import struct
import subprocess
import sys
import termios
import threading
import time
import tty
START, END = b"\x1b[200~", b"\x1b[201~"
ENABLE, DISABLE = b"\x1b[?2004h", b"\x1b[?2004l"
MAX_PASTE = 8 * 1024 * 1024
class PasteError(Exception):
"""Messages must not include clipboard contents, paths or subprocess output."""
def prefix_tail(data, marker):
for length in range(min(len(data), len(marker) - 1), 0, -1):
if data.endswith(marker[:length]):
return length
return 0
class InputFrames:
"""Recognize bracketed pastes across arbitrary PTY read boundaries."""
def __init__(self):
self.buffer = b""
self.pasting = False
self.overflow = False
def feed(self, data):
self.buffer += data
events = []
while self.buffer:
if self.pasting:
end = self.buffer.find(END)
if end < 0:
if len(self.buffer) > MAX_PASTE:
self.overflow = True
tail = prefix_tail(self.buffer, END)
self.buffer = self.buffer[-tail:] if tail else b""
break
payload, self.buffer = self.buffer[:end], self.buffer[end + len(END):]
events.append(("error" if self.overflow or len(payload) > MAX_PASTE else "paste", payload))
self.pasting = self.overflow = False
else:
start = self.buffer.find(START)
if start >= 0:
if start:
events.append(("data", self.buffer[:start]))
self.buffer = self.buffer[start + len(START):]
self.pasting = True
else:
tail = prefix_tail(self.buffer, START)
size = len(self.buffer) - tail
if size:
events.append(("data", self.buffer[:size]))
self.buffer = self.buffer[size:]
break
return events
def flush_key(self):
# A standalone Escape must not wait indefinitely for another key.
if not self.pasting:
result, self.buffer = self.buffer, b""
return result
return b""
class OutputModes:
"""Keep local paste framing on; retain the remote app's requested mode."""
def __init__(self):
self.buffer = b""
self.bracketed = False
def feed(self, data):
self.buffer += data
output = bytearray()
while self.buffer:
index = self.buffer.find(b"\x1b")
if index < 0:
output.extend(self.buffer)
self.buffer = b""
break
output.extend(self.buffer[:index])
self.buffer = self.buffer[index:]
if self.buffer.startswith(b"\x1bc"):
output.extend(b"\x1bc" + ENABLE)
self.bracketed = False
self.buffer = self.buffer[2:]
continue
match = re.match(rb"\x1b\[\?([0-9;]+)([hl])", self.buffer)
if match:
params = match[1].split(b";")
if b"2004" in params:
self.bracketed = match[2] == b"h"
others = [p for p in params if p != b"2004"]
if others:
output.extend(b"\x1b[?" + b";".join(others) + match[2])
output.extend(ENABLE)
else:
output.extend(match[0])
self.buffer = self.buffer[match.end():]
elif len(self.buffer) < 128 and re.fullmatch(rb"\x1b(?:\[(?:\?[0-9;]*)?)?", self.buffer):
break
else:
output.extend(self.buffer[:1])
self.buffer = self.buffer[1:]
return bytes(output)
def paste_bytes(data, bracketed):
return START + data + END if bracketed else data
def clipboard_paths(helper):
try:
result = subprocess.run([str(helper)], capture_output=True, timeout=3, check=True)
paths = json.loads(result.stdout)
if not isinstance(paths, list) or not all(isinstance(p, str) for p in paths):
raise ValueError()
return paths
except (OSError, ValueError, subprocess.SubprocessError):
raise PasteError("Cannot check copied files; paste was not sent.") from None
def copied_files(data, read_clipboard):
try:
text = data.decode("utf-8")
paths = shlex.split(text)
except (UnicodeError, ValueError):
return None
if not paths or not all(p.startswith("/") for p in paths):
return None
# Ordinary text that happens to name a local file must never upload it.
# Ghostty 1.3.1 getOpinionatedStringContents escapes Finder file paths;
# require the entire pasted path list to match actual file-URL clipboard data.
if paths != read_clipboard():
return None
if len(paths) > 256:
raise PasteError("Too many copied files (maximum 256).")
for path in paths:
if any(ord(c) < 32 or ord(c) == 127 for c in path):
raise PasteError("A copied filename contains unsupported control characters.")
try:
if not stat.S_ISREG(os.stat(path).st_mode):
raise PasteError("Copy files individually; folder pasting is not supported.")
except OSError:
raise PasteError("A copied file is no longer readable.") from None
if len({Path(p).name for p in paths}) != len(paths):
raise PasteError("Copied files must have distinct filenames; paste them separately.")
return paths
class SCPMeter:
"""Reduce OpenSSH's private progress output to numeric batch counters."""
# OpenSSH progressmeter.c writes: filename percent size rate time [ETA].
# Anchor at the numeric suffix; filenames and errors are never displayed.
record = re.compile(rb" (\d{1,3})%\s+(\d{1,20}(?:[KMGT]B)?)\s+"
rb"(\d{1,20}(?:\.\d{1,10})?[KMGT]B)/s\s+"
rb"(?:\d+:\d\d(?::\d\d)?(?: ETA)?|--:-- ETA|- stalled -)\s*$")
def __init__(self, sizes, report):
self.sizes, self.report = sizes, report
self.buffer, self.index, self.finished = b"", 0, 0
self.current, self.percent = 0, 0
@staticmethod
def amount(token):
match = re.fullmatch(rb"(\d+(?:\.\d+)?)([KMGT])?B?", token)
return int(float(match[1]) * 1024 ** (b" KMGT".index(match[2]) if match[2] else 0))
def parse(self, line):
match = self.record.search(line)
if not match or self.index >= len(self.sizes):
return
percent = int(match[1])
if percent > 100:
return
self.percent = max(self.percent, percent)
size = self.sizes[self.index]
self.current = max(self.current, min(size, self.amount(match[2])))
if percent == 100:
self.current = size
self.report("uploading", self.finished + self.current, sum(self.sizes), self.amount(match[3]))
def feed(self, data):
for piece in re.split(rb"([\r\n])", data):
if piece in (b"\r", b"\n"):
self.parse(self.buffer)
self.buffer = b""
if piece == b"\n" and self.percent == 100:
self.finished += self.sizes[self.index]
self.index += 1
self.current = self.percent = 0
else:
# Keep only enough for a numeric suffix, not unlimited errors.
self.buffer = (self.buffer + piece)[-512:]
self.parse(self.buffer)
def run_metered(args, cancel, timeout, meter):
master, slave = pty.openpty()
fcntl.ioctl(slave, termios.TIOCSWINSZ, struct.pack("HHHH", 24, 120, 0, 0))
try:
# The upload runs on a worker thread, so avoid Python preexec_fn after
# fork. Acquire the private controlling TTY in a fresh interpreter.
launch = ("import fcntl,os,sys,termios;fcntl.ioctl(1,termios.TIOCSCTTY,0);"
"os.execv(sys.argv[1],sys.argv[1:])")
with subprocess.Popen([sys.executable, "-c", launch, *args],
stdin=subprocess.DEVNULL, stdout=slave, stderr=slave,
start_new_session=True) as process:
os.close(slave)
slave = None
deadline = time.monotonic() + timeout
try:
while True:
if cancel.is_set() or time.monotonic() > deadline:
raise PasteError("Upload cancelled or timed out; paste was not sent.")
if select.select([master], [], [], 0.1)[0]:
try:
data = os.read(master, 65536)
except OSError as error:
if error.errno != errno.EIO:
raise
data = b""
if not data:
break
meter.feed(data)
elif process.poll() is not None:
break
try:
status = process.wait(timeout=max(0.1, deadline - time.monotonic()))
except subprocess.TimeoutExpired:
raise PasteError("Upload timed out; paste was not sent.") from None
if status:
raise PasteError("Upload failed; paste was not sent.")
finally:
if process.poll() is None:
os.killpg(process.pid, signal.SIGKILL)
process.wait()
finally:
os.close(master)
if slave is not None:
os.close(slave)
return b""
def run_private(args, cancel, timeout, meter=None):
# Neither SSH errors nor SCP output may disclose paths, clipboard/file data,
# or credentials. Authentication never reads from the interactive terminal.
if meter is not None:
return run_metered(args, cancel, timeout, meter)
with subprocess.Popen(args, stdin=subprocess.DEVNULL, stdout=subprocess.PIPE,
stderr=subprocess.DEVNULL, start_new_session=True) as process:
deadline = time.monotonic() + timeout
while True:
if cancel.is_set() or time.monotonic() > deadline:
os.killpg(process.pid, signal.SIGKILL)
process.communicate()
raise PasteError("Upload cancelled." if cancel.is_set() else "Upload timed out; paste was not sent.")
try:
stdout, _ = process.communicate(timeout=0.1)
if process.returncode:
raise PasteError("Upload failed; check the UU mapping and SSH access. Paste was not sent.")
return stdout
except subprocess.TimeoutExpired:
pass
class Uploader:
def __init__(self, config, host):
common = ["-F", str(config)] if config else []
common += ["-o", "BatchMode=yes", "-o", "ConnectTimeout=15"]
self.ssh = ["/usr/bin/ssh", *common, host]
self.scp = ["/usr/bin/scp", "-q", *common]
self.host = host
def upload(self, paths, cancel, progress=None):
sizes = [os.stat(path).st_size for path in paths] if progress else []
if progress:
progress("connecting", 0, sum(sizes), 0)
script = ('umask 077; d="$HOME/.local/share/uuremote/uploads"; '
'mkdir -p "$d" && mktemp -d "$d/paste.XXXXXXXX"')
try:
directory = run_private([*self.ssh, script], cancel, 30).decode("utf-8").strip()
except UnicodeError:
raise PasteError("Invalid upload destination; paste was not sent.") from None
if (not directory.startswith("/") or len(directory) > 4096 or
any(ord(c) < 32 or ord(c) == 127 for c in directory) or
not re.fullmatch(r"paste\.[A-Za-z0-9]+", directory.rsplit("/", 1)[-1])):
raise PasteError("Invalid upload destination; paste was not sent.")
try:
# Use modern SCP's SFTP mode, never legacy SCP (-O). Unique batch
# directories prevent overwrites; all local paths are absolute.
if progress:
progress("uploading", 0, sum(sizes), 0)
scp = self.scp[:1] + self.scp[2:] # Remove only our own -q.
run_private([*scp, *paths, f"{self.host}:{directory}/"], cancel, 300,
SCPMeter(sizes, progress))
progress("finishing", sum(sizes), sum(sizes), 0)
else:
run_private([*self.scp, *paths, f"{self.host}:{directory}/"], cancel, 300)
except (PasteError, OSError):
# Clean only this batch, with quoted remote shell syntax. Cancellation
# of one upload must not stop another SSH/UU session.
try:
run_private([*self.ssh, "rm -rf -- " + shlex.quote(directory)], threading.Event(), 10)
except (PasteError, OSError):
pass
raise
return " ".join(shlex.quote(directory + "/" + Path(p).name) for p in paths).encode("utf-8")
def write_all(fd, data):
view = memoryview(data)
while view:
view = view[os.write(fd, view):]
def display_size(size):
for unit in ("B", "KiB", "MiB", "GiB", "TiB"):
if size < 1024 or unit == "TiB":
return f"{size:.0f} {unit}" if unit == "B" else f"{size:.1f} {unit}"
size /= 1024
class UploadDisplay:
"""Session-local title and OSC 9;4 progress; terminal cells stay untouched."""
# https://ghostty.org/docs/vt/osc/conemu: states 0=clear, 1=percent, 3=busy.
def __init__(self, emit):
self.emit, self.active = emit, False
self.title, self.pending = b"UU SSH", b""
self.state = ("connecting", 0, 0, 0)
self.started = self.rendered = 0
def observe(self, data):
self.pending = (self.pending + data)[-8192:]
for match in re.finditer(rb"\x1b\][02];([^\x07\x1b]*)(?:\x07|\x1b\\)", self.pending):
self.title = match[1]
# Retain only an incomplete OSC title across output reads.
index = self.pending.rfind(b"\x1b]")
if index < 0:
self.pending = b"\x1b" if self.pending.endswith(b"\x1b") else b""
else:
tail = self.pending[index:]
self.pending = tail if b"\x07" not in tail and b"\x1b\\" not in tail else b""
def start(self, total):
self.active = True
self.started = time.monotonic()
self.state = ("connecting", 0, total, 0)
self.render(force=True)
def update(self, stage, done, total, speed):
self.state = stage, done, total, speed
def render(self, force=False):
now = time.monotonic()
if not self.active or (not force and now - self.rendered < 0.2):
return
self.rendered = now
stage, done, total, speed = self.state
elapsed = int(now - self.started)
if stage in ("connecting", "cancelling"):
label = "Connecting" if stage == "connecting" else "Cancelling"
text = f"UU upload: {label} | {display_size(total)} | {elapsed}s"
indicator = b"\x1b]9;4;3\x1b\\"
else:
percent = min(100, int(done * 100 / total)) if total else 100
label = "Finishing" if stage == "finishing" else "Uploading"
text = (f"UU upload: {label} {percent}% | {display_size(done)}/{display_size(total)}"
f" | {display_size(speed)}/s | {elapsed}s")
indicator = f"\x1b]9;4;1;{percent}\x1b\\".encode()
self.emit(b"\x1b]2;" + text.encode() + b"\x1b\\" + indicator)
def finish(self):
if self.active:
self.active = False
self.emit(b"\x1b]9;4;0\x1b\\\x1b]2;" + self.title + b"\x1b\\")
def relay(command, read_clipboard, uploader):
original = termios.tcgetattr(0)
master, slave = pty.openpty()
def resize(*_):
try:
size = fcntl.ioctl(0, termios.TIOCGWINSZ, bytes(8))
fcntl.ioctl(master, termios.TIOCSWINSZ, size)
except OSError:
pass
resize()
def child_tty():
os.setsid()
fcntl.ioctl(0, termios.TIOCSCTTY, 0)
child = subprocess.Popen(command, stdin=slave, stdout=slave, stderr=slave, preexec_fn=child_tty)
os.close(slave)
previous_resize = signal.signal(signal.SIGWINCH, resize)
def shutdown(signum, _frame):
raise SystemExit(128 + signum)
previous_signals = {sig: signal.signal(sig, shutdown)
for sig in (signal.SIGHUP, signal.SIGTERM, signal.SIGINT)}
frames, modes = InputFrames(), OutputModes()
events, completed = collections.deque(), queue.Queue()
updates = queue.Queue()
display = UploadDisplay(lambda data: write_all(1, data))
cancel, uploading, interrupted = threading.Event(), False, False
worker = None
last_input = time.monotonic()
def upload_worker(paths):
try:
completed.put((uploader.upload(paths, cancel, lambda *args: updates.put(args)), None))
except (OSError, PasteError):
completed.put((None, "Upload failed or cancelled; paste was not sent."))
def notice(message):
write_all(2, ("\r\n[UU paste] " + message + "\r\n").encode())
def interrupt_upload():
nonlocal interrupted, frames
if not uploading:
return
pending = list(events)
positions = [(i, payload.rfind(b"\x03")) for i, (kind, payload) in enumerate(pending)
if kind == "data" and b"\x03" in payload]
if positions:
index, offset = positions[-1]
cancel.set()
interrupted = True
_, done, total, _ = display.state
display.update("cancelling", done, total, 0)
display.render(force=True)
frames = InputFrames()
events.clear()
events.extend(frames.feed(pending[index][1][offset + 1:]))
events.extend(pending[index + 1:])
write_all(master, b"\x03")
try:
tty.setraw(0)
write_all(1, ENABLE)
while True:
interrupt_upload()
while not updates.empty():
update = updates.get_nowait()
if not interrupted:
display.update(*update)
if uploading:
display.render()
try:
data, error = completed.get_nowait()
except queue.Empty:
pass
else:
uploading = False
display.finish()
if error:
notice(error)
elif not interrupted:
write_all(master, paste_bytes(data, modes.bracketed))
while events and not uploading:
kind, data = events.popleft()
if kind == "error":
notice("Paste exceeds 8 MiB; paste was not sent.")
continue
if kind == "data":
write_all(master, data)
continue
try:
files = copied_files(data, read_clipboard)
except PasteError as error:
notice(str(error))
continue
if files is None:
write_all(master, paste_bytes(data, modes.bracketed))
else:
try:
total = sum(os.stat(path).st_size for path in files)
except OSError:
notice("A copied file is no longer readable; paste was not sent.")
continue
cancel.clear()
uploading, interrupted = True, False
display.start(total)
worker = threading.Thread(target=upload_worker, args=(files,), daemon=True)
worker.start()
interrupt_upload()
readable, _, _ = select.select([0, master], [], [], 0.025)
if master in readable:
try:
data = os.read(master, 65536)
except OSError as error:
if error.errno != errno.EIO:
raise
data = b""
if not data:
break
display.observe(data)
write_all(1, modes.feed(data))
if 0 in readable:
data = os.read(0, 65536)
if not data:
break
last_input = time.monotonic()
events.extend(frames.feed(data))
if sum(len(payload) for _, payload in events) > MAX_PASTE:
events.clear()
notice("Input queue is full; queued input was discarded.")
elif time.monotonic() - last_input > 0.025:
data = frames.flush_key()
if data:
events.append(("data", data))
if modes.buffer:
write_all(1, modes.buffer)
finally:
cancel.set()
signal.signal(signal.SIGWINCH, previous_resize)
for sig, previous in previous_signals.items():
signal.signal(sig, previous)
termios.tcsetattr(0, termios.TCSADRAIN, original)
display.finish()
write_all(1, DISABLE)
os.close(master)
if child.poll() is None:
try:
child.wait(timeout=2)
except subprocess.TimeoutExpired:
os.killpg(child.pid, signal.SIGTERM)
try:
child.wait(timeout=2)
except subprocess.TimeoutExpired:
os.killpg(child.pid, signal.SIGKILL)
status = child.wait()
if worker is not None:
worker.join(timeout=12)
return status if status >= 0 else 128 - status
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("-F", "--ssh-config", type=Path)
parser.add_argument("host", help="SSH alias for an existing UU loopback port mapping")
parser.add_argument("command", nargs=argparse.REMAINDER)
args = parser.parse_args()
if not re.fullmatch(r"[A-Za-z0-9][A-Za-z0-9_.@-]*", args.host):
parser.error("use an SSH host alias, without options or a port")
common = ["-F", str(args.ssh_config)] if args.ssh_config else []
command = ["/usr/bin/ssh", *common]
if not (os.isatty(0) and os.isatty(1)):
os.execv(command[0], [*command, args.host, *args.command])
helper = Path(__file__).resolve().with_name("clipboard-files")
if not helper.is_file():
parser.error("run contrib/macos-ssh/install.sh on your Mac first")
return relay([*command, "-tt", args.host, *args.command],
lambda: clipboard_paths(helper), Uploader(args.ssh_config, args.host))
if __name__ == "__main__":
try:
sys.exit(main())
except (OSError, PasteError):
print("UU SSH companion failed; check the UU mapping and SSH configuration.", file=sys.stderr)
sys.exit(1)
+21
View File
@@ -0,0 +1,21 @@
# 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.
FROM ubuntu:24.04
ARG VERSION=v0.2.20
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.licenses="GPL-3.0"
RUN apt-get update \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
ca-certificates curl bash libx11-6 libxext6 libxtst6 libxfixes3 libgtk-3-0 \
&& cd /tmp \
&& base="https://github.com/VallierDev/uu-remote-linux/releases/download/${VERSION}/uu-remote-linux-${VERSION}-x86_64-linux.tar.gz" \
&& curl -fsSLO "$base" && curl -fsSLO "$base.sha256" && sha256sum -c "uu-remote-linux-${VERSION}-x86_64-linux.tar.gz.sha256" \
&& tar xzf "uu-remote-linux-${VERSION}-x86_64-linux.tar.gz" \
&& install -m755 "$(find /tmp -name uuremote-server -type f | head -1)" /usr/local/bin/uuremote-server \
&& rm -rf /tmp/* /var/lib/apt/lists/*
# Credentials live in /config (keep it private); /data is what file transfer and the terminal see as home.
ENV UU_CONFIG=/config/config.json UU_DESKTOP_BACKEND=none UU_LOGIN_WINDOW=0 UU_AUDIO=0 RUST_LOG=info HOME=/data
VOLUME ["/config", "/data"]
WORKDIR /data
ENTRYPOINT ["uuremote-server"]
+9
View File
@@ -0,0 +1,9 @@
# Docker(群晖 / NAS,无桌面)
本目录是 [`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux) 镜像的构建文件。
**部署和使用步骤见 [docs/deploy-nas-docker.md](../docs/deploy-nas-docker.md)。**
This directory builds the `ghcr.io/vallierdev/uu-remote-linux` image; see
[docs/deploy-nas-docker.md](../docs/deploy-nas-docker.md#english) for deployment.
自行构建 / build locally: `docker compose build`(`Dockerfile` 从 GitHub 发布包安装 `uuremote-server`,可用 `--build-arg VERSION=vX.Y.Z` 指定版本)。
+13
View File
@@ -0,0 +1,13 @@
# docker compose up -d (first run: log in once, see README.md in this directory)
services:
uu-remote:
image: ghcr.io/vallierdev/uu-remote-linux:latest
build: .
container_name: uu-remote
# Host networking gives WebRTC direct UDP paths; bridge mode also works but falls back to relays more often.
network_mode: host
restart: unless-stopped
volumes:
- ./config:/config
# Folder offered to file transfer and the terminal (change to your share, e.g. /volume1/homes/you).
- ./data:/data
+133
View File
@@ -0,0 +1,133 @@
# 群晖 / NAS 部署指南(Docker,无桌面)
**简体中文** | [English](#english)
镜像:[`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux)
(标签 `latest` 或具体版本如 `v0.2.8`)
把本项目主机跑在没有桌面的 NAS 上之后,就能在外面用官方 UU 远程客户端(手机 / Mac / Windows):
| 功能 | 说明 |
|---|---|
| 文件传输 | 收发 NAS 上的文件(只开放你挂进容器的文件夹) |
| 终端 | 打开容器里的命令行(bash) |
| 端口映射 | 经 UU 访问家里局域网的服务:NAS 管理页、路由器、其他电脑的 SSH / 远程桌面等 |
**不提供远程桌面**(NAS 没有图形界面,点「远程桌面」会一直显示正在连接,属正常)。
## 准备
- x86_64 的 NAS(群晖 DSM 7.2 及以上已安装「Container Manager」,或任意装了 Docker 的 Linux NAS)。ARM 机型暂不支持。
- 能 SSH 登录 NAS(群晖:控制面板 → 终端机和 SNMP → 启用 SSH),并有管理员权限(`sudo`)。
- 手机上的 UU 远程 App,用于扫码登录。
## 第一步:建目录和配置
SSH 登录 NAS,新建一个目录(下面以 `/volume1/docker/uu-remote` 为例):
```sh
sudo mkdir -p /volume1/docker/uu-remote/config
sudo chmod 700 /volume1/docker/uu-remote/config
cd /volume1/docker/uu-remote
```
新建 `compose.yaml`,内容如下。把 `/volume1/共享文件夹` 改成你想远程访问的文件夹(可以写多行挂多个):
```yaml
services:
uu-remote:
image: ghcr.io/vallierdev/uu-remote-linux:latest
container_name: uu-remote
network_mode: host # 让远程连接尽量走直连,速度更快
restart: unless-stopped
volumes:
- ./config:/config # 登录信息,请勿外传
- /volume1/共享文件夹:/data # 文件传输和终端看到的目录
```
## 第二步:扫码登录(只需一次)
```sh
sudo docker compose pull
sudo docker compose run --rm uu-remote login --no-gui
```
终端里会显示一个二维码:用手机 UU 远程扫码并确认。看到登录成功的提示后,按 `Ctrl+C` 退出(如果没有自动退出)。
> 二维码等同于你的登录凭据,**不要截图或发给别人**。登录信息保存在 `config/config.json`。
> 一定要用上面的 `docker compose run`(主机网络),这样设备在列表里显示的是 NAS 的名字;
> 若用普通 `docker run` 登录,设备名会是一串随机字符。
## 第三步:启动
```sh
sudo docker compose up -d
sudo docker compose logs -f
```
日志里出现 `availability=Some("ready")` 就说明上线了,按 `Ctrl+C` 退出日志查看(容器继续在后台运行)。
之后 NAS 开机会自动启动它。
**用群晖界面管理**:Container Manager → 项目 → 新增,路径选 `/volume1/docker/uu-remote`,会自动读取 `compose.yaml`。
首次登录仍需在 SSH 里执行第二步。
## 使用
打开官方 UU 远程客户端,在「我的设备」里找到你的 NAS(显示为 Windows 设备,这是正常的):
- **文件传输**:浏览、上传、下载 `/data` 里的文件。
- **终端**:进入容器的命令行,当前目录是 `/data`。注意这是容器而不是 NAS 系统本身。
- **端口映射**:例如目标填 `127.0.0.1`、端口 `5000`,就能在本地浏览器打开 NAS 的 DSM 管理页;
填局域网里其他设备的地址和端口(如 `192.168.1.10:22`)即可访问那台设备的服务。
## 更新
```sh
cd /volume1/docker/uu-remote
sudo docker compose pull && sudo docker compose up -d
```
`config` 目录保留即可,不用重新登录。
## 停用与移除
```sh
sudo docker compose down # 停止并删除容器
```
再在官方客户端的设备列表里删除这台设备;如需彻底清除登录信息,删除 `config` 目录。
## 常见问题
- **设备名是一串随机字符**:登录时没有用主机网络。删除 `config/config.json`,按第二步用 `docker compose run` 重新登录。
- **一直不上线**:`sudo docker compose logs --tail 100` 查看日志;确认 NAS 能访问外网。
- **连接慢、经常卡**:确认 `network_mode: host` 没有被去掉。
- **想要远程桌面**:NAS 上不支持;请在有桌面的 Linux 电脑上安装主机端(见主 README)。
安全提示:只挂需要远程访问的文件夹;端口映射可以访问 NAS 所在局域网,请保管好 UU 账号。
---
## English
Image: [`ghcr.io/vallierdev/uu-remote-linux`](https://github.com/VallierDev/uu-remote-linux/pkgs/container/uu-remote-linux)
Runs this project's host headless on a desktop-less NAS (x86_64, e.g. Synology DSM 7.2+ with Container Manager) for the
official UU Remote clients: **file transfer** (folders you mount at `/data`), **terminal** (bash inside the container) and
**port mapping** into your LAN. No remote desktop.
```sh
sudo mkdir -p /volume1/docker/uu-remote/config && sudo chmod 700 /volume1/docker/uu-remote/config
cd /volume1/docker/uu-remote
# compose.yaml: image ghcr.io/vallierdev/uu-remote-linux:latest, network_mode: host,
# volumes ./config:/config and /volume1/your-share:/data (see the Chinese section above)
sudo docker compose pull
sudo docker compose run --rm uu-remote login --no-gui # scan the QR with the UU mobile app; the QR is a credential
sudo docker compose up -d
sudo docker compose logs -f # wait for availability=Some("ready")
```
Update with `docker compose pull && docker compose up -d` (keep `config/`). Remove with `docker compose down`, then delete
the device in the official client.
**Unofficial project, not affiliated with NetEase.**
Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 161 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 255 KiB

+18
View File
@@ -0,0 +1,18 @@
修复 iPhone 上「超清 / 原画」「常规 / 真彩」点不动。/ Fix iPhone quality and chroma choices being locked.
### 修复 / Fixed
- **iPhone 无法切换画质与真彩**(#49,感谢 @RiverOnVenus 的细致排查):连接本项目主机时,iPhone 的「超清」「原画」
以及「常规 / 真彩」按钮点了没反应,只有帧率能改。原因是主机发出的设备能力消息(`forward_setting` 的 `device_capability`)
格式与官方 Windows 被控端不一致,iPhone 无法识别,于是锁定在默认值。现在按官方格式发送设备能力(含 4:4:4 等真实支持的格式),
并补发发送参数 `sender_para_info`。
已实测:iPhone(UU 远程 4.42.0)连接修复后的主机,可以切换画质(主机收到新的画质请求)。Mac 客户端不依赖这条消息,此前即正常。
- Device capability is now sent in the official nested shape (and `sender_para_info` is added), so the iPhone client unlocks
quality and chroma choices. Verified with the UU iPhone app 4.42.0.
### 其他 / Other
- 控制端窗口与主机使用同一图标,并新增控制端启动项 `contrib/desktop/uu-remote-linux-viewer.desktop`(#13)。
### 下载 / Download
`uu-remote-linux-v0.2.10-x86_64-linux.tar.gz`(主机 `uuremote-server` + 控制端 `uuremote-viewer`,附带 `contrib/`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.10`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+20
View File
@@ -0,0 +1,20 @@
Wayland(wlroots)手机输入法上屏;登录默认直连,不走环境代理。/ Mobile IME text on wlroots Wayland; cloud API ignores ambient proxies by default.
### 新增 / Added
- **wlroots Wayland 支持手机输入法 `text_input`**(#51,感谢 @hiclaw):手机端输入法提交的文字,
在 Hyprland / Sway 等 wlroots 合成器上通过虚拟键盘的备用键码上屏。仅在 Hyprland 0.56.2 上实测;
KWin / GNOME(门户后端)仍不支持,见 #50。
- Mobile IME `text_input` now types through the virtual keyboard's spare keycodes on wlroots compositors.
Tested on Hyprland 0.56.2 only; KWin/GNOME (portal backend) are not covered yet.
### 变更 / Changed
- **云端接口默认忽略代理环境变量**(#52,感谢 @aresbit):本地有拦截 TLS 的 HTTP/SOCKS 代理时,登录会报
`tls handshake eof`。现在主机和控制端访问网易服务器默认直连,忽略 `http_proxy` / `https_proxy` / `all_proxy`;
确实需要经代理上网的环境请设置 `UU_USE_PROXY=1`。未在拦截代理环境中实机验证,CI 测试通过。
- Cloud API clients now bypass `http_proxy` / `https_proxy` / `all_proxy` by default; set `UU_USE_PROXY=1` if your
network requires a proxy. Not verified against an intercepting proxy; CI passes.
### 下载 / Download
`uu-remote-linux-v0.2.11-x86_64-linux.tar.gz`(主机 `uuremote-server` + 控制端 `uuremote-viewer`,附带 `contrib/`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.11`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+15
View File
@@ -0,0 +1,15 @@
修复缩放桌面尺寸为奇数时画面一直「正在传输」。/ Fix the stream never starting when the captured desktop has an odd size.
### 修复 / Fixed
- **奇数尺寸桌面无法出画面**(#53,感谢 @wen0531):KDE Plasma(Wayland,门户后端)150% 缩放、两块屏上下排列时,
逻辑桌面为 2560x2507,H.264/HEVC 编码器要求偶数宽高,全部启动失败,客户端一直停在「正在传输画面」。
现在原生分辨率采集遇到奇数宽高时,在右/下补齐 1 像素黑边再编码;偶数尺寸、「其他分辨率」缩放不受影响。
贡献者已在 KDE Plasma 6.7 / Wayland / NVENC + 官方安卓客户端上实测。进程内编码(`inproc-av`)路径未覆盖。
- When the native capture size is odd (e.g. scaled stacked monitors), the encoder input is padded by one black
row/column so every H.264/HEVC encoder can open. Verified by the contributor on KDE Plasma 6.7 (Wayland, NVENC).
The optional `inproc-av` path is not covered.
### 下载 / Download
`uu-remote-linux-v0.2.12-x86_64-linux.tar.gz`(主机 `uuremote-server` + 控制端 `uuremote-viewer`,附带 `contrib/`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.12`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+25
View File
@@ -0,0 +1,25 @@
一个包支持所有桌面:Wayland 和 GNOME/KDE 不再需要源码编译。/ One package for every desktop: no source build needed for Wayland or GNOME/KDE.
### 新增 / Added
- **预编译包内置 Wayland 与 GNOME/KDE 支持**(#43、#54):Release 包新增 `libuu-wayland.so`(Hyprland / Sway / niri 等 wlroots)
和 `libuu-portal.so`(GNOME / KDE Wayland)。程序按当前会话自动选择后端,只在 Wayland 会话里加载对应插件,X11 用户不需要任何
Wayland 库。安装:
```sh
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/
```
系统要求:X11 与 wlroots 为 glibc ≥ 2.35;GNOME/KDE 插件为 glibc ≥ 2.39(Ubuntu 24.04、Fedora 40、Debian 13 及更新)及 libei ≥ 1.1。
缺库或版本过旧时日志会写明原因。**验证范围**:插件加载、回退与报错在 Hyprland 虚拟机(ARM)实测,wlroots 采集正常;
预编译的 GNOME/KDE 插件尚未在真机上完成画面/键鼠验收(引擎代码本身未改动)。Wayland 仍为实验性。
- The release now ships `libuu-wayland.so` and `libuu-portal.so`, loaded at runtime only on Wayland sessions; X11 hosts need no
Wayland libraries. The portal plugin requires glibc >= 2.39 and libei >= 1.1. Plugin loading was tested on a Hyprland VM;
the prebuilt GNOME/KDE plugin has not yet been accepted on real hardware.
### 改进 / Improved
- 在 GNOME/KDE Wayland 上缺少 portal 支持时,不再反复报看不懂的 `portal unavailable (code 2)`,而是直接说明原因和解决办法(#43)。
- README:支持表加入 niri(实验性,协议已按源码确认、未实机验收);systemd 单元名须为 `uuremote-native.service`;uinput 无人值守授权示例(#55)。
### 下载 / Download
`uu-remote-linux-v0.2.13-x86_64-linux.tar.gz`(`uuremote-server`、`uuremote-viewer`、`libuu-wayland.so`、`libuu-portal.so`、`contrib/`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.13`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+20
View File
@@ -0,0 +1,20 @@
Hyprland 双屏点击偏移修复,并可在手机端切换显示器(实验性)。/ Hyprland dual-monitor pointer fix and opt-in monitor switching.
### 修复 / Fixed
- **Hyprland 双屏点击偏移**(#57,感谢 @JuanZoran):原生 Wayland 后端的绝对鼠标定位改为绑定正在采集的输出
(此前 uinput 绝对坐标映射到整个桌面,双屏时点击位置偏移)。uinput 仍用于键盘、按键和相对移动。
**影响所有 Hyprland 用户的默认路径**;单屏下映射结果与之前等价。贡献者已在双屏真机(2560×1440@125% + 1920×1080@133%)
上验证落点误差 ≤ 2 像素;维护者未另行复测。
- Absolute pointer motion on the native Wayland backend is now bound to the captured output (it previously spanned the whole
desktop through uinput, offsetting clicks on multi-monitor setups). Verified by the contributor on real dual-monitor hardware.
### 新增 / Added
- **Hyprland 多显示器切换(实验性,默认关闭)**:设置 `UU_WAYLAND_MULTISCREEN=1` 后,手机端可以选择物理显示器,画面与
鼠标定位同步切换;`UU_WAYLAND_OUTPUT` 指定默认屏幕。通过 `hyprctl` 枚举未旋转的显示器,插拔或布局变化后需重启服务;
切换失败会恢复原屏。由贡献者用官方手机客户端在 Omarchy / Hyprland 双屏上实测。
- Opt-in Hyprland monitor switching (`UU_WAYLAND_MULTISCREEN=1`), accepted by the contributor with the official phone client.
### 下载 / Download
`uu-remote-linux-v0.2.14-x86_64-linux.tar.gz`(含 `libuu-wayland.so` / `libuu-portal.so`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.14`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+18
View File
@@ -0,0 +1,18 @@
ARM64 预编译包;无硬件编码器时默认 H.264。/ aarch64 release package; CPU-only hosts default to H.264.
### 新增 / Added
- **aarch64 预编译包**(#59,感谢 @DeliciousBuding):新增 `uu-remote-linux-v0.2.15-aarch64-linux.tar.gz`,与 x86_64 包相同,
含 `uuremote-server`、`uuremote-viewer` 和两个桌面引擎插件;ARM64 主机不再需要源码编译。CI 新增 ARM64 原生构建与测试(#58)。
aarch64 包由 GitHub ARM runner 构建,尚未在真实 ARM 主机上运行验收。
- New aarch64 release package (same contents as x86_64), built on GitHub ARM runners; not yet run on real ARM hardware.
### 变更 / Changed
- **只有 CPU 编码时默认使用 H.264**(#59):libx265 比 libx264 慢约 10 倍(4 核 Ampere A1 上 1080p 约 15 帧对 155 帧),
原先 CPU 主机默认 H.265 会掉到十几帧。现在只有使用硬件编码器(NVENC / 显式 VAAPI)时才自动选 H.265;
`UU_VIDEO_CODEC=h265` 仍可强制 H.265。NVENC / VAAPI 主机行为不变。
- Without NVENC/VAAPI the host now picks H.264 even when both sides offer H.265; `UU_VIDEO_CODEC=h265` forces H.265.
### 下载 / Download
`uu-remote-linux-v0.2.15-x86_64-linux.tar.gz` / `uu-remote-linux-v0.2.15-aarch64-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.15`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+18
View File
@@ -0,0 +1,18 @@
KDE 远程期间不再自动锁屏;锁屏和黑屏原因写进日志。/ No idle lock on KDE during remote sessions; lock and black-screen hints.
### 修复 / Fixed
- **KDE Wayland 远程操作中途自动锁屏**(#61,感谢 @coolxll):桌面连接期间通过 `org.freedesktop.ScreenSaver.Inhibit` 阻止空闲锁屏,
断开后释放(GNOME 沿用 SessionManager 的空闲抑制)。尚未在 KDE 真机上验证。
- **`inproc-av` 奇数尺寸桌面**(#60,感谢 @ferstar):进程内编码路径同样补齐为偶数尺寸(#53 只修了默认 FFmpeg 管线)。
`inproc-av` 不在预编译包里;未在奇数尺寸真机上验证。
### 改进 / Improved
- 桌面锁屏时日志提示「控制端在解锁前只会看到黑屏」,并给出解锁方式(控制端「自动解锁被控端」或本机 `loginctl unlock-session`)。
- 检测到 Wayland 会话却选中了 X11 后端时给出警告(此时采集 XWayland 只会得到全黑画面且没有报错)。
- KDE sessions hold a freedesktop ScreenSaver inhibitor while connected (not yet tested on real KDE); the log now explains lock-screen
black frames and warns when X11 capture is used inside a Wayland session; `inproc-av` pads odd sizes too.
### 下载 / Download
`uu-remote-linux-v0.2.16-x86_64-linux.tar.gz` / `uu-remote-linux-v0.2.16-aarch64-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.16`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+14
View File
@@ -0,0 +1,14 @@
新增 `uuremote-server doctor` 一键诊断。/ New `uuremote-server doctor` diagnostic report.
### 新增 / Added
- **`uuremote-server doctor`**:一次输出提 issue 需要的状态——会话类型与桌面、最终选中的后端(含「Wayland 会话里用了 X11 后端会黑屏」的提醒)、
Wayland / portal 插件能否加载及缺什么库、`/dev/uinput` 与显卡 render 节点权限、FFmpeg 可用编码器和版本、默认编码(H.264 / H.265)、
是否已登录、服务状态和重复进程。只输出布尔值、名称和版本,主目录和用户名会被替换,不含账号 ID、令牌、IP、MAC 或文件内容,
可以直接贴到 issue。issue 模板已改为先运行它。
- `uuremote-server doctor` prints a paste-safe report (session, backend, plugins, permissions, encoders, default codec, sign-in and
service state) with no ids, tokens, addresses or file contents.
### 下载 / Download
`uu-remote-linux-v0.2.17-x86_64-linux.tar.gz` / `uu-remote-linux-v0.2.17-aarch64-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.17`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+25
View File
@@ -0,0 +1,25 @@
Ubuntu / Debian 安装包(.deb);实验性远程开机辅助。/ Debian packages; experimental Wake-on-LAN helper.
### 新增 / Added
- **`.deb` 安装包**(amd64 / arm64):`sudo apt install ./uu-remote-linux_0.2.18_amd64.deb` 一步装好程序、两个桌面插件、
用户级 systemd 服务和应用菜单图标,依赖由 apt 自动安装。之后以桌面用户运行:
```sh
uuremote-server login
systemctl --user enable --now uuremote-native.service
```
服务随图形会话启动(GNOME / KDE 会自动传入显示环境;Xfce 等需按 README 补 `DISPLAY`)。uinput 权限不会自动开启,规则文件放在
`/usr/share/doc/uu-remote-linux/`。安装流程在 CI 的 Ubuntu 22.04 上实测(apt 安装、`--help`、systemd 单元校验);尚未在真实桌面上完整验收。
- **远程开机辅助(实验性,默认关闭,`UU_WOL_HELPER=1`)**:仿照官方 Windows 被控端,登录后向网易上报本机局域网信息,
收到云端的唤醒请求时向同一局域网发送唤醒包,让这台常开的 Linux(例如 NAS)帮你唤醒同局域网的其他电脑。
字段名来自官方程序的日志字符串,**未经端到端验证**;不开启时不上报任何局域网信息,只记录唤醒推送的字段名(不含 MAC/IP)。
- Debian packages (amd64/arm64) with the binaries, plugins, a systemd user unit and menu entries; install-tested on Ubuntu 22.04 in CI.
Experimental, opt-in Wake-on-LAN helper (`UU_WOL_HELPER=1`) modelled on the official Windows host; not verified end to end.
### 修复 / Fixed
- `uuremote-server doctor` 不再输出带完整路径的插件加载日志(路径可能含用户名)。
### 下载 / Download
`uu-remote-linux_0.2.18_amd64.deb` / `uu-remote-linux_0.2.18_arm64.deb`,或 `uu-remote-linux-v0.2.18-<x86_64|aarch64>-linux.tar.gz`,
或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.18`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+18
View File
@@ -0,0 +1,18 @@
无头 Wayland 出画面、自定义码率、`show` 与登录体验修复。/ Headless Wayland video, custom bitrate, `show` and login fixes.
### 修复 / Fixed
- **无头 Wayland 主机连上没有画面**(#64 / #65,感谢 @axlrose):输出不支持 DPMS 时电源握手失败不再中断视频;贡献者在 sway headless 上复现并验证。
- **自定义码率单位错误**(#67,感谢 @JuanZoran):手机端自定义码率按 bit/s 发送(1 Mbps = 1000000),此前被当成 kbit/s 而触发 100 Mbps 上限,
导致大量重传、画面滞留。贡献者在 Hyprland + NVENC 上用手机实测。另外对明显是 Mbps / kbps 的小数值做了兜底换算(维护者补充,未实测)。
- **`uuremote-server show` 静默卡 30 秒**(#62,感谢 @axlrose):服务被条件跳过、反复崩溃重启或启动失败时立即报出真实原因。贡献者已用真实 systemd 单元验证。
- **登录二维码反复立即失效**(#68,感谢 @axlrose):状态轮询在服务器立即应答时不再紧循环(2 秒退避);二维码连续在几秒内失效时指数退避,
并提示可备份删除 `~/.config/uuremote/config.json` 重新登录(注册新设备身份,#68 中以此恢复)。退避逻辑未在被标记的设备上实测。
### 改进 / Improved
- `doctor`:会话里没有 `DISPLAY` / `WAYLAND_DISPLAY` 时给出提示(#66,感谢 @axlrose)。
- 文档:`inproc-av` / `viewer-ffmpeg` 只支持 FFmpeg 6.x,FFmpeg 7+ 会在依赖里报 `avfft.h file not found`(#63)。
### 下载 / Download
`uu-remote-linux_0.2.19_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.19-<x86_64|aarch64>-linux.tar.gz`,或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.19`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+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.**
+13
View File
@@ -0,0 +1,13 @@
Linux 控制端像官方控制端一样请求桌面视频轨道,修复第二个会话永久黑屏。/ The Linux viewer now requests the desktop video track like the official viewer, fixing a permanently black second session.
### 修复 / Fixed
- **第二个会话黑屏(#124,感谢 @shao-zhijie 的码流取证)**:被控端已在给别的控制端推流时,Linux 控制端只会接上那条流的中段,没有 SPS/PPS/IDR,永远无法解码;官方主机也不响应 RTCP PLI。官方 iPhone 控制端在 CONTROL 通道打开后会立即发 RPC 15 `SendVideoTrackReq`(无字段);Linux 控制端现在桌面会话里也发这一条。
Desktop sessions now send RpcRequest case 15 `SendVideoTrackReq` (no fields) right after CONTROL opens, as the official iPhone viewer does, so the host starts a track for this session instead of the viewer joining another session's stream mid-GOP.
### 验证范围 / Validation
单元测试与 CI;官方 iPhone 控制端发送该 RPC 的行为来自本项目主机日志(`response_field=11 value=None`)。与官方 macOS 主机的第二会话场景尚待报告者实测。
### 下载 / Download
`uu-remote-linux_0.2.39_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.39-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.39`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+22
View File
@@ -0,0 +1,22 @@
控制端:修复 FFmpeg 9 下没有画面;新增「删除设备」。/ Viewer: fix no video with FFmpeg 9; add device removal.
### 控制端修复 / Viewer — fixed
- **FFmpeg 9 下桌面没有画面**(v0.2.2、v0.2.3 的回归):为兼容 FFmpeg 4.4 改用的 `-vsync 0` 已被 FFmpeg 9 删除,解码进程一启动就退出,
所有帧都解码失败。现在启动时探测当前 ffmpeg 支持的参数:新版本用 `-fps_mode passthrough`,旧版本(如 Ubuntu 22.04 的 4.4)用 `-vsync 0`。
已在 FFmpeg 9.0.2 上连接官方 Mac 被控端实测:0 解码错误。
Fixed: with FFmpeg 9 every frame failed to decode (`-vsync` was removed). Verified against the official Mac host on FFmpeg 9.0.2.
### 控制端新增 / Viewer — added
- **删除设备**:启动窗口「更多工具 → 删除设备」(带确认),或命令行 `uuremote-viewer unbind DEVICE`,把设备从账号中移除,
与官方客户端的「删除设备」相同。命令行方式已对一台测试设备实测删除成功;⚠️ 启动窗口里的按钮尚未实机点击验收;
分享给你的设备(`--shared`)只有字符串依据,未实测。
Remove a device from the account (CLI verified live on a test device; launcher button and `--shared` not yet verified).
### 已知问题 / Known issues
- 剪贴板只在控制端窗口获得焦点时同步;控制端 → 官方 Windows 被控端的剪贴板仍在排查。
- Clipboard syncs only while the viewer window is focused; viewer → official Windows host clipboard is still unresolved.
### 下载 / Download
`uu-remote-linux-v0.2.4-x86_64-linux.tar.gz`:主机 `uuremote-server`(X11 版)与控制端 `uuremote-viewer`(x86_64,glibc ≥ 2.35;控制端需 SDL2、GTK3、ffmpeg),附带 `contrib/`。主机端与 v0.2.3 相同。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+21
View File
@@ -0,0 +1,21 @@
窗口颜色修复;控制端可接收官方 Mac 被控端的剪贴板。/ Window colors fixed; viewer receives the official Mac host's clipboard.
### 修复 / Fixed
- **深色系统主题下窗口文字看不见**(#43):协助窗口、控制端启动窗口和工具窗口使用固定浅色背景,但部分文字跟随系统深色主题变成了白色。
现在这些窗口固定使用浅色主题。已在虚拟机中设置深色偏好后截图确认。
GTK windows now stay on the light theme, so text is readable under dark system themes.
- **控制端 ↔ 官方 Mac 被控端剪贴板**:Mac 被控端以 `public.utf8-plain-text`(UTF-8)提供文本,而不是 Windows 的 `CF_UNICODETEXT`,
之前控制端不会请求,剪贴板始终不同步。现在两种格式都支持;主机端发给官方客户端的格式不变。
Mac → 控制端已实机验证;⚠️ 控制端 → Mac 尚未验证。
The viewer now handles the Mac host's UTF-8 text format (Mac → viewer verified live; viewer → Mac not yet verified).
### 已验证 / Verified with the official Mac host(FFmpeg 9.0.2)
- 画面 0 解码错误,键盘输入正确,文件上传/下载/列目录 sha256 一致。
### 已知问题 / Known issues
- 剪贴板只在控制端窗口获得焦点时同步;控制端 → 官方 Windows 被控端的剪贴板仍在排查。
### 下载 / Download
`uu-remote-linux-v0.2.5-x86_64-linux.tar.gz`:主机 `uuremote-server`(X11 版)与控制端 `uuremote-viewer`(x86_64,glibc ≥ 2.35;控制端需 SDL2、GTK3、ffmpeg),附带 `contrib/`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+19
View File
@@ -0,0 +1,19 @@
控制端可打开官方 Mac 被控端的终端;输入问题诊断日志。/ Viewer terminal works with the official Mac host; input diagnostics.
### 控制端修复 / Viewer — fixed
- **连接官方 Mac 被控端的终端**:之前一连上就断开(「Terminal channel closed」)。Mac 被控端把终端的应答发在终端通道上,
控制端现在能识别。已实机验证:可打开终端并正常回显。Mac 被控端的端口映射也已实测可用。
Terminal sessions with the official Mac host now open (verified live); port mapping with it was verified too.
### 主机端诊断 / Host diagnostics(#46)
- 收到不认识的输入事件时记一条日志(只有动作名和字段名,**不含输入内容**),用于排查手机输入法打字无反应。
- 小键盘按键记录被控端当前的 NumLock 状态(只记开/关,不记按键),用于排查小键盘不出数字。
- Logs unsupported input actions (names only, never typed text) and the server's NumLock state for numpad keys.
### 其他 / Other
- README 标题与开头加入控制端介绍并放上截图(#44)。
### 下载 / Download
`uu-remote-linux-v0.2.6-x86_64-linux.tar.gz`:主机 `uuremote-server`(X11 版)与控制端 `uuremote-viewer`(x86_64,glibc ≥ 2.35;控制端需 SDL2、GTK3、ffmpeg),附带 `contrib/`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+25
View File
@@ -0,0 +1,25 @@
手机输入法打字(实验);控制端 → 官方 Windows 被控端剪贴板修复。/ Mobile input-method text (experimental); viewer → Windows host clipboard fixed.
### 主机端 / Host
- **手机自带输入法打字**(#13、#46):官方 Windows 被控端用 `text_input` 动作接收手机输入法的文字。本版主机端支持这个动作,
在 X11 上把文字(含中文)直接输入到当前窗口;不论它从哪个数据通道到达都会处理。
已用手机 UU 远程实测:手机自带键盘输入的英文正确打出(手机在 CONTROL 通道发送 `text_input`);中文注入已在 X11 上
单独实测正确,但尚未用手机中文输入法实测。Wayland / 门户后端暂不支持,会记录一次警告。
诊断:非 CONTROL 通道收到的输入动作会记录动作名(不含内容)。
- Mobile input-method text via the official `text_input {content}` action, typed on X11. Verified with the UU mobile app
(English); Chinese injection verified on X11 separately, not yet with a phone IME.
### 控制端修复 / Viewer — fixed
- **控制端 → 官方 Windows 被控端剪贴板**:之前被控端确认收到,但粘贴为空。原因是控制端同时发送的「富剪贴板格式通告」
会覆盖刚写入的文本,而 Windows 被控端之后从不请求数据。现在按被控端平台发送:Windows 及本项目主机只发文本变更,
Mac 只发格式通告,平台未知时两者都发。已实测:Windows 被控端「运行」框可粘贴,官方 Mac 被控端正常。
Viewer → official Windows host clipboard now works (verified live); Mac unchanged and verified.
### 社区贡献 / Community
- **Mac SSH 粘贴助手**(#45,感谢 @jo32):`contrib/macos-ssh/`,在 Ghostty 里经 UU 端口映射用 SSH 时粘贴 Finder 文件会先上传再插入路径。
可选工具,维护者尚未实机验收。Optional contrib tool, not verified by the maintainer.
### 下载 / Download
`uu-remote-linux-v0.2.7-x86_64-linux.tar.gz`:主机 `uuremote-server`(X11 版)与控制端 `uuremote-viewer`(x86_64,glibc ≥ 2.35;控制端需 SDL2、GTK3、ffmpeg),附带 `contrib/`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+15
View File
@@ -0,0 +1,15 @@
群晖 / NAS 容器镜像。/ Docker image for Synology and other NAS boxes.
### 新增 / Added
- **群晖 / NAS(Docker,无桌面)**:`ghcr.io/vallierdev/uu-remote-linux`,在没有图形界面的 NAS 上运行本项目主机,
供官方客户端使用文件传输、终端(容器内 bash)和端口映射(经 UU 访问家里局域网的服务)。不提供远程桌面。
已在群晖 DSM 7.3.2(x86_64)上实测:文件上传下载 sha256 一致、终端回显正常、端口映射访问 DSM 管理页返回 200。
安装与首次扫码登录见 [docker/README.md](https://github.com/VallierDev/uu-remote-linux/blob/main/docker/README.md)。
- Headless NAS container image (file transfer, terminal, port mapping), verified on Synology DSM 7.3.2 (x86_64).
主机端与控制端程序与 v0.2.7 相同。/ Host and viewer binaries are unchanged from v0.2.7.
### 下载 / Download
`uu-remote-linux-v0.2.8-x86_64-linux.tar.gz`(主机 `uuremote-server` + 控制端 `uuremote-viewer`,附带 `contrib/`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.8`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+19
View File
@@ -0,0 +1,19 @@
修复 H.265 + VAAPI 时手机卡在「正在传输」;VAAPI 可选加大编码缓冲。/ Fix H.265 + VAAPI stalling at "transferring"; optional VAAPI VBV buffer.
### 修复 / Fixed
- **H.265 用 VAAPI 硬件编码时没有画面**(#48,感谢 @NuoFang6):`hevc_vaapi` 只在关键帧处写帧分隔符,主机按分隔符切帧,
把整组画面当成一帧后全部被拦下,被控端几乎不发画面,手机停在「正在传输」。现在按图像边界切分 H.265 访问单元,
不再依赖帧分隔符;维护者补充了后缀 SEI 等尾随单元的处理。
已实测:作者在 Intel 核显 + 官方安卓客户端上(2560×1440,约 58 fps);维护者在 RTX 3090 上用固定输入探针验证
`hevc_nvenc` 与 `libx265` 均 90/90 帧可解码、首帧为关键帧。
- H.265 access units are now split on picture boundaries (RFC 7798), fixing hevc_vaapi sessions that sent almost nothing.
### 新增 / Added
- **`UU_VAAPI_BUFFER_MS`**(#47,感谢 @NuoFang6,源自 #42):可选加大 VAAPI 的编码缓冲(10–1000 ms),缓解高分辨率下
关键帧被压糊、画面周期性模糊。默认不启用。⚠️ 仅在一台机器上实测,代价是关键帧变大,建议从 250 ms 试起。
- Optional VAAPI VBV buffer `UU_VAAPI_BUFFER_MS` (off by default; verified on one machine only).
### 下载 / Download
`uu-remote-linux-v0.2.9-x86_64-linux.tar.gz`(主机 `uuremote-server` + 控制端 `uuremote-viewer`,附带 `contrib/`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.9`。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+67
View File
@@ -0,0 +1,67 @@
#!/bin/sh
# Build uu-remote-linux_<version>_<arch>.deb from release binaries.
# usage: packaging/deb/build-deb.sh VERSION BIN_DIR OUT_DIR (VERSION without the leading v)
set -eu
version=$1 bin=$2 out=$3
here=$(cd "$(dirname "$0")" && pwd) root=$(cd "$here/../.." && pwd)
case $(uname -m) in x86_64) arch=amd64 ;; aarch64) arch=arm64 ;; *) echo "unsupported arch" >&2; exit 1 ;; esac
pkg=$(mktemp -d)
trap 'rm -rf "$pkg"' EXIT
install -Dm755 "$bin/uuremote-server" "$pkg/usr/bin/uuremote-server"
[ -f "$bin/uuremote-viewer" ] && install -Dm755 "$bin/uuremote-viewer" "$pkg/usr/bin/uuremote-viewer"
for lib in libuu-wayland.so libuu-portal.so; do
[ -f "$bin/$lib" ] && install -Dm644 "$bin/$lib" "$pkg/usr/lib/uu-remote-linux/$lib"
done
install -Dm644 "$here/uuremote-native.service" "$pkg/usr/lib/systemd/user/uuremote-native.service"
install -Dm644 "$root/contrib/desktop/uu-remote-linux.desktop" "$pkg/usr/share/applications/uu-remote-linux.desktop"
[ -f "$pkg/usr/bin/uuremote-viewer" ] && install -Dm644 "$root/contrib/desktop/uu-remote-linux-viewer.desktop" "$pkg/usr/share/applications/uu-remote-linux-viewer.desktop"
install -Dm644 "$root/contrib/desktop/uu-remote-linux.svg" "$pkg/usr/share/icons/hicolor/scalable/apps/uu-remote-linux.svg"
install -Dm644 "$root/LICENSE" "$pkg/usr/share/doc/uu-remote-linux/copyright"
# uinput access is opt-in: it lets the service inject input into the whole seat.
printf '%s\n' 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' \
> "$pkg/usr/share/doc/uu-remote-linux/60-uu-remote-linux-uinput.rules"
size=$(du -sk "$pkg/usr" | cut -f1)
# Library dependencies from the binaries themselves (the server hard, the viewer recommended).
shlibdeps() {
work=$(mktemp -d); mkdir "$work/debian"
printf 'Source: uu-remote-linux\n\nPackage: uu-remote-linux\nArchitecture: any\n' > "$work/debian/control"
(cd "$work" && dpkg-shlibdeps -O --ignore-missing-info "$1" 2>/dev/null) | sed -n 's/^shlibs:Depends=//p'
rm -rf "$work"
}
depends=$(shlibdeps "$pkg/usr/bin/uuremote-server")
recommends=""
[ -f "$pkg/usr/bin/uuremote-viewer" ] && recommends=$(shlibdeps "$pkg/usr/bin/uuremote-viewer")
[ -n "$depends" ] || { echo "dpkg-shlibdeps produced no dependencies" >&2; exit 1; }
mkdir -p "$pkg/DEBIAN"
cat > "$pkg/DEBIAN/control" <<CONTROL
Package: uu-remote-linux
Version: $version
Architecture: $arch
Maintainer: VallierDev <[email protected]>
Installed-Size: $size
Depends: $depends, ffmpeg
Recommends: ${recommends:+$recommends, }libwayland-client0, libxkbcommon0
Suggests: libpipewire-0.3-0, libei1, wl-clipboard
Section: net
Priority: optional
Homepage: https://github.com/VallierDev/uu-remote-linux
Description: Unofficial native Linux host for NetEase UU Remote
Lets the official NetEase UU Remote clients control this Linux desktop
(X11, wlroots Wayland and GNOME/KDE Wayland through runtime plugins).
Includes the experimental uuremote-viewer. Not affiliated with NetEase.
CONTROL
cat > "$pkg/DEBIAN/postinst" <<'POSTINST'
#!/bin/sh
set -e
if [ "$1" = configure ]; then
cat <<'MSG'
uu-remote-linux installed. As your desktop user (not root):
uuremote-server login # scan the QR code with the UU Remote app
systemctl --user enable --now uuremote-native.service # start with the graphical session
Optional uinput keyboard/mouse (Wayland): see /usr/share/doc/uu-remote-linux/60-uu-remote-linux-uinput.rules
MSG
fi
POSTINST
chmod 755 "$pkg/DEBIAN/postinst"
mkdir -p "$out"
dpkg-deb --build --root-owner-group "$pkg" "$out/uu-remote-linux_${version}_${arch}.deb"
+17
View File
@@ -0,0 +1,17 @@
# Installed by the uu-remote-linux .deb as a systemd *user* unit; enable it per user:
# systemctl --user enable --now uuremote-native.service
# GNOME and KDE import DISPLAY / WAYLAND_DISPLAY into the user manager when the graphical session
# starts. Desktops that do not (e.g. Xfce) can add a drop-in with Environment=DISPLAY=:0.
[Unit]
Description=UU Remote Linux host (unofficial)
After=graphical-session.target
PartOf=graphical-session.target
[Service]
Environment=RUST_LOG=info
ExecStart=/usr/bin/uuremote-server
Restart=always
RestartSec=5
[Install]
WantedBy=graphical-session.target
+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_take_command(arg: *mut libc::c_char, len: libc::size_t) -> libc::c_int;
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.
+1 -10
View File
@@ -1,7 +1,6 @@
//! 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.
//! Encoding runs in this process with the `inproc-av` feature (unless `UU_FFMPEG_ROOT` is set),
//! otherwise an FFmpeg child process does it.
//! An FFmpeg child process does the encoding.
//! 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.
@@ -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>)
-> Result<(Stopper, tokio::task::JoinHandle<Result<(), String>>), String> {
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 stdout = child.stdout.take().ok_or("Encoder stdout missing")?;
let job = tokio::task::spawn_blocking(move || read_packets(stdout, &tx));
+143 -1
View File
@@ -91,6 +91,48 @@ pub struct UUAuthClient {
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,
/// timeout) lives in the source chain. URL user-info (proxy credentials) and query
/// strings are removed before the chain is shown.
@@ -121,9 +163,27 @@ fn redact_urls(text: &str) -> String {
out
}
/// 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
/// into reqwest's standard proxy environment handling.
pub fn http_client_builder() -> reqwest::ClientBuilder {
let builder = reqwest::Client::builder();
if proxy_enabled() {
builder
} else {
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 {
matches!(value.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on")
}
impl UUAuthClient {
pub fn new(creds: Credentials) -> Self {
let http = reqwest::Client::builder()
let http = http_client_builder()
.timeout(std::time::Duration::from_secs(12))
.build()
.unwrap();
@@ -236,6 +296,27 @@ impl UUAuthClient {
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).
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 resp = self.http.post(format!("{base}{path}"))
.headers(self.build_headers("POST", path, &body_str)).body(body_str)
.send().await.map_err(|e| format!("HTTP post {path} failed: {}", transport_error(&e)))?;
let status = resp.status().as_u16();
Ok((status, resp.json().await.unwrap_or(serde_json::Value::Null)))
}
/// Guest APIs use requestPlain for empty requests; sign the actual empty body.
/// Errors intentionally exclude response text and URL (both can contain secrets).
pub async fn assist_post(&self, path: &str, body: Option<&serde_json::Value>) -> Result<(u16, serde_json::Value), String> {
@@ -346,4 +427,65 @@ mod guest_tests {
let text = super::redact_urls("proxy http://user:[email protected]:3128 failed for (https://api.example/p?token=abc)");
assert_eq!(text, "proxy http://proxy.example:3128 failed for (https://api.example/p)");
}
#[test]
fn proxy_opt_in_accepts_only_explicit_truthy_values() {
for value in ["1", "true", "TRUE", " yes ", "On"] { 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"));
}
}
+59 -22
View File
@@ -27,21 +27,50 @@ pub fn h264_device_capability(
fps: i32,
codec_impl: i32,
) -> Value {
device_capability(client_id, ice_id, display_id, fps, codec_impl, false)
device_capability(client_id, ice_id, display_id, fps, codec_impl, false, false)
}
pub fn device_capability(client_id: &str, ice_id: &str, display_id: i32, fps: i32, codec_impl: i32, hevc: bool) -> Value {
let mut codecs = vec![json!({"video_codec": VIDEO_CODEC_H264, "chroma_sampling": 1,
"codec_impl": codec_impl, "bit_depth": 8})];
// Official VideoCodecCapability::SerializeJson uses the same fields for CodecType H265=2.
if hevc { codecs.push(json!({"video_codec": 2, "chroma_sampling": 1, "codec_impl": codec_impl, "bit_depth": 8})); }
/// Shape of the official Windows host's `forward_setting` (observed from a live 4.37 host):
/// `{client_id, data: {device_capability: {display_info, ice_id, video_codec_capability}, type}}`.
/// 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
/// then kept quality and chroma locked at their defaults (#49). Only 8-bit and the chroma formats
/// 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 {
let mut codecs = Vec::new();
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)) {
let (width, height) = (3840, 2160);
codecs.push(json!({"video_codec": codec, "chroma_sampling": chroma, "codec_impl": codec_impl,
"bit_depth": 8, "width": width, "height": height}));
}
}
json!({
"client_id": client_id,
"type": "device_capability",
"data": {
"display_info": [{"id": display_id, "fps": fps, "type": 0, "hdr": 0}],
"video_codec_capability": codecs,
"ice_id": ice_id
"device_capability": {
"display_info": [{"id": display_id, "fps": fps, "type": 0, "hdr": -1}],
"video_codec_capability": codecs,
"ice_id": ice_id
},
"type": "device_capability"
}
})
}
/// Official `sender_para_info` (capture and encoder names; the Windows host sends "DXGI" /
/// "NVIDIA NVENC") for the single video track.
pub fn sender_para_info(client_id: &str, ice_id: &str, capture_impl: &str, encoder_impl: &str) -> Value {
json!({
"client_id": client_id,
"data": {
"sender_para_info": {
"capture_impl": capture_impl, "encoder_impl": encoder_impl, "ice_id": ice_id,
"sender_media_infos": [{"capture_impl": capture_impl, "encoder_impl": encoder_impl, "video_track_index": 0}],
"video_track_index": 0
},
"type": "sender_para_info"
}
})
}
@@ -51,12 +80,20 @@ mod tests {
use super::*;
#[test]
fn hevc_capability_uses_official_codec_enum_and_420_only() {
let payload = device_capability("client-example", "ice-example", 0, 60, 5, true);
assert_eq!(payload["data"]["video_codec_capability"], json!([
{"video_codec":1,"chroma_sampling":1,"codec_impl":5,"bit_depth":8},
{"video_codec":2,"chroma_sampling":1,"codec_impl":5,"bit_depth":8}]));
assert_eq!(device_capability("c", "i", 0, 60, 5, false)["data"]["video_codec_capability"].as_array().unwrap().len(), 1);
fn capability_uses_the_official_nested_shape_and_real_formats() {
let payload = device_capability("client-example", "ice-example", 0, 60, 5, true, true);
assert_eq!(payload["data"]["type"], "device_capability");
assert!(payload.get("type").is_none());
let caps = &payload["data"]["device_capability"]["video_codec_capability"];
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[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);
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);
let sender = sender_para_info("c", "i", "X11", "NVIDIA NVENC");
assert_eq!(sender["data"]["type"], "sender_para_info");
assert_eq!(sender["data"]["sender_para_info"]["sender_media_infos"][0]["encoder_impl"], "NVIDIA NVENC");
}
#[test]
@@ -71,15 +108,15 @@ mod tests {
#[test]
fn device_capability_uses_object_data_and_string_ice_id() {
let payload = h264_device_capability("client-example", "ice-example", 11, 60, 0);
assert_eq!(payload["type"], "device_capability");
assert!(payload["data"].is_object());
assert_eq!(payload["data"]["ice_id"], "ice-example");
let display = &payload["data"]["display_info"][0];
let capability = &payload["data"]["device_capability"];
assert!(capability.is_object());
assert_eq!(capability["ice_id"], "ice-example");
let display = &capability["display_info"][0];
assert_eq!(display.as_object().unwrap().len(), 4);
assert_eq!(display["id"], 11);
assert_eq!(display["fps"], 60);
let codec = &payload["data"]["video_codec_capability"][0];
assert_eq!(codec.as_object().unwrap().len(), 4);
let codec = &capability["video_codec_capability"][0];
assert_eq!(codec.as_object().unwrap().len(), 6);
assert_eq!(codec["video_codec"], 1);
assert_eq!(codec["codec_impl"], 0);
assert_eq!(codec["bit_depth"], 8);
+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
/// 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() } {
1 => true,
0 => false,
code => { log::warn!("X11 geometry query failed with code {code}"); false }
0 | 1 => x11_last_size(),
-1 => None,
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 backend: crate::desktop_backend::DesktopBackend,
pub init_error: Option<String>,
+190 -19
View File
@@ -40,11 +40,13 @@ impl VideoCodec {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct VideoSettings {
pub source_id: usize,
pub source_generation: u64,
pub fps: u32,
pub codec: VideoCodec,
pub quality: u64,
/// Viewer max_custom_bitrate (only used for QUALITY_CUSTOM): Mbit/s, or kbit/s above 1000.
pub custom_mbps: u32,
/// Viewer max_custom_bitrate in bits/s (only used for QUALITY_CUSTOM).
pub custom_bps: u32,
/// Scaled stream size (其他分辨率); None streams the native desktop size.
pub output: Option<(u32, u32)>,
/// CHROMA_420 or CHROMA_444 (真彩); 4:4:4 only when the encoder pipeline supports it.
@@ -52,7 +54,7 @@ pub struct VideoSettings {
}
impl Default for VideoSettings {
fn default() -> Self { Self { codec: VideoCodec::H264, fps: 60, quality: QUALITY_AUTO, custom_mbps: 0, output: None, chroma: CHROMA_420 } }
fn default() -> Self { let (source_id,source_generation)=crate::wayland::selection(); Self { source_id,source_generation, codec: VideoCodec::H264, fps: 60, quality: QUALITY_AUTO, custom_bps: 0, output: None, chroma: CHROMA_420 } }
}
/// Selectable smaller stream sizes with the desktop's aspect ratio (even dimensions).
@@ -84,8 +86,8 @@ impl VideoSettings {
QUALITY_GENERAL => Some(2_000),
QUALITY_HD => Some(8_000),
QUALITY_BLURAY => Some(20_000),
QUALITY_CUSTOM if self.custom_mbps > 0 =>
Some(if self.custom_mbps > 1_000 { self.custom_mbps } else { self.custom_mbps * 1_000 }.min(100_000)),
QUALITY_CUSTOM if self.custom_bps > 0 =>
Some((self.custom_bps / 1_000).clamp(1, 100_000)),
_ => None,
}
}
@@ -110,22 +112,67 @@ fn fps_from_option(value: u64) -> Option<u64> {
/// Applies a capture-setting RPC to `settings` and returns the RpcResponse payload (Message 22),
/// or None when the RPC is not a capture/fps/quality setting.
/// max_custom_bitrate (field 8) in bit/s: the mobile viewer sends 1_000_000 for 1 Mbps (#67). Values
/// that can only be a different unit stay usable instead of collapsing to a 1 kbit/s cap: below 1000
/// they are Mbit/s, below 200_000 kbit/s (no viewer offers custom rates under 200 kbit/s).
fn custom_bitrate_bps(value: u64) -> u32 {
let bps = if value < 1_000 { value * 1_000_000 } else if value < 200_000 { value * 1_000 } else { value };
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>> {
handle_rpc_with_codecs(rpc, settings, native, true, false)
}
/// Initial codec once the m-line is negotiated: H.265 when both sides support it (the Mac viewer
/// lists H265 first in its offer), unless UU_VIDEO_CODEC=h264.
/// 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
/// hosts default to H.264. UU_VIDEO_CODEC=h264 / h265 overrides.
#[cfg(test)]
fn test_selection() -> crate::video_select::Selection {
crate::video_select::resolve_pair(Some("auto"), None, Some("auto"), None, false, None)
}
#[cfg(test)]
pub fn preferred_codec(h264: bool, h265: bool) -> VideoCodec {
let forced_h264 = std::env::var("UU_VIDEO_CODEC").is_ok_and(|v| v.eq_ignore_ascii_case("h264"));
if h265 && !(forced_h264 && h264) { VideoCodec::H265 } else { VideoCodec::H264 }
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 };
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>> {
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 mut next = *settings.borrow();
if let Some(request) = message(rpc, 2) {
@@ -136,11 +183,13 @@ 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 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.
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.
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(bitrate) = number(&fields, 8).filter(|v| *v > 0) { next.custom_mbps = bitrate as u32; }
if let Some(bitrate) = number(&fields, 8).filter(|v| *v > 0) { next.custom_bps = custom_bitrate_bps(bitrate); }
// Field 7 chorma_format (sic): 3 = 4:4:4 when 真彩 is on, 1 = 4:2:0. The Sync reports what is encoded.
match number(&fields, 7) {
Some(CHROMA_444) if full_chroma => next.chroma = CHROMA_444,
@@ -180,9 +229,37 @@ fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native:
Some(out)
}
/// CaptureSettingResponse.errors (Error fields 1 code / 2 message, rpc_main.proto).
pub fn rejected_request(data:&[u8],reason:&str)->Option<Vec<u8>> {
let outer=decode_wire(data).ok()?;
let rpc=decode_wire(message(&outer,21)?).ok()?;
message(&rpc,2)?;
let mut error=Vec::new();
put_varint(1,(-1i64) as u64,&mut error);
put_bytes(2,reason.as_bytes(),&mut error);
let mut errors=Vec::new();put_bytes(1,&error,&mut errors);
let mut response=Vec::new();
put_bytes(1,message(&rpc,1).unwrap_or(&[]),&mut response);
put_bytes(2,&errors,&mut response);
Some(response)
}
/// Message 7 ScreenSources in pixels for capture-setting v4: native, choices, current size.
pub fn screen_sources(seq: u64, timestamp: u64, native: (u32, u32), output: Option<(u32, u32)>, name: &str) -> Result<Vec<u8>, String> {
use crate::initialization::{Screen, WinRect};
let outputs=crate::wayland::outputs();
if !outputs.is_empty() {
let current=crate::wayland::selected();
let choices:Vec<Vec<(i32,i32)>>=outputs.iter().map(|m|scaled_sizes((m.width,m.height)).into_iter().map(|(w,h)|(w as i32,h as i32)).collect()).collect();
let screens:Vec<Screen<'_>>=outputs.iter().enumerate().map(|(id,m)| Screen {
id:id as i32, fps:m.fps,
resolution:WinRect {left:0,top:0,width:m.width as i32,height:m.height as i32,pixel_width:m.width as i32,pixel_height:m.height as i32},
primary:id==0,dpr:1.0,display_name:&m.name,video_track_index:if id==current {0} else {-1},
screen_type:0,builtin_screen_type:if m.name.starts_with("eDP") {1} else {2},scaled:&choices[id],
current:if id==current {output.map(|(w,h)|(w as i32,h as i32))} else {None},
}).collect();
return crate::initialization::encode_screen_sources(seq,timestamp,&screens,current as i32);
}
let (w, h) = (native.0 as i32, native.1 as i32);
let scaled: Vec<(i32, i32)> = scaled_sizes(native).into_iter().map(|(w, h)| (w as i32, h as i32)).collect();
// DPI_SCALE starts at version 5; the observed v4 request uses fields 5/6 as pixels.
@@ -201,7 +278,7 @@ pub fn sync_payload(settings: &VideoSettings, native: (u32, u32)) -> Vec<u8> {
put_varint(1, u64::from(settings.fps), &mut out);
put_varint(2, settings.quality, &mut out);
put_varint(3, settings.chroma, &mut out);
if settings.custom_mbps > 0 { put_varint(4, u64::from(settings.custom_mbps), &mut out); }
if settings.custom_bps > 0 { put_varint(4, u64::from(settings.custom_bps), &mut out); }
put_varint(5, u64::from(size.0), &mut out);
put_varint(6, u64::from(size.1), &mut out);
put_varint(9, u64::from(size.0), &mut out);
@@ -248,7 +325,7 @@ mod tests {
put_varint(18, 30, &mut body);
let request = rpc(77, 2, &body);
let response = handle_rpc(&decode_wire(&request).unwrap(), &tx, (1920, 1080)).unwrap();
assert_eq!(*rx.borrow(), VideoSettings { codec: VideoCodec::H264, fps: 30, quality: QUALITY_GENERAL, custom_mbps: 0, output: None, chroma: CHROMA_420 });
assert_eq!(*rx.borrow(), VideoSettings { source_id:0,source_generation:0, codec: VideoCodec::H264, fps: 30, quality: QUALITY_GENERAL, custom_bps: 0, output: None, chroma: CHROMA_420 });
assert_eq!(rx.borrow().max_kbps(), Some(2_000));
let fields = decode_wire(&response).unwrap();
assert_eq!(message(&fields, 1), Some(&[8u8, 77][..]));
@@ -274,12 +351,12 @@ mod tests {
let (tx, rx) = watch::channel(VideoSettings::default());
// Observed Mac viewer request with 真彩 on: field 7 = 3.
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);
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!(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);
}
@@ -432,8 +509,40 @@ mod tests {
#[test]
fn auto_quality_keeps_constant_quality_encoding() {
assert_eq!(VideoSettings::default().max_kbps(), None);
assert_eq!(VideoSettings { quality: QUALITY_CUSTOM, custom_mbps: 0, ..Default::default() }.max_kbps(), None);
assert_eq!(VideoSettings { quality: QUALITY_CUSTOM, custom_mbps: 12, ..Default::default() }.max_kbps(), Some(12_000));
assert_eq!(VideoSettings { quality: QUALITY_CUSTOM, custom_bps: 0, ..Default::default() }.max_kbps(), None);
assert_eq!(VideoSettings { quality: QUALITY_CUSTOM, custom_bps: 12_000_000, ..Default::default() }.max_kbps(), Some(12_000));
}
#[test]
fn mobile_custom_bitrate_is_bits_per_second_in_request_and_sync() {
// Mobile viewer sends field 8 = 1_000_000 for 1 Mbps (observed live, 2026-10-20).
for (bps, kbps) in [(1_000_000, 1_000), (30_000_000, 30_000), (500_000, 500), (100_000_000, 100_000), (200_000_000, 100_000)] {
let (tx, rx) = watch::channel(VideoSettings::default());
let mut body = Vec::new();
put_varint(2, QUALITY_CUSTOM, &mut body);
put_varint(8, bps, &mut body);
handle_rpc(&decode_wire(&rpc(7, 2, &body)).unwrap(), &tx, (1920, 1080)).unwrap();
assert_eq!(rx.borrow().max_kbps(), Some(kbps));
let sync = sync_payload(&rx.borrow(), (1920, 1080));
assert_eq!(number(&decode_wire(&sync).unwrap(), 4), Some(bps));
}
}
#[test]
fn small_custom_bitrates_are_read_as_larger_units() {
assert_eq!(custom_bitrate_bps(20), 20_000_000);
assert_eq!(custom_bitrate_bps(8_000), 8_000_000);
assert_eq!(custom_bitrate_bps(1_000_000), 1_000_000);
}
#[test]
fn oversized_custom_bitrate_does_not_wrap_before_encoder_limit() {
let (tx, rx) = watch::channel(VideoSettings::default());
let mut body = Vec::new();
put_varint(2, QUALITY_CUSTOM, &mut body);
put_varint(8, u64::from(u32::MAX) + 1, &mut body);
handle_rpc(&decode_wire(&rpc(8, 2, &body)).unwrap(), &tx, (1920, 1080)).unwrap();
assert_eq!(rx.borrow().max_kbps(), Some(100_000));
}
#[test]
@@ -469,4 +578,66 @@ mod codec_tests {
assert_eq!(rx.borrow().codec, VideoCodec::H265);
assert_eq!(preferred_codec(true, false), VideoCodec::H264);
}
#[test]
fn software_hosts_default_to_h264_unless_forced() {
assert_eq!(pick_codec(true, true, None, true), VideoCodec::H265);
assert_eq!(pick_codec(true, true, None, false), VideoCodec::H264);
assert_eq!(pick_codec(true, true, Some("h265"), false), VideoCodec::H265);
assert_eq!(pick_codec(true, true, Some("h264"), true), VideoCodec::H264);
// Only one codec bound in the SDP: use it whatever the preference.
assert_eq!(pick_codec(false, true, None, false), VideoCodec::H265);
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)]
mod screen_error_tests {
use super::*;
#[test]
fn failed_switch_returns_correlated_error_not_success() {
let header=[10,4,b't',b'e',b's',b't'];
let mut rpc=Vec::new();put_bytes(1,&header,&mut rpc);put_bytes(2,&[32,99],&mut rpc);
let request=crate::initialization::envelope(1,2,21,&rpc);
let response=rejected_request(&request,"Unknown screen").unwrap();
let fields=decode_wire(&response).unwrap();
assert_eq!(message(&fields,1),Some(header.as_slice()));
let result=decode_wire(message(&fields,2).unwrap()).unwrap();
let error=decode_wire(message(&result,1).unwrap()).unwrap();
assert_eq!(number(&error,1),Some(u64::MAX));
assert_eq!(message(&error,2),Some(b"Unknown screen".as_slice()));
assert!(rejected_request(b"invalid","failure").is_none());
}
}
+73 -12
View File
@@ -5,11 +5,37 @@ use crate::protocol::{decode_wire,WireValue};
use std::collections::BTreeMap;
const UNICODE_TEXT:u64=13;
/// The official Mac host offers its pasteboard text as format id 0 named `public.utf8-plain-text` (observed live).
const MAC_TEXT:&str="public.utf8-plain-text";
#[derive(Clone,Copy,PartialEq,Eq,Debug)]
enum TextFormat {Windows,Mac}
impl TextFormat {
fn of(format:&[u8])->Option<Self>{
if number(format,1)==Ok(UNICODE_TEXT){return Some(Self::Windows)}
let named=|n|text_field(format,n).is_ok_and(|s|s==MAC_TEXT);
(named(2)||named(3)).then_some(Self::Mac)
}
fn id(self)->u64{match self{Self::Windows=>UNICODE_TEXT,Self::Mac=>0}}
fn name(self)->&'static str{match self{Self::Windows=>"CF_UNICODETEXT",Self::Mac=>MAC_TEXT}}
fn encode(self,text:&str)->Vec<u8>{match self{Self::Windows=>encode_windows(text),Self::Mac=>text.as_bytes().to_vec()}}
fn decode(self,data:&[u8])->Result<String,&'static str>{
match self{
Self::Windows=>decode_windows(data),
Self::Mac=>{
let data=data.strip_suffix(&[0]).unwrap_or(data);
if data.len()>MAX_TEXT{return Err("clipboard text exceeds limit");}
let text=std::str::from_utf8(data).map_err(|_|"invalid UTF-8 clipboard text")?;
if text.contains('\0'){return Err("embedded NUL in clipboard text");}
Ok(text.to_owned())
}
}
}
}
const BLOCK_BYTES:usize=0x20000;
const MAX_BYTES:usize=MAX_TEXT*2+2;
pub struct ResultMessages {pub messages:Vec<(u32,Vec<u8>)>,pub text:Option<String>}
impl Default for ResultMessages {fn default()->Self{Self{messages:Vec::new(),text:None}}}
struct Pending {key:String, count:Option<usize>, blocks:BTreeMap<usize,Vec<u8>>}
struct Pending {key:String, format:TextFormat, count:Option<usize>, blocks:BTreeMap<usize,Vec<u8>>}
#[derive(Default)]
pub struct State {local:Option<String>, pending:Option<Pending>}
pub fn format_ids(rpc:&[u8])->Vec<u64>{
@@ -62,12 +88,15 @@ fn decode_windows(data:&[u8])->Result<String,&'static str>{
if text.len()>MAX_TEXT{return Err("clipboard text exceeds limit");}Ok(text)
}
impl State{
pub fn offer(&mut self,id:u64,text:String)->Result<Vec<u8>,&'static str>{
pub fn offer(&mut self,id:u64,text:String)->Result<Vec<u8>,&'static str>{self.offer_formats(id,text,&[TextFormat::Windows])}
/// Viewer offers: Windows hosts pick CF_UNICODETEXT, the official Mac host its UTF-8 type.
pub fn offer_any_host(&mut self,id:u64,text:String)->Result<Vec<u8>,&'static str>{self.offer_formats(id,text,&[TextFormat::Windows,TextFormat::Mac])}
fn offer_formats(&mut self,id:u64,text:String,formats:&[TextFormat])->Result<Vec<u8>,&'static str>{
if text.len()>MAX_TEXT{return Err("clipboard text exceeds limit");}
if text.contains('\0')||encode_windows(&text).len()>MAX_BYTES{return Err("clipboard encoded text exceeds limit");}
self.local=Some(text);
let mut format=Vec::new();int(1,UNICODE_TEXT,&mut format);string(2,"CF_UNICODETEXT",&mut format);
let mut list=Vec::new();nested(1,&format,&mut list);
let mut list=Vec::new();
for kind in formats {let mut format=Vec::new();int(1,kind.id(),&mut format);string(2,kind.name(),&mut format);nested(1,&format,&mut list);}
Ok(request(id,1,&list))
}
pub fn request(&mut self,rpc:&[u8],next:&mut impl FnMut()->u64)->Result<ResultMessages,&'static str>{
@@ -78,22 +107,30 @@ impl State{
if let Some(list)=bytes(clip,1)?{
out.messages.push((22,response(h,1,&[])));
let fields=decode_wire(list).map_err(|_|"invalid clipboard format list")?;
let supports_text=fields.iter().filter(|f|f.number==1).any(|f|match f.value{WireValue::Bytes(format)=>number(format,1)==Ok(UNICODE_TEXT),_=>false});
let offered:Vec<TextFormat>=fields.iter().filter(|f|f.number==1).filter_map(|f|match f.value{WireValue::Bytes(format)=>TextFormat::of(format),_=>None}).collect();
let chosen=if offered.contains(&TextFormat::Windows){Some(TextFormat::Windows)}else{offered.first().copied()};
let supports_text=chosen.is_some();
self.pending=None;
if supports_text{
if !supports_text{
// Format ids/names only (never data), to learn non-Windows peers' text formats.
let formats:Vec<(u64,String)>=fields.iter().filter(|f|f.number==1).filter_map(|f|match f.value{WireValue::Bytes(format)=>Some(format),_=>None})
.take(8).map(|format|(number(format,1).unwrap_or(u64::MAX),decode_wire(format).ok().and_then(|x|x.into_iter().find_map(|y|match (y.number,y.value){(n,WireValue::Bytes(s)) if n!=1=>std::str::from_utf8(s).ok().map(|s|s.chars().take(48).collect()),_=>None})).unwrap_or_default())).collect();
log::info!("Clipboard offer without a supported text format: formats={formats:?}");
}
if let Some(format)=chosen{
let id=next();
let epoch=std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs() as u32;
let key=format!("{epoch:08x}-0000-4000-8000-{:012x}",id & 0xffffffffffff);
let mut ask=Vec::new();int(1,UNICODE_TEXT,&mut ask);string(2,&key,&mut ask);string(3,"CF_UNICODETEXT",&mut ask);
self.pending=Some(Pending{key,count:None,blocks:BTreeMap::new()});
let mut ask=Vec::new();int(1,format.id(),&mut ask);string(2,&key,&mut ask);string(3,format.name(),&mut ask);
self.pending=Some(Pending{key,format,count:None,blocks:BTreeMap::new()});
out.messages.push((21,request(id,2,&ask)));
}
}else if let Some(ask)=bytes(clip,2)?{
let key=text_field(ask,2)?;
if key.len()>256||key.is_empty(){return Err("invalid clipboard block key");}
let available=number(ask,1)?==UNICODE_TEXT&&self.local.is_some();
let mut confirm=Vec::new();int(1,if available{1}else{2},&mut confirm);string(2,key,&mut confirm);
let data=if available{Some(encode_windows(self.local.as_ref().unwrap()))}else{None};
let format=if number(ask,1)?==UNICODE_TEXT{Some(TextFormat::Windows)}else if text_field(ask,3).is_ok_and(|s|s==MAC_TEXT){Some(TextFormat::Mac)}else{None};
let data=format.zip(self.local.as_ref()).map(|(format,text)|format.encode(text));
let mut confirm=Vec::new();int(1,if data.is_some(){1}else{2},&mut confirm);string(2,key,&mut confirm);
if let Some(data)=&data{int(3,data.chunks(BLOCK_BYTES).len() as u64,&mut confirm);}
out.messages.push((22,response(h,2,&confirm)));
if let Some(data)=data{
@@ -144,13 +181,37 @@ impl State{
else if (1..=count).all(|i|pending.blocks.contains_key(&i)){1}
else{return Ok(None);};
let data:Vec<u8>=(first..first+count).flat_map(|i|pending.blocks[&i].iter().copied()).collect();
self.pending=None;decode_windows(&data).map(Some)
let format=pending.format;self.pending=None;format.decode(&data).map(Some)
}
}
#[cfg(test)]
mod tests{
use super::*;
#[test] fn mac_utf8_text_round_trips_both_directions(){
// Mac host offer: format list {1 id 0, 2 "public.utf8-plain-text"} (observed live).
let mut mac=Vec::new();int(1,0,&mut mac);string(2,MAC_TEXT,&mut mac);
let mut list=Vec::new();nested(1,&mac,&mut list);
let mut viewer=State::default();let mut id=200;let mut next=||{id+=1;id};
let asked=viewer.request(&request(7,1,&list),&mut next).unwrap();
assert_eq!(asked.messages.len(),2);
let ask_rpc=&asked.messages[1].1;let clip=bytes(ask_rpc,9).unwrap().unwrap();let ask=bytes(clip,2).unwrap().unwrap();
assert_eq!(number(ask,1),Ok(0));assert_eq!(text_field(ask,3),Ok(MAC_TEXT));
let key=text_field(ask,2).unwrap().to_owned();
let mut confirm=Vec::new();int(1,1,&mut confirm);string(2,&key,&mut confirm);int(3,1,&mut confirm);
assert_eq!(viewer.response(&response(header(ask_rpc).unwrap(),2,&confirm)).unwrap(),None);
let mut block=Vec::new();string(1,&key,&mut block);int(2,0,&mut block);nested(3,"中文 text\n".as_bytes(),&mut block);
assert_eq!(viewer.request(&request(8,3,&block),&mut next).unwrap().text.as_deref(),Some("中文 text\n"));
// Viewer offer lists both formats; a Mac-style ask gets UTF-8 bytes back.
let offer=viewer.offer_any_host(9,"hi".into()).unwrap();
assert_eq!(format_ids(&offer),vec![13,0]);
let mut ask=Vec::new();int(1,0,&mut ask);string(2,"k",&mut ask);string(3,MAC_TEXT,&mut ask);
let out=viewer.request(&request(10,2,&ask),&mut next).unwrap();
let data=bytes(bytes(bytes(&out.messages[1].1,9).unwrap().unwrap(),3).unwrap().unwrap(),3).unwrap().unwrap();
assert_eq!(data,b"hi");
// Host-side offers are unchanged: CF_UNICODETEXT only.
assert_eq!(format_ids(&State::default().offer(1,"hi".into()).unwrap()),vec![13]);
}
#[test]
fn desktop_clipboard_negotiates_and_buffers_unicode_until_confirmation(){
let text="UU-test-中文🙂\n".repeat(900);
+7
View File
@@ -5,6 +5,13 @@
use std::path::PathBuf;
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 {
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)
+11
View File
@@ -15,6 +15,9 @@ pub enum ControlInput {
MouseAbsolute { x: f64, y: f64 },
MouseRelative { dx: i32, dy: i32 },
MouseScroll { dx: i32, dy: i32 },
/// Official Windows host `text_input {content}` (KeyboardMouseRunner::execTextInput): text typed by the
/// mobile clients' own input method. Never logged.
TextInput { text: String },
}
#[derive(Debug, Clone, PartialEq)]
@@ -58,6 +61,11 @@ pub fn decode_control(data: &[u8]) -> Result<ControlMessage, String> {
"mouse_move_relative" => ControlInput::MouseRelative {
dx: integer(&v, "delta_x")?, dy: integer(&v, "delta_y")?,
},
"text_input" => {
let text = v.get("content").and_then(Value::as_str).ok_or("CONTROL field content must be a string")?;
if text.len() > 16 * 1024 { return Err("text_input content exceeds 16 KiB".into()); }
ControlInput::TextInput { text: text.to_owned() }
}
"mouse_scroll" => ControlInput::MouseScroll {
dx: integer(&v, "delta_x")?, dy: integer(&v, "delta_y")?,
},
@@ -137,6 +145,9 @@ mod tests {
#[test]
fn does_not_invent_actions_for_unknown_json() {
assert!(matches!(decode_control(br#"{"action":"unverified"}"#).unwrap(), ControlMessage::Unsupported(_)));
assert_eq!(decode_control("{\"action\":\"text_input\",\"content\":\"你好 a\"}".as_bytes()).unwrap(),
ControlMessage::Input(ControlInput::TextInput { text: "你好 a".into() }));
assert!(decode_control(br#"{"action":"text_input"}"#).is_err());
}
}
+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 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.
pub fn wait(&mut self, timeout: Duration) -> Result<bool, String> {
let deadline = Instant::now() + timeout;
+10
View File
@@ -6,6 +6,16 @@ pub enum DesktopBackend { X11, Wayland, Portal, Kms }
/// port mapping stay available (servers without a monitor or logged-in session).
pub fn headless() -> bool { std::env::var("UU_DESKTOP_BACKEND").is_ok_and(|v| v == "none") }
/// A Wayland compositor socket exists for this user or the environment says so, even when this
/// process (e.g. a systemd unit with only DISPLAY set) would select X11.
pub fn wayland_session_running() -> bool {
std::env::var("XDG_SESSION_TYPE").is_ok_and(|v| v == "wayland")
|| std::env::var("WAYLAND_DISPLAY").is_ok_and(|v| !v.is_empty())
|| std::env::var_os("XDG_RUNTIME_DIR").and_then(|dir| std::fs::read_dir(dir).ok())
.is_some_and(|entries| entries.flatten().any(|e| e.file_name().to_str()
.is_some_and(|n| n.starts_with("wayland-") && !n.ends_with(".lock"))))
}
pub fn detect() -> Result<DesktopBackend, String> {
let backend=select(std::env::var("UU_DESKTOP_BACKEND").ok().as_deref(),
std::env::var("XDG_SESSION_TYPE").ok().as_deref(),
+53
View File
@@ -215,3 +215,56 @@ async fn locked_control_unlock_requests_and_tools_work_without_a_video_frame() {
drop(lock);
}).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());
}
}
+16 -10
View File
@@ -4,10 +4,11 @@
mod native {
use std::{ffi::c_void, ptr::NonNull};
extern "C" {
crate::engine_ffi! { crate::engine_plugin::Engine::Portal;
fn uu_desktop_power_wake() -> i32;
fn uu_desktop_idle_inhibitor_acquire(error: *mut i32) -> *mut c_void;
fn uu_desktop_idle_inhibitor_release(inhibitor: *mut c_void);
fn uu_desktop_screensaver_inhibitor_acquire(error: *mut i32) -> *mut c_void;
}
pub struct Handle(NonNull<c_void>);
@@ -16,9 +17,9 @@ mod native {
unsafe impl Send for Handle {}
impl Handle {
pub fn acquire() -> Result<Self, String> {
pub fn acquire(gnome: bool) -> Result<Self, String> {
let mut error = 0;
let pointer = unsafe { uu_desktop_idle_inhibitor_acquire(&mut error) };
let pointer = unsafe { if gnome { uu_desktop_idle_inhibitor_acquire(&mut error) } else { uu_desktop_screensaver_inhibitor_acquire(&mut error) } };
NonNull::new(pointer).map(Self).ok_or_else(|| super::error("idle inhibition", error))
}
@@ -50,7 +51,9 @@ pub fn wake() -> Result<(), String> {
}
}
/// Holds a GNOME SessionManager idle-only inhibitor until dropped.
/// Holds an idle-only inhibitor until dropped: GNOME SessionManager on GNOME, the freedesktop
/// ScreenSaver interface on KDE (remote input through the portal does not count as activity
/// there, so the session locked mid-session, #61).
///
/// Acquire and drop perform blocking D-Bus work. Session-bus setup and each method call are
/// bounded to three seconds. Callers on an async runtime should move both operations to a
@@ -62,7 +65,8 @@ pub struct IdleInhibitor {
impl IdleInhibitor {
pub fn acquire() -> Result<Self, String> {
if !gnome_portal_active() {
let kde = portal_desktop_is("kde");
if !gnome_portal_active() && !kde {
return Ok(Self {
#[cfg(all(target_os = "linux", feature = "portal"))]
_handle: None,
@@ -70,7 +74,7 @@ impl IdleInhibitor {
}
#[cfg(all(target_os = "linux", feature = "portal"))]
{
native::Handle::acquire().map(|handle| Self { _handle: Some(handle) })
native::Handle::acquire(!kde).map(|handle| Self { _handle: Some(handle) })
}
#[cfg(not(all(target_os = "linux", feature = "portal")))]
{
@@ -79,10 +83,12 @@ impl IdleInhibitor {
}
}
fn gnome_portal_active() -> bool {
let gnome = std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_default().split(':')
.any(|desktop| desktop.eq_ignore_ascii_case("gnome"));
gnome && crate::desktop_backend::detect().is_ok_and(|backend| backend == crate::desktop_backend::DesktopBackend::Portal)
fn gnome_portal_active() -> bool { portal_desktop_is("gnome") }
fn portal_desktop_is(name: &str) -> bool {
let matches = std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_default().split(':')
.any(|desktop| desktop.eq_ignore_ascii_case(name));
matches && crate::desktop_backend::detect().is_ok_and(|backend| backend == crate::desktop_backend::DesktopBackend::Portal)
}
#[cfg(all(target_os = "linux", feature = "portal"))]
+225
View File
@@ -0,0 +1,225 @@
//! `uuremote-server doctor`: one report with what an issue needs (session, backend, plugins,
//! input permission, encoders, config and service state), safe to paste publicly. It prints only
//! booleans, names and versions: no account ids, tokens, addresses, MACs or file contents, and the
//! home directory is shown as `~`.
fn redact(text: &str) -> String {
let mut out = text.to_owned();
if let Some(home) = std::env::var_os("HOME").and_then(|h| h.into_string().ok()).filter(|h| h.len() > 1) { out = out.replace(&home, "~"); }
if let Ok(user) = std::env::var("USER") { if user.len() > 2 { out = out.replace(&user, "<user>"); } }
out
}
fn env_state(name: &str) -> String {
match std::env::var(name) { Ok(v) if v.is_empty() => "set (empty)".into(), Ok(_) => "set".into(), Err(_) => "unset".into() }
}
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 {
#[cfg(all(target_os = "linux", target_env = "gnu"))]
{
extern "C" { fn gnu_get_libc_version() -> *const libc::c_char; }
return unsafe { std::ffi::CStr::from_ptr(gnu_get_libc_version()) }.to_string_lossy().into_owned();
}
#[allow(unreachable_code)]
"n/a".into()
}
fn writable(path: &str) -> &'static str {
let Ok(c_path) = std::ffi::CString::new(path) else { return "invalid" };
if !std::path::Path::new(path).exists() { "missing" }
else if unsafe { libc::access(c_path.as_ptr(), libc::W_OK) } == 0 { "writable" } else { "no permission" }
}
async fn command_output(program: &str, args: &[&str]) -> Option<String> {
let output = tokio::time::timeout(std::time::Duration::from_secs(5),
tokio::process::Command::new(program).args(args).kill_on_drop(true).output()).await.ok()?.ok()?;
Some(String::from_utf8_lossy(&output.stdout).trim().to_owned())
}
/// Whether the report must say that this session has no screen to capture: neither DISPLAY nor
/// WAYLAND_DISPLAY is set, and the backend is the X11 one that needs a display to open.
fn missing_display(backend: crate::desktop_backend::DesktopBackend, headless: bool,
display: Option<&std::ffi::OsStr>, wayland: Option<&std::ffi::OsStr>) -> bool {
!headless && backend == crate::desktop_backend::DesktopBackend::X11
&& display.is_none() && wayland.is_none()
}
pub async fn run() -> Result<(), String> {
use crate::desktop_backend as backend;
use crate::engine_plugin::{load, Engine};
// Info logs (e.g. plugin paths under the home directory) would bypass the redaction below.
log::set_max_level(log::LevelFilter::Warn);
println!("uu-remote-linux doctor (safe to paste: no ids, tokens, addresses or file contents)");
line("version", format!("v{} {}", env!("CARGO_PKG_VERSION"), std::env::consts::ARCH));
line("glibc", glibc());
let os = std::fs::read_to_string("/etc/os-release").ok()
.and_then(|t| t.lines().find_map(|l| l.strip_prefix("PRETTY_NAME=").map(|v| v.trim_matches('"').to_owned())));
line("os", os.unwrap_or_else(|| "unknown".into()));
let features: Vec<&str> = [("wayland", cfg!(feature = "wayland")), ("portal", cfg!(feature = "portal")),
("engine-plugins", cfg!(feature = "engine-plugins")), ("inproc-av", cfg!(feature = "inproc-av"))]
.into_iter().filter(|(_, on)| *on).map(|(name, _)| name).collect();
line("build features", if features.is_empty() { "default (X11 only)".to_owned() } else { features.join(", ") });
println!("-- session");
line("XDG_SESSION_TYPE", std::env::var("XDG_SESSION_TYPE").unwrap_or_else(|_| "unset".into()));
line("XDG_CURRENT_DESKTOP", std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_else(|_| "unset".into()));
line("DISPLAY", env_state("DISPLAY"));
line("WAYLAND_DISPLAY", env_state("WAYLAND_DISPLAY"));
line("wayland running", backend::wayland_session_running());
line("UU_DESKTOP_BACKEND", std::env::var("UU_DESKTOP_BACKEND").unwrap_or_else(|_| "auto".into()));
let selected = backend::detect();
line("selected backend", match &selected { Ok(b) if backend::headless() => format!("none (headless, {b:?} unused)"), Ok(b) => format!("{b:?}"), Err(e) => format!("error: {e}") });
if selected.as_ref().is_ok_and(|b| *b == backend::DesktopBackend::X11) && backend::wayland_session_running() && !backend::headless() {
println!(" ! X11 backend inside a Wayland session: the picture will be black");
}
// A session without any display cannot capture a screen; say so instead of naming a backend.
if let Ok(selected) = &selected {
if missing_display(*selected, backend::headless(), std::env::var_os("DISPLAY").as_deref(), std::env::var_os("WAYLAND_DISPLAY").as_deref()) {
println!(" ! DISPLAY and WAYLAND_DISPLAY are unset: the X11 engine will only try :0 and :1; without an X server there, no screen can be captured");
println!(" terminal, file transfer and port mapping still work; UU_DESKTOP_BACKEND=none marks the host as headless");
}
}
if cfg!(feature = "engine-plugins") {
for engine in [Engine::Wayland, Engine::Portal] {
line(engine.file(), match load(engine) { Ok(()) => "loaded".to_owned(), Err(e) => e });
}
}
println!("-- input");
line("/dev/uinput", writable("/dev/uinput"));
line("UU_INPUT_BACKEND", std::env::var("UU_INPUT_BACKEND").unwrap_or_else(|_| "auto".into()));
println!("-- video");
let selection = crate::video_select::selection();
let env_enc = std::env::var("UU_VIDEO_ENCODER").unwrap_or_else(|_| "unset".into());
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 probe_text = if selection.encoder_source == crate::video_select::Source::Auto {
format_probe(&crate::video::run_auto_probe().await)
} else {
crate::video_select::cached_probe().as_ref().map(format_probe).unwrap_or_else(|| "not yet run".to_owned())
};
let selection = if selection.encoder_source == crate::video_select::Source::Auto { crate::video_select::selection() } else { selection };
line("encoder probe", probe_text);
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)));
// 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();
version.arg("-version").kill_on_drop(true);
if let Ok(Ok(output)) = tokio::time::timeout(std::time::Duration::from_secs(5), version.output()).await {
line("ffmpeg version", String::from_utf8_lossy(&output.stdout).lines().next().unwrap_or("").split_whitespace().nth(2).unwrap_or("unknown"));
}
line("nvidia driver", std::path::Path::new("/proc/driver/nvidia/version").exists());
line("render node", writable(&std::env::var("UU_VAAPI_DEVICE").unwrap_or_else(|_| "/dev/dri/renderD128".into())));
println!("-- audio");
for tool in ["pactl", "pw-cli"] {
line(tool, command_output("sh", &["-c", &format!("command -v {tool} >/dev/null && echo found || echo missing")]).await.unwrap_or_else(|| "unknown".into()));
}
println!("-- account and service");
let path = crate::config::path();
line("config", path.display());
match std::fs::metadata(&path) {
Ok(meta) => {
use std::os::unix::fs::PermissionsExt;
line("config mode", format!("{:o}", meta.permissions().mode() & 0o777));
// Presence only: never read values out of the file.
let fields: Option<serde_json::Value> = std::fs::read(&path).ok().and_then(|b| serde_json::from_slice(&b).ok());
let has = |key: &str| fields.as_ref().and_then(|v| v.get(key)).is_some_and(|v| !v.is_null() && v.as_str() != Some(""));
line("signed in", has("token") && has("user_id"));
line("device registered", has("device_id"));
}
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()));
let running = host_processes();
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(())
}
/// 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)]
mod tests {
#[test]
fn redaction_hides_home_and_user() {
let home = std::env::var("HOME").unwrap_or_default();
if home.len() > 1 { assert_eq!(super::redact(&format!("{home}/.config/x")), "~/.config/x"); }
assert_eq!(super::env_state("UU_DOCTOR_TEST_SURELY_UNSET"), "unset");
}
#[test]
fn a_session_without_any_display_is_reported() {
use crate::desktop_backend::DesktopBackend;
let display = std::ffi::OsStr::new(":0");
let wayland = std::ffi::OsStr::new("wayland-1");
// No DISPLAY and no WAYLAND_DISPLAY: nothing can be captured.
assert!(super::missing_display(DesktopBackend::X11, false, None, None));
// One of them present: the backend has a screen to open.
assert!(!super::missing_display(DesktopBackend::X11, false, Some(display), None));
assert!(!super::missing_display(DesktopBackend::X11, false, None, Some(wayland)));
// Another backend, or a headless host: not this warning.
assert!(!super::missing_display(DesktopBackend::Wayland, false, 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);
}
}
+121
View File
@@ -0,0 +1,121 @@
//! Optional desktop engines loaded at runtime (`--features engine-plugins`).
//!
//! The Wayland (wlroots) and GNOME/KDE portal engines link libwayland/libxkbcommon and
//! GIO/PipeWire/libei. Linking them into `uuremote-server` would stop it from starting on X11 hosts
//! without those libraries, and libei is missing on older distributions. With engine-plugins they
//! are built as `libuu-wayland.so` / `libuu-portal.so`, shipped next to the binary, and opened with
//! dlopen only when the session needs them, so one release package serves every backend.
//! Without the feature the engines are linked statically as before and nothing here is used.
#![cfg_attr(not(feature = "engine-plugins"), allow(dead_code))]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Engine { Wayland, Portal }
impl Engine {
pub fn file(self) -> &'static str { match self { Self::Wayland => "libuu-wayland.so", Self::Portal => "libuu-portal.so" } }
fn index(self) -> usize { self as usize }
}
/// Directories searched for engine libraries, in order.
fn search_dirs() -> Vec<std::path::PathBuf> {
let mut dirs = Vec::new();
if let Some(dir) = std::env::var_os("UU_ENGINE_DIR").filter(|d| !d.is_empty()) { dirs.push(dir.into()); }
if let Some(exe_dir) = std::env::current_exe().ok().and_then(|exe| exe.parent().map(|d| d.to_path_buf())) {
dirs.push(exe_dir.join("../lib/uu-remote-linux"));
dirs.push(exe_dir.clone());
}
if let Some(home) = std::env::var_os("HOME") { dirs.push(std::path::Path::new(&home).join(".local/lib/uu-remote-linux")); }
dirs.extend(["/usr/local/lib/uu-remote-linux", "/usr/lib/uu-remote-linux"].map(std::path::PathBuf::from));
dirs
}
#[cfg(all(target_os = "linux", feature = "engine-plugins"))]
mod native {
use super::Engine;
use std::sync::OnceLock;
static HANDLES: [OnceLock<Result<usize, String>>; 2] = [OnceLock::new(), OnceLock::new()];
fn dlerror() -> String {
let message = unsafe { libc::dlerror() };
if message.is_null() { return "unknown dlopen error".into(); }
unsafe { std::ffi::CStr::from_ptr(message) }.to_string_lossy().into_owned()
}
fn open(engine: Engine) -> Result<usize, String> {
for dir in super::search_dirs() {
let path = dir.join(engine.file());
if !path.is_file() { continue; }
use std::os::unix::ffi::OsStrExt;
let Ok(c_path) = std::ffi::CString::new(path.as_os_str().as_bytes()) else { continue };
let handle = unsafe { libc::dlopen(c_path.as_ptr(), libc::RTLD_NOW | libc::RTLD_LOCAL) };
if handle.is_null() {
// Usually a missing system library (e.g. libei.so.1) or a too old glibc.
return Err(format!("{} could not be loaded: {}", path.display(), dlerror()));
}
log::info!("Desktop engine loaded: {}", path.display());
return Ok(handle as usize);
}
Err(format!("{} not found (looked next to uuremote-server, in ../lib/uu-remote-linux, ~/.local/lib/uu-remote-linux, /usr/lib/uu-remote-linux; UU_ENGINE_DIR overrides)", engine.file()))
}
pub fn load(engine: Engine) -> Result<(), String> {
HANDLES[engine.index()].get_or_init(|| open(engine)).as_ref().map(|_| ()).map_err(Clone::clone)
}
/// Address of `name` (NUL-terminated) in the engine, or 0 when the engine or symbol is missing.
pub fn symbol(engine: Engine, name: &'static str) -> usize {
let Ok(handle) = HANDLES[engine.index()].get_or_init(|| open(engine)) else { return 0 };
let address = unsafe { libc::dlsym(*handle as *mut libc::c_void, name.as_ptr().cast()) };
if address.is_null() { log::warn!("Desktop engine {} lacks {}", engine.file(), name.trim_end_matches('\0')); }
address as usize
}
}
/// Loads `engine`, or explains why it is unavailable. Always Ok when the engines are linked in.
pub fn load(engine: Engine) -> Result<(), String> {
#[cfg(all(target_os = "linux", feature = "engine-plugins"))]
{ native::load(engine) }
#[cfg(not(all(target_os = "linux", feature = "engine-plugins")))]
{ let _ = engine; Ok(()) }
}
#[cfg(all(target_os = "linux", feature = "engine-plugins"))]
pub use native::symbol;
/// Value returned by an engine call whose library could not be loaded (callers check `load` first).
pub trait Missing { fn missing() -> Self; }
impl Missing for () { fn missing() -> Self {} }
impl Missing for i32 { fn missing() -> Self { -1 } }
impl<T> Missing for *mut T { fn missing() -> Self { std::ptr::null_mut() } }
/// Declares engine C functions: an `extern "C"` block when linked statically, or dlsym-resolved
/// wrappers with the same names and signatures with `engine-plugins`.
#[macro_export]
macro_rules! engine_ffi {
($engine:expr; $(fn $name:ident($($arg:ident: $ty:ty),* $(,)?) $(-> $ret:ty)?;)*) => {
#[cfg(not(feature = "engine-plugins"))]
extern "C" { $(fn $name($($arg: $ty),*) $(-> $ret)?;)* }
$(
#[cfg(feature = "engine-plugins")]
unsafe fn $name($($arg: $ty),*) $(-> $ret)? {
static ADDRESS: std::sync::OnceLock<usize> = std::sync::OnceLock::new();
let address = *ADDRESS.get_or_init(|| $crate::engine_plugin::symbol($engine, concat!(stringify!($name), "\0")));
if address == 0 { return $crate::engine_plugin::Missing::missing(); }
let function: unsafe extern "C" fn($($ty),*) $(-> $ret)? = unsafe { std::mem::transmute(address) };
unsafe { function($($arg),*) }
}
)*
};
}
#[cfg(test)]
mod tests {
#[test]
fn search_prefers_override_then_package_layout() {
let dirs = super::search_dirs();
let exe_dir = std::env::current_exe().unwrap().parent().unwrap().to_path_buf();
assert!(dirs.iter().position(|d| *d == exe_dir.join("../lib/uu-remote-linux")) < dirs.iter().position(|d| *d == exe_dir));
assert_eq!(dirs.last().unwrap(), std::path::Path::new("/usr/lib/uu-remote-linux"));
}
}
+14 -3
View File
@@ -77,8 +77,8 @@ pub struct Screen<'a> {
}
impl Screen<'_> {
fn encode(&self) -> Result<Vec<u8>, String> {
if self.id < 0 || self.fps <= 0 || self.video_track_index < 0 {
return Err("Screen id/track must be nonnegative and fps positive".into());
if self.id < 0 || self.fps <= 0 || self.video_track_index < -1 {
return Err("Screen id must be nonnegative, track >= -1 and fps positive".into());
}
if !self.dpr.is_finite() || self.dpr <= 0.0 {
return Err("Screen dpr must be positive and finite".into());
@@ -118,7 +118,7 @@ pub fn encode_screen_sources(seq: u64, timestamp: u64, screens: &[Screen<'_>], c
let mut tracks = std::collections::HashSet::new();
let mut payload = Vec::new();
for screen in screens {
if !ids.insert(screen.id) || !tracks.insert(screen.video_track_index) {
if !ids.insert(screen.id) || (screen.video_track_index >= 0 && !tracks.insert(screen.video_track_index)) {
return Err("Screen ids and video track indices must be unique".into());
}
bytes(1, &screen.encode()?, &mut payload);
@@ -295,3 +295,14 @@ mod tests {
assert!(encode_capture_change(1, 2, 4, 1, "").is_err());
}
}
#[cfg(test)]
mod inactive_track_tests {
use super::*;
#[test]
fn multiple_inactive_screens_share_minus_one_but_active_track_is_unique() {
let screen=|id,track| Screen {id,fps:60,resolution:WinRect {left:0,top:0,width:1920,height:1080,pixel_width:1920,pixel_height:1080},primary:id==0,dpr:1.0,display_name:"test",video_track_index:track,screen_type:0,builtin_screen_type:0,scaled:&[],current:None};
assert!(encode_screen_sources(1,2,&[screen(0,0),screen(1,-1),screen(2,-1)],0).is_ok());
assert!(encode_screen_sources(1,2,&[screen(0,0),screen(1,0)],0).is_err());
}
}
+671 -391
View File
File diff suppressed because it is too large. Load diff
+259 -1
View File
@@ -10,9 +10,12 @@ extern "C" {
fn x11_key_event(keycode: libc::c_int, is_press: libc::c_int) -> libc::c_int;
fn x11_release_all() -> libc::c_int;
fn x11_terminal_shortcut_state() -> libc::c_int;
fn x11_type_utf8(text: *const libc::c_char) -> libc::c_int;
}
#[cfg(not(target_os = "linux"))]
unsafe fn x11_terminal_shortcut_state() -> libc::c_int { 0 }
#[cfg(not(target_os = "linux"))]
unsafe fn x11_type_utf8(_: *const libc::c_char) -> libc::c_int { 0 }
#[cfg(not(target_os = "linux"))]
unsafe fn x11_mouse_move(_: libc::c_int, _: libc::c_int) -> libc::c_int { 0 }
@@ -248,6 +251,14 @@ impl InputInjector {
if AUDIT.fetch_add(1,std::sync::atomic::Ordering::Relaxed) < 8 {
log::info!("Desktop keyboard injection outcome: result={result}");
}
// KP_0..KP_9 type digits only with NumLock on (#46); record the server's NumLock state, not the key.
static NUMPAD: std::sync::atomic::AtomicUsize = std::sync::atomic::AtomicUsize::new(0);
if (0x60..=0x6f).contains(&key) && is_press && self.backend==crate::desktop_backend::DesktopBackend::X11
&& NUMPAD.fetch_add(1,std::sync::atomic::Ordering::Relaxed) < 4 {
let (mut x,mut y,mut mask)=(0,0,0u32);
let state=unsafe { x11_pointer_state(&mut x,&mut y,&mut mask) };
log::info!("Desktop numpad key: result={result} numlock={}", state==0 && mask & 0x10 != 0);
}
if result == 0 {
let mut held=self.held.lock().unwrap();
if is_press {held.keys.insert(symbol);} else {held.keys.remove(&symbol);}
@@ -314,9 +325,21 @@ impl InputInjector {
}
}
fn inject_move(&self,x:i32,y:i32,relative:bool)->i32 {
// uinput ABS axes span the compositor's whole desktop. A captured output
// uses its own pixel space; bind absolute motion to that Wayland output,
// 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 {
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 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 {
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)));
@@ -349,6 +372,133 @@ impl InputInjector {
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)) } }
}
/// 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
/// 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) {
let _serial=self.serial.lock().unwrap();
let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return };
if self.backend==crate::desktop_backend::DesktopBackend::X11 {
let typed=unsafe { x11_type_utf8(c_text.as_ptr()) };
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
} else if self.backend==crate::desktop_backend::DesktopBackend::Wayland {
// Escape hatch: disable Wayland text typing/pasting entirely without rebuilding.
if std::env::var("UU_WAYLAND_TEXT").is_ok_and(|v|v=="0") { return; }
let typed=crate::wayland::type_utf8(text);
if typed>=0 {
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
return;
}
// 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);
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
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 {
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
log::warn!("Mobile text input is not supported on the {:?} backend yet", self.backend);
}
}
}
pub fn key_event(&self, keycode: i32, is_press: bool) {
let _serial=self.serial.lock().unwrap();
if self.backend!=crate::desktop_backend::DesktopBackend::X11 { return; }
@@ -600,3 +750,111 @@ mod lifecycle_tests {
session.with_input(||panic!("late event after disconnect"));
}
}
#[cfg(all(test,target_os="linux",feature="wayland"))]
mod output_pointer_tests {
use super::*;
#[test]
#[ignore="requires unlocked Hyprland, UU_WAYLAND_MULTISCREEN=1 and accessible uinput; moves pointer only"]
fn absolute_pointer_stays_on_capture_output_with_uinput_enabled() {
fn cursor()->serde_json::Value {
let output=std::process::Command::new("hyprctl").args(["cursorpos","-j"]).output().unwrap();
assert!(output.status.success());serde_json::from_slice(&output.stdout).unwrap()
}
struct Restore(serde_json::Value);
impl Drop for Restore {
fn drop(&mut self) {
let _=std::process::Command::new("hyprctl").args(["dispatch","movecursor",&self.0["x"].to_string(),&self.0["y"].to_string()]).output();
}
}
let _restore=Restore(cursor());
crate::wayland::init().unwrap();
let input=InputInjector::new();
assert!(input.uinput.is_some(),"test must exercise the uinput/native hybrid path");
// libinput discovers the newly created virtual devices asynchronously.
std::thread::sleep(std::time::Duration::from_secs(1));
let output=std::process::Command::new("hyprctl").args(["monitors","-j"]).output().unwrap();
let monitors:Vec<serde_json::Value>=serde_json::from_slice(&output.stdout).unwrap();
let outputs=crate::wayland::outputs();assert!(outputs.len()>=2,"needs at least two outputs");
for (id,output) in outputs.iter().enumerate().chain(outputs.iter().enumerate().rev()) {
crate::wayland::select(id).unwrap();
let monitor=monitors.iter().find(|m|m["name"].as_str()==Some(output.name.as_str())).unwrap();
let scale=monitor["scale"].as_f64().unwrap();
for (x,y) in [(0.1,0.1),(0.5,0.5),(0.9,0.9),(0.1,0.9),(0.9,0.1)] {
let size=(output.width,output.height);
let pixels=crate::input_mapping::normalized_pointer(x,y,size.0,size.1).unwrap();
assert_eq!(input.backend,crate::desktop_backend::DesktopBackend::Wayland);
input.mouse_absolute_normalized(x,y,size);input.flush_pointer();
let expected=(monitor["x"].as_f64().unwrap()+f64::from(pixels.0)/scale,
monitor["y"].as_f64().unwrap()+f64::from(pixels.1)/scale);
// Motion is asynchronous; observe its first arrival instead of a
// later position potentially changed by another input device.
let deadline=std::time::Instant::now()+std::time::Duration::from_millis(250);
loop {
let actual=cursor();
let matched=(actual["x"].as_f64().unwrap()-expected.0).abs()<=2.0
&& (actual["y"].as_f64().unwrap()-expected.1).abs()<=2.0;
if matched {break;}
assert!(std::time::Instant::now()<deadline,"pointer offset: output={} normalized=({},{}) actual={} expected={:?}",output.name,x,y,actual,expected);
std::thread::sleep(std::time::Duration::from_millis(5));
}
}
}
}
}
#[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())
}
pub async fn run(pc: &RTCPeerConnection, track: &VideoTrack, desktop: &PortalDesktop) -> Result<(), String> {
run_with_encoder(pc, track, desktop, black_frame).await
pub async fn run(pc: &RTCPeerConnection, track: &VideoTrack, desktop: &PortalDesktop, selection: crate::video_select::Selection) -> Result<(), String> {
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>> {
// #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.
@@ -55,8 +55,8 @@ where F: FnMut(VideoCodec) -> Fut, Fut: std::future::Future<Output = Result<Byte
if !updates.borrow().waiting || *locked.borrow() != Some(true)
|| pc.connection_state() != RTCPeerConnectionState::Connected { continue; }
if frame.is_none() {
let codec = crate::capture_setting::preferred_codec(
track.supports(VideoCodec::H264), track.supports(VideoCodec::H265));
let codec = crate::capture_setting::preferred_codec_for(
track.supports(VideoCodec::H264), track.supports(VideoCodec::H265), selection);
let encoded = tokio::select! {
biased;
_ = 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_track = peers.track.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_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 revision = peers.track.revision();
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 lock_tx = lock_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_track = peers.track.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(
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_track = peers.track.clone();
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();
tokio::time::timeout(Duration::from_secs(2), close_task).await
.expect("locked video task did not stop after terminal peer close")
+162 -37
View File
@@ -8,7 +8,7 @@
//! (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.
use crate::auth::{Credentials, UUAuthClient};
use crate::auth::{Credentials, QrRequestErrorKind, UUAuthClient};
use crate::login_ui::{LoginUi, Tone};
use serde_json::{json, Value};
use std::time::Duration;
@@ -127,6 +127,35 @@ fn render_qr(content: &str) -> Result<String, String> {
/// API code for an expired login QR code.
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.
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}"))?;
@@ -268,13 +297,30 @@ pub async fn prepare_device() -> Result<(Value, Credentials), String> {
pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
let (mut cfg, creds) = prepare_device().await?;
let client = UUAuthClient::new(creds.clone());
// 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 {
let (status, resp) = client.post_json("/api/v1/qrcode/gen/login", &json!({})).await?;
let d = data("qrcode gen", status, &resp)?;
let (status, resp) = match client.post_with_timeout("/api/v1/qrcode/gen/login", None, timeout).await {
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 ticket = d.get("token").or_else(|| d.get("status_query_ticket")).and_then(|v| v.as_str())
.ok_or("qrcode gen returned no token")?.to_string();
let ticket = qr_ticket(&d).ok_or("qrcode gen returned no status ticket")?.to_string();
ui.offer_refresh(false);
if ui.shown() {
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)?;
@@ -289,40 +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())?;
}
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 expired = false;
for _ in 0..150 {
let failure = loop {
let query = json!({"token": ticket, "qrcode_jump_url": url, "login_status": login_status});
let (status, resp) = match client.post_json("/api/v1/qrcode/login/status", &query).await {
let (status, resp) = match client.post_with_timeout("/api/v1/qrcode/login/status", Some(&query), timeout).await {
Ok(r) => r,
Err(_) => continue, // long-poll timeout: ask again
Err(e) => {
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.
if resp.get("code").and_then(|c| c.as_i64()) == Some(QR_EXPIRED) {
ui.status("二维码已过期,正在刷新…", Tone::Info);
expired = true; break;
}
let st = data("qrcode status", status, &resp)?.get("status").and_then(|v| v.as_i64()).unwrap_or(login_status);
if st == login_status { continue; }
login_status = st;
match st {
2 => {
match qr_poll_action(login_status, status, &resp) {
QrPollAction::Wait(st) => {
if st == 1 && login_status != 1 { ui.status("等待扫码…", Tone::Info); }
login_status = st;
}
QrPollAction::Scanned => {
login_status = 2;
println!("已扫码,请在手机上确认 (scanned, confirm on the phone)");
ui.status("已扫码,请在手机上确认登录", Tone::Ok);
}
3 | 4 => {
// A final state: confirmed logs in; cancelled/expired is refused and a new QR follows.
QrPollAction::Refresh(delay) => {
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 (status, resp) = client.post_json("/api/v1/login/by_qrcode", &body).await?;
let d = match data("qrcode login", status, &resp) {
Ok(d) => d,
Err(e) => {
println!("QR status {st}: login not granted ({e})");
ui.status("手机端未确认登录,正在刷新二维码…", Tone::Error);
expired = true; break;
let (status, resp) = match client.post_with_timeout("/api/v1/login/by_qrcode", Some(&body), timeout).await {
Ok(r) => r,
Err(e) if e.response_received() => {
eprintln!("QR login exchange response failed: {e}");
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 user = d.get("user_id").and_then(|v| v.as_str()).ok_or("login returned no user_id")?;
@@ -339,19 +394,88 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
println!("Logged in as {} ({}); saved to {}", nickname, user, path.display());
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" });
tokio::time::sleep(Duration::from_secs(1)).await; // never spin if the server keeps refusing
};
if !failure.is_empty() { wait_for_refresh(ui, failure).await; }
}
}
/// 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)]
mod tests {
use super::*;
#[tokio::test]
async fn service_waits_until_a_new_token_is_saved() {
#[test]
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()));
std::fs::create_dir_all(&dir).unwrap();
let path = dir.join("config.json");
@@ -367,6 +491,7 @@ mod tests {
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
let _ = std::fs::remove_dir_all(&dir);
});
}
#[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_closed() -> libc::c_int;
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)]
@@ -56,6 +58,19 @@ impl LoginUi {
}
#[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) {
#[cfg(uu_gtk)]
if self.shown { let t = cstr(text); unsafe { uu_login_ui_set_status(t.as_ptr(), tone as libc::c_int) } }
+331 -25
View File
@@ -1,7 +1,12 @@
//! UU Remote Pure Native Linux Server (Rust Edition)
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
mod ws_transport;
mod engine_plugin;
mod doctor;
mod wol;
mod desktop_backend;
mod desktop_mode;
mod desktop_session;
mod desktop_power;
mod portal;
@@ -26,6 +31,7 @@ mod signaling;
mod terminal;
mod webrtc;
mod video;
mod video_select;
mod video_track;
mod locked_video;
#[cfg(test)]
@@ -68,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))
.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> {
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()
@@ -123,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))
}
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.
fn present_on_usr1(ui: std::sync::Arc<assist::LocalUi>) {
// Install the handler before publishing the pid: SIGUSR1's default action terminates the process.
let Ok(mut usr1) = tokio::signal::unix::signal(tokio::signal::unix::SignalKind::user_defined1()) else { return };
/// 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.
/// The default action of either signal terminates the process, so both handlers are installed before `host.pid` is written.
/// 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();
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") }
@@ -136,10 +317,41 @@ fn host_pid_path() -> std::path::PathBuf { config::path().with_file_name("host.p
fn write_host_pid() {
use std::os::unix::fs::OpenOptionsExt;
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());
}
}
/// Why `unit` is not (going to be) running, from `systemctl --user show`; None while it is active or starting.
fn unit_not_running(unit: &str, settled: bool) -> Option<String> {
let output = std::process::Command::new("systemctl").args(["--user", "show", unit, "-p", "ActiveState,SubState,ConditionResult"]).output().ok()?;
let text = String::from_utf8_lossy(&output.stdout);
let value = |key: &str| text.lines().find_map(|l| l.strip_prefix(key).and_then(|v| v.strip_prefix('='))).unwrap_or("").to_owned();
unit_state_problem(unit, &value("ActiveState"), &value("SubState"), &value("ConditionResult"), settled)
}
fn unit_state_problem(unit: &str, active: &str, sub: &str, condition: &str, settled: bool) -> Option<String> {
let hint = format!("see `systemctl --user status {unit}` and `journalctl --user -u {unit}`");
if condition == "no" { return Some(format!("{unit} was skipped: a Condition in the unit is not met (e.g. ConditionEnvironment outside the graphical session); {hint}")); }
if active == "failed" { return Some(format!("{unit} failed to start; {hint}")); }
if sub == "auto-restart" { return Some(format!("{unit} keeps exiting and being restarted; {hint}")); }
if settled && active == "inactive" { return Some(format!("{unit} is not running; {hint}")); }
None
}
#[cfg(test)]
mod show_unit_tests {
#[test]
fn skipped_crashing_and_failed_units_are_reported() {
let p = |a, s, c, settled| super::unit_state_problem("u.service", a, s, c, settled);
assert!(p("inactive", "dead", "no", false).unwrap().contains("skipped"));
assert!(p("activating", "auto-restart", "yes", false).unwrap().contains("restarted"));
assert!(p("failed", "failed", "yes", false).unwrap().contains("failed"));
assert!(p("inactive", "dead", "yes", false).is_none());
assert!(p("inactive", "dead", "yes", true).unwrap().contains("not running"));
assert!(p("active", "running", "yes", true).is_none());
assert!(p("activating", "start", "yes", true).is_none());
}
}
/// `uuremote-server show` (desktop launcher): open the running host's window, or start the host in the
/// foreground with its window when none runs (e.g. no systemd unit installed yet).
fn show_running_host() -> Result<(), Box<dyn std::error::Error>> {
@@ -159,7 +371,10 @@ fn show_running_host() -> Result<(), Box<dyn std::error::Error>> {
.stdout(std::process::Stdio::null()).stderr(std::process::Stdio::null()).status().is_ok_and(|s| s.success());
if installed && std::process::Command::new("systemctl").args(["--user", "start", &unit]).status().is_ok_and(|s| s.success()) {
let before = std::fs::metadata(host_pid_path()).and_then(|m| m.modified()).ok();
for _ in 0..60 {
for attempt in 0..60 {
// `systemctl start` also returns 0 when the unit is skipped by a Condition or keeps
// crashing under Restart=; report that instead of waiting 30 s for a pid (#62).
if let Some(reason) = unit_not_running(&unit, attempt >= 2) { return Err(reason.into()); }
std::thread::sleep(std::time::Duration::from_millis(500));
let fresh = std::fs::metadata(host_pid_path()).and_then(|m| m.modified()).ok().is_some_and(|t| Some(t) != before);
let pid = std::fs::read_to_string(host_pid_path()).ok().and_then(|s| s.trim().parse::<i32>().ok());
@@ -168,7 +383,7 @@ fn show_running_host() -> Result<(), Box<dyn std::error::Error>> {
if unsafe { libc::kill(pid, libc::SIGUSR1) } == 0 { return Ok(()); }
}
}
return Err("the UU remote host service started but did not open its window".into());
return Err(format!("{unit} is running but did not open its window within 30 s; check `journalctl --user -u {unit}`").into());
}
use std::os::unix::process::CommandExt;
Err(Box::new(std::process::Command::new("/proc/self/exe").env("UU_SHOW_WINDOW", "1").exec()))
@@ -190,16 +405,20 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
.filter_module("uuremote_server", log::LevelFilter::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.
const SUBCOMMANDS: [&str; 13] = ["show", "assist", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture",
"wayland-input-probe", "clipboard-acceptance", "portal-acceptance"];
if let Some(arg) = std::env::args().nth(1).filter(|a| !SUBCOMMANDS.contains(&a.as_str())) {
let arg1 = std::env::args().nth(1);
let value_ok = match arg1.as_deref() {
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(" | "));
if matches!(arg.as_str(), "help" | "-h" | "--help") { println!("{usage}"); return Ok(()); }
if code == 0 { println!("{usage}"); return Ok(()); }
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 matches!(std::env::args().nth(1).as_deref(), Some("set-encoder") | Some("set-codec")) { return set_video_pref(); }
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()); }
assist::configure()?;
@@ -353,6 +572,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
if std::env::args().nth(1).as_deref() == Some("wayland-input-probe") {
return wayland::input_probe().map_err(|e|e.into());
}
if std::env::args().nth(1).as_deref() == Some("wayland-text-probe") {
return wayland::text_probe().map_err(|e|e.into());
}
if std::env::args().nth(1).as_deref() == Some("doctor") {
return doctor::run().await.map_err(|e| e.into());
}
if std::env::args().nth(1).as_deref() == Some("wayland-capture") {
return wayland::capture_stdout().map_err(|e| e.into());
}
@@ -405,11 +630,22 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
virtual_audio::init();
let _audio_cleanup=virtual_audio::Cleanup;
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() {
// X11 capture inside a Wayland session reads XWayland's root window: all black, no error (#61).
log::warn!("A Wayland session is running but the X11 backend is selected: the picture will be black. Run inside the Wayland session (WAYLAND_DISPLAY set, UU_DESKTOP_BACKEND=auto) or log in to the Xorg session");
}
let capture = Arc::new((if desktop_backend::headless() {
Err("headless mode (UU_DESKTOP_BACKEND=none)".to_owned())
} else if desktop_backend::detect()?==desktop_backend::DesktopBackend::Portal {
Err("Portal capture waits for a desktop CONTROL connection".to_owned())
Err(if !cfg!(feature = "portal") { portal::NOT_BUILT.to_owned() }
else if let Err(reason) = engine_plugin::load(engine_plugin::Engine::Portal) { format!("GNOME/KDE Wayland (portal) engine unavailable: {reason}") }
else { "Portal capture waits for a desktop CONTROL connection".to_owned() })
} else { ScreenCapture::new() }).unwrap_or_else(|error| {
log::warn!("Desktop unavailable; terminal and file tools remain available: {error}");
ScreenCapture::unavailable(error)
@@ -459,7 +695,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
if let Some(task) = command_task { task.abort(); }
// One exit path for commands, signals, transport failures and UI failures.
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();
// 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
@@ -511,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 mac_by_ice: HashMap<String, bool> = HashMap::new();
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 {
if *shutdown.borrow() {
@@ -595,6 +833,7 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
_ = shutdown.changed() => Some(SignalingEvent::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),
Some(ice) = desktop_requested.recv() => Some(SignalingEvent::DesktopRequested(ice)),
event = rx_event.recv() => event,
};
let Some(evt) = event else { break; };
@@ -629,12 +868,17 @@ 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::Failed)).map(|(id, _)| id.clone()).collect();
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; } }
if desktop_ended && !sessions.values().any(|s| s.desktop) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
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.role.is_desktop()) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
if let Some(s) = assist.as_mut() { s.tick()?; }
}
SignalingEvent::Connected => {
log::info!("Signaling handshake established.");
static WOL_REPORTED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
if wol::enabled() && assist.as_ref().is_none_or(|s| s.is_account()) && !WOL_REPORTED.swap(true, std::sync::atomic::Ordering::AcqRel) {
let client = auth.clone();
tokio::spawn(async move { wol::report(&client).await; });
}
}
SignalingEvent::RoomInfoAck(_) => { log::info!("RoomInfo acknowledged by NetEase server"); }
SignalingEvent::DeviceInfoChanged(val) => {
@@ -644,6 +888,21 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
log::debug!("Assist bmsg_push shape: type={:?} keys={:?} data_keys={:?}",
val.get("type").and_then(serde_json::Value::as_str), keys(Some(&val)), keys(val.get("data")));
}
if val.get("type").and_then(serde_json::Value::as_str) == Some("wake_on_lan") {
// Key names only: the target carries a MAC and LAN address.
let data = val.get("data").unwrap_or(&val);
log::info!("wake_on_lan push received: keys={:?} target_keys={:?} helper_enabled={}",
data.as_object().map(|o| o.keys().cloned().collect::<Vec<_>>()).unwrap_or_default(),
data.get("target_device").and_then(|t| t.as_object()).map(|o| o.keys().cloned().collect::<Vec<_>>()).unwrap_or_default(),
wol::enabled());
if wol::enabled() {
match wol::handle_push(data) {
Ok(sent) => log::info!("WOL helper: magic packet sent ({sent} datagrams)"),
Err(error) => log::warn!("WOL helper: {error}"),
}
}
continue;
}
if val.get("type").and_then(serde_json::Value::as_str) == Some("get_control_mode") {
if let Some(s) = assist.as_mut() {
match s.control_mode(val.get("data").unwrap_or(&serde_json::Value::Null)).await {
@@ -697,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::Failed)).map(|(k, _)| k.clone()).collect();
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; } }
if desktop_ended && !sessions.values().any(|s| s.desktop) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
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.role.is_desktop()) { if let Some(s) = assist.as_mut() { s.session_ended()?; } }
if let Some(s) = assist.as_mut() { s.tick()?; }
if soac.msg_type == "offer" {
@@ -708,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);
if desktop { input.set_mac_controller(controller_mac); }
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.
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() {
log::info!("Desktop connection ignored: headless mode (terminal, file transfer and port mapping remain available)");
continue;
}
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"); }
let session_capture=if desktop && portal_desktop.is_none() && (capture.init_error.is_some() || resized) {
match tokio::task::spawn_blocking(ScreenCapture::new).await {
@@ -732,7 +996,12 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
if desktop { if let Some(portal) = &portal_desktop { portal.begin(); } }
match WebRtcSession::new(session_capture, input.clone(), signaling_client.clone(), desktop, transport,
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
// a peer whose answer may already be queued to the viewer.
sessions.insert(ice.clone(), sess);
@@ -755,7 +1024,7 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
}
Err(_) => {
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)"),
@@ -777,13 +1046,50 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
let mut desktop_ended = false;
for k in targets {
if let Some(old) = sessions.remove(&k) {
desktop_ended |= old.desktop;
if let Err(e) = old.pc.close().await { log::warn!("Close released peer failed: {}", e); }
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()?; }
}
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 => {
capture_types.clear();
next_capture_type=None;
+20 -9
View File
@@ -22,7 +22,7 @@ mod permissions;
#[cfg(all(target_os = "linux", feature = "portal"))]
mod native {
use std::{ffi::c_void, ptr::NonNull, sync::{Mutex, MutexGuard, TryLockError}};
extern "C" {
crate::engine_ffi! { crate::engine_plugin::Engine::Portal;
fn uu_portal_open_persist(restore: *const libc::c_char, save: extern "C" fn(*const libc::c_char, *mut c_void), data: *mut c_void, error: *mut i32, width: *mut u32, height: *mut u32) -> *mut c_void;
fn uu_portal_open_persist_cancellable(restore: *const libc::c_char, save: extern "C" fn(*const libc::c_char, *mut c_void), save_data: *mut c_void, cancelled: extern "C" fn(*mut c_void) -> i32, cancel_data: *mut c_void, error: *mut i32, width: *mut u32, height: *mut u32) -> *mut c_void;
fn uu_portal_clipboard_supported(portal: *mut c_void) -> i32;
@@ -116,6 +116,8 @@ mod native {
if cancelled.is_some_and(|value| value.load(std::sync::atomic::Ordering::Acquire)) {
return Err(super::PortalError { code: 13 });
}
// engine-plugins: libuu-portal.so (or one of its libraries) may be missing on this host.
crate::engine_plugin::load(crate::engine_plugin::Engine::Portal).map_err(|_| super::PortalError { code: 15 })?;
let (mut error, mut width, mut height) = (0, 0, 0);
let directory = super::permissions::directory();
let key = super::permissions::desktop_key();
@@ -584,12 +586,20 @@ fn error(code: i32) -> String {
8 => "unsupported frame format or size", 9 => "session closed or stream lost",
10 => "frame unavailable", 11 => "invalid input or frame buffer",
13 => "operation cancelled", 14 => "dimensions changed; reconnect required",
15 => return match crate::engine_plugin::load(crate::engine_plugin::Engine::Portal) {
Err(reason) if cfg!(feature = "portal") => format!("GNOME/KDE Wayland (portal) engine unavailable: {reason}"),
_ => NOT_BUILT.into(),
},
_ => "operation failed",
};
format!("Portal {reason} (code {code})")
}
fn check(code: i32) -> Result<(), String> { if code == 0 { Ok(()) } else { Err(error(code)) } }
/// GNOME/KDE Wayland selected the portal backend, but this binary was built without it (the release
/// package is X11 only): say how to get a picture instead of an opaque "portal unavailable".
pub const NOT_BUILT: &str = "this build has no GNOME/KDE Wayland (portal) support: choose the Xorg session \
(\"GNOME on Xorg\" / \"Plasma (X11)\") at the login screen, or build with --features wayland,portal";
#[cfg(all(target_os = "linux", feature = "portal"))]
pub use native::Session as PortalSession;
#[cfg(not(all(target_os = "linux", feature = "portal")))]
@@ -598,24 +608,24 @@ pub struct PortalSession { pub width: u32, pub height: u32 }
impl PortalSession {
pub fn clipboard_supported(&self) -> bool { false }
pub fn clipboard_ready(&self) -> bool { false }
pub fn clipboard_set(&self, _: &str) -> Result<(), String> { Err(error(2)) }
pub fn clipboard_set(&self, _: &str) -> Result<(), String> { Err(error(15)) }
pub fn clipboard_poll(&self) -> Option<String> { None }
pub fn is_alive(&self) -> bool { false }
pub fn open() -> Result<Self, String> { Err("Portal backend requires Linux and --features portal".into()) }
pub fn open_cancellable(cancelled: &std::sync::atomic::AtomicBool) -> Result<Self, PortalError> {
if cancelled.load(std::sync::atomic::Ordering::Acquire) { Err(PortalError { code: 13 }) }
else { Err(PortalError { code: 2 }) }
else { Err(PortalError { code: 15 }) }
}
pub fn recover(&self, cancelled: &std::sync::atomic::AtomicBool) -> Result<bool, PortalError> {
if cancelled.load(std::sync::atomic::Ordering::Acquire) { Err(PortalError { code: 13 }) }
else { Err(PortalError { code: 2 }) }
else { Err(PortalError { code: 15 }) }
}
pub fn pause(&self) {}
pub fn capture(&self, _: &mut [u8]) -> Result<(), String> { Err(error(2)) }
pub fn capture_changed(&self, _: &mut [u8], _: &mut Option<FrameVersion>) -> Result<bool, String> { Err(error(2)) }
pub fn move_pointer(&self, _: f64, _: f64, _: bool) -> Result<(), String> { Err(error(2)) }
pub fn button(&self, _: i32, _: bool) -> Result<(), String> { Err(error(2)) }
pub fn key(&self, _: u64, _: bool) -> Result<(), String> { Err(error(2)) }
pub fn capture(&self, _: &mut [u8]) -> Result<(), String> { Err(error(15)) }
pub fn capture_changed(&self, _: &mut [u8], _: &mut Option<FrameVersion>) -> Result<bool, String> { Err(error(15)) }
pub fn move_pointer(&self, _: f64, _: f64, _: bool) -> Result<(), String> { Err(error(15)) }
pub fn button(&self, _: i32, _: bool) -> Result<(), String> { Err(error(15)) }
pub fn key(&self, _: u64, _: bool) -> Result<(), String> { Err(error(15)) }
}
/// Forward frames in-process into encoder stdin. Cancellation drops the Arc;
@@ -641,6 +651,7 @@ mod tests {
fn errors_never_include_remote_messages_or_identifiers() {
assert!(super::check(4).unwrap_err().contains("cancelled or denied"));
assert!(super::check(9).unwrap_err().contains("closed or stream lost"));
assert!(super::check(15).unwrap_err().contains("--features wayland,portal"));
}
#[test]
fn portal_error_display_is_fixed_and_sanitized() {
Loaded 100 of 229 files, more files were not shown because too many files have changed in this diff. Show more