//=============================================================================================================
/**
 * @file     rtdataclient.h
 * @author   Lorenz Esch <lesch@mgh.harvard.edu>;
 *           Matti Hamalainen <msh@nmr.mgh.harvard.edu>;
 *           Christoph Dinh <chdinh@nmr.mgh.harvard.edu>
 * @since    0.1.0
 * @date     July, 2012
 *
 * @section  LICENSE
 *
 * Copyright (C) 2012, Lorenz Esch, Matti Hamalainen, Christoph Dinh. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 * the following conditions are met:
 *     * Redistributions of source code must retain the above copyright notice, this list of conditions and the
 *       following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
 *       the following disclaimer in the documentation and/or other materials provided with the distribution.
 *     * Neither the name of MNE-CPP authors nor the names of its contributors may be used
 *       to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * @brief     declaration of the RtDataClient Class.
 *
 */

#ifndef RTDATACLIENT_H
#define RTDATACLIENT_H

//=============================================================================================================
// INCLUDES
//=============================================================================================================

#include "../communication_global.h"

#include <fiff/fiff_stream.h>
#include <fiff/fiff_info.h>
#include <fiff/fiff_tag.h>
#include <fiff/fiff_digitizer_data.h>

#include <utility>

//=============================================================================================================
// QT INCLUDES
//=============================================================================================================

#include <QSharedPointer>
#include <QString>
#include <QTcpSocket>

//=============================================================================================================
// DEFINE NAMESPACE COMMUNICATIONLIB
//=============================================================================================================

namespace COMMUNICATIONLIB
{

//=============================================================================================================
/**
 * @brief Bundles FiffInfo and FiffDigitizerData received from mne_rt_server for a measurement session
 */
struct MetaData{
    MetaData(FIFFLIB::FiffInfo::SPtr pInfo,
             FIFFLIB::FiffDigitizerData::SPtr pDigitizerData)
            :m_pInfo(pInfo)
            ,m_pDigitizerData(pDigitizerData){};

    FIFFLIB::FiffInfo::SPtr m_pInfo;
    FIFFLIB::FiffDigitizerData::SPtr m_pDigitizerData;
};

//=============================================================================================================
/**
 * The real-time data client class provides an interface to communicate with the data port 4218 of a running mne_rt_server.
 *
 * @brief TCP client for streaming raw MEG/EEG measurement data from mne_rt_server (port 4218)
 */
class COMMUNICATIONSHARED_EXPORT RtDataClient : public QTcpSocket
{
    Q_OBJECT

public:
    typedef QSharedPointer<RtDataClient> SPtr;               /**< Shared pointer type for RtDataClient. */
    typedef QSharedPointer<const RtDataClient> ConstSPtr;    /**< Const shared pointer type for RtDataClient. */

    //=========================================================================================================
    /**
     * Creates the real-time data client.
     *
     * @param[in] parent     Parent QObject (optional).
     */
    explicit RtDataClient(QObject *parent = Q_NULLPTR);

    //=========================================================================================================
    /**
     * Attempts to close the socket. If there is pending data waiting to be written, QAbstractSocket will enter
     * ClosingState and wait until all data has been written. Eventually, it will enter UnconnectedState and
     * emit the disconnected() signal.
     */
    virtual void disconnectFromHost();

    //=========================================================================================================
    /**
     * Requests the ID at mne_rt_server and returns it
     *
     * @return the requested id.
     */
    qint32 getClientId();

    //=========================================================================================================
    /**
     * Reads fiff measurement information of a data the connection
     *
     * @return the read fiff measurement information.
     */
    FIFFLIB::FiffInfo::SPtr readInfo();

    //=========================================================================================================
    /**
     * Reads fiff metaata class from data connection
     *
     * @return returns metadata class (FiffInfo and FiffDigitizerData)
     */
    MetaData readMetadata();

    //=========================================================================================================
    /**
     * Reads fiff measurement information of a data the connection
     *
     * @param[in] p_nChannels    Number of channels to reshape the received data.
     * @param[out] data          The read data - ToDo change this to raw buffer data object.
     * @param[out] kind          Data kind.
     */
    void readRawBuffer(qint32 p_nChannels,
                       Eigen::MatrixXf& data,
                       FIFFLIB::fiff_int_t& kind);

    //=========================================================================================================
    /**
     * Sets the alias of the data client
     *
     * @param[in] p_sAlias    The alias of the data client.
     */
    void setClientAlias(const QString &p_sAlias);

private:
    qint32 m_clientID;  /**< Corresponding client id of the data client at mne_rt_server. */
    
};
} // NAMESPACE

#endif // RTDATACLIENT_H
