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

Receving Audio Data over the wire and requesting for more data when done to synchronize the processing with the sender. The audio data is processed by the EncodedAudioStream; If you have multiple readers, only one receiver should be used as confirmer! More...

#include <AudioSync.h>

Inheritance diagram for AudioSyncReader:
AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 AudioSyncReader (Stream &in, EncodedAudioStream &out, bool isConfirmer=true)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 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
 
virtual int availableForWrite () override
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
size_t copy ()
 
virtual void end ()
 
virtual void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
 operator bool ()
 
virtual size_t readBytes (uint8_t *buffer, size_t length) override
 
virtual size_t readSilence (uint8_t *buffer, size_t length)
 Source to generate silence: just sets the buffer to 0.
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
virtual size_t write (const uint8_t *buffer, size_t size) override
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

void audioDataBegin ()
 Starts the processing.
 
void audioDataEnd ()
 Ends the processing.
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void readProtocol (AudioHeader *data, int len)
 Reads the protocol record.
 
int receiveData ()
 
void refillReadBuffer ()
 
void requestData ()
 Request new data from writer.
 
void waitFor (int size)
 Waits for the data to be available.
 

Protected Attributes

int _timeout = 10
 
size_t available = 0
 
AudioDataBegin begin
 
AudioHeader header
 
AudioInfo info
 
bool is_confirmer
 
bool is_notify_active = true
 
bool is_started = false
 
int last_seq = 0
 
Vector< AudioInfoSupport * > notify_vector
 
Streamp_in
 
EncodedAudioStreamp_out
 
AudioConfirmDataToReceive req
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 

Detailed Description

Receving Audio Data over the wire and requesting for more data when done to synchronize the processing with the sender. The audio data is processed by the EncodedAudioStream; If you have multiple readers, only one receiver should be used as confirmer!

Author
Phil Schatzmann

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