Mariano Abad
e6103daea8
`usable_sample` took the remap flag being clear as "the input mapping is ready". It is not: the display service bumps the layout generation and promotes the baseline before the uinput range update completes, and a failed or pending update leaves the device mapping absolute coordinates with the range of the previous layout. Every sample then carries the new generation while its point lands scaled by the old range; two stops share that error and agreement confirms it (zhou, review of 25-sep: a desktop narrowed from 4000 to 3800 px puts a hotx of 4 at 54, inside the bitmap). The display service now keeps the layout generation whose uinput range the device runs, and a count, raised when an apply starts and again when the device acknowledges it. Both move when `update_mouse_resolution` returns Ok, on the DRM session-init path (also run by the hotplug worker) and in the layout poll; the session-init path labels the range with the generation read before it computed the rect, and the raw DRM union it falls back to when the compositor cannot be asked with no generation, so no stream measures on it until the poll applies or finds a compositor range. A range that already fits the layout moves the generation only, so the samples injected under it stay valid. From the moment an apply starts, on any path, no generation is ready, the count is raised and the recorded rect is forgotten, so an apply that fails or times out (the device may still take the range late) leaves nothing ready, and only an acknowledged apply records a generation again. The poll and `update_uinput_resolution` run on different threads; they check, apply and record under one lock. `check_init`, which a display falling back to PipeWire runs inside a DRM session, records its apply the same way (cfg(feature = "drm") lines only; the drm-off build is unchanged). It has no fits check and applies on every run, as before, so each run moves the count. A path that read its generation before the poll bumped it records under the older one; no stream measures then until a later layout check records the current one. A sample is stamped under the ENIGO guard of its move, which an adoption also needs for its refresh, so a move stamped with the count of an adoption was injected after that adoption's refresh. The count is raised before the generation is published and read after it. A stream measures only while that generation is its own; each peer sample carries the count at injection and is a reference only under the current one; a candidate measured under one count starts over instead of confirming under the next. The remap flag is untouched. Tests: a_stale_input_mapping_publishes_nothing_until_fresh_samples_follow_the_adoption (generations equal, no drift, the device on the previous range: two stops publish and cache nothing; after the adoption a sample from before it does not count, and fresh ones confirm), a_sample_is_a_reference_only_under_the_adopted_input_mapping, a_candidate_does_not_confirm_across_an_input_mapping_change, an_acknowledged_range_is_an_adoption_and_a_fitting_one_is_not, the_raw_drm_union_labels_a_range_with_no_generation, an_apply_leaves_no_range_ready_until_it_is_acknowledged; the drm CI step runs input_map_tests. Mutations: dropping the adopted-generation gate, dropping the count gate, confirming across counts, an adoption that does not count, a fitting range that counts, the union labelled with the generation, and an apply that keeps the recorded rect or leaves a generation ready, each turn one of them red. The call sites (the lock, the calls before and after each apply on the three paths, the range-fits branches) run IPC and are covered by reading.
Build •
Docker •
Structure •
Screenshots
[Українська] | [česky] | [中文] | [Magyar] | [Español] | [فارسی] | [Français] | [Deutsch] | [Polski] | [Indonesian] | [Suomi] | [മലയാളം] | [日本語] | [Nederlands] | [Italiano] | [Русский] | [Português (Brasil)] | [Esperanto] | [한국어] | [العربي] | [Tiếng Việt] | [Dansk] | [Ελληνικά] | [Türkçe] | [Norsk] | [Română]
We need your help to translate this README, RustDesk UI and RustDesk Doc to your native language
Caution
Misuse Disclaimer:
The developers of RustDesk do not condone or support any unethical or illegal use of this software. Misuse, such as unauthorized access, control or invasion of privacy, is strictly against our guidelines. The authors are not responsible for any misuse of the application.
Chat with us: Discord | Twitter | Reddit | YouTube
Yet another remote desktop solution, written in Rust. Works out of the box with no configuration required. You have full control of your data, with no concerns about security. You can use our rendezvous/relay server, set up your own, or write your own rendezvous/relay server.
RustDesk welcomes contribution from everyone. See CONTRIBUTING.md for help getting started.
Dependencies
Desktop versions use Flutter or Sciter (deprecated) for GUI. This tutorial is for Sciter only, since it is easier and more friendly to start. Check out our CI for building the Flutter version.
Please download Sciter dynamic library yourself.
Raw Steps to build
-
Prepare your Rust development env and C++ build env
-
Install vcpkg, and set
VCPKG_ROOTenv variable correctly- Windows: vcpkg install libvpx:x64-windows-static libyuv:x64-windows-static opus:x64-windows-static aom:x64-windows-static
- Linux/macOS: vcpkg install libvpx libyuv opus aom
-
run
cargo run
Build
How to Build on Linux
Ubuntu 18 (Debian 10)
sudo apt install -y zip g++ gcc git curl wget nasm yasm libgtk-3-dev clang libxcb-randr0-dev libxdo-dev \
libxfixes-dev libxcb-shape0-dev libxcb-xfixes0-dev libasound2-dev libpulse-dev cmake make \
libclang-dev ninja-build libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev
openSUSE Tumbleweed
sudo zypper install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libXfixes-devel cmake alsa-lib-devel gstreamer-devel gstreamer-plugins-base-devel xdotool-devel
Fedora 28 (CentOS 8)
sudo yum -y install gcc-c++ git curl wget nasm yasm gcc gtk3-devel clang libxcb-devel libxdo-devel libXfixes-devel pulseaudio-libs-devel cmake alsa-lib-devel gstreamer1-devel gstreamer1-plugins-base-devel
Arch (Manjaro)
sudo pacman -Syu --needed unzip git cmake gcc curl wget yasm nasm zip make pkg-config clang gtk3 xdotool libxcb libxfixes alsa-lib pipewire
Install vcpkg
git clone https://github.com/microsoft/vcpkg
cd vcpkg
git checkout 2023.04.15
cd ..
vcpkg/bootstrap-vcpkg.sh
export VCPKG_ROOT=$HOME/vcpkg
vcpkg/vcpkg install libvpx libyuv opus aom
Fix libvpx (For Fedora)
cd vcpkg/buildtrees/libvpx/src
cd *
./configure
sed -i 's/CFLAGS+=-I/CFLAGS+=-fPIC -I/g' Makefile
sed -i 's/CXXFLAGS+=-I/CXXFLAGS+=-fPIC -I/g' Makefile
make
cp libvpx.a $HOME/vcpkg/installed/x64-linux/lib/
cd
Build
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env
git clone --recurse-submodules https://github.com/rustdesk/rustdesk
cd rustdesk
mkdir -p target/debug
wget https://raw.githubusercontent.com/c-smile/sciter-sdk/master/bin.lnx/x64/libsciter-gtk.so
mv libsciter-gtk.so target/debug
VCPKG_ROOT=$HOME/vcpkg cargo run
How to build with Docker
Begin by cloning the repository and building the Docker container:
git clone https://github.com/rustdesk/rustdesk
cd rustdesk
git submodule update --init --recursive
docker build -t "rustdesk-builder" .
Then, each time you need to build the application, run the following command:
docker run --rm -it -v $PWD:/home/user/rustdesk -v rustdesk-git-cache:/home/user/.cargo/git -v rustdesk-registry-cache:/home/user/.cargo/registry -e PUID="$(id -u)" -e PGID="$(id -g)" rustdesk-builder
Note that the first build may take longer before dependencies are cached, subsequent builds will be faster. Additionally, if you need to specify different arguments to the build command, you may do so at the end of the command in the <OPTIONAL-ARGS> position. For instance, if you wanted to build an optimized release version, you would run the command above followed by --release. The resulting executable will be available in the target folder on your system, and can be run with:
target/debug/rustdesk
Or, if you're running a release executable:
target/release/rustdesk
Please ensure that you run these commands from the root of the RustDesk repository, or the application may not find the required resources. Also note that other cargo subcommands such as install or run are not currently supported via this method as they would install or run the program inside the container instead of the host.
File Structure
- libs/hbb_common: video codec, config, tcp/udp wrapper, and some other utility functions shared with the server
- libs/base: protobuf, fs functions for file transfer, keyboard and platform code used only by this app
- libs/scrap: screen capture
- libs/enigo: platform specific keyboard/mouse control
- libs/clipboard: file copy and paste implementation for Windows, Linux, macOS.
- src/ui: obsolete Sciter UI (deprecated)
- src/server: audio/clipboard/input/video services, and network connections
- src/client.rs: start a peer connection
- src/rendezvous_mediator.rs: Communicate with rustdesk-server, wait for remote direct (TCP hole punching) or relayed connection
- src/platform: platform specific code
- flutter: Flutter code for desktop and mobile