TransformationReader< T > Class Template Reference

ConverterStream Helper class which implements the readBytes with the help of write. More...

#include <AudioIO.h>

Public Member Functions
void	begin (T *transform, Stream *source)
	setup of the TransformationReader class
void	end ()
size_t	readBytes (uint8_t *data, size_t len)
void	resizeReadBuffer (int size)
	Defines the read buffer size for individual reads.
void	resizeResultQueue (int size)
	Defines the queue size for result.
void	setResultQueueFactor (int factor)
	Defines the queue size dependent on the read size.

Protected Member Functions
void	restoreOutput (Print *out)
	restores the original output in the converter class
Print *	setupOutput ()

Protected Attributes
bool	active = false
Vector< uint8_t >	buffer {0}
Stream *	p_stream = nullptr
T *	p_transform = nullptr
QueueStream< uint8_t >	result_queue {result_queue_buffer}
RingBuffer< uint8_t >	result_queue_buffer {0}
int	result_queue_factor = 5

Detailed Description

template<class T>
class audio_tools::TransformationReader< T >

ConverterStream Helper class which implements the readBytes with the help of write.

Author

Phil Schatzmann

Copyright

GPLv3

Template Parameters

T	class name of the original transformer stream

Member Function Documentation

begin()

template<class T >

void begin ( T *  transform, Stream *  source  )

inline

setup of the TransformationReader class

Parameters

transform	The original transformer stream
source	The data source of the data to be converted the requested converted bytes

end()

template<class T >

void end ( )

inline

readBytes()

template<class T >

size_t readBytes ( uint8_t *  data, size_t  len  )

inline

resizeReadBuffer()

template<class T >

void resizeReadBuffer ( int  size )

inline

Defines the read buffer size for individual reads.

resizeResultQueue()

template<class T >

void resizeResultQueue ( int  size )

inline

Defines the queue size for result.

restoreOutput()

template<class T >

void restoreOutput ( Print *  out )

inlineprotected

restores the original output in the converter class

Parameters

out

setResultQueueFactor()

template<class T >

void setResultQueueFactor ( int  factor )

inline

Defines the queue size dependent on the read size.

setupOutput()

template<class T >

Print * setupOutput ( )

inlineprotected

Makes sure that the data is written to the array

Parameters

data

Returns

original output of the converter class

Member Data Documentation

active

template<class T >

bool active = false

protected

buffer

template<class T >

Vector<uint8_t> buffer {0}

protected

p_stream

template<class T >

Stream* p_stream = nullptr

protected

p_transform

template<class T >

T* p_transform = nullptr

protected

result_queue

template<class T >

QueueStream<uint8_t> result_queue {result_queue_buffer}

protected

result_queue_buffer

template<class T >

RingBuffer<uint8_t> result_queue_buffer {0}

protected

result_queue_factor

template<class T >

int result_queue_factor = 5

protected

---

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

• src/AudioTools/CoreAudio/AudioIO.h