DataProtocol.h

Go to the documentation of this file.

//*****************************************************************
/*
  JackTrip: A System for High-Quality Audio Network Performance
  over the Internet
 
  Copyright (c) 2008 Juan-Pablo Caceres, Chris Chafe.
  SoundWIRE group at CCRMA, Stanford University.
 
  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.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  OTHER DEALINGS IN THE SOFTWARE.
*/
//*****************************************************************
 
#ifndef __DATAPROTOCOL_H__
#define __DATAPROTOCOL_H__
 
#ifdef __WIN_32__
#include <winsock2.h>
#include <ws2tcpip.h>
#endif
 
#ifndef __WIN_32__
#include <netinet/in.h> //sockaddr_in{} and other Internet defns
#include <arpa/inet.h> //inet(3) functions
#include <netdb.h>
//#include <tr1/memory> //for shared_ptr
#endif
 
#include <iostream>
 
#include <QThread>
#include <QHostAddress>
#include <QMutex>
#include <QMutexLocker>
 
class JackTrip; // forward declaration
 
 
class DataProtocol : public QThread
{
    Q_OBJECT;
 
public:
 
    //----------ENUMS------------------------------------------
    enum packetHeaderTypeT {
        DEFAULT, 
        JAMLINK, 
        EMPTY    
    };
 
    enum runModeT {
        SENDER, 
        RECEIVER 
    };
    //---------------------------------------------------------
 
 
    DataProtocol(JackTrip* jacktrip,
                 const runModeT runmode,
                 int bind_port, int peer_port);
 
    virtual ~DataProtocol();
 
    virtual void run() = 0;
 
    virtual void stop() {
        QMutexLocker lock(&mMutex);
        mStopped = true;
    }
 
    void setAudioPacketSize(const size_t size_bytes){ mAudioPacketSize = size_bytes; }
 
    size_t getAudioPacketSizeInBites() { return(mAudioPacketSize); }
 
    virtual void setPeerAddress(const char* peerHostOrIP) = 0;
 
    virtual void setPeerPort(int port) = 0;
 
    //virtual void getPeerAddressFromFirstPacket(QHostAddress& peerHostAddress,
    //                               uint16_t& port) = 0;
 
#if defined (__WIN_32__)
    virtual void setSocket(SOCKET &socket) = 0;
#else
    virtual void setSocket(int &socket) = 0;
#endif
 
    struct PktStat {
        uint32_t tot;
        uint32_t lost;
        uint32_t outOfOrder;
        uint32_t revived;
        uint32_t statCount;
    };
    virtual bool getStats(PktStat*) {return false;}
 
    virtual void setIssueSimulation(double /*loss*/, double /*jitter*/, double /*max_delay*/) {}
    void setUseRtPriority(bool use) {mUseRtPriority = use;}
 
signals:
 
    void signalError(const char* error_message);
    void signalReceivedConnectionFromPeer();
    void signalCeaseTransmission(const QString &reason = "");
 
protected:
 
    runModeT getRunMode() const { return mRunMode; }
 
    volatile bool mStopped;
    volatile bool mHasPeerAddress;
    volatile bool mHasPacketsToReceive;
    QMutex mMutex;
 
 
private:
 
    int mLocalPort; 
    int mPeerPort; 
    const runModeT mRunMode; 
 
    struct sockaddr_in mLocalIPv4Addr; 
    struct sockaddr_in mPeerIPv4Addr; 
 
    static int sClientsRunning;
 
    size_t mAudioPacketSize; 
 
 
protected:
    //PacketHeader* mHeader; ///< Packet Header
    JackTrip* mJackTrip; 
    bool mUseRtPriority;
 
};
 
#endif