arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
audio_tools::RAWDecoder Class Reference

RAWDecoder - Actually this class does no encoding or decoding at all. It just passes on the data. The reason that this class exists is that we can use the same processing chain for different file types and just replace the decoder. More...

#include <CodecRAW.h>

Inheritance diagram for audio_tools::RAWDecoder:
audio_tools::AudioDecoder audio_tools::AudioWriter audio_tools::AudioBaseInfoSource

Public Member Functions

 RAWDecoder ()
 Construct a new RAWDecoder object.
 
 RAWDecoder (Print &out_stream, AudioBaseInfoDependent &bi)
 Construct a new RAWDecoder object. More...
 
 RAWDecoder (Print &out_stream, bool active=true)
 Construct a new RAWDecoder object. More...
 
AudioBaseInfo audioInfo () override
 
void begin () override
 
void begin (AudioBaseInfo info)
 
void end () override
 
virtual operator bool () override
 
void setNotifyAudioChange (AudioBaseInfoDependent &bi) override
 
void setOutputStream (Print &out_stream) override
 Defines the output Stream. More...
 
virtual size_t write (const void *in_ptr, size_t in_size) override
 
- Public Member Functions inherited from audio_tools::AudioDecoder
 AudioDecoder (AudioDecoder const &)=delete
 
virtual AudioBaseInfo audioInfo ()=0
 
virtual bool isResultPCM ()
 
AudioDecoderoperator= (AudioDecoder const &)=delete
 
virtual void setAudioInfo (AudioBaseInfo from) override
 
virtual void setOutputStream (AudioPrint &out_stream)
 
virtual void setOutputStream (AudioStream &out_stream)
 
virtual void setOutputStream (Print &out_stream) override=0
 
virtual void begin ()=0
 
virtual void end ()=0
 
virtual operator bool ()=0
 
virtual void setAudioInfo (AudioBaseInfo from)=0
 
virtual void setOutputStream (Print &out_stream)=0
 
virtual size_t write (const void *in_ptr, size_t in_size)=0
 
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi)=0
 

Protected Attributes

bool active
 
AudioBaseInfoDependentbid =nullptr
 
AudioBaseInfo cfg
 
Printp_print =nullptr
 

Detailed Description

RAWDecoder - Actually this class does no encoding or decoding at all. It just passes on the data. The reason that this class exists is that we can use the same processing chain for different file types and just replace the decoder.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ RAWDecoder() [1/2]

audio_tools::RAWDecoder::RAWDecoder ( Print out_stream,
bool  active = true 
)
inline

Construct a new RAWDecoder object.

Parameters
out_streamOutput Stream to which we write the decoded result

◆ RAWDecoder() [2/2]

audio_tools::RAWDecoder::RAWDecoder ( Print out_stream,
AudioBaseInfoDependent bi 
)
inline

Construct a new RAWDecoder object.

Parameters
out_streamOutput Stream to which we write the decoded result
biObject that will be notified about the Audio Formt (Changes)

Member Function Documentation

◆ audioInfo()

AudioBaseInfo audio_tools::RAWDecoder::audioInfo ( )
inlineoverridevirtual

◆ begin()

void audio_tools::RAWDecoder::begin ( )
inlineoverridevirtual

◆ end()

void audio_tools::RAWDecoder::end ( )
inlineoverridevirtual

◆ operator bool()

virtual audio_tools::RAWDecoder::operator bool ( )
inlineoverridevirtual

◆ setNotifyAudioChange()

void audio_tools::RAWDecoder::setNotifyAudioChange ( AudioBaseInfoDependent bi)
inlineoverridevirtual

◆ setOutputStream()

void audio_tools::RAWDecoder::setOutputStream ( Print out_stream)
inlineoverridevirtual

Defines the output Stream.

Implements audio_tools::AudioDecoder.

◆ write()

virtual size_t audio_tools::RAWDecoder::write ( const void *  in_ptr,
size_t  in_size 
)
inlineoverridevirtual

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