Array2D.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2024 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Resolution.h"
 
#include <cstddef>
#include <cstring>
#include <iterator>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <string>
#include <type_traits>
 
namespace Zivid
{
    template<class PixelFormat>
    class Image;
 
#ifndef NO_DOC
    namespace Detail
    {
        ZIVID_CORE_EXPORT std::string array2DToString(std::size_t width, std::size_t height);
    } // namespace Detail
#endif
 
    template<typename DataFormat>
    class Array2D
    {
    public:
        using ValueType = DataFormat;
 
        using ConstIterator = const DataFormat *;
 
        Array2D()
            : m_width{ 0 }
            , m_height{ 0 }
        {}
 
        size_t width() const
        {
            return m_width;
        }
 
        size_t height() const
        {
            return m_height;
        }
 
        size_t size() const
        {
            return width() * height();
        }
 
        bool isEmpty() const
        {
            return size() == 0;
        }
 
        const DataFormat *data() const
        {
            return m_data.get();
        }
 
        const DataFormat &operator()(size_t idx) const
        {
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic push
#        pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#    endif
#endif
            return *(data() + idx);
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic pop
#    endif
#endif
        }
 
        const DataFormat &operator()(size_t i, size_t j) const
        {
            return operator()(width() * i + j);
        }
 
        ConstIterator begin() const
        {
            return data();
        }
 
        ConstIterator end() const
        {
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic push
#        pragma clang diagnostic ignored "-Wunsafe-buffer-usage"
#    endif
#endif
            return data() + size();
#ifdef __clang__
#    if __has_warning("-Wunsafe-buffer-usage")
#        pragma clang diagnostic pop
#    endif
#endif
        }
 
        ConstIterator cbegin() const
        {
            return begin();
        }
 
        ConstIterator cend() const
        {
            return end();
        }
 
        std::string toString() const
        {
            return Detail::array2DToString(width(), height());
        }
 
    private:
        template<
            typename Iterator,
            typename T = DataFormat,
            typename std::enable_if<
                std::is_convertible<typename std::iterator_traits<Iterator>::value_type, T>::value,
                std::nullptr_t>::type = nullptr>
        Array2D(const Resolution &resolution, Iterator beginIt, Iterator endIt)
            : m_width{ resolution.width() }
            , m_height{ resolution.height() }
            , m_data{ [&] {
                         const auto inputSize = std::distance(beginIt, endIt);
                         if(inputSize != static_cast<std::ptrdiff_t>(resolution.size()))
                         {
                             /* NOLINT */ throw std::out_of_range(
                                 "Array2D constructor got input that does not match image size. Expected "
                                 + std::to_string(resolution.size()) + " items, got " + std::to_string(inputSize)
                                 + " items.");
                         }
                         std::unique_ptr<DataFormat[]> data{ new DataFormat[resolution.size()] };
                         std::copy(beginIt, endIt, data.get());
                         return data.release();
                     }(),
                      std::default_delete<DataFormat[]>() }
        {}
 
        template<
            typename T = DataFormat,
            typename std::enable_if<std::is_trivial<T>::value, std::nullptr_t>::type = nullptr>
        Array2D(const Resolution &resolution, const unsigned char *begin, const unsigned char *end)
            : m_width{ resolution.width() }
            , m_height{ resolution.height() }
        {
            const auto byteCount = std::distance(begin, end);
            {
                const auto expectedByteCount = static_cast<std::ptrdiff_t>(resolution.size() * sizeof(DataFormat));
                if(expectedByteCount != byteCount)
                {
                    std::ostringstream errorMessage;
                    errorMessage
                        << "The provided input buffer size does not match the expected size. The provided input buffer size is "
                        << byteCount << " bytes. Expected " << expectedByteCount << " bytes (" << resolution.width()
                        << " x " << resolution.height() << " x " << sizeof(DataFormat) << " bytes).";
                    /* NOLINT */ throw std::logic_error(std::move(errorMessage).str());
                }
            }
            std::shared_ptr<DataFormat> data(new DataFormat[resolution.size()], std::default_delete<DataFormat[]>{});
 
            if(resolution.size() != 0) // To handle the case where resolution is zero and begin == end == nullptr.
            {
                std::memcpy(data.get(), begin, byteCount);
            }
 
            m_data = std::move(data);
        }
 
        friend class Array2DFactory;
        friend class Image<DataFormat>;
 
        Array2D(std::size_t width, std::size_t height, std::unique_ptr<DataFormat[]> data)
            : m_width{ width }
            , m_height{ height }
            , m_data{ // Due to poor support for shared_ptr array types in C++11 the data
                      // ownership is transferred from the std::unique_ptr to a std::shared_ptr
                      // of non-array type with a specified array deleter.
                      data.release(),
                      std::default_delete<DataFormat[]>()
            }
        {}
 
        std::size_t m_width;
        std::size_t m_height;
        std::shared_ptr<const DataFormat> m_data;
    };
 
    template<typename T>
    std::ostream &operator<<(std::ostream &stream, const Array2D<T> &array)
    {
        return stream << array.toString();
    }
 
    template<typename T>
    typename Array2D<T>::ConstIterator cbegin(const Array2D<T> &array)
    {
        return array.cbegin();
    }
 
    template<typename T>
    typename Array2D<T>::ConstIterator begin(const Array2D<T> &array)
    {
        return array.begin();
    }
 
    template<typename T>
    typename Array2D<T>::ConstIterator cend(const Array2D<T> &array)
    {
        return array.cend();
    }
 
    template<typename T>
    typename Array2D<T>::ConstIterator end(const Array2D<T> &array)
    {
        return array.end();
    }
} // namespace Zivid