IBestShotQualityEstimator.h

#pragma once

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

#include "IHeadPoseEstimator.h" // for HeadPoseEstimation

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IBestShotQualityEstimator);
#endif

    struct IBestShotQualityEstimator : IRefCounted {
        
        enum EstimationRequest {
            estimateAGS         = 1 << 0, 
            estimateHeadPose    = 1 << 1, 
            estimateAll         = 0xffff  
        };

        struct EstimationResult {
            Optional<HeadPoseEstimation> headPose;  
            Optional<float> ags;                    
        };

        virtual Result<FSDKError> estimate(
            const Image& image,
            const Detection& detection,
            const EstimationRequest request,
            EstimationResult& result) const noexcept = 0;

        virtual Result<FSDKError> estimate(
            Span<const Image> images,
            Span<const Detection> detections,
            const EstimationRequest request,
            Span<EstimationResult> results) const noexcept = 0;

        virtual Result<FSDKError>
        validate(
            Span<const Image> images,
            Span<const Detection> detections,
            const fsdk::IBestShotQualityEstimator::EstimationRequest request,
            Span<Result<FSDKError>> errors) const noexcept = 0;
    };

    /*
        Implementation details.
    */
    inline IBestShotQualityEstimator::EstimationRequest
    operator|(
        IBestShotQualityEstimator::EstimationRequest first,
        IBestShotQualityEstimator::EstimationRequest second
    ) {
        return static_cast<IBestShotQualityEstimator::EstimationRequest>(
            static_cast<int>(first) | static_cast<int>(second)
        );
    }

} // namespace fsdk