MartinB: XML import

2015-02-13T11:25:40Z

XML import

← Older revision		Revision as of 11:25, 13 February 2015
Line 1:		Line 1:


	{\| width="50%"		{\| width="50%"
	\|-		\|-
Line 5:		Line 7:
	\|-		\|-
	\| 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

JonnyW: XML import

2014-01-16T15:58:11Z

XML import

← Older revision		Revision as of 15:58, 16 January 2014
Line 1:		Line 1:


	{\| width="50%"		{\| width="50%"
	\|-		\|-

JonnyW: XML import

2014-01-16T13:05:36Z

XML import

← Older revision		Revision as of 13:05, 16 January 2014
Line 15:		Line 15:


	==[[~~Media~~: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.		Must be added to a project to allow the other DSP components to connect together correctly.

JonnyW: XML import

2014-01-16T11:12:01Z

XML import

Show changes

Admin: /* Examples */

2013-11-22T15:26:54Z

Examples

← Older revision		Revision as of 15:26, 22 November 2013
Line 21:		Line 21:

	==Examples==		==Examples==
	~~''<span style="color:red;">No additional examples</span>''~~

			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==

JonnyW: XML import of component help

2013-11-11T17:02:56Z

XML import of component help

← Older revision		Revision as of 17:02, 11 November 2013
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==

JonnyW: XML import of component documentation

2013-08-09T14:20:26Z

XML import of component documentation

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| [http://www.matrixltd.com Matrix Ltd]
|-
| width="20%" style="color: gray;" | Version
| 1.2
|-
| width="20%" style="color: gray;" | Category
| DSP
|}

==[[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.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>TickSpecificBuffer</tt>===
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'''

:[[Variable Types|BYTE]] ''idx''
::Specifies which buffer index to increment (0:A - 7:H)

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SetBuffer_Idx</tt>===
Allows manual control over the buffer index.

'''Parameters'''

:[[Variable Types|BYTE]] ''BufferIdx''
::Specifies which buffer to control (0:A - 7:H)

:[[Variable Types|UINT]] ''Idx''
::Raw index value to assign to the buffer

'''Return value'''

:''This call does not return a value''

===<tt>SetBuff</tt>===
Adds a value into the start of the buffer specified by the idx parameter.

'''Parameters'''

:[[Variable Types|BYTE]] ''Idx''

:[[Variable Types|UINT]] ''Data''

'''Return value'''

:''This call does not return a value''

===<tt>GetBuff</tt>===
Gets a value from the end of the buffer specified by the idx parameter

'''Parameters'''

:[[Variable Types|BYTE]] ''Idx''

'''Return value'''

:[[Variable Types|UINT]]

===<tt>TickAllBuffers</tt>===
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'''

:[[Variable Types|BYTE]]

===<tt>Initialise</tt>===
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''.

''No additional information''

Buffer B Name

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

''No additional information''

Buffer C Name

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Bit Depth

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

''No additional information''

Sign

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

''No additional information''

Size

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

''No additional information''

Component: DSP System (DSP) - Revision history

MartinB: XML import

JonnyW: XML import

JonnyW: XML import

JonnyW: XML import

Admin: /* Examples */

JonnyW: XML import of component help

JonnyW: XML import of component documentation