ofxPDSP
pdsp::GrainWindow Class Reference

Single trigger envelope with a DSP-window shape, with included amp. More...

#include <GrainWindow.h>

Inheritance diagram for pdsp::GrainWindow:
pdsp::Unit pdsp::Preparable pdsp::Patchable

Public Member Functions

Patchableset (float grainLengthMs)
 sets the default envelope length and returns the unit ready to be patched. More...
 
Patchableset (float grainLengthMs, Window_t type, int window_length=1024)
 sets the default envelope length, the envelope window shape, optionally the resolution of the table and returns the unit ready to be patched. More...
 
Patchablein_signal ()
 Sets "signal" as selected input and returns this Unit ready to be patched. This is the default input. This input is the signal to which the envelope is applied. If there are no triggers on in the in_trig() input and the envelope is already terminated this input is not even processed.
 
Patchablein_trig ()
 Sets "trig" as selected input and returns this Unit ready to be patched. You have to patch an out_trig() to this input. The trigger on values received retrigger the envelope.
 
Patchablein_length ()
 Sets "length" as selected input and returns this Unit ready to be patched. This input is checked at control rate so it has no sense to patch audio-rate modulations to it. This is the envelope length in milliseconds. Init default value is 200 ms.
 
Patchableout_signal ()
 Sets "signal" as selected output and returns this Unit ready to be patched. This is the default output. This is the enveloped output.
 
void setWindowType (Window_t type, int window_length=1024)
 sets the envelope window shape, optionally the resolution of the table. More...
 
float meter_window () const
 returns the last processed envelope amplitude value. This method is thread-safe.
 
- Public Member Functions inherited from pdsp::Unit
 Unit (const Unit &other)
 
Unitoperator= (const Unit &other)
 
 Unit (Unit &&other)
 
Unitoperator= (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.
 
Patchablein (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...
 
Patchableout (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.
 
InputNodegetSelectedInput ()
 returns the selected input, you can patch a Patchable or OutputNode to it with the >> operator.
 
OutputNodegetSelectedOutput ()
 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

Single trigger envelope with a DSP-window shape, with included amp.

This is a combination of an amp and a single trigger envelope that use a window shape. It is useful together with Sampler to create granular sampling modules. It uses linear interpolation on the table, for higher resolution choose a bigger table size. Standard table size is 1024.

Member Function Documentation

◆ set() [1/2]

pdsp::Patchable & pdsp::GrainWindow::set ( float  grainLengthMs)

sets the default envelope length and returns the unit ready to be patched.

Parameters
[in]grainLengthMsenvelope length

◆ set() [2/2]

pdsp::Patchable & pdsp::GrainWindow::set ( float  grainLengthMs,
Window_t  type,
int  window_length = 1024 
)

sets the default envelope length, the envelope window shape, optionally the resolution of the table and returns the unit ready to be patched.

Parameters
[in]grainLengthMsenvelope length
[in]typewindow type
[in]window_lengthwindow length, if not specified 1024

◆ setWindowType()

void pdsp::GrainWindow::setWindowType ( Window_t  type,
int  window_length = 1024 
)

sets the envelope window shape, optionally the resolution of the table.

Parameters
[in]typewindow type
[in]window_lengthwindow length, if not specified 1024

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