MetaDataFilterEncoder Class Reference

MetaDataFilter applied to an encoder: filters out ID3v1 / ID3v2 metadata from the mp3 input stream before it is provided to the wrapped encoder. This is basically a pass-through for mp3 data with metadata skipped. More...

#include <MetaDataFilter.h>

Inheritance diagram for MetaDataFilterEncoder:

Public Member Functions
	MetaDataFilterEncoder (AudioEncoder &encoder)
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin () override
bool	begin (AudioInfo info) override
void	end () override
uint32_t	frameDurationUs () override
	Optional rtsp function: provide the frame duration in microseconds.
const char *	mime () override
	Provides the mime type of the encoded result.
	operator bool () override
uint16_t	samplesPerFrame () override
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo info) override
	Defines the sample rate, number of channels and bits per sample.
void	setOutput (Print &out_stream) override
	Default output assignment (encoders may override to store Print reference)
size_t	write (const uint8_t *data, size_t len) override

Protected Member Functions
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
MetaDataFilter	filter
AudioInfo	info
bool	is_initialized = false
AudioEncoder *	p_encoder = nullptr

Detailed Description

MetaDataFilter applied to an encoder: filters out ID3v1 / ID3v2 metadata from the mp3 input stream before it is provided to the wrapped encoder. This is basically a pass-through for mp3 data with metadata skipped.

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, BinaryContainerEncoder, and MP3ParserEncoder.

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 >.

begin() [1/2]

bool begin ( )

inlineoverridevirtual

Implements AudioWriter.

begin() [2/2]

bool begin ( AudioInfo  info )

inlineoverridevirtual

Reimplemented from AudioWriter.

end()

void end ( )

inlineoverridevirtual

Implements AudioWriter.

frameDurationUs()

uint32_t frameDurationUs ( )

inlineoverridevirtual

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented from AudioEncoder.

mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

samplesPerFrame()

uint16_t samplesPerFrame ( )

inlineoverridevirtual

Optional rtsp function: provide samples per the frame.

Reimplemented from AudioEncoder.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtual

Defines the sample rate, number of channels and bits per sample.

Reimplemented from AudioEncoder.

setOutput()

void setOutput ( Print &  out_stream )

inlineoverridevirtual

Default output assignment (encoders may override to store Print reference)

Reimplemented from AudioEncoder.

write()

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtual

Implements AudioWriter.

---

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

• src/AudioTools/CoreAudio/AudioMetaData/MetaDataFilter.h