EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. The number of channels are used to merge the samples of one frame into one sample before outputting the result as a frame (by repeating the result sample for each channel). Currently only int16_t values are supported, so I recommend to use the AudioEffectStream class which is defined as using AudioEffectStream = AudioEffectStreamT<effect_t>;. More...
#include <AudioEffects.h>
Public Member Functions | |
| AudioEffectStreamT (Print &out) | |
| AudioEffectStreamT (Stream &io) | |
| void | addEffect (AudioEffect &effect) |
| Adds an effect object (by reference) | |
| void | addEffect (AudioEffect *effect) |
| Adds an effect using a pointer. | |
| 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 | |
| int | available () override |
| int | availableForWrite () override |
| bool | begin () |
| bool | begin (AudioInfo cfg) |
| void | clear () |
| deletes all defined effects | |
| virtual void | clearNotifyAudioChange () |
| Deletes all change notify subscriptions. | |
| AudioInfo | defaultConfig () |
| void | end () override |
| AudioEffect * | findEffect (int id) |
| Finds an effect by id. | |
| virtual void | flush () override |
| bool | isNotifyActive () |
| Checks if the automatic AudioInfo update is active. | |
| virtual | operator bool () |
| AudioEffect * | operator[] (int idx) |
| gets an effect by index | |
| 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. | |
| virtual void | setAudioInfo (AudioInfo newInfo) override |
| Defines the input AudioInfo. | |
| void | setNotifyActive (bool flag) |
| Deactivate/Reactivate automatic AudioInfo updates: (default is active) | |
| void | setOutput (Print &print) override |
| Defines/Changes the output target. | |
| void | setStream (Stream &io) override |
| Defines/Changes the input & output. | |
| size_t | size () |
| Provides the actual number of defined effects. | |
| 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 | |
| virtual int | not_supported (int out, const char *msg="") |
| void | notifyAudioChange (AudioInfo info) |
| void | refillReadBuffer () |
Protected Attributes | |
| int | _timeout = 10 |
| bool | active = false |
| AudioEffectCommon | effects |
| AudioInfo | info |
| bool | is_notify_active = true |
| Vector< AudioInfoSupport * > | notify_vector |
| Stream * | p_io =nullptr |
| Print * | p_print =nullptr |
| RingBuffer< uint8_t > | tmp_in {0} |
| RingBuffer< uint8_t > | tmp_out {0} |
Detailed Description
EffectsStreamT: the template class describes an input or output stream to which one or multiple effects are applied. The number of channels are used to merge the samples of one frame into one sample before outputting the result as a frame (by repeating the result sample for each channel). Currently only int16_t values are supported, so I recommend to use the AudioEffectStream class which is defined as using AudioEffectStream = AudioEffectStreamT<effect_t>;.
- Copyright
- GPLv3
Member Function Documentation
◆ addNotifyAudioChange()
|
inlinevirtualinherited |
Adds target to be notified about audio changes.
Reimplemented in CodecNOP, MP3DecoderMAD, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, MP3DecoderHelix, OggContainerDecoder, Pipeline, and Pipeline::ModifyingStreamAdapter.
◆ audioInfo()
provides the actual input AudioInfo
Implements AudioInfoSupport.
Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, and GeneratedSoundStream< int16_t >.
◆ audioInfoOut()
provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, and ResampleStream.
◆ available()
Reimplemented from BaseStream.
◆ availableForWrite()
Reimplemented from BaseStream.
◆ begin()
Reimplemented from BaseStream.
◆ end()
Reimplemented from BaseStream.
◆ flush()
Reimplemented from Print.
Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.
◆ operator bool()
Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.
◆ readBytes()
Provides the audio data by reading the assinged Stream and applying the effects on that input
Reimplemented from AudioStream.
◆ setAudioInfo()
Defines the input AudioInfo.
Implements AudioInfoSupport.
Reimplemented in VS1053Stream, WM8960Stream, I2SBitBang, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, MeasuringStream, VolumeMeter, TimerCallbackAudioStream, AudioBLEStream, LoRaStream, AudioFFTBase, AudioKitStream, VBANStream, AnalogAudioArduino, Equalizer3Bands, AdapterAudioOutputToAudioStream, TimedStream, ProgressStream, FormatConverterStream, FadeStream, Pipeline::ModifyingStreamAdapter, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, and ResampleStream.
◆ setOutput()
Defines/Changes the output target.
Implements ModifyingStream.
◆ setStream()
Defines/Changes the input & output.
Implements ModifyingStream.
◆ write() [1/2]
Writes the samples passed in the buffer and applies the effects before writing the result to the output defined in the constructor.
Reimplemented from AudioStream.
◆ write() [2/2]
Reimplemented in BufferedTaskStream, and BufferedStream.
The documentation for this class was generated from the following file:
- src/AudioTools/CoreAudio/AudioEffects/AudioEffects.h
