JackTrip: src/RingBuffer.h Source File

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 //using namespace JackTripNamespace;
48
49
57 class RingBuffer
58 {
59 public:
60
65 RingBuffer(int SlotSize, int NumSlots);
66
69 virtual ~RingBuffer();
70
80 void insertSlotBlocking(const int8_t* ptrToSlot);
81
91 void readSlotBlocking(int8_t* ptrToReadSlot);
92
96 void insertSlotNonBlocking(const int8_t* ptrToSlot);
97
101 void readSlotNonBlocking(int8_t* ptrToReadSlot);
102
103
104 protected:
105
110 virtual void setUnderrunReadSlot(int8_t* ptrToReadSlot);
111
118 virtual void setMemoryInReadSlotWithLastReadSlot(int8_t* ptrToReadSlot);
119
120 private:
121
123 void underrunReset();
125 void overflowReset();
127 void debugDump() const;
128
129 const int mSlotSize;
130 const int mNumSlots;
131 const int mTotalSize;
132 int mReadPosition;
133 int mWritePosition;
134 int mFullSlots;
135 int8_t* mRingBuffer;
136 int8_t* mLastReadSlot;
137
138 // Thread Synchronization Private Members
139 QMutex mMutex;
140 QWaitCondition mBufferIsNotFull;
141 QWaitCondition mBufferIsNotEmpty;
142 };
143
144 #endif
jacktrip_types.h
RingBuffer::setMemoryInReadSlotWithLastReadSlot
virtual void setMemoryInReadSlotWithLastReadSlot(int8_t *ptrToReadSlot)
Uses the last read slot to set the memory in the Read Slot.
Definition: RingBuffer.cpp:211
RingBuffer::~RingBuffer
virtual ~RingBuffer()
The class destructor.
Definition: RingBuffer.cpp:93
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::insertSlotBlocking
void insertSlotBlocking(const int8_t *ptrToSlot)
Insert a slot into the RingBuffer from ptrToSlot. This method will block until there&#39;s space in the b...
Definition: RingBuffer.cpp:103
RingBuffer
Provides a ring-buffer (or circular-buffer) that can be written to and read from asynchronously (bloc...
Definition: RingBuffer.h:57
RingBuffer::readSlotNonBlocking
void readSlotNonBlocking(int8_t *ptrToReadSlot)
Same as readSlotBlocking but non-blocking (asynchronous)
Definition: RingBuffer.cpp:175
RingBuffer::RingBuffer
RingBuffer(int SlotSize, int NumSlots)
The class constructor.
Definition: RingBuffer.cpp:50
RingBuffer::insertSlotNonBlocking
void insertSlotNonBlocking(const int8_t *ptrToSlot)
Same as insertSlotBlocking but non-blocking (asynchronous)
Definition: RingBuffer.cpp:149
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:204
RingBuffer::readSlotBlocking
void readSlotBlocking(int8_t *ptrToReadSlot)
Read a slot from the RingBuffer into ptrToReadSlot. This method will block until there&#39;s space in the...
Definition: RingBuffer.cpp:125