One-KVM/kvmd/plugins/hid/otg/events.py
2022-09-04 18:08:40 +03:00

177 lines
5.2 KiB
Python

# ========================================================================== #
# #
# KVMD - The main PiKVM daemon. #
# #
# Copyright (C) 2018-2022 Maxim Devaev <mdevaev@gmail.com> #
# #
# This program is free software: you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by #
# the Free Software Foundation, either version 3 of the License, or #
# (at your option) any later version. #
# #
# This program is distributed in the hope that it will be useful, #
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
# GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License #
# along with this program. If not, see <https://www.gnu.org/licenses/>. #
# #
# ========================================================================== #
import struct
import dataclasses
from ....keyboard.mappings import UsbKey
from ....keyboard.mappings import KEYMAP
from ....mouse import MouseRange
# =====
class BaseEvent:
pass
class ClearEvent(BaseEvent):
pass
class ResetEvent(BaseEvent):
pass
# =====
@dataclasses.dataclass(frozen=True)
class KeyEvent(BaseEvent):
key: UsbKey
state: bool
def __post_init__(self) -> None:
assert (not self.key.is_modifier)
@dataclasses.dataclass(frozen=True)
class ModifierEvent(BaseEvent):
modifier: UsbKey
state: bool
def __post_init__(self) -> None:
assert self.modifier.is_modifier
def make_keyboard_event(key: str, state: bool) -> (KeyEvent | ModifierEvent):
usb_key = KEYMAP[key].usb
if usb_key.is_modifier:
return ModifierEvent(usb_key, state)
return KeyEvent(usb_key, state)
def get_led_caps(flags: int) -> bool:
# https://wiki.osdev.org/USB_Human_Interface_Devices#LED_lamps
return bool(flags & 2)
def get_led_scroll(flags: int) -> bool:
return bool(flags & 4)
def get_led_num(flags: int) -> bool:
return bool(flags & 1)
def make_keyboard_report(
pressed_modifiers: set[UsbKey],
pressed_keys: list[UsbKey | None],
) -> bytes:
modifiers = 0
for modifier in pressed_modifiers:
modifiers |= modifier.code
assert len(pressed_keys) == 6
keys = [
(0 if key is None else key.code)
for key in pressed_keys
]
return bytes([modifiers, 0] + keys)
# =====
@dataclasses.dataclass(frozen=True)
class MouseButtonEvent(BaseEvent):
button: str
state: bool
code: int = 0
def __post_init__(self) -> None:
object.__setattr__(self, "code", {
"left": 0x1,
"right": 0x2,
"middle": 0x4,
"up": 0x8, # Back
"down": 0x10, # Forward
}[self.button])
@dataclasses.dataclass(frozen=True)
class MouseMoveEvent(BaseEvent):
to_x: int
to_y: int
win98_fix: bool = False
to_fixed_x: int = 0
to_fixed_y: int = 0
def __post_init__(self) -> None:
assert MouseRange.MIN <= self.to_x <= MouseRange.MAX
assert MouseRange.MIN <= self.to_y <= MouseRange.MAX
to_fixed_x = MouseRange.remap(self.to_x, 0, MouseRange.MAX)
to_fixed_y = MouseRange.remap(self.to_y, 0, MouseRange.MAX)
if self.win98_fix:
# https://github.com/pikvm/pikvm/issues/159
# For some reason, the correct implementation of this fix
# is a shift to the left, and not to the right, as in VirtualBox
to_fixed_x <<= 1
to_fixed_y <<= 1
object.__setattr__(self, "to_fixed_x", to_fixed_x)
object.__setattr__(self, "to_fixed_y", to_fixed_y)
@dataclasses.dataclass(frozen=True)
class MouseRelativeEvent(BaseEvent):
delta_x: int
delta_y: int
def __post_init__(self) -> None:
assert -127 <= self.delta_x <= 127
assert -127 <= self.delta_y <= 127
@dataclasses.dataclass(frozen=True)
class MouseWheelEvent(BaseEvent):
delta_x: int
delta_y: int
def __post_init__(self) -> None:
assert -127 <= self.delta_x <= 127
assert -127 <= self.delta_y <= 127
def make_mouse_report(
absolute: bool,
buttons: int,
move_x: int,
move_y: int,
wheel_x: (int | None),
wheel_y: int,
) -> bytes:
# XXX: Wheel Y before X: it's ok.
# See /kvmd/apps/otg/hid/mouse.py for details
if wheel_x is not None:
return struct.pack(("<BHHbb" if absolute else "<Bbbbb"), buttons, move_x, move_y, wheel_y, wheel_x)
else:
return struct.pack(("<BHHb" if absolute else "<Bbbb"), buttons, move_x, move_y, wheel_y)