ILiveness.h

Go to the documentation of this file.

#pragma once
#include <fsdk/IObject.h>
#include <fsdk/Types.h>

namespace lsdk {

    enum LivenessAlgorithmType {
        LA_PITCH_DOWN, 
        LA_PITCH_UP,   
        LA_YAW_LEFT,   
        LA_YAW_RIGHT,  
        LA_SMILE,      
        LA_MOUTH,      
        LA_EYEBROW,    
        LA_EYE,        
        LA_INFRARED,   
        LA_COUNT       
    };

    enum ComplexLivenessAlgorithmType {
        CLA_DEPTH, 
        CLA_COUNT  
    };

    enum class LSDKError : uint32_t {
        Ok,                 
        NotInitialized,     
        NotReady,           
        PreconditionFailed, 
        Internal,           
    };

    struct Angles {
        float yaw = 0.f;
        float pitch = 0.f;
        float roll = 0.f;
    };

    struct Scores {
        float smile = 0.f;
        float mouth = 0.f;
        float eyebrow = 0.f;
    };

    struct EyeStates {
        int left = 0;
        int right = 0;
    };

    struct ILiveness : fsdk::IRefCounted {

        virtual void reset() noexcept = 0;

        virtual fsdk::ResultValue<LSDKError, bool> update(fsdk::Image& image) noexcept = 0;

        virtual void runAfter(ILiveness* other) noexcept = 0;

        virtual bool getDetection(fsdk::Detection* detection) noexcept = 0;

        virtual bool getWarp(fsdk::Image* image) noexcept = 0;

        virtual bool getLandmarks68(fsdk::Landmarks68* landmarks68) noexcept = 0;

        virtual bool getLandmarks5(fsdk::Landmarks5* landmarks5) noexcept = 0;

        virtual bool getIrisLandmarks(fsdk::Landmarks<32>* irisLandmarks) noexcept = 0;

        virtual bool getAngles(Angles* angles) noexcept = 0;

        virtual bool getScores(Scores* scores) noexcept = 0;

        virtual bool getEyestates(EyeStates* eyeStates) noexcept = 0;

        virtual fsdk::Result<LSDKError> loadSettings(fsdk::ISettingsProvider* provider) noexcept = 0;
    };

    template <typename T, typename... Args>
    uint32_t field(T current, Args... rest) noexcept {
        return field(rest...) | (1 << (uint32_t)current);
    }

    template <typename T>
    uint32_t field(T last) noexcept {
        return (uint32_t)(1 << (uint32_t)last);
    }

    struct IUnifiedLiveness : ILiveness {

        virtual void consider(uint32_t flags) noexcept = 0;

        virtual int getBlinkCounter() noexcept = 0;
    };

    struct IComplexLiveness : ILiveness {

        virtual fsdk::ResultValue<LSDKError, bool> update(fsdk::Image& rgb, fsdk::Image& map) noexcept = 0;
    };

} // namespace lsdk

namespace fsdk {
    template <>
    struct ErrorTraits<lsdk::LSDKError> {

        static bool isOk(lsdk::LSDKError error) noexcept {
            return error == lsdk::LSDKError::Ok;
        }

        static const char* toString(lsdk::LSDKError error) noexcept {
            switch(error) {
            case lsdk::LSDKError::Ok:
                return "Ok";
            case lsdk::LSDKError::Internal:
                return "Internal error";
            case lsdk::LSDKError::NotReady:
                return "Liveness result is not ready.";
            case lsdk::LSDKError::NotInitialized:
                return "Liveness is not initialized";
            case lsdk::LSDKError::PreconditionFailed:
                return "Precondition failed";
            default:
                return "Unknown error";
            }
        }
    };
} // namespace fsdk