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

From Flowcode Help
Jump to navigationJump to search
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
−
| [http://www.matrixltd.com Matrix Ltd]
+
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
 
| 1.2
 
| 1.2
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| DSP
 
| DSP
 
|}
 
|}
  
  
−
 
+
==Delay component==
−
==[[File:Component Icon e0ddc704_6bab_4d08_8f10_19a14c6683ef.png|Image]] Delay component==
 
 
Allows an adjustable delay to be inserted into the DSP system
 
Allows an adjustable delay to be inserted into the DSP system
  
−
==Examples==
+
==Component Pack==
  
 +
DSP
  
−
Here is a simple example file for the Delay component.
+
==Detailed description==
  
−
[[File:Delay.fcfx]]
 
  
  
−
The DelayADC component is used to set the amount of delay that the component provides 0-2550 samples in steps of 10 samples.
 
  
  
−
The Input ADC component is used to pass a variable value into the DSP chain to allow the delay to be simulated.
 
  
  
−
Here is a picture showing the scope response of the delay component.
 
  
−
[[File:DSPDelay.jpg]]
 
  
  
−
Note: 8-bit PICs can only reference an array of up to 256 elements. Anything more then this will cause compilation errors. There is a workaround documented on the user forums on how to get around this limitation but it adds overhead to the rest of the program.
 
  
−
==Downloadable macro reference==
+
''No detailed description exists yet for this component''
  
−
===<span style="font-weight: normal;"><u><tt>DelayTick</tt></u></span>===
+
==Examples==
−
Passes a single value from a buffer into the delay buffer and spits out a delayed value at the other end
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Delay</tt></u></span>===
 
−
Passes an entire buffer into the delay buffer and spits out a delayed version of the buffer at the other end
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
Here is a simple example file for the Delay component.
  
 +
{{Fcfile|Delay.fcfx|Delay}}
  
−
===<span style="font-weight: normal;"><u><tt>SetDelaySize</tt></u></span>===
+
The DelayADC component is used to set the amount of delay that the component provides 0-2550 samples in steps of 10 samples.
−
Specifies the number of values in the delay buffer to allow the length of the delay to  be adjustable during runtime.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|UINT]] ''Delay_Count''
+
The Input ADC component is used to pass a variable value into the DSP chain to allow the delay to be simulated.
  
  
−
'''Return value'''
+
Here is a picture showing the response of the delay component using the data recorder window.
  
−
:''This call does not return a value''
+
[[File:DSPDelay.jpg]]
  
 +
==Downloadable macro reference==
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DelayArray'''
 +
|-
 +
| colspan="2" | Passes an entire buffer into the delay buffer and spits out a delayed version of the buffer at the other end&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Delay'''
 +
|-
 +
| colspan="2" | Passes a single value from a buffer into the delay buffer and spits out a delayed value at the other end&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
==Property reference==
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
<span style="font-weight: normal;"><u>Max Delay Count</u></span>
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDelaySize'''
 +
|-
 +
| colspan="2" | Specifies the number of values in the delay buffer to allow the length of the delay to  be adjustable during runtime.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Delay_Count
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_delay''.
 
  
−
The maximum number of values to delay the incoming signal by
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PresetDelay'''
 +
|-
 +
| colspan="2" | Presets the contents of the delay buffer with the specified value.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
<span style="font-weight: normal;"><u>Initial Delay Count</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''initial_delay''.
 
  
−
The initial delay that will be used at startup
 
  
−
<span style="font-weight: normal;"><u>Buffer Manager</u></span>
+
==Property reference==
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Specifies the DSP system buffer manager
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
<span style="font-weight: normal;"><u>Input</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Connect To
−
Specifies the buffer which is used as the input to the delay
+
|-
−
 
+
| colspan="2" | DSP component with output buffer to collect our data from.&nbsp;
−
<span style="font-weight: normal;"><u>Output</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''output_c''.
+
| width="90%" | Buffer Size
−
 
+
|-
−
Specifies the buffer which is used as the output to the delay
+
| colspan="2" | Number of individual elements the buffer can store, default 1.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Sample Rate (Hz)</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Buffer Type
−
This property is of type ''Floating point'' and can be referenced with the variable name ''sample_rate''.
+
|-
−
 
+
| colspan="2" | Sets the buffer data type.&nbsp;
−
Sample rate used to generate some useful calculations
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
<span style="font-weight: normal;"><u>Max Delay (s)</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Delay
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''del_max''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Maximum possible delay in seconds at the specified sample rate
+
| width="90%" | Initial Delay Count
−
 
+
|-
−
<span style="font-weight: normal;"><u>Initial Delay (s)</u></span>
+
| colspan="2" | The initial delay that will be used at startup&nbsp;
−
 
+
|-
−
This property is of type ''Floating point'' and can be referenced with the variable name ''del_initial''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Max Delay Count
−
Initial delay in seconds at the specified sample rate
+
|-
 +
| colspan="2" | The maximum number of values to delay the incoming signal by&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 +
| width="90%" | Initial Value
 +
|-
 +
| colspan="2" | Value used to preset the delay buffer.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Delay Calculation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Sample Rate (Hz)
 +
|-
 +
| colspan="2" | Sample rate used to generate some useful calculations&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Max Delay (s)
 +
|-
 +
| colspan="2" | Maximum possible delay in seconds at the specified sample rate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Initial Delay (s)
 +
|-
 +
| colspan="2" | Initial delay in seconds at the specified sample rate&nbsp;
 +
|}

Latest revision as of 17:19, 9 November 2022

Author Matrix Ltd
Version 1.2
Category DSP


Delay component

Allows an adjustable delay to be inserted into the DSP system

Component Pack

DSP

Detailed description

No detailed description exists yet for this component

Examples

Here is a simple example file for the Delay component.

FC6 Icon.png Delay

The DelayADC component is used to set the amount of delay that the component provides 0-2550 samples in steps of 10 samples.


The Input ADC component is used to pass a variable value into the DSP chain to allow the delay to be simulated.


Here is a picture showing the response of the delay component using the data recorder window.

DSPDelay.jpg

Downloadable macro reference

Fc9-comp-macro.png DelayArray
Passes an entire buffer into the delay buffer and spits out a delayed version of the buffer at the other end 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Delay
Passes a single value from a buffer into the delay buffer and spits out a delayed value at the other end 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDelaySize
Specifies the number of values in the delay buffer to allow the length of the delay to be adjustable during runtime. 
Fc9-u16-icon.png - UINT Delay_Count
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PresetDelay
Presets the contents of the delay buffer with the specified value. 
Fc9-u16-icon.png - UINT Value
 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Connect To
DSP component with output buffer to collect our data from. 
Fc9-type-21-icon.png Buffer Size
Number of individual elements the buffer can store, default 1. 
Fc9-type-16-icon.png Buffer Type
Sets the buffer data type. 
Fc9-conn-icon.png Delay
Fc9-type-14-icon.png Initial Delay Count
The initial delay that will be used at startup 
Fc9-type-14-icon.png Max Delay Count
The maximum number of values to delay the incoming signal by 
Fc9-type-14-icon.png Initial Value
Value used to preset the delay buffer. 
Fc9-conn-icon.png Delay Calculation
Fc9-type-15-icon.png Sample Rate (Hz)
Sample rate used to generate some useful calculations 
Fc9-type-15-icon.png Max Delay (s)
Maximum possible delay in seconds at the specified sample rate 
Fc9-type-15-icon.png Initial Delay (s)
Initial delay in seconds at the specified sample rate 
Retrieved from "https://www.flowcode.co.uk/wikiv9/index.php?title=Component:_Delay_(DSP)&oldid=28527"