-
-
Notifications
You must be signed in to change notification settings - Fork 160
Expand file tree
/
Copy pathmouse_hook_linux.py
More file actions
950 lines (859 loc) · 33.5 KB
/
Copy pathmouse_hook_linux.py
File metadata and controls
950 lines (859 loc) · 33.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
"""
Linux mouse hook implementation.
"""
import glob
import os
import stat
import sys
import threading
import time
try:
import select as _select_mod
import evdev as _evdev_mod
from evdev import InputDevice as _InputDevice
from evdev import UInput as _UInput
from evdev import ecodes as _ecodes
_EVDEV_OK = True
except ImportError:
_EVDEV_OK = False
print("[MouseHook] python-evdev not installed — pip install evdev")
from core.logi_devices import (
build_evdev_connected_device_info,
resolve_device as _resolve_logi_device,
)
from core.mouse_hook_base import BaseMouseHook, HidGestureListener
from core.mouse_hook_types import HidRuntimeState, MouseEvent
_LOGI_VENDOR = 0x046D
_LOG_ONCE_KEYS = set()
_REMAP_REASON_UINPUT_FAILED = "uinput_failed"
_REMAP_REASON_GRAB_FAILED = "grab_failed"
_REMAP_STATUS_MESSAGES = {
_REMAP_REASON_UINPUT_FAILED: (
"Linux evdev remapping is degraded: the virtual input device could not "
"be created. Physical button/wheel interception is unavailable, but "
"HID++ controls may still work."
),
_REMAP_REASON_GRAB_FAILED: (
"Linux evdev remapping is degraded: the mouse could not be grabbed. "
"Physical button/wheel interception is unavailable, but HID++ controls "
"may still work."
),
}
_REMAP_RECOVERY_STATUS = "Linux evdev remapping restored."
def _log_once(key, message):
if key in _LOG_ONCE_KEYS:
return
_LOG_ONCE_KEYS.add(key)
print(message)
def _owner_name(uid):
try:
import pwd
return pwd.getpwuid(uid).pw_name
except Exception:
return str(uid)
def _group_name(gid):
try:
import grp
return grp.getgrgid(gid).gr_name
except Exception:
return str(gid)
def _format_linux_device_access(path):
if not path:
return "path=-"
try:
st = os.stat(path)
except OSError as exc:
return f"path={path} stat_error={exc}"
mode = stat.S_IMODE(st.st_mode)
can_read = os.access(path, os.R_OK)
can_write = os.access(path, os.W_OK)
can_rw = os.access(path, os.R_OK | os.W_OK)
return (
f"path={path} mode={mode:04o} "
f"owner={_owner_name(st.st_uid)}({st.st_uid}) "
f"group={_group_name(st.st_gid)}({st.st_gid}) "
f"access=read:{can_read} write:{can_write} read_write:{can_rw}"
)
def _format_linux_device_access_list(paths, limit=8):
details = [_format_linux_device_access(path) for path in list(paths)[:limit]]
remaining = max(0, len(paths) - limit)
if remaining:
details.append(f"... {remaining} more")
return "; ".join(details) if details else "-"
class MouseHook(BaseMouseHook):
"""
Uses evdev on Linux to intercept mouse button presses and scroll events.
Grabs the mouse device for exclusive access and forwards non-blocked events
via a uinput virtual mouse.
"""
def __init__(self):
super().__init__()
self._running = False
self._evdev_ready = False
self._hid_ready = False
self._evdev_connected_device = None
self._gesture_lock = threading.Lock()
self._evdev_device = None
self._uinput = None
self._evdev_thread = None
self._rescan_requested = threading.Event()
self._evdev_wakeup = threading.Event()
self._ignored_non_logitech = set()
self._ui_passthrough = False
self._evdev_grabbed = False
self._evdev_remap_ready = False
self._evdev_remap_status_state = (False, None)
@property
def evdev_ready(self):
return self._evdev_ready
@property
def hid_ready(self):
return self._hid_ready
@property
def evdev_remap_ready(self):
return self._evdev_remap_ready
@property
def hid_runtime_state(self):
hg = getattr(self, "_hid_gesture", None)
hid_device = getattr(hg, "connected_device", None) if hg else None
return HidRuntimeState(
input_ready=bool(self._device_connected),
hid_ready=bool(self._hid_ready and hid_device is not None),
connected_device=self._connected_device,
)
def set_ui_passthrough(self, enabled):
enabled = bool(enabled)
if self._ui_passthrough == enabled:
return
self._ui_passthrough = enabled
if enabled:
message = "Linux input passthrough enabled; evdev remapping paused"
self._disable_evdev_remapping()
self._rescan_requested.set()
self._evdev_wakeup.set()
print(f"[MouseHook] {message}")
self._emit_status(message)
else:
message = "Linux input passthrough disabled; evdev remapping restored"
self._rescan_requested.clear()
if self._evdev_device is not None:
self._enable_evdev_remapping()
self._evdev_wakeup.set()
print(f"[MouseHook] {message}")
self._emit_status(message)
def _acquire_evdev_grab(self):
dev = self._evdev_device
if dev is None or self._evdev_grabbed:
return self._evdev_grabbed
try:
dev.grab()
self._evdev_grabbed = True
print(f"[MouseHook] Grabbed {dev.name} ({dev.path})")
return True
except Exception as exc:
print(f"[MouseHook] Failed to grab {getattr(dev, 'path', '?')}: {exc}")
return False
def _release_evdev_grab(self):
dev = self._evdev_device
if dev is None or not self._evdev_grabbed:
return
try:
dev.ungrab()
self._evdev_grabbed = False
print(f"[MouseHook] Released grab for {dev.name} ({dev.path})")
except Exception as exc:
print(f"[MouseHook] Failed to ungrab {getattr(dev, 'path', '?')}: {exc}")
def _set_evdev_remap_ready(self, ready, reason=None):
ready = bool(ready)
reason = None if ready else reason
if reason not in (_REMAP_REASON_UINPUT_FAILED, _REMAP_REASON_GRAB_FAILED):
reason = None
next_state = (ready, reason)
if next_state == self._evdev_remap_status_state:
self._evdev_remap_ready = ready
return
previous_state = self._evdev_remap_status_state
self._evdev_remap_status_state = next_state
self._evdev_remap_ready = ready
if ready:
if previous_state[1] in (
_REMAP_REASON_UINPUT_FAILED,
_REMAP_REASON_GRAB_FAILED,
):
self._emit_status(_REMAP_RECOVERY_STATUS)
return
message = _REMAP_STATUS_MESSAGES.get(reason)
if message:
self._emit_status(message)
def _close_uinput(self):
if self._uinput:
try:
self._uinput.close()
except Exception:
pass
self._uinput = None
def _disable_evdev_remapping(self, reason=None):
self._set_evdev_remap_ready(False, reason)
self._release_evdev_grab()
self._close_uinput()
def _enable_evdev_remapping(self):
dev = self._evdev_device
if dev is None or self._ui_passthrough:
self._disable_evdev_remapping()
return False
if self._evdev_remap_ready:
return True
if self._uinput is None:
try:
self._uinput = _UInput(
events=self._filtered_uinput_events(dev),
name="Mouser Virtual Mouse",
vendor=getattr(dev.info, "vendor", 1),
product=getattr(dev.info, "product", 1),
version=getattr(dev.info, "version", 1),
bustype=getattr(dev.info, "bustype", 0x03),
)
except PermissionError:
print(
"[MouseHook] Permission denied — add user to 'input' group "
"and ensure /dev/uinput is writable"
)
self._set_evdev_remap_ready(False, _REMAP_REASON_UINPUT_FAILED)
return False
except Exception as exc:
print(f"[MouseHook] Failed to setup uinput: {exc}")
self._set_evdev_remap_ready(False, _REMAP_REASON_UINPUT_FAILED)
return False
if not self._acquire_evdev_grab():
self._disable_evdev_remapping(_REMAP_REASON_GRAB_FAILED)
return False
self._set_evdev_remap_ready(True)
return True
def _set_evdev_ready(self, ready):
if ready == self._evdev_ready:
return
self._evdev_ready = ready
self._refresh_device_state(force=True)
def _set_device_connected(self, connected, force=False):
changed = connected != self._device_connected
if not changed and not force:
return
self._device_connected = connected
if changed:
state = "Connected" if connected else "Disconnected"
print(f"[MouseHook] Device {state}")
if self._connection_change_cb:
try:
self._connection_change_cb(connected)
except Exception:
pass
def _build_evdev_connected_device(self, dev):
info = getattr(dev, "info", None)
return build_evdev_connected_device_info(
product_id=getattr(info, "product", None) if info else None,
product_name=getattr(dev, "name", None),
transport="evdev",
source="evdev",
)
def _refresh_device_state(self, force=False):
previous = self._connected_device
next_device = None
if self._hid_ready and self._hid_gesture:
next_device = self._hid_gesture.connected_device
if next_device is None:
next_device = self._evdev_connected_device
self._connected_device = next_device
prev_source = getattr(previous, "source", None) if previous is not None else None
next_source = getattr(next_device, "source", None) if next_device is not None else None
if prev_source != next_source:
if next_source == "evdev":
print("[MouseHook] Using evdev fallback device info")
elif prev_source == "evdev" and next_device is not None:
print("[MouseHook] Device info upgraded from evdev fallback to HID++")
self._set_device_connected(self._evdev_ready, force=force)
def _hid_gesture_available(self):
return self._hid_gesture is not None and self._evdev_ready
def _accumulate_gesture_delta(self, delta_x, delta_y, source):
dispatch_event = None
with self._gesture_lock:
if not (self._gesture_direction_enabled and self._gesture_active):
return
if self._gesture_cooldown_active():
self._emit_debug(
f"Gesture cooldown active source={source} "
f"dx={delta_x} dy={delta_y}"
)
self._emit_gesture_event(
{
"type": "cooldown_active",
"source": source,
"dx": delta_x,
"dy": delta_y,
}
)
return
if not self._gesture_tracking:
self._emit_debug(f"Gesture tracking started source={source}")
self._emit_gesture_event(
{
"type": "tracking_started",
"source": source,
}
)
self._start_gesture_tracking()
now = time.monotonic()
idle_ms = (now - self._gesture_last_move_at) * 1000.0
if idle_ms > self._gesture_timeout_ms:
self._emit_debug(
f"Gesture segment reset timeout source={source} "
f"accum_x={self._gesture_delta_x} accum_y={self._gesture_delta_y}"
)
self._start_gesture_tracking()
if source == "hid_rawxy" and self._gesture_input_source == "evdev":
self._emit_debug(
"Gesture source promoted from evdev to hid_rawxy "
f"prev_accum_x={self._gesture_delta_x} "
f"prev_accum_y={self._gesture_delta_y}"
)
self._start_gesture_tracking()
if self._gesture_input_source not in (None, source):
self._emit_debug(
f"Gesture source locked to {self._gesture_input_source}; "
f"ignoring {source} dx={delta_x} dy={delta_y}"
)
return
self._gesture_input_source = source
self._gesture_delta_x += delta_x
self._gesture_delta_y += delta_y
self._gesture_last_move_at = now
self._emit_debug(
f"Gesture segment source={source} "
f"accum_x={self._gesture_delta_x} accum_y={self._gesture_delta_y}"
)
self._emit_gesture_event(
{
"type": "segment",
"source": source,
"dx": self._gesture_delta_x,
"dy": self._gesture_delta_y,
}
)
gesture_event = self._detect_gesture_event()
if not gesture_event:
return
self._gesture_triggered = True
self._emit_debug(
"Gesture detected "
f"{gesture_event} source={source} "
f"delta_x={self._gesture_delta_x} delta_y={self._gesture_delta_y}"
)
self._emit_gesture_event(
{
"type": "detected",
"event_name": gesture_event,
"source": source,
"dx": self._gesture_delta_x,
"dy": self._gesture_delta_y,
}
)
dispatch_event = MouseEvent(
gesture_event,
{
"delta_x": self._gesture_delta_x,
"delta_y": self._gesture_delta_y,
"source": source,
},
)
self._gesture_cooldown_until = (
time.monotonic() + self._gesture_cooldown_ms / 1000.0
)
self._emit_debug(
f"Gesture cooldown started source={source} "
f"for_ms={self._gesture_cooldown_ms}"
)
self._emit_gesture_event(
{
"type": "cooldown_started",
"source": source,
"for_ms": self._gesture_cooldown_ms,
}
)
self._finish_gesture_tracking()
if dispatch_event:
self._dispatch(dispatch_event)
def _on_hid_gesture_down(self):
if self._ui_passthrough:
return
with self._gesture_lock:
if not self._gesture_active:
self._gesture_active = True
self._gesture_triggered = False
self._emit_debug("HID gesture button down")
self._emit_gesture_event({"type": "button_down"})
if self._gesture_direction_enabled and not self._gesture_cooldown_active():
self._start_gesture_tracking()
else:
self._gesture_tracking = False
self._gesture_triggered = False
def _on_hid_gesture_up(self):
if self._ui_passthrough:
return
dispatch_click = False
with self._gesture_lock:
if self._gesture_active:
should_click = not self._gesture_triggered
self._gesture_active = False
self._finish_gesture_tracking()
self._gesture_triggered = False
self._emit_debug(
f"HID gesture button up click_candidate={str(should_click).lower()}"
)
self._emit_gesture_event(
{
"type": "button_up",
"click_candidate": should_click,
}
)
dispatch_click = should_click
if dispatch_click:
self._dispatch(MouseEvent(MouseEvent.GESTURE_CLICK))
def _on_hid_mode_shift_down(self):
if self._ui_passthrough:
return
self._emit_debug("HID mode shift button down")
self._dispatch(MouseEvent(MouseEvent.MODE_SHIFT_DOWN))
def _on_hid_mode_shift_up(self):
if self._ui_passthrough:
return
self._emit_debug("HID mode shift button up")
self._dispatch(MouseEvent(MouseEvent.MODE_SHIFT_UP))
def _on_hid_dpi_switch_down(self):
if self._ui_passthrough:
return
self._emit_debug("HID DPI switch button down")
self._dispatch(MouseEvent(MouseEvent.DPI_SWITCH_DOWN))
def _on_hid_dpi_switch_up(self):
if self._ui_passthrough:
return
self._emit_debug("HID DPI switch button up")
self._dispatch(MouseEvent(MouseEvent.DPI_SWITCH_UP))
def _on_hid_gesture_move(self, delta_x, delta_y):
if self._ui_passthrough:
return
self._emit_debug(f"HID rawxy move dx={delta_x} dy={delta_y}")
self._emit_gesture_event(
{
"type": "move",
"source": "hid_rawxy",
"dx": delta_x,
"dy": delta_y,
}
)
self._accumulate_gesture_delta(delta_x, delta_y, "hid_rawxy")
def _on_hid_connect(self):
self._hid_ready = True
self._refresh_device_state(force=True)
dev = self._evdev_device
should_wake_evdev = (
self._running
and _EVDEV_OK
and (
dev is None
or not self._evdev_ready
or dev.info.vendor != _LOGI_VENDOR
)
)
if should_wake_evdev:
print("[MouseHook] Logitech HID connected; waking evdev scan")
self._rescan_requested.set()
self._evdev_wakeup.set()
def _on_hid_disconnect(self):
self._hid_ready = False
if self._gesture_active:
self._gesture_active = False
self._finish_gesture_tracking()
self._gesture_triggered = False
self._refresh_device_state(force=True)
def _find_mouse_device(self):
logi_mice = []
try:
paths = list(_evdev_mod.list_devices())
except Exception as exc:
_log_once(
("evdev-list-error", type(exc).__name__, str(exc)),
f"[MouseHook] Cannot list evdev devices: {exc}",
)
return None
if not paths:
event_paths = sorted(glob.glob("/dev/input/event*"))
if event_paths:
_log_once(
"evdev-empty-fallback-event-nodes",
"[MouseHook] evdev returned no input devices; falling "
"back to visible /dev/input/event* nodes: "
f"{_format_linux_device_access_list(event_paths)}",
)
paths = event_paths
else:
_log_once(
"evdev-no-input-devices",
"[MouseHook] evdev returned no input devices and no "
"/dev/input/event* nodes are visible; remapping needs "
f"/dev/input/event* access. "
f"{_format_linux_device_access('/dev/input')}",
)
for path in paths:
try:
dev = _InputDevice(path)
except PermissionError as exc:
_log_once(
("evdev-open-permission", path),
f"[MouseHook] Permission denied opening {path}: {exc}. "
f"{_format_linux_device_access(path)}. "
"Add the user to a group with /dev/input/event* access "
"or install a udev rule.",
)
continue
except Exception as exc:
_log_once(
("evdev-open-error", path, type(exc).__name__, str(exc)),
f"[MouseHook] Cannot open evdev device {path}: {exc}",
)
continue
try:
caps = dev.capabilities(absinfo=False)
if _ecodes.EV_REL not in caps or _ecodes.EV_KEY not in caps:
dev.close()
continue
rel_caps = set(caps.get(_ecodes.EV_REL, []))
key_caps = set(caps.get(_ecodes.EV_KEY, []))
if _ecodes.REL_X not in rel_caps or _ecodes.REL_Y not in rel_caps:
dev.close()
continue
if not key_caps.intersection(
{
_ecodes.BTN_LEFT,
_ecodes.BTN_RIGHT,
_ecodes.BTN_MIDDLE,
}
):
dev.close()
continue
has_side = bool(
key_caps.intersection(
{
_ecodes.BTN_SIDE,
_ecodes.BTN_EXTRA,
}
)
)
except PermissionError as exc:
_log_once(
("evdev-capabilities-permission", dev.path),
f"[MouseHook] Permission denied reading capabilities for "
f"{dev.path}: {exc}",
)
dev.close()
continue
except Exception as exc:
_log_once(
("evdev-capabilities-error", dev.path, type(exc).__name__, str(exc)),
f"[MouseHook] Cannot inspect evdev device {dev.path}: {exc}",
)
dev.close()
continue
if dev.info.vendor == _LOGI_VENDOR:
logi_mice.append((dev, has_side))
else:
info = getattr(dev, "info", None)
dedupe_key = (
dev.path,
getattr(info, "vendor", 0),
getattr(info, "product", 0),
dev.name or "",
)
if dedupe_key not in self._ignored_non_logitech:
self._ignored_non_logitech.add(dedupe_key)
print(
"[MouseHook] Ignoring non-Logitech evdev candidate: "
f"{dev.name} ({dev.path}) "
f"vendor=0x{getattr(info, 'vendor', 0):04X} "
f"product=0x{getattr(info, 'product', 0):04X}"
)
dev.close()
def _event_num(dev):
try:
return int(str(dev.path).rsplit("event", 1)[1])
except (IndexError, ValueError):
return -1
def _sort_key(item):
dev, has_side = item
info = getattr(dev, "info", None)
spec = _resolve_logi_device(
product_id=getattr(info, "product", None),
product_name=getattr(dev, "name", None),
)
return (
int(spec is not None),
int(has_side),
_event_num(dev),
)
ordered = sorted(logi_mice, key=_sort_key, reverse=True)
if ordered:
chosen = ordered[0][0]
for dev, _ in ordered[1:]:
dev.close()
print(
f"[MouseHook] Found mouse: {chosen.name} ({chosen.path}) "
f"vendor=0x{chosen.info.vendor:04X}"
)
return chosen
_log_once(
"evdev-no-logitech-mouse",
"[MouseHook] No Logitech evdev mouse found; UI connection state "
"and remapping require a Logitech mouse visible under "
"/dev/input/event* with vendor 0x046D",
)
return None
def _setup_evdev(self):
dev = self._find_mouse_device()
if not dev:
return False
try:
self._evdev_device = dev
self._evdev_grabbed = False
self._evdev_connected_device = self._build_evdev_connected_device(dev)
self._set_evdev_ready(True)
if self._ui_passthrough:
self._disable_evdev_remapping()
else:
self._enable_evdev_remapping()
return True
except Exception as exc:
print(f"[MouseHook] Failed to setup evdev: {exc}")
dev.close()
return False
def _filtered_uinput_events(self, dev):
caps = dict(dev.capabilities(absinfo=False))
for filtered_type in (_ecodes.EV_SYN, getattr(_ecodes, "EV_FF", None)):
if filtered_type is not None:
caps.pop(filtered_type, None)
rel_type = _ecodes.EV_REL
rel_caps = list(caps.get(rel_type, []))
if not rel_caps:
return caps
hi_res_codes = {
getattr(_ecodes, "REL_WHEEL_HI_RES", None),
getattr(_ecodes, "REL_HWHEEL_HI_RES", None),
}
filtered_rel_caps = [code for code in rel_caps if code not in hi_res_codes]
if filtered_rel_caps == rel_caps:
return caps
if filtered_rel_caps:
caps[rel_type] = filtered_rel_caps
else:
caps.pop(rel_type, None)
print(
"[MouseHook] Filtering REL_WHEEL_HI_RES / "
"REL_HWHEEL_HI_RES from Mouser Virtual Mouse"
)
return caps
def _cleanup_evdev(self):
self._disable_evdev_remapping()
if self._evdev_device:
try:
self._evdev_device.close()
except Exception:
pass
self._evdev_device = None
self._evdev_grabbed = False
print("[MouseHook] evdev device released")
self._evdev_connected_device = None
self._set_evdev_ready(False)
def _evdev_loop(self):
while self._running:
self._rescan_requested.clear()
if not self._setup_evdev():
if self._running:
self._wait_for_evdev_wakeup(2)
continue
try:
while self._running:
if self._rescan_requested.is_set():
break
if not self._evdev_remap_ready:
self._wait_for_evdev_wakeup(None)
if self._rescan_requested.is_set():
break
if (
self._running
and not self._ui_passthrough
and not self._evdev_remap_ready
):
self._enable_evdev_remapping()
continue
self._listen_loop()
break
except OSError as exc:
if self._running:
print(f"[MouseHook] Device disconnected: {exc}")
except Exception as exc:
if self._running:
print(f"[MouseHook] evdev error: {exc}")
finally:
self._cleanup_evdev()
if self._running:
if self._rescan_requested.is_set():
continue
self._wait_for_evdev_wakeup(1)
def _wait_for_evdev_wakeup(self, timeout=None):
self._evdev_wakeup.wait(timeout)
self._evdev_wakeup.clear()
def _listen_loop(self):
fd = self._evdev_device.fd
while self._running:
if self._rescan_requested.is_set():
print("[MouseHook] Rescan requested; leaving listen loop")
return
if not self._evdev_remap_ready:
self._wait_for_evdev_wakeup(None)
continue
readable, _, _ = _select_mod.select([fd], [], [], 0.5)
if not readable:
continue
for event in self._evdev_device.read():
if not self._running:
return
if self._ui_passthrough:
continue
if event.type == _ecodes.EV_SYN:
self._uinput.write_event(event)
elif event.type == _ecodes.EV_KEY:
self._handle_button(event)
elif event.type == _ecodes.EV_REL:
self._handle_rel(event)
else:
self._uinput.write_event(event)
def _handle_button(self, event):
if self._ui_passthrough or not self._evdev_remap_ready:
return
mouse_event = None
should_block = False
if event.code == _ecodes.BTN_SIDE:
if event.value == 1:
mouse_event = MouseEvent(MouseEvent.XBUTTON1_DOWN)
should_block = MouseEvent.XBUTTON1_DOWN in self._blocked_events
elif event.value == 0:
mouse_event = MouseEvent(MouseEvent.XBUTTON1_UP)
should_block = MouseEvent.XBUTTON1_UP in self._blocked_events
elif event.code == _ecodes.BTN_EXTRA:
if event.value == 1:
mouse_event = MouseEvent(MouseEvent.XBUTTON2_DOWN)
should_block = MouseEvent.XBUTTON2_DOWN in self._blocked_events
elif event.value == 0:
mouse_event = MouseEvent(MouseEvent.XBUTTON2_UP)
should_block = MouseEvent.XBUTTON2_UP in self._blocked_events
elif event.code == _ecodes.BTN_MIDDLE:
if event.value == 1:
mouse_event = MouseEvent(MouseEvent.MIDDLE_DOWN)
should_block = MouseEvent.MIDDLE_DOWN in self._blocked_events
elif event.value == 0:
mouse_event = MouseEvent(MouseEvent.MIDDLE_UP)
should_block = MouseEvent.MIDDLE_UP in self._blocked_events
if mouse_event:
self._dispatch(mouse_event)
if not should_block:
self._uinput.write_event(event)
def _handle_rel(self, event):
if self._ui_passthrough or not self._evdev_remap_ready:
return
code = event.code
value = event.value
if code == _ecodes.REL_X or code == _ecodes.REL_Y:
if self._gesture_direction_enabled and self._gesture_active:
if self._gesture_input_source != "hid_rawxy":
if code == _ecodes.REL_X:
self._accumulate_gesture_delta(value, 0, "evdev")
else:
self._accumulate_gesture_delta(0, value, "evdev")
return
self._uinput.write_event(event)
return
rel_wheel_hi_res = getattr(_ecodes, "REL_WHEEL_HI_RES", 0x0B)
if code == _ecodes.REL_WHEEL or code == rel_wheel_hi_res:
if self.invert_vscroll:
self._uinput.write(_ecodes.EV_REL, code, -value)
else:
self._uinput.write_event(event)
return
rel_hwheel_hi_res = getattr(_ecodes, "REL_HWHEEL_HI_RES", 0x0C)
if code == _ecodes.REL_HWHEEL or code == rel_hwheel_hi_res:
should_block = False
if value > 0:
should_block = MouseEvent.HSCROLL_RIGHT in self._blocked_events
elif value < 0:
should_block = MouseEvent.HSCROLL_LEFT in self._blocked_events
if code == _ecodes.REL_HWHEEL:
if value > 0:
self._dispatch(MouseEvent(MouseEvent.HSCROLL_RIGHT, abs(value)))
elif value < 0:
self._dispatch(MouseEvent(MouseEvent.HSCROLL_LEFT, abs(value)))
if should_block:
return
if self.invert_hscroll:
self._uinput.write(_ecodes.EV_REL, code, -value)
else:
self._uinput.write_event(event)
return
self._uinput.write_event(event)
def _install_crash_guard(self):
import atexit
import signal
atexit.register(self._cleanup_evdev)
for sig in (signal.SIGTERM, signal.SIGINT, signal.SIGHUP):
prev = signal.getsignal(sig)
def _handler(signum, frame, _prev=prev):
self._cleanup_evdev()
if callable(_prev) and _prev not in (signal.SIG_DFL, signal.SIG_IGN):
_prev(signum, frame)
else:
raise SystemExit(128 + signum)
signal.signal(sig, _handler)
def start(self):
self._running = True
self._start_hid_listener()
if _EVDEV_OK:
self._install_crash_guard()
self._evdev_thread = threading.Thread(
target=self._evdev_loop,
daemon=True,
name="MouseHook-evdev",
)
self._evdev_thread.start()
else:
print("[MouseHook] evdev not available — button remapping disabled")
return True
def stop(self):
self._running = False
self._stop_hid_listener()
self._hid_ready = False
self._connected_device = None
self._evdev_connected_device = None
self._rescan_requested.set()
self._evdev_wakeup.set()
if self._evdev_thread:
self._evdev_thread.join(timeout=2)
self._evdev_thread = None
self._cleanup_evdev()
MouseHook._platform_module = sys.modules[__name__]
__all__ = [
"MouseHook",
"HidGestureListener",
"_select_mod",
"_evdev_mod",
"_InputDevice",
"_UInput",
"_ecodes",
"_EVDEV_OK",
"_LOGI_VENDOR",
]