IBlackWhiteEstimator.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(IBlackWhiteEstimator);
#endif

    struct ImageColorEstimation {

        float colorScore;    
        float infraredScore; 

        enum class ImageColorType : uint8_t {
            Color = 0, 
            Grayscale, 
            Infrared,  
        };

        ImageColorType colorType;
    };

    struct IBlackWhiteEstimator : IRefCounted {
        FSDK_DEPRECATED("This method is deprecated since v.5.6.0, use estimation by warped image instead!")
        virtual Result<FSDKError> estimate(const Image& image, bool& outIsGrayscale) const noexcept = 0;

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

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

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

} // namespace fsdk