slsDetectorPackage/slsReceiverSoftware/include/sls/Receiver.h

// SPDX-License-Identifier: LGPL-3.0-or-other
// Copyright (C) 2021 Contributors to the SLS Detector Package
#pragma once
#include "sls/sls_detector_defs.h"
#include <memory>

namespace sls {

class ClientInterface;

class Receiver : private virtual slsDetectorDefs {

  public:
    /**
     * Constructor
     * Starts up a Receiver server. Reads configuration file, options, and
     * assembles a Receiver using TCP and UDP detector interfaces
     * throws an exception in case of failure
     * @param argc from command line
     * @param argv from command line
     */
    Receiver(int argc, char *argv[]);

    /**
     * Constructor
     * Starts up a Receiver server. Reads configuration file, options, and
     * assembles a Receiver using TCP and UDP detector interfaces
     * throws an exception in case of failure
     * @param tcpip_port_no TCP/IP port number
     */
    Receiver(uint16_t tcpip_port_no = 1954);

    ~Receiver();

    /**
     * get get Receiver Version
     \returns id
     */
    std::string getReceiverVersion();

    /**
     * Start Acquisition Call back (slsMultiReceiver writes data if file write
     * enabled) if registerCallBackRawDataReady or
     * registerCallBackRawDataModifyReady registered, users get data callback
     * arguments are:
     * - file path
     * - file name prefix
     * - file index
     * - image size in bytes
     */
    void registerCallBackStartAcquisition(int (*func)(const std::string &,
                                                      const std::string &,
                                                      uint64_t, size_t, void *),
                                          void *arg);

    /**
     * Call back for acquisition finished
     * callback argument is:
     * - total frames caught
     */
    void registerCallBackAcquisitionFinished(void (*func)(uint64_t, void *),
                                             void *arg);

    /**
     * Call back for raw data
     * args to raw data ready callback are:
     * - sls_receiver_header frame metadata,
     * - pointer to data
     * - image size in bytes
     */
    void registerCallBackRawDataReady(void (*func)(sls_receiver_header &,
                                                   char *, size_t, void *),
                                      void *arg);

    /**
     * Call back for raw data (modified)
     * args to raw data ready callback are:
     * - sls_receiver_header frame metadata,
     * - pointer to data
     * - revDatasize is the reference of data size in bytes.
     * Can be modified to the new size to be written/streamed. (only smaller
     * value allowed).
     */
    void registerCallBackRawDataModifyReady(void (*func)(sls_receiver_header &,
                                                         char *, size_t &,
                                                         void *),
                                            void *arg);

  private:
    std::unique_ptr<ClientInterface> tcpipInterface;
};

} // namespace sls