IBestShotMobile.h

#pragma once

#include "BestShotMobileDefs.h"

#include <fsdk/FaceEngine.h>
#if BESTSHOT_MOBILE_IOS_PLATFORM
    #include <tsdk/ITrackEngine.h>
#else
    #include <trackEngine/ITrackEngine.h>
#endif

namespace mobile {

    enum class LivenessType {
        None     = 0,      
        Online   = 1,      
        Offline  = 2       
    };

    enum class LivenessState {
        Alive,                    
        Fake,                     
        None,                     
        NotReady,                 
        BadHeadPose,              
        BadQuality,               
        FaceNotFound,             
        FaceTooClose,             
        FaceCloseToBorder,        
        FaceTooSmall,             
        TooManyFaces,             
        Timeout,                  
        CriticalError             
    };

    enum class BestShotState {
        Ok,                       
        BadQuality,               
        BadHeadPose,              
        Error                     
    };

    struct BestShotInfo {
        BestShotState state;

        fsdk::Image image;
        fsdk::Detection detection;
        fsdk::Landmarks5 landmarks;

        fsdk::HeadPoseEstimation headPoseEstimation;
        float agsEstimation;

        tsdk::FrameId frameIndex;
        tsdk::TrackId trackId;
    };

    struct IBestShotMobileObserver {
        BESTSHOT_MOBILE_API virtual void bestShot(
            const BestShotInfo& bestShotInfo) = 0;

        BESTSHOT_MOBILE_API virtual void liveness(
            const LivenessState livenessState,
            const BestShotInfo& bestShotInfo) = 0;

        BESTSHOT_MOBILE_API virtual void trackEnd(
            const tsdk::TrackId& trackId) = 0;
    };

    struct IBestShotMobile {

        virtual ~IBestShotMobile() = default;

        BESTSHOT_MOBILE_API virtual bool pushFrame(
            const fsdk::Image &frame,
            uint32_t frameId) = 0;

        BESTSHOT_MOBILE_API virtual void setBestShotMobileObserver(
            IBestShotMobileObserver* observer) = 0;

        BESTSHOT_MOBILE_API virtual void join() = 0;

        BESTSHOT_MOBILE_API virtual LivenessType getLivenessType() = 0;
    };

    BESTSHOT_MOBILE_API IBestShotMobile* createBestShotMobile(
        fsdk::FaceEngineType* faceEngine,
        tsdk::ITrackEngine* trackEngine,
        fsdk::ISettingsProvider* settings
    );

    BESTSHOT_MOBILE_API IBestShotMobile* createBestShotMobile(
        fsdk::FaceEngineType* faceEngine,
        tsdk::ITrackEngine* trackEngine,
        const char * configPath
    );

} // namespace mobile