mirror of
https://github.com/open-mmlab/mmdeploy.git
synced 2025-01-14 08:09:43 +08:00
d79413fa32
* update c-api's comments by following doxygen's guide * fix according to review comments
63 lines
2.4 KiB
C
63 lines
2.4 KiB
C
// Copyright (c) OpenMMLab. All rights reserved.
|
|
|
|
/**
|
|
* @file restorer.h
|
|
* @brief Interface to MMEditing image restoration task
|
|
*/
|
|
|
|
#ifndef MMDEPLOY_SRC_APIS_C_RESTORER_H_
|
|
#define MMDEPLOY_SRC_APIS_C_RESTORER_H_
|
|
|
|
#include "common.h"
|
|
|
|
/**
|
|
* @brief Create a restorer instance
|
|
* @param[in] model an instance of image restoration 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 handle of the created restorer, which must be destroyed
|
|
* by \ref mmdeploy_restorer_destroy
|
|
* @return status code of the operation
|
|
*/
|
|
MM_SDK_API int mmdeploy_restorer_create(mm_model_t model, const char* device_name, int device_id,
|
|
mm_handle_t* handle);
|
|
|
|
/**
|
|
* @brief Create a restorer instance
|
|
* @param[in] model_path path to image restoration model
|
|
* @param[in] device_name name of device, such as "cpu", "cuda", etc.
|
|
* @param[in] device_id id of device.
|
|
* @param[out] handle handle of the created restorer, which must be destroyed
|
|
* by \ref mmdeploy_restorer_destroy
|
|
* @return status code of the operation
|
|
*/
|
|
MM_SDK_API int mmdeploy_restorer_create_by_path(const char* model_path, const char* device_name,
|
|
int device_id, mm_handle_t* handle);
|
|
|
|
/**
|
|
* @brief Apply restorer to a batch of images
|
|
* @param[in] handle restorer's handle created by \ref mmdeploy_restorer_create_by_path
|
|
* @param[in] images a batch of images
|
|
* @param[in] count number of images in the batch
|
|
* @param[out] results a linear buffer contains the restored images, must be release
|
|
* by \ref mmdeploy_restorer_release_result
|
|
* @return status code of the operation
|
|
*/
|
|
MM_SDK_API int mmdeploy_restorer_apply(mm_handle_t handle, const mm_mat_t* images, int count,
|
|
mm_mat_t** results);
|
|
|
|
/** @brief Release result buffer returned by \ref mmdeploy_restorer_apply
|
|
* @param[in] results result buffer by restorer
|
|
* @param[in] count length of \p result
|
|
*/
|
|
MM_SDK_API void mmdeploy_restorer_release_result(mm_mat_t* results, int count);
|
|
|
|
/**
|
|
* @brief destroy restorer
|
|
* @param[in] handle handle of restorer created by \ref mmdeploy_restorer_create_by_path
|
|
*/
|
|
MM_SDK_API void mmdeploy_restorer_destroy(mm_handle_t handle);
|
|
|
|
#endif // MMDEPLOY_SRC_APIS_C_RESTORER_H_
|