RingBufferImpl Class Reference

#include <ringbufferimpl.h>

Public Types
enum	WaitingCondition { kAvailable , kSpace }

Public Member Functions
	RingBufferImpl (WaitingCondition c, int bufferSize)
	~RingBufferImpl ()
void	reset ()
void	waitAvailable (void)
void	waitSpace (void)
int	add (const Real *inputData, int inputSize)
int	get (Real *outputData, int outputSize)

Public Attributes
int	_bufferSize
int	_writeIndex
int	_readIndex
Atomic	_available
Atomic	_space
Real *	_buffer
Condition	condition
enum essentia::streaming::RingBufferImpl::WaitingCondition	_waitingCondition

Member Enumeration Documentation

WaitingCondition

enum WaitingCondition

Enumerator
kAvailable
kSpace

Constructor & Destructor Documentation

RingBufferImpl()

RingBufferImpl ( WaitingCondition  c, int  bufferSize  )

inline

References RingBufferImpl::_buffer, and RingBufferImpl::_bufferSize.

~RingBufferImpl()

~RingBufferImpl ( )

inline

References RingBufferImpl::_buffer.

Member Function Documentation

add()

int add ( const Real *  inputData, int  inputSize  )

inline

References RingBufferImpl::_available, RingBufferImpl::_buffer, RingBufferImpl::_bufferSize, RingBufferImpl::_space, RingBufferImpl::_waitingCondition, RingBufferImpl::_writeIndex, RingBufferImpl::condition, RingBufferImpl::kAvailable, Condition::lock(), Condition::signal(), and Condition::unlock().

get()

int get ( Real *  outputData, int  outputSize  )

inline

References RingBufferImpl::_available, RingBufferImpl::_buffer, RingBufferImpl::_bufferSize, RingBufferImpl::_readIndex, RingBufferImpl::_space, RingBufferImpl::_waitingCondition, RingBufferImpl::condition, RingBufferImpl::kSpace, Condition::lock(), Condition::signal(), and Condition::unlock().

reset()

void reset ( )

inline

References RingBufferImpl::_available, RingBufferImpl::_buffer, RingBufferImpl::_bufferSize, RingBufferImpl::_readIndex, RingBufferImpl::_space, and RingBufferImpl::_writeIndex.

waitAvailable()

void waitAvailable ( void  )

inline

References RingBufferImpl::_available, RingBufferImpl::_waitingCondition, RingBufferImpl::condition, RingBufferImpl::kAvailable, Condition::lock(), Condition::unlock(), and Condition::wait().

waitSpace()

void waitSpace ( void  )

inline

References RingBufferImpl::_space, RingBufferImpl::_waitingCondition, RingBufferImpl::condition, RingBufferImpl::kSpace, Condition::lock(), Condition::unlock(), and Condition::wait().

Member Data Documentation

_available

Atomic _available

Referenced by RingBufferImpl::add(), RingBufferImpl::get(), RingBufferImpl::reset(), and RingBufferImpl::waitAvailable().

_buffer

Real* _buffer

Referenced by RingBufferImpl::add(), RingBufferImpl::get(), RingBufferImpl::reset(), RingBufferImpl::RingBufferImpl(), and RingBufferImpl::~RingBufferImpl().

_bufferSize

int _bufferSize

Referenced by RingBufferImpl::add(), RingBufferImpl::get(), RingBufferImpl::reset(), and RingBufferImpl::RingBufferImpl().

_readIndex

int _readIndex

Referenced by RingBufferImpl::get(), and RingBufferImpl::reset().

_space

Atomic _space

Referenced by RingBufferImpl::add(), RingBufferImpl::get(), RingBufferImpl::reset(), and RingBufferImpl::waitSpace().

_waitingCondition

enum essentia::streaming::RingBufferImpl::WaitingCondition _waitingCondition

Referenced by RingBufferImpl::add(), RingBufferImpl::get(), RingBufferImpl::waitAvailable(), and RingBufferImpl::waitSpace().

_writeIndex

int _writeIndex

Referenced by RingBufferImpl::add(), and RingBufferImpl::reset().

condition

Condition condition

Referenced by RingBufferImpl::add(), RingBufferImpl::get(), RingBufferImpl::waitAvailable(), and RingBufferImpl::waitSpace().

---

The documentation for this class was generated from the following file:

• src/essentia/utils/ringbufferimpl.h