JackTrip
RingBuffer.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 __RINGBUFFER_H__
39 #define __RINGBUFFER_H__
40 
41 #include <QWaitCondition>
42 #include <QMutex>
43 #include <QMutexLocker>
44 
45 #include "jacktrip_types.h"
46 
47 #include <atomic>
48 
49 //using namespace JackTripNamespace;
50 
51 
60 {
61 public:
62 
67  RingBuffer(int SlotSize, int NumSlots);
68 
71  virtual ~RingBuffer();
72 
82  void insertSlotBlocking(const int8_t* ptrToSlot);
83 
93  void readSlotBlocking(int8_t* ptrToReadSlot);
94 
98  virtual bool insertSlotNonBlocking(const int8_t* ptrToSlot, int len, int lostLen);
99 
103  virtual void readSlotNonBlocking(int8_t* ptrToReadSlot);
104  virtual void readBroadcastSlot(int8_t* ptrToReadSlot);
105 
106  struct IOStat {
118 
121  };
122  virtual bool getStats(IOStat* stat, bool reset);
123 
124 protected:
125 
130  virtual void setUnderrunReadSlot(int8_t* ptrToReadSlot);
131 
138  virtual void setMemoryInReadSlotWithLastReadSlot(int8_t* ptrToReadSlot);
139 
141  void underrunReset();
143  void overflowReset();
145  void debugDump() const;
146  void updateReadStats();
147 
148  /*const*/ int mSlotSize;
149  /*const*/ int mNumSlots;
150  /*const*/ int mTotalSize;
156 
157  // Thread Synchronization Private Members
158  QMutex mMutex;
159  QWaitCondition mBufferIsNotFull;
160  QWaitCondition mBufferIsNotEmpty;
161 
162  // IO stat
167  double mLevelCur;
170 
175 
176  // temp counters for reads
180 
181  // broadcast counters
184 };
185 
186 #endif
Provides a ring-buffer (or circular-buffer) that can be written to and read from asynchronously (bloc...
Definition: RingBuffer.h:60
uint32_t mBufIncCompensate
Definition: RingBuffer.h:174
double mLevelCur
Definition: RingBuffer.h:167
double mLevelDownRate
Definition: RingBuffer.h:168
uint32_t mOverflows
Definition: RingBuffer.h:165
int mNumSlots
Number of Slots.
Definition: RingBuffer.h:149
virtual ~RingBuffer()
The class destructor.
Definition: RingBuffer.cpp:112
void debugDump() const
Helper method to debug, prints member variables to terminal.
Definition: RingBuffer.cpp:299
uint32_t mReadPosition
Read Positions in the RingBuffer (Tail)
Definition: RingBuffer.h:151
int32_t mLevel
Definition: RingBuffer.h:169
virtual void readBroadcastSlot(int8_t *ptrToReadSlot)
Definition: RingBuffer.cpp:247
virtual void readSlotNonBlocking(int8_t *ptrToReadSlot)
Same as readSlotBlocking but non-blocking (asynchronous)
Definition: RingBuffer.cpp:211
uint32_t mBufDecOverflow
Definition: RingBuffer.h:171
int8_t * mRingBuffer
8-bit array of data (1-byte)
Definition: RingBuffer.h:154
int32_t mBroadcastSkew
Definition: RingBuffer.h:182
RingBuffer(int SlotSize, int NumSlots)
The class constructor.
Definition: RingBuffer.cpp:52
virtual bool insertSlotNonBlocking(const int8_t *ptrToSlot, int len, int lostLen)
Same as insertSlotBlocking but non-blocking (asynchronous)
Definition: RingBuffer.cpp:173
void updateReadStats()
Definition: RingBuffer.cpp:342
int32_t mBroadcastDelta
Definition: RingBuffer.h:183
int mTotalSize
Total size of the mRingBuffer = mSlotSize*mNumSlotss.
Definition: RingBuffer.h:150
QWaitCondition mBufferIsNotFull
Buffer not full condition to monitor threads.
Definition: RingBuffer.h:159
uint32_t mUnderrunsNew
Definition: RingBuffer.h:178
void insertSlotBlocking(const int8_t *ptrToSlot)
Insert a slot into the RingBuffer from ptrToSlot. This method will block until there's space in the b...
Definition: RingBuffer.cpp:122
void readSlotBlocking(int8_t *ptrToReadSlot)
Read a slot from the RingBuffer into ptrToReadSlot. This method will block until there's space in the...
Definition: RingBuffer.cpp:145
int mSlotSize
The size of one slot in byes.
Definition: RingBuffer.h:148
virtual bool getStats(IOStat *stat, bool reset)
Definition: RingBuffer.cpp:308
uint32_t mReadsNew
Definition: RingBuffer.h:177
void underrunReset()
Resets the ring buffer for reads under-runs non-blocking.
Definition: RingBuffer.cpp:271
uint32_t mBufIncUnderrun
Definition: RingBuffer.h:173
virtual void setMemoryInReadSlotWithLastReadSlot(int8_t *ptrToReadSlot)
Uses the last read slot to set the memory in the Read Slot.
Definition: RingBuffer.cpp:261
uint32_t mWritePosition
Write Position in the RingBuffer (Head)
Definition: RingBuffer.h:152
int mFullSlots
Number of used (full) slots, in slot-size.
Definition: RingBuffer.h:153
int32_t mSkewRaw
Definition: RingBuffer.h:166
void overflowReset()
Resets the ring buffer for writes over-flows non-blocking.
Definition: RingBuffer.cpp:285
uint32_t mUnderruns
Definition: RingBuffer.h:164
int32_t mSkew0
Definition: RingBuffer.h:179
QWaitCondition mBufferIsNotEmpty
Buffer not empty condition to monitor threads.
Definition: RingBuffer.h:160
uint32_t mBufDecPktLoss
Definition: RingBuffer.h:172
virtual void setUnderrunReadSlot(int8_t *ptrToReadSlot)
Sets the memory in the Read Slot when uderrun occurs. By default, this sets it to 0....
Definition: RingBuffer.cpp:254
QMutex mMutex
Mutex to protect read and write operations.
Definition: RingBuffer.h:158
int8_t * mLastReadSlot
Last slot read.
Definition: RingBuffer.h:155
int mStatUnit
Definition: RingBuffer.h:163
qint32 int32_t
Typedef for signed int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:82
quint32 uint32_t
Typedef for unsigned int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:73
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78
Definition: RingBuffer.h:106
uint32_t overflows
Definition: RingBuffer.h:108
int32_t skew_raw
Definition: RingBuffer.h:110
uint32_t buf_inc_compensate
Definition: RingBuffer.h:115
int32_t skew
Definition: RingBuffer.h:109
int32_t broadcast_delta
Definition: RingBuffer.h:117
int32_t autoq_corr
Definition: RingBuffer.h:119
uint32_t buf_dec_pktloss
Definition: RingBuffer.h:113
uint32_t underruns
Definition: RingBuffer.h:107
uint32_t buf_inc_underrun
Definition: RingBuffer.h:114
int32_t broadcast_skew
Definition: RingBuffer.h:116
int32_t autoq_rate
Definition: RingBuffer.h:120
uint32_t buf_dec_overflows
Definition: RingBuffer.h:112
int32_t level
Definition: RingBuffer.h:111