CpuImage.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* 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.
*/
 
 
#ifndef NVNEURAL_CPUIMAGE_H
#define NVNEURAL_CPUIMAGE_H
 
#include <nvneural/CoreTypes.h>
#include <nvneural/CoreHelpers.h>
#include <memory>
#include <string>
#include <vector>
#include <stb/stb_image.h>
#include <stb/stb_image_write.h>
 
namespace nvneural {
 
struct ImageDescriptor
{
    static const std::size_t DefaultChannels = 0; 
 
    std::string filename;
    std::size_t channels = DefaultChannels;
 
    ImageDescriptor(std::string filename_, std::size_t channels_)
        : filename(filename_)
        , channels(channels_)
    {}
};
 
class IFileImage : public IRefObject
{
public:
    static const IRefObject::TypeId typeID = 0x6c7a3cb3f81db69bul;
 
    virtual NeuralResult loadFromFile(const std::string& filename) noexcept = 0;
 
    virtual NeuralResult loadFromDescriptors(const std::vector<ImageDescriptor>& descriptors) noexcept = 0;
 
    virtual NeuralResult fromFill(std::size_t height, std::size_t width, std::size_t channels, std::uint8_t fillValue) noexcept = 0;
 
    virtual NeuralResult fromRandomValues(std::size_t height, std::size_t width, std::size_t channels) noexcept = 0;
 
    virtual NeuralResult saveToFile(const std::string& filename) noexcept = 0;
};
 
class Image : public nvneural::refobj::RefObjectBase<
    nvneural::refobj::Implements<nvneural::IFileImage>,
    nvneural::refobj::Implements<nvneural::IImage>>
{
public:
    // IFileImage members
 
    NeuralResult loadFromFile(const std::string& filename) noexcept override;
    NeuralResult loadFromDescriptors(const std::vector<ImageDescriptor>& descriptors) noexcept override;
    NeuralResult fromFill(std::size_t height, std::size_t width, std::size_t channels, std::uint8_t fillValue) noexcept override;
    NeuralResult fromRandomValues(std::size_t height, std::size_t width, std::size_t channels) noexcept override;
    NeuralResult saveToFile(const std::string& filename) noexcept override;
 
    // IImage members
    NeuralResult resize(std::size_t height, std::size_t width, std::size_t channels) noexcept override;
    std::size_t height() const noexcept override;
    std::size_t width() const noexcept override;
    std::size_t channels() const noexcept override;
    std::size_t elements() const noexcept override;
    std::uint8_t* data() noexcept override;
    const std::uint8_t* data() const noexcept override;
 
private:
    static const std::uint8_t FillValue = 0u;
 
    std::unique_ptr<std::uint8_t[], decltype(&stbi_image_free)> m_data{nullptr, stbi_image_free};
    std::size_t m_height = 0;
    std::size_t m_width = 0;
    std::size_t m_channels = 0;
 
    NeuralResult resetBuffer(std::size_t height, std::size_t width, std::size_t channels) noexcept;
 
    NeuralResult addChannelPadding(std::size_t extraChannels) noexcept;
    NeuralResult mergeImage(const Image& image) noexcept;
    NeuralResult loadFromFile(const std::string& filename, std::size_t forceChannels) noexcept;
};
 
} // namespace nvneural
 
#endif // NVNEURAL_CPUIMAGE_H