arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FaustStream< DSP > Class Template Reference

Integration into Faust DSP see https://faust.grame.fr/ To generate code from faust, select src and cpp. More...

#include <AudioFaust.h>

Inheritance diagram for FaustStream< DSP >:
AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Public Member Functions

 FaustStream (bool useSeparateOutputBuffer=true)
 Constructor for Faust as Audio Source.
 
 FaustStream (Print &out, bool useSeparateOutputBuffer=true)
 Constructor for Faust as Singal Processor - changing an input signal and sending it to out.
 
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
 
virtual bool begin ()
 
bool begin (AudioInfo cfg)
 Checks the parameters and starts the processing.
 
virtual FAUSTFLOAT bend ()
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
AudioInfo defaultConfig ()
 
void end ()
 Ends the processing.
 
virtual void flush () override
 
virtual FAUSTFLOAT frequency ()
 
virtual FAUSTFLOAT gain ()
 
dspgetDSP ()
 Provides a pointer to the actual dsp object.
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual FAUSTFLOAT labelValue (const char *label)
 Determines the value of a parameter.
 
virtual bool midiOff (int note)
 
virtual bool midiOn (int note, FAUSTFLOAT gain)
 
 operator bool ()
 
size_t readBytes (uint8_t *data, size_t len) override
 Used if FaustStream is used as audio source.
 
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.
 
virtual bool setBend (FAUSTFLOAT bend)
 
virtual bool setFrequency (FAUSTFLOAT freq)
 
virtual bool setGain (FAUSTFLOAT gain)
 
virtual bool setLabelValue (const char *label, FAUSTFLOAT value)
 Defines the value of a parameter.
 
virtual bool setMidiNote (int note)
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
size_t write (const uint8_t *write_data, size_t len) override
 Used if FaustStream is used as audio sink or filter.
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

void allocateFloatBuffer (int samples, bool allocate_out)
 Allocate the buffer that is needed by faust.
 
bool checkChannels ()
 Checks the input and output channels and updates the is_write or is_read scenario flags.
 
template<class T >
void convertFloatBufferToInt (int samples, FAUSTFLOAT **p_float_in, void *data_out)
 Converts the float buffer to int values.
 
template<class T >
void convertIntBufferToFloat (int samples, void *data_in, FAUSTFLOAT **p_float_out)
 Converts the int buffer to float values.
 
void deleteFloatBuffer ()
 
virtual int not_supported (int out, const char *msg="")
 
FAUSTFLOAT noteToFrequency (uint8_t x)
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 
template<class T >
size_t writeT (const uint8_t *write_data, size_t len)
 Used if FaustStream is used as audio sink or filter.
 

Protected Attributes

int _timeout = 10
 
int buffer_allocated
 
int bytes_per_frame
 
int bytes_per_sample
 
AudioInfo cfg
 
float float_to_int_factor = 32767
 
bool gate_exists = false
 
AudioInfo info
 
bool is_init = false
 
bool is_notify_active = true
 
bool is_read = false
 
bool is_write = false
 
Vector< AudioInfoSupport * > notify_vector
 
FAUSTFLOAT ** p_buffer =nullptr
 
FAUSTFLOAT ** p_buffer_out =nullptr
 
DSP * p_dsp = nullptr
 
Printp_out =nullptr
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
UI ui
 
bool with_output_buffer
 

Detailed Description

template<class DSP>
class audio_tools::FaustStream< DSP >

Integration into Faust DSP see https://faust.grame.fr/ To generate code from faust, select src and cpp.

Author
Phil Schatzmann

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