react-native-executorch 0.4.8 → 0.5.1-rc.0

package/android/CMakeLists.txt

@@ -0,0 +1,17 @@
+cmake_minimum_required(VERSION 3.13)
+project(RnExecutorch)
+
+set (CMAKE_VERBOSE_MAKEFILE ON)
+set (CMAKE_CXX_STANDARD 20)
+
+include("${REACT_NATIVE_DIR}/ReactAndroid/cmake-utils/folly-flags.cmake")
+add_compile_options(${folly_FLAGS})
+
+string(APPEND CMAKE_CXX_FLAGS " -DRCT_NEW_ARCH_ENABLED")
+
+set(ANDROID_CPP_DIR "${CMAKE_SOURCE_DIR}/src/main/cpp")
+set(COMMON_CPP_DIR "${CMAKE_SOURCE_DIR}/../common")
+set(LIBS_DIR "${CMAKE_SOURCE_DIR}/../third-party/android/libs")
+set(INCLUDE_DIR "${CMAKE_SOURCE_DIR}/../third-party/include")
+
+add_subdirectory("${ANDROID_CPP_DIR}")

package/android/build.gradle

@@ -1,3 +1,5 @@
+import org.apache.tools.ant.taskdefs.condition.Os
+
 buildscript {
   ext {
     agp_version = '8.4.2'
@@ -21,19 +23,20 @@ buildscript {
 
 def reactNativeArchitectures() {
   def value = rootProject.getProperties().get("reactNativeArchitectures")
-  return value ? value.split(",") : ["armeabi-v7a", "x86", "x86_64", "arm64-v8a"]
-}
-
-def isNewArchitectureEnabled() {
-  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+  // react-native-executorch supports only these architectures. This is due to
+  // Executorch not supporting anything else.
+  def defaultArchitectures = ["x86_64", "arm64-v8a"]
+  if(!value) {
+    return defaultArchitectures
+  }
+  def architectures = value.split(",")
+  return architectures.findAll { it in defaultArchitectures }
 }
 
 apply plugin: "com.android.library"
 apply plugin: "kotlin-android"
+apply plugin: "com.facebook.react"
 
-if (isNewArchitectureEnabled()) {
-  apply plugin: "com.facebook.react"
-}
 
 def getExtOrDefault(name) {
   return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["RnExecutorch_" + name]
@@ -52,6 +55,38 @@ def supportsNamespace() {
   return (major == 7 && minor >= 3) || major >= 8
 }
 
+def safeAppExtGet(prop, fallback) {
+  def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
+  appProject?.ext?.has(prop) ? appProject.ext.get(prop) : fallback
+}
+
+def toPlatformFileString(String path) {
+  if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+      path = path.replace(File.separatorChar, '/' as char)
+  }
+  return path
+}
+
+def resolveReactNativeDirectory() {
+  def reactNativeLocation = safeAppExtGet("REACT_NATIVE_NODE_MODULES_DIR", null)
+
+  if (reactNativeLocation !== null) {
+    return file(reactNativeLocation)
+  }
+
+  // Fallback to node resolver for custom directory structures like monorepos.
+  def reactNativePackage = file(["node", "--print", "require.resolve('react-native/package.json')"].execute(null, rootDir).text.trim())
+  if(reactNativePackage.exists()) {
+      return reactNativePackage.parentFile
+  }
+
+  throw new GradleException(
+      "[RnExecutorch] Unable to resolve react-native location in node_modules. You should project extension property (in `app/build.gradle`) `REACT_NATIVE_NODE_MODULES_DIR` with path to react-native."
+  )
+}
+
+def reactNativeRootDir = resolveReactNativeDirectory()
+
 android {
   if (supportsNamespace()) {
     namespace "com.swmansion.rnexecutorch"
@@ -63,12 +98,40 @@ android {
     }
   }
 
+  buildFeatures {
+    prefab true
+    prefabPublishing true
+    buildConfig true
+  }
+
+  prefab {
+    "react-native-executorch" {
+      headers "src/main/cpp"
+    }
+  }
+
   compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
 
   defaultConfig {
     minSdkVersion getExtOrIntegerDefault("minSdkVersion")
     targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
-    buildConfigField("boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString())
+    externalNativeBuild {
+        cmake {
+          cppFlags "-O2 -frtti -fexceptions -Wall -fstack-protector-all -fopenmp -static-openmp"
+          abiFilters (*reactNativeArchitectures())
+          arguments "-DANDROID_STL=c++_shared",
+                    "-DREACT_NATIVE_DIR=${toPlatformFileString(reactNativeRootDir.path)}",
+                    "-DBUILD_DIR=${project.buildDir}",
+                    "-DANDROID_TOOLCHAIN=clang"
+      }
+    }
+  }
+
+
+  externalNativeBuild {
+    cmake {
+      path "CMakeLists.txt"
+    }
   }
 
   buildTypes {
@@ -85,6 +148,7 @@ android {
     sourceCompatibility JavaVersion.VERSION_1_8
     targetCompatibility JavaVersion.VERSION_1_8
   }
+
 }
 
 repositories {
@@ -99,11 +163,10 @@ dependencies {
   // For < 0.71, this will be from the local maven repo
   // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
   //noinspection GradleDynamicVersion
-  implementation 'com.github.wendykierp:JTransforms:3.1'
   implementation "com.facebook.react:react-android:+"
-  implementation 'org.opencv:opencv:4.10.0'
+  implementation "com.facebook.react:react-native:+"
+  implementation 'com.facebook.fbjni:fbjni:0.6.0'
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-	implementation("com.github.software-mansion:react-native-executorch:release~0.4-SNAPSHOT")
-  implementation 'org.opencv:opencv:4.10.0'
+  implementation files('libs/classes.jar')
   implementation("com.squareup.okhttp3:okhttp:4.9.2")
 }

package/android/src/main/cpp/CMakeLists.txt

@@ -0,0 +1,73 @@
+cmake_minimum_required(VERSION 3.13)
+
+file(GLOB_RECURSE ANDROID_CPP_SOURCES CONFIGURE_DEPENDS "${ANDROID_CPP_DIR}/*.cpp")
+file(GLOB_RECURSE COMMON_CPP_SOURCES CONFIGURE_DEPENDS "${COMMON_CPP_DIR}/*.cpp" "${COMMON_CPP_DIR}/*.c")
+file(GLOB_RECURSE TEST_CPP_SOURCES "${COMMON_CPP_DIR}/rnexecutorch/tests/*.cpp")
+list(REMOVE_ITEM COMMON_CPP_SOURCES ${TEST_CPP_SOURCES})
+
+add_library(react-native-executorch SHARED ${ANDROID_CPP_SOURCES} ${COMMON_CPP_SOURCES})
+
+find_package(ReactAndroid REQUIRED CONFIG)
+find_package(fbjni REQUIRED CONFIG)
+
+target_include_directories(
+  react-native-executorch
+  PUBLIC
+  "${COMMON_CPP_DIR}"
+  "${ANDROID_CPP_DIR}"
+  "${INCLUDE_DIR}"
+  "${REACT_NATIVE_DIR}/ReactCommon"
+  "${REACT_NATIVE_DIR}/ReactAndroid/src/main/jni/react/turbomodule"
+  "${REACT_NATIVE_DIR}/ReactCommon/callinvoker"
+)
+
+set(LINK_LIBRARIES
+  ReactAndroid::jsi
+  fbjni::fbjni
+  android
+  log
+)
+
+set(RN_VERSION_LINK_LIBRARIES
+  ReactAndroid::reactnative
+)
+
+# Dependencies:
+# ------- Executorch -------
+
+add_library(executorch SHARED IMPORTED)
+
+set_target_properties(executorch PROPERTIES
+                      IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libexecutorch.so")
+
+# ------- OpenCV -------
+
+set(OPENCV_LIBS 
+  "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_core.a"
+  "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_features2d.a"
+  "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_highgui.a"
+  "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_imgproc.a"
+  "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_photo.a"
+  "${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_video.a"
+)
+
+if(ANDROID_ABI STREQUAL "arm64-v8a")
+  set(OPENCV_THIRD_PARTY_LIBS
+    "${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv_hal.a"
+    "${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv_thread.a"
+    "${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv.a"
+  )
+elseif(ANDROID_ABI STREQUAL "x86_64")
+  set(OPENCV_THIRD_PARTY_LIBS "")
+endif()
+
+# --------------
+
+target_link_libraries(
+  react-native-executorch 
+  ${LINK_LIBRARIES} 
+  ${RN_VERSION_LINK_LIBRARIES}
+  ${OPENCV_LIBS}
+  ${OPENCV_THIRD_PARTY_LIBS}
+  executorch
+)

package/android/src/main/cpp/ETInstallerModule.cpp

@@ -0,0 +1,76 @@
+#include "ETInstallerModule.h"
+
+#include <rnexecutorch/RnExecutorchInstaller.h>
+
+#include <jni.h>
+#include <jsi/jsi.h>
+
+namespace rnexecutorch {
+JavaVM *java_machine;
+using namespace facebook::jni;
+
+ETInstallerModule::ETInstallerModule(
+    jni::alias_ref<ETInstallerModule::jhybridobject> &jThis,
+    jsi::Runtime *jsiRuntime,
+    const std::shared_ptr<facebook::react::CallInvoker> &jsCallInvoker)
+    : javaPart_(make_global(jThis)), jsiRuntime_(jsiRuntime),
+      jsCallInvoker_(jsCallInvoker) {}
+
+jni::local_ref<ETInstallerModule::jhybriddata> ETInstallerModule::initHybrid(
+    jni::alias_ref<jhybridobject> jThis, jlong jsContext,
+    jni::alias_ref<facebook::react::CallInvokerHolder::javaobject>
+        jsCallInvokerHolder) {
+  auto jsCallInvoker = jsCallInvokerHolder->cthis()->getCallInvoker();
+  auto rnRuntime = reinterpret_cast<jsi::Runtime *>(jsContext);
+  return makeCxxInstance(jThis, rnRuntime, jsCallInvoker);
+}
+
+void ETInstallerModule::registerNatives() {
+  registerHybrid({
+      makeNativeMethod("initHybrid", ETInstallerModule::initHybrid),
+      makeNativeMethod("injectJSIBindings",
+                       ETInstallerModule::injectJSIBindings),
+  });
+}
+
+void ETInstallerModule::injectJSIBindings() {
+  // Grab a function for fetching images via URL from Java
+  auto fetchDataByUrl = [](std::string url) {
+    // Attaching Current Thread to JVM
+
+    JNIEnv *env = nullptr;
+    int getEnvStat = java_machine->GetEnv((void **)&env, JNI_VERSION_1_6);
+    if (getEnvStat == JNI_EDETACHED) {
+      if (java_machine->AttachCurrentThread(&env, nullptr) != 0) {
+        throw std::runtime_error("Failed to attach thread to JVM");
+      }
+    }
+    static jclass cls = javaClassStatic().get();
+    static jmethodID method = env->GetStaticMethodID(
+        cls, "fetchByteDataFromUrl", "(Ljava/lang/String;)[B");
+
+    jstring jUrl = env->NewStringUTF(url.c_str());
+    jbyteArray byteData =
+        (jbyteArray)env->CallStaticObjectMethod(cls, method, jUrl);
+
+    if (env->IsSameObject(byteData, NULL)) {
+      throw std::runtime_error("Error fetching data from a url");
+    }
+
+    int size = env->GetArrayLength(byteData);
+    jbyte *bytes = env->GetByteArrayElements(byteData, JNI_FALSE);
+    std::byte *dataBytePtr = reinterpret_cast<std::byte *>(bytes);
+
+    return std::vector<std::byte>(dataBytePtr, dataBytePtr + size);
+  };
+
+  RnExecutorchInstaller::injectJSIBindings(jsiRuntime_, jsCallInvoker_,
+                                           fetchDataByUrl);
+}
+} // namespace rnexecutorch
+
+JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM *vm, void *) {
+  rnexecutorch::java_machine = vm;
+  return facebook::jni::initialize(
+      vm, [] { rnexecutorch::ETInstallerModule::registerNatives(); });
+}

package/android/src/main/cpp/ETInstallerModule.h

@@ -0,0 +1,43 @@
+#pragma once
+
+#include <ReactCommon/CallInvokerHolder.h>
+#include <fbjni/fbjni.h>
+#include <react/jni/CxxModuleWrapper.h>
+#include <react/jni/JMessageQueueThread.h>
+
+#include <memory>
+#include <utility>
+
+namespace rnexecutorch {
+
+using namespace facebook;
+using namespace react;
+
+class ETInstallerModule : public jni::HybridClass<ETInstallerModule> {
+public:
+  static auto constexpr kJavaDescriptor =
+      "Lcom/swmansion/rnexecutorch/ETInstaller;";
+
+  static jni::local_ref<ETInstallerModule::jhybriddata>
+  initHybrid(jni::alias_ref<jhybridobject> jThis, jlong jsContext,
+             jni::alias_ref<facebook::react::CallInvokerHolder::javaobject>
+                 jsCallInvokerHolder);
+
+  static void registerNatives();
+
+  void injectJSIBindings();
+
+private:
+  friend HybridBase;
+
+  jni::global_ref<ETInstallerModule::javaobject> javaPart_;
+  jsi::Runtime *jsiRuntime_;
+  std::shared_ptr<facebook::react::CallInvoker> jsCallInvoker_;
+
+  explicit ETInstallerModule(
+      jni::alias_ref<ETInstallerModule::jhybridobject> &jThis,
+      jsi::Runtime *jsiRuntime,
+      const std::shared_ptr<facebook::react::CallInvoker> &jsCallInvoker);
+};
+
+} // namespace rnexecutorch

package/android/src/main/java/com/swmansion/rnexecutorch/ETInstaller.kt

@@ -0,0 +1,66 @@
+package com.swmansion.rnexecutorch
+
+import com.facebook.jni.HybridData
+import com.facebook.proguard.annotations.DoNotStrip
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReactMethod
+import com.facebook.react.common.annotations.FrameworkAPI
+import com.facebook.react.module.annotations.ReactModule
+import com.facebook.react.turbomodule.core.CallInvokerHolderImpl
+import java.io.InputStream
+import java.net.URL
+
+@OptIn(FrameworkAPI::class)
+@ReactModule(name = ETInstaller.NAME)
+class ETInstaller(
+  reactContext: ReactApplicationContext,
+) : NativeETInstallerSpec(reactContext) {
+  companion object {
+    const val NAME = NativeETInstallerSpec.NAME
+
+    @JvmStatic
+    @DoNotStrip
+    @Throws(Exception::class)
+    fun fetchByteDataFromUrl(source: String): ByteArray? {
+      try {
+        val url = URL(source)
+        val connection = url.openConnection()
+        connection.connect()
+
+        val inputStream: InputStream = connection.getInputStream()
+        val data = inputStream.readBytes()
+        inputStream.close()
+
+        return data
+      } catch (exception: Throwable) {
+        return null
+      }
+    }
+  }
+
+  private val mHybridData: HybridData
+
+  external fun initHybrid(
+    jsContext: Long,
+    callInvoker: CallInvokerHolderImpl,
+  ): HybridData
+
+  private external fun injectJSIBindings()
+
+  init {
+    try {
+      System.loadLibrary("executorch")
+      System.loadLibrary("react-native-executorch")
+      val jsCallInvokerHolder = reactContext.jsCallInvokerHolder as CallInvokerHolderImpl
+      mHybridData = initHybrid(reactContext.javaScriptContextHolder!!.get(), jsCallInvokerHolder)
+    } catch (exception: UnsatisfiedLinkError) {
+      throw RuntimeException("Could not load native module ETInstaller", exception)
+    }
+  }
+
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  override fun install(): Boolean {
+    injectJSIBindings()
+    return true
+  }
+}

package/android/src/main/java/com/swmansion/rnexecutorch/LLM.kt

@@ -8,7 +8,8 @@ import org.pytorch.executorch.extension.llm.LlmModule
 
 class LLM(
   reactContext: ReactApplicationContext,
-) : NativeLLMSpec(reactContext), LlmCallback {
+) : NativeLLMSpec(reactContext),
+  LlmCallback {
   private var llmModule: LlmModule? = null
 
   override fun getName(): String = NAME
@@ -45,8 +46,7 @@ class LLM(
     Thread {
       llmModule!!.generate(input, this)
       promise.resolve("Inference completed successfully")
-    }
-      .start()
+    }.start()
   }
 
   override fun interrupt() {

package/android/src/main/java/com/swmansion/rnexecutorch/RnExecutorchPackage.kt

@@ -16,26 +16,8 @@ class RnExecutorchPackage : TurboReactPackage() {
   ): NativeModule? =
     if (name == LLM.NAME) {
       LLM(reactContext)
-    } else if (name == ETModule.NAME) {
-      ETModule(reactContext)
-    } else if (name == StyleTransfer.NAME) {
-      StyleTransfer(reactContext)
-    } else if (name == Classification.NAME) {
-      Classification(reactContext)
-    } else if (name == ObjectDetection.NAME) {
-      ObjectDetection(reactContext)
-    } else if (name == SpeechToText.NAME) {
-      SpeechToText(reactContext)
-    } else if (name == OCR.NAME) {
-      OCR(reactContext)
-    } else if (name == VerticalOCR.NAME) {
-      VerticalOCR(reactContext)
-    } else if (name == ImageSegmentation.NAME) {
-      ImageSegmentation(reactContext)
-    } else if (name == Tokenizer.NAME) {
-      Tokenizer(reactContext)
-    } else if (name == TextEmbeddings.NAME) {
-      TextEmbeddings(reactContext)
+    } else if (name == ETInstaller.NAME) {
+      ETInstaller(reactContext)
     } else {
       null
     }
@@ -49,105 +31,17 @@ class RnExecutorchPackage : TurboReactPackage() {
           LLM.NAME,
           false, // canOverrideExistingModule
           false, // needsEagerInit
+          true, // hasConstants
           false, // isCxxModule
           true,
         )
-      moduleInfos[ETModule.NAME] =
+      moduleInfos[ETInstaller.NAME] =
         ReactModuleInfo(
-          ETModule.NAME,
-          ETModule.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[StyleTransfer.NAME] =
-        ReactModuleInfo(
-          StyleTransfer.NAME,
-          StyleTransfer.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[Classification.NAME] =
-        ReactModuleInfo(
-          Classification.NAME,
-          Classification.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[ObjectDetection.NAME] =
-        ReactModuleInfo(
-          ObjectDetection.NAME,
-          ObjectDetection.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[SpeechToText.NAME] =
-        ReactModuleInfo(
-          SpeechToText.NAME,
-          SpeechToText.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[OCR.NAME] =
-        ReactModuleInfo(
-          OCR.NAME,
-          OCR.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[VerticalOCR.NAME] =
-        ReactModuleInfo(
-          VerticalOCR.NAME,
-          VerticalOCR.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[ImageSegmentation.NAME] =
-        ReactModuleInfo(
-          ImageSegmentation.NAME,
-          ImageSegmentation.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[Tokenizer.NAME] =
-        ReactModuleInfo(
-          Tokenizer.NAME,
-          Tokenizer.NAME,
-          false, // canOverrideExistingModule
-          false, // needsEagerInit
-          false, // isCxxModule
-          true,
-        )
-
-      moduleInfos[TextEmbeddings.NAME] =
-        ReactModuleInfo(
-          TextEmbeddings.NAME,
-          TextEmbeddings.NAME,
+          ETInstaller.NAME,
+          ETInstaller.NAME,
           false, // canOverrideExistingModule
           false, // needsEagerInit
+          true, // hasConstants
           false, // isCxxModule
           true,
         )