ImageConversion.h

Go to the documentation of this file.

#pragma once
 
#include <array>
#include <cstddef>
#include <span>
#include <vector>
 
#include <BufferStream.h>
 
#include "ImageFormats.h"
 
namespace vtfpp::ImageConversion {
 
// Negative means use default quality
// BC7, BC6H: 0.1
// Everything else: 1.0
constexpr float DEFAULT_COMPRESSED_QUALITY = -1.f;

[[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,
};
 
struct ResizeBounds {
    uint16_t resizeMinWidth = 0;
    uint16_t resizeMaxWidth = 0;
    uint16_t resizeMinHeight = 0;
    uint16_t resizeMaxHeight = 0;
 
    ResizeBounds() = default;
    explicit ResizeBounds(uint16_t size) : resizeMinWidth{size}, resizeMaxWidth{size}, resizeMinHeight{size}, resizeMaxHeight{size} {}
    ResizeBounds(uint16_t width, uint16_t height) : resizeMinWidth{width}, resizeMaxWidth{width}, resizeMinHeight{height}, resizeMaxHeight{height} {}
    ResizeBounds(uint16_t minWidth, uint16_t maxWidth, uint16_t minHeight, uint16_t maxHeight) : resizeMinWidth{minWidth}, resizeMaxWidth{maxWidth}, resizeMinHeight{minHeight}, resizeMaxHeight{maxHeight} {}
 
    [[nodiscard]] std::pair<uint16_t, uint16_t> clamp(uint16_t width, uint16_t height) const;
};

[[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> padImageData(std::span<const std::byte> imageData, ImageFormat format, uint16_t width, uint16_t widthPad, uint16_t height, uint16_t heightPad);

[[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);
 
} // namespace vtfpp::ImageConversion