Added iOS pose landmarker header

mediapipe/tasks/ios/vision/pose_landmarker/BUILD

@@ -45,3 +45,15 @@ objc_library(
     deps = ["//mediapipe/tasks/ios/components/containers:MPPConnection"],
 )
 
+objc_library(
+    name = "MPPPoseLandmarker",
+    hdrs = ["sources/MPPPoseLandmarker.h"],
+    module_name = "MPPPoseLandmarker",
+    deps = [
+        ":MPPPoseLandmarkerOptions",
+        ":MPPPoseLandmarkerResult",
+        ":MPPPoseLandmarksConnections",
+        "//mediapipe/tasks/ios/components/containers:MPPConnection",
+        "//mediapipe/tasks/ios/vision/core:MPPImage",
+    ],
+)

mediapipe/tasks/ios/vision/pose_landmarker/sources/MPPPoseLandmarker.h

@@ -0,0 +1,161 @@
+// 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/pose_landmarker/sources/MPPPoseLandmarkerOptions.h"
+#import "mediapipe/tasks/ios/vision/pose_landmarker/sources/MPPPoseLandmarkerResult.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * @brief Performs pose landmarks detection on images.
+ *
+ * This API expects a pre-trained pose landmarks model asset bundle.
+ */
+NS_SWIFT_NAME(PoseLandmarker)
+@interface MPPPoseLandmarker : NSObject
+
+/** The array of connections between all the landmarks in the detected pose. */
+@property(class, nonatomic, readonly) NSArray<MPPConnection *> *poseLandmarks;
+
+/**
+ * Creates a new instance of `PoseLandmarker` from an absolute path to a model asset bundle stored
+ * locally on the device and the default `PoseLandmarkerOptions`.
+ *
+ * @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
+ * pose landmarker.
+ *
+ * @return A new instance of `PoseLandmarker` with the given model path. `nil` if there is an error
+ * in initializing the pose landmarker.
+ */
+- (nullable instancetype)initWithModelPath:(NSString *)modelPath error:(NSError **)error;
+
+/**
+ * Creates a new instance of `PoseLandmarker` from the given `PoseLandmarkerOptions`.
+ *
+ * @param options The options of type `PoseLandmarkerOptions` to use for configuring the
+ * `PoseLandmarker`.
+ * @param error An optional error parameter populated when there is an error in initializing the
+ * pose landmarker.
+ *
+ * @return A new instance of `PoseLandmarker` with the given options. `nil` if there is an error in
+ * initializing the pose landmarker.
+ */
+- (nullable instancetype)initWithOptions:(MPPPoseLandmarkerOptions *)options
+                                   error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/**
+ * Performs pose landmarks detection on the provided `MPImage` using the whole image as region of
+ * interest. Rotation will be applied according to the `orientation` property of the provided
+ * `MPImage`. Only use this method when the `PoseLandmarker` is created with running mode, `.image`.
+ *
+ * This method supports performing pose landmarks detection on RGBA images. If your `MPImage` has a
+ * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of
+ * the following pixel format types:
+ * 1. kCVPixelFormatType_32BGRA
+ *
+ * If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha
+ * channel.
+ *
+ * @param image The `MPImage` on which pose landmarks detection is to be performed.
+ * @param error An optional error parameter populated when there is an error in performing pose
+ * landmark detection on the input image.
+ *
+ * @return  An `PoseLandmarkerResult` object that contains the pose landmarks detection
+ * results.
+ */
+- (nullable MPPPoseLandmarkerResult *)detectImage:(MPPImage *)image
+                                            error:(NSError **)error NS_SWIFT_NAME(detect(image:));
+
+/**
+ * Performs pose landmarks detection on the provided video frame of type `MPImage` using the whole
+ * image as region of interest. Rotation will be applied according to the `orientation` property of
+ * the provided `MPImage`. Only use this method when the `PoseLandmarker` is created with running
+ * mode, `.video`.
+ *
+ * It's required to provide the video frame's timestamp (in milliseconds). The input timestamps must
+ * be monotonically increasing.
+ *
+ * This method supports performing pose landmarks detection on RGBA images. If your `MPImage` has a
+ * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of
+ * the following pixel format types:
+ * 1. kCVPixelFormatType_32BGRA
+ *
+ * If your `MPImage` has a source type of `.image` ensure that the color space is RGB with an Alpha
+ * channel.
+ *
+ * @param image The `MPImage` on which pose 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 pose
+ * landmark detection on the input video frame.
+ *
+ * @return  An `PoseLandmarkerResult` object that contains the pose landmarks detection
+ * results.
+ */
+- (nullable MPPPoseLandmarkerResult *)detectVideoFrame:(MPPImage *)image
+                               timestampInMilliseconds:(NSInteger)timestampInMilliseconds
+                                                 error:(NSError **)error
+    NS_SWIFT_NAME(detect(videoFrame:timestampInMilliseconds:));
+
+/**
+ * Sends live stream image data of type `MPImage` to perform pose landmarks detection using the
+ * whole image as region of interest. Rotation will be applied according to the `orientation`
+ * property of the provided `MPImage`. Only use this method when the `PoseLandmarker` is created
+ * with running mode, `.liveStream`.
+ *
+ * The object which needs to be continuously notified of the available results of pose landmark
+ * detection must confirm to `PoseLandmarkerLiveStreamDelegate` protocol and implement the
+ * `poseLandmarker(_:didFinishDetectionWithResult:timestampInMilliseconds:error:)` delegate method.
+ *
+ * It's required to provide a timestamp (in milliseconds) to indicate when the input image is sent
+ * to the pose landmarker. The input timestamps must be monotonically increasing.
+ *
+ * This method supports performing pose landmarks detection on RGBA images. If your `MPImage` has a
+ * source type of `.pixelBuffer` or `.sampleBuffer`, the underlying pixel buffer must have one of
+ * the following pixel format types:
+ * 1. kCVPixelFormatType_32BGRA
+ *
+ * If the input `MPImage` has a source type of `.image` ensure that the color space is RGB with an
+ * Alpha channel.
+ *
+ * If this method is used for performing pose landmarks detection on live camera frames using
+ * `AVFoundation`, ensure that you request `AVCaptureVideoDataOutput` to output frames in
+ * `kCMPixelFormat_32BGRA` using its `videoSettings` property.
+ *
+ * @param image A live stream image data of type `MPImage` on which pose landmarks detection is to
+ * be performed.
+ * @param timestampInMilliseconds The timestamp (in milliseconds) which indicates when the input
+ * image is sent to the pose landmarker. The input timestamps must be monotonically increasing.
+ * @param error An optional error parameter populated when there is an error in performing pose
+ * landmark detection on the input live stream image data.
+ *
+ * @return `YES` if the image was sent to the task successfully, otherwise `NO`.
+ */
+- (BOOL)detectAsyncImage:(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