PiPo
Plug In Plug Out / Plugin Interface for Processing Objects
PiPoDelta Class Reference
Inheritance diagram for PiPoDelta:
PiPo

Public Member Functions

 PiPoDelta (Parent *parent, PiPo *receiver=NULL)
 
int streamAttributes (bool hasTimeTags, double rate, double offset, unsigned int width, unsigned int size, const char **labels, bool hasVarSize, double domain, unsigned int maxFrames)
 Configures a PiPo module according to the input stream attributes and propagate output stream attributes. More...
 
int reset ()
 Resets processing (optional) More...
 
int frames (double time, double weight, float *values, unsigned int size, unsigned int num)
 Processes a single frame or a block of frames. More...
 
- Public Member Functions inherited from PiPo
 PiPo (Parent *parent, PiPo *receiver=NULL)
 
 PiPo (const PiPo &other)
 
virtual void setParent (Parent *parent)
 Sets PiPo parent. More...
 
int propagateStreamAttributes (bool hasTimeTags, double rate, double offset, unsigned int width, unsigned int height, const char **labels, bool hasVarSize, double domain, unsigned int maxFrames)
 Propagates a module's output stream attributes to its receiver. More...
 
int propagateReset (void)
 Propagates the reset control event. More...
 
int propagateFrames (double time, double weight, PiPoValue *values, unsigned int size, unsigned int num)
 Propagates a module's output frames to its receiver. More...
 
int propagateFinalize (double inputEnd)
 Propagates the finalize control event. More...
 
virtual PiPogetReceiver (unsigned int index=0)
 Gets a PiPo modules receiver (call only by the PiPo host) More...
 
virtual void setReceiver (PiPo *receiver, bool add=false)
 Sets a PiPo modules receiver (call only by the PiPo host) More...
 
virtual int segment (double time, bool start)
 Signals segment start or end. More...
 
virtual int finalize (double inputEnd)
 Finalizes processing (optinal) More...
 
void streamAttributesChanged (Attr *attr)
 
void signalError (std::string errorMsg)
 
void signalWarning (std::string errorMsg)
 
void addAttr (PiPo *pipo, const char *name, const char *descr, Attr *attr, bool clear=false)
 att attribute
 
AttrgetAttr (unsigned int index)
 Gets PiPo attribute by index. More...
 
AttrgetAttr (const char *name)
 Gets PiPo attribute by name. More...
 
AttrgetAttr (const char *piponame, const char *name)
 Gets PiPo attribute by qualified name. More...
 
bool setAttr (unsigned int index, int value, bool silently=false)
 
bool setAttr (unsigned int index, int *values, unsigned int numValues, bool silently=false)
 
bool setAttr (unsigned int index, double val, bool silently=false)
 
bool setAttr (unsigned int index, double *values, unsigned int numValues, bool silently=false)
 
unsigned int getNumAttrs (void)
 Gets number of attributes. More...
 
void cloneAttrs (PiPo *other)
 Copies current parent and attributes values. More...
 
void cloneAttr (PiPo::Attr *attr)
 Copies current value(s) of given attribute. More...
 

Public Attributes

PiPoScalarAttr< int > filter_size_param
 
PiPoScalarAttr< bool > normalize
 

Additional Inherited Members

- Public Types inherited from PiPo
enum  Type {
  Undefined, Bool, Enum, Int,
  Float, Double, String
}
 
enum  Enumerate
 
- Static Public Member Functions inherited from PiPo
static float getVersion ()
 
- Protected Attributes inherited from PiPo
Parentparent
 
std::vector< PiPo * > receivers
 
std::vector< Attr * > attrs
 

Member Function Documentation

◆ frames()

int PiPoDelta::frames ( double  time,
double  weight,
float *  values,
unsigned int  size,
unsigned int  num 
)
inlinevirtual

Processes a single frame or a block of frames.

PiPo module: An implementation of this method may call propagateFrames(), typically like this:

return this->propagateFrames(time, weight, values, size, num);

PiPo host: A terminating receiver module provided by a PiPo host handles the received frames and usally returns 0.

Parameters
timetime-tag for a single frame or a block of frames
weightweight associated to frame or block
valuesinterleaved frames values, row by row (interleaving channels or columns), frame by frame TODO: should be const!!!
sizetotal size of each of all frames (size = number of elements = width * height = number of channels for audio)
numnumber of frames (number of samples for audio input)
Returns
0 for ok or a negative error code (to be specified), -1 for an unspecified error

Implements PiPo.

◆ reset()

int PiPoDelta::reset ( void  )
inlinevirtual

Resets processing (optional)

PiPo module: Any implementation of this method requires a propagateReset() method call and returns its return value.

PiPo host: A terminating receiver module provided by a PiPo host usally simply returns 0.

Returns
0 for ok or a negative error code (to be specified), -1 for an unspecified error

Reimplemented from PiPo.

◆ streamAttributes()

int PiPoDelta::streamAttributes ( bool  hasTimeTags,
double  rate,
double  offset,
unsigned int  width,
unsigned int  height,
const char **  labels,
bool  hasVarSize,
double  domain,
unsigned int  maxFrames 
)
inlinevirtual

Configures a PiPo module according to the input stream attributes and propagate output stream attributes.

PiPo module: Any implementation of this method requires a propagateStreamAttributes() method call and returns its return value, typically like this:

return this->propagateStreamAttributes(hasTimeTags, rate, offset, width, height, labels, hasVarSize, domain, maxFrames);

PiPo host: A terminating receiver module provided by a PiPo host handles the final output stream attributes and usally returns 0.

Parameters
hasTimeTagsa boolean representing whether the elements of the stream are time-tagged
ratethe frame rate (highest average rate for time-tagged streams, sample rate for audio input)
offsetthe lag of the output stream relative to the input
widththe frame width (number of channels for audio or data matrix columns)
heightthe frame height (or number of matrix rows, always 1 for audio)
labelsoptional labels for the frames' channels or columns (can be NULL)
hasVarSizea boolean representing whether the frames have a variable height (respecting the given frame height as maximum)
domainextent of a frame in the given domain (e.g. duration or frequency range)
maxFramesmaximum number of frames in a block exchanged between two modules (window size for audio)
Returns
0 for ok or a negative error code (to be specified), -1 for an unspecified error

Implements PiPo.