EncoderBase64 Class Reference

EncoderBase64s - Encodes the input data into a Base64 string. By default each audio frame is followed by a new line, so that we can easily resynchronize the reading of a data stream. The generation of the new line can be configured with the setNewLine() method. More...

#include <CodecBase64.h>

Inheritance diagram for EncoderBase64:

Public Member Functions
	EncoderBase64 ()
	EncoderBase64 (Print &out)
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual bool	begin () override
	starts the processing using the actual RAWAudioInfo
virtual bool	begin (AudioInfo info)
void	end () override
	stops the processing
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual int	frameSize ()
bool	isOpen ()
const char *	mime () override
	Provides "text/base64".
	operator bool () override
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo from) override
	Defines the sample rate, number of channels and bits per sample.
void	setNewLine (Base46Logic flag)
	We add a new line after each write.
void	setOutput (Print &out_buffeream) override
	Defines the output Stream.
virtual size_t	write (const uint8_t *data, size_t len) override
	Writes PCM data to be encoded as RAW.

Protected Member Functions
void	encodeLine (const uint8_t *data, size_t input_length)
void	flush ()
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
int	frame_size
AudioInfo	info
bool	is_open
Base46Logic	newline_logic = CRforFrame
Print *	p_print = nullptr
Vector< uint8_t >	ret

Detailed Description

EncoderBase64s - Encodes the input data into a Base64 string. By default each audio frame is followed by a new line, so that we can easily resynchronize the reading of a data stream. The generation of the new line can be configured with the setNewLine() method.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

EncoderBase64() [1/2]

EncoderBase64 ( )

inline

EncoderBase64() [2/2]

EncoderBase64 ( Print &  out )

inline

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, MP3EncoderShine, 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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

begin() [1/2]

virtual bool begin ( )

inlineoverridevirtual

starts the processing using the actual RAWAudioInfo

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in OpusOggEncoder, OggContainerEncoder, DecoderBasic, AudioDecoder, AACEncoderFDK, AACEncoderVO, OggContainerDecoder, and MetaDataFilterEncoder.

encodeLine()

void encodeLine ( const uint8_t *  data, size_t  input_length  )

inlineprotected

end()

void end ( )

inlineoverridevirtual

stops the processing

Implements AudioWriter.

flush()

void flush ( )

inlineprotected

frameDurationUs()

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, MP3EncoderShine, OpusOggEncoder, MP3ParserEncoder, and MetaDataFilterEncoder.

frameSize()

virtual int frameSize ( )

inlinevirtualinherited

Optional rtsp function: provide the encoded size (in bytes) of one frame, once known (e.g. after the encoder has seen real data). Lets an RTSPFormat size its RTP fragments to match one frame instead of a fixed guess, so throughput actually tracks frameDurationUs() - a fragment size covering several frames' worth of bytes sent at one-frame timing overruns real-time bandwidth and, over UDP (no flow control), causes packet loss. Returns 0 if not yet known/not applicable (fixed-frame-size codecs have no need to override this).

Reimplemented in ADPCMEncoder, EncoderALAC, AMRNBEncoder, AMRWBEncoder, and MP3ParserEncoder.

isOpen()

bool isOpen ( )

inline

mime()

const char * mime ( )

inlineoverridevirtual

Provides "text/base64".

Implements AudioEncoder.

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

samplesPerFrame()

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in OpusAudioEncoder, OpusMultiStreamAudioEncoder, MP3EncoderShine, MP3ParserEncoder, and MetaDataFilterEncoder.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

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

Implements AudioWriter.

Reimplemented in MP3EncoderLAME, EncoderBasic, CodecChain, DSFEncoder, FLACEncoder, MP3EncoderShine, OpusAudioEncoder, OpusMultiStreamAudioEncoder, WAVEncoder, CodecNOP, G7xxEncoder, G729Encoder, BinaryContainerEncoder, OggContainerEncoder, OSCContainerEncoder, H264RtpEncoder, JPEGRtpEncoder, and MetaDataFilterEncoder.

setNewLine()

void setNewLine ( Base46Logic  flag )

inline

We add a new line after each write.

setOutput()

void setOutput ( Print &  out_buffeream )

inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioEncoder.

write()

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

inlineoverridevirtual

Writes PCM data to be encoded as RAW.

Implements AudioWriter.

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

frame_size

int frame_size

protected

info

AudioInfo info

protected

is_open

bool is_open

protected

newline_logic

Base46Logic newline_logic = CRforFrame

protected

p_print

Print* p_print = nullptr

protected

ret

Vector<uint8_t> ret

protected

---

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

• src/AudioTools/AudioCodecs/CodecBase64.h