Image.cpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
/*
  This file is in a pretty hacky state.  Sorry!
 
*/
 
#include <yarp/sig/Image.h>
 
#include <yarp/os/Bottle.h>
#include <yarp/os/ConnectionReader.h>
#include <yarp/os/ConnectionWriter.h>
#include <yarp/os/Log.h>
#include <yarp/os/Time.h>
#include <yarp/os/Vocab.h>
 
#include <yarp/sig/ImageNetworkHeader.h>
#include <yarp/sig/impl/IplImage.h>
 
#include <cstdio>
#include <cstring>
#include <string>
#include <utility>
 
 
using namespace yarp::sig;
using namespace yarp::os;
 
#define DBGPF1 if (0)
 
inline bool readFromConnection(Image &dest, ImageNetworkHeader &header, ConnectionReader& connection)
{
    dest.resize(header.width, header.height);
    unsigned char *mem = dest.getRawImage();
    size_t allocatedBytes = dest.getRawImageSize();
    yAssert(mem != nullptr);
    //this check is redundant with assertion, I would remove it
    if (dest.getRawImageSize() != static_cast<size_t>(header.imgSize)) {
        printf("There is a problem reading an image\n");
        printf("incoming: width %zu, height %zu, code %zu, quantum %zu, size %zu\n",
               static_cast<size_t>(header.width),
               static_cast<size_t>(header.height),
               static_cast<size_t>(header.id),
               static_cast<size_t>(header.quantum),
               static_cast<size_t>(header.imgSize));
        printf("my space: width %zu, height %zu, code %d, quantum %zu, size %zu\n",
            dest.width(), dest.height(), dest.getPixelCode(), dest.getQuantum(), allocatedBytes);
    }
    yAssert(allocatedBytes == (size_t) header.imgSize);
    bool ok = connection.expectBlock(reinterpret_cast<char*>(mem), allocatedBytes);
    return (!connection.isError() && ok);
}
 
 
 
class ImageStorage {
public:
    MiniIplImage* pImage;
    char **Data;  // this is not IPL. it's char to maintain IPL compatibility
    int extern_type_id;
    size_t extern_type_quantum;
    size_t quantum;
    int type_id;
 
protected:
    Image& owner;
 
    int is_owner;
 
    // ipl allocation is done in two steps.
    // _alloc allocates the actual ipl pointer.
    // _alloc_data allocates the image array and data.
    // memory is allocated in a single chunk. Row ptrs are then
    // made to point appropriately. This is compatible with IPL and
    // SOMEONE says it's more efficient on NT.
    void _alloc ();
    void _alloc_extern (const void *buf);
    void _alloc_data ();
    void _free ();
 
    bool _set_ipl_header(size_t x, size_t y, int pixel_type, size_t quantum);
    void _alloc_complete(size_t x, size_t y, int pixel_type, size_t quantum);
    void _free_complete();
 
 
    // computes the # of padding bytes. These are always at the end of the row.
    int _pad_bytes (size_t linesize, size_t align) const;
 
    inline int GetPadding() const {
        return _pad_bytes (pImage->width * pImage->nChannels,
                           YARP_IMAGE_ALIGN);
    }
 
public:
    ImageStorage(Image& owner) : owner(owner) {
        type_id = 0;
        pImage = nullptr;
        Data = nullptr;
        is_owner = 1;
        quantum = 0;
        extern_type_id = 0;
        extern_type_quantum = -1;
    }
 
    ~ImageStorage() {
        _free_complete();
    }
 
    void resize(size_t x, size_t y, int pixel_type, size_t quantum);
    void _alloc_complete_extern(const void *buf, size_t x, size_t y, int pixel_type, size_t quantum);
};
 
 
void ImageStorage::resize(size_t x, size_t y, int pixel_type, size_t quantum)
{
    int need_recreation = 1;
 
    if (quantum==0) {
        quantum = YARP_IMAGE_ALIGN;
    }
 
    if (need_recreation) {
        _free_complete();
        DBGPF1 printf("HIT recreation for %p %p: %zu %zu %d\n", static_cast<void*>(this), static_cast<void*>(pImage), x, y, pixel_type);
        _alloc_complete (x, y, pixel_type, quantum);
    }
    extern_type_id = pixel_type;
    extern_type_quantum = quantum;
}
 
// allocates an empty image.
void ImageStorage::_alloc ()
{
    _free(); // was iplDeallocateImage(pImage); but that won't work with refs
 
    iplAllocateImage (pImage);
}
 
// installs an external buffer as the image data
void ImageStorage::_alloc_extern (const void *buf)
{
    yAssert(pImage != nullptr);
    yAssert(Data==nullptr);
 
    if (pImage != nullptr) {
        if (pImage->imageData != nullptr) {
            iplDeallocateImage (pImage);
        }
    }
 
    pImage->imageData = const_cast<char*>(reinterpret_cast<const char*>(buf));
}
 
// allocates the Data pointer.
void ImageStorage::_alloc_data ()
{
    DBGPF1 printf("alloc_data1\n"), fflush(stdout);
    yAssert(pImage != nullptr);
 
    yAssert(Data==nullptr);
 
    char **ptr = new char *[pImage->height];
 
    Data = ptr;
 
    yAssert(Data != nullptr);
 
    yAssert(pImage->imageData != nullptr);
 
    int height = pImage->height;
 
    char * DataArea = pImage->imageData;
 
    for (int r = 0; r < height; r++)
        {
            Data[r] = DataArea;
            DataArea += pImage->widthStep;
        }
    DBGPF1 printf("alloc_data4\n");
}
 
void ImageStorage::_free ()
{
    if (pImage != nullptr) {
        if (pImage->imageData != nullptr) {
            if (is_owner) {
                iplDeallocateImage (pImage);
                delete[] Data;
            } else {
                delete[] Data;
            }
 
            is_owner = 1;
            Data = nullptr;
            pImage->imageData = nullptr;
        }
    }
}
 
 
void ImageStorage::_free_complete()
{
    _free();
 
    if (pImage != nullptr)
    {
        iplDeallocateHeader(pImage);
    }
    pImage = nullptr;
}
 
void ImageStorage::_alloc_complete(size_t x, size_t y, int pixel_type, size_t quantum)
{
    _free_complete();
    _set_ipl_header(x, y, pixel_type, quantum);
    _alloc ();
    _alloc_data ();
}
 
 
struct pixelTypeIplParams
{
    int   nChannels;
    int   depth;
};
 
const std::map<int, pixelTypeIplParams> pixelCode2iplParams = {
    {VOCAB_PIXEL_MONO,                  {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_ENCODING_BAYER_GRBG8,  {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_ENCODING_BAYER_BGGR8,  {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_ENCODING_BAYER_GBRG8,  {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_ENCODING_BAYER_RGGB8,  {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_YUV_420,               {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_YUV_444,               {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_YUV_422,               {1, IPL_DEPTH_16U}},
    {VOCAB_PIXEL_YUV_411,               {1, IPL_DEPTH_8U}},
    {VOCAB_PIXEL_MONO16,                {1, IPL_DEPTH_16U}},
    {VOCAB_PIXEL_ENCODING_BAYER_GRBG16, {1, IPL_DEPTH_16U}},
    {VOCAB_PIXEL_ENCODING_BAYER_BGGR16, {1, IPL_DEPTH_16U}},
    {VOCAB_PIXEL_ENCODING_BAYER_GBRG16, {1, IPL_DEPTH_16U}},
    {VOCAB_PIXEL_ENCODING_BAYER_RGGB16, {1, IPL_DEPTH_16U}},
    {VOCAB_PIXEL_RGB,                   {3, IPL_DEPTH_8U,}},
    {VOCAB_PIXEL_RGBA,                  {4, IPL_DEPTH_8U,}},
    {VOCAB_PIXEL_BGRA,                  {4, IPL_DEPTH_8U,}},
    {VOCAB_PIXEL_INT,                   {1, IPL_DEPTH_32S}},
    {VOCAB_PIXEL_HSV,                   {3, IPL_DEPTH_8U,}},
    {VOCAB_PIXEL_BGR,                   {3, IPL_DEPTH_8U,}},
    {VOCAB_PIXEL_MONO_SIGNED,           {1, IPL_DEPTH_8S,}},
    {VOCAB_PIXEL_RGB_INT,               {3, IPL_DEPTH_32S}},
    {VOCAB_PIXEL_MONO_FLOAT,            {1, IPL_DEPTH_32F}},
    {VOCAB_PIXEL_RGB_FLOAT,             {3, IPL_DEPTH_32F}},
    {-2,                                {1, IPL_DEPTH_16U}},
    {-4,                                {1, IPL_DEPTH_32S}}
};
 
bool ImageStorage::_set_ipl_header(size_t x, size_t y, int pixel_type, size_t quantum)
{
    if (pImage != nullptr) {
        iplDeallocateImage(pImage);
        pImage = nullptr;
    }
 
    if (pixel_type == VOCAB_PIXEL_INVALID) {
        // not a type!
        printf ("*** Trying to allocate an invalid pixel type image\n");
        std::exit(1);
     }
    if (pixelCode2iplParams.find(pixel_type) == pixelCode2iplParams.end()) {
        // unknown pixel type. Should revert to a non-IPL mode... how?
        return false;
    }
 
    const pixelTypeIplParams& param = pixelCode2iplParams.at(pixel_type);
 
    if (quantum==0) {
        quantum = IPL_ALIGN_QWORD;
    }
 
    pImage = iplCreateImageHeader(param.nChannels, param.depth, quantum, x, y);
 
    type_id = pixel_type;
    this->quantum = quantum;
    return true;
}
 
void ImageStorage::_alloc_complete_extern(const void *buf, size_t x, size_t y, int pixel_type, size_t quantum)
{
    if (quantum==0) {
        quantum = 1;
    }
    this->quantum = quantum;
 
    _free_complete();
    _set_ipl_header(x, y, pixel_type, quantum);
    Data = nullptr;
    _alloc_extern (buf);
    _alloc_data ();
    is_owner = 0;
}
 
 
 
int ImageStorage::_pad_bytes (size_t linesize, size_t align) const
{
    return yarp::sig::PAD_BYTES (linesize, align);
}
 
const std::map<YarpVocabPixelTypesEnum, size_t> Image::pixelCode2Size = {
    {VOCAB_PIXEL_INVALID,               0 },
    {VOCAB_PIXEL_MONO,                  sizeof(yarp::sig::PixelMono)},
    {VOCAB_PIXEL_MONO16,                sizeof(yarp::sig::PixelMono16)},
    {VOCAB_PIXEL_RGB,                   sizeof(yarp::sig::PixelRgb)},
    {VOCAB_PIXEL_RGBA,                  sizeof(yarp::sig::PixelRgba)},
    {VOCAB_PIXEL_BGRA,                  sizeof(yarp::sig::PixelBgra)},
    {VOCAB_PIXEL_INT,                   sizeof(yarp::sig::PixelInt)},
    {VOCAB_PIXEL_HSV,                   sizeof(yarp::sig::PixelHsv)},
    {VOCAB_PIXEL_BGR,                   sizeof(yarp::sig::PixelBgr)},
    {VOCAB_PIXEL_MONO_SIGNED,           sizeof(yarp::sig::PixelMonoSigned)},
    {VOCAB_PIXEL_RGB_SIGNED,            sizeof(yarp::sig::PixelRgbSigned)},
    {VOCAB_PIXEL_RGB_INT,               sizeof(yarp::sig::PixelRgbInt)},
    {VOCAB_PIXEL_MONO_FLOAT,            sizeof(yarp::sig::PixelFloat)},
    {VOCAB_PIXEL_RGB_FLOAT,             sizeof(yarp::sig::PixelRgbFloat)},
    {VOCAB_PIXEL_HSV_FLOAT,             sizeof(yarp::sig::PixelHsvFloat)},
    {VOCAB_PIXEL_ENCODING_BAYER_GRBG8,  1 },
    {VOCAB_PIXEL_ENCODING_BAYER_GRBG16, 2 },
    {VOCAB_PIXEL_ENCODING_BAYER_BGGR8,  1 },
    {VOCAB_PIXEL_ENCODING_BAYER_BGGR16, 2 },
    {VOCAB_PIXEL_ENCODING_BAYER_GBRG8,  1 },
    {VOCAB_PIXEL_ENCODING_BAYER_GBRG16, 2 },
    {VOCAB_PIXEL_ENCODING_BAYER_RGGB8,  1 },
    {VOCAB_PIXEL_ENCODING_BAYER_RGGB16, 2 },
    {VOCAB_PIXEL_YUV_420, 1},
    {VOCAB_PIXEL_YUV_444, 1},
    {VOCAB_PIXEL_YUV_422, 1},
    {VOCAB_PIXEL_YUV_411, 1}
};
 
Image::Image() {
    initialize();
}
 
void Image::initialize() {
    implementation = nullptr;
    data = nullptr;
    imgWidth = imgHeight = 0;
    imgPixelSize = imgRowSize = 0;
    imgPixelCode = 0;
    imgQuantum = 0;
    implementation = new ImageStorage(*this);
    yAssert(implementation!=nullptr);
}
 
 
Image::~Image() {
    if (implementation!=nullptr) {
        delete static_cast<ImageStorage*>(implementation);
        implementation = nullptr;
    }
}
 
 
size_t Image::getPixelSize() const {
    return imgPixelSize;
}
 
 
int Image::getPixelCode() const {
    return imgPixelCode;
}
 
 
void Image::zero() {
    if (getRawImage()!=nullptr) {
        memset(getRawImage(),0,getRawImageSize());
    }
}
 
 
void Image::resize(size_t imgWidth, size_t imgHeight) {
 
    int code = getPixelCode();
    bool change = false;
    if (code!=imgPixelCode) {
        setPixelCode(code);
        change = true;
    }
    if (imgPixelCode!=(static_cast<ImageStorage*>(implementation))->extern_type_id) {
        change = true;
    }
    if (imgQuantum!=(static_cast<ImageStorage*>(implementation))->extern_type_quantum) {
        change = true;
    }
 
    if (imgWidth!=width()||imgHeight!=height()) {
        change = true;
    }
 
    if (change) {
        (static_cast<ImageStorage*>(implementation))->resize(imgWidth,
                                                             imgHeight,
                                                             imgPixelCode,
                                                             imgQuantum);
        synchronize();
        //printf("CHANGE! %ld\n", (long int)(this));
    }
}
 
void Image::setPixelSize(size_t imgPixelSize) {
    if(imgPixelSize == pixelCode2Size.at(static_cast<YarpVocabPixelTypesEnum>(imgPixelCode))) {
        return;
    }
 
    setPixelCode(-imgPixelSize);
}
 
void Image::setPixelCode(int imgPixelCode) {
    this->imgPixelCode = imgPixelCode;
    this->imgPixelSize = (imgPixelCode < 0) ? -imgPixelCode : pixelCode2Size.at(static_cast<YarpVocabPixelTypesEnum>(imgPixelCode));
 
    if (implementation) {
        auto* impl = static_cast<ImageStorage*>(implementation);
        impl->type_id = imgPixelCode;
    }
}
 
 
void Image::setQuantum(size_t imgQuantum) {
    this->imgQuantum = imgQuantum;
 
    if (implementation) {
        auto* impl = static_cast<ImageStorage*>(implementation);
        impl->quantum = imgQuantum;
    }
}
 
void Image::synchronize() {
    auto* impl = static_cast<ImageStorage*>(implementation);
    yAssert(impl!=nullptr);
    if (impl->pImage!=nullptr) {
        imgWidth = impl->pImage->width;
        imgHeight = impl->pImage->height;
        data = impl->Data;
        imgQuantum = impl->quantum;
        imgRowSize = impl->pImage->widthStep;
        setPixelCode(impl->type_id);
    } else {
        data = nullptr;
        imgWidth = 0;
        imgHeight = 0;
    }
}
 
 
unsigned char *Image::getRawImage() const {
    auto* impl = static_cast<ImageStorage*>(implementation);
    yAssert(impl!=nullptr);
    if (impl->pImage!=nullptr) {
        return reinterpret_cast<unsigned char*>(impl->pImage->imageData);
    }
    return nullptr;
}
 
size_t Image::getRawImageSize() const {
    auto* impl = static_cast<ImageStorage*>(implementation);
    yAssert(impl!=nullptr);
    if (impl->pImage!=nullptr) {
        return impl->pImage->imageSize;
    }
    return 0;
}
 
bool Image::read(yarp::os::ConnectionReader& connection) {
 
    // auto-convert text mode interaction
    connection.convertTextMode();
 
    ImageNetworkHeader header;
 
    bool ok = connection.expectBlock(reinterpret_cast<char*>(&header),sizeof(header));
    if (!ok) {
        return false;
    }
 
    //first check that the received image size is reasonable
    if (header.width == 0 || header.height == 0)
    {
        // I maintain the previous logic, although we should probably return false
        return !connection.isError();
    }
 
    setPixelCode(header.id);
 
    size_t q = getQuantum();
    if (q==0) {
        //q = YARP_IMAGE_ALIGN;
        setQuantum(header.quantum);
        q = getQuantum();
    }
    if (q != static_cast<size_t>(header.quantum)) {
        if ((header.depth*header.width)%header.quantum==0 &&
            (header.depth*header.width)%q==0) {
            header.quantum = q;
        }
    }
 
    // handle easy case, received and current image are compatible, no conversion needed
    if (getPixelCode() == header.id && q == static_cast<size_t>(header.quantum) && imgPixelSize == static_cast<size_t>(header.depth))
    {
        return readFromConnection(*this, header, connection);
    }
 
    // received and current images are binary incompatible, so
    // prepare a FlexImage, set it to be compatible with the received image
    // read new image into FlexImage then copy from it.
    FlexImage flex;
    flex.setPixelCode(header.id);
    flex.setQuantum(header.quantum);
    ok = readFromConnection(flex, header, connection);
    if (ok) {
        copy(flex);
    }
 
    return ok;
}
 
 
bool Image::write(yarp::os::ConnectionWriter& connection) const {
    ImageNetworkHeader header;
    header.setFromImage(*this);
    connection.appendBlock(reinterpret_cast<char*>(&header),sizeof(header));
    unsigned char *mem = getRawImage();
    if (header.width!=0&&header.height!=0) {
        yAssert(mem!=nullptr);
 
        // Note use of external block.
        // Implies care needed about ownership.
        connection.appendExternalBlock(reinterpret_cast<char *>(mem),header.imgSize);
    }
 
    // if someone is foolish enough to connect in text mode,
    // let them see something readable.
    connection.convertTextMode();
 
    return !connection.isError();
}
 
 
Image::Image(const Image& alt) : Portable()
{
    initialize();
    copy(alt);
}
 
Image::Image(Image&& other) noexcept
    : implementation(std::exchange(other.implementation, nullptr))
{
    synchronize();
}
 
Image& Image::operator=(Image&& other) noexcept
{
    delete static_cast<ImageStorage*>(implementation);
    implementation = std::exchange(other.implementation, nullptr);
    synchronize();
    return *this;
}
 
bool Image::operator==(const Image& alt) const
{
    //test general properties
    if (width() != alt.width()) return false;
    if (height() != alt.height()) return false;
    if (imgPixelCode != alt.imgPixelCode) return false;
    size_t raw1size = getRawImageSize();
    size_t raw2size = alt.getRawImageSize();
    if (raw1size != raw2size)
    {
        return false;
    }
    //test byte per byte
    unsigned char* raw1 = getRawImage();
    unsigned char* raw2 = alt.getRawImage();
    if (raw1 == nullptr) { return false;}
    if (raw2 == nullptr) { return false;}
    for (size_t i = 0; i < raw1size; i++)
    {
        if (raw1[i] != raw2[i]) {
            return false;
        }
    }
    return true;
}
 
Image& Image::operator=(const Image& alt)
{
    if (&alt != this) {
        copy(alt);
    }
    return *this;
}
 
 
bool Image::copy(const Image& alt)
{
    if (&alt != this)
    {
        int myCode = getPixelCode();
        if (myCode==0) {
            setPixelCode(alt.getPixelCode());
            setQuantum(alt.getQuantum());
        }
        resize(alt.width(),alt.height());
 
        int q1 = alt.getQuantum();
        int q2 = getQuantum();
        if (q1==0) { q1 = YARP_IMAGE_ALIGN; }
        if (q2==0) { q2 = YARP_IMAGE_ALIGN; }
 
        yAssert(width()==alt.width());
        yAssert(height()==alt.height());
        if (getPixelCode()==alt.getPixelCode()) {
            if (getQuantum()==alt.getQuantum()) {
                yAssert(getRawImageSize()==alt.getRawImageSize());
                yAssert(q1==q2);
            }
        }
 
        copyPixels(alt.getRawImage(),alt.getPixelCode(),
                   getRawImage(),getPixelCode(),
                   width(),height(),
                   getRawImageSize(),q1,q2);
    }
    return true;
}
 
 
bool Image::move(Image&& alt) noexcept
{
    // Cannot move an image of the wrong type inside an ImageOf that does not
    // support it.
    yAssert(dynamic_cast<FlexImage*>(this) || getPixelCode() == alt.getPixelCode() || alt.getPixelCode() == 0);
    if (&alt != this) {
        delete static_cast<ImageStorage*>(implementation);
        implementation = std::exchange(alt.implementation, nullptr);
        synchronize();
    }
    return true;
}
 
 
bool Image::swap(Image& alt)
{
    // Cannot swap two ImageOf of different type, or an image of the wrong type
    // inside an ImageOf that does not support it.
    yAssert(dynamic_cast<FlexImage*>(this) || getPixelCode() == alt.getPixelCode() || alt.getPixelCode() == 0);
    yAssert(dynamic_cast<FlexImage*>(&alt) || getPixelCode() == alt.getPixelCode() || getPixelCode() == 0);
    if (&alt != this) {
        std::swap(alt.implementation, implementation);
        synchronize();
        alt.synchronize();
    }
    return true;
}
 
 
void Image::setExternal(const void *data, size_t imgWidth, size_t imgHeight) {
    if (imgQuantum==0) {
        imgQuantum = 1;
    }
    (static_cast<ImageStorage*>(implementation))->_alloc_complete_extern(data,
                                                                         imgWidth,
                                                                         imgHeight,
                                                                         getPixelCode(),
                                                                         imgQuantum);
    synchronize();
}
 
 
bool Image::copy(const Image& alt, size_t w, size_t h) {
    if (getPixelCode()==0) {
        setPixelCode(alt.getPixelCode());
        setQuantum(alt.getQuantum());
    }
    if (&alt==this) {
        FlexImage img;
        img.copy(alt);
        return copy(img,w,h);
    }
 
    if (getPixelCode()!=alt.getPixelCode()) {
        FlexImage img;
        img.setPixelCode(getPixelCode());
        img.setQuantum(getQuantum());
        img.copy(alt);
        return copy(img,w,h);
    }
 
    resize(w,h);
    size_t d = getPixelSize();
 
    size_t nw = w;
    size_t nh = h;
    w = alt.width();
    h = alt.height();
 
    float di = (static_cast<float>(h))/nh;
    float dj = (static_cast<float>(w))/nw;
 
    for (size_t i=0; i<nh; i++)
        {
            auto i0 = static_cast<size_t>(di*i);
            for (size_t j=0; j<nw; j++)
                {
                    auto j0 = static_cast<size_t>(dj*j);
                    memcpy(getPixelAddress(j,i),
                           alt.getPixelAddress(j0,i0),
                           d);
                }
        }
    return true;
}