cassdlcm/mediapipe
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformatted using the clang formatter.

Browse Source
This commit is contained in:
Prianka Liz Kariat 2023-01-06 14:30:29 +05:30
parent 5f41d4591c
commit 95f5ea7203
1 changed files with 34 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
mediapipe/tasks/ios/core/sources/MPPTaskRunner.h
View File

@ -25,26 +25,26 @@ NS_ASSUME_NONNULL_BEGIN
*
* An instance of the newly created C++ task runner will be stored until this class is destroyed.
* When methods are called for processing (performing inference), closing etc., on this class,
* internally the appropriate methods will be called on the C++ task runner instance to execute
* the appropriate actions. For each type of task, a subclass of this class must be defined to add
* any additional functionality. For eg:, vision tasks must create an `MPPVisionTaskRunner` and
* provide additional functionality. An instance of `MPPVisionTaskRunner` can in turn be used by
* the each vision task for creation and execution of the task. Please see the documentation for
* the C++ Task Runner for more details on how the taks runner operates.
* internally the appropriate methods will be called on the C++ task runner instance to execute the
* appropriate actions. For each type of task, a subclass of this class must be defined to add any
* additional functionality. For eg:, vision tasks must create an `MPPVisionTaskRunner` and provide
* additional functionality. An instance of `MPPVisionTaskRunner` can in turn be used by the each
* vision task for creation and execution of the task. Please see the documentation for the C++ Task
* Runner for more details on how the taks runner operates.
**/
@interface MPPTaskRunner : NSObject
/**
* Initializes a new `MPPTaskRunner` with the MediaPipe calculator configuration proto and an optional
* C++ packets callback.
* Initializes a new `MPPTaskRunner` with the MediaPipe calculator configuration proto and an
* optional C++ packets callback.
*
* You can pass `nullptr` for `packetsCallback` in case the mode of operation
* requested by the user is synchronous.
* You can pass `nullptr` for `packetsCallback` in case the mode of operation requested by the user
* is synchronous.
*
* If the task is operating in asynchronous mode, any iOS MediaPipe task that uses the `MPPTaskRunner`
* must define a C++ callback function to obtain the results of inference asynchronously and deliver
* the results to the user. To accomplish this, callback function will in turn invoke the block
* provided by the user in the task options supplied to create the task.
* If the task is operating in asynchronous mode, any iOS MediaPipe task that uses the
* `MPPTaskRunner` must define a C++ callback function to obtain the results of inference
* asynchronously and deliver the results to the user. To accomplish this, callback function will in
* turn invoke the block provided by the user in the task options supplied to create the task.
* Please see the documentation of the C++ Task Runner for more information on the synchronous and
* asynchronous modes of operation.
*
@ -61,22 +61,23 @@ NS_ASSUME_NONNULL_BEGIN
(mediapipe::tasks::core::PacketsCallback)packetsCallback
error:(NSError **)error NS_DESIGNATED_INITIALIZER;
/** A synchronous method for processing batch data or offline streaming data. This method is
* designed for processing either batch data such as unrelated images and texts or offline streaming
* data such as the decoded frames from a video file and an audio file. The call blocks the current
/**
* A synchronous method for processing batch data or offline streaming data. This method is designed
* for processing either batch data such as unrelated images and texts or offline streaming data
* such as the decoded frames from a video file and an audio file. The call blocks the current
* thread until a failure status or a successful result is returned. If the input packets have no
* timestamp, an internal timestamp will be assigend per invocation. Otherwise, when the timestamp is
* set in the input packets, the caller must ensure that the input packet timestamps are greater than
* the timestamps of the previous invocation. This method is thread-unsafe and it is the caller's
* responsibility to synchronize access to this method across multiple threads and to ensure that the
* input packet timestamps are in order.
* timestamp, an internal timestamp will be assigend per invocation. Otherwise, when the timestamp
* is set in the input packets, the caller must ensure that the input packet timestamps are greater
* than the timestamps of the previous invocation. This method is thread-unsafe and it is the
* caller's responsibility to synchronize access to this method across multiple threads and to
* ensure that the input packet timestamps are in order.
**/
- (absl::StatusOr<mediapipe::tasks::core::PacketMap>)process:
(const mediapipe::tasks::core::PacketMap &)packetMap;
/**
* Shuts down the C++ task runner. After the runner is closed, any calls that send input data to
* the runner are illegal and will receive errors.
* Shuts down the C++ task runner. After the runner is closed, any calls that send input data to the
* runner are illegal and will receive errors.
**/
- (absl::Status)close;