APTXEncoder Class Reference

Encoder for OpenAptx - Depends on https://github.com/pschatzmann/libopenaptx. More...

#include <CodecAPTX.h>

Inheritance diagram for APTXEncoder:

Public Member Functions
	APTXEncoder (bool isHd=false)
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 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.
virtual void	setAudioInfo (AudioInfo info)
	Defines the input AudioInfo.
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
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
struct aptx_context *	ctx = nullptr
AudioInfo	info
Vector< int24_t >	input_buffer {4 * 2}
int	input_pos = 0
bool	is_hd
Vector< uint8_t >	output_buffer
int	output_pos = 0
Print *	p_print = nullptr

Detailed Description

Encoder for OpenAptx - Depends on https://github.com/pschatzmann/libopenaptx.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

APTXEncoder()

APTXEncoder ( bool  isHd = false )

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, and ResampleStreamT< TInterpolator >.

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.

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.

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

virtual void setAudioInfo ( AudioInfo  info )

inlinevirtual

Defines the input AudioInfo.

Implements AudioWriter.

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

ctx

struct aptx_context* ctx = nullptr

protected

info

AudioInfo info

protectedinherited

input_buffer

Vector<int24_t> input_buffer {4 * 2}

protected

input_pos

int input_pos = 0

protected

is_hd

bool is_hd

protected

output_buffer

Vector<uint8_t> output_buffer

protected

output_pos

int output_pos = 0

protected

p_print

Print* p_print = nullptr

protected

---

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

• src/AudioTools/AudioCodecs/CodecAPTX.h