peak_image_view.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common_c/detail/peak_common_defines.h>
 
#include <peak_common/types/geometry/peak_common_size.hpp>
#include <peak_common/types/peak_common_any.hpp>
#include <peak_common/types/peak_common_iimageview.hpp>
#include <peak_common/types/peak_common_pixel_format.hpp>
 
#include <memory>

namespace peak
{
namespace core
{
class Buffer;
class BufferPart;
 
namespace detail
{
struct ExtractedPayload
{
    peak::common::Size size;
    peak::common::PixelFormat pixelFormat{};
    void* dataPtr{};
    size_t dataSize{};
    size_t bytesPerLine{};
    size_t lineStartOffset{};
};
} // namespace detail

enum class MetadataExtractionMode
{
    Minimal = 1,

    Extended = 2,
};
 

class ImageView : public peak::common::IImageView
{
public:
    explicit ImageView(const std::shared_ptr<Buffer>& buffer);

    ImageView(const std::shared_ptr<Buffer>& buffer, MetadataExtractionMode mode);

    explicit ImageView(const std::shared_ptr<BufferPart>& part);

    ImageView(const std::shared_ptr<BufferPart>& part, MetadataExtractionMode mode);

    PEAK_COMMON_NO_DISCARD const uint8_t* GetData() const override;

    PEAK_COMMON_NO_DISCARD uint8_t* GetData() override;

    PEAK_COMMON_NO_DISCARD std::size_t GetLineStartOffset() const override;

    PEAK_COMMON_NO_DISCARD std::size_t GetSizeInBytes() const override;

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

    PEAK_COMMON_NO_DISCARD peak::common::PixelFormatInfo GetPixelFormatInfo() const override;

    PEAK_COMMON_NO_DISCARD peak::common::Size GetSize() const override;

    PEAK_COMMON_NO_DISCARD uint32_t GetWidth() const override;

    PEAK_COMMON_NO_DISCARD uint32_t GetHeight() const override;

    PEAK_COMMON_NO_DISCARD size_t GetBitsPerPixel() const override;

    PEAK_COMMON_NO_DISCARD size_t GetBytesPerLine() const override;

    PEAK_COMMON_NO_DISCARD std::shared_ptr<peak::common::Metadata> GetMetadata() override;

    PEAK_COMMON_NO_DISCARD std::shared_ptr<const peak::common::Metadata> GetMetadata() const override;

    PEAK_COMMON_NO_DISCARD std::shared_ptr<peak::core::Buffer> GetParentBuffer() const;
 
private:
    explicit ImageView(const detail::ExtractedPayload& payload, std::shared_ptr<peak::common::Metadata> metadata);
    std::shared_ptr<peak::common::Metadata> m_metadata;
    std::weak_ptr<peak::core::Buffer> m_parentBuffer;
    const detail::ExtractedPayload m_payload;
};
 
} // namespace core
} // namespace peak