mmdeploy/csrc/apis/c/rotated_detector.h

// Copyright (c) OpenMMLab. All rights reserved.

/**
 * @file rotated_detector.h
 * @brief Interface to MMRotate task
 */

#ifndef MMDEPLOY_SRC_APIS_C_ROTATED_DETECTOR_H_
#define MMDEPLOY_SRC_APIS_C_ROTATED_DETECTOR_H_

#include "common.h"
#include "executor.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct mm_rotated_detect_t {
  int label_id;
  float score;
  float rbbox[5];  // cx, cy, w, h, angle
} mm_rotated_detect_t;

/**
 * @brief Create rotated detector's handle
 * @param[in] model an instance of mmrotate sdk model created by
 * \ref mmdeploy_model_create_by_path or \ref mmdeploy_model_create in \ref model.h
 * @param[in] device_name name of device, such as "cpu", "cuda", etc.
 * @param[in] device_id id of device.
 * @param[out] handle instance of a rotated detector
 * @return status of creating rotated detector's handle
 */
MMDEPLOY_API int mmdeploy_rotated_detector_create(mm_model_t model, const char* device_name,
                                                  int device_id, mm_handle_t* handle);

/**
 * @brief Create rotated detector's handle
 * @param[in] model_path path of mmrotate sdk model exported by mmdeploy model converter
 * @param[in] device_name name of device, such as "cpu", "cuda", etc.
 * @param[in] device_id id of device.
 * @param[out] handle instance of a rotated detector
 * @return status of creating rotated detector's handle
 */
MMDEPLOY_API int mmdeploy_rotated_detector_create_by_path(const char* model_path,
                                                          const char* device_name, int device_id,
                                                          mm_handle_t* handle);

/**
 * @brief Apply rotated detector to batch images and get their inference results
 * @param[in] handle rotated detector's handle created by \ref
 * mmdeploy_rotated_detector_create_by_path
 * @param[in] mats a batch of images
 * @param[in] mat_count number of images in the batch
 * @param[out] results a linear buffer to save detection results of each image. It must be released
 * by \ref mmdeploy_rotated_detector_release_result
 * @param[out] result_count a linear buffer with length being \p mat_count to save the number of
 * detection results of each image. And it must be released by \ref
 * mmdeploy_rotated_detector_release_result
 * @return status of inference
 */
MMDEPLOY_API int mmdeploy_rotated_detector_apply(mm_handle_t handle, const mm_mat_t* mats,
                                                 int mat_count, mm_rotated_detect_t** results,
                                                 int** result_count);

/** @brief Release the inference result buffer created by \ref mmdeploy_rotated_detector_apply
 * @param[in] results rotated detection results buffer
 * @param[in] result_count  \p results size buffer
 */
MMDEPLOY_API void mmdeploy_rotated_detector_release_result(mm_rotated_detect_t* results,
                                                           const int* result_count);

/**
 * @brief Destroy rotated detector's handle
 * @param[in] handle rotated detector's handle created by \ref
 * mmdeploy_rotated_detector_create_by_path or by \ref mmdeploy_rotated_detector_create
 */
MMDEPLOY_API void mmdeploy_rotated_detector_destroy(mm_handle_t handle);

/******************************************************************************
 * Experimental asynchronous APIs */

/**
 * @brief Same as \ref mmdeploy_detector_create, but allows to control execution context of tasks
 * via exec_info
 */
MMDEPLOY_API int mmdeploy_rotated_detector_create_v2(mm_model_t model, const char* device_name,
                                                     int device_id, mmdeploy_exec_info_t exec_info,
                                                     mm_handle_t* handle);

/**
 * @brief Pack rotated detector inputs into mmdeploy_value_t
 * @param[in] mats a batch of images
 * @param[in] mat_count number of images in the batch
 * @return the created value
 */
MMDEPLOY_API int mmdeploy_rotated_detector_create_input(const mm_mat_t* mats, int mat_count,
                                                        mmdeploy_value_t* input);

/**
 * @brief Same as \ref mmdeploy_rotated_detector_apply, but input and output are packed in \ref
 * mmdeploy_value_t.
 */
MMDEPLOY_API int mmdeploy_rotated_detector_apply_v2(mm_handle_t handle, mmdeploy_value_t input,
                                                    mmdeploy_value_t* output);

/**
 * @brief Apply rotated detector asynchronously
 * @param[in] handle handle to the detector
 * @param[in] input input sender
 * @return output sender
 */
MMDEPLOY_API int mmdeploy_rotated_detector_apply_async(mm_handle_t handle, mmdeploy_sender_t input,
                                                       mmdeploy_sender_t* output);

/**
 * @brief Unpack rotated detector output from a mmdeploy_value_t
 * @param[in] output output obtained by applying a detector
 * @param[out] results a linear buffer to save detection results of each image. It must be released
 * by \ref mmdeploy_detector_release_result
 * @param[out] result_count a linear buffer with length number of input images to save the number of
 * detection results of each image. Must be released by \ref
 * mmdeploy_detector_release_result
 * @return status of the operation
 */
MMDEPLOY_API int mmdeploy_rotated_detector_get_result(mmdeploy_value_t output,
                                                      mm_rotated_detect_t** results,
                                                      int** result_count);

#ifdef __cplusplus
}
#endif

#endif  // MMDEPLOY_SRC_APIS_C_ROTATED_DETECTOR_H_