Added iOS Image Segmenter Options

This commit is contained in:
Prianka Liz Kariat 2023-06-23 20:09:18 +05:30
parent 7fe365489d
commit 7623c5a941
3 changed files with 149 additions and 0 deletions

View File

@ -26,3 +26,13 @@ objc_library(
],
)
objc_library(
name = "MPPImageSegmenterOptions",
srcs = ["sources/MPPImageSegmenterOptions.m"],
hdrs = ["sources/MPPImageSegmenterOptions.h"],
deps = [
":MPPImageSegmenterResult",
"//mediapipe/tasks/ios/core:MPPTaskOptions",
"//mediapipe/tasks/ios/vision/core:MPPRunningMode",
],
)

View File

@ -0,0 +1,99 @@
// Copyright 2023 The MediaPipe Authors.
//
// 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 "mediapipe/tasks/ios/core/sources/MPPTaskOptions.h"
#import "mediapipe/tasks/ios/vision/core/sources/MPPRunningMode.h"
#import "mediapipe/tasks/ios/vision/image_segmenter/sources/MPPImageSegmenterResult.h"
NS_ASSUME_NONNULL_BEGIN
@class MPPImageSegmenter;
/**
* This protocol defines an interface for the delegates of `MPPImageSegmenter` object to receive
* results of performing asynchronous segmentation on images (i.e, when `runningMode` =
* `MPPRunningModeLiveStream`).
*
* The delegate of `MPPImageSegmenter` must adopt `MPPImageSegmenterLiveStreamDelegate` protocol.
* The methods in this protocol are optional.
*/
NS_SWIFT_NAME(ObjectDetectorLiveStreamDelegate)
@protocol MPPImageSegmenterLiveStreamDelegate <NSObject>
@optional
/**
* This method notifies a delegate that the results of asynchronous segmentation of
* an image submitted to the `MPPImageSegmenter` is available.
*
* This method is called on a private serial dispatch queue created by the `MPPImageSegmenter`
* for performing the asynchronous delegates calls.
*
* @param imageSegmenter The image segmenter which performed the segmentation.
* This is useful to test equality when there are multiple instances of `MPPImageSegmenter`.
* @param result The `MPPImageSegmenterResult` object that contains a list of category or confidence
* masks and optional quality scores.
* @param timestampInMilliseconds The timestamp (in milliseconds) which indicates when the input
* image was sent to the image segmenter.
* @param error An optional error parameter populated when there is an error in performing
* segmentation on the input live stream image data.
*/
- (void)imageSegmenter:(MPPImageSegmenter *)imageSegmenter
didFinishSegmentationWithResult:(nullable MPPImageSegmenterResult *)result
timestampInMilliseconds:(NSInteger)timestampInMilliseconds
error:(nullable NSError *)error
NS_SWIFT_NAME(imageSegmenter(_:didFinishSegmentation:timestampInMilliseconds:error:));
@end
/** Options for setting up a `MPPImageSegmenter`. */
NS_SWIFT_NAME(ObjectDetectorOptions)
@interface MPPImageSegmenterOptions : MPPTaskOptions <NSCopying>
/**
* Running mode of the image segmenter task. Defaults to `MPPRunningModeImage`.
* `MPPImageSegmenter` can be created with one of the following running modes:
* 1. `MPPRunningModeImage`: The mode for performing segmentation on single image inputs.
* 2. `MPPRunningModeVideo`: The mode for performing segmentation on the decoded frames of a
* video.
* 3. `MPPRunningModeLiveStream`: The mode for performing segmentation on a live stream of
* input data, such as from the camera.
*/
@property(nonatomic) MPPRunningMode runningMode;
/**
* An object that confirms to `MPPImageSegmenterLiveStreamDelegate` protocol. This object must
* implement `imageSegmenter:didFinishSegmentationWithResult:timestampInMilliseconds:error:` to
* receive the results of performing asynchronous segmentation on images (i.e, when `runningMode` =
* `MPPRunningModeLiveStream`).
*/
@property(nonatomic, weak, nullable) id<MPPImageSegmenterLiveStreamDelegate>
imageSegmenterLiveStreamDelegate;
/**
* The locale to use for display names specified through the TFLite Model Metadata, if any. Defaults
* to English.
*/
@property(nonatomic, copy) NSString *displayNamesLocale;
/** Represents whether to output confidence masks. */
@property(nonatomic) BOOL shouldOutputConfidenceMasks;
/** Represents whether to output category mask. */
@property(nonatomic) BOOL shouldOutputCategoryMasks;
@end
NS_ASSUME_NONNULL_END

View File

@ -0,0 +1,40 @@
// Copyright 2023 The MediaPipe Authors.
//
// 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 "mediapipe/tasks/ios/vision/image_segmenter/sources/MPPImageSegmenterOptions.h"
@implementation MPPImageSegmenterOptions
- (instancetype)init {
self = [super init];
if (self) {
_displayNamesLocale = @"en";
_shouldOutputConfidenceMasks = YES;
}
return self;
}
- (id)copyWithZone:(NSZone *)zone {
MPPImageSegmenterOptions *imageSegmenterOptions = [super copyWithZone:zone];
imageSegmenterOptions.runningMode = self.runningMode;
imageSegmenterOptions.shouldOutputConfidenceMasks = self.shouldOutputConfidenceMasks;
imageSegmenterOptions.shouldOutputCategoryMasks = self.shouldOutputConfidenceMasks;
imageSegmenterOptions.displayNamesLocale = self.displayNamesLocale;
imageSegmenterOptions.imageSegmenterLiveStreamDelegate = self.imageSegmenterLiveStreamDelegate;
return imageSegmenterOptions;
}
@end