imagetransfer.h

/*******************************************************************************
 * Copyright (c) 2018 Nerian Vision GmbH
 *
 * 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.
 *******************************************************************************/

#ifndef VISIONTRANSFER_IMAGETRANSFER_H
#define VISIONTRANSFER_IMAGETRANSFER_H

#include <string>
#include "visiontransfer/common.h"
#include "visiontransfer/imageprotocol.h"
#include "visiontransfer/imagepair.h"
#include "visiontransfer/deviceinfo.h"

class VT_EXPORT ImageTransfer {
public:
    enum TransferStatus {
        ALL_TRANSFERRED,

        PARTIAL_TRANSFER,

        NO_VALID_DATA,

        WOULD_BLOCK,

        NOT_CONNECTED
    };

    ImageTransfer(const char* address, const char* service = "7681",
        ImageProtocol::ProtocolType protType = ImageProtocol::PROTOCOL_UDP,
        bool server = false, int bufferSize = 1048576, int maxUdpPacketSize = 1472);

    ImageTransfer(const DeviceInfo& device, int bufferSize = 1048576,
        int maxUdpPacketSize = 1472);

    ~ImageTransfer();

    void setRawTransferData(const ImagePair& metaData, unsigned char* rawData,
        int secondTileWidth = 0, int validBytes = 0x7FFFFFFF);

    void setRawValidBytes(int validBytes);

    void setTransferImagePair(const ImagePair& imagePair);

    TransferStatus transferData();

    bool receiveImagePair(ImagePair& imagePair);

    bool receivePartialImagePair(ImagePair& imagePair, int& validRows, bool& complete);

    int getNumDroppedFrames() const;

    bool tryAccept();

    bool isConnected() const;

    void disconnect();

    std::string getRemoteAddress() const;

private:
    // We follow the pimpl idiom
    class Pimpl;
    Pimpl* pimpl;

    // This class cannot be copied
    ImageTransfer(const ImageTransfer& other);
    ImageTransfer& operator=(const ImageTransfer&);
};

#endif