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 
32 /**
33  * \file JitterBuffer.h
34  * \author Anton Runov
35  * \date June 2020
36  */
37 
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);
~JitterBuffer()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:
60     int mMaxLatency;
61     int mNumChannels;
62     int mAudioBitRes;
63     int mMinStepSize;
64     int mFPP;
65     int mSampleRate;
66     int mInSlotSize;
67     bool mActive;
68     uint32_t mBroadcastLatency;
69     uint32_t mBroadcastPosition;
70     double  mBroadcastPositionCorr;
71 
72     double mUnderrunIncTolerance;
73     double mCorrIncTolerance;
74     double mOverflowDecTolerance;
75     int    mOverflowDropStep;
76     uint32_t mLastCorrCounter;
77     int    mLastCorrDirection;
78     double mMinLevelThreshold;
lastCorrFactor()79     double lastCorrFactor() const {return 500.0 / std::max(500U, mLastCorrCounter);}
80 
81     int    mAutoQueue;
82     double mAutoQueueCorr;
83     double mAutoQFactor;
84     double mAutoQRate;
85     double mAutoQRateMin;
86     double mAutoQRateDecay;
87 };
88 
89 
90 #endif //__JITTERBUFFER_H__
91