JackTrip
JitterBuffer.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) 2020 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 __JITTERBUFFER_H__
39 #define __JITTERBUFFER_H__
40 
41 #include "RingBuffer.h"
42 
43 class JitterBuffer : public RingBuffer
44 {
45 public:
46  JitterBuffer(int buf_samples, int qlen, int sample_rate, int strategy,
47  int bcast_qlen, int channels, int bit_res);
48  virtual ~JitterBuffer() {}
49 
50  virtual bool insertSlotNonBlocking(const int8_t* ptrToSlot, int len, int lostLen);
51  virtual void readSlotNonBlocking(int8_t* ptrToReadSlot);
52  virtual void readBroadcastSlot(int8_t* ptrToReadSlot);
53 
54  virtual bool getStats(IOStat* stat, bool reset);
55 
56 protected:
57  void processPacketLoss(int lostLen);
58 
59 protected:
64  int mFPP;
67  bool mActive;
71 
79  double lastCorrFactor() const {return 500.0 / std::max(500U, mLastCorrCounter);}
80 
83  double mAutoQFactor;
84  double mAutoQRate;
85  double mAutoQRateMin;
87 };
88 
89 
90 #endif //__JITTERBUFFER_H__
JitterBuffer::mAutoQRateMin
double mAutoQRateMin
Definition: JitterBuffer.h:85
int8_t
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78
JitterBuffer::mNumChannels
int mNumChannels
Definition: JitterBuffer.h:61
JitterBuffer::mOverflowDecTolerance
double mOverflowDecTolerance
Definition: JitterBuffer.h:74
JitterBuffer::mBroadcastPositionCorr
double mBroadcastPositionCorr
Definition: JitterBuffer.h:70
JitterBuffer::mOverflowDropStep
int mOverflowDropStep
Definition: JitterBuffer.h:75
JitterBuffer::readSlotNonBlocking
virtual void readSlotNonBlocking(int8_t *ptrToReadSlot)
Same as readSlotBlocking but non-blocking (asynchronous)
Definition: JitterBuffer.cpp:193
JitterBuffer::insertSlotNonBlocking
virtual bool insertSlotNonBlocking(const int8_t *ptrToSlot, int len, int lostLen)
Same as insertSlotBlocking but non-blocking (asynchronous)
Definition: JitterBuffer.cpp:121
JitterBuffer::mAutoQFactor
double mAutoQFactor
Definition: JitterBuffer.h:83
JitterBuffer::~JitterBuffer
virtual ~JitterBuffer()
Definition: JitterBuffer.h:48
JitterBuffer::mSampleRate
int mSampleRate
Definition: JitterBuffer.h:65
JitterBuffer::lastCorrFactor
double lastCorrFactor() const
Definition: JitterBuffer.h:79
JitterBuffer::processPacketLoss
void processPacketLoss(int lostLen)
Definition: JitterBuffer.cpp:314
JitterBuffer::mBroadcastLatency
uint32_t mBroadcastLatency
Definition: JitterBuffer.h:68
JitterBuffer
Definition: JitterBuffer.h:44
JitterBuffer::mCorrIncTolerance
double mCorrIncTolerance
Definition: JitterBuffer.h:73
JitterBuffer::JitterBuffer
JitterBuffer(int buf_samples, int qlen, int sample_rate, int strategy, int bcast_qlen, int channels, int bit_res)
Definition: JitterBuffer.cpp:51
JitterBuffer::mLastCorrDirection
int mLastCorrDirection
Definition: JitterBuffer.h:77
uint32_t
quint32 uint32_t
Typedef for unsigned int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:73
JitterBuffer::mActive
bool mActive
Definition: JitterBuffer.h:67
JitterBuffer::mMinLevelThreshold
double mMinLevelThreshold
Definition: JitterBuffer.h:78
JitterBuffer::mInSlotSize
int mInSlotSize
Definition: JitterBuffer.h:66
JitterBuffer::mAutoQueue
int mAutoQueue
Definition: JitterBuffer.h:81
JitterBuffer::mBroadcastPosition
uint32_t mBroadcastPosition
Definition: JitterBuffer.h:69
JitterBuffer::mMinStepSize
int mMinStepSize
Definition: JitterBuffer.h:63
JitterBuffer::mMaxLatency
int mMaxLatency
Definition: JitterBuffer.h:60
JitterBuffer::getStats
virtual bool getStats(IOStat *stat, bool reset)
Definition: JitterBuffer.cpp:357
RingBuffer
Provides a ring-buffer (or circular-buffer) that can be written to and read from asynchronously (bloc...
Definition: RingBuffer.h:60
JitterBuffer::mAutoQRateDecay
double mAutoQRateDecay
Definition: JitterBuffer.h:86
JitterBuffer::mFPP
int mFPP
Definition: JitterBuffer.h:64
JitterBuffer::mAutoQueueCorr
double mAutoQueueCorr
Definition: JitterBuffer.h:82
JitterBuffer::mAutoQRate
double mAutoQRate
Definition: JitterBuffer.h:84
JitterBuffer::mLastCorrCounter
uint32_t mLastCorrCounter
Definition: JitterBuffer.h:76
RingBuffer.h
JitterBuffer::readBroadcastSlot
virtual void readBroadcastSlot(int8_t *ptrToReadSlot)
Definition: JitterBuffer.cpp:248
JitterBuffer::mAudioBitRes
int mAudioBitRes
Definition: JitterBuffer.h:62
JitterBuffer::mUnderrunIncTolerance
double mUnderrunIncTolerance
Definition: JitterBuffer.h:72