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 >:

Public Member Functions
	FaustStream (bool useSeparateOutputBuffer=true)
	Constructor for Faust as Audio Source.

	FaustStream (Print &out, bool useSeparateOutputBuffer=true)
	Constructor for Faust as signal Processor - changing an input signal and sending it to out.

	~FaustStream ()

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 ()

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 ()

dsp *	getDSP ()
	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)

virtual	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)

void	setWriteBufferSize (int size)

size_t	write (const uint8_t *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 ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

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

Print *	p_out =nullptr

RingBuffer< uint8_t >	tmp_in {0}

RingBuffer< uint8_t >	tmp_out {0}

UI	ui

bool	with_output_buffer

int	write_buffer_size = MAX_SINGLE_CHARS

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

Copyright: GPLv3

Constructor & Destructor Documentation

◆ FaustStream() [1/2]

template<class DSP >

FaustStream ( bool useSeparateOutputBuffer = true )

inline

Constructor for Faust as Audio Source.

◆ FaustStream() [2/2]

template<class DSP >

FaustStream	(	Print &	out,
		bool	useSeparateOutputBuffer = `true`
	)

inline

Constructor for Faust as signal Processor - changing an input signal and sending it to out.

◆ ~FaustStream()

template<class DSP >

~FaustStream ( )

inline

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport & bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

◆ allocateFloatBuffer()

template<class DSP >

void allocateFloatBuffer	(	int	samples,
		bool	allocate_out
	)

inlineprotected

Allocate the buffer that is needed by faust.

◆ audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

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

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

◆ available()

template<class DSP >

int available ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

template<class DSP >

int availableForWrite ( )

inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, USBAudioDeviceBase, VBANStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3Bands, Equalizer3BandsPerChannel, I2SStream, AudioStreamWrapper, TimerCallbackAudioStream, FrequencyDetectorAutoCorrelation, GoertzelStream, ResampleStreamT< TInterpolator >, FileLoopT< FileType >, FileLoopT< File >, EncodedAudioStream, AudioBoardStream, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, HLSStreamT< URLStream >, NRF24Stream, AnalogAudioStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, MeasuringStream, 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, QualityAnalysisStream, ResampleStream, VolumeStream, AudioFFTBase, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

◆ begin() [2/2]

template<class DSP >

bool begin ( AudioInfo cfg )

inline

Checks the parameters and starts the processing.

◆ bend()

template<class DSP >

virtual FAUSTFLOAT bend ( )

inlinevirtual

◆ checkChannels()

template<class DSP >

bool checkChannels ( )

inlineprotected

Checks the input and output channels and updates the is_write or is_read scenario flags.

◆ clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

◆ convertFloatBufferToInt()

template<class DSP >

template<class T >

void convertFloatBufferToInt	(	int	samples,
		FAUSTFLOAT **	p_float_in,
		void *	data_out
	)

inlineprotected

Converts the float buffer to int values.

◆ convertIntBufferToFloat()

template<class DSP >

template<class T >

void convertIntBufferToFloat	(	int	samples,
		void *	data_in,
		FAUSTFLOAT **	p_float_out
	)

inlineprotected

Converts the int buffer to float values.

◆ defaultConfig()

template<class DSP >

AudioInfo defaultConfig ( )

inline

◆ deleteFloatBuffer()

template<class DSP >

void deleteFloatBuffer ( )

inlineprotected

◆ end()

template<class DSP >

void end ( )

inlinevirtual

Ends the processing.

Reimplemented from BaseStream.

◆ flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, AudioStreamWrapper, ResampleStream, EncodedAudioStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.

◆ frequency()

template<class DSP >

virtual FAUSTFLOAT frequency ( )

inlinevirtual

◆ gain()

template<class DSP >

virtual FAUSTFLOAT gain ( )

inlinevirtual

◆ getDSP()

template<class DSP >

dsp * getDSP ( )

inline

Provides a pointer to the actual dsp object.

◆ isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

◆ labelValue()

template<class DSP >

virtual FAUSTFLOAT labelValue ( const char * label )

inlinevirtual

Determines the value of a parameter.

◆ midiOff()

template<class DSP >

virtual bool midiOff ( int note )

inlinevirtual

◆ midiOn()

template<class DSP >

virtual bool midiOn	(	int	note,
		FAUSTFLOAT	gain
	)

inlinevirtual

◆ not_supported()

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

inlineprotectedvirtualinherited

◆ noteToFrequency()

template<class DSP >

FAUSTFLOAT noteToFrequency ( uint8_t x )

inlineprotected

◆ notifyAudioChange()

void notifyAudioChange ( AudioInfo info )

inlineprotectedinherited

◆ operator bool()

virtual operator bool ( )

inlinevirtualinherited

Reimplemented in A2DPStream, ICYStreamT< T >, AudioBLEStream, PortAudioStream, URLStream, USBAudioDeviceBase, I2SStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, Pipeline, and AudioFFTBase.

◆ readBytes()

template<class DSP >

size_t readBytes	(	uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Used if FaustStream is used as audio source.

Reimplemented from AudioStream.

◆ readSilence()

virtual size_t readSilence	(	uint8_t *	buffer,
		size_t	length
	)

inlinevirtualinherited

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

◆ 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()

virtual void setAudioInfo ( AudioInfo info )

inlineoverridevirtualinherited

Defines the input AudioInfo.

Implements AudioInfoSupport.

Reimplemented in VS1053Stream, WM8960Stream, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, VolumeStream, MiniAudioStream, PortAudioStream, I2SCodecStream, MozziStream, SPDIFOutput, AudioLoRa, AnalogAudioStream, I2SStream, TimerCallbackAudioStream, AudioBLEStream, MDFEchoCancellationStream< T, SampleType >, AudioKitStream, NRF24Stream, SPIAudioSlave, USBAudioDeviceBase, VBANStream, Equalizer3Bands, Equalizer3BandsPerChannel, AdapterAudioOutputToAudioStream, TimedStream, MeasuringStream, ProgressStream, CallbackStream, VolumeMeter, AudioInputMonitor, FormatConverterStream, FadeStream, GoertzelStream, Pipeline::ModifyingStreamAdapter, QualityAnalysisStream, AudioFFTBase, EncodedAudioStream, PureDataStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.

◆ setBend()

template<class DSP >

virtual bool setBend ( FAUSTFLOAT bend )

inlinevirtual

◆ setFrequency()

template<class DSP >

virtual bool setFrequency ( FAUSTFLOAT freq )

inlinevirtual

◆ setGain()

template<class DSP >

virtual bool setGain ( FAUSTFLOAT gain )

inlinevirtual

◆ setLabelValue()

template<class DSP >

virtual bool setLabelValue	(	const char *	label,
		FAUSTFLOAT	value
	)

inlinevirtual

Defines the value of a parameter.

◆ setMidiNote()

template<class DSP >

virtual bool setMidiNote ( int note )

inlinevirtual

◆ setNotifyActive()

void setNotifyActive ( bool flag )

inlineinherited

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

◆ setWriteBufferSize()

void setWriteBufferSize ( int size )

inlineinherited

◆ write() [1/2]

template<class DSP >

size_t write	(	const uint8_t *	data,
		size_t	len
	)

inlineoverridevirtual

Used if FaustStream is used as audio sink or filter.

Reimplemented from AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

◆ writeSilence()

virtual void writeSilence ( size_t len )

inlinevirtualinherited

Writes len bytes of silence (=0).

◆ writeT()

template<class DSP >

template<class T >

size_t writeT	(	const uint8_t *	write_data,
		size_t	len
	)

inlineprotected

Used if FaustStream is used as audio sink or filter.

Member Data Documentation

◆ _timeout

int _timeout = 10

protectedinherited

◆ buffer_allocated

template<class DSP >

int buffer_allocated

protected

◆ bytes_per_frame

template<class DSP >

int bytes_per_frame

protected

◆ bytes_per_sample

template<class DSP >

int bytes_per_sample

protected

◆ cfg

template<class DSP >

AudioInfo cfg

protected

◆ float_to_int_factor

template<class DSP >

float float_to_int_factor = 32767

protected

◆ gate_exists

template<class DSP >

bool gate_exists = false

protected

◆ info

AudioInfo info

protectedinherited

◆ is_init

template<class DSP >

bool is_init = false

protected

◆ is_notify_active

bool is_notify_active = true

protectedinherited

◆ is_read

template<class DSP >

bool is_read = false

protected

◆ is_write

template<class DSP >

bool is_write = false

protected

◆ notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

◆ p_buffer

template<class DSP >

FAUSTFLOAT** p_buffer =nullptr

protected

◆ p_buffer_out

template<class DSP >

FAUSTFLOAT** p_buffer_out =nullptr

protected

◆ p_dsp

template<class DSP >

DSP* p_dsp = nullptr

protected

◆ p_out

template<class DSP >

Print* p_out =nullptr

protected

◆ tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

◆ tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

◆ ui

template<class DSP >

UI ui

protected

◆ with_output_buffer

template<class DSP >

bool with_output_buffer

protected

◆ write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

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

src/AudioTools/AudioLibs/AudioFaust.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FaustStream() [1/2]

◆ FaustStream() [2/2]

◆ ~FaustStream()

Member Function Documentation

◆ addNotifyAudioChange()

◆ allocateFloatBuffer()

◆ audioInfo()

◆ audioInfoOut()

◆ available()

◆ availableForWrite()

◆ begin() [1/2]

◆ begin() [2/2]

◆ bend()

◆ checkChannels()

◆ clearNotifyAudioChange()

◆ convertFloatBufferToInt()

◆ convertIntBufferToFloat()

◆ defaultConfig()

◆ deleteFloatBuffer()

◆ end()

◆ flush()

◆ frequency()

◆ gain()

◆ getDSP()

◆ isNotifyActive()

◆ labelValue()

◆ midiOff()

◆ midiOn()

◆ not_supported()

◆ noteToFrequency()

◆ notifyAudioChange()

◆ operator bool()

◆ readBytes()

◆ readSilence()

◆ refillReadBuffer()

◆ removeNotifyAudioChange()

◆ setAudioInfo()

◆ setBend()

◆ setFrequency()

◆ setGain()

◆ setLabelValue()

◆ setMidiNote()

◆ setNotifyActive()

◆ setWriteBufferSize()

◆ write() [1/2]

◆ write() [2/2]

◆ writeSilence()

◆ writeT()

Member Data Documentation

◆ _timeout

◆ buffer_allocated

◆ bytes_per_frame

◆ bytes_per_sample

◆ cfg

◆ float_to_int_factor

◆ gate_exists

◆ info

◆ is_init

◆ is_notify_active

◆ is_read

◆ is_write

◆ notify_vector

◆ p_buffer

◆ p_buffer_out

◆ p_dsp

◆ p_out

◆ tmp_in

◆ tmp_out

◆ ui

◆ with_output_buffer

◆ write_buffer_size