WavIMADecoder Class Reference

Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send the sound data to the stream which was indicated in the constructor. Only WAV files with WAVE_FORMAT_IMA_ADPCM are supported by this codec! More...

#include <CodecWavIMA.h>

Inheritance diagram for WavIMADecoder:

Public Member Functions
	WavIMADecoder ()
	Construct a new WavIMADecoder object.
	WavIMADecoder (Print &out_stream, AudioInfoSupport &bi)
	Construct a new WavIMADecoder object.
	WavIMADecoder (Print &out_stream, bool active=true)
	Construct a new WavIMADecoder object.
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
AudioInfo	audioInfo () override
	provides the actual input AudioInfo
WavIMAAudioInfo &	audioInfoEx ()
virtual AudioInfo	audioInfoOut ()
	provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
bool	begin ()
virtual bool	begin (AudioInfo info) override
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
void	end ()
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 ()
virtual	operator bool ()
int	readStream (Stream &in)
	Alternative API which provides the data from an input stream.
virtual bool	removeNotifyAudioChange (AudioInfoSupport &bi)
	Removes a target in order not to be notified about audio changes.
virtual void	setAudioInfo (AudioInfo from) override
	for most decoders this is not needed
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 &out_stream)
	Defines the output Stream.
virtual size_t	write (const uint8_t *data, size_t len)

Public Attributes
int	id
	custom id to be used by application

Protected Member Functions
void	decodeBlock (int channels)
int16_t	decodeSample (uint8_t sample, int channel=0)
void	notifyAudioChange (AudioInfo info)
void	processInput (const uint8_t *data, size_t size)
void	writeBlocking (Print *out, uint8_t *data, size_t len)

Protected Attributes
bool	active
size_t	bytes_per_decoded_block = 0
size_t	bytes_per_encoded_block = 0
WavIMAHeader	header
IMAState	ima_states [2]
AudioInfo	info
uint8_t *	input_buffer = nullptr
int32_t	input_pos = 0
bool	is_notify_active = true
bool	isFirst = true
bool	isValid = true
Vector< AudioInfoSupport * >	notify_vector
Print *	out
int16_t *	output_buffer = nullptr
Print *	p_print = nullptr
size_t	remaining_bytes = 0
size_t	samples_per_decoded_block = 0

Detailed Description

Obsolete: WavIMADecoder - based on WAVDecoder - We parse the header data as we receive it and send the sound data to the stream which was indicated in the constructor. Only WAV files with WAVE_FORMAT_IMA_ADPCM are supported by this codec!

We recommend using the WAVDecoder with a corresponding ADPCMDecoder instead.

Author

Phil Schatzmann

Norman Ritz

Copyright

GPLv3

Constructor & Destructor Documentation

WavIMADecoder() [1/2]

WavIMADecoder ( Print &  out_stream, bool  active = true  )

inline

Construct a new WavIMADecoder object.

Parameters

out_stream

Output Stream to which we write the decoded result

WavIMADecoder() [2/2]

WavIMADecoder ( Print &  out_stream, AudioInfoSupport &  bi  )

inline

Construct a new WavIMADecoder object.

Parameters

out_stream	Output Stream to which we write the decoded result
bi	Object that will be notified about the Audio Formt (Changes)

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

AudioInfo audioInfo ( )

inlineoverridevirtual

provides the actual input AudioInfo

Reimplemented from AudioDecoder.

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]

bool begin ( )

inlinevirtual

Reimplemented from AudioDecoder.

begin() [2/2]

virtual bool begin ( AudioInfo  info )

inlineoverridevirtualinherited

Reimplemented from AudioWriter.

end()

void end ( )

inlinevirtual

Reimplemented from AudioDecoder.

isResultPCM()

virtual bool isResultPCM ( )

inlinevirtualinherited

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

Reimplemented in CopyDecoder, and GGWaveDecoder.

operator bool()

virtual operator bool ( )

inlinevirtual

Implements AudioWriter.

setAudioInfo()

virtual void setAudioInfo ( AudioInfo  from )

inlineoverridevirtualinherited

for most decoders this is not needed

Implements AudioWriter.

Reimplemented in GGWaveDecoder, DecoderL8, OpusAudioDecoder, CodecNOP, AACDecoderHelix, and G7xxDecoder.

setOutput() [1/3]

virtual void setOutput ( AudioOutput &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

setOutput() [2/3]

virtual void setOutput ( AudioStream &  out_stream )

inlinevirtualinherited

Defines where the decoded result is written to.

Reimplemented in MetaDataFilterDecoder.

setOutput() [3/3]

void setOutput ( Print &  out_stream )

inlinevirtual

Defines the output Stream.

Reimplemented from AudioDecoder.

write()

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

inlinevirtual

Implements AudioWriter.

---

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

• src/AudioTools/AudioCodecs/CodecWavIMA.h