Merge pull request #709 from khanhlvg:ios-image-classifier-impl

PiperOrigin-RevId: 411099262

Author: tflite-support-robot

tensorflow_lite_support/c/task/processor/classification_options.h

@@ -30,7 +30,7 @@ typedef struct TfLiteStringArrayOption {
   int length;
 
   // Array of C strings.
-  const char** list;
+  char** list;
 } TfLiteStringArrayOption;
 
 // Holds settings for any single classification task.
@@ -47,7 +47,7 @@ typedef struct TfLiteClassificationOptions {
 
   // The locale to use for display names specified through the TFLite Model
   // Metadata, if any. Defaults to English.
-  const char* display_names_local;
+  char* display_names_local;
 
   // The maximum number of top-scored classification results to return. If < 0,
   // all available results will be returned. If 0, an invalid argument error is

tensorflow_lite_support/c/test/task/vision/image_classifier_test.cc

@@ -133,11 +133,11 @@ TEST_F(ImageClassifierFromOptionsTest,
   TfLiteImageClassifierOptions options = TfLiteImageClassifierOptionsCreate();
   options.base_options.model_file.file_path = model_path.data();
 
-  const char* label_denylist[] = {"brambling"};
+  char* label_denylist[9] = {(char*)"brambling"};
   options.classification_options.label_denylist.list = label_denylist;
   options.classification_options.label_denylist.length = 1;
 
-  const char* label_allowlist[] = {"cheeseburger"};
+  char* label_allowlist[12] = {(char*)"cheeseburger"};
   options.classification_options.label_allowlist.list = label_allowlist;
   options.classification_options.label_allowlist.length = 1;
 
@@ -329,15 +329,15 @@ TEST_F(ImageClassifierClassifyTest, FailsWithRoiOutsideImageBoundsAndError) {
 
 TEST(ImageClassifierWithUserDefinedOptionsClassifyTest,
      SucceedsWithClassNameDenyList) {
-  const char* denylisted_label_name = "cheeseburger";
+  char* denylisted_label_name = (char*)"cheeseburger";
   std::string model_path =
       JoinPath("./" /*test src dir*/, kTestDataDirectory,
                kMobileNetQuantizedWithMetadata);
 
   TfLiteImageClassifierOptions options = TfLiteImageClassifierOptionsCreate();
   options.base_options.model_file.file_path = model_path.data();
 
-  const char* label_denylist[] = {denylisted_label_name};
+  char* label_denylist[12] = {denylisted_label_name};
   options.classification_options.label_denylist.list = label_denylist;
   options.classification_options.label_denylist.length = 1;
 
@@ -373,7 +373,7 @@ TEST(ImageClassifierWithUserDefinedOptionsClassifyTest,
 
 TEST(ImageClassifierWithUserDefinedOptionsClassifyTest,
      SucceedsWithClassNameAllowList) {
-  const char* allowlisted_label_name = "cheeseburger";
+  char* allowlisted_label_name = (char*)"cheeseburger";
   std::string model_path =
       JoinPath("./" /*test src dir*/, kTestDataDirectory,
                kMobileNetQuantizedWithMetadata)
@@ -382,7 +382,7 @@ TEST(ImageClassifierWithUserDefinedOptionsClassifyTest,
   TfLiteImageClassifierOptions options = TfLiteImageClassifierOptionsCreate();
   options.base_options.model_file.file_path = model_path.data();
 
-  const char* label_allowlist[] = {allowlisted_label_name};
+  char* label_allowlist[12] = {allowlisted_label_name};
   options.classification_options.label_allowlist.list = label_allowlist;
   options.classification_options.label_allowlist.length = 1;
 

tensorflow_lite_support/cc/test/testdata/task/vision/sparrow.png

@@ -93,6 +93,9 @@ objc_library(
 
 objc_library(
     name = "TFLCommonUtils",
+    srcs = [
+        "sources/TFLCommonUtils.m",
+    ],
     hdrs = [
         "sources/TFLCommonUtils.h",
     ],
@@ -102,5 +105,6 @@ objc_library(
     ],
     deps = [
         "//tensorflow_lite_support/c:common",
+        "//tensorflow_lite_support/ios:TFLCommon",
     ],
 )

tensorflow_lite_support/ios/BUILD

@@ -0,0 +1,59 @@
+// Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//    http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#import "tensorflow_lite_support/ios/sources/TFLCommonUtils.h"
+#import "tensorflow_lite_support/ios/sources/TFLCommon.h"
+
+/** Error domain of TensorFlow Lite Support related errors. */
+static NSString *const TFLSupportTaskErrorDomain = @"org.tensorflow.lite.tasks";
+
+@implementation TFLCommonUtils
+
++ (void)customErrorWithCode:(NSInteger)code
+                description:(NSString *)description
+                      error:(NSError **)error {
+  if (error)
+    *error = [NSError errorWithDomain:TFLSupportTaskErrorDomain
+                                 code:code
+                             userInfo:@{NSLocalizedDescriptionKey : description}];
+}
+
++ (void)errorFromTfLiteSupportError:(TfLiteSupportError *)supportError error:(NSError **)error {
+  if (supportError && error)
+    *error = [NSError
+        errorWithDomain:TFLSupportTaskErrorDomain
+                   code:supportError->code
+               userInfo:@{
+                 NSLocalizedDescriptionKey : [NSString stringWithCString:supportError->message
+                                                                encoding:NSUTF8StringEncoding]
+               }];
+}
+
++ (void *)mallocWithSize:(size_t)memSize error:(NSError **)error {
+  if (!memSize) {
+    [TFLCommonUtils customErrorWithCode:TFLSupportErrorCodeInvalidArgumentError
+                            description:@"Invalid memory size passed for allocation of object."
+                                  error:error];
+    return NULL;
+  }
+
+  void *allocedMemory = malloc(memSize);
+  if (!allocedMemory && memSize) {
+    exit(-1);
+  }
+
+  return allocedMemory;
+}
+
+@end

tensorflow_lite_support/ios/sources/TFLCommonUtils.m

@@ -5,8 +5,26 @@ package(
 
 objc_library(
     name = "TFLBaseOptions",
+    srcs = [
+        "sources/TFLBaseOptions.m",
+    ],
     hdrs = [
-        "apis/TFLBaseOptions.h",
+        "sources/TFLBaseOptions.h",
     ],
     module_name = "TFLBaseOptions",
 )
+
+objc_library(
+    name = "TFLBaseOptionsHelpers",
+    srcs = [
+        "sources/TFLBaseOptions+Helpers.m",
+    ],
+    hdrs = [
+        "sources/TFLBaseOptions+Helpers.h",
+    ],
+    module_name = "TFLBaseOptionsHelpers",
+    deps = [
+        "//tensorflow_lite_support/c/task/core:base_options",
+        "//tensorflow_lite_support/ios/task/core:TFLBaseOptions",
+    ],
+)

tensorflow_lite_support/ios/task/core/BUILD

@@ -0,0 +1,24 @@
+/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ==============================================================================*/
+#include "tensorflow_lite_support/c/task/core/base_options.h"
+#import "third_party/tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface TFLBaseOptions (Helpers)
+- (void)copyBaseOptionsToCBaseOptions:(TfLiteBaseOptions *)cBaseOptions;
+@end
+
+NS_ASSUME_NONNULL_END

tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.h

@@ -0,0 +1,25 @@
+/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ==============================================================================*/
+#import "tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.h"
+
+@implementation TFLBaseOptions (Helpers)
+
+- (void)copyBaseOptionsToCBaseOptions:(TfLiteBaseOptions *)cBaseOptions {
+  if (self.modelFile.filePath) {
+    cBaseOptions->model_file.file_path = self.modelFile.filePath.UTF8String;
+  }
+}
+
+@end

tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.m

@@ -17,7 +17,7 @@ NS_ASSUME_NONNULL_BEGIN
  * Holds cpu settings.
  */
 NS_SWIFT_NAME(CpuSettings)
-@interface TFLCpuSettings : NSObject
+@interface TFLCpuSettings : NSObject <NSCopying>
 
 /** Specifies the number of threads to be used for TFLite ops that support multi-threadingwhen
  * running inference with CPU.
@@ -32,7 +32,7 @@ NS_SWIFT_NAME(CpuSettings)
  * Holds settings for one possible acceleration configuration.
  */
 NS_SWIFT_NAME(ComputeSettings)
-@interface TFLComputeSettings : NSObject
+@interface TFLComputeSettings : NSObject <NSCopying>
 
 /** Holds cpu settings. */
 @property(nonatomic, copy) TFLCpuSettings *cpuSettings;
@@ -43,7 +43,7 @@ NS_SWIFT_NAME(ComputeSettings)
  * Holds settings for one possible acceleration configuration.
  */
 NS_SWIFT_NAME(ExternalFile)
-@interface TFLExternalFile : NSObject
+@interface TFLExternalFile : NSObject <NSCopying>
 
 /** Path to the file in bundle. */
 @property(nonatomic, copy) NSString *filePath;
@@ -56,7 +56,7 @@ NS_SWIFT_NAME(ExternalFile)
  * important information acceleration configuration, tflite model source etc.
  */
 NS_SWIFT_NAME(BaseOptions)
-@interface TFLBaseOptions : NSObject
+@interface TFLBaseOptions : NSObject <NSCopying>
 
 /**
  * The external model file, as a single standalone TFLite file. It could be packed with TFLite Model

tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions.h

@@ -0,0 +1,94 @@
+/* Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ==============================================================================*/
+#import "tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions.h"
+
+@implementation TFLCpuSettings
+@synthesize numThreads;
+
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    self.numThreads = -1;
+  }
+  return self;
+}
+
+- (id)copyWithZone:(NSZone *)zone {
+  TFLCpuSettings *cpuSettings = [[TFLCpuSettings alloc] init];
+
+  [cpuSettings setNumThreads:self.numThreads];
+
+  return cpuSettings;
+}
+
+@end
+
+@implementation TFLComputeSettings
+@synthesize cpuSettings;
+
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    self.cpuSettings = [[TFLCpuSettings alloc] init];
+  }
+  return self;
+}
+
+- (id)copyWithZone:(NSZone *)zone {
+  TFLComputeSettings *computeSettings = [[TFLComputeSettings alloc] init];
+
+  [computeSettings setCpuSettings:self.cpuSettings];
+
+  return computeSettings;
+}
+
+@end
+
+@implementation TFLExternalFile
+@synthesize filePath;
+
+- (id)copyWithZone:(NSZone *)zone {
+  TFLExternalFile *externalFile = [[TFLExternalFile alloc] init];
+
+  [externalFile setFilePath:self.filePath];
+
+  return externalFile;
+}
+
+@end
+
+@implementation TFLBaseOptions
+@synthesize modelFile;
+@synthesize computeSettings;
+
+- (instancetype)init {
+  self = [super init];
+  if (self) {
+    self.computeSettings = [[TFLComputeSettings alloc] init];
+    self.modelFile = [[TFLExternalFile alloc] init];
+  }
+  return self;
+}
+
+- (id)copyWithZone:(NSZone *)zone {
+  TFLBaseOptions *baseOptions = [[TFLBaseOptions alloc] init];
+
+  [baseOptions setModelFile:self.modelFile];
+  [baseOptions setComputeSettings:self.computeSettings];
+
+  return baseOptions;
+}
+
+@end