MP3EncoderLAME Class Reference

Encodes PCM data to the MP3 format and writes the result to a stream This is basically just a wrapper using https://github.com/pschatzmann/arduino-liblame. More...

#include <CodecMP3LAME.h>

Inheritance diagram for MP3EncoderLAME:

Public Member Functions
	MP3EncoderLAME ()
	MP3EncoderLAME (Print &out_stream)
	~MP3EncoderLAME ()
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
AudioInfoLAME &	audioInfoExt ()
virtual AudioInfo	audioInfoOut ()
bool	begin ()
virtual bool	begin (AudioInfo info)
bool	begin (AudioInfoLAME from)
AudioInfoLAME	defaultConfig ()
liblame::MP3EncoderLAME *	driver ()
void	end ()
virtual uint32_t	frameDurationUs ()
	Optional rtsp function: provide the frame duration in microseconds.
const char *	mime ()
	Provides the mime type of the encoded result.
virtual	operator bool ()
virtual uint16_t	samplesPerFrame ()
	Optional rtsp function: provide samples per the frame.
void	setAudioInfo (AudioInfo from)
	Defines the Audio Info.
void	setAudioInfo (AudioInfoLAME from)
	Defines the Audio Info.
void	setOutput (Print &out_stream)
	Defines the output stream.
size_t	write (const uint8_t *data, size_t len)

Protected Member Functions
void	createEnc ()
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
liblame::MP3EncoderLAME *	enc =nullptr
AudioInfo	info
AudioInfoLAME	lame_info
Print *	p_print =nullptr

Detailed Description

Encodes PCM data to the MP3 format and writes the result to a stream This is basically just a wrapper using https://github.com/pschatzmann/arduino-liblame.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

MP3EncoderLAME() [1/2]

MP3EncoderLAME ( )

inline

MP3EncoderLAME() [2/2]

MP3EncoderLAME ( Print &  out_stream )

inline

~MP3EncoderLAME()

~MP3EncoderLAME ( )

inline

Member Function Documentation

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, BinaryContainerEncoder, and MP3ParserEncoder.

audioInfoExt()

AudioInfoLAME & audioInfoExt ( )

inline

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/3]

bool begin ( )

inlinevirtual

Implements AudioWriter.

begin() [2/3]

virtual bool begin ( AudioInfo  info )

inlinevirtualinherited

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

begin() [3/3]

bool begin ( AudioInfoLAME  from )

inline

createEnc()

void createEnc ( )

inlineprotected

defaultConfig()

AudioInfoLAME defaultConfig ( )

inline

driver()

liblame::MP3EncoderLAME * driver ( )

inline

end()

void end ( )

inlinevirtual

Implements AudioWriter.

frameDurationUs()

virtual uint32_t frameDurationUs ( )

inlinevirtualinherited

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

inlinevirtual

Implements AudioWriter.

samplesPerFrame()

virtual uint16_t samplesPerFrame ( )

inlinevirtualinherited

Optional rtsp function: provide samples per the frame.

Reimplemented in MP3ParserEncoder, and MetaDataFilterEncoder.

setAudioInfo() [1/2]

void setAudioInfo ( AudioInfo  from )

inlinevirtual

Defines the Audio Info.

Reimplemented from AudioEncoder.

setAudioInfo() [2/2]

void setAudioInfo ( AudioInfoLAME  from )

inline

Defines the Audio Info.

setOutput()

void setOutput ( Print &  out_stream )

inlinevirtual

Defines the output stream.

Reimplemented from AudioEncoder.

write()

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

enc

liblame::MP3EncoderLAME* enc =nullptr

protected

info

AudioInfo info

protectedinherited

lame_info

AudioInfoLAME lame_info

protected

p_print

Print* p_print =nullptr

protected

---

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

• src/AudioTools/AudioCodecs/CodecMP3LAME.h