mirror of
https://github.com/VallierDev/uu-remote-linux.git
synced 2026-11-16 16:50:41 +01:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0fe9b979e5 | ||
|
|
cb4850d296 | ||
|
|
16ded48a99 | ||
|
|
d95053d490 | ||
|
|
50ed54d77a | ||
|
|
d6752e77c8 | ||
|
|
9906dd4767 | ||
|
|
9e2198b03d | ||
|
|
21c01d2e18 | ||
|
|
059a3b1bb8 | ||
|
|
76941459cc | ||
|
|
1fa346fd1f | ||
|
|
e09778cc94 | ||
|
|
b1da297e42 | ||
|
|
c739036301 | ||
|
|
25893cd4ab | ||
|
|
5089c0343c | ||
|
|
5fdb98b0f5 | ||
|
|
89abae2369 | ||
|
|
0afc602e66 | ||
|
|
762cfccc44 | ||
|
|
9520b69730 | ||
|
|
c45e4749b5 | ||
|
|
c1b8bfe1b3 | ||
|
|
03d2311649 | ||
|
|
5949314e55 | ||
|
|
8389fc4eed | ||
|
|
b8de665593 | ||
|
|
554cbe806a | ||
|
|
a91f0024d3 | ||
|
|
68ad9759bd | ||
|
|
169edf2224 | ||
|
|
9994279b29 | ||
|
|
6733a117a2 | ||
|
|
e3cab32c75 | ||
|
|
57e1a5d07c | ||
|
|
d90b4bccde | ||
|
|
fa7fe733a6 | ||
|
|
65c04e796a | ||
|
|
3480318089 | ||
|
|
949acaac30 | ||
|
|
22fb6783a0 | ||
|
|
10166c66e0 | ||
|
|
b7f9f2aa68 | ||
|
|
6416f75b7f | ||
|
|
70cb5ad57e |
No files matched your search
@@ -37,6 +37,7 @@ body:
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
{
|
{
|
||||||
|
echo "== doctor (v0.2.17+)"; uuremote-server doctor
|
||||||
echo "== 系统"; grep PRETTY_NAME /etc/os-release; uname -rm
|
echo "== 系统"; grep PRETTY_NAME /etc/os-release; uname -rm
|
||||||
echo "== 桌面"; echo "session=$XDG_SESSION_TYPE desktop=$XDG_CURRENT_DESKTOP"
|
echo "== 桌面"; echo "session=$XDG_SESSION_TYPE desktop=$XDG_CURRENT_DESKTOP"
|
||||||
echo "== 显示器"; xrandr --listmonitors 2>/dev/null
|
echo "== 显示器"; xrandr --listmonitors 2>/dev/null
|
||||||
|
|||||||
@@ -24,10 +24,25 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install -y build-essential pkg-config \
|
sudo apt-get install -y build-essential pkg-config \
|
||||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev
|
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
|
||||||
|
libwayland-dev libwayland-bin libxkbcommon-dev
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
- run: cargo test --locked
|
- 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
|
||||||
|
|
||||||
test-viewer:
|
test-viewer:
|
||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
@@ -56,6 +71,12 @@ jobs:
|
|||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
- run: cargo test --locked --features wayland,portal
|
- 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)
|
- name: Native portal and EIS regression tests (ASan/UBSan)
|
||||||
env:
|
env:
|
||||||
ASAN_OPTIONS: detect_leaks=1
|
ASAN_OPTIONS: detect_leaks=1
|
||||||
@@ -73,12 +94,37 @@ jobs:
|
|||||||
runs-on: ubuntu-24.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Install build dependencies (X11 + FFmpeg 6 for the inproc-av feature)
|
- name: Install build dependencies (X11; inproc-av vendors the NVENC headers; the VAAPI/DRI3 engines need libva/gbm/xcb-dri3 headers, libva itself is dlopen'ed at runtime)
|
||||||
run: |
|
run: |
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install -y build-essential pkg-config \
|
sudo apt-get install -y build-essential pkg-config \
|
||||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
|
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev \
|
||||||
libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev
|
libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage0-dev
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
- uses: Swatinem/rust-cache@v2
|
- uses: Swatinem/rust-cache@v2
|
||||||
- run: cargo test --locked --features inproc-av
|
- run: cargo test --locked --features inproc-av
|
||||||
|
|
||||||
|
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
|
||||||
@@ -9,35 +9,99 @@ permissions:
|
|||||||
packages: write
|
packages: write
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
# GNOME/KDE Wayland engine: libei >= 1.1 first ships in Ubuntu 24.04, so this plugin needs
|
||||||
# Built on 22.04 so the binary also runs on Ubuntu 22.04/24.04 and newer Debian (glibc >= 2.35).
|
# glibc >= 2.39. It is only loaded on portal sessions; X11 and wlroots hosts never open it.
|
||||||
runs-on: ubuntu-22.04
|
portal-plugin:
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- { arch: x86_64, runner: ubuntu-24.04 }
|
||||||
|
- { arch: aarch64, runner: ubuntu-24.04-arm }
|
||||||
|
runs-on: ${{ matrix.runner }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Install build dependencies
|
- name: Install build dependencies
|
||||||
run: |
|
run: |
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install -y build-essential pkg-config \
|
sudo apt-get install -y build-essential pkg-config \
|
||||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libgtk-3-dev 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
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
- run: cargo test --release --locked
|
- run: cargo test --release --locked
|
||||||
- run: cargo build --release --locked
|
# One package for every desktop: Wayland (wlroots) and GNOME/KDE portal engines are plugins
|
||||||
# Experimental viewer; built after the host so uuremote-server keeps the default features.
|
# 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
|
- run: cargo build --release --locked --features native-viewer,viewer-sdl --bin uuremote-viewer
|
||||||
- name: Package
|
- name: Package
|
||||||
run: |
|
run: |
|
||||||
name=uu-remote-linux-${GITHUB_REF_NAME}-x86_64-linux
|
name=uu-remote-linux-${GITHUB_REF_NAME}-${{ matrix.arch }}-linux
|
||||||
mkdir -p "$name"
|
mkdir -p "$name"
|
||||||
cp target/release/uuremote-server target/release/uuremote-viewer 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 \
|
||||||
|
LICENSE README.md README.en.md config.example.json "$name/"
|
||||||
cp -r contrib "$name/"
|
cp -r contrib "$name/"
|
||||||
tar czf "$name.tar.gz" "$name"
|
tar czf "$name.tar.gz" "$name"
|
||||||
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
|
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
|
||||||
|
- 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
|
- uses: softprops/action-gh-release@v2
|
||||||
with:
|
with:
|
||||||
body_path: docs/release-notes/${{ github.ref_name }}.md
|
body_path: docs/release-notes/${{ github.ref_name }}.md
|
||||||
files: |
|
files: |
|
||||||
uu-remote-linux-*.tar.gz
|
uu-remote-linux-*.tar.gz
|
||||||
uu-remote-linux-*.tar.gz.sha256
|
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.
|
# Headless NAS image (docker/), built from the release tarball published by the job above.
|
||||||
docker:
|
docker:
|
||||||
|
|||||||
@@ -38,8 +38,13 @@ Dependencies (Ubuntu/Debian):
|
|||||||
```sh
|
```sh
|
||||||
sudo apt install build-essential pkg-config \
|
sudo apt install build-essential pkg-config \
|
||||||
libx11-dev libxext-dev libxtst-dev libxfixes-dev libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev libgtk-3-dev ffmpeg
|
libx11-dev libxext-dev libxtst-dev libxfixes-dev libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev libgtk-3-dev ffmpeg
|
||||||
# --features inproc-av: libavcodec-dev libavformat-dev libavdevice-dev libswscale-dev libclang-dev
|
# --features inproc-av: X11 in-process capture + native NVENC/VAAPI. NVENC headers are vendored and
|
||||||
# (FFmpeg 6.x; in-process capture/encoding, Ubuntu 24.04 ships it)
|
# 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: libwayland-dev libxkbcommon-dev wl-clipboard
|
||||||
# --features wayland,portal: + libglib2.0-dev libpipewire-0.3-dev libei-dev (libei >= 1.1)
|
# --features wayland,portal: + libglib2.0-dev libpipewire-0.3-dev libei-dev (libei >= 1.1)
|
||||||
```
|
```
|
||||||
@@ -78,17 +83,21 @@ cargo build --release --features native-viewer,viewer-sdl --bin uuremote-viewer
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=UU Remote Linux host (unofficial)
|
Description=UU Remote Linux host (unofficial)
|
||||||
After=graphical-session.target
|
After=graphical-session.target
|
||||||
|
PartOf=graphical-session.target
|
||||||
[Service]
|
[Service]
|
||||||
Environment=RUST_LOG=info
|
Environment=RUST_LOG=info
|
||||||
Environment=DISPLAY=:0
|
|
||||||
# GNOME on Xorg usually needs: Environment=XAUTHORITY=/run/user/<uid>/gdm/Xauthority
|
|
||||||
ExecStart=%h/.local/bin/uuremote-server
|
ExecStart=%h/.local/bin/uuremote-server
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=5
|
RestartSec=5
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=default.target
|
WantedBy=graphical-session.target
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Same as packaging/deb. GNOME/KDE import DISPLAY / WAYLAND_DISPLAY and start graphical-session.target; do not hard-code
|
||||||
|
DISPLAY there (it overrides the session's real one, XWayland is often :1); under default.target the unit can
|
||||||
|
start before WAYLAND_DISPLAY is imported and fall back to X11. Desktops without that target (Xfce, i3) and the Xvfb
|
||||||
|
virtual desktop need `WantedBy=default.target` plus an explicit `Environment=DISPLAY=...`; headless
|
||||||
|
(`UU_DESKTOP_BACKEND=none` + linger) needs `WantedBy=default.target` only (GNOME on Xorg outside the session: `XAUTHORITY=/run/user/<uid>/gdm/Xauthority`).
|
||||||
Find the real display/Xauthority with `loginctl show-session <id> -p Display` / `ps -o args -C Xorg`.
|
Find the real display/Xauthority with `loginctl show-session <id> -p Display` / `ps -o args -C Xorg`.
|
||||||
5. `systemctl --user daemon-reload && systemctl --user enable --now uuremote-native.service`
|
5. `systemctl --user daemon-reload && systemctl --user enable --now uuremote-native.service`
|
||||||
6. Verify: `journalctl --user -u uuremote-native.service -f` must show
|
6. Verify: `journalctl --user -u uuremote-native.service -f` must show
|
||||||
@@ -107,6 +116,7 @@ viewer does not reconnect them automatically.
|
|||||||
| `~/.config/uuremote/config.json` | user_id, device_id, client_id, system_id, machine_guid, token, csrf; optional `sign_key`, `ffmpeg_root`. `$UU_CONFIG` overrides the path |
|
| `~/.config/uuremote/config.json` | user_id, device_id, client_id, system_id, machine_guid, token, csrf; optional `sign_key`, `ffmpeg_root`. `$UU_CONFIG` overrides the path |
|
||||||
| `~/.config/uuremote/host_settings.json` | persisted 安全 settings: auto_lock, keep_mute, mute_permanent |
|
| `~/.config/uuremote/host_settings.json` | persisted 安全 settings: auto_lock, keep_mute, mute_permanent |
|
||||||
| `UU_DESKTOP_BACKEND` | `auto` (default) / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless: no display; desktop offers ignored; tool peers get a nominal 1920x1080 screen + Allow permissions, which the port-mapping viewer requires) |
|
| `UU_DESKTOP_BACKEND` | `auto` (default) / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless: no display; desktop offers ignored; tool peers get a nominal 1920x1080 screen + Allow permissions, which the port-mapping viewer requires) |
|
||||||
|
| `UU_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_INPUT_BACKEND` | `auto` (uinput on Wayland/portal when `/dev/uinput` is accessible, udev `uaccess` rule in README) / `uinput` / `native`. X11 keeps XTest (held-key autorepeat handling) |
|
| `UU_INPUT_BACKEND` | `auto` (uinput on Wayland/portal when `/dev/uinput` is accessible, udev `uaccess` rule in README) / `uinput` / `native`. X11 keeps XTest (held-key autorepeat handling) |
|
||||||
| Mac viewer Cmd | With 「使用 macOS 快捷键」 off the Mac viewer sends Cmd=VK_LWIN 0x5B, Option=0xA4, Ctrl=0xA2; connect header `controller_platform`=4 is macOS. For Mac controllers Cmd is held back: Cmd+C/V/A/F/X/Z → Ctrl+key (terminal: Cmd+C/V → Ctrl+Shift+C/V), other combos/alone → Super |
|
| Mac viewer Cmd | With 「使用 macOS 快捷键」 off the Mac viewer sends Cmd=VK_LWIN 0x5B, Option=0xA4, Ctrl=0xA2; connect header `controller_platform`=4 is macOS. For Mac controllers Cmd is held back: Cmd+C/V/A/F/X/Z → Ctrl+key (terminal: Cmd+C/V → Ctrl+Shift+C/V), other combos/alone → Super |
|
||||||
| `UU_TERMINAL_SHORTCUTS=0` | disable Ctrl+V → Ctrl+Shift+V in focused X11 terminals (Mac Cmd and Ctrl both arrive as VK_LCONTROL) |
|
| `UU_TERMINAL_SHORTCUTS=0` | disable Ctrl+V → Ctrl+Shift+V in focused X11 terminals (Mac Cmd and Ctrl both arrive as VK_LCONTROL) |
|
||||||
@@ -116,10 +126,14 @@ viewer does not reconnect them automatically.
|
|||||||
| `UU_FFMPEG_ROOT` | FFmpeg prefix (`bin/ffmpeg`, libs in `lib/x86_64-linux-gnu`) |
|
| `UU_FFMPEG_ROOT` | FFmpeg prefix (`bin/ffmpeg`, libs in `lib/x86_64-linux-gnu`) |
|
||||||
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
|
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
|
||||||
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
|
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
|
||||||
|
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
|
||||||
|
| `UU_WOL_HELPER=1` | experimental: report LAN info (`api-ipv4…/api/v1/device/wake_on_lan/info` {mac, ip, subnet_mask}) after sign-in and answer `wake_on_lan` pushes (`target_device` {mac, ip, subnet_mask}) with a magic packet, like the official Windows host (field names from its log strings; not verified end to end). `wake_on_lan` push key names are always logged |
|
||||||
|
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default |
|
||||||
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
|
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
|
||||||
|
|
||||||
Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. The config is re-read
|
Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. `config.json` is parsed once
|
||||||
every 60 s.
|
(`config::file()`); only a `LoginExpired` room answer re-reads it from disk (`config::read_fresh()`) before waiting
|
||||||
|
for a new QR login.
|
||||||
|
|
||||||
## 6. Code map
|
## 6. Code map
|
||||||
|
|
||||||
@@ -142,6 +156,7 @@ every 60 s.
|
|||||||
| `src/initialization.rs`, `src/control_protocol.rs`, `src/protocol.rs` | protobuf encoders/decoders for CONTROL |
|
| `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/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/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/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/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 |
|
| `c_engine/wayland_engine.c`, `c_engine/portal_engine.c` | Wayland and portal engines |
|
||||||
@@ -149,8 +164,9 @@ every 60 s.
|
|||||||
| `src/viewer_main.rs`, `src/viewer/` | experimental viewer (`--features native-viewer,viewer-sdl`): cloud join, WebRTC offer side, SDL desktop window (ffmpeg CLI decode), files/terminal/portmap/power/assist tools, device removal (`POST /api/v1/device/{id}/unbind`, verified live; shared devices use `/api/v1/device/share/{id}/unbind`, strings only), GTK launcher |
|
| `src/viewer_main.rs`, `src/viewer/` | experimental viewer (`--features native-viewer,viewer-sdl`): cloud join, WebRTC offer side, SDL desktop window (ffmpeg CLI decode), files/terminal/portmap/power/assist tools, device removal (`POST /api/v1/device/{id}/unbind`, verified live; shared devices use `/api/v1/device/share/{id}/unbind`, strings only), GTK launcher |
|
||||||
| `c_engine/viewer_window.c`, `c_engine/viewer_tools.c` | viewer GTK launcher and tool windows (files, port mapping, terminal list) |
|
| `c_engine/viewer_window.c`, `c_engine/viewer_tools.c` | viewer GTK launcher and tool windows (files, port mapping, terminal list) |
|
||||||
|
|
||||||
Diagnostic subcommands: `login [--no-gui]`, `unlock-check` (password on stdin, prints only accepted/rejected),
|
Diagnostic subcommands: `doctor` (paste-safe report: session, selected backend, engine plugins, uinput, encoders,
|
||||||
`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`,
|
default codec, sign-in/service state; booleans and names only), `login [--no-gui]`, `unlock-check` (password on stdin, prints only accepted/rejected),
|
||||||
|
`desktop-probe [new.png]`, `desktop-video-probe` (`UU_PROBE_FPS`, `UU_PROBE_FRAMES`, `UU_PROBE_QUALITY` 1-5 = viewer bitrate preset, 5 auto; `UU_PROBE_CHROMA=444` 真彩; `UU_PROBE_INPUT` fixed video/image sequence, `UU_PROBE_LOOP=1` repeats), `wayland-input-probe`, `clipboard-acceptance`,
|
||||||
`portal-acceptance`, `help`. Unknown arguments exit with code 2. Builds up to v0.1.0 did **not** reject them and
|
`portal-acceptance`, `help`. Unknown arguments exit with code 2. Builds up to v0.1.0 did **not** reject them and
|
||||||
started a second full host server instead, so check that a subcommand exists in the binary you run.
|
started a second full host server instead, so check that a subcommand exists in the binary you run.
|
||||||
|
|
||||||
@@ -173,7 +189,7 @@ started a second full host server instead, so check that a subcommand exists in
|
|||||||
5 Auto, 6 Custom. Resolution: 16/17 pixel size or 5/6, 10 resolution_type (3 = follow remote).
|
5 Auto, 6 Custom. Resolution: 16/17 pixel size or 5/6, 10 resolution_type (3 = follow remote).
|
||||||
Field 7 `chorma_format` (ChromaFormat 1 = 4:2:0, 3 = 4:4:4) is sent when 真彩 is toggled; ff_capture_setting versions
|
Field 7 `chorma_format` (ChromaFormat 1 = 4:2:0, 3 = 4:4:4) is sent when 真彩 is toggled; ff_capture_setting versions
|
||||||
are cumulative (3 CHROMA_SAMPLING, 4 CUSTOM_BITRATE, 5 DPI_SCALE, 6 HDR). 4:4:4 = NVENC `high444p` / x264 `high444`
|
are cumulative (3 CHROMA_SAMPLING, 4 CUSTOM_BITRATE, 5 DPI_SCALE, 6 HDR). 4:4:4 = NVENC `high444p` / x264 `high444`
|
||||||
with `yuv444p`; VAAPI and inproc stay 4:2:0.
|
with `yuv444p`; the in-process NVENC engine uses High 4:4:4 / HEVC FRExt (AQ off); VAAPI stays 4:2:0.
|
||||||
Reply `RpcResponse{2 CaptureSettingResponse{}}` (no errors = applied) and send Message 25 CaptureSettingSync
|
Reply `RpcResponse{2 CaptureSettingResponse{}}` (no errors = applied) and send Message 25 CaptureSettingSync
|
||||||
(field 3 = the chroma actually encoded).
|
(field 3 = the chroma actually encoded).
|
||||||
- ConnectOptions field 4 `decoder_cap_list` = DecoderCap {1 fps, 2 codec_type (1 H264, 2 H265), 3 width, 4 height,
|
- ConnectOptions field 4 `decoder_cap_list` = DecoderCap {1 fps, 2 codec_type (1 H264, 2 H265), 3 width, 4 height,
|
||||||
@@ -265,12 +281,19 @@ started a second full host server instead, so check that a subcommand exists in
|
|||||||
|
|
||||||
`UU_VIDEO_ENCODER=vaapi` selects Intel/AMD H.264 VAAPI; `UU_VAAPI_DEVICE` defaults to
|
`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.
|
`/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.
|
The FFmpeg process pipeline uploads NV12 frames to a VAAPI frame pool. With `--features inproc-av` on X11, VAAPI
|
||||||
|
H.264/HEVC Main runs in process: a DRI3 DMA-BUF of the root (XShm upload without DRI3) goes through VPP to NV12
|
||||||
|
and VCN, with SPS/PPS(/VPS) and slice headers packed by the host as radeonsi (Mesa 26) needs; parameters follow
|
||||||
|
FFmpeg's hevc_vaapi/h264_vaapi on that driver. Accepted on AMD HawkPoint1 (Mesa 26.2.3) and Cezanne
|
||||||
|
(Mesa 26.2.5; XShm-upload and DRI3 zero-copy probes plus a full HEVC Mac-viewer session) with the official
|
||||||
|
Mac viewer (presets, fps, scaling); Intel iHD is not verified. Measured on Cezanne + RTX 3050 Ti
|
||||||
|
(1920x1200, desktop-video-probe, 300 frames): in-process VAAPI ~1.5 ms CPU/frame vs in-process NVENC
|
||||||
|
~7.1 ms vs libx264 process pipeline ~19 ms.
|
||||||
VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1,
|
VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1,
|
||||||
AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264
|
AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264
|
||||||
with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac
|
with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac
|
||||||
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av`
|
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). The process pipeline on
|
||||||
VAAPI path are not hardware-verified.
|
AMD is not separately verified (AMD acceptance is the in-process engine above).
|
||||||
|
|
||||||
### Virtual audio / 虚拟声卡
|
### Virtual audio / 虚拟声卡
|
||||||
|
|
||||||
@@ -311,8 +334,8 @@ This permission can inject into the whole seat, including lock/greeter screens.
|
|||||||
Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils`
|
Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils`
|
||||||
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
|
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
|
||||||
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`.
|
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`.
|
||||||
Rolling Arch FFmpeg may be newer than supported `inproc-av` (FFmpeg 6.x); use the default process
|
Rolling Arch FFmpeg may be newer than supported `viewer-ffmpeg` (FFmpeg 6.x); build it against a separate
|
||||||
pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg.
|
FFmpeg 6 prefix. Do not downgrade the system FFmpeg. The host's `inproc-av` does not link FFmpeg.
|
||||||
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
|
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
|
||||||
|
|
||||||
### Experimental KMS / 实验后端
|
### Experimental KMS / 实验后端
|
||||||
|
|||||||
Generated
+1
-3
@@ -2741,7 +2741,7 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "uu-remote-linux"
|
name = "uu-remote-linux"
|
||||||
version = "0.2.10"
|
version = "0.2.25"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"async-trait",
|
"async-trait",
|
||||||
"base64 0.22.1",
|
"base64 0.22.1",
|
||||||
@@ -3075,8 +3075,6 @@ dependencies = [
|
|||||||
[[package]]
|
[[package]]
|
||||||
name = "webrtc-srtp"
|
name = "webrtc-srtp"
|
||||||
version = "0.12.0"
|
version = "0.12.0"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "383b0f0f73ee6cce396bdbc4d54ec661861a59eae9fc988914c1a8d82c5ac272"
|
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"aead",
|
"aead",
|
||||||
"aes",
|
"aes",
|
||||||
|
|||||||
+13
-4
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "uu-remote-linux"
|
name = "uu-remote-linux"
|
||||||
version = "0.2.10"
|
version = "0.2.25"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
default-run = "uuremote-server"
|
default-run = "uuremote-server"
|
||||||
authors = ["uu-remote-linux contributors"]
|
authors = ["uu-remote-linux contributors"]
|
||||||
@@ -28,9 +28,11 @@ wayland = []
|
|||||||
# Experimental direct linear framebuffer capture; never enabled in release builds.
|
# Experimental direct linear framebuffer capture; never enabled in release builds.
|
||||||
kms = []
|
kms = []
|
||||||
portal = []
|
portal = []
|
||||||
# In-process capture and encoding through FFmpeg 6 libraries (libavcodec/libavdevice dev packages).
|
# Build the wayland/portal engines as runtime-loaded libuu-wayland.so / libuu-portal.so (release packages).
|
||||||
# Off by default so release binaries do not link the build machine's libav.
|
engine-plugins = []
|
||||||
inproc-av = ["dep:ffmpeg-next", "dep:x11rb"]
|
# 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]
|
[dependencies]
|
||||||
tokio = { version = "1", features = ["full"] }
|
tokio = { version = "1", features = ["full"] }
|
||||||
@@ -62,6 +64,13 @@ sdl2 = { version = "0.37", optional = true, features = ["use-pkgconfig"] }
|
|||||||
cc = "1.0"
|
cc = "1.0"
|
||||||
|
|
||||||
[patch.crates-io]
|
[patch.crates-io]
|
||||||
|
# RTP rollover counter survives delayed NACK retransmissions (vendor/webrtc-srtp/PATCHES.md).
|
||||||
|
webrtc-srtp = { path = "vendor/webrtc-srtp" }
|
||||||
webrtc-dtls = { path = "vendor/webrtc-dtls" }
|
webrtc-dtls = { path = "vendor/webrtc-dtls" }
|
||||||
# Larger data-channel receive buffer (see vendor/webrtc/src/data_channel/mod.rs).
|
# Larger data-channel receive buffer (see vendor/webrtc/src/data_channel/mod.rs).
|
||||||
webrtc = { path = "vendor/webrtc" }
|
webrtc = { path = "vendor/webrtc" }
|
||||||
|
|
||||||
|
[[bench]]
|
||||||
|
name = "nvenc_pipeline_bench"
|
||||||
|
harness = false
|
||||||
|
required-features = ["inproc-av"]
|
||||||
+91
-16
@@ -46,7 +46,7 @@
|
|||||||
| Mac shortcuts | **Recommended**: turn off 「使用 macOS 快捷键」 (use macOS shortcuts) in the Mac viewer's remote-window menu; then Cmd+C/V/A/F/X/Z work as on a Mac (Cmd+C/V become Ctrl+Shift+C/V in terminals) and Ctrl+C always interrupts. With the option on, the viewer sends Cmd as Ctrl: in a terminal Ctrl+V / Cmd+V paste, Ctrl+C interrupts, copy is Cmd+Shift+C (X11) |
|
| Mac shortcuts | **Recommended**: turn off 「使用 macOS 快捷键」 (use macOS shortcuts) in the Mac viewer's remote-window menu; then Cmd+C/V/A/F/X/Z work as on a Mac (Cmd+C/V become Ctrl+Shift+C/V in terminals) and Ctrl+C always interrupts. With the option on, the viewer sends Cmd as Ctrl: in a terminal Ctrl+V / Cmd+V paste, Ctrl+C interrupts, copy is Cmd+Shift+C (X11) |
|
||||||
| Pointer shape | Remote cursor shape is mirrored to the viewer (X11) |
|
| Pointer shape | Remote cursor shape is mirrored to the viewer (X11) |
|
||||||
| Clipboard | Two-way text sync |
|
| Clipboard | Two-way text sync |
|
||||||
| Quality / frame rate / resolution | Auto, Original 20M, Ultra 8M, HD 2M, custom; 30/60/90/144 fps; "other resolutions" are scaled by the encoder, the host monitor is left untouched |
|
| Quality / frame rate / resolution | Auto, Original 20M, Ultra 8M, HD 2M, custom; 30/60/90/144 fps; on X11 a resolution choice changes the desktop resolution itself like the official Windows host (xrandr, adding the mode when missing; restored for "original" or on disconnect), `UU_DESKTOP_RESIZE=0` scales in the encoder instead; Wayland scales in the encoder |
|
||||||
| Sound | System audio captured from PulseAudio / PipeWire and sent as Opus |
|
| Sound | System audio captured from PulseAudio / PipeWire and sent as Opus |
|
||||||
| File transfer | Upload, download (including folders), create folder, rename, delete |
|
| File transfer | Upload, download (including folders), create folder, rename, delete |
|
||||||
| Terminal | The official "Terminal" tool, PTY sessions, multiple sessions, rename |
|
| Terminal | The official "Terminal" tool, PTY sessions, multiple sessions, rename |
|
||||||
@@ -73,13 +73,15 @@ authorized session. Independent file/terminal tool peers do not reset input.
|
|||||||
| Xfce | X11 | ✅ Tested in a VM | default |
|
| Xfce | X11 | ✅ Tested in a VM | default |
|
||||||
| Cinnamon / MATE | 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` |
|
| 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` |
|
| 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
|
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`.
|
`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.
|
permission; the permission is remembered once granted.
|
||||||
|
|
||||||
Scaled GNOME desktops using native Portal input use EIS on the same authorized session when `ConnectToEIS` and a screen `mapping_id` are available. Each axis is mapped using the matched region and actual frame dimensions, with no fixed resolution or scale factor. This avoids scaled-coordinate rejection by `NotifyPointerMotionAbsolute`. Portal builds require libei >= 1.1. Missing EIS support retains the legacy input path and its existing scaling limitations; other initialization failures are reported and trigger session recovery. After a successful EIS connection, all input uses EIS. Capture alone and uinput do not initialize EIS; missing optional logical dimensions do not block capture. Keyboard input uses the existing Windows VK to evdev mapping. Recovery keeps the encoder frame dimensions fixed but accepts logical-size changes after scaling. On GNOME, a display-change notification enables earlier recovery when previously streaming Portal capture remains paused without a valid format for a 200 ms grace after both conditions are present. Healthy renegotiation cancels the early check; repeated notifications do not postpone the same interruption. The five-second fallback remains without a related notification. Static video and valid-format pauses do not trigger recovery. Tested while connected on Ubuntu 26.04, GNOME Wayland, one 3840x2160 display: 200% -> 166.67% -> 200%, with continuously updating video and full-screen pointer control after recovery. Switching briefly freezes and goes black before recovering; five seconds is the fallback threshold, not total recovery time. See [#35](../../pull/35) for timing measurements and validation limits. Lock recovery still needs hardware acceptance testing; multi-monitor support, live resolution changes, and rotation/reflection transforms are outside this fix's scope. Capture settings remain at protocol version 4: advertised resolutions use pixel coordinates and DPR 1; Portal logical dimensions are used only for local input mapping.
|
Scaled GNOME desktops using native Portal input use EIS on the same authorized session when `ConnectToEIS` and a screen `mapping_id` are available. Each axis is mapped using the matched region and actual frame dimensions, with no fixed resolution or scale factor. This avoids scaled-coordinate rejection by `NotifyPointerMotionAbsolute`. Portal builds require libei >= 1.1. Missing EIS support retains the legacy input path and its existing scaling limitations; other initialization failures are reported and trigger session recovery. After a successful EIS connection, all input uses EIS. Capture alone and uinput do not initialize EIS; missing optional logical dimensions do not block capture. Keyboard input uses the existing Windows VK to evdev mapping. Recovery keeps the encoder frame dimensions fixed but accepts logical-size changes after scaling. On GNOME, a display-change notification enables earlier recovery when previously streaming Portal capture remains paused without a valid format for a 200 ms grace after both conditions are present. Healthy renegotiation cancels the early check; repeated notifications do not postpone the same interruption. The five-second fallback remains without a related notification. Static video and valid-format pauses do not trigger recovery. Tested while connected on Ubuntu 26.04, GNOME Wayland, one 3840x2160 display: 200% -> 166.67% -> 200%, with continuously updating video and full-screen pointer control after recovery. Switching briefly freezes and goes black before recovering; five seconds is the fallback threshold, not total recovery time. See [#35](../../pull/35) for timing measurements and validation limits. Lock recovery still needs hardware acceptance testing; multi-monitor support, live resolution changes, and rotation/reflection transforms are outside this fix's scope. Capture settings remain at protocol version 4: advertised resolutions use pixel coordinates and DPR 1; Portal logical dimensions are used only for local input mapping.
|
||||||
@@ -102,12 +104,20 @@ failure falls back to SHM. The virgl VM verified fallback only: successful impor
|
|||||||
mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI;
|
mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI;
|
||||||
`UU_VIDEO_ENCODER=vaapi` still uploads CPU frames through FFmpeg.
|
`UU_VIDEO_ENCODER=vaapi` still uploads CPU frames through FFmpeg.
|
||||||
|
|
||||||
|
### Hyprland monitor switching (experimental)
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Switching reuses one video track and pauses input until the new source sends a frame. Capture/encoder failure or a first-frame timeout requests restoration of the previous source. The inventory uses `hyprctl` and supports unrotated outputs; restart the host after monitor hotplug or layout changes. Phone-side switching and clicks were tested on Omarchy / Hyprland with 2560×1440 at 125% and 1920×1080 at 133.33%.
|
||||||
|
|
||||||
## Not implemented / not supported
|
## Not implemented / not supported
|
||||||
|
|
||||||
| Feature | Status |
|
| Feature | Status |
|
||||||
|---|---|
|
|---|---|
|
||||||
| Switching between multiple monitors | In progress |
|
| Switching between multiple monitors | Experimental on native Hyprland Wayland; see above |
|
||||||
| True color (4:4:4) | Supported (v0.1.15): the default FFmpeg pipeline with NVENC / libx264 encodes H.264 High 4:4:4; VAAPI and `inproc-av` stay 4:2:0 and report that to the client |
|
| True color (4:4:4) | Supported (v0.1.15): the default FFmpeg pipeline with NVENC / libx264 encodes H.264 High 4:4:4; `inproc-av` native NVENC encodes H.264 High 4:4:4 / HEVC FRExt; VAAPI stays 4:2:0 and reports that to the client |
|
||||||
| HDR | Not implemented |
|
| HDR | Not implemented |
|
||||||
| Super screen / virtual display | Not implemented |
|
| Super screen / virtual display | Not implemented |
|
||||||
| Privacy screen on the host | Not implemented |
|
| Privacy screen on the host | Not implemented |
|
||||||
@@ -119,6 +129,39 @@ mapping and hardware acceleration remain unverified. This is not zero-copy VAAPI
|
|||||||
|
|
||||||
## Installation
|
## 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; 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:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||||
|
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/
|
||||||
|
```
|
||||||
|
|
||||||
|
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)
|
### 1. Dependencies (Ubuntu / Debian)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -129,6 +172,8 @@ sudo apt install build-essential pkg-config \
|
|||||||
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
|
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
|
||||||
# optional: GNOME/KDE portal backend
|
# optional: GNOME/KDE portal backend
|
||||||
sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev
|
sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev
|
||||||
|
# optional: headers for the inproc-av VAAPI/DRI3 engines (libva itself is loaded at runtime)
|
||||||
|
sudo apt install libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage0-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
- A Rust toolchain is required (<https://rustup.rs>).
|
- A Rust toolchain is required (<https://rustup.rs>).
|
||||||
@@ -144,6 +189,9 @@ cargo build --release --features wayland # + Hyprland
|
|||||||
cargo build --release --features wayland,portal # + GNOME/KDE on Wayland
|
cargo build --release --features wayland,portal # + GNOME/KDE on Wayland
|
||||||
```
|
```
|
||||||
|
|
||||||
|
The 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
|
### 3. Log in
|
||||||
|
|
||||||
Run inside your graphical session:
|
Run inside your graphical session:
|
||||||
@@ -163,17 +211,17 @@ machine, in `~/.config/uuremote/config.json` (mode 0600).
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=UU Remote Linux host (unofficial)
|
Description=UU Remote Linux host (unofficial)
|
||||||
After=graphical-session.target
|
After=graphical-session.target
|
||||||
|
PartOf=graphical-session.target
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Environment=RUST_LOG=info
|
Environment=RUST_LOG=info
|
||||||
# X11 desktops need the display; on GNOME, XAUTHORITY is usually /run/user/<uid>/gdm/Xauthority
|
# GNOME/KDE import DISPLAY / WAYLAND_DISPLAY into the user manager and start graphical-session.target
|
||||||
Environment=DISPLAY=:0
|
|
||||||
ExecStart=%h/.local/bin/uuremote-server
|
ExecStart=%h/.local/bin/uuremote-server
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=5
|
RestartSec=5
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=default.target
|
WantedBy=graphical-session.target
|
||||||
```
|
```
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -185,6 +233,10 @@ journalctl --user -u uuremote-native.service -f # online once you see availabi
|
|||||||
|
|
||||||
If you have not logged in yet, the service opens the QR login window on your desktop.
|
If you have not logged in yet, the service opens the QR login window on your desktop.
|
||||||
|
|
||||||
|
Desktops that never start `graphical-session.target` (e.g. Xfce, i3) will not autostart this unit: change `[Install]` to
|
||||||
|
`WantedBy=default.target`, add `Environment=DISPLAY=:0` (your actual display) and `enable` again. Headless mode and the
|
||||||
|
virtual desktop below also need `default.target`.
|
||||||
|
|
||||||
### 5. uinput virtual keyboard/mouse on Wayland (recommended)
|
### 5. uinput virtual keyboard/mouse on Wayland (recommended)
|
||||||
|
|
||||||
On Wayland (especially GNOME/KDE via the portal) the default input path needs portal consent and some keyboard layouts
|
On Wayland (especially GNOME/KDE via the portal) the default input path needs portal consent and some keyboard layouts
|
||||||
@@ -235,7 +287,7 @@ the same account cannot assist each other, an official restriction).
|
|||||||
## Servers without a monitor
|
## Servers without a monitor
|
||||||
|
|
||||||
**Headless mode** (terminal, file transfer and port mapping only): add `Environment=UU_DESKTOP_BACKEND=none` to the
|
**Headless mode** (terminal, file transfer and port mapping only): add `Environment=UU_DESKTOP_BACKEND=none` to the
|
||||||
service and run `loginctl enable-linger $USER`, so the systemd user manager (with `XDG_RUNTIME_DIR` and the user D-Bus)
|
service, change `[Install]` to `WantedBy=default.target` (`graphical-session.target` never starts without a login), and run `loginctl enable-linger $USER`, so the systemd user manager (with `XDG_RUNTIME_DIR` and the user D-Bus)
|
||||||
starts at boot without a login. The viewer's remote desktop keeps showing "connecting" in this mode; that is expected.
|
starts at boot without a login. The viewer's remote desktop keeps showing "connecting" in this mode; that is expected.
|
||||||
Log in once with `uuremote-server login --no-gui` (QR in the terminal).
|
Log in once with `uuremote-server login --no-gui` (QR in the terminal).
|
||||||
|
|
||||||
@@ -278,6 +330,10 @@ Common environment variables:
|
|||||||
|---|---|
|
|---|---|
|
||||||
| `UU_CONFIG` | Config file path (default `~/.config/uuremote/config.json`) |
|
| `UU_CONFIG` | Config file path (default `~/.config/uuremote/config.json`) |
|
||||||
| `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless) |
|
| `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms` (experimental feature) / `none` (headless) |
|
||||||
|
| `UU_DESKTOP_RESIZE=0` | on X11, keep the desktop resolution and only scale the encoded stream when the viewer picks a resolution |
|
||||||
|
| `UU_WAYLAND_MULTISCREEN=1` | Enable Hyprland physical monitor switching (off by default) |
|
||||||
|
| `UU_WAYLAND_OUTPUT` | Initial native Wayland output name, e.g. `HDMI-A-1` |
|
||||||
|
| `UU_WAYLAND_NO_VIRTUAL_KEYBOARD=1` | Native Wayland skips the virtual keyboard (e.g. Denial reserves it for its input method); keys go through uinput. Without wlr-virtual-pointer the pointer also uses uinput (#72) |
|
||||||
| `UU_INPUT_BACKEND` | `auto` (default: uinput on Wayland when accessible) / `uinput` / `native` |
|
| `UU_INPUT_BACKEND` | `auto` (default: uinput on Wayland when accessible) / `uinput` / `native` |
|
||||||
| `UU_TERMINAL_SHORTCUTS=0` | Disable the Ctrl+V paste rewrite in terminal windows |
|
| `UU_TERMINAL_SHORTCUTS=0` | Disable the Ctrl+V paste rewrite in terminal windows |
|
||||||
| `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: opt-in Intel/AMD; `nvenc`: force NVENC; unset: NVENC only when an NVIDIA driver is loaded, else CPU |
|
| `UU_VIDEO_ENCODER` | `cpu`: libx264; `vaapi`: opt-in Intel/AMD; `nvenc`: force NVENC; unset: NVENC only when an NVIDIA driver is loaded, else CPU |
|
||||||
@@ -288,10 +344,14 @@ Common environment variables:
|
|||||||
| `UU_ASSIST_ALLOW=1` | Allow remote assistance at start (overrides the saved switch) |
|
| `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_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing |
|
||||||
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
|
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
|
||||||
|
| `UU_WOL_HELPER=1` | Experimental: act as a remote-boot helper like the official Windows host — report this host's LAN info after sign-in and send a magic packet to the LAN when the cloud asks to wake a PC (not verified end to end) |
|
||||||
|
| `UU_USE_PROXY=1` | Honor HTTP/SOCKS proxy environment variables; by default proxies are ignored and NetEase servers are reached directly |
|
||||||
|
|
||||||
Host settings such as "lock after remote session" and "mute host" are stored in
|
Host settings such as "lock after remote session" and "mute host" are stored in
|
||||||
`~/.config/uuremote/host_settings.json`.
|
`~/.config/uuremote/host_settings.json`.
|
||||||
|
|
||||||
|
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).
|
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).
|
||||||
|
|
||||||
## Let an AI agent install or develop it
|
## Let an AI agent install or develop it
|
||||||
@@ -349,7 +409,7 @@ Released under the [GPL-3.0](LICENSE): you may use, modify and redistribute it,
|
|||||||
|
|
||||||
### H.265 / HEVC
|
### 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
|
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
|
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_ENCODER=vaapi` (`hevc_vaapi`); hardware failure falls back to software HEVC, then to H.264.
|
||||||
@@ -357,6 +417,9 @@ synthetic frame and announces encoder support with CodecNegotiation. `hevc_nvenc
|
|||||||
Verified with the official Mac viewer on an RTX 3090 (hevc_nvenc, including 4:4:4) and with the official Android
|
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
|
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.
|
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.
|
||||||
|
|
||||||
HEVC access units are split on RFC 7798 picture boundaries instead of AUDs: `hevc_vaapi` with `-aud 1` writes an
|
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
|
AUD only at IRAPs and drops every other picture from the bitstream, so an AUD-based reader turns a whole GOP into
|
||||||
@@ -367,12 +430,21 @@ sends about 12 kbit/s. `UU_VIDEO_CODEC=h265` selects H.265 explicitly for A/B di
|
|||||||
|
|
||||||
`UU_VIDEO_ENCODER=vaapi` selects Intel/AMD H.264 VAAPI; `UU_VAAPI_DEVICE` defaults to
|
`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.
|
`/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.
|
The FFmpeg process uploads NV12 frames to a VAAPI frame pool; a self-built `--features inproc-av`
|
||||||
|
binary instead runs VAAPI in process on X11 (a DRI3 DMA-BUF of the root window zero-copy, or XShm
|
||||||
|
upload without DRI3, then VPP to NV12 and VCN; H.264/HEVC).
|
||||||
VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1,
|
VBR uses the viewer bitrate preset and CQ-derived minimum QP, no B-frames, async depth 1,
|
||||||
AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264
|
AUD and the existing GOP/VFR timing. Unsupported device/driver/initialization falls back to libx264
|
||||||
with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac
|
with a warning. Accepted on Intel UHD 770 (iHD) with the default FFmpeg process pipeline and the official Mac
|
||||||
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264). AMD and the `inproc-av`
|
viewer (presets, fps, scaling, reconnect; no fallback, ~40% less CPU than libx264 — a figure from the
|
||||||
VAAPI path are not hardware-verified.
|
FFmpeg-process-pipeline era). AMD iGPUs are verified on
|
||||||
|
the **in-process engine** (`--features inproc-av`): end-to-end sessions with the official Mac viewer passed
|
||||||
|
acceptance on HawkPoint (Mesa 26.2.3) and Cezanne (Mesa 26.2.5) — HEVC, presets, fps, scaling; on Cezanne,
|
||||||
|
H.264 and both capture paths were additionally probe-verified: the XShm upload (decodable bitstream, correct
|
||||||
|
picture) and the DRI3 zero-copy import. Measured on one machine (1920x1200@60, Cezanne iGPU + RTX 3050 Ti):
|
||||||
|
in-process VAAPI costs about **1/12** of the per-frame encode CPU of libx264 (FFmpeg pipeline, superfast)
|
||||||
|
and about **1/5** of in-process NVENC. The FFmpeg process pipeline (what the release packages use) is not
|
||||||
|
separately verified on AMD.
|
||||||
|
|
||||||
The default VAAPI VBV buffer (100-500 kbit) squeezes keyframes hard at high resolution: on a 2560x1440
|
The default VAAPI VBV buffer (100-500 kbit) squeezes keyframes hard at high resolution: on a 2560x1440
|
||||||
H.264 VAAPI stream capped at 30 Mbit/s the first IDR measured 59,910 bytes and the picture blurred at
|
H.264 VAAPI stream capped at 30 Mbit/s the first IDR measured 59,910 bytes and the picture blurred at
|
||||||
@@ -414,18 +486,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
|
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`.
|
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 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.
|
This permission can inject into the whole seat, including lock/greeter screens.
|
||||||
`UU_INPUT_BACKEND=uinput` requests kernel devices; verify startup actually reports uinput.
|
`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`;
|
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):
|
tie the unit to the graphical session instead (community-verified autostart on Omarchy):
|
||||||
`After=` and `PartOf=graphical-session.target`, `ConditionEnvironment=WAYLAND_DISPLAY`,
|
`After=` and `PartOf=graphical-session.target`, `ConditionEnvironment=WAYLAND_DISPLAY`,
|
||||||
`Environment=UU_DESKTOP_BACKEND=wayland` (no `DISPLAY`), and `WantedBy=graphical-session.target`.
|
`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`
|
Optional VAAPI: `intel-media-driver` (modern Intel) or `libva-mesa-driver` (AMD), `libva-utils`
|
||||||
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
|
for `vainfo`. Optional KMS: `libdrm`. Virtual Xfce: `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
|
||||||
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`.
|
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`.
|
||||||
Rolling Arch FFmpeg may be newer than supported `inproc-av` (FFmpeg 6.x); use the default process
|
If building `viewer-ffmpeg`, rolling Arch FFmpeg may be newer than supported 6.x; use a separate FFmpeg 6 prefix rather than downgrading system FFmpeg (`inproc-av` native NVENC on the host does not depend on FFmpeg).
|
||||||
pipeline or build against a separate FFmpeg 6 prefix. Do not downgrade the system FFmpeg.
|
|
||||||
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
|
User-bus headless setup and the official Mac checklist: [virtual desktop acceptance](contrib/virtual-desktop/ACCEPTANCE.md).
|
||||||
|
|
||||||
### Experimental KMS / 实验后端
|
### Experimental KMS / 实验后端
|
||||||
|
|||||||
@@ -40,7 +40,7 @@
|
|||||||
| Mac 快捷键 | **推荐**:在 Mac 远控窗口菜单里关闭「使用 macOS 快捷键」,之后和在 Mac 上一样:Cmd+C/V/A/F/X/Z 是复制、粘贴、全选、查找、剪切、撤销(终端里 Cmd+C/V 自动变成 Ctrl+Shift+C/V),Ctrl+C 在终端里始终是中断。保持开启时,客户端会把 Cmd 和 Ctrl 都当成 Ctrl 发送:终端里 Ctrl+V / Cmd+V 自动转成粘贴,Ctrl+C 是中断,复制用 Cmd+Shift+C(X11) |
|
| Mac 快捷键 | **推荐**:在 Mac 远控窗口菜单里关闭「使用 macOS 快捷键」,之后和在 Mac 上一样:Cmd+C/V/A/F/X/Z 是复制、粘贴、全选、查找、剪切、撤销(终端里 Cmd+C/V 自动变成 Ctrl+Shift+C/V),Ctrl+C 在终端里始终是中断。保持开启时,客户端会把 Cmd 和 Ctrl 都当成 Ctrl 发送:终端里 Ctrl+V / Cmd+V 自动转成粘贴,Ctrl+C 是中断,复制用 Cmd+Shift+C(X11) |
|
||||||
| 鼠标指针样式 | 远端指针形状实时同步(X11) |
|
| 鼠标指针样式 | 远端指针形状实时同步(X11) |
|
||||||
| 剪贴板 | 双向文本同步 |
|
| 剪贴板 | 双向文本同步 |
|
||||||
| 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;「其他分辨率」由编码器缩放,不改动主机显示器 |
|
| 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;X11 下切换分辨率会像官方 Windows 被控端一样真正修改桌面分辨率(xrandr,缺少该模式时自动添加;选「原始」或断开后恢复),`UU_DESKTOP_RESIZE=0` 改为仅由编码器缩放;Wayland 仍由编码器缩放 |
|
||||||
| 声音 | 采集系统声音(PulseAudio / PipeWire),Opus 编码传到控制端 |
|
| 声音 | 采集系统声音(PulseAudio / PipeWire),Opus 编码传到控制端 |
|
||||||
| 文件传输 | 上传、下载(含文件夹)、新建文件夹、重命名、删除 |
|
| 文件传输 | 上传、下载(含文件夹)、新建文件夹、重命名、删除 |
|
||||||
| 终端 | 官方「终端」工具,PTY 会话,支持多会话和重命名 |
|
| 终端 | 官方「终端」工具,PTY 会话,支持多会话和重命名 |
|
||||||
@@ -65,12 +65,15 @@ Portal 仅作用于本服务获授权的会话。文件传输、终端等独立
|
|||||||
| Xfce | X11 | ✅ 虚拟机测试通过 | 默认 |
|
| Xfce | X11 | ✅ 虚拟机测试通过 | 默认 |
|
||||||
| Cinnamon / MATE | X11 | ✅ 虚拟机测试通过 | 默认 |
|
| Cinnamon / MATE | X11 | ✅ 虚拟机测试通过 | 默认 |
|
||||||
| Hyprland | Wayland(wlroots 原生协议) | 🧪 实验性,虚拟机测试(部分功能受限,见下) | `--features wayland` |
|
| Hyprland | Wayland(wlroots 原生协议) | 🧪 实验性,虚拟机测试(部分功能受限,见下) | `--features wayland` |
|
||||||
|
| niri | Wayland(wlroots 原生协议) | 🧪 实验性,协议支持已按 niri 源码确认,尚未实机验收(#55) | `--features wayland` |
|
||||||
| GNOME / KDE Plasma | Wayland(xdg-desktop-portal) | 🧪 实验性,验证范围与限制见下 | `--features wayland,portal` |
|
| 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),
|
最后一列是源码编译方式;Release 预编译包已包含全部后端,直接使用即可(见[安装](#0-直接用-release-预编译包推荐x86_64))。
|
||||||
请附上发行版、桌面环境、显卡型号和 `journalctl --user -u uuremote-native.service` 里的相关日志。
|
|
||||||
|
|
||||||
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 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。
|
||||||
|
|
||||||
GNOME 缩放桌面在使用 Portal 原生键鼠时,若支持 `ConnectToEIS` 和屏幕 `mapping_id`,通过同一授权会话的 EIS 接口注入输入,按匹配的区域与实际帧尺寸分别映射横纵坐标,没有固定分辨率或缩放倍率,可避免 `NotifyPointerMotionAbsolute` 在缩放时拒绝坐标。Portal 构建需要 libei ≥ 1.1。缺少 EIS 支持时保留旧输入路径及其既有缩放限制;其他初始化错误会明确报告并触发会话恢复。EIS 连接成功后全部输入统一使用 EIS。只采集画面或使用 uinput 时不会初始化 EIS;缺少可选的逻辑尺寸也不阻断采集。键盘沿用项目现有的 Windows VK → evdev 映射。恢复时保持编码器的采集帧尺寸不变,允许缩放后的逻辑尺寸变化。GNOME 显示配置变化后,已推流的 Portal 采集若持续「暂停且无有效格式」,会在关联通知后的 200 毫秒宽限结束后提前进入现有恢复流程;正常重协商恢复会取消提前判定,连续通知不会推迟同次异常的判定。未收到相关通知时保留五秒兜底;静态画面或有效格式下的暂停不会触发恢复。Ubuntu 26.04、GNOME Wayland 单屏 3840×2160 已实测保持连接切换 200%→166.67%→200%,恢复后画面持续更新且鼠标可控制全屏;切换期间会短暂停顿、黑屏后恢复,五秒是兜底判定阈值,并非总恢复时间。提前恢复的测量结果和验证范围见 [#35](../../pull/35)。此路径仍需实机验证锁屏恢复;多屏、连接中改变分辨率及旋转/镜像变换不属于本次修复范围。 捕获设置协议仍为版本 4:对客户端上报的分辨率统一使用像素坐标、DPR 为 1;Portal 逻辑尺寸仅用于本地输入映射。
|
GNOME 缩放桌面在使用 Portal 原生键鼠时,若支持 `ConnectToEIS` 和屏幕 `mapping_id`,通过同一授权会话的 EIS 接口注入输入,按匹配的区域与实际帧尺寸分别映射横纵坐标,没有固定分辨率或缩放倍率,可避免 `NotifyPointerMotionAbsolute` 在缩放时拒绝坐标。Portal 构建需要 libei ≥ 1.1。缺少 EIS 支持时保留旧输入路径及其既有缩放限制;其他初始化错误会明确报告并触发会话恢复。EIS 连接成功后全部输入统一使用 EIS。只采集画面或使用 uinput 时不会初始化 EIS;缺少可选的逻辑尺寸也不阻断采集。键盘沿用项目现有的 Windows VK → evdev 映射。恢复时保持编码器的采集帧尺寸不变,允许缩放后的逻辑尺寸变化。GNOME 显示配置变化后,已推流的 Portal 采集若持续「暂停且无有效格式」,会在关联通知后的 200 毫秒宽限结束后提前进入现有恢复流程;正常重协商恢复会取消提前判定,连续通知不会推迟同次异常的判定。未收到相关通知时保留五秒兜底;静态画面或有效格式下的暂停不会触发恢复。Ubuntu 26.04、GNOME Wayland 单屏 3840×2160 已实测保持连接切换 200%→166.67%→200%,恢复后画面持续更新且鼠标可控制全屏;切换期间会短暂停顿、黑屏后恢复,五秒是兜底判定阈值,并非总恢复时间。提前恢复的测量结果和验证范围见 [#35](../../pull/35)。此路径仍需实机验证锁屏恢复;多屏、连接中改变分辨率及旋转/镜像变换不属于本次修复范围。 捕获设置协议仍为版本 4:对客户端上报的分辨率统一使用像素坐标、DPR 为 1;Portal 逻辑尺寸仅用于本地输入映射。
|
||||||
|
|
||||||
@@ -87,12 +90,20 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
|
|||||||
原生 Wayland 实验选项:`UU_WAYLAND_PIPELINE=0` 可关闭流水线做对照。`UU_WAYLAND_DMABUF=1` 显式尝试 dma-buf→GBM CPU 映射(默认关闭,需要运行时 libgbm;可用 `UU_WAYLAND_DMABUF_DEVICE` 指定 render node,默认 `/dev/dri/renderD128`)。仅支持显式线性修饰符、单平面 8-bit RGB,失败回退 SHM;virgl VM 中只验证了回退,成功导入/映射和硬件加速均未验证。这不是零拷贝 VAAPI 路径;选择 `UU_VIDEO_ENCODER=vaapi` 时仍由 FFmpeg 上传 CPU 帧。
|
原生 Wayland 实验选项:`UU_WAYLAND_PIPELINE=0` 可关闭流水线做对照。`UU_WAYLAND_DMABUF=1` 显式尝试 dma-buf→GBM CPU 映射(默认关闭,需要运行时 libgbm;可用 `UU_WAYLAND_DMABUF_DEVICE` 指定 render node,默认 `/dev/dri/renderD128`)。仅支持显式线性修饰符、单平面 8-bit RGB,失败回退 SHM;virgl VM 中只验证了回退,成功导入/映射和硬件加速均未验证。这不是零拷贝 VAAPI 路径;选择 `UU_VIDEO_ENCODER=vaapi` 时仍由 FFmpeg 上传 CPU 帧。
|
||||||
首次连接时,桌面会弹窗请求「远程桌面 / 屏幕共享」授权,同意后会记住授权。
|
首次连接时,桌面会弹窗请求「远程桌面 / 屏幕共享」授权,同意后会记住授权。
|
||||||
|
|
||||||
|
### Hyprland 多显示器切换(实验性)
|
||||||
|
|
||||||
|
原生 Wayland 的绝对鼠标定位默认绑定正在采集的输出,修复双屏桌面下的点击偏移。uinput 可继续用于键盘、按键和相对移动。
|
||||||
|
|
||||||
|
设置 `UU_WAYLAND_MULTISCREEN=1` 后,手机端可选择并切换物理显示器;`UU_WAYLAND_OUTPUT` 指定默认屏幕。画面与绝对鼠标定位同步切换,支持不同分辨率、缩放和桌面位置。
|
||||||
|
|
||||||
|
切屏复用同一条视频轨道,过渡期间暂停输入,发送新屏首帧后恢复;采集或编码失败、等待首帧超时会请求恢复原屏。当前通过 `hyprctl` 枚举未旋转的显示器,显示器插拔或布局变化后需重启服务。已在 Omarchy / Hyprland 上用官方手机客户端实测 2560×1440(125%)与 1920×1080(133.33%)双屏切换及点击。
|
||||||
|
|
||||||
## 尚未实现 / 不支持
|
## 尚未实现 / 不支持
|
||||||
|
|
||||||
| 功能 | 状态 |
|
| 功能 | 状态 |
|
||||||
|---|---|
|
|---|---|
|
||||||
| 多显示器切换 | 开发中 |
|
| 多显示器切换 | Hyprland 原生 Wayland 后端实验性支持,见上文 |
|
||||||
| 真彩(4:4:4) | 支持(v0.1.15):NVENC / libx264 的默认 FFmpeg 管线输出 H.264 High 4:4:4;VAAPI 和 `inproc-av` 管线仍为 4:2:0,并如实回报给客户端 |
|
| 真彩(4:4:4) | 支持(v0.1.15):NVENC / libx264 的默认 FFmpeg 管线输出 H.264 High 4:4:4;`inproc-av` 原生 NVENC 输出 H.264 High 4:4:4 / HEVC FRExt;VAAPI 管线仍为 4:2:0,并如实回报给客户端 |
|
||||||
| HDR | 未实现 |
|
| HDR | 未实现 |
|
||||||
| 超级屏 / 虚拟显示器 | 未实现 |
|
| 超级屏 / 虚拟显示器 | 未实现 |
|
||||||
| 被控端防窥模式 | 未实现 |
|
| 被控端防窥模式 | 未实现 |
|
||||||
@@ -104,6 +115,38 @@ 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 服务和应用菜单图标;uinput 权限不会自动开启(见第 5 步)。
|
||||||
|
GNOME / KDE 会把显示环境自动传给服务;Xfce 等不传的桌面需按第 4 步补 `DISPLAY`。
|
||||||
|
|
||||||
|
**其他发行版**:从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||||
|
install -Dm644 libuu-wayland.so libuu-portal.so -t ~/.local/lib/uu-remote-linux/
|
||||||
|
```
|
||||||
|
|
||||||
|
同一个包支持 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)
|
### 1. 依赖(Ubuntu / Debian)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -114,6 +157,8 @@ sudo apt install build-essential pkg-config \
|
|||||||
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
|
sudo apt install libwayland-dev libxkbcommon-dev wl-clipboard
|
||||||
# 可选:GNOME/KDE portal 后端
|
# 可选:GNOME/KDE portal 后端
|
||||||
sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev
|
sudo apt install libglib2.0-dev libpipewire-0.3-dev libei-dev
|
||||||
|
# 可选:inproc-av 的 VAAPI/DRI3 引擎编译所需(libva 本体运行时加载)
|
||||||
|
sudo apt install libva-dev libgbm-dev libx11-xcb-dev libxcb-dri3-dev libxcb-damage0-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
- 需要 Rust 工具链(<https://rustup.rs>)。
|
- 需要 Rust 工具链(<https://rustup.rs>)。
|
||||||
@@ -128,6 +173,9 @@ cargo build --release --features wayland # + Hyprland
|
|||||||
cargo build --release --features wayland,portal # + GNOME/KDE Wayland
|
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. 登录
|
### 3. 登录
|
||||||
|
|
||||||
在图形桌面里运行:
|
在图形桌面里运行:
|
||||||
@@ -147,17 +195,17 @@ cargo build --release --features wayland,portal # + GNOME/KDE Wayland
|
|||||||
[Unit]
|
[Unit]
|
||||||
Description=UU Remote Linux host (unofficial)
|
Description=UU Remote Linux host (unofficial)
|
||||||
After=graphical-session.target
|
After=graphical-session.target
|
||||||
|
PartOf=graphical-session.target
|
||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Environment=RUST_LOG=info
|
Environment=RUST_LOG=info
|
||||||
# X11 桌面需要指明显示器;GNOME 的 XAUTHORITY 一般在 /run/user/<uid>/gdm/Xauthority
|
# GNOME/KDE 等桌面会把 DISPLAY / WAYLAND_DISPLAY 导入用户管理器,并启动 graphical-session.target
|
||||||
Environment=DISPLAY=:0
|
|
||||||
ExecStart=%h/.local/bin/uuremote-server
|
ExecStart=%h/.local/bin/uuremote-server
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=5
|
RestartSec=5
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=default.target
|
WantedBy=graphical-session.target
|
||||||
```
|
```
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -169,6 +217,9 @@ journalctl --user -u uuremote-native.service -f # 看到 availability=Some("re
|
|||||||
|
|
||||||
如果还没有登录,服务会自动在桌面上弹出扫码窗口。
|
如果还没有登录,服务会自动在桌面上弹出扫码窗口。
|
||||||
|
|
||||||
|
Xfce、i3 等不启动 `graphical-session.target` 的桌面,按上面的写法开机不会自启:把 `[Install]` 改成 `WantedBy=default.target`,
|
||||||
|
并加上 `Environment=DISPLAY=:0`(按实际显示器填写),再重新 `enable`。下文的无头模式、虚拟桌面也要用 `default.target`。
|
||||||
|
|
||||||
### 5. Wayland 下使用 uinput 虚拟键鼠(推荐)
|
### 5. Wayland 下使用 uinput 虚拟键鼠(推荐)
|
||||||
|
|
||||||
Wayland(尤其是 GNOME/KDE portal)下,默认的键鼠注入要经过 portal 授权,部分键盘布局下还会丢符号(比如下划线)。
|
Wayland(尤其是 GNOME/KDE portal)下,默认的键鼠注入要经过 portal 授权,部分键盘布局下还会丢符号(比如下划线)。
|
||||||
@@ -208,7 +259,7 @@ install -Dm644 contrib/desktop/uu-remote-linux-viewer.desktop ~/.local/share/app
|
|||||||
## 没有显示器的服务器
|
## 没有显示器的服务器
|
||||||
|
|
||||||
**无头模式**:只要终端、文件传输和端口映射,不需要图形界面。在服务里加 `Environment=UU_DESKTOP_BACKEND=none`,
|
**无头模式**:只要终端、文件传输和端口映射,不需要图形界面。在服务里加 `Environment=UU_DESKTOP_BACKEND=none`,
|
||||||
再执行 `loginctl enable-linger $USER`,这样开机后不用登录,systemd 用户服务(以及 `XDG_RUNTIME_DIR`、用户 D-Bus)也会自动启动。
|
把 `[Install]` 改成 `WantedBy=default.target`(无人登录时 `graphical-session.target` 不会启动),再执行 `loginctl enable-linger $USER`,这样开机后不用登录,systemd 用户服务(以及 `XDG_RUNTIME_DIR`、用户 D-Bus)也会自动启动。
|
||||||
无头模式下控制端点「远程桌面」会一直显示正在连接,这是正常的。首次登录用 `uuremote-server login --no-gui` 在终端里扫码。
|
无头模式下控制端点「远程桌面」会一直显示正在连接,这是正常的。首次登录用 `uuremote-server login --no-gui` 在终端里扫码。
|
||||||
|
|
||||||
**群晖 / NAS(Docker)**:没有桌面的 NAS 可以用容器运行无头模式(文件传输、终端、端口映射)。
|
**群晖 / NAS(Docker)**:没有桌面的 NAS 可以用容器运行无头模式(文件传输、终端、端口映射)。
|
||||||
@@ -248,6 +299,10 @@ systemctl --user restart uuremote-native.service
|
|||||||
|---|---|
|
|---|---|
|
||||||
| `UU_CONFIG` | 配置文件路径(默认 `~/.config/uuremote/config.json`) |
|
| `UU_CONFIG` | 配置文件路径(默认 `~/.config/uuremote/config.json`) |
|
||||||
| `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms`(实验性特性) / `none`(无头模式) |
|
| `UU_DESKTOP_BACKEND` | `auto` / `x11` / `wayland` / `portal` / `kms`(实验性特性) / `none`(无头模式) |
|
||||||
|
| `UU_DESKTOP_RESIZE=0` | X11 下控制端切换分辨率时不改桌面分辨率,只缩放编码画面 |
|
||||||
|
| `UU_WAYLAND_MULTISCREEN=1` | 启用 Hyprland 物理显示器切换(默认关闭) |
|
||||||
|
| `UU_WAYLAND_OUTPUT` | 原生 Wayland 默认采集输出名称,例如 `HDMI-A-1` |
|
||||||
|
| `UU_WAYLAND_NO_VIRTUAL_KEYBOARD=1` | 原生 Wayland 不创建虚拟键盘(如 Denial 只把它给自己的输入法),键盘改走 uinput。合成器没有 wlr-virtual-pointer 时鼠标也自动改走 uinput(#72) |
|
||||||
| `UU_INPUT_BACKEND` | `auto`(默认,Wayland 下可用时用 uinput)/ `uinput` / `native` |
|
| `UU_INPUT_BACKEND` | `auto`(默认,Wayland 下可用时用 uinput)/ `uinput` / `native` |
|
||||||
| `UU_TERMINAL_SHORTCUTS=0` | 关闭终端窗口里的 Ctrl+V 粘贴转换 |
|
| `UU_TERMINAL_SHORTCUTS=0` | 关闭终端窗口里的 Ctrl+V 粘贴转换 |
|
||||||
| `UU_VIDEO_ENCODER` | `cpu` 强制 CPU;`vaapi` 显式启用 Intel/AMD 硬编;`nvenc` 强制 NVENC;未设置时检测到 NVIDIA 驱动才用 NVENC,否则用 CPU |
|
| `UU_VIDEO_ENCODER` | `cpu` 强制 CPU;`vaapi` 显式启用 Intel/AMD 硬编;`nvenc` 强制 NVENC;未设置时检测到 NVIDIA 驱动才用 NVENC,否则用 CPU |
|
||||||
@@ -258,9 +313,13 @@ systemctl --user restart uuremote-native.service
|
|||||||
| `UU_REMOTE_ASSIST=0` | 关闭远程协助(未登录时也不再以访客身份提供协助) |
|
| `UU_REMOTE_ASSIST=0` | 关闭远程协助(未登录时也不再以访客身份提供协助) |
|
||||||
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
|
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
|
||||||
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
|
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
|
||||||
|
| `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) |
|
||||||
|
| `UU_USE_PROXY=1` | 使用环境变量里的 HTTP/SOCKS 代理;默认忽略代理、直连网易服务器 |
|
||||||
|
|
||||||
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。
|
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。
|
||||||
|
|
||||||
|
自定义码率按客户端选择的 Mbps 生效,例如 1 Mbps 对应 1000 kbit/s 的编码上限。
|
||||||
|
|
||||||
选择码率档(原画 / 超清 / 高清 / 自定义)时,外部 FFmpeg 的 CPU 编码以平均码率(ABR)为目标,避免 4K 低码率下关键帧发灰;「自动」档仍使用恒定质量(CRF)。
|
选择码率档(原画 / 超清 / 高清 / 自定义)时,外部 FFmpeg 的 CPU 编码以平均码率(ABR)为目标,避免 4K 低码率下关键帧发灰;「自动」档仍使用恒定质量(CRF)。
|
||||||
|
|
||||||
本地编码诊断 `desktop-video-probe [output.h264]` 可设置 `UU_PROBE_FPS`、`UU_PROBE_FRAMES`(默认 5)和 `UU_PROBE_QUALITY`(1–5);设置 `UU_PROBE_INPUT=clip.y4m`(也支持 `.mp4`、`frames/%05d.png`)可绕过桌面采集,以相同的生产 FFmpeg 编码参数测量固定输入并打印分辨率和编码统计,`UU_PROBE_LOOP=1` 循环到指定帧数,输入无法打开或帧数不足时以非零状态退出(固定输入始终使用外部 FFmpeg 管线)。
|
本地编码诊断 `desktop-video-probe [output.h264]` 可设置 `UU_PROBE_FPS`、`UU_PROBE_FRAMES`(默认 5)和 `UU_PROBE_QUALITY`(1–5);设置 `UU_PROBE_INPUT=clip.y4m`(也支持 `.mp4`、`frames/%05d.png`)可绕过桌面采集,以相同的生产 FFmpeg 编码参数测量固定输入并打印分辨率和编码统计,`UU_PROBE_LOOP=1` 循环到指定帧数,输入无法打开或帧数不足时以非零状态退出(固定输入始终使用外部 FFmpeg 管线)。
|
||||||
@@ -311,8 +370,9 @@ flowchart LR
|
|||||||
|
|
||||||
### H.265 / HEVC
|
### H.265 / HEVC
|
||||||
|
|
||||||
控制端和主机都支持 H.265 时,主机自动使用 H.265(与官方主机一致,由主机按双方能力选择;官方 Mac 客户端在 SDP
|
控制端和主机都支持 H.265、且主机使用硬件编码器(NVENC / 显式 VAAPI)时,主机自动使用 H.265(与官方主机一致,由主机按双方能力选择;官方 Mac 客户端在 SDP
|
||||||
中优先列出 H.265)。首次桌面连接会用合成帧探测实际编码能力,并通过 CodecNegotiation 告知客户端。支持 `hevc_nvenc`、
|
中优先列出 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。
|
`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`。
|
`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)实机验收;`hevc_vaapi` 配官方 Android 客户端也已实机验收
|
已用官方 Mac 客户端在 RTX 3090(hevc_nvenc,含 4:4:4)实机验收;`hevc_vaapi` 配官方 Android 客户端也已实机验收
|
||||||
@@ -326,9 +386,9 @@ HEVC 的访问单元按 RFC 7798 的图片边界切分,不依赖 AUD:`hevc_v
|
|||||||
|
|
||||||
设置 `UU_VIDEO_ENCODER=vaapi` 使用 Intel/AMD H.264 VAAPI;`UU_VAAPI_DEVICE` 默认
|
设置 `UU_VIDEO_ENCODER=vaapi` 使用 Intel/AMD H.264 VAAPI;`UU_VAAPI_DEVICE` 默认
|
||||||
`/dev/dri/renderD128`,运行用户需要 render 节点权限。不会自动选择 VAAPI;设备或驱动初始化
|
`/dev/dri/renderD128`,运行用户需要 render 节点权限。不会自动选择 VAAPI;设备或驱动初始化
|
||||||
失败会明确警告并回退 libx264。外部 FFmpeg 和 `--features inproc-av` 均先转 NV12 再上传硬件帧。
|
失败会明确警告并回退 libx264。外部 FFmpeg 先转 NV12 再上传硬件帧。
|
||||||
VBR 使用控制端码率预设及 CQ 对应的最小 QP,无 B 帧、async depth=1,并保留现有 GOP/VFR 规则。
|
VBR 使用控制端码率预设及 CQ 对应的最小 QP,无 B 帧、async depth=1,并保留现有 GOP/VFR 规则。
|
||||||
Intel 核显(UHD 770,iHD 驱动)已实机验收:默认的外部 FFmpeg 管线用官方 Mac 控制端测试了各档画质、帧率、缩放和重连,全程硬件编码、无回退,CPU 占用比 libx264 低约 40%。**AMD 显卡和 `--features inproc-av` 管线的 VAAPI 尚未实机验证。**
|
Intel 核显(UHD 770,iHD 驱动)已实机验收:默认的外部 FFmpeg 管线用官方 Mac 控制端测试了各档画质、帧率、缩放和重连,全程硬件编码、无回退,CPU 占用比 libx264 低约 40%(该数字为 FFmpeg 进程管线时代的测量)。AMD 核显已在**进程内原生引擎**上实机验收(`--features inproc-av`):官方 Mac 客户端的端到端会话在 HawkPoint(Mesa 26.2.3)与 Cezanne(Mesa 26.2.5)上通过验收(HEVC,含画质档、帧率、缩放);Cezanne 上另以探测验证了 H.264 与两条采集路径——XShm 上传(码流可解码、画面正确)与 DRI3 DMA-BUF 零拷贝导入。同机实测(1920×1200@60,Cezanne iGPU + RTX 3050 Ti 双显卡):进程内 VAAPI 每帧编码 CPU 约为 libx264(FFmpeg 管线 superfast)的 **1/12**、进程内 NVENC 的 **1/5**;外部 FFmpeg 进程管线(预编译包使用)在 AMD 上未单独验证。
|
||||||
|
|
||||||
高分辨率下 VAAPI 的默认 VBV 缓冲(100–500 kbit)会把关键帧压得过狠:2560×1440 H.264 VAAPI、30M
|
高分辨率下 VAAPI 的默认 VBV 缓冲(100–500 kbit)会把关键帧压得过狠:2560×1440 H.264 VAAPI、30M
|
||||||
上限、静止画面上实测首个 IDR 只有 59,910 字节,画面每隔一个 GOP 糊一下再慢慢恢复。设
|
上限、静止画面上实测首个 IDR 只有 59,910 字节,画面每隔一个 GOP 糊一下再慢慢恢复。设
|
||||||
@@ -364,7 +424,8 @@ cargo build --release --features wayland
|
|||||||
|
|
||||||
Omarchy 使用 Hyprland:在其用户会话中运行,设置 `UU_DESKTOP_BACKEND=wayland`,保留
|
Omarchy 使用 Hyprland:在其用户会话中运行,设置 `UU_DESKTOP_BACKEND=wayland`,保留
|
||||||
`WAYLAND_DISPLAY` 和 `XDG_RUNTIME_DIR`。其他合成器可能需要 `--features wayland,portal`。
|
`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` 后,
|
该权限能向整个 seat(包括锁屏/登录界面)注入输入。设置 `UU_INPUT_BACKEND=uinput` 后,
|
||||||
仍须确认启动日志实际选择了 uinput。
|
仍须确认启动日志实际选择了 uinput。
|
||||||
|
|
||||||
@@ -385,11 +446,14 @@ Environment=UU_DESKTOP_BACKEND=wayland
|
|||||||
WantedBy=graphical-session.target
|
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` 提供
|
VAAPI 可选包:Intel 新显卡用 `intel-media-driver`,AMD 用 `libva-mesa-driver`,`libva-utils` 提供
|
||||||
`vainfo`。KMS 依赖 `libdrm`。虚拟 Xfce 依赖 `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
|
`vainfo`。KMS 依赖 `libdrm`。虚拟 Xfce 依赖 `xorg-server-xvfb xorg-xauth xorg-xdpyinfo
|
||||||
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`。
|
xfce4-session xfce4-panel xfdesktop xfwm4 gnome-terminal`。
|
||||||
滚动 Arch 的 FFmpeg 可能超出 `inproc-av` 支持的 6.x;请使用默认进程方案或独立的 FFmpeg 6 前缀,
|
若编译包含 `viewer-ffmpeg`,滚动 Arch 的 FFmpeg 可能超出其支持的 6.x;请使用独立的 FFmpeg 6 前缀,不要降级系统 FFmpeg(服务端的 `--features inproc-av` 原生 NVENC 不依赖 FFmpeg)。
|
||||||
不要降级系统 FFmpeg。
|
|
||||||
|
|
||||||
### 实验性 KMS 截屏
|
### 实验性 KMS 截屏
|
||||||
|
|
||||||
|
|||||||
@@ -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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,10 @@
|
|||||||
fn main() {
|
fn main() {
|
||||||
println!("cargo:rerun-if-changed=c_engine/portal_clipboard.inc");
|
println!("cargo:rerun-if-changed=c_engine/portal_clipboard.inc");
|
||||||
println!("cargo:rerun-if-changed=c_engine/x11_engine.c");
|
println!("cargo:rerun-if-changed=c_engine/x11_engine.c");
|
||||||
|
println!("cargo:rerun-if-changed=c_engine/nvenc_engine.c");
|
||||||
|
println!("cargo:rerun-if-changed=c_engine/nvenc_engine.h");
|
||||||
|
println!("cargo:rerun-if-changed=vendor/ffnvcodec/ffnvcodec/dynlink_cuda.h");
|
||||||
|
println!("cargo:rerun-if-changed=vendor/ffnvcodec/ffnvcodec/nvEncodeAPI.h");
|
||||||
println!("cargo:rerun-if-changed=c_engine/clipboard.c");
|
println!("cargo:rerun-if-changed=c_engine/clipboard.c");
|
||||||
println!("cargo:rerun-if-changed=c_engine/assist_window.c");
|
println!("cargo:rerun-if-changed=c_engine/assist_window.c");
|
||||||
println!("cargo:rerun-if-changed=c_engine/viewer_window.c");
|
println!("cargo:rerun-if-changed=c_engine/viewer_window.c");
|
||||||
@@ -21,11 +25,27 @@ fn main() {
|
|||||||
build.compile("uu_kms_engine");
|
build.compile("uu_kms_engine");
|
||||||
println!("cargo:rustc-link-lib=drm");
|
println!("cargo:rustc-link-lib=drm");
|
||||||
}
|
}
|
||||||
cc::Build::new()
|
let mut x11_build = cc::Build::new();
|
||||||
.file("c_engine/x11_engine.c")
|
x11_build.file("c_engine/x11_engine.c")
|
||||||
.file("c_engine/clipboard.c")
|
.file("c_engine/clipboard.c")
|
||||||
.file("c_engine/pam_check.c")
|
.file("c_engine/pam_check.c");
|
||||||
.compile("x11_engine");
|
if std::env::var_os("CARGO_FEATURE_INPROC_AV").is_some() {
|
||||||
|
x11_build.file("c_engine/nvenc_engine.c");
|
||||||
|
x11_build.file("c_engine/vaapi_engine.c");
|
||||||
|
x11_build.file("c_engine/dri3_capture.c");
|
||||||
|
for f in ["c_engine/vaapi_engine.c", "c_engine/vaapi_engine.h", "c_engine/dri3_capture.c", "c_engine/dri3_capture.h"] {
|
||||||
|
println!("cargo:rerun-if-changed={f}");
|
||||||
|
}
|
||||||
|
x11_build.include("vendor/ffnvcodec");
|
||||||
|
// libva/libva-drm are dlopen'ed at runtime (like NVENC's libcuda); these are
|
||||||
|
// link-time-only deps of the DRI3/VAAPI engines and must stay out of default builds.
|
||||||
|
println!("cargo:rustc-link-lib=gbm");
|
||||||
|
println!("cargo:rustc-link-lib=X11-xcb");
|
||||||
|
println!("cargo:rustc-link-lib=xcb");
|
||||||
|
println!("cargo:rustc-link-lib=xcb-dri3");
|
||||||
|
println!("cargo:rustc-link-lib=xcb-damage");
|
||||||
|
}
|
||||||
|
x11_build.compile("x11_engine");
|
||||||
|
|
||||||
println!("cargo:rustc-link-lib=X11");
|
println!("cargo:rustc-link-lib=X11");
|
||||||
println!("cargo:rustc-link-lib=Xext");
|
println!("cargo:rustc-link-lib=Xext");
|
||||||
@@ -50,7 +70,15 @@ fn main() {
|
|||||||
}
|
}
|
||||||
None => println!("cargo:warning=gtk+-3.0 not found: building without the login window"),
|
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.c");
|
||||||
println!("cargo:rerun-if-changed=c_engine/portal_engine.h");
|
println!("cargo:rerun-if-changed=c_engine/portal_engine.h");
|
||||||
println!("cargo:rerun-if-changed=c_engine/portal_eis.inc");
|
println!("cargo:rerun-if-changed=c_engine/portal_eis.inc");
|
||||||
@@ -76,6 +104,7 @@ fn main() {
|
|||||||
let mut build = cc::Build::new();
|
let mut build = cc::Build::new();
|
||||||
build.flag_if_supported("-Wno-unused-parameter"); // protocol listener signatures
|
build.flag_if_supported("-Wno-unused-parameter"); // protocol listener signatures
|
||||||
build.file("c_engine/wayland_engine.c").include(&out);
|
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"] {
|
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");
|
let xml = format!("c_engine/wayland-protocols/{name}.xml");
|
||||||
println!("cargo:rerun-if-changed={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()
|
let status = std::process::Command::new("wayland-scanner").args([mode, &xml]).arg(&target).status()
|
||||||
.expect("Install wayland-scanner to build the Wayland backend");
|
.expect("Install wayland-scanner to build the Wayland backend");
|
||||||
assert!(status.success(), "wayland-scanner failed");
|
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");
|
println!("cargo:rerun-if-changed=c_engine/wayland_engine.c");
|
||||||
build.compile("uu_wayland_engine");
|
if plugins {
|
||||||
println!("cargo:rustc-link-lib=wayland-client");
|
let sources: Vec<&str> = sources.iter().map(String::as_str).collect();
|
||||||
println!("cargo:rustc-link-lib=xkbcommon");
|
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"); }
|
||||||
|
}
|
||||||
@@ -46,7 +46,10 @@ static pthread_cond_t init_cond = PTHREAD_COND_INITIALIZER;
|
|||||||
static GtkWidget *window, *allow_switch, *id_label, *code_label, *eye_button, *share_button, *hint_label, *verify_combo, *note_label;
|
static GtkWidget *window, *allow_switch, *id_label, *code_label, *eye_button, *share_button, *hint_label, *verify_combo, *note_label;
|
||||||
static GtkWidget *refresh_items[5], *footer_label;
|
static GtkWidget *refresh_items[5], *footer_label;
|
||||||
// Account card: QR login before sign-in, user info (+ logout) after.
|
// Account card: QR login before sign-in, user info (+ logout) after.
|
||||||
static GtkWidget *assist_card, *account_card, *account_stack, *qr_stack, *qr_image, *login_status, *user_label;
|
static GtkWidget *assist_card, *account_card, *account_stack, *qr_stack, *qr_image, *login_status, *user_label, *qr_refresh;
|
||||||
|
/* Like the official client, a failed or timed-out QR stays until the user asks for a new one. */
|
||||||
|
static atomic_int qr_refresh_requested;
|
||||||
|
static void on_qr_refresh(GtkButton *b, gpointer d) { (void)b; (void)d; atomic_store(&qr_refresh_requested, 1); gtk_widget_hide(qr_refresh); }
|
||||||
static int show_assist = 1, show_account;
|
static int show_assist = 1, show_account;
|
||||||
// Tray (host service only): AppIndicator via dlopen (no build dependency), else GtkStatusIcon.
|
// Tray (host service only): AppIndicator via dlopen (no build dependency), else GtkStatusIcon.
|
||||||
static GtkWidget *tray_menu, *tray_allow;
|
static GtkWidget *tray_menu, *tray_allow;
|
||||||
@@ -250,6 +253,11 @@ static GtkWidget *build_account_card(void) {
|
|||||||
login_status = label("", "status");
|
login_status = label("", "status");
|
||||||
gtk_label_set_line_wrap(GTK_LABEL(login_status), TRUE);
|
gtk_label_set_line_wrap(GTK_LABEL(login_status), TRUE);
|
||||||
gtk_box_pack_start(GTK_BOX(qr_text), login_status, FALSE, FALSE, 0);
|
gtk_box_pack_start(GTK_BOX(qr_text), login_status, FALSE, FALSE, 0);
|
||||||
|
qr_refresh = gtk_button_new_with_label("刷新二维码");
|
||||||
|
gtk_widget_set_halign(qr_refresh, GTK_ALIGN_START);
|
||||||
|
gtk_widget_set_no_show_all(qr_refresh, TRUE);
|
||||||
|
g_signal_connect(qr_refresh, "clicked", G_CALLBACK(on_qr_refresh), NULL);
|
||||||
|
gtk_box_pack_start(GTK_BOX(qr_text), qr_refresh, FALSE, FALSE, 0);
|
||||||
gtk_box_pack_start(GTK_BOX(qr_page), qr_text, TRUE, TRUE, 0);
|
gtk_box_pack_start(GTK_BOX(qr_page), qr_text, TRUE, TRUE, 0);
|
||||||
gtk_stack_add_named(GTK_STACK(account_stack), qr_page, "qr");
|
gtk_stack_add_named(GTK_STACK(account_stack), qr_page, "qr");
|
||||||
|
|
||||||
@@ -297,6 +305,29 @@ static void on_status_menu(GtkStatusIcon *i, guint button, guint time, gpointer
|
|||||||
(void)i; (void)button; (void)time; (void)d;
|
(void)i; (void)button; (void)time; (void)d;
|
||||||
gtk_menu_popup_at_pointer(GTK_MENU(tray_menu), NULL);
|
gtk_menu_popup_at_pointer(GTK_MENU(tray_menu), NULL);
|
||||||
}
|
}
|
||||||
|
// Monochrome tray icon that follows light/dark panels: GTK and the GNOME AppIndicator extension
|
||||||
|
// recolor "-symbolic" names, KDE recolors the ColorScheme-Text class. Written to the user cache
|
||||||
|
// and offered as an icon theme path, so it needs no package install.
|
||||||
|
static const char TRAY_ICON_NAME[] = "uu-remote-linux-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 theme path holding the icon (hicolor layout plus a loose copy), or NULL.
|
||||||
|
static gchar *write_tray_icon(void) {
|
||||||
|
gchar *root = g_build_filename(g_get_user_cache_dir(), "uu-remote-linux", "icons", NULL);
|
||||||
|
gchar *apps = g_build_filename(root, "hicolor", "scalable", "apps", NULL);
|
||||||
|
gchar *file = g_strconcat(TRAY_ICON_NAME, ".svg", NULL);
|
||||||
|
gchar *themed = g_build_filename(apps, file, NULL), *loose = g_build_filename(root, file, NULL);
|
||||||
|
int ok = g_mkdir_with_parents(apps, 0700) == 0 && g_file_set_contents(themed, TRAY_ICON_SVG, -1, NULL)
|
||||||
|
&& g_file_set_contents(loose, TRAY_ICON_SVG, -1, NULL);
|
||||||
|
g_free(apps); g_free(file); g_free(themed); g_free(loose);
|
||||||
|
if (!ok) { g_free(root); return NULL; }
|
||||||
|
return root;
|
||||||
|
}
|
||||||
static void build_tray(void) {
|
static void build_tray(void) {
|
||||||
tray_menu = gtk_menu_new();
|
tray_menu = gtk_menu_new();
|
||||||
GtkWidget *open = gtk_menu_item_new_with_label("打开主窗口");
|
GtkWidget *open = gtk_menu_item_new_with_label("打开主窗口");
|
||||||
@@ -310,7 +341,10 @@ static void build_tray(void) {
|
|||||||
gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), gtk_separator_menu_item_new());
|
gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), gtk_separator_menu_item_new());
|
||||||
gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), quit);
|
gtk_menu_shell_append(GTK_MENU_SHELL(tray_menu), quit);
|
||||||
gtk_widget_show_all(tray_menu);
|
gtk_widget_show_all(tray_menu);
|
||||||
const char *icon = gtk_icon_theme_has_icon(gtk_icon_theme_get_default(), "uu-remote-linux") ? "uu-remote-linux" : "computer";
|
gchar *icon_path = write_tray_icon();
|
||||||
|
if (icon_path) gtk_icon_theme_append_search_path(gtk_icon_theme_get_default(), icon_path);
|
||||||
|
const char *fallback = gtk_icon_theme_has_icon(gtk_icon_theme_get_default(), "uu-remote-linux") ? "uu-remote-linux" : "computer";
|
||||||
|
const char *icon = icon_path ? TRAY_ICON_NAME : fallback;
|
||||||
|
|
||||||
// StatusNotifierItem (GNOME AppIndicator extension, KDE): libayatana-appindicator3 / libappindicator3.
|
// StatusNotifierItem (GNOME AppIndicator extension, KDE): libayatana-appindicator3 / libappindicator3.
|
||||||
const char *libs[] = { "libayatana-appindicator3.so.1", "libappindicator3.so.1" };
|
const char *libs[] = { "libayatana-appindicator3.so.1", "libappindicator3.so.1" };
|
||||||
@@ -321,8 +355,11 @@ static void build_tray(void) {
|
|||||||
void (*set_status)(void *, int) = (void (*)(void *, int))dlsym(h, "app_indicator_set_status");
|
void (*set_status)(void *, int) = (void (*)(void *, int))dlsym(h, "app_indicator_set_status");
|
||||||
void (*set_menu)(void *, GtkMenu *) = (void (*)(void *, GtkMenu *))dlsym(h, "app_indicator_set_menu");
|
void (*set_menu)(void *, GtkMenu *) = (void (*)(void *, GtkMenu *))dlsym(h, "app_indicator_set_menu");
|
||||||
void (*set_title)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_title");
|
void (*set_title)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_title");
|
||||||
|
void (*set_theme_path)(void *, const char *) = (void (*)(void *, const char *))dlsym(h, "app_indicator_set_icon_theme_path");
|
||||||
if (ind_new && set_status && set_menu) {
|
if (ind_new && set_status && set_menu) {
|
||||||
void *ind = ind_new("uu-remote-linux", icon, 0 /* APPLICATION_STATUS */);
|
// Without a theme path the panel cannot find the cached icon; keep the installed one.
|
||||||
|
void *ind = ind_new("uu-remote-linux", set_theme_path ? icon : fallback, 0 /* APPLICATION_STATUS */);
|
||||||
|
if (icon_path && set_theme_path) set_theme_path(ind, icon_path);
|
||||||
if (set_title) set_title(ind, "UU 远程 Linux 主机");
|
if (set_title) set_title(ind, "UU 远程 Linux 主机");
|
||||||
set_menu(ind, GTK_MENU(tray_menu));
|
set_menu(ind, GTK_MENU(tray_menu));
|
||||||
set_status(ind, 1 /* ACTIVE */);
|
set_status(ind, 1 /* ACTIVE */);
|
||||||
@@ -641,6 +678,16 @@ void uu_ui_set_user(const char *name) {
|
|||||||
if (!ui_started || init_state != 1) return;
|
if (!ui_started || init_state != 1) return;
|
||||||
g_idle_add(apply_user, g_strdup(name ? name : ""));
|
g_idle_add(apply_user, g_strdup(name ? name : ""));
|
||||||
}
|
}
|
||||||
|
static gboolean apply_qr_refresh(gpointer data) {
|
||||||
|
if (window && qr_refresh) { if (GPOINTER_TO_INT(data)) gtk_widget_show(qr_refresh); else gtk_widget_hide(qr_refresh); }
|
||||||
|
return G_SOURCE_REMOVE;
|
||||||
|
}
|
||||||
|
void uu_login_ui_offer_refresh(int visible) {
|
||||||
|
if (!ui_started || init_state != 1 || atomic_load(&closed)) return;
|
||||||
|
atomic_store(&qr_refresh_requested, 0);
|
||||||
|
g_idle_add(apply_qr_refresh, GINT_TO_POINTER(visible != 0));
|
||||||
|
}
|
||||||
|
int uu_login_ui_take_refresh(void) { return atomic_exchange(&qr_refresh_requested, 0); }
|
||||||
void uu_login_ui_set_done(const char *text) { uu_ui_set_user(text); }
|
void uu_login_ui_set_done(const char *text) { uu_ui_set_user(text); }
|
||||||
int uu_login_ui_closed(void) { return atomic_load(&closed); }
|
int uu_login_ui_closed(void) { return atomic_load(&closed); }
|
||||||
void uu_login_ui_close(void) { uu_assist_ui_close(); }
|
void uu_login_ui_close(void) { uu_assist_ui_close(); }
|
||||||
@@ -7,6 +7,8 @@
|
|||||||
#define SESSION_DEST "org.gnome.SessionManager"
|
#define SESSION_DEST "org.gnome.SessionManager"
|
||||||
#define SESSION_PATH "/org/gnome/SessionManager"
|
#define SESSION_PATH "/org/gnome/SessionManager"
|
||||||
#define SESSION_IFACE "org.gnome.SessionManager"
|
#define SESSION_IFACE "org.gnome.SessionManager"
|
||||||
|
#define SCREENSAVER_DEST "org.freedesktop.ScreenSaver"
|
||||||
|
#define SCREENSAVER_PATH "/org/freedesktop/ScreenSaver"
|
||||||
|
|
||||||
enum {
|
enum {
|
||||||
UU_POWER_OK = 0,
|
UU_POWER_OK = 0,
|
||||||
@@ -17,6 +19,7 @@ enum {
|
|||||||
struct uu_idle_inhibitor {
|
struct uu_idle_inhibitor {
|
||||||
GDBusConnection *connection;
|
GDBusConnection *connection;
|
||||||
guint32 cookie;
|
guint32 cookie;
|
||||||
|
int freedesktop; /* org.freedesktop.ScreenSaver (KDE) instead of org.gnome.SessionManager */
|
||||||
};
|
};
|
||||||
|
|
||||||
struct setup_timeout {
|
struct setup_timeout {
|
||||||
@@ -138,13 +141,45 @@ struct uu_idle_inhibitor *uu_desktop_idle_inhibitor_acquire(int *error_code) {
|
|||||||
return inhibitor;
|
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) {
|
void uu_desktop_idle_inhibitor_release(struct uu_idle_inhibitor *inhibitor) {
|
||||||
if (!inhibitor) return;
|
if (!inhibitor) return;
|
||||||
GError *error = NULL;
|
GError *error = NULL;
|
||||||
GVariant *reply = g_dbus_connection_call_sync(
|
GVariant *reply = inhibitor->freedesktop
|
||||||
inhibitor->connection, SESSION_DEST, SESSION_PATH, SESSION_IFACE, "Uninhibit",
|
? g_dbus_connection_call_sync(
|
||||||
g_variant_new("(u)", inhibitor->cookie), G_VARIANT_TYPE("()"),
|
inhibitor->connection, SCREENSAVER_DEST, SCREENSAVER_PATH, SCREENSAVER_DEST, "UnInhibit",
|
||||||
G_DBUS_CALL_FLAGS_NONE, CALL_TIMEOUT_MS, NULL, &error);
|
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);
|
if (reply) g_variant_unref(reply);
|
||||||
g_clear_error(&error);
|
g_clear_error(&error);
|
||||||
|
|
||||||
|
|||||||
@@ -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);
|
||||||
|
}
|
||||||
@@ -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
|
||||||
@@ -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);
|
||||||
|
}
|
||||||
@@ -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
|
||||||
@@ -0,0 +1,835 @@
|
|||||||
|
#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, ¶m, &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;
|
||||||
|
rc.max_qp = 44;
|
||||||
|
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);
|
||||||
|
}
|
||||||
@@ -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
|
||||||
+250
-31
@@ -58,6 +58,14 @@ static struct xkb_context *xkb;
|
|||||||
static struct xkb_keymap *keymap;
|
static struct xkb_keymap *keymap;
|
||||||
static struct xkb_state *key_state;
|
static struct xkb_state *key_state;
|
||||||
static unsigned char held_keys[768];
|
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; };
|
struct output { struct wl_output *handle; char name[128]; int transform,scale; uint32_t width,height; };
|
||||||
static struct output outputs[32];
|
static struct output outputs[32];
|
||||||
static unsigned output_count, selected;
|
static unsigned output_count, selected;
|
||||||
@@ -116,6 +124,164 @@ static int sync_display(void) {
|
|||||||
if (!ready) wl_callback_destroy(cb);
|
if (!ready) wl_callback_destroy(cb);
|
||||||
return result;
|
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_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) {
|
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; }
|
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;
|
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));
|
pending=0; output_count=0; initialized=0; memset(outputs,0,sizeof(outputs));
|
||||||
memset(held_keys,0,sizeof(held_keys));
|
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) {
|
int uu_wl_init(int32_t *w,int32_t *h) {
|
||||||
pthread_mutex_lock(&lock);
|
pthread_mutex_lock(&lock);
|
||||||
@@ -368,7 +535,10 @@ int uu_wl_init(int32_t *w,int32_t *h) {
|
|||||||
wl_registry_add_listener(registry,®istry_listener,NULL);
|
wl_registry_add_listener(registry,®istry_listener,NULL);
|
||||||
if(sync_display()!=0 || sync_display()!=0) goto end;
|
if(sync_display()!=0 || sync_display()!=0) goto end;
|
||||||
dma_init();
|
dma_init();
|
||||||
if(!shm || !seat || !copy_manager || !pointer_manager || !keyboard_manager || !output_count) goto end;
|
/* wlr-virtual-pointer is an optional input path. When the compositor does not
|
||||||
|
advertise it, pointer injection is skipped and the caller may drive input
|
||||||
|
through uinput; screencopy + virtual keyboard are still enough to capture. */
|
||||||
|
if(!shm || !seat || !copy_manager || !output_count) goto end;
|
||||||
const char *name=getenv("UU_WAYLAND_OUTPUT"); selected=0;
|
const char *name=getenv("UU_WAYLAND_OUTPUT"); selected=0;
|
||||||
if(name && *name) {
|
if(name && *name) {
|
||||||
for(selected=0;selected<output_count;selected++) if(!strcmp(outputs[selected].name,name)) break;
|
for(selected=0;selected<output_count;selected++) if(!strcmp(outputs[selected].name,name)) break;
|
||||||
@@ -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);
|
power=zwlr_output_power_manager_v1_get_output_power(power_manager,outputs[selected].handle);
|
||||||
zwlr_output_power_v1_add_listener(power,&power_listener,NULL);
|
zwlr_output_power_v1_add_listener(power,&power_listener,NULL);
|
||||||
}
|
}
|
||||||
pointer=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[selected].handle);
|
if(pointer_manager) pointer=zwlr_virtual_pointer_manager_v1_create_virtual_pointer_with_output(pointer_manager,seat,outputs[selected].handle);
|
||||||
keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat);
|
/* Some compositors reject a virtual keyboard from anything that is not their active
|
||||||
xkb=xkb_context_new(XKB_CONTEXT_NO_FLAGS);
|
input method (Denial does), and a rejected proxy poisons later requests. Allow the
|
||||||
if(!xkb) goto end;
|
caller to opt out and rely on uinput for key input instead. */
|
||||||
struct xkb_rule_names names={.layout="us"};
|
const char *skip_kbd=getenv("UU_WAYLAND_NO_VIRTUAL_KEYBOARD");
|
||||||
keymap=xkb_keymap_new_from_names(xkb,&names,XKB_KEYMAP_COMPILE_NO_FLAGS);
|
if(keyboard_manager && !(skip_kbd && *skip_kbd && strcmp(skip_kbd,"0")))
|
||||||
if(!keymap) goto end;
|
keyboard=zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(keyboard_manager,seat);
|
||||||
key_state=xkb_state_new(keymap); if(!key_state) goto end;
|
if(keyboard) {
|
||||||
char *map=xkb_keymap_get_as_string(keymap,XKB_KEYMAP_FORMAT_TEXT_V1);
|
xkb=xkb_context_new(XKB_CONTEXT_NO_FLAGS);
|
||||||
if(!map) goto end;
|
if(!xkb) goto end;
|
||||||
size_t length=strlen(map)+1;
|
struct xkb_rule_names names={.layout="us"};
|
||||||
int fd=memfd_create("uuremote-keymap",MFD_CLOEXEC);
|
keymap=xkb_keymap_new_from_names(xkb,&names,XKB_KEYMAP_COMPILE_NO_FLAGS);
|
||||||
if(fd<0) { free(map); goto end; }
|
if(!keymap) goto end;
|
||||||
if(ftruncate(fd,(off_t)length)!=0 || write(fd,map,length)!=(ssize_t)length) { free(map); close(fd); goto end; }
|
key_state=xkb_state_new(keymap); if(!key_state) goto end;
|
||||||
free(map);
|
keymap_text=xkb_keymap_get_as_string(keymap,XKB_KEYMAP_FORMAT_TEXT_V1);
|
||||||
zwp_virtual_keyboard_v1_keymap(keyboard,WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,fd,length); close(fd);
|
if(!keymap_text) goto end;
|
||||||
if(sync_display()!=0) 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;
|
initialized=1; *w=width; *h=height; result=0;
|
||||||
end:
|
end:
|
||||||
if(result!=0) reset();
|
if(result!=0) reset();
|
||||||
pthread_mutex_unlock(&lock); return result;
|
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) {
|
int uu_wl_wake(void) {
|
||||||
pthread_mutex_lock(&lock); int result=-1;
|
pthread_mutex_lock(&lock); int result=-1;
|
||||||
/* Output power management is optional; missing it must not block screencopy. */
|
/* 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) {
|
if(initialized && power && !power_failed) {
|
||||||
zwlr_output_power_v1_set_mode(power,ZWLR_OUTPUT_POWER_V1_MODE_ON);
|
zwlr_output_power_v1_set_mode(power,ZWLR_OUTPUT_POWER_V1_MODE_ON);
|
||||||
if(sync_display()==0 && !power_failed) result=0;
|
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) {
|
int uu_wl_move(int32_t x,int32_t y,int relative) {
|
||||||
pthread_mutex_lock(&lock); int result=-1;
|
pthread_mutex_lock(&lock); int result=-1;
|
||||||
|
/* -2: no virtual pointer at all, so the caller may use uinput; -1 stays a real failure. */
|
||||||
|
if(initialized && !pointer) { result=-2; goto end; }
|
||||||
if(initialized) {
|
if(initialized) {
|
||||||
if(relative) {
|
if(relative) {
|
||||||
/* UU reports pixels (source DPR=1); Wayland motion is in logical points. */
|
/* UU reports pixels (source DPR=1); Wayland motion is in logical points. */
|
||||||
@@ -470,6 +683,7 @@ end: pthread_mutex_unlock(&lock); return result;
|
|||||||
}
|
}
|
||||||
int uu_wl_button(int button,int pressed) {
|
int uu_wl_button(int button,int pressed) {
|
||||||
pthread_mutex_lock(&lock); int result=-1;
|
pthread_mutex_lock(&lock); int result=-1;
|
||||||
|
if(initialized && !pointer) { goto end; } /* no virtual pointer: report failure so the caller falls back to uinput */
|
||||||
if(initialized) {
|
if(initialized) {
|
||||||
if(button>=4 && button<=7) {
|
if(button>=4 && button<=7) {
|
||||||
if(pressed) {
|
if(pressed) {
|
||||||
@@ -489,6 +703,7 @@ end: pthread_mutex_unlock(&lock); return result;
|
|||||||
}
|
}
|
||||||
int uu_wl_key(uint64_t symbol,int pressed) {
|
int uu_wl_key(uint64_t symbol,int pressed) {
|
||||||
pthread_mutex_lock(&lock); int result=-1;
|
pthread_mutex_lock(&lock); int result=-1;
|
||||||
|
if(initialized && !keyboard) { pthread_mutex_unlock(&lock); return -1; } /* no virtual keyboard: caller falls back to uinput */
|
||||||
if(initialized) {
|
if(initialized) {
|
||||||
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
|
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
|
||||||
int matches=0;
|
int matches=0;
|
||||||
@@ -519,20 +734,24 @@ int uu_wl_release_all(void) {
|
|||||||
if(initialized) {
|
if(initialized) {
|
||||||
/* Sweep this client's virtual keyboard directly: a keysym lookup can
|
/* Sweep this client's virtual keyboard directly: a keysym lookup can
|
||||||
fail for unmapped OEM/keypad symbols before reaching held modifiers. */
|
fail for unmapped OEM/keypad symbols before reaching held modifiers. */
|
||||||
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
|
if(keyboard) {
|
||||||
if(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue;
|
for(xkb_keycode_t code=xkb_keymap_min_keycode(keymap);code<=xkb_keymap_max_keycode(keymap);code++) {
|
||||||
zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_RELEASED);
|
if(code<8 || code>=sizeof(held_keys) || !xkb_keymap_key_get_name(keymap,code)) continue;
|
||||||
if(held_keys[code]) xkb_state_update_key(key_state,code,XKB_KEY_UP);
|
zwp_virtual_keyboard_v1_key(keyboard,timestamp(),code-8,WL_KEYBOARD_KEY_STATE_RELEASED);
|
||||||
|
if(held_keys[code]) xkb_state_update_key(key_state,code,XKB_KEY_UP);
|
||||||
|
}
|
||||||
|
zwp_virtual_keyboard_v1_modifiers(keyboard,
|
||||||
|
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_DEPRESSED),
|
||||||
|
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LATCHED),
|
||||||
|
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LOCKED),
|
||||||
|
xkb_state_serialize_layout(key_state,XKB_STATE_LAYOUT_EFFECTIVE));
|
||||||
}
|
}
|
||||||
memset(held_keys,0,sizeof(held_keys));
|
memset(held_keys,0,sizeof(held_keys));
|
||||||
zwp_virtual_keyboard_v1_modifiers(keyboard,
|
if(pointer) {
|
||||||
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_DEPRESSED),
|
for(unsigned code=0x110;code<=0x114;code++)
|
||||||
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LATCHED),
|
zwlr_virtual_pointer_v1_button(pointer,timestamp(),code,WL_POINTER_BUTTON_STATE_RELEASED);
|
||||||
xkb_state_serialize_mods(key_state,XKB_STATE_MODS_LOCKED),
|
zwlr_virtual_pointer_v1_frame(pointer);
|
||||||
xkb_state_serialize_layout(key_state,XKB_STATE_LAYOUT_EFFECTIVE));
|
}
|
||||||
for(unsigned code=0x110;code<=0x114;code++)
|
|
||||||
zwlr_virtual_pointer_v1_button(pointer,timestamp(),code,WL_POINTER_BUTTON_STATE_RELEASED);
|
|
||||||
zwlr_virtual_pointer_v1_frame(pointer);
|
|
||||||
result=wl_display_flush(display)<0?-1:0;
|
result=wl_display_flush(display)<0?-1:0;
|
||||||
}
|
}
|
||||||
pthread_mutex_unlock(&lock);return result;
|
pthread_mutex_unlock(&lock);return result;
|
||||||
|
|||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
# Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop.
|
# Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop.
|
||||||
# Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary.
|
# Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary.
|
||||||
FROM ubuntu:24.04
|
FROM ubuntu:24.04
|
||||||
ARG VERSION=v0.2.10
|
ARG VERSION=v0.2.20
|
||||||
LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \
|
LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \
|
||||||
org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \
|
org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \
|
||||||
org.opencontainers.image.licenses="GPL-3.0"
|
org.opencontainers.image.licenses="GPL-3.0"
|
||||||
|
|||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
@@ -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.**
|
||||||
Executable
+67
@@ -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"
|
||||||
@@ -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
|
||||||
+1
-10
@@ -1,7 +1,6 @@
|
|||||||
//! Desktop sound for the viewer's 声音 menu: the default output's monitor (PulseAudio or
|
//! Desktop sound for the viewer's 声音 menu: the default output's monitor (PulseAudio or
|
||||||
//! PipeWire-pulse) is encoded to Opus and sent on the negotiated audio m-line.
|
//! PipeWire-pulse) is encoded to Opus and sent on the negotiated audio m-line.
|
||||||
//! Encoding runs in this process with the `inproc-av` feature (unless `UU_FFMPEG_ROOT` is set),
|
//! An FFmpeg child process does the encoding.
|
||||||
//! otherwise an FFmpeg child process does it.
|
|
||||||
//! PipeWire monitors ignore the sink's mute by default, so 被控端静音运行 keeps the stream audible.
|
//! PipeWire monitors ignore the sink's mute by default, so 被控端静音运行 keeps the stream audible.
|
||||||
//! `UU_AUDIO=0` disables it; `UU_AUDIO_SOURCE` picks another Pulse source.
|
//! `UU_AUDIO=0` disables it; `UU_AUDIO_SOURCE` picks another Pulse source.
|
||||||
|
|
||||||
@@ -57,14 +56,6 @@ fn read_packets(stdout: impl Read, tx: &tokio::sync::mpsc::Sender<bytes::Bytes>)
|
|||||||
fn start(source: &str, tx: tokio::sync::mpsc::Sender<bytes::Bytes>)
|
fn start(source: &str, tx: tokio::sync::mpsc::Sender<bytes::Bytes>)
|
||||||
-> Result<(Stopper, tokio::task::JoinHandle<Result<(), String>>), String> {
|
-> Result<(Stopper, tokio::task::JoinHandle<Result<(), String>>), String> {
|
||||||
let stop = Arc::new(AtomicBool::new(false));
|
let stop = Arc::new(AtomicBool::new(false));
|
||||||
#[cfg(feature = "inproc-av")]
|
|
||||||
if crate::inproc_encoder::selected() {
|
|
||||||
let job = tokio::task::spawn_blocking({
|
|
||||||
let (stop, source) = (stop.clone(), source.to_owned());
|
|
||||||
move || crate::inproc_encoder::run_audio(&source, tx, stop)
|
|
||||||
});
|
|
||||||
return Ok((Stopper { stop, child: None }, job));
|
|
||||||
}
|
|
||||||
let mut child = spawn_encoder(source)?;
|
let mut child = spawn_encoder(source)?;
|
||||||
let stdout = child.stdout.take().ok_or("Encoder stdout missing")?;
|
let stdout = child.stdout.take().ok_or("Encoder stdout missing")?;
|
||||||
let job = tokio::task::spawn_blocking(move || read_packets(stdout, &tx));
|
let job = tokio::task::spawn_blocking(move || read_packets(stdout, &tx));
|
||||||
|
|||||||
+43
-1
@@ -121,9 +121,24 @@ fn redact_urls(text: &str) -> String {
|
|||||||
out
|
out
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Cloud API clients ignore ambient HTTP/SOCKS 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 std::env::var("UU_USE_PROXY").ok().as_deref().is_some_and(proxy_requested) {
|
||||||
|
builder
|
||||||
|
} else {
|
||||||
|
builder.no_proxy()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fn proxy_requested(value: &str) -> bool {
|
||||||
|
matches!(value.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on")
|
||||||
|
}
|
||||||
|
|
||||||
impl UUAuthClient {
|
impl UUAuthClient {
|
||||||
pub fn new(creds: Credentials) -> Self {
|
pub fn new(creds: Credentials) -> Self {
|
||||||
let http = reqwest::Client::builder()
|
let http = http_client_builder()
|
||||||
.timeout(std::time::Duration::from_secs(12))
|
.timeout(std::time::Duration::from_secs(12))
|
||||||
.build()
|
.build()
|
||||||
.unwrap();
|
.unwrap();
|
||||||
@@ -236,6 +251,27 @@ impl UUAuthClient {
|
|||||||
Ok((status, value))
|
Ok((status, value))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Signed POST with an optional JSON body (None = empty body, like Moya `requestPlain`) and an
|
||||||
|
/// explicit timeout. The official clients long-poll the QR status with a 60 s request timeout.
|
||||||
|
pub async fn post_with_timeout(&self, path: &str, body: Option<&serde_json::Value>, timeout: std::time::Duration) -> Result<(u16, serde_json::Value), String> {
|
||||||
|
let body_str = body.map(serde_json::to_string).transpose().map_err(|e| e.to_string())?.unwrap_or_default();
|
||||||
|
let resp = self.http.post(format!("{}{}", BASE_URL, path)).timeout(timeout)
|
||||||
|
.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)))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 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.
|
/// Guest APIs use requestPlain for empty requests; sign the actual empty body.
|
||||||
/// Errors intentionally exclude response text and URL (both can contain secrets).
|
/// 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> {
|
pub async fn assist_post(&self, path: &str, body: Option<&serde_json::Value>) -> Result<(u16, serde_json::Value), String> {
|
||||||
@@ -346,4 +382,10 @@ mod guest_tests {
|
|||||||
let text = super::redact_urls("proxy http://user:[email protected]:3128 failed for (https://api.example/p?token=abc)");
|
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)");
|
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)); }
|
||||||
|
}
|
||||||
}
|
}
|
||||||
+4
-3
@@ -35,12 +35,13 @@ pub fn h264_device_capability(
|
|||||||
/// The payload sits under `data.device_capability` with `type` beside it. The earlier flat shape
|
/// The payload sits under `data.device_capability` with `type` beside it. The earlier flat shape
|
||||||
/// (`type` at the top, fields directly in `data`) was not recognised by the iPhone client, which
|
/// (`type` at the top, fields directly in `data`) was not recognised by the iPhone client, which
|
||||||
/// then kept quality and chroma locked at their defaults (#49). Only 8-bit and the chroma formats
|
/// then kept quality and chroma locked at their defaults (#49). Only 8-bit and the chroma formats
|
||||||
/// the encoder really produces are listed; the first entry carries the maximum size as officially.
|
/// the encoder really produces are listed, each with its maximum size: the official viewer treats a
|
||||||
|
/// 0x0 entry as unsupported (#77; the 4.37 host we copied had a GTX 660 without HEVC/4:4:4).
|
||||||
pub fn device_capability(client_id: &str, ice_id: &str, display_id: i32, fps: i32, codec_impl: i32, hevc: bool, full_chroma: bool) -> Value {
|
pub fn device_capability(client_id: &str, ice_id: &str, display_id: i32, fps: i32, codec_impl: i32, hevc: bool, full_chroma: bool) -> Value {
|
||||||
let mut codecs = Vec::new();
|
let mut codecs = Vec::new();
|
||||||
for codec in [VIDEO_CODEC_H264].into_iter().chain(hevc.then_some(2)) {
|
for codec in [VIDEO_CODEC_H264].into_iter().chain(hevc.then_some(2)) {
|
||||||
for chroma in [1].into_iter().chain(full_chroma.then_some(3)) {
|
for chroma in [1].into_iter().chain(full_chroma.then_some(3)) {
|
||||||
let (width, height) = if codecs.is_empty() { (3840, 2160) } else { (0, 0) };
|
let (width, height) = (3840, 2160);
|
||||||
codecs.push(json!({"video_codec": codec, "chroma_sampling": chroma, "codec_impl": codec_impl,
|
codecs.push(json!({"video_codec": codec, "chroma_sampling": chroma, "codec_impl": codec_impl,
|
||||||
"bit_depth": 8, "width": width, "height": height}));
|
"bit_depth": 8, "width": width, "height": height}));
|
||||||
}
|
}
|
||||||
@@ -86,7 +87,7 @@ mod tests {
|
|||||||
let caps = &payload["data"]["device_capability"]["video_codec_capability"];
|
let caps = &payload["data"]["device_capability"]["video_codec_capability"];
|
||||||
assert_eq!(caps.as_array().unwrap().len(), 4);
|
assert_eq!(caps.as_array().unwrap().len(), 4);
|
||||||
assert_eq!(caps[0], json!({"video_codec":1,"chroma_sampling":1,"codec_impl":5,"bit_depth":8,"width":3840,"height":2160}));
|
assert_eq!(caps[0], json!({"video_codec":1,"chroma_sampling":1,"codec_impl":5,"bit_depth":8,"width":3840,"height":2160}));
|
||||||
assert_eq!(caps[3], json!({"video_codec":2,"chroma_sampling":3,"codec_impl":5,"bit_depth":8,"width":0,"height":0}));
|
assert_eq!(caps[3], json!({"video_codec":2,"chroma_sampling":3,"codec_impl":5,"bit_depth":8,"width":3840,"height":2160}));
|
||||||
assert_eq!(payload["data"]["device_capability"]["display_info"][0]["hdr"], -1);
|
assert_eq!(payload["data"]["device_capability"]["display_info"][0]["hdr"], -1);
|
||||||
let h264_420 = device_capability("c", "i", 0, 60, 5, false, false);
|
let h264_420 = device_capability("c", "i", 0, 60, 5, false, false);
|
||||||
assert_eq!(h264_420["data"]["device_capability"]["video_codec_capability"].as_array().unwrap().len(), 1);
|
assert_eq!(h264_420["data"]["device_capability"]["video_codec_capability"].as_array().unwrap().len(), 1);
|
||||||
|
|||||||
+12
-4
@@ -46,14 +46,22 @@ unsafe fn x11_display_name() -> *const libc::c_char { b":0\0".as_ptr().cast() }
|
|||||||
|
|
||||||
/// The X11 root can be resized while the host runs (RandR, xrdp reconnects); the
|
/// The X11 root can be resized while the host runs (RandR, xrdp reconnects); the
|
||||||
/// geometry read at startup then makes x11grab reject every new connection.
|
/// geometry read at startup then makes x11grab reject every new connection.
|
||||||
pub fn x11_resized() -> bool {
|
/// Re-reads the root size; None when the X11 engine is not in use or the query fails.
|
||||||
|
pub fn x11_size() -> Option<(u32, u32)> {
|
||||||
match unsafe { x11_refresh_geometry() } {
|
match unsafe { x11_refresh_geometry() } {
|
||||||
1 => true,
|
0 | 1 => x11_last_size(),
|
||||||
0 => false,
|
-1 => None,
|
||||||
code => { log::warn!("X11 geometry query failed with code {code}"); false }
|
code => { log::warn!("X11 geometry query failed with code {code}"); None }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The root size from the last refresh, without an X round trip (pointer mapping).
|
||||||
|
pub fn x11_last_size() -> Option<(u32, u32)> {
|
||||||
|
let (mut w, mut h): (libc::c_int, libc::c_int) = (0, 0);
|
||||||
|
if unsafe { x11_get_dimensions(&mut w, &mut h) } != 0 || w <= 0 || h <= 0 { return None; }
|
||||||
|
Some((w as u32, h as u32))
|
||||||
|
}
|
||||||
|
|
||||||
pub struct ScreenCapture {
|
pub struct ScreenCapture {
|
||||||
pub backend: crate::desktop_backend::DesktopBackend,
|
pub backend: crate::desktop_backend::DesktopBackend,
|
||||||
pub init_error: Option<String>,
|
pub init_error: Option<String>,
|
||||||
|
|||||||
+133
-13
@@ -40,11 +40,13 @@ impl VideoCodec {
|
|||||||
|
|
||||||
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
pub struct VideoSettings {
|
pub struct VideoSettings {
|
||||||
|
pub source_id: usize,
|
||||||
|
pub source_generation: u64,
|
||||||
pub fps: u32,
|
pub fps: u32,
|
||||||
pub codec: VideoCodec,
|
pub codec: VideoCodec,
|
||||||
pub quality: u64,
|
pub quality: u64,
|
||||||
/// Viewer max_custom_bitrate (only used for QUALITY_CUSTOM): Mbit/s, or kbit/s above 1000.
|
/// Viewer max_custom_bitrate in bits/s (only used for QUALITY_CUSTOM).
|
||||||
pub custom_mbps: u32,
|
pub custom_bps: u32,
|
||||||
/// Scaled stream size (其他分辨率); None streams the native desktop size.
|
/// Scaled stream size (其他分辨率); None streams the native desktop size.
|
||||||
pub output: Option<(u32, u32)>,
|
pub output: Option<(u32, u32)>,
|
||||||
/// CHROMA_420 or CHROMA_444 (真彩); 4:4:4 only when the encoder pipeline supports it.
|
/// 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 {
|
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).
|
/// Selectable smaller stream sizes with the desktop's aspect ratio (even dimensions).
|
||||||
@@ -84,8 +86,8 @@ impl VideoSettings {
|
|||||||
QUALITY_GENERAL => Some(2_000),
|
QUALITY_GENERAL => Some(2_000),
|
||||||
QUALITY_HD => Some(8_000),
|
QUALITY_HD => Some(8_000),
|
||||||
QUALITY_BLURAY => Some(20_000),
|
QUALITY_BLURAY => Some(20_000),
|
||||||
QUALITY_CUSTOM if self.custom_mbps > 0 =>
|
QUALITY_CUSTOM if self.custom_bps > 0 =>
|
||||||
Some(if self.custom_mbps > 1_000 { self.custom_mbps } else { self.custom_mbps * 1_000 }.min(100_000)),
|
Some((self.custom_bps / 1_000).clamp(1, 100_000)),
|
||||||
_ => None,
|
_ => None,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -110,21 +112,50 @@ fn fps_from_option(value: u64) -> Option<u64> {
|
|||||||
|
|
||||||
/// Applies a capture-setting RPC to `settings` and returns the RpcResponse payload (Message 22),
|
/// 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.
|
/// 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
|
||||||
|
}
|
||||||
|
|
||||||
pub fn handle_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32)) -> Option<Vec<u8>> {
|
pub fn handle_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32)) -> Option<Vec<u8>> {
|
||||||
handle_rpc_with_codecs(rpc, settings, native, true, false)
|
handle_rpc_with_codecs(rpc, settings, native, true, false)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Initial codec once the m-line is negotiated: H.265 when both sides support it (the Mac viewer
|
/// 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.
|
||||||
pub fn preferred_codec(h264: bool, h265: bool) -> VideoCodec {
|
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"));
|
let forced = std::env::var("UU_VIDEO_CODEC").ok().map(|v| v.to_ascii_lowercase());
|
||||||
if h265 && !(forced_h264 && h264) { VideoCodec::H265 } else { VideoCodec::H264 }
|
pick_codec(h264, h265, forced.as_deref(), crate::video::Encoder::requested() != crate::video::Encoder::Cpu)
|
||||||
|
}
|
||||||
|
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 }
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn handle_rpc_with_codecs(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool) -> Option<Vec<u8>> {
|
pub fn handle_rpc_with_codecs(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool) -> Option<Vec<u8>> {
|
||||||
apply_rpc(rpc, settings, native, h264, h265, crate::video::full_chroma_available())
|
apply_rpc(rpc, settings, native, h264, h265, crate::video::full_chroma_available())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// 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) -> Option<Vec<u8>> {
|
fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native: (u32, u32), h264: bool, h265: bool, full_chroma: bool) -> Option<Vec<u8>> {
|
||||||
let header = message(rpc, 1).unwrap_or(&[]);
|
let header = message(rpc, 1).unwrap_or(&[]);
|
||||||
let mut next = *settings.borrow();
|
let mut next = *settings.borrow();
|
||||||
@@ -140,7 +171,7 @@ fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native:
|
|||||||
// Field 1 is the viewer's fps option index (1 = 30, 2 = 60, ...); 18 fpsCount is the frame rate.
|
// Field 1 is the viewer's fps option index (1 = 30, 2 = 60, ...); 18 fpsCount is the frame rate.
|
||||||
if let Some(fps) = number(&fields, 18).filter(|v| *v > 0).or_else(|| number(&fields, 1).and_then(fps_from_option)) { next.fps = fps as u32; }
|
if let Some(fps) = number(&fields, 18).filter(|v| *v > 0).or_else(|| number(&fields, 1).and_then(fps_from_option)) { next.fps = fps as u32; }
|
||||||
if let Some(quality) = number(&fields, 2).filter(|v| *v > 0) { next.quality = quality; }
|
if let Some(quality) = number(&fields, 2).filter(|v| *v > 0) { next.quality = quality; }
|
||||||
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.
|
// 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) {
|
match number(&fields, 7) {
|
||||||
Some(CHROMA_444) if full_chroma => next.chroma = CHROMA_444,
|
Some(CHROMA_444) if full_chroma => next.chroma = CHROMA_444,
|
||||||
@@ -180,9 +211,37 @@ fn apply_rpc(rpc: &[WireField], settings: &watch::Sender<VideoSettings>, native:
|
|||||||
Some(out)
|
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.
|
/// 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> {
|
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};
|
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 (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();
|
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.
|
// DPI_SCALE starts at version 5; the observed v4 request uses fields 5/6 as pixels.
|
||||||
@@ -201,7 +260,7 @@ pub fn sync_payload(settings: &VideoSettings, native: (u32, u32)) -> Vec<u8> {
|
|||||||
put_varint(1, u64::from(settings.fps), &mut out);
|
put_varint(1, u64::from(settings.fps), &mut out);
|
||||||
put_varint(2, settings.quality, &mut out);
|
put_varint(2, settings.quality, &mut out);
|
||||||
put_varint(3, settings.chroma, &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(5, u64::from(size.0), &mut out);
|
||||||
put_varint(6, u64::from(size.1), &mut out);
|
put_varint(6, u64::from(size.1), &mut out);
|
||||||
put_varint(9, u64::from(size.0), &mut out);
|
put_varint(9, u64::from(size.0), &mut out);
|
||||||
@@ -248,7 +307,7 @@ mod tests {
|
|||||||
put_varint(18, 30, &mut body);
|
put_varint(18, 30, &mut body);
|
||||||
let request = rpc(77, 2, &body);
|
let request = rpc(77, 2, &body);
|
||||||
let response = handle_rpc(&decode_wire(&request).unwrap(), &tx, (1920, 1080)).unwrap();
|
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));
|
assert_eq!(rx.borrow().max_kbps(), Some(2_000));
|
||||||
let fields = decode_wire(&response).unwrap();
|
let fields = decode_wire(&response).unwrap();
|
||||||
assert_eq!(message(&fields, 1), Some(&[8u8, 77][..]));
|
assert_eq!(message(&fields, 1), Some(&[8u8, 77][..]));
|
||||||
@@ -432,8 +491,40 @@ mod tests {
|
|||||||
#[test]
|
#[test]
|
||||||
fn auto_quality_keeps_constant_quality_encoding() {
|
fn auto_quality_keeps_constant_quality_encoding() {
|
||||||
assert_eq!(VideoSettings::default().max_kbps(), None);
|
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_bps: 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: 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]
|
#[test]
|
||||||
@@ -469,4 +560,33 @@ mod codec_tests {
|
|||||||
assert_eq!(rx.borrow().codec, VideoCodec::H265);
|
assert_eq!(rx.borrow().codec, VideoCodec::H265);
|
||||||
assert_eq!(preferred_codec(true, false), VideoCodec::H264);
|
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);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[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());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -70,6 +70,16 @@ impl DamageCapture {
|
|||||||
|
|
||||||
pub fn size(&self) -> (u32, u32) { (self.width as u32, self.height as u32) }
|
pub fn size(&self) -> (u32, u32) { (self.width as u32, self.height as u32) }
|
||||||
|
|
||||||
|
pub fn shm_raw_ptr(&self) -> *mut u8 { self.shm_ptr }
|
||||||
|
|
||||||
|
pub fn shm_size(&self) -> usize { self.len }
|
||||||
|
|
||||||
|
pub fn refresh(&mut self) -> Result<(), String> {
|
||||||
|
self.conn.shm_get_image(self.root, 0, 0, self.width, self.height, !0, Z_PIXMAP, self.seg, 0)
|
||||||
|
.map_err(text)?.reply().map_err(text)?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
/// Waits up to `timeout` for the screen to change. Returns `true` on change, `false` on timeout.
|
/// Waits up to `timeout` for the screen to change. Returns `true` on change, `false` on timeout.
|
||||||
pub fn wait(&mut self, timeout: Duration) -> Result<bool, String> {
|
pub fn wait(&mut self, timeout: Duration) -> Result<bool, String> {
|
||||||
let deadline = Instant::now() + timeout;
|
let deadline = Instant::now() + timeout;
|
||||||
|
|||||||
@@ -6,6 +6,16 @@ pub enum DesktopBackend { X11, Wayland, Portal, Kms }
|
|||||||
/// port mapping stay available (servers without a monitor or logged-in session).
|
/// 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") }
|
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> {
|
pub fn detect() -> Result<DesktopBackend, String> {
|
||||||
let backend=select(std::env::var("UU_DESKTOP_BACKEND").ok().as_deref(),
|
let backend=select(std::env::var("UU_DESKTOP_BACKEND").ok().as_deref(),
|
||||||
std::env::var("XDG_SESSION_TYPE").ok().as_deref(),
|
std::env::var("XDG_SESSION_TYPE").ok().as_deref(),
|
||||||
|
|||||||
@@ -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
@@ -4,10 +4,11 @@
|
|||||||
mod native {
|
mod native {
|
||||||
use std::{ffi::c_void, ptr::NonNull};
|
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_power_wake() -> i32;
|
||||||
fn uu_desktop_idle_inhibitor_acquire(error: *mut i32) -> *mut c_void;
|
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_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>);
|
pub struct Handle(NonNull<c_void>);
|
||||||
@@ -16,9 +17,9 @@ mod native {
|
|||||||
unsafe impl Send for Handle {}
|
unsafe impl Send for Handle {}
|
||||||
|
|
||||||
impl Handle {
|
impl Handle {
|
||||||
pub fn acquire() -> Result<Self, String> {
|
pub fn acquire(gnome: bool) -> Result<Self, String> {
|
||||||
let mut error = 0;
|
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))
|
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
|
/// 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
|
/// bounded to three seconds. Callers on an async runtime should move both operations to a
|
||||||
@@ -62,7 +65,8 @@ pub struct IdleInhibitor {
|
|||||||
|
|
||||||
impl IdleInhibitor {
|
impl IdleInhibitor {
|
||||||
pub fn acquire() -> Result<Self, String> {
|
pub fn acquire() -> Result<Self, String> {
|
||||||
if !gnome_portal_active() {
|
let kde = portal_desktop_is("kde");
|
||||||
|
if !gnome_portal_active() && !kde {
|
||||||
return Ok(Self {
|
return Ok(Self {
|
||||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
_handle: None,
|
_handle: None,
|
||||||
@@ -70,7 +74,7 @@ impl IdleInhibitor {
|
|||||||
}
|
}
|
||||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
#[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")))]
|
#[cfg(not(all(target_os = "linux", feature = "portal")))]
|
||||||
{
|
{
|
||||||
@@ -79,10 +83,12 @@ impl IdleInhibitor {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn gnome_portal_active() -> bool {
|
fn gnome_portal_active() -> bool { portal_desktop_is("gnome") }
|
||||||
let gnome = std::env::var("XDG_CURRENT_DESKTOP").unwrap_or_default().split(':')
|
|
||||||
.any(|desktop| desktop.eq_ignore_ascii_case("gnome"));
|
fn portal_desktop_is(name: &str) -> bool {
|
||||||
gnome && crate::desktop_backend::detect().is_ok_and(|backend| backend == crate::desktop_backend::DesktopBackend::Portal)
|
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"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
|
|||||||
+165
@@ -0,0 +1,165 @@
|
|||||||
|
//! `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 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 encoder = crate::video::Encoder::requested();
|
||||||
|
line("encoder", format!("{encoder:?} (UU_VIDEO_ENCODER={})", std::env::var("UU_VIDEO_ENCODER").unwrap_or_else(|_| "auto".into())));
|
||||||
|
line("default codec", format!("{:?}", crate::capture_setting::preferred_codec(true, true)));
|
||||||
|
let mut ffmpeg = crate::video::ffmpeg_command();
|
||||||
|
ffmpeg.args(["-hide_banner", "-encoders"]).kill_on_drop(true);
|
||||||
|
match tokio::time::timeout(std::time::Duration::from_secs(5), ffmpeg.output()).await {
|
||||||
|
Ok(Ok(output)) => {
|
||||||
|
let text = String::from_utf8_lossy(&output.stdout);
|
||||||
|
let found: Vec<&str> = ["libx264", "libx265", "h264_nvenc", "hevc_nvenc", "h264_vaapi", "hevc_vaapi"].into_iter()
|
||||||
|
.filter(|name| text.split_whitespace().any(|word| word == *name)).collect();
|
||||||
|
line("ffmpeg encoders", if found.is_empty() { "none of libx264/libx265/nvenc/vaapi".to_owned() } else { found.join(", ") });
|
||||||
|
}
|
||||||
|
_ => 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 = command_output("pgrep", &["-c", "-x", "uuremote-server"]).await.filter(|n| !n.is_empty()).unwrap_or_else(|| "unknown".into());
|
||||||
|
line("uuremote-server procs", format!("{running} (including this one; more than 2 means duplicates)"));
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[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));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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
@@ -77,8 +77,8 @@ pub struct Screen<'a> {
|
|||||||
}
|
}
|
||||||
impl Screen<'_> {
|
impl Screen<'_> {
|
||||||
fn encode(&self) -> Result<Vec<u8>, String> {
|
fn encode(&self) -> Result<Vec<u8>, String> {
|
||||||
if self.id < 0 || self.fps <= 0 || self.video_track_index < 0 {
|
if self.id < 0 || self.fps <= 0 || self.video_track_index < -1 {
|
||||||
return Err("Screen id/track must be nonnegative and fps positive".into());
|
return Err("Screen id must be nonnegative, track >= -1 and fps positive".into());
|
||||||
}
|
}
|
||||||
if !self.dpr.is_finite() || self.dpr <= 0.0 {
|
if !self.dpr.is_finite() || self.dpr <= 0.0 {
|
||||||
return Err("Screen dpr must be positive and finite".into());
|
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 tracks = std::collections::HashSet::new();
|
||||||
let mut payload = Vec::new();
|
let mut payload = Vec::new();
|
||||||
for screen in screens {
|
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());
|
return Err("Screen ids and video track indices must be unique".into());
|
||||||
}
|
}
|
||||||
bytes(1, &screen.encode()?, &mut payload);
|
bytes(1, &screen.encode()?, &mut payload);
|
||||||
@@ -295,3 +295,14 @@ mod tests {
|
|||||||
assert!(encode_capture_change(1, 2, 4, 1, "").is_err());
|
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
File diff suppressed because it is too large.
Load diff
+76
-1
@@ -325,6 +325,15 @@ impl InputInjector {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
fn inject_move(&self,x:i32,y:i32,relative:bool)->i32 {
|
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; }
|
||||||
|
}
|
||||||
if let Some(uinput)=&self.uinput {
|
if let Some(uinput)=&self.uinput {
|
||||||
if relative { return Self::uinput_result(uinput.move_relative(x,y)); }
|
if relative { return Self::uinput_result(uinput.move_relative(x,y)); }
|
||||||
let (w,h)=*self.screen.lock().unwrap();
|
let (w,h)=*self.screen.lock().unwrap();
|
||||||
@@ -360,13 +369,27 @@ impl InputInjector {
|
|||||||
if self.backend==crate::desktop_backend::DesktopBackend::Wayland { crate::wayland::key(symbol,pressed) }
|
if self.backend==crate::desktop_backend::DesktopBackend::Wayland { crate::wayland::key(symbol,pressed) }
|
||||||
else { unsafe { x11_key_symbol(symbol as libc::c_ulong,i32::from(pressed)) } }
|
else { unsafe { x11_key_symbol(symbol as libc::c_ulong,i32::from(pressed)) } }
|
||||||
}
|
}
|
||||||
/// Mobile input-method text (`text_input`). X11 only for now; other backends log once.
|
/// Mobile input-method text (`text_input`). X11 types it directly; Wayland re-maps a spare
|
||||||
|
/// keycode in the virtual keyboard's keymap. Other backends log once.
|
||||||
pub fn text_input(&self, text: &str) {
|
pub fn text_input(&self, text: &str) {
|
||||||
let _serial=self.serial.lock().unwrap();
|
let _serial=self.serial.lock().unwrap();
|
||||||
let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return };
|
let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return };
|
||||||
if self.backend==crate::desktop_backend::DesktopBackend::X11 {
|
if self.backend==crate::desktop_backend::DesktopBackend::X11 {
|
||||||
let typed=unsafe { x11_type_utf8(c_text.as_ptr()) };
|
let typed=unsafe { x11_type_utf8(c_text.as_ptr()) };
|
||||||
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
|
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
|
||||||
|
} else if self.backend==crate::desktop_backend::DesktopBackend::Wayland {
|
||||||
|
// Escape hatch: keep the old behaviour 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;
|
||||||
|
}
|
||||||
|
// A keymap whose keycodes are all mapped cannot carry text; report it once.
|
||||||
|
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 (no spare keycode in this keymap)");
|
||||||
|
}
|
||||||
} else {
|
} else {
|
||||||
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
|
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
|
||||||
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
|
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
|
||||||
@@ -625,3 +648,55 @@ mod lifecycle_tests {
|
|||||||
session.with_input(||panic!("late event after disconnect"));
|
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));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+65
-33
@@ -268,13 +268,22 @@ pub async fn prepare_device() -> Result<(Value, Credentials), String> {
|
|||||||
pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
|
pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
|
||||||
let (mut cfg, creds) = prepare_device().await?;
|
let (mut cfg, creds) = prepare_device().await?;
|
||||||
let client = UUAuthClient::new(creds.clone());
|
let client = UUAuthClient::new(creds.clone());
|
||||||
|
// Mirrors the official Mac client (LoginViewController / LoginManager, UURemote 4.42): gen/login has
|
||||||
|
// no body; the status long poll sends gen's `status_query_ticket` under `token` with the last
|
||||||
|
// status, re-asks as soon as an answer arrives (60 s request timeout), regenerates on status 3
|
||||||
|
// at once and on status 0 after 0.35 s, logs in on 4, and on any error (e.g. HTTP 400 code 1190)
|
||||||
|
// stops until the user asks for a new QR. Sending gen's older `token` field made the cloud reject
|
||||||
|
// every QR within seconds (#68).
|
||||||
|
let timeout = Duration::from_secs(60);
|
||||||
loop {
|
loop {
|
||||||
let (status, resp) = client.post_json("/api/v1/qrcode/gen/login", &json!({})).await?;
|
let (status, resp) = client.post_with_timeout("/api/v1/qrcode/gen/login", None, timeout).await?;
|
||||||
let d = data("qrcode gen", status, &resp)?;
|
let d = match data("qrcode gen", status, &resp) {
|
||||||
|
Ok(d) => d.clone(),
|
||||||
|
Err(e) => { println!("QR code could not be loaded ({e})"); wait_for_refresh(ui, "二维码加载失败").await; continue; }
|
||||||
|
};
|
||||||
let url = d.get("qrcode_jump_url").and_then(|v| v.as_str()).ok_or("qrcode gen returned no qrcode_jump_url")?.to_string();
|
let url = d.get("qrcode_jump_url").and_then(|v| v.as_str()).ok_or("qrcode gen returned no qrcode_jump_url")?.to_string();
|
||||||
let ticket = d.get("token").or_else(|| d.get("status_query_ticket")).and_then(|v| v.as_str())
|
let ticket = qr_ticket(&d).ok_or("qrcode gen returned no status ticket")?.to_string();
|
||||||
.ok_or("qrcode gen returned no token")?.to_string();
|
ui.offer_refresh(false);
|
||||||
if ui.shown() {
|
if ui.shown() {
|
||||||
let modules = qrcode::QrCode::new(url.as_bytes()).map_err(|e| e.to_string())?.width() + 2;
|
let modules = qrcode::QrCode::new(url.as_bytes()).map_err(|e| e.to_string())?.width() + 2;
|
||||||
let (rgba, edge) = qr_rgba(&url, (224 / modules).max(2), 1)?;
|
let (rgba, edge) = qr_rgba(&url, (224 / modules).max(2), 1)?;
|
||||||
@@ -289,40 +298,31 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
|
|||||||
file.write_all(&crate::cursor::encode_png(edge as u32,edge as u32,&rgba)).map_err(|e|e.to_string())?;
|
file.write_all(&crate::cursor::encode_png(edge as u32,edge as u32,&rgba)).map_err(|e|e.to_string())?;
|
||||||
}
|
}
|
||||||
if !ui.quiet() { println!("\nScan with the UU Remote mobile app (网易UU远程 App 扫码登录):\n{}", render_qr(&url)?); }
|
if !ui.quiet() { println!("\nScan with the UU Remote mobile app (网易UU远程 App 扫码登录):\n{}", render_qr(&url)?); }
|
||||||
// Status is a long poll: send the state already shown (server enum 1..4; observed:
|
|
||||||
// 1 waiting, 2 scanned, 4 after the phone confirmed); the server answers when it changes.
|
|
||||||
let mut login_status = 1i64;
|
let mut login_status = 1i64;
|
||||||
let mut expired = false;
|
let failure = loop {
|
||||||
for _ in 0..150 {
|
|
||||||
let query = json!({"token": ticket, "qrcode_jump_url": url, "login_status": login_status});
|
let query = json!({"token": ticket, "qrcode_jump_url": url, "login_status": login_status});
|
||||||
let (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,
|
Ok(r) => r,
|
||||||
Err(_) => continue, // long-poll timeout: ask again
|
Err(_) => break "网络超时,二维码已停止刷新",
|
||||||
};
|
};
|
||||||
// Code 1190 (HTTP 400, "二维码已失效"): the QR expired; generate a new one.
|
let code = resp.get("code").and_then(|c| c.as_i64());
|
||||||
if resp.get("code").and_then(|c| c.as_i64()) == Some(QR_EXPIRED) {
|
if code == Some(QR_EXPIRED) { break "二维码已失效"; }
|
||||||
ui.status("二维码已过期,正在刷新…", Tone::Info);
|
let Ok(d) = data("qrcode status", status, &resp) else { break "二维码状态查询失败"; };
|
||||||
expired = true; break;
|
let st = d.get("status").and_then(|v| v.as_i64()).unwrap_or(login_status);
|
||||||
}
|
|
||||||
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 {
|
match st {
|
||||||
2 => {
|
1 => {}
|
||||||
|
2 => if login_status != 2 {
|
||||||
println!("已扫码,请在手机上确认 (scanned, confirm on the phone)");
|
println!("已扫码,请在手机上确认 (scanned, confirm on the phone)");
|
||||||
ui.status("已扫码,请在手机上确认登录", Tone::Ok);
|
ui.status("已扫码,请在手机上确认登录", Tone::Ok);
|
||||||
}
|
},
|
||||||
3 | 4 => {
|
3 => { println!("QR code expired; generating a new one"); break ""; }
|
||||||
// A final state: confirmed logs in; cancelled/expired is refused and a new QR follows.
|
0 => { tokio::time::sleep(Duration::from_millis(350)).await; break ""; }
|
||||||
|
4 => {
|
||||||
let body = json!({"token": ticket, "qrcode_jump_url": url});
|
let body = json!({"token": ticket, "qrcode_jump_url": url});
|
||||||
let (status, resp) = client.post_json("/api/v1/login/by_qrcode", &body).await?;
|
let (status, resp) = client.post_with_timeout("/api/v1/login/by_qrcode", Some(&body), timeout).await?;
|
||||||
let d = match data("qrcode login", status, &resp) {
|
let d = match data("qrcode login", status, &resp) {
|
||||||
Ok(d) => d,
|
Ok(d) => d,
|
||||||
Err(e) => {
|
Err(e) => { println!("QR login not granted ({e})"); break "登录失败"; }
|
||||||
println!("QR status {st}: login not granted ({e})");
|
|
||||||
ui.status("手机端未确认登录,正在刷新二维码…", Tone::Error);
|
|
||||||
expired = true; break;
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
let token = d.get("token").and_then(|v| v.as_str()).ok_or("login returned no token")?;
|
let token = d.get("token").and_then(|v| v.as_str()).ok_or("login returned no token")?;
|
||||||
let user = d.get("user_id").and_then(|v| v.as_str()).ok_or("login returned no user_id")?;
|
let user = d.get("user_id").and_then(|v| v.as_str()).ok_or("login returned no user_id")?;
|
||||||
@@ -339,17 +339,49 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
|
|||||||
println!("Logged in as {} ({}); saved to {}", nickname, user, path.display());
|
println!("Logged in as {} ({}); saved to {}", nickname, user, path.display());
|
||||||
return Ok(if nickname.is_empty() { user.to_string() } else { nickname.to_string() });
|
return Ok(if nickname.is_empty() { user.to_string() } else { nickname.to_string() });
|
||||||
}
|
}
|
||||||
_ => { println!("QR status: {st}"); ui.status("二维码已失效,正在刷新…", Tone::Error); expired = true; break; }
|
other => { println!("QR status: {other}"); break "二维码已失效"; }
|
||||||
}
|
}
|
||||||
}
|
login_status = st;
|
||||||
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)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
#[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);
|
||||||
|
}
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn service_waits_until_a_new_token_is_saved() {
|
async fn service_waits_until_a_new_token_is_saved() {
|
||||||
let dir = std::env::temp_dir().join(format!("uu-login-wait-{}", std::process::id()));
|
let dir = std::env::temp_dir().join(format!("uu-login-wait-{}", std::process::id()));
|
||||||
|
|||||||
@@ -10,6 +10,8 @@ extern "C" {
|
|||||||
fn uu_login_ui_set_done(text: *const libc::c_char);
|
fn uu_login_ui_set_done(text: *const libc::c_char);
|
||||||
fn uu_login_ui_closed() -> libc::c_int;
|
fn uu_login_ui_closed() -> libc::c_int;
|
||||||
fn uu_login_ui_close();
|
fn uu_login_ui_close();
|
||||||
|
fn uu_login_ui_offer_refresh(visible: libc::c_int);
|
||||||
|
fn uu_login_ui_take_refresh() -> libc::c_int;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Clone, Copy)]
|
#[derive(Clone, Copy)]
|
||||||
@@ -56,6 +58,19 @@ impl LoginUi {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[allow(unused_variables)]
|
#[allow(unused_variables)]
|
||||||
|
/// Show or hide the 刷新二维码 button (a failed QR waits for the user, like the official client).
|
||||||
|
pub fn offer_refresh(&self, visible: bool) {
|
||||||
|
#[cfg(uu_gtk)]
|
||||||
|
if self.shown { unsafe { uu_login_ui_offer_refresh(libc::c_int::from(visible)) } }
|
||||||
|
#[cfg(not(uu_gtk))]
|
||||||
|
let _ = visible;
|
||||||
|
}
|
||||||
|
/// The user clicked 刷新二维码 since the last call.
|
||||||
|
pub fn take_refresh(&self) -> bool {
|
||||||
|
#[cfg(uu_gtk)]
|
||||||
|
if self.shown { return unsafe { uu_login_ui_take_refresh() } != 0; }
|
||||||
|
false
|
||||||
|
}
|
||||||
pub fn status(&self, text: &str, tone: Tone) {
|
pub fn status(&self, text: &str, tone: Tone) {
|
||||||
#[cfg(uu_gtk)]
|
#[cfg(uu_gtk)]
|
||||||
if self.shown { let t = cstr(text); unsafe { uu_login_ui_set_status(t.as_ptr(), tone as libc::c_int) } }
|
if self.shown { let t = cstr(text); unsafe { uu_login_ui_set_status(t.as_ptr(), tone as libc::c_int) } }
|
||||||
|
|||||||
+75
-6
@@ -1,7 +1,11 @@
|
|||||||
//! UU Remote Pure Native Linux Server (Rust Edition)
|
//! UU Remote Pure Native Linux Server (Rust Edition)
|
||||||
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
|
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
|
||||||
|
|
||||||
|
mod engine_plugin;
|
||||||
|
mod doctor;
|
||||||
|
mod wol;
|
||||||
mod desktop_backend;
|
mod desktop_backend;
|
||||||
|
mod desktop_mode;
|
||||||
mod desktop_session;
|
mod desktop_session;
|
||||||
mod desktop_power;
|
mod desktop_power;
|
||||||
mod portal;
|
mod portal;
|
||||||
@@ -140,6 +144,35 @@ fn write_host_pid() {
|
|||||||
let _ = write!(f, "{}", std::process::id());
|
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
|
/// `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).
|
/// foreground with its window when none runs (e.g. no systemd unit installed yet).
|
||||||
fn show_running_host() -> Result<(), Box<dyn std::error::Error>> {
|
fn show_running_host() -> Result<(), Box<dyn std::error::Error>> {
|
||||||
@@ -159,7 +192,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());
|
.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()) {
|
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();
|
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));
|
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 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());
|
let pid = std::fs::read_to_string(host_pid_path()).ok().and_then(|s| s.trim().parse::<i32>().ok());
|
||||||
@@ -168,7 +204,7 @@ fn show_running_host() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
if unsafe { libc::kill(pid, libc::SIGUSR1) } == 0 { return Ok(()); }
|
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;
|
use std::os::unix::process::CommandExt;
|
||||||
Err(Box::new(std::process::Command::new("/proc/self/exe").env("UU_SHOW_WINDOW", "1").exec()))
|
Err(Box::new(std::process::Command::new("/proc/self/exe").env("UU_SHOW_WINDOW", "1").exec()))
|
||||||
@@ -190,8 +226,8 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
.filter_module("uuremote_server", log::LevelFilter::Info).init();
|
.filter_module("uuremote_server", log::LevelFilter::Info).init();
|
||||||
} else { env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); }
|
} else { env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init(); }
|
||||||
// An unknown argument must never fall through to starting a second full host server.
|
// An unknown argument must never fall through to starting a second full host server.
|
||||||
const SUBCOMMANDS: [&str; 13] = ["show", "assist", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture",
|
const SUBCOMMANDS: [&str; 15] = ["doctor", "show", "assist", "desktop-input-probe", "virtual-audio-probe", "login", "unlock-check", "desktop-probe", "desktop-video-probe", "desktop-audio-probe", "wayland-capture",
|
||||||
"wayland-input-probe", "clipboard-acceptance", "portal-acceptance"];
|
"wayland-input-probe", "wayland-text-probe", "clipboard-acceptance", "portal-acceptance"];
|
||||||
if let Some(arg) = std::env::args().nth(1).filter(|a| !SUBCOMMANDS.contains(&a.as_str())) {
|
if let Some(arg) = std::env::args().nth(1).filter(|a| !SUBCOMMANDS.contains(&a.as_str())) {
|
||||||
let usage = format!("usage: uuremote-server [{}]\n (no argument: run the host)", SUBCOMMANDS.join(" | "));
|
let usage = format!("usage: uuremote-server [{}]\n (no argument: run the host)", SUBCOMMANDS.join(" | "));
|
||||||
if matches!(arg.as_str(), "help" | "-h" | "--help") { println!("{usage}"); return Ok(()); }
|
if matches!(arg.as_str(), "help" | "-h" | "--help") { println!("{usage}"); return Ok(()); }
|
||||||
@@ -353,6 +389,12 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
if std::env::args().nth(1).as_deref() == Some("wayland-input-probe") {
|
if std::env::args().nth(1).as_deref() == Some("wayland-input-probe") {
|
||||||
return wayland::input_probe().map_err(|e|e.into());
|
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") {
|
if std::env::args().nth(1).as_deref() == Some("wayland-capture") {
|
||||||
return wayland::capture_stdout().map_err(|e| e.into());
|
return wayland::capture_stdout().map_err(|e| e.into());
|
||||||
}
|
}
|
||||||
@@ -406,10 +448,16 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
|
|||||||
let _audio_cleanup=virtual_audio::Cleanup;
|
let _audio_cleanup=virtual_audio::Cleanup;
|
||||||
log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION"));
|
log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION"));
|
||||||
|
|
||||||
|
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() {
|
let capture = Arc::new((if desktop_backend::headless() {
|
||||||
Err("headless mode (UU_DESKTOP_BACKEND=none)".to_owned())
|
Err("headless mode (UU_DESKTOP_BACKEND=none)".to_owned())
|
||||||
} else if desktop_backend::detect()?==desktop_backend::DesktopBackend::Portal {
|
} 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| {
|
} else { ScreenCapture::new() }).unwrap_or_else(|error| {
|
||||||
log::warn!("Desktop unavailable; terminal and file tools remain available: {error}");
|
log::warn!("Desktop unavailable; terminal and file tools remain available: {error}");
|
||||||
ScreenCapture::unavailable(error)
|
ScreenCapture::unavailable(error)
|
||||||
@@ -635,6 +683,11 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
|||||||
}
|
}
|
||||||
SignalingEvent::Connected => {
|
SignalingEvent::Connected => {
|
||||||
log::info!("Signaling handshake established.");
|
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::RoomInfoAck(_) => { log::info!("RoomInfo acknowledged by NetEase server"); }
|
||||||
SignalingEvent::DeviceInfoChanged(val) => {
|
SignalingEvent::DeviceInfoChanged(val) => {
|
||||||
@@ -644,6 +697,21 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
|||||||
log::debug!("Assist bmsg_push shape: type={:?} keys={:?} data_keys={:?}",
|
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")));
|
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 val.get("type").and_then(serde_json::Value::as_str) == Some("get_control_mode") {
|
||||||
if let Some(s) = assist.as_mut() {
|
if let Some(s) = assist.as_mut() {
|
||||||
match s.control_mode(val.get("data").unwrap_or(&serde_json::Value::Null)).await {
|
match s.control_mode(val.get("data").unwrap_or(&serde_json::Value::Null)).await {
|
||||||
@@ -717,7 +785,8 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
let resized=desktop && capture.init_error.is_none() && capture.backend==desktop_backend::DesktopBackend::X11
|
let resized=desktop && capture.init_error.is_none() && capture.backend==desktop_backend::DesktopBackend::X11
|
||||||
&& tokio::task::spawn_blocking(crate::capture::x11_resized).await.unwrap_or(false);
|
// Compare with this capture, not the engine: a live stream may already have refreshed it.
|
||||||
|
&& tokio::task::spawn_blocking(crate::capture::x11_size).await.ok().flatten().is_some_and(|size| size!=(capture.width,capture.height));
|
||||||
if resized { log::info!("Desktop geometry changed since startup; reinitializing capture"); }
|
if resized { log::info!("Desktop geometry changed since startup; reinitializing capture"); }
|
||||||
let session_capture=if desktop && portal_desktop.is_none() && (capture.init_error.is_some() || resized) {
|
let session_capture=if desktop && portal_desktop.is_none() && (capture.init_error.is_some() || resized) {
|
||||||
match tokio::task::spawn_blocking(ScreenCapture::new).await {
|
match tokio::task::spawn_blocking(ScreenCapture::new).await {
|
||||||
|
|||||||
+20
-9
@@ -22,7 +22,7 @@ mod permissions;
|
|||||||
#[cfg(all(target_os = "linux", feature = "portal"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
mod native {
|
mod native {
|
||||||
use std::{ffi::c_void, ptr::NonNull, sync::{Mutex, MutexGuard, TryLockError}};
|
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(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_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;
|
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)) {
|
if cancelled.is_some_and(|value| value.load(std::sync::atomic::Ordering::Acquire)) {
|
||||||
return Err(super::PortalError { code: 13 });
|
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 (mut error, mut width, mut height) = (0, 0, 0);
|
||||||
let directory = super::permissions::directory();
|
let directory = super::permissions::directory();
|
||||||
let key = super::permissions::desktop_key();
|
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",
|
8 => "unsupported frame format or size", 9 => "session closed or stream lost",
|
||||||
10 => "frame unavailable", 11 => "invalid input or frame buffer",
|
10 => "frame unavailable", 11 => "invalid input or frame buffer",
|
||||||
13 => "operation cancelled", 14 => "dimensions changed; reconnect required",
|
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",
|
_ => "operation failed",
|
||||||
};
|
};
|
||||||
format!("Portal {reason} (code {code})")
|
format!("Portal {reason} (code {code})")
|
||||||
}
|
}
|
||||||
fn check(code: i32) -> Result<(), String> { if code == 0 { Ok(()) } else { Err(error(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"))]
|
#[cfg(all(target_os = "linux", feature = "portal"))]
|
||||||
pub use native::Session as PortalSession;
|
pub use native::Session as PortalSession;
|
||||||
#[cfg(not(all(target_os = "linux", feature = "portal")))]
|
#[cfg(not(all(target_os = "linux", feature = "portal")))]
|
||||||
@@ -598,24 +608,24 @@ pub struct PortalSession { pub width: u32, pub height: u32 }
|
|||||||
impl PortalSession {
|
impl PortalSession {
|
||||||
pub fn clipboard_supported(&self) -> bool { false }
|
pub fn clipboard_supported(&self) -> bool { false }
|
||||||
pub fn clipboard_ready(&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 clipboard_poll(&self) -> Option<String> { None }
|
||||||
pub fn is_alive(&self) -> bool { false }
|
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() -> Result<Self, String> { Err("Portal backend requires Linux and --features portal".into()) }
|
||||||
pub fn open_cancellable(cancelled: &std::sync::atomic::AtomicBool) -> Result<Self, PortalError> {
|
pub fn open_cancellable(cancelled: &std::sync::atomic::AtomicBool) -> Result<Self, PortalError> {
|
||||||
if cancelled.load(std::sync::atomic::Ordering::Acquire) { Err(PortalError { code: 13 }) }
|
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> {
|
pub fn recover(&self, cancelled: &std::sync::atomic::AtomicBool) -> Result<bool, PortalError> {
|
||||||
if cancelled.load(std::sync::atomic::Ordering::Acquire) { Err(PortalError { code: 13 }) }
|
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 pause(&self) {}
|
||||||
pub fn capture(&self, _: &mut [u8]) -> 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(2)) }
|
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(2)) }
|
pub fn move_pointer(&self, _: f64, _: f64, _: bool) -> Result<(), String> { Err(error(15)) }
|
||||||
pub fn button(&self, _: i32, _: bool) -> Result<(), String> { Err(error(2)) }
|
pub fn button(&self, _: i32, _: bool) -> Result<(), String> { Err(error(15)) }
|
||||||
pub fn key(&self, _: u64, _: bool) -> Result<(), String> { Err(error(2)) }
|
pub fn key(&self, _: u64, _: bool) -> Result<(), String> { Err(error(15)) }
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Forward frames in-process into encoder stdin. Cancellation drops the Arc;
|
/// 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() {
|
fn errors_never_include_remote_messages_or_identifiers() {
|
||||||
assert!(super::check(4).unwrap_err().contains("cancelled or denied"));
|
assert!(super::check(4).unwrap_err().contains("cancelled or denied"));
|
||||||
assert!(super::check(9).unwrap_err().contains("closed or stream lost"));
|
assert!(super::check(9).unwrap_err().contains("closed or stream lost"));
|
||||||
|
assert!(super::check(15).unwrap_err().contains("--features wayland,portal"));
|
||||||
}
|
}
|
||||||
#[test]
|
#[test]
|
||||||
fn portal_error_display_is_fixed_and_sanitized() {
|
fn portal_error_display_is_fixed_and_sanitized() {
|
||||||
|
|||||||
@@ -92,6 +92,8 @@ pub fn watch_locked() -> watch::Receiver<Option<bool>> {
|
|||||||
if locked.is_none() { session = None; } // session ended or changed: look it up again
|
if locked.is_none() { session = None; } // session ended or changed: look it up again
|
||||||
sender.send_if_modified(|current| if *current != locked {
|
sender.send_if_modified(|current| if *current != locked {
|
||||||
log::info!("Desktop lock state: {}", match locked { Some(true) => "locked", Some(false) => "unlocked", None => "unknown" });
|
log::info!("Desktop lock state: {}", match locked { Some(true) => "locked", Some(false) => "unlocked", None => "unknown" });
|
||||||
|
// The viewer only sees black frames while locked and gives no hint (#61).
|
||||||
|
if locked == Some(true) { log::info!("Desktop is locked: viewers see a black screen until it is unlocked (viewer 自动解锁被控端, or `loginctl unlock-session` on the host)"); }
|
||||||
*current = locked; true
|
*current = locked; true
|
||||||
} else { false });
|
} else { false });
|
||||||
std::thread::sleep(Duration::from_secs(1));
|
std::thread::sleep(Duration::from_secs(1));
|
||||||
|
|||||||
+146
-29
@@ -160,6 +160,8 @@ fn is_independent_frame(bytes: &[u8]) -> bool { is_independent_frame_for(bytes,
|
|||||||
|
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
struct CompleteFrame {
|
struct CompleteFrame {
|
||||||
|
source_id: usize,
|
||||||
|
source_generation: u64,
|
||||||
codec: VideoCodec,
|
codec: VideoCodec,
|
||||||
sequence: u64,
|
sequence: u64,
|
||||||
completed_at: Instant,
|
completed_at: Instant,
|
||||||
@@ -167,6 +169,12 @@ struct CompleteFrame {
|
|||||||
_permit: Option<OwnedSemaphorePermit>,
|
_permit: Option<OwnedSemaphorePermit>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl CompleteFrame {
|
||||||
|
fn matches(&self,settings:&VideoSettings)->bool {
|
||||||
|
self.codec==settings.codec && self.source_id==settings.source_id && self.source_generation==settings.source_generation
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const RTP_CLOCK: u64 = 90_000;
|
const RTP_CLOCK: u64 = 90_000;
|
||||||
|
|
||||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||||
@@ -190,11 +198,9 @@ impl Encoder {
|
|||||||
fn nvidia_present() -> bool {
|
fn nvidia_present() -> bool {
|
||||||
std::path::Path::new("/proc/driver/nvidia/version").exists() || std::path::Path::new("/dev/nvidia0").exists()
|
std::path::Path::new("/proc/driver/nvidia/version").exists() || std::path::Path::new("/dev/nvidia0").exists()
|
||||||
}
|
}
|
||||||
/// 真彩 (4:4:4) needs the FFmpeg process pipeline with NVENC or libx264 (h264_vaapi and the
|
/// 真彩 (4:4:4): NVENC (in-process or FFmpeg) and libx264; h264_vaapi is 4:2:0 only.
|
||||||
/// in-process encoder are 4:2:0 only).
|
/// A GPU without 4:4:4 NVENC falls back to libx264, which keeps 4:4:4.
|
||||||
pub fn full_chroma_available() -> bool {
|
pub fn full_chroma_available() -> bool {
|
||||||
#[cfg(feature = "inproc-av")]
|
|
||||||
if crate::inproc_encoder::selected() { return false; }
|
|
||||||
Encoder::requested() != Encoder::Vaapi
|
Encoder::requested() != Encoder::Vaapi
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -286,8 +292,22 @@ fn encoder_options(settings: &VideoSettings, encoder: Encoder, gop: &str, rgb: O
|
|||||||
options.into_iter().map(str::to_owned).collect()
|
options.into_iter().map(str::to_owned).collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
fn scale_options(settings: &VideoSettings, encoder: Encoder) -> Vec<String> {
|
/// Filter chain for a capture of `source` size (None when the input size is not known yet, e.g.
|
||||||
if encoder == Encoder::Vaapi { return vec!["-vf".into(), vaapi_filter(settings.output)]; }
|
/// the fixed-input probe). H.264/HEVC 4:2:0 encoders — and NVENC's surface allocation — require
|
||||||
|
/// even frame dimensions, but the captured size is not always even: the portal backend reports the
|
||||||
|
/// compositor's logical desktop size, so two stacked monitors at 150% scale capture 2560x2507 and
|
||||||
|
/// every encoder failed to open ("height not divisible by 2 (2560x2507)" from libx264,
|
||||||
|
/// "InitializeEncoder failed: out of memory (10)" from h264_nvenc), leaving the viewer stuck on the
|
||||||
|
/// 正在传输画面 spinner. When the native capture size is odd, pad the odd row/column; the host
|
||||||
|
/// display mode and every reported capture setting stay untouched.
|
||||||
|
fn scale_options(settings: &VideoSettings, encoder: Encoder, source: Option<(u32,u32)>) -> Vec<String> {
|
||||||
|
const EVEN_PAD: &str = "pad=ceil(iw/2)*2:ceil(ih/2)*2:0:0:black";
|
||||||
|
let odd_capture = settings.output.is_none() && source.is_some_and(|(w,h)| w % 2 != 0 || h % 2 != 0);
|
||||||
|
if encoder == Encoder::Vaapi {
|
||||||
|
let filtered = if odd_capture { format!("{EVEN_PAD},{}", vaapi_filter(None)) } else { vaapi_filter(settings.output) };
|
||||||
|
return vec!["-vf".into(), filtered];
|
||||||
|
}
|
||||||
|
if odd_capture { return vec!["-vf".into(), EVEN_PAD.into()]; }
|
||||||
settings.output.map_or_else(Vec::new, |(w,h)| vec!["-vf".into(), format!("scale={w}:{h}:flags=bilinear")])
|
settings.output.map_or_else(Vec::new, |(w,h)| vec!["-vf".into(), format!("scale={w}:{h}:flags=bilinear")])
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -484,17 +504,40 @@ async fn read_encoder(
|
|||||||
) -> Result<(), String> {
|
) -> Result<(), String> {
|
||||||
// The sequence is shared so a CPU fallback or settings restart continues it (skip statistics stay correct).
|
// The sequence is shared so a CPU fallback or settings restart continues it (skip statistics stay correct).
|
||||||
let encoder = Encoder::requested();
|
let encoder = Encoder::requested();
|
||||||
if encoder == Encoder::Cpu { return read_encoder_with(size,display,portal,latest,Encoder::Cpu,sequence,settings,idr,budget).await; }
|
if encoder == Encoder::Cpu { return read_encoder_with(size,display,portal,latest,Encoder::Cpu,true,sequence,settings,idr,budget).await; }
|
||||||
match read_encoder_with(size,display.clone(),portal.clone(),latest.clone(),encoder,sequence.clone(),settings,idr.clone(),budget.clone()).await {
|
#[cfg_attr(not(feature = "inproc-av"), allow(unused_mut))]
|
||||||
|
let mut result = read_encoder_with(size,display.clone(),portal.clone(),latest.clone(),encoder,true,sequence.clone(),settings,idr.clone(),budget.clone()).await;
|
||||||
|
// A failed native NVENC session (old driver, unsupported mode) still leaves FFmpeg's NVENC process pipeline.
|
||||||
|
#[cfg(feature = "inproc-av")]
|
||||||
|
if let Err(error) = &result {
|
||||||
|
if !latest.is_closed() && native_inproc(&display, portal.is_some(), encoder) && x11_resized(&display, portal.is_some(), size).is_none() {
|
||||||
|
log::warn!("In-process {} stream unavailable; switching to the FFmpeg process pipeline: {}",encoder.name_for(settings.codec),error);
|
||||||
|
result = read_encoder_with(size,display.clone(),portal.clone(),latest.clone(),encoder,false,sequence.clone(),settings,idr.clone(),budget.clone()).await;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
match result {
|
||||||
Ok(())=>Ok(()),
|
Ok(())=>Ok(()),
|
||||||
Err(error) if !latest.is_closed()=>{
|
Err(error) if !latest.is_closed() && x11_resized(&display, portal.is_some(), size).is_none()=>{
|
||||||
log::warn!("{} stream unavailable; switching scoped encoder to CPU: {}",encoder.name_for(settings.codec),error);
|
log::warn!("{} stream unavailable; switching scoped encoder to CPU: {}",encoder.name_for(settings.codec),error);
|
||||||
read_encoder_with(size,display,portal,latest,Encoder::Cpu,sequence,settings,idr,budget).await
|
read_encoder_with(size,display,portal,latest,Encoder::Cpu,true,sequence,settings,idr,budget).await
|
||||||
},
|
},
|
||||||
Err(error)=>Err(error),
|
Err(error)=>Err(error),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A resized X11 root fails every encoder alike (x11grab BadMatch on the old size);
|
||||||
|
/// returns the new size so the stream restarts capture instead of walking the fallback chain.
|
||||||
|
fn x11_resized(display: &str, portal: bool, size: (u32, u32)) -> Option<(u32, u32)> {
|
||||||
|
if portal || display.starts_with("wayland:") || display.starts_with("kms:") { return None; }
|
||||||
|
crate::capture::x11_size().filter(|current| *current != size)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The native in-process NVENC path serves X11 only (not Wayland/KMS capture or a portal session).
|
||||||
|
#[cfg(feature = "inproc-av")]
|
||||||
|
fn native_inproc(display: &str, portal: bool, encoder: Encoder) -> bool {
|
||||||
|
!display.starts_with("wayland:") && !display.starts_with("kms:") && !portal && crate::inproc_encoder::selected(encoder)
|
||||||
|
}
|
||||||
|
|
||||||
/// Capture and encode inside this process; each packet is one access unit.
|
/// Capture and encode inside this process; each packet is one access unit.
|
||||||
#[cfg(feature = "inproc-av")]
|
#[cfg(feature = "inproc-av")]
|
||||||
async fn read_inprocess(
|
async fn read_inprocess(
|
||||||
@@ -506,14 +549,16 @@ async fn read_inprocess(
|
|||||||
let stop = Arc::new(AtomicBool::new(false));
|
let stop = Arc::new(AtomicBool::new(false));
|
||||||
// If this future is dropped (reader task aborted), the blocking encoder stops at its next packet.
|
// If this future is dropped (reader task aborted), the blocking encoder stops at its next packet.
|
||||||
let _stop_on_drop = StopOnDrop(stop.clone());
|
let _stop_on_drop = StopOnDrop(stop.clone());
|
||||||
|
// A restart aborts the previous reader without waiting for its blocking encoder; wait for it here.
|
||||||
|
let slot = crate::inproc_encoder::stream_slot(&idr).await;
|
||||||
let job = tokio::task::spawn_blocking({
|
let job = tokio::task::spawn_blocking({
|
||||||
let stop = stop.clone();
|
let stop = stop.clone();
|
||||||
move || crate::inproc_encoder::run(config, units_tx, stop, idr, budget)
|
move || { let _slot = slot; crate::inproc_encoder::run(config, units_tx, stop, idr, budget) }
|
||||||
});
|
});
|
||||||
let mut gate = DependencyGate::default();
|
let mut gate = DependencyGate::default();
|
||||||
while let Some(unit) = units.recv().await {
|
while let Some(unit) = units.recv().await {
|
||||||
let sequence = sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
|
let sequence = sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
|
||||||
gate.submit(&latest, Arc::new(CompleteFrame { codec, sequence, completed_at: unit.completed_at, data: unit.data, _permit: Some(unit.permit) }));
|
gate.submit(&latest, Arc::new(CompleteFrame { source_generation: 0, source_id: 0, codec, sequence, completed_at: unit.completed_at, data: unit.data, _permit: Some(unit.permit) }));
|
||||||
if latest.is_closed() { break; }
|
if latest.is_closed() { break; }
|
||||||
}
|
}
|
||||||
// Dropping the receiver also unblocks the encoder if it is waiting to send.
|
// Dropping the receiver also unblocks the encoder if it is waiting to send.
|
||||||
@@ -557,9 +602,12 @@ fn rate_args(settings: &VideoSettings, encoder: Encoder) -> (String, String) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async fn read_encoder_with(
|
async fn read_encoder_with(
|
||||||
size: (u32,u32),display:String,portal:Option<Arc<crate::portal::PortalSession>>,latest:mpsc::Sender<Arc<CompleteFrame>>,encoder:Encoder,sequence:Arc<std::sync::atomic::AtomicU64>,
|
size: (u32,u32),display:String,portal:Option<Arc<crate::portal::PortalSession>>,latest:mpsc::Sender<Arc<CompleteFrame>>,encoder:Encoder,
|
||||||
|
#[cfg_attr(not(feature = "inproc-av"), allow(unused_variables))] allow_inproc: bool,sequence:Arc<std::sync::atomic::AtomicU64>,
|
||||||
settings: VideoSettings, #[cfg_attr(not(feature = "inproc-av"), allow(unused_variables))] idr: Arc<AtomicBool>, budget: Arc<Semaphore>,
|
settings: VideoSettings, #[cfg_attr(not(feature = "inproc-av"), allow(unused_variables))] idr: Arc<AtomicBool>, budget: Arc<Semaphore>,
|
||||||
)->Result<(),String>{
|
)->Result<(),String>{
|
||||||
|
let selected_output=if display.starts_with("wayland:") {crate::wayland::source(settings.source_id)} else {None};
|
||||||
|
let size=selected_output.map_or(size,|s|(s.width,s.height));
|
||||||
let kms=display.starts_with("kms:");
|
let kms=display.starts_with("kms:");
|
||||||
let wayland=kms || display.starts_with("wayland:");
|
let wayland=kms || display.starts_with("wayland:");
|
||||||
let (permits_tx,mut permits_rx)=mpsc::channel::<OwnedSemaphorePermit>(4);
|
let (permits_tx,mut permits_rx)=mpsc::channel::<OwnedSemaphorePermit>(4);
|
||||||
@@ -569,19 +617,20 @@ async fn read_encoder_with(
|
|||||||
Some(Arc::new(capture))
|
Some(Arc::new(capture))
|
||||||
} else { None };
|
} else { None };
|
||||||
#[cfg(feature = "inproc-av")]
|
#[cfg(feature = "inproc-av")]
|
||||||
if !wayland && portal.is_none() && crate::inproc_encoder::selected() {
|
if allow_inproc && native_inproc(&display, portal.is_some(), encoder) {
|
||||||
let max_kbps = settings.max_kbps().unwrap_or(30_000) as i64;
|
let max_kbps = settings.max_kbps().unwrap_or(30_000) as i64;
|
||||||
let config = crate::inproc_encoder::Config {
|
let config = crate::inproc_encoder::Config {
|
||||||
display: display.clone(), input: size, output: settings.output, fps: u32::from(settings.fps),
|
display: display.clone(), input: size, output: settings.output, fps: u32::from(settings.fps),
|
||||||
gop: gop_frames(settings.fps, true) as u32, cq: settings.cq() as u32,
|
gop: gop_frames(settings.fps, true) as u32, cq: settings.cq() as u32,
|
||||||
target_bps: settings.max_kbps().map_or(16_000, |k| i64::from(k) * 3 / 4) * 1000,
|
target_bps: settings.max_kbps().map_or(16_000, |k| i64::from(k) * 3 / 4) * 1000,
|
||||||
max_bps: max_kbps * 1000, buffer_bits: i64::from(buffer_for(&settings, encoder)) * 1000, encoder, codec: settings.codec,
|
max_bps: max_kbps * 1000, buffer_bits: i64::from(buffer_for(&settings, encoder)) * 1000, codec: settings.codec, chroma: settings.chroma,
|
||||||
damage: crate::inproc_encoder::damage_enabled(),
|
vaapi: encoder == Encoder::Vaapi,
|
||||||
};
|
};
|
||||||
log::info!("Desktop encoder: display={} source={}x{} output={:?} fps={} cq={} maxrate={}k encoder={} pipeline=in-process",
|
log::info!("Desktop encoder: display={} source={}x{} output={:?} fps={} cq={} maxrate={}k encoder={} pipeline=in-process",
|
||||||
display,size.0,size.1,settings.output,settings.fps,config.cq,max_kbps,encoder.name_for(settings.codec));
|
display,size.0,size.1,settings.output,settings.fps,config.cq,max_kbps,encoder.name_for(settings.codec));
|
||||||
return read_inprocess(config, latest, sequence, idr, budget).await;
|
return read_inprocess(config, latest, sequence, idr, budget).await;
|
||||||
}
|
}
|
||||||
|
let source_size = size;
|
||||||
let size = format!("{}x{}", size.0, size.1);
|
let size = format!("{}x{}", size.0, size.1);
|
||||||
let fps = settings.fps.to_string();
|
let fps = settings.fps.to_string();
|
||||||
// Keep the IDR interval at 2 s whatever the frame rate.
|
// Keep the IDR interval at 2 s whatever the frame rate.
|
||||||
@@ -605,7 +654,7 @@ async fn read_encoder_with(
|
|||||||
"-video_size",&size,"-i",&display,"-an"]);
|
"-video_size",&size,"-i",&display,"-an"]);
|
||||||
}
|
}
|
||||||
// 其他分辨率: scale the captured desktop (the host display mode is left untouched).
|
// 其他分辨率: scale the captured desktop (the host display mode is left untouched).
|
||||||
command.args(scale_options(&settings, encoder));
|
command.args(scale_options(&settings, encoder, Some(source_size)));
|
||||||
command.args(encoder_options(&settings, encoder, &gop, rgb));
|
command.args(encoder_options(&settings, encoder, &gop, rgb));
|
||||||
// x11grab paces against an absolute schedule; after a capture stall it grabs
|
// x11grab paces against an absolute schedule; after a capture stall it grabs
|
||||||
// back-to-back to "catch up" (measured 69 frames in 200ms). vfr on a 1/FPS
|
// back-to-back to "catch up" (measured 69 frames in 200ms). vfr on a 1/FPS
|
||||||
@@ -622,7 +671,9 @@ async fn read_encoder_with(
|
|||||||
let executable=std::path::PathBuf::from("/proc/self/exe");
|
let executable=std::path::PathBuf::from("/proc/self/exe");
|
||||||
#[cfg(not(target_os="linux"))]
|
#[cfg(not(target_os="linux"))]
|
||||||
let executable=std::env::current_exe().map_err(|e|format!("Capture executable: {e}"))?;
|
let executable=std::env::current_exe().map_err(|e|format!("Capture executable: {e}"))?;
|
||||||
let mut capture=wayland_capture_command(&executable,settings.fps)
|
let mut capture_command=wayland_capture_command(&executable,settings.fps);
|
||||||
|
if let Some(output)=selected_output {capture_command.env("UU_WAYLAND_OUTPUT",&output.name);}
|
||||||
|
let mut capture=capture_command
|
||||||
.env("UU_WAYLAND_DEMAND","1")
|
.env("UU_WAYLAND_DEMAND","1")
|
||||||
.kill_on_drop(true).stdin(std::process::Stdio::piped()).stdout(std::process::Stdio::piped()).stderr(std::process::Stdio::inherit())
|
.kill_on_drop(true).stdin(std::process::Stdio::piped()).stdout(std::process::Stdio::piped()).stderr(std::process::Stdio::inherit())
|
||||||
.spawn().map_err(|e|format!("Start Wayland capture: {e}"))?;
|
.spawn().map_err(|e|format!("Start Wayland capture: {e}"))?;
|
||||||
@@ -720,7 +771,7 @@ async fn read_encoder_with(
|
|||||||
let frame: Vec<u8> = pending.drain(..next).collect();
|
let frame: Vec<u8> = pending.drain(..next).collect();
|
||||||
let sequence = sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
|
let sequence = sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed) + 1;
|
||||||
let permit=if wayland {Some(permits_rx.recv().await.ok_or("Capture producer stopped")?)} else {None};
|
let permit=if wayland {Some(permits_rx.recv().await.ok_or("Capture producer stopped")?)} else {None};
|
||||||
gate.submit(&latest, Arc::new(CompleteFrame {
|
gate.submit(&latest, Arc::new(CompleteFrame { source_generation: settings.source_generation, source_id: settings.source_id,
|
||||||
codec: settings.codec, sequence, completed_at: Instant::now(), data: frame, _permit: permit,
|
codec: settings.codec, sequence, completed_at: Instant::now(), data: frame, _permit: permit,
|
||||||
}));
|
}));
|
||||||
if latest.is_closed() { return Ok(()); }
|
if latest.is_closed() { return Ok(()); }
|
||||||
@@ -748,7 +799,10 @@ fn probe_settings() -> Result<VideoSettings,String> {
|
|||||||
None=>crate::capture_setting::QUALITY_AUTO,
|
None=>crate::capture_setting::QUALITY_AUTO,
|
||||||
Some(v)=>v.parse::<u64>().ok().filter(|q|(1..=5).contains(q)).ok_or("UU_PROBE_QUALITY must be 1-5")?,
|
Some(v)=>v.parse::<u64>().ok().filter(|q|(1..=5).contains(q)).ok_or("UU_PROBE_QUALITY must be 1-5")?,
|
||||||
};
|
};
|
||||||
Ok(VideoSettings {fps,quality,codec:probe_codec(),..VideoSettings::default()})
|
let mut settings=VideoSettings {fps,quality,codec:probe_codec(),..VideoSettings::default()};
|
||||||
|
// UU_PROBE_CHROMA=444 requests 真彩 like the viewer does (only where full_chroma_available()).
|
||||||
|
if std::env::var("UU_PROBE_CHROMA").as_deref()==Ok("444") && full_chroma_available() { settings.chroma=crate::capture_setting::CHROMA_444; }
|
||||||
|
Ok(settings)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The probe follows `UU_VIDEO_CODEC` so the HEVC path can be measured at all (H.264 otherwise),
|
/// The probe follows `UU_VIDEO_CODEC` so the HEVC path can be measured at all (H.264 otherwise),
|
||||||
@@ -768,7 +822,7 @@ fn probe_input_command(spec:&FfmpegSpec,input:&std::ffi::OsStr,loop_input:bool,s
|
|||||||
if loop_input { command.args(["-stream_loop","-1"]); }
|
if loop_input { command.args(["-stream_loop","-1"]); }
|
||||||
// Override source timestamps so clips and image sequences use the same nominal probe rate.
|
// Override source timestamps so clips and image sequences use the same nominal probe rate.
|
||||||
command.args(["-r",&settings.fps.to_string(),"-i"]).arg(input).args(["-map","0:v:0","-an"]);
|
command.args(["-r",&settings.fps.to_string(),"-i"]).arg(input).args(["-map","0:v:0","-an"]);
|
||||||
command.args(scale_options(settings,encoder));
|
command.args(scale_options(settings,encoder,None));
|
||||||
command.args(encoder_options(settings,encoder,&gop_frames(settings.fps,false).to_string(),None));
|
command.args(encoder_options(settings,encoder,&gop_frames(settings.fps,false).to_string(),None));
|
||||||
command.args(timing_args(timing,settings.fps));
|
command.args(timing_args(timing,settings.fps));
|
||||||
command.args(["-frames:v",&wanted.to_string(),"-f",if settings.codec==VideoCodec::H265 {"hevc"} else {"h264"},"pipe:1"]);
|
command.args(["-frames:v",&wanted.to_string(),"-f",if settings.codec==VideoCodec::H265 {"hevc"} else {"h264"},"pipe:1"]);
|
||||||
@@ -868,8 +922,9 @@ pub async fn probe(size:(u32,u32),display:String,portal:Option<Arc<crate::portal
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_track::VideoTrack>, size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>,
|
pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_track::VideoTrack>, mut size: (u32, u32), display: String, portal:Option<Arc<crate::portal::PortalSession>>,
|
||||||
mut settings: tokio::sync::watch::Receiver<VideoSettings>, applied: Arc<tokio::sync::watch::Sender<VideoSettings>>, idr: Arc<AtomicBool>) -> Result<(), String> {
|
mut settings: tokio::sync::watch::Receiver<VideoSettings>, applied: Arc<tokio::sync::watch::Sender<VideoSettings>>, idr: Arc<AtomicBool>) -> Result<(), String> {
|
||||||
|
let _desktop_mode = crate::desktop_mode::StreamGuard::new();
|
||||||
loop {
|
loop {
|
||||||
if transport_closed(&pc) { return Ok(()); }
|
if transport_closed(&pc) { return Ok(()); }
|
||||||
if pc.connection_state() == RTCPeerConnectionState::Connected
|
if pc.connection_state() == RTCPeerConnectionState::Connected
|
||||||
@@ -906,9 +961,11 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
'stream: loop {
|
'stream: loop {
|
||||||
let next = *settings.borrow_and_update();
|
let next = *settings.borrow_and_update();
|
||||||
if next != current || send_interrupted {
|
if next != current || send_interrupted {
|
||||||
let discard = next.codec != current.codec || send_interrupted;
|
let discard = next.codec != current.codec || next.source_generation != current.source_generation || next.source_id != current.source_id || send_interrupted;
|
||||||
current = next;
|
current = next;
|
||||||
timeline.fps = u64::from(next.fps);
|
timeline.fps = u64::from(next.fps);
|
||||||
|
// A viewer resolution choice may have changed the X11 display mode (desktop_mode).
|
||||||
|
if let Some(resized) = x11_resized(&display, portal_stream, size) { size = resized; }
|
||||||
if discard {
|
if discard {
|
||||||
reader.0.abort();
|
reader.0.abort();
|
||||||
let _ = (&mut reader.0).await;
|
let _ = (&mut reader.0).await;
|
||||||
@@ -922,6 +979,13 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
tokio::select! {
|
tokio::select! {
|
||||||
result = &mut reader.0 => {
|
result = &mut reader.0 => {
|
||||||
let result = result.map_err(|e| format!("Encoder reader task: {e}"))?;
|
let result = result.map_err(|e| format!("Encoder reader task: {e}"))?;
|
||||||
|
if let Some(resized) = result.as_ref().err().and_then(|_| x11_resized(&display, portal_stream, size)) {
|
||||||
|
log::info!("Desktop geometry changed during the stream ({}x{} -> {}x{}); restarting capture", size.0, size.1, resized.0, resized.1);
|
||||||
|
size = resized;
|
||||||
|
while receiver.try_recv().is_ok() {}
|
||||||
|
reader.0 = tokio::spawn(read_encoder(size, display.clone(), portal.clone(), latest.clone(), current, sequence.clone(), idr.clone(), budget.clone()));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
if let (Err(error), VideoCodec::H265, true) = (&result, current.codec, track.supports(VideoCodec::H264)) {
|
if let (Err(error), VideoCodec::H265, true) = (&result, current.codec, track.supports(VideoCodec::H264)) {
|
||||||
log::warn!("HEVC stream failed ({error}); falling back to negotiated H264");
|
log::warn!("HEVC stream failed ({error}); falling back to negotiated H264");
|
||||||
applied.send_modify(|value| value.codec = VideoCodec::H264);
|
applied.send_modify(|value| value.codec = VideoCodec::H264);
|
||||||
@@ -930,6 +994,19 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
reader.0 = tokio::spawn(read_encoder(size, display.clone(), portal.clone(), latest.clone(), current, sequence.clone(), idr.clone(), budget.clone()));
|
reader.0 = tokio::spawn(read_encoder(size, display.clone(), portal.clone(), latest.clone(), current, sequence.clone(), idr.clone(), budget.clone()));
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
if result.is_err() && !crate::wayland::outputs().is_empty() && !crate::wayland::input_ready() {
|
||||||
|
// Leave the stream task alive so the request worker can roll back
|
||||||
|
// a failed capture/encoder and restart the previous source.
|
||||||
|
crate::wayland::failed(current.source_id,current.source_generation);
|
||||||
|
loop {
|
||||||
|
tokio::select! {
|
||||||
|
changed=settings.changed()=>{if changed.is_err(){return result;}break;},
|
||||||
|
_=health.tick()=>{if transport_closed(&pc){return Ok(());}},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
send_interrupted=true;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
return result;
|
return result;
|
||||||
},
|
},
|
||||||
_ = health.tick() => { if transport_closed(&pc) { return Ok(()); } },
|
_ = health.tick() => { if transport_closed(&pc) { return Ok(()); } },
|
||||||
@@ -940,7 +1017,7 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
frame = receiver.recv() => {
|
frame = receiver.recv() => {
|
||||||
// A closed queue means the reader ended; its JoinHandle carries the reason.
|
// A closed queue means the reader ended; its JoinHandle carries the reason.
|
||||||
let Some(frame) = frame else { return (&mut reader.0).await.map_err(|e| format!("Encoder reader task: {e}"))?; };
|
let Some(frame) = frame else { return (&mut reader.0).await.map_err(|e| format!("Encoder reader task: {e}"))?; };
|
||||||
if frame.codec != current.codec { continue; }
|
if !frame.matches(¤t) { continue; }
|
||||||
let duration = timeline.duration_after(frame.completed_at);
|
let duration = timeline.duration_after(frame.completed_at);
|
||||||
if let Some(last) = previous { skipped += frame.sequence.saturating_sub(last + 1); }
|
if let Some(last) = previous { skipped += frame.sequence.saturating_sub(last + 1); }
|
||||||
max_age_ms = max_age_ms.max(frame.completed_at.elapsed().as_millis());
|
max_age_ms = max_age_ms.max(frame.completed_at.elapsed().as_millis());
|
||||||
@@ -949,6 +1026,7 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
data: frame.data.clone().into(), duration, ..Default::default()
|
data: frame.data.clone().into(), duration, ..Default::default()
|
||||||
};
|
};
|
||||||
let extensions = [crate::rtp_metadata::capture_index(0), crate::rtp_metadata::new_frame()];
|
let extensions = [crate::rtp_metadata::capture_index(0), crate::rtp_metadata::new_frame()];
|
||||||
|
let sent_before=track.revision();
|
||||||
let send = track.write_sample_with_extensions(frame.codec, &sample, &extensions);
|
let send = track.write_sample_with_extensions(frame.codec, &sample, &extensions);
|
||||||
let send_started=Instant::now();
|
let send_started=Instant::now();
|
||||||
tokio::pin!(send);
|
tokio::pin!(send);
|
||||||
@@ -962,6 +1040,9 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if !crate::wayland::outputs().is_empty() && track.revision()>sent_before {
|
||||||
|
crate::wayland::presented(current.source_id,current.source_generation);
|
||||||
|
}
|
||||||
previous = Some(frame.sequence);
|
previous = Some(frame.sequence);
|
||||||
max_send_ms=max_send_ms.max(send_started.elapsed().as_millis());
|
max_send_ms=max_send_ms.max(send_started.elapsed().as_millis());
|
||||||
frames += 1;
|
frames += 1;
|
||||||
@@ -981,6 +1062,28 @@ pub async fn stream_desktop(pc: Arc<RTCPeerConnection>, track: Arc<crate::video_
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
|
#[test]
|
||||||
|
fn native_frame_dimensions_are_padded_to_even() {
|
||||||
|
// A scaled compositor can report an odd logical desktop (e.g. two stacked 150% monitors →
|
||||||
|
// 2560x2507); H.264/HEVC 4:2:0 encoders reject odd dimensions, so a native-size capture
|
||||||
|
// with a known odd size gets a pad filter. Even sizes, explicit output scaling and the
|
||||||
|
// fixed-input probe (size unknown) keep their existing filter chains.
|
||||||
|
let native = VideoSettings { output: None, ..Default::default() };
|
||||||
|
let pad = "pad=ceil(iw/2)*2:ceil(ih/2)*2:0:0:black";
|
||||||
|
for encoder in [Encoder::Cpu, Encoder::Nvenc] {
|
||||||
|
assert_eq!(scale_options(&native, encoder, Some((2560, 2507))), vec!["-vf".to_string(), pad.to_string()]);
|
||||||
|
assert!(scale_options(&native, encoder, Some((2560, 2508))).is_empty());
|
||||||
|
assert!(scale_options(&native, encoder, None).is_empty());
|
||||||
|
}
|
||||||
|
assert_eq!(scale_options(&native, Encoder::Vaapi, Some((2560, 2507))),
|
||||||
|
vec!["-vf".to_string(), format!("{pad},format=nv12,hwupload")]);
|
||||||
|
assert_eq!(scale_options(&native, Encoder::Vaapi, Some((2560, 2508))),
|
||||||
|
vec!["-vf".to_string(), "format=nv12,hwupload".to_string()]);
|
||||||
|
let scaled = VideoSettings { output: Some((1280, 720)), ..Default::default() };
|
||||||
|
assert_eq!(scale_options(&scaled, Encoder::Cpu, Some((2560, 2507))),
|
||||||
|
vec!["-vf".to_string(), "scale=1280:720:flags=bilinear".to_string()]);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn fixed_input_arguments_share_production_encoding_options() {
|
fn fixed_input_arguments_share_production_encoding_options() {
|
||||||
let spec=FfmpegSpec {program:"ffmpeg".into(),ld_library_path:None,path:None};
|
let spec=FfmpegSpec {program:"ffmpeg".into(),ld_library_path:None,path:None};
|
||||||
@@ -993,7 +1096,7 @@ mod tests {
|
|||||||
let args:Vec<_>=command.as_std().get_args().map(|a|a.to_str().unwrap().to_owned()).collect();
|
let args:Vec<_>=command.as_std().get_args().map(|a|a.to_str().unwrap().to_owned()).collect();
|
||||||
let expected=encoder_options(&settings,encoder,&gop_frames(30,false).to_string(),None);
|
let expected=encoder_options(&settings,encoder,&gop_frames(30,false).to_string(),None);
|
||||||
assert!(args.windows(expected.len()).any(|w|w==expected));
|
assert!(args.windows(expected.len()).any(|w|w==expected));
|
||||||
let scale=scale_options(&settings,encoder);
|
let scale=scale_options(&settings,encoder,None);
|
||||||
assert!(args.windows(scale.len()).any(|w|w==scale));
|
assert!(args.windows(scale.len()).any(|w|w==scale));
|
||||||
assert!(args.windows(4).any(|w|w==["-r","30","-i","frames/%05d.png"]));
|
assert!(args.windows(4).any(|w|w==["-r","30","-i","frames/%05d.png"]));
|
||||||
assert!(args.windows(2).any(|w|w==["-frames:v","17"]));
|
assert!(args.windows(2).any(|w|w==["-frames:v","17"]));
|
||||||
@@ -1045,7 +1148,7 @@ mod tests {
|
|||||||
let mut gate=DependencyGate::default();
|
let mut gate=DependencyGate::default();
|
||||||
for sequence in 1..=2 {
|
for sequence in 1..=2 {
|
||||||
let permit=budget.clone().acquire_owned().await.unwrap();
|
let permit=budget.clone().acquire_owned().await.unwrap();
|
||||||
gate.submit(&tx,Arc::new(CompleteFrame {codec:VideoCodec::H264,sequence,completed_at:Instant::now(),
|
gate.submit(&tx,Arc::new(CompleteFrame { source_generation: 0, source_id: 0,codec:VideoCodec::H264,sequence,completed_at:Instant::now(),
|
||||||
data:vec![0,0,1,5,42],_permit:Some(permit)}));
|
data:vec![0,0,1,5,42],_permit:Some(permit)}));
|
||||||
}
|
}
|
||||||
let sending=rx.recv().await.unwrap();
|
let sending=rx.recv().await.unwrap();
|
||||||
@@ -1179,7 +1282,7 @@ mod tests {
|
|||||||
let (tx, mut rx) = mpsc::channel(4);
|
let (tx, mut rx) = mpsc::channel(4);
|
||||||
let old_tx = tx.clone();
|
let old_tx = tx.clone();
|
||||||
let (started_tx, started_rx) = tokio::sync::oneshot::channel();
|
let (started_tx, started_rx) = tokio::sync::oneshot::channel();
|
||||||
let frame = |sequence, idr| Arc::new(CompleteFrame { _permit: None,
|
let frame = |sequence, idr| Arc::new(CompleteFrame { source_generation: 0, source_id: 0, _permit: None,
|
||||||
sequence, codec: VideoCodec::H264, completed_at: Instant::now(),
|
sequence, codec: VideoCodec::H264, completed_at: Instant::now(),
|
||||||
data: vec![0, 0, 1, 9, 240, 0, 0, 1, if idr { 5 } else { 1 }, 42],
|
data: vec![0, 0, 1, 9, 240, 0, 0, 1, if idr { 5 } else { 1 }, 42],
|
||||||
});
|
});
|
||||||
@@ -1274,7 +1377,7 @@ mod tests {
|
|||||||
async fn bounded_queue_never_sends_broken_prediction_chain_after_overload(){
|
async fn bounded_queue_never_sends_broken_prediction_chain_after_overload(){
|
||||||
let(tx,mut rx)=mpsc::channel(1);
|
let(tx,mut rx)=mpsc::channel(1);
|
||||||
let mut gate=DependencyGate::default();
|
let mut gate=DependencyGate::default();
|
||||||
let frame=|sequence,idr|Arc::new(CompleteFrame{_permit:None,sequence,codec:VideoCodec::H264,completed_at:Instant::now(),data:vec![0,0,1,9,240,0,0,1,if idr{5}else{1},42]});
|
let frame=|sequence,idr|Arc::new(CompleteFrame{source_generation:0,source_id:0,_permit:None,sequence,codec:VideoCodec::H264,completed_at:Instant::now(),data:vec![0,0,1,9,240,0,0,1,if idr{5}else{1},42]});
|
||||||
gate.submit(&tx,frame(1,false));assert!(rx.try_recv().is_err()); // no IDR yet
|
gate.submit(&tx,frame(1,false));assert!(rx.try_recv().is_err()); // no IDR yet
|
||||||
gate.submit(&tx,frame(2,true));
|
gate.submit(&tx,frame(2,true));
|
||||||
gate.submit(&tx,frame(3,false)); // queue full: P3 lost
|
gate.submit(&tx,frame(3,false)); // queue full: P3 lost
|
||||||
@@ -1328,7 +1431,7 @@ mod tests {
|
|||||||
async fn hevc_dependency_gate_recovers_only_at_irap_after_overflow() {
|
async fn hevc_dependency_gate_recovers_only_at_irap_after_overflow() {
|
||||||
let (tx, mut rx) = mpsc::channel(1);
|
let (tx, mut rx) = mpsc::channel(1);
|
||||||
let mut gate = DependencyGate::default();
|
let mut gate = DependencyGate::default();
|
||||||
let frame = |sequence, irap| Arc::new(CompleteFrame { _permit: None, codec: VideoCodec::H265,
|
let frame = |sequence, irap| Arc::new(CompleteFrame { source_generation: 0, source_id: 0, _permit: None, codec: VideoCodec::H265,
|
||||||
sequence, completed_at: Instant::now(), data: vec![0,0,1,if irap { 38 } else { 2 },1,42] });
|
sequence, completed_at: Instant::now(), data: vec![0,0,1,if irap { 38 } else { 2 },1,42] });
|
||||||
gate.submit(&tx, frame(1, false));
|
gate.submit(&tx, frame(1, false));
|
||||||
assert!(rx.try_recv().is_err());
|
assert!(rx.try_recv().is_err());
|
||||||
@@ -1370,3 +1473,17 @@ mod tests {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod screen_frame_tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn source_restart_rejects_queued_frames_even_with_same_screen_and_codec() {
|
||||||
|
let frame=CompleteFrame {source_id:0,source_generation:7,codec:VideoCodec::H264,sequence:1,completed_at:Instant::now(),data:vec![],_permit:None};
|
||||||
|
let mut settings=VideoSettings {source_id:0,source_generation:7,..Default::default()};
|
||||||
|
assert!(frame.matches(&settings));
|
||||||
|
settings.source_generation=9;assert!(!frame.matches(&settings));
|
||||||
|
settings.source_generation=7;settings.source_id=1;assert!(!frame.matches(&settings));
|
||||||
|
settings.source_id=0;settings.codec=VideoCodec::H265;assert!(!frame.matches(&settings));
|
||||||
|
}
|
||||||
|
}
|
||||||
+1
-1
@@ -93,7 +93,7 @@ pub struct Api {
|
|||||||
}
|
}
|
||||||
impl Api {
|
impl Api {
|
||||||
pub fn new(signer: UUAuthClient, base: &str) -> Self {
|
pub fn new(signer: UUAuthClient, base: &str) -> Self {
|
||||||
Self { signer, base: base.trim_end_matches('/').into(), http: reqwest::Client::builder().timeout(Duration::from_secs(12)).build().unwrap() }
|
Self { signer, base: base.trim_end_matches('/').into(), http: crate::auth::http_client_builder().timeout(Duration::from_secs(12)).build().unwrap() }
|
||||||
}
|
}
|
||||||
pub async fn join_share(&self, connect_id: &str, connect_code: &str) -> Result<JoinData, Error> {
|
pub async fn join_share(&self, connect_id: &str, connect_code: &str) -> Result<JoinData, Error> {
|
||||||
if connect_id.trim().is_empty() || connect_code.trim().is_empty() || connect_id.chars().chain(connect_code.chars()).any(char::is_control) { return Err(Error::InvalidAssist); }
|
if connect_id.trim().is_empty() || connect_code.trim().is_empty() || connect_id.chars().chain(connect_code.chars()).any(char::is_control) { return Err(Error::InvalidAssist); }
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
//! Uses the same optional FFmpeg dependency as the host inproc-av feature.
|
//! Uses the optional FFmpeg 6 libraries of the `viewer-ffmpeg` feature.
|
||||||
use super::desktop::{Decoder,Frame};
|
use super::desktop::{Decoder,Frame};
|
||||||
use ffmpeg_next as av;
|
use ffmpeg_next as av;
|
||||||
use super::media::Codec;
|
use super::media::Codec;
|
||||||
|
|||||||
+211
-1
@@ -1,6 +1,7 @@
|
|||||||
//! Hyprland/wlroots native backend. No XWayland fallback and no input logging.
|
//! Hyprland/wlroots native backend. No XWayland fallback and no input logging.
|
||||||
#[cfg(all(target_os="linux", feature="wayland"))]
|
#[cfg(all(target_os="linux", feature="wayland"))]
|
||||||
extern "C" {
|
crate::engine_ffi! { crate::engine_plugin::Engine::Wayland;
|
||||||
|
fn uu_wl_select_output(name: *const libc::c_char, width: u32, height: u32) -> i32;
|
||||||
fn uu_wl_init(out_w: *mut i32, out_h: *mut i32) -> i32;
|
fn uu_wl_init(out_w: *mut i32, out_h: *mut i32) -> i32;
|
||||||
fn uu_wl_capture(buffer: *mut u8, length: usize) -> i32;
|
fn uu_wl_capture(buffer: *mut u8, length: usize) -> i32;
|
||||||
fn uu_wl_move(x: i32, y: i32, relative: i32) -> i32;
|
fn uu_wl_move(x: i32, y: i32, relative: i32) -> i32;
|
||||||
@@ -8,6 +9,26 @@ extern "C" {
|
|||||||
fn uu_wl_key(symbol: u64, pressed: i32) -> i32;
|
fn uu_wl_key(symbol: u64, pressed: i32) -> i32;
|
||||||
fn uu_wl_wake() -> i32;
|
fn uu_wl_wake() -> i32;
|
||||||
fn uu_wl_release_all() -> i32;
|
fn uu_wl_release_all() -> i32;
|
||||||
|
fn uu_wl_type_utf8(text: *const libc::c_char) -> i32;
|
||||||
|
fn uu_wl_text_ready() -> i32;
|
||||||
|
}
|
||||||
|
/// How many characters one keymap upload can carry; 0 means this keymap has no spare keycode.
|
||||||
|
pub fn text_ready()->i32 {
|
||||||
|
#[cfg(all(target_os="linux",feature="wayland"))]
|
||||||
|
{ return unsafe { uu_wl_text_ready() }; }
|
||||||
|
#[cfg(not(all(target_os="linux",feature="wayland")))]
|
||||||
|
-1
|
||||||
|
}
|
||||||
|
/// Mobile input-method text (#13/#46). Returns the number of characters typed, or a negative code
|
||||||
|
/// when this keymap has no spare keycode to carry them. Never logs the text.
|
||||||
|
pub fn type_utf8(text:&str)->i32 {
|
||||||
|
#[cfg(all(target_os="linux",feature="wayland"))]
|
||||||
|
{
|
||||||
|
let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return -1 };
|
||||||
|
return unsafe { uu_wl_type_utf8(c_text.as_ptr()) };
|
||||||
|
}
|
||||||
|
#[cfg(not(all(target_os="linux",feature="wayland")))]
|
||||||
|
{ let _=text; -1 }
|
||||||
}
|
}
|
||||||
pub fn release_all()->i32 {
|
pub fn release_all()->i32 {
|
||||||
#[cfg(all(target_os="linux",feature="wayland"))]
|
#[cfg(all(target_os="linux",feature="wayland"))]
|
||||||
@@ -18,11 +39,19 @@ pub fn release_all()->i32 {
|
|||||||
pub fn init() -> Result<(u32,u32),String> {
|
pub fn init() -> Result<(u32,u32),String> {
|
||||||
#[cfg(all(target_os="linux", feature="wayland"))]
|
#[cfg(all(target_os="linux", feature="wayland"))]
|
||||||
{
|
{
|
||||||
|
crate::engine_plugin::load(crate::engine_plugin::Engine::Wayland).map_err(|reason| format!("Wayland engine unavailable: {reason}"))?;
|
||||||
let (mut w,mut h)=(0,0);
|
let (mut w,mut h)=(0,0);
|
||||||
let result=unsafe { uu_wl_init(&mut w,&mut h) };
|
let result=unsafe { uu_wl_init(&mut w,&mut h) };
|
||||||
if result != 0 || w <= 0 || h <= 0 {
|
if result != 0 || w <= 0 || h <= 0 {
|
||||||
return Err(format!("Wayland initialization failed ({result}); requires screencopy, virtual keyboard and virtual pointer. Check UU_WAYLAND_OUTPUT and session environment."));
|
return Err(format!("Wayland initialization failed ({result}); requires screencopy, virtual keyboard and virtual pointer. Check UU_WAYLAND_OUTPUT and session environment."));
|
||||||
}
|
}
|
||||||
|
// The compositor registry and hyprctl need not enumerate outputs in the
|
||||||
|
// same order. Bind the initial engine to the inventory's selected output.
|
||||||
|
static BINDING: std::sync::OnceLock<Result<(),String>>=std::sync::OnceLock::new();
|
||||||
|
if !outputs().is_empty() {
|
||||||
|
BINDING.get_or_init(||select(0)).as_ref().map_err(Clone::clone)?;
|
||||||
|
return Ok(input_size((w as u32,h as u32)));
|
||||||
|
}
|
||||||
return Ok((w as u32,h as u32));
|
return Ok((w as u32,h as u32));
|
||||||
}
|
}
|
||||||
#[cfg(not(all(target_os="linux", feature="wayland")))]
|
#[cfg(not(all(target_os="linux", feature="wayland")))]
|
||||||
@@ -144,3 +173,184 @@ pub fn input_probe()->Result<(),String> {
|
|||||||
println!("Wayland test events sent; verify the native GTK acceptance report.");
|
println!("Wayland test events sent; verify the native GTK acceptance report.");
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Local diagnostic for the mobile-text path: report the keymap's capacity for it, then type a
|
||||||
|
/// sample into the focused window. Only the built-in sample is echoed; UU_PROBE_TEXT stays private.
|
||||||
|
pub fn text_probe()->Result<(),String> {
|
||||||
|
init()?;
|
||||||
|
let ready=text_ready();
|
||||||
|
if ready<=0 { return Err("this keymap has no spare keycode: mobile text input cannot be carried".into()); }
|
||||||
|
const SAMPLE:&str="uu remote abc 你好世界";
|
||||||
|
let (sample,builtin)=match std::env::var("UU_PROBE_TEXT") {
|
||||||
|
Ok(value)=>(value,false), Err(_)=>(SAMPLE.to_owned(),true),
|
||||||
|
};
|
||||||
|
println!("Wayland text probe: spare keycodes={ready} characters={} bytes={}",sample.chars().count(),sample.len());
|
||||||
|
if builtin { println!("Sample: {sample}"); }
|
||||||
|
// UU_PROBE_SEQUENCE types each |-separated field as its own call - one text_input message each,
|
||||||
|
// the way the phone's input method sends them - with UU_PROBE_STEP_MS between the calls. One
|
||||||
|
// process means one virtual keyboard, exactly as the host has.
|
||||||
|
let step=std::env::var("UU_PROBE_STEP_MS").ok().and_then(|v|v.parse::<u64>().ok()).unwrap_or(0);
|
||||||
|
let sequence=std::env::var("UU_PROBE_SEQUENCE").unwrap_or_else(|_|sample.clone());
|
||||||
|
let mut typed=0;
|
||||||
|
for (index,message) in sequence.split('|').enumerate() {
|
||||||
|
if index>0 && step>0 { std::thread::sleep(std::time::Duration::from_millis(step)); }
|
||||||
|
let one=type_utf8(message);
|
||||||
|
if one<0 { return Err(format!("Wayland text typing failed ({one})")); }
|
||||||
|
typed+=one;
|
||||||
|
}
|
||||||
|
if typed<0 { return Err(format!("Wayland text typing failed ({typed})")); }
|
||||||
|
println!("Typed {typed} of {} characters in {} calls; check that they match.",
|
||||||
|
sequence.chars().filter(|character|*character!='|').count(),sequence.split('|').count());
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Opt-in single-track monitor switching for Hyprland. The existing native engine owns
|
||||||
|
// capture/pointer binding; no compositor layout or user credentials are modified.
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct Output { pub name:String, pub width:u32, pub height:u32, pub fps:i32 }
|
||||||
|
static OUTPUTS: std::sync::OnceLock<Vec<Output>> = std::sync::OnceLock::new();
|
||||||
|
#[derive(Default)]
|
||||||
|
struct Selection { id:usize, generation:u64, presented:Option<u64>, failed:bool }
|
||||||
|
impl Selection {
|
||||||
|
fn begin(&mut self,id:usize) {
|
||||||
|
self.id=id; self.generation+=1; self.presented=None; self.failed=false;
|
||||||
|
}
|
||||||
|
fn sent(&mut self,id:usize,generation:u64) {
|
||||||
|
if (self.id,self.generation)==(id,generation) {self.presented=Some(generation);}
|
||||||
|
}
|
||||||
|
fn ready(&self)->bool {self.presented==Some(self.generation)}
|
||||||
|
}
|
||||||
|
static SELECTION:std::sync::Mutex<Selection>=std::sync::Mutex::new(Selection {id:0,generation:0,presented:None,failed:false});
|
||||||
|
pub fn outputs() -> &'static [Output] {
|
||||||
|
OUTPUTS.get_or_init(|| {
|
||||||
|
if !cfg!(all(target_os="linux",feature="wayland"))
|
||||||
|
|| std::env::var("UU_WAYLAND_MULTISCREEN").ok().as_deref()!=Some("1")
|
||||||
|
|| crate::desktop_backend::detect().ok()!=Some(crate::desktop_backend::DesktopBackend::Wayland) {return Vec::new();}
|
||||||
|
let output=std::process::Command::new("hyprctl").args(["monitors","-j"]).output();
|
||||||
|
let result=output.map_err(|_|"hyprctl unavailable").and_then(|output| {
|
||||||
|
if !output.status.success() {return Err("hyprctl failed");}
|
||||||
|
parse_outputs(&output.stdout,&std::env::var("UU_WAYLAND_OUTPUT").unwrap_or_default())
|
||||||
|
});
|
||||||
|
match result {Ok(outputs)=>outputs,Err(reason)=>{log::warn!("Wayland multi-screen disabled: {}",reason);Vec::new()}}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
fn parse_outputs(json:&[u8],preferred:&str)->Result<Vec<Output>,&'static str> {
|
||||||
|
let monitors=serde_json::from_slice::<Vec<serde_json::Value>>(json).map_err(|_|"Invalid monitor inventory")?;
|
||||||
|
let mut seen=std::collections::HashSet::new();
|
||||||
|
let mut outputs:Vec<Output>=monitors.into_iter().filter_map(|m| {
|
||||||
|
if m["disabled"].as_bool()==Some(true) || m["transform"].as_u64()!=Some(0) {return None;}
|
||||||
|
let name=m["name"].as_str()?;
|
||||||
|
let width=u32::try_from(m["width"].as_u64()?).ok()?;
|
||||||
|
let height=u32::try_from(m["height"].as_u64()?).ok()?;
|
||||||
|
if name.is_empty() || name.len()>127 || name.contains('\0') || !seen.insert(name.to_owned())
|
||||||
|
|| width<2 || height<2 || width>16384 || height>16384 || u64::from(width)*u64::from(height)*4>256*1024*1024 {return None;}
|
||||||
|
Some(Output {name:name.into(),width,height,fps:m["refreshRate"].as_f64()?.round().clamp(1.0,240.0) as i32})
|
||||||
|
}).collect();
|
||||||
|
outputs.sort_by_key(|m| (m.name!=preferred,m.name.clone()));
|
||||||
|
outputs.truncate(16);
|
||||||
|
if outputs.is_empty() || (!preferred.is_empty() && outputs[0].name!=preferred) {return Err("No capturable preferred output");}
|
||||||
|
Ok(outputs)
|
||||||
|
}
|
||||||
|
pub fn selection()->(usize,u64) {let s=SELECTION.lock().unwrap();(s.id,s.generation)}
|
||||||
|
pub fn selected()->usize {selection().0}
|
||||||
|
pub fn source(id:usize)->Option<&'static Output> {outputs().get(id)}
|
||||||
|
pub fn input_size(fallback:(u32,u32))->(u32,u32) {source(selected()).map_or(fallback,|s|(s.width,s.height))}
|
||||||
|
pub fn input_ready()->bool {outputs().is_empty() || SELECTION.lock().unwrap().ready()}
|
||||||
|
pub fn switch_failed()->bool {SELECTION.lock().unwrap().failed}
|
||||||
|
pub fn presented(id:usize,generation:u64) {SELECTION.lock().unwrap().sent(id,generation);}
|
||||||
|
pub fn failed(id:usize,generation:u64) {
|
||||||
|
let mut state=SELECTION.lock().unwrap();
|
||||||
|
if (state.id,state.generation)==(id,generation) {state.failed=true;}
|
||||||
|
}
|
||||||
|
pub fn select(id:usize)->Result<(),String> {
|
||||||
|
let output=source(id).ok_or("Unknown Wayland screen")?;
|
||||||
|
#[cfg(all(target_os="linux",feature="wayland"))]
|
||||||
|
{
|
||||||
|
let name=std::ffi::CString::new(output.name.as_str()).map_err(|_|"Invalid output name")?;
|
||||||
|
let mut state=SELECTION.lock().unwrap();
|
||||||
|
if unsafe {uu_wl_select_output(name.as_ptr(),output.width,output.height)}!=0 {return Err("Wayland output switch failed".into());}
|
||||||
|
state.begin(id);
|
||||||
|
log::info!("Wayland screen selected: id={} source={}x{}",id,output.width,output.height);
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
#[cfg(not(all(target_os="linux",feature="wayland")))]
|
||||||
|
{let _=output;Err("Wayland output switching unavailable".into())}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// CaptureSettingRequest.screen_id is field 4 (rpc_main.proto); official desktop
|
||||||
|
/// activation also uses SimpleAction 8 {"screen_id":id}. Reference: openuuyc main
|
||||||
|
/// a87b8e7, stream_control/wire.rs and publisher/displays.rs (Windows S456070).
|
||||||
|
/// https://github.com/djkcyl/openuuyc/tree/a87b8e772c238e542215ab039f1b1d2ca4a9ef46/src/features/stream_control
|
||||||
|
/// Official phone acceptance on Hyprland: field 4 selected each advertised id;
|
||||||
|
/// current-source settings used the signed value -1.
|
||||||
|
pub fn requested_output(data:&[u8]) -> Option<usize> {
|
||||||
|
use crate::protocol::{decode_wire,WireValue};
|
||||||
|
let outer=decode_wire(data).ok()?;
|
||||||
|
fn bytes<'a>(fields:&[crate::protocol::WireField<'a>],n:u32)->Option<&'a [u8]> {fields.iter().find_map(|f|match f.value {WireValue::Bytes(b) if f.number==n=>Some(b),_=>None})}
|
||||||
|
if let Some(rpc)=bytes(&outer,21) {
|
||||||
|
let rpc=decode_wire(rpc).ok()?;
|
||||||
|
let request=decode_wire(bytes(&rpc,2)?).ok()?;
|
||||||
|
let id=request.iter().find_map(|f|match f.value {WireValue::Varint(v) if f.number==4=>Some(v as i64),_=>None}).unwrap_or(0);
|
||||||
|
return usize::try_from(id).ok();
|
||||||
|
}
|
||||||
|
let action=decode_wire(bytes(&outer,3)?).ok()?;
|
||||||
|
let kind=action.iter().find_map(|f|match f.value {WireValue::Varint(v) if f.number==1=>Some(v),_=>None})?;
|
||||||
|
if kind!=8 {return None;}
|
||||||
|
let args:serde_json::Value=serde_json::from_slice(bytes(&action,2)?).ok()?;
|
||||||
|
usize::try_from(args["screen_id"].as_i64()?).ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod monitor_switch_tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn capture_setting_screen_zero_and_signed_current_target() {
|
||||||
|
// Message.rpc_request(21), RpcRequest.capture_setting(2), screen_id(4).
|
||||||
|
let request=|payload:&[u8]| {let mut rpc=vec![18,payload.len() as u8];rpc.extend(payload);crate::initialization::envelope(1,2,21,&rpc)};
|
||||||
|
assert_eq!(requested_output(&request(&[32,1])),Some(1));
|
||||||
|
assert_eq!(requested_output(&request(&[])),Some(0));
|
||||||
|
assert_eq!(requested_output(&request(&[32,255,255,255,255,255,255,255,255,255,1])),None);
|
||||||
|
assert_eq!(requested_output(b"not protobuf"),None);
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn only_explicit_desktop_restart_selects_an_output() {
|
||||||
|
let request=|action:u8,args:&str| {let mut sa=vec![8,action,18,args.len() as u8];sa.extend(args.bytes());crate::initialization::envelope(1,2,3,&sa)};
|
||||||
|
assert_eq!(requested_output(&request(8,r#"{"screen_id":1}"#)),Some(1));
|
||||||
|
assert_eq!(requested_output(&request(8,r#"{"screen_id":-1}"#)),None);
|
||||||
|
assert_eq!(requested_output(&request(7,r#"{"screen_id":1}"#)),None);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod selection_regressions {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn old_frames_cannot_unlock_a_return_to_the_same_screen() {
|
||||||
|
let mut s=Selection::default();
|
||||||
|
s.begin(0);let old=s.generation;s.sent(0,old);assert!(s.ready());
|
||||||
|
s.begin(1);assert!(!s.ready());s.sent(0,old);assert!(!s.ready());
|
||||||
|
s.begin(0);let current=s.generation;
|
||||||
|
s.sent(0,old);assert!(!s.ready());
|
||||||
|
s.sent(1,current);assert!(!s.ready());
|
||||||
|
s.sent(0,current);assert!(s.ready());
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn mixed_scale_inventory_preserves_pixel_sizes_and_preferred_output() {
|
||||||
|
let json=br#"[{"name":"eDP-1","width":1920,"height":1080,"scale":1.3333334,"transform":0,"refreshRate":144},
|
||||||
|
{"name":"HDMI-A-1","width":2560,"height":1440,"scale":1.25,"transform":0,"refreshRate":75}]"#;
|
||||||
|
let outputs=parse_outputs(json,"HDMI-A-1").unwrap();
|
||||||
|
assert_eq!(outputs.iter().map(|m|(m.name.as_str(),m.width,m.height)).collect::<Vec<_>>(),
|
||||||
|
vec![("HDMI-A-1",2560,1440),("eDP-1",1920,1080)]);
|
||||||
|
assert!(parse_outputs(json,"missing-output").is_err());
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn unusable_outputs_are_not_advertised() {
|
||||||
|
let json=br#"[{"name":"rotated","width":1920,"height":1080,"transform":1,"refreshRate":60},
|
||||||
|
{"name":"too-large","width":16000,"height":16000,"transform":0,"refreshRate":60},
|
||||||
|
{"name":"off","width":1920,"height":1080,"disabled":true,"transform":0,"refreshRate":60},
|
||||||
|
{"name":"normal","width":1920,"height":1080,"transform":0,"refreshRate":60}]"#;
|
||||||
|
let outputs=parse_outputs(json,"").unwrap();
|
||||||
|
assert_eq!(outputs.len(),1);assert_eq!(outputs[0].name,"normal");
|
||||||
|
assert!(parse_outputs(b"not JSON","").is_err());
|
||||||
|
}
|
||||||
|
}
|
||||||
+98
-11
@@ -391,11 +391,14 @@ impl WebRtcSession {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Settings arrive on CONTROL or TEXT; serialize both queues for this peer.
|
||||||
|
let settings_serial=Arc::new(Mutex::new(()));
|
||||||
// 监听 DataChannel
|
// 监听 DataChannel
|
||||||
pc.on_data_channel(Box::new(move |d: Arc<RTCDataChannel>| {
|
pc.on_data_channel(Box::new(move |d: Arc<RTCDataChannel>| {
|
||||||
let label = d.label().to_string();
|
let label = d.label().to_string();
|
||||||
log::info!("New DataChannel received: {}", label);
|
log::info!("New DataChannel received: {}", label);
|
||||||
|
|
||||||
|
let peer_settings_serial=settings_serial.clone();
|
||||||
let input_inst = input_clone.clone();
|
let input_inst = input_clone.clone();
|
||||||
let channel_input_session=input_session.clone();
|
let channel_input_session=input_session.clone();
|
||||||
let screen = control_capture.clone();
|
let screen = control_capture.clone();
|
||||||
@@ -445,7 +448,7 @@ impl WebRtcSession {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
let (capture_tx, mut capture_rx) = tokio::sync::mpsc::channel::<Vec<u8>>(16);
|
let (capture_tx, mut capture_rx) = tokio::sync::mpsc::channel::<Vec<u8>>(16);
|
||||||
if label == "CONTROL_DATA_CHANNEL" {
|
if matches!(label.as_str(),"CONTROL_DATA_CHANNEL"|"TEXT_DATA_CHANNEL") {
|
||||||
let settings = channel_video_settings.clone();
|
let settings = channel_video_settings.clone();
|
||||||
let track = peer_video_track.clone();
|
let track = peer_video_track.clone();
|
||||||
let response_tx = outbound.clone();
|
let response_tx = outbound.clone();
|
||||||
@@ -453,6 +456,8 @@ impl WebRtcSession {
|
|||||||
let manager = portal_desktop.clone();
|
let manager = portal_desktop.clone();
|
||||||
let channel = Arc::downgrade(&d);
|
let channel = Arc::downgrade(&d);
|
||||||
let initial_screen = screen.clone();
|
let initial_screen = screen.clone();
|
||||||
|
let switch_owner=channel_input_session.clone();
|
||||||
|
let settings_serial=peer_settings_serial.clone();
|
||||||
tokio::spawn(async move {
|
tokio::spawn(async move {
|
||||||
let mut health = tokio::time::interval(std::time::Duration::from_millis(100));
|
let mut health = tokio::time::interval(std::time::Duration::from_millis(100));
|
||||||
loop {
|
loop {
|
||||||
@@ -467,6 +472,36 @@ impl WebRtcSession {
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
let _serial=settings_serial.lock().await;
|
||||||
|
if desktop && switch_owner.as_ref().is_none_or(|owner|!owner.is_current()) {continue;}
|
||||||
|
let reject=|reason:&str| {
|
||||||
|
if let Some(response)=crate::capture_setting::rejected_request(&request,reason) {
|
||||||
|
let ts=std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
|
||||||
|
let _=response_tx.send(crate::initialization::envelope(sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed),ts,22,&response));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let source_before=crate::wayland::selected();
|
||||||
|
let settings_before=*settings.borrow();
|
||||||
|
if desktop && !crate::wayland::outputs().is_empty() {
|
||||||
|
if let Some(id)=crate::wayland::requested_output(&request) {
|
||||||
|
if crate::wayland::source(id).is_none() {reject("Unknown screen");continue;}
|
||||||
|
if id!=source_before {
|
||||||
|
let mut changed=false;
|
||||||
|
if let Some(owner)=&switch_owner {owner.with_current(|| {
|
||||||
|
owner.release_input();
|
||||||
|
match crate::wayland::select(id) {
|
||||||
|
Ok(())=>{
|
||||||
|
let (source_id,source_generation)=crate::wayland::selection();
|
||||||
|
settings.send_modify(|s|{s.source_id=source_id;s.source_generation=source_generation;s.output=None;});
|
||||||
|
changed=true;
|
||||||
|
},
|
||||||
|
Err(error)=>{log::warn!("Screen switch rejected: {}",error);reject(&error);},
|
||||||
|
}
|
||||||
|
});}
|
||||||
|
if !changed {continue;}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
let active_screen = if desktop {
|
let active_screen = if desktop {
|
||||||
if let Some(manager) = &manager {
|
if let Some(manager) = &manager {
|
||||||
loop {
|
loop {
|
||||||
@@ -492,19 +527,66 @@ impl WebRtcSession {
|
|||||||
let input_size = if active_screen.init_error.is_none() {
|
let input_size = if active_screen.init_error.is_none() {
|
||||||
(active_screen.width, active_screen.height)
|
(active_screen.width, active_screen.height)
|
||||||
} else { (1920, 1080) };
|
} else { (1920, 1080) };
|
||||||
|
let input_size=crate::wayland::input_size(input_size);
|
||||||
|
let source_changed=source_before!=crate::wayland::selected();
|
||||||
|
if source_changed {
|
||||||
|
let target=crate::wayland::selection();
|
||||||
|
let deadline=tokio::time::Instant::now()+std::time::Duration::from_secs(10);
|
||||||
|
while crate::wayland::selection()==target && !crate::wayland::input_ready()
|
||||||
|
&& !crate::wayland::switch_failed() && tokio::time::Instant::now()<deadline {
|
||||||
|
if channel.upgrade().is_none_or(|c|c.ready_state()!=webrtc::data_channel::data_channel_state::RTCDataChannelState::Open)
|
||||||
|
|| switch_owner.as_ref().is_none_or(|owner|!owner.is_current()) {return;}
|
||||||
|
tokio::time::sleep(std::time::Duration::from_millis(20)).await;
|
||||||
|
}
|
||||||
|
if switch_owner.as_ref().is_none_or(|owner|!owner.is_current()) || crate::wayland::selection()!=target {continue;}
|
||||||
|
if !crate::wayland::input_ready() {
|
||||||
|
if let Some(owner)=&switch_owner {owner.with_current(|| {
|
||||||
|
if crate::wayland::selection()==target && crate::wayland::select(source_before).is_ok() {
|
||||||
|
let (source_id,source_generation)=crate::wayland::selection();
|
||||||
|
settings.send_replace(crate::capture_setting::VideoSettings {source_id,source_generation,..settings_before});
|
||||||
|
}
|
||||||
|
});}
|
||||||
|
log::warn!("Screen switch failed; previous source requested");
|
||||||
|
reject("Screen switch failed; restoring previous screen");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
let ts=std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
|
||||||
|
if let Ok(message)=crate::capture_setting::screen_sources(sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed),ts,input_size,None,"Linux desktop") {let _=response_tx.send(message);}
|
||||||
|
if let Ok(message)=crate::initialization::encode_capture_change(sequence.fetch_add(1,std::sync::atomic::Ordering::Relaxed),ts,0,crate::wayland::selected() as i32,"Linux desktop") {let _=response_tx.send(message);}
|
||||||
|
}
|
||||||
let Ok(fields) = crate::protocol::decode_wire(&request) else { continue; };
|
let Ok(fields) = crate::protocol::decode_wire(&request) else { continue; };
|
||||||
use crate::protocol::WireValue;
|
use crate::protocol::WireValue;
|
||||||
let Some(rpc) = fields.iter().find_map(|f| match (f.number, &f.value) {
|
let Some(rpc) = fields.iter().find_map(|f| match (f.number, &f.value) {
|
||||||
(21, WireValue::Bytes(rpc)) => Some(*rpc), _ => None,
|
(21, WireValue::Bytes(rpc)) => Some(*rpc), _ => None,
|
||||||
}) else { continue; };
|
}) else { continue; };
|
||||||
let Ok(rpc_fields) = crate::protocol::decode_wire(rpc) else { continue; };
|
let Ok(rpc_fields) = crate::protocol::decode_wire(rpc) else { continue; };
|
||||||
|
// X11: 分辨率 changes the display mode itself, like the official Windows host; the stream
|
||||||
|
// then carries the new native size instead of a scaled one (desktop_mode).
|
||||||
|
let resized = if desktop && active_screen.init_error.is_none() && active_screen.portal.is_none()
|
||||||
|
&& active_screen.backend == crate::desktop_backend::DesktopBackend::X11 && crate::desktop_mode::enabled() {
|
||||||
|
match crate::capture_setting::requested_resolution(&rpc_fields) {
|
||||||
|
Some(request) => {
|
||||||
|
let display = active_screen.display.clone();
|
||||||
|
tokio::task::spawn_blocking(move || crate::desktop_mode::apply(&display, request)).await.ok().flatten()
|
||||||
|
.filter(|size| *size != input_size)
|
||||||
|
},
|
||||||
|
None => None,
|
||||||
|
}
|
||||||
|
} else { None };
|
||||||
|
let input_size = resized.unwrap_or(input_size);
|
||||||
let before = *settings.borrow();
|
let before = *settings.borrow();
|
||||||
let output_before = before.output;
|
let output_before = before.output;
|
||||||
let revision = track.revision();
|
let revision = track.revision();
|
||||||
let Some(response) = crate::capture_setting::handle_rpc_with_codecs(
|
let apply=|| crate::capture_setting::handle_rpc_with_codecs(
|
||||||
&rpc_fields, &settings, input_size,
|
&rpc_fields, &settings, input_size,
|
||||||
track.supports(crate::capture_setting::VideoCodec::H264),
|
track.supports(crate::capture_setting::VideoCodec::H264),
|
||||||
track.supports(crate::capture_setting::VideoCodec::H265)) else { continue; };
|
track.supports(crate::capture_setting::VideoCodec::H265));
|
||||||
|
let response=if let Some(owner)=&switch_owner {
|
||||||
|
let mut response=None;owner.with_current(||response=apply());response
|
||||||
|
} else {apply()};
|
||||||
|
let Some(response)=response else {continue;};
|
||||||
|
// Restart capture even when the encoded settings are unchanged (native size, no scaling).
|
||||||
|
if resized.is_some() { settings.send_modify(|s| s.source_generation = s.source_generation.wrapping_add(1)); }
|
||||||
let codec_changed = settings.borrow().codec != before.codec;
|
let codec_changed = settings.borrow().codec != before.codec;
|
||||||
if desktop && codec_changed && !track.wait_for_applied(revision, &settings).await {
|
if desktop && codec_changed && !track.wait_for_applied(revision, &settings).await {
|
||||||
log::warn!("Codec switch did not produce a transmitted frame; success reply withheld");
|
log::warn!("Codec switch did not produce a transmitted frame; success reply withheld");
|
||||||
@@ -515,7 +597,7 @@ impl WebRtcSession {
|
|||||||
let next = || sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
|
let next = || sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
|
||||||
let _ = response_tx.send(crate::initialization::envelope(next(), timestamp, 22, &response));
|
let _ = response_tx.send(crate::initialization::envelope(next(), timestamp, 22, &response));
|
||||||
let current = *settings.borrow();
|
let current = *settings.borrow();
|
||||||
if current.output != output_before {
|
if current.output != output_before || resized.is_some() {
|
||||||
match crate::capture_setting::screen_sources(next(), timestamp, input_size, current.output, "Linux desktop") {
|
match crate::capture_setting::screen_sources(next(), timestamp, input_size, current.output, "Linux desktop") {
|
||||||
Ok(screens) => { let _ = response_tx.send(screens); }
|
Ok(screens) => { let _ = response_tx.send(screens); }
|
||||||
Err(error) => log::warn!("Screen sources update failed: {}", error),
|
Err(error) => log::warn!("Screen sources update failed: {}", error),
|
||||||
@@ -645,7 +727,7 @@ impl WebRtcSession {
|
|||||||
.duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
|
.duration_since(std::time::UNIX_EPOCH).unwrap_or_default().as_secs();
|
||||||
let message = crate::initialization::encode_capture_change(
|
let message = crate::initialization::encode_capture_change(
|
||||||
sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed),
|
sequence.fetch_add(1, std::sync::atomic::Ordering::Relaxed),
|
||||||
timestamp, 0, 0, "Linux desktop").expect("desktop capture type");
|
timestamp, 0, crate::wayland::selected() as i32, "Linux desktop").expect("desktop capture type");
|
||||||
if let Err(error) = channel.send(&bytes::Bytes::from(message)).await {
|
if let Err(error) = channel.send(&bytes::Bytes::from(message)).await {
|
||||||
log::error!("CONTROL desktop selection failed: {error}");
|
log::error!("CONTROL desktop selection failed: {error}");
|
||||||
return;
|
return;
|
||||||
@@ -733,9 +815,9 @@ impl WebRtcSession {
|
|||||||
} else { crate::system_metrics::Permission::Reject };
|
} else { crate::system_metrics::Permission::Reject };
|
||||||
// Without a desktop (headless/portal before consent) the port-mapping tool still waits
|
// Without a desktop (headless/portal before consent) the port-mapping tool still waits
|
||||||
// for ScreenSources/CaptureChange and aborts otherwise: tool peers get a nominal screen.
|
// for ScreenSources/CaptureChange and aborts otherwise: tool peers get a nominal screen.
|
||||||
let screen_size=if screen.init_error.is_none() { (screen.width, screen.height) } else { (1920, 1080) };
|
let screen_size=crate::wayland::input_size(if screen.init_error.is_none() { (screen.width, screen.height) } else { (1920, 1080) });
|
||||||
let messages = [
|
let messages = [
|
||||||
(8, crate::initialization::encode_capture_change(next_seq(), timestamp, 0, 0, "Linux desktop")),
|
(8, crate::initialization::encode_capture_change(next_seq(), timestamp, 0, crate::wayland::selected() as i32, "Linux desktop")),
|
||||||
(13, Ok(crate::initialization::envelope(next_seq(), timestamp, 13, &init_actions.metrics_payload(desktop_sound, desktop_permission)))),
|
(13, Ok(crate::initialization::envelope(next_seq(), timestamp, 13, &init_actions.metrics_payload(desktop_sound, desktop_permission)))),
|
||||||
(26, Ok(crate::initialization::envelope(next_seq(), timestamp, 26,
|
(26, Ok(crate::initialization::envelope(next_seq(), timestamp, 26,
|
||||||
&crate::system_metrics::remote_download_path(&home)))),
|
&crate::system_metrics::remote_download_path(&home)))),
|
||||||
@@ -822,11 +904,14 @@ impl WebRtcSession {
|
|||||||
let capture_requests = capture_tx.clone();
|
let capture_requests = capture_tx.clone();
|
||||||
|
|
||||||
Box::pin(async move {
|
Box::pin(async move {
|
||||||
let input_size = (screen.width, screen.height);
|
let input_size = crate::wayland::input_size((screen.width, screen.height));
|
||||||
|
// After a RandR resize the stream restarts capture at the new size; map the pointer to it.
|
||||||
|
let live_x11 = screen.init_error.is_none() && screen.portal.is_none() && screen.backend == crate::desktop_backend::DesktopBackend::X11;
|
||||||
if let Some(term) = &terminal_worker {
|
if let Some(term) = &terminal_worker {
|
||||||
if crate::terminal::is_frame(&msg.data) { term.handle(&msg.data); return; }
|
if crate::terminal::is_frame(&msg.data) { term.handle(&msg.data); return; }
|
||||||
}
|
}
|
||||||
if channel_name == "CONTROL_DATA_CHANNEL" && is_capture_setting_message(&msg.data) {
|
if matches!(channel_name.as_str(),"CONTROL_DATA_CHANNEL"|"TEXT_DATA_CHANNEL")
|
||||||
|
&& (is_capture_setting_message(&msg.data) || (!crate::wayland::outputs().is_empty() && crate::wayland::requested_output(&msg.data).is_some())) {
|
||||||
// Back-pressure like the old inline handler instead of dropping the latest setting.
|
// Back-pressure like the old inline handler instead of dropping the latest setting.
|
||||||
if capture_requests.send(msg.data.to_vec()).await.is_err() {
|
if capture_requests.send(msg.data.to_vec()).await.is_err() {
|
||||||
log::warn!("Capture setting queue closed; request dropped");
|
log::warn!("Capture setting queue closed; request dropped");
|
||||||
@@ -1070,7 +1155,7 @@ impl WebRtcSession {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
if let Ok(crate::control_protocol::ControlMessage::Input(crate::control_protocol::ControlInput::TextInput {text})) = crate::control_protocol::decode_control(&msg.data) {
|
if let Ok(crate::control_protocol::ControlMessage::Input(crate::control_protocol::ControlInput::TextInput {text})) = crate::control_protocol::decode_control(&msg.data) {
|
||||||
if let Some(session)=message_input_session.as_ref() { session.with_input(|| input_worker.text_input(&text)); }
|
if let Some(session)=message_input_session.as_ref() { session.with_input(|| {if crate::wayland::input_ready() {input_worker.text_input(&text);}}); }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if channel_name.contains("CONTROL") {
|
if channel_name.contains("CONTROL") {
|
||||||
@@ -1078,6 +1163,7 @@ impl WebRtcSession {
|
|||||||
Ok(crate::control_protocol::ControlMessage::Input(event)) => {
|
Ok(crate::control_protocol::ControlMessage::Input(event)) => {
|
||||||
if screen.backend == crate::desktop_backend::DesktopBackend::Portal
|
if screen.backend == crate::desktop_backend::DesktopBackend::Portal
|
||||||
&& (screen.init_error.is_some() || !desktop_ready || *lock_for_message.borrow() != Some(false)) { return; }
|
&& (screen.init_error.is_some() || !desktop_ready || *lock_for_message.borrow() != Some(false)) { return; }
|
||||||
|
if !crate::wayland::input_ready() {return;}
|
||||||
use crate::control_protocol::ControlInput;
|
use crate::control_protocol::ControlInput;
|
||||||
// Separate receipt budgets keep motion floods from hiding clicks.
|
// Separate receipt budgets keep motion floods from hiding clicks.
|
||||||
static RECEIPTS: [std::sync::atomic::AtomicUsize; 3] = [const { std::sync::atomic::AtomicUsize::new(0) }; 3];
|
static RECEIPTS: [std::sync::atomic::AtomicUsize; 3] = [const { std::sync::atomic::AtomicUsize::new(0) }; 3];
|
||||||
@@ -1090,8 +1176,9 @@ impl WebRtcSession {
|
|||||||
log::info!("CONTROL input received: kind={}", kind);
|
log::info!("CONTROL input received: kind={}", kind);
|
||||||
}
|
}
|
||||||
if let Some(session)=message_input_session.as_ref() {session.with_input(|| {
|
if let Some(session)=message_input_session.as_ref() {session.with_input(|| {
|
||||||
|
if !crate::wayland::input_ready() {return;}
|
||||||
match &event {
|
match &event {
|
||||||
ControlInput::MouseAbsolute {x,y} => input_worker.mouse_absolute_normalized(*x,*y,input_size),
|
ControlInput::MouseAbsolute {x,y} => input_worker.mouse_absolute_normalized(*x,*y,crate::wayland::input_size(if live_x11 {crate::capture::x11_last_size().unwrap_or(input_size)} else {input_size})),
|
||||||
ControlInput::MouseRelative {dx,dy} => input_worker.mouse_relative(*dx,*dy),
|
ControlInput::MouseRelative {dx,dy} => input_worker.mouse_relative(*dx,*dy),
|
||||||
ControlInput::MouseScroll {dx,dy} => input_worker.mouse_scroll(*dx,*dy),
|
ControlInput::MouseScroll {dx,dy} => input_worker.mouse_scroll(*dx,*dy),
|
||||||
ControlInput::Keyboard {key, pressed} => input_worker.windows_key_event(*key, *pressed),
|
ControlInput::Keyboard {key, pressed} => input_worker.windows_key_event(*key, *pressed),
|
||||||
|
|||||||
+123
@@ -0,0 +1,123 @@
|
|||||||
|
//! Experimental Wake-on-LAN helper (`UU_WOL_HELPER=1`, off by default).
|
||||||
|
//!
|
||||||
|
//! The official Windows host (GameViewerServer: LoginManager::reportLanInfo, PushMessageHandler::wakeOnLan,
|
||||||
|
//! wake_on_lan.cpp host::send_wol) reports its LAN address to `api-ipv4…/api/v1/device/wake_on_lan/info`
|
||||||
|
//! after sign-in (logged as "mac / ip / subnet_mask", response carries `turn_on_wol`), and on a
|
||||||
|
//! `wake_on_lan` cloud push with a `target_device` {mac, ip, subnet_mask} it sends a magic packet to that
|
||||||
|
//! subnet's broadcast address, waking another PC of the account on the same LAN. The exact request and
|
||||||
|
//! push field names come from the official log strings only; nothing here is verified end to end yet.
|
||||||
|
//! Addresses are sent to NetEase only when the helper is enabled and are never logged.
|
||||||
|
|
||||||
|
use std::net::{Ipv4Addr, SocketAddrV4, UdpSocket};
|
||||||
|
|
||||||
|
pub fn enabled() -> bool { std::env::var("UU_WOL_HELPER").is_ok_and(|v| v == "1") }
|
||||||
|
|
||||||
|
/// `aa:bb:cc:dd:ee:ff` / `aa-bb-…` / `aabbcc…` → 6 bytes.
|
||||||
|
pub fn parse_mac(text: &str) -> Option<[u8; 6]> {
|
||||||
|
let hex: String = text.chars().filter(|c| c.is_ascii_hexdigit()).collect();
|
||||||
|
if hex.len() != 12 || text.chars().any(|c| !(c.is_ascii_hexdigit() || matches!(c, ':' | '-' | '.'))) { return None; }
|
||||||
|
let mut mac = [0u8; 6];
|
||||||
|
for (i, byte) in mac.iter_mut().enumerate() { *byte = u8::from_str_radix(&hex[i * 2..i * 2 + 2], 16).ok()?; }
|
||||||
|
(mac != [0; 6] && mac != [0xff; 6]).then_some(mac)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Six 0xFF bytes followed by the MAC sixteen times.
|
||||||
|
pub fn magic_packet(mac: [u8; 6]) -> Vec<u8> {
|
||||||
|
let mut packet = vec![0xff; 6];
|
||||||
|
for _ in 0..16 { packet.extend_from_slice(&mac); }
|
||||||
|
packet
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Directed broadcast of `ip`/`mask`, or None when either is missing or invalid.
|
||||||
|
pub fn subnet_broadcast(ip: &str, mask: &str) -> Option<Ipv4Addr> {
|
||||||
|
let (ip, mask): (Ipv4Addr, Ipv4Addr) = (ip.parse().ok()?, mask.parse().ok()?);
|
||||||
|
let mask = u32::from(mask);
|
||||||
|
if mask == 0 || mask.leading_ones() + mask.trailing_zeros() != 32 { return None; }
|
||||||
|
Some(Ipv4Addr::from(u32::from(ip) | !mask))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Handles a `wake_on_lan` push payload; returns how many datagrams were sent.
|
||||||
|
pub fn handle_push(data: &serde_json::Value) -> Result<usize, String> {
|
||||||
|
let target = data.get("target_device").or_else(|| data.get("data").and_then(|d| d.get("target_device")))
|
||||||
|
.ok_or("wake_on_lan push without target_device")?;
|
||||||
|
let text = |key: &str| target.get(key).and_then(serde_json::Value::as_str).unwrap_or("");
|
||||||
|
let mac = parse_mac(text("mac")).ok_or("wake_on_lan target has no valid mac")?;
|
||||||
|
let packet = magic_packet(mac);
|
||||||
|
let socket = UdpSocket::bind("0.0.0.0:0").map_err(|e| format!("WOL socket: {}", e.kind()))?;
|
||||||
|
socket.set_broadcast(true).map_err(|e| format!("WOL broadcast: {}", e.kind()))?;
|
||||||
|
let mut targets = vec![Ipv4Addr::BROADCAST];
|
||||||
|
if let Some(directed) = subnet_broadcast(text("ip"), text("subnet_mask")) { targets.insert(0, directed); }
|
||||||
|
let mut sent = 0;
|
||||||
|
for address in targets { for port in [9, 7] {
|
||||||
|
if socket.send_to(&packet, SocketAddrV4::new(address, port)).is_ok() { sent += 1; }
|
||||||
|
} }
|
||||||
|
if sent == 0 { return Err("WOL packet could not be sent".into()); }
|
||||||
|
Ok(sent)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This host's LAN identity on the default IPv4 route: (mac, ip, subnet mask).
|
||||||
|
#[cfg(target_os = "linux")]
|
||||||
|
pub fn lan_info() -> Option<(String, String, String)> {
|
||||||
|
let routes = std::fs::read_to_string("/proc/net/route").ok()?;
|
||||||
|
let iface = routes.lines().skip(1).map(|l| l.split_whitespace().collect::<Vec<_>>())
|
||||||
|
.find(|f| f.len() > 2 && f[1] == "00000000")?.first()?.to_string();
|
||||||
|
let mac = std::fs::read_to_string(format!("/sys/class/net/{iface}/address")).ok()?.trim().to_owned();
|
||||||
|
parse_mac(&mac)?;
|
||||||
|
let mut addrs: *mut libc::ifaddrs = std::ptr::null_mut();
|
||||||
|
if unsafe { libc::getifaddrs(&mut addrs) } != 0 { return None; }
|
||||||
|
let mut result = None;
|
||||||
|
let mut cursor = addrs;
|
||||||
|
while !cursor.is_null() {
|
||||||
|
let entry = unsafe { &*cursor };
|
||||||
|
cursor = entry.ifa_next;
|
||||||
|
if entry.ifa_addr.is_null() || entry.ifa_netmask.is_null() { continue; }
|
||||||
|
let name = unsafe { std::ffi::CStr::from_ptr(entry.ifa_name) }.to_string_lossy();
|
||||||
|
if name != iface.as_str() || i32::from(unsafe { (*entry.ifa_addr).sa_family }) != libc::AF_INET { continue; }
|
||||||
|
let v4 = |p: *mut libc::sockaddr| Ipv4Addr::from(u32::from_be(unsafe { (*(p as *const libc::sockaddr_in)).sin_addr.s_addr }));
|
||||||
|
result = Some((mac.clone(), v4(entry.ifa_addr).to_string(), v4(entry.ifa_netmask).to_string()));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
unsafe { libc::freeifaddrs(addrs) };
|
||||||
|
result
|
||||||
|
}
|
||||||
|
#[cfg(not(target_os = "linux"))]
|
||||||
|
pub fn lan_info() -> Option<(String, String, String)> { None }
|
||||||
|
|
||||||
|
/// Report this host's LAN identity like the official host after sign-in.
|
||||||
|
pub async fn report(auth: &crate::auth::UUAuthClient) {
|
||||||
|
let Some((mac, ip, subnet_mask)) = lan_info() else { log::warn!("WOL helper: no IPv4 default-route interface"); return; };
|
||||||
|
let body = serde_json::json!({ "mac": mac, "ip": ip, "subnet_mask": subnet_mask });
|
||||||
|
match auth.post_json_url("https://api-ipv4.nrd.nie.163.com", "/api/v1/device/wake_on_lan/info", &body).await {
|
||||||
|
Ok((status, value)) => log::info!("WOL helper: LAN info reported: status={status} code={:?} turn_on_wol={:?}",
|
||||||
|
value.get("code").and_then(serde_json::Value::as_i64),
|
||||||
|
value.get("data").and_then(|d| d.get("turn_on_wol")).or_else(|| value.get("turn_on_wol"))),
|
||||||
|
Err(error) => log::warn!("WOL helper: LAN info report failed: {error}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn mac_parsing_and_packet() {
|
||||||
|
assert_eq!(parse_mac("AA:bb:cc:dd:ee:01"), Some([0xaa, 0xbb, 0xcc, 0xdd, 0xee, 1]));
|
||||||
|
assert_eq!(parse_mac("aa-bb-cc-dd-ee-01"), parse_mac("aabbccddee01"));
|
||||||
|
assert!(parse_mac("aa:bb:cc").is_none() && parse_mac("zz:bb:cc:dd:ee:01").is_none() && parse_mac("00:00:00:00:00:00").is_none());
|
||||||
|
let packet = magic_packet([1, 2, 3, 4, 5, 6]);
|
||||||
|
assert_eq!(packet.len(), 102);
|
||||||
|
assert_eq!(&packet[..6], &[0xff; 6]);
|
||||||
|
assert_eq!(&packet[96..], &[1, 2, 3, 4, 5, 6]);
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn directed_broadcast() {
|
||||||
|
assert_eq!(subnet_broadcast("192.168.2.29", "255.255.255.0"), Some(Ipv4Addr::new(192, 168, 2, 255)));
|
||||||
|
assert_eq!(subnet_broadcast("10.1.2.3", "255.255.0.0"), Some(Ipv4Addr::new(10, 1, 255, 255)));
|
||||||
|
assert_eq!(subnet_broadcast("10.1.2.3", "255.0.255.0"), None);
|
||||||
|
assert_eq!(subnet_broadcast("", "255.255.255.0"), None);
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn push_without_target_is_rejected() {
|
||||||
|
assert!(handle_push(&serde_json::json!({})).is_err());
|
||||||
|
assert!(handle_push(&serde_json::json!({"target_device": {"mac": "nope"}})).is_err());
|
||||||
|
}
|
||||||
|
}
|
||||||
Vendored
+4
@@ -0,0 +1,4 @@
|
|||||||
|
`ffnvcodec/dynlink_cuda.h` and `ffnvcodec/nvEncodeAPI.h` are unmodified copies from
|
||||||
|
[nv-codec-headers](https://github.com/FFmpeg/nv-codec-headers) tag `n12.1.14.0`
|
||||||
|
(NVENC API 12.1, the version FFmpeg 6.1 builds against; NVIDIA Linux driver 530.41 or newer).
|
||||||
|
MIT licensed, see the header comments. Only the in-process NVENC engine (`--features inproc-av`) uses them.
|
||||||
+518
@@ -0,0 +1,518 @@
|
|||||||
|
/*
|
||||||
|
* This copyright notice applies to this header file only:
|
||||||
|
*
|
||||||
|
* Copyright (c) 2016
|
||||||
|
*
|
||||||
|
* Permission is hereby granted, free of charge, to any person
|
||||||
|
* obtaining a copy of this software and associated documentation
|
||||||
|
* files (the "Software"), to deal in the Software without
|
||||||
|
* restriction, including without limitation the rights to use,
|
||||||
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
* copies of the software, and to permit persons to whom the
|
||||||
|
* software is furnished to do so, subject to the following
|
||||||
|
* conditions:
|
||||||
|
*
|
||||||
|
* The above copyright notice and this permission notice shall be
|
||||||
|
* included in all copies or substantial portions of the Software.
|
||||||
|
*
|
||||||
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||||
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||||
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||||
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||||
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||||
|
* OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#if !defined(FFNV_DYNLINK_CUDA_H) && !defined(CUDA_VERSION)
|
||||||
|
#define FFNV_DYNLINK_CUDA_H
|
||||||
|
|
||||||
|
#include <stddef.h>
|
||||||
|
#include <stdint.h>
|
||||||
|
|
||||||
|
#define CUDA_VERSION 7050
|
||||||
|
|
||||||
|
#if defined(_WIN32) || defined(__CYGWIN__)
|
||||||
|
#define CUDAAPI __stdcall
|
||||||
|
#else
|
||||||
|
#define CUDAAPI
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#define CU_CTX_SCHED_BLOCKING_SYNC 4
|
||||||
|
|
||||||
|
typedef int CUdevice;
|
||||||
|
#if defined(__x86_64) || defined(AMD64) || defined(_M_AMD64) || defined(__LP64__) || defined(__aarch64__)
|
||||||
|
typedef unsigned long long CUdeviceptr;
|
||||||
|
#else
|
||||||
|
typedef unsigned int CUdeviceptr;
|
||||||
|
#endif
|
||||||
|
typedef unsigned long long CUtexObject;
|
||||||
|
|
||||||
|
typedef struct CUarray_st *CUarray;
|
||||||
|
typedef struct CUctx_st *CUcontext;
|
||||||
|
typedef struct CUstream_st *CUstream;
|
||||||
|
typedef struct CUevent_st *CUevent;
|
||||||
|
typedef struct CUfunc_st *CUfunction;
|
||||||
|
typedef struct CUmod_st *CUmodule;
|
||||||
|
typedef struct CUmipmappedArray_st *CUmipmappedArray;
|
||||||
|
typedef struct CUgraphicsResource_st *CUgraphicsResource;
|
||||||
|
typedef struct CUextMemory_st *CUexternalMemory;
|
||||||
|
typedef struct CUextSemaphore_st *CUexternalSemaphore;
|
||||||
|
typedef struct CUeglStreamConnection_st *CUeglStreamConnection;
|
||||||
|
|
||||||
|
typedef struct CUlinkState_st *CUlinkState;
|
||||||
|
|
||||||
|
typedef enum cudaError_enum {
|
||||||
|
CUDA_SUCCESS = 0,
|
||||||
|
CUDA_ERROR_NOT_READY = 600,
|
||||||
|
CUDA_ERROR_LAUNCH_TIMEOUT = 702,
|
||||||
|
CUDA_ERROR_UNKNOWN = 999
|
||||||
|
} CUresult;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Device properties (subset)
|
||||||
|
*/
|
||||||
|
typedef enum CUdevice_attribute_enum {
|
||||||
|
CU_DEVICE_ATTRIBUTE_CLOCK_RATE = 13,
|
||||||
|
CU_DEVICE_ATTRIBUTE_TEXTURE_ALIGNMENT = 14,
|
||||||
|
CU_DEVICE_ATTRIBUTE_MULTIPROCESSOR_COUNT = 16,
|
||||||
|
CU_DEVICE_ATTRIBUTE_INTEGRATED = 18,
|
||||||
|
CU_DEVICE_ATTRIBUTE_CAN_MAP_HOST_MEMORY = 19,
|
||||||
|
CU_DEVICE_ATTRIBUTE_COMPUTE_MODE = 20,
|
||||||
|
CU_DEVICE_ATTRIBUTE_CONCURRENT_KERNELS = 31,
|
||||||
|
CU_DEVICE_ATTRIBUTE_PCI_BUS_ID = 33,
|
||||||
|
CU_DEVICE_ATTRIBUTE_PCI_DEVICE_ID = 34,
|
||||||
|
CU_DEVICE_ATTRIBUTE_TCC_DRIVER = 35,
|
||||||
|
CU_DEVICE_ATTRIBUTE_MEMORY_CLOCK_RATE = 36,
|
||||||
|
CU_DEVICE_ATTRIBUTE_GLOBAL_MEMORY_BUS_WIDTH = 37,
|
||||||
|
CU_DEVICE_ATTRIBUTE_ASYNC_ENGINE_COUNT = 40,
|
||||||
|
CU_DEVICE_ATTRIBUTE_UNIFIED_ADDRESSING = 41,
|
||||||
|
CU_DEVICE_ATTRIBUTE_PCI_DOMAIN_ID = 50,
|
||||||
|
CU_DEVICE_ATTRIBUTE_TEXTURE_PITCH_ALIGNMENT = 51,
|
||||||
|
CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MAJOR = 75,
|
||||||
|
CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MINOR = 76,
|
||||||
|
CU_DEVICE_ATTRIBUTE_MANAGED_MEMORY = 83,
|
||||||
|
CU_DEVICE_ATTRIBUTE_MULTI_GPU_BOARD = 84,
|
||||||
|
CU_DEVICE_ATTRIBUTE_MULTI_GPU_BOARD_GROUP_ID = 85,
|
||||||
|
} CUdevice_attribute;
|
||||||
|
|
||||||
|
typedef enum CUarray_format_enum {
|
||||||
|
CU_AD_FORMAT_UNSIGNED_INT8 = 0x01,
|
||||||
|
CU_AD_FORMAT_UNSIGNED_INT16 = 0x02,
|
||||||
|
CU_AD_FORMAT_UNSIGNED_INT32 = 0x03,
|
||||||
|
CU_AD_FORMAT_SIGNED_INT8 = 0x08,
|
||||||
|
CU_AD_FORMAT_SIGNED_INT16 = 0x09,
|
||||||
|
CU_AD_FORMAT_SIGNED_INT32 = 0x0a,
|
||||||
|
CU_AD_FORMAT_HALF = 0x10,
|
||||||
|
CU_AD_FORMAT_FLOAT = 0x20
|
||||||
|
} CUarray_format;
|
||||||
|
|
||||||
|
typedef enum CUmemorytype_enum {
|
||||||
|
CU_MEMORYTYPE_HOST = 1,
|
||||||
|
CU_MEMORYTYPE_DEVICE = 2,
|
||||||
|
CU_MEMORYTYPE_ARRAY = 3
|
||||||
|
} CUmemorytype;
|
||||||
|
|
||||||
|
typedef enum CUlimit_enum {
|
||||||
|
CU_LIMIT_STACK_SIZE = 0,
|
||||||
|
CU_LIMIT_PRINTF_FIFO_SIZE = 1,
|
||||||
|
CU_LIMIT_MALLOC_HEAP_SIZE = 2,
|
||||||
|
CU_LIMIT_DEV_RUNTIME_SYNC_DEPTH = 3,
|
||||||
|
CU_LIMIT_DEV_RUNTIME_PENDING_LAUNCH_COUNT = 4
|
||||||
|
} CUlimit;
|
||||||
|
|
||||||
|
typedef enum CUresourcetype_enum {
|
||||||
|
CU_RESOURCE_TYPE_ARRAY = 0x00,
|
||||||
|
CU_RESOURCE_TYPE_MIPMAPPED_ARRAY = 0x01,
|
||||||
|
CU_RESOURCE_TYPE_LINEAR = 0x02,
|
||||||
|
CU_RESOURCE_TYPE_PITCH2D = 0x03
|
||||||
|
} CUresourcetype;
|
||||||
|
|
||||||
|
typedef enum CUaddress_mode_enum {
|
||||||
|
CU_TR_ADDRESS_MODE_WRAP = 0,
|
||||||
|
CU_TR_ADDRESS_MODE_CLAMP = 1,
|
||||||
|
CU_TR_ADDRESS_MODE_MIRROR = 2,
|
||||||
|
CU_TR_ADDRESS_MODE_BORDER = 3
|
||||||
|
} CUaddress_mode;
|
||||||
|
|
||||||
|
typedef enum CUfilter_mode_enum {
|
||||||
|
CU_TR_FILTER_MODE_POINT = 0,
|
||||||
|
CU_TR_FILTER_MODE_LINEAR = 1
|
||||||
|
} CUfilter_mode;
|
||||||
|
|
||||||
|
typedef enum CUgraphicsRegisterFlags_enum {
|
||||||
|
CU_GRAPHICS_REGISTER_FLAGS_NONE = 0,
|
||||||
|
CU_GRAPHICS_REGISTER_FLAGS_READ_ONLY = 1,
|
||||||
|
CU_GRAPHICS_REGISTER_FLAGS_WRITE_DISCARD = 2,
|
||||||
|
CU_GRAPHICS_REGISTER_FLAGS_SURFACE_LDST = 4,
|
||||||
|
CU_GRAPHICS_REGISTER_FLAGS_TEXTURE_GATHER = 8
|
||||||
|
} CUgraphicsRegisterFlags;
|
||||||
|
|
||||||
|
typedef enum CUexternalMemoryHandleType_enum {
|
||||||
|
CU_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_FD = 1,
|
||||||
|
CU_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32 = 2,
|
||||||
|
CU_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT = 3,
|
||||||
|
CU_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP = 4,
|
||||||
|
CU_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE = 5,
|
||||||
|
} CUexternalMemoryHandleType;
|
||||||
|
|
||||||
|
typedef enum CUexternalSemaphoreHandleType_enum {
|
||||||
|
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_FD = 1,
|
||||||
|
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32 = 2,
|
||||||
|
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT = 3,
|
||||||
|
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE = 4,
|
||||||
|
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_TIMELINE_SEMAPHORE_FD = 9,
|
||||||
|
CU_EXTERNAL_SEMAPHORE_HANDLE_TYPE_TIMELINE_SEMAPHORE_WIN32 = 10,
|
||||||
|
} CUexternalSemaphoreHandleType;
|
||||||
|
|
||||||
|
typedef enum CUjit_option_enum
|
||||||
|
{
|
||||||
|
CU_JIT_MAX_REGISTERS = 0,
|
||||||
|
CU_JIT_THREADS_PER_BLOCK = 1,
|
||||||
|
CU_JIT_WALL_TIME = 2,
|
||||||
|
CU_JIT_INFO_LOG_BUFFER = 3,
|
||||||
|
CU_JIT_INFO_LOG_BUFFER_SIZE_BYTES = 4,
|
||||||
|
CU_JIT_ERROR_LOG_BUFFER = 5,
|
||||||
|
CU_JIT_ERROR_LOG_BUFFER_SIZE_BYTES = 6,
|
||||||
|
CU_JIT_OPTIMIZATION_LEVEL = 7,
|
||||||
|
CU_JIT_TARGET_FROM_CUCONTEXT = 8,
|
||||||
|
CU_JIT_TARGET = 9,
|
||||||
|
CU_JIT_FALLBACK_STRATEGY = 10,
|
||||||
|
CU_JIT_GENERATE_DEBUG_INFO = 11,
|
||||||
|
CU_JIT_LOG_VERBOSE = 12,
|
||||||
|
CU_JIT_GENERATE_LINE_INFO = 13,
|
||||||
|
CU_JIT_CACHE_MODE = 14,
|
||||||
|
CU_JIT_NEW_SM3X_OPT = 15,
|
||||||
|
CU_JIT_FAST_COMPILE = 16,
|
||||||
|
CU_JIT_GLOBAL_SYMBOL_NAMES = 17,
|
||||||
|
CU_JIT_GLOBAL_SYMBOL_ADDRESSES = 18,
|
||||||
|
CU_JIT_GLOBAL_SYMBOL_COUNT = 19,
|
||||||
|
CU_JIT_NUM_OPTIONS
|
||||||
|
} CUjit_option;
|
||||||
|
|
||||||
|
typedef enum CUjitInputType_enum
|
||||||
|
{
|
||||||
|
CU_JIT_INPUT_CUBIN = 0,
|
||||||
|
CU_JIT_INPUT_PTX = 1,
|
||||||
|
CU_JIT_INPUT_FATBINARY = 2,
|
||||||
|
CU_JIT_INPUT_OBJECT = 3,
|
||||||
|
CU_JIT_INPUT_LIBRARY = 4,
|
||||||
|
CU_JIT_NUM_INPUT_TYPES
|
||||||
|
} CUjitInputType;
|
||||||
|
|
||||||
|
typedef enum CUeglFrameType
|
||||||
|
{
|
||||||
|
CU_EGL_FRAME_TYPE_ARRAY = 0,
|
||||||
|
CU_EGL_FRAME_TYPE_PITCH = 1,
|
||||||
|
} CUeglFrameType;
|
||||||
|
|
||||||
|
typedef enum CUeglColorFormat
|
||||||
|
{
|
||||||
|
CU_EGL_COLOR_FORMAT_YUV420_PLANAR = 0x00,
|
||||||
|
CU_EGL_COLOR_FORMAT_YUV420_SEMIPLANAR = 0x01,
|
||||||
|
CU_EGL_COLOR_FORMAT_YVU420_SEMIPLANAR = 0x15,
|
||||||
|
CU_EGL_COLOR_FORMAT_Y10V10U10_420_SEMIPLANAR = 0x17,
|
||||||
|
CU_EGL_COLOR_FORMAT_Y12V12U12_420_SEMIPLANAR = 0x19,
|
||||||
|
} CUeglColorFormat;
|
||||||
|
|
||||||
|
typedef enum CUd3d11DeviceList_enum
|
||||||
|
{
|
||||||
|
CU_D3D11_DEVICE_LIST_ALL = 1,
|
||||||
|
CU_D3D11_DEVICE_LIST_CURRENT_FRAME = 2,
|
||||||
|
CU_D3D11_DEVICE_LIST_NEXT_FRAME = 3,
|
||||||
|
} CUd3d11DeviceList;
|
||||||
|
|
||||||
|
#ifndef CU_UUID_HAS_BEEN_DEFINED
|
||||||
|
#define CU_UUID_HAS_BEEN_DEFINED
|
||||||
|
typedef struct CUuuid_st {
|
||||||
|
char bytes[16];
|
||||||
|
} CUuuid;
|
||||||
|
#endif
|
||||||
|
|
||||||
|
typedef struct CUDA_MEMCPY2D_st {
|
||||||
|
size_t srcXInBytes;
|
||||||
|
size_t srcY;
|
||||||
|
CUmemorytype srcMemoryType;
|
||||||
|
const void *srcHost;
|
||||||
|
CUdeviceptr srcDevice;
|
||||||
|
CUarray srcArray;
|
||||||
|
size_t srcPitch;
|
||||||
|
|
||||||
|
size_t dstXInBytes;
|
||||||
|
size_t dstY;
|
||||||
|
CUmemorytype dstMemoryType;
|
||||||
|
void *dstHost;
|
||||||
|
CUdeviceptr dstDevice;
|
||||||
|
CUarray dstArray;
|
||||||
|
size_t dstPitch;
|
||||||
|
|
||||||
|
size_t WidthInBytes;
|
||||||
|
size_t Height;
|
||||||
|
} CUDA_MEMCPY2D;
|
||||||
|
|
||||||
|
typedef struct CUDA_RESOURCE_DESC_st {
|
||||||
|
CUresourcetype resType;
|
||||||
|
union {
|
||||||
|
struct {
|
||||||
|
CUarray hArray;
|
||||||
|
} array;
|
||||||
|
struct {
|
||||||
|
CUmipmappedArray hMipmappedArray;
|
||||||
|
} mipmap;
|
||||||
|
struct {
|
||||||
|
CUdeviceptr devPtr;
|
||||||
|
CUarray_format format;
|
||||||
|
unsigned int numChannels;
|
||||||
|
size_t sizeInBytes;
|
||||||
|
} linear;
|
||||||
|
struct {
|
||||||
|
CUdeviceptr devPtr;
|
||||||
|
CUarray_format format;
|
||||||
|
unsigned int numChannels;
|
||||||
|
size_t width;
|
||||||
|
size_t height;
|
||||||
|
size_t pitchInBytes;
|
||||||
|
} pitch2D;
|
||||||
|
struct {
|
||||||
|
int reserved[32];
|
||||||
|
} reserved;
|
||||||
|
} res;
|
||||||
|
unsigned int flags;
|
||||||
|
} CUDA_RESOURCE_DESC;
|
||||||
|
|
||||||
|
typedef struct CUDA_TEXTURE_DESC_st {
|
||||||
|
CUaddress_mode addressMode[3];
|
||||||
|
CUfilter_mode filterMode;
|
||||||
|
unsigned int flags;
|
||||||
|
unsigned int maxAnisotropy;
|
||||||
|
CUfilter_mode mipmapFilterMode;
|
||||||
|
float mipmapLevelBias;
|
||||||
|
float minMipmapLevelClamp;
|
||||||
|
float maxMipmapLevelClamp;
|
||||||
|
float borderColor[4];
|
||||||
|
int reserved[12];
|
||||||
|
} CUDA_TEXTURE_DESC;
|
||||||
|
|
||||||
|
/* Unused type */
|
||||||
|
typedef struct CUDA_RESOURCE_VIEW_DESC_st CUDA_RESOURCE_VIEW_DESC;
|
||||||
|
|
||||||
|
typedef unsigned int GLenum;
|
||||||
|
typedef unsigned int GLuint;
|
||||||
|
/*
|
||||||
|
* Prefix type name to avoid collisions. Clients using these types
|
||||||
|
* will include the real headers with real definitions.
|
||||||
|
*/
|
||||||
|
typedef int32_t ffnv_EGLint;
|
||||||
|
typedef void *ffnv_EGLStreamKHR;
|
||||||
|
|
||||||
|
typedef enum CUGLDeviceList_enum {
|
||||||
|
CU_GL_DEVICE_LIST_ALL = 1,
|
||||||
|
CU_GL_DEVICE_LIST_CURRENT_FRAME = 2,
|
||||||
|
CU_GL_DEVICE_LIST_NEXT_FRAME = 3,
|
||||||
|
} CUGLDeviceList;
|
||||||
|
|
||||||
|
typedef struct CUDA_EXTERNAL_MEMORY_HANDLE_DESC_st {
|
||||||
|
CUexternalMemoryHandleType type;
|
||||||
|
union {
|
||||||
|
int fd;
|
||||||
|
struct {
|
||||||
|
void *handle;
|
||||||
|
const void *name;
|
||||||
|
} win32;
|
||||||
|
} handle;
|
||||||
|
unsigned long long size;
|
||||||
|
unsigned int flags;
|
||||||
|
unsigned int reserved[16];
|
||||||
|
} CUDA_EXTERNAL_MEMORY_HANDLE_DESC;
|
||||||
|
|
||||||
|
typedef struct CUDA_EXTERNAL_MEMORY_BUFFER_DESC_st {
|
||||||
|
unsigned long long offset;
|
||||||
|
unsigned long long size;
|
||||||
|
unsigned int flags;
|
||||||
|
unsigned int reserved[16];
|
||||||
|
} CUDA_EXTERNAL_MEMORY_BUFFER_DESC;
|
||||||
|
|
||||||
|
typedef struct CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC_st {
|
||||||
|
CUexternalSemaphoreHandleType type;
|
||||||
|
union {
|
||||||
|
int fd;
|
||||||
|
struct {
|
||||||
|
void *handle;
|
||||||
|
const void *name;
|
||||||
|
} win32;
|
||||||
|
} handle;
|
||||||
|
unsigned int flags;
|
||||||
|
unsigned int reserved[16];
|
||||||
|
} CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC;
|
||||||
|
|
||||||
|
typedef struct CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS_st {
|
||||||
|
struct {
|
||||||
|
struct {
|
||||||
|
unsigned long long value;
|
||||||
|
} fence;
|
||||||
|
unsigned int reserved[16];
|
||||||
|
} params;
|
||||||
|
unsigned int flags;
|
||||||
|
unsigned int reserved[16];
|
||||||
|
} CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS;
|
||||||
|
|
||||||
|
typedef CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS CUDA_EXTERNAL_SEMAPHORE_WAIT_PARAMS;
|
||||||
|
|
||||||
|
typedef struct CUDA_ARRAY_DESCRIPTOR_st {
|
||||||
|
size_t Width;
|
||||||
|
size_t Height;
|
||||||
|
|
||||||
|
CUarray_format Format;
|
||||||
|
unsigned int NumChannels;
|
||||||
|
} CUDA_ARRAY_DESCRIPTOR;
|
||||||
|
|
||||||
|
typedef struct CUDA_ARRAY3D_DESCRIPTOR_st {
|
||||||
|
size_t Width;
|
||||||
|
size_t Height;
|
||||||
|
size_t Depth;
|
||||||
|
|
||||||
|
CUarray_format Format;
|
||||||
|
unsigned int NumChannels;
|
||||||
|
unsigned int Flags;
|
||||||
|
} CUDA_ARRAY3D_DESCRIPTOR;
|
||||||
|
|
||||||
|
typedef struct CUDA_EXTERNAL_MEMORY_MIPMAPPED_ARRAY_DESC_st {
|
||||||
|
unsigned long long offset;
|
||||||
|
CUDA_ARRAY3D_DESCRIPTOR arrayDesc;
|
||||||
|
unsigned int numLevels;
|
||||||
|
unsigned int reserved[16];
|
||||||
|
} CUDA_EXTERNAL_MEMORY_MIPMAPPED_ARRAY_DESC;
|
||||||
|
|
||||||
|
#define CU_EGL_FRAME_MAX_PLANES 3
|
||||||
|
typedef struct CUeglFrame_st {
|
||||||
|
union {
|
||||||
|
CUarray pArray[CU_EGL_FRAME_MAX_PLANES];
|
||||||
|
void* pPitch[CU_EGL_FRAME_MAX_PLANES];
|
||||||
|
} frame;
|
||||||
|
unsigned int width;
|
||||||
|
unsigned int height;
|
||||||
|
unsigned int depth;
|
||||||
|
unsigned int pitch;
|
||||||
|
unsigned int planeCount;
|
||||||
|
unsigned int numChannels;
|
||||||
|
CUeglFrameType frameType;
|
||||||
|
CUeglColorFormat eglColorFormat;
|
||||||
|
CUarray_format cuFormat;
|
||||||
|
} CUeglFrame;
|
||||||
|
|
||||||
|
#define CU_STREAM_DEFAULT 0
|
||||||
|
#define CU_STREAM_NON_BLOCKING 1
|
||||||
|
|
||||||
|
#define CU_EVENT_DEFAULT 0
|
||||||
|
#define CU_EVENT_BLOCKING_SYNC 1
|
||||||
|
#define CU_EVENT_DISABLE_TIMING 2
|
||||||
|
|
||||||
|
#define CU_EVENT_WAIT_DEFAULT 0
|
||||||
|
#define CU_EVENT_WAIT_EXTERNAL 1
|
||||||
|
|
||||||
|
#define CU_TRSF_READ_AS_INTEGER 1
|
||||||
|
|
||||||
|
typedef void CUDAAPI CUstreamCallback(CUstream hStream, CUresult status, void *userdata);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuInit(unsigned int Flags);
|
||||||
|
typedef CUresult CUDAAPI tcuDriverGetVersion(int *driverVersion);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetCount(int *count);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGet(CUdevice *device, int ordinal);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetAttribute(int *pi, CUdevice_attribute attrib, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetName(char *name, int len, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetUuid(CUuuid *uuid, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetUuid_v2(CUuuid *uuid, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetLuid(char* luid, unsigned int* deviceNodeMask, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetByPCIBusId(CUdevice* dev, const char* pciBusId);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceGetPCIBusId(char* pciBusId, int len, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDeviceComputeCapability(int *major, int *minor, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxCreate_v2(CUcontext *pctx, unsigned int flags, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxGetCurrent(CUcontext *pctx);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxSetLimit(CUlimit limit, size_t value);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxPushCurrent_v2(CUcontext pctx);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxPopCurrent_v2(CUcontext *pctx);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxDestroy_v2(CUcontext ctx);
|
||||||
|
typedef CUresult CUDAAPI tcuMemAlloc_v2(CUdeviceptr *dptr, size_t bytesize);
|
||||||
|
typedef CUresult CUDAAPI tcuMemAllocPitch_v2(CUdeviceptr *dptr, size_t *pPitch, size_t WidthInBytes, size_t Height, unsigned int ElementSizeBytes);
|
||||||
|
typedef CUresult CUDAAPI tcuMemAllocManaged(CUdeviceptr *dptr, size_t bytesize, unsigned int flags);
|
||||||
|
typedef CUresult CUDAAPI tcuMemsetD8Async(CUdeviceptr dstDevice, unsigned char uc, size_t N, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuMemFree_v2(CUdeviceptr dptr);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpy(CUdeviceptr dst, CUdeviceptr src, size_t bytesize);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyAsync(CUdeviceptr dst, CUdeviceptr src, size_t bytesize, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpy2D_v2(const CUDA_MEMCPY2D *pcopy);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpy2DAsync_v2(const CUDA_MEMCPY2D *pcopy, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyHtoD_v2(CUdeviceptr dstDevice, const void *srcHost, size_t ByteCount);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyHtoDAsync_v2(CUdeviceptr dstDevice, const void *srcHost, size_t ByteCount, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyDtoH_v2(void *dstHost, CUdeviceptr srcDevice, size_t ByteCount);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyDtoHAsync_v2(void *dstHost, CUdeviceptr srcDevice, size_t ByteCount, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyDtoD_v2(CUdeviceptr dstDevice, CUdeviceptr srcDevice, size_t ByteCount);
|
||||||
|
typedef CUresult CUDAAPI tcuMemcpyDtoDAsync_v2(CUdeviceptr dstDevice, CUdeviceptr srcDevice, size_t ByteCount, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuGetErrorName(CUresult error, const char** pstr);
|
||||||
|
typedef CUresult CUDAAPI tcuGetErrorString(CUresult error, const char** pstr);
|
||||||
|
typedef CUresult CUDAAPI tcuCtxGetDevice(CUdevice *device);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuDevicePrimaryCtxRetain(CUcontext *pctx, CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDevicePrimaryCtxRelease(CUdevice dev);
|
||||||
|
typedef CUresult CUDAAPI tcuDevicePrimaryCtxSetFlags(CUdevice dev, unsigned int flags);
|
||||||
|
typedef CUresult CUDAAPI tcuDevicePrimaryCtxGetState(CUdevice dev, unsigned int *flags, int *active);
|
||||||
|
typedef CUresult CUDAAPI tcuDevicePrimaryCtxReset(CUdevice dev);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuStreamCreate(CUstream *phStream, unsigned int flags);
|
||||||
|
typedef CUresult CUDAAPI tcuStreamQuery(CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuStreamSynchronize(CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuStreamDestroy_v2(CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuStreamAddCallback(CUstream hStream, CUstreamCallback *callback, void *userdata, unsigned int flags);
|
||||||
|
typedef CUresult CUDAAPI tcuStreamWaitEvent(CUstream hStream, CUevent hEvent, unsigned int flags);
|
||||||
|
typedef CUresult CUDAAPI tcuEventCreate(CUevent *phEvent, unsigned int flags);
|
||||||
|
typedef CUresult CUDAAPI tcuEventDestroy_v2(CUevent hEvent);
|
||||||
|
typedef CUresult CUDAAPI tcuEventSynchronize(CUevent hEvent);
|
||||||
|
typedef CUresult CUDAAPI tcuEventQuery(CUevent hEvent);
|
||||||
|
typedef CUresult CUDAAPI tcuEventRecord(CUevent hEvent, CUstream hStream);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuLaunchKernel(CUfunction f, unsigned int gridDimX, unsigned int gridDimY, unsigned int gridDimZ, unsigned int blockDimX, unsigned int blockDimY, unsigned int blockDimZ, unsigned int sharedMemBytes, CUstream hStream, void** kernelParams, void** extra);
|
||||||
|
typedef CUresult CUDAAPI tcuLinkCreate(unsigned int numOptions, CUjit_option* options, void** optionValues, CUlinkState* stateOut);
|
||||||
|
typedef CUresult CUDAAPI tcuLinkAddData(CUlinkState state, CUjitInputType type, void* data, size_t size, const char* name, unsigned int numOptions, CUjit_option* options, void** optionValues);
|
||||||
|
typedef CUresult CUDAAPI tcuLinkComplete(CUlinkState state, void** cubinOut, size_t* sizeOut);
|
||||||
|
typedef CUresult CUDAAPI tcuLinkDestroy(CUlinkState state);
|
||||||
|
typedef CUresult CUDAAPI tcuModuleLoadData(CUmodule* module, const void* image);
|
||||||
|
typedef CUresult CUDAAPI tcuModuleUnload(CUmodule hmod);
|
||||||
|
typedef CUresult CUDAAPI tcuModuleGetFunction(CUfunction* hfunc, CUmodule hmod, const char* name);
|
||||||
|
typedef CUresult CUDAAPI tcuModuleGetGlobal(CUdeviceptr *dptr, size_t *bytes, CUmodule hmod, const char* name);
|
||||||
|
typedef CUresult CUDAAPI tcuTexObjectCreate(CUtexObject* pTexObject, const CUDA_RESOURCE_DESC* pResDesc, const CUDA_TEXTURE_DESC* pTexDesc, const CUDA_RESOURCE_VIEW_DESC* pResViewDesc);
|
||||||
|
typedef CUresult CUDAAPI tcuTexObjectDestroy(CUtexObject texObject);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuGLGetDevices_v2(unsigned int* pCudaDeviceCount, CUdevice* pCudaDevices, unsigned int cudaDeviceCount, CUGLDeviceList deviceList);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsGLRegisterImage(CUgraphicsResource* pCudaResource, GLuint image, GLenum target, unsigned int Flags);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsUnregisterResource(CUgraphicsResource resource);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsMapResources(unsigned int count, CUgraphicsResource* resources, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsUnmapResources(unsigned int count, CUgraphicsResource* resources, CUstream hStream);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsSubResourceGetMappedArray(CUarray* pArray, CUgraphicsResource resource, unsigned int arrayIndex, unsigned int mipLevel);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsResourceGetMappedPointer(CUdeviceptr *devPtrOut, size_t *sizeOut, CUgraphicsResource resource);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuImportExternalMemory(CUexternalMemory* extMem_out, const CUDA_EXTERNAL_MEMORY_HANDLE_DESC* memHandleDesc);
|
||||||
|
typedef CUresult CUDAAPI tcuDestroyExternalMemory(CUexternalMemory extMem);
|
||||||
|
typedef CUresult CUDAAPI tcuExternalMemoryGetMappedBuffer(CUdeviceptr* devPtr, CUexternalMemory extMem, const CUDA_EXTERNAL_MEMORY_BUFFER_DESC* bufferDesc);
|
||||||
|
typedef CUresult CUDAAPI tcuExternalMemoryGetMappedMipmappedArray(CUmipmappedArray* mipmap, CUexternalMemory extMem, const CUDA_EXTERNAL_MEMORY_MIPMAPPED_ARRAY_DESC* mipmapDesc);
|
||||||
|
typedef CUresult CUDAAPI tcuMipmappedArrayGetLevel(CUarray* pLevelArray, CUmipmappedArray hMipmappedArray, unsigned int level);
|
||||||
|
typedef CUresult CUDAAPI tcuMipmappedArrayDestroy(CUmipmappedArray hMipmappedArray);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuImportExternalSemaphore(CUexternalSemaphore* extSem_out, const CUDA_EXTERNAL_SEMAPHORE_HANDLE_DESC* semHandleDesc);
|
||||||
|
typedef CUresult CUDAAPI tcuDestroyExternalSemaphore(CUexternalSemaphore extSem);
|
||||||
|
typedef CUresult CUDAAPI tcuSignalExternalSemaphoresAsync(const CUexternalSemaphore* extSemArray, const CUDA_EXTERNAL_SEMAPHORE_SIGNAL_PARAMS* paramsArray, unsigned int numExtSems, CUstream stream);
|
||||||
|
typedef CUresult CUDAAPI tcuWaitExternalSemaphoresAsync(const CUexternalSemaphore* extSemArray, const CUDA_EXTERNAL_SEMAPHORE_WAIT_PARAMS* paramsArray, unsigned int numExtSems, CUstream stream);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuArrayCreate(CUarray *pHandle, const CUDA_ARRAY_DESCRIPTOR* pAllocateArray);
|
||||||
|
typedef CUresult CUDAAPI tcuArray3DCreate(CUarray *pHandle, const CUDA_ARRAY3D_DESCRIPTOR* pAllocateArray);
|
||||||
|
typedef CUresult CUDAAPI tcuArrayDestroy(CUarray hArray);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuEGLStreamProducerConnect(CUeglStreamConnection* conn, ffnv_EGLStreamKHR stream, ffnv_EGLint width, ffnv_EGLint height);
|
||||||
|
typedef CUresult CUDAAPI tcuEGLStreamProducerDisconnect(CUeglStreamConnection* conn);
|
||||||
|
typedef CUresult CUDAAPI tcuEGLStreamConsumerDisconnect(CUeglStreamConnection* conn);
|
||||||
|
typedef CUresult CUDAAPI tcuEGLStreamProducerPresentFrame(CUeglStreamConnection* conn, CUeglFrame eglframe, CUstream* pStream);
|
||||||
|
typedef CUresult CUDAAPI tcuEGLStreamProducerReturnFrame(CUeglStreamConnection* conn, CUeglFrame* eglframe, CUstream* pStream);
|
||||||
|
|
||||||
|
typedef CUresult CUDAAPI tcuD3D11GetDevice(CUdevice *device, void *dxgiAdapter);
|
||||||
|
typedef CUresult CUDAAPI tcuD3D11GetDevices(unsigned int *deviceCountOut, CUdevice *devices, unsigned int deviceCount, void *d3d11device, CUd3d11DeviceList listType);
|
||||||
|
typedef CUresult CUDAAPI tcuGraphicsD3D11RegisterResource(CUgraphicsResource *cudaResourceOut, void *d3d11Resource, unsigned int flags);
|
||||||
|
#endif
|
||||||
+4451
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,11 @@
|
|||||||
|
# Generated by Cargo
|
||||||
|
# will have compiled files and executables
|
||||||
|
/target/
|
||||||
|
/.idea/
|
||||||
|
|
||||||
|
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
|
||||||
|
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
|
||||||
|
Cargo.lock
|
||||||
|
|
||||||
|
# These are backup files generated by rustfmt
|
||||||
|
**/*.rs.bk
|
||||||
Vendored
+19
@@ -0,0 +1,19 @@
|
|||||||
|
# webrtc-srtp changelog
|
||||||
|
|
||||||
|
## Unreleased
|
||||||
|
|
||||||
|
## v0.9.1
|
||||||
|
|
||||||
|
* Increased minimum support rust version to `1.60.0`.
|
||||||
|
* Increased required `webrtc-util` version to `0.7.0`.
|
||||||
|
|
||||||
|
|
||||||
|
## v0.9.0
|
||||||
|
|
||||||
|
* [#8 update deps + loosen some requirements](https://github.com/webrtc-rs/srtp/pull/8) by [@melekes](https://github.com/melekes).
|
||||||
|
* Increased min version of `log` dependency to `0.4.16`. [#250 Fix log at ^0.4.16 to make tests compile](https://github.com/webrtc-rs/webrtc/pull/250) by [@k0nserv](https://github.com/k0nserv).
|
||||||
|
|
||||||
|
## Prior to 0.8.9
|
||||||
|
|
||||||
|
Before 0.8.9 there was no changelog, previous changes are sometimes, but not always, available in the [GitHub Releases](https://github.com/webrtc-rs/srtp/releases).
|
||||||
|
|
||||||
Vendored
+100
@@ -0,0 +1,100 @@
|
|||||||
|
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
|
||||||
|
#
|
||||||
|
# When uploading crates to the registry Cargo will automatically
|
||||||
|
# "normalize" Cargo.toml files for maximal compatibility
|
||||||
|
# with all versions of Cargo and also rewrite `path` dependencies
|
||||||
|
# to registry (e.g., crates.io) dependencies.
|
||||||
|
#
|
||||||
|
# If you are reading this file be aware that the original Cargo.toml
|
||||||
|
# will likely look very different (and much more reasonable).
|
||||||
|
# See Cargo.toml.orig for the original contents.
|
||||||
|
|
||||||
|
[package]
|
||||||
|
edition = "2021"
|
||||||
|
name = "webrtc-srtp"
|
||||||
|
version = "0.12.0"
|
||||||
|
authors = ["Rain Liu <[email protected]>"]
|
||||||
|
description = "A pure Rust implementation of SRTP"
|
||||||
|
homepage = "https://webrtc.rs"
|
||||||
|
documentation = "https://docs.rs/webrtc-srtp"
|
||||||
|
readme = "README.md"
|
||||||
|
license = "MIT OR Apache-2.0"
|
||||||
|
repository = "https://github.com/webrtc-rs/srtp"
|
||||||
|
|
||||||
|
[[bench]]
|
||||||
|
name = "srtp_bench"
|
||||||
|
harness = false
|
||||||
|
|
||||||
|
[dependencies.aead]
|
||||||
|
version = "0.5"
|
||||||
|
features = ["std"]
|
||||||
|
|
||||||
|
[dependencies.aes]
|
||||||
|
version = "0.8"
|
||||||
|
|
||||||
|
[dependencies.aes-gcm]
|
||||||
|
version = "0.10"
|
||||||
|
features = ["std"]
|
||||||
|
|
||||||
|
[dependencies.byteorder]
|
||||||
|
version = "1"
|
||||||
|
|
||||||
|
[dependencies.bytes]
|
||||||
|
version = "1"
|
||||||
|
|
||||||
|
[dependencies.ctr]
|
||||||
|
version = "0.9"
|
||||||
|
|
||||||
|
[dependencies.hmac]
|
||||||
|
version = "0.12"
|
||||||
|
features = ["std"]
|
||||||
|
|
||||||
|
[dependencies.log]
|
||||||
|
version = "0.4"
|
||||||
|
|
||||||
|
[dependencies.openssl]
|
||||||
|
version = "0.10.57"
|
||||||
|
optional = true
|
||||||
|
|
||||||
|
[dependencies.rtcp]
|
||||||
|
version = "0.10.1"
|
||||||
|
|
||||||
|
[dependencies.rtp]
|
||||||
|
version = "0.10.0"
|
||||||
|
|
||||||
|
[dependencies.sha1]
|
||||||
|
version = "0.10"
|
||||||
|
|
||||||
|
[dependencies.subtle]
|
||||||
|
version = "2"
|
||||||
|
|
||||||
|
[dependencies.thiserror]
|
||||||
|
version = "1"
|
||||||
|
|
||||||
|
[dependencies.tokio]
|
||||||
|
version = "1.32.0"
|
||||||
|
features = ["full"]
|
||||||
|
|
||||||
|
[dependencies.util]
|
||||||
|
version = "0.8.1"
|
||||||
|
features = [
|
||||||
|
"conn",
|
||||||
|
"buffer",
|
||||||
|
"marshal",
|
||||||
|
]
|
||||||
|
default-features = false
|
||||||
|
package = "webrtc-util"
|
||||||
|
|
||||||
|
[dev-dependencies.criterion]
|
||||||
|
version = "0.5"
|
||||||
|
features = ["async_futures"]
|
||||||
|
|
||||||
|
[dev-dependencies.lazy_static]
|
||||||
|
version = "1"
|
||||||
|
|
||||||
|
[dev-dependencies.tokio-test]
|
||||||
|
version = "0.4"
|
||||||
|
|
||||||
|
[features]
|
||||||
|
openssl = ["dep:openssl"]
|
||||||
|
vendored-openssl = ["openssl/vendored"]
|
||||||
+46
@@ -0,0 +1,46 @@
|
|||||||
|
[package]
|
||||||
|
name = "webrtc-srtp"
|
||||||
|
version = "0.12.0"
|
||||||
|
authors = ["Rain Liu <[email protected]>"]
|
||||||
|
edition = "2021"
|
||||||
|
description = "A pure Rust implementation of SRTP"
|
||||||
|
license = "MIT OR Apache-2.0"
|
||||||
|
documentation = "https://docs.rs/webrtc-srtp"
|
||||||
|
homepage = "https://webrtc.rs"
|
||||||
|
repository = "https://github.com/webrtc-rs/srtp"
|
||||||
|
|
||||||
|
[features]
|
||||||
|
openssl = ["dep:openssl"]
|
||||||
|
vendored-openssl = ["openssl/vendored"]
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
util = { version = "0.8.1", path = "../util", package = "webrtc-util", default-features = false, features = [
|
||||||
|
"conn",
|
||||||
|
"buffer",
|
||||||
|
"marshal",
|
||||||
|
] }
|
||||||
|
rtp = { version = "0.10.0", path = "../rtp" }
|
||||||
|
rtcp = { version = "0.10.1", path = "../rtcp" }
|
||||||
|
|
||||||
|
byteorder = "1"
|
||||||
|
bytes = "1"
|
||||||
|
thiserror = "1"
|
||||||
|
hmac = { version = "0.12", features = ["std"] }
|
||||||
|
sha1 = "0.10"
|
||||||
|
ctr = "0.9"
|
||||||
|
aes = "0.8"
|
||||||
|
subtle = "2"
|
||||||
|
tokio = { version = "1.32.0", features = ["full"] }
|
||||||
|
log = "0.4"
|
||||||
|
aead = { version = "0.5", features = ["std"] }
|
||||||
|
aes-gcm = { version = "0.10", features = ["std"] }
|
||||||
|
openssl = { version = "0.10.57", optional = true }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
criterion = { version = "0.5", features = ["async_futures"] }
|
||||||
|
tokio-test = "0.4"
|
||||||
|
lazy_static = "1"
|
||||||
|
|
||||||
|
[[bench]]
|
||||||
|
name = "srtp_bench"
|
||||||
|
harness = false
|
||||||
Vendored
+201
@@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
Vendored
+21
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2021 WebRTC.rs
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
Vendored
+14
@@ -0,0 +1,14 @@
|
|||||||
|
# Local patch to webrtc-srtp 0.12.0
|
||||||
|
|
||||||
|
Source: crates.io webrtc-srtp 0.12.0 (MIT / Apache-2.0; upstream licenses retained).
|
||||||
|
|
||||||
|
`SrtpSsrcState` estimates the rollover counter with the half-sequence-space rule from
|
||||||
|
RFC 3711 Appendix A and only advances to the highest packet index seen. Upstream used a
|
||||||
|
100-packet window and stored every sequence number, so a NACK retransmission of a
|
||||||
|
pre-wrap packet sent after the wrap (e.g. 65000 after 85) moved the state back and the
|
||||||
|
next new packet was protected with ROC+1; the receiver then failed authentication for
|
||||||
|
every following packet (frozen video, #83). Fix and regression tests contributed by
|
||||||
|
@AYssu. Cipher code, wire format and SRTCP are unchanged.
|
||||||
|
|
||||||
|
The upstream lifecycle test jumped from 5004 to 65535, outside the half-space window;
|
||||||
|
bridge packets keep it consecutive and the known-answer vectors are unchanged.
|
||||||
Vendored
+30
@@ -0,0 +1,30 @@
|
|||||||
|
<h1 align="center">
|
||||||
|
<a href="https://webrtc.rs"><img src="./doc/webrtc.rs.png" alt="WebRTC.rs"></a>
|
||||||
|
<br>
|
||||||
|
</h1>
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://github.com/webrtc-rs/srtp/actions">
|
||||||
|
<img src="https://github.com/webrtc-rs/srtp/workflows/cargo/badge.svg">
|
||||||
|
</a>
|
||||||
|
<a href="https://codecov.io/gh/webrtc-rs/srtp">
|
||||||
|
<img src="https://codecov.io/gh/webrtc-rs/srtp/branch/main/graph/badge.svg">
|
||||||
|
</a>
|
||||||
|
<a href="https://deps.rs/repo/github/webrtc-rs/srtp">
|
||||||
|
<img src="https://deps.rs/repo/github/webrtc-rs/srtp/status.svg">
|
||||||
|
</a>
|
||||||
|
<a href="https://crates.io/crates/webrtc-srtp">
|
||||||
|
<img src="https://img.shields.io/crates/v/webrtc-srtp.svg">
|
||||||
|
</a>
|
||||||
|
<a href="https://docs.rs/webrtc-srtp">
|
||||||
|
<img src="https://docs.rs/webrtc-srtp/badge.svg">
|
||||||
|
</a>
|
||||||
|
<a href="https://doc.rust-lang.org/1.6.0/complement-project-faq.html#why-dual-mitasl2-license">
|
||||||
|
<img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue" alt="License: MIT/Apache 2.0">
|
||||||
|
</a>
|
||||||
|
<a href="https://discord.gg/4Ju8UHdXMs">
|
||||||
|
<img src="https://img.shields.io/discord/800204819540869120?logo=discord" alt="Discord">
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
<p align="center">
|
||||||
|
A pure Rust implementation of SRTP. Rewrite <a href="https://github.com/pion/srtp/releases/tag/v1.5.2">Pion</a> SRTP in Rust
|
||||||
|
</p>
|
||||||
+158
@@ -0,0 +1,158 @@
|
|||||||
|
use bytes::BytesMut;
|
||||||
|
use criterion::{criterion_group, criterion_main, Criterion};
|
||||||
|
use util::Marshal;
|
||||||
|
use webrtc_srtp::{context::Context, protection_profile::ProtectionProfile};
|
||||||
|
|
||||||
|
const MASTER_KEY: &[u8] = &[
|
||||||
|
96, 180, 31, 4, 119, 137, 128, 252, 75, 194, 252, 44, 63, 56, 61, 55,
|
||||||
|
];
|
||||||
|
const MASTER_SALT: &[u8] = &[247, 26, 49, 94, 99, 29, 79, 94, 5, 111, 252, 216, 62, 195];
|
||||||
|
const RAW_RTCP: &[u8] = &[
|
||||||
|
0x81, 0xc8, 0x00, 0x0b, 0xca, 0xfe, 0xba, 0xbe, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab,
|
||||||
|
0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab,
|
||||||
|
];
|
||||||
|
|
||||||
|
fn benchmark_encrypt_rtp_aes_128_cm_hmac_sha1(c: &mut Criterion) {
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
MASTER_KEY,
|
||||||
|
MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let mut pld = BytesMut::new();
|
||||||
|
for i in 0..1200 {
|
||||||
|
pld.extend_from_slice(&[i as u8]);
|
||||||
|
}
|
||||||
|
|
||||||
|
c.bench_function("Benchmark RTP encrypt", |b| {
|
||||||
|
let mut seq = 1;
|
||||||
|
b.iter_batched(
|
||||||
|
|| {
|
||||||
|
let pkt = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
sequence_number: seq,
|
||||||
|
timestamp: seq.into(),
|
||||||
|
extension_profile: 48862,
|
||||||
|
marker: true,
|
||||||
|
padding: false,
|
||||||
|
extension: true,
|
||||||
|
payload_type: 96,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: pld.clone().into(),
|
||||||
|
};
|
||||||
|
seq += 1;
|
||||||
|
pkt.marshal().unwrap()
|
||||||
|
},
|
||||||
|
|pkt_raw| {
|
||||||
|
ctx.encrypt_rtp(&pkt_raw).unwrap();
|
||||||
|
},
|
||||||
|
criterion::BatchSize::LargeInput,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn benchmark_decrypt_rtp_aes_128_cm_hmac_sha1(c: &mut Criterion) {
|
||||||
|
let mut setup_ctx = Context::new(
|
||||||
|
MASTER_KEY,
|
||||||
|
MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
MASTER_KEY,
|
||||||
|
MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let mut pld = BytesMut::new();
|
||||||
|
for i in 0..1200 {
|
||||||
|
pld.extend_from_slice(&[i as u8]);
|
||||||
|
}
|
||||||
|
|
||||||
|
c.bench_function("Benchmark RTP decrypt", |b| {
|
||||||
|
let mut seq = 1;
|
||||||
|
b.iter_batched(
|
||||||
|
|| {
|
||||||
|
let pkt = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
sequence_number: seq,
|
||||||
|
timestamp: seq.into(),
|
||||||
|
extension_profile: 48862,
|
||||||
|
marker: true,
|
||||||
|
padding: false,
|
||||||
|
extension: true,
|
||||||
|
payload_type: 96,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: pld.clone().into(),
|
||||||
|
};
|
||||||
|
seq += 1;
|
||||||
|
setup_ctx.encrypt_rtp(&pkt.marshal().unwrap()).unwrap()
|
||||||
|
},
|
||||||
|
|encrypted| ctx.decrypt_rtp(&encrypted).unwrap(),
|
||||||
|
criterion::BatchSize::LargeInput,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn benchmark_encrypt_rtcp_aes_128_cm_hmac_sha1(c: &mut Criterion) {
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
MASTER_KEY,
|
||||||
|
MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
c.bench_function("Benchmark RTCP encrypt", |b| {
|
||||||
|
b.iter(|| {
|
||||||
|
ctx.encrypt_rtcp(RAW_RTCP).unwrap();
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn benchmark_decrypt_rtcp_aes_128_cm_hmac_sha1(c: &mut Criterion) {
|
||||||
|
let encrypted = Context::new(
|
||||||
|
MASTER_KEY,
|
||||||
|
MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap()
|
||||||
|
.encrypt_rtcp(RAW_RTCP)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
MASTER_KEY,
|
||||||
|
MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
c.bench_function("Benchmark RTCP decrypt", |b| {
|
||||||
|
b.iter(|| ctx.decrypt_rtcp(&encrypted).unwrap());
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
criterion_group!(
|
||||||
|
benches,
|
||||||
|
benchmark_encrypt_rtp_aes_128_cm_hmac_sha1,
|
||||||
|
benchmark_decrypt_rtp_aes_128_cm_hmac_sha1,
|
||||||
|
benchmark_encrypt_rtcp_aes_128_cm_hmac_sha1,
|
||||||
|
benchmark_decrypt_rtcp_aes_128_cm_hmac_sha1
|
||||||
|
);
|
||||||
|
criterion_main!(benches);
|
||||||
Vendored
+23
@@ -0,0 +1,23 @@
|
|||||||
|
codecov:
|
||||||
|
require_ci_to_pass: yes
|
||||||
|
max_report_age: off
|
||||||
|
token: d65de923-7c3d-4836-8d9a-5183b356be4f
|
||||||
|
|
||||||
|
coverage:
|
||||||
|
precision: 2
|
||||||
|
round: down
|
||||||
|
range: 50..90
|
||||||
|
status:
|
||||||
|
project:
|
||||||
|
default:
|
||||||
|
enabled: no
|
||||||
|
threshold: 0.2
|
||||||
|
if_not_found: success
|
||||||
|
patch:
|
||||||
|
default:
|
||||||
|
enabled: no
|
||||||
|
if_not_found: success
|
||||||
|
changes:
|
||||||
|
default:
|
||||||
|
enabled: no
|
||||||
|
if_not_found: success
|
||||||
Vendored
BIN
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
@@ -0,0 +1,247 @@
|
|||||||
|
use aes_gcm::aead::generic_array::GenericArray;
|
||||||
|
use aes_gcm::aead::{Aead, Payload};
|
||||||
|
use aes_gcm::{Aes128Gcm, KeyInit, Nonce};
|
||||||
|
use byteorder::{BigEndian, ByteOrder};
|
||||||
|
use bytes::{Bytes, BytesMut};
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use super::Cipher;
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::key_derivation::*;
|
||||||
|
|
||||||
|
pub const CIPHER_AEAD_AES_GCM_AUTH_TAG_LEN: usize = 16;
|
||||||
|
|
||||||
|
const RTCP_ENCRYPTION_FLAG: u8 = 0x80;
|
||||||
|
|
||||||
|
/// AEAD Cipher based on AES.
|
||||||
|
pub(crate) struct CipherAeadAesGcm {
|
||||||
|
srtp_cipher: aes_gcm::Aes128Gcm,
|
||||||
|
srtcp_cipher: aes_gcm::Aes128Gcm,
|
||||||
|
srtp_session_salt: Vec<u8>,
|
||||||
|
srtcp_session_salt: Vec<u8>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Cipher for CipherAeadAesGcm {
|
||||||
|
fn auth_tag_len(&self) -> usize {
|
||||||
|
CIPHER_AEAD_AES_GCM_AUTH_TAG_LEN
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
payload: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
// Grow the given buffer to fit the output.
|
||||||
|
let header_len = header.marshal_size();
|
||||||
|
let mut writer = BytesMut::with_capacity(payload.len() + self.auth_tag_len());
|
||||||
|
|
||||||
|
// Copy header unencrypted.
|
||||||
|
writer.extend_from_slice(&payload[..header_len]);
|
||||||
|
|
||||||
|
let nonce = self.rtp_initialization_vector(header, roc);
|
||||||
|
|
||||||
|
let encrypted = self.srtp_cipher.encrypt(
|
||||||
|
Nonce::from_slice(&nonce),
|
||||||
|
Payload {
|
||||||
|
msg: &payload[header_len..],
|
||||||
|
aad: &writer,
|
||||||
|
},
|
||||||
|
)?;
|
||||||
|
|
||||||
|
writer.extend(encrypted);
|
||||||
|
Ok(writer.freeze())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
ciphertext: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
if ciphertext.len() < self.auth_tag_len() {
|
||||||
|
return Err(Error::ErrFailedToVerifyAuthTag);
|
||||||
|
}
|
||||||
|
|
||||||
|
let nonce = self.rtp_initialization_vector(header, roc);
|
||||||
|
let payload_offset = header.marshal_size();
|
||||||
|
let decrypted_msg: Vec<u8> = self.srtp_cipher.decrypt(
|
||||||
|
Nonce::from_slice(&nonce),
|
||||||
|
Payload {
|
||||||
|
msg: &ciphertext[payload_offset..],
|
||||||
|
aad: &ciphertext[..payload_offset],
|
||||||
|
},
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let mut writer = BytesMut::with_capacity(payload_offset + decrypted_msg.len());
|
||||||
|
writer.extend_from_slice(&ciphertext[..payload_offset]);
|
||||||
|
writer.extend(decrypted_msg);
|
||||||
|
|
||||||
|
Ok(writer.freeze())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_rtcp(&mut self, decrypted: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes> {
|
||||||
|
let iv = self.rtcp_initialization_vector(srtcp_index, ssrc);
|
||||||
|
let aad = self.rtcp_additional_authenticated_data(decrypted, srtcp_index);
|
||||||
|
|
||||||
|
let encrypted_data = self.srtcp_cipher.encrypt(
|
||||||
|
Nonce::from_slice(&iv),
|
||||||
|
Payload {
|
||||||
|
msg: &decrypted[8..],
|
||||||
|
aad: &aad,
|
||||||
|
},
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let mut writer = BytesMut::with_capacity(encrypted_data.len() + aad.len());
|
||||||
|
writer.extend_from_slice(&decrypted[..8]);
|
||||||
|
writer.extend(encrypted_data);
|
||||||
|
writer.extend_from_slice(&aad[8..]);
|
||||||
|
|
||||||
|
Ok(writer.freeze())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_rtcp(&mut self, encrypted: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes> {
|
||||||
|
if encrypted.len() < self.auth_tag_len() + SRTCP_INDEX_SIZE {
|
||||||
|
return Err(Error::ErrFailedToVerifyAuthTag);
|
||||||
|
}
|
||||||
|
|
||||||
|
let nonce = self.rtcp_initialization_vector(srtcp_index, ssrc);
|
||||||
|
let aad = self.rtcp_additional_authenticated_data(encrypted, srtcp_index);
|
||||||
|
|
||||||
|
let decrypted_data = self.srtcp_cipher.decrypt(
|
||||||
|
Nonce::from_slice(&nonce),
|
||||||
|
Payload {
|
||||||
|
msg: &encrypted[8..(encrypted.len() - SRTCP_INDEX_SIZE)],
|
||||||
|
aad: &aad,
|
||||||
|
},
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let mut writer = BytesMut::with_capacity(8 + decrypted_data.len());
|
||||||
|
writer.extend_from_slice(&encrypted[..8]);
|
||||||
|
writer.extend(decrypted_data);
|
||||||
|
|
||||||
|
Ok(writer.freeze())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_rtcp_index(&self, input: &[u8]) -> usize {
|
||||||
|
let pos = input.len() - 4;
|
||||||
|
let val = BigEndian::read_u32(&input[pos..]);
|
||||||
|
|
||||||
|
(val & !((RTCP_ENCRYPTION_FLAG as u32) << 24)) as usize
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CipherAeadAesGcm {
|
||||||
|
/// Create a new AEAD instance.
|
||||||
|
pub(crate) fn new(master_key: &[u8], master_salt: &[u8]) -> Result<CipherAeadAesGcm> {
|
||||||
|
let srtp_session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_ENCRYPTION,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let srtp_block = GenericArray::from_slice(&srtp_session_key);
|
||||||
|
|
||||||
|
let srtp_cipher = Aes128Gcm::new(srtp_block);
|
||||||
|
|
||||||
|
let srtcp_session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTCP_ENCRYPTION,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let srtcp_block = GenericArray::from_slice(&srtcp_session_key);
|
||||||
|
|
||||||
|
let srtcp_cipher = Aes128Gcm::new(srtcp_block);
|
||||||
|
|
||||||
|
let srtp_session_salt = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_SALT,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let srtcp_session_salt = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTCP_SALT,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
Ok(CipherAeadAesGcm {
|
||||||
|
srtp_cipher,
|
||||||
|
srtcp_cipher,
|
||||||
|
srtp_session_salt,
|
||||||
|
srtcp_session_salt,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The 12-octet IV used by AES-GCM SRTP is formed by first concatenating
|
||||||
|
/// 2 octets of zeroes, the 4-octet SSRC, the 4-octet rollover counter
|
||||||
|
/// (ROC), and the 2-octet sequence number (SEQ). The resulting 12-octet
|
||||||
|
/// value is then XORed to the 12-octet salt to form the 12-octet IV.
|
||||||
|
///
|
||||||
|
/// https://tools.ietf.org/html/rfc7714#section-8.1
|
||||||
|
pub(crate) fn rtp_initialization_vector(
|
||||||
|
&self,
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Vec<u8> {
|
||||||
|
let mut iv = vec![0u8; 12];
|
||||||
|
BigEndian::write_u32(&mut iv[2..], header.ssrc);
|
||||||
|
BigEndian::write_u32(&mut iv[6..], roc);
|
||||||
|
BigEndian::write_u16(&mut iv[10..], header.sequence_number);
|
||||||
|
|
||||||
|
for (i, v) in iv.iter_mut().enumerate() {
|
||||||
|
*v ^= self.srtp_session_salt[i];
|
||||||
|
}
|
||||||
|
|
||||||
|
iv
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The 12-octet IV used by AES-GCM SRTCP is formed by first
|
||||||
|
/// concatenating 2 octets of zeroes, the 4-octet SSRC identifier,
|
||||||
|
/// 2 octets of zeroes, a single "0" bit, and the 31-bit SRTCP index.
|
||||||
|
/// The resulting 12-octet value is then XORed to the 12-octet salt to
|
||||||
|
/// form the 12-octet IV.
|
||||||
|
///
|
||||||
|
/// https://tools.ietf.org/html/rfc7714#section-9.1
|
||||||
|
pub(crate) fn rtcp_initialization_vector(&self, srtcp_index: usize, ssrc: u32) -> Vec<u8> {
|
||||||
|
let mut iv = vec![0u8; 12];
|
||||||
|
|
||||||
|
BigEndian::write_u32(&mut iv[2..], ssrc);
|
||||||
|
BigEndian::write_u32(&mut iv[8..], srtcp_index as u32);
|
||||||
|
|
||||||
|
for (i, v) in iv.iter_mut().enumerate() {
|
||||||
|
*v ^= self.srtcp_session_salt[i];
|
||||||
|
}
|
||||||
|
|
||||||
|
iv
|
||||||
|
}
|
||||||
|
|
||||||
|
/// In an SRTCP packet, a 1-bit Encryption flag is prepended to the
|
||||||
|
/// 31-bit SRTCP index to form a 32-bit value we shall call the
|
||||||
|
/// "ESRTCP word"
|
||||||
|
///
|
||||||
|
/// https://tools.ietf.org/html/rfc7714#section-17
|
||||||
|
pub(crate) fn rtcp_additional_authenticated_data(
|
||||||
|
&self,
|
||||||
|
rtcp_packet: &[u8],
|
||||||
|
srtcp_index: usize,
|
||||||
|
) -> Vec<u8> {
|
||||||
|
let mut aad = vec![0u8; 12];
|
||||||
|
|
||||||
|
aad[..8].copy_from_slice(&rtcp_packet[..8]);
|
||||||
|
|
||||||
|
BigEndian::write_u32(&mut aad[8..], srtcp_index as u32);
|
||||||
|
|
||||||
|
aad[8] |= RTCP_ENCRYPTION_FLAG;
|
||||||
|
aad
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,220 @@
|
|||||||
|
use aes::cipher::generic_array::GenericArray;
|
||||||
|
use aes::cipher::{KeyIvInit, StreamCipher, StreamCipherSeek};
|
||||||
|
use bytes::{BufMut, Bytes};
|
||||||
|
use rtcp::header::{HEADER_LENGTH, SSRC_LENGTH};
|
||||||
|
use subtle::ConstantTimeEq;
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use super::{Cipher, CipherInner};
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::key_derivation::*;
|
||||||
|
|
||||||
|
type Aes128Ctr = ctr::Ctr128BE<aes::Aes128>;
|
||||||
|
|
||||||
|
pub(crate) struct CipherAesCmHmacSha1 {
|
||||||
|
inner: CipherInner,
|
||||||
|
srtp_session_key: Vec<u8>,
|
||||||
|
srtcp_session_key: Vec<u8>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CipherAesCmHmacSha1 {
|
||||||
|
pub fn new(master_key: &[u8], master_salt: &[u8]) -> Result<Self> {
|
||||||
|
let inner = CipherInner::new(master_key, master_salt)?;
|
||||||
|
|
||||||
|
let srtp_session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_ENCRYPTION,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
let srtcp_session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTCP_ENCRYPTION,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
Ok(CipherAesCmHmacSha1 {
|
||||||
|
inner,
|
||||||
|
srtp_session_key,
|
||||||
|
srtcp_session_key,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Cipher for CipherAesCmHmacSha1 {
|
||||||
|
fn auth_tag_len(&self) -> usize {
|
||||||
|
self.inner.auth_tag_len()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_rtcp_index(&self, input: &[u8]) -> usize {
|
||||||
|
self.inner.get_rtcp_index(input)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
plaintext: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let mut writer = Vec::with_capacity(plaintext.len() + self.auth_tag_len());
|
||||||
|
|
||||||
|
// Write the plaintext to the destination buffer.
|
||||||
|
writer.extend_from_slice(plaintext);
|
||||||
|
|
||||||
|
// Encrypt the payload
|
||||||
|
let counter = generate_counter(
|
||||||
|
header.sequence_number,
|
||||||
|
roc,
|
||||||
|
header.ssrc,
|
||||||
|
&self.inner.srtp_session_salt,
|
||||||
|
);
|
||||||
|
let key = GenericArray::from_slice(&self.srtp_session_key);
|
||||||
|
let nonce = GenericArray::from_slice(&counter);
|
||||||
|
let mut stream = Aes128Ctr::new(key, nonce);
|
||||||
|
stream.apply_keystream(&mut writer[header.marshal_size()..]);
|
||||||
|
|
||||||
|
// Generate the auth tag.
|
||||||
|
let auth_tag = &self.inner.generate_srtp_auth_tag(&writer, roc)[..self.auth_tag_len()];
|
||||||
|
writer.extend(auth_tag);
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
encrypted: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let encrypted_len = encrypted.len();
|
||||||
|
if encrypted_len < self.auth_tag_len() {
|
||||||
|
return Err(Error::SrtpTooSmall(encrypted_len, self.auth_tag_len()));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut writer = Vec::with_capacity(encrypted_len - self.auth_tag_len());
|
||||||
|
|
||||||
|
// Split the auth tag and the cipher text into two parts.
|
||||||
|
let actual_tag = &encrypted[encrypted_len - self.auth_tag_len()..];
|
||||||
|
let cipher_text = &encrypted[..encrypted_len - self.auth_tag_len()];
|
||||||
|
|
||||||
|
// Generate the auth tag we expect to see from the ciphertext.
|
||||||
|
let expected_tag =
|
||||||
|
&self.inner.generate_srtp_auth_tag(cipher_text, roc)[..self.auth_tag_len()];
|
||||||
|
|
||||||
|
// See if the auth tag actually matches.
|
||||||
|
// We use a constant time comparison to prevent timing attacks.
|
||||||
|
if actual_tag.ct_eq(expected_tag).unwrap_u8() != 1 {
|
||||||
|
return Err(Error::RtpFailedToVerifyAuthTag);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write cipher_text to the destination buffer.
|
||||||
|
writer.extend_from_slice(cipher_text);
|
||||||
|
|
||||||
|
// Decrypt the ciphertext for the payload.
|
||||||
|
let counter = generate_counter(
|
||||||
|
header.sequence_number,
|
||||||
|
roc,
|
||||||
|
header.ssrc,
|
||||||
|
&self.inner.srtp_session_salt,
|
||||||
|
);
|
||||||
|
|
||||||
|
let key = GenericArray::from_slice(&self.srtp_session_key);
|
||||||
|
let nonce = GenericArray::from_slice(&counter);
|
||||||
|
let mut stream = Aes128Ctr::new(key, nonce);
|
||||||
|
stream.seek(0);
|
||||||
|
stream.apply_keystream(&mut writer[header.marshal_size()..]);
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_rtcp(&mut self, decrypted: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes> {
|
||||||
|
let mut writer =
|
||||||
|
Vec::with_capacity(decrypted.len() + SRTCP_INDEX_SIZE + self.auth_tag_len());
|
||||||
|
|
||||||
|
// Write the decrypted to the destination buffer.
|
||||||
|
writer.extend_from_slice(decrypted);
|
||||||
|
|
||||||
|
// Encrypt everything after header
|
||||||
|
let counter = generate_counter(
|
||||||
|
(srtcp_index & 0xFFFF) as u16,
|
||||||
|
(srtcp_index >> 16) as u32,
|
||||||
|
ssrc,
|
||||||
|
&self.inner.srtcp_session_salt,
|
||||||
|
);
|
||||||
|
|
||||||
|
let key = GenericArray::from_slice(&self.srtcp_session_key);
|
||||||
|
let nonce = GenericArray::from_slice(&counter);
|
||||||
|
let mut stream = Aes128Ctr::new(key, nonce);
|
||||||
|
|
||||||
|
stream.apply_keystream(&mut writer[HEADER_LENGTH + SSRC_LENGTH..]);
|
||||||
|
|
||||||
|
// Add SRTCP index and set Encryption bit
|
||||||
|
writer.put_u32(srtcp_index as u32 | (1u32 << 31));
|
||||||
|
|
||||||
|
// Generate the auth tag.
|
||||||
|
let auth_tag = &self.inner.generate_srtcp_auth_tag(&writer)[..self.auth_tag_len()];
|
||||||
|
writer.extend(auth_tag);
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_rtcp(&mut self, encrypted: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes> {
|
||||||
|
let encrypted_len = encrypted.len();
|
||||||
|
if encrypted_len < self.auth_tag_len() + SRTCP_INDEX_SIZE {
|
||||||
|
return Err(Error::SrtcpTooSmall(
|
||||||
|
encrypted_len,
|
||||||
|
self.auth_tag_len() + SRTCP_INDEX_SIZE,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let tail_offset = encrypted_len - (self.auth_tag_len() + SRTCP_INDEX_SIZE);
|
||||||
|
|
||||||
|
let mut writer = Vec::with_capacity(tail_offset);
|
||||||
|
|
||||||
|
writer.extend_from_slice(&encrypted[0..tail_offset]);
|
||||||
|
|
||||||
|
let is_encrypted = encrypted[tail_offset] >> 7;
|
||||||
|
if is_encrypted == 0 {
|
||||||
|
return Ok(Bytes::from(writer));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split the auth tag and the cipher text into two parts.
|
||||||
|
let actual_tag = &encrypted[encrypted_len - self.auth_tag_len()..];
|
||||||
|
if actual_tag.len() != self.auth_tag_len() {
|
||||||
|
return Err(Error::RtcpInvalidLengthAuthTag(
|
||||||
|
actual_tag.len(),
|
||||||
|
self.auth_tag_len(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let cipher_text = &encrypted[..encrypted_len - self.auth_tag_len()];
|
||||||
|
|
||||||
|
// Generate the auth tag we expect to see from the ciphertext.
|
||||||
|
let expected_tag = &self.inner.generate_srtcp_auth_tag(cipher_text)[..self.auth_tag_len()];
|
||||||
|
|
||||||
|
// See if the auth tag actually matches.
|
||||||
|
// We use a constant time comparison to prevent timing attacks.
|
||||||
|
if actual_tag.ct_eq(expected_tag).unwrap_u8() != 1 {
|
||||||
|
return Err(Error::RtcpFailedToVerifyAuthTag);
|
||||||
|
}
|
||||||
|
|
||||||
|
let counter = generate_counter(
|
||||||
|
(srtcp_index & 0xFFFF) as u16,
|
||||||
|
(srtcp_index >> 16) as u32,
|
||||||
|
ssrc,
|
||||||
|
&self.inner.srtcp_session_salt,
|
||||||
|
);
|
||||||
|
|
||||||
|
let key = GenericArray::from_slice(&self.srtcp_session_key);
|
||||||
|
let nonce = GenericArray::from_slice(&counter);
|
||||||
|
let mut stream = Aes128Ctr::new(key, nonce);
|
||||||
|
|
||||||
|
stream.seek(0);
|
||||||
|
stream.apply_keystream(&mut writer[HEADER_LENGTH + SSRC_LENGTH..]);
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
use byteorder::{BigEndian, ByteOrder};
|
||||||
|
use hmac::{Hmac, Mac};
|
||||||
|
use sha1::Sha1;
|
||||||
|
|
||||||
|
use super::Cipher;
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::key_derivation::*;
|
||||||
|
use crate::protection_profile::*;
|
||||||
|
|
||||||
|
#[cfg(not(feature = "openssl"))]
|
||||||
|
mod ctrcipher;
|
||||||
|
|
||||||
|
#[cfg(feature = "openssl")]
|
||||||
|
mod opensslcipher;
|
||||||
|
|
||||||
|
#[cfg(not(feature = "openssl"))]
|
||||||
|
pub(crate) use ctrcipher::CipherAesCmHmacSha1;
|
||||||
|
|
||||||
|
#[cfg(feature = "openssl")]
|
||||||
|
pub(crate) use opensslcipher::CipherAesCmHmacSha1;
|
||||||
|
|
||||||
|
type HmacSha1 = Hmac<Sha1>;
|
||||||
|
|
||||||
|
pub const CIPHER_AES_CM_HMAC_SHA1AUTH_TAG_LEN: usize = 10;
|
||||||
|
|
||||||
|
pub(crate) struct CipherInner {
|
||||||
|
srtp_session_salt: Vec<u8>,
|
||||||
|
srtp_session_auth: HmacSha1,
|
||||||
|
srtcp_session_salt: Vec<u8>,
|
||||||
|
srtcp_session_auth: HmacSha1,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CipherInner {
|
||||||
|
pub fn new(master_key: &[u8], master_salt: &[u8]) -> Result<Self> {
|
||||||
|
let srtp_session_salt = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_SALT,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_salt.len(),
|
||||||
|
)?;
|
||||||
|
let srtcp_session_salt = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTCP_SALT,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_salt.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let auth_key_len = ProtectionProfile::Aes128CmHmacSha1_80.auth_key_len();
|
||||||
|
|
||||||
|
let srtp_session_auth_tag = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_AUTHENTICATION_TAG,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
auth_key_len,
|
||||||
|
)?;
|
||||||
|
let srtcp_session_auth_tag = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTCP_AUTHENTICATION_TAG,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
auth_key_len,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let srtp_session_auth = HmacSha1::new_from_slice(&srtp_session_auth_tag)
|
||||||
|
.map_err(|e| Error::Other(e.to_string()))?;
|
||||||
|
let srtcp_session_auth = HmacSha1::new_from_slice(&srtcp_session_auth_tag)
|
||||||
|
.map_err(|e| Error::Other(e.to_string()))?;
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
srtp_session_salt,
|
||||||
|
srtp_session_auth,
|
||||||
|
srtcp_session_salt,
|
||||||
|
srtcp_session_auth,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// https://tools.ietf.org/html/rfc3711#section-4.2
|
||||||
|
/// In the case of SRTP, M SHALL consist of the Authenticated
|
||||||
|
/// Portion of the packet (as specified in Figure 1) concatenated with
|
||||||
|
/// the roc, M = Authenticated Portion || roc;
|
||||||
|
///
|
||||||
|
/// The pre-defined authentication transform for SRTP is HMAC-SHA1
|
||||||
|
/// [RFC2104]. With HMAC-SHA1, the SRTP_PREFIX_LENGTH (Figure 3) SHALL
|
||||||
|
/// be 0. For SRTP (respectively SRTCP), the HMAC SHALL be applied to
|
||||||
|
/// the session authentication key and M as specified above, i.e.,
|
||||||
|
/// HMAC(k_a, M). The HMAC output SHALL then be truncated to the n_tag
|
||||||
|
/// left-most bits.
|
||||||
|
/// - Authenticated portion of the packet is everything BEFORE MKI
|
||||||
|
/// - k_a is the session message authentication key
|
||||||
|
/// - n_tag is the bit-length of the output authentication tag
|
||||||
|
fn generate_srtp_auth_tag(&self, buf: &[u8], roc: u32) -> [u8; 20] {
|
||||||
|
let mut signer = self.srtp_session_auth.clone();
|
||||||
|
|
||||||
|
signer.update(buf);
|
||||||
|
|
||||||
|
// For SRTP only, we need to hash the rollover counter as well.
|
||||||
|
signer.update(&roc.to_be_bytes());
|
||||||
|
|
||||||
|
signer.finalize().into_bytes().into()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// https://tools.ietf.org/html/rfc3711#section-4.2
|
||||||
|
///
|
||||||
|
/// The pre-defined authentication transform for SRTP is HMAC-SHA1
|
||||||
|
/// [RFC2104]. With HMAC-SHA1, the SRTP_PREFIX_LENGTH (Figure 3) SHALL
|
||||||
|
/// be 0. For SRTP (respectively SRTCP), the HMAC SHALL be applied to
|
||||||
|
/// the session authentication key and M as specified above, i.e.,
|
||||||
|
/// HMAC(k_a, M). The HMAC output SHALL then be truncated to the n_tag
|
||||||
|
/// left-most bits.
|
||||||
|
/// - Authenticated portion of the packet is everything BEFORE MKI
|
||||||
|
/// - k_a is the session message authentication key
|
||||||
|
/// - n_tag is the bit-length of the output authentication tag
|
||||||
|
fn generate_srtcp_auth_tag(&self, buf: &[u8]) -> [u8; 20] {
|
||||||
|
let mut signer = self.srtcp_session_auth.clone();
|
||||||
|
|
||||||
|
signer.update(buf);
|
||||||
|
|
||||||
|
signer.finalize().into_bytes().into()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn auth_tag_len(&self) -> usize {
|
||||||
|
CIPHER_AES_CM_HMAC_SHA1AUTH_TAG_LEN
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_rtcp_index(&self, input: &[u8]) -> usize {
|
||||||
|
let tail_offset = input.len() - (self.auth_tag_len() + SRTCP_INDEX_SIZE);
|
||||||
|
(BigEndian::read_u32(&input[tail_offset..tail_offset + SRTCP_INDEX_SIZE]) & !(1 << 31))
|
||||||
|
as usize
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,261 @@
|
|||||||
|
use bytes::{BufMut, Bytes};
|
||||||
|
use openssl::cipher_ctx::CipherCtx;
|
||||||
|
use rtcp::header::{HEADER_LENGTH, SSRC_LENGTH};
|
||||||
|
use subtle::ConstantTimeEq;
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use super::{Cipher, CipherInner};
|
||||||
|
use crate::{
|
||||||
|
error::{Error, Result},
|
||||||
|
key_derivation::*,
|
||||||
|
};
|
||||||
|
|
||||||
|
pub(crate) struct CipherAesCmHmacSha1 {
|
||||||
|
inner: CipherInner,
|
||||||
|
rtp_ctx: CipherCtx,
|
||||||
|
rtcp_ctx: CipherCtx,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CipherAesCmHmacSha1 {
|
||||||
|
pub fn new(master_key: &[u8], master_salt: &[u8]) -> Result<Self> {
|
||||||
|
let inner = CipherInner::new(master_key, master_salt)?;
|
||||||
|
|
||||||
|
let srtp_session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_ENCRYPTION,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
let srtcp_session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTCP_ENCRYPTION,
|
||||||
|
master_key,
|
||||||
|
master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let t = openssl::cipher::Cipher::aes_128_ctr();
|
||||||
|
let mut rtp_ctx = CipherCtx::new().map_err(|e| Error::Other(e.to_string()))?;
|
||||||
|
rtp_ctx
|
||||||
|
.encrypt_init(Some(t), Some(&srtp_session_key[..]), None)
|
||||||
|
.map_err(|e| Error::Other(e.to_string()))?;
|
||||||
|
|
||||||
|
let t = openssl::cipher::Cipher::aes_128_ctr();
|
||||||
|
let mut rtcp_ctx = CipherCtx::new().map_err(|e| Error::Other(e.to_string()))?;
|
||||||
|
rtcp_ctx
|
||||||
|
.encrypt_init(Some(t), Some(&srtcp_session_key[..]), None)
|
||||||
|
.map_err(|e| Error::Other(e.to_string()))?;
|
||||||
|
|
||||||
|
Ok(Self {
|
||||||
|
inner,
|
||||||
|
rtp_ctx,
|
||||||
|
rtcp_ctx,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Cipher for CipherAesCmHmacSha1 {
|
||||||
|
fn auth_tag_len(&self) -> usize {
|
||||||
|
self.inner.auth_tag_len()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_rtcp_index(&self, input: &[u8]) -> usize {
|
||||||
|
self.inner.get_rtcp_index(input)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
plaintext: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let header_len = header.marshal_size();
|
||||||
|
let mut writer = Vec::with_capacity(plaintext.len() + self.auth_tag_len());
|
||||||
|
|
||||||
|
// Copy the header unencrypted.
|
||||||
|
writer.extend_from_slice(&plaintext[..header_len]);
|
||||||
|
|
||||||
|
// Encrypt the payload
|
||||||
|
let nonce = generate_counter(
|
||||||
|
header.sequence_number,
|
||||||
|
roc,
|
||||||
|
header.ssrc,
|
||||||
|
&self.inner.srtp_session_salt,
|
||||||
|
);
|
||||||
|
writer.resize(plaintext.len(), 0);
|
||||||
|
self.rtp_ctx.encrypt_init(None, None, Some(&nonce)).unwrap();
|
||||||
|
let count = self
|
||||||
|
.rtp_ctx
|
||||||
|
.cipher_update(&plaintext[header_len..], Some(&mut writer[header_len..]))
|
||||||
|
.unwrap();
|
||||||
|
self.rtp_ctx
|
||||||
|
.cipher_final(&mut writer[header_len + count..])
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// Generate and write the auth tag.
|
||||||
|
let auth_tag = &self.inner.generate_srtp_auth_tag(&writer, roc)[..self.auth_tag_len()];
|
||||||
|
writer.extend_from_slice(auth_tag);
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
encrypted: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let encrypted_len = encrypted.len();
|
||||||
|
if encrypted_len < self.auth_tag_len() {
|
||||||
|
return Err(Error::SrtpTooSmall(encrypted_len, self.auth_tag_len()));
|
||||||
|
}
|
||||||
|
let header_len = header.marshal_size();
|
||||||
|
|
||||||
|
let mut writer = Vec::with_capacity(encrypted_len - self.auth_tag_len());
|
||||||
|
|
||||||
|
// Split the auth tag and the cipher text into two parts.
|
||||||
|
let actual_tag = &encrypted[encrypted_len - self.auth_tag_len()..];
|
||||||
|
let cipher_text = &encrypted[..encrypted_len - self.auth_tag_len()];
|
||||||
|
|
||||||
|
// Generate the auth tag we expect to see from the ciphertext.
|
||||||
|
let expected_tag =
|
||||||
|
&self.inner.generate_srtp_auth_tag(cipher_text, roc)[..self.auth_tag_len()];
|
||||||
|
|
||||||
|
// See if the auth tag actually matches.
|
||||||
|
// We use a constant time comparison to prevent timing attacks.
|
||||||
|
if actual_tag.ct_eq(expected_tag).unwrap_u8() != 1 {
|
||||||
|
return Err(Error::RtpFailedToVerifyAuthTag);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Write cipher_text to the destination buffer.
|
||||||
|
writer.extend_from_slice(&cipher_text[..header_len]);
|
||||||
|
|
||||||
|
// Decrypt the ciphertext for the payload.
|
||||||
|
let nonce = generate_counter(
|
||||||
|
header.sequence_number,
|
||||||
|
roc,
|
||||||
|
header.ssrc,
|
||||||
|
&self.inner.srtp_session_salt,
|
||||||
|
);
|
||||||
|
|
||||||
|
writer.resize(encrypted_len - self.auth_tag_len(), 0);
|
||||||
|
self.rtp_ctx.decrypt_init(None, None, Some(&nonce)).unwrap();
|
||||||
|
let count = self
|
||||||
|
.rtp_ctx
|
||||||
|
.cipher_update(&cipher_text[header_len..], Some(&mut writer[header_len..]))
|
||||||
|
.unwrap();
|
||||||
|
self.rtp_ctx
|
||||||
|
.cipher_final(&mut writer[header_len + count..])
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_rtcp(&mut self, decrypted: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes> {
|
||||||
|
let decrypted_len = decrypted.len();
|
||||||
|
|
||||||
|
let mut writer = Vec::with_capacity(decrypted_len + SRTCP_INDEX_SIZE + self.auth_tag_len());
|
||||||
|
|
||||||
|
// Write the decrypted to the destination buffer.
|
||||||
|
writer.extend_from_slice(&decrypted[..HEADER_LENGTH + SSRC_LENGTH]);
|
||||||
|
|
||||||
|
// Encrypt everything after header
|
||||||
|
let nonce = generate_counter(
|
||||||
|
(srtcp_index & 0xFFFF) as u16,
|
||||||
|
(srtcp_index >> 16) as u32,
|
||||||
|
ssrc,
|
||||||
|
&self.inner.srtcp_session_salt,
|
||||||
|
);
|
||||||
|
|
||||||
|
writer.resize(decrypted_len, 0);
|
||||||
|
self.rtcp_ctx
|
||||||
|
.encrypt_init(None, None, Some(&nonce))
|
||||||
|
.unwrap();
|
||||||
|
let count = self
|
||||||
|
.rtcp_ctx
|
||||||
|
.cipher_update(
|
||||||
|
&decrypted[HEADER_LENGTH + SSRC_LENGTH..],
|
||||||
|
Some(&mut writer[HEADER_LENGTH + SSRC_LENGTH..]),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
self.rtcp_ctx
|
||||||
|
.cipher_final(&mut writer[HEADER_LENGTH + SSRC_LENGTH + count..])
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// Add SRTCP index and set Encryption bit
|
||||||
|
writer.put_u32(srtcp_index as u32 | (1u32 << 31));
|
||||||
|
|
||||||
|
// Generate the auth tag.
|
||||||
|
let auth_tag = &self.inner.generate_srtcp_auth_tag(&writer)[..self.auth_tag_len()];
|
||||||
|
writer.extend(auth_tag);
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn decrypt_rtcp(&mut self, encrypted: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes> {
|
||||||
|
let encrypted_len = encrypted.len();
|
||||||
|
|
||||||
|
if encrypted_len < self.auth_tag_len() + SRTCP_INDEX_SIZE {
|
||||||
|
return Err(Error::SrtcpTooSmall(
|
||||||
|
encrypted_len,
|
||||||
|
self.auth_tag_len() + SRTCP_INDEX_SIZE,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let tail_offset = encrypted_len - (self.auth_tag_len() + SRTCP_INDEX_SIZE);
|
||||||
|
|
||||||
|
let mut writer = Vec::with_capacity(tail_offset);
|
||||||
|
|
||||||
|
writer.extend_from_slice(&encrypted[..HEADER_LENGTH + SSRC_LENGTH]);
|
||||||
|
|
||||||
|
let is_encrypted = encrypted[tail_offset] >> 7;
|
||||||
|
if is_encrypted == 0 {
|
||||||
|
return Ok(Bytes::from(writer));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split the auth tag and the cipher text into two parts.
|
||||||
|
let actual_tag = &encrypted[encrypted_len - self.auth_tag_len()..];
|
||||||
|
if actual_tag.len() != self.auth_tag_len() {
|
||||||
|
return Err(Error::RtcpInvalidLengthAuthTag(
|
||||||
|
actual_tag.len(),
|
||||||
|
self.auth_tag_len(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
let cipher_text = &encrypted[..encrypted_len - self.auth_tag_len()];
|
||||||
|
|
||||||
|
// Generate the auth tag we expect to see from the ciphertext.
|
||||||
|
let expected_tag = &self.inner.generate_srtcp_auth_tag(cipher_text)[..self.auth_tag_len()];
|
||||||
|
|
||||||
|
// See if the auth tag actually matches.
|
||||||
|
// We use a constant time comparison to prevent timing attacks.
|
||||||
|
if actual_tag.ct_eq(expected_tag).unwrap_u8() != 1 {
|
||||||
|
return Err(Error::RtcpFailedToVerifyAuthTag);
|
||||||
|
}
|
||||||
|
|
||||||
|
let nonce = generate_counter(
|
||||||
|
(srtcp_index & 0xFFFF) as u16,
|
||||||
|
(srtcp_index >> 16) as u32,
|
||||||
|
ssrc,
|
||||||
|
&self.inner.srtcp_session_salt,
|
||||||
|
);
|
||||||
|
|
||||||
|
writer.resize(tail_offset, 0);
|
||||||
|
self.rtcp_ctx
|
||||||
|
.decrypt_init(None, None, Some(&nonce))
|
||||||
|
.unwrap();
|
||||||
|
let count = self
|
||||||
|
.rtcp_ctx
|
||||||
|
.cipher_update(
|
||||||
|
&encrypted[HEADER_LENGTH + SSRC_LENGTH..tail_offset],
|
||||||
|
Some(&mut writer[HEADER_LENGTH + SSRC_LENGTH..]),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
self.rtcp_ctx
|
||||||
|
.cipher_final(&mut writer[HEADER_LENGTH + SSRC_LENGTH + count..])
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
Ok(Bytes::from(writer))
|
||||||
|
}
|
||||||
|
}
|
||||||
Vendored
+61
@@ -0,0 +1,61 @@
|
|||||||
|
pub mod cipher_aead_aes_gcm;
|
||||||
|
pub mod cipher_aes_cm_hmac_sha1;
|
||||||
|
|
||||||
|
use bytes::Bytes;
|
||||||
|
|
||||||
|
use crate::error::Result;
|
||||||
|
|
||||||
|
///NOTE: Auth tag and AEAD auth tag are placed at the different position in SRTCP
|
||||||
|
///
|
||||||
|
///In non-AEAD cipher, the authentication tag is placed *after* the ESRTCP word
|
||||||
|
///(Encrypted-flag and SRTCP index).
|
||||||
|
///
|
||||||
|
///> AES_128_CM_HMAC_SHA1_80
|
||||||
|
///> | RTCP Header | Encrypted payload |E| SRTCP Index | Auth tag |
|
||||||
|
///> ^ |----------|
|
||||||
|
///> | ^
|
||||||
|
///> | authTagLen=10
|
||||||
|
///> aeadAuthTagLen=0
|
||||||
|
///
|
||||||
|
///In AEAD cipher, the AEAD authentication tag is embedded in the ciphertext.
|
||||||
|
///It is *before* the ESRTCP word (Encrypted-flag and SRTCP index).
|
||||||
|
///
|
||||||
|
///> AEAD_AES_128_GCM
|
||||||
|
///> | RTCP Header | Encrypted payload | AEAD auth tag |E| SRTCP Index |
|
||||||
|
///> |---------------| ^
|
||||||
|
///> ^ authTagLen=0
|
||||||
|
///> aeadAuthTagLen=16
|
||||||
|
///
|
||||||
|
///See https://tools.ietf.org/html/rfc7714 for the full specifications.
|
||||||
|
|
||||||
|
/// Cipher represents a implementation of one
|
||||||
|
/// of the SRTP Specific ciphers.
|
||||||
|
pub(crate) trait Cipher {
|
||||||
|
/// Get authenticated tag length.
|
||||||
|
fn auth_tag_len(&self) -> usize;
|
||||||
|
|
||||||
|
/// Retrieved RTCP index.
|
||||||
|
fn get_rtcp_index(&self, input: &[u8]) -> usize;
|
||||||
|
|
||||||
|
/// Encrypt RTP payload.
|
||||||
|
fn encrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
payload: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes>;
|
||||||
|
|
||||||
|
/// Decrypt RTP payload.
|
||||||
|
fn decrypt_rtp(
|
||||||
|
&mut self,
|
||||||
|
payload: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
roc: u32,
|
||||||
|
) -> Result<Bytes>;
|
||||||
|
|
||||||
|
/// Encrypt RTCP payload.
|
||||||
|
fn encrypt_rtcp(&mut self, payload: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes>;
|
||||||
|
|
||||||
|
/// Decrypt RTCP payload.
|
||||||
|
fn decrypt_rtcp(&mut self, payload: &[u8], srtcp_index: usize, ssrc: u32) -> Result<Bytes>;
|
||||||
|
}
|
||||||
Vendored
+83
@@ -0,0 +1,83 @@
|
|||||||
|
use util::KeyingMaterialExporter;
|
||||||
|
|
||||||
|
use crate::error::Result;
|
||||||
|
use crate::option::*;
|
||||||
|
use crate::protection_profile::*;
|
||||||
|
|
||||||
|
const LABEL_EXTRACTOR_DTLS_SRTP: &str = "EXTRACTOR-dtls_srtp";
|
||||||
|
|
||||||
|
/// SessionKeys bundles the keys required to setup an SRTP session
|
||||||
|
#[derive(Default, Debug, Clone)]
|
||||||
|
pub struct SessionKeys {
|
||||||
|
pub local_master_key: Vec<u8>,
|
||||||
|
pub local_master_salt: Vec<u8>,
|
||||||
|
pub remote_master_key: Vec<u8>,
|
||||||
|
pub remote_master_salt: Vec<u8>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Config is used to configure a session.
|
||||||
|
/// You can provide either a KeyingMaterialExporter to export keys
|
||||||
|
/// or directly pass the keys themselves.
|
||||||
|
/// After a Config is passed to a session it must not be modified.
|
||||||
|
#[derive(Default)]
|
||||||
|
pub struct Config {
|
||||||
|
pub keys: SessionKeys,
|
||||||
|
pub profile: ProtectionProfile,
|
||||||
|
//LoggerFactory: logging.LoggerFactory
|
||||||
|
/// List of local/remote context options.
|
||||||
|
/// ReplayProtection is enabled on remote context by default.
|
||||||
|
/// Default replay protection window size is 64.
|
||||||
|
pub local_rtp_options: Option<ContextOption>,
|
||||||
|
pub remote_rtp_options: Option<ContextOption>,
|
||||||
|
|
||||||
|
pub local_rtcp_options: Option<ContextOption>,
|
||||||
|
pub remote_rtcp_options: Option<ContextOption>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Config {
|
||||||
|
/// ExtractSessionKeysFromDTLS allows setting the Config SessionKeys by
|
||||||
|
/// extracting them from DTLS. This behavior is defined in RFC5764:
|
||||||
|
/// https://tools.ietf.org/html/rfc5764
|
||||||
|
pub async fn extract_session_keys_from_dtls(
|
||||||
|
&mut self,
|
||||||
|
exporter: impl KeyingMaterialExporter,
|
||||||
|
is_client: bool,
|
||||||
|
) -> Result<()> {
|
||||||
|
let key_len = self.profile.key_len();
|
||||||
|
let salt_len = self.profile.salt_len();
|
||||||
|
|
||||||
|
let keying_material = exporter
|
||||||
|
.export_keying_material(
|
||||||
|
LABEL_EXTRACTOR_DTLS_SRTP,
|
||||||
|
&[],
|
||||||
|
(key_len * 2) + (salt_len * 2),
|
||||||
|
)
|
||||||
|
.await?;
|
||||||
|
|
||||||
|
let mut offset = 0;
|
||||||
|
let client_write_key = keying_material[offset..offset + key_len].to_vec();
|
||||||
|
offset += key_len;
|
||||||
|
|
||||||
|
let server_write_key = keying_material[offset..offset + key_len].to_vec();
|
||||||
|
offset += key_len;
|
||||||
|
|
||||||
|
let client_write_salt = keying_material[offset..offset + salt_len].to_vec();
|
||||||
|
offset += salt_len;
|
||||||
|
|
||||||
|
let server_write_salt = keying_material[offset..offset + salt_len].to_vec();
|
||||||
|
|
||||||
|
if is_client {
|
||||||
|
self.keys.local_master_key = client_write_key;
|
||||||
|
self.keys.local_master_salt = client_write_salt;
|
||||||
|
self.keys.remote_master_key = server_write_key;
|
||||||
|
self.keys.remote_master_salt = server_write_salt;
|
||||||
|
} else {
|
||||||
|
self.keys.local_master_key = server_write_key;
|
||||||
|
self.keys.local_master_salt = server_write_salt;
|
||||||
|
self.keys.remote_master_key = client_write_key;
|
||||||
|
self.keys.remote_master_salt = client_write_salt;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
+341
@@ -0,0 +1,341 @@
|
|||||||
|
use bytes::Bytes;
|
||||||
|
use lazy_static::lazy_static;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use crate::key_derivation::*;
|
||||||
|
|
||||||
|
const CIPHER_CONTEXT_ALGO: ProtectionProfile = ProtectionProfile::Aes128CmHmacSha1_80;
|
||||||
|
const DEFAULT_SSRC: u32 = 0;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_context_roc() -> Result<()> {
|
||||||
|
let key_len = CIPHER_CONTEXT_ALGO.key_len();
|
||||||
|
let salt_len = CIPHER_CONTEXT_ALGO.salt_len();
|
||||||
|
|
||||||
|
let mut c = Context::new(
|
||||||
|
&vec![0; key_len],
|
||||||
|
&vec![0; salt_len],
|
||||||
|
CIPHER_CONTEXT_ALGO,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let roc = c.get_roc(123);
|
||||||
|
assert!(roc.is_none(), "ROC must return None for unused SSRC");
|
||||||
|
|
||||||
|
c.set_roc(123, 100);
|
||||||
|
let roc = c.get_roc(123);
|
||||||
|
if let Some(r) = roc {
|
||||||
|
assert_eq!(r, 100, "ROC is set to 100, but returned {r}")
|
||||||
|
} else {
|
||||||
|
panic!("ROC must return value for used SSRC");
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_context_index() -> Result<()> {
|
||||||
|
let key_len = CIPHER_CONTEXT_ALGO.key_len();
|
||||||
|
let salt_len = CIPHER_CONTEXT_ALGO.salt_len();
|
||||||
|
|
||||||
|
let mut c = Context::new(
|
||||||
|
&vec![0; key_len],
|
||||||
|
&vec![0; salt_len],
|
||||||
|
CIPHER_CONTEXT_ALGO,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let index = c.get_index(123);
|
||||||
|
assert!(index.is_none(), "Index must return None for unused SSRC");
|
||||||
|
|
||||||
|
c.set_index(123, 100);
|
||||||
|
let index = c.get_index(123);
|
||||||
|
if let Some(i) = index {
|
||||||
|
assert_eq!(i, 100, "Index is set to 100, but returned {i}");
|
||||||
|
} else {
|
||||||
|
panic!("Index must return true for used SSRC")
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_key_len() -> Result<()> {
|
||||||
|
let key_len = CIPHER_CONTEXT_ALGO.key_len();
|
||||||
|
let salt_len = CIPHER_CONTEXT_ALGO.salt_len();
|
||||||
|
|
||||||
|
let result = Context::new(&[], &vec![0; salt_len], CIPHER_CONTEXT_ALGO, None, None);
|
||||||
|
assert!(result.is_err(), "CreateContext accepted a 0 length key");
|
||||||
|
|
||||||
|
let result = Context::new(&vec![0; key_len], &[], CIPHER_CONTEXT_ALGO, None, None);
|
||||||
|
assert!(result.is_err(), "CreateContext accepted a 0 length salt");
|
||||||
|
|
||||||
|
let result = Context::new(
|
||||||
|
&vec![0; key_len],
|
||||||
|
&vec![0; salt_len],
|
||||||
|
CIPHER_CONTEXT_ALGO,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
result.is_ok(),
|
||||||
|
"CreateContext failed with a valid length key and salt"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_valid_packet_counter() -> Result<()> {
|
||||||
|
let master_key = vec![
|
||||||
|
0x0d, 0xcd, 0x21, 0x3e, 0x4c, 0xbc, 0xf2, 0x8f, 0x01, 0x7f, 0x69, 0x94, 0x40, 0x1e, 0x28,
|
||||||
|
0x89,
|
||||||
|
];
|
||||||
|
let master_salt = vec![
|
||||||
|
0x62, 0x77, 0x60, 0x38, 0xc0, 0x6d, 0xc9, 0x41, 0x9f, 0x6d, 0xd9, 0x43, 0x3e, 0x7c,
|
||||||
|
];
|
||||||
|
|
||||||
|
let srtp_session_salt = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_SALT,
|
||||||
|
&master_key,
|
||||||
|
&master_salt,
|
||||||
|
0,
|
||||||
|
master_salt.len(),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let s = SrtpSsrcState {
|
||||||
|
ssrc: 4160032510,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let expected_counter = [
|
||||||
|
0xcf, 0x90, 0x1e, 0xa5, 0xda, 0xd3, 0x2c, 0x15, 0x00, 0xa2, 0x24, 0xae, 0xae, 0xaf, 0x00,
|
||||||
|
0x00,
|
||||||
|
];
|
||||||
|
let counter = generate_counter(32846, s.rollover_counter, s.ssrc, &srtp_session_salt);
|
||||||
|
assert_eq!(
|
||||||
|
counter, expected_counter,
|
||||||
|
"Session Key {counter:?} does not match expected {expected_counter:?}",
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rollover_count() -> Result<()> {
|
||||||
|
let mut s = SrtpSsrcState {
|
||||||
|
ssrc: DEFAULT_SSRC,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
// Set initial seqnum
|
||||||
|
let roc = s.next_rollover_count(65530);
|
||||||
|
assert_eq!(roc, 0, "Initial rolloverCounter must be 0");
|
||||||
|
s.update_rollover_count(65530);
|
||||||
|
|
||||||
|
// Invalid packets never update ROC
|
||||||
|
s.next_rollover_count(0);
|
||||||
|
s.next_rollover_count(0x4000);
|
||||||
|
s.next_rollover_count(0x8000);
|
||||||
|
s.next_rollover_count(0xFFFF);
|
||||||
|
s.next_rollover_count(0);
|
||||||
|
|
||||||
|
// We rolled over to 0
|
||||||
|
let roc = s.next_rollover_count(0);
|
||||||
|
assert_eq!(roc, 1, "rolloverCounter was not updated after it crossed 0");
|
||||||
|
s.update_rollover_count(0);
|
||||||
|
|
||||||
|
let roc = s.next_rollover_count(65530);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 0,
|
||||||
|
"rolloverCounter was not updated when it rolled back, failed to handle out of order"
|
||||||
|
);
|
||||||
|
s.update_rollover_count(65530);
|
||||||
|
|
||||||
|
let roc = s.next_rollover_count(5);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 1,
|
||||||
|
"rolloverCounter was not updated when it rolled over initial, to handle out of order"
|
||||||
|
);
|
||||||
|
s.update_rollover_count(5);
|
||||||
|
|
||||||
|
s.next_rollover_count(6);
|
||||||
|
s.update_rollover_count(6);
|
||||||
|
|
||||||
|
s.next_rollover_count(7);
|
||||||
|
s.update_rollover_count(7);
|
||||||
|
|
||||||
|
let roc = s.next_rollover_count(8);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 1,
|
||||||
|
"rolloverCounter was improperly updated for non-significant packets"
|
||||||
|
);
|
||||||
|
s.update_rollover_count(8);
|
||||||
|
|
||||||
|
// valid packets never update ROC
|
||||||
|
let roc = s.next_rollover_count(0x4000);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 1,
|
||||||
|
"rolloverCounter was improperly updated for non-significant packets"
|
||||||
|
);
|
||||||
|
s.update_rollover_count(0x4000);
|
||||||
|
|
||||||
|
let roc = s.next_rollover_count(0x8000);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 1,
|
||||||
|
"rolloverCounter was improperly updated for non-significant packets"
|
||||||
|
);
|
||||||
|
s.update_rollover_count(0x8000);
|
||||||
|
|
||||||
|
let roc = s.next_rollover_count(0xFFFF);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 1,
|
||||||
|
"rolloverCounter was improperly updated for non-significant packets"
|
||||||
|
);
|
||||||
|
s.update_rollover_count(0xFFFF);
|
||||||
|
|
||||||
|
let roc = s.next_rollover_count(0);
|
||||||
|
assert_eq!(
|
||||||
|
roc, 2,
|
||||||
|
"rolloverCounter must be incremented after wrapping, got {roc}"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
lazy_static! {
|
||||||
|
static ref MASTER_KEY: Bytes = Bytes::from_static(&[
|
||||||
|
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
|
||||||
|
0x0f,
|
||||||
|
]);
|
||||||
|
static ref MASTER_SALT: Bytes = Bytes::from_static(&[
|
||||||
|
0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab,
|
||||||
|
]);
|
||||||
|
static ref DECRYPTED_RTP_PACKET: Bytes = Bytes::from_static(&[
|
||||||
|
0x80, 0x0f, 0x12, 0x34, 0xde, 0xca, 0xfb, 0xad, 0xca, 0xfe, 0xba, 0xbe, 0xab, 0xab, 0xab,
|
||||||
|
0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab,
|
||||||
|
]);
|
||||||
|
static ref ENCRYPTED_RTP_PACKET: Bytes = Bytes::from_static(&[
|
||||||
|
0x80, 0x0f, 0x12, 0x34, 0xde, 0xca, 0xfb, 0xad, 0xca, 0xfe, 0xba, 0xbe, 0xc5, 0x00, 0x2e,
|
||||||
|
0xde, 0x04, 0xcf, 0xdd, 0x2e, 0xb9, 0x11, 0x59, 0xe0, 0x88, 0x0a, 0xa0, 0x6e, 0xd2, 0x97,
|
||||||
|
0x68, 0x26, 0xf7, 0x96, 0xb2, 0x01, 0xdf, 0x31, 0x31, 0xa1, 0x27, 0xe8, 0xa3, 0x92,
|
||||||
|
]);
|
||||||
|
static ref DECRYPTED_RTCP_PACKET: Bytes = Bytes::from_static(&[
|
||||||
|
0x81, 0xc8, 0x00, 0x0b, 0xca, 0xfe, 0xba, 0xbe, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab,
|
||||||
|
0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab, 0xab,
|
||||||
|
]);
|
||||||
|
static ref ENCRYPTED_RTCP_PACKET: Bytes = Bytes::from_static(&[
|
||||||
|
0x81, 0xc8, 0x00, 0x0b, 0xca, 0xfe, 0xba, 0xbe, 0xc9, 0x8b, 0x8b, 0x5d, 0xf0, 0x39, 0x2a,
|
||||||
|
0x55, 0x85, 0x2b, 0x6c, 0x21, 0xac, 0x8e, 0x70, 0x25, 0xc5, 0x2c, 0x6f, 0xbe, 0xa2, 0xb3,
|
||||||
|
0xb4, 0x46, 0xea, 0x31, 0x12, 0x3b, 0xa8, 0x8c, 0xe6, 0x1e, 0x80, 0x00, 0x00, 0x01,
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_encrypt_rtp() {
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
&MASTER_KEY,
|
||||||
|
&MASTER_SALT,
|
||||||
|
ProtectionProfile::AeadAes128Gcm,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.expect("Error creating srtp context");
|
||||||
|
|
||||||
|
let gotten_encrypted_rtp_packet = ctx
|
||||||
|
.encrypt_rtp(&DECRYPTED_RTP_PACKET)
|
||||||
|
.expect("Error encrypting rtp payload");
|
||||||
|
|
||||||
|
assert_eq!(gotten_encrypted_rtp_packet, *ENCRYPTED_RTP_PACKET)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_decrypt_rtp() {
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
&MASTER_KEY,
|
||||||
|
&MASTER_SALT,
|
||||||
|
ProtectionProfile::AeadAes128Gcm,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.expect("Error creating srtp context");
|
||||||
|
|
||||||
|
let gotten_decrypted_rtp_packet = ctx
|
||||||
|
.decrypt_rtp(&ENCRYPTED_RTP_PACKET)
|
||||||
|
.expect("Error decrypting rtp payload");
|
||||||
|
|
||||||
|
assert_eq!(gotten_decrypted_rtp_packet, *DECRYPTED_RTP_PACKET)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_encrypt_rtcp() {
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
&MASTER_KEY,
|
||||||
|
&MASTER_SALT,
|
||||||
|
ProtectionProfile::AeadAes128Gcm,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.expect("Error creating srtp context");
|
||||||
|
|
||||||
|
let gotten_encrypted_rtcp_packet = ctx
|
||||||
|
.encrypt_rtcp(&DECRYPTED_RTCP_PACKET)
|
||||||
|
.expect("Error encrypting rtcp payload");
|
||||||
|
|
||||||
|
assert_eq!(gotten_encrypted_rtcp_packet, *ENCRYPTED_RTCP_PACKET)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_decrypt_rtcp() {
|
||||||
|
let mut ctx = Context::new(
|
||||||
|
&MASTER_KEY,
|
||||||
|
&MASTER_SALT,
|
||||||
|
ProtectionProfile::AeadAes128Gcm,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.expect("Error creating srtp context");
|
||||||
|
|
||||||
|
let gotten_decrypted_rtcp_packet = ctx
|
||||||
|
.decrypt_rtcp(&ENCRYPTED_RTCP_PACKET)
|
||||||
|
.expect("Error decrypting rtcp payload");
|
||||||
|
|
||||||
|
assert_eq!(gotten_decrypted_rtcp_packet, *DECRYPTED_RTCP_PACKET)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rollover_high_water_mark() {
|
||||||
|
let mut state = super::SrtpSsrcState::default();
|
||||||
|
for seq in [65000, 65535, 85] {
|
||||||
|
state.update_rollover_count(seq);
|
||||||
|
}
|
||||||
|
for seq in [65000, 65530, 84, 0] {
|
||||||
|
state.update_rollover_count(seq);
|
||||||
|
assert_eq!(state.rollover_counter, 1);
|
||||||
|
assert_eq!(state.last_sequence_number, 85);
|
||||||
|
}
|
||||||
|
assert_eq!(state.next_rollover_count(86), 1);
|
||||||
|
state.update_rollover_count(1000);
|
||||||
|
state.update_rollover_count(32000);
|
||||||
|
state.update_rollover_count(64000);
|
||||||
|
assert_eq!(state.next_rollover_count(1000), 2);
|
||||||
|
state.update_rollover_count(1000);
|
||||||
|
assert_eq!(state.rollover_counter, 2);
|
||||||
|
assert_eq!(state.last_sequence_number, 1000);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rollover_initial_zero_and_counter_wrap() {
|
||||||
|
let mut state = super::SrtpSsrcState::default();
|
||||||
|
state.update_rollover_count(0);
|
||||||
|
assert_eq!(state.next_rollover_count(65535), u32::MAX);
|
||||||
|
state.update_rollover_count(65535);
|
||||||
|
assert_eq!(state.rollover_counter, 0);
|
||||||
|
assert_eq!(state.last_sequence_number, 0);
|
||||||
|
state.rollover_counter = u32::MAX;
|
||||||
|
state.last_sequence_number = 65535;
|
||||||
|
state.update_rollover_count(0);
|
||||||
|
assert_eq!(state.rollover_counter, 0);
|
||||||
|
assert_eq!(state.last_sequence_number, 0);
|
||||||
|
}
|
||||||
+177
@@ -0,0 +1,177 @@
|
|||||||
|
#[cfg(test)]
|
||||||
|
mod context_test;
|
||||||
|
#[cfg(test)]
|
||||||
|
mod rollover_regression_test;
|
||||||
|
#[cfg(test)]
|
||||||
|
mod srtcp_test;
|
||||||
|
#[cfg(test)]
|
||||||
|
mod srtp_test;
|
||||||
|
|
||||||
|
use std::collections::HashMap;
|
||||||
|
|
||||||
|
use util::replay_detector::*;
|
||||||
|
|
||||||
|
use crate::cipher::cipher_aead_aes_gcm::*;
|
||||||
|
use crate::cipher::cipher_aes_cm_hmac_sha1::*;
|
||||||
|
use crate::cipher::*;
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::option::*;
|
||||||
|
use crate::protection_profile::*;
|
||||||
|
|
||||||
|
pub mod srtcp;
|
||||||
|
pub mod srtp;
|
||||||
|
|
||||||
|
const SEQUENCE_HALF_RANGE: i32 = 1 << 15;
|
||||||
|
|
||||||
|
/// Encrypt/Decrypt state for a single SRTP SSRC
|
||||||
|
#[derive(Default)]
|
||||||
|
pub(crate) struct SrtpSsrcState {
|
||||||
|
ssrc: u32,
|
||||||
|
rollover_counter: u32,
|
||||||
|
rollover_has_processed: bool,
|
||||||
|
last_sequence_number: u16,
|
||||||
|
replay_detector: Option<Box<dyn ReplayDetector + Send + 'static>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Encrypt/Decrypt state for a single SRTCP SSRC
|
||||||
|
#[derive(Default)]
|
||||||
|
pub(crate) struct SrtcpSsrcState {
|
||||||
|
srtcp_index: usize,
|
||||||
|
ssrc: u32,
|
||||||
|
replay_detector: Option<Box<dyn ReplayDetector + Send + 'static>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl SrtpSsrcState {
|
||||||
|
pub fn next_rollover_count(&self, sequence_number: u16) -> u32 {
|
||||||
|
let roc = self.rollover_counter;
|
||||||
|
if !self.rollover_has_processed {
|
||||||
|
return roc;
|
||||||
|
}
|
||||||
|
// RFC 3711 Appendix A: estimate the index nearest the highest packet.
|
||||||
|
let last = i32::from(self.last_sequence_number);
|
||||||
|
let seq = i32::from(sequence_number);
|
||||||
|
if last < SEQUENCE_HALF_RANGE {
|
||||||
|
if seq - last > SEQUENCE_HALF_RANGE {
|
||||||
|
return roc.wrapping_sub(1);
|
||||||
|
}
|
||||||
|
} else if last - SEQUENCE_HALF_RANGE > seq {
|
||||||
|
return roc.wrapping_add(1);
|
||||||
|
}
|
||||||
|
roc
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn update_rollover_count(&mut self, sequence_number: u16) {
|
||||||
|
let roc = self.next_rollover_count(sequence_number);
|
||||||
|
// Retransmissions must never move the highest authenticated index back.
|
||||||
|
if !self.rollover_has_processed
|
||||||
|
|| (roc == self.rollover_counter && sequence_number > self.last_sequence_number)
|
||||||
|
|| roc == self.rollover_counter.wrapping_add(1)
|
||||||
|
{
|
||||||
|
self.rollover_counter = roc;
|
||||||
|
self.last_sequence_number = sequence_number;
|
||||||
|
self.rollover_has_processed = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Context represents a SRTP cryptographic context
|
||||||
|
/// Context can only be used for one-way operations
|
||||||
|
/// it must either used ONLY for encryption or ONLY for decryption
|
||||||
|
pub struct Context {
|
||||||
|
cipher: Box<dyn Cipher + Send>,
|
||||||
|
|
||||||
|
srtp_ssrc_states: HashMap<u32, SrtpSsrcState>,
|
||||||
|
srtcp_ssrc_states: HashMap<u32, SrtcpSsrcState>,
|
||||||
|
|
||||||
|
new_srtp_replay_detector: ContextOption,
|
||||||
|
new_srtcp_replay_detector: ContextOption,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Context {
|
||||||
|
/// CreateContext creates a new SRTP Context
|
||||||
|
pub fn new(
|
||||||
|
master_key: &[u8],
|
||||||
|
master_salt: &[u8],
|
||||||
|
profile: ProtectionProfile,
|
||||||
|
srtp_ctx_opt: Option<ContextOption>,
|
||||||
|
srtcp_ctx_opt: Option<ContextOption>,
|
||||||
|
) -> Result<Context> {
|
||||||
|
let key_len = profile.key_len();
|
||||||
|
let salt_len = profile.salt_len();
|
||||||
|
|
||||||
|
if master_key.len() != key_len {
|
||||||
|
return Err(Error::SrtpMasterKeyLength(key_len, master_key.len()));
|
||||||
|
} else if master_salt.len() != salt_len {
|
||||||
|
return Err(Error::SrtpSaltLength(salt_len, master_salt.len()));
|
||||||
|
}
|
||||||
|
|
||||||
|
let cipher: Box<dyn Cipher + Send> = match profile {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 => {
|
||||||
|
Box::new(CipherAesCmHmacSha1::new(master_key, master_salt)?)
|
||||||
|
}
|
||||||
|
|
||||||
|
ProtectionProfile::AeadAes128Gcm => {
|
||||||
|
Box::new(CipherAeadAesGcm::new(master_key, master_salt)?)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
let srtp_ctx_opt = if let Some(ctx_opt) = srtp_ctx_opt {
|
||||||
|
ctx_opt
|
||||||
|
} else {
|
||||||
|
srtp_no_replay_protection()
|
||||||
|
};
|
||||||
|
|
||||||
|
let srtcp_ctx_opt = if let Some(ctx_opt) = srtcp_ctx_opt {
|
||||||
|
ctx_opt
|
||||||
|
} else {
|
||||||
|
srtcp_no_replay_protection()
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(Context {
|
||||||
|
cipher,
|
||||||
|
srtp_ssrc_states: HashMap::new(),
|
||||||
|
srtcp_ssrc_states: HashMap::new(),
|
||||||
|
new_srtp_replay_detector: srtp_ctx_opt,
|
||||||
|
new_srtcp_replay_detector: srtcp_ctx_opt,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_srtp_ssrc_state(&mut self, ssrc: u32) -> &mut SrtpSsrcState {
|
||||||
|
let s = SrtpSsrcState {
|
||||||
|
ssrc,
|
||||||
|
replay_detector: Some((self.new_srtp_replay_detector)()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
self.srtp_ssrc_states.entry(ssrc).or_insert(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_srtcp_ssrc_state(&mut self, ssrc: u32) -> &mut SrtcpSsrcState {
|
||||||
|
let s = SrtcpSsrcState {
|
||||||
|
ssrc,
|
||||||
|
replay_detector: Some((self.new_srtcp_replay_detector)()),
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
self.srtcp_ssrc_states.entry(ssrc).or_insert(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// roc returns SRTP rollover counter value of specified SSRC.
|
||||||
|
fn get_roc(&self, ssrc: u32) -> Option<u32> {
|
||||||
|
self.srtp_ssrc_states.get(&ssrc).map(|s| s.rollover_counter)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// set_roc sets SRTP rollover counter value of specified SSRC.
|
||||||
|
fn set_roc(&mut self, ssrc: u32, roc: u32) {
|
||||||
|
self.get_srtp_ssrc_state(ssrc).rollover_counter = roc;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// index returns SRTCP index value of specified SSRC.
|
||||||
|
fn get_index(&self, ssrc: u32) -> Option<usize> {
|
||||||
|
self.srtcp_ssrc_states.get(&ssrc).map(|s| s.srtcp_index)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// set_index sets SRTCP index value of specified SSRC.
|
||||||
|
fn set_index(&mut self, ssrc: u32, index: usize) {
|
||||||
|
self.get_srtcp_ssrc_state(ssrc).srtcp_index = index;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
use crate::{context::Context, protection_profile::ProtectionProfile};
|
||||||
|
fn packet(seq: u16) -> (Vec<u8>, rtp::header::Header) {
|
||||||
|
let h = rtp::header::Header {
|
||||||
|
version: 2,
|
||||||
|
sequence_number: seq,
|
||||||
|
ssrc: 1,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
let mut b = vec![0x80, 96];
|
||||||
|
b.extend(seq.to_be_bytes());
|
||||||
|
b.extend(0u32.to_be_bytes());
|
||||||
|
b.extend(1u32.to_be_bytes());
|
||||||
|
b.extend([1, 2, 3, 4]);
|
||||||
|
(b, h)
|
||||||
|
}
|
||||||
|
fn run(profile: ProtectionProfile, retransmits: bool) -> usize {
|
||||||
|
let mut tx = Context::new(
|
||||||
|
&vec![0; 16],
|
||||||
|
&vec![
|
||||||
|
0;
|
||||||
|
match profile {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 => 14,
|
||||||
|
_ => 12,
|
||||||
|
}
|
||||||
|
],
|
||||||
|
profile,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
let mut rx = Context::new(
|
||||||
|
&vec![0; 16],
|
||||||
|
&vec![
|
||||||
|
0;
|
||||||
|
match profile {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 => 14,
|
||||||
|
_ => 12,
|
||||||
|
}
|
||||||
|
],
|
||||||
|
profile,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
for seq in (65000u16..=65535).chain(0..=85) {
|
||||||
|
let (b, h) = packet(seq);
|
||||||
|
let e = tx.encrypt_rtp_with_header(&b, &h).unwrap();
|
||||||
|
rx.decrypt_rtp(&e).unwrap();
|
||||||
|
}
|
||||||
|
if retransmits {
|
||||||
|
for seq in [65000, 65530] {
|
||||||
|
let (b, h) = packet(seq);
|
||||||
|
let _ = tx.encrypt_rtp_with_header(&b, &h).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let mut failures = 0;
|
||||||
|
for seq in 86..=1000 {
|
||||||
|
let (b, h) = packet(seq);
|
||||||
|
let e = tx.encrypt_rtp_with_header(&b, &h).unwrap();
|
||||||
|
failures += usize::from(rx.decrypt_rtp(&e).is_err());
|
||||||
|
}
|
||||||
|
failures
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn delayed_retransmissions_preserve_authentication() {
|
||||||
|
for profile in [
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
ProtectionProfile::AeadAes128Gcm,
|
||||||
|
] {
|
||||||
|
assert_eq!(run(profile, false), 0);
|
||||||
|
assert_eq!(run(profile, true), 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
+50
@@ -0,0 +1,50 @@
|
|||||||
|
use bytes::Bytes;
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use crate::error::Result;
|
||||||
|
|
||||||
|
impl Context {
|
||||||
|
/// DecryptRTCP decrypts a RTCP packet with an encrypted payload
|
||||||
|
pub fn decrypt_rtcp(&mut self, encrypted: &[u8]) -> Result<Bytes> {
|
||||||
|
let mut buf = encrypted;
|
||||||
|
rtcp::header::Header::unmarshal(&mut buf)?;
|
||||||
|
|
||||||
|
let index = self.cipher.get_rtcp_index(encrypted);
|
||||||
|
let ssrc = u32::from_be_bytes([encrypted[4], encrypted[5], encrypted[6], encrypted[7]]);
|
||||||
|
|
||||||
|
if let Some(replay_detector) = &mut self.get_srtcp_ssrc_state(ssrc).replay_detector {
|
||||||
|
if !replay_detector.check(index as u64) {
|
||||||
|
return Err(Error::SrtcpSsrcDuplicated(ssrc, index));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let dst = self.cipher.decrypt_rtcp(encrypted, index, ssrc)?;
|
||||||
|
|
||||||
|
if let Some(replay_detector) = &mut self.get_srtcp_ssrc_state(ssrc).replay_detector {
|
||||||
|
replay_detector.accept();
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(dst)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// EncryptRTCP marshals and encrypts an RTCP packet, writing to the dst buffer provided.
|
||||||
|
/// If the dst buffer does not have the capacity to hold `len(plaintext) + 14` bytes, a new one will be allocated and returned.
|
||||||
|
pub fn encrypt_rtcp(&mut self, decrypted: &[u8]) -> Result<Bytes> {
|
||||||
|
let mut buf = decrypted;
|
||||||
|
rtcp::header::Header::unmarshal(&mut buf)?;
|
||||||
|
|
||||||
|
let ssrc = u32::from_be_bytes([decrypted[4], decrypted[5], decrypted[6], decrypted[7]]);
|
||||||
|
|
||||||
|
let index = {
|
||||||
|
let state = self.get_srtcp_ssrc_state(ssrc);
|
||||||
|
state.srtcp_index += 1;
|
||||||
|
if state.srtcp_index > MAX_SRTCP_INDEX {
|
||||||
|
state.srtcp_index = 0;
|
||||||
|
}
|
||||||
|
state.srtcp_index
|
||||||
|
};
|
||||||
|
|
||||||
|
self.cipher.encrypt_rtcp(decrypted, index, ssrc)
|
||||||
|
}
|
||||||
|
}
|
||||||
+257
@@ -0,0 +1,257 @@
|
|||||||
|
use bytes::{Buf, Bytes, BytesMut};
|
||||||
|
use lazy_static::lazy_static;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use crate::key_derivation::*;
|
||||||
|
|
||||||
|
pub struct RTCPTestCase {
|
||||||
|
ssrc: u32,
|
||||||
|
index: usize,
|
||||||
|
encrypted: Bytes,
|
||||||
|
decrypted: Bytes,
|
||||||
|
}
|
||||||
|
|
||||||
|
lazy_static! {
|
||||||
|
static ref RTCP_TEST_MASTER_KEY: Bytes = Bytes::from_static(&[
|
||||||
|
0xfd, 0xa6, 0x25, 0x95, 0xd7, 0xf6, 0x92, 0x6f, 0x7d, 0x9c, 0x02, 0x4c, 0xc9, 0x20, 0x9f,
|
||||||
|
0x34
|
||||||
|
]);
|
||||||
|
|
||||||
|
static ref RTCP_TEST_MASTER_SALT: Bytes = Bytes::from_static(&[
|
||||||
|
0xa9, 0x65, 0x19, 0x85, 0x54, 0x0b, 0x47, 0xbe, 0x2f, 0x27, 0xa8, 0xb8, 0x81, 0x23
|
||||||
|
]);
|
||||||
|
|
||||||
|
static ref RTCP_TEST_CASES: Vec<RTCPTestCase> = vec![
|
||||||
|
RTCPTestCase {
|
||||||
|
ssrc: 0x66ef91ff,
|
||||||
|
index: 0,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x00, 0x06, 0x66, 0xef, 0x91, 0xff, 0xcd, 0x34, 0xc5, 0x78, 0xb2, 0x8b,
|
||||||
|
0xe1, 0x6b, 0xc5, 0x09, 0xd5, 0x77, 0xe4, 0xce, 0x5f, 0x20, 0x80, 0x21, 0xbd, 0x66,
|
||||||
|
0x74, 0x65, 0xe9, 0x5f, 0x49, 0xe5, 0xf5, 0xc0, 0x68, 0x4e, 0xe5, 0x6a, 0x78, 0x07,
|
||||||
|
0x75, 0x46, 0xed, 0x90, 0xf6, 0xdc, 0x9d, 0xef, 0x3b, 0xdf, 0xf2, 0x79, 0xa9, 0xd8,
|
||||||
|
0x80, 0x00, 0x00, 0x01, 0x60, 0xc0, 0xae, 0xb5, 0x6f, 0x40, 0x88, 0x0e, 0x28, 0xba
|
||||||
|
]),
|
||||||
|
decrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x00, 0x06, 0x66, 0xef, 0x91, 0xff, 0xdf, 0x48, 0x80, 0xdd, 0x61, 0xa6,
|
||||||
|
0x2e, 0xd3, 0xd8, 0xbc, 0xde, 0xbe, 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x16, 0x04,
|
||||||
|
0x81, 0xca, 0x00, 0x06, 0x66, 0xef, 0x91, 0xff, 0x01, 0x10, 0x52, 0x6e, 0x54, 0x35,
|
||||||
|
0x43, 0x6d, 0x4a, 0x68, 0x7a, 0x79, 0x65, 0x74, 0x41, 0x78, 0x77, 0x2b, 0x00, 0x00
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTCPTestCase{
|
||||||
|
ssrc: 0x11111111,
|
||||||
|
index: 0,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x00, 0x06, 0x11, 0x11, 0x11, 0x11, 0x17, 0x8c, 0x15, 0xf1, 0x4b, 0x11,
|
||||||
|
0xda, 0xf5, 0x74, 0x53, 0x86, 0x2b, 0xc9, 0x07, 0x29, 0x40, 0xbf, 0x22, 0xf6, 0x46,
|
||||||
|
0x11, 0xa4, 0xc1, 0x3a, 0xff, 0x5a, 0xbd, 0xd0, 0xf8, 0x8b, 0x38, 0xe4, 0x95, 0x38,
|
||||||
|
0x5d, 0xcf, 0x1b, 0xf5, 0x27, 0x77, 0xfb, 0xdb, 0x3f, 0x10, 0x68, 0x99, 0xd8, 0xad,
|
||||||
|
0x80, 0x00, 0x00, 0x01, 0x34, 0x3c, 0x2e, 0x83, 0x17, 0x13, 0x93, 0x69, 0xcf, 0xc0
|
||||||
|
]),
|
||||||
|
decrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x00, 0x06, 0x11, 0x11, 0x11, 0x11, 0xdf, 0x48, 0x80, 0xdd, 0x61, 0xa6,
|
||||||
|
0x2e, 0xd3, 0xd8, 0xbc, 0xde, 0xbe, 0x00, 0x00, 0x00, 0x09, 0x00, 0x00, 0x16, 0x04,
|
||||||
|
0x81, 0xca, 0x00, 0x06, 0x66, 0xef, 0x91, 0xff, 0x01, 0x10, 0x52, 0x6e, 0x54, 0x35,
|
||||||
|
0x43, 0x6d, 0x4a, 0x68, 0x7a, 0x79, 0x65, 0x74, 0x41, 0x78, 0x77, 0x2b, 0x00, 0x00
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTCPTestCase{
|
||||||
|
ssrc: 0x11111111,
|
||||||
|
index: 0x7ffffffe, // Upper boundary of index
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x00, 0x06, 0x11, 0x11, 0x11, 0x11, 0x17, 0x8c, 0x15, 0xf1, 0x4b, 0x11,
|
||||||
|
0xda, 0xf5, 0x74, 0x53, 0x86, 0x2b, 0xc9, 0x07, 0x29, 0x40, 0xbf, 0x22, 0xf6, 0x46,
|
||||||
|
0x11, 0xa4, 0xc1, 0x3a, 0xff, 0x5a, 0xbd, 0xd0, 0xf8, 0x8b, 0x38, 0xe4, 0x95, 0x38,
|
||||||
|
0x5d, 0xcf, 0x1b, 0xf5, 0x27, 0x77, 0xfb, 0xdb, 0x3f, 0x10, 0x68, 0x99, 0xd8, 0xad,
|
||||||
|
0xff, 0xff, 0xff, 0xff, 0x5a, 0x99, 0xce, 0xed, 0x9f, 0x2e, 0x4d, 0x9d, 0xfa, 0x97
|
||||||
|
]),
|
||||||
|
decrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x0, 0x6, 0x11, 0x11, 0x11, 0x11, 0x4, 0x99, 0x47, 0x53, 0xc4, 0x1e,
|
||||||
|
0xb9, 0xde, 0x52, 0xa3, 0x1d, 0x77, 0x2f, 0xff, 0xcc, 0x75, 0xbb, 0x6a, 0x29, 0xb8,
|
||||||
|
0x1, 0xb7, 0x2e, 0x4b, 0x4e, 0xcb, 0xa4, 0x81, 0x2d, 0x46, 0x4, 0x5e, 0x86, 0x90,
|
||||||
|
0x17, 0x4f, 0x4d, 0x78, 0x2f, 0x58, 0xb8, 0x67, 0x91, 0x89, 0xe3, 0x61, 0x1, 0x7d
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTCPTestCase{
|
||||||
|
ssrc: 0x11111111,
|
||||||
|
index: 0x7fffffff, // Will be wrapped to 0
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x00, 0x06, 0x11, 0x11, 0x11, 0x11, 0x17, 0x8c, 0x15, 0xf1, 0x4b, 0x11,
|
||||||
|
0xda, 0xf5, 0x74, 0x53, 0x86, 0x2b, 0xc9, 0x07, 0x29, 0x40, 0xbf, 0x22, 0xf6, 0x46,
|
||||||
|
0x11, 0xa4, 0xc1, 0x3a, 0xff, 0x5a, 0xbd, 0xd0, 0xf8, 0x8b, 0x38, 0xe4, 0x95, 0x38,
|
||||||
|
0x5d, 0xcf, 0x1b, 0xf5, 0x27, 0x77, 0xfb, 0xdb, 0x3f, 0x10, 0x68, 0x99, 0xd8, 0xad,
|
||||||
|
0x80, 0x00, 0x00, 0x00, 0x7d, 0x51, 0xf8, 0x0e, 0x56, 0x40, 0x72, 0x7b, 0x9e, 0x02
|
||||||
|
]),
|
||||||
|
decrypted: Bytes::from_static(&[
|
||||||
|
0x80, 0xc8, 0x0, 0x6, 0x11, 0x11, 0x11, 0x11, 0xda, 0xb5, 0xe0, 0x56, 0x9a, 0x4a,
|
||||||
|
0x74, 0xed, 0x8a, 0x54, 0xc, 0xcf, 0xd5, 0x9, 0xb1, 0x40, 0x1, 0x42, 0xc3, 0x9a,
|
||||||
|
0x76, 0x0, 0xa9, 0xd4, 0xf7, 0x29, 0x9e, 0x51, 0xfb, 0x3c, 0xc1, 0x74, 0x72, 0xf9,
|
||||||
|
0x52, 0xb1, 0x92, 0x31, 0xca, 0x22, 0xab, 0x3e, 0xc5, 0x5f, 0x83, 0x34, 0xf0, 0x28
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rtcp_lifecycle() -> Result<()> {
|
||||||
|
let mut encrypt_context = Context::new(
|
||||||
|
&RTCP_TEST_MASTER_KEY,
|
||||||
|
&RTCP_TEST_MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
let mut decrypt_context = Context::new(
|
||||||
|
&RTCP_TEST_MASTER_KEY,
|
||||||
|
&RTCP_TEST_MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
for test_case in &*RTCP_TEST_CASES {
|
||||||
|
let decrypt_result = decrypt_context.decrypt_rtcp(&test_case.encrypted)?;
|
||||||
|
assert_eq!(
|
||||||
|
decrypt_result, test_case.decrypted,
|
||||||
|
"RTCP failed to decrypt"
|
||||||
|
);
|
||||||
|
|
||||||
|
encrypt_context.set_index(test_case.ssrc, test_case.index);
|
||||||
|
let encrypt_result = encrypt_context.encrypt_rtcp(&test_case.decrypted)?;
|
||||||
|
assert_eq!(
|
||||||
|
encrypt_result, test_case.encrypted,
|
||||||
|
"RTCP failed to encrypt"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rtcp_invalid_auth_tag() -> Result<()> {
|
||||||
|
let auth_tag_len = ProtectionProfile::Aes128CmHmacSha1_80.auth_tag_len();
|
||||||
|
|
||||||
|
let mut decrypt_context = Context::new(
|
||||||
|
&RTCP_TEST_MASTER_KEY,
|
||||||
|
&RTCP_TEST_MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let decrypt_result = decrypt_context.decrypt_rtcp(&RTCP_TEST_CASES[0].encrypted)?;
|
||||||
|
assert_eq!(
|
||||||
|
decrypt_result, RTCP_TEST_CASES[0].decrypted,
|
||||||
|
"RTCP failed to decrypt"
|
||||||
|
);
|
||||||
|
|
||||||
|
// Zero out auth tag
|
||||||
|
let mut rtcp_packet = BytesMut::new();
|
||||||
|
rtcp_packet.extend_from_slice(&RTCP_TEST_CASES[0].encrypted);
|
||||||
|
let rtcp_packet_len = rtcp_packet.len();
|
||||||
|
rtcp_packet[rtcp_packet_len - auth_tag_len..].copy_from_slice(&vec![0; auth_tag_len]);
|
||||||
|
let rtcp_packet = rtcp_packet.freeze();
|
||||||
|
let decrypt_result = decrypt_context.decrypt_rtcp(&rtcp_packet);
|
||||||
|
assert!(
|
||||||
|
decrypt_result.is_err(),
|
||||||
|
"Was able to decrypt RTCP packet with invalid Auth Tag"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rtcp_replay_detector_separation() -> Result<()> {
|
||||||
|
let mut decrypt_context = Context::new(
|
||||||
|
&RTCP_TEST_MASTER_KEY,
|
||||||
|
&RTCP_TEST_MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
Some(srtcp_replay_protection(10)),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let rtcp_packet1 = RTCP_TEST_CASES[0].encrypted.clone();
|
||||||
|
let decrypt_result1 = decrypt_context.decrypt_rtcp(&rtcp_packet1)?;
|
||||||
|
assert_eq!(
|
||||||
|
decrypt_result1, RTCP_TEST_CASES[0].decrypted,
|
||||||
|
"RTCP failed to decrypt"
|
||||||
|
);
|
||||||
|
|
||||||
|
let rtcp_packet2 = RTCP_TEST_CASES[1].encrypted.clone();
|
||||||
|
let decrypt_result2 = decrypt_context.decrypt_rtcp(&rtcp_packet2)?;
|
||||||
|
assert_eq!(
|
||||||
|
decrypt_result2, RTCP_TEST_CASES[1].decrypted,
|
||||||
|
"RTCP failed to decrypt"
|
||||||
|
);
|
||||||
|
|
||||||
|
let result = decrypt_context.decrypt_rtcp(&rtcp_packet1);
|
||||||
|
assert!(
|
||||||
|
result.is_err(),
|
||||||
|
"Was able to decrypt duplicated RTCP packet"
|
||||||
|
);
|
||||||
|
|
||||||
|
let result = decrypt_context.decrypt_rtcp(&rtcp_packet2);
|
||||||
|
assert!(
|
||||||
|
result.is_err(),
|
||||||
|
"Was able to decrypt duplicated RTCP packet"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_rtcp_index(encrypted: &Bytes, auth_tag_len: usize) -> u32 {
|
||||||
|
let tail_offset = encrypted.len() - (auth_tag_len + SRTCP_INDEX_SIZE);
|
||||||
|
let reader = &mut encrypted.slice(tail_offset..tail_offset + SRTCP_INDEX_SIZE);
|
||||||
|
//^(1 << 31)
|
||||||
|
reader.get_u32() & 0x7FFFFFFF
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_encrypt_rtcp_separation() -> Result<()> {
|
||||||
|
let mut encrypt_context = Context::new(
|
||||||
|
&RTCP_TEST_MASTER_KEY,
|
||||||
|
&RTCP_TEST_MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let auth_tag_len = ProtectionProfile::Aes128CmHmacSha1_80.auth_tag_len();
|
||||||
|
|
||||||
|
let mut decrypt_context = Context::new(
|
||||||
|
&RTCP_TEST_MASTER_KEY,
|
||||||
|
&RTCP_TEST_MASTER_SALT,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
Some(srtcp_replay_protection(10)),
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let inputs = vec![
|
||||||
|
RTCP_TEST_CASES[0].decrypted.clone(),
|
||||||
|
RTCP_TEST_CASES[1].decrypted.clone(),
|
||||||
|
RTCP_TEST_CASES[0].decrypted.clone(),
|
||||||
|
RTCP_TEST_CASES[1].decrypted.clone(),
|
||||||
|
];
|
||||||
|
let mut encrypted_rctps = vec![];
|
||||||
|
|
||||||
|
for input in &inputs {
|
||||||
|
let encrypted = encrypt_context.encrypt_rtcp(input)?;
|
||||||
|
encrypted_rctps.push(encrypted);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (i, expected_index) in [1, 1, 2, 2].iter().enumerate() {
|
||||||
|
assert_eq!(
|
||||||
|
*expected_index,
|
||||||
|
get_rtcp_index(&encrypted_rctps[i], auth_tag_len),
|
||||||
|
"RTCP index does not match"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (i, output) in encrypted_rctps.iter().enumerate() {
|
||||||
|
let decrypted = decrypt_context.decrypt_rtcp(output)?;
|
||||||
|
assert_eq!(inputs[i], decrypted);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
+70
@@ -0,0 +1,70 @@
|
|||||||
|
use bytes::Bytes;
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use crate::error::Result;
|
||||||
|
|
||||||
|
impl Context {
|
||||||
|
pub fn decrypt_rtp_with_header(
|
||||||
|
&mut self,
|
||||||
|
encrypted: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let roc = {
|
||||||
|
let state = self.get_srtp_ssrc_state(header.ssrc);
|
||||||
|
if let Some(replay_detector) = &mut state.replay_detector {
|
||||||
|
if !replay_detector.check(header.sequence_number as u64) {
|
||||||
|
return Err(Error::SrtpSsrcDuplicated(
|
||||||
|
header.ssrc,
|
||||||
|
header.sequence_number,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
state.next_rollover_count(header.sequence_number)
|
||||||
|
};
|
||||||
|
|
||||||
|
let dst = self.cipher.decrypt_rtp(encrypted, header, roc)?;
|
||||||
|
{
|
||||||
|
let state = self.get_srtp_ssrc_state(header.ssrc);
|
||||||
|
if let Some(replay_detector) = &mut state.replay_detector {
|
||||||
|
replay_detector.accept();
|
||||||
|
}
|
||||||
|
state.update_rollover_count(header.sequence_number);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(dst)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// DecryptRTP decrypts a RTP packet with an encrypted payload
|
||||||
|
pub fn decrypt_rtp(&mut self, encrypted: &[u8]) -> Result<Bytes> {
|
||||||
|
let mut buf = encrypted;
|
||||||
|
let header = rtp::header::Header::unmarshal(&mut buf)?;
|
||||||
|
self.decrypt_rtp_with_header(encrypted, &header)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn encrypt_rtp_with_header(
|
||||||
|
&mut self,
|
||||||
|
payload: &[u8],
|
||||||
|
header: &rtp::header::Header,
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let roc = self
|
||||||
|
.get_srtp_ssrc_state(header.ssrc)
|
||||||
|
.next_rollover_count(header.sequence_number);
|
||||||
|
|
||||||
|
let dst = self.cipher.encrypt_rtp(payload, header, roc)?;
|
||||||
|
|
||||||
|
self.get_srtp_ssrc_state(header.ssrc)
|
||||||
|
.update_rollover_count(header.sequence_number);
|
||||||
|
|
||||||
|
Ok(dst)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// EncryptRTP marshals and encrypts an RTP packet, writing to the dst buffer provided.
|
||||||
|
/// If the dst buffer does not have the capacity to hold `len(plaintext) + 10` bytes, a new one will be allocated and returned.
|
||||||
|
pub fn encrypt_rtp(&mut self, plaintext: &[u8]) -> Result<Bytes> {
|
||||||
|
let mut buf = plaintext;
|
||||||
|
let header = rtp::header::Header::unmarshal(&mut buf)?;
|
||||||
|
self.encrypt_rtp_with_header(plaintext, &header)
|
||||||
|
}
|
||||||
|
}
|
||||||
+188
@@ -0,0 +1,188 @@
|
|||||||
|
use bytes::Bytes;
|
||||||
|
use lazy_static::lazy_static;
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
struct RTPTestCase {
|
||||||
|
sequence_number: u16,
|
||||||
|
encrypted: Bytes,
|
||||||
|
}
|
||||||
|
|
||||||
|
lazy_static! {
|
||||||
|
static ref RTP_TEST_CASE_DECRYPTED: Bytes = Bytes::from_static(&[0x00, 0x01, 0x02, 0x03, 0x04, 0x05]);
|
||||||
|
static ref RTP_TEST_CASES: Vec<RTPTestCase> = vec![
|
||||||
|
RTPTestCase {
|
||||||
|
sequence_number: 5000,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x6d, 0xd3, 0x7e, 0xd5, 0x99, 0xb7, 0x2d, 0x28, 0xb1, 0xf3, 0xa1, 0xf0, 0xc, 0xfb,
|
||||||
|
0xfd, 0x8
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTPTestCase {
|
||||||
|
sequence_number: 5001,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0xda, 0x47, 0xb, 0x2a, 0x74, 0x53, 0x65, 0xbd, 0x2f, 0xeb, 0xdc, 0x4b, 0x6d, 0x23,
|
||||||
|
0xf3, 0xde
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTPTestCase {
|
||||||
|
sequence_number: 5002,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x6e, 0xa7, 0x69, 0x8d, 0x24, 0x6d, 0xdc, 0xbf, 0xec, 0x2, 0x1c, 0xd1, 0x60, 0x76,
|
||||||
|
0xc1, 0x0e
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTPTestCase {
|
||||||
|
sequence_number: 5003,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x24, 0x7e, 0x96, 0xc8, 0x7d, 0x33, 0xa2, 0x92, 0x8d, 0x13, 0x8d, 0xe0, 0x76, 0x9f,
|
||||||
|
0x08, 0xdc
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTPTestCase {
|
||||||
|
sequence_number: 5004,
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0x75, 0x43, 0x28, 0xe4, 0x3a, 0x77, 0x59, 0x9b, 0x2e, 0xdf, 0x7b, 0x12, 0x68, 0x0b,
|
||||||
|
0x57, 0x49
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
RTPTestCase{
|
||||||
|
sequence_number: 65535, // upper boundary
|
||||||
|
encrypted: Bytes::from_static(&[
|
||||||
|
0xaf, 0xf7, 0xc2, 0x70, 0x37, 0x20, 0x83, 0x9c, 0x2c, 0x63, 0x85, 0x15, 0x0e, 0x44,
|
||||||
|
0xca, 0x36
|
||||||
|
]),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
fn build_test_context() -> Result<Context> {
|
||||||
|
let master_key = Bytes::from_static(&[
|
||||||
|
0x0d, 0xcd, 0x21, 0x3e, 0x4c, 0xbc, 0xf2, 0x8f, 0x01, 0x7f, 0x69, 0x94, 0x40, 0x1e, 0x28,
|
||||||
|
0x89,
|
||||||
|
]);
|
||||||
|
let master_salt = Bytes::from_static(&[
|
||||||
|
0x62, 0x77, 0x60, 0x38, 0xc0, 0x6d, 0xc9, 0x41, 0x9f, 0x6d, 0xd9, 0x43, 0x3e, 0x7c,
|
||||||
|
]);
|
||||||
|
|
||||||
|
Context::new(
|
||||||
|
&master_key,
|
||||||
|
&master_salt,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rtp_invalid_auth() -> Result<()> {
|
||||||
|
let master_key = Bytes::from_static(&[
|
||||||
|
0x0d, 0xcd, 0x21, 0x3e, 0x4c, 0xbc, 0xf2, 0x8f, 0x01, 0x7f, 0x69, 0x94, 0x40, 0x1e, 0x28,
|
||||||
|
0x89,
|
||||||
|
]);
|
||||||
|
let invalid_salt = Bytes::from_static(&[
|
||||||
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
||||||
|
]);
|
||||||
|
|
||||||
|
let mut encrypt_context = build_test_context()?;
|
||||||
|
let mut invalid_context = Context::new(
|
||||||
|
&master_key,
|
||||||
|
&invalid_salt,
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
for test_case in &*RTP_TEST_CASES {
|
||||||
|
let pkt = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
sequence_number: test_case.sequence_number,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: RTP_TEST_CASE_DECRYPTED.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let pkt_raw = pkt.marshal()?;
|
||||||
|
let out = encrypt_context.encrypt_rtp(&pkt_raw)?;
|
||||||
|
|
||||||
|
let result = invalid_context.decrypt_rtp(&out);
|
||||||
|
assert!(
|
||||||
|
result.is_err(),
|
||||||
|
"Managed to decrypt with incorrect salt for packet with SeqNum: {}",
|
||||||
|
test_case.sequence_number
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_rtp_lifecycle() -> Result<()> {
|
||||||
|
let mut encrypt_context = build_test_context()?;
|
||||||
|
let mut decrypt_context = build_test_context()?;
|
||||||
|
let auth_tag_len = ProtectionProfile::Aes128CmHmacSha1_80.auth_tag_len();
|
||||||
|
|
||||||
|
for test_case in RTP_TEST_CASES.iter() {
|
||||||
|
// Keep consecutive indices within RFC 3711's half-sequence-space window.
|
||||||
|
// The known-answer vector at 65535 still uses ROC 0, as before.
|
||||||
|
if test_case.sequence_number == 65535 {
|
||||||
|
for sequence_number in [32000, 64000] {
|
||||||
|
let bridge = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
sequence_number,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: RTP_TEST_CASE_DECRYPTED.clone(),
|
||||||
|
}
|
||||||
|
.marshal()?;
|
||||||
|
let encrypted = encrypt_context.encrypt_rtp(&bridge)?;
|
||||||
|
assert_eq!(decrypt_context.decrypt_rtp(&encrypted)?, bridge);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let decrypted_pkt = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
sequence_number: test_case.sequence_number,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: RTP_TEST_CASE_DECRYPTED.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let decrypted_raw = decrypted_pkt.marshal()?;
|
||||||
|
|
||||||
|
let encrypted_pkt = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
sequence_number: test_case.sequence_number,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: test_case.encrypted.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let encrypted_raw = encrypted_pkt.marshal()?;
|
||||||
|
let actual_encrypted = encrypt_context.encrypt_rtp(&decrypted_raw)?;
|
||||||
|
assert_eq!(
|
||||||
|
actual_encrypted, encrypted_raw,
|
||||||
|
"RTP packet with SeqNum invalid encryption: {}",
|
||||||
|
test_case.sequence_number
|
||||||
|
);
|
||||||
|
|
||||||
|
let actual_decrypted = decrypt_context.decrypt_rtp(&encrypted_raw)?;
|
||||||
|
assert_ne!(
|
||||||
|
encrypted_raw[..encrypted_raw.len() - auth_tag_len].to_vec(),
|
||||||
|
actual_decrypted,
|
||||||
|
"DecryptRTP improperly encrypted in place"
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
actual_decrypted, decrypted_raw,
|
||||||
|
"RTP packet with SeqNum invalid decryption: {}",
|
||||||
|
test_case.sequence_number,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
//TODO: BenchmarkEncryptRTP
|
||||||
|
//TODO: BenchmarkEncryptRTPInPlace
|
||||||
|
//TODO: BenchmarkDecryptRTP
|
||||||
Vendored
+120
@@ -0,0 +1,120 @@
|
|||||||
|
use std::io;
|
||||||
|
|
||||||
|
use thiserror::Error;
|
||||||
|
use tokio::sync::mpsc::error::SendError as MpscSendError;
|
||||||
|
|
||||||
|
pub type Result<T> = std::result::Result<T, Error>;
|
||||||
|
|
||||||
|
#[derive(Error, Debug, PartialEq)]
|
||||||
|
#[non_exhaustive]
|
||||||
|
pub enum Error {
|
||||||
|
#[error("duplicated packet")]
|
||||||
|
ErrDuplicated,
|
||||||
|
#[error("SRTP master key is not long enough")]
|
||||||
|
ErrShortSrtpMasterKey,
|
||||||
|
#[error("SRTP master salt is not long enough")]
|
||||||
|
ErrShortSrtpMasterSalt,
|
||||||
|
#[error("no such SRTP Profile")]
|
||||||
|
ErrNoSuchSrtpProfile,
|
||||||
|
#[error("indexOverKdr > 0 is not supported yet")]
|
||||||
|
ErrNonZeroKdrNotSupported,
|
||||||
|
#[error("exporter called with wrong label")]
|
||||||
|
ErrExporterWrongLabel,
|
||||||
|
#[error("no config provided")]
|
||||||
|
ErrNoConfig,
|
||||||
|
#[error("no conn provided")]
|
||||||
|
ErrNoConn,
|
||||||
|
#[error("failed to verify auth tag")]
|
||||||
|
ErrFailedToVerifyAuthTag,
|
||||||
|
#[error("packet is too short to be rtcp packet")]
|
||||||
|
ErrTooShortRtcp,
|
||||||
|
#[error("payload differs")]
|
||||||
|
ErrPayloadDiffers,
|
||||||
|
#[error("started channel used incorrectly, should only be closed")]
|
||||||
|
ErrStartedChannelUsedIncorrectly,
|
||||||
|
#[error("stream has not been inited, unable to close")]
|
||||||
|
ErrStreamNotInited,
|
||||||
|
#[error("stream is already closed")]
|
||||||
|
ErrStreamAlreadyClosed,
|
||||||
|
#[error("stream is already inited")]
|
||||||
|
ErrStreamAlreadyInited,
|
||||||
|
#[error("failed to cast child")]
|
||||||
|
ErrFailedTypeAssertion,
|
||||||
|
|
||||||
|
#[error("index_over_kdr > 0 is not supported yet")]
|
||||||
|
UnsupportedIndexOverKdr,
|
||||||
|
#[error("SRTP Master Key must be len {0}, got {1}")]
|
||||||
|
SrtpMasterKeyLength(usize, usize),
|
||||||
|
#[error("SRTP Salt must be len {0}, got {1}")]
|
||||||
|
SrtpSaltLength(usize, usize),
|
||||||
|
#[error("SyntaxError: {0}")]
|
||||||
|
ExtMapParse(String),
|
||||||
|
#[error("srtp ssrc={0} index={1}: duplicated")]
|
||||||
|
SrtpSsrcDuplicated(u32, u16),
|
||||||
|
#[error("srtcp ssrc={0} index={1}: duplicated")]
|
||||||
|
SrtcpSsrcDuplicated(u32, usize),
|
||||||
|
#[error("ssrc {0} not exist in srtcp_ssrc_state")]
|
||||||
|
SsrcMissingFromSrtcp(u32),
|
||||||
|
#[error("Stream with ssrc {0} exists")]
|
||||||
|
StreamWithSsrcExists(u32),
|
||||||
|
#[error("Session RTP/RTCP type must be same as input buffer")]
|
||||||
|
SessionRtpRtcpTypeMismatch,
|
||||||
|
#[error("Session EOF")]
|
||||||
|
SessionEof,
|
||||||
|
#[error("too short SRTP packet: only {0} bytes, expected > {1} bytes")]
|
||||||
|
SrtpTooSmall(usize, usize),
|
||||||
|
#[error("too short SRTCP packet: only {0} bytes, expected > {1} bytes")]
|
||||||
|
SrtcpTooSmall(usize, usize),
|
||||||
|
#[error("failed to verify rtp auth tag")]
|
||||||
|
RtpFailedToVerifyAuthTag,
|
||||||
|
#[error("too short auth tag: only {0} bytes, expected > {1} bytes")]
|
||||||
|
RtcpInvalidLengthAuthTag(usize, usize),
|
||||||
|
#[error("failed to verify rtcp auth tag")]
|
||||||
|
RtcpFailedToVerifyAuthTag,
|
||||||
|
#[error("SessionSRTP has been closed")]
|
||||||
|
SessionSrtpAlreadyClosed,
|
||||||
|
#[error("this stream is not a RTPStream")]
|
||||||
|
InvalidRtpStream,
|
||||||
|
#[error("this stream is not a RTCPStream")]
|
||||||
|
InvalidRtcpStream,
|
||||||
|
|
||||||
|
#[error("{0}")]
|
||||||
|
Io(#[source] IoError),
|
||||||
|
#[error("{0}")]
|
||||||
|
KeyingMaterial(#[from] util::KeyingMaterialExporterError),
|
||||||
|
#[error("mpsc send: {0}")]
|
||||||
|
MpscSend(String),
|
||||||
|
#[error("{0}")]
|
||||||
|
Util(#[from] util::Error),
|
||||||
|
#[error("{0}")]
|
||||||
|
Rtcp(#[from] rtcp::Error),
|
||||||
|
#[error("aes gcm: {0}")]
|
||||||
|
AesGcm(#[from] aes_gcm::Error),
|
||||||
|
|
||||||
|
#[error("{0}")]
|
||||||
|
Other(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Error)]
|
||||||
|
#[error("io error: {0}")]
|
||||||
|
pub struct IoError(#[from] pub io::Error);
|
||||||
|
|
||||||
|
// Workaround for wanting PartialEq for io::Error.
|
||||||
|
impl PartialEq for IoError {
|
||||||
|
fn eq(&self, other: &Self) -> bool {
|
||||||
|
self.0.kind() == other.0.kind()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<io::Error> for Error {
|
||||||
|
fn from(e: io::Error) -> Self {
|
||||||
|
Error::Io(IoError(e))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Because Tokio SendError is parameterized, we sadly lose the backtrace.
|
||||||
|
impl<T> From<MpscSendError<T>> for Error {
|
||||||
|
fn from(e: MpscSendError<T>) -> Self {
|
||||||
|
Error::MpscSend(e.to_string())
|
||||||
|
}
|
||||||
|
}
|
||||||
+173
@@ -0,0 +1,173 @@
|
|||||||
|
use aes::cipher::generic_array::GenericArray;
|
||||||
|
use aes::cipher::BlockEncrypt;
|
||||||
|
use aes::Aes128;
|
||||||
|
use aes_gcm::KeyInit;
|
||||||
|
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
|
||||||
|
pub const LABEL_SRTP_ENCRYPTION: u8 = 0x00;
|
||||||
|
pub const LABEL_SRTP_AUTHENTICATION_TAG: u8 = 0x01;
|
||||||
|
pub const LABEL_SRTP_SALT: u8 = 0x02;
|
||||||
|
pub const LABEL_SRTCP_ENCRYPTION: u8 = 0x03;
|
||||||
|
pub const LABEL_SRTCP_AUTHENTICATION_TAG: u8 = 0x04;
|
||||||
|
pub const LABEL_SRTCP_SALT: u8 = 0x05;
|
||||||
|
|
||||||
|
pub(crate) const SRTCP_INDEX_SIZE: usize = 4;
|
||||||
|
|
||||||
|
pub(crate) fn aes_cm_key_derivation(
|
||||||
|
label: u8,
|
||||||
|
master_key: &[u8],
|
||||||
|
master_salt: &[u8],
|
||||||
|
index_over_kdr: usize,
|
||||||
|
out_len: usize,
|
||||||
|
) -> Result<Vec<u8>> {
|
||||||
|
if index_over_kdr != 0 {
|
||||||
|
// 24-bit "index DIV kdr" must be xored to prf input.
|
||||||
|
return Err(Error::UnsupportedIndexOverKdr);
|
||||||
|
}
|
||||||
|
|
||||||
|
// https://tools.ietf.org/html/rfc3711#appendix-B.3
|
||||||
|
// The input block for AES-CM is generated by exclusive-oring the master salt with the
|
||||||
|
// concatenation of the encryption key label 0x00 with (index DIV kdr),
|
||||||
|
// - index is 'rollover count' and DIV is 'divided by'
|
||||||
|
|
||||||
|
let n_master_key = master_key.len();
|
||||||
|
let n_master_salt = master_salt.len();
|
||||||
|
|
||||||
|
let mut prf_in = vec![0u8; n_master_key];
|
||||||
|
prf_in[..n_master_salt].copy_from_slice(master_salt);
|
||||||
|
|
||||||
|
prf_in[7] ^= label;
|
||||||
|
|
||||||
|
//The resulting value is then AES encrypted using the master key to get the cipher key.
|
||||||
|
let key = GenericArray::from_slice(master_key);
|
||||||
|
let block = Aes128::new(key);
|
||||||
|
|
||||||
|
let mut out = vec![0u8; ((out_len + n_master_key) / n_master_key) * n_master_key];
|
||||||
|
for (i, n) in (0..out_len).step_by(n_master_key).enumerate() {
|
||||||
|
//BigEndian.PutUint16(prfIn[nMasterKey-2:], i)
|
||||||
|
prf_in[n_master_key - 2] = ((i >> 8) & 0xFF) as u8;
|
||||||
|
prf_in[n_master_key - 1] = (i & 0xFF) as u8;
|
||||||
|
|
||||||
|
out[n..n + n_master_key].copy_from_slice(&prf_in);
|
||||||
|
let out_key = GenericArray::from_mut_slice(&mut out[n..n + n_master_key]);
|
||||||
|
block.encrypt_block(out_key);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(out[..out_len].to_vec())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Generate IV https://tools.ietf.org/html/rfc3711#section-4.1.1
|
||||||
|
/// where the 128-bit integer value IV SHALL be defined by the SSRC, the
|
||||||
|
/// SRTP packet index i, and the SRTP session salting key k_s, as below.
|
||||||
|
/// ROC = a 32-bit unsigned rollover counter (roc), which records how many
|
||||||
|
/// times the 16-bit RTP sequence number has been reset to zero after
|
||||||
|
/// passing through 65,535
|
||||||
|
/// ```nobuild
|
||||||
|
/// i = 2^16 * roc + SEQ
|
||||||
|
/// IV = (salt*2 ^ 16) | (ssrc*2 ^ 64) | (i*2 ^ 16)
|
||||||
|
/// ```
|
||||||
|
pub(crate) fn generate_counter(
|
||||||
|
sequence_number: u16,
|
||||||
|
rollover_counter: u32,
|
||||||
|
ssrc: u32,
|
||||||
|
session_salt: &[u8],
|
||||||
|
) -> [u8; 16] {
|
||||||
|
assert!(session_salt.len() <= 16);
|
||||||
|
|
||||||
|
let mut counter = [0; 16];
|
||||||
|
|
||||||
|
let ssrc_be = ssrc.to_be_bytes();
|
||||||
|
let rollover_be = rollover_counter.to_be_bytes();
|
||||||
|
let seq_be = ((sequence_number as u32) << 16).to_be_bytes();
|
||||||
|
|
||||||
|
counter[4..8].copy_from_slice(&ssrc_be);
|
||||||
|
counter[8..12].copy_from_slice(&rollover_be);
|
||||||
|
counter[12..16].copy_from_slice(&seq_be);
|
||||||
|
|
||||||
|
for i in 0..session_salt.len() {
|
||||||
|
counter[i] ^= session_salt[i];
|
||||||
|
}
|
||||||
|
|
||||||
|
counter
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod test {
|
||||||
|
use super::*;
|
||||||
|
use crate::protection_profile::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_valid_session_keys() -> Result<()> {
|
||||||
|
// Key Derivation Test Vectors from https://tools.ietf.org/html/rfc3711#appendix-B.3
|
||||||
|
let master_key = vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
];
|
||||||
|
let master_salt = vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
];
|
||||||
|
|
||||||
|
let expected_session_key = vec![
|
||||||
|
0xC6, 0x1E, 0x7A, 0x93, 0x74, 0x4F, 0x39, 0xEE, 0x10, 0x73, 0x4A, 0xFE, 0x3F, 0xF7,
|
||||||
|
0xA0, 0x87,
|
||||||
|
];
|
||||||
|
let expected_session_salt = vec![
|
||||||
|
0x30, 0xCB, 0xBC, 0x08, 0x86, 0x3D, 0x8C, 0x85, 0xD4, 0x9D, 0xB3, 0x4A, 0x9A, 0xE1,
|
||||||
|
];
|
||||||
|
let expected_session_auth_tag = vec![
|
||||||
|
0xCE, 0xBE, 0x32, 0x1F, 0x6F, 0xF7, 0x71, 0x6B, 0x6F, 0xD4, 0xAB, 0x49, 0xAF, 0x25,
|
||||||
|
0x6A, 0x15, 0x6D, 0x38, 0xBA, 0xA4,
|
||||||
|
];
|
||||||
|
|
||||||
|
let session_key = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_ENCRYPTION,
|
||||||
|
&master_key,
|
||||||
|
&master_salt,
|
||||||
|
0,
|
||||||
|
master_key.len(),
|
||||||
|
)?;
|
||||||
|
assert_eq!(
|
||||||
|
session_key, expected_session_key,
|
||||||
|
"Session Key:\n{session_key:?} \ndoes not match expected:\n{expected_session_key:?}\nMaster Key:\n{master_key:?}\nMaster Salt:\n{master_salt:?}\n",
|
||||||
|
);
|
||||||
|
|
||||||
|
let session_salt = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_SALT,
|
||||||
|
&master_key,
|
||||||
|
&master_salt,
|
||||||
|
0,
|
||||||
|
master_salt.len(),
|
||||||
|
)?;
|
||||||
|
assert_eq!(
|
||||||
|
session_salt, expected_session_salt,
|
||||||
|
"Session Salt {session_salt:?} does not match expected {expected_session_salt:?}"
|
||||||
|
);
|
||||||
|
|
||||||
|
let auth_key_len = ProtectionProfile::Aes128CmHmacSha1_80.auth_key_len();
|
||||||
|
|
||||||
|
let session_auth_tag = aes_cm_key_derivation(
|
||||||
|
LABEL_SRTP_AUTHENTICATION_TAG,
|
||||||
|
&master_key,
|
||||||
|
&master_salt,
|
||||||
|
0,
|
||||||
|
auth_key_len,
|
||||||
|
)?;
|
||||||
|
assert_eq!(
|
||||||
|
session_auth_tag, expected_session_auth_tag,
|
||||||
|
"Session Auth Tag {session_auth_tag:?} does not match expected {expected_session_auth_tag:?}",
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
// This test asserts that calling aesCmKeyDerivation with a non-zero indexOverKdr fails
|
||||||
|
// Currently this isn't supported, but the API makes sure we can add this in the future
|
||||||
|
#[test]
|
||||||
|
fn test_index_over_kdr() -> Result<()> {
|
||||||
|
let result = aes_cm_key_derivation(LABEL_SRTP_AUTHENTICATION_TAG, &[], &[], 1, 0);
|
||||||
|
assert!(result.is_err());
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
Vendored
+14
@@ -0,0 +1,14 @@
|
|||||||
|
#![warn(rust_2018_idioms)]
|
||||||
|
#![allow(dead_code)]
|
||||||
|
|
||||||
|
mod cipher;
|
||||||
|
pub mod config;
|
||||||
|
pub mod context;
|
||||||
|
mod error;
|
||||||
|
mod key_derivation;
|
||||||
|
pub mod option;
|
||||||
|
pub mod protection_profile;
|
||||||
|
pub mod session;
|
||||||
|
pub mod stream;
|
||||||
|
|
||||||
|
pub use error::Error;
|
||||||
Vendored
+36
@@ -0,0 +1,36 @@
|
|||||||
|
use util::replay_detector::*;
|
||||||
|
|
||||||
|
pub type ContextOption = Box<dyn (Fn() -> Box<dyn ReplayDetector + Send + 'static>) + Send + Sync>;
|
||||||
|
|
||||||
|
pub(crate) const MAX_SEQUENCE_NUMBER: u16 = 65535;
|
||||||
|
pub(crate) const MAX_SRTCP_INDEX: usize = 0x7FFFFFFF;
|
||||||
|
|
||||||
|
/// srtp_replay_protection sets SRTP replay protection window size.
|
||||||
|
pub fn srtp_replay_protection(window_size: usize) -> ContextOption {
|
||||||
|
Box::new(move || -> Box<dyn ReplayDetector + Send> {
|
||||||
|
Box::new(WrappedSlidingWindowDetector::new(
|
||||||
|
window_size,
|
||||||
|
MAX_SEQUENCE_NUMBER as u64,
|
||||||
|
))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Sets SRTCP replay protection window size.
|
||||||
|
pub fn srtcp_replay_protection(window_size: usize) -> ContextOption {
|
||||||
|
Box::new(move || -> Box<dyn ReplayDetector + Send> {
|
||||||
|
Box::new(WrappedSlidingWindowDetector::new(
|
||||||
|
window_size,
|
||||||
|
MAX_SRTCP_INDEX as u64,
|
||||||
|
))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// srtp_no_replay_protection disables SRTP replay protection.
|
||||||
|
pub fn srtp_no_replay_protection() -> ContextOption {
|
||||||
|
Box::new(|| -> Box<dyn ReplayDetector + Send> { Box::<NoOpReplayDetector>::default() })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// srtcp_no_replay_protection disables SRTCP replay protection.
|
||||||
|
pub fn srtcp_no_replay_protection() -> ContextOption {
|
||||||
|
Box::new(|| -> Box<dyn ReplayDetector + Send> { Box::<NoOpReplayDetector>::default() })
|
||||||
|
}
|
||||||
+37
@@ -0,0 +1,37 @@
|
|||||||
|
/// ProtectionProfile specifies Cipher and AuthTag details, similar to TLS cipher suite
|
||||||
|
#[derive(Default, Debug, Clone, Copy)]
|
||||||
|
#[repr(u8)]
|
||||||
|
pub enum ProtectionProfile {
|
||||||
|
#[default]
|
||||||
|
Aes128CmHmacSha1_80 = 0x0001,
|
||||||
|
AeadAes128Gcm = 0x0007,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ProtectionProfile {
|
||||||
|
pub(crate) fn key_len(&self) -> usize {
|
||||||
|
match *self {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 | ProtectionProfile::AeadAes128Gcm => 16,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn salt_len(&self) -> usize {
|
||||||
|
match *self {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 => 14,
|
||||||
|
ProtectionProfile::AeadAes128Gcm => 12,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn auth_tag_len(&self) -> usize {
|
||||||
|
match *self {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 => 10, //CIPHER_AES_CM_HMAC_SHA1AUTH_TAG_LEN,
|
||||||
|
ProtectionProfile::AeadAes128Gcm => 16, //CIPHER_AEAD_AES_GCM_AUTH_TAG_LEN,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn auth_key_len(&self) -> usize {
|
||||||
|
match *self {
|
||||||
|
ProtectionProfile::Aes128CmHmacSha1_80 => 20,
|
||||||
|
ProtectionProfile::AeadAes128Gcm => 0,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+271
@@ -0,0 +1,271 @@
|
|||||||
|
#[cfg(test)]
|
||||||
|
mod session_rtcp_test;
|
||||||
|
#[cfg(test)]
|
||||||
|
mod session_rtp_test;
|
||||||
|
|
||||||
|
use std::collections::{HashMap, HashSet};
|
||||||
|
use std::marker::{Send, Sync};
|
||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use bytes::Bytes;
|
||||||
|
use tokio::sync::{mpsc, Mutex};
|
||||||
|
use util::conn::Conn;
|
||||||
|
use util::marshal::*;
|
||||||
|
|
||||||
|
use crate::config::*;
|
||||||
|
use crate::context::*;
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
use crate::option::*;
|
||||||
|
use crate::stream::*;
|
||||||
|
|
||||||
|
const DEFAULT_SESSION_SRTP_REPLAY_PROTECTION_WINDOW: usize = 64;
|
||||||
|
const DEFAULT_SESSION_SRTCP_REPLAY_PROTECTION_WINDOW: usize = 64;
|
||||||
|
|
||||||
|
/// Session implements io.ReadWriteCloser and provides a bi-directional SRTP session
|
||||||
|
/// SRTP itself does not have a design like this, but it is common in most applications
|
||||||
|
/// for local/remote to each have their own keying material. This provides those patterns
|
||||||
|
/// instead of making everyone re-implement
|
||||||
|
pub struct Session {
|
||||||
|
local_context: Arc<Mutex<Context>>,
|
||||||
|
streams_map: Arc<Mutex<HashMap<u32, Arc<Stream>>>>,
|
||||||
|
new_stream_rx: Arc<Mutex<mpsc::Receiver<Arc<Stream>>>>,
|
||||||
|
close_stream_tx: mpsc::Sender<u32>,
|
||||||
|
close_session_tx: mpsc::Sender<()>,
|
||||||
|
pub(crate) udp_tx: Arc<dyn Conn + Send + Sync>,
|
||||||
|
is_rtp: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Session {
|
||||||
|
pub async fn new(
|
||||||
|
conn: Arc<dyn Conn + Send + Sync>,
|
||||||
|
config: Config,
|
||||||
|
is_rtp: bool,
|
||||||
|
) -> Result<Self> {
|
||||||
|
let local_context = Context::new(
|
||||||
|
&config.keys.local_master_key,
|
||||||
|
&config.keys.local_master_salt,
|
||||||
|
config.profile,
|
||||||
|
config.local_rtp_options,
|
||||||
|
config.local_rtcp_options,
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let mut remote_context = Context::new(
|
||||||
|
&config.keys.remote_master_key,
|
||||||
|
&config.keys.remote_master_salt,
|
||||||
|
config.profile,
|
||||||
|
if config.remote_rtp_options.is_none() {
|
||||||
|
Some(srtp_replay_protection(
|
||||||
|
DEFAULT_SESSION_SRTP_REPLAY_PROTECTION_WINDOW,
|
||||||
|
))
|
||||||
|
} else {
|
||||||
|
config.remote_rtp_options
|
||||||
|
},
|
||||||
|
if config.remote_rtcp_options.is_none() {
|
||||||
|
Some(srtcp_replay_protection(
|
||||||
|
DEFAULT_SESSION_SRTCP_REPLAY_PROTECTION_WINDOW,
|
||||||
|
))
|
||||||
|
} else {
|
||||||
|
config.remote_rtcp_options
|
||||||
|
},
|
||||||
|
)?;
|
||||||
|
|
||||||
|
let streams_map = Arc::new(Mutex::new(HashMap::new()));
|
||||||
|
let (mut new_stream_tx, new_stream_rx) = mpsc::channel(8);
|
||||||
|
let (close_stream_tx, mut close_stream_rx) = mpsc::channel(8);
|
||||||
|
let (close_session_tx, mut close_session_rx) = mpsc::channel(8);
|
||||||
|
let udp_tx = Arc::clone(&conn);
|
||||||
|
let udp_rx = Arc::clone(&conn);
|
||||||
|
let cloned_streams_map = Arc::clone(&streams_map);
|
||||||
|
let cloned_close_stream_tx = close_stream_tx.clone();
|
||||||
|
|
||||||
|
tokio::spawn(async move {
|
||||||
|
let mut buf = vec![0u8; 8192];
|
||||||
|
|
||||||
|
loop {
|
||||||
|
let incoming_stream = Session::incoming(
|
||||||
|
&udp_rx,
|
||||||
|
&mut buf,
|
||||||
|
&cloned_streams_map,
|
||||||
|
&cloned_close_stream_tx,
|
||||||
|
&mut new_stream_tx,
|
||||||
|
&mut remote_context,
|
||||||
|
is_rtp,
|
||||||
|
);
|
||||||
|
let close_stream = close_stream_rx.recv();
|
||||||
|
let close_session = close_session_rx.recv();
|
||||||
|
|
||||||
|
tokio::select! {
|
||||||
|
result = incoming_stream => match result{
|
||||||
|
Ok(()) => {},
|
||||||
|
Err(err) => log::info!("{}", err),
|
||||||
|
},
|
||||||
|
opt = close_stream => if let Some(ssrc) = opt {
|
||||||
|
Session::close_stream(&cloned_streams_map, ssrc).await
|
||||||
|
},
|
||||||
|
_ = close_session => break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
Ok(Session {
|
||||||
|
local_context: Arc::new(Mutex::new(local_context)),
|
||||||
|
streams_map,
|
||||||
|
new_stream_rx: Arc::new(Mutex::new(new_stream_rx)),
|
||||||
|
close_stream_tx,
|
||||||
|
close_session_tx,
|
||||||
|
udp_tx,
|
||||||
|
is_rtp,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn close_stream(streams_map: &Arc<Mutex<HashMap<u32, Arc<Stream>>>>, ssrc: u32) {
|
||||||
|
let mut streams = streams_map.lock().await;
|
||||||
|
streams.remove(&ssrc);
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn incoming(
|
||||||
|
udp_rx: &Arc<dyn Conn + Send + Sync>,
|
||||||
|
buf: &mut [u8],
|
||||||
|
streams_map: &Arc<Mutex<HashMap<u32, Arc<Stream>>>>,
|
||||||
|
close_stream_tx: &mpsc::Sender<u32>,
|
||||||
|
new_stream_tx: &mut mpsc::Sender<Arc<Stream>>,
|
||||||
|
remote_context: &mut Context,
|
||||||
|
is_rtp: bool,
|
||||||
|
) -> Result<()> {
|
||||||
|
let n = udp_rx.recv(buf).await?;
|
||||||
|
if n == 0 {
|
||||||
|
return Err(Error::SessionEof);
|
||||||
|
}
|
||||||
|
|
||||||
|
let decrypted = if is_rtp {
|
||||||
|
remote_context.decrypt_rtp(&buf[0..n])?
|
||||||
|
} else {
|
||||||
|
remote_context.decrypt_rtcp(&buf[0..n])?
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut buf = &decrypted[..];
|
||||||
|
let ssrcs = if is_rtp {
|
||||||
|
vec![rtp::header::Header::unmarshal(&mut buf)?.ssrc]
|
||||||
|
} else {
|
||||||
|
let pkts = rtcp::packet::unmarshal(&mut buf)?;
|
||||||
|
destination_ssrc(&pkts)
|
||||||
|
};
|
||||||
|
|
||||||
|
for ssrc in ssrcs {
|
||||||
|
let (stream, is_new) =
|
||||||
|
Session::get_or_create_stream(streams_map, close_stream_tx.clone(), is_rtp, ssrc)
|
||||||
|
.await;
|
||||||
|
if is_new {
|
||||||
|
log::trace!(
|
||||||
|
"srtp session got new {} stream {}",
|
||||||
|
if is_rtp { "rtp" } else { "rtcp" },
|
||||||
|
ssrc
|
||||||
|
);
|
||||||
|
new_stream_tx.send(Arc::clone(&stream)).await?;
|
||||||
|
}
|
||||||
|
|
||||||
|
match stream.buffer.write(&decrypted).await {
|
||||||
|
Ok(_) => {}
|
||||||
|
Err(err) => {
|
||||||
|
// Silently drop data when the buffer is full.
|
||||||
|
if util::Error::ErrBufferFull != err {
|
||||||
|
return Err(err.into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn get_or_create_stream(
|
||||||
|
streams_map: &Arc<Mutex<HashMap<u32, Arc<Stream>>>>,
|
||||||
|
close_stream_tx: mpsc::Sender<u32>,
|
||||||
|
is_rtp: bool,
|
||||||
|
ssrc: u32,
|
||||||
|
) -> (Arc<Stream>, bool) {
|
||||||
|
let mut streams = streams_map.lock().await;
|
||||||
|
|
||||||
|
if let Some(stream) = streams.get(&ssrc) {
|
||||||
|
(Arc::clone(stream), false)
|
||||||
|
} else {
|
||||||
|
let stream = Arc::new(Stream::new(ssrc, close_stream_tx, is_rtp));
|
||||||
|
streams.insert(ssrc, Arc::clone(&stream));
|
||||||
|
(stream, true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// open on the given SSRC to create a stream, it can be used
|
||||||
|
/// if you want a certain SSRC, but don't want to wait for Accept
|
||||||
|
pub async fn open(&self, ssrc: u32) -> Arc<Stream> {
|
||||||
|
let (stream, _) = Session::get_or_create_stream(
|
||||||
|
&self.streams_map,
|
||||||
|
self.close_stream_tx.clone(),
|
||||||
|
self.is_rtp,
|
||||||
|
ssrc,
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
stream
|
||||||
|
}
|
||||||
|
|
||||||
|
/// accept returns a stream to handle RTCP for a single SSRC
|
||||||
|
pub async fn accept(&self) -> Result<Arc<Stream>> {
|
||||||
|
let mut new_stream_rx = self.new_stream_rx.lock().await;
|
||||||
|
let result = new_stream_rx.recv().await;
|
||||||
|
if let Some(stream) = result {
|
||||||
|
Ok(stream)
|
||||||
|
} else {
|
||||||
|
Err(Error::SessionSrtpAlreadyClosed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn close(&self) -> Result<()> {
|
||||||
|
self.close_session_tx.send(()).await?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn write(&self, buf: &Bytes, is_rtp: bool) -> Result<usize> {
|
||||||
|
if self.is_rtp != is_rtp {
|
||||||
|
return Err(Error::SessionRtpRtcpTypeMismatch);
|
||||||
|
}
|
||||||
|
|
||||||
|
let encrypted = {
|
||||||
|
let mut local_context = self.local_context.lock().await;
|
||||||
|
|
||||||
|
if is_rtp {
|
||||||
|
local_context.encrypt_rtp(buf)?
|
||||||
|
} else {
|
||||||
|
local_context.encrypt_rtcp(buf)?
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(self.udp_tx.send(&encrypted).await?)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn write_rtp(&self, pkt: &rtp::packet::Packet) -> Result<usize> {
|
||||||
|
let raw = pkt.marshal()?;
|
||||||
|
self.write(&raw, true).await
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn write_rtcp(
|
||||||
|
&self,
|
||||||
|
pkt: &(dyn rtcp::packet::Packet + Send + Sync),
|
||||||
|
) -> Result<usize> {
|
||||||
|
let raw = pkt.marshal()?;
|
||||||
|
self.write(&raw, false).await
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// create a list of Destination SSRCs
|
||||||
|
/// that's a superset of all Destinations in the slice.
|
||||||
|
fn destination_ssrc(pkts: &[Box<dyn rtcp::packet::Packet + Send + Sync>]) -> Vec<u32> {
|
||||||
|
let mut ssrc_set = HashSet::new();
|
||||||
|
for p in pkts {
|
||||||
|
for ssrc in p.destination_ssrc() {
|
||||||
|
ssrc_set.insert(ssrc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
ssrc_set.into_iter().collect()
|
||||||
|
}
|
||||||
+239
@@ -0,0 +1,239 @@
|
|||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use bytes::{Bytes, BytesMut};
|
||||||
|
use rtcp::payload_feedbacks::*;
|
||||||
|
use tokio::sync::{mpsc, Mutex};
|
||||||
|
use util::conn::conn_pipe::*;
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use crate::error::Result;
|
||||||
|
use crate::protection_profile::*;
|
||||||
|
|
||||||
|
async fn build_session_srtcp_pair() -> Result<(Session, Session)> {
|
||||||
|
let (ua, ub) = pipe();
|
||||||
|
|
||||||
|
let ca = Config {
|
||||||
|
profile: ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
keys: SessionKeys {
|
||||||
|
local_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
local_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
remote_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
remote_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
|
||||||
|
local_rtp_options: None,
|
||||||
|
remote_rtp_options: None,
|
||||||
|
|
||||||
|
local_rtcp_options: None,
|
||||||
|
remote_rtcp_options: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let cb = Config {
|
||||||
|
profile: ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
keys: SessionKeys {
|
||||||
|
local_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
local_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
remote_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
remote_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
|
||||||
|
local_rtp_options: None,
|
||||||
|
remote_rtp_options: None,
|
||||||
|
|
||||||
|
local_rtcp_options: None,
|
||||||
|
remote_rtcp_options: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let sa = Session::new(Arc::new(ua), ca, false).await?;
|
||||||
|
let sb = Session::new(Arc::new(ub), cb, false).await?;
|
||||||
|
|
||||||
|
Ok((sa, sb))
|
||||||
|
}
|
||||||
|
|
||||||
|
const TEST_SSRC: u32 = 5000;
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtcp_accept() -> Result<()> {
|
||||||
|
let (sa, sb) = build_session_srtcp_pair().await?;
|
||||||
|
|
||||||
|
let rtcp_packet = picture_loss_indication::PictureLossIndication {
|
||||||
|
media_ssrc: TEST_SSRC,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
let test_payload = rtcp_packet.marshal()?;
|
||||||
|
sa.write_rtcp(&rtcp_packet).await?;
|
||||||
|
|
||||||
|
let read_stream = sb.accept().await?;
|
||||||
|
let ssrc = read_stream.get_ssrc();
|
||||||
|
assert_eq!(
|
||||||
|
ssrc, TEST_SSRC,
|
||||||
|
"SSRC mismatch during accept exp({TEST_SSRC}) actual({ssrc})"
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(test_payload.len());
|
||||||
|
read_buffer.resize(test_payload.len(), 0u8);
|
||||||
|
read_stream.read(&mut read_buffer).await?;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[..],
|
||||||
|
"Sent buffer does not match the one received exp({:?}) actual({:?})",
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[..]
|
||||||
|
);
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtcp_listen() -> Result<()> {
|
||||||
|
let (sa, sb) = build_session_srtcp_pair().await?;
|
||||||
|
|
||||||
|
let rtcp_packet = picture_loss_indication::PictureLossIndication {
|
||||||
|
media_ssrc: TEST_SSRC,
|
||||||
|
..Default::default()
|
||||||
|
};
|
||||||
|
|
||||||
|
let test_payload = rtcp_packet.marshal()?;
|
||||||
|
let read_stream = sb.open(TEST_SSRC).await;
|
||||||
|
|
||||||
|
sa.write_rtcp(&rtcp_packet).await?;
|
||||||
|
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(test_payload.len());
|
||||||
|
read_buffer.resize(test_payload.len(), 0u8);
|
||||||
|
read_stream.read(&mut read_buffer).await?;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[..],
|
||||||
|
"Sent buffer does not match the one received exp({:?}) actual({:?})",
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[..]
|
||||||
|
);
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_srtcp(
|
||||||
|
context: &mut Context,
|
||||||
|
pkt: &(dyn rtcp::packet::Packet + Send + Sync),
|
||||||
|
) -> Result<Bytes> {
|
||||||
|
let decrypted = pkt.marshal()?;
|
||||||
|
let encrypted = context.encrypt_rtcp(&decrypted)?;
|
||||||
|
Ok(encrypted)
|
||||||
|
}
|
||||||
|
|
||||||
|
const PLI_PACKET_SIZE: usize = 8;
|
||||||
|
|
||||||
|
async fn get_sender_ssrc(read_stream: &Arc<Stream>) -> Result<u32> {
|
||||||
|
let auth_tag_size = ProtectionProfile::Aes128CmHmacSha1_80.auth_tag_len();
|
||||||
|
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(PLI_PACKET_SIZE + auth_tag_size);
|
||||||
|
read_buffer.resize(PLI_PACKET_SIZE + auth_tag_size, 0u8);
|
||||||
|
|
||||||
|
let pkts = read_stream.read_rtcp(&mut read_buffer).await?;
|
||||||
|
let mut bytes = &pkts[0].marshal()?[..];
|
||||||
|
let pli = picture_loss_indication::PictureLossIndication::unmarshal(&mut bytes)?;
|
||||||
|
|
||||||
|
Ok(pli.sender_ssrc)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtcp_replay_protection() -> Result<()> {
|
||||||
|
let (sa, sb) = build_session_srtcp_pair().await?;
|
||||||
|
|
||||||
|
let read_stream = sb.open(TEST_SSRC).await;
|
||||||
|
|
||||||
|
// Generate test packets
|
||||||
|
let mut packets = vec![];
|
||||||
|
let mut expected_ssrc = vec![];
|
||||||
|
{
|
||||||
|
let mut local_context = sa.local_context.lock().await;
|
||||||
|
for i in 0..0x10u32 {
|
||||||
|
expected_ssrc.push(i);
|
||||||
|
|
||||||
|
let packet = picture_loss_indication::PictureLossIndication {
|
||||||
|
media_ssrc: TEST_SSRC,
|
||||||
|
sender_ssrc: i,
|
||||||
|
};
|
||||||
|
|
||||||
|
let encrypted = encrypt_srtcp(&mut local_context, &packet)?;
|
||||||
|
|
||||||
|
packets.push(encrypted);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
|
||||||
|
|
||||||
|
let received_ssrc = Arc::new(Mutex::new(vec![]));
|
||||||
|
let cloned_received_ssrc = Arc::clone(&received_ssrc);
|
||||||
|
let count = expected_ssrc.len();
|
||||||
|
|
||||||
|
tokio::spawn(async move {
|
||||||
|
let mut i = 0;
|
||||||
|
while i < count {
|
||||||
|
match get_sender_ssrc(&read_stream).await {
|
||||||
|
Ok(ssrc) => {
|
||||||
|
let mut r = cloned_received_ssrc.lock().await;
|
||||||
|
r.push(ssrc);
|
||||||
|
|
||||||
|
i += 1;
|
||||||
|
}
|
||||||
|
Err(_) => break,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
drop(done_tx);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Write with replay attack
|
||||||
|
for packet in &packets {
|
||||||
|
sa.udp_tx.send(packet).await?;
|
||||||
|
|
||||||
|
// Immediately replay
|
||||||
|
sa.udp_tx.send(packet).await?;
|
||||||
|
}
|
||||||
|
for packet in &packets {
|
||||||
|
// Delayed replay
|
||||||
|
sa.udp_tx.send(packet).await?;
|
||||||
|
}
|
||||||
|
|
||||||
|
done_rx.recv().await;
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
{
|
||||||
|
let received_ssrc = received_ssrc.lock().await;
|
||||||
|
assert_eq!(&expected_ssrc[..], &received_ssrc[..]);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
+308
@@ -0,0 +1,308 @@
|
|||||||
|
use std::collections::HashMap;
|
||||||
|
use std::sync::Arc;
|
||||||
|
|
||||||
|
use bytes::{Bytes, BytesMut};
|
||||||
|
use tokio::net::UdpSocket;
|
||||||
|
use tokio::sync::{mpsc, Mutex};
|
||||||
|
|
||||||
|
use super::*;
|
||||||
|
use crate::error::Result;
|
||||||
|
use crate::protection_profile::*;
|
||||||
|
|
||||||
|
async fn build_session_srtp_pair() -> Result<(Session, Session)> {
|
||||||
|
let ua = UdpSocket::bind("127.0.0.1:0").await?;
|
||||||
|
let ub = UdpSocket::bind("127.0.0.1:0").await?;
|
||||||
|
|
||||||
|
ua.connect(ub.local_addr()?).await?;
|
||||||
|
ub.connect(ua.local_addr()?).await?;
|
||||||
|
|
||||||
|
let ca = Config {
|
||||||
|
profile: ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
keys: SessionKeys {
|
||||||
|
local_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
local_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
remote_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
remote_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
|
||||||
|
local_rtp_options: None,
|
||||||
|
remote_rtp_options: None,
|
||||||
|
|
||||||
|
local_rtcp_options: None,
|
||||||
|
remote_rtcp_options: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let cb = Config {
|
||||||
|
profile: ProtectionProfile::Aes128CmHmacSha1_80,
|
||||||
|
keys: SessionKeys {
|
||||||
|
local_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
local_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
remote_master_key: vec![
|
||||||
|
0xE1, 0xF9, 0x7A, 0x0D, 0x3E, 0x01, 0x8B, 0xE0, 0xD6, 0x4F, 0xA3, 0x2C, 0x06, 0xDE,
|
||||||
|
0x41, 0x39,
|
||||||
|
],
|
||||||
|
remote_master_salt: vec![
|
||||||
|
0x0E, 0xC6, 0x75, 0xAD, 0x49, 0x8A, 0xFE, 0xEB, 0xB6, 0x96, 0x0B, 0x3A, 0xAB, 0xE6,
|
||||||
|
],
|
||||||
|
},
|
||||||
|
|
||||||
|
local_rtp_options: None,
|
||||||
|
remote_rtp_options: None,
|
||||||
|
|
||||||
|
local_rtcp_options: None,
|
||||||
|
remote_rtcp_options: None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let sa = Session::new(Arc::new(ua), ca, true).await?;
|
||||||
|
let sb = Session::new(Arc::new(ub), cb, true).await?;
|
||||||
|
|
||||||
|
Ok((sa, sb))
|
||||||
|
}
|
||||||
|
|
||||||
|
const TEST_SSRC: u32 = 5000;
|
||||||
|
const RTP_HEADER_SIZE: usize = 12;
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtp_accept() -> Result<()> {
|
||||||
|
let test_payload = Bytes::from_static(&[0x00, 0x01, 0x03, 0x04]);
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(RTP_HEADER_SIZE + test_payload.len());
|
||||||
|
read_buffer.resize(RTP_HEADER_SIZE + test_payload.len(), 0u8);
|
||||||
|
let (sa, sb) = build_session_srtp_pair().await?;
|
||||||
|
|
||||||
|
let packet = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
ssrc: TEST_SSRC,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: test_payload.clone(),
|
||||||
|
};
|
||||||
|
sa.write_rtp(&packet).await?;
|
||||||
|
|
||||||
|
let read_stream = sb.accept().await?;
|
||||||
|
let ssrc = read_stream.get_ssrc();
|
||||||
|
assert_eq!(
|
||||||
|
ssrc, TEST_SSRC,
|
||||||
|
"SSRC mismatch during accept exp({TEST_SSRC}) actual({ssrc})"
|
||||||
|
);
|
||||||
|
|
||||||
|
read_stream.read(&mut read_buffer).await?;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[RTP_HEADER_SIZE..],
|
||||||
|
"Sent buffer does not match the one received exp({:?}) actual({:?})",
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[RTP_HEADER_SIZE..]
|
||||||
|
);
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtp_listen() -> Result<()> {
|
||||||
|
let test_payload = Bytes::from_static(&[0x00, 0x01, 0x03, 0x04]);
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(RTP_HEADER_SIZE + test_payload.len());
|
||||||
|
read_buffer.resize(RTP_HEADER_SIZE + test_payload.len(), 0u8);
|
||||||
|
let (sa, sb) = build_session_srtp_pair().await?;
|
||||||
|
|
||||||
|
let packet = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
ssrc: TEST_SSRC,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: test_payload.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let read_stream = sb.open(TEST_SSRC).await;
|
||||||
|
|
||||||
|
sa.write_rtp(&packet).await?;
|
||||||
|
|
||||||
|
read_stream.read(&mut read_buffer).await?;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[RTP_HEADER_SIZE..],
|
||||||
|
"Sent buffer does not match the one received exp({:?}) actual({:?})",
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[RTP_HEADER_SIZE..]
|
||||||
|
);
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtp_multi_ssrc() -> Result<()> {
|
||||||
|
let ssrcs = vec![5000, 5001, 5002];
|
||||||
|
let test_payload = Bytes::from_static(&[0x00, 0x01, 0x03, 0x04]);
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(RTP_HEADER_SIZE + test_payload.len());
|
||||||
|
read_buffer.resize(RTP_HEADER_SIZE + test_payload.len(), 0u8);
|
||||||
|
let (sa, sb) = build_session_srtp_pair().await?;
|
||||||
|
|
||||||
|
let mut read_streams = HashMap::new();
|
||||||
|
for ssrc in &ssrcs {
|
||||||
|
let read_stream = sb.open(*ssrc).await;
|
||||||
|
read_streams.insert(*ssrc, read_stream);
|
||||||
|
}
|
||||||
|
|
||||||
|
for ssrc in &ssrcs {
|
||||||
|
let packet = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
ssrc: *ssrc,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: test_payload.clone(),
|
||||||
|
};
|
||||||
|
sa.write_rtp(&packet).await?;
|
||||||
|
|
||||||
|
if let Some(read_stream) = read_streams.get_mut(ssrc) {
|
||||||
|
read_stream.read(&mut read_buffer).await?;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[RTP_HEADER_SIZE..],
|
||||||
|
"Sent buffer does not match the one received exp({:?}) actual({:?})",
|
||||||
|
&test_payload[..],
|
||||||
|
&read_buffer[RTP_HEADER_SIZE..]
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
panic!("ssrc {} not found", *ssrc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn encrypt_srtp(context: &mut Context, pkt: &rtp::packet::Packet) -> Result<Bytes> {
|
||||||
|
let decrypted = pkt.marshal()?;
|
||||||
|
let encrypted = context.encrypt_rtp(&decrypted)?;
|
||||||
|
Ok(encrypted)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn payload_srtp(
|
||||||
|
read_stream: &Arc<Stream>,
|
||||||
|
header_size: usize,
|
||||||
|
expected_payload: &[u8],
|
||||||
|
) -> Result<u16> {
|
||||||
|
let mut read_buffer = BytesMut::with_capacity(header_size + expected_payload.len());
|
||||||
|
read_buffer.resize(header_size + expected_payload.len(), 0u8);
|
||||||
|
|
||||||
|
let pkt = read_stream.read_rtp(&mut read_buffer).await?;
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
expected_payload,
|
||||||
|
&pkt.payload[..],
|
||||||
|
"Sent buffer does not match the one received exp({:?}) actual({:?})",
|
||||||
|
expected_payload,
|
||||||
|
&pkt.payload[..]
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(pkt.header.sequence_number)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_session_srtp_replay_protection() -> Result<()> {
|
||||||
|
let test_payload = Bytes::from_static(&[0x00, 0x01, 0x03, 0x04]);
|
||||||
|
|
||||||
|
let (sa, sb) = build_session_srtp_pair().await?;
|
||||||
|
|
||||||
|
let read_stream = sb.open(TEST_SSRC).await;
|
||||||
|
|
||||||
|
// Generate test packets
|
||||||
|
let mut packets = vec![];
|
||||||
|
let mut expected_sequence_number = vec![];
|
||||||
|
{
|
||||||
|
let mut local_context = sa.local_context.lock().await;
|
||||||
|
let mut i = 0xFFF0u16;
|
||||||
|
while i != 0x10 {
|
||||||
|
expected_sequence_number.push(i);
|
||||||
|
|
||||||
|
let packet = rtp::packet::Packet {
|
||||||
|
header: rtp::header::Header {
|
||||||
|
ssrc: TEST_SSRC,
|
||||||
|
sequence_number: i,
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
payload: test_payload.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let encrypted = encrypt_srtp(&mut local_context, &packet)?;
|
||||||
|
|
||||||
|
packets.push(encrypted);
|
||||||
|
|
||||||
|
if i == 0xFFFF {
|
||||||
|
i = 0;
|
||||||
|
} else {
|
||||||
|
i += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
|
||||||
|
|
||||||
|
let received_sequence_number = Arc::new(Mutex::new(vec![]));
|
||||||
|
let cloned_received_sequence_number = Arc::clone(&received_sequence_number);
|
||||||
|
let count = expected_sequence_number.len();
|
||||||
|
|
||||||
|
tokio::spawn(async move {
|
||||||
|
let mut i = 0;
|
||||||
|
while i < count {
|
||||||
|
let seq = payload_srtp(&read_stream, RTP_HEADER_SIZE, &test_payload)
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
let mut r = cloned_received_sequence_number.lock().await;
|
||||||
|
r.push(seq);
|
||||||
|
|
||||||
|
i += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
drop(done_tx);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Write with replay attack
|
||||||
|
for packet in &packets {
|
||||||
|
sa.udp_tx.send(packet).await?;
|
||||||
|
|
||||||
|
// Immediately replay
|
||||||
|
sa.udp_tx.send(packet).await?;
|
||||||
|
}
|
||||||
|
for packet in &packets {
|
||||||
|
// Delayed replay
|
||||||
|
sa.udp_tx.send(packet).await?;
|
||||||
|
}
|
||||||
|
|
||||||
|
done_rx.recv().await;
|
||||||
|
|
||||||
|
sa.close().await?;
|
||||||
|
sb.close().await?;
|
||||||
|
|
||||||
|
{
|
||||||
|
let received_sequence_number = received_sequence_number.lock().await;
|
||||||
|
assert_eq!(&received_sequence_number[..], &expected_sequence_number[..]);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
Vendored
+91
@@ -0,0 +1,91 @@
|
|||||||
|
use tokio::sync::mpsc;
|
||||||
|
use util::marshal::*;
|
||||||
|
use util::Buffer;
|
||||||
|
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
|
||||||
|
/// Limit the buffer size to 1MB
|
||||||
|
pub const SRTP_BUFFER_SIZE: usize = 1000 * 1000;
|
||||||
|
|
||||||
|
/// Limit the buffer size to 100KB
|
||||||
|
pub const SRTCP_BUFFER_SIZE: usize = 100 * 1000;
|
||||||
|
|
||||||
|
/// Stream handles decryption for a single RTP/RTCP SSRC
|
||||||
|
#[derive(Debug)]
|
||||||
|
pub struct Stream {
|
||||||
|
ssrc: u32,
|
||||||
|
tx: mpsc::Sender<u32>,
|
||||||
|
pub(crate) buffer: Buffer,
|
||||||
|
is_rtp: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Stream {
|
||||||
|
/// Create a new stream
|
||||||
|
pub fn new(ssrc: u32, tx: mpsc::Sender<u32>, is_rtp: bool) -> Self {
|
||||||
|
Stream {
|
||||||
|
ssrc,
|
||||||
|
tx,
|
||||||
|
// Create a buffer with a 1MB limit
|
||||||
|
buffer: Buffer::new(
|
||||||
|
0,
|
||||||
|
if is_rtp {
|
||||||
|
SRTP_BUFFER_SIZE
|
||||||
|
} else {
|
||||||
|
SRTCP_BUFFER_SIZE
|
||||||
|
},
|
||||||
|
),
|
||||||
|
is_rtp,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// GetSSRC returns the SSRC we are demuxing for
|
||||||
|
pub fn get_ssrc(&self) -> u32 {
|
||||||
|
self.ssrc
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check if RTP is a stream.
|
||||||
|
pub fn is_rtp_stream(&self) -> bool {
|
||||||
|
self.is_rtp
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Read reads and decrypts full RTP packet from the nextConn
|
||||||
|
pub async fn read(&self, buf: &mut [u8]) -> Result<usize> {
|
||||||
|
Ok(self.buffer.read(buf, None).await?)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// ReadRTP reads and decrypts full RTP packet and its header from the nextConn
|
||||||
|
pub async fn read_rtp(&self, buf: &mut [u8]) -> Result<rtp::packet::Packet> {
|
||||||
|
if !self.is_rtp {
|
||||||
|
return Err(Error::InvalidRtpStream);
|
||||||
|
}
|
||||||
|
|
||||||
|
let n = self.buffer.read(buf, None).await?;
|
||||||
|
let mut b = &buf[..n];
|
||||||
|
let pkt = rtp::packet::Packet::unmarshal(&mut b)?;
|
||||||
|
|
||||||
|
Ok(pkt)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// read_rtcp reads and decrypts full RTP packet and its header from the nextConn
|
||||||
|
pub async fn read_rtcp(
|
||||||
|
&self,
|
||||||
|
buf: &mut [u8],
|
||||||
|
) -> Result<Vec<Box<dyn rtcp::packet::Packet + Send + Sync>>> {
|
||||||
|
if self.is_rtp {
|
||||||
|
return Err(Error::InvalidRtcpStream);
|
||||||
|
}
|
||||||
|
|
||||||
|
let n = self.buffer.read(buf, None).await?;
|
||||||
|
let mut b = &buf[..n];
|
||||||
|
let pkt = rtcp::packet::unmarshal(&mut b)?;
|
||||||
|
|
||||||
|
Ok(pkt)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Close removes the ReadStream from the session and cleans up any associated state
|
||||||
|
pub async fn close(&self) -> Result<()> {
|
||||||
|
self.buffer.close().await;
|
||||||
|
let _ = self.tx.send(self.ssrc).await;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user