Files
FastDeploy/c_api/fastdeploy_capi/vision/result.h
chenjian 091e039991 [C API] Add create api for c results (#1547)
add create api for c results
2023-03-09 11:11:47 +08:00

359 lines
11 KiB
C++

// Copyright (c) 2023 PaddlePaddle Authors. All Rights Reserved.
//
// 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.
#pragma once
#include "fastdeploy_capi/core/fd_common.h"
#include "fastdeploy_capi/core/fd_type.h"
typedef struct FD_C_ClassifyResultWrapper FD_C_ClassifyResultWrapper;
typedef struct FD_C_DetectionResultWrapper FD_C_DetectionResultWrapper;
typedef struct FD_C_OCRResultWrapper FD_C_OCRResultWrapper;
typedef struct FD_C_SegmentationResultWrapper FD_C_SegmentationResultWrapper;
#ifdef __cplusplus
extern "C" {
#endif
typedef struct FD_C_ClassifyResult {
FD_C_OneDimArrayInt32 label_ids;
FD_C_OneDimArrayFloat scores;
FD_C_ResultType type;
} FD_C_ClassifyResult;
typedef struct FD_C_OneDimClassifyResult {
size_t size;
FD_C_ClassifyResult* data;
} FD_C_OneDimClassifyResult;
typedef struct FD_C_Mask {
FD_C_OneDimArrayUint8 data;
FD_C_OneDimArrayInt64 shape;
FD_C_ResultType type;
} FD_C_Mask;
typedef struct FD_C_OneDimMask {
size_t size;
FD_C_Mask* data;
} FD_C_OneDimMask; // std::vector<FD_C_Mask>
typedef struct FD_C_DetectionResult {
FD_C_TwoDimArrayFloat boxes;
FD_C_OneDimArrayFloat scores;
FD_C_OneDimArrayInt32 label_ids;
FD_C_OneDimMask masks;
FD_C_Bool contain_masks;
FD_C_ResultType type;
} FD_C_DetectionResult;
typedef struct FD_C_OneDimDetectionResult {
size_t size;
FD_C_DetectionResult* data;
} FD_C_OneDimDetectionResult;
typedef struct FD_C_OCRResult {
FD_C_TwoDimArrayInt32 boxes;
FD_C_OneDimArrayCstr text;
FD_C_OneDimArrayFloat rec_scores;
FD_C_OneDimArrayFloat cls_scores;
FD_C_OneDimArrayInt32 cls_labels;
FD_C_ResultType type;
} FD_C_OCRResult;
typedef struct FD_C_OneDimOCRResult {
size_t size;
FD_C_OCRResult* data;
} FD_C_OneDimOCRResult;
typedef struct FD_C_SegmentationResult {
FD_C_OneDimArrayUint8 label_map;
FD_C_OneDimArrayFloat score_map;
FD_C_OneDimArrayInt64 shape;
FD_C_Bool contain_score_map;
FD_C_ResultType type;
} FD_C_SegmentationResult;
typedef struct FD_C_OneDimSegmentationResult {
size_t size;
FD_C_SegmentationResult* data;
} FD_C_OneDimSegmentationResult;
// Classification Results
/** \brief Create a new FD_C_ClassifyResultWrapper object
*
* \return Return a pointer to FD_C_ClassifyResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_ClassifyResultWrapper*
FD_C_CreateClassifyResultWrapper();
/** \brief Destroy a FD_C_ClassifyResultWrapper object
*
* \param[in] fd_c_classify_result_wrapper pointer to FD_C_ClassifyResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroyClassifyResultWrapper(
__fd_take FD_C_ClassifyResultWrapper* fd_c_classify_result_wrapper);
/** \brief Create a new FD_C_ClassifyResult object
*
* \return Return a pointer to FD_C_ClassifyResult object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_ClassifyResult*
FD_C_CreateClassifyResult();
/** \brief Destroy a FD_C_ClassifyResult object
*
* \param[in] fd_c_classify_result pointer to FD_C_ClassifyResult object
*/
FASTDEPLOY_CAPI_EXPORT extern void
FD_C_DestroyClassifyResult(__fd_take FD_C_ClassifyResult* fd_c_classify_result);
/** \brief Get a FD_C_ClassifyResult object from FD_C_ClassifyResultWrapper object
*
* \param[in] fd_c_classify_result_wrapper pointer to FD_C_ClassifyResultWrapper object
* \param[out] fd_c_classify_result pointer to FD_C_ClassifyResult object used to store data
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give void
FD_C_ClassifyResultWrapperToCResult(
__fd_keep FD_C_ClassifyResultWrapper* fd_c_classify_result_wrapper,
__fd_keep FD_C_ClassifyResult* fd_c_classify_result);
/** \brief Create a new FD_C_ClassifyResultWrapper object from FD_C_ClassifyResult object
*
* \param[in] fd_c_classify_result pointer to FD_C_ClassifyResult object
* \return Return a pointer to FD_C_ClassifyResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_ClassifyResultWrapper*
FD_C_CreateClassifyResultWrapperFromCResult(
__fd_keep FD_C_ClassifyResult* fd_c_classify_result);
/** \brief Print ClassifyResult formated information
*
* \param[in] fd_c_classify_result pointer to FD_C_ClassifyResult object
* \param[out] str_buffer used to store string
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give void
FD_C_ClassifyResultStr(
__fd_keep FD_C_ClassifyResult* fd_c_classify_result, char* str_buffer);
// Detection Results
/** \brief Create a new FD_C_DetectionResultWrapper object
*
* \return Return a pointer to FD_C_DetectionResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_DetectionResultWrapper*
FD_C_CreateDetectionResultWrapper();
/** \brief Destroy a FD_C_DetectionResultWrapper object
*
* \param[in] fd_c_detection_result_wrapper pointer to FD_C_DetectionResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroyDetectionResultWrapper(
__fd_take FD_C_DetectionResultWrapper* fd_c_detection_result_wrapper);
/** \brief Create a new FD_C_DetectionResult object
*
* \return Return a pointer to FD_C_DetectionResult object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_DetectionResult*
FD_C_CreateDetectionResult();
/** \brief Destroy a FD_C_DetectionResult object
*
* \param[in] fd_c_detection_result pointer to FD_C_DetectionResult object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroyDetectionResult(
__fd_take FD_C_DetectionResult* fd_c_detection_result);
/** \brief Get a FD_C_DetectionResult object from FD_C_DetectionResultWrapper object
*
* \param[in] fd_c_detection_result_wrapper pointer to FD_C_DetectionResultWrapper object
* \param[out] fd_c_detection_result pointer to FD_C_DetectionResult object used to store data
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give void
FD_C_DetectionResultWrapperToCResult(
__fd_keep FD_C_DetectionResultWrapper* fd_c_detection_result_wrapper,
__fd_keep FD_C_DetectionResult* fd_c_detection_result);
/** \brief Create a new FD_C_DetectionResultWrapper object from FD_C_DetectionResult object
*
* \param[in] fd_c_detection_result pointer to FD_C_DetectionResult object
* \return Return a pointer to FD_C_DetectionResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_DetectionResultWrapper*
FD_C_CreateDetectionResultWrapperFromCResult(
__fd_keep FD_C_DetectionResult* fd_c_detection_result);
/** \brief Print DetectionResult formated information
*
* \param[in] fd_c_detection_result pointer to FD_C_DetectionResult object
* \param[out] str_buffer used to store string
*/
FASTDEPLOY_CAPI_EXPORT extern void
FD_C_DetectionResultStr(
__fd_keep FD_C_DetectionResult* fd_c_detection_result, char* str_buffer);
// OCR Results
/** \brief Create a new FD_C_OCRResultWrapper object
*
* \return Return a pointer to FD_C_OCRResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_OCRResultWrapper*
FD_C_CreateOCRResultWrapper();
/** \brief Destroy a FD_C_OCRResultWrapper object
*
* \param[in] fd_c_ocr_result_wrapper pointer to FD_C_OCRResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroyOCRResultWrapper(
__fd_take FD_C_OCRResultWrapper* fd_c_ocr_result_wrapper);
/** \brief Create a new FD_C_OCRResult object
*
* \return Return a pointer to FD_C_OCRResult object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_OCRResult*
FD_C_CreateOCRResult();
/** \brief Destroy a FD_C_OCRResult object
*
* \param[in] fd_c_ocr_result pointer to FD_C_OCRResult object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroyOCRResult(
__fd_take FD_C_OCRResult* fd_c_ocr_result);
/** \brief Get a FD_C_OCRResult object from FD_C_OCRResultWrapper object
*
* \param[in] fd_c_ocr_result_wrapper pointer to FD_C_OCRResultWrapper object
* \param[out] fd_c_ocr_result pointer to FD_C_OCRResult object used to store data
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give void
FD_C_OCRResultWrapperToCResult(
__fd_keep FD_C_OCRResultWrapper* fd_c_ocr_result_wrapper,
__fd_keep FD_C_OCRResult* fd_c_ocr_result);
/** \brief Create a new FD_C_OCRResultWrapper object from FD_C_OCRResult object
*
* \param[in] fd_c_ocr_result pointer to FD_C_OCRResult object
* \return Return a pointer to FD_C_OCRResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_OCRResultWrapper*
FD_C_CreateOCRResultWrapperFromCResult(
__fd_keep FD_C_OCRResult* fd_c_ocr_result);
/** \brief Print OCRResult formated information
*
* \param[in] fd_c_ocr_result pointer to FD_C_OCRResult object
* \param[out] str_buffer used to store string
*/
FASTDEPLOY_CAPI_EXPORT extern void
FD_C_OCRResultStr(
__fd_keep FD_C_OCRResult* fd_c_ocr_result, char* str_buffer);
// Segmentation Results
/** \brief Create a new FD_C_SegmentationResultWrapper object
*
* \return Return a pointer to FD_C_SegmentationResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_SegmentationResultWrapper*
FD_C_CreateSegmentationResultWrapper();
/** \brief Destroy a FD_C_SegmentationResultWrapper object
*
* \param[in] fd_c_segmentation_result_wrapper pointer to FD_C_SegmentationResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroySegmentationResultWrapper(
__fd_take FD_C_SegmentationResultWrapper* fd_c_segmentation_result_wrapper);
/** \brief Create a new FD_C_SegmentationResult object
*
* \return Return a pointer to FD_C_SegmentationResult object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_SegmentationResult*
FD_C_CreateSegmentationResult();
/** \brief Destroy a FD_C_SegmentationResult object
*
* \param[in] fd_c_segmentation_result pointer to FD_C_SegmentationResult object
*/
FASTDEPLOY_CAPI_EXPORT extern void FD_C_DestroySegmentationResult(
__fd_take FD_C_SegmentationResult* fd_c_segmentation_result);
/** \brief Get a FD_C_SegmentationResult object from FD_C_SegmentationResultWrapper object
*
* \param[in] fd_c_segmentation_result_wrapper pointer to FD_C_SegmentationResultWrapper object
* \param[out] fd_c_segmentation_result pointer to FD_C_SegmentationResult object used to store data
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give void
FD_C_SegmentationResultWrapperToCResult(
__fd_keep FD_C_SegmentationResultWrapper* fd_c_segmentation_result_wrapper,
__fd_keep FD_C_SegmentationResult* fd_c_segmentation_result);
/** \brief Create a new FD_C_SegmentationResultWrapper object from FD_C_SegmentationResult object
*
* \param[in] fd_c_segmentation_result pointer to FD_C_SegmentationResult object
* \return Return a pointer to FD_C_SegmentationResultWrapper object
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give FD_C_SegmentationResultWrapper*
FD_C_CreateSegmentationResultWrapperFromCResult(
__fd_keep FD_C_SegmentationResult* fd_c_segmentation_result);
/** \brief Print SegmentationResult formated information
*
* \param[in] fd_c_segmentation_result pointer to FD_C_SegmentationResult object
* \param[out] str_buffer used to store string
*/
FASTDEPLOY_CAPI_EXPORT extern __fd_give void
FD_C_SegmentationResultStr(
__fd_keep FD_C_SegmentationResult* fd_c_segmentation_result, char* str_buffer);
#ifdef __cplusplus
} // extern "C"
#endif