LC3Encoder Class Reference

Encoder for LC3 - Depends on https://github.com/pschatzmann/codec-lc3. More...

#include <CodecLC3.h>

Inheritance diagram for LC3Encoder:

Public Member Functions
	LC3Encoder (int dt_us=7500, uint16_t outputByteCount=40)
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin ()
virtual bool	begin (AudioInfo info)
virtual void	end ()
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
virtual int	frameSize ()
virtual const char *	mime ()
	Provides the mime type of the encoded result.
	operator bool ()
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	setOutput (Print &out_stream)
	Default output assignment (encoders may override to store Print reference)
virtual size_t	write (const uint8_t *data, size_t len)

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

Protected Attributes
bool	active = false
unsigned	dt_us = 1000
AudioInfo	info
Vector< uint8_t >	input_buffer
int	input_pos = 0
lc3_encoder_t	lc3_encoder = nullptr
Vector< uint8_t >	lc3_encoder_memory
uint16_t	num_frames
Vector< uint8_t >	output_buffer
uint16_t	output_byte_count = 20
Print *	p_print = nullptr
lc3_pcm_format	pcm_format

Detailed Description

Encoder for LC3 - Depends on https://github.com/pschatzmann/codec-lc3.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

LC3Encoder()

LC3Encoder ( int  dt_us = 7500, uint16_t  outputByteCount = 40  )

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]

bool begin ( )

inlinevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

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

checkValues()

bool checkValues ( )

inlineprotected

end()

virtual void end ( )

inlinevirtual

Implements AudioWriter.

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.

mime()

virtual const char * mime ( )

inlinevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

operator bool ( )

inlinevirtual

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.

setOutput()

virtual void setOutput ( Print &  out_stream )

inlinevirtual

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

Reimplemented from AudioEncoder.

write()

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

inlinevirtual

Implements AudioWriter.

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

active

bool active = false

protected

dt_us

unsigned dt_us = 1000

protected

info

AudioInfo info

protectedinherited

input_buffer

Vector<uint8_t> input_buffer

protected

input_pos

int input_pos = 0

protected

lc3_encoder

lc3_encoder_t lc3_encoder = nullptr

protected

lc3_encoder_memory

Vector<uint8_t> lc3_encoder_memory

protected

num_frames

uint16_t num_frames

protected

output_buffer

Vector<uint8_t> output_buffer

protected

output_byte_count

uint16_t output_byte_count = 20

protected

p_print

Print* p_print = nullptr

protected

pcm_format

lc3_pcm_format pcm_format

protected

---

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

• src/AudioTools/AudioCodecs/CodecLC3.h