Change library to pynput, refactor class

Author: upgradeQ

README.md

@@ -3,17 +3,17 @@ Selected source will  follow mouse pointer.
 Using [`obs_sceneitem_set_pos`](https://obsproject.com/docs/reference-scenes.html#c.obs_sceneitem_set_pos) 
 # Installation 
 - Make sure your OBS Studio supports [scripting](https://obsproject.com/docs/scripting.html)
-- Download and extract source code from [here](https://github.com/upgradeQ/OBS-Studio-Cursor-skin/releases/tag/0.2.1)
-- You will need to install mouse package from [pypi](https://pypi.org/project/mouse/):  
-`python -m pip install mouse`
+- You will need to install pynput package from [pypi](hhttps://pypi.org/project/pynput/):  
+`python -m pip install pynput`
 # Limitations
 - Multilpe monitors setup will not work .
+- If used in fullscreen apps, offset will appear.
 # Usage
 - Create _source_ with desired cursor(e.g Image source or Media source).
 - In scripts select _that_ source name.
 - Test it: press Start, press Stop, tweak refresh rate.
 # Crop auto update
-For zoom or higlight.
+Zoom or higlight.
 - Create 2 display captures.
 - Create crop filter with this name: `cropXY`.
 - Check relative.

mouse_skin_obs.py

@@ -1,9 +1,10 @@
 import obspython as obs
-from mouse import get_position  # python -m pip install mouse
+from pynput.mouse import Controller  # python -m pip install pynput
 
-__version__ = "0.3.0-alpha"
-REFRESH_RATE = 15
-FLAG = True
+c = Controller()
+get_position = lambda: c.position
+
+__version__ = "1.0.0"
 
 
 def apply_scale(x, y, width, height):
@@ -13,16 +14,12 @@ def apply_scale(x, y, width, height):
 
 
 class CursorAsSource:
-    def __init__(self, source_name=None):
-        self.source_name = source_name
-        self.lock = True
-        self.update_xy = False
-        self.update_gs = False  # green screen
-        self.update_cr = False
+    source_name = None
+    lock = True
+    flag = True
+    refresh_rate = 15
 
     def update_cursor(self):
-        """ in script settings check update cursor"""
-
         source = obs.obs_get_source_by_name(self.source_name)
         settings = obs.obs_data_create()
         if source is not None:
@@ -48,58 +45,14 @@ def update_cursor(self):
             obs.obs_scene_release(scene)
             obs.obs_source_release(source)
 
-    def update_green(self):
-        """
-        create new scene with name:__spotlight__
-        add color source , add opacity(color correction) to that source
-        add green circle 
-        add that scene as source to ur current scene 
-        apply chromakey filter to that source 
-        in script settings check update green
-        """
-        source = obs.obs_get_source_by_name(self.source_name)
-        settings = obs.obs_data_create()
-        if source is not None:
-            scene_width = obs.obs_source_get_width(source)
-            scene_height = obs.obs_source_get_height(source)
-            # get all scenes
-            scenes = obs.obs_frontend_get_scenes()
-            for sc in scenes:
-                # select the one with chromakey cursor(green)
-                name = obs.obs_source_get_name(sc)
-                if name == "__spotlight__":
-                    # assign it
-                    _item = sc
-                else:
-                    obs.obs_source_release(sc)
-
-            scene = obs.obs_scene_from_source(_item)
-            scene_item = obs.obs_scene_find_source(scene, self.source_name)
-            if scene_item:
-                scale = obs.vec2()
-                obs.obs_sceneitem_get_scale(scene_item, scale)
-                scene_width, scene_height = apply_scale(
-                    scale.x, scale.y, scene_width, scene_height
-                )
-                next_pos = obs.vec2()
-                next_pos.x, next_pos.y = get_position()
-                next_pos.x -= scene_width / 2
-                next_pos.y -= scene_height / 2
-                # set position to center of source where cursor is
-                obs.obs_sceneitem_set_pos(scene_item, next_pos)
-
-            obs.obs_data_release(settings)
-            obs.obs_scene_release(scene)
-            obs.obs_source_release(source)
-
     def update_crop(self):
         """
         Create 2 display captures.
         Create crop filter with this name: cropXY.
         Check relative.
         Set Width and Height to relatively small numbers e.g : 64x64 .
         Image mask blend + color correction might be an option too.
-        Run script,select this source as cursor source , check Update crop and updated cursor, click start.
+        Run script,select this source as cursor source , check Update crop, click start.
         """
         source = obs.obs_get_source_by_name(self.source_name)
         crop = obs.obs_source_get_filter_by_name(source, "cropXY")
@@ -125,54 +78,42 @@ def ticker(self):
             if self.update_xy:
                 self.update_crop()
                 self.update_cursor()
-            if self.update_gs:
-                self.update_green()
-            if self.update_cr:
+            else:
                 self.update_cursor()
 
         if not self.lock:
             obs.remove_current_callback()
 
 
-py_cursor = CursorAsSource()  # class created ,obs part starts
+py_cursor = CursorAsSource()
 
 
 def stop_pressed(props, prop):
-    global FLAG
-    FLAG = True
+    py_cursor.flag = True
     py_cursor.lock = False
 
 
 def start_pressed(props, prop):
-    global FLAG  # to keep only one timer callback
-    if py_cursor.source_name != "" and FLAG:
-        obs.timer_add(py_cursor.ticker, REFRESH_RATE)
+    if py_cursor.source_name != "" and py_cursor.flag:
+        obs.timer_add(py_cursor.ticker, py_cursor.refresh_rate)
     py_cursor.lock = True
-    FLAG = False
-
-
-def script_description():
-    return "USE SOURCE AS CURSOR"
+    py_cursor.flag = False  # to keep only one timer callback
 
 
 def script_defaults(settings):
-    global REFRESH_RATE
-    obs.obs_data_set_default_int(settings, "refresh_rate", REFRESH_RATE)
+    obs.obs_data_set_default_int(settings, "_refresh_rate", py_cursor.refresh_rate)
 
 
 def script_update(settings):
-    global REFRESH_RATE
     py_cursor.update_xy = obs.obs_data_get_bool(settings, "bool_yn")
-    py_cursor.update_xy = obs.obs_data_get_bool(settings, "bool_yn_cursor")
-    py_cursor.update_gs = obs.obs_data_get_bool(settings, "bool_yn_green")
     py_cursor.source_name = obs.obs_data_get_string(settings, "source")
-    REFRESH_RATE = obs.obs_data_get_int(settings, "refresh_rate")
+    py_cursor.refresh_rate = obs.obs_data_get_int(settings, "_refresh_rate")
 
 
-def script_properties():  # ui
+def script_properties():
     props = obs.obs_properties_create()
     number = obs.obs_properties_add_int(
-        props, "refresh_rate", "Refresh rate (ms)", 15, 300, 5
+        props, "_refresh_rate", "Refresh rate (ms)", 15, 300, 5
     )
     p = obs.obs_properties_add_list(
         props,
@@ -191,6 +132,4 @@ def script_properties():  # ui
     obs.obs_properties_add_button(props, "button", "Stop", stop_pressed)
     obs.obs_properties_add_button(props, "button2", "Start", start_pressed)
     obs.obs_properties_add_bool(props, "bool_yn", "Update crop")
-    obs.obs_properties_add_bool(props, "bool_yn_green", "Update green circle")
-    obs.obs_properties_add_bool(props, "bool_yn_cursor", "Update cursro ")
     return props