liveness_c_api.h

Go to the documentation of this file.

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

#pragma once

#include <voicesdk/core/core_c_api.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct VoiceSdkLivenessEngine VoiceSdkLivenessEngine;

typedef enum VoiceSdkLivenessResultValidationStatusCode {
    kVoiceSdkLivenessResultValidationStatusCodeOk, 
    kVoiceSdkLivenessResultValidationStatusCodeTooSmallSpeechLength 
} VoiceSdkLivenessResultValidationStatusCode;

typedef struct VoiceSdkLivenessResult {
    float score;

    float probability;

    VoiceSdkLivenessResultValidationStatusCode status_code;
} VoiceSdkLivenessResult;

VOICE_SDK_API
VoiceSdkLivenessEngine* VoiceSdkLivenessEngineCreate(const char* init_path, VoiceSdkErrorCode* error_code,
                                                     char** error_msg);

VOICE_SDK_API
bool VoiceSdkLivenessEngineCheckLivenessAudioFile(const VoiceSdkLivenessEngine* engine, const char* audio_path,
                                                  VoiceSdkLivenessResult* result, VoiceSdkErrorCode* error_code,
                                                  char** error_msg);

VOICE_SDK_API
bool VoiceSdkLivenessEngineCheckLivenessBytes(const VoiceSdkLivenessEngine* engine, const uint8_t* bytes,
                                              size_t num_bytes, size_t sample_rate, VoiceSdkLivenessResult* result,
                                              VoiceSdkErrorCode* error_code, char** error_msg);

VOICE_SDK_API
bool VoiceSdkLivenessEngineCheckLivenessPcm16Samples(const VoiceSdkLivenessEngine* engine, const int16_t* pcm16_samples,
                                                     size_t num_samples, size_t sample_rate,
                                                     VoiceSdkLivenessResult* result, VoiceSdkErrorCode* error_code,
                                                     char** error_msg);

VOICE_SDK_API
bool VoiceSdkLivenessEngineCheckLivenessFloatSamples(const VoiceSdkLivenessEngine* engine, const float* float_samples,
                                                     size_t num_samples, size_t sample_rate,
                                                     VoiceSdkLivenessResult* result, VoiceSdkErrorCode* error_code,
                                                     char** error_msg);

VOICE_SDK_API
void VoiceSdkLivenessEngineRelease(VoiceSdkLivenessEngine* engine);

#ifdef __cplusplus
}
#endif