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

    enum class SmileType {
        None,       
        SmileLips,  
        SmileOpen   
    };

    struct SmileTypeScores {
        float smileLips;    
        float smileOpen;    
    };

    struct MouthEstimation {
        float opened;    
        float smile;     
        float occluded;  
        bool isOpened;   
        bool isSmiling;  
        bool isOccluded; 
    };

    struct MouthEstimationExtended {
        float opened;       
        float smile;        
        float occluded;     
        bool isOpened;      
        bool isSmiling;     
        bool isOccluded;    

        SmileTypeScores smileTypeScores;    
        SmileType smileType;                
    };

    struct IMouthEstimator : IRefCounted {
        virtual Result<FSDKError>
        estimate(
            const Image& warp,
            MouthEstimation& estimation) const noexcept = 0;

        virtual Result<FSDKError>
        estimate(
            Span<const Image> warps,
            Span<MouthEstimation> mouthEstimations) const noexcept = 0;

        virtual Result<FSDKError>
        estimate(
            const Image& warp,
            MouthEstimationExtended& estimation) const noexcept = 0;

        virtual Result<FSDKError>
        estimate(
            Span<const Image> warps,
            Span<MouthEstimationExtended> mouthEstimations) const noexcept = 0;

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

    };

} // namespace fsdk