Shared functionality of all buffers. More...

#include <CodecOpusOgg.h>

Public Member Functions
	BaseBuffer ()=default
	BaseBuffer ()=default
	BaseBuffer (const BaseBuffer &)=default
	BaseBuffer (const BaseBuffer &)=default
virtual	~BaseBuffer ()=default
virtual	~BaseBuffer ()=default
virtual T *	address ()=0
	returns the address of the start of the physical read buffer
virtual T *	address ()=0
	returns the address of the start of the physical read buffer
virtual int	available ()=0
	provides the number of entries that are available to read
virtual int	available ()=0
	provides the number of entries that are available to read
virtual int	availableForWrite ()=0
	provides the number of entries that are available to write
virtual int	availableForWrite ()=0
	provides the number of entries that are available to write
virtual int	bufferCountEmpty ()
	Provides the number of entries that are available to write: -1 does not apply.
virtual int	bufferCountEmpty ()
	Provides the number of entries that are available to write: -1 does not apply.
virtual int	bufferCountFilled ()
	Provides the number of entries that are available to read: -1 does not apply.
virtual int	bufferCountFilled ()
	Provides the number of entries that are available to read: -1 does not apply.
void	clear ()
	same as reset
void	clear ()
	same as reset
virtual int	clearArray (int len)
	Removes the next len entries.
virtual int	clearArray (int len)
	Removes the next len entries.
virtual void	flush ()
virtual void	flush ()
virtual float	freePercent ()
	Returns the free space of the buffer in %.
virtual float	freePercent ()
	Returns the free space of the buffer in %.
bool	isEmpty ()
bool	isEmpty ()
virtual bool	isFull ()
	checks if the buffer is full
virtual bool	isFull ()
	checks if the buffer is full
virtual float	levelPercent ()
	Returns the level of the buffer in %.
virtual float	levelPercent ()
	Returns the level of the buffer in %.
BaseBuffer &	operator= (const BaseBuffer &)=default
BaseBuffer &	operator= (const BaseBuffer &)=default
virtual bool	peek (T &result)=0
	peeks the actual entry from the buffer
virtual bool	peek (T &result)=0
	peeks the actual entry from the buffer
virtual bool	read (T &result)=0
	reads a single value
virtual bool	read (T &result)=0
	reads a single value
virtual int	readArray (T data[], int len)
	reads multiple values
virtual int	readArray (T data[], int len)
	reads multiple values
virtual void	reset ()=0
	clears the buffer
virtual void	reset ()=0
	clears the buffer
virtual bool	resize (size_t bytes)
	Resizes the buffer if supported: returns false if not supported.
virtual bool	resize (size_t bytes)
	Resizes the buffer if supported: returns false if not supported.
virtual bool	resize (size_t size, int count)
	Resize the buffer by indicating the size and count (allocated bytes = size * count).
virtual bool	resize (size_t size, int count)
	Resize the buffer by indicating the size and count (allocated bytes = size * count).
virtual size_t	size ()=0
virtual size_t	size ()=0
virtual bool	write (T data)=0
	write add an entry to the buffer
virtual bool	write (T data)=0
	write add an entry to the buffer
virtual int	writeArray (const T data[], int len)
	Fills the buffer data.
virtual int	writeArray (const T data[], int len)
	Fills the buffer data.
virtual int	writeArrayOverwrite (const T data[], int len)
	Fills the buffer data and overwrites the oldest data if the buffer is full.
virtual int	writeArrayOverwrite (const T data[], int len)
	Fills the buffer data and overwrites the oldest data if the buffer is full.

Detailed Description

template<typename T = uint8_t>
class audio_tools::audio_tools::BaseBuffer< T >

Shared functionality of all buffers.

Author: Phil Schatzmann

Copyright: GPLv3