Added Utils for iOS Task Library Backed by C++ APIs

tensorflow_lite_support/ios/task/audio/BUILD

@@ -15,7 +15,7 @@ objc_library(
     module_name = "TFLAudioClassifier",
     deps = [
         "//tensorflow_lite_support/c/task/audio:audio_classifier",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils/c:TFLCommonCUtils",
         "//tensorflow_lite_support/ios/task/audio/core/audio_tensor:TFLAudioTensor",
         "//tensorflow_lite_support/ios/task/audio/core/audio_tensor/utils:TFLAudioTensorUtils",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptions",

tensorflow_lite_support/ios/task/audio/core/BUILD

@@ -26,7 +26,7 @@ objc_library(
     deps = [
         ":TFLFloatBuffer",
         "//tensorflow_lite_support/ios:TFLCommon",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
     ],
 )
 

tensorflow_lite_support/ios/task/audio/core/audio_record/BUILD

@@ -14,7 +14,7 @@ objc_library(
     module_name = "TFLAudioRecord",
     sdk_frameworks = ["AVFoundation"],
     deps = [
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
         "//tensorflow_lite_support/ios/task/audio/core:TFLAudioFormat",
         "//tensorflow_lite_support/ios/task/audio/core:TFLFloatBuffer",
         "//tensorflow_lite_support/ios/task/audio/core:TFLRingBuffer",

tensorflow_lite_support/ios/task/audio/core/audio_tensor/BUILD

@@ -15,7 +15,7 @@ objc_library(
     sdk_frameworks = ["AVFoundation"],
     deps = [
         "//tensorflow_lite_support/ios:TFLCommon",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
         "//tensorflow_lite_support/ios/task/audio/core:TFLFloatBuffer",
         "//tensorflow_lite_support/ios/task/audio/core:TFLRingBuffer",
         "//tensorflow_lite_support/ios/task/audio/core/audio_record:TFLAudioRecord",

tensorflow_lite_support/ios/task/audio/sources/TFLAudioClassifier.m

@@ -14,7 +14,7 @@
  ==============================================================================*/
 #import "tensorflow_lite_support/ios/task/audio/sources/TFLAudioClassifier.h"
 #import "tensorflow_lite_support/ios/sources/TFLCommon.h"
-#import "tensorflow_lite_support/ios/sources/TFLCommonUtils.h"
+#import "tensorflow_lite_support/ios/utils/c/sources/TFLCommonCUtils.h"
 #import "tensorflow_lite_support/ios/task/audio/core/audio_tensor/utils/sources/TFLAudioTensor+Utils.h"
 #import "tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.h"
 #import "tensorflow_lite_support/ios/task/processor/sources/TFLClassificationOptions+Helpers.h"
@@ -66,7 +66,7 @@ - (BOOL)populateRequiredBufferSizeWithError:(NSError **)error {
       TfLiteAudioClassifierGetRequiredInputBufferSize(_audioClassifier, &requiredBufferSizeError);
 
   // Populate iOS error if C Error is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:requiredBufferSizeError toError:error]) {
+  if (![TFLCommonCUtils checkCError:requiredBufferSizeError toError:error]) {
     TfLiteSupportErrorDelete(requiredBufferSizeError);
   }
 
@@ -78,7 +78,7 @@ - (BOOL)populateRequiredAudioFormatWithError:(NSError **)error {
   _requiredCAudioFormat =
       TfLiteAudioClassifierGetRequiredAudioFormat(_audioClassifier, &getAudioFormatError);
 
-  if (![TFLCommonUtils checkCError:getAudioFormatError toError:error]) {
+  if (![TFLCommonCUtils checkCError:getAudioFormatError toError:error]) {
     TfLiteSupportErrorDelete(getAudioFormatError);
   }
 
@@ -129,7 +129,7 @@ + (nullable instancetype)audioClassifierWithOptions:(TFLAudioClassifierOptions *
       deleteAllocatedMemoryOfClassificationOptions:&(cOptions.classification_options)];
 
   // Populate iOS error if TfliteSupportError is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:cCreateClassifierError toError:error]) {
+  if (![TFLCommonCUtils checkCError:cCreateClassifierError toError:error]) {
     TfLiteSupportErrorDelete(cCreateClassifierError);
   }
 
@@ -159,7 +159,7 @@ - (nullable TFLClassificationResult *)classifyWithAudioTensor:(TFLAudioTensor *)
       TfLiteAudioClassifierClassify(_audioClassifier, &cAudioBuffer, &classifyError);
 
   // Populate iOS error if C Error is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:classifyError toError:error]) {
+  if (![TFLCommonCUtils checkCError:classifyError toError:error]) {
     TfLiteSupportErrorDelete(classifyError);
   }
 

tensorflow_lite_support/ios/task/processor/BUILD

@@ -63,7 +63,7 @@ objc_library(
     ],
     module_name = "TFLSegmentationResult",
     deps = [
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
     ],
 )
 
@@ -79,7 +79,7 @@ objc_library(
     deps = [
         "//tensorflow_lite_support/c/task/processor:classification_options",
         "//tensorflow_lite_support/ios:TFLCommon",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
         "//tensorflow_lite_support/ios/task/processor:TFLClassificationOptions",
     ],
 )

tensorflow_lite_support/ios/task/vision/BUILD

@@ -15,7 +15,7 @@ objc_library(
     module_name = "TFLImageClassifier",
     deps = [
         "//tensorflow_lite_support/c/task/vision:image_classifier",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils/c:TFLCommonCUtils",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptions",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptionsHelpers",
         "//tensorflow_lite_support/ios/task/processor:TFLClassificationOptions",
@@ -39,7 +39,7 @@ objc_library(
     module_name = "TFLObjectDetector",
     deps = [
         "//tensorflow_lite_support/c/task/vision:object_detector",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils/c:TFLCommonCUtils",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptions",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptionsHelpers",
         "//tensorflow_lite_support/ios/task/processor:TFLClassificationOptions",
@@ -63,7 +63,7 @@ objc_library(
     module_name = "TFLImageSegmenter",
     deps = [
         "//tensorflow_lite_support/c/task/vision:image_segmenter",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils/c:TFLCommonCUtils",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptions",
         "//tensorflow_lite_support/ios/task/core:TFLBaseOptionsHelpers",
         "//tensorflow_lite_support/ios/task/processor:TFLSegmentationResult",

tensorflow_lite_support/ios/task/vision/sources/TFLImageClassifier.m

@@ -14,7 +14,7 @@
  ==============================================================================*/
 #import "tensorflow_lite_support/ios/task/vision/sources/TFLImageClassifier.h"
 #import "tensorflow_lite_support/ios/sources/TFLCommon.h"
-#import "tensorflow_lite_support/ios/sources/TFLCommonUtils.h"
+#import "tensorflow_lite_support/ios/utils/c/sources/TFLCommonCUtils.h"
 #import "tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.h"
 #import "tensorflow_lite_support/ios/task/processor/sources/TFLClassificationOptions+Helpers.h"
 #import "tensorflow_lite_support/ios/task/processor/sources/TFLClassificationResult+Helpers.h"
@@ -91,7 +91,7 @@ + (nullable instancetype)imageClassifierWithOptions:(TFLImageClassifierOptions *
       deleteAllocatedMemoryOfClassificationOptions:&(cOptions.classification_options)];
 
   // Populate iOS error if TfliteSupportError is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:cCreateClassifierError toError:error]) {
+  if (![TFLCommonCUtils checkCError:cCreateClassifierError toError:error]) {
     TfLiteSupportErrorDelete(cCreateClassifierError);
   }
 
@@ -143,7 +143,7 @@ - (nullable TFLClassificationResult *)classifyWithGMLImage:(GMLImage *)image
   cFrameBuffer = NULL;
 
   // Populate iOS error if C Error is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:classifyError toError:error]) {
+  if (![TFLCommonCUtils checkCError:classifyError toError:error]) {
     TfLiteSupportErrorDelete(classifyError);
   }
 

tensorflow_lite_support/ios/task/vision/sources/TFLImageSegmenter.m

@@ -14,7 +14,7 @@
  ==============================================================================*/
 #import "tensorflow_lite_support/ios/task/vision/sources/TFLImageSegmenter.h"
 #import "tensorflow_lite_support/ios/sources/TFLCommon.h"
-#import "tensorflow_lite_support/ios/sources/TFLCommonUtils.h"
+#import "tensorflow_lite_support/ios/utils/c/sources/TFLCommonCUtils.h"
 #import "tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.h"
 #import "tensorflow_lite_support/ios/task/processor/sources/TFLSegmentationResult+Helpers.h"
 #import "tensorflow_lite_support/ios/task/vision/utils/sources/GMLImage+Utils.h"
@@ -90,7 +90,7 @@ + (nullable instancetype)imageSegmenterWithOptions:(nonnull TFLImageSegmenterOpt
   // Freeing memory of allocated string.
   free(cOptions.display_names_locale);
 
-  if (![TFLCommonUtils checkCError:cCreateImageSegmenterError toError:error]) {
+  if (![TFLCommonCUtils checkCError:cCreateImageSegmenterError toError:error]) {
     TfLiteSupportErrorDelete(cCreateImageSegmenterError);
   }
 
@@ -128,7 +128,7 @@ - (nullable TFLSegmentationResult *)segmentWithGMLImage:(GMLImage *)image
   cFrameBuffer = nil;
 
   // Populate iOS error if C Error is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:cSegmentError toError:error]) {
+  if (![TFLCommonCUtils checkCError:cSegmentError toError:error]) {
     TfLiteSupportErrorDelete(cSegmentError);
   }
 

tensorflow_lite_support/ios/task/vision/sources/TFLObjectDetector.m

@@ -14,7 +14,7 @@
  ==============================================================================*/
 #import "tensorflow_lite_support/ios/task/vision/sources/TFLObjectDetector.h"
 #import "tensorflow_lite_support/ios/sources/TFLCommon.h"
-#import "tensorflow_lite_support/ios/sources/TFLCommonUtils.h"
+#import "tensorflow_lite_support/ios/utils/c/sources/TFLCommonCUtils.h"
 #import "tensorflow_lite_support/ios/task/core/sources/TFLBaseOptions+Helpers.h"
 #import "tensorflow_lite_support/ios/task/processor/sources/TFLClassificationOptions+Helpers.h"
 #import "tensorflow_lite_support/ios/task/processor/sources/TFLDetectionResult+Helpers.h"
@@ -91,7 +91,7 @@ + (nullable instancetype)objectDetectorWithOptions:(TFLObjectDetectorOptions *)o
       deleteAllocatedMemoryOfClassificationOptions:&(cOptions.classification_options)];
 
   // Populate iOS error if TfliteSupportError is not null and afterwards delete  it.
-  if (![TFLCommonUtils checkCError:cCreateObjectDetectorError toError:error]) {
+  if (![TFLCommonCUtils checkCError:cCreateObjectDetectorError toError:error]) {
     TfLiteSupportErrorDelete(cCreateObjectDetectorError);
   }
 
@@ -130,7 +130,7 @@ - (nullable TFLDetectionResult *)detectWithGMLImage:(GMLImage *)image
   cFrameBuffer = nil;
 
   // Populate iOS error if C Error is not null and afterwards delete it.
-  if (![TFLCommonUtils checkCError:cDetectError toError:error]) {
+  if (![TFLCommonCUtils checkCError:cDetectError toError:error]) {
     TfLiteSupportErrorDelete(cDetectError);
   }
 

tensorflow_lite_support/ios/task/vision/utils/BUILD

@@ -16,7 +16,7 @@ objc_library(
     sdk_frameworks = ["Accelerate"],
     deps = [
         "//tensorflow_lite_support/c/task/vision/core:frame_buffer",
-        "//tensorflow_lite_support/ios:TFLCommonUtils",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
         "//tensorflow_lite_support/odml/ios/image:MLImage",
     ],
 )

tensorflow_lite_support/ios/utils/BUILD

@@ -6,10 +6,24 @@ package(
 objc_library(
     name = "TFLStringUtil",
     srcs = [
-        "Sources/TFLStringUtil.mm",
+        "sources/TFLStringUtil.mm",
     ],
     hdrs = [
-        "Sources/TFLStringUtil.h",
+        "sources/TFLStringUtil.h",
     ],
     module_name = "TFLStringUtil",
 )
+
+objc_library(
+    name = "TFLCommonUtils",
+    srcs = [
+        "sources/TFLCommonUtils.m",
+    ],
+    hdrs = [
+        "sources/TFLCommonUtils.h",
+    ],
+    module_name = "TFLCommonUtils",
+    deps = [
+        "//tensorflow_lite_support/ios:TFLCommon",
+    ],
+)

tensorflow_lite_support/ios/utils/c/BUILD

@@ -0,0 +1,19 @@
+package(
+    default_visibility = ["//tensorflow_lite_support:internal"],
+    licenses = ["notice"],  # Apache 2.0
+)
+
+objc_library(
+    name = "TFLCommonCUtils",
+    srcs = [
+        "sources/TFLCommonCUtils.m",
+    ],
+    hdrs = [
+        "sources/TFLCommonCUtils.h",
+    ],
+    module_name = "TFLCommonCUtils",
+    deps = [
+        "//tensorflow_lite_support/c:common",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
+    ],
+)

tensorflow_lite_support/ios/utils/c/sources/TFLCommonCUtils.h

@@ -0,0 +1,37 @@
+/* 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 <Foundation/Foundation.h>
+#import "tensorflow_lite_support/ios/utils/sources/TFLCommonUtils.h"
+
+#include "tensorflow_lite_support/c/common.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** Helper utility for the all tasks which encapsulates common functionality of the iOS task library
+ * backed by C APIs. */
+@interface TFLCommonCUtils : TFLCommonUtils
+
+/**
+ * Converts a C library error, TfLiteSupportError to an NSError.
+ *
+ * @param supportError C library error.
+ * @param error Pointer to the memory location where the created error should be saved. If `nil`,
+ * no error will be saved.
+ */
++ (BOOL)checkCError:(TfLiteSupportError *)supportError toError:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

tensorflow_lite_support/ios/utils/c/sources/TFLCommonCUtils.m

@@ -0,0 +1,29 @@
+// 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/utils/c/sources/TFLCommonCUtils.h"
+
+@implementation TFLCommonCUtils
+
++ (BOOL)checkCError:(TfLiteSupportError *)supportError toError:(NSError **)error {
+  if (!supportError) {
+    return YES;
+  }
+  NSString *description = [NSString stringWithCString:supportError->message
+                                             encoding:NSUTF8StringEncoding];
+  [TFLCommonUtils createCustomError:error withCode:supportError->code description:description];
+  return NO;
+}
+
+@end

tensorflow_lite_support/ios/utils/cpp/BUILD

@@ -0,0 +1,17 @@
+package(
+    default_visibility = ["//tensorflow_lite_support:internal"],
+    licenses = ["notice"],  # Apache 2.0
+)
+
+objc_library(
+    name = "TFLCommonCppUtils",
+    hdrs = [
+        "sources/TFLCommonCppUtils.h",
+    ],
+    module_name = "TFLCommonCppUtils",
+    deps = [
+        "//tensorflow_lite_support/cc:common",
+        "@com_google_absl//absl/status",
+        "//tensorflow_lite_support/ios/utils:TFLCommonUtils",
+    ],
+)

tensorflow_lite_support/ios/utils/cpp/sources/TFLCommonCppUtils.h

@@ -0,0 +1,37 @@
+/* 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 <Foundation/Foundation.h>
+#import "tensorflow_lite_support/ios/utils/sources/TFLCommonUtils.h"
+
+#include "absl/status/status.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/** Helper utility for the all tasks which encapsulates common functionality of the iOS task library
+ * backed by C++ APIs. */
+@interface TFLCommonCppUtils : TFLCommonUtils
+
+/**
+ * Converts an absl status to an NSError.
+ *
+ * @param status absl status.
+ * @param error Pointer to the memory location where the created error should be saved. If `nil`,
+ * no error will be saved.
+ */
++ (BOOL)checkCppError:(const absl::Status &)status toError:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END