JackTrip.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 __JACKTRIP_H__
#define __JACKTRIP_H__
 
//#include <tr1/memory> //for shared_ptr
#include <stdexcept>
 
#include <QObject>
#include <QString>
#include <QUdpSocket>
#include <QTcpSocket>
#include <QTimer>
#include <QSharedPointer>
 
#include "DataProtocol.h"
#include "AudioInterface.h"
 
#ifndef __NO_JACK__
#include "JackAudioInterface.h"
#endif //__NO_JACK__
 
#include "PacketHeader.h"
#include "RingBuffer.h"
#include "AudioTester.h"
 
//#include <signal.h>
class JackTrip : public QObject
{
    Q_OBJECT;
 
public:
 
    //----------ENUMS------------------------------------------
    enum dataProtocolT {
        UDP, 
        TCP, 
        SCTP 
    };
 
    enum jacktripModeT {
        SERVER, 
        CLIENT,  
        CLIENTTOPINGSERVER, 
        SERVERPINGSERVER 
    };
 
    enum underrunModeT {
        WAVETABLE, 
        ZEROS  
    };
 
    enum audiointerfaceModeT {
        JACK, 
        RTAUDIO  
    };
 
    enum connectionModeT {
        NORMAL, 
        KSTRONG,  
        JAMTEST  
    };
 
    enum hubConnectionModeT {
        SERVERTOCLIENT, 
        CLIENTECHO,  
        CLIENTFOFI,  
        RESERVEDMATRIX,  
        FULLMIX,  
        NOAUTO  
    };
    //---------------------------------------------------------
 
 
    JackTrip(jacktripModeT JacktripMode = CLIENT,
             dataProtocolT DataProtocolType = UDP,
             int NumChans = gDefaultNumInChannels,
         #ifdef WAIR // wair
             int NumNetRevChans = 0,
         #endif // endwhere
             int BufferQueueLength = gDefaultQueueLength,
             unsigned int redundancy = gDefaultRedundancy,
             AudioInterface::audioBitResolutionT AudioBitResolution =
             AudioInterface::BIT16,
             DataProtocol::packetHeaderTypeT PacketHeaderType =
             DataProtocol::DEFAULT,
             underrunModeT UnderRunMode = WAVETABLE,
             int receiver_bind_port = gDefaultPort,
             int sender_bind_port = gDefaultPort,
             int receiver_peer_port = gDefaultPort,
             int sender_peer_port = gDefaultPort,
             int tcp_peer_port = gDefaultPort);
 
    virtual ~JackTrip();
    
    static void sigIntHandler(__attribute__((unused)) int unused)
    { std::cout << std::endl << "Shutting Down..." << std::endl; sSigInt = true; }
    static bool sSigInt;
    static bool sJackStopped;
 
    /*virtual void run() {
        if (gVerboseFlag) std::cout << "Settings:startJackTrip before mJackTrip->run" << std::endl;
    }*/
 
    virtual void setPeerAddress(QString PeerHostOrIP);
 
    //void appendProcessPlugin(const std::tr1::shared_ptr<ProcessPlugin> plugin);
    virtual void appendProcessPluginToNetwork(ProcessPlugin* plugin);
    virtual void appendProcessPluginFromNetwork(ProcessPlugin* plugin);
 
    virtual void startProcess(
        #ifdef WAIRTOHUB // wair
            int ID
        #endif // endwhere
            );
    virtual void completeConnection();
 
    virtual void stop(QString errorMessage = "");
 
    virtual void waitThreads();
 
    virtual void checkIfPortIsBinded(int port);
 
    //------------------------------------------------------------------------------------
 
    //
    virtual void setJackTripMode(jacktripModeT JacktripMode)
    { mJackTripMode = JacktripMode; }
    virtual void setDataProtocoType(dataProtocolT DataProtocolType)
    { mDataProtocol = DataProtocolType; }
    virtual void setPacketHeaderType(DataProtocol::packetHeaderTypeT PacketHeaderType)
    {
        mPacketHeaderType = PacketHeaderType;
        delete mPacketHeader;
        mPacketHeader = NULL;
        createHeader(mPacketHeaderType);
    }
    virtual void setBufferQueueLength(int BufferQueueLength)
    { mBufferQueueLength = BufferQueueLength; }
    virtual void setBufferStrategy(int BufferStrategy)
    { mBufferStrategy = BufferStrategy; }
    virtual void setAudioBitResolution(AudioInterface::audioBitResolutionT AudioBitResolution)
    { mAudioBitResolution = AudioBitResolution; }
    virtual void setUnderRunMode(underrunModeT UnderRunMode)
    { mUnderRunMode = UnderRunMode; }
    virtual void setStopOnTimeout(bool stopOnTimeout)
    { mStopOnTimeout = stopOnTimeout; }
    virtual void setAllPorts(int port)
    {
        mReceiverBindPort = port;
        mSenderPeerPort = port;
        mSenderBindPort = port;
        mReceiverPeerPort = port;
    }
    void setBindPorts(int port)
    {
        mReceiverBindPort = port;
        mSenderBindPort = port;
    }
    void setPeerPorts(int port)
    {
        mSenderPeerPort = port;
        mReceiverPeerPort = port;
    }
    virtual void setClientName(QString clientName)
    { mJackClientName = clientName; }
    virtual void setRemoteClientName(QString remoteClientName)
    { mRemoteClientName = remoteClientName; }
    virtual void setNumChannels(int num_chans)
    { mNumChans = num_chans; }
    
    virtual void setIOStatTimeout(int timeout) { mIOStatTimeout = timeout; }
    virtual void setIOStatStream(QSharedPointer<std::ofstream> statStream) { mIOStatStream = statStream; }
 
    virtual void setConnectDefaultAudioPorts(bool connect)
    {mConnectDefaultAudioPorts = connect;}
 
    virtual int getReceiverBindPort() const
    { return mReceiverBindPort; }
    virtual int getSenderPeerPort() const
    { return mSenderPeerPort; }
    virtual int getSenderBindPort() const
    { return mSenderBindPort; }
    virtual int getReceiverPeerPort() const
    { return mReceiverPeerPort; }
 
    virtual DataProtocol* getDataProtocolSender() const
    { return mDataProtocolSender; }
    virtual DataProtocol* getDataProtocolReceiver() const
    { return mDataProtocolReceiver; }
    virtual void setDataProtocolSender(DataProtocol* const DataProtocolSender)
    { mDataProtocolSender = DataProtocolSender; }
    virtual void setDataProtocolReceiver(DataProtocol* const DataProtocolReceiver)
    { mDataProtocolReceiver = DataProtocolReceiver; }
 
    virtual RingBuffer* getSendRingBuffer() const
    { return mSendRingBuffer; }
    virtual RingBuffer* getReceiveRingBuffer() const
    { return mReceiveRingBuffer; }
    virtual void setSendRingBuffer(RingBuffer* const SendRingBuffer)
    { mSendRingBuffer = SendRingBuffer; }
    virtual void setReceiveRingBuffer(RingBuffer* const ReceiveRingBuffer)
    { mReceiveRingBuffer = ReceiveRingBuffer; }
 
    virtual void setPacketHeader(PacketHeader* const PacketHeader)
    { mPacketHeader = PacketHeader; }
 
    virtual int getRingBuffersSlotSize()
    { return getTotalAudioPacketSizeInBytes(); }
 
    virtual void setAudiointerfaceMode(JackTrip::audiointerfaceModeT audiointerface_mode)
    { mAudiointerfaceMode = audiointerface_mode; }
    virtual void setAudioInterface(AudioInterface* const AudioInterface)
    { mAudioInterface = AudioInterface; }
    virtual void setLoopBack(bool b)
    { mLoopBack = b; }
    virtual void setAudioTesterP(AudioTester* atp) { mAudioTesterP = atp; }
 
    void setSampleRate(uint32_t sample_rate)
    { mSampleRate = sample_rate; }
    void setDeviceID(uint32_t device_id)
    { mDeviceID = device_id; }
    void setAudioBufferSizeInSamples(uint32_t buf_size)
    { mAudioBufferSize = buf_size; }
 
 
    JackTrip::connectionModeT getConnectionMode() const
    { return mConnectionMode; }
    void setConnectionMode(JackTrip::connectionModeT connection_mode)
    { mConnectionMode = connection_mode; }
 
    JackTrip::hubConnectionModeT getHubConnectionModeT() const
    { return mHubConnectionModeT; }
    void setHubConnectionModeT(JackTrip::hubConnectionModeT connection_mode)
    { mHubConnectionModeT = connection_mode; }
 
    JackTrip::jacktripModeT getJackTripMode() const
    { return mJackTripMode; }
 
    QString getPeerAddress() const
    { return mPeerAddress; }
 
    bool receivedConnectionFromPeer()
    { return mReceivedConnection; }
 
    bool tcpConnectionError()
    { return mTcpConnectionError; }
 
    //------------------------------------------------------------------------------------
 
 
    //------------------------------------------------------------------------------------
 
 
    virtual void createHeader(const DataProtocol::packetHeaderTypeT headertype);
    void putHeaderInPacket(int8_t* full_packet, int8_t* audio_packet);
    virtual int getPacketSizeInBytes();
    void parseAudioPacket(int8_t* full_packet, int8_t* audio_packet);
    virtual void sendNetworkPacket(const int8_t* ptrToSlot)
    { mSendRingBuffer->insertSlotNonBlocking(ptrToSlot, 0, 0); }
    virtual void receiveBroadcastPacket(int8_t* ptrToReadSlot)
    { mReceiveRingBuffer->readBroadcastSlot(ptrToReadSlot); }
    virtual void receiveNetworkPacket(int8_t* ptrToReadSlot)
    { mReceiveRingBuffer->readSlotNonBlocking(ptrToReadSlot); }
    virtual void readAudioBuffer(int8_t* ptrToReadSlot)
    { mSendRingBuffer->readSlotBlocking(ptrToReadSlot); }
    virtual bool writeAudioBuffer(const int8_t* ptrToSlot, int len, int lostLen)
    { return mReceiveRingBuffer->insertSlotNonBlocking(ptrToSlot, len, lostLen); }
    uint32_t getBufferSizeInSamples() const
    { return mAudioBufferSize; /*return mAudioInterface->getBufferSizeInSamples();*/ }
    uint32_t getDeviceID() const
    { return mDeviceID; /*return mAudioInterface->mDeviceID();*/ }
 
    AudioInterface::samplingRateT getSampleRateType() const
    { return mAudioInterface->getSampleRateType(); }
    int getSampleRate() const
    { return mSampleRate; /*return mAudioInterface->getSampleRate();*/ }
 
    uint8_t getAudioBitResolution() const
    { return mAudioBitResolution*8; /*return mAudioInterface->getAudioBitResolution();*/ }
    unsigned int getNumInputChannels() const
    { return mNumChans; /*return mAudioInterface->getNumInputChannels();*/ }
    unsigned int getNumOutputChannels() const
    { return mNumChans; /*return mAudioInterface->getNumOutputChannels();*/ }
    unsigned int getNumChannels() const
    {
        if (getNumInputChannels() == getNumOutputChannels())
        { return getNumInputChannels(); }
        else { return 0; }
    }
    virtual void checkPeerSettings(int8_t* full_packet);
    void increaseSequenceNumber()
    { mPacketHeader->increaseSequenceNumber(); }
    int getSequenceNumber() const
    { return mPacketHeader->getSequenceNumber(); }
 
    uint64_t getPeerTimeStamp(int8_t* full_packet) const
    { return mPacketHeader->getPeerTimeStamp(full_packet); }
 
    uint16_t getPeerSequenceNumber(int8_t* full_packet) const
    { return mPacketHeader->getPeerSequenceNumber(full_packet); }
 
    uint16_t getPeerBufferSize(int8_t* full_packet) const
    { return mPacketHeader->getPeerBufferSize(full_packet); }
 
    uint8_t getPeerSamplingRate(int8_t* full_packet) const
    { return mPacketHeader->getPeerSamplingRate(full_packet); }
 
    uint8_t getPeerBitResolution(int8_t* full_packet) const
    { return mPacketHeader->getPeerBitResolution(full_packet); }
 
    uint8_t  getPeerNumChannels(int8_t* full_packet) const
    { return mPacketHeader->getPeerNumChannels(full_packet); }
 
    uint8_t  getPeerConnectionMode(int8_t* full_packet) const
    { return mPacketHeader->getPeerConnectionMode(full_packet); }
 
    size_t getSizeInBytesPerChannel() const
    { return mAudioInterface->getSizeInBytesPerChannel(); }
    int getHeaderSizeInBytes() const
    { return mPacketHeader->getHeaderSizeInBytes(); }
    virtual int getTotalAudioPacketSizeInBytes() const
    {
#ifdef WAIR // WAIR
        if (mNumNetRevChans)
            return mAudioInterface->getSizeInBytesPerChannel() * mNumNetRevChans;
        else // not wair
#endif // endwhere
            return mAudioInterface->getSizeInBytesPerChannel() * mNumChans;
    }
    //------------------------------------------------------------------------------------
 
    void printTextTest() {std::cout << "=== JackTrip PRINT ===" << std::endl;}
    void printTextTest2() {std::cout << "=== JackTrip PRINT2 ===" << std::endl;}
 
    void setNetIssuesSimulation(double loss, double jitter, double delay_rel)
    {
        mSimulatedLossRate = loss;
        mSimulatedJitterRate = jitter;
        mSimulatedDelayRel = delay_rel;
    }
    void setBroadcast(int broadcast_queue) {mBroadcastQueueLength = broadcast_queue;}
    void setUseRtUdpPriority(bool use) {mUseRtUdpPriority = use;}
 
public slots:
    virtual void slotStopProcesses()
    { this->stop(); }
    virtual void slotStopProcessesDueToError(const QString &errorMessage)
    { this->stop(errorMessage); }
 
    void slotUdpWaitingTooLongClientGoneProbably(int wait_msec)
    {
        int wait_time = 10000; // msec
        if ( !(wait_msec%wait_time) ) {
            std::cerr << "UDP WAITED MORE THAN 10 seconds." << std::endl;
            if (mStopOnTimeout) {
                stop("No network data received for 10 seconds");
            }
            emit signalNoUdpPacketsForSeconds();
        }
    }
    void slotUdpWaitingTooLong()
    { emit signalUdpWaitingTooLong(); }
    void slotPrintTest()
    { std::cout << "=== TESTING ===" << std::endl; }
    void slotReceivedConnectionFromPeer()
    { mReceivedConnection = true; emit signalReceivedConnectionFromPeer(); }
    void onStatTimer();
    
private slots:
    void receivedConnectionTCP();
    void receivedDataTCP();
    void receivedDataUDP();
    void udpTimerTick();
    void tcpTimerTick();
 
signals:
    //void signalUdpTimeOut();
    void signalProcessesStopped();
    void signalNoUdpPacketsForSeconds();
    void signalTcpClientConnected();
    void signalError(const QString &errorMessage);
    void signalReceivedConnectionFromPeer();
    void signalUdpWaitingTooLong();
 
public:
 
    virtual void setupAudio(
        #ifdef WAIRTOHUB // WAIR
            int ID
        #endif // endwhere
            );
    void closeAudio();
    virtual void setupDataProtocol();
    void setupRingBuffers();
    void clientStart();
    int serverStart(bool timeout = false, int udpTimeout = gTimeOutMultiThreadedServer);
    virtual int clientPingToServerStart();
 
private:
    //void bindReceiveSocket(QUdpSocket& UdpSocket, int bind_port,
    //                       QHostAddress PeerHostAddress, int peer_port)
    //throw(std::runtime_error);
 
 
    jacktripModeT mJackTripMode; 
    dataProtocolT mDataProtocol; 
    DataProtocol::packetHeaderTypeT mPacketHeaderType; 
    JackTrip::audiointerfaceModeT mAudiointerfaceMode;
 
    int mNumChans; 
#ifdef WAIR // WAIR
    int mNumNetRevChans; 
#endif // endwhere
    int mBufferQueueLength; 
    int mBufferStrategy;
    int mBroadcastQueueLength;
    uint32_t mSampleRate; 
    uint32_t mDeviceID; 
    uint32_t mAudioBufferSize; 
    AudioInterface::audioBitResolutionT mAudioBitResolution; 
    bool mLoopBack;
    QString mPeerAddress; 
 
    DataProtocol* mDataProtocolSender;
    DataProtocol* mDataProtocolReceiver;
    AudioInterface* mAudioInterface; 
    PacketHeader* mPacketHeader; 
    underrunModeT mUnderRunMode; 
    bool mStopOnTimeout; 
 
    RingBuffer* mSendRingBuffer;
    RingBuffer* mReceiveRingBuffer;
 
    int mReceiverBindPort; 
    int mSenderPeerPort; 
    int mSenderBindPort; 
    int mReceiverPeerPort; 
    int mTcpServerPort;
 
    unsigned int mRedundancy; 
    QString mJackClientName; 
    QString mRemoteClientName; 
 
    JackTrip::connectionModeT mConnectionMode; 
    JackTrip::hubConnectionModeT mHubConnectionModeT; 
 
    QVector<ProcessPlugin*> mProcessPluginsFromNetwork; 
    QVector<ProcessPlugin*> mProcessPluginsToNetwork; 
    
    QTimer mTimeoutTimer;
    int mSleepTime;
    int mElapsedTime;
    int mEndTime;
    QTcpSocket mTcpClient;
    QUdpSocket mUdpSockTemp;
 
    volatile bool mReceivedConnection; 
    volatile bool mTcpConnectionError;
    volatile bool mStopped;
    volatile bool mHasShutdown;
 
    bool mConnectDefaultAudioPorts; 
    QSharedPointer<std::ofstream> mIOStatStream;
    int mIOStatTimeout;
    std::ostream mIOStatLogStream;
    double mSimulatedLossRate;
    double mSimulatedJitterRate;
    double mSimulatedDelayRel;
    bool mUseRtUdpPriority;
 
    AudioTester* mAudioTesterP;
};
 
#endif