AudioEncoder Class Reference

Encoding of PCM data. More...

#include <AudioCodecsBase.h>

Inheritance diagram for AudioEncoder:

Public Member Functions
	AudioEncoder (AudioEncoder const &)=delete
AudioInfo	audioInfo ()
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
virtual bool	begin ()=0
virtual bool	begin (AudioInfo info)
virtual void	end ()=0
virtual const char *	mime ()=0
	Provides the mime type of the encoded result.
virtual	operator bool ()=0
AudioEncoder &	operator= (AudioEncoder const &)=delete
void	setAudioInfo (AudioInfo from) override
	Defines the sample rate, number of channels and bits per sample.
virtual void	setOutput (Print &out_stream)=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)

Protected Attributes
AudioInfo	info

Detailed Description

Encoding of PCM data.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlinevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, and BinaryContainerEncoder.

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, and ResampleStream.

begin() [1/2]

virtual bool begin ( )

pure virtualinherited

Implemented in AACDecoderFAAD, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, SBCEncoder, AACDecoderHelix, EncoderBase64, EncoderBasic, FLACEncoder, EncoderFloat, EncoderL16, EncoderL8, MTSDecoder, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and MultiDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

Reimplemented in AACEncoderFDK.

end()

virtual void end ( )

pure virtualinherited

Implemented in AACDecoderFAAD, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, SBCEncoder, AACDecoderHelix, EncoderBase64, EncoderBasic, FLACEncoder, EncoderFloat, EncoderL16, EncoderL8, MTSDecoder, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and MultiDecoder.

mime()

virtual const char * mime ( )

pure virtual

Provides the mime type of the encoded result.

Implemented in CodecNOP, AACEncoderFDK, APTXEncoder, Codec2Encoder, CopyEncoder, G722Encoder, GSMEncoder, ILBCEncoder, LC3Encoder, MP3EncoderLAME, SBCEncoder, BinaryContainerEncoder, GGWaveEncoder, ADPCMEncoder, ADPCMEncoderXQ, EncoderBase64, EncoderBasic, FLACEncoder, EncoderFloat, G7xxEncoder, EncoderL16, EncoderL8, OpusAudioEncoder, OpusOggEncoder, WAVEncoder, and OggContainerEncoder.

operator bool()

virtual operator bool ( )

pure virtualinherited

Implemented in AACDecoderFAAD, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, AACDecoderHelix, and ADTSDecoder.

setAudioInfo()

void setAudioInfo ( AudioInfo  from )

inlineoverridevirtual

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

Implements AudioWriter.

Reimplemented in MP3EncoderLAME, EncoderBasic, FLACEncoder, OpusAudioEncoder, WAVEncoder, CodecNOP, G7xxEncoder, BinaryContainerEncoder, and OggContainerEncoder.

setOutput()

virtual void setOutput ( Print &  out_stream )

pure virtualinherited

Implemented in MP3DecoderMAD, DecoderBase64, EncoderBasic, WAVEncoder, DecoderAdapter, EncoderBase64, CodecNOP, AACDecoderFDK, AACEncoderFDK, AACDecoderHelix, ADPCMDecoderXQ, APTXDecoder, Codec2Decoder, CopyDecoder, G722Decoder, GSMDecoder, ILBCDecoder, LC3Decoder, MP3EncoderLAME, SBCDecoder, WavIMADecoder, GGWaveDecoder, AudioDecoder, ADPCMDecoder, ADTSDecoder, DecoderBasic, FLACEncoder, DecoderFloat, EncoderFloat, G7xxDecoder, DecoderL16, EncoderL16, EncoderL8, MTSDecoder, OpusAudioDecoder, OpusAudioEncoder, MTSDecoderTSDemux, WAVDecoder, AVIDecoder, MultiDecoder, MetaDataFilterDecoder, MP3DecoderMini, BinaryContainerDecoder, MP3DecoderHelix, OggContainerDecoder, and OggContainerEncoder.

write()

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

pure virtualinherited

Implemented in AACDecoderFAAD, MP3DecoderHelix, MP3DecoderMAD, MP3DecoderMini, BinaryContainerEncoder, AACDecoderHelix, ADTSDecoder, EncoderBase64, FLACEncoder, DecoderFloat, EncoderFloat, EncoderL16, EncoderL8, OpusAudioEncoder, WAVEncoder, ContainerMP4, OggContainerEncoder, and EncoderBasic.

---

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

• src/AudioTools/AudioCodecs/AudioCodecsBase.h