liveness.h

Go to the documentation of this file.

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

#pragma once
#include <string>
#include <iostream>
#include <utility>
#include <memory>
#include <voicesdk/core/config.h>

namespace voicesdk {

struct LivenessResult {
    enum class ValidationStatusCode {
        kOk, 
        kTooSmallSpeechLength 
    };

    struct Value {
        Value() = default;
        Value(float score, float probability) : score(score), probability(probability) {}

        friend std::ostream& operator<<(std::ostream& os, const Value& obj) {
            os << "LivenessResult::Value["
               << "score: " << obj.score << ", "
               << "probability: " << obj.probability << "]";
            return os;
        }

        float score = 0.0f;       
        float probability = 0.0f; 
    };

    LivenessResult() = default;
    explicit LivenessResult(const Value& value) : value(value) {}
    explicit LivenessResult(ValidationStatusCode status_code) : status_code(status_code) {}

    bool Ok() const noexcept {
        return status_code == ValidationStatusCode::kOk;
    }

    const Value& GetValue() const {
        if (!Ok()) {
            throw std::runtime_error("LivenessResult: value is not available, status code is not kOk");
        }

        return value;
    }

    const ValidationStatusCode& GetStatusCode() const noexcept {
        return status_code;
    }

    friend std::ostream& operator<<(std::ostream& os, const LivenessResult& result) {
        os << "LivenessResult[ status: " << static_cast<int>(result.status_code) << ", value: ";
        if (result.Ok()) {
            os << result.value;
        } else {
            os << "unavailable";
        }
        os << " ]";
        return os;
    }

private:
    Value value;
    ValidationStatusCode status_code = ValidationStatusCode::kOk;
};

class VOICE_SDK_API LivenessEngine {
public:
    using Ptr = std::shared_ptr<LivenessEngine>;

    static LivenessEngine::Ptr Create(const std::string& init_path);

    virtual LivenessResult CheckLiveness(const uint8_t* pcm16_bytes, size_t num_bytes, size_t sample_rate) const = 0;

    virtual LivenessResult CheckLiveness(const int16_t* pcm16_samples, size_t num_samples,
                                              size_t sample_rate) const = 0;

    virtual LivenessResult CheckLiveness(const float* float_samples, size_t num_samples,
                                         size_t sample_rate) const = 0;

    virtual LivenessResult CheckLiveness(const std::string& audio_path) const = 0;

    virtual ~LivenessEngine() = default;
};

}  // namespace voicesdk