Merge pull request #5 from asterics/change-shortcuts

Change shortcuts

Author: deinhofer

Demo.py

@@ -62,7 +62,6 @@ def __init__(self):
         super().__init__()
         self.is_running = False
         self.is_tracking = False
-        self.mouse_enabled = False
         self.mouse_absolute = True
         self.mouse: Mouse.Mouse = Mouse.Mouse()
 
@@ -115,7 +114,13 @@ def __init__(self):
         # add hotkey
         # TODO: how to handle activate mouse / toggle mouse etc. by global hotkey
         # keyboard.add_hotkey("esc", lambda: self.stop())
+        # alt + 1: toggle gestures + mouse movement
+        # alt + g: toggle gestures (keyboard and mouse)
+        # alt + m: toggle mouse movement
         keyboard.add_hotkey("alt + 1", lambda: self.toggle_gesture_mouse())  # TODO: Linux alternative
+        keyboard.add_hotkey("alt + g", lambda: self.toggle_gestures())
+        keyboard.add_hotkey("alt + m", lambda: self.toggle_mouse_movement())
+        keyboard.add_hotkey("alt + t", lambda: self.toggle_tracking())
         keyboard.add_hotkey("m", lambda: self.toggle_mouse_mode())
         keyboard.add_hotkey("c", lambda: self.mouse.centre_mouse())
         keyboard.add_hotkey(".", lambda: self.mouse.switch_monitor())
@@ -219,7 +224,7 @@ def __run_livelinkface(self):
 
                 if self.write_csv:
                     self.csv_writer.writerow(row)
-                if self.mouse_enabled:
+                if self.mouse.mouse_movement_enabled:
                     self.mouse.process_signal(self.signals)
 
     def __start_camera(self):
@@ -306,6 +311,12 @@ def __csv_recording(self):
                 self.mediapipe_csv_writer.writerow(mp_row)
                 self.iphone_csv_writer.writerow(ip_row)
 
+    def toggle_tracking(self):
+        print("toggle tracking..")
+        if self.is_tracking:
+            self.stop_tracking()
+        else:
+            self.start_tracking()
     def stop_tracking(self):
         print("Stopping tracking..")
         self.is_tracking = False
@@ -332,24 +343,59 @@ def update_webcam_video_file_selection(self, vid_source_file):
         print(f"Setting camera with video file {vid_source_file}")
         self.vid_source_file = vid_source_file
 
-    def disable_gesture_mouse(self):
+    def toggle_gestures(self):
+        if self.mouse.mouse_gesture_enabled:
+            self.disable_gestures()
+        else:
+            self.enable_gestures()
+
+    """
+    Disables alls configured gestures (mouse and keyboard).
+    """
+    def disable_gestures(self):
+        print("disabling gestures")
         # Disables gesture mouse and enables normal mouse input
         for signal in self.signals.values():
             signal.set_actions_active(False)
-        self.mouse_enabled = False
-        self.mouse.disable_gesture()
+        self.mouse.disable_gestures()
+
+    """
+    Disables all gestures and mouse movement.
+    """
+    def disable_gesture_mouse(self):
+        self.disable_mouse_movement()
+        self.disable_gestures()
+
+    """
+    Enables all gestures (mouse and keyboard)
+    """
+    def enable_gestures(self):
+        print("enabling gestures")
+        for signal in self.signals.values():
+            signal.set_actions_active(True)
+
+        self.mouse.enable_gestures()
 
+    """
+    Enables all gestures and the mouse.
+    """
     def enable_gesture_mouse(self):
         # Enables gesture mouse and enables normal mouse input
+        self.enable_mouse_movement()
+        self.enable_gestures()
 
-        for signal in self.signals.values():
-            signal.set_actions_active(True)
-        self.mouse_enabled = True
-        self.mouse.enable_gesture()
+    def enable_mouse_movement(self):
+        self.mouse.enable_mouse_movement()
+    def disable_mouse_movement(self):
+        self.mouse.disable_mouse_movement()
+
+    def toggle_mouse_movement(self):
+        self.mouse.toggle_mouse_movement()
 
     def toggle_gesture_mouse(self):
+        print("toggling mouse and gestures")
         # Toggles between gesture and normal mouse
-        if self.mouse_enabled:
+        if self.mouse.mouse_movement_enabled:
             self.disable_gesture_mouse()
         else:
             self.enable_gesture_mouse()

Mouse.py

@@ -80,8 +80,8 @@ def __init__(self):
 
         # Tracking Mode
         self.tracking_mode = TrackingMode.MEDIAPIPE
-        # To disable mouse
-        self.mouse_enabled = True
+        # To toggle mouse movement
+        self.mouse_movement_enabled = True
         self.is_dragging = False
         self.precision_mode = False
 
@@ -90,6 +90,10 @@ def __init__(self):
         self.kalman_filter = Kalman1D(sz=100, R=self.filter_value ** 2)
         self.filter_mouse_position = True
 
+        # Gestures
+        # To toggle mouse gestures
+        self.mouse_gesture_enabled = True
+
     def move(self, pitch: float, yaw: float):
         if self.mode == MouseMode.ABSOLUTE:
             # x_new = self.w_pixels * 2 * (yaw - 0.25) + self.monitor_x_offset
@@ -207,51 +211,67 @@ def process_signal(self, signals):
 
         pitch = signals[upDown].scaled_value
         yaw = signals[leftRight].scaled_value
-        if self.mouse_enabled:
+        if self.mouse_movement_enabled:
             self.move(pitch, yaw)
         else:
             self.dx = 0
             self.dy = 0
         self.pitch = pitch
         self.yaw = yaw
 
-    def enable_gesture(self):
-        self.mouse_enabled = True
+    def enable_gestures(self):
+        self.mouse_gesture_enabled = True
+
+    def disable_gestures(self):
+        self.mouse_gesture_enabled = False
+
+    def toggle_gestures(self):
+        self.mouse_gesture_enabled = not self.mouse_gesture_enabled
 
     def click(self, button):
         """
         Clicks the mouse button specified with button.
         :param button: str, one of the buttons to click
         :return:
         """
-        self.mouse_controller.click(button)
+        if self.mouse_gesture_enabled:
+            self.mouse_controller.click(button)
 
     def double_click(self, button):
         """
         Double-clicks the mouse button specified with button.
         :param button: str, one of the buttons to click
         :return:
         """
-        self.mouse_controller.click(button, 2)
+        if self.mouse_gesture_enabled:
+            self.mouse_controller.click(button, 2)
 
     def drag_drop(self):
-        if self.is_dragging:
-            self.mouse_controller.release(mouse.Button.left)
-            self.is_dragging = False
+        if self.mouse_gesture_enabled:
+            if self.is_dragging:
+                self.mouse_controller.release(mouse.Button.left)
+                self.is_dragging = False
+            else:
+                self.mouse_controller.press(mouse.Button.left)
+                self.is_dragging = True
+            print(self.is_dragging)
+
+    def toggle_mouse_movement(self):
+        if self.mouse_movement_enabled:
+            self.disable_mouse_movement()
         else:
-            self.mouse_controller.press(mouse.Button.left)
-            self.is_dragging = True
-        print(self.is_dragging)
-
-    def disable_gesture(self):
-        self.mouse_enabled = False
+            self.enable_mouse_movement()
+    def enable_mouse_movement(self):
+        print("enable mouse movement")
+        self.mouse_movement_enabled = True
 
-    def toggle_active(self):
-        self.mouse_enabled = not self.mouse_enabled
+    def disable_mouse_movement(self):
+        print("disable mouse movement")
+        self.mouse_movement_enabled = False
 
     def toggle_mode(self):
         self.mode = self.mode.next()
-        print(f"Mouse mode is {self.tracking_mode.name}")
+        print(f"Mouse mode is {self.mode.name}")
 
     def set_mouse_mode(self, mode: str):
         try:
@@ -272,12 +292,14 @@ def centre_mouse(self):
         self.in_finezone = False
 
     def switch_monitor(self):
+        print("switch monitor")
         self.monitor_index = (self.monitor_index + 1) % len(self.monitors_list)
         screen = self.monitors_list[self.monitor_index]
         self.h_pixels = screen.height
         self.w_pixels = screen.width
         self.monitor_x_offset = screen.x
         self.monitor_y_offset = screen.y
+        print(f"screen {screen}, h_pixels{self.h_pixels}, x_offset {self.monitor_x_offset}")
 
 
     def set_x_sensitivity(self, value: float):
@@ -371,7 +393,7 @@ def toggle_tracking_mode(self):
     mouse.set_filter_enabled(False)
     mouse.set_mouse_mode(MouseMode.ABSOLUTE.name)
     mouse.set_tracking_mode(TrackingMode.NOSE.name)
-    mouse.enable_gesture()
+    mouse.enable_gestures()
 
     for i in range(1000):
         time.sleep(0.01)

README.md

@@ -1,33 +1,50 @@
 # Gesture Mouse
 
 A library that allows to control the mouse and keyboard with head movement and face gestures. This project is based on the 
-google mediapipe library (https://google.github.io/mediapipe/).
+google mediapipe library (https://ai.google.dev/edge/mediapipe/solutions/guide).
 
 ## Installation instructions
 Tested with Python 3.10 and PySide6.4.3. 
 1. Clone repository
 2. Create a sufolder `mkdir venv`
 3. Create virtual environment  `python -m venv venv`
-4. Activate virtual environment `venv\Scripts\activate.bat` (Linux: `. venv/bin/activate`)
+4. Activate virtual environment `venv\Scripts\activate.bat` (Linux: `. ./venv/bin/activate`)
 5. Install packages `pip install -r requirements.txt`
 
 ## Running Gesture Mouse
-### Starting the application
-- `python gui.py` to start gui (Linux: `sudo ./venv/bin/python3.10 gui.py`) 
-- `Alt+1` to toggle mouse controlled by python or system.
-- `Esc` to turn off program. (Used if you lose control over mouse)
 
-Alternatively you can create an executable distribution and run `dist\gui.exe` (Windows) or `dist/gui` (Linux)
+### Release
+
+1. Extract zip file
+2. Run `gesture_mouse.exe` (Windows) or `sudo ./gesture_mouse` (Linux)
+
+### Development
+
+- `python gui.py` to start gui (Linux: `sudo ./venv/bin/python3.10 gui.py`)
+
+## Hotkeys
+
+- <kbd>Alt</kbd>+<kbd>1</kbd> to toggle mouse movement and gestures.
+- <kbd>Alt</kbd>+<kbd>m</kbd> to toggle mouse movement.
+- <kbd>Alt</kbd>+<kbd>g</kbd> to toggle gestures.
+- <kbd>Alt</kbd>+<kbd>t</kbd> to toggle tracking (start or stop camera).
+
+### Hotkeys Mouse Movement
+
+- <kbd>m</kbd> iterate through mouse (ABSOLUTE, RELATIVE, JOYSTICK, HYBRID) modes
+- <kbd>t</kbd> iterate through tracking mode (PNP, MEDIAPIPE, NOSE)
+- <kbd>c</kbd> Center mouse position
+- <kbd>.</kbd> Switch monitor in case there are several monitors applied. Ignored for RELATIVE mouse mode.
 
 ## Creating an exe distribution
-To create a distribution folder wich includes all necessery .dll and an executable one can use PyInstaller([https://pyinstaller.org](https://pyinstaller.org)). 
+To create a distribution folder which includes all necessery .dll and an executable one can use PyInstaller([https://pyinstaller.org](https://pyinstaller.org)). 
 Instructions:
 1. Follow the installation instructions
-2. Activate virtual environment `venv/Scripts/activate` on windows and `source venv/bin/activate` on linux
+2. Activate virtual environment
 3. Install PyInstaller `pip install pyinstaller`
 4. Execute build process with  
-`pyinstaller gui.py -D --add-data config;config --add-data data;data --collect-all mediapipe` on windows  
-`pyinstaller gui.py -D --add-data config:config --add-data data:data --collect-all mediapipe` on linux 
+`pyinstaller gui.py -D --add-data config;config --add-data data;data --collect-all mediapipe -n gesture-mouse --contents-directory .` on linux  
+`pyinstaller gui.py -D --add-data config:config --add-data data:data --collect-all mediapipe -n gesture-mouse --contents-directory .` on windows 
 
 ## Algorithms
 

config/profiles/keyboard_latest.json

@@ -1,11 +1 @@
-[
-  {
-    "action": "keyboard_key",
-    "signal": "jawOpen",
-    "threshold": 0.318,
-    "delay": 0.1,
-    "trigger": "up",
-    "action_type": "press and release",
-    "key": "Backspace"
-  }
-]
+[]

config/profiles/mouse_latest.json

@@ -1,7 +1,7 @@
 {
   "mouse_setting": {
     "left_click": {
-      "threshold": 0.176,
+      "threshold": 0.121,
       "signal": "-",
       "delay": 0.0
     },
@@ -36,7 +36,7 @@
       "delay": 0.5
     },
     "switch_monitor": {
-      "threshold": 0.651,
+      "threshold": 0.641,
       "signal": "-",
       "delay": 0.1
     },
@@ -54,6 +54,6 @@
     "filter_enabled": false,
     "filter_value": 0.0018371727707755903,
     "tracking_mode": "NOSE",
-    "mouse_mode": "JOYSTICK"
+    "mouse_mode": "RELATIVE"
   }
 }

gui.py

@@ -880,7 +880,7 @@ def __init__(self, demo):
         self.mouse_settings["right_click"] = MouseClickSettings("Right",self.demo,lambda : self.demo.mouse.click(mouse.Button.right))
         self.mouse_settings["double_click"] = MouseClickSettings("Double Click", self.demo,lambda : self.demo.mouse.double_click(mouse.Button.left))
         self.mouse_settings["drag_drop"] = MouseClickSettings("Drag and Drop",self.demo,lambda : self.demo.mouse.drag_drop())
-        self.mouse_settings["pause"] = MouseClickSettings("Pause", self.demo, lambda : self.demo.mouse.toggle_active())
+        self.mouse_settings["pause"] = MouseClickSettings("Pause", self.demo, lambda : self.demo.mouse.toggle_mouse_movement())
         self.mouse_settings["center"] = MouseClickSettings("Center", self.demo, lambda : self.demo.mouse.centre_mouse())
         self.mouse_settings["switch_mode"] = MouseClickSettings("Switch Mode", self.demo, lambda : self.demo.mouse.toggle_mode())
         self.mouse_settings["switch_monitor"] = MouseClickSettings("Switch Monitor", self.demo, lambda : self.demo.mouse.switch_monitor())
@@ -1321,7 +1321,7 @@ def update_action(self):
         print("Parsed hotkey ", parsed_hotkeys)
 
         # create new action
-        new_action = Signal.GestureAction()
+        new_action = Gesture.GestureAction()
         new_action.threshold = threshold
         action_function = None
         if action_type == "press":