arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
StreamCopyT< T > Class Template Reference
Arduino Audio Tools » Tools

Typed Stream Copy which supports the conversion from channel to 2 channels. We make sure that we allways copy full samples. More...

#include <StreamCopy.h>

Public Member Functions

 StreamCopyT (Allocator &allocator, int bufferSize=DEFAULT_BUFFER_SIZE)
 
 StreamCopyT (int bufferSize=DEFAULT_BUFFER_SIZE, Allocator &allocator=DefaultAllocator)
 
 StreamCopyT (Print &to, AudioStream &from, int bufferSize=DEFAULT_BUFFER_SIZE, Allocator &allocator=DefaultAllocator)
 
 StreamCopyT (Print &to, Stream &from, int bufferSize=DEFAULT_BUFFER_SIZE, Allocator &allocator=DefaultAllocator)
 
 ~StreamCopyT ()
 
int available ()
 available bytes of the data source
 
void begin ()
 (Re)starts the processing
 
void begin (Print &to, AudioStream &from)
 assign a new output and input stream
 
void begin (Print &to, Stream &from)
 assign a new output and input stream
 
int bufferSize ()
 Provides the buffer size.
 
size_t copy ()
 
size_t copy (BaseConverter &converter)
 
size_t copyAll (int retryCount=5, int retryWaitMs=200)
 copies all data - returns the number of processed bytes
 
size_t copyBytes (size_t bytes)
 
size_t copyMs (size_t millis, AudioInfo info)
 
size_t copyN (size_t pages)
 Copies pages * buffersize samples: returns the processed number of bytes.
 
void end ()
 Ends the processing.
 
Stream * getFrom ()
 
Print * getTo ()
 
bool isActive ()
 Check if copier is active.
 
bool isCheckAvailable ()
 Is Available check activated ?
 
bool isCheckAvailableForWrite ()
 Is Available for Write check activated ?
 
int minCopySize ()
 Determine frame size.
 
bool resize (size_t len)
 resizes the copy buffer
 
void setActive (bool flag)
 deactivate/activate copy - active by default
 
void setAvailableCallback (int(*callback)(Stream *stream))
 Defines a callback that provides the available bytes at the source.
 
void setCallbackOnWrite (void(*onWrite)(void *obj, void *buffer, size_t len), void *obj)
 Defines a callback that is notified with the wirtten data.
 
void setCheckAvailable (bool flag)
 Activates the check that we copy only if available returns a value.
 
void setCheckAvailableForWrite (bool flag)
 
void setDelayOnNoData (int delayMs)
 Defines the dealy that is used if no data is available.
 
void setLogName (const char *name)
 Defines a name which will be printed in the log to identify the copier.
 
void setMimeDetector (MimeDetector &mime)
 Define a mime detector.
 
void setMinCopySize (int size)
 
void setRetry (int retry)
 Defines the max number of retries.
 
void setRetryDelay (int delay)
 Defines the delay that is added before we retry an incomplete copy.
 
void setSynchAudioInfo (bool active)
 

Protected Member Functions

void syncAudioInfo ()
 
size_t write (size_t len, size_t &delayCount)
 blocking write - until everything is processed
 

Protected Attributes

Allocator _allocator
 
bool active = true
 
int(* availableCallback )(Stream *stream) = nullptr
 
Vector< uint8_t > buffer {0, _allocator}
 
int buffer_size = DEFAULT_BUFFER_SIZE
 
int channels = 0
 
bool check_available = true
 
bool check_available_for_write = false
 
int delay_on_no_data = COPY_DELAY_ON_NODATA
 
Stream * from = nullptr
 
AudioStream * from_audio = nullptr
 
bool is_sync_audio_info = false
 
const char * log_name = ""
 
int min_copy_size = 1
 
void(* onWrite )(void *obj, void *buffer, size_t len) = nullptr
 
void * onWriteObj = nullptr
 
AudioInfoSupport * p_audio_info_support = nullptr
 
BaseConverter * p_converter = nullptr
 
MimeDetector * p_mime_detector = nullptr
 
int retry_delay = 10
 
int retryLimit = COPY_RETRY_LIMIT
 
Print * to = nullptr
 

Detailed Description

template<class T>
class audio_tools::StreamCopyT< T >

Typed Stream Copy which supports the conversion from channel to 2 channels. We make sure that we allways copy full samples.

Template Parameters
T
Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ StreamCopyT() [1/4]

template<class T >
StreamCopyT ( Allocator &  allocator,
int  bufferSize = DEFAULT_BUFFER_SIZE 
)
inline

◆ StreamCopyT() [2/4]

template<class T >
StreamCopyT ( Print &  to,
AudioStream &  from,
int  bufferSize = DEFAULT_BUFFER_SIZE,
Allocator &  allocator = DefaultAllocator 
)
inline

◆ StreamCopyT() [3/4]

template<class T >
StreamCopyT ( Print &  to,
Stream &  from,
int  bufferSize = DEFAULT_BUFFER_SIZE,
Allocator &  allocator = DefaultAllocator 
)
inline

◆ StreamCopyT() [4/4]

template<class T >
StreamCopyT ( int  bufferSize = DEFAULT_BUFFER_SIZE,
Allocator &  allocator = DefaultAllocator 
)
inline

◆ ~StreamCopyT()

template<class T >
~StreamCopyT ( )
inline

Member Function Documentation

◆ available()

template<class T >
int available ( )
inline

available bytes of the data source

◆ begin() [1/3]

template<class T >
void begin ( )
inline

(Re)starts the processing

◆ begin() [2/3]

template<class T >
void begin ( Print &  to,
AudioStream &  from 
)
inline

assign a new output and input stream

◆ begin() [3/3]

template<class T >
void begin ( Print &  to,
Stream &  from 
)
inline

assign a new output and input stream

◆ bufferSize()

template<class T >
int bufferSize ( )
inline

Provides the buffer size.

◆ copy() [1/2]

template<class T >
size_t copy ( )
inline

copies the data from the source to the destination and returns the processed number of bytes

◆ copy() [2/2]

template<class T >
size_t copy ( BaseConverter &  converter)
inline

copies the data from the source to the destination and applies the converter - the result is the processed number of bytes

◆ copyAll()

template<class T >
size_t copyAll ( int  retryCount = 5,
int  retryWaitMs = 200 
)
inline

copies all data - returns the number of processed bytes

◆ copyBytes()

template<class T >
size_t copyBytes ( size_t  bytes)
inline

copies the inicated number of bytes from the source to the destination and returns the processed number of bytes

◆ copyMs()

template<class T >
size_t copyMs ( size_t  millis,
AudioInfo  info 
)
inline

Copies audio for the indicated number of milliseconds: note that the resolution is determined by the buffer_size

◆ copyN()

template<class T >
size_t copyN ( size_t  pages)
inline

Copies pages * buffersize samples: returns the processed number of bytes.

◆ end()

template<class T >
void end ( )
inline

Ends the processing.

◆ getFrom()

template<class T >
Stream * getFrom ( )
inline

Provides a pointer to the copy source. Can be used to check if the source is defined.

◆ getTo()

template<class T >
Print * getTo ( )
inline

Provides a pointer to the copy target. Can be used to check if the target is defined.

◆ isActive()

template<class T >
bool isActive ( )
inline

Check if copier is active.

◆ isCheckAvailable()

template<class T >
bool isCheckAvailable ( )
inline

Is Available check activated ?

◆ isCheckAvailableForWrite()

template<class T >
bool isCheckAvailableForWrite ( )
inline

Is Available for Write check activated ?

◆ minCopySize()

template<class T >
int minCopySize ( )
inline

Determine frame size.

◆ resize()

template<class T >
bool resize ( size_t  len)
inline

resizes the copy buffer

◆ setActive()

template<class T >
void setActive ( bool  flag)
inline

deactivate/activate copy - active by default

◆ setAvailableCallback()

template<class T >
void setAvailableCallback ( int(*)(Stream *stream)  callback)
inline

Defines a callback that provides the available bytes at the source.

◆ setCallbackOnWrite()

template<class T >
void setCallbackOnWrite ( void(*)(void *obj, void *buffer, size_t len)  onWrite,
void *  obj 
)
inline

Defines a callback that is notified with the wirtten data.

◆ setCheckAvailable()

template<class T >
void setCheckAvailable ( bool  flag)
inline

Activates the check that we copy only if available returns a value.

◆ setCheckAvailableForWrite()

template<class T >
void setCheckAvailableForWrite ( bool  flag)
inline

Activates the check that we copy only if available for write returns a value

◆ setDelayOnNoData()

template<class T >
void setDelayOnNoData ( int  delayMs)
inline

Defines the dealy that is used if no data is available.

◆ setLogName()

template<class T >
void setLogName ( const char *  name)
inline

Defines a name which will be printed in the log to identify the copier.

◆ setMimeDetector()

template<class T >
void setMimeDetector ( MimeDetector &  mime)
inline

Define a mime detector.

◆ setMinCopySize()

template<class T >
void setMinCopySize ( int  size)
inline

Defines the minimum frame size that is used to round the copy size: 0 will automatically try to determine the value

◆ setRetry()

template<class T >
void setRetry ( int  retry)
inline

Defines the max number of retries.

◆ setRetryDelay()

template<class T >
void setRetryDelay ( int  delay)
inline

Defines the delay that is added before we retry an incomplete copy.

◆ setSynchAudioInfo()

template<class T >
void setSynchAudioInfo ( bool  active)
inline

Activate the synchronization from the AudioInfo form the source to the target

◆ syncAudioInfo()

template<class T >
void syncAudioInfo ( )
inlineprotected

◆ write()

template<class T >
size_t write ( size_t  len,
size_t &  delayCount 
)
inlineprotected

blocking write - until everything is processed

Member Data Documentation

◆ _allocator

template<class T >
Allocator _allocator
protected

◆ active

template<class T >
bool active = true
protected

◆ availableCallback

template<class T >
int(* availableCallback) (Stream *stream) = nullptr
protected

◆ buffer

template<class T >
Vector<uint8_t> buffer {0, _allocator}
protected

◆ buffer_size

template<class T >
int buffer_size = DEFAULT_BUFFER_SIZE
protected

◆ channels

template<class T >
int channels = 0
protected

◆ check_available

template<class T >
bool check_available = true
protected

◆ check_available_for_write

template<class T >
bool check_available_for_write = false
protected

◆ delay_on_no_data

template<class T >
int delay_on_no_data = COPY_DELAY_ON_NODATA
protected

◆ from

template<class T >
Stream* from = nullptr
protected

◆ from_audio

template<class T >
AudioStream* from_audio = nullptr
protected

◆ is_sync_audio_info

template<class T >
bool is_sync_audio_info = false
protected

◆ log_name

template<class T >
const char* log_name = ""
protected

◆ min_copy_size

template<class T >
int min_copy_size = 1
protected

◆ onWrite

template<class T >
void(* onWrite) (void *obj, void *buffer, size_t len) = nullptr
protected

◆ onWriteObj

template<class T >
void* onWriteObj = nullptr
protected

◆ p_audio_info_support

template<class T >
AudioInfoSupport* p_audio_info_support = nullptr
protected

◆ p_converter

template<class T >
BaseConverter* p_converter = nullptr
protected

◆ p_mime_detector

template<class T >
MimeDetector* p_mime_detector = nullptr
protected

◆ retry_delay

template<class T >
int retry_delay = 10
protected

◆ retryLimit

template<class T >
int retryLimit = COPY_RETRY_LIMIT
protected

◆ to

template<class T >
Print* to = nullptr
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8