IFacialHairEstimator.h

#pragma once

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

#include <fsdk/Types/Image.h>
#include <fsdk/Types/Result.h>
#include <fsdk/Types/Span.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFacialHairEstimator);
#endif

    enum class FacialHair {
        NoHair = 0, 
        Stubble,    
        Mustache,   
        Beard       
    };

    struct FacialHairEstimation {
        FacialHair result; 
        // scores
        float noHairScore;   
        float stubbleScore;  
        float mustacheScore; 
        float beardScore;    
    };

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

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

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

} // namespace fsdk