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

Abstract Audio Ouptut class. More...

#include <CodecOpusOgg.h>

Inheritance diagram for AudioOutput:
Print AudioInfoSupport AudioInfoSource Print AudioInfoSupport AudioInfoSource AudioESP32ULP AudioOutputAdapter AudioServerEx AudioSyncWriter ChannelSplitOutput ChannelsSelectOutput CsvOutput< T > FFTEffect HexDumpOutput MemoryOutput MetaDataFilter MetaDataOutput ModifyingOutput OSCContainerEncoder::OSCOutput OggContainerOutput PWMAudioOutput< PWMDriverT > PitchShiftOutput< T, BufferT > R2ROutput RTSPOutput< Platform > RTTTLOutput< T > SPIAudioMaster WakeWordDetector< T, N > WebSocketOutput AudioOutputAdapter ChannelSplitOutput ChannelSplitOutput ChannelsSelectOutput CsvOutput< T > CsvOutput< T > HexDumpOutput HexDumpOutput MemoryOutput MemoryOutput ModifyingOutput ModifyingOutput

Public Member Functions

virtual ~AudioOutput ()=default
virtual ~AudioOutput ()=default
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
virtual AudioInfo audioInfoOut ()
virtual AudioInfo audioInfoOut ()
virtual int availableForWrite () override
virtual int availableForWrite () override
virtual bool begin ()
virtual bool begin ()
virtual bool begin (AudioInfo info)
virtual bool begin (AudioInfo info)
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
virtual void end ()
virtual void end ()
virtual void flush ()
virtual void flush ()
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
virtual bool isDeletable ()
 If true we need to release the related memory in the destructor.
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
virtual operator bool ()
virtual operator bool ()
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
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.
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active).
virtual size_t write (const uint8_t *data, size_t len) override=0
virtual size_t write (const uint8_t *data, size_t len) override=0
virtual size_t write (uint8_t ch) override
virtual size_t write (uint8_t ch) override
virtual void writeSilence (size_t len)
virtual void writeSilence (size_t len)

Protected Member Functions

void notifyAudioChange (AudioInfo info)
void notifyAudioChange (AudioInfo info)

Protected Attributes

int _timeout = 10
AudioInfo cfg
bool is_active = false
bool is_notify_active = true
Vector< AudioInfoSupport * > notify_vector
SingleBuffer< uint8_t > tmp { 8 }
int tmpPos = 0

Detailed Description

Abstract Audio Ouptut class.

Author
Phil Schatzmann
Copyright
GPLv3

Constructor & Destructor Documentation

◆ ~AudioOutput() [1/2]

virtual ~AudioOutput ( )
virtualdefault

◆ ~AudioOutput() [2/2]

virtual ~AudioOutput ( )
virtualdefault

Member Function Documentation

◆ addNotifyAudioChange() [1/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ addNotifyAudioChange() [2/2]

virtual void addNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, CodecNOP, EncodedAudioOutput, and EncodedAudioStream.

◆ audioInfo() [1/2]

virtual AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, EncodedAudioOutput, and EncodedAudioOutput.

◆ audioInfo() [2/2]

virtual AudioInfo audioInfo ( )
inlineoverridevirtual

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, EncodedAudioOutput, and EncodedAudioOutput.

◆ audioInfoOut() [1/2]

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ audioInfoOut() [2/2]

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in ChannelFormatConverterStream, ChannelFormatConverterStreamT< T >, FormatConverterStream, MP3EncoderShine, NumberFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, Pipeline, PureDataStream, PWMAudioOutput< PWMDriverT >, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

◆ availableForWrite() [1/2]

virtual int availableForWrite ( )
inlineoverridevirtual

Reimplemented from Print.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, MemoryOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ availableForWrite() [2/2]

virtual int availableForWrite ( )
inlineoverridevirtual

Reimplemented from Print.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, MemoryOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, CsvOutput< T >, EncodedAudioOutput, MemoryOutput, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ begin() [1/4]

virtual bool begin ( )
inlinevirtual

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, HexDumpOutput, HexDumpOutput, MemoryOutput, MemoryOutput, AudioServerEx, ChannelsSelectOutput, CsvOutput< T >, EncodedAudioOutput, FFTEffect, FFTEqualizer, FFTPitchShift, HexDumpOutput, MemoryOutput, MetaDataFilter, OggContainerOutput, OSCContainerEncoder::OSCOutput, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, R2ROutput, RTSPOutput< Platform >, and RTTTLOutput< T >.

◆ begin() [2/4]

virtual bool begin ( )
inlinevirtual

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, HexDumpOutput, HexDumpOutput, MemoryOutput, MemoryOutput, AudioServerEx, ChannelsSelectOutput, CsvOutput< T >, EncodedAudioOutput, FFTEffect, FFTEqualizer, FFTPitchShift, HexDumpOutput, MemoryOutput, MetaDataFilter, OggContainerOutput, OSCContainerEncoder::OSCOutput, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, R2ROutput, RTSPOutput< Platform >, and RTTTLOutput< T >.

◆ begin() [3/4]

virtual bool begin ( AudioInfo info)
inlinevirtual

Reimplemented in ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, and EncodedAudioOutput.

◆ begin() [4/4]

virtual bool begin ( AudioInfo info)
inlinevirtual

Reimplemented in ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, and EncodedAudioOutput.

◆ clearNotifyAudioChange() [1/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ clearNotifyAudioChange() [2/2]

virtual void clearNotifyAudioChange ( )
inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >, RTSPClient< EthernetClient, EthernetUDP >, and RTSPClient< WiFiClient, WiFiUDP >.

◆ end() [1/2]

virtual void end ( )
inlinevirtual

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, EncodedAudioOutput, MetaDataFilter, MetaDataOutput, OggContainerOutput, OpusOggWriter, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ end() [2/2]

virtual void end ( )
inlinevirtual

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, EncodedAudioOutput, MetaDataFilter, MetaDataOutput, OggContainerOutput, OpusOggWriter, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, RTSPOutput< Platform >, and SPIAudioMaster.

◆ flush() [1/2]

virtual void flush ( )
inlinevirtual

Reimplemented from Print.

Reimplemented in HexDumpOutput, HexDumpOutput, MultiOutput, HexDumpOutput, and MultiOutput.

◆ flush() [2/2]

virtual void flush ( )
inlinevirtual

Reimplemented from Print.

Reimplemented in HexDumpOutput, HexDumpOutput, MultiOutput, HexDumpOutput, and MultiOutput.

◆ isDeletable() [1/2]

virtual bool isDeletable ( )
inlinevirtual

If true we need to release the related memory in the destructor.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, and AdapterPrintToAudioOutput.

◆ isDeletable() [2/2]

virtual bool isDeletable ( )
inlinevirtual

If true we need to release the related memory in the destructor.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, and AdapterPrintToAudioOutput.

◆ isNotifyActive() [1/2]

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ isNotifyActive() [2/2]

bool isNotifyActive ( )
inlineinherited

Checks if the automatic AudioInfo update is active.

◆ notifyAudioChange() [1/2]

void notifyAudioChange ( AudioInfo info)
inlineprotectedinherited

◆ notifyAudioChange() [2/2]

void notifyAudioChange ( AudioInfo info)
inlineprotectedinherited

◆ operator bool() [1/2]

virtual operator bool ( )
inlinevirtual

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, EncodedAudioOutput, and RTSPOutput< Platform >.

◆ operator bool() [2/2]

virtual operator bool ( )
inlinevirtual

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterAudioStreamToAudioOutput, EncodedAudioOutput, EncodedAudioOutput, and RTSPOutput< Platform >.

◆ removeNotifyAudioChange() [1/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

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

◆ removeNotifyAudioChange() [2/2]

virtual bool removeNotifyAudioChange ( AudioInfoSupport & bi)
inlinevirtualinherited

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

◆ setAudioInfo() [1/2]

virtual void setAudioInfo ( AudioInfo info)
inlineoverridevirtual

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, and MultiOutput.

◆ setAudioInfo() [2/2]

virtual void setAudioInfo ( AudioInfo info)
inlineoverridevirtual

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, and MultiOutput.

◆ setNotifyActive() [1/2]

void setNotifyActive ( bool flag)
inlineinherited

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

◆ setNotifyActive() [2/2]

void setNotifyActive ( bool flag)
inlineinherited

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

◆ write() [1/4]

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

Reimplemented from Print.

Implemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AudioWriterToAudioOutput, ChannelSplitOutput, ChannelSplitOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, HexDumpOutput, HexDumpOutput, MemoryOutput, MemoryOutput, MultiOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, AudioWriterToAudioOutput, ChannelSplitOutput, ChannelsSelectOutput, CsvOutput< T >, EncodedAudioOutput, FFTEffect, HexDumpOutput, MemoryOutput, MetaDataFilter, MetaDataOutput, MultiOutput, OggContainerOutput, OpusOggWriter, OSCContainerEncoder::OSCOutput, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, R2ROutput, RTSPOutput< Platform >, RTTTLOutput< T >, SPIAudioMaster, WakeWordDetector< T, N >, and WebSocketOutput.

◆ write() [2/4]

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

Reimplemented from Print.

Implemented in AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AdapterAudioStreamToAudioOutput, AdapterPrintToAudioOutput, AudioWriterToAudioOutput, ChannelSplitOutput, ChannelSplitOutput, ChannelsSelectOutput, CsvOutput< T >, CsvOutput< T >, EncodedAudioOutput, HexDumpOutput, HexDumpOutput, MemoryOutput, MemoryOutput, MultiOutput, AudioESP32ULP, AudioServerEx, AudioSyncWriter, AudioWriterToAudioOutput, ChannelSplitOutput, ChannelsSelectOutput, CsvOutput< T >, EncodedAudioOutput, FFTEffect, HexDumpOutput, MemoryOutput, MetaDataFilter, MetaDataOutput, MultiOutput, OggContainerOutput, OpusOggWriter, OSCContainerEncoder::OSCOutput, PitchShiftOutput< T, BufferT >, PWMAudioOutput< PWMDriverT >, R2ROutput, RTSPOutput< Platform >, RTTTLOutput< T >, SPIAudioMaster, WakeWordDetector< T, N >, and WebSocketOutput.

◆ write() [3/4]

virtual size_t write ( uint8_t ch)
inlineoverridevirtual

Reimplemented in MultiOutput, MetaDataOutput, and MultiOutput.

◆ write() [4/4]

virtual size_t write ( uint8_t ch)
inlineoverridevirtual

Reimplemented in MultiOutput, MetaDataOutput, and MultiOutput.

◆ writeSilence() [1/2]

virtual void writeSilence ( size_t len)
inlinevirtual

Writes n 0 values (= silence)

Parameters
len

◆ writeSilence() [2/2]

virtual void writeSilence ( size_t len)
inlinevirtual

Writes n 0 values (= silence)

Parameters
len

Member Data Documentation

◆ _timeout

int _timeout = 10
protectedinherited

◆ cfg

AudioInfo cfg
protected

◆ is_active

bool is_active = false
protected

◆ is_notify_active

bool is_notify_active = true
protectedinherited

◆ notify_vector

Vector< AudioInfoSupport * > notify_vector
protectedinherited

◆ tmp

SingleBuffer< uint8_t > tmp { 8 }
protected

◆ tmpPos

int tmpPos = 0
protected
The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0