MetaDataOutput Class Reference

ID3 and Icecast/Shoutcast metadata output support. Just write the audio data to an object of this class and receive the metadata via the callback. More...

#include <MetaData.h>

Inheritance diagram for MetaDataOutput:

Public Member Functions
	MetaDataOutput ()=default
	MetaDataOutput (MetaDataOutput const &)=delete
	~MetaDataOutput ()
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 ()
virtual int	availableForWrite () override
virtual bool	begin ()
virtual void	begin (AbstractURLStream &url)
	Starts the processing - iceMetaint is determined from the HttpRequest.
virtual bool	begin (AudioInfo info)
virtual void	begin (int iceMetaint=0)
	Starts the processing - if iceMetaint is defined we use icecast.
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
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 ()
MetaDataOutput &	operator= (MetaDataOutput const &)=delete
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	setCallback (void(*fn)(MetaDataType info, const char *str, int len))
	Defines the callback.
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
virtual size_t	write (const uint8_t *data, size_t len)
	Provide tha audio data to the API to parse for Meta Data.
virtual size_t	write (uint8_t c)
virtual void	writeSilence (size_t len)

Protected Member Functions
void	notifyAudioChange (AudioInfo info)

Protected Attributes
int	_timeout = 10
void(*	callback )(MetaDataType info, const char *str, int len) =nullptr
AudioInfo	cfg
bool	is_active = false
bool	is_notify_active = true
AbstractMetaData *	meta =nullptr
Vector< AudioInfoSupport * >	notify_vector
SingleBuffer< uint8_t >	tmp {MAX_SINGLE_CHARS}
int	tmpPos = 0

Detailed Description

ID3 and Icecast/Shoutcast metadata output support. Just write the audio data to an object of this class and receive the metadata via the callback.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MetaDataOutput() [1/2]

MetaDataOutput ( )

default

MetaDataOutput() [2/2]

MetaDataOutput ( MetaDataOutput const &  )

delete

~MetaDataOutput()

~MetaDataOutput ( )

inline

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()

virtual int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from Print.

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

begin() [1/4]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in OSCContainerEncoder::OSCOutput, AudioOutputWithCallback, AudioServerEx, RTSPOutput< Platform >, PitchShiftOutput< T, BufferT >, PWMAudioOutput, RTTTLOutput< T >, EncodedAudioOutput, OggContainerOutput, FFTEffect, FFTPitchShift, R2ROutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, MetaDataFilter, CsvOutput< T >, HexDumpOutput, MemoryOutput, and RTTTLOutput< T >.

begin() [2/4]

virtual void begin ( AbstractURLStream &  url )

inlinevirtual

Starts the processing - iceMetaint is determined from the HttpRequest.

begin() [3/4]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AudioESP32ULP, RTSPOutput< Platform >, RTTTLOutput< T >, ChannelsSelectOutput, CsvOutput< T >, and EncodedAudioOutput.

begin() [4/4]

virtual void begin ( int  iceMetaint = 0 )

inlinevirtual

Starts the processing - if iceMetaint is defined we use icecast.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

end()

virtual void end ( )

inlinevirtual

Reimplemented from AudioOutput.

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.

operator=()

MetaDataOutput & operator= ( MetaDataOutput const &  )

delete

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()

virtual void setAudioInfo ( AudioInfo  info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

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

setCallback()

virtual void setCallback ( void(*)(MetaDataType info, const char *str, int len)  fn )

inlinevirtual

Defines the callback.

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

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

write() [1/2]

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

inlinevirtual

Provide tha audio data to the API to parse for Meta Data.

Implements AudioOutput.

write() [2/2]

virtual size_t write ( uint8_t  c )

inlinevirtual

Reimplemented from AudioOutput.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes n 0 values (= silence)

Parameters

len

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

callback

void(* callback) (MetaDataType info, const char *str, int len) =nullptr

protected

cfg

AudioInfo cfg

protectedinherited

is_active

bool is_active = false

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

meta

AbstractMetaData* meta =nullptr

protected

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

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/AudioMetaData/MetaData.h