MP3 Decoder using https://github.com/pschatzmann/codec-minimp3. This decoder does not provide any good results and it is not suited to decode any audio above 32000 on an ESP32. So the sample rate is limited by the MINIMP3_MAX_SAMPLE_RATE variable. More...

#include <CodecMP3Mini.h>

Inheritance diagram for MP3DecoderMini:

[legend]

Collaboration diagram for MP3DecoderMini:

[legend]

Public Member Functions
	MP3DecoderMini ()=default

	~MP3DecoderMini ()
	Destroy the MP3DecoderMini object.

virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.

AudioInfo	audioInfo () override
	provides the actual input AudioInfo

virtual AudioInfo	audioInfoOut ()

bool	begin ()
	Starts the processing.

virtual bool	begin (AudioInfo info) override

virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.

void	end ()
	Releases the reserved memory.

void	flush ()
	Decodes the last outstanding data.

Print *	getOutput ()

bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.

virtual bool	isResultPCM ()
	Returns true to indicate that the decoding result is PCM data.

const char *	mime () override
	Provides the mime type of the data that is expected by this decoder.

virtual	operator bool ()
	checks if the class is active

virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.

void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed

void	setBufferLength (int len)

virtual bool	setCodecConfig (const uint8_t *data, size_t len)
	Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)

virtual void	setOutput (AudioOutput &out_stream)
	Defines where the decoded result is written to.

virtual void	setOutput (AudioStream &out_stream)
	Defines where the decoded result is written to.

void	setOutput (Print &outStream)
	Defines the output Stream.

void	setSampleRateLimit (int limit)

size_t	write (const uint8_t *data, size_t len)
	Write mp3 data to decoder.

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
void	decode (int write_len)
	Process single bytes so that we can decode a full frame when it is available.

void	f32_to_s16 (float in, int16_t out, int num_samples)

void	notifyAudioChange (AudioInfo info)

void	provideResult (int samples)
	Provides Metadata and PCM data.

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

Protected Attributes
bool	active

Vector< uint8_t >	buffer

size_t	buffer_pos = 0

size_t	buffer_size = 5 * 1024

AudioInfo	info

bool	is_notify_active = true

mp3dec_t	mp3d

mp3dec_frame_info_t	mp3dec_info

Vector< AudioInfoSupport * >	notify_vector

Print *	out = nullptr

Print *	p_print = nullptr

Vector< mp3d_sample_t >	pcm

int	sample_rate_limit = 44100

Detailed Description

MP3 Decoder using https://github.com/pschatzmann/codec-minimp3. This decoder does not provide any good results and it is not suited to decode any audio above 32000 on an ESP32. So the sample rate is limited by the MINIMP3_MAX_SAMPLE_RATE variable.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ MP3DecoderMini()

MP3DecoderMini ( )

default

◆ ~MP3DecoderMini()

~MP3DecoderMini ( )

inline

Destroy the MP3DecoderMini object.

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in CodecNOP, DecoderBasic, DSFDecoder, MP3DecoderHelix, MP3DecoderMAD, OpusAudioDecoder, OpusMultiStreamAudioDecoder, VorbisDecoder, WAVDecoder, WavIMADecoder, OggContainerDecoder, and VorbisDecoder.

◆ 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 MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ begin() [1/2]

bool begin ( )

inlinevirtual

Starts the processing.

Reimplemented from AudioDecoder.

◆ begin() [2/2]

virtual bool begin ( AudioInfo info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

Reimplemented in DecoderBasic, and OggContainerDecoder.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ decode()

void decode ( int write_len )

inlineprotected

Process single bytes so that we can decode a full frame when it is available.

◆ end()

void end ( )

inlinevirtual

Releases the reserved memory.

Reimplemented from AudioDecoder.

◆ f32_to_s16()

void f32_to_s16	(	float *	in,
		int16_t *	out,
		int	num_samples
	)

inlineprotected

◆ flush()

void flush ( )

inline

Decodes the last outstanding data.

◆ getOutput()

Print * getOutput ( )

inlineinherited

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

Returns true to indicate that the decoding result is PCM data.

Reimplemented in CopyDecoder, DecoderNetworkFormat, and ContainerM4A.

◆ mime()

const char * mime ( )

inlineoverridevirtual

Provides the mime type of the data that is expected by this decoder.

Implements AudioDecoder.

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtual

checks if the class is active

Implements AudioWriter.

◆ provideResult()

void provideResult ( int samples )

inlineprotected

Provides Metadata and PCM data.

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in DecoderALAC, CodecChain, DSFDecoder, DecoderL8, OpusAudioDecoder, OpusMultiStreamAudioDecoder, CodecNOP, G729Decoder, and G7xxDecoder.

◆ setBufferLength()

void setBufferLength ( int len )

inline

◆ setCodecConfig()

virtual bool setCodecConfig	(	const uint8_t *	data,
		size_t	len
	)

inlinevirtualinherited

Some decoders need e.g. a magic cookie to provide the relevant info for decoding.

Reimplemented in DecoderALAC, DecoderATRAC, and MultiDecoder.

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

◆ setOutput() [1/3]

virtual void setOutput ( AudioOutput & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ContainerATRAC, ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

◆ setOutput() [2/3]

virtual void setOutput ( AudioStream & out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in ContainerATRAC, ADTSDecoder, CodecChain, MTSDecoder, MTSDecoderTSDemux, and MetaDataFilterDecoder.

◆ setOutput() [3/3]

void setOutput ( Print & outStream )

inlinevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

◆ setSampleRateLimit()

void setSampleRateLimit ( int limit )

inline

◆ write()

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlinevirtual

Write mp3 data to decoder.

Implements AudioWriter.

◆ writeBlocking()

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

inlineprotectedinherited

Member Data Documentation

◆ active

bool active

protected

◆ buffer

Vector<uint8_t> buffer

protected

◆ buffer_pos

size_t buffer_pos = 0

protected

◆ buffer_size

size_t buffer_size = 5 * 1024

protected

◆ id

int id

src/AudioTools/AudioCodecs/CodecMP3Mini.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MP3DecoderMini()

◆ ~MP3DecoderMini()

Member Function Documentation

◆ addNotifyAudioChange()

◆ audioInfo()

◆ audioInfoOut()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clearNotifyAudioChange()

◆ decode()

◆ end()

◆ f32_to_s16()

◆ flush()

◆ getOutput()

◆ isNotifyActive()

◆ isResultPCM()

◆ mime()

◆ notifyAudioChange()

◆ operator bool()

◆ provideResult()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setBufferLength()

◆ setCodecConfig()

◆ setNotifyActive()

◆ setOutput() [1/3]

◆ setOutput() [2/3]

◆ setOutput() [3/3]

◆ setSampleRateLimit()

◆ write()

◆ writeBlocking()

Member Data Documentation

◆ active

◆ buffer

◆ buffer_pos

◆ buffer_size

◆ id

◆ info

◆ is_notify_active

◆ mp3d

◆ mp3dec_info

◆ notify_vector

◆ out

◆ p_print

◆ pcm

◆ sample_rate_limit