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) throw(std::invalid_argument);
91 
100  //virtual int receivePacket(char* buf, const size_t n);
101  virtual int receivePacket(QUdpSocket& UdpSocket, char* buf, const size_t n);
102 
111  virtual int sendPacket(QUdpSocket& UdpSocket, const QHostAddress& PeerAddress,
112  const char* buf, const size_t n);
113 
119  virtual void getPeerAddressFromFirstPacket(QUdpSocket& UdpSocket,
120  QHostAddress& peerHostAddress,
121  uint16_t& port);
122 
125  void setBindPort(int port)
126  { mBindPort = port; }
127 
130  void setPeerPort(int port)
131  { mPeerPort = port; }
132 
138  virtual void run();
139 
140 
141 private slots:
142  void printUdpWaitedTooLong(int wait_msec);
143 
144 
145 signals:
146 
149  void signalWatingTooLong(int wait_msec);
150 
151 
152 //private:
153 protected:
154 
157  void bindSocket(QUdpSocket& UdpSocket) throw(std::runtime_error);
158 
168  bool waitForReady(QUdpSocket& UdpSocket, int timeout_msec);
169 
172  virtual void receivePacketRedundancy(QUdpSocket& UdpSocket,
173  int8_t* full_redundant_packet,
174  int full_redundant_packet_size,
175  int full_packet_size,
176  uint16_t& current_seq_num,
177  uint16_t& last_seq_num,
178  uint16_t& newer_seq_num);
179 
182  virtual void sendPacketRedundancy(QUdpSocket& UdpSocket,
183  QHostAddress& PeerAddress,
184  int8_t* full_redundant_packet,
185  int full_redundant_packet_size,
186  int full_packet_size);
187 
188 
189 private:
190 
191  int mBindPort;
192  int mPeerPort;
193  const runModeT mRunMode;
194 
195  QHostAddress mPeerAddress;
196 
197  int8_t* mAudioPacket;
198  int8_t* mFullPacket;
199 
200  unsigned int mUdpRedundancyFactor;
201  static QMutex sUdpMutex;
202 };
203 
204 #endif // __UDPDATAPROTOCOL_H__
virtual int sendPacket(QUdpSocket &UdpSocket, const QHostAddress &PeerAddress, const char *buf, const size_t n)
Sends a packet.
Definition: UdpDataProtocol.cpp:293
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:302
void setPeerAddress(const char *peerHostOrIP)
Set the Peer address to connect to.
Definition: UdpDataProtocol.cpp:93
UDP implementation of DataProtocol class.
Definition: UdpDataProtocol.h:66
virtual void run()
Implements the Thread Loop. To start the thread, call start() ( DO NOT CALL run() ) ...
Definition: UdpDataProtocol.cpp:315
void setPeerPort(int port)
Sets the peer port number.
Definition: UdpDataProtocol.h:130
UdpDataProtocol(JackTrip *jacktrip, const runModeT runmode, int bind_port, int peer_port, unsigned int udp_redundancy_factor=1)
The class constructor.
Definition: UdpDataProtocol.cpp:66
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78
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:495
void bindSocket(QUdpSocket &UdpSocket)
Binds the UDP socket to the available address and specified port.
Definition: UdpDataProtocol.cpp:126
Base class that defines the transmission protocol.
Definition: DataProtocol.h:92
virtual ~UdpDataProtocol()
The class destructor.
Definition: UdpDataProtocol.cpp:84
virtual int receivePacket(QUdpSocket &UdpSocket, char *buf, const size_t n)
Receives a packet. It blocks until a packet is received.
Definition: UdpDataProtocol.cpp:283
bool 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:457
runModeT
Enum to define class modes, SENDER or RECEIVER.
Definition: DataProtocol.h:107
void setBindPort(int port)
Sets the bind port number.
Definition: UdpDataProtocol.h:125
virtual void sendPacketRedundancy(QUdpSocket &UdpSocket, QHostAddress &PeerAddress, int8_t *full_redundant_packet, int full_redundant_packet_size, int full_packet_size)
Redundancy algorythm at the sender&#39;s end.
Definition: UdpDataProtocol.cpp:542
Main class to creates a SERVER (to listen) or a CLIENT (to connect to a listening server) to send aud...
Definition: JackTrip.h:67
void signalWatingTooLong(int wait_msec)
Signals when waiting every 10 milliseconds, with the total wait on wait_msec.
Definition: moc_UdpDataProtocol.cpp:137
quint16 uint16_t
Typedef for unsigned short. This type is guaranteed to be 16-bit.
Definition: jacktrip_types.h:71