Data.h

#pragma once
 
/* <editor-fold desc="MIT License">
 
Copyright(c) 2018 Robert Osfield
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
</editor-fold> */
 
#include <vsg/core/Allocator.h>
#include <vsg/core/Object.h>
#include <vsg/core/compare.h>
#include <vsg/core/type_name.h>
#include <vsg/vk/vulkan.h>
 
#include <cstring>
#include <vector>
 
namespace vsg
{
 
    // forward declaer MipmapLayout
    class MipmapLayout;

    struct ModifiedCount
    {
        uint32_t count = 0;
 
        bool operator==(const ModifiedCount& rhs) const { return count == rhs.count; }
        bool operator!=(const ModifiedCount& rhs) const { return count != rhs.count; }
 
        void operator++() { ++count; }
    };

    struct block64
    {
        uint8_t value[8];
    };

    struct block128
    {
        uint8_t value[16];
    };
 
    enum Origin : uint8_t
    {
        TOP_LEFT = 0,
        BOTTOM_LEFT = 2
    };
 
    enum DataVariance : uint8_t
    {
        STATIC_DATA = 0,                       
        STATIC_DATA_UNREF_AFTER_TRANSFER = 1,  
        DYNAMIC_DATA = 2,                      
        DYNAMIC_DATA_TRANSFER_AFTER_RECORD = 3 
    };
 
    template<typename T>
    struct stride_iterator
    {
        using value_type = T;
        using iterator_category = std::forward_iterator_tag;
        using difference_type = std::ptrdiff_t;
        using pointer = T*;
        using reference = T&;
 
        value_type* ptr;
        uint32_t stride; // stride in bytes
 
        inline void advance()
        {
            if constexpr (std::is_const<value_type>::value)
                ptr = reinterpret_cast<value_type*>(reinterpret_cast<const uint8_t*>(ptr) + stride);
            else
                ptr = reinterpret_cast<value_type*>(reinterpret_cast<uint8_t*>(ptr) + stride);
        }
 
        stride_iterator& operator++()
        {
            advance();
            return *this;
        }
        stride_iterator operator++(int)
        {
            stride_iterator reval(*this);
            advance();
            return reval;
        }
 
        bool operator==(stride_iterator rhs) const { return ptr == rhs.ptr; }
        bool operator!=(stride_iterator rhs) const { return ptr != rhs.ptr; }
        bool operator<(stride_iterator rhs) const { return ptr < rhs.ptr; }
        bool operator<=(stride_iterator rhs) const { return ptr <= rhs.ptr; }
        bool operator>(stride_iterator rhs) const { return ptr > rhs.ptr; }
        bool operator>=(stride_iterator rhs) const { return ptr >= rhs.ptr; }
 
        value_type& operator*() { return *reinterpret_cast<value_type*>(ptr); }
        value_type* operator->() { return reinterpret_cast<value_type*>(ptr); }
    };
 
    class MipmapLayout;

    class VSG_DECLSPEC Data : public Object
    {
    public:
        /* Properties used for specifying the format of the data, use of mipmaps, block compressed data and origin.
         * Default of no mipmapping and {1,1,1} is uncompressed.
         * A single block (Block64/Block128) is stored as a single value with the Data object. */
        struct VSG_DECLSPEC Properties
        {
            Properties() = default;
            Properties(const Properties& rhs) = default;
            explicit Properties(VkFormat in_format) :
                format(in_format) {}
 
            VkFormat format = VK_FORMAT_UNDEFINED;
            uint32_t stride = 0;
            uint8_t mipLevels = 0;
            uint8_t blockWidth = 1;
            uint8_t blockHeight = 1;
            uint8_t blockDepth = 1;
            uint8_t origin = TOP_LEFT;               
            int8_t imageViewType = -1;               
            DataVariance dataVariance = STATIC_DATA; 
            AllocatorType allocatorType = ALLOCATOR_TYPE_VSG_ALLOCATOR;
 
            int compare(const Properties& rhs) const;
            Properties& operator=(const Properties& rhs);
        };
 
        Data() {}
 
        Data(const Data& data, const CopyOp& copyop = {}) :
            Object(data, copyop), properties(data.properties) {}
 
        explicit Data(Properties layout) :
            properties(layout) {}
 
        Data(Properties layout, uint32_t min_stride) :
            properties(layout)
        {
            if (properties.stride < min_stride) properties.stride = min_stride;
        }

        static void* operator new(size_t count);
        static void operator delete(void* ptr);
 
        size_t sizeofObject() const noexcept override { return sizeof(Data); }
        bool is_compatible(const std::type_info& type) const noexcept override { return typeid(Data) == type || Object::is_compatible(type); }
 
        int compare(const Object& rhs_object) const override;
 
        void read(Input& input) override;
        void write(Output& output) const override;

        Properties properties;
 
        bool dynamic() const { return properties.dataVariance >= DYNAMIC_DATA; }
 
        virtual size_t valueSize() const = 0;
        virtual size_t valueCount() const = 0;
 
        virtual bool dataAvailable() const = 0;
        virtual size_t dataSize() const = 0;
 
        virtual void* dataPointer() = 0;
        virtual const void* dataPointer() const = 0;
 
        virtual void* dataPointer(size_t index) = 0;
        virtual const void* dataPointer(size_t index) const = 0;
 
        virtual void* dataRelease() = 0;
 
        virtual uint32_t dimensions() const = 0;
 
        virtual uint32_t width() const = 0;
        virtual uint32_t height() const = 0;
        virtual uint32_t depth() const = 0;

        std::tuple<uint32_t, uint32_t, uint32_t> pixelExtents() const;
 
        bool contiguous() const { return valueSize() == properties.stride; }
 
        uint32_t stride() const { return properties.stride ? properties.stride : static_cast<uint32_t>(valueSize()); }
 
        size_t computeValueCountIncludingMipmaps() const;

        void dirty() { ++_modifiedCount; }

        bool getModifiedCount(ModifiedCount& mc) const
        {
            if (_modifiedCount != mc)
            {
                mc = _modifiedCount;
                return true;
            }
            else
                return false;
        }

        bool differentModifiedCount(const ModifiedCount& mc) const { return _modifiedCount != mc; }

        void setMipmapLayout(MipmapLayout* mipmapData);

        const MipmapLayout* getMipmapLayout() const;
 
    protected:
        virtual ~Data() {}
 
        void _copy(const Data& rhs);
        void _clear();
 
        ModifiedCount _modifiedCount;
 
#if 1
    public:
        using Layout = Properties;

        void setLayout(Layout layout)
        {
            VkFormat previous_format = properties.format; // temporary hack to keep applications that call setFormat(..) before setLayout(..) working
            uint32_t previous_stride = properties.stride;
            properties = layout;
            if (properties.format == 0 && previous_format != 0) properties.format = previous_format; // temporary hack to keep existing applications working
            if (properties.stride == 0 && previous_stride != 0) properties.stride = previous_stride; // make sure the layout has a valid stride.
        }

        Layout& getLayout() { return properties; }
        Layout getLayout() const { return properties; }
#endif
    };
    VSG_type_name(vsg::Data);
 
    using DataList = std::vector<ref_ptr<Data>>;
 
} // namespace vsg