FLACEncoder Class Reference

FLACEncoder. More...

#include <CodecFLAC.h>

Inheritance diagram for FLACEncoder:

Public Member Functions
	FLACEncoder (bool isOgg=false)
	Default Constructor.
	~FLACEncoder ()
	Destructor - calls end();.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual AudioInfo	audioInfoOut ()
virtual bool	begin (AudioInfo info)
virtual bool	begin () override
	starts the processing using the actual AudioInfo
bool	begin (Print &out)
	starts the processing
int	blockSize ()
int	compressionLevel ()
void	end () override
	stops the processing
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual int	frameSize ()
virtual int	frameSize ()
bool	isOgg ()
bool	isOpen ()
const char *	mime () override
	Provides "audio/pcm".
	operator bool () override
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
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.
virtual void	setAudioInfo (AudioInfo from) override
	We update the audio information which will be used in the begin method.
void	setBlockSize (int size)
void	setCompressionLevel (int level)
void	setOgg (bool isOgg)
void	setOutput (Print &out_stream) override
	Defines the output Stream.
virtual size_t	write (const uint8_t *data, size_t len) override
	Writes FLAC Packet.

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

Static Protected Member Functions
static FLAC__StreamEncoderWriteStatus	write_callback (const FLAC__StreamEncoder *encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void *client_data)

Protected Attributes
Vector< FLAC__int32 >	buffer
AudioInfo	cfg
int	flac_block_size = 512
int	flac_compression_level = 8
AudioInfo	info
bool	is_ogg = false
bool	is_open = false
FLAC__StreamEncoder *	p_encoder =nullptr
Print *	p_print = nullptr

Detailed Description

FLACEncoder.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

FLACEncoder()

FLACEncoder ( bool isOgg = false )

inline

Default Constructor.

~FLACEncoder()

~FLACEncoder ( )

inline

Destructor - calls end();.

Member Function Documentation

audioInfo() [1/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, BinaryContainerEncoder, CodecNOP, MP3EncoderShine, and MP3ParserEncoder.

audioInfo() [2/2]

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, CodecNOP, BinaryContainerEncoder, CodecNOP, MP3EncoderShine, and MP3ParserEncoder.

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.

begin() [1/3]

virtual bool begin ( AudioInfo info )

inlinevirtualinherited

Reimplemented in AudioDecoder, and AudioDecoder.

begin() [2/3]

virtual bool begin ( )

inlineoverridevirtual

starts the processing using the actual AudioInfo

Implements AudioWriter.

begin() [3/3]

bool begin ( Print & out )

inline

starts the processing

blockSize()

int blockSize ( )

inline

compressionLevel()

int compressionLevel ( )

inline

end()

void end ( )

inlineoverridevirtual

stops the processing

Implements AudioWriter.

frameDurationUs() [1/2]

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

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

frameDurationUs() [2/2]

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

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

frameSize() [1/2]

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, AMRNBEncoder, AMRWBEncoder, EncoderALAC, and MP3ParserEncoder.

frameSize() [2/2]

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, AMRNBEncoder, AMRWBEncoder, EncoderALAC, and MP3ParserEncoder.

isOgg()

bool isOgg ( )

inline

isOpen()

bool isOpen ( )

inline

mime()

const char * mime ( )

inlineoverridevirtual

Provides "audio/pcm".

Implements AudioEncoder.

operator bool()

operator bool ( )

inlineoverridevirtual

Implements AudioWriter.

samplesPerFrame() [1/2]

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

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

samplesPerFrame() [2/2]

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

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

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

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

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

setAudioInfo() [2/2]

virtual void setAudioInfo ( AudioInfo from )

inlineoverridevirtual

We update the audio information which will be used in the begin method.

setBlockSize()

void setBlockSize ( int size )

inline

setCompressionLevel()

void setCompressionLevel ( int level )

inline

setOgg()

void setOgg ( bool isOgg )

inline

setOutput()

void setOutput ( Print & out_stream )

inlineoverridevirtual

Defines the output Stream.

Reimplemented from AudioEncoder.

write()

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

inlineoverridevirtual

Writes FLAC Packet.

Implements AudioWriter.

write_callback()

FLAC__StreamEncoderWriteStatus write_callback ( const FLAC__StreamEncoder * encoder, const FLAC__byte buffer[], size_t bytes, uint32_t samples, uint32_t current_frame, void * client_data )

inlinestaticprotected

writeBlocking() [1/2]

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

inlineprotectedinherited

writeBlocking() [2/2]

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

inlineprotectedinherited

writeBuffer()

void writeBuffer ( int16_t * data, size_t samples )

inlineprotected

Member Data Documentation

buffer

Vector<FLAC__int32> buffer

protected

cfg

AudioInfo cfg

protected

flac_block_size

int flac_block_size = 512

protected

flac_compression_level

int flac_compression_level = 8

protected

info

AudioInfo info

protectedinherited

is_ogg

bool is_ogg = false

protected

is_open

bool is_open = false

protected

p_encoder

FLAC__StreamEncoder* p_encoder =nullptr

protected

p_print

Print* p_print = nullptr

protected

---

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

• src/AudioTools/AudioCodecs/CodecFLAC.h