c_api.h

Go to the documentation of this file.

/* Copyright 2021 ID R&D Inc. All Rights Reserved. */

#pragma once

#include <stdint.h>
#include <stddef.h>

#include "config.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct DocSdkImage DocSdkImage;

typedef struct DocSdkLivenessPipeline DocSdkLivenessPipeline;

typedef enum DocSdkErrorCode {
    kDocSdkErrorCodeOk,              
    kDocSdkErrorCodeNullptr,         
    kDocSdkErrorCodeNativeException, 
    kDocSdkErrorCodeLicenseException 
} DocSdkErrorCode;

typedef enum DocSdkColorEncoding {
    kDocSdkColorEncodingRGB888, 
    kDocSdkColorEncodingBGR888  
} DocSdkColorEncoding;

typedef enum DocSdkValidationStatusCode {
    kDocSdkValidationStatusCodeOk,                       
    kDocSdkValidationStatusCodeDocumentTooCloseToCamera, 
    kDocSdkValidationStatusCodeDocumentTooCloseToBorder, 
    kDocSdkValidationStatusCodeDocumentCropped, 
    kDocSdkValidationStatusCodeDocumentNotFound,     
    kDocSdkValidationStatusCodeDocumentTooSmall,     
    kDocSdkValidationStatusCodeTooManyDocuments,     
    kDocSdkValidationStatusCodeDocumentIsColorless,  
    kDocSdkValidationStatusCodeDocumentPhotoNotFound 
} DocSdkValidationStatusCode;

typedef enum DocSdkImageQualityWarning {
    kDocSdkImageQualityWarningRelativeDocumentSizeLowerThan10Percent, 
    kDocSdkImageQualityWarningDocumentBordersOutsideOfFrame, 
    kDocSdkImageQualityWarningMultipleDocumentsInFrame,      
    kDocSdkImageQualityWarningDocumentTooCloseToBorder,      
    kDocSdkImageQualityWarningImageTooBlurry,                
    kDocSdkImageQualityWarningImageTooCompressed,            
    kDocSdkImageQualityWarningPoorImageExposure,             
    kDocSdkImageQualityWarningGlareOnImage                   
} DocSdkImageQualityWarning;

typedef struct DocSdkLivenessPipelineResult {
    float liveness_probability;

    float liveness_score;

    float quality_score;

    uint64_t image_quality_warnings;

    DocSdkValidationStatusCode status_code;
} DocSdkLivenessPipelineResult;

typedef enum DocSdkLivenessCheckCalibration {
    kDocSdkLivenessCheckCalibrationRegular, 
    kDocSdkLivenessCheckCalibrationSoft, 
    kDocSdkLivenessCheckCalibrationHard 
} DocSdkLivenessCheckCalibration;

typedef struct DocSdkLivenessCheckOptions {
    DocSdkLivenessCheckCalibration calibration;

    DocSdkValidationStatusCode* errors_to_ignore;

    size_t num_errors_to_ignore;
} DocSdkLivenessCheckOptions;

typedef enum DocSdkAttackType {
    kDocSdkAttackTypeScreenReplay,         
    kDocSdkAttackTypePrintedCopy,          
    kDocSdkAttackTypePortraitSubstitution, 
    kDocSdkAttackTypeDigitalManipulation,  
    kDocSdkAttackTypeOther,                
} DocSdkAttackType;

typedef struct DocSdkFeature {
    DocSdkAttackType attack_type; 
    char* pipeline_name;          
    char* expiration_date;        
} DocSdkFeature;

typedef struct DocSdkLicenseInfo {
    DocSdkFeature* features; 
    size_t num_features;     
} DocSdkLicenseInfo;

DOCSDK_API void DocSdkSetErrorLogCallback(void (*callback)(DocSdkErrorCode, const char*));

DOCSDK_API void DocSdkSetNumThreads(unsigned int num_threads);

DOCSDK_API DocSdkLicenseInfo* DocSdkGetLicenseInfo(DocSdkErrorCode* error_code);

DOCSDK_API void DocSdkDestroyLicenseInfo(DocSdkLicenseInfo* license_info);

DOCSDK_API void DocSdkSetRuntimeLicense(const char* license_str, DocSdkErrorCode* error_code);

DOCSDK_API DocSdkImage* DocSdkCreateImageFromBuffer(const uint8_t* bytes, size_t size, DocSdkErrorCode* error_code);

DOCSDK_API DocSdkImage* DocSdkCreateImageFromFile(const char* file_path, DocSdkErrorCode* error_code);

DOCSDK_API DocSdkImage* DocSdkCreateImageFromRawData(const uint8_t* data, size_t num_rows, size_t num_cols,
                                                     DocSdkColorEncoding encoding, DocSdkErrorCode* error_code);

DOCSDK_API void DocSdkDestroyImage(DocSdkImage* image);

DOCSDK_API DocSdkLivenessPipeline* DocSdkCreateLivenessPipeline(const char* config_path, DocSdkErrorCode* error_code);

DOCSDK_API void DocSdkDestroyLivenessPipeline(DocSdkLivenessPipeline* liveness_pipeline);

DOCSDK_API DocSdkLivenessCheckOptions DocSdkLivenessCheckOptionsDefault();

DOCSDK_API DocSdkLivenessPipelineResult DocSdkLivenessPipelineCheckLiveness(DocSdkLivenessPipeline* liveness_pipeline,
                                                                            DocSdkImage* image,
                                                                            DocSdkLivenessCheckOptions* options,
                                                                            DocSdkErrorCode* error_code);

DOCSDK_API DocSdkLivenessPipelineResult DocSdkLivenessPipelineCheckLivenessSequence(
        DocSdkLivenessPipeline* liveness_pipeline, DocSdkImage** images, size_t num_images,
        DocSdkLivenessCheckOptions* options, DocSdkErrorCode* error_code);

#ifdef __cplusplus
}
#endif