peak_common_pixel_format.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common/exceptions/peak_common_exceptions.hpp>
#include <peak_common/types/geometry/peak_common_size.hpp>
#include <peak_common/types/peak_common_channel.hpp>
#include <peak_common_c/detail/peak_common_defines.h>
#include <peak_common_c/types/peak_common_pixel_format.h>
#include <unordered_map>
#include <algorithm>
#include <array>
#include <cstdint>
#include <ostream>
#include <string>
#include <vector>
 
// helper to suppress c enum deprecation warnings
#define PEAK_COMMON_CREATE_DEPRECATED_HELPER(SUFFIX, CONST)  \
    constexpr uint64_t DeprecatedHelperGet##SUFFIX##CEnumValue() \
    {                                                            \
        return CPixelFormatCast(CONST);                          \
    }
 
namespace peak
{
namespace common
{
namespace detail
{
constexpr uint64_t CPixelFormatCast(peak_common_pixel_format pixelFormat) noexcept
{
    return static_cast<uint32_t>(static_cast<std::underlying_type_t<peak_common_pixel_format>>(pixelFormat));
}
 
PEAK_COMMON_BEGIN_DISABLE_DEPRECATED_WARNINGS
PEAK_COMMON_CREATE_DEPRECATED_HELPER(Mono32FIDS, PEAK_COMMON_PIXEL_FORMAT_MONO_32F_IDS)
PEAK_COMMON_CREATE_DEPRECATED_HELPER(RGB32FIDS, PEAK_COMMON_PIXEL_FORMAT_RGB_32F_IDS)
PEAK_COMMON_END_DISABLE_DEPRECATED_WARNINGS
 
} // namespace detail
 
// clang-format off
enum class PixelFormat : uint64_t
{
    BayerGR8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8,                                                                        
    BayerGR10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10,                                                                      
    BayerGR12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12,                                                                      
 
    BayerRG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8,                                                                        
    BayerRG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10,                                                                      
    BayerRG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12,                                                                      
 
    BayerGB8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8,                                                                        
    BayerGB10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10,                                                                      
    BayerGB12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12,                                                                      
 
    BayerBG8 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8,                                                                        
    BayerBG10 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10,                                                                      
    BayerBG12 = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12,                                                                      
 
    Mono8 = PEAK_COMMON_PIXEL_FORMAT_MONO_8,                                                                               
    Mono10 = PEAK_COMMON_PIXEL_FORMAT_MONO_10,                                                                             
    Mono12 = PEAK_COMMON_PIXEL_FORMAT_MONO_12,                                                                             
    Mono16 = PEAK_COMMON_PIXEL_FORMAT_MONO_16,                                                                             
    Mono32f = PEAK_COMMON_PIXEL_FORMAT_MONO_32F,                                                                           
 
    Confidence8 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_8,                                                                   
    Confidence16 = PEAK_COMMON_PIXEL_FORMAT_CONFIDENCE_16,                                                                 
 
    Coord3D_C8 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C8,                                                                      
    Coord3D_C16 = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C16,                                                                    
    Coord3D_C32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_C32F,                                                                  
 
    Coord3D_ABC32f = PEAK_COMMON_PIXEL_FORMAT_COORD3D_ABC32F,                                                              
 
    YUV420_8_YY_UV_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_UV_SemiplanarIDS,                                  
    YUV420_8_YY_VU_SemiplanarIDS = PEAK_COMMON_PIXEL_FORMAT_YUV420_8_YY_VU_SemiplanarIDS,                                  
 
    YUV422_8_UYVY = PEAK_COMMON_PIXEL_FORMAT_YUV422_8_UYVY,                                                                
 
    RGB8 = PEAK_COMMON_PIXEL_FORMAT_RGB_8,                                                                                 
    RGB10 = PEAK_COMMON_PIXEL_FORMAT_RGB_10,                                                                               
    RGB12 = PEAK_COMMON_PIXEL_FORMAT_RGB_12,                                                                               
    RGB32f = PEAK_COMMON_PIXEL_FORMAT_RGB_32F,                                                                             
 
    BGR8 = PEAK_COMMON_PIXEL_FORMAT_BGR_8,                                                                                 
    BGR10 = PEAK_COMMON_PIXEL_FORMAT_BGR_10,                                                                               
    BGR12 = PEAK_COMMON_PIXEL_FORMAT_BGR_12,                                                                               
 
    RGBa8 = PEAK_COMMON_PIXEL_FORMAT_RGBA_8,                                                                               
    RGBa10 = PEAK_COMMON_PIXEL_FORMAT_RGBA_10,                                                                             
    RGBa12 = PEAK_COMMON_PIXEL_FORMAT_RGBA_12,                                                                             
 
    BGRa8 = PEAK_COMMON_PIXEL_FORMAT_BGRA_8,                                                                               
    BGRa10 = PEAK_COMMON_PIXEL_FORMAT_BGRA_10,                                                                             
    BGRa12 = PEAK_COMMON_PIXEL_FORMAT_BGRA_12,                                                                             
 
    BayerBG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED,                                                              
    BayerBG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED,                                                              
 
    BayerGB10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED,                                                              
    BayerGB12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED,                                                              
 
    BayerGR10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED,                                                              
    BayerGR12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED,                                                              
 
    BayerRG10p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED,                                                              
    BayerRG12p = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED,                                                              
 
    Mono10p = PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED,                                                                     
    Mono12p = PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED,                                                                     
 
    RGB10p32 = PEAK_COMMON_PIXEL_FORMAT_RGB_10_PACKED_32,                                                                  
    BGR10p32 = PEAK_COMMON_PIXEL_FORMAT_BGR_10_PACKED_32,                                                                  
 
    BayerRG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS,                                                 
    BayerGB10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS,                                                 
    BayerGR10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS,                                                 
    BayerBG10g40IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS,                                                 
 
    BayerRG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS,                                                 
    BayerGB12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS,                                                 
    BayerGR12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS,                                                 
    BayerBG12g24IDS = PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS,                                                 
 
    Mono10g40IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS,                                                        
    Mono12g24IDS = PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS,                                                        
 
    Mono32fIDS PEAK_COMMON_DEPRECATED_ENUM_MSG("This value will be removed in a future Version. Use Mono32f instead.") = detail::DeprecatedHelperGetMono32FIDSCEnumValue(), 
    RGB32fIDS PEAK_COMMON_DEPRECATED_ENUM_MSG("This value will be removed in a future Version. Use RGB32fIDS instead.") = detail::DeprecatedHelperGetRGB32FIDSCEnumValue(), 
 
    Mono10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_A_B),        
    BayerRG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_GROUPED_40_IDS_INTERLEAVED_A_B), 
    BayerBG10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_GROUPED_40_IDS_INTERLEAVED_A_B), 
    BayerGR10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_GROUPED_40_IDS_INTERLEAVED_A_B), 
    BayerGB10g40IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_GROUPED_40_IDS_INTERLEAVED_A_B), 
    Mono12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_A_B),        
    BayerRG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_GROUPED_24_IDS_INTERLEAVED_A_B), 
    BayerBG12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_GROUPED_24_IDS_INTERLEAVED_A_B), 
    BayerGR12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_GROUPED_24_IDS_INTERLEAVED_A_B), 
    BayerGB12g24IDS_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_GROUPED_24_IDS_INTERLEAVED_A_B), 
    Mono8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_A_B),                               
    BayerRG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_INTERLEAVED_A_B),                        
    BayerBG8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_INTERLEAVED_A_B),                        
    BayerGR8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_INTERLEAVED_A_B),                        
    BayerGB8_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_INTERLEAVED_A_B),                        
    Mono10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_A_B),                             
    BayerRG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_INTERLEAVED_A_B),                      
    BayerBG10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_INTERLEAVED_A_B),                      
    BayerGR10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_INTERLEAVED_A_B),                      
    BayerGB10_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_INTERLEAVED_A_B),                      
    Mono12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_A_B),                             
    BayerRG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_INTERLEAVED_A_B),                      
    BayerBG12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_INTERLEAVED_A_B),                      
    BayerGR12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_INTERLEAVED_A_B),                      
    BayerGB12_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_INTERLEAVED_A_B),                      
    Mono10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_A_B),                     
    BayerRG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_PACKED_INTERLEAVED_A_B),              
    BayerBG10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_PACKED_INTERLEAVED_A_B),              
    BayerGR10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_PACKED_INTERLEAVED_A_B),              
    BayerGB10p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_PACKED_INTERLEAVED_A_B),              
    Mono12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_A_B),                     
    BayerRG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_PACKED_INTERLEAVED_A_B),              
    BayerBG12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_PACKED_INTERLEAVED_A_B),              
    BayerGR12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_PACKED_INTERLEAVED_A_B),              
    BayerGB12p_I_A_B = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_PACKED_INTERLEAVED_A_B),              
    Mono8_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_INTERLEAVED_AB_CD),                           
    Mono10_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_INTERLEAVED_AB_CD),                         
    Mono12_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_INTERLEAVED_AB_CD),                         
    Mono10p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_PACKED_INTERLEAVED_AB_CD),                 
    Mono12p_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_PACKED_INTERLEAVED_AB_CD),                 
    Mono10g40IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_GROUPED_40_IDS_INTERLEAVED_AB_CD),    
    Mono12g24IDS_I_AB_CD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_GROUPED_24_IDS_INTERLEAVED_AB_CD),    
 
    Mono10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_AB),                                             
    BayerRG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_10_AB),                                      
    BayerBG10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_10_AB),                                      
    BayerGR10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_10_AB),                                      
    BayerGB10_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_10_AB),                                      
    Mono12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_AB),                                             
    BayerRG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_12_AB),                                      
    BayerBG12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_12_AB),                                      
    BayerGR12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_12_AB),                                      
    BayerGB12_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_12_AB),                                      
    Mono8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_AB),                                               
    BayerRG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_RG_8_AB),                                        
    BayerBG8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_BG_8_AB),                                        
    BayerGR8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GR_8_AB),                                        
    BayerGB8_AB = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_BAYER_GB_8_AB),                                        
    Mono8_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_8_ABCD),                                           
    Mono10_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_10_ABCD),                                         
    Mono12_ABCD = detail::CPixelFormatCast(PEAK_COMMON_PIXEL_FORMAT_MONO_12_ABCD),                                         
};
// clang-format on
 
namespace detail
{
constexpr PixelFormat CPixelFormatToCppPixelFormat(peak_common_pixel_format pixelFormat) noexcept
{
    return static_cast<PixelFormat>(CPixelFormatCast(pixelFormat));
}
 
constexpr peak_common_pixel_format CppPixelFormatToCPixelFormat(PixelFormat pixelFormat) noexcept
{
    return static_cast<peak_common_pixel_format>(static_cast<uint32_t>(pixelFormat));
}
} // namespace detail

class PixelFormatInfo
{
public:
    explicit PixelFormatInfo(peak::common::PixelFormat pixelFormat);

    explicit PixelFormatInfo(const std::string& name);

    template <typename T = size_t>
    PEAK_COMMON_NO_DISCARD T GetMinimumValuePerChannel() const;

    template <typename T = size_t>
    PEAK_COMMON_NO_DISCARD T GetMaximumValuePerChannel() const;

    PEAK_COMMON_NO_DISCARD size_t GetStorageBitsPerPixel() const;

    PEAK_COMMON_NO_DISCARD size_t GetStorageBitsPerChannel() const;

    PEAK_COMMON_NO_DISCARD std::string GetName() const;

    PEAK_COMMON_NO_DISCARD std::vector<Channel> GetChannels() const;

    PEAK_COMMON_NO_DISCARD size_t GetAllocatedBitsPerPixel() const;

    PEAK_COMMON_NO_DISCARD bool HasIntensityChannel() const;

    PEAK_COMMON_NO_DISCARD size_t GetChannelIndex(Channel channel) const;

    PEAK_COMMON_NO_DISCARD size_t GetNumberOfChannels() const;

    PEAK_COMMON_NO_DISCARD bool IsSingleChannel() const;

    PEAK_COMMON_NO_DISCARD bool HasChannel(Channel channel) const;

    PEAK_COMMON_NO_DISCARD peak::common::PixelFormat GetPixelFormat() const;

    PEAK_COMMON_NO_DISCARD size_t GetSizeInBytes(const Size& size) const;

    PEAK_COMMON_NO_DISCARD bool IsPacked() const;

    PEAK_COMMON_NO_DISCARD bool IsInterleaved() const;

    PEAK_COMMON_NO_DISCARD bool IsFloat() const;

    PEAK_COMMON_NO_DISCARD PixelFormat GetUnpackedPixelFormat() const;
 
private:
    peak::common::PixelFormat m_pixelFormat;
};
 
inline PixelFormatInfo::PixelFormatInfo(peak::common::PixelFormat pixelFormat)
    : m_pixelFormat{ pixelFormat }
{}
 
inline bool PixelFormatInfo::HasIntensityChannel() const
{
    return HasChannel(Channel::Intensity);
}
 
inline size_t PixelFormatInfo::GetChannelIndex(Channel channel) const
{
    const auto channels = this->GetChannels();
    const auto it = std::find(channels.cbegin(), channels.cend(), channel);
    if (it == channels.end())
    {
        throw InvalidParameterException("The given channel is not part of the pixel format " + GetName() + '!');
    }
 
    return static_cast<size_t>(std::distance(channels.begin(), it));
}
 
inline size_t PixelFormatInfo::GetNumberOfChannels() const
{
    return this->GetChannels().size();
}
 
inline bool PixelFormatInfo::IsSingleChannel() const
{
    return GetNumberOfChannels() == 1;
}
 
inline bool PixelFormatInfo::HasChannel(Channel channel) const
{
    const auto channels = this->GetChannels();
    return std::find(channels.cbegin(), channels.cend(), channel) != channels.cend();
}
 
inline peak::common::PixelFormat PixelFormatInfo::GetPixelFormat() const
{
    return m_pixelFormat;
}
} // namespace common 
} // namespace peak
 
#include <peak_common/types/detail/peak_common_pixel_format.ipp>