RawInputImage.h

/*
 * Copyright 2023 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
#pragma once
 
#include <lagrange/common.h>
#include <lagrange/image/api.h>
 
#include <cassert>
#include <vector>
 
namespace lagrange {
namespace image {
 
class LA_IMAGE_API RawInputImage
{
public:
    enum class precision_semantic : uint32_t {
        byte_p, 
        half_p, 
        single_p, 
        double_p 
    };
 
    enum class color_space : uint32_t {
        linear, 
        sRGB 
    };
 
    enum class texture_format : uint32_t {
        luminance = ((1) << 8) | 0x0,
        luminance_alpha = ((2) << 8) | 0x1,
        alpha_luminance = ((2) << 8) | 0x2,
        rgb = ((3) << 8) | 0x4,
        bgr = ((3) << 8) | 0x8,
        rgba = ((4) << 8) | 0x10,
        argb = ((4) << 8) | 0x12, 
        bgra = ((4) << 8) | 0x14, 
        max = ((4) << 8) | ((1 << 8) - 1) 
    };
 
    enum class image_storage_format : uint32_t {
        first_pixel_row_at_bottom, 
        first_pixel_row_at_top 
    };
 
    enum class wrap_mode : uint32_t {
        repeat, 
        clamp, 
        mirror 
    };
 
    enum class texture_filtering : uint32_t {
        nearest, 
        bilinear 
    };
 
    template <typename Scalar, uint32_t NumChannels>
    struct PixelTraits;
 
public:
    size_t get_width() const { return m_width; }
    size_t get_height() const { return m_height; }
    size_t get_row_byte_stride() const { return m_row_byte_stride; }
    precision_semantic get_pixel_precision() const { return m_pixel_precision; }
    color_space get_color_space() const { return m_color_space; }
    texture_format get_tex_format() const { return m_tex_format; }
    wrap_mode get_wrap_u() const { return m_wrap_u; }
    wrap_mode get_wrap_v() const { return m_wrap_v; }
    image_storage_format get_storage_format() const { return m_storage_format; }
 
    size_t get_size_precision() const
    {
        return static_cast<size_t>(1llu << static_cast<uint32_t>(m_pixel_precision));
    }
 
    size_t get_num_channels() const
    {
        return static_cast<size_t>(static_cast<uint32_t>(m_tex_format) >> 8u);
    }
 
    size_t get_size_pixel() const { return get_size_precision() * get_num_channels(); }
 
    size_t get_row_stride() const
    {
        return (0 == m_row_byte_stride ? get_size_pixel() * m_width : m_row_byte_stride);
    }
 
    size_t get_pixel_data_offset() const
    {
        return image_storage_format::first_pixel_row_at_top == m_storage_format
                   ? 0
                   : get_row_stride() * (m_height - 1);
    }
 
    const void* get_pixel_data() const;
 
    void set_width(size_t x) { m_width = x; }
    void set_height(size_t x) { m_height = x; }
    void set_row_byte_stride(size_t x) { m_row_byte_stride = x; }
    void set_pixel_precision(precision_semantic x) { m_pixel_precision = x; }
    void set_color_space(color_space x) { m_color_space = x; }
    void set_tex_format(texture_format x) { m_tex_format = x; }
    void set_wrap_u(wrap_mode x) { m_wrap_u = x; }
    void set_wrap_v(wrap_mode x) { m_wrap_v = x; }
    void set_storage_format(image_storage_format x) { m_storage_format = x; }
 
    void set_pixel_data(const void* pixel_data, const bool copy_to_local);
 
    void set_pixel_data_buffer(std::vector<unsigned char> pixel_data_buffer);
 
    bool operator==(const RawInputImage& other) const;
    bool operator!=(const RawInputImage& other) const { return !(*this == other); }
 
    template <typename TexcoordScalar, typename Scalar, uint32_t NumChannels>
    typename PixelTraits<Scalar, NumChannels>::Pixel sample(
        const TexcoordScalar u,
        const TexcoordScalar v,
        const texture_filtering filtering = texture_filtering::bilinear) const;
 
    template <typename TexcoordScalar, typename Scalar, uint32_t NumChannels>
    typename PixelTraits<Scalar, NumChannels>::Pixel sample_float(
        const TexcoordScalar u,
        const TexcoordScalar v,
        const texture_filtering filtering = texture_filtering::bilinear) const;
 
    template <typename Archive>
    void serialize_impl(Archive& ar);
 
protected:
    template <
        typename TexcoordScalar,
        typename Scalar,
        uint32_t NumChannels,
        typename InternalScalar,
        uint32_t InternalNumChannels>
    typename PixelTraits<Scalar, NumChannels>::Pixel sample(
        const TexcoordScalar u,
        const TexcoordScalar v,
        const texture_filtering filtering = texture_filtering::bilinear) const;
 
protected:
    size_t m_width = 0;
    size_t m_height = 0;
    size_t m_row_byte_stride = 0;
    precision_semantic m_pixel_precision = precision_semantic::single_p;
    color_space m_color_space = color_space::linear;
    texture_format m_tex_format = texture_format::rgba;
    wrap_mode m_wrap_u = wrap_mode::clamp;
    wrap_mode m_wrap_v = wrap_mode::clamp;
    image_storage_format m_storage_format = image_storage_format::first_pixel_row_at_top;
 
    const void* m_pixel_data = nullptr;
 
    std::vector<unsigned char> m_local_pixel_data;
};
 
template <typename Scalar, uint32_t NumChannels>
struct RawInputImage::PixelTraits
{
    static_assert(
        0u < NumChannels && NumChannels <= (static_cast<uint32_t>(texture_format::max) >> 8u));
    static_assert(
        std::is_same<unsigned char, Scalar>::value || std::is_same<Eigen::half, Scalar>::value ||
        std::is_same<float, Scalar>::value || std::is_same<double, Scalar>::value);
 
    using Pixel = Eigen::Matrix<Scalar, NumChannels, 1>;
 
    static Pixel zero() { return Pixel::Zero(); }
 
    static Scalar coeff(const Pixel& p, const size_t i)
    {
        assert(i < NumChannels);
        return p[i];
    }
 
    static Scalar& coeff(Pixel& p, const size_t i)
    {
        assert(i < NumChannels);
        return p[i];
    }
};
 
template <typename Scalar>
struct RawInputImage::PixelTraits<Scalar, 1>
{
    static_assert(
        std::is_same<unsigned char, Scalar>::value || std::is_same<Eigen::half, Scalar>::value ||
        std::is_same<float, Scalar>::value || std::is_same<double, Scalar>::value);
 
    using Pixel = Scalar;
 
    static Pixel zero() { return static_cast<Scalar>(0); }
 
    static Scalar coeff(const Pixel& p, [[maybe_unused]] const size_t i)
    {
        assert(0 == i);
        return p;
    }
 
    static Scalar& coeff(Pixel& p, [[maybe_unused]] const size_t i)
    {
        assert(0 == i);
        return p;
    }
};
 
template <typename Archive>
void serialize(lagrange::image::RawInputImage& image, Archive& ar)
{
    image.serialize_impl(ar);
}
 
LA_IMAGE_API RawInputImage
make_default_rgba_image(std::size_t i_width, std::size_t i_height, const void* i_pixels);
 
LA_IMAGE_API RawInputImage
make_default_luminance_image(std::size_t i_width, std::size_t i_height, const void* i_pixels);
 
template <typename T>
T wrap_uv(const T u, const RawInputImage::wrap_mode m)
{
    if (RawInputImage::wrap_mode::clamp == m) {
        return std::clamp(u, static_cast<T>(0), static_cast<T>(1));
    } else if (RawInputImage::wrap_mode::repeat == m) {
        return u - std::floor(u);
    } else if (RawInputImage::wrap_mode::mirror == m) {
        const auto f = static_cast<int>(std::floor(u));
        auto _u = u - static_cast<T>(f);
        if (f & 1) {
            _u = static_cast<T>(1) - _u;
        }
        return _u;
    }
    assert(0);
    return u;
}
 
} // namespace image
} // namespace lagrange
 
#include <lagrange/image/RawInputImage.impl.h>