ImageConversion.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <concepts>
#include <cstddef>
#include <span>
#include <vector>
 
#include <BufferStream.h>
#include <sourcepp/Templates.h>
 
#include "ImageFormats.h"
 
namespace vtfpp {
 
namespace ImagePixel {
 
#define VTFPP_CHECK_SIZE(format) \
    static_assert(sizeof(format) == ImageFormatDetails::bpp(ImageFormat::format) / 8)
 
#define VTFPP_FORMAT_INHERITED(format, parent)              \
    struct format : parent {                                \
        static constexpr auto FORMAT = ImageFormat::format; \
    };                                                      \
    VTFPP_CHECK_SIZE(format)
 
struct RGBA8888 {
    static constexpr auto FORMAT = ImageFormat::RGBA8888;
    uint8_t r;
    uint8_t g;
    uint8_t b;
    uint8_t a;
}; VTFPP_CHECK_SIZE(RGBA8888);
 
struct ABGR8888 {
    static constexpr auto FORMAT = ImageFormat::ABGR8888;
    uint8_t a;
    uint8_t b;
    uint8_t g;
    uint8_t r;
}; VTFPP_CHECK_SIZE(ABGR8888);
 
struct RGB888 {
    static constexpr auto FORMAT = ImageFormat::RGB888;
    uint8_t r;
    uint8_t g;
    uint8_t b;
}; VTFPP_CHECK_SIZE(RGB888);
 
VTFPP_FORMAT_INHERITED(RGB888_BLUESCREEN, RGB888);
 
struct BGR888 {
    static constexpr auto FORMAT = ImageFormat::BGR888;
    uint8_t b;
    uint8_t g;
    uint8_t r;
}; VTFPP_CHECK_SIZE(BGR888);
 
VTFPP_FORMAT_INHERITED(BGR888_BLUESCREEN, BGR888);
 
struct RGB565 {
    static constexpr auto FORMAT = ImageFormat::RGB565;
    uint16_t r : 5;
    uint16_t g : 6;
    uint16_t b : 5;
}; VTFPP_CHECK_SIZE(RGB565);
 
struct I8 {
    static constexpr auto FORMAT = ImageFormat::I8;
    uint8_t i;
}; VTFPP_CHECK_SIZE(I8);
 
struct IA88 {
    static constexpr auto FORMAT = ImageFormat::IA88;
    uint8_t i;
    uint8_t a;
}; VTFPP_CHECK_SIZE(IA88);
 
struct P8 {
    static constexpr auto FORMAT = ImageFormat::P8;
    uint8_t p;
}; VTFPP_CHECK_SIZE(P8);
 
struct A8 {
    static constexpr auto FORMAT = ImageFormat::A8;
    uint8_t a;
}; VTFPP_CHECK_SIZE(A8);
 
struct ARGB8888 {
    static constexpr auto FORMAT = ImageFormat::ARGB8888;
    uint8_t a;
    uint8_t r;
    uint8_t g;
    uint8_t b;
}; VTFPP_CHECK_SIZE(ARGB8888);
 
struct BGRA8888 {
    static constexpr auto FORMAT = ImageFormat::BGRA8888;
    uint8_t b;
    uint8_t g;
    uint8_t r;
    uint8_t a;
}; VTFPP_CHECK_SIZE(BGRA8888);
 
struct BGRX8888 {
    static constexpr auto FORMAT = ImageFormat::BGRX8888;
    uint8_t b;
    uint8_t g;
    uint8_t r;
    uint8_t x;
}; VTFPP_CHECK_SIZE(BGRX8888);
 
struct BGR565 {
    static constexpr auto FORMAT = ImageFormat::BGR565;
    uint16_t b : 5;
    uint16_t g : 6;
    uint16_t r : 5;
}; VTFPP_CHECK_SIZE(BGR565);
 
struct BGRX5551 {
    static constexpr auto FORMAT = ImageFormat::BGRX5551;
    uint16_t b : 5;
    uint16_t g : 5;
    uint16_t r : 5;
    uint16_t x : 1;
}; VTFPP_CHECK_SIZE(BGRX5551);
 
struct BGRA4444 {
    static constexpr auto FORMAT = ImageFormat::BGRA4444;
    uint16_t b : 4;
    uint16_t g : 4;
    uint16_t r : 4;
    uint16_t a : 4;
}; VTFPP_CHECK_SIZE(BGRA4444);
 
struct BGRA5551 {
    static constexpr auto FORMAT = ImageFormat::BGRA5551;
    uint16_t b : 5;
    uint16_t g : 5;
    uint16_t r : 5;
    uint16_t a : 1;
}; VTFPP_CHECK_SIZE(BGRA5551);
 
struct UV88 {
    static constexpr auto FORMAT = ImageFormat::UV88;
    uint8_t u;
    uint8_t v;
}; VTFPP_CHECK_SIZE(UV88);
 
struct UVWQ8888 {
    static constexpr auto FORMAT = ImageFormat::UVWQ8888;
    uint8_t u;
    uint8_t v;
    uint8_t w;
    uint8_t q;
}; VTFPP_CHECK_SIZE(UVWQ8888);
 
struct RGBA16161616F {
    static constexpr auto FORMAT = ImageFormat::RGBA16161616F;
    half r;
    half g;
    half b;
    half a;
}; VTFPP_CHECK_SIZE(RGBA16161616F);
 
struct RGBA16161616 {
    static constexpr auto FORMAT = ImageFormat::RGBA16161616;
    uint16_t r;
    uint16_t g;
    uint16_t b;
    uint16_t a;
}; VTFPP_CHECK_SIZE(RGBA16161616);
 
struct UVLX8888 {
    static constexpr auto FORMAT = ImageFormat::UVLX8888;
    uint8_t u;
    uint8_t v;
    uint8_t l;
    uint8_t x;
}; VTFPP_CHECK_SIZE(UVLX8888);
 
struct R32F {
    static constexpr auto FORMAT = ImageFormat::R32F;
    float r;
}; VTFPP_CHECK_SIZE(R32F);
 
struct RGB323232F {
    static constexpr auto FORMAT = ImageFormat::R32F;
    float r;
    float g;
    float b;
}; VTFPP_CHECK_SIZE(RGB323232F);
 
struct RGBA32323232F {
    static constexpr auto FORMAT = ImageFormat::RGBA32323232F;
    float r;
    float g;
    float b;
    float a;
}; VTFPP_CHECK_SIZE(RGBA32323232F);
 
struct RG1616F {
    static constexpr auto FORMAT = ImageFormat::RG1616F;
    half r;
    half g;
}; VTFPP_CHECK_SIZE(RG1616F);
 
struct RG3232F {
    static constexpr auto FORMAT = ImageFormat::RG3232F;
    float r;
    float g;
}; VTFPP_CHECK_SIZE(RG3232F);
 
struct RGBX8888 {
    static constexpr auto FORMAT = ImageFormat::RGBX8888;
    uint8_t r;
    uint8_t g;
    uint8_t b;
    uint8_t x;
}; VTFPP_CHECK_SIZE(RGBX8888);
 
struct RGBA1010102 {
    static constexpr auto FORMAT = ImageFormat::RGBA1010102;
    uint32_t r : 10;
    uint32_t g : 10;
    uint32_t b : 10;
    uint32_t a : 2;
}; VTFPP_CHECK_SIZE(RGBA1010102);
 
struct BGRA1010102 {
    static constexpr auto FORMAT = ImageFormat::BGRA1010102;
    uint32_t b : 10;
    uint32_t g : 10;
    uint32_t r : 10;
    uint32_t a : 2;
}; VTFPP_CHECK_SIZE(BGRA1010102);
 
struct R16F {
    static constexpr auto FORMAT = ImageFormat::R16F;
    half r;
}; VTFPP_CHECK_SIZE(R16F);
 
struct R8 {
    static constexpr auto FORMAT = ImageFormat::R8;
    uint8_t r;
}; VTFPP_CHECK_SIZE(R8);
 
VTFPP_FORMAT_INHERITED(CONSOLE_BGRX8888_LINEAR, BGRX8888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_RGBA8888_LINEAR, RGBA8888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_ABGR8888_LINEAR, ABGR8888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_ARGB8888_LINEAR, ARGB8888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_BGRA8888_LINEAR, BGRA8888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_RGB888_LINEAR, RGB888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_BGR888_LINEAR, BGR888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_BGRX5551_LINEAR, BGRX5551);
 
VTFPP_FORMAT_INHERITED(CONSOLE_I8_LINEAR, I8);
 
VTFPP_FORMAT_INHERITED(CONSOLE_RGBA16161616_LINEAR, RGBA16161616);
 
VTFPP_FORMAT_INHERITED(CONSOLE_BGRX8888_LE, BGRX8888);
 
VTFPP_FORMAT_INHERITED(CONSOLE_BGRA8888_LE, BGRA8888);
 
#undef VTFPP_FORMAT_INHERITED
#undef VTFPP_CHECK_SIZE
 
template<typename T>
concept PixelType =
        std::same_as<T, RGBA8888> ||
        std::same_as<T, ABGR8888> ||
        std::same_as<T, RGB888> ||
        std::same_as<T, BGR888> ||
        std::same_as<T, RGB565> ||
        std::same_as<T, I8> ||
        std::same_as<T, IA88> ||
        std::same_as<T, P8> ||
        std::same_as<T, A8> ||
        std::same_as<T, RGB888_BLUESCREEN> ||
        std::same_as<T, BGR888_BLUESCREEN> ||
        std::same_as<T, ARGB8888> ||
        std::same_as<T, BGRA8888> ||
        std::same_as<T, BGRX8888> ||
        std::same_as<T, BGR565> ||
        std::same_as<T, BGRX5551> ||
        std::same_as<T, BGRA4444> ||
        std::same_as<T, BGRA5551> ||
        std::same_as<T, UV88> ||
        std::same_as<T, UVWQ8888> ||
        std::same_as<T, RGBA16161616F> ||
        std::same_as<T, RGBA16161616> ||
        std::same_as<T, UVLX8888> ||
        std::same_as<T, R32F> ||
        std::same_as<T, RGB323232F> ||
        std::same_as<T, RGBA32323232F> ||
        std::same_as<T, RG1616F> ||
        std::same_as<T, RG3232F> ||
        std::same_as<T, RGBX8888> ||
        std::same_as<T, RGBA1010102> ||
        std::same_as<T, BGRA1010102> ||
        std::same_as<T, R16F> ||
        std::same_as<T, CONSOLE_BGRX8888_LINEAR> ||
        std::same_as<T, CONSOLE_RGBA8888_LINEAR> ||
        std::same_as<T, CONSOLE_ABGR8888_LINEAR> ||
        std::same_as<T, CONSOLE_ARGB8888_LINEAR> ||
        std::same_as<T, CONSOLE_BGRA8888_LINEAR> ||
        std::same_as<T, CONSOLE_RGB888_LINEAR> ||
        std::same_as<T, CONSOLE_BGR888_LINEAR> ||
        std::same_as<T, CONSOLE_BGRX5551_LINEAR> ||
        std::same_as<T, CONSOLE_I8_LINEAR> ||
        std::same_as<T, CONSOLE_RGBA16161616_LINEAR> ||
        std::same_as<T, CONSOLE_BGRX8888_LE> ||
        std::same_as<T, CONSOLE_BGRA8888_LE> ||
        std::same_as<T, R8>;
 
} // namespace ImagePixel
 
namespace ImageConversion {
 
constexpr float DEFAULT_COMPRESSED_QUALITY = 0.105f;
 
[[nodiscard]] std::vector<std::byte> convertImageDataToFormat(std::span<const std::byte> imageData, ImageFormat oldFormat, ImageFormat newFormat, uint16_t width, uint16_t height, float quality = DEFAULT_COMPRESSED_QUALITY);
 
[[nodiscard]] std::vector<std::byte> convertSeveralImageDataToFormat(std::span<const std::byte> imageData, ImageFormat oldFormat, ImageFormat newFormat, uint8_t mipCount, uint16_t frameCount, uint8_t faceCount, uint16_t width, uint16_t height, uint16_t depth, float quality = DEFAULT_COMPRESSED_QUALITY);
 
[[nodiscard]] std::array<std::vector<std::byte>, 6> convertHDRIToCubeMap(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t height, uint16_t resolution = 0, bool bilinear = true);
 
enum class FileFormat {
    DEFAULT = 0,
    PNG     = 1,
    JPG     = 2,
    BMP     = 3,
    TGA     = 4,
#ifdef VTFPP_SUPPORT_WEBP
    WEBP    = 5,
#endif
#ifdef VTFPP_SUPPORT_QOI
    QOI     = 6,
#endif
    HDR     = 7,
#ifdef VTFPP_SUPPORT_EXR
    EXR     = 8,
#endif
};
 
[[nodiscard]] FileFormat getDefaultFileFormatForImageFormat(ImageFormat format);
 
[[nodiscard]] std::vector<std::byte> convertImageDataToFile(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t height, FileFormat fileFormat = FileFormat::DEFAULT);
 
[[nodiscard]] std::vector<std::byte> convertFileToImageData(std::span<const std::byte> fileData, ImageFormat& format, int& width, int& height, int& frameCount);
 
enum class ResizeEdge {
    // Matches stbir_edge
    CLAMP = 0,
    REFLECT,
    WRAP,
    ZERO,
};
 
enum class ResizeFilter {
    // Matches stbir_filter
    DEFAULT = 0,
    BOX,
    BILINEAR,
    CUBIC_BSPLINE,
    CATMULL_ROM,
    MITCHELL,
    POINT_SAMPLE,
 
    // User-defined
    KAISER = 100,
    NICE = 101,
};
 
enum class ResizeMethod {
    NONE,
    POWER_OF_TWO_BIGGER,
    POWER_OF_TWO_SMALLER,
    POWER_OF_TWO_NEAREST,
};
 
[[nodiscard]] uint16_t getResizedDim(uint16_t n, ResizeMethod method);
 
void setResizedDims(uint16_t& width, ResizeMethod widthResize, uint16_t& height, ResizeMethod heightResize);
 
[[nodiscard]] std::vector<std::byte> resizeImageData(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t newWidth, uint16_t height, uint16_t newHeight, bool srgb, ResizeFilter filter, ResizeEdge edge = ResizeEdge::CLAMP);
 
[[nodiscard]] std::vector<std::byte> resizeImageDataStrict(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t newWidth, uint16_t& widthOut, ResizeMethod widthResize, uint16_t height, uint16_t newHeight, uint16_t& heightOut, ResizeMethod heightResize, bool srgb, ResizeFilter filter, ResizeEdge edge = ResizeEdge::CLAMP);
 
[[nodiscard]] std::vector<std::byte> cropImageData(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t newWidth, uint16_t xOffset, uint16_t height, uint16_t newHeight, uint16_t yOffset);
 
[[nodiscard]] std::vector<std::byte> gammaCorrectImageData(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t height, float gamma);
 
[[nodiscard]] std::vector<std::byte> invertGreenChannelForImageData(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t height);
 
template<ImagePixel::PixelType P>
[[nodiscard]] std::vector<std::byte> extractChannelFromImageData(std::span<const std::byte> imageData, auto P::*channel) {
    using C = sourcepp::member_type_t<decltype(channel)>;
    if (imageData.empty() || imageData.size() % sizeof(P) != 0) {
        return {};
    }
 
    std::span pixels{reinterpret_cast<const P*>(imageData.data()), imageData.size() / sizeof(P)};
 
    std::vector<std::byte> out(imageData.size() / sizeof(P) * sizeof(C));
    BufferStream stream{out, false};
    for (const auto& pixel : pixels) {
        stream << pixel.*channel;
    }
    return out;
}
 
} // namespace ImageConversion
 
} // namespace vtfpp