Stream Wrapper which can be used to print the values as readable ASCII to the screen to be analyzed in the Serial Plotter The frames are separated by a new line. The channels in one frame are separated by a ,. More...

#include <AudioOutput.h>

Inheritance diagram for CsvOutput< T >:

Public Member Functions
	CsvOutput (int buffer_size=DEFAULT_BUFFER_SIZE, bool active=true)

	CsvOutput (Print &out, int channels=2, int buffer_size=DEFAULT_BUFFER_SIZE, bool active=true)
	Constructor.

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

int	availableForWrite () override

bool	begin () override
	(Re)start (e.g. if channels is set in constructor)

bool	begin (AudioInfo info) override
	Starts the processing with the defined number of channels.

bool	begin (int channels)
	Starts the processing with the defined number of channels.

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

AudioInfo	defaultConfig ()
	Provides the default configuration.

AudioInfo	defaultConfig (RxTxMode mode)

const char *	delimiter ()
	Provides the current column delimiter.

virtual void	end ()

virtual void	flush ()

virtual bool	isDeletable ()
	If true we need to release the related memory in the destructor.

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual	operator bool ()

virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.

virtual void	setAudioInfo (AudioInfo info) override
	defines the number of channels

void	setDelimiter (const char *del)
	Defines an alternative (column) delimiter. The default is ,.

void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

virtual size_t	write (const uint8_t *data, size_t len) override
	Writes the data - formatted as CSV - to the output stream.

virtual size_t	write (uint8_t ch) override

virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)

void	writeFrames (T *data_ptr, int frameCount)

Protected Attributes
int	_timeout = 10

AudioInfo	cfg

int	channel = 0

T *	data_ptr

const char *	delimiter_str = ","

bool	is_active = false

bool	is_notify_active = true

Vector< AudioInfoSupport * >	notify_vector

Print *	out_ptr = &Serial

SingleBuffer< uint8_t >	tmp {MAX_SINGLE_CHARS}

int	tmpPos = 0

Detailed Description

template<typename T = int16_t>
class audio_tools::CsvOutput< T >

Stream Wrapper which can be used to print the values as readable ASCII to the screen to be analyzed in the Serial Plotter The frames are separated by a new line. The channels in one frame are separated by a ,.

Template Parameters

T

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ CsvOutput() [1/2]

template<typename T = int16_t>

CsvOutput	(	int	buffer_size = `DEFAULT_BUFFER_SIZE`,
		bool	active = `true`
	)

inline

◆ CsvOutput() [2/2]

template<typename T = int16_t>

CsvOutput	(	Print &	out,
		int	channels = `2`,
		int	buffer_size = `DEFAULT_BUFFER_SIZE`,
		bool	active = `true`
	)

inline

Constructor.

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterPrintToAudioOutput, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ availableForWrite()

template<typename T = int16_t>

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ begin() [1/3]

template<typename T = int16_t>

bool begin ( )

inlineoverridevirtual

(Re)start (e.g. if channels is set in constructor)

Reimplemented from AudioOutput.

◆ begin() [2/3]

template<typename T = int16_t>

bool begin ( AudioInfo info )

inlineoverridevirtual

Starts the processing with the defined number of channels.

Reimplemented from AudioOutput.

◆ begin() [3/3]

template<typename T = int16_t>

bool begin ( int channels )

inline

Starts the processing with the defined number of channels.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ defaultConfig() [1/2]

template<typename T = int16_t>

AudioInfo defaultConfig ( )

inline

Provides the default configuration.

◆ defaultConfig() [2/2]

template<typename T = int16_t>

AudioInfo defaultConfig ( RxTxMode mode )

inline

◆ delimiter()

template<typename T = int16_t>

const char * delimiter ( )

inline

Provides the current column delimiter.

◆ end()

virtual void end ( )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, AudioServerEx, AudioSyncWriter, RTSPOutput< Platform >, SPIAudioMaster, PitchShiftOutput< T, BufferT >, MetaDataOutput, EncodedAudioOutput, OggContainerOutput, AdapterAudioStreamToAudioOutput, MetaDataFilter, and PWMAudioOutput.

◆ flush()

virtual void flush ( )

inlinevirtualinherited

Reimplemented from Print.

Reimplemented in MultiOutput, and HexDumpOutput.

◆ isDeletable()

virtual bool isDeletable ( )

inlinevirtualinherited

If true we need to release the related memory in the destructor.

Reimplemented in AdapterPrintToAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in RTSPOutput< Platform >, EncodedAudioOutput, and AdapterAudioStreamToAudioOutput.

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setAudioInfo()

template<typename T = int16_t>

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtual

defines the number of channels

Reimplemented from AudioOutput.

◆ setDelimiter()

template<typename T = int16_t>

void setDelimiter ( const char * del )

inline

Defines an alternative (column) delimiter. The default is ,.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

◆ write() [1/2]

template<typename T = int16_t>

virtual size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Writes the data - formatted as CSV - to the output stream.

Implements AudioOutput.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MetaDataOutput, and MultiOutput.

◆ writeFrames()

template<typename T = int16_t>

void writeFrames	(	T *	data_ptr,
		int	frameCount
	)

inlineprotected

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ cfg

AudioInfo cfg

protectedinherited

◆ channel

template<typename T = int16_t>

int channel = 0

protected

◆ data_ptr

template<typename T = int16_t>

T* data_ptr

protected

◆ delimiter_str

template<typename T = int16_t>

const char* delimiter_str = ","

protected

◆ is_active

bool is_active = false

protectedinherited

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ out_ptr

template<typename T = int16_t>

Print* out_ptr = &Serial

protected

◆ tmp

SingleBuffer<uint8_t> tmp {MAX_SINGLE_CHARS}

protectedinherited

◆ tmpPos

int tmpPos = 0

protectedinherited

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

src/AudioTools/CoreAudio/AudioOutput.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CsvOutput() [1/2]

◆ CsvOutput() [2/2]

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ availableForWrite()

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ clearNotifyAudioChange()

◆ defaultConfig() [1/2]

◆ defaultConfig() [2/2]

◆ delimiter()

◆ end()

◆ flush()

◆ isDeletable()

◆ isNotifyActive()

◆ notifyAudioChange()

◆ operator bool()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setDelimiter()

◆ setNotifyActive()

◆ write() [1/2]

◆ write() [2/2]

◆ writeFrames()

◆ writeSilence()

Member Data Documentation

◆ _timeout

◆ cfg

◆ channel

◆ data_ptr

◆ delimiter_str

◆ is_active

◆ is_notify_active

◆ notify_vector

◆ out_ptr

◆ tmp

◆ tmpPos