Difference between revisions of "Component: DSP System (DSP)"
(XML import of component documentation) |
(XML import) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Author | | width="20%" style="color: gray;" | Author | ||
− | | | + | | Matrix Ltd |
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
− | | 1.2 | + | | 1.2 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
Line 17: | Line 17: | ||
==[[File:Component Icon 917f243e_4102_4bee_9998_81f18bc6ca9d.png|Image]] DSP System component== | ==[[File: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. | 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== | ==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== | ==Downloadable macro reference== | ||
Line 140: | Line 146: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''buff_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Buffer B Name</u></span> | <span style="font-weight: normal;"><u>Buffer B Name</u></span> | ||
Line 148: | Line 152: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''buff_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Buffer C Name</u></span> | <span style="font-weight: normal;"><u>Buffer C Name</u></span> | ||
Line 156: | Line 158: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''buff_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 164: | Line 164: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_a_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 172: | Line 174: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_a_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 180: | Line 184: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_a_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 188: | Line 190: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_b_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 196: | Line 200: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_b_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 204: | Line 210: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_b_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 212: | Line 216: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_c_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 220: | Line 226: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_c_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 228: | Line 236: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_c_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 236: | Line 242: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_d_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 244: | Line 252: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_d_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 252: | Line 262: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_d_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 260: | Line 268: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_e_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 268: | Line 278: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_e_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 276: | Line 288: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_e_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 284: | Line 294: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_f_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 292: | Line 304: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_f_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 300: | Line 314: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_f_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 308: | Line 320: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_g_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 316: | Line 330: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_g_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 324: | Line 340: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_g_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 332: | Line 346: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_h_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 340: | Line 356: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_h_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 348: | Line 366: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_h_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 | |
− | |||
− | |||
<span style="font-weight: normal;"><u>Bit Depth</u></span> | <span style="font-weight: normal;"><u>Bit Depth</u></span> | ||
Line 356: | Line 372: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_simp_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 | ||
<span style="font-weight: normal;"><u>Sign</u></span> | <span style="font-weight: normal;"><u>Sign</u></span> | ||
Line 364: | Line 382: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buff_simp_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 | ||
<span style="font-weight: normal;"><u>Size</u></span> | <span style="font-weight: normal;"><u>Size</u></span> | ||
Line 372: | Line 392: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''buff_simp_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 |
Latest revision as of 11:25, 13 February 2015
Author | Matrix Ltd |
Version | 1.2 (Release) |
Category | DSP |
Contents
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
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
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
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