CicmWrapper  Beta 0.4
A wrapper for Pure Data
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
Data Structures | Enumerations | Functions
The DSP Object Part

The t_edspobj and t_edspbox part. More...

Data Structures

struct  t_edsp
 The DSP structure. More...
 
struct  t_edspobj
 The DSP object. More...
 
struct  t_edspbox
 The GUI DSP object. More...
 

Enumerations

enum  edsp_flags { E_INPLACE = 0, E_NO_INPLACE = 1 }
 The flags that discribe the behavior of a t_edspobj. More...
 

Functions

void eobj_dspsetup (void *x, long nins, long nouts)
 Initializes the dsp members of the t_edsp. More...
 
void eobj_dspflags (void *x, long flags)
 Initializes the flags of the t_edsp. More...
 
void eobj_dspfree (void *x)
 The t_edspobj deletion function.
This function should replace pd_free(). More...
 
void eobj_resize_inputs (void *x, long nins)
 Resizes the number of signal inputs of a t_edspobj. More...
 
t_sample * eobj_getsignalinput (void *x, long index)
 Retrieves the pointer to the signal of an input. More...
 
t_sample * eobj_getsignaloutput (void *x, long index)
 Retrieves the pointer to the signal of an output. More...
 

Detailed Description

The t_edspobj and t_edspbox part.

This part refers to the methods and structures that can be used by all the t_edspobj structures.


Data Structure Documentation

struct t_edsp

The DSP structure.

It contains all the members for signal processing. This should be used for no graphical object that have signal processing methods.

Data Fields
float d_float

The float member to initialize the signal method.

long d_size

The number of signal inlets and outlets.

t_int * d_vectors

The vector that contains all the pointers for the perform method.

long d_flags

The flags to initialize the perform method.

void * d_user_param

The user parameters to pass through the perform method.

t_float ** d_sigs_out

The array of signal vectors.

t_float * d_sigs_real

The real array of signal.

t_typ_method d_perform_method

The user perform method.

long d_misc

The flag that could be inplace or not.

struct t_edspobj

The DSP object.

It contains the t_eobj with the t_edsp structure. This should be used for no graphical object that have signal processing methods.

Data Fields
t_eobj d_obj

The default object.

t_edsp d_dsp

The dsp structure.

struct t_edspbox

The GUI DSP object.

It contains the t_eobj with all the members for graphical behavior and signal processing. This should be used for graphical object that have signal processing methods.

Data Fields
t_eobj b_obj

The DSP object.

t_symbol * b_receive_id

The object user ID.

t_symbol * b_send_id

The object send ID.

t_symbol * b_objpreset_id

The object preset ID.

t_symbol * b_canvas_id

The canvas ID.

t_symbol * b_drawing_id

The drawing ID.

t_symbol * b_window_id

The window ID.

t_symbol * b_all_id

The global ID.

long b_flags

The ebox flags.

t_rect b_rect

The ebox rectangle.

t_rect b_rect_last

The ebox previous rectangle.

t_efont b_font

The ebox font.

int b_selected_box

The selected state

int b_selected_item

The items selected.

int b_selected_inlet

The inlet selected.

int b_selected_outlet

The outlet selected.

char b_mouse_down

The mouse state.

char b_visible

The visible State.

char b_ready_to_draw

The ebox state for drawing.

char b_have_window

The ebox window state.

char b_isinsubcanvas

If the box is in a sub canvas.

t_edrawparams b_boxparameters

The ebox parameters.

t_elayer * b_layers

The ebox layers.

long b_number_of_layers

The ebox number of layers.

t_edsp d_dsp

The dsp structure.

Enumeration Type Documentation

enum edsp_flags

The flags that discribe the behavior of a t_edspobj.

It define all the behavior of a t_edspobj.

Enumerator
E_INPLACE 

The signal processing can be inplace.

E_NO_INPLACE 

The signal processing can't be inplace.

Function Documentation

void eobj_dspsetup ( void *  x,
long  nins,
long  nouts 
)

Initializes the dsp members of the t_edsp.

Allocate the memory for digital dignal processing of a t_edspobj.
This funtion should replace inlet_new and outlet_new for the signal.

Parameters
xThe edspobj pointer
ninsThe number of signal inputs.
noutsThe number of signal outputs
void eobj_dspflags ( void *  x,
long  flags 
)

Initializes the flags of the t_edsp.

Sets the dsp inplace (default) or not inplace. You should use this function before the call of the dsp method (in the new method for example).

Parameters
xThe edspobj pointer
flagsThe dsp flags.
See also
edsp_flags
void eobj_dspfree ( void *  x)

The t_edspobj deletion function.
This function should replace pd_free().

Frees the memory allocated for digital dignal processing of a t_edspobj.
This function should replace pd_free() and you shouldn't have to call eobj_free();

Parameters
xThe edspobj pointer
void eobj_resize_inputs ( void *  x,
long  nins 
)

Resizes the number of signal inputs of a t_edspobj.

Allocates or free the signal inputs. The method can be called after the allocation of the object.

Parameters
xThe edspobj pointer.
ninsThe number of signal inputs.
t_sample* eobj_getsignalinput ( void *  x,
long  index 
)

Retrieves the pointer to the signal of an input.

Retrieves the pointer to the signal vector of an input.
The can function can only be used during the dsp method call.

Parameters
xThe edspobj pointer.
indexThe index of the input.
Returns
A pointer to the signal vector or NULL.
t_sample* eobj_getsignaloutput ( void *  x,
long  index 
)

Retrieves the pointer to the signal of an output.

Retrieves the pointer to the signal vector of an output.
The can function can only be used during the dsp method call.

Parameters
xThe edspobj pointer.
indexThe index of the output.
Returns
A pointer to the signal vector or NULL.