feat(android): enable ggml-hexagon backend

Author: jhen0409

.gitignore

@@ -85,3 +85,9 @@ ios/rnwhisper.xcframework/**/*.framework
 
 local-plan/
 local-plan-done/
+
+# Hexagon HTP build artifacts
+build-hexagon-htp/
+bin/arm64-v8a/libggml-htp-*.so
+cpp/ggml-hexagon/htp/v73/htp_iface_stub.c
+cpp/ggml-hexagon/htp/v73/htp_iface.h

android/build.gradle

@@ -15,9 +15,64 @@ def isNewArchitectureEnabled() {
 
 apply plugin: "com.android.library"
 
+def repoRootDir = project.projectDir.parentFile
+def htpLibSourceDir = new File(repoRootDir, "bin/arm64-v8a")
 
 def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
 
+if (appProject != null) {
+  def configureHtpSyncTask = { Project applicationProject ->
+    def assetsRootDir = new File(applicationProject.projectDir, "src/main/assets")
+    def ggmlHexagonDir = new File(assetsRootDir, "ggml-hexagon")
+
+    def syncTask = applicationProject.tasks.register("syncRNWhisperHtpAssets", Copy) {
+      group = "whisper.rn"
+      description = "Copies whisper.rn Hexagon HTP libraries into the host application's assets directory."
+
+      onlyIf {
+        if (!htpLibSourceDir.exists()) {
+          logger.info("whisper.rn: No HTP libraries found at ${htpLibSourceDir.absolutePath}, skipping asset sync")
+          return false
+        }
+        true
+      }
+
+      doFirst {
+        if (!assetsRootDir.exists()) {
+          assetsRootDir.mkdirs()
+        }
+        if (!ggmlHexagonDir.exists()) {
+          ggmlHexagonDir.mkdirs()
+          return
+        }
+        ggmlHexagonDir.listFiles({ File dir, String name ->
+          name.startsWith("libggml-htp-") && name.endsWith(".so")
+        } as FilenameFilter)?.each { File lib ->
+          lib.delete()
+        }
+      }
+
+      into(assetsRootDir)
+      from(htpLibSourceDir) {
+        include "libggml-htp-*.so"
+        into "ggml-hexagon"
+      }
+    }
+
+    applicationProject.tasks.matching { it.name == "preBuild" }.configureEach {
+      dependsOn(syncTask)
+    }
+  }
+
+  if (appProject.state.executed) {
+    configureHtpSyncTask(appProject)
+  } else {
+    appProject.afterEvaluate {
+      configureHtpSyncTask(appProject)
+    }
+  }
+}
+
 if (isNewArchitectureEnabled()) {
   apply plugin: "com.facebook.react"
 }
@@ -74,13 +129,18 @@ android {
     minSdkVersion getExtOrIntegerDefault("minSdkVersion")
     targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
     buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+    def homeDir = System.getProperty("user.home")
+    def hexagonSdkRoot = System.getenv('HEXAGON_SDK_ROOT') ?: "${homeDir}/.hexagon-sdk/6.4.0.2"
+    def hexagonToolsRoot = System.getenv('HEXAGON_TOOLS_ROOT') ?: "${homeDir}/.hexagon-sdk/6.4.0.2/tools/HEXAGON_Tools/19.0.04"
     externalNativeBuild {
       cmake {
         abiFilters (*reactNativeArchitectures())
         // Configure STL to be compatible with ReactAndroid JSI libraries
         arguments "-DANDROID_STL=c++_shared",
                   "-DREACT_NATIVE_MINOR_VERSION=${REACT_NATIVE_MINOR_VERSION}",
-                  "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON"
+                  "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON",
+                  "-DHEXAGON_SDK_ROOT=${hexagonSdkRoot}",
+                  "-DHEXAGON_TOOLS_ROOT=${hexagonToolsRoot}"
       }
     }
     ndk {
@@ -105,6 +165,9 @@ android {
       "**/libturbomodulejsijni.so",
       "**/libreact_nativemodule_core.so",
     ]
+    jniLibs {
+      excludes += ["**/libcdsprpc.so"]
+    }
   }
 
   buildFeatures {

android/src/main/CMakeLists.txt

@@ -18,105 +18,82 @@ include_directories(
     ${RNWHISPER_LIB_DIR}/jsi
 )
 
+# Include core library builds
+add_subdirectory(rnwhisper)
+
+# JNI source files
 set(
-    SOURCE_FILES
-    ${RNWHISPER_LIB_DIR}/ggml.c
-    ${RNWHISPER_LIB_DIR}/ggml-alloc.c
-    ${RNWHISPER_LIB_DIR}/ggml-backend.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-backend-reg.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/amx/amx.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/amx/mmq.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/ggml-cpu.c
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/ggml-cpu.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/quants.c
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/traits.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/repack.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/unary-ops.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/binary-ops.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/vec.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-cpu/ops.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-opt.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-threading.cpp
-    ${RNWHISPER_LIB_DIR}/ggml-quants.c
-    ${RNWHISPER_LIB_DIR}/gguf.cpp
-    ${RNWHISPER_LIB_DIR}/whisper.cpp
-    ${RNWHISPER_LIB_DIR}/rn-audioutils.cpp
-    ${RNWHISPER_LIB_DIR}/rn-whisper.cpp
+    JNI_SOURCE_FILES
     ${RNWHISPER_LIB_DIR}/jsi/RNWhisperJSI.cpp
     ${CMAKE_SOURCE_DIR}/jni.cpp
 )
 
 find_library(LOG_LIB log)
 
-function(build_library target_name arch cpu_flags)
-    if (NOT ${arch} STREQUAL "generic")
-        set(SOURCE_FILES_ARCH
-            ${RNWHISPER_LIB_DIR}/ggml-cpu/arch/${arch}/quants.c
-            ${RNWHISPER_LIB_DIR}/ggml-cpu/arch/${arch}/repack.cpp
-        )
-    endif ()
+# Build JNI wrapper library function
+function(build_rnwhisper_jni jni_name rnwhisper_name cpu_flags)
+    # Check if Hexagon is enabled (name contains "_hexagon")
+    string(REGEX MATCH ".*_hexagon.*" ENABLE_HEXAGON ${rnwhisper_name})
 
     add_library(
-        ${target_name}
+        ${jni_name}
         SHARED
-        ${SOURCE_FILES}
-        ${SOURCE_FILES_ARCH}
+        ${JNI_SOURCE_FILES}
     )
 
-    # Link JSI libraries
+    # JNI wrapper links to core library and ReactAndroid
     if(${REACT_NATIVE_MINOR_VERSION} GREATER_EQUAL 76)
-        target_link_libraries(${target_name}
+        target_link_libraries(${jni_name}
             ${LOG_LIB}
             android
+            ${rnwhisper_name}
             fbjni::fbjni
             ReactAndroid::jsi
             ReactAndroid::reactnative
         )
     else ()
-        target_link_libraries(${target_name}
+        target_link_libraries(${jni_name}
             ${LOG_LIB}
             android
+            ${rnwhisper_name}
             fbjni::fbjni
             ReactAndroid::jsi
             ReactAndroid::turbomodulejsijni
             ReactAndroid::react_nativemodule_core
         )
     endif ()
 
-    if (${arch} STREQUAL "generic")
-        target_compile_options(${target_name} PRIVATE -DWSP_GGML_CPU_GENERIC)
-    endif ()
+    target_compile_options(${jni_name} PRIVATE -pthread ${cpu_flags})
 
-    target_compile_options(${target_name} PRIVATE -DWSP_GGML_USE_CPU -DWSP_GGML_USE_CPU_REPACK -pthread ${cpu_flags})
+    if (ENABLE_HEXAGON)
+        target_compile_options(${jni_name} PRIVATE -DWSP_GGML_USE_HEXAGON)
+    endif ()
 
     if (${CMAKE_BUILD_TYPE} STREQUAL "Debug")
-        target_compile_options(${target_name} PRIVATE -DRNWHISPER_ANDROID_ENABLE_LOGGING)
+        target_compile_options(${jni_name} PRIVATE -DRNWHISPER_ANDROID_ENABLE_LOGGING)
     endif ()
 
-    # NOTE: If you want to debug the native code, you can uncomment if and endif
-    # Note that it will be extremely slow
-    # if (NOT ${CMAKE_BUILD_TYPE} STREQUAL "Debug")
-        target_compile_options(${target_name} PRIVATE -O3 -DNDEBUG)
-        target_compile_options(${target_name} PRIVATE -fvisibility=hidden -fvisibility-inlines-hidden)
-        target_compile_options(${target_name} PRIVATE -ffunction-sections -fdata-sections)
-
-        target_link_options(${target_name} PRIVATE -Wl,--gc-sections)
-        target_link_options(${target_name} PRIVATE -Wl,--exclude-libs,ALL)
-        target_link_options(${target_name} PRIVATE -flto)
-    # endif ()
+    target_compile_options(${jni_name} PRIVATE -O3 -DNDEBUG)
+    target_compile_options(${jni_name} PRIVATE -fvisibility=hidden -fvisibility-inlines-hidden)
+    target_compile_options(${jni_name} PRIVATE -ffunction-sections -fdata-sections)
+
+    target_link_options(${jni_name} PRIVATE -Wl,--gc-sections)
+    target_link_options(${jni_name} PRIVATE -Wl,--exclude-libs,ALL)
+    target_link_options(${jni_name} PRIVATE -flto)
 endfunction()
 
-build_library("rnwhisper" "generic" "")
+# Build JNI wrapper variants
+build_rnwhisper_jni("rnwhisper_jni" "rnwhisper" "")
 
 if (${ANDROID_ABI} STREQUAL "arm64-v8a")
-    build_library("rnwhisper_v8fp16_va_2" "arm" "-march=armv8.2-a+fp16")
-    build_library("rnwhisper_v8" "arm" "-march=armv8-a")
+    build_rnwhisper_jni("rnwhisper_jni_v8fp16_va_2" "rnwhisper_v8fp16_va_2" "-march=armv8.2-a+fp16")
+    build_rnwhisper_jni("rnwhisper_jni_v8" "rnwhisper_v8" "-march=armv8-a")
+    # Hexagon HTP variant (experimental)
+    build_rnwhisper_jni("rnwhisper_jni_v8_2_hexagon" "rnwhisper_v8_2_hexagon" "-march=armv8.2-a+fp16+dotprod")
 elseif (${ANDROID_ABI} STREQUAL "armeabi-v7a")
-    build_library("rnwhisper_vfpv4" "arm" "-mfpu=neon-vfpv4")
+    build_rnwhisper_jni("rnwhisper_jni_vfpv4" "rnwhisper_vfpv4" "-mfpu=neon-vfpv4")
 elseif (${ANDROID_ABI} STREQUAL "x86_64")
-    # x86_64 target
-    build_library("rnwhisper_x86_64" "x86" "-march=x86-64" "-mtune=intel" "-msse4.2" "-mpopcnt")
+    build_rnwhisper_jni("rnwhisper_jni_x86_64" "rnwhisper_x86_64" "-march=x86-64" "-mtune=intel" "-msse4.2" "-mpopcnt")
 endif ()
 
-
 include_directories(${RNWHISPER_LIB_DIR})