IPPImage.cpp

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#include "cloudViewer/t/geometry/kernel/IPPImage.h"
 
#include <unordered_map>
 
#if IPP_VERSION_INT < \
        20211000  // macOS IPP v2021.9.11 uses old directory layout
#include <ippi.h>
 
#include <iw++/iw_image_color.hpp>
#include <iw++/iw_image_filter.hpp>
#include <iw++/iw_image_op.hpp>
#include <iw++/iw_image_transform.hpp>
#else  // Linux and Windows IPP >=v2021.10 uses new directory layout
#include <ipp/ippi.h>
 
#include <ipp/iw++/iw_image_color.hpp>
#include <ipp/iw++/iw_image_filter.hpp>
#include <ipp/iw++/iw_image_op.hpp>
#include <ipp/iw++/iw_image_transform.hpp>
#endif
 
#include <Logging.h>
 
#include "cloudViewer/core/Dispatch.h"
#include "cloudViewer/core/Dtype.h"
#include "cloudViewer/core/ShapeUtil.h"
#include "cloudViewer/core/Tensor.h"
#include "cloudViewer/t/geometry/Image.h"
 
namespace cloudViewer {
namespace t {
namespace geometry {
namespace ipp {
 
void To(const core::Tensor &src_im,
        core::Tensor &dst_im,
        double scale,
        double offset) {
    // Supported device and datatype checking happens in calling code and will
    // result in an exception if there are errors.
 
    auto src_dtype = src_im.GetDtype();
    auto dst_dtype = dst_im.GetDtype();
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(src_dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * src_dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dst_dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dst_dtype.ByteSize());
 
    try {
        ::ipp::iwiScale(ipp_src_im, ipp_dst_im, scale, offset);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
void RGBToGray(const core::Tensor &src_im, core::Tensor &dst_im) {
    auto dtype = src_im.GetDtype();
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dtype.ByteSize());
 
    try {
        ::ipp::iwiColorConvert(ipp_src_im, ::ipp::iwiColorRGB, ipp_dst_im,
                               ::ipp::iwiColorGray);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
void Resize(const core::Tensor &src_im,
            core::Tensor &dst_im,
            Image::InterpType interp_type) {
    auto dtype = src_im.GetDtype();
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dtype.ByteSize());
 
    static const std::unordered_map<Image::InterpType, IppiInterpolationType>
            type_dict = {
                    {Image::InterpType::Nearest, ippNearest},
                    {Image::InterpType::Linear, ippLinear},
                    {Image::InterpType::Cubic, ippCubic},
                    {Image::InterpType::Lanczos, ippLanczos},
                    {Image::InterpType::Super, ippSuper},
            };
 
    auto it = type_dict.find(interp_type);
    if (it == type_dict.end()) {
        utility::LogError("Unsupported interp type {}",
                          static_cast<int>(interp_type));
    }
 
    try {
        ::ipp::iwiResize(ipp_src_im, ipp_dst_im, it->second);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
void Dilate(const core::Tensor &src_im, core::Tensor &dst_im, int kernel_size) {
    // Supported device and datatype checking happens in calling code and will
    // result in an exception if there are errors.
 
    // Create mask.
    core::Tensor mask =
            core::Tensor::Ones(core::SizeVector{kernel_size, kernel_size, 1},
                               core::UInt8, src_im.GetDevice());
 
    auto dtype = src_im.GetDtype();
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_mask_im(
            ::ipp::IwiSize(mask.GetShape(1), mask.GetShape(0)),
            ToIppDataType(mask.GetDtype()), mask.GetShape(2) /* channels */,
            0 /* border buffer size */, mask.GetDataPtr(),
            mask.GetStride(0) * mask.GetDtype().ByteSize());
    try {
        ::ipp::iwiFilterMorphology(
                ipp_src_im, ipp_dst_im, ::ipp::iwiMorphDilate, ipp_mask_im,
                ::ipp::IwDefault(), /* Do not use IwiFilterMorphologyParams() */
                ippBorderRepl);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
void Filter(const core::Tensor &src_im,
            core::Tensor &dst_im,
            const core::Tensor &kernel) {
    // Supported device and datatype checking happens in calling code and will
    // result in an exception if there are errors.
    auto dtype = src_im.GetDtype();
 
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_kernel(
            ::ipp::IwiSize(kernel.GetShape(1), kernel.GetShape(0)),
            ToIppDataType(core::Float32), 1 /* channels */,
            0 /* border buffer size */, const_cast<void *>(kernel.GetDataPtr()),
            kernel.GetStride(0) * core::Float32.ByteSize());
 
    try {
        ::ipp::iwiFilter(ipp_src_im, ipp_dst_im, ipp_kernel);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
};
 
void FilterBilateral(const core::Tensor &src_im,
                     core::Tensor &dst_im,
                     int kernel_size,
                     float value_sigma,
                     float distance_sigma) {
    // Supported device and datatype checking happens in calling code and will
    // result in an exception if there are errors.
    auto dtype = src_im.GetDtype();
 
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dtype.ByteSize());
 
    try {
        ::ipp::iwiFilterBilateral(ipp_src_im, ipp_dst_im, kernel_size / 2,
                                  value_sigma * value_sigma,
                                  distance_sigma * distance_sigma);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
void FilterGaussian(const core::Tensor &src_im,
                    core::Tensor &dst_im,
                    int kernel_size,
                    float sigma) {
    // Supported device and datatype checking happens in calling code and will
    // result in an exception if there are errors.
    auto dtype = src_im.GetDtype();
 
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(dtype), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * dtype.ByteSize());
    ::ipp::IwiImage ipp_dst_im(
            ::ipp::IwiSize(dst_im.GetShape(1), dst_im.GetShape(0)),
            ToIppDataType(dtype), dst_im.GetShape(2) /* channels */,
            0 /* border buffer size */, dst_im.GetDataPtr(),
            dst_im.GetStride(0) * dtype.ByteSize());
 
    try {
        ::ipp::iwiFilterGaussian(ipp_src_im, ipp_dst_im, kernel_size, sigma);
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
void FilterSobel(const core::Tensor &src_im,
                 core::Tensor &dst_im_dx,
                 core::Tensor &dst_im_dy,
                 int kernel_size) {
    const static std::unordered_map<int, IppiMaskSize> kKernelSizeMap = {
            {3, ::ipp::ippMskSize3x3},
            {5, ::ipp::ippMskSize5x5},
    };
    auto it = kKernelSizeMap.find(kernel_size);
    if (it == kKernelSizeMap.end()) {
        utility::LogError("Unsupported kernel size {} for IPP FilterSobel",
                          kernel_size);
    }
 
    // Create IPP wrappers for all CloudViewer tensors
    const ::ipp::IwiImage ipp_src_im(
            ::ipp::IwiSize(src_im.GetShape(1), src_im.GetShape(0)),
            ToIppDataType(src_im.GetDtype()), src_im.GetShape(2) /* channels */,
            0 /* border buffer size */, const_cast<void *>(src_im.GetDataPtr()),
            src_im.GetStride(0) * src_im.GetDtype().ByteSize());
    ::ipp::IwiImage ipp_dst_im_dx(
            ::ipp::IwiSize(dst_im_dx.GetShape(1), dst_im_dx.GetShape(0)),
            ToIppDataType(dst_im_dx.GetDtype()),
            dst_im_dx.GetShape(2) /* channels */, 0 /* border buffer size */,
            dst_im_dx.GetDataPtr(),
            dst_im_dx.GetStride(0) * dst_im_dx.GetDtype().ByteSize());
    ::ipp::IwiImage ipp_dst_im_dy(
            ::ipp::IwiSize(dst_im_dy.GetShape(1), dst_im_dy.GetShape(0)),
            ToIppDataType(dst_im_dy.GetDtype()),
            dst_im_dy.GetShape(2) /* channels */, 0 /* border buffer size */,
            dst_im_dy.GetDataPtr(),
            dst_im_dy.GetStride(0) * dst_im_dy.GetDtype().ByteSize());
 
    try {
        ::ipp::iwiFilterSobel(ipp_src_im, ipp_dst_im_dx,
                              IwiDerivativeType::iwiDerivVerFirst, it->second);
        ::ipp::iwiFilterSobel(ipp_src_im, ipp_dst_im_dy,
                              IwiDerivativeType::iwiDerivHorFirst, it->second);
        // IPP uses a "left minus right" kernel,
        // https://software.intel.com/content/www/us/en/develop/documentation/ipp-dev-reference/top/volume-2-image-processing/filtering-functions-2/fixed-filters/filtersobel.html
        // so we need to negate it in-place.
        dst_im_dx.Neg_();
    } catch (const ::ipp::IwException &e) {
        // See comments in ipp/ipptypes.h for m_status meaning
        utility::LogError("IPP-IW error {}: {}", e.m_status, e.m_string);
    }
}
 
// Plain IPP functions
 
void Remap(const core::Tensor &src_im,       /*{Ws, Hs, C}*/
           const core::Tensor &dst2src_xmap, /*{Wd, Hd}, float*/
           const core::Tensor &dst2src_ymap, /*{Wd, Hd}, float*/
           core::Tensor &dst_im,             /*{Wd, Hd, C}*/
           Image::InterpType interp_type) {
    auto dtype = src_im.GetDtype();
    if (dtype != dst_im.GetDtype()) {
        utility::LogError(
                "Source ({}) and destination ({}) image dtypes are different!",
                dtype.ToString(), dst_im.GetDtype().ToString());
    }
    if (dst2src_xmap.GetDtype() != core::Float32) {
        utility::LogError("dst2src_xmap dtype ({}) must be Float32.",
                          dst2src_xmap.GetDtype().ToString());
    }
    if (dst2src_ymap.GetDtype() != core::Float32) {
        utility::LogError("dst2src_ymap dtype ({}) must be Float32.",
                          dst2src_ymap.GetDtype().ToString());
    }
 
    static const std::unordered_map<Image::InterpType, int> interp_dict = {
            {Image::InterpType::Nearest, IPPI_INTER_NN},
            {Image::InterpType::Linear, IPPI_INTER_LINEAR},
            {Image::InterpType::Cubic, IPPI_INTER_CUBIC},
            {Image::InterpType::Lanczos, IPPI_INTER_LANCZOS},
            /* {Image::InterpType::Cubic2p_CatmullRom, */
            /*  IPPI_INTER_CUBIC2P_CATMULLROM}, */
    };
 
    auto interp_it = interp_dict.find(interp_type);
    if (interp_it == interp_dict.end()) {
        utility::LogError("Unsupported interp type {}",
                          static_cast<int>(interp_type));
    }
 
    IppiSize src_size{static_cast<int>(src_im.GetShape(1)),
                      static_cast<int>(src_im.GetShape(0))},
            dst_roi_size{static_cast<int>(dst_im.GetShape(1)),
                         static_cast<int>(dst_im.GetShape(0))};
    IppiRect src_roi{0, 0, static_cast<int>(src_im.GetShape(1)),
                     static_cast<int>(src_im.GetShape(0))};
    IppStatus sts = ippStsNoErr;
 
    int src_step = src_im.GetDtype().ByteSize() * src_im.GetStride(0);
    int dst_step = dst_im.GetDtype().ByteSize() * dst_im.GetStride(0);
    int xmap_step =
            dst2src_xmap.GetDtype().ByteSize() * dst2src_xmap.GetStride(0);
    int ymap_step =
            dst2src_ymap.GetDtype().ByteSize() * dst2src_ymap.GetStride(0);
    if (src_im.GetDtype() == core::Float32 && src_im.GetShape(2) == 4) {
        /* IPPAPI(IppStatus, ippiRemap_32f_C4R, (const Ipp32f* pSrc, IppiSize
         * srcSize, */
        /*     int srcStep, IppiRect srcROI, const Ipp32f* pxMap, int xMapStep,
         */
        /*     const Ipp32f* pyMap, int yMapStep, Ipp32f* pDst, int dstStep, */
        /*     IppiSize dstRoiSize, int interpolation)) */
        const auto p_src_im = src_im.GetDataPtr<float>();
        auto p_dst_im = dst_im.GetDataPtr<float>();
        const auto p_dst2src_xmap = dst2src_xmap.GetDataPtr<float>();
        const auto p_dst2src_ymap = dst2src_ymap.GetDataPtr<float>();
        sts = ippiRemap_32f_C4R(p_src_im, src_size, src_step, src_roi,
                                p_dst2src_xmap, xmap_step, p_dst2src_ymap,
                                ymap_step, p_dst_im, dst_step, dst_roi_size,
                                interp_it->second);
    } else {
        utility::LogError(
                "Remap not implemented for dtype ({}) and channels ({}).",
                src_im.GetDtype().ToString(), src_im.GetShape(2));
    }
    if (sts != ippStsNoErr) {
        // See comments in icv/include/ippicv_types.h for meaning
        utility::LogError("IPP remap error {}", ippGetStatusString(sts));
    }
}
}  // namespace ipp
 
}  // namespace geometry
}  // namespace t
}  // namespace cloudViewer