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  void insertSlotNonBlocking(const int8_t* ptrToSlot);
99 
103  void readSlotNonBlocking(int8_t* ptrToReadSlot);
104 
105  struct IOStat {
108  };
109  virtual bool getStats(IOStat* stat, bool reset);
110 
111 protected:
112 
117  virtual void setUnderrunReadSlot(int8_t* ptrToReadSlot);
118 
125  virtual void setMemoryInReadSlotWithLastReadSlot(int8_t* ptrToReadSlot);
126 
127 private:
128 
130  void underrunReset();
132  void overflowReset();
134  void debugDump() const;
135 
136  const int mSlotSize;
137  const int mNumSlots;
138  const int mTotalSize;
139  int mReadPosition;
140  int mWritePosition;
141  int mFullSlots;
142  int8_t* mRingBuffer;
143  int8_t* mLastReadSlot;
144 
145  // Thread Synchronization Private Members
146  QMutex mMutex;
147  QWaitCondition mBufferIsNotFull;
148  QWaitCondition mBufferIsNotEmpty;
149  std::atomic<uint32_t> mUnderruns;
150  std::atomic<uint32_t> mOverflows;
151 };
152 
153 #endif
RingBuffer::IOStat::overflows
uint32_t overflows
Definition: RingBuffer.h:107
RingBuffer::IOStat
Definition: RingBuffer.h:105
RingBuffer::setUnderrunReadSlot
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:206
RingBuffer::readSlotBlocking
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:127
int8_t
qint8 int8_t
Typedef for unsigned long long int. This type is guaranteed to be 64-bit.
Definition: jacktrip_types.h:78
RingBuffer::getStats
virtual bool getStats(IOStat *stat, bool reset)
Definition: RingBuffer.cpp:257
RingBuffer::IOStat::underruns
uint32_t underruns
Definition: RingBuffer.h:106
RingBuffer::setMemoryInReadSlotWithLastReadSlot
virtual void setMemoryInReadSlotWithLastReadSlot(int8_t *ptrToReadSlot)
Uses the last read slot to set the memory in the Read Slot.
Definition: RingBuffer.cpp:213
RingBuffer::insertSlotBlocking
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:105
uint32_t
quint32 uint32_t
Typedef for unsigned int. This type is guaranteed to be 32-bit.
Definition: jacktrip_types.h:73
RingBuffer::readSlotNonBlocking
void readSlotNonBlocking(int8_t *ptrToReadSlot)
Same as readSlotBlocking but non-blocking (asynchronous)
Definition: RingBuffer.cpp:177
RingBuffer::RingBuffer
RingBuffer(int SlotSize, int NumSlots)
The class constructor.
Definition: RingBuffer.cpp:50
RingBuffer::~RingBuffer
virtual ~RingBuffer()
The class destructor.
Definition: RingBuffer.cpp:95
RingBuffer::insertSlotNonBlocking
void insertSlotNonBlocking(const int8_t *ptrToSlot)
Same as insertSlotBlocking but non-blocking (asynchronous)
Definition: RingBuffer.cpp:151
RingBuffer
Provides a ring-buffer (or circular-buffer) that can be written to and read from asynchronously (bloc...
Definition: RingBuffer.h:60
jacktrip_types.h