IEyeEstimator.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(IEyeEstimator);
#endif

    struct EyesEstimation {
        struct EyeAttributes {
            enum class State : uint8_t {
                Closed,     
                Open,       
                Occluded    
            };
            
            static constexpr uint64_t irisLandmarksCount = 32; 
            static constexpr uint64_t eyelidLandmarksCount = 6; 

            using IrisLandmarks = Landmarks<irisLandmarksCount>;

            using EyelidLandmarks = Landmarks<eyelidLandmarksCount>;

            State state; 

            IrisLandmarks iris; 
            EyelidLandmarks eyelid; 
        };

        EyeAttributes leftEye;  
        EyeAttributes rightEye; 
    };


    struct FSDK_API EyeCropper {

        struct EyesRects {
            fsdk::Rect leftEyeRect;
            fsdk::Rect rightEyeRect;
        };

        EyesRects
        cropByLandmarks5(
            const fsdk::Image& warp,
            const fsdk::Landmarks5& landmarks5
        );

        EyeCropper::EyesRects
        cropByLandmarks68(
            const fsdk::Image& warp,
            const fsdk::Landmarks68& landmarks68
        );
    };


    struct IEyeEstimator : IRefCounted {
        virtual Result<FSDKError>
        FSDK_DEPRECATED("estimate by landmarks5 is deprecated since v.3.6.0, use estimate(const Image& warp,"
            "const EyeCropper::EyesRects& eyeRects,EyesEstimation& eyesEstimation) instead")
        estimate(
            const Image& warp,
            const Landmarks5& landmarks5,
            EyesEstimation& eyesEstimation) const noexcept = 0;
        
        virtual Result<FSDKError>
        FSDK_DEPRECATED("estimate by landmarks68 is deprecated since v.3.6.0, use estimate(const Image& warp,"
            "const EyeCropper::EyesRects& eyeRects, EyesEstimation& eyesEstimation) instead")
        estimate(
            const Image& warp,
            const Landmarks68& landmarks68,
            EyesEstimation& eyesEstimation) const noexcept = 0;

        virtual Result<FSDKError>
        estimate(
            const Image& warp,
            const EyeCropper::EyesRects& eyeRects,
            EyesEstimation& eyesEstimation) const noexcept = 0;

        virtual Result<FSDKError>
        estimate(
            const Image warps[],
            const EyeCropper::EyesRects eyeRects[],
            const uint32_t batchSize,
            EyesEstimation eyesEstimations[]) const noexcept  = 0;
    };

} // namespace fsdk