arduino-audio-tools
Loading...
Searching...
No Matches
AudioEncoder Class Referenceabstract

Encoding of PCM data. More...

#include <CodecOpusOgg.h>

Inheritance diagram for AudioEncoder:
AudioWriter MimeSource AudioWriter MimeSource AudioInfoSupport AudioInfoSupport AudioInfoSupport AudioInfoSupport AACEncoderFAAC AACEncoderFDK AACEncoderVO ADPCMEncoderXQ AMRNBEncoder AMRWBEncoder APTXEncoder AudioEncoderExt BinaryContainerEncoder Codec2Encoder CodecChain CodecNOP CopyEncoder DSFEncoder EncoderALAC EncoderBase64 EncoderBasic EncoderFloat EncoderL16 EncoderL8 EncoderNetworkFormat FLACEncoder G722Encoder G729Encoder G7xxEncoder GSMEncoder ILBCEncoder LC3Encoder MP3EncoderLAME MP3EncoderShine MP3ParserEncoder MetaDataFilterEncoder OSCContainerEncoder OggContainerEncoder OpusAudioEncoder OpusMultiStreamAudioEncoder RTSPVideoEncoder SBCEncoder WAVEncoder AudioEncoderExt AudioEncoderExt CodecNOP CodecNOP

Public Member Functions

 AudioEncoder ()=default
 AudioEncoder ()=default
 AudioEncoder (AudioEncoder const &)=delete
 AudioEncoder (AudioEncoder const &)=delete
virtual ~AudioEncoder ()=default
virtual ~AudioEncoder ()=default
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 ()=0
virtual bool begin ()=0
virtual bool begin (AudioInfo info)
virtual bool begin (AudioInfo info)
virtual void end ()=0
virtual void end ()=0
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 ()
virtual const char * mime ()=0
 Provides the mime type of the encoded result.
virtual const char * mime ()=0
 Provides the mime type of the encoded result.
virtual operator bool ()=0
virtual operator bool ()=0
AudioEncoder & operator= (AudioEncoder const &)=delete
AudioEncoder & operator= (AudioEncoder const &)=delete
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.
void setAudioInfo (AudioInfo from) override
 Defines the sample rate, number of channels and bits per sample.
virtual void setOutput (Print &out_stream) override
 Default output assignment (encoders may override to store Print reference).
virtual void setOutput (Print &out_stream) override
 Default output assignment (encoders may override to store Print reference).
virtual size_t write (const uint8_t *data, size_t len)=0
virtual size_t write (const uint8_t *data, size_t len)=0

Protected Member Functions

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

Protected Attributes

AudioInfo info

Detailed Description

Encoding of PCM data.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ AudioEncoder() [1/4]

AudioEncoder ( )
default

◆ ~AudioEncoder() [1/2]

virtual ~AudioEncoder ( )
virtualdefault

◆ AudioEncoder() [2/4]

AudioEncoder ( AudioEncoder const & )
delete

◆ AudioEncoder() [3/4]

AudioEncoder ( )
default

◆ ~AudioEncoder() [2/2]

virtual ~AudioEncoder ( )
virtualdefault

◆ AudioEncoder() [4/4]

AudioEncoder ( AudioEncoder const & )
delete

Member Function Documentation

◆ audioInfo() [1/2]

AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

◆ audioInfo() [2/2]

AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

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

◆ audioInfoOut() [1/2]

◆ audioInfoOut() [2/2]

◆ begin() [1/4]

virtual bool begin ( )
pure virtualinherited

◆ begin() [2/4]

virtual bool begin ( )
pure virtualinherited

◆ begin() [3/4]

virtual bool begin ( AudioInfo info)
inlinevirtualinherited

Reimplemented in AudioDecoder, and AudioDecoder.

◆ begin() [4/4]

virtual bool begin ( AudioInfo info)
inlinevirtualinherited

Reimplemented in AudioDecoder, and AudioDecoder.

◆ end() [1/2]

◆ end() [2/2]

◆ frameDurationUs() [1/2]

virtual uint32_t frameDurationUs ( )
inlinevirtual

Optional rtsp function: provide the frame duration in microseconds.

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

◆ frameDurationUs() [2/2]

virtual uint32_t frameDurationUs ( )
inlinevirtual

Optional rtsp function: provide the frame duration in microseconds.

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

◆ frameSize() [1/2]

virtual int frameSize ( )
inlinevirtual

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

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.

◆ mime() [1/2]

◆ mime() [2/2]

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ operator=() [1/2]

AudioEncoder & operator= ( AudioEncoder const & )
delete

◆ operator=() [2/2]

AudioEncoder & operator= ( AudioEncoder const & )
delete

◆ samplesPerFrame() [1/2]

virtual uint16_t samplesPerFrame ( )
inlinevirtual

Optional rtsp function: provide samples per the frame.

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

◆ samplesPerFrame() [2/2]

virtual uint16_t samplesPerFrame ( )
inlinevirtual

Optional rtsp function: provide samples per the frame.

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

◆ setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo from)
inlineoverridevirtual

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

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

◆ setAudioInfo() [2/2]

void setAudioInfo ( AudioInfo from)
inlineoverridevirtual

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

Implements AudioWriter.

Reimplemented in CodecNOP, and CodecNOP.

◆ setOutput() [1/2]

◆ setOutput() [2/2]

◆ write() [1/2]

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

◆ write() [2/2]

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

◆ 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

Member Data Documentation

◆ info

AudioInfo info
protected

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