imageprotocol.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_IMAGEPROTOCOL_H
#define VISIONTRANSFER_IMAGEPROTOCOL_H

#include "visiontransfer/common.h"
#include "visiontransfer/imagepair.h"

class VT_EXPORT ImageProtocol {
public:
    enum ProtocolType {
        PROTOCOL_TCP,

        PROTOCOL_UDP
    };

    ImageProtocol(bool server, ProtocolType protType, int maxUdpPacketSize = 1472);

    ~ImageProtocol();

    void setTransferImagePair(const ImagePair& imagePair);

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

    void setRawValidBytes(int validBytes);

    const unsigned char* getTransferMessage(int& length);

    bool transferComplete();

    void resetTransfer();

    bool getReceivedImagePair(ImagePair& imagePair);

    bool getPartiallyReceivedImagePair(ImagePair& imagePair, 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);

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

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

#endif