Component: DSP System (DSP)

From Flowcode Help
Jump to navigationJump to search


Author Matrix Ltd
Version 1.2 (Release)
Category DSP


Image DSP System component

DSP System main buffer manager responsible for allocating memory, taking care of buffer indexes and reading / writing the buffers. Must be added to a project to allow the other DSP components to connect together correctly. Multiple DSP systems can be added to a single project to allow for more then 8 individual buffers.

Examples

The DSP System component is basically a buffer manager for the other DSP components to reference.

The DSP system does not perform any specific DSP function by itself.


For examples of how to use the DSP System component please refer to the other functional DSP components.

Downloadable macro reference

TickSpecificBuffer

Moves to the next segment of a specific DSP system buffer.

Returns the first buffer index if the end of a buffer has been reached.

Parameters

BYTE idx
Specifies which buffer index to increment (0:A - 7:H)


Return value

BYTE


SetBuffer_Idx

Allows manual control over the buffer index.

Parameters

BYTE BufferIdx
Specifies which buffer to control (0:A - 7:H)
UINT Idx
Raw index value to assign to the buffer


Return value

This call does not return a value


SetBuff

Adds a value into the start of the buffer specified by the idx parameter.

Parameters

BYTE Idx
UINT Data


Return value

This call does not return a value


GetBuff

Gets a value from the end of the buffer specified by the idx parameter

Parameters

BYTE Idx


Return value

UINT


TickAllBuffers

Moves to the next segment of each DSP system buffer.

Returns the first buffer index if the end of a buffer has been reached.

Parameters

This macro has no parameters


Return value

BYTE


Initialise

Initialises the DSP System allowing DSP components to run correctly.

Parameters

This macro has no parameters


Return value

This call does not return a value


Simulation macro reference

This component does not contain any simulation macros


Property reference

Buffer Count

This property is of type Fixed list of ints and can be referenced with the variable name buffer_count.

Number of DSP buffers to allocate memory for

Simple Mode

This property is of type True or false and can be referenced with the variable name simple_mode.

Simple mode

Yes - all buffers are the same type and length

No - all buffers are configured individually

Buffer A Name

This property is of type Line of text and can be referenced with the variable name buff_a_name.

The name assigned to buffer A

Buffer B Name

This property is of type Line of text and can be referenced with the variable name buff_b_name.

The name assigned to buffer B

Buffer C Name

This property is of type Line of text and can be referenced with the variable name buff_c_name.

The name assigned to buffer C

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_a_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_a_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_a_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_b_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_b_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_b_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_c_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_c_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_c_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_d_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_d_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_d_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_e_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_e_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_e_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_f_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_f_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_f_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_g_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_g_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_g_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_h_depth.

The maximum size of each value in the buffer:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_h_sign.

The typecast sign allowing the values in the buffer to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_h_size.

The number of individual values inside the buffer

Bit Depth

This property is of type Fixed list of ints and can be referenced with the variable name buff_simp_depth.

The maximum size of each value in the buffers:

8-bit = 0 to 255 or -128 to 127

16-bit = 0 to 65535 or -32768 to 32767

Sign

This property is of type Fixed list of ints and can be referenced with the variable name buff_simp_sign.

The typecast sign allowing the values in the buffers to represent negative values:

Signed = -128 to 127 or -32768 to 32767

Unsigned = 0 to 255 or 0 to 65535

Size

This property is of type Signed integer and can be referenced with the variable name buff_simp_size.

The number of individual values inside the buffers