include/fsdk/Estimators/IFaceOcclusionEstimator.h

#pragma once

#include <fsdk/IObject.h>
#include <fsdk/FSDKError.h>
#include <fsdk/Optional.h>
#include <fsdk/Types.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFaceOcclusionEstimator);
#endif

    enum class FaceOcclusionType : uint8_t {
        Forehead = 0, 
        LeftEye,      
        RightEye,     
        Nose,         
        Mouth,        
        LowerFace,    
        Count         
    };

    enum class FaceOcclusionState : uint8_t {
        NotOccluded = 0, 
        Occluded,        
        Count            
    };

    struct FaceOcclusionEstimation {
        FaceOcclusionState states[static_cast<uint8_t>(FaceOcclusionType::Count)]; 

        float typeScores[static_cast<uint8_t>(FaceOcclusionType::Count)];

        inline float getScore(FaceOcclusionType type) const {
            return typeScores[static_cast<uint8_t>(type)];
        }

        inline FaceOcclusionState getState(FaceOcclusionType type) const {
            return states[static_cast<uint8_t>(type)];
        }

        FaceOcclusionState overallOcclusionState;
        float overallOcclusionScore;
        float hairOcclusionScore;
    };

    struct IFaceOcclusionEstimator : IRefCounted {
        virtual ResultValue<FSDKError, FaceOcclusionEstimation>
        estimate(const Image& warp, const Landmarks5& landmarks5) const noexcept = 0;

        virtual Result<FSDKError> estimate(
            Span<const Image> warps,
            Span<const Landmarks5> landmarks,
            Span<FaceOcclusionEstimation> faceOcclusionEstimations) const noexcept = 0;

        virtual Result<FSDKError> validate(
            Span<const Image> warps,
            Span<const Landmarks5> landmarks,
            Span<Result<FSDKError>> errors) const noexcept = 0;
    };

} // namespace fsdk