diff options
author | Vibhav Aggarwal <v.aggarwal@samsung.com> | 2024-06-12 18:09:43 +0900 |
---|---|---|
committer | Vibhav Aggarwal <v.aggarwal@samsung.com> | 2024-06-12 18:09:43 +0900 |
commit | 5ee3a4ba41c4de5241f4fed867a60e575d7fc09b (patch) | |
tree | 3140d074673a093509080e04cac3a8ebde3e5d08 /include/mv_facial_landmark_internal.h | |
parent | 73632120a834f87d020841985eff7f307a3abf28 (diff) | |
download | mediavision-5ee3a4ba41c4de5241f4fed867a60e575d7fc09b.tar.gz mediavision-5ee3a4ba41c4de5241f4fed867a60e575d7fc09b.tar.bz2 mediavision-5ee3a4ba41c4de5241f4fed867a60e575d7fc09b.zip |
[ACR-1848] Publish machine learning APIsaccepted/tizen/unified/x/asan/20240625.092955accepted/tizen/unified/x/20240619.013513accepted/tizen/unified/toolchain/20240624.121719accepted/tizen/unified/dev/20240620.004157accepted/tizen/unified/20240618.060058accepted/tizen_unified_x_asanaccepted/tizen_unified_toolchain
Please refer to the following ACR:
https://jira.sec.samsung.net/browse/ACR-1848
Change-Id: I92c053b3cb1d872735ccd548a091ba9e6b29861f
Signed-off-by: Vibhav Aggarwal <v.aggarwal@samsung.com>
Diffstat (limited to 'include/mv_facial_landmark_internal.h')
-rw-r--r-- | include/mv_facial_landmark_internal.h | 198 |
1 files changed, 0 insertions, 198 deletions
diff --git a/include/mv_facial_landmark_internal.h b/include/mv_facial_landmark_internal.h index 411e983c..cbf9651a 100644 --- a/include/mv_facial_landmark_internal.h +++ b/include/mv_facial_landmark_internal.h @@ -37,50 +37,6 @@ extern "C" { /** * @internal - * @brief Creates a inference handle for facial landmark object. - * @details Use this function to create a inference handle. After the creation - * the facial landmark task has to be prepared with - * mv_facial_landmark_prepare() function to prepare a network - * for the inference. - * - * @since_tizen 9.0 - * - * @remarks The @a infer should be released using mv_facial_landmark_destroy(). - * - * @param[out] handle The handle to the inference to be created. - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MEDIA_VISION_ERROR_OUT_OF_MEMORY Out of memory - * - * @see mv_facial_landmark_destroy() - * @see mv_facial_landmark_prepare() - */ -int mv_facial_landmark_create(mv_facial_landmark_h *handle); - -/** - * @internal - * @brief Destroys inference handle and releases all its resources. - * - * @since_tizen 9.0 - * - * @param[in] handle The handle to the inference to be destroyed. - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * - * @pre Create inference handle by using mv_facial_landmark_create() - * - * @see mv_facial_landmark_create() - */ -int mv_facial_landmark_destroy(mv_facial_landmark_h handle); - -/** - * @internal * @brief Sets user-given model information. * @details Use this function to change the model information instead of default one after calling @ref mv_facial_landmark_create(). * @@ -104,160 +60,6 @@ int mv_facial_landmark_set_model(mv_facial_landmark_h handle, const char *model_ /** * @internal - * @brief Configures the backend for the facial landmark inference. - * - * @since_tizen 9.0 - * - * @param [in] handle The handle to the inference - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MEDIA_VISION_ERROR_INVALID_OPERATION Invalid operation - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - */ -int mv_facial_landmark_configure(mv_facial_landmark_h handle); - -/** - * @internal - * @brief Prepares the facial landmark inference - * @details Use this function to prepare the facial landmark inference based on - * the configured network. - * - * @since_tizen 9.0 - * - * @param[in] handle The handle to the inference. - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_PERMISSION_DENIED Permission denied - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MEDIA_VISION_ERROR_INVALID_DATA Invalid model data - * @retval #MEDIA_VISION_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MEDIA_VISION_ERROR_INVALID_OPERATION Invalid operation - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED_FORMAT Not supported format - */ -int mv_facial_landmark_prepare(mv_facial_landmark_h handle); - -/** - * @internal - * @brief Performs the facial landmark inference on the @a source. - * - * @since_tizen 9.0 - * @remarks This function is synchronous and may take considerable time to run. - * - * @param[in] handle The handle to the inference - * @param[in] source The handle to the source of the media - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MEDIA_VISION_ERROR_INTERNAL Internal error - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED_FORMAT Source colorspace - * isn't supported - * - * @pre Create a source handle by calling mv_create_source() - * @pre Create an inference handle by calling mv_facial_landmark_create() - * @pre Prepare an inference by calling mv_facial_landmark_configure() - * @pre Prepare an inference by calling mv_facial_landmark_prepare() - */ -int mv_facial_landmark_inference(mv_facial_landmark_h handle, mv_source_h source); - -/** - * @internal - * @brief Performs asynchronously the facial landmark inference on the @a source. - * - * @since_tizen 9.0 - * @remarks This function operates asynchronously, so it returns immediately upon invocation. - * The inference results are inserted into the outgoing queue within the framework - * in the order of processing, and the results can be obtained through mv_facial_landmark_get_positions(). - * - * @param[in] handle The handle to the inference - * @param[in] source The handle to the source of the media - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MEDIA_VISION_ERROR_INTERNAL Internal error - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED_FORMAT Source colorspace - * isn't supported - * - * @pre Create a source handle by calling mv_create_source() - * @pre Create an inference handle by calling mv_facial_landmark_create() - * @pre Prepare an inference by calling mv_facial_landmark_configure() - * @pre Prepare an inference by calling mv_facial_landmark_prepare() - */ -int mv_facial_landmark_inference_async(mv_facial_landmark_h handle, mv_source_h source); - -/** - * @internal - * @brief Gets the result count to objects. - * - * @since_tizen 9.0 - * - * @param[in] handle The handle to the inference - * @param[out] frame_number A frame number inferenced. - * @param[out] result_cnt A number of results. - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MEDIA_VISION_ERROR_INTERNAL Internal error - * - * @pre Create a source handle by calling mv_create_source() - * @pre Create an inference handle by calling mv_facial_landmark_create() - * @pre Prepare an inference by calling mv_facial_landmark_configure() - * @pre Prepare an inference by calling mv_facial_landmark_prepare() - * @pre Request an inference by calling mv_facial_landmark_inference() - */ -int mv_facial_landmark_get_result_count(mv_facial_landmark_h handle, unsigned long *frame_number, - unsigned int *result_cnt); - -/** - * @internal - * @brief Gets the facial landmark position values to a given index. - * - * @since_tizen 9.0 - * @remarks pos_x and pos_y arrays are allocated internally by the framework and will remain valid - * until the handle is released. - * Please do not deallocate them directly, and if you want to use them after the handle is released, - * please copy them to user memory and use the copy. - * - * This function operates differently depending on the inference request method. - * - After mv_facial_landmark_inference() calls, this function returns facial landmark positions immediately. - * - After mv_facial_landmark_inference_async() calls, this function can be blocked until the asynchronous inference request is completed - * or the timeout occurs if no result within 3 seconds. - * - * Additionally, after calling the mv_facial_landmark_inference_async function, the function operates - * in asynchronous mode until the handle is released. - * - * @param[in] handle The handle to the inference - * @param[in] index A result index. - * @param[out] pos_x An array containing x-coordinate values. - * @param[out] pos_y An array containing y-coordinate values. - * - * @return @c 0 on success, otherwise a negative error value - * @retval #MEDIA_VISION_ERROR_NONE Successful - * @retval #MEDIA_VISION_ERROR_NOT_SUPPORTED Not supported - * @retval #MEDIA_VISION_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MEDIA_VISION_ERROR_INTERNAL Internal error - * - * @pre Create a source handle by calling mv_create_source() - * @pre Create an inference handle by calling mv_facial_landmark_create() - * @pre Prepare an inference by calling mv_facial_landmark_configure() - * @pre Prepare an inference by calling mv_facial_landmark_prepare() - * @pre Prepare an inference by calling mv_facial_landmark_inference() - * @pre Get result count by calling mv_facial_landmark_get_result_count() - */ -int mv_facial_landmark_get_position(mv_facial_landmark_h handle, unsigned int index, unsigned int *pos_x, - unsigned int *pos_y); - -/** - * @internal * @brief Sets user-given inference engine and device types for inference. * @details Use this function to change the inference engine and device types for inference instead of default ones after calling @ref mv_facial_landmark_create(). * |