Generate trigger on/off messages when the input values are greater than a set value. More...

#include <ToGateTrigger.h>

Inheritance diagram for pdsp::ToGateTrigger:

Public Member Functions
Patchable &	set (float threshold, float hysteresis=0.0f)
	Sets the default threshold, optionally set the hysteresis and returns the Unit ready to be patched. More...

void	setHystersis (float hysteresis)
	Sets the hysteresis. More...

Patchable &	in_signal ()
	Sets "signal" as selected input and returns this Unit ready to be patched. This is the default input. This input is the signal that will be used to generate triggers.

Patchable &	in_threshold ()
	Sets "threshold" as selected input and returns this Unit ready to be patched. This input is the threshold value to superate to activate the gate and emit trigger values. Default value is 0.5 .

Patchable &	out_trig ()
	Sets "trig" as selected output and returns this Unit ready to be patched. This is the default output. This is the trigger output to connect to envelopes or "trig" inputs.

float	meter_gate () const
	returns the state of the gate, 1.0f for on / 0.0f for off . This method is thread safe.

Public Member Functions inherited from pdsp::Unit
	Unit (const Unit &other)

Unit &	operator= (const Unit &other)

	Unit (Unit &&other)

Unit &	operator= (Unit &&other)

virtual void	setOversampleLevel (int newOversampleLevel)
	sets the unit oversample level More...

int	getOversampleLevel () const
	returns the Unit oversample level

Public Member Functions inherited from pdsp::Patchable
void	resetInputToDefault ()
	resets the selected input to the default.

void	resetOutputToDefault ()
	resets the selected output to the default.

Patchable &	in (const char *tag)
	sets the selected input to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More...

Patchable &	out (const char *tag)
	sets the selected output to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More...

void	disconnectIn ()
	disconnects all the outputs connected to the selected input, then resets the selected input to the default.

void	disconnectOut ()
	disconnects all the inputs connected to the selected output, then resets the selected output to the default.

void	disconnectAll ()
	disconnects all the inputs and outputs to their connected outputs and inputs. Also resets the selected input and output to the default.

InputNode &	getSelectedInput ()
	returns the selected input, you can patch a Patchable or OutputNode to it with the >> operator.

OutputNode &	getSelectedOutput ()
	returns the selected output, you can patch it to another Patchable or InputNode with the >> operator.

std::vector< std::string >	getInputsList ()
	returns a vector of the valid input tags

std::vector< std::string >	getOutputsList ()
	returns a vector of the valid input tags

Additional Inherited Members
Static Public Member Functions inherited from pdsp::Preparable
static double	getGlobalSampleRate ()

Protected Member Functions inherited from pdsp::Unit
void	prepareToPlay (int expectedBufferSize, double sampleRate) override
	you have to use this method only in the constructor, inside if(dynamicConstruction){ } More...

const float *	processInput (InputNode &node, int &stateNow)
	process the given input, gives you a pointer to the processed buffer as result and its state More...

float	processAndGetSingleValue (InputNode &input, int pos)
	process the given input, gives you a pointer to the processed buffer as result and its state More...

float *	getOutputBufferToFill (OutputNode &node)
	gets a pointer to the output buffer for rendering audio to it, and sets the OutputNode state to AudioRate More...

void	setControlRateOutput (OutputNode &node, float scalarValue)
	sets the OutputNode buffer to "Changed" and its first value to scalarValue More...

void	setOutputToZero (OutputNode &node)
	sets the OutputNode buffer to "Changed" and its first value to 0.0f More...

void	updateOutputNodes ()
	call this method in the Unit constructor after adding all the Outputs, this is mandatory for the inner working of the patching framework.

Protected Member Functions inherited from pdsp::Patchable
void	addOutput (const char *tag, OutputNode &output)
	method to add outputs when constructing a Unit More...

void	addInput (const char *tag, InputNode &input)
	method to add inputs when constructing a Unit More...

void	addModuleOutput (const char *tag, Patchable &unit)
	method to add outputs when constructing a module More...

void	addModuleInput (const char *tag, Patchable &unit)
	method to add outputs when constructing a module More...

Detailed Description

Generate trigger on/off messages when the input values are greater than a set value.

ToGateTrigger generate trigger on/off values from the values got from in_signal(). It also has an "hysteresis" parameter that is how much lower from the threshold the signal has to go to generate a trigger off value. If you want to use it with audio signal maybe it's a good idea to make them pass into another unit to make them positive and then got an envelope from them, like FullWavePeakDetector >> EnvelopeFollower . You can also set the threshold in realtime using in_threshold().

Member Function Documentation

◆ set()

pdsp::Patchable & pdsp::ToGateTrigger::set	(	float	threshold,
		float	hysteresis = `0.0f`
	)

Sets the default threshold, optionally set the hysteresis and returns the Unit ready to be patched.

Parameters

[in]	threshold	Default threshold value to set, it will be overrided by patching.
[in]	hysteresis	Hysteresis value to set, if not specified is 0.0f .

◆ setHystersis()

void pdsp::ToGateTrigger::setHystersis ( float hysteresis )

Sets the hysteresis.

Parameters

[in] hysteresis Hysteresis value to set.

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

ToGateTrigger.h
ToGateTrigger.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ set()

◆ setHystersis()