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

    struct Quality {
        float light;
        float dark;
        float gray;
        float blur;
        inline float getQuality() const noexcept;
    };
    
    struct SubjectiveQuality {
        float blur;
        float light;
        float darkness;
        float illumination;
        float specularity;
        bool isBlurred;
        bool isHighlighted;
        bool isDark;
        bool isIlluminated;
        bool isNotSpecular;
        inline bool isGood() const noexcept;
    };
    
    struct IQualityEstimator : IRefCounted {
        virtual Result<FSDKError>
        estimate(const Image& warp, Quality& quality) const noexcept = 0;

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

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

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

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

    /*
        Implementation details.
    */
    float Quality::getQuality() const noexcept {
        float min1 = std::min(dark, light);
        float min2 = std::min(gray, blur);
        return std::min(min1, min2);
    }

    /*
        Implementation details.
    */
    bool SubjectiveQuality::isGood() const noexcept {
        if (!isBlurred && !isHighlighted && !isDark && !isIlluminated && !isNotSpecular)
            return true;
        return false;
    }
} // namespace fsdk