@desklink/host 0.1.0

package/engine/src/x11.rs

@@ -0,0 +1,244 @@
+//! An X11 desktop: capture and input over one connection.
+//!
+//! This is the second capture backend, and the one a machine without a working
+//! screen-cast portal uses — a headless X server, a remote X session, or
+//! XWayland. It is capability-detected rather than assumed: the portal is
+//! preferred when it is there, because the portal is what carries the user's
+//! consent on a Wayland desktop.
+//!
+//! Capture reads the root window directly and input goes through XTest, so on an
+//! X server this process owns, **nothing it does can reach another session's
+//! keyboard**: XTest is scoped to the X server it is connected to, unlike
+//! `uinput`, which the kernel delivers to whatever holds the seat.
+
+use crate::convert::{fit, to_i420, I420};
+use anyhow::{Context, Result};
+use x11rb::connection::Connection;
+use x11rb::protocol::xproto::{ConnectionExt as _, ImageFormat, Screen};
+use x11rb::protocol::xtest::ConnectionExt as _;
+use x11rb::rust_connection::RustConnection;
+
+/// X key codes are evdev codes offset by 8 on every evdev-backed server,
+/// including Xvfb, so the layout mapping the engine already has applies here too.
+const X_KEYCODE_OFFSET: u8 = 8;
+
+/// X core-protocol button numbers.
+pub mod button {
+    pub const LEFT: u8 = 1;
+    pub const MIDDLE: u8 = 2;
+    pub const RIGHT: u8 = 3;
+    pub const WHEEL_UP: u8 = 4;
+    pub const WHEEL_DOWN: u8 = 5;
+    pub const WHEEL_LEFT: u8 = 6;
+    pub const WHEEL_RIGHT: u8 = 7;
+}
+
+pub struct X11Desktop {
+    connection: RustConnection,
+    root: u32,
+    pub width: usize,
+    pub height: usize,
+    /// Bytes per pixel the server reports; 4 for the 24/32-bit TrueColor that
+    /// every normal server uses, and the only depth this backend reads.
+    depth: u8,
+}
+
+impl X11Desktop {
+    /// Connect to `display` (`:99`, or the `DISPLAY` environment when omitted).
+    pub fn connect(display: Option<&str>) -> Result<Self> {
+        let (connection, screen_number) = match display {
+            Some(display) => RustConnection::connect(Some(display))
+                .with_context(|| format!("cannot open X display {display}"))?,
+            None => {
+                RustConnection::connect(None).context("cannot open the X display in DISPLAY")?
+            }
+        };
+        let screen: &Screen = connection
+            .setup()
+            .roots
+            .get(screen_number as usize)
+            .context("the X display has no screen")?;
+        if screen.root_depth != 24 {
+            anyhow::bail!(
+                "unsupported X root depth {}; this backend reads 24-bit TrueColor",
+                screen.root_depth
+            );
+        }
+        Ok(Self {
+            root: screen.root,
+            width: screen.width_in_pixels as usize,
+            height: screen.height_in_pixels as usize,
+            depth: screen.root_depth,
+            connection,
+        })
+    }
+
+    pub fn screen_size(&self) -> (i32, i32) {
+        (self.width as i32, self.height as i32)
+    }
+
+    /// Read the whole root window as I420, downscaled into the caller's box.
+    ///
+    /// The root image is the composited screen contents: on a server with no
+    /// compositor this is every window drawn onto the framebuffer, which is what
+    /// the viewer expects to see.
+    pub fn capture(&mut self, max_width: usize, max_height: usize) -> Result<I420> {
+        let image = self
+            .connection
+            .get_image(
+                ImageFormat::Z_PIXMAP,
+                self.root,
+                0,
+                0,
+                self.width as u16,
+                self.height as u16,
+                u32::MAX,
+            )
+            .context("X11 GetImage failed")?
+            .reply()
+            .context("X11 GetImage returned no reply")?;
+        let stride = self.width * 4;
+        if image.data.len() < stride * self.height {
+            anyhow::bail!(
+                "X11 returned {} bytes for a {}x{} screen",
+                image.data.len(),
+                self.width,
+                self.height
+            );
+        }
+        let (width, height) = fit(self.width, self.height, max_width, max_height);
+        // The server's depth is the only field that can tell us how the pixel is
+        // packed; the engine assumes the byte order every TrueColor server uses.
+        let _ = self.depth;
+        to_i420(
+            &image.data,
+            self.width,
+            self.height,
+            stride,
+            crate::capture::PixelFormat::Bgrx,
+            width,
+            height,
+        )
+        .context("the captured X11 pixels are not a format this engine can read")
+    }
+
+    fn flush(&self) -> Result<()> {
+        self.connection
+            .flush()
+            .context("the X11 connection dropped")
+    }
+
+    pub fn move_pointer(&self, x: i64, y: i64) -> Result<()> {
+        let (x, y) = self.clamp(x, y);
+        self.connection
+            .xtest_fake_input(
+                x11rb::protocol::xproto::MOTION_NOTIFY_EVENT,
+                false as u8,
+                0,
+                self.root,
+                x as i16,
+                y as i16,
+                0,
+            )
+            .context("XTest motion failed")?;
+        self.flush()
+    }
+
+    pub fn button(&self, button: u8, down: bool) -> Result<()> {
+        self.connection
+            .xtest_fake_input(
+                x11rb::protocol::xproto::BUTTON_PRESS_EVENT + u8::from(!down),
+                button,
+                0,
+                self.root,
+                0,
+                0,
+                0,
+            )
+            .context("XTest button failed")?;
+        self.flush()
+    }
+
+    /// A wheel notch. `dy` is in detents and positive means "down", matching the
+    /// control channel's convention.
+    pub fn scroll(&self, dx: i64, dy: i64) -> Result<()> {
+        for _ in 0..dy.abs().min(20) {
+            self.button(
+                if dy > 0 {
+                    button::WHEEL_DOWN
+                } else {
+                    button::WHEEL_UP
+                },
+                true,
+            )?;
+            self.button(
+                if dy > 0 {
+                    button::WHEEL_DOWN
+                } else {
+                    button::WHEEL_UP
+                },
+                false,
+            )?;
+        }
+        for _ in 0..dx.abs().min(20) {
+            self.button(
+                if dx > 0 {
+                    button::WHEEL_RIGHT
+                } else {
+                    button::WHEEL_LEFT
+                },
+                true,
+            )?;
+            self.button(
+                if dx > 0 {
+                    button::WHEEL_RIGHT
+                } else {
+                    button::WHEEL_LEFT
+                },
+                false,
+            )?;
+        }
+        Ok(())
+    }
+
+    /// `evdev_code` is the layout layer's Linux key code; the X server's own key
+    /// code for it is that value plus eight.
+    pub fn key(&self, evdev_code: i16, down: bool) -> Result<()> {
+        let keycode = evdev_code.saturating_add(X_KEYCODE_OFFSET as i16);
+        if !(8..=255).contains(&keycode) {
+            anyhow::bail!("{evdev_code} is not a key this X server can press");
+        }
+        self.connection
+            .xtest_fake_input(
+                x11rb::protocol::xproto::KEY_PRESS_EVENT + u8::from(!down),
+                keycode as u8,
+                0,
+                0,
+                0,
+                0,
+                0,
+            )
+            .context("XTest key failed")?;
+        self.flush()
+    }
+
+    fn clamp(&self, x: i64, y: i64) -> (i64, i64) {
+        (
+            x.clamp(0, self.width.saturating_sub(1) as i64),
+            y.clamp(0, self.height.saturating_sub(1) as i64),
+        )
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn fitting_never_upscales_and_keeps_even_dimensions() {
+        assert_eq!(fit(800, 600, 1280, 800), (800, 600));
+        assert_eq!(fit(1920, 1080, 1280, 720), (1280, 720));
+        let (w, h) = fit(1000, 1000, 600, 600);
+        assert_eq!((w, h), (600, 600));
+    }
+}

package/engine/vendor/inputtino/.clang-format

@@ -0,0 +1,166 @@
+---
+Language: Cpp
+# BasedOnStyle:  LLVM with a few personal changes
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Right
+AlignOperands: Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: false
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: false
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: MultiLine
+AttributeMacros:
+  - __capability
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  AfterExternBlock: false
+  BeforeCatch: false
+  BeforeElse: false
+  BeforeLambdaBody: false
+  BeforeWhile: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit: 120
+CommentPragmas: '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat: false
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+StatementAttributeLikeMacros:
+  - Q_EMIT
+IncludeBlocks: Preserve
+IncludeCategories:
+  - Regex: '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority: 2
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '^(<|"(gtest|gmock|isl|json)/)'
+    Priority: 3
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '.*'
+    Priority: 1
+    SortPriority: 0
+    CaseSensitive: false
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires: false
+IndentWidth: 2
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd: ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 20
+PenaltyBreakBeforeFirstCallParameter: 0
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Right
+ReflowComments: true
+SortIncludes: CaseInsensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard: Latest
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth: 8
+UseCRLF: false
+UseTab: Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME
+...
+

package/engine/vendor/inputtino/.clang-tidy

@@ -0,0 +1,30 @@
+# Generated from CLion Inspection settings
+---
+Checks: '-*,
+bugprone-*,
+mpi-*,
+cert-err52-cpp,
+cert-err60-cpp,
+cert-err34-c,
+cert-str34-c,
+cert-dcl21-cpp,
+cert-msc50-cpp,
+cert-msc51-cpp,
+cert-dcl58-cpp,
+cert-flp30-c,
+cppcoreguidelines-*,
+-cppcoreguidelines-avoid-do-while,
+google-default-arguments,
+google-runtime-operator,
+google-explicit-constructor,
+hicpp-multiway-paths-covered,
+hicpp-exception-baseclass,
+misc-unconventional-assign-operator,
+misc-misplaced-const,
+misc-new-delete-overloads,
+misc-non-copyable-objects,
+misc-no-recursion,
+misc-throw-by-value-catch-by-reference,
+misc-uniqueptr-reset-release,
+openmp-use-default-none,
+portability-simd-intrinsics'

package/engine/vendor/inputtino/.dockerignore

@@ -0,0 +1,11 @@
+# Start by removing everything and add just the things we need
+*
+!src
+!CMakeLists.txt
+!include
+!cmake/
+!docker/startup.sh
+!share/
+
+# Rust bindings
+!bindings/rust/

package/engine/vendor/inputtino/.github/workflows/mirror-repo.yml

@@ -0,0 +1,14 @@
+# Pushes the contents of the repo to the Codeberg mirror
+name: Repo Mirror
+on: [ push ]
+jobs:
+  codeberg:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: pixta-dev/repository-mirroring-action@v1
+        with:
+          target_repo_url: "git@codeberg.org:games-on-whales/inputtino.git"
+          ssh_private_key: ${{ secrets.CODEBERG_SSH }}

package/engine/vendor/inputtino/.github/workflows/python-lint-format-test-typecheck.yml

@@ -0,0 +1,124 @@
+name: "Python: Lint / Format / Test / Type Check"
+
+on:
+  push:
+    branches: [stable]
+  pull_request:
+    branches: [stable]
+
+defaults:
+  run:
+    shell: bash
+    working-directory: ./bindings/python
+
+env:
+  PYTHON_VERSION: "3.10"
+  UV_VERSION: "0.5.10"
+
+jobs:
+  run_linter:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y clang-format cpplint cppcheck make build-essential cmake libevdev-dev pkg-config
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: ${{ env.PYTHON_VERSION }}
+          enable-cache: true
+
+      - name: Run linter
+        run: make lint
+
+  run_formatter:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y clang-format cpplint cppcheck make build-essential cmake libevdev-dev pkg-config
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: ${{ env.PYTHON_VERSION }}
+          enable-cache: true
+
+      - name: Run formatter
+        run: make format
+
+  run_tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest"]
+        python-version: ["3.10", "3.11","3.12", "3.13"]
+
+    timeout-minutes: 20
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake libevdev-dev pkg-config
+
+      - name: Cache uv dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: uv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('uv.lock', 'pyproject.toml') }}
+
+      - name: Install dependencies
+        run: uv sync --reinstall
+
+      - name: Run pytest with coverage
+        run: |
+          uv run pytest -v --log-level INFO --cov -m "not practical"
+
+  run_type-check:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake libevdev-dev pkg-config
+
+      - name: Set up Python
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: ${{ env.UV_VERSION }}
+          python-version: ${{ env.PYTHON_VERSION }}
+          enable-cache: true
+
+      - name: Cache uv dependencies
+        uses: actions/cache@v4
+        with:
+          path: .venv
+          key: uv-${{ runner.os }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('uv.lock', 'pyproject.toml') }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run pyright
+        run: uv run pyright src

package/engine/vendor/inputtino/.github/workflows/python-test-install.yaml

@@ -0,0 +1,49 @@
+name: "Python: Installation Test"
+
+on:
+  push:
+    branches: [stable]
+  pull_request:
+    branches: [stable]
+
+defaults:
+  run:
+    shell: bash
+    working-directory: ./bindings/python
+
+jobs:
+  test-install:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        container:
+          - image: ubuntu:22.04
+            install: >-
+              apt-get update &&
+              apt-get install -y build-essential cmake libevdev-dev pkg-config git python3 python3-pip &&
+              python3 -m pip install --upgrade pip
+          - image: ubuntu:24.04
+            install: >-
+              apt-get update &&
+              apt-get install -y build-essential cmake libevdev-dev pkg-config git python3 python3-pip
+          - image: archlinux:latest
+            install: >-
+              pacman -Syu --noconfirm &&
+              pacman -S --noconfirm git cmake base-devel pkgconf libevdev python python-pip &&
+              python -m pip install --upgrade pip --break-system-packages
+          - image: fedora:latest
+            install: >-
+              dnf install -y git cmake gcc gcc-c++ make pkgconf-pkg-config libevdev-devel python3-devel python3-pip &&
+              python -m pip install --upgrade pip --break-system-packages
+    container:
+      image: ${{ matrix.container.image }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: ${{ matrix.container.install }}
+
+      - name: Install package
+        run: python3 -m pip install . --break-system-packages

package/engine/vendor/inputtino/.github/workflows/rust.yml

@@ -0,0 +1,40 @@
+name: Test Rust bindings
+
+on:
+  push:
+    branches: [ "stable" ]
+  pull_request:
+    branches: [ "stable" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Setup dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y build-essential cmake libevdev-dev pkg-config
+      shell: bash
+
+    - name: Build
+      working-directory: bindings/rust
+      run: |
+        cargo build --verbose
+      shell: bash
+
+    # Disabled testing as uinput / uhid doesn't work in Github Actions.
+    # - name: Run tests
+    #   run: |
+    #     cargo test --verbose
+    #   shell: bash
+
+    - name: Machete
+      uses: bnjbvr/cargo-machete@main