Added MPPHandLandmarker
This commit is contained in:
Prianka Liz Kariat
parent
ad499c170a
commit
0c33601510
|
|
@ -37,3 +37,21 @@ objc_library(
|
|||
"//mediapipe/tasks/ios/vision/core:MPPRunningMode",
|
||||
],
|
||||
)
|
||||
|
||||
objc_library(
|
||||
name = "MPPHandLandmarker",
|
||||
hdrs = ["sources/MPPHandLandmarker.h"],
|
||||
copts = [
|
||||
"-ObjC++",
|
||||
"-std=c++17",
|
||||
"-x objective-c++",
|
||||
],
|
||||
module_name = "MPPHandLandmarker",
|
||||
deps = [
|
||||
":MPPHandLandmarkerOptions",
|
||||
":MPPHandLandmarkerResult",
|
||||
"//mediapipe/tasks/ios/components/containers:MPPConnection",
|
||||
"//mediapipe/tasks/ios/vision/core:MPPImage",
|
||||
],
|
||||
)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,181 @@
|
|||
// 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/components/containers/sources/MPPConnection.h"
|
||||
#import "mediapipe/tasks/ios/vision/core/sources/MPPImage.h"
|
||||
#import "mediapipe/tasks/ios/vision/hand_landmarker/sources/MPPHandLandmarkerOptions.h"
|
||||
#import "mediapipe/tasks/ios/vision/hand_landmarker/sources/MPPHandLandmarkerResult.h"
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
/**
|
||||
* @brief Performs hand landmarks detection on images.
|
||||
*
|
||||
* This API expects a pre-trained hand landmarks model asset bundle.
|
||||
*/
|
||||
NS_SWIFT_NAME(HandLandmarker)
|
||||
@interface MPPHandLandmarker : NSObject
|
||||
|
||||
/** The connections between the landmarks in the palm. */
|
||||
@property(nonatomic, readonly) NSArray<MPPConnection *> *handPalmConnections;
|
||||
|
||||
/** The connections between the landmarks in the index finger. */
|
||||
@property(nonatomic, readonly) NSArray<MPPConnection *> *handIndexFingerConnections;
|
||||
|
||||
/** The connections between the landmarks in the middle finger. */
|
||||
@property(nonatomic, readonly) NSArray<MPPConnection *> *handMiddleFingerConnections;
|
||||
|
||||
/** The connections between the landmarks in the ring finger. */
|
||||
@property(nonatomic, readonly) NSArray<MPPConnection *> *handRingFingerConnections;
|
||||
|
||||
/** The connections between the landmarks in the pinky. */
|
||||
@property(nonatomic, readonly) NSArray<MPPConnection *> *handPinkyConnections;
|
||||
|
||||
/** The connections between all the landmarks in the hand. */
|
||||
@property(nonatomic, readonly) NSArray<MPPConnection *> *handConnections;
|
||||
|
||||
/**
|
||||
* Creates a new instance of `MPPHandLandmarker` from an absolute path to a model asset bundle
|
||||
* stored locally on the device and the default `MPPHandLandmarkerOptions`.
|
||||
*
|
||||
* @param modelPath An absolute path to a model asset bundle stored locally on the device.
|
||||
* @param error An optional error parameter populated when there is an error in initializing the
|
||||
* hand landmarker.
|
||||
*
|
||||
* @return A new instance of `MPPHandLandmarker` with the given model path. `nil` if there is an
|
||||
* error in initializing the hand landmarker.
|
||||
*/
|
||||
- (nullable instancetype)initWithModelPath:(NSString *)modelPath error:(NSError **)error;
|
||||
|
||||
/**
|
||||
* Creates a new instance of `MPPHandLandmarker` from the given `MPPHandLandmarkerOptions`.
|
||||
*
|
||||
* @param options The options of type `MPPHandLandmarkerOptions` to use for configuring the
|
||||
* `MPPHandLandmarker`.
|
||||
* @param error An optional error parameter populated when there is an error in initializing the
|
||||
* hand landmarker.
|
||||
*
|
||||
* @return A new instance of `MPPHandLandmarker` with the given options. `nil` if there is an
|
||||
* error in initializing the hand landmarker.
|
||||
*/
|
||||
- (nullable instancetype)initWithOptions:(MPPHandLandmarkerOptions *)options
|
||||
error:(NSError **)error NS_DESIGNATED_INITIALIZER;
|
||||
|
||||
/**
|
||||
* Performs hand landmarks detection on the provided `MPPImage` using the whole image as region of
|
||||
* interest. Rotation will be applied according to the `orientation` property of the provided
|
||||
* `MPPImage`. Only use this method when the `MPPHandLandmarker` is created with
|
||||
* `MPPRunningModeImage`.
|
||||
*
|
||||
* This method supports performing hand landmarks detection on RGBA images. If your `MPPImage` has a
|
||||
* source type of `MPPImageSourceTypePixelBuffer` or `MPPImageSourceTypeSampleBuffer`, the
|
||||
* underlying pixel buffer must have one of the following pixel format types:
|
||||
* 1. kCVPixelFormatType_32BGRA
|
||||
* 2. kCVPixelFormatType_32RGBA
|
||||
*
|
||||
* If your `MPPImage` has a source type of `MPPImageSourceTypeImage` ensure that the color space is
|
||||
* RGB with an Alpha channel.
|
||||
*
|
||||
* @param image The `MPPImage` on which hand landmarks detection is to be performed.
|
||||
* @param error An optional error parameter populated when there is an error in performing hand
|
||||
* landmarks detection on the input image.
|
||||
*
|
||||
* @return An `MPPHandLandmarkerResult` object that contains the hand hand landmarks detection
|
||||
* results.
|
||||
*/
|
||||
- (nullable MPPHandLandmarkerResult *)detectInImage:(MPPImage *)image
|
||||
error:(NSError **)error NS_SWIFT_NAME(detect(image:));
|
||||
|
||||
/**
|
||||
* Performs hand landmarks detection on the provided video frame of type `MPPImage` using the whole
|
||||
* image as region of interest. Rotation will be applied according to the `orientation` property of
|
||||
* the provided `MPPImage`. Only use this method when the `MPPHandLandmarker` is created with
|
||||
* `MPPRunningModeVideo`.
|
||||
*
|
||||
* It's required to provide the video frame's timestamp (in milliseconds). The input timestamps must
|
||||
* be monotonically increasing.
|
||||
*
|
||||
* This method supports performing hand landmarks detection on RGBA images. If your `MPPImage` has a
|
||||
* source type of `MPPImageSourceTypePixelBuffer` or `MPPImageSourceTypeSampleBuffer`, the
|
||||
* underlying pixel buffer must have one of the following pixel format types:
|
||||
* 1. kCVPixelFormatType_32BGRA
|
||||
* 2. kCVPixelFormatType_32RGBA
|
||||
*
|
||||
* If your `MPPImage` has a source type of `MPPImageSourceTypeImage` ensure that the color space is
|
||||
* RGB with an Alpha channel.
|
||||
*
|
||||
* @param image The `MPPImage` on which hand landmarks detection is to be performed.
|
||||
* @param timestampInMilliseconds The video frame's timestamp (in milliseconds). The input
|
||||
* timestamps must be monotonically increasing.
|
||||
* @param error An optional error parameter populated when there is an error in performing hand
|
||||
* landmarks detection on the input video frame.
|
||||
*
|
||||
* @return An `MPPHandLandmarkerResult` object that contains the hand hand landmarks detection
|
||||
* results.
|
||||
*/
|
||||
- (nullable MPPHandLandmarkerResult *)detectInVideoFrame:(MPPImage *)image
|
||||
timestampInMilliseconds:(NSInteger)timestampInMilliseconds
|
||||
error:(NSError **)error
|
||||
NS_SWIFT_NAME(detect(videoFrame:timestampInMilliseconds:));
|
||||
|
||||
/**
|
||||
* Sends live stream image data of type `MPPImage` to perform hand landmarks detection using the
|
||||
* whole image as region of interest. Rotation will be applied according to the `orientation`
|
||||
* property of the provided `MPPImage`. Only use this method when the `MPPHandLandmarker` is created
|
||||
* with `MPPRunningModeLiveStream`.
|
||||
*
|
||||
* The object which needs to be continuously notified of the available results of hand landmarks
|
||||
* detection must confirm to `MPPHandLandmarkerLiveStreamDelegate` protocol and implement the
|
||||
* `handLandmarker:didFinishDetectionWithResult:timestampInMilliseconds:error:`
|
||||
* delegate method.
|
||||
*
|
||||
* It's required to provide a timestamp (in milliseconds) to indicate when the input image is sent
|
||||
* to the hand landmarker. The input timestamps must be monotonically increasing.
|
||||
*
|
||||
* This method supports performing hand landmarks detection on RGBA images. If your `MPPImage` has a
|
||||
* source type of `MPPImageSourceTypePixelBuffer` or `MPPImageSourceTypeSampleBuffer`, the
|
||||
* underlying pixel buffer must have one of the following pixel format types:
|
||||
* 1. kCVPixelFormatType_32BGRA
|
||||
* 2. kCVPixelFormatType_32RGBA
|
||||
*
|
||||
* If the input `MPPImage` has a source type of `MPPImageSourceTypeImage` ensure that the color
|
||||
* space is RGB with an Alpha channel.
|
||||
*
|
||||
* If this method is used for performing hand landmarks detection on live camera frames using
|
||||
* `AVFoundation`, ensure that you request `AVCaptureVideoDataOutput` to output frames in
|
||||
* `kCMPixelFormat_32RGBA` using its `videoSettings` property.
|
||||
*
|
||||
* @param image A live stream image data of type `MPPImage` on which hand landmarks detection is to
|
||||
* be performed.
|
||||
* @param timestampInMilliseconds The timestamp (in milliseconds) which indicates when the input
|
||||
* image is sent to the hand landmarker. The input timestamps must be monotonically increasing.
|
||||
* @param error An optional error parameter populated when there is an error in performing hand
|
||||
* landmarks detection on the input live stream image data.
|
||||
*
|
||||
* @return `YES` if the image was sent to the task successfully, otherwise `NO`.
|
||||
*/
|
||||
- (BOOL)detectAsyncInImage:(MPPImage *)image
|
||||
timestampInMilliseconds:(NSInteger)timestampInMilliseconds
|
||||
error:(NSError **)error
|
||||
NS_SWIFT_NAME(detectAsync(image:timestampInMilliseconds:));
|
||||
|
||||
- (instancetype)init NS_UNAVAILABLE;
|
||||
|
||||
+ (instancetype)new NS_UNAVAILABLE;
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
Loading…
Reference in New Issue
Block a user