DeviceArray.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2026 (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/Array1D.h"
#include "Zivid/Array2D.h"
#include "Zivid/Color.h"
#include "Zivid/ComputeWrappers.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Disparity.h"
#include "Zivid/Image.h"
#include "Zivid/Normal.h"
#include "Zivid/Point.h"
#include "Zivid/SNR.h"
 
#include <memory>
#include <type_traits>
#include <vector>
 
namespace Zivid
{
    template<typename Format>
    class DeviceArray
    {
        static_assert(
            std::is_same_v<Format, PointXYZ> || std::is_same_v<Format, PointXYZW> || std::is_same_v<Format, PointZ>
                || std::is_same_v<Format, SNR> || std::is_same_v<Format, Disparity> || std::is_same_v<Format, NormalXYZ>
                || std::is_same_v<Format, ColorRGBA> || std::is_same_v<Format, ColorRGBA_SRGB>
                || std::is_same_v<Format, ColorBGRA> || std::is_same_v<Format, ColorBGRA_SRGB>
                || std::is_same_v<Format, ColorRGBAf> || std::is_same_v<Format, ColorRGB>
                || std::is_same_v<Format, ColorRGB_SRGB> || std::is_same_v<Format, ColorBGR>
                || std::is_same_v<Format, ColorBGR_SRGB>,
            "Format must be one of: PointXYZ, PointXYZW, PointZ, SNR, Disparity, NormalXYZ, "
            "ColorRGBA, ColorRGBA_SRGB, ColorBGRA, ColorBGRA_SRGB, ColorRGBAf, ColorRGB, ColorRGB_SRGB, "
            "ColorBGR, or ColorBGR_SRGB");
 
    public:
        DeviceArray() = default;

        ~DeviceArray() = default;

        DeviceArray(const DeviceArray &other) = default;

        DeviceArray &operator=(const DeviceArray &other) = default;

        DeviceArray(DeviceArray &&other) noexcept = default;

        DeviceArray &operator=(DeviceArray &&other) noexcept = default;

        void *devicePointer() const;

        std::vector<int> shape() const;

        std::vector<int> strides() const;

        std::vector<int> stridesInBytes() const;

        size_t size() const;

        size_t sizeInBytes() const;

        ComputeBackend backend() const;

        bool isValid() const;

        bool isEmpty() const;

        Array2D<Format> toArray2D(StreamOrQueue streamOrQueue) const;

        Array1D<Format> toArray1D(StreamOrQueue streamOrQueue) const;

        void copyToHost(Format *destination, size_t sizeInBytes, StreamOrQueue streamOrQueue) const;
 
#ifndef NO_DOC
        explicit DeviceArray(std::shared_ptr<class DeviceArrayInterface> impl);
        const std::shared_ptr<class DeviceArrayInterface> &getImpl() const;
#endif
 
    private:
        std::shared_ptr<class DeviceArrayInterface> m_impl;
    };
 
#ifndef NO_DOC
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<PointXYZ>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<PointXYZW>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<PointZ>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<SNR>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<Disparity>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<NormalXYZ>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorRGBA>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorRGBA_SRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorBGRA>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorBGRA_SRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorRGBAf>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorRGB_SRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorBGR>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArray<ColorBGR_SRGB>;
#endif

    template<typename Format>
    class DeviceArrayView
    {
        static_assert(
            std::is_same_v<Format, PointXYZ> || std::is_same_v<Format, PointXYZW> || std::is_same_v<Format, PointZ>
                || std::is_same_v<Format, SNR> || std::is_same_v<Format, Disparity> || std::is_same_v<Format, NormalXYZ>
                || std::is_same_v<Format, ColorRGBA> || std::is_same_v<Format, ColorRGBA_SRGB>
                || std::is_same_v<Format, ColorBGRA> || std::is_same_v<Format, ColorBGRA_SRGB>
                || std::is_same_v<Format, ColorRGBAf> || std::is_same_v<Format, ColorRGB>
                || std::is_same_v<Format, ColorRGB_SRGB> || std::is_same_v<Format, ColorBGR>
                || std::is_same_v<Format, ColorBGR_SRGB>,
            "Format must be one of: PointXYZ, PointXYZW, PointZ, SNR, Disparity, NormalXYZ, "
            "ColorRGBA, ColorRGBA_SRGB, ColorBGRA, ColorBGRA_SRGB, ColorRGBAf, ColorRGB, ColorRGB_SRGB, "
            "ColorBGR, or ColorBGR_SRGB");
 
    public:
        DeviceArrayView() = default;

        // NOLINTNEXTLINE(google-explicit-constructor,hicpp-explicit-conversions)
        DeviceArrayView(const DeviceArray<Format> &source);

        ~DeviceArrayView() = default;

        DeviceArrayView(const DeviceArrayView &other) = default;

        DeviceArrayView &operator=(const DeviceArrayView &other) = default;

        DeviceArrayView(DeviceArrayView &&other) noexcept = default;

        DeviceArrayView &operator=(DeviceArrayView &&other) noexcept = default;

        void *devicePointer() const;

        std::vector<int> shape() const;

        std::vector<int> strides() const;

        std::vector<int> stridesInBytes() const;

        size_t size() const;

        size_t sizeInBytes() const;

        ComputeBackend backend() const;

        bool isValid() const;

        bool isEmpty() const;

        void copyToHost(Format *destination, size_t sizeInBytes, StreamOrQueue streamOrQueue) const;

        Array2D<Format> toArray2D(StreamOrQueue streamOrQueue) const;

        Array1D<Format> toArray1D(StreamOrQueue streamOrQueue) const;
 
#ifndef NO_DOC
        explicit DeviceArrayView(std::shared_ptr<class DeviceArrayInterface> impl);
        const std::shared_ptr<class DeviceArrayInterface> &getImpl() const;
#endif
 
    private:
        std::shared_ptr<class DeviceArrayInterface> m_impl;
    };
 
#ifndef NO_DOC
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<PointXYZ>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<PointXYZW>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<PointZ>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<SNR>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<Disparity>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<NormalXYZ>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorRGBA>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorRGBA_SRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorBGRA>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorBGRA_SRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorRGBAf>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorRGB_SRGB>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorBGR>;
    extern template class ZIVID_CORE_EXPORT_NON_WIN32 DeviceArrayView<ColorBGR_SRGB>;
#endif
 
#ifndef NO_DOC
    namespace Detail
    {
        template<typename ColorFormat>
        struct SupportedImageDeviceArrayColorFormat : std::false_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorRGBA> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorBGRA> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorRGBA_SRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorBGRA_SRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorRGBAf> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorRGB_SRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorBGR> : std::true_type
        {};
 
        template<>
        struct SupportedImageDeviceArrayColorFormat<ColorBGR_SRGB> : std::true_type
        {};
 
        template<typename Format>
        struct SupportedDeviceArrayViewFormat : std::bool_constant<SupportedImageDeviceArrayColorFormat<Format>::value>
        {};
    } // namespace Detail
#endif

    template<typename ColorFormat, typename = std::enable_if_t<Detail::SupportedImageColorFormat<ColorFormat>::value>>
    Image<ColorFormat> toImage(const DeviceArray<ColorFormat> &buffer, StreamOrQueue streamOrQueue)
    {
        return Image<ColorFormat>{ buffer.toArray2D(streamOrQueue) };
    }

    template<typename ColorFormat, typename = std::enable_if_t<Detail::SupportedImageColorFormat<ColorFormat>::value>>
    Image<ColorFormat> toImage(const DeviceArrayView<ColorFormat> &buffer, StreamOrQueue streamOrQueue)
    {
        return Image<ColorFormat>{ buffer.toArray2D(streamOrQueue) };
    }
} // namespace Zivid