MaaFw 4.5.5__py3-none-manylinux2014_x86_64.whl → 5.4.0__py3-none-manylinux2014_x86_64.whl

maa/controller.py

@@ -1,12 +1,13 @@
 import json
+import os
+import numpy
 from abc import abstractmethod
 from ctypes import c_int32
-import os
 from pathlib import Path
-from typing import Any, Dict, Optional, Union
+from typing import Any, Dict, Optional, Tuple, Union
 
 from .buffer import ImageBuffer, StringBuffer
-from .notification_handler import NotificationHandler
+from .event_sink import EventSink, NotificationType
 from .define import *
 from .job import Job, JobWithResult
 from .library import Library
@@ -14,13 +15,14 @@ from .library import Library
 __all__ = [
     "AdbController",
     "DbgController",
+    "PlayCoverController",
     "Win32Controller",
+    "GamepadController",
     "CustomController",
 ]
 
 
 class Controller:
-    _notification_handler: Optional[NotificationHandler]
     _handle: MaaControllerHandle
     _own: bool
 
@@ -42,16 +44,63 @@ class Controller:
             Library.framework().MaaControllerDestroy(self._handle)
 
     def post_connection(self) -> Job:
+        """异步连接设备 / Asynchronously connect device
+
+        这是一个异步操作，会立即返回一个 Job 对象
+        This is an asynchronous operation that immediately returns a Job object
+
+        Returns:
+            Job: 作业对象，可通过 status/wait 查询状态 / Job object, can query status via status/wait
+        """
         ctrl_id = Library.framework().MaaControllerPostConnection(self._handle)
         return self._gen_ctrl_job(ctrl_id)
 
-    def post_click(self, x: int, y: int) -> Job:
-        ctrl_id = Library.framework().MaaControllerPostClick(self._handle, x, y)
+    def post_click(self, x: int, y: int, contact: int = 0, pressure: int = 1) -> Job:
+        """异步点击 / Asynchronously click
+
+        这是一个异步操作，会立即返回一个 Job 对象
+        This is an asynchronous operation that immediately returns a Job object
+
+        Args:
+            x: x 坐标 / x coordinate
+            y: y 坐标 / y coordinate
+            contact: 触点编号 (Adb 控制器: 手指编号; Win32 控制器: 鼠标按键 0:左键, 1:右键, 2:中键) / Contact number (Adb controller: finger number; Win32 controller: mouse button 0:left, 1:right, 2:middle)
+            pressure: 触点力度 / Contact pressure
+
+        Returns:
+            Job: 作业对象，可通过 status/wait 查询状态 / Job object, can query status via status/wait
+        """
+        ctrl_id = Library.framework().MaaControllerPostClickV2(
+            self._handle, x, y, contact, pressure
+        )
         return self._gen_ctrl_job(ctrl_id)
 
-    def post_swipe(self, x1: int, y1: int, x2: int, y2: int, duration: int) -> Job:
-        ctrl_id = Library.framework().MaaControllerPostSwipe(
-            self._handle, x1, y1, x2, y2, duration
+    def post_swipe(
+        self,
+        x1: int,
+        y1: int,
+        x2: int,
+        y2: int,
+        duration: int,
+        contact: int = 0,
+        pressure: int = 1,
+    ) -> Job:
+        """滑动 / Swipe
+
+        Args:
+            x1: 起点 x 坐标 / Start x coordinate
+            y1: 起点 y 坐标 / Start y coordinate
+            x2: 终点 x 坐标 / End x coordinate
+            y2: 终点 y 坐标 / End y coordinate
+            duration: 滑动时长(毫秒) / Swipe duration in milliseconds
+            contact: 触点编号 (Adb 控制器: 手指编号; Win32 控制器: 鼠标按键 0:左键, 1:右键, 2:中键) / Contact number (Adb controller: finger number; Win32 controller: mouse button 0:left, 1:right, 2:middle)
+            pressure: 触点力度 / Contact pressure
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
+        ctrl_id = Library.framework().MaaControllerPostSwipeV2(
+            self._handle, x1, y1, x2, y2, duration, contact, pressure
         )
         return self._gen_ctrl_job(ctrl_id)
 
@@ -62,30 +111,78 @@ class Controller:
         return self.post_click_key(key)
 
     def post_click_key(self, key: int) -> Job:
+        """单击按键 / Click key
+
+        Args:
+            key: 虚拟键码 / Virtual key code
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostClickKey(self._handle, key)
         return self._gen_ctrl_job(ctrl_id)
 
     def post_key_down(self, key: int) -> Job:
+        """按下键 / Key down
+
+        Args:
+            key: 虚拟键码 / Virtual key code
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostKeyDown(self._handle, key)
         return self._gen_ctrl_job(ctrl_id)
 
     def post_key_up(self, key: int) -> Job:
+        """抬起键 / Key up
+
+        Args:
+            key: 虚拟键码 / Virtual key code
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostKeyUp(self._handle, key)
         return self._gen_ctrl_job(ctrl_id)
 
     def post_input_text(self, text: str) -> Job:
+        """输入文本 / Input text
+
+        Args:
+            text: 要输入的文本 / Text to input
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostInputText(
             self._handle, text.encode()
         )
         return self._gen_ctrl_job(ctrl_id)
 
     def post_start_app(self, intent: str) -> Job:
+        """启动应用 / Start app
+
+        Args:
+            intent: 目标应用 (Adb 控制器: package name 或 activity) / Target app (Adb controller: package name or activity)
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostStartApp(
             self._handle, intent.encode()
         )
         return self._gen_ctrl_job(ctrl_id)
 
     def post_stop_app(self, intent: str) -> Job:
+        """关闭应用 / Stop app
+
+        Args:
+            intent: 目标应用 (Adb 控制器: package name) / Target app (Adb controller: package name)
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostStopApp(
             self._handle, intent.encode()
         )
@@ -94,6 +191,17 @@ class Controller:
     def post_touch_down(
         self, x: int, y: int, contact: int = 0, pressure: int = 1
     ) -> Job:
+        """按下 / Touch down
+
+        Args:
+            x: x 坐标 / x coordinate
+            y: y 坐标 / y coordinate
+            contact: 触点编号 (Adb 控制器: 手指编号; Win32 控制器: 鼠标按键 0:左键, 1:右键, 2:中键) / Contact number (Adb controller: finger number; Win32 controller: mouse button 0:left, 1:right, 2:middle)
+            pressure: 触点力度 / Contact pressure
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostTouchDown(
             self._handle, contact, x, y, pressure
         )
@@ -102,16 +210,57 @@ class Controller:
     def post_touch_move(
         self, x: int, y: int, contact: int = 0, pressure: int = 1
     ) -> Job:
+        """移动 / Move
+
+        Args:
+            x: x 坐标 / x coordinate
+            y: y 坐标 / y coordinate
+            contact: 触点编号 (Adb 控制器: 手指编号; Win32 控制器: 鼠标按键 0:左键, 1:右键, 2:中键) / Contact number (Adb controller: finger number; Win32 controller: mouse button 0:left, 1:right, 2:middle)
+            pressure: 触点力度 / Contact pressure
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostTouchMove(
             self._handle, contact, x, y, pressure
         )
         return self._gen_ctrl_job(ctrl_id)
 
     def post_touch_up(self, contact: int = 0) -> Job:
+        """抬起 / Touch up
+
+        Args:
+            contact: 触点编号 (Adb 控制器: 手指编号; Win32 控制器: 鼠标按键 0:左键, 1:右键, 2:中键) / Contact number (Adb controller: finger number; Win32 controller: mouse button 0:left, 1:right, 2:middle)
+
+        Returns:
+            Job: 作业对象 / Job object
+        """
         ctrl_id = Library.framework().MaaControllerPostTouchUp(self._handle, contact)
         return self._gen_ctrl_job(ctrl_id)
 
+    def post_scroll(self, dx: int, dy: int) -> Job:
+        """滚动 / Scroll
+
+        Args:
+            dx: 水平滚动距离，正值向右滚动，负值向左滚动 / Horizontal scroll distance, positive for right, negative for left
+            dy: 垂直滚动距离，正值向上滚动，负值向下滚动 / Vertical scroll distance, positive for up, negative for down
+
+        Returns:
+            Job: 作业对象 / Job object
+
+        Note:
+            不是所有控制器都支持滚动操作 / Not all controllers support scroll operation
+            建议使用 120 的整数倍（WHEEL_DELTA）以获得最佳兼容性 / Using multiples of 120 (WHEEL_DELTA) is recommended
+        """
+        ctrl_id = Library.framework().MaaControllerPostScroll(self._handle, dx, dy)
+        return self._gen_ctrl_job(ctrl_id)
+
     def post_screencap(self) -> JobWithResult:
+        """截图 / Screenshot
+
+        Returns:
+            JobWithResult: 作业对象，可通过 result 获取截图 / Job object, can get screenshot via result
+        """
         ctrl_id = Library.framework().MaaControllerPostScreencap(self._handle)
         return JobWithResult(
             ctrl_id,
@@ -122,6 +271,22 @@ class Controller:
 
     @property
     def cached_image(self) -> numpy.ndarray:
+        """获取最新一次截图 / Get the latest screenshot
+
+        Returns:
+            numpy.ndarray: 截图图像 / Screenshot image
+
+        Raises:
+            RuntimeError: 如果获取失败
+
+        Note:
+            返回的图像是经过缩放的，尺寸根据截图目标尺寸设置（长边/短边）而定，可能与设备原始分辨率不同。
+            使用 resolution 属性可获取设备的原始（未缩放）分辨率。
+
+            The returned image is scaled according to the screenshot target size settings (long side / short side).
+            The image dimensions may differ from the raw device resolution.
+            Use the resolution property to get the raw (unscaled) device resolution.
+        """
         image_buffer = ImageBuffer()
         if not Library.framework().MaaControllerCachedImage(
             self._handle, image_buffer._handle
@@ -129,18 +294,101 @@ class Controller:
             raise RuntimeError("Failed to get cached image.")
         return image_buffer.get()
 
+    def post_shell(self, cmd: str, timeout: int = 20000) -> JobWithResult:
+        """执行 shell 命令 (仅 ADB 控制器) / Execute shell command (ADB only)
+
+        Args:
+            cmd: shell 命令 / shell command
+            timeout: 超时时间（毫秒），默认 20000 / Timeout in milliseconds, default 20000
+
+        Returns:
+            JobWithResult: 作业对象，可通过 result 获取命令输出 / Job object, can get output via result
+        """
+        ctrl_id = Library.framework().MaaControllerPostShell(
+            self._handle, cmd.encode("utf-8"), timeout
+        )
+        return JobWithResult(
+            ctrl_id,
+            self._status,
+            self._wait,
+            self._get_shell_output,
+        )
+
+    @property
+    def shell_output(self) -> str:
+        """获取最近一次 shell 命令输出 / Get the latest shell command output
+
+        Returns:
+            str: shell 命令输出 / shell command output
+
+        Raises:
+            RuntimeError: 如果获取失败
+        """
+        string_buffer = StringBuffer()
+        if not Library.framework().MaaControllerGetShellOutput(
+            self._handle, string_buffer._handle
+        ):
+            raise RuntimeError("Failed to get shell output.")
+        return string_buffer.get()
+
     @property
     def connected(self) -> bool:
+        """判断是否已连接 / Check if connected
+
+        Returns:
+            bool: 是否已连接 / Whether connected
+        """
         return bool(Library.framework().MaaControllerConnected(self._handle))
 
     @property
     def uuid(self) -> str:
+        """获取设备 uuid / Get device uuid
+
+        Returns:
+            str: 设备 uuid / Device uuid
+
+        Raises:
+            RuntimeError: 如果获取失败
+        """
         buffer = StringBuffer()
         if not Library.framework().MaaControllerGetUuid(self._handle, buffer._handle):
             raise RuntimeError("Failed to get UUID.")
         return buffer.get()
 
+    @property
+    def resolution(self) -> Tuple[int, int]:
+        """获取设备原始（未缩放）分辨率 / Get the raw (unscaled) device resolution
+
+        Returns:
+            Tuple[int, int]: (宽度, 高度)，获取失败时返回 (0, 0) / (width, height), returns (0, 0) on failure
+
+        Note:
+            返回的是设备屏幕的实际分辨率，未经任何缩放处理。
+            而通过 cached_image 获取的截图是经过缩放的，其尺寸可能与此原始分辨率不同。
+            需要在首次截图后才能获取到有效值，否则返回 (0, 0)。
+
+            This returns the actual device screen resolution before any scaling.
+            The screenshot obtained via cached_image is scaled according to the screenshot target size settings,
+            so its dimensions may differ from this raw resolution.
+            Valid values are only available after the first screenshot is taken, otherwise returns (0, 0).
+        """
+        width = ctypes.c_int32()
+        height = ctypes.c_int32()
+        if not Library.framework().MaaControllerGetResolution(
+            self._handle, ctypes.byref(width), ctypes.byref(height)
+        ):
+            return (0, 0)
+        return (width.value, height.value)
+
     def set_screenshot_target_long_side(self, long_side: int) -> bool:
+        """设置截图缩放长边到指定长度 / Set screenshot scaling long side to specified length
+
+        Args:
+            long_side: 长边长度 / Long side length
+
+        Returns:
+            bool: 是否成功 / Whether successful
+        """
         cint = ctypes.c_int32(long_side)
         return bool(
             Library.framework().MaaControllerSetOption(
@@ -152,6 +400,14 @@ class Controller:
         )
 
     def set_screenshot_target_short_side(self, short_side: int) -> bool:
+        """设置截图缩放短边到指定长度 / Set screenshot scaling short side to specified length
+
+        Args:
+            short_side: 短边长度 / Short side length
+
+        Returns:
+            bool: 是否成功 / Whether successful
+        """
         cint = ctypes.c_int32(short_side)
         return bool(
             Library.framework().MaaControllerSetOption(
@@ -163,6 +419,17 @@ class Controller:
         )
 
     def set_screenshot_use_raw_size(self, enable: bool) -> bool:
+        """设置截图不缩放 / Set screenshot use raw size without scaling
+
+        注意：此选项可能导致在不同分辨率的设备上坐标不正确
+        Note: This option may cause incorrect coordinates on devices with different resolutions
+
+        Args:
+            enable: 是否启用 / Whether to enable
+
+        Returns:
+            bool: 是否成功 / Whether successful
+        """
         cbool = MaaBool(enable)
         return bool(
             Library.framework().MaaControllerSetOption(
@@ -173,6 +440,41 @@ class Controller:
             )
         )
 
+    _sink_holder: Dict[int, "ControllerEventSink"] = {}
+
+    def add_sink(self, sink: "ControllerEventSink") -> Optional[int]:
+        """添加控制器事件监听器 / Add controller event listener
+
+        Args:
+            sink: 事件监听器 / Event sink
+
+        Returns:
+            Optional[int]: 监听器 id，失败返回 None / Listener id, or None if failed
+        """
+        sink_id = int(
+            Library.framework().MaaControllerAddSink(
+                self._handle, *EventSink._gen_c_param(sink)
+            )
+        )
+        if sink_id == MaaInvalidId:
+            return None
+
+        self._sink_holder[sink_id] = sink
+        return sink_id
+
+    def remove_sink(self, sink_id: int) -> None:
+        """移除控制器事件监听器 / Remove controller event listener
+
+        Args:
+            sink_id: 监听器 id / Listener id
+        """
+        Library.framework().MaaControllerRemoveSink(self._handle, sink_id)
+        self._sink_holder.pop(sink_id)
+
+    def clear_sinks(self) -> None:
+        """清除所有控制器事件监听器 / Clear all controller event listeners"""
+        Library.framework().MaaControllerClearSinks(self._handle)
+
     ### private ###
 
     def _status(self, maaid: int) -> MaaStatus:
@@ -184,6 +486,9 @@ class Controller:
     def _get_screencap(self, _: int) -> numpy.ndarray:
         return self.cached_image
 
+    def _get_shell_output(self, _: int) -> str:
+        return self.shell_output
+
     def _gen_ctrl_job(self, ctrlid: MaaCtrlId) -> Job:
         return Job(
             ctrlid,
@@ -220,6 +525,15 @@ class Controller:
             c_int32,
         ]
 
+        Library.framework().MaaControllerPostClickV2.restype = MaaCtrlId
+        Library.framework().MaaControllerPostClickV2.argtypes = [
+            MaaControllerHandle,
+            c_int32,
+            c_int32,
+            c_int32,
+            c_int32,
+        ]
+
         Library.framework().MaaControllerPostSwipe.restype = MaaCtrlId
         Library.framework().MaaControllerPostSwipe.argtypes = [
             MaaControllerHandle,
@@ -230,6 +544,18 @@ class Controller:
             c_int32,
         ]
 
+        Library.framework().MaaControllerPostSwipeV2.restype = MaaCtrlId
+        Library.framework().MaaControllerPostSwipeV2.argtypes = [
+            MaaControllerHandle,
+            c_int32,
+            c_int32,
+            c_int32,
+            c_int32,
+            c_int32,
+            c_int32,
+            c_int32,
+        ]
+
         Library.framework().MaaControllerPostClickKey.restype = MaaCtrlId
         Library.framework().MaaControllerPostClickKey.argtypes = [
             MaaControllerHandle,
@@ -292,6 +618,14 @@ class Controller:
             MaaControllerHandle,
             c_int32,
         ]
+
+        Library.framework().MaaControllerPostScroll.restype = MaaCtrlId
+        Library.framework().MaaControllerPostScroll.argtypes = [
+            MaaControllerHandle,
+            c_int32,
+            c_int32,
+        ]
+
         Library.framework().MaaControllerStatus.restype = MaaStatus
         Library.framework().MaaControllerStatus.argtypes = [
             MaaControllerHandle,
@@ -319,8 +653,37 @@ class Controller:
             MaaStringBufferHandle,
         ]
 
+        Library.framework().MaaControllerGetResolution.restype = MaaBool
+        Library.framework().MaaControllerGetResolution.argtypes = [
+            MaaControllerHandle,
+            ctypes.POINTER(ctypes.c_int32),
+            ctypes.POINTER(ctypes.c_int32),
+        ]
+
+        Library.framework().MaaControllerAddSink.restype = MaaSinkId
+        Library.framework().MaaControllerAddSink.argtypes = [
+            MaaControllerHandle,
+            MaaEventCallback,
+            ctypes.c_void_p,
+        ]
+
+        Library.framework().MaaControllerRemoveSink.restype = None
+        Library.framework().MaaControllerRemoveSink.argtypes = [
+            MaaControllerHandle,
+            MaaSinkId,
+        ]
+
+        Library.framework().MaaControllerClearSinks.restype = None
+        Library.framework().MaaControllerClearSinks.argtypes = [MaaControllerHandle]
+
 
 class AdbController(Controller):
+    """Adb 控制器 / Adb controller
+
+    截图方式和输入方式会在启动时进行测速, 选择最快的方案
+    Screenshot and input methods will be speed tested at startup, selecting the fastest option
+    """
+
     AGENT_BINARY_PATH = os.path.join(
         os.path.dirname(__file__),
         "../MaaAgentBinary",
@@ -334,13 +697,23 @@ class AdbController(Controller):
         input_methods: int = MaaAdbInputMethodEnum.Default,
         config: Dict[str, Any] = {},
         agent_path: Union[str, Path] = AGENT_BINARY_PATH,
-        notification_handler: Optional[NotificationHandler] = None,
     ):
+        """创建 Adb 控制器 / Create Adb controller
+
+        Args:
+            adb_path: adb 路径 / adb path
+            address: 连接地址 / connection address
+            screencap_methods: 所有可使用的截图方式 / all available screenshot methods
+            input_methods: 所有可使用的输入方式 / all available input methods
+            config: 额外配置 / extra config
+            agent_path: MaaAgentBinary 路径 / MaaAgentBinary path
+
+        Raises:
+            RuntimeError: 如果创建失败
+        """
         super().__init__()
         self._set_adb_api_properties()
 
-        self._notification_handler = notification_handler
-
         self._handle = Library.framework().MaaAdbControllerCreate(
             str(adb_path).encode(),
             address.encode(),
@@ -348,7 +721,6 @@ class AdbController(Controller):
             MaaAdbInputMethod(input_methods),
             json.dumps(config, ensure_ascii=False).encode(),
             str(agent_path).encode(),
-            *NotificationHandler._gen_c_param(self._notification_handler)
         )
 
         if not self._handle:
@@ -364,29 +736,38 @@ class AdbController(Controller):
             MaaAdbInputMethod,
             ctypes.c_char_p,
             ctypes.c_char_p,
-            MaaNotificationCallback,
-            ctypes.c_void_p,
         ]
 
 
 class Win32Controller(Controller):
+    """Win32 控制器 / Win32 controller"""
 
     def __init__(
         self,
         hWnd: Union[ctypes.c_void_p, int, None],
-        screencap_method: int = MaaWin32ScreencapMethodEnum.DXGI_DesktopDup,
-        input_method: int = MaaWin32InputMethodEnum.Seize,
-        notification_handler: Optional[NotificationHandler] = None,
+        screencap_method: int = MaaWin32ScreencapMethodEnum.FramePool,
+        mouse_method: int = MaaWin32InputMethodEnum.Seize,
+        keyboard_method: int = MaaWin32InputMethodEnum.Seize,
     ):
+        """创建 Win32 控制器 / Create Win32 controller
+
+        Args:
+            hWnd: 窗口句柄 / window handle
+            screencap_method: 使用的截图方式 / screenshot method used
+            mouse_method: 使用的鼠标输入方式 / mouse input method used
+            keyboard_method: 使用的键盘输入方式 / keyboard input method used
+
+        Raises:
+            RuntimeError: 如果创建失败
+        """
         super().__init__()
         self._set_win32_api_properties()
 
-        self._notification_handler = notification_handler
         self._handle = Library.framework().MaaWin32ControllerCreate(
             hWnd,
             MaaWin32ScreencapMethod(screencap_method),
-            MaaWin32InputMethod(input_method),
-            *NotificationHandler._gen_c_param(self._notification_handler)
+            MaaWin32InputMethod(mouse_method),
+            MaaWin32InputMethod(keyboard_method),
         )
 
         if not self._handle:
@@ -398,12 +779,52 @@ class Win32Controller(Controller):
             ctypes.c_void_p,
             MaaWin32ScreencapMethod,
             MaaWin32InputMethod,
-            MaaNotificationCallback,
-            ctypes.c_void_p,
+            MaaWin32InputMethod,
+        ]
+
+
+class PlayCoverController(Controller):
+    """PlayCover 控制器 / PlayCover controller
+
+    用于在 macOS 上控制通过 PlayCover 运行的 iOS 应用
+    For controlling iOS apps running via PlayCover on macOS
+    """
+
+    def __init__(
+        self,
+        address: str,
+        uuid: str,
+    ):
+        """创建 PlayCover 控制器 / Create PlayCover controller
+
+        Args:
+            address: PlayTools 服务地址 (host:port) / PlayTools service endpoint (host:port)
+            uuid: 目标应用 bundle identifier / Target app bundle identifier
+
+        Raises:
+            RuntimeError: 如果创建失败
+        """
+        super().__init__()
+        self._set_playcover_api_properties()
+
+        self._handle = Library.framework().MaaPlayCoverControllerCreate(
+            address.encode(),
+            uuid.encode(),
+        )
+
+        if not self._handle:
+            raise RuntimeError("Failed to create PlayCover controller.")
+
+    def _set_playcover_api_properties(self):
+        Library.framework().MaaPlayCoverControllerCreate.restype = MaaControllerHandle
+        Library.framework().MaaPlayCoverControllerCreate.argtypes = [
+            ctypes.c_char_p,
+            ctypes.c_char_p,
         ]
 
 
 class DbgController(Controller):
+    """调试控制器 / Debug controller"""
 
     def __init__(
         self,
@@ -411,18 +832,26 @@ class DbgController(Controller):
         write_path: Union[str, Path],
         dbg_type: int,
         config: Dict[str, Any] = {},
-        notification_handler: Optional[NotificationHandler] = None,
     ):
+        """创建调试控制器 / Create debug controller
+
+        Args:
+            read_path: 输入路径, 包含通过 Recording 选项记录的操作 / Input path, includes operations recorded via Recording option
+            write_path: 输出路径, 包含执行结果 / Output path, includes execution results
+            dbg_type: 控制器模式 / Controller mode
+            config: 额外配置 / Extra config
+
+        Raises:
+            RuntimeError: 如果创建失败
+        """
         super().__init__()
         self._set_dbg_api_properties()
 
-        self._notification_handler = notification_handler
         self._handle = Library.framework().MaaDbgControllerCreate(
             str(read_path).encode(),
             str(write_path).encode(),
             MaaDbgControllerType(dbg_type),
             json.dumps(config, ensure_ascii=False).encode(),
-            *NotificationHandler._gen_c_param(self._notification_handler)
         )
 
         if not self._handle:
@@ -435,27 +864,77 @@ class DbgController(Controller):
             ctypes.c_char_p,
             MaaDbgControllerType,
             ctypes.c_char_p,
-            MaaNotificationCallback,
-            ctypes.c_void_p,
         ]
 
 
-class CustomController(Controller):
+class GamepadController(Controller):
+    """虚拟手柄控制器 (仅 Windows) / Virtual gamepad controller (Windows only)
 
-    _callbacks: MaaCustomControllerCallbacks
+    通过 ViGEm 模拟 Xbox 360 或 DualShock 4 手柄，用于控制需要手柄输入的游戏。
+    Emulates Xbox 360 or DualShock 4 gamepad via ViGEm for controlling games that require gamepad input.
+
+    需要安装 ViGEm Bus Driver: https://github.com/ViGEm/ViGEmBus/releases
+    Requires ViGEm Bus Driver: https://github.com/ViGEm/ViGEmBus/releases
+
+    手柄操作映射:
+    - click_key/key_down/key_up: 数字按键 (使用 MaaGamepadButtonEnum)
+    - touch_down/touch_move/touch_up: 摇杆和扳机 (contact 使用 MaaGamepadContactEnum)
+      - contact 0: 左摇杆 (x, y: -32768~32767)
+      - contact 1: 右摇杆 (x, y: -32768~32767)
+      - contact 2: 左扳机 (pressure: 0~255)
+      - contact 3: 右扳机 (pressure: 0~255)
+    """
 
     def __init__(
         self,
-        notification_handler: Optional[NotificationHandler] = None,
+        hWnd: Union[ctypes.c_void_p, int, None],
+        gamepad_type: int = MaaGamepadTypeEnum.Xbox360,
+        screencap_method: int = MaaWin32ScreencapMethodEnum.FramePool,
     ):
+        """创建虚拟手柄控制器 / Create virtual gamepad controller
+
+        Args:
+            hWnd: 窗口句柄，用于截图 (可为 None，不需要截图时) / Window handle for screencap (can be None if screencap not needed)
+            gamepad_type: 手柄类型 (MaaGamepadTypeEnum.Xbox360 或 MaaGamepadTypeEnum.DualShock4) / Gamepad type
+            screencap_method: 截图方式 (当 hWnd 不为 None 时使用) / Screencap method (used when hWnd is not None)
+
+        Raises:
+            RuntimeError: 如果创建失败
+        """
         super().__init__()
-        self._set_custom_api_properties()
+        self._set_gamepad_api_properties()
+
+        self._handle = Library.framework().MaaGamepadControllerCreate(
+            hWnd,
+            MaaGamepadType(gamepad_type),
+            MaaWin32ScreencapMethod(screencap_method),
+        )
+
+        if not self._handle:
+            raise RuntimeError("Failed to create Gamepad controller.")
+
+    def _set_gamepad_api_properties(self):
+        Library.framework().MaaGamepadControllerCreate.restype = MaaControllerHandle
+        Library.framework().MaaGamepadControllerCreate.argtypes = [
+            ctypes.c_void_p,
+            MaaGamepadType,
+            MaaWin32ScreencapMethod,
+        ]
+
+
+class CustomController(Controller):
+
+    _callbacks: MaaCustomControllerCallbacks
 
-        self._notification_handler = notification_handler
+    def __init__(self):
+        super().__init__()
+        self._set_custom_api_properties()
 
         self._callbacks = MaaCustomControllerCallbacks(
             CustomController._c_connect_agent,
+            CustomController._c_connected_agent,
             CustomController._c_request_uuid_agent,
+            CustomController._c_get_features_agent,
             CustomController._c_start_app_agent,
             CustomController._c_stop_app_agent,
             CustomController._c_screencap_agent,
@@ -468,12 +947,12 @@ class CustomController(Controller):
             CustomController._c_input_text_agent,
             CustomController._c_key_down_agent,
             CustomController._c_key_up_agent,
+            CustomController._c_scroll_agent,
         )
 
         self._handle = Library.framework().MaaCustomControllerCreate(
             self.c_handle,
             self.c_arg,
-            *NotificationHandler._gen_c_param(self._notification_handler)
         )
 
         if not self._handle:
@@ -491,10 +970,20 @@ class CustomController(Controller):
     def connect(self) -> bool:
         raise NotImplementedError
 
+    def connected(self) -> bool:
+        """检查是否已连接（可选实现，默认返回 True）"""
+        return True
+
     @abstractmethod
     def request_uuid(self) -> str:
         raise NotImplementedError
 
+    def get_features(self) -> int:
+        return (
+            MaaControllerFeatureEnum.UseMouseDownAndUpInsteadOfClick
+            | MaaControllerFeatureEnum.UseKeyboardDownAndUpInsteadOfClick
+        )
+
     @abstractmethod
     def start_app(self, intent: str) -> bool:
         raise NotImplementedError
@@ -555,6 +1044,10 @@ class CustomController(Controller):
     def key_up(self, keycode: int) -> bool:
         raise NotImplementedError
 
+    @abstractmethod
+    def scroll(self, dx: int, dy: int) -> bool:
+        raise NotImplementedError
+
     @staticmethod
     @MaaCustomControllerCallbacks.ConnectFunc
     def _c_connect_agent(
@@ -570,6 +1063,21 @@ class CustomController(Controller):
 
         return int(self.connect())
 
+    @staticmethod
+    @MaaCustomControllerCallbacks.ConnectedFunc
+    def _c_connected_agent(
+        trans_arg: ctypes.c_void_p,
+    ) -> int:
+        if not trans_arg:
+            return int(False)
+
+        self: CustomController = ctypes.cast(
+            trans_arg,
+            ctypes.py_object,
+        ).value
+
+        return int(self.connected())
+
     @staticmethod
     @MaaCustomControllerCallbacks.RequestUuidFunc
     def _c_request_uuid_agent(
@@ -590,6 +1098,19 @@ class CustomController(Controller):
         uuid_buffer.set(uuid)
         return int(True)
 
+    @staticmethod
+    @MaaCustomControllerCallbacks.GetFeaturesFunc
+    def _c_get_features_agent(trans_arg: ctypes.c_void_p) -> int:
+        if not trans_arg:
+            return int(MaaControllerFeatureEnum.Null)
+
+        self: CustomController = ctypes.cast(
+            trans_arg,
+            ctypes.py_object,
+        ).value
+
+        return int(self.get_features())
+
     @staticmethod
     @MaaCustomControllerCallbacks.StartAppFunc
     def _c_start_app_agent(
@@ -800,11 +1321,65 @@ class CustomController(Controller):
 
         return int(self.input_text(c_text.decode()))
 
+    @staticmethod
+    @MaaCustomControllerCallbacks.ScrollFunc
+    def _c_scroll_agent(
+        c_dx: ctypes.c_int32,
+        c_dy: ctypes.c_int32,
+        trans_arg: ctypes.c_void_p,
+    ) -> int:
+        if not trans_arg:
+            return int(False)
+
+        self: CustomController = ctypes.cast(
+            trans_arg,
+            ctypes.py_object,
+        ).value
+
+        return int(self.scroll(int(c_dx), int(c_dy)))
+
     def _set_custom_api_properties(self):
         Library.framework().MaaCustomControllerCreate.restype = MaaControllerHandle
         Library.framework().MaaCustomControllerCreate.argtypes = [
             ctypes.POINTER(MaaCustomControllerCallbacks),
             ctypes.c_void_p,
-            MaaNotificationCallback,
-            ctypes.c_void_p,
         ]
+
+
+class ControllerEventSink(EventSink):
+
+    @dataclass
+    class ControllerActionDetail:
+        ctrl_id: int
+        uuid: str
+        action: str
+        param: dict
+
+    def on_controller_action(
+        self,
+        controller: Controller,
+        noti_type: NotificationType,
+        detail: ControllerActionDetail,
+    ):
+        pass
+
+    def on_raw_notification(self, controller: Controller, msg: str, details: dict):
+        pass
+
+    def _on_raw_notification(self, handle: ctypes.c_void_p, msg: str, details: dict):
+
+        controller = Controller(handle=handle)
+        self.on_raw_notification(controller, msg, details)
+
+        noti_type = EventSink._notification_type(msg)
+        if msg.startswith("Controller.Action"):
+            detail = self.ControllerActionDetail(
+                ctrl_id=details["ctrl_id"],
+                uuid=details["uuid"],
+                action=details["action"],
+                param=details["param"],
+            )
+            self.on_controller_action(controller, noti_type, detail)
+
+        else:
+            self.on_unknown_notification(controller, msg, details)