UdpDataProtocol.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 __UDPDATAPROTOCOL_H__
#define __UDPDATAPROTOCOL_H__
 
#include <stdexcept>
 
#include <QThread>
#include <QHostAddress>
#include <QMutex>
#include <vector>
#include <random>
 
#include "DataProtocol.h"
#include "jacktrip_types.h"
#include "jacktrip_globals.h"
 
class UdpDataProtocol : public DataProtocol
{
    Q_OBJECT;
 
public:
 
    UdpDataProtocol(JackTrip* jacktrip, const runModeT runmode,
                    int bind_port, int peer_port,
                    unsigned int udp_redundancy_factor = 1);
 
    virtual ~UdpDataProtocol();
 
    void setPeerAddress(const char* peerHostOrIP);
 
#if defined (__WIN_32__)
    void setSocket(SOCKET &socket);
#else
    void setSocket(int &socket);
#endif
 
    //virtual int receivePacket(char* buf, const size_t n);
    virtual int receivePacket(char* buf, const size_t n);
 
    virtual int sendPacket(const char* buf, const size_t n);
 
    virtual void getPeerAddressFromFirstPacket(QHostAddress& peerHostAddress,
                                               uint16_t& port);
 
    void setBindPort(int port)
    { mBindPort = port; }
 
    void setPeerPort(int port)
    { mPeerPort = port; mPeerAddr.sin_port = htons(mPeerPort); mPeerAddr6.sin6_port = htons(mPeerPort); }
 
    virtual void run();
 
    virtual bool getStats(PktStat* stat);
    virtual void setIssueSimulation(double loss, double jitter, double max_delay);
 
private slots:
    void printUdpWaitedTooLong(int wait_msec);
    
 
signals:
 
    void signalWaitingTooLong(int wait_msec);
    void signalUdpWaitingTooLong();
 
    //private:
protected:
 
#if defined (__WIN_32__)
    SOCKET bindSocket();
#else
    int bindSocket();
#endif
 
    void waitForReady(int timeout_msec);
 
    virtual void receivePacketRedundancy(int8_t* full_redundant_packet,
                                         int full_redundant_packet_size,
                                         int full_packet_size,
                                         uint16_t& current_seq_num,
                                         uint16_t& last_seq_num,
                                         uint16_t& newer_seq_num);
 
    virtual void sendPacketRedundancy(int8_t* full_redundant_packet,
                                      int full_redundant_packet_size,
                                      int full_packet_size);
 
private:
    bool datagramAvailable();
    
    int mBindPort; 
    int mPeerPort; 
    const runModeT mRunMode; 
    bool mIPv6; 
 
    QHostAddress mPeerAddress; 
    struct sockaddr_in mPeerAddr;
    struct sockaddr_in6 mPeerAddr6;
#if defined (__WIN_32__)
    SOCKET mSocket;
#else
    int mSocket;
#endif
 
    int8_t* mAudioPacket; 
    int8_t* mFullPacket; 
    std::vector<int8_t> mBuffer;
    int mChans;
    int mSmplSize;
    int mLastOutOfOrderCount;
    bool mInitialState;
 
    unsigned int mUdpRedundancyFactor; 
    static QMutex sUdpMutex; 
 
    std::atomic<uint32_t>  mTotCount;
    std::atomic<uint32_t>  mLostCount;
    std::atomic<uint32_t>  mOutOfOrderCount;
    std::atomic<uint32_t>  mRevivedCount;
    uint32_t  mStatCount;
 
    uint8_t mControlPacketSize;
    bool mStopSignalSent;
 
    // packet loss/jitter simulation
    double mSimulatedLossRate;
    double mSimulatedJitterRate;
    double mSimulatedJitterMaxDelay;
    std::default_random_engine mRndEngine;
    std::uniform_real_distribution<double> mUniformDist;
};
 
#endif // __UDPDATAPROTOCOL_H__