Rust rewrite completely (#18)

* Changes

* Base providers

* Switch to json conversion

* Refactor animation structures and update JSON configuration for NDK compatibility

* Attempt to move most of the work to Rust

* Update PointDefinitionW constructor to include BaseProviderContext and refactor property access in AssignPathAnimationData

* Refactor animation context constructors and update PointDefinitionW to support copy construction

* Refactor TracksContext and update BeatmapAssociatedData to use shared_ptr for internal_tracks_context

* Implement event queuing

* Refactor Track and PointDefinition headers to improve structure and add interpolation methods for various vector types

* Add operator overloads and registration methods to TrackW and PathPropertyW for improved usability

* Refactor GameObjectTrackController to use std::span for track parameters and enhance property retrieval methods with optional types

* Multiply scale

* Refactor GameObjectTrackController to use TimeUnit for lastCheckedTime and enhance vector operations with new operator overloads

* Fix PointDefinitionW, missing one thing

* Enhance PointDefinitionW and Track classes with context management and const correctness; refactor point data handling in BeatmapAssociatedData

* Use corrosion

* Finally get tracks_rs statically linked

* Optimize binaries

* Remove tracks-rs dependency from qpm.json and qpm.shared.json

* Add Rust setup step for nightly and aarch64-linux-android target in CI workflows

* Remove canary NDK setup from build workflows

* Update QPM Rust Action to use version 1 in build and publish workflows

* Update to BS 1.40.3

* Install cargo-ndk

* Specify toolchain for aarch64-linux-android target in build workflows

* Fix GameObjectTrackController class declaration

* Fix static linking libtracks_rs_link

* Disable sl2 bundling in qmod

* Refactor include paths and improve const correctness in Track and Property classes

* Add lastCheckedTime and getter

* Fix time param

* Fix null context

---------

Co-authored-by: Futuremappermydud <54294576+Futuremappermydud@users.noreply.github.com>

Author: Fernthedev

.github/workflows/build-ndk.yml

@@ -24,23 +24,13 @@ jobs:
 
       - uses: seanmiddleditch/gha-setup-ninja@v3
 
-      # Use canary NDK to avoid lesser known compile bugs
-      - name: Setup canary NDK
-        id: setup-ndk
-        uses: ./.github/actions/canary-ndk
-
-      - name: Create ndkpath.txt
-        run: |
-          echo ${{ steps.setup-ndk.outputs.ndk-path }} > ${GITHUB_WORKSPACE}/ndkpath.txt
-          cat ${GITHUB_WORKSPACE}/ndkpath.txt
-      
       # - name: Create ndkpath.txt
       #   run: |
       #     echo "$ANDROID_NDK_LATEST_HOME" > ${GITHUB_WORKSPACE}/ndkpath.txt
       #     cat ${GITHUB_WORKSPACE}/ndkpath.txt
 
       - name: QPM Rust Action
-        uses: Fernthedev/qpm-rust-action@main
+        uses: Fernthedev/qpm-rust-action@v1
         with:
           #required
           workflow_token: ${{secrets.GITHUB_TOKEN}}
@@ -55,6 +45,12 @@ jobs:
         run: |
           qpm-rust collapse
 
+      - name: Setup Rust
+        run: |
+          rustup install nightly
+          rustup target add aarch64-linux-android --toolchain nightly
+          cargo install --locked --git https://github.com/bbqsrc/cargo-ndk.git cargo-ndk 
+
       - name: Build
         run: |
           cd ${GITHUB_WORKSPACE}

.github/workflows/publish.yml

@@ -22,16 +22,6 @@ jobs:
           lfs: true
 
       - uses: seanmiddleditch/gha-setup-ninja@v3
-
-      # Use canary NDK to avoid lesser known compile bugs
-      - name: Setup canary NDK
-        id: setup-ndk
-        uses: ./.github/actions/canary-ndk
-
-      - name: Create ndkpath.txt
-        run: |
-          echo ${{ steps.setup-ndk.outputs.ndk-path }} > ${GITHUB_WORKSPACE}/ndkpath.txt
-          cat ${GITHUB_WORKSPACE}/ndkpath.txt
 
       # - name: Create ndkpath.txt
       #   run: |
@@ -46,15 +36,15 @@ jobs:
           echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/v}
 
       - name: QPM Rust Action
-        uses: Fernthedev/qpm-action@main
+        uses: Fernthedev/qpm-action@v1
         with:
           #required
           workflow_token: ${{secrets.GITHUB_TOKEN}}
 
           restore: true # will run restore on download
           cache: true #will cache dependencies
 
-          publish: true
+          publish: "late"
           publish_token: ${{secrets.QPM_TOKEN}}
 
           version: ${{ steps.get_tag_version.outputs.VERSION }}
@@ -67,6 +57,12 @@ jobs:
           # Name of qmod in release asset. Assumes exists, same as prior
           qpm_qmod: ${{env.qmodName}}.qmod
 
+      - name: Setup Rust
+        run: |
+          rustup install nightly
+          rustup target add aarch64-linux-android --toolchain nightly
+          cargo install --locked --git https://github.com/bbqsrc/cargo-ndk.git cargo-ndk
+
       - name: Build
         run: |
           cd ${GITHUB_WORKSPACE}

CMakeLists.txt

@@ -1,9 +1,11 @@
+cmake_minimum_required(VERSION 3.21)
+
 # include some defines automatically made by qpm
 include(qpm_defines.cmake)
 
-cmake_minimum_required(VERSION 3.21)
 project(${COMPILE_ID})
 
+
 # c++ standard
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED 20)
@@ -17,9 +19,8 @@ set(INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include)
 # compile options used
 add_compile_options(-frtti -fexceptions)
 
-
-
 add_compile_options(-O3)
+
 # compile definitions used
 add_compile_definitions(VERSION=\"${MOD_VERSION}\")
 add_compile_definitions(MOD_ID=\"${MOD_ID}\")
@@ -41,18 +42,25 @@ add_library(
         ${c_file_list}
         ${inline_hook_c}
         ${inline_hook_cpp}
+        tracks_rs_link/target/aarch64-linux-android/release/libtracks_rs_link.a
 )
 
 # add src dir as include dir
 target_include_directories(${COMPILE_ID} PRIVATE ${SOURCE_DIR})
+
 # add include dir as include dir
 target_include_directories(${COMPILE_ID} PRIVATE ${INCLUDE_DIR})
+
 # add shared dir as include dir
 target_include_directories(${COMPILE_ID} PUBLIC ${SHARED_DIR})
-# codegen includes 
+
+# codegen includes
 target_include_directories(${COMPILE_ID} PRIVATE ${EXTERN_DIR}/includes/${CODEGEN_ID}/include)
 
 target_link_libraries(${COMPILE_ID} PRIVATE -llog)
+target_link_directories(${COMPILE_ID} PUBLIC tracks_rs_link/target/aarch64-linux-android/release)
+target_link_libraries(${COMPILE_ID} PUBLIC tracks_rs_link)
+
 # add extern stuff like libs and other includes
 include(extern.cmake)
 
@@ -64,14 +72,14 @@ add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
 add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
         COMMAND ${CMAKE_COMMAND} -E make_directory debug
         COMMENT "Rename the lib to debug_ since it has debug symbols"
-        )
+)
 
 add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
         COMMAND ${CMAKE_COMMAND} -E rename lib${COMPILE_ID}.so debug/lib${COMPILE_ID}.so
         COMMENT "Rename the lib to debug_ since it has debug symbols"
-        )
+)
 
 add_custom_command(TARGET ${COMPILE_ID} POST_BUILD
         COMMAND ${CMAKE_COMMAND} -E rename stripped_lib${COMPILE_ID}.so lib${COMPILE_ID}.so
         COMMENT "Rename the stripped lib to regular"
-        )
+)

build.ps1

@@ -19,7 +19,11 @@ if (($clean.IsPresent) -or (-not (Test-Path -Path "build")))
     $out = new-item -Path build -ItemType Directory
 }
 
-cd build
+# build the rust code
+cd ./tracks_rs_link
+cargo ndk --bindgen --no-strip -t arm64-v8a -o build build --release
+
+cd ../build
 & cmake -G "Ninja" -DCMAKE_BUILD_TYPE="RelWithDebInfo" ../
 & cmake --build .
 cd ..

include/Animation/Events.h

@@ -12,30 +12,27 @@ void AddEventCallbacks();
 void UpdateCoroutines(GlobalNamespace::BeatmapCallbacksController* callbackController);
 
 struct AnimateTrackContext {
-  PointDefinition* points;
-  Property* property;
+  PointDefinitionW points;
+  PropertyW property;
   float duration;
   Functions easing;
   float startTime;
   int repeat;
 
-  constexpr AnimateTrackContext(PointDefinition* points, Property* aProperty, float duration, float startTime,
+  constexpr AnimateTrackContext(PointDefinitionW points, PropertyW aProperty, float duration, float startTime,
                                 Functions easing, int repeat)
       : points(points), property(aProperty), duration(duration), startTime(startTime), easing(easing), repeat(repeat) {}
 
-  constexpr AnimateTrackContext() = default;
 };
 
 struct AssignPathAnimationContext {
-  PathProperty* property;
+  PathPropertyW property;
   float duration;
   Functions easing;
   float startTime;
   int repeat;
 
-  constexpr AssignPathAnimationContext() = default;
-
-  constexpr AssignPathAnimationContext(PathProperty* aProperty, float duration, float startTime, Functions easing,
+  constexpr AssignPathAnimationContext(PathPropertyW aProperty, float duration, float startTime, Functions easing,
                                        int repeat)
       : property(aProperty), duration(duration), startTime(startTime), easing(easing), repeat(repeat) {}
 };

qpm.json

@@ -5,7 +5,7 @@
   "info": {
     "name": "Tracks",
     "id": "tracks",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "url": "https://github.com/StackDoubleFlow/Tracks",
     "additionalData": {
       "overrideSoName": "libtracks.so",
@@ -18,6 +18,7 @@
         "pwsh ./build.ps1"
       ]
     },
+    "ndk": "^27.1.12297006",
     "qmodIncludeDirs": [
       "./build",
       "./extern/libs"
@@ -29,11 +30,13 @@
     {
       "id": "beatsaber-hook",
       "versionRange": "^6.1.7",
-      "additionalData": {}
+      "additionalData": {
+        "extraFiles": []
+      }
     },
     {
       "id": "bs-cordl",
-      "versionRange": "^4000.0.0",
+      "versionRange": "^4030.0.0",
       "additionalData": {
         "includeQmod": true
       }
@@ -51,7 +54,9 @@
     {
       "id": "scotland2",
       "versionRange": "*",
-      "additionalData": {}
+      "additionalData": {
+        "includeQmod": false
+      }
     },
     {
       "id": "custom-types",
@@ -67,7 +72,7 @@
     },
     {
       "id": "paper2_scotland2",
-      "versionRange": "^4.4.1",
+      "versionRange": "^4.6.1",
       "additionalData": {}
     }
   ]