Difference between revisions of "Component: DSP System (DSP)"

Revision as of 11:12, 16 January 2014

Author	Matrix Ltd
Version	1.2
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

Difference between revisions of "Component: DSP System (DSP)"

Revision as of 11:12, 16 January 2014

Contents

Image DSP System component

Examples

Downloadable macro reference

`TickSpecificBuffer`

`SetBuffer_Idx`

`SetBuff`

`GetBuff`

`TickAllBuffers`

`Initialise`

Simulation macro reference

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 4: / Line 4: @@
 |-
 | width="20%" style="color: gray;" | Author
-| [http://www.matrixltd.com Matrix Ltd]
+| Matrix Ltd
 |-
 | width="20%" style="color: gray;" | Version
@@ Line 15: / Line 15: @@
-==[[File:Component Icon 917f243e_4102_4bee_9998_81f18bc6ca9d.png|Image]] DSP System component==
+==[[Media:Component Icon 917f243e_4102_4bee_9998_81f18bc6ca9d.png|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.
@@ Line 21: / Line 21: @@
 ==Examples==
 The DSP System component is basically a buffer manager for the other DSP components to reference.
@@ Line 147: / Line 146: @@
 This property is of type ''Line of text'' and can be referenced with the variable name ''buff_a_name''.
-''<span style="color:red;">No additional information</span>''
+The name assigned to buffer A
 <span style="font-weight: normal;"><u>Buffer B Name</u></span>
@@ Line 155: / Line 152: @@
 This property is of type ''Line of text'' and can be referenced with the variable name ''buff_b_name''.
-''<span style="color:red;">No additional information</span>''
+The name assigned to buffer B
 <span style="font-weight: normal;"><u>Buffer C Name</u></span>
@@ Line 163: / Line 158: @@
 This property is of type ''Line of text'' and can be referenced with the variable name ''buff_c_name''.
-''<span style="color:red;">No additional information</span>''
+The name assigned to buffer C
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 171: / Line 164: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_a_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 179: / Line 174: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_a_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 187: / Line 184: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_a_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 195: / Line 190: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_b_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 203: / Line 200: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_b_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 211: / Line 210: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_b_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 219: / Line 216: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_c_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 227: / Line 226: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_c_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 235: / Line 236: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_c_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 243: / Line 242: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_d_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 251: / Line 252: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_d_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 259: / Line 262: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_d_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 267: / Line 268: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_e_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 275: / Line 278: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_e_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 283: / Line 288: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_e_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 291: / Line 294: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_f_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 299: / Line 304: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_f_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 307: / Line 314: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_f_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 315: / Line 320: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_g_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 323: / Line 330: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_g_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 331: / Line 340: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_g_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 339: / Line 346: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_h_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffer:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 347: / Line 356: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_h_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 355: / Line 366: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_h_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffer
 <span style="font-weight: normal;"><u>Bit Depth</u></span>
@@ Line 363: / Line 372: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_simp_depth''.
-''<span style="color:red;">No additional information</span>''
+The maximum size of each value in the buffers:
+-bit = 0 to 255 or -128 to 127
+-bit = 0 to 65535 or -32768 to 32767
 <span style="font-weight: normal;"><u>Sign</u></span>
@@ Line 371: / Line 382: @@
 This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_simp_sign''.
-''<span style="color:red;">No additional information</span>''
+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
 <span style="font-weight: normal;"><u>Size</u></span>
@@ Line 379: / Line 392: @@
 This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_simp_size''.
-''<span style="color:red;">No additional information</span>''
+The number of individual values inside the buffers