JackTripWorker.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 __JACKTRIPWORKER_H__
#define __JACKTRIPWORKER_H__
 
#include <iostream>
 
#include <QThreadPool>
#include <QObject>
#include <QEventLoop>
#include <QHostAddress>
#include <QMutex>
 
#include "JackTrip.h"
#include "jacktrip_globals.h"
 
//class JackTrip; // forward declaration
class UdpHubListener; // forward declaration
 
 
// Note that it is not possible to start run() as an event loop. That has to be implemented
// inside a QThread
class JackTripWorker : public QObject, public QRunnable
{
    Q_OBJECT; // QRunnable is not a QObject, so I have to inherit from QObject as well
 
public:
    JackTripWorker(UdpHubListener* udphublistener, int BufferQueueLength = gDefaultQueueLength, JackTrip::underrunModeT UnderRunMode = JackTrip::WAVETABLE, QString clientName = "");
    virtual ~JackTripWorker();
 
    void run();
    bool isSpawning();
    void setJackTrip(int id,
                     QString client_address,
                     uint16_t server_port,
                     uint16_t client_port,
                     int num_channels,
                     bool connectDefaultAudioPorts
                     );
    void stopThread();
    int getID()
    {
        return mID;
    }
 
    void setBufferStrategy(int BufferStrategy) { mBufferStrategy = BufferStrategy; }
    void setNetIssuesSimulation(double loss, double jitter, double delay_rel)
    {
        mSimulatedLossRate = loss;
        mSimulatedJitterRate = jitter;
        mSimulatedDelayRel = delay_rel;
    }
    void setBroadcast(int broadcast_queue) {mBroadcastQueue = broadcast_queue;}
    void setUseRtUdpPriority(bool use) {mUseRtUdpPriority = use;}
    
    void setIOStatTimeout(int timeout) { mIOStatTimeout = timeout; }
    void setIOStatStream(QSharedPointer<std::ofstream> statStream) { mIOStatStream = statStream; }
    
private slots:
    void slotTest()
    { std::cout << "--- JackTripWorker TEST SLOT ---" << std::endl; }
 
 
signals:
    void signalRemoveThread();
 
private:
    int setJackTripFromClientHeader(JackTrip& jacktrip);
    JackTrip::connectionModeT getConnectionModeFromHeader();
 
    UdpHubListener* mUdpHubListener; 
    //QHostAddress mClientAddress; ///< Client Address
    QString mClientAddress;
    uint16_t mServerPort; 
    bool m_connectDefaultAudioPorts;
 
    uint16_t mClientPort;
    
    int mBufferQueueLength;
    JackTrip::underrunModeT mUnderRunMode;
    QString mClientName;
 
    volatile bool mSpawning;
    QMutex mMutex; 
 
    int mID; 
    int mNumChans; 
 
    int mBufferStrategy;
    int mBroadcastQueue;
    double mSimulatedLossRate;
    double mSimulatedJitterRate;
    double mSimulatedDelayRel;
    bool mUseRtUdpPriority;
    
    int mIOStatTimeout;
    QSharedPointer<std::ofstream> mIOStatStream;
#ifdef WAIR // wair
    int mNumNetRevChans; 
    bool mWAIR;
#endif // endwhere
};
 
 
#endif //__JACKTRIPWORKER_H__