visppy 0.0.1__tar.gz

visppy-0.0.1/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.3
+Name: visppy
+Version: 0.0.1
+Summary: TODO
+Requires-Dist: coredeco>=1.1.0
+Requires-Dist: mss>=10.2.0
+Requires-Dist: ntmemoryapi>=2.6.0
+Requires-Dist: pillow>=12.3.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+

visppy-0.0.1/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "visppy"
+version = "0.0.1"
+description = "TODO"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "coredeco>=1.1.0",
+    "mss>=10.2.0",
+    "ntmemoryapi>=2.6.0",
+    "pillow>=12.3.0",
+]
+
+[project.scripts]
+visppy = "visppy:main"
+
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13.0"]
+build-backend = "uv_build"

visppy-0.0.1/pyproject.toml.orig

@@ -0,0 +1,19 @@
+[project]
+name = "visppy"
+version = "0.0.1"
+description = "TODO"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "coredeco>=1.1.0",
+    "mss>=10.2.0",
+    "ntmemoryapi>=2.6.0",
+    "pillow>=12.3.0",
+]
+
+[project.scripts]
+visppy = "visppy:main"
+
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13.0"]
+build-backend = "uv_build"

visppy-0.0.1/src/visppy/__init__.py

@@ -0,0 +1,138 @@
+import io
+import os
+import mss
+import coredeco
+import PIL.Image
+import dataclasses
+import ntmemoryapi
+
+# Local imports
+from . import embed
+from . import windows
+
+# Custom types
+type Rect[T] = tuple[T, T, T, T]
+type RGBColor[T] = tuple[T, T, T]
+
+
+# ==----------------------------------------------------------------== #
+# Dataclasses                                                          #
+# ==----------------------------------------------------------------== #
+@dataclasses.dataclass(frozen=True, slots=True)
+class BoudingBox:
+    """Dataclass that contains information about found image bouding box and confidence."""
+
+    # Initial confidence score with which image was found
+    confidence: float
+
+    # Position information
+    x: int
+    y: int
+    w: int
+    h: int
+
+    # ==--------------------------------== #
+    # Properties                           #
+    # ==--------------------------------== #
+    @property
+    def center(self) -> tuple[int, int]:
+        """Locate position center."""
+
+        # Return position
+        return self.x + self.w // 2, self.y + self.h // 2
+
+
+# ==----------------------------------------------------------------== #
+# Classes                                                              #
+# ==----------------------------------------------------------------== #
+class VisionEngine:
+    """Capture dispay screen, search needle images on haystack image or display screen capture."""
+
+    # ==--------------------------------== #
+    # Public methods                       #
+    # ==--------------------------------== #
+    def __init__(self, tracking_window: str | None = None) -> None:
+        """Create instance of vision engine, capture `tracking_window` region if defined."""
+
+        # Save initializer arguments as instance attributes
+        self.tracking_window = tracking_window
+
+        # Instance inner attributes
+        self.image_cache = {}
+        self.screenshoter = mss.MSS()
+
+    def screenshot(self, region: Rect[int] | None = None) -> PIL.Image.Image:
+        """Get display screenshot."""
+
+        # Grab display screenshot
+        screengrab = self.screenshoter.grab(self.screenshoter.monitors[1] if (region := self.__get_region(region)) is None else {
+            key: value for key, value in zip(["left", "top", "width", "height"], region)
+        })
+
+        # Convert screenshot to RGB format image and return
+        return PIL.Image.frombuffer(
+            "RGB", screengrab.size, screengrab.bgra, "raw", "BGRX"
+        )
+
+    def pixel(self, x: int, y: int, *, cache_haystack: bool = False, haystack: io.BytesIO | PIL.Image.Image | str | None = None) -> RGBColor[int]:
+        """Get pixel color on an image, make display screenshot and use it as haystack if `haystack` is `None`."""
+
+        # Get image to get pixel information
+        image = self.screenshot() if haystack is None else self.__load_image(haystack, cache_haystack)
+
+        # Get pixel information
+        return image.getpixel((x, y))
+
+    # ==--------------------------------== #
+    # Private methods                      #
+    # ==--------------------------------== #
+    def __get_region(self, region: Rect[int] | None = None) -> Rect[int] | None:
+        """Get region for capture."""
+
+        # If tracking window is not defined
+        if self.tracking_window is None or region is not None:
+            return region
+
+        # Retrieve window information
+        window_information = windows.get_window_position(self.tracking_window)["visible_area"]
+
+        # If window if out of the screen
+        if window_information["w"] <= 0 or window_information["h"] <= 0:
+            raise RuntimeError(f"Window {self.tracking_window} is out of the screen")
+
+        return tuple(window_information.values())
+
+    def __load_image(self, data: io.BytesIO | PIL.Image.Image | str, cache_image: bool = False) -> PIL.Image.Image:
+        """Load `PIL.Image.Image` instance from given data."""
+
+        # If data is already an image
+        if isinstance(data, PIL.Image.Image):
+            return data
+
+        # If data is not an image
+        if isinstance(data, (io.BytesIO, str)):
+
+            # If image caching required
+            if cache_image:
+
+                # If image is not cached
+                if data not in self.image_cache:
+
+                    # Open image and load it
+                    image = PIL.Image.open(data)
+                    image.load()
+
+                    # Save image to cache
+                    self.image_cache[data] = image
+
+                # Return image from cache
+                return self.image_cache[data]
+
+            # Open image and load it
+            image = PIL.Image.open(data)
+            image.load()
+
+            return image
+
+        # Data is not an image
+        raise ValueError("Data can't be converted into pillow image")

visppy-0.0.1/src/visppy/windows.py

@@ -0,0 +1,177 @@
+import ctypes
+
+
+# ==----------------------------------------------------------------== #
+# C-structures                                                         #
+# ==----------------------------------------------------------------== #
+class Rect(ctypes.Structure):
+    """Structure that contains window rect position."""
+
+    _fields_ = [
+        ("left", ctypes.c_long),
+        ("top", ctypes.c_long),
+        ("right", ctypes.c_long),
+        ("bottom", ctypes.c_long),
+    ]
+
+
+class DevMode(ctypes.Structure):
+    """Structure that contains display information."""
+
+    _fields_ = [
+        ("dm_device_name", ctypes.c_wchar * 32),
+        ("dm_spec_version", ctypes.c_ushort),
+        ("dm_driver_version", ctypes.c_ushort),
+        ("dm_size", ctypes.c_ushort),
+        ("dm_driver_extra", ctypes.c_ushort),
+        ("dm_fields", ctypes.c_ulong),
+        ("dm_position_x", ctypes.c_long),
+        ("dm_Position_y", ctypes.c_long),
+        ("dm_display_orientation", ctypes.c_ulong),
+        ("dm_display_fixed_output", ctypes.c_ulong),
+        ("dm_color", ctypes.c_short),
+        ("dm_duplex", ctypes.c_short),
+        ("dm_y_resolution", ctypes.c_short),
+        ("dm_tt_option", ctypes.c_short),
+        ("dm_collate", ctypes.c_short),
+        ("dm_form_name", ctypes.c_wchar * 32),
+        ("dm_log_pixels", ctypes.c_ushort),
+        ("dm_bits_per_pel", ctypes.c_ulong),
+        ("dm_pels_width", ctypes.c_ulong),
+        ("dm_pels_height", ctypes.c_ulong),
+    ]
+
+
+# ==----------------------------------------------------------------== #
+# Functions                                                            #
+# ==----------------------------------------------------------------== #
+def window_exists(window_title: str) -> bool:
+    """Check if window with given title exist."""
+
+    return bool(ctypes.windll.user32.FindWindowW(None, window_title))
+
+
+def set_window_title(window_title: str, new_window_title: str) -> None:
+    """Set new title for window with given title."""
+
+    # If window not found
+    if not (window_descriptor := ctypes.windll.user32.FindWindowW(None, window_title)):
+        raise ctypes.WinError(descr="Unable to find window with `%s` title" % window_title)
+
+    # Set new window title
+    if not ctypes.windll.user32.SetWindowTextW(window_descriptor, new_window_title):
+        raise ctypes.WinError(descr="Unable to set `%s` title for window with `%s` title" % (new_window_title, window_title))
+
+
+def set_window_position(window_title: str, position: tuple[int, int]) -> None:
+    """Set new position for window with given title."""
+
+    # If window not found
+    if not (window_descriptor := ctypes.windll.user32.FindWindowW(None, window_title)):
+        raise ctypes.WinError(descr="Unable to find window with `%s` title" % window_title)
+
+    # Set new window position
+    if not ctypes.windll.user32.SetWindowPos(window_descriptor, None, *position, 0, 0, 0x1):
+        raise ctypes.WinError(descr="Unable to set position for window with `%s` title" % window_title)
+
+
+def set_window_size(window_title: str, size: tuple[int, int]) -> None:
+    """Set new size for window with given title."""
+
+    # If window not found
+    if not (window_descriptor := ctypes.windll.user32.FindWindowW(None, window_title)):
+        raise ctypes.WinError(descr="Unable to find window with `%s` title" % window_title)
+
+    # Set new window size
+    if not ctypes.windll.user32.SetWindowPos(window_descriptor, None, 0, 0, *size, 0x2):
+        raise ctypes.WinError(descr="Unable to set size for window with `%s` title" % window_title)
+
+
+def set_window_foreground(window_title: str) -> None:
+    """Set window with given title foreground."""
+
+    # If window not found
+    if not (window_descriptor := ctypes.windll.user32.FindWindowW(None, window_title)):
+        raise ctypes.WinError(descr="Unable to find window with `%s` title" % window_title)
+
+    # Set window foreground
+    if not ctypes.windll.user32.SetForegroundWindow(window_descriptor):
+        raise ctypes.WinError(descr="Unable o set window with `%s` title foreground" % window_title)
+
+
+def set_window_frameless(window_title: str) -> None:
+    """Set window with given title frameless."""
+
+    # If window not found
+    if not (window_descriptor := ctypes.windll.user32.FindWindowW(None, window_title)):
+        raise ctypes.WinError(descr="Unable to find window with `%s` title" % window_title)
+
+    # If unable to retrieve windows styles
+    if not (window_style := ctypes.windll.user32.GetWindowLongW(window_descriptor, -16)):
+        raise ctypes.WinError(descr="Unable to retrieve styles for window with `%s` title" % window_title)
+
+    # If unable to update windows styles
+    if not ctypes.windll.user32.SetWindowLongW(window_descriptor, -16, window_style & ~(0x10000 | 0x20000 | 0x40000 | 0x80000 | 0xC00000)):
+        raise ctypes.WinError(descr="Unable to update styles for window with `%s` tltle" % window_title)
+
+    # If unable to update window to apply styles
+    if not ctypes.windll.user32.SetWindowPos(window_descriptor, None, 0, 0, 0, 0, 0x27):
+        raise ctypes.WinError(descr="Unable to update window with `%s` title to apply styles" % window_title)
+
+
+def get_window_position(window_title: str) -> dict[str, dict | int]:
+    """Get window position information that contains its absolute screen coordinates, size and visible area."""
+
+    # If window not found
+    if not (window_descriptor := ctypes.windll.user32.FindWindowW(None, window_title)):
+        raise ctypes.WinError(descr="Unable to find window with `%s` title" % window_title)
+
+    # If unable to retrieve physical dispaly resolutions
+    if not ctypes.windll.user32.EnumDisplaySettingsW(None, 0xFFFFFFFF, ctypes.byref(devmode := DevMode(dmSize=ctypes.sizeof(DevMode), dmFields=0x00040000 | 0x00080000))):
+        raise ctypes.WinError(descr="Unable to retrieve physical display information")
+
+    # If unable to retrieve window information
+    if ctypes.windll.dwmapi.DwmGetWindowAttribute(window_descriptor, 9, ctypes.byref(window_rect := Rect()), ctypes.sizeof(window_rect)):
+        raise ctypes.WinError(descr="Unable to retrieve information for window with `%s` title" % window_title)
+
+    # Result dict
+    result = {"visible_area": {"x": 0, "y": 0, "w": 0, "h": 0}}
+
+    # Visible area of window section
+    visible_area = result["visible_area"]
+
+    # Save window position
+    result["x"] = window_rect.left
+    result["y"] = window_rect.top
+
+    # Save window size
+    result["w"] = window_rect.right - window_rect.left
+    result["h"] = window_rect.bottom - window_rect.top
+
+    # Get window visible area horizontaly
+    if result["x"] < 0:
+        visible_area["x"] = 0
+        visible_area["w"] = result["w"] + result["x"]
+
+    elif result["x"] + result["w"] > devmode.dm_pels_width:
+        visible_area["x"] = result["x"]
+        visible_area["w"] = result["w"] - (result["w"] + result["x"] - devmode.dm_pels_width)
+
+    else:
+        visible_area["x"] = result["x"]
+        visible_area["w"] = result["w"]
+
+    # Get window visible area verticaly
+    if result["y"] < 0:
+        visible_area["y"] = 0
+        visible_area["h"] = result["h"] + result["y"]
+
+    elif result["y"] + result["h"] > devmode.dm_pels_height:
+        visible_area["y"] = result["y"]
+        visible_area["h"] = result["h"] - (result["h"] + result["y"] - devmode.dm_pels_height)
+
+    else:
+        visible_area["y"] = result["y"]
+        visible_area["h"] = result["h"]
+
+    return result