AMRNBEncoder Class Reference

AMR NB Encoder See https://github.com/pschatzmann/codec-amr. More...

#include <CodecAMRNB.h>

Inheritance diagram for AMRNBEncoder:

Public Member Functions
	AMRNBEncoder (AMRNB::Mode mode)
	~AMRNBEncoder () override=default
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
bool	begin ()
virtual bool	begin (AudioInfo info)
int	blockSize ()
	Provides the block size (size of encoded frame)
virtual void	end ()=0
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
int	frameSize ()
	Provides the frame size (size of decoded frame)
Print *	getOutput ()
const char *	mime ()
	Provides the mime type of the encoded result.
virtual	operator bool ()=0
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo from)
	Defines the input AudioInfo.
void	setMode (AMRNB::Mode mode)
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
AMRNB	amr
SingleBuffer< uint8_t >	buffer {0}
AudioInfo	info
AMRNB::Mode	mode
Print *	p_print = nullptr

Detailed Description

AMR NB Encoder See https://github.com/pschatzmann/codec-amr.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

AMRNBEncoder()

AMRNBEncoder ( AMRNB::Mode  mode )

inline

Default Constructor with valid mode values: NB_475,NB_515,NB_59,NB_67,NB_74,NB_795,NB_102,NB_122 (e.g. AMRNB::Mode::NB_475) AMRNBDecoder(AMRNB::Mode mode) {

~AMRNBEncoder()

~AMRNBEncoder ( )

overridedefault

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

inlinevirtual

Implements AudioWriter.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

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

blockSize()

int blockSize ( )

inline

Provides the block size (size of encoded frame)

end()

virtual void end ( )

pure virtualinherited

Implemented in CodecNOP, AACDecoderFAAD, APTXEncoder, Codec2Decoder, Codec2Encoder, CopyDecoder, CopyEncoder, FLACDecoderFoxen, G722Decoder, G722Encoder, GSMDecoder, GSMEncoder, ILBCDecoder, ILBCEncoder, LC3Decoder, LC3Encoder, MP3EncoderLAME, MP3DecoderMini, DecoderNetworkFormat, EncoderNetworkFormat, SBCDecoder, SBCEncoder, WavIMADecoder, BinaryContainerEncoder, BinaryContainerDecoder, OSCContainerEncoder, OSCContainerDecoder, AudioDecoder, AACDecoderFDK, AACEncoderFDK, AACDecoderHelix, ADPCMDecoder, ADPCMEncoder, ADPCMDecoderXQ, ADPCMEncoderXQ, ADTSDecoder, EncoderALAC, APTXDecoder, DecoderBase64, EncoderBase64, DecoderBasic, EncoderBasic, CodecChain, DSFDecoder, FLACEncoder, EncoderFloat, G729Decoder, G729Encoder, G7xxDecoder, G7xxEncoder, EncoderL16, EncoderL8, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, OpusAudioDecoder, OpusAudioEncoder, OpusOggDecoder, MTSDecoderTSDemux, VorbisDecoder, WAVDecoder, WAVEncoder, AVIDecoder, ContainerM4A, OggContainerDecoder, OggContainerEncoder, MP3ParserEncoder, MultiDecoder, DecoderAdapter, VorbisDecoder, MetaDataFilterDecoder, and MetaDataFilterEncoder.

frameDurationUs()

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

Optional rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, OpusOggEncoder, MP3ParserEncoder, and MetaDataFilterEncoder.

frameSize()

int frameSize ( )

inline

Provides the frame size (size of decoded frame)

getOutput()

Print * getOutput ( )

inline

mime()

const char * mime ( )

inlinevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

operator bool()

virtual operator bool ( )

pure virtualinherited

Implemented in CodecNOP, AACDecoderFAAD, DecoderALAC, EncoderALAC, APTXDecoder, APTXEncoder, CodecChain, Codec2Decoder, Codec2Encoder, CopyDecoder, CopyEncoder, DSFDecoder, G722Decoder, G722Encoder, G7xxDecoder, G7xxEncoder, GSMDecoder, GSMEncoder, ILBCDecoder, ILBCEncoder, LC3Decoder, LC3Encoder, MP3EncoderLAME, MP3DecoderMini, DecoderNetworkFormat, EncoderNetworkFormat, SBCDecoder, SBCEncoder, WavIMADecoder, BinaryContainerEncoder, BinaryContainerDecoder, OSCContainerEncoder, OSCContainerDecoder, AACDecoderFDK, AACEncoderFDK, AACDecoderHelix, ADPCMDecoder, ADPCMEncoder, ADPCMDecoderXQ, ADPCMEncoderXQ, ADTSDecoder, AMRNBDecoder, AMRWBDecoder, DecoderBase64, EncoderBase64, DecoderBasic, EncoderBasic, FLACEncoder, FLACDecoderFoxen, DecoderFloat, EncoderFloat, G729Decoder, G729Encoder, DecoderL16, EncoderL16, DecoderL8, EncoderL8, MP3DecoderHelix, MP3DecoderMAD, MTSDecoder, OpusAudioDecoder, OpusAudioEncoder, MTSDecoderTSDemux, VorbisDecoder, WAVDecoder, WAVEncoder, AVIDecoder, ContainerM4A, OggContainerDecoder, OggContainerEncoder, MP3ParserEncoder, MultiDecoder, DecoderAdapter, VorbisDecoder, MetaDataFilterDecoder, and MetaDataFilterEncoder.

samplesPerFrame()

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in MP3ParserEncoder, and MetaDataFilterEncoder.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlinevirtual

Defines the input AudioInfo.

Implements AudioWriter.

setMode()

void setMode ( AMRNB::Mode  mode )

inline

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.

writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

amr

AMRNB amr

protected

buffer

SingleBuffer<uint8_t> buffer {0}

protected

info

AudioInfo info

protectedinherited

mode

AMRNB::Mode mode

protected

p_print

Print* p_print = nullptr

protected

---

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

• src/AudioTools/AudioCodecs/CodecAMRNB.h