update android app, very basic functionality

Author: edgchen1

mobile/examples/model_tester/android/app/build.gradle.kts

@@ -5,12 +5,12 @@ plugins {
 
 android {
     namespace = "com.onnxruntime.example.modeltester"
-    compileSdk = 33
+    compileSdk = 34
 
     defaultConfig {
         applicationId = "com.onnxruntime.example.modeltester"
         minSdk = 24
-        targetSdk = 33
+        targetSdk = 34
         versionCode = 1
         versionName = "1.0"
 
@@ -42,10 +42,10 @@ android {
     buildFeatures {
         viewBinding = true
     }
+    ndkVersion = "28.1.13356709"
 }
 
 dependencies {
-
     implementation("androidx.core:core-ktx:1.9.0")
     implementation("androidx.appcompat:appcompat:1.7.0")
     implementation("com.google.android.material:material:1.12.0")

mobile/examples/model_tester/android/app/src/main/cpp/CMakeLists.txt

@@ -11,6 +11,8 @@ cmake_minimum_required(VERSION 3.22.1)
 # build script scope).
 project("modeltester")
 
+set(CMAKE_CXX_STANDARD 20)
+
 # Creates and names a library, sets it as either STATIC
 # or SHARED, and provides the relative paths to its source code.
 # You can define multiple libraries, and CMake builds them for you.
@@ -24,14 +26,26 @@ project("modeltester")
 # System.loadLibrary() and pass the name of the library defined here;
 # for GameActivity/NativeActivity derived applications, the same library name must be
 # used in the AndroidManifest.xml file.
+add_library(onnxruntime SHARED IMPORTED)
+set_target_properties(onnxruntime PROPERTIES
+        IMPORTED_LOCATION
+            ${CMAKE_SOURCE_DIR}/lib/${ANDROID_ABI}/libonnxruntime.so
+        INTERFACE_INCLUDE_DIRECTORIES
+            ${CMAKE_SOURCE_DIR}/include)
+
 add_library(${CMAKE_PROJECT_NAME} SHARED
-        # List C/C++ source files with relative paths to this CMakeLists.txt.
-        native-lib.cpp)
+        ${CMAKE_CURRENT_SOURCE_DIR}/native-lib.cpp
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../../common/include/model_runner.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../../common/model_runner.cpp)
+
+target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/../../../../../common/include)
 
 # Specifies libraries CMake should link to your target library. You
 # can link libraries from various origins, such as libraries defined in this
 # build script, prebuilt third-party libraries, or Android system libraries.
 target_link_libraries(${CMAKE_PROJECT_NAME}
         # List libraries link to the target library
         android
-        log)
+        log
+        onnxruntime)

mobile/examples/model_tester/android/app/src/main/cpp/native-lib.cpp

@@ -1,10 +1,101 @@
+#include <android/log.h>
+
 #include <jni.h>
+
+#include <memory>
 #include <string>
+#include <stdexcept>
+#include <vector>
+
+#include "model_runner.h"
+
+namespace util {
+struct JstringUtfCharDeleter {
+  JstringUtfCharDeleter(JNIEnv& env, jstring jstr) : env{env}, jstr{jstr} {}
+
+  void operator()(const char* p) {
+    env.ReleaseStringUTFChars(jstr, p);
+  }
+
+  JNIEnv& env;
+  jstring jstr;
+};
+
+auto MakeUniqueJstringUtfCharPtr(JNIEnv& env, jstring jstr) {
+  const auto* raw_utf_chars = env.GetStringUTFChars(jstr, nullptr);
+  return std::unique_ptr<const char, JstringUtfCharDeleter>{
+      raw_utf_chars, JstringUtfCharDeleter{env, jstr}};
+}
+
+std::string JstringToStdString(JNIEnv& env, jstring jstr) {
+  auto utf_chars = MakeUniqueJstringUtfCharPtr(env, jstr);
+  return std::string{utf_chars.get()};
+}
+
+std::vector<std::string> JstringArrayToStdStrings(JNIEnv& env, jobjectArray jobjs) {
+  std::vector<std::string> strs;
+  const auto java_string_class = env.FindClass("java/lang/String");
+  const auto length = env.GetArrayLength(jobjs);
+  for (jsize i = 0; i < length; ++i) {
+    const auto jobj = env.GetObjectArrayElement(jobjs, i);
+    if (!env.IsInstanceOf(jobj, java_string_class)) {
+      throw std::runtime_error("jobjectArray element is not a string");
+    }
+    const auto jstr = static_cast<jstring>(jobj);
+    strs.emplace_back(JstringToStdString(env, jstr));
+  }
+  return strs;
+}
+
+struct JbyteArrayElementsDeleter {
+  JbyteArrayElementsDeleter(JNIEnv& env, jbyteArray array) : env{env}, array{array} {}
+
+  void operator()(jbyte* p) {
+    env.ReleaseByteArrayElements(array, p, 0);
+  }
+
+  JNIEnv& env;
+  jbyteArray array;
+};
+
+auto MakeUniqueJbyteArrayElementsPtr(JNIEnv& env, jbyteArray array) {
+  auto* jbytes_raw = env.GetByteArrayElements(array, nullptr);
+  return std::unique_ptr<jbyte[], JbyteArrayElementsDeleter>{
+      jbytes_raw, JbyteArrayElementsDeleter{env, array}};
+}
+}  // namespace util
 
 extern "C" JNIEXPORT jstring JNICALL
-Java_com_onnxruntime_example_modeltester_MainActivity_stringFromJNI(
-        JNIEnv* env,
-        jobject /* this */) {
-    std::string hello = "Hello from C++";
-    return env->NewStringUTF(hello.c_str());
+Java_com_onnxruntime_example_modeltester_MainActivity_run(JNIEnv* env, jobject thiz,
+                                                          jbyteArray java_model_bytes,
+                                                          jint num_iterations,
+                                                          jstring execution_provider_type,
+                                                          jobjectArray execution_provider_option_names,
+                                                          jobjectArray execution_provider_option_values) {
+  try {
+    auto model_bytes = util::MakeUniqueJbyteArrayElementsPtr(*env, java_model_bytes);
+    const size_t model_bytes_length = env->GetArrayLength(java_model_bytes);
+    auto model_bytes_span = std::span{reinterpret_cast<const std::byte*>(model_bytes.get()),
+                                      model_bytes_length};
+
+    auto config = model_runner::RunConfig{};
+    config.model_path_or_bytes = model_bytes_span;
+    config.num_iterations = num_iterations;
+
+    // TODO handle EP type and EP options
+
+    auto result = model_runner::Run(config);
+
+    auto summary = model_runner::GetRunSummary(config, result);
+
+    return env->NewStringUTF(summary.c_str());
+  } catch (const std::exception& e) {
+    const auto java_exception_class = env->FindClass("java/lang/RuntimeException");
+    env->ThrowNew(java_exception_class, e.what());
+
+    __android_log_print(ANDROID_LOG_ERROR, "com.onnxruntime.example.modeltester",
+                        "Error: %s", e.what());
+
+    return nullptr;
+  }
 }

mobile/examples/model_tester/android/app/src/main/java/com/onnxruntime/example/modeltester/MainActivity.kt

@@ -2,7 +2,6 @@ package com.onnxruntime.example.modeltester
 
 import androidx.appcompat.app.AppCompatActivity
 import android.os.Bundle
-import android.widget.TextView
 import com.onnxruntime.example.modeltester.databinding.ActivityMainBinding
 
 class MainActivity : AppCompatActivity() {
@@ -15,15 +14,24 @@ class MainActivity : AppCompatActivity() {
         binding = ActivityMainBinding.inflate(layoutInflater)
         setContentView(binding.root)
 
-        // Example of a call to a native method
-        binding.sampleText.text = stringFromJNI()
+        val modelResourceId = R.raw.model
+        val modelBytes = resources.openRawResource(modelResourceId).readBytes()
+
+        val summary = run(modelBytes, 10, null, null, null)
+
+        binding.sampleText.text = summary
     }
 
     /**
      * A native method that is implemented by the 'modeltester' native library,
      * which is packaged with this application.
      */
-    external fun stringFromJNI(): String
+    external fun run(modelBytes: ByteArray,
+                     numIterations: Int,
+                     executionProviderType: String?,
+                     executionProviderOptionNames: Array<String>?,
+                     executionProviderOptionValues: Array<String>?,
+                     ): String
 
     companion object {
         // Used to load the 'modeltester' library on application startup.

mobile/examples/model_tester/android/readme.md

@@ -0,0 +1,20 @@
+setup instructions:
+
+1. manually set up native onnxruntime libraries. unzip onnxruntime-android.aar, then put shared libraries and headers into these directories:
+
+under mobile/examples/model_tester/android/app/src/main/cpp:
+include/onnxruntime_session_options_config_keys.h
+include/nnapi_provider_factory.h
+include/cpu_provider_factory.h
+include/onnxruntime_lite_custom_op.h
+include/onnxruntime_run_options_config_keys.h
+include/onnxruntime_float16.h
+include/onnxruntime_cxx_inline.h
+include/onnxruntime_cxx_api.h
+include/onnxruntime_c_api.h
+lib/armeabi-v7a/libonnxruntime.so
+lib/x86/libonnxruntime.so
+lib/arm64-v8a/libonnxruntime.so
+lib/x86_64/libonnxruntime.so
+
+2. copy an onnx model file to mobile/examples/model_tester/android/app/src/main/res/raw/model.onnx