imageprotocol.h

/*******************************************************************************
 * Copyright (c) 2024 Allied Vision Technologies 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_IMAGEPROTOCOL_H
#define VISIONTRANSFER_IMAGEPROTOCOL_H
 
#include "visiontransfer/common.h"
#include "visiontransfer/imageset.h"
 
#include <vector>
 
namespace visiontransfer {
 
class VT_EXPORT ImageProtocol {
public:
    enum ProtocolType {
        PROTOCOL_TCP,
 
        PROTOCOL_UDP
    };
 
    ImageProtocol(bool server, ProtocolType protType, int maxUdpPacketSize = 1472);
 
    ~ImageProtocol();
 
    void setTransferImageSet(const ImageSet& imageSet);
 
    void setRawTransferData(const ImageSet& metaData, const std::vector<unsigned char*>& imageData,
        int firstTileWidth = 0, int middleTilesWidth = 0, int lastTileWidth = 0);
 
    void setRawValidBytes(const std::vector<int>& validBytes);
 
    const unsigned char* getTransferMessage(int& length);
 
    bool transferComplete();
 
    void resetTransfer();
 
    bool getReceivedImageSet(ImageSet& imageSet);
 
    bool getPartiallyReceivedImageSet(ImageSet& imageSet, int& validRows, bool& complete);
 
    bool imagesReceived() const;
 
    unsigned char* getNextReceiveBuffer(int& maxLength);
 
    void processReceivedMessage(int length);
 
    int getNumDroppedFrames() const;
 
    void resetReception();
 
    bool newClientConnected();
 
    bool isConnected() const;
 
    const unsigned char* getNextControlMessage(int& length);
 
    bool supportsExtendedConnectionStateProtocol() const;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    std::string statusReport();
#endif
 
private:
    // We follow the pimpl idiom
    class Pimpl;
    Pimpl* pimpl;
 
    // This class cannot be copied
    ImageProtocol(const ImageProtocol& other);
    ImageProtocol& operator=(const ImageProtocol&);
};
 
} // namespace
 
#endif