include/fsdk/Estimators/IGlassesEstimator.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(IGlassesEstimator);
#endif

    enum class GlassesEstimation: uint8_t{
        NoGlasses,
        EyeGlasses,
        SunGlasses,
        EstimationError
    };

    struct IGlassesEstimator : IRefCounted {
        virtual ResultValue<FSDKError, GlassesEstimation>
        estimate(const Image& warp) const noexcept  = 0;

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

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