arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
BLESerialStream Class Referenceabstract

Common functionality of the BLE serial server and client: data is exchanged via two characteristics like a serial connection. The audio info can optionally be exchanged via a third characteristic. More...

#include <BLESerialStream.h>

Inheritance diagram for BLESerialStream:
Inheritance graph
[legend]
Collaboration diagram for BLESerialStream:
Collaboration graph
[legend]

Public Member Functions

 BLESerialStream (int mtu)
 
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 ()
 
virtual int available () override
 
virtual int availableForWrite () override
 
virtual bool begin ()
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
virtual bool connected ()=0
 Returns true if we are connected with the other side.
 
virtual void end ()=0
 
virtual void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
 operator bool () override
 
int packetSize ()
 
virtual size_t readBytes (uint8_t *data, size_t len) 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.
 
void setAudioInfo (AudioInfo newInfo) override
 
void setAudioInfoActive (bool flag)
 Activates the exchange of the audio info.
 
void setAudioInfoUUID (const char *uuid)
 Defines the UUID of the audio info characteristic.
 
void setFramed (bool flag)
 Keeps the write sizes: each write is one BLE packet.
 
void setMTU (int mtu)
 Defines the requested MTU (must be called before begin)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setRxBufferSize (int bytes, int packets=100)
 
void setRxUUID (const char *uuid)
 Defines the UUID of the characteristic which is written by the client.
 
void setServiceUUID (const char *uuid)
 Defines the service UUID.
 
void setTxBufferSize (int bytes, int packets=100)
 
void setTxUUID (const char *uuid)
 Defines the UUID of the characteristic which is read by the client.
 
void setWriteBufferSize (int size)
 
AudioInfo toInfo (const uint8_t *data, size_t len)
 Converts the string from the info characteristic to the audio info.
 
StrView toStr (AudioInfo info)
 
virtual size_t write (const uint8_t *data, size_t len) override
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

 BLESerialStream (BLESerialStream const &other)=delete
 
virtual int getMTU ()
 Effective MTU.
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void operator= (BLESerialStream const &other)=delete
 
void receiveAudioInfo (const uint8_t *data, size_t size)
 Process the audio info which was received from the other side.
 
void refillReadBuffer ()
 Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
 
virtual void writeAudioInfo (StrView info)=0
 Provides the audio info to the other side.
 

Static Protected Member Functions

static int getHeader (const uint8_t *packet, int packetLen)
 Determines the payload length from the 2 byte header.
 
static void setHeader (uint8_t *packet, int len)
 Copies the payload length into the 2 byte header.
 

Protected Attributes

int _timeout = 10
 
char audio_info_str [40]
 
const char * BLE_CH1_UUID = "6e400002-b5a3-f393-e0a9-e50e24dcca9e"
 
const char * BLE_CH2_UUID = "6e400003-b5a3-f393-e0a9-e50e24dcca9e"
 
const char * BLE_INFO_UUID = "6e400004-b5a3-f393-e0a9-e50e24dcca9e"
 
const char * BLE_SERIAL_SERVICE_UUID = "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
 
AudioInfo info
 
bool is_audio_info_active = false
 
bool is_audio_info_defined = false
 
bool is_framed = false
 
bool is_notify_active = true
 
int max_transfer_size = 0
 
Vector< AudioInfoSupport * > notify_vector
 
int rx_buffer_size = 4096
 
int rx_packet_count = 100
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
int tx_buffer_size = 4096
 
int tx_packet_count = 100
 
int write_buffer_size = MAX_SINGLE_CHARS
 

Detailed Description

Common functionality of the BLE serial server and client: data is exchanged via two characteristics like a serial connection. The audio info can optionally be exchanged via a third characteristic.

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ BLESerialStream() [1/2]

BLESerialStream ( int  mtu)
inline

◆ BLESerialStream() [2/2]

BLESerialStream ( BLESerialStream const &  other)
protecteddelete

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi)
inlinevirtualinherited

◆ audioInfo()

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ available()

virtual int available ( )
inlineoverridevirtualinherited

Reimplemented from Stream.

Reimplemented in AudioKitStream, AudioLoRa, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, VBANStream, AudioStreamWrapper, FaustStream< DSP >, AudioMP34DT05, I2SCodecStream, MiniAudioStream, StdioStream, TfLiteAudioStream, A2DPStream, BLESerialServerBase, BLESerialClientBase, ESPNowStream, HammingFEC< bytecount, block_t >, HLSStreamT< URLStream >, HttpRequest, ICYStreamT< T >, URLStream, BufferedTaskStream, NRF24Stream, ReedSolomonFEC< bytecount, additional_bytes >, SPIAudioSlave, SPIRegAudioSlave, UDPStream, USBAudioStreamBase, AutomaticGainControlStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, MeasuringStream, QualityAnalysisStream, VolumeStream, AnalogAudioStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, I2SStream, ReformatBaseStream, TimedStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, ProgressStream, Throttle, InputMixer< T, SumT >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, FadeStream, Pipeline, Pipeline::ModifyingStreamAdapter, SupportedRatesStream, FileLoopT< FileType >, FileLoopT< File >, and AudioFFTBase.

◆ availableForWrite()

virtual int availableForWrite ( )
inlineoverridevirtualinherited

◆ begin()

virtual bool begin ( )
inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, USBAudioDeviceBase, USBAudioHostBase, VBANStream, FrequencyDetectorAutoCorrelation, GoertzelStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, I2SStream, AudioTimeSourceStream, AudioStreamWrapper, TimerCallbackAudioStream, ResampleStreamT< TInterpolator >, FileLoopT< FileType >, FileLoopT< File >, EncodedAudioStream, AudioBoardStream, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, HLSStreamT< URLStream >, NRF24Stream, ReedSolomonFEC< bytecount, additional_bytes >, AutomaticGainControlStream, MeasuringStream, QualityAnalysisStream, VolumeStream, AnalogAudioStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, ProgressStream, Throttle, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, SupportedRatesStream, AudioFFTBase, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ connected()

virtual bool connected ( )
pure virtual

Returns true if we are connected with the other side.

Implemented in BLESerialServerArduinoBLE, BLESerialServerESP32, and BLESerialClientBase.

◆ end()

virtual void end ( )
pure virtual

◆ flush()

virtual void flush ( )
inlineoverridevirtualinherited

◆ getHeader()

static int getHeader ( const uint8_t *  packet,
int  packetLen 
)
inlinestaticprotected

Determines the payload length from the 2 byte header.

◆ getMTU()

virtual int getMTU ( )
inlineprotectedvirtual

Effective MTU.

Reimplemented in BLESerialClientESP32, and BLESerialServerESP32.

◆ isNotifyActive()

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ not_supported()

virtual int not_supported ( int  out,
const char *  msg = "" 
)
inlineprotectedvirtualinherited

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo  info)
inlineprotectedinherited

◆ operator bool()

operator bool ( )
inlineoverridevirtual

Reimplemented from AudioStream.

◆ operator=()

void operator= ( BLESerialStream const &  other)
protecteddelete

◆ packetSize()

int packetSize ( )
inline

Max number of payload bytes in one BLE packet: the packets read by the client also contain the length header and a value can not be longer than 512 bytes

◆ readBytes()

virtual size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlineoverridevirtualinherited

Implements BaseStream.

Reimplemented in LMSEchoCancellationStream< T >, MDFEchoCancellationStream< T, SampleType >, USBAudioStreamBase, MozziStream, PureDataStream, AudioLoRa, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, EncodedAudioStream, FaustStream< DSP >, AudioKitStream, AudioMP34DT05, I2SCodecStream, MiniAudioStream, PortAudioStream, TfLiteAudioStream, A2DPStream, AdaptiveResamplingStream, BLESerialServerBase, BLESerialClientBase, HLSStreamT< URLStream >, ICYStreamT< T >, URLStream, BufferedTaskStream, URLStreamESP32, NRF24Stream, SPIAudioSlave, SPIRegAudioSlave, VBANStream, AutomaticGainControlStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, MeasuringStream, QualityAnalysisStream, VolumeStream, AnalogAudioStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, I2SStream, ReformatBaseStream, TimedStream, AudioTimeSourceStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, ConverterStream< T >, ProgressStream, Throttle, InputMixer< T, SumT >, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FadeStream, Pipeline, SupportedRatesStream, AudioFFTBase, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, WM8960Stream, AnalogDriverESP32V1::IO16Bit, and AnalogDriverESP32V2::IO16Bit.

◆ readSilence()

virtual size_t readSilence ( uint8_t *  buffer,
size_t  length 
)
inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

◆ receiveAudioInfo()

void receiveAudioInfo ( const uint8_t *  data,
size_t  size 
)
inlineprotected

Process the audio info which was received from the other side.

◆ refillReadBuffer()

void refillReadBuffer ( )
inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

◆ removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi)
inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ setAudioInfo()

void setAudioInfo ( AudioInfo  newInfo)
inlineoverridevirtual

Defines the audio info and informs the other side if setAudioInfoActive(true) was called

Reimplemented from AudioStream.

◆ setAudioInfoActive()

void setAudioInfoActive ( bool  flag)
inline

Activates the exchange of the audio info.

◆ setAudioInfoUUID()

void setAudioInfoUUID ( const char *  uuid)
inline

Defines the UUID of the audio info characteristic.

◆ setFramed()

void setFramed ( bool  flag)
inline

Keeps the write sizes: each write is one BLE packet.

◆ setHeader()

static void setHeader ( uint8_t *  packet,
int  len 
)
inlinestaticprotected

Copies the payload length into the 2 byte header.

◆ setMTU()

void setMTU ( int  mtu)
inline

Defines the requested MTU (must be called before begin)

◆ setNotifyActive()

void setNotifyActive ( bool  flag)
inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

◆ setRxBufferSize()

void setRxBufferSize ( int  bytes,
int  packets = 100 
)
inline

Defines the size of the receive buffer and (in framed mode) the max number of packets: must be called before begin

◆ setRxUUID()

void setRxUUID ( const char *  uuid)
inline

Defines the UUID of the characteristic which is written by the client.

◆ setServiceUUID()

void setServiceUUID ( const char *  uuid)
inline

Defines the service UUID.

◆ setTxBufferSize()

void setTxBufferSize ( int  bytes,
int  packets = 100 
)
inline

Defines the size of the transmit buffer and (in framed mode) the max number of packets: must be called before begin

◆ setTxUUID()

void setTxUUID ( const char *  uuid)
inline

Defines the UUID of the characteristic which is read by the client.

◆ setWriteBufferSize()

void setWriteBufferSize ( int  size)
inlineinherited

◆ toInfo()

AudioInfo toInfo ( const uint8_t *  data,
size_t  len 
)
inline

Converts the string from the info characteristic to the audio info.

◆ toStr()

StrView toStr ( AudioInfo  info)
inline

Converts the audio info to the string which is used in the info characteristic

◆ write() [1/2]

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

Implements BaseStream.

Reimplemented in URLStream, LMSEchoCancellationStream< T >, MDFEchoCancellationStream< T, SampleType >, ESP3288AudioOutput, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, AudioLoRa, USBAudioStreamBase, I2SStream, AudioStreamWrapper, ConverterStream< T >, EncodedAudioStream, FaustStream< DSP >, AudioKitStream, MiniAudioStream, PortAudioStream, TfLiteAudioStream, VS1053Stream, A2DPStream, AdaptiveResamplingStream, BLESerialServerBase, BLESerialClientBase, BufferedTaskStream, URLStreamESP32, NRF24Stream, SPIAudioSlave, VBANStream, AutomaticGainControlStream, FrequencyDetectorAutoCorrelation, FrequencyDetectorZeroCrossing, GoertzelStream, MeasuringStream, QualityAnalysisStream, VolumeStream, AnalogAudioStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, AdapterAudioOutputToAudioStream, TimedStream, AudioTimeSourceStream, MemoryStream, RingBufferStream, BufferedStream, ProgressStream, Throttle, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, FadeStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, ResampleStreamT< TInterpolator >, SupportedRatesStream, AudioFFTBase, EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >, TfLiteAudioStreamBase, WM8960Stream, AnalogDriverESP32V1::IO16Bit, and AnalogDriverESP32V2::IO16Bit.

◆ write() [2/2]

virtual size_t write ( uint8_t  ch)
inlineoverridevirtualinherited

◆ writeAudioInfo()

virtual void writeAudioInfo ( StrView  info)
protectedpure virtual

Provides the audio info to the other side.

Implemented in BLESerialClientArduinoBLE, BLESerialClientESP32, BLESerialServerArduinoBLE, and BLESerialServerESP32.

◆ writeSilence()

virtual void writeSilence ( size_t  len)
inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

◆ _timeout

int _timeout = 10
protectedinherited

◆ audio_info_str

char audio_info_str[40]
protected

◆ BLE_CH1_UUID

const char* BLE_CH1_UUID = "6e400002-b5a3-f393-e0a9-e50e24dcca9e"
protected

◆ BLE_CH2_UUID

const char* BLE_CH2_UUID = "6e400003-b5a3-f393-e0a9-e50e24dcca9e"
protected

◆ BLE_INFO_UUID

const char* BLE_INFO_UUID = "6e400004-b5a3-f393-e0a9-e50e24dcca9e"
protected

◆ BLE_SERIAL_SERVICE_UUID

const char* BLE_SERIAL_SERVICE_UUID = "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
protected

◆ info

AudioInfo info
protectedinherited

◆ is_audio_info_active

bool is_audio_info_active = false
protected

◆ is_audio_info_defined

bool is_audio_info_defined = false
protected

◆ is_framed

bool is_framed = false
protected

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ max_transfer_size

int max_transfer_size = 0
protected

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector
protectedinherited

◆ rx_buffer_size

int rx_buffer_size = 4096
protected

◆ rx_packet_count

int rx_packet_count = 100
protected

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}
protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}
protectedinherited

◆ tx_buffer_size

int tx_buffer_size = 4096
protected

◆ tx_packet_count

int tx_packet_count = 100
protected

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS
protectedinherited

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