arduino-audio-tools
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
BinaryContainerDecoder Class Reference

Decodes the provided data from the DAT and CFG segments. More...

#include <ContainerBinary.h>

Inheritance diagram for BinaryContainerDecoder:
ContainerDecoder AudioDecoder AudioWriter AudioInfoSource AudioInfoSupport

Public Member Functions

 BinaryContainerDecoder (AudioDecoder &decoder)
 
 BinaryContainerDecoder (AudioDecoder *decoder)
 
void addErrorHandler (void(*error_handler)(BinaryContainerEncoderError error, BinaryContainerDecoder *source, void *ref))
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo ()
 provides the actual input AudioInfo
 
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.
 
 operator bool ()
 
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 setDecoder (AudioDecoder *decoder)
 
void setIgnoreWriteErrors (bool flag)
 If set to true we do not expect a retry to write the missing data but continue just with the next. (Default is true);.
 
void setMetaCallback (void(*callback)(uint8_t *, int, void *))
 
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 where the decoded result is written to.
 
void setReference (void *ref)
 Provide additional information for callback.
 
size_t write (const void *data, size_t len)
 

Public Attributes

int id
 custom id to be used by application
 

Protected Member Functions

bool isValidHeader ()
 
void nextRecord ()
 
void notifyAudioChange (AudioInfo info)
 
size_t output (uint8_t *data, size_t len)
 
bool parseBuffer ()
 
bool processData ()
 
void writeBlocking (Print *out, uint8_t *data, size_t len)
 

Protected Attributes

SingleBuffer< uint8_t > buffer {0}
 
void(* error_handler )(BinaryContainerEncoderError error, BinaryContainerDecoder *source, void *ref) = nullptr
 
CommonHeader header
 
const size_t header_size = sizeof(header)
 
bool ignore_write_errors = true
 
AudioInfo info
 
bool is_first = true
 
bool is_notify_active = true
 
void(* meta_callback )(uint8_t *data, int len, void *ref) = nullptr
 
Vector< AudioInfoSupport * > notify_vector
 
AudioDecoderp_codec = nullptr
 
Printp_out = nullptr
 
Printp_print = nullptr
 
void * reference = nullptr
 

Detailed Description

Decodes the provided data from the DAT and CFG segments.

Author
Phil Schatzmann

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