peak_ipl_image_writer.hpp

Go to the documentation of this file.

#pragma once

#include <peak_ipl/backend/peak_ipl_backend.h>
#include <peak_ipl/exception/peak_ipl_exception.hpp>
#include <peak_ipl/types/peak_ipl_pixel_format.hpp>
#include <peak_ipl/types/peak_ipl_simple_types.hpp>
#include <peak_ipl/types/peak_ipl_image.hpp>

#include <cstdint>
#include <string>

namespace peak
{
namespace ipl
{

class Image;

class ImageWriter final
{
public:
    ImageWriter() = delete;

    struct PNGParameter final
    {
        PNGParameter()
            : Quality(100)
        {}
        // Compression parameter from 0 to 100 -> 100 means quality level 0 for PNG
        uint32_t Quality = 100;
    };

    struct JPEGParameter final
    {
        JPEGParameter()
            : Quality(75)
        {}
        // Quality parameter from 0 to 100
        uint32_t Quality = 75;
    };

    static void WriteAsBMP(const std::string& filePath, const Image& imageToSave);

    static void WriteAsPNG(
        const std::string& filePath, const Image& imageToSave, const PNGParameter& parameter = PNGParameter());

    static void WriteAsJPG(
        const std::string& filePath, const Image& imageToSave, const JPEGParameter& parameter = JPEGParameter());

    static void WriteAsRAW(const std::string& filePath, const Image& imageToSave);

    static void Write(const std::string& filePath, const Image& imageToSave);
};

inline void ImageWriter::WriteAsBMP(const std::string& filePath, const Image& imageToSave)
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ImageWriter_WriteAsBMP(
            ImageBackendAccessor::BackendHandle(imageToSave), filePath.c_str(), filePath.size());
    });
}

inline void ImageWriter::WriteAsPNG(
    const std::string& filePath, const Image& imageToSave, const PNGParameter& parameter)
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ImageWriter_WriteAsPNG(
            ImageBackendAccessor::BackendHandle(imageToSave), parameter.Quality, filePath.c_str(), filePath.size());
    });
}

inline void ImageWriter::WriteAsJPG(
    const std::string& filePath, const Image& imageToSave, const JPEGParameter& parameter)
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ImageWriter_WriteAsJPG(
            ImageBackendAccessor::BackendHandle(imageToSave), parameter.Quality, filePath.c_str(), filePath.size());
    });
}

inline void ImageWriter::WriteAsRAW(const std::string& filePath, const Image& imageToSave)
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ImageWriter_WriteAsRAW(
            ImageBackendAccessor::BackendHandle(imageToSave), filePath.c_str(), filePath.size());
    });
}

inline void ImageWriter::Write(const std::string& filePath, const Image& imageToSave)
{
    ExecuteAndMapReturnCodes([&] {
        return PEAK_IPL_C_ABI_PREFIX PEAK_IPL_ImageWriter_Write(
            ImageBackendAccessor::BackendHandle(imageToSave), filePath.c_str(), filePath.size());
    });
}

} /* namespace ipl */
} /* namespace peak */