satdump::ndsp::DSPBuffer Class Reference

DSP Buffer class. More...

#include <dsp_buffer.h>

Public Member Functions
template<typename T>
T *	getSamples ()
	Get sample pointer.
bool	isTerminator ()
	Checks if this buffer is a terminator. This covers BOTH propagating and normal terminator markers.
bool	terminatorShouldPropagate ()
	Checks if this buffer is a propagating terminator. If it is, a propagating terminator should be sent down to the next blocks as well!

Public Attributes
dsp_buffer_type_t	type = DSP_BUFFER_TYPE_INVALID
uint8_t	typesize = 0
uint32_t	max_size = 0
uint32_t	size = 0

Friends
class	DSPStream

Detailed Description

DSP Buffer class.

This is a simple helper class to make it easier to manage sample buffers used in blocks. It holds a pointer with raw samples, the size of said buffer as well as actual useful sample count.

Parameters

type	of the buffer
typesize	size of the type, (eg, float = 4 bytes)
max_size	size of the buffer, in number of elements. This is the size of the allocated buffer, NOT sample count!
size	number of actual samples

Member Function Documentation

getSamples()

template<typename T>

T * satdump::ndsp::DSPBuffer::getSamples ( )

inline

Get sample pointer.

Returns

sample pointer

isTerminator()

bool satdump::ndsp::DSPBuffer::isTerminator ( )

inline

Checks if this buffer is a terminator. This covers BOTH propagating and normal terminator markers.

Returns

true if terminator

terminatorShouldPropagate()

bool satdump::ndsp::DSPBuffer::terminatorShouldPropagate ( )

inline

Checks if this buffer is a propagating terminator. If it is, a propagating terminator should be sent down to the next blocks as well!

Returns

true if propagating

---

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

• src-core/dsp/base/dsp_buffer.h