Creates a Hex Dump. More...

#include <CodecOpusOgg.h>

Inheritance diagram for HexDumpOutput:

Public Member Functions
	HexDumpOutput (int buffer_size=125, bool active=true)
	HexDumpOutput (int buffer_size=125, bool active=true)
	HexDumpOutput (Print &out, int buffer_size=125, bool active=true)
	Constructor.
	HexDumpOutput (Print &out, int buffer_size=125, bool active=true)
	Constructor.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual int	availableForWrite () override
virtual int	availableForWrite () override
virtual bool	begin (AudioInfo info)
bool	begin () override
bool	begin () override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
AudioInfo	defaultConfig (RxTxMode mode=TX_MODE)
AudioInfo	defaultConfig (RxTxMode mode=TX_MODE)
virtual void	end ()
virtual void	end ()
void	flush () override
void	flush () override
virtual bool	isDeletable ()
	If true we need to release the related memory in the destructor.
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.
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
virtual	operator bool ()
virtual	operator bool ()
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
virtual void	setAudioInfo (AudioInfo newInfo) override
	Defines the input AudioInfo.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active).
virtual size_t	write (uint8_t ch) override
virtual size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (const uint8_t *data, size_t len) override
virtual void	writeSilence (size_t len)
virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)
void	notifyAudioChange (AudioInfo info)

Protected Attributes
int	_timeout = 10
AudioInfo	cfg
bool	is_active = false
bool	is_notify_active = true
Vector< AudioInfoSupport * >	notify_vector
Print *	out_ptr = &Serial
int	pos = 0
SingleBuffer< uint8_t >	tmp { 8 }
int	tmpPos = 0

Detailed Description

Creates a Hex Dump.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ HexDumpOutput() [1/4]

HexDumpOutput	(	int	buffer_size = 125,
		bool	active = true )

inline

◆ HexDumpOutput() [2/4]

HexDumpOutput	(	Print &	out,
		int	buffer_size = 125,
		bool	active = true )

inline

Constructor.

◆ HexDumpOutput() [3/4]

HexDumpOutput	(	int	buffer_size = 125,
		bool	active = true )

inline

◆ HexDumpOutput() [4/4]

HexDumpOutput	(	Print &	out,
		int	buffer_size = 125,
		bool	active = true )

inline

Constructor.

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ audioInfo() [1/2]

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, EncodedAudioOutput, and EncodedAudioOutput.

◆ audioInfo() [2/2]

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, EncodedAudioOutput, and EncodedAudioOutput.

◆ audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

◆ audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

◆ availableForWrite() [1/2]

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, MemoryOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ availableForWrite() [2/2]

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, MemoryOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ begin() [1/3]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

Reimplemented in ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, and EncodedAudioOutput.

◆ begin() [2/3]

bool begin ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ begin() [3/3]

bool begin ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ defaultConfig() [1/2]

AudioInfo defaultConfig ( RxTxMode mode = TX_MODE )

inline

◆ defaultConfig() [2/2]

AudioInfo defaultConfig ( RxTxMode mode = TX_MODE )

inline

◆ end() [1/2]

virtual void end ( )

inlinevirtualinherited

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

◆ end() [2/2]

virtual void end ( )

inlinevirtualinherited

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

◆ flush() [1/2]

void flush ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ flush() [2/2]

void flush ( )

inlineoverridevirtual

Reimplemented from AudioOutput.

◆ isDeletable() [1/2]

virtual bool isDeletable ( )

inlinevirtualinherited

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

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, and AdapterPrintToAudioOutput.

◆ isDeletable() [2/2]

virtual bool isDeletable ( )

inlinevirtualinherited

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

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, and AdapterPrintToAudioOutput.

◆ isNotifyActive() [1/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isNotifyActive() [2/2]

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool() [1/2]

virtual operator bool ( )

inlinevirtualinherited

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

◆ operator bool() [2/2]

virtual operator bool ( )

inlinevirtualinherited

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

◆ removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

◆ removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

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

◆ setAudioInfo() [1/2]

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, and MultiOutput.

◆ setAudioInfo() [2/2]

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, and MultiOutput.

◆ setNotifyActive() [1/2]

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setNotifyActive() [2/2]

void setNotifyActive ( bool flag )

inlineinherited

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

◆ write() [1/3]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MultiOutput, MetaDataOutput, and MultiOutput.

◆ write() [2/3]

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

inlineoverridevirtual

Implements AudioOutput.

◆ write() [3/3]

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

inlineoverridevirtual

Implements AudioOutput.

◆ writeSilence() [1/2]

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

◆ writeSilence() [2/2]

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

◆ 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

Print * out_ptr = &Serial

protected

◆ pos

int pos = 0

protected

◆ tmp

SingleBuffer< uint8_t > tmp { 8 }

protectedinherited

◆ tmpPos

int tmpPos = 0

protectedinherited

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

src/AudioTools/AudioCodecs/CodecOpusOgg.h
src/AudioTools/AudioCodecs/CodecTSDemux.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HexDumpOutput() [1/4]

◆ HexDumpOutput() [2/4]

◆ HexDumpOutput() [3/4]

◆ HexDumpOutput() [4/4]

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

◆ addNotifyAudioChange() [2/2]

◆ audioInfo() [1/2]

◆ audioInfo() [2/2]

◆ audioInfoOut() [1/2]

◆ audioInfoOut() [2/2]

◆ availableForWrite() [1/2]

◆ availableForWrite() [2/2]

◆ begin() [1/3]

◆ begin() [2/3]

◆ begin() [3/3]

◆ clearNotifyAudioChange() [1/2]

◆ clearNotifyAudioChange() [2/2]

◆ defaultConfig() [1/2]

◆ defaultConfig() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ flush() [1/2]

◆ flush() [2/2]

◆ isDeletable() [1/2]

◆ isDeletable() [2/2]

◆ isNotifyActive() [1/2]

◆ isNotifyActive() [2/2]

◆ notifyAudioChange() [1/2]

◆ notifyAudioChange() [2/2]

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ removeNotifyAudioChange() [1/2]

◆ removeNotifyAudioChange() [2/2]

◆ setAudioInfo() [1/2]

◆ setAudioInfo() [2/2]

◆ setNotifyActive() [1/2]

◆ setNotifyActive() [2/2]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]

◆ writeSilence() [1/2]

◆ writeSilence() [2/2]

Member Data Documentation

◆ _timeout

◆ cfg

◆ is_active

◆ is_notify_active

◆ notify_vector

◆ out_ptr

◆ pos

◆ tmp

◆ tmpPos