JackTrip
UdpDataProtocol.h
Go to the documentation of this file.
1 //*****************************************************************
2 /*
3  JackTrip: A System for High-Quality Audio Network Performance
4  over the Internet
5 
6  Copyright (c) 2008 Juan-Pablo Caceres, Chris Chafe.
7  SoundWIRE group at CCRMA, Stanford University.
8 
9  Permission is hereby granted, free of charge, to any person
10  obtaining a copy of this software and associated documentation
11  files (the "Software"), to deal in the Software without
12  restriction, including without limitation the rights to use,
13  copy, modify, merge, publish, distribute, sublicense, and/or sell
14  copies of the Software, and to permit persons to whom the
15  Software is furnished to do so, subject to the following
16  conditions:
17 
18  The above copyright notice and this permission notice shall be
19  included in all copies or substantial portions of the Software.
20 
21  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
23  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
25  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  OTHER DEALINGS IN THE SOFTWARE.
29 */
30 //*****************************************************************
31 
38 #ifndef __UDPDATAPROTOCOL_H__
39 #define __UDPDATAPROTOCOL_H__
40 
41 #include <stdexcept>
42 
43 #include <QThread>
44 #include <QUdpSocket>
45 #include <QHostAddress>
46 #include <QMutex>
47 
48 #include "DataProtocol.h"
49 #include "jacktrip_types.h"
50 #include "jacktrip_globals.h"
51 
67 {
68  Q_OBJECT;
69 
70 public:
71 
79  UdpDataProtocol(JackTrip* jacktrip, const runModeT runmode,
80  int bind_port, int peer_port,
81  unsigned int udp_redundancy_factor = 1);
82 
85  virtual ~UdpDataProtocol();
86 
90  void setPeerAddress(const char* peerHostOrIP);
91 
92 #if defined (__WIN_32__)
93  void setSocket(SOCKET &socket);
94 #else
95  void setSocket(int &socket);
96 #endif
97 
106  //virtual int receivePacket(char* buf, const size_t n);
107  virtual int receivePacket(QUdpSocket& UdpSocket, char* buf, const size_t n);
108 
117  virtual int sendPacket(const char* buf, const size_t n);
118 
124  virtual void getPeerAddressFromFirstPacket(QUdpSocket& UdpSocket,
125  QHostAddress& peerHostAddress,
126  uint16_t& port);
127 
130  void setBindPort(int port)
131  { mBindPort = port; }
132 
135  void setPeerPort(int port)
136  { mPeerPort = port; mPeerAddr.sin_port = htons(mPeerPort); mPeerAddr6.sin6_port = htons(mPeerPort); }
137 
143  virtual void run();
144 
145  virtual bool getStats(PktStat* stat);
146 
147 private slots:
148  void printUdpWaitedTooLong(int wait_msec);
149 
150 
151 signals:
152 
155  void signalWaitingTooLong(int wait_msec);
156 
157 
158  //private:
159 protected:
160 
163 #if defined (__WIN_32__)
164  SOCKET bindSocket();
165 #else
166  int bindSocket();
167 #endif
168 
178  void waitForReady(QUdpSocket& UdpSocket, int timeout_msec);
179 
182  virtual void receivePacketRedundancy(QUdpSocket& UdpSocket,
183  int8_t* full_redundant_packet,
184  int full_redundant_packet_size,
185  int full_packet_size,
186  uint16_t& current_seq_num,
187  uint16_t& last_seq_num,
188  uint16_t& newer_seq_num);
189 
192  virtual void sendPacketRedundancy(int8_t* full_redundant_packet,
193  int full_redundant_packet_size,
194  int full_packet_size);
195 
196 
197 private:
198 
199  int mBindPort;
200  int mPeerPort;
201  const runModeT mRunMode;
202  bool mIPv6;
203 
204  QHostAddress mPeerAddress;
205  struct sockaddr_in mPeerAddr;
206  struct sockaddr_in6 mPeerAddr6;
207 #if defined (__WIN_32__)
208  SOCKET mSocket;
209 #else
210  int mSocket;
211 #endif
212 
213  int8_t* mAudioPacket;
214  int8_t* mFullPacket;
215 
216  unsigned int mUdpRedundancyFactor;
217  static QMutex sUdpMutex;
218 
219  std::atomic<uint32_t> mTotCount;
220  std::atomic<uint32_t> mLostCount;
221  std::atomic<uint32_t> mOutOfOrderCount;
222  std::atomic<uint32_t> mRevivedCount;
223  uint32_t mStatCount;
224 };
225 
226 #endif // __UDPDATAPROTOCOL_H__
UdpDataProtocol::setBindPort
void setBindPort(int port)
Sets the bind port number.
Definition: UdpDataProtocol.h:130
UdpDataProtocol::signalWaitingTooLong
void signalWaitingTooLong(int wait_msec)
Signals when waiting every 10 milliseconds, with the total wait on wait_msec.
UdpDataProtocol::run
virtual void run()
Implements the Thread Loop. To start the thread, call start() ( DO NOT CALL run() )
Definition: UdpDataProtocol.cpp:374
DataProtocol
Base class that defines the transmission protocol.
Definition: DataProtocol.h:94
uint16_t
quint16 uint16_t
Typedef for unsigned short. This type is guaranteed to be 16-bit.
Definition: jacktrip_types.h:71
JackTrip
Main class to creates a SERVER (to listen) or a CLIENT (to connect to a listening server) to send aud...
Definition: JackTrip.h:68
int8_t
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78
UdpDataProtocol::receivePacketRedundancy
virtual void receivePacketRedundancy(QUdpSocket &UdpSocket, 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)
Redundancy algorythm at the receiving end.
Definition: UdpDataProtocol.cpp:643
UdpDataProtocol
UDP implementation of DataProtocol class.
Definition: UdpDataProtocol.h:67
UdpDataProtocol::setSocket
void setSocket(int &socket)
Definition: UdpDataProtocol.cpp:156
UdpDataProtocol::receivePacket
virtual int receivePacket(QUdpSocket &UdpSocket, char *buf, const size_t n)
Receives a packet. It blocks until a packet is received.
Definition: UdpDataProtocol.cpp:319
UdpDataProtocol::bindSocket
int bindSocket()
Binds the UDP socket to the available address and specified port.
Definition: UdpDataProtocol.cpp:181
UdpDataProtocol::~UdpDataProtocol
virtual ~UdpDataProtocol()
The class destructor.
Definition: UdpDataProtocol.cpp:92
UdpDataProtocol::UdpDataProtocol
UdpDataProtocol(JackTrip *jacktrip, const runModeT runmode, int bind_port, int peer_port, unsigned int udp_redundancy_factor=1)
The class constructor.
Definition: UdpDataProtocol.cpp:68
uint32_t
quint32 uint32_t
Typedef for unsigned int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:73
jacktrip_globals.h
DataProtocol::runModeT
runModeT
Enum to define class modes, SENDER or RECEIVER.
Definition: DataProtocol.h:108
UdpDataProtocol::waitForReady
void waitForReady(QUdpSocket &UdpSocket, int timeout_msec)
This function blocks until data is available for reading in the QUdpSocket. The function will timeout...
Definition: UdpDataProtocol.cpp:602
UdpDataProtocol::sendPacket
virtual int sendPacket(const char *buf, const size_t n)
Sends a packet.
Definition: UdpDataProtocol.cpp:329
UdpDataProtocol::sendPacketRedundancy
virtual void sendPacketRedundancy(int8_t *full_redundant_packet, int full_redundant_packet_size, int full_packet_size)
Redundancy algorythm at the sender's end.
Definition: UdpDataProtocol.cpp:719
UdpDataProtocol::setPeerPort
void setPeerPort(int port)
Sets the peer port number.
Definition: UdpDataProtocol.h:135
DataProtocol.h
jacktrip_types.h
UdpDataProtocol::setPeerAddress
void setPeerAddress(const char *peerHostOrIP)
Set the Peer address to connect to.
Definition: UdpDataProtocol.cpp:101
UdpDataProtocol::getStats
virtual bool getStats(PktStat *stat)
Definition: UdpDataProtocol.cpp:703
UdpDataProtocol::getPeerAddressFromFirstPacket
virtual void getPeerAddressFromFirstPacket(QUdpSocket &UdpSocket, QHostAddress &peerHostAddress, uint16_t &port)
Obtains the peer address from the first UDP packet received. This address is used by the SERVER mode ...
Definition: UdpDataProtocol.cpp:361