Task delegate 7: Expose BaseOptions in Java ObjectDetector

PiperOrigin-RevId: 400229475

Author: lu-wang-g

tensorflow_lite_support/java/src/java/org/tensorflow/lite/task/vision/detector/ObjectDetector.java

@@ -28,6 +28,7 @@
 import org.tensorflow.lite.annotations.UsedByReflection;
 import org.tensorflow.lite.support.image.MlImageAdapter;
 import org.tensorflow.lite.support.image.TensorImage;
+import org.tensorflow.lite.task.core.BaseOptions;
 import org.tensorflow.lite.task.core.TaskJniUtils;
 import org.tensorflow.lite.task.core.TaskJniUtils.EmptyHandleProvider;
 import org.tensorflow.lite.task.core.TaskJniUtils.FdAndOptionsHandleProvider;
@@ -151,7 +152,12 @@ public long createHandle(
                   long fileDescriptorOffset,
                   ObjectDetectorOptions options) {
                 return initJniWithModelFdAndOptions(
-                    fileDescriptor, fileDescriptorLength, fileDescriptorOffset, options);
+                    fileDescriptor,
+                    fileDescriptorLength,
+                    fileDescriptorOffset,
+                    options,
+                    TaskJniUtils.createProtoBaseOptionsHandleWithLegacyNumThreads(
+                        options.getBaseOptions(), options.getNumThreads()));
               }
             },
             OBJECT_DETECTOR_NATIVE_LIB,
@@ -180,7 +186,9 @@ public long createHandle() {
                       descriptor.getFd(),
                       /*fileDescriptorLength=*/ OPTIONAL_FD_LENGTH,
                       /*fileDescriptorOffset=*/ OPTIONAL_FD_OFFSET,
-                      options);
+                      options,
+                      TaskJniUtils.createProtoBaseOptionsHandleWithLegacyNumThreads(
+                          options.getBaseOptions(), options.getNumThreads()));
                 }
               },
               OBJECT_DETECTOR_NATIVE_LIB));
@@ -209,7 +217,11 @@ public static ObjectDetector createFromBufferAndOptions(
             new EmptyHandleProvider() {
               @Override
               public long createHandle() {
-                return initJniWithByteBuffer(modelBuffer, options);
+                return initJniWithByteBuffer(
+                    modelBuffer,
+                    options,
+                    TaskJniUtils.createProtoBaseOptionsHandleWithLegacyNumThreads(
+                        options.getBaseOptions(), options.getNumThreads()));
               }
             },
             OBJECT_DETECTOR_NATIVE_LIB));
@@ -233,6 +245,7 @@ public static class ObjectDetectorOptions {
     // 1. java.util.Optional require Java 8 while we need to support Java 7.
     // 2. The Guava library (com.google.common.base.Optional) is avoided in this project. See the
     // comments for labelAllowList.
+    private final BaseOptions baseOptions;
     private final String displayNamesLocale;
     private final int maxResults;
     private final float scoreThreshold;
@@ -252,6 +265,7 @@ public static Builder builder() {
 
     /** A builder that helps to configure an instance of ObjectDetectorOptions. */
     public static class Builder {
+      private BaseOptions baseOptions = BaseOptions.builder().build();
       private String displayNamesLocale = "en";
       private int maxResults = -1;
       private float scoreThreshold;
@@ -262,6 +276,12 @@ public static class Builder {
 
       private Builder() {}
 
+      /** Sets the general options to configure Task APIs, such as accelerators. */
+      public Builder setBaseOptions(BaseOptions baseOptions) {
+        this.baseOptions = baseOptions;
+        return this;
+      }
+
       /**
        * Sets the locale to use for display names specified through the TFLite Model Metadata, if
        * any.
@@ -335,7 +355,11 @@ public Builder setLabelDenyList(List<String> labelDenyList) {
        *
        * <p>numThreads should be greater than 0 or equal to -1. Setting numThreads to -1 has the
        * effect to let TFLite runtime set the value.
+       *
+       * @deprecated use {@link BaseOptions} to configure number of threads instead. This method
+       *     will override the number of threads configured from {@link BaseOptions}.
        */
+      @Deprecated
       public Builder setNumThreads(int numThreads) {
         this.numThreads = numThreads;
         return this;
@@ -381,6 +405,10 @@ public int getNumThreads() {
       return numThreads;
     }
 
+    public BaseOptions getBaseOptions() {
+      return baseOptions;
+    }
+
     private ObjectDetectorOptions(Builder builder) {
       displayNamesLocale = builder.displayNamesLocale;
       maxResults = builder.maxResults;
@@ -389,6 +417,7 @@ private ObjectDetectorOptions(Builder builder) {
       labelAllowList = builder.labelAllowList;
       labelDenyList = builder.labelDenyList;
       numThreads = builder.numThreads;
+      baseOptions = builder.baseOptions;
     }
   }
 
@@ -463,8 +492,7 @@ public List<Detection> detect(MlImage image) {
   }
 
   /**
-   * Performs actual detection on the provided {@code MlImage} with {@link
-   * ImageProcessingOptions}.
+   * Performs actual detection on the provided {@code MlImage} with {@link ImageProcessingOptions}.
    *
    * <p>{@link ObjectDetector} supports the following options:
    *
@@ -497,10 +525,11 @@ private static native long initJniWithModelFdAndOptions(
       int fileDescriptor,
       long fileDescriptorLength,
       long fileDescriptorOffset,
-      ObjectDetectorOptions options);
+      ObjectDetectorOptions options,
+      long baseOptionsHandle);
 
   private static native long initJniWithByteBuffer(
-      ByteBuffer modelBuffer, ObjectDetectorOptions options);
+      ByteBuffer modelBuffer, ObjectDetectorOptions options, long baseOptionsHandle);
 
   private static native List<Detection> detectNative(long nativeHandle, long frameBufferHandle);
 

tensorflow_lite_support/java/src/native/task/vision/detector/BUILD

@@ -18,6 +18,7 @@ jni_binary_with_tflite(
     name = "libtask_vision_jni.so",
     srcs = [
         "object_detector_jni.cc",
+        "//tensorflow_lite_support/java/src/native/task/core:task_jni_utils.cc",
         "//tensorflow_lite_support/java/src/native/task/vision/core:base_vision_task_api_jni.cc",
     ],
     linkscript = "//tensorflow_lite_support/java:default_version_script.lds",
@@ -28,6 +29,7 @@ jni_binary_with_tflite(
     ],
     deps = [
         "//tensorflow_lite_support/cc/port:statusor",
+        "//tensorflow_lite_support/cc/task/core/proto:base_options_proto_inc",
         "//tensorflow_lite_support/cc/task/vision/core:frame_buffer",
         "//tensorflow_lite_support/cc/task/vision/proto:bounding_box_proto_inc",
         "//tensorflow_lite_support/cc/task/vision/proto:detections_proto_inc",

tensorflow_lite_support/java/src/native/task/vision/detector/object_detector_jni.cc

@@ -20,6 +20,7 @@ limitations under the License.
 
 #include "external/com_google_absl/absl/strings/string_view.h"
 #include "tensorflow_lite_support/cc/port/statusor.h"
+#include "tensorflow_lite_support/cc/task/core/proto/base_options_proto_inc.h"
 #include "tensorflow_lite_support/cc/task/vision/core/frame_buffer.h"
 #include "tensorflow_lite_support/cc/task/vision/object_detector.h"
 #include "tensorflow_lite_support/cc/task/vision/proto/bounding_box_proto_inc.h"
@@ -36,16 +37,26 @@ using ::tflite::support::utils::kAssertionError;
 using ::tflite::support::utils::kInvalidPointer;
 using ::tflite::support::utils::StringListToVector;
 using ::tflite::support::utils::ThrowException;
+using ::tflite::task::core::BaseOptions;
 using ::tflite::task::vision::BoundingBox;
 using ::tflite::task::vision::ConvertToCategory;
 using ::tflite::task::vision::DetectionResult;
 using ::tflite::task::vision::FrameBuffer;
+
 using ::tflite::task::vision::ObjectDetector;
 using ::tflite::task::vision::ObjectDetectorOptions;
 
 // Creates an ObjectDetectorOptions proto based on the Java class.
-ObjectDetectorOptions ConvertToProtoOptions(JNIEnv* env, jobject java_options) {
+ObjectDetectorOptions ConvertToProtoOptions(JNIEnv* env, jobject java_options,
+                                            jlong base_options_handle) {
   ObjectDetectorOptions proto_options;
+
+  if (base_options_handle != kInvalidPointer) {
+    // proto_options will free the previous base_options and set the new one.
+    proto_options.set_allocated_base_options(
+        reinterpret_cast<BaseOptions*>(base_options_handle));
+  }
+
   jclass java_options_class = env->FindClass(
       "org/tensorflow/lite/task/vision/detector/"
       "ObjectDetector$ObjectDetectorOptions");
@@ -91,12 +102,6 @@ ObjectDetectorOptions ConvertToProtoOptions(JNIEnv* env, jobject java_options) {
   for (const auto& class_name : deny_list_vector) {
     proto_options.add_class_name_blacklist(class_name);
   }
-
-  jmethodID num_threads_id =
-      env->GetMethodID(java_options_class, "getNumThreads", "()I");
-  jint num_threads = env->CallIntMethod(java_options, num_threads_id);
-  proto_options.set_num_threads(num_threads);
-
   return proto_options;
 }
 
@@ -177,10 +182,11 @@ extern "C" JNIEXPORT jlong JNICALL
 Java_org_tensorflow_lite_task_vision_detector_ObjectDetector_initJniWithModelFdAndOptions(
     JNIEnv* env, jclass thiz, jint file_descriptor,
     jlong file_descriptor_length, jlong file_descriptor_offset,
-    jobject java_options) {
+    jobject java_options, jlong base_options_handle) {
   ObjectDetectorOptions proto_options =
-      ConvertToProtoOptions(env, java_options);
-  auto file_descriptor_meta = proto_options.mutable_model_file_with_metadata()
+      ConvertToProtoOptions(env, java_options, base_options_handle);
+  auto file_descriptor_meta = proto_options.mutable_base_options()
+                                  ->mutable_model_file()
                                   ->mutable_file_descriptor_meta();
   file_descriptor_meta->set_fd(file_descriptor);
   if (file_descriptor_length > 0) {
@@ -194,10 +200,11 @@ Java_org_tensorflow_lite_task_vision_detector_ObjectDetector_initJniWithModelFdA
 
 extern "C" JNIEXPORT jlong JNICALL
 Java_org_tensorflow_lite_task_vision_detector_ObjectDetector_initJniWithByteBuffer(
-    JNIEnv* env, jclass thiz, jobject model_buffer, jobject java_options) {
+    JNIEnv* env, jclass thiz, jobject model_buffer, jobject java_options,
+    jlong base_options_handle) {
   ObjectDetectorOptions proto_options =
-      ConvertToProtoOptions(env, java_options);
-  proto_options.mutable_model_file_with_metadata()->set_file_content(
+      ConvertToProtoOptions(env, java_options, base_options_handle);
+  proto_options.mutable_base_options()->mutable_model_file()->set_file_content(
       static_cast<char*>(env->GetDirectBufferAddress(model_buffer)),
       static_cast<size_t>(env->GetDirectBufferCapacity(model_buffer)));
   return CreateObjectDetectorFromOptions(env, proto_options);