IFacialHairEstimator.h

#pragma once

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

#include <fsdk/Types/Image.h>
#include <fsdk/Types/Result.h>
#include <fsdk/Types/Ref.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;           
    };

    enum class Beard {
        NoBeard = 0,                
        Stubble,                    
        ShortBeard,                 
        LongBeard                   
    };

    enum class Mustache {
        NoMustache = 0,            
        Mustache,                  
        Stubble                    
    };

    struct BeardEstimation {
        Beard result;                
        // scores
        float noBeardScore;          
        float stubbleScore;          
        float shortBeardScore;       
        float longBeardScore;        
    };

    struct MustacheEstimation {
        Mustache result;             
        // scores
        float noMustacheScore;       
        float mustacheScore;         
        float stubbleScore;          
    };

    struct FacialHairEstimationExtended {
        BeardEstimation beard;       
        MustacheEstimation mustache; 
    };

    struct IFacialHairEstimator : IRefCounted {

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

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

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

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

} // namespace fsdk