peak_ipl_chromatic_adaption.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_ipl/types/peak_ipl_color_correction_factors.hpp>
#include <peak_ipl/types/peak_ipl_range.hpp>
#include <peak_ipl/backend/peak_ipl_backend.h>
#include <peak_ipl/exception/peak_ipl_exception.hpp>

namespace peak
{
namespace ipl
{
class ChromaticAdapter final
{
public:
    enum class ColorSpace
    {
        SRGB_D50 = PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE_SRGB_D50,

        SRGB_D65 = PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE_SRGB_D65,

        CIE_RGB_E = PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE_CIE_RGB_E,

        ECI_RGB_D50 = PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE_ECI_RGB_D50,

        Adobe_RGB_D65 = PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE_ADOBE_RGB_D65
    };

    enum class Algorithm
    {
        Legacy = PEAK_IPL_CHROMATIC_ADAPTER_ALGORITHM_LEGACY,

        Bradford = PEAK_IPL_CHROMATIC_ADAPTER_ALGORITHM_BRADFORD,
    };

    ChromaticAdapter();

    ~ChromaticAdapter();

    ChromaticAdapter(const ChromaticAdapter& other);

    ChromaticAdapter& operator=(const ChromaticAdapter& other);

    ChromaticAdapter(ChromaticAdapter&& other) noexcept;

    ChromaticAdapter& operator=(ChromaticAdapter&& other) noexcept;

    PEAK_IPL_NO_DISCARD ColorSpace TargetColorSpace() const;

    void SetTargetColorSpace(ColorSpace colorSpace);

    PEAK_IPL_NO_DISCARD Algorithm AdaptionAlgorithm() const;

    void SetAdaptionAlgorithm(Algorithm algorithm);

    PEAK_IPL_NO_DISCARD Range<uint32_t> TemperatureRange() const;

    PEAK_IPL_NO_DISCARD ColorCorrectionFactors CalculateColorCorrectionMatrix(uint32_t colorTemperature,
        const ColorCorrectionFactors& correctionFactors = ColorCorrectionFactors::Identity()) const;
 
private:
    PEAK_IPL_CHROMATIC_ADAPTER_HANDLE m_backendHandle{};
};
 
inline ChromaticAdapter::ChromaticAdapter()
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_Construct(&m_backendHandle);
    });
}
 
inline ChromaticAdapter::~ChromaticAdapter()
{
    if (m_backendHandle)
    {
        (void)PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_Destruct(m_backendHandle);
    }
}
 
inline ChromaticAdapter::ChromaticAdapter(const ChromaticAdapter& other)
{
    if (other.m_backendHandle)
    {
        ExecuteAndMapReturnCodes(
            [&] { return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_Acquire(other.m_backendHandle); });
    }
 
    m_backendHandle = other.m_backendHandle;
}
 
inline ChromaticAdapter& ChromaticAdapter::operator=(const ChromaticAdapter& other)
{
    if (this != &other)
    {
        if (m_backendHandle)
        {
            (void)PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_Destruct(m_backendHandle);
        }
 
        if (other.m_backendHandle)
        {
            ExecuteAndMapReturnCodes(
                [&] { return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_Acquire(other.m_backendHandle); });
        }
    }
 
    m_backendHandle = other.m_backendHandle;
 
    return *this;
}
 
inline ChromaticAdapter::ChromaticAdapter(ChromaticAdapter&& other) noexcept
{
    *this = std::move(other);
}
 
inline ChromaticAdapter& ChromaticAdapter::operator=(ChromaticAdapter&& other) noexcept
{
    if (this != &other)
    {
        if (m_backendHandle != nullptr)
        {
            (void)PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_Destruct(m_backendHandle);
        }
 
        m_backendHandle = other.m_backendHandle;
        other.m_backendHandle = nullptr;
    }
 
    return *this;
}
 
inline ChromaticAdapter::ColorSpace ChromaticAdapter::TargetColorSpace() const
{
    ColorSpace colorSpace{};
 
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_GetTargetColorSpace(
            m_backendHandle, reinterpret_cast<PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE*>(&colorSpace));
    });
 
    return colorSpace;
}
 
inline void ChromaticAdapter::SetTargetColorSpace(ColorSpace colorSpace)
{
    ExecuteAndMapReturnCodes([&] {
    return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_SetTargetColorSpace(
        m_backendHandle, static_cast<PEAK_IPL_CHROMATIC_ADAPTER_COLOR_SPACE>(colorSpace));
});
}
 
inline ChromaticAdapter::Algorithm ChromaticAdapter::AdaptionAlgorithm() const
{
    Algorithm algorithm{};
 
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_GetAdaptionAlgorithm(
            m_backendHandle, reinterpret_cast<PEAK_IPL_CHROMATIC_ADAPTER_ALGORITHM*>(&algorithm));
    });
 
    return algorithm;
}
 
inline void ChromaticAdapter::SetAdaptionAlgorithm(Algorithm algorithm)
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_SetAdaptionAlgorithm(
            m_backendHandle, static_cast<PEAK_IPL_CHROMATIC_ADAPTER_ALGORITHM>(algorithm));
    });
}
 
inline ColorCorrectionFactors ChromaticAdapter::CalculateColorCorrectionMatrix(uint32_t colorTemperature,
    const ColorCorrectionFactors& correctionFactors) const
{
    ColorCorrectionFactors correctionFactorsCalculated{};
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_CalculateColorCorrectionMatrix(
            m_backendHandle, colorTemperature, reinterpret_cast<const float*>(&correctionFactors),
            reinterpret_cast<float*>(&correctionFactorsCalculated));
    });
 
    return correctionFactorsCalculated;
}
 
inline Range<uint32_t> ChromaticAdapter::TemperatureRange() const
{
    uint32_t minTemp{};
    uint32_t maxTemp{};
    uint32_t incTemp{};
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ChromaticAdapter_GetTemperatureRange(m_backendHandle, &minTemp, &maxTemp, &incTemp);
    });
 
    return Range<uint32_t>{minTemp, maxTemp, incTemp};
}
 
} /* namespace ipl */
} /* namespace peak */