Image.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/Array2D.h"
#include "Zivid/Color.h"
#include "Zivid/Detail/CoreExport.h"
 
#include <string>
#include <type_traits>
 
namespace Zivid
{
#ifndef NO_DOC
    namespace Detail
    {
        template<typename T>
        class LoadImageTag
        {};
 
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorRGBA> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorBGRA> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorRGBA_SRGB> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorBGRA_SRGB> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorRGB> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorRGB_SRGB> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorBGR> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT void saveImageImpl(const Zivid::Array2D<ColorBGR_SRGB> &image, const std::string &fileName);
        ZIVID_CORE_EXPORT Zivid::Image<ColorBGRA> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorBGRA> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorRGBA> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorRGBA> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorRGBA_SRGB> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorRGBA_SRGB> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorBGRA_SRGB> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorBGRA_SRGB> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorRGB> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorRGB> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorRGB_SRGB> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorRGB_SRGB> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorBGR> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorBGR> /* tag */);
        ZIVID_CORE_EXPORT Zivid::Image<ColorBGR_SRGB> loadImageImpl(
            const std::string &fileName,
            LoadImageTag<ColorBGR_SRGB> /* tag */);
 
        template<typename ColorFormat>
        struct SupportedImageColorFormat : std::false_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorRGBA> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorBGRA> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorRGBA_SRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorBGRA_SRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorRGB_SRGB> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorBGR> : std::true_type
        {};
 
        template<>
        struct SupportedImageColorFormat<ColorBGR_SRGB> : std::true_type
        {};
    } // namespace Detail
#endif
    template<class PixelFormat>
    class Image : public Array2D<PixelFormat>
    {
    public:
        static_assert(
            Detail::SupportedImageColorFormat<PixelFormat>::value,
            "PixelFormat must be Zivid::ColorRGBA, Zivid::ColorBGRA, Zivid::ColorRGBA_SRGB, Zivid::ColorBGRA_SRGB, "
            "Zivid::ColorRGB, Zivid::ColorRGB_SRGB, Zivid::ColorBGR, or Zivid::ColorBGR_SRGB");

        Image() = default;

        template<typename Iterator>
        Image(const Resolution &resolution, Iterator beginIt, Iterator endIt)
            : Array2D<PixelFormat>(resolution, beginIt, endIt)
        {}

        Image(const Resolution &resolution, const unsigned char *begin, const unsigned char *end)
            : Array2D<PixelFormat>{ resolution, begin, end }
 
        {}

        explicit Image(const std::string &fileName)
            : Image{ Detail::loadImageImpl(fileName, Detail::LoadImageTag<PixelFormat>{}) }
 
        {}

        Resolution resolution() const
        {
            return Resolution{ Array2D<PixelFormat>::width(), Array2D<PixelFormat>::height() };
        }

        void save(const std::string &fileName) const
        {
            return Detail::saveImageImpl(*this, fileName);
        }
 
#ifndef NO_DOC
        explicit Image(Array2D<PixelFormat> &&a)
            : Array2D<PixelFormat>(std::move(a))
        {}
#endif
    };
} // namespace Zivid