arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AMRWBEncoder Class Referenceabstract

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

#include <CodecAMRWB.h>

Inheritance diagram for AMRWBEncoder:
AudioEncoder AudioWriter AudioInfoSupport

Public Member Functions

 AMRWBEncoder (AMRWB::Mode mode)
 
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 ()
 Optioinal rtsp function: provide the frame duration in microseconds.
 
int frameSize ()
 Provides the frame size (size of decoded frame)
 
PrintgetOutput ()
 
const char * mime ()
 Provides the mime type of the encoded result.
 
virtual operator bool ()=0
 
virtual uint16_t samplesPerFrame ()
 Optioinal rtsp function: provide samples per the frame.
 
void setAudioInfo (AudioInfo from)
 Defines the input AudioInfo.
 
void setMode (AMRWB::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

AMRWB amr
 
SingleBuffer< uint8_t > buffer {0}
 
AudioInfo info
 
AMRWB::Mode mode
 
Printp_print = nullptr
 

Detailed Description

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

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ AMRWBEncoder()

AMRWBEncoder ( AMRWB::Mode  mode)
inline

Default constructor with valid mode values: WB_6_60,WB_8_85,WB_12_65,WB_14_25, WB_15_85,WB_18_25,WB_19_85,WB_23_05,WB_23_85 (e.g. AMRWB::Mode::WB_6_60)

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

◆ begin() [1/2]

bool begin ( )
inlinevirtual

Implements AudioWriter.

◆ begin() [2/2]

virtual bool begin ( AudioInfo  info)
inlinevirtualinherited

Reimplemented in AACEncoderFDK.

◆ end()

virtual void end ( )
pure virtualinherited

◆ frameDurationUs()

virtual uint32_t frameDurationUs ( )
inlinevirtualinherited

Optioinal rtsp function: provide the frame duration in microseconds.

Reimplemented in ADPCMEncoder, OpusOggEncoder, MP3ParserEncoder, and MetaDataFilterEncoder.

◆ mime()

const char * mime ( )
inlinevirtual

Provides the mime type of the encoded result.

Implements AudioEncoder.

◆ operator bool()

virtual operator bool ( )
pure virtualinherited

◆ samplesPerFrame()

virtual uint16_t samplesPerFrame ( )
inlinevirtualinherited

Optioinal rtsp function: provide samples per the frame.

Reimplemented in MP3ParserEncoder, and MetaDataFilterEncoder.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo  info)
inlinevirtual

Defines the input AudioInfo.

Implements AudioWriter.

◆ 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.


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