feat: GRPC

.clang-format

@@ -2,6 +2,8 @@ Language: Json
 ColumnLimit: 1000
 IndentWidth: 4
 ---
+Language: Proto
+---
 Language: Cpp
 AccessModifierOffset: -4
 AlignAfterOpenBracket: Align

.github/workflows/ci.yml

@@ -71,6 +71,24 @@ jobs:
       fail-fast: false
 
     steps:
+      - name: Windows runner hack
+        shell: cmd
+        run: |
+          dir d:\a
+          cd ..
+          mkdir C:\MaaFramework
+          rmdir MaaFramework
+          mklink /j MaaFramework C:\MaaFramework
+          dism /Online /Disable-Feature /FeatureName:Windows-Defender /Remove /NoRestart /Quiet
+          cd .
+
+      - name: Windows runner hack (2)
+        uses: al-cheb/[email protected]
+        with:
+          minimum-size: 16GB
+          maximum-size: 16GB
+          disk-root: "D:"
+
       - uses: actions/checkout@v3
         with:
           submodules: true
@@ -273,7 +291,6 @@ jobs:
           name: MAA-nupkgs
           path: "pkgs/nupkgs/*.nupkg"
 
-
   release:
     if: ${{ needs.meta.outputs.is_release == 'true' }}
     needs: [meta, windows, ubuntu, macos, nuget_pack]
@@ -299,7 +316,7 @@ jobs:
           for f in *; do
             (cd $f && zip -r ../$f-${{ needs.meta.outputs.tag }}.zip .)
           done
-      
+
       - uses: softprops/action-gh-release@v1
         with:
           files: assets/*.zip

.gitmodules

@@ -1,6 +1,7 @@
 [submodule "MaaDeps"]
 	path = MaaDeps
 	url = https://github.com/MaaAssistantArknights/MaaDeps.git
+  branch = grpc
 [submodule "assets/config/MaaAgentBinary"]
 	path = assets/config/MaaAgentBinary
 	url = https://github.com/MaaAssistantArknights/MaaAgentBinary.git

CMakeLists.txt

@@ -14,6 +14,7 @@ set(Boost_NO_WARN_NEW_VERSIONS 1)
 option(BUILD_SAMPLE "build a demo" OFF)
 option(USE_MAADEPS "use third-party libraries built by MaaDeps" ON)
 option(WITH_THRIFT "build with thrift" ON)
+option(WITH_GRPC "build with protobuf and grpc" ON)
 option(BUILD_JAVASCRIPT "build JavaScript binding extras" OFF)
 
 include(${PROJECT_SOURCE_DIR}/cmake/config.cmake) # Basic compile & link configuration
@@ -35,6 +36,10 @@ find_package(MaaDerpLearning REQUIRED)
 if(WITH_THRIFT)
     find_package(Thrift CONFIG REQUIRED)
 endif(WITH_THRIFT)
+if(WITH_GRPC)
+    find_package(protobuf REQUIRED)
+    find_package(gRPC CONFIG REQUIRED)
+endif(WITH_GRPC)
 find_package(ONNXRuntime)
 
 add_subdirectory(3rdparty)

include/Interface/proto/buffer.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+
+message ImageInfoResponse {
+  optional int32 type = 1;
+  optional Size size = 2;
+}
+
+service Image {
+  rpc create(EmptyRequest) returns (HandleResponse);
+  rpc destroy(HandleRequest) returns (EmptyResponse);
+  rpc is_empty(HandleRequest) returns (BoolResponse);
+  rpc clear(HandleRequest) returns (EmptyResponse);
+  rpc info(HandleRequest) returns (ImageInfoResponse);
+  rpc encoded(HandleRequest) returns (BufferResponse);
+  rpc set_encoded(HandleBufferRequest) returns (BoolResponse);
+}

include/Interface/proto/config.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+
+service Config {
+  rpc init(EmptyRequest) returns (EmptyResponse);
+  rpc uninit(EmptyRequest) returns (EmptyResponse);
+
+  rpc get_custom(StringRequest) returns (StringResponse);
+  rpc set_custom(KeyValueRequest) returns (EmptyResponse);
+
+  rpc config_size(EmptyRequest) returns (SizeResponse);
+}

include/Interface/proto/controller.proto

@@ -0,0 +1,69 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+import "custom.controller.proto";
+
+message AdbControllerRequest {
+  optional string id = 1;
+  optional string adb_path = 2;
+  optional string adb_serial = 3;
+  optional uint32 adb_type = 4;
+  optional string adb_config = 5;
+}
+
+message ControllerSetOptionRequest {
+  optional string handle = 1;
+  oneof option {
+    int32 long_side = 101;
+    int32 short_side = 102;
+    string def_package_entry = 103;
+    string def_package = 104;
+  }
+}
+
+message ControllerPostClickRequest {
+  optional string handle = 1;
+  optional ClickParam param = 2;
+}
+
+message ControllerPostSwipeRequest {
+  optional string handle = 1;
+  optional SwipeParam param = 2;
+}
+
+message ControllerPostKeyRequest {
+  optional string handle = 1;
+  optional KeyParam param = 2;
+}
+
+message ControllerPostTouchRequest {
+  optional string handle = 1;
+  optional TouchParam param = 2;
+}
+
+service Controller {
+  rpc create_adb(AdbControllerRequest) returns (HandleResponse);
+  rpc destroy(HandleRequest) returns (EmptyResponse);
+
+  rpc create_custom(stream CustomControllerRequest)
+      returns (stream CustomControllerResponse);
+
+  rpc set_option(ControllerSetOptionRequest) returns (EmptyResponse);
+  rpc post_connection(HandleRequest) returns (IIdResponse);
+  rpc post_click(ControllerPostClickRequest) returns (IIdResponse);
+  rpc post_swipe(ControllerPostSwipeRequest) returns (IIdResponse);
+  rpc post_press_key(ControllerPostKeyRequest) returns (IIdResponse);
+  rpc post_touch_down(ControllerPostTouchRequest) returns (IIdResponse);
+  rpc post_touch_move(ControllerPostTouchRequest) returns (IIdResponse);
+  rpc post_touch_up(ControllerPostTouchRequest) returns (IIdResponse);
+  rpc post_screencap(HandleRequest) returns (IIdResponse);
+
+  rpc status(HandleIIdRequest) returns (StatusResponse);
+  rpc wait(HandleIIdRequest) returns (StatusResponse);
+  rpc connected(HandleRequest) returns (BoolResponse);
+
+  rpc image(HandleHandleRequest) returns (EmptyResponse);
+  rpc uuid(HandleRequest) returns (StringResponse);
+}

include/Interface/proto/custom.action.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+
+message CustomActionInit {
+  optional string handle = 1;
+  optional string name = 2;
+  optional string act_id = 3;
+}
+
+message CustomActionSubmit {
+  optional string handle = 1;
+  optional string cmd_id = 2;
+  optional bool ok = 3;
+}
+
+message CustomActionRequest {
+  oneof payload {
+    CustomActionInit init = 1;
+    CustomActionSubmit submit = 2;
+  }
+}
+
+message CustomActionRunParam {
+  optional string context = 1;
+  optional string task = 2;
+  optional string param = 3;
+  optional Rect box = 4;
+  optional string detail = 5;
+}
+
+message CustomActionResponse {
+  optional string act_id = 1;
+  optional string cmd_id = 2;
+  oneof command {
+    CustomActionRunParam run = 101;
+    bool stop = 102; // void
+  }
+}

include/Interface/proto/custom.controller.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+
+message CustomControllerSetOptionParam {
+  optional int32 key = 1;
+  optional string value = 2;
+}
+
+message CustomControllerRequest {
+  optional bool ok = 1;
+  oneof result {
+    string init = 101;
+
+    Size resolution = 201;
+    string uuid = 202;
+  }
+}
+
+message CustomControllerResponse {
+  oneof command {
+    string init = 101; // handle
+
+    bool connect = 201; // void
+    ClickParam click = 202;
+    SwipeParam swipe = 203;
+    KeyParam key = 204;
+    TouchParam touch_down = 205;
+    TouchParam touch_move = 206;
+    TouchParam touch_up = 207;
+    string start = 208;
+    string stop = 209;
+    bool resolution = 210; // void
+    string image = 211;
+    bool uuid = 212; // void
+    CustomControllerSetOptionParam set_option = 213;
+  }
+}

include/Interface/proto/custom.recognizer.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+
+message CustomRecognizerInit {
+  optional string handle = 1;
+  optional string name = 2;
+  optional string reco_id = 3;
+}
+
+message CustomRecognizerAnalyzeResult {
+  optional bool match = 1;
+  optional Rect box = 2;
+  optional string detail = 3;
+}
+
+message CustomRecognizerSubmit {
+  optional string handle = 1;
+  optional string cmd_id = 2;
+  optional bool ok = 3;
+  oneof result { CustomRecognizerAnalyzeResult analyze = 101; }
+}
+
+message CustomRecognizerRequest {
+  oneof payload {
+    CustomRecognizerInit init = 1;
+    CustomRecognizerSubmit submit = 2;
+  }
+}
+
+message CustomRecognizerAnalyzeParam {
+  optional string context = 1;
+  optional string image_handle = 2;
+  optional string task = 3;
+  optional string param = 4;
+}
+
+message CustomRecognizerResponse {
+  optional string reco_id = 1;
+  optional string cmd_id = 2;
+  oneof command { CustomRecognizerAnalyzeParam analyze = 101; }
+}

include/Interface/proto/device.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+
+message DeviceInfo {
+  optional string name = 1;
+  optional string adb_path = 2;
+  optional string adb_serial = 3;
+  optional int32 adb_type = 4;
+  optional string adb_config = 5;
+}
+
+message DeviceInfosResponse { repeated DeviceInfo info = 1; }
+
+service Device {
+  rpc find(EmptyRequest) returns (DeviceInfosResponse);
+  rpc find_with_adb(StringRequest) returns (DeviceInfosResponse);
+}

include/Interface/proto/instance.proto

@@ -0,0 +1,50 @@
+syntax = "proto3";
+
+package maarpc;
+
+import "types.proto";
+import "custom.recognizer.proto";
+import "custom.action.proto";
+
+message InstancePostTaskRequest {
+  optional string handle = 1;
+  optional string task = 2;
+  optional string param = 3;
+}
+
+message InstanceSetTaskParamRequest {
+  optional string handle = 1;
+  optional uint64 id = 2;
+  optional string param = 3;
+}
+
+service Instance {
+  rpc create(IdRequest) returns (HandleResponse);
+  rpc destroy(HandleRequest) returns (EmptyResponse);
+
+  rpc register_custom_recognizer(stream CustomRecognizerRequest)
+      returns (stream CustomRecognizerResponse);
+  rpc unregister_custom_recognizer(HandleStringRequest) returns (EmptyResponse);
+  rpc clear_custom_recognizer(HandleRequest) returns (EmptyResponse);
+
+  rpc register_custom_action(stream CustomActionRequest)
+      returns (stream CustomActionResponse);
+  rpc unregister_custom_action(HandleStringRequest) returns (EmptyResponse);
+  rpc clear_custom_action(HandleRequest) returns (EmptyResponse);
+
+  rpc bind_resource(HandleHandleRequest) returns (EmptyResponse);
+  rpc bind_controller(HandleHandleRequest) returns (EmptyResponse);
+  rpc inited(HandleRequest) returns (BoolResponse);
+
+  rpc post_task(InstancePostTaskRequest) returns (IIdResponse);
+  rpc set_task_param(InstanceSetTaskParamRequest) returns (EmptyResponse);
+
+  rpc status(HandleIIdRequest) returns (StatusResponse);
+  rpc wait(HandleIIdRequest) returns (StatusResponse);
+  rpc all_finished(HandleRequest) returns (BoolResponse);
+
+  rpc stop(HandleRequest) returns (EmptyResponse);
+
+  rpc resource(HandleRequest) returns (HandleRequest);
+  rpc controller(HandleRequest) returns (HandleRequest);
+}