Audio Object Description User Guide

Interface objects category contains following audio objects.

• AudioIO
• ControlIn
• ControlOut

The AudioIO audio object acts as the interface object between the xAF instance and other audio objects in the single flow design.

This AudioIO object can be configured to either receive audio data (AudioIn) from framework or pass the processed audio (AudioOut) back to the framework.

• When configured as AudioIn, this object copies the audio data from the input audio buffers of the framework to the output buffers of this audio object that is accessible to other audio objects in the pipeline.
• When configured as AudioOut, this object copies the audio data from its input buffer to the output buffers of the xAF instance.

Use Cases: This object can be deployed whenever an audio buffer needs to be sent or received by the framework.

AudioIO Properties

Below table provide the details about AudioIO audio object properties and functionality.

Properties	Description
# of Audio Out Or # of Audio In	Enter the number of audio input or audio output. For any xAF instance, the SFD can have only one input AudioIO object and one output AudioIO object. The number of audio channels of this object shall be same as the number of audio IO of the instance. Range: 1 to 255 Data type: Unsigned short The default value is set to 2.
Display Name	Display name of the AudioIO audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	The AudioIO audio object supports following two modes. Audio In Audio Out

Mode

The AudioIO audio object supports following two modes:

• Audio In: In this case the AudioIO audio object is used to receive audio data from the xAF instance (source). The object will have only audio outputs in this mode to pass the audio to subsequent objects for processing.
• Audio Out: In this case the AudioIO audio object is used to send audio data back to the xAF instance (sink). The object will have only audio inputs in this mode to collect the processed audio and pass it back to the xAF instance audio buffers.

Additional Parameters

There are no additional parameters available for AudioIO audio object.

Tuning Parameters

There are no tuning parameters available for AudioIO audio object.

Control Parameters

There are no control parameters available for AudioIO audio object.

Native Panel

AudioIO audio object does not support native panel.

The ControlIn audio object is deployed to connect the external control signals to the audio objects used in the signal flow. Each framework instance can have only one instance of this ControlIn object. This object serves as the consolidation point for all the control inputs for the framework instance.

Use Cases:

• Use case 1 –Central volume control received (0 to 100% volume) from the Head unit will be forwarded to the controlIn AO. User can design the signal flow using LUT to convert the percentage volume to db unit and send it to Volume AO to manipulate the audio signals. 
• Use case 2 – Bass and treble input from user can be converted to Frequency, Gain and Quality factor for Tone control audio object to give desired affect for the audio signal.  

ControlIn Properties

Below table provide the details about ControlIn object properties and functionality.

Properties	Description
Number of Control Output	The number of control output signals is configurable. Range: 1 to 100 By default, the number of control output signal set to 1.
Display Name	Display the name of the ControlIn object in signal flow design. It can be changed based on the intended usage of the object.

Additionally, in the ControlIn object you can configure the Control ID for each control pin.

The Control IDs can be selected from the available list or you can add the new custom Control IDs. For more details on adding and editing control ID, refer to Control IDs.

Mode

There are no modes available for ControlIn object.

Additional Parameters

There are no additional parameters available for ControlIn object.

Tuning Parameters

There are no tuning parameters available for ControlIn object.

Control Parameters

The ControlIn object pass through the control signals received from the framework instance on the configured pins. Additionally there are no control parameters available specifically to control the functioning of this object.

Native Panel

ControlIn object does not support native panel.

The ControlOut audio object is a framework level object, that ties directly with the framework’s control system. The purpose is to take control values from an xAF instance (AudioProcessingBase) and make them available externally.

The ControlOut audio object accepts any combination of controls – single or block.

Use Case: This object can be deployed whenever framework wants to access any control value of a signal flow. Platform may want to access these values from the framework.

ControlOut Properties

Below table provide the details about ControlOut object properties and functionality.

Properties	Description
Number of Control Input	The number of control Input signals is configurable. Range: 1 to 225 By default, the number of control input signal is set to 1.
Display Name	Display the name of the ControlOut object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no modes available for ControlOut object.

Additional Parameters

Parameters	Description
Group Sizes	This is an additional parameter which is an array with a length equal to NumElements Each value in this array is the size of the corresponding control. Example: [1,2] would mean the first control input is a single control, but the second is a block control of size 2.

Tuning Parameters

There are no tuning parameters available for ControlOut object.

Control Parameters

There are no control parameters available to control the functioning of this object.

Native Panel

ControlOut audio object does not support native panel.

Basic objects category contains following audio objects.

• Delay
• Gain
• Level Monitor
• Fader Balance
• Volume and Mute
• VolumeLite

The purpose of the Delay audio object is to time shift between the input and output audio samples. The audio object has the ability to add delays to several channels, each with a different delay setting.

However, each channel will support the maximum allowed delay set in SFD. As a result, each channel will have a buffer that is the appropriate size to handle the maximum delay. The Delay audio object can be used when a time delay is required in an audio pipeline. The objects supports DelayPool functionality as an operating mode. In this mode, sum of the  individual channel delay configured will be less than or equal to the maximum delay.

Use Case: The Delay audio object can be used when a time delay is required in an audio pipeline.

Delay Object Properties

Below table describes about the Delay audio object properties and functionality.

Properties	Description
# of Channels	The number of channels is configurable in the SFD and is always equal to both, the number of input and output channels. Range: 1 to 225 Data type: uint The default value is set to 1.
Max.delay(ms)	Specifies the maximum possible delay for each channel in audio object. For Delay Pool  (Refer below on mode details) mode Max Delay is maximum delay which can be utilized by all channels combined.  Range: 1 to 9999 ms Data type: uint The default value is set to 1. Max delay value specified in milliseconds (ms).
Display Name	Display name of the Delay audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	Delay object operates in one of the following three modes. Instant CrossFade DelayPool m_Mode is used to specify whether the change in the delay is Instant or uses a Crossfade or operate as DelayPool.

Mode

Delay object operates in one of the following three modes.

Parameter	Description	Value	Data Type
Instant	No fading – change straight to the newly requested delay value. This is the default mode.	0 (Instant)	uint
CrossFade	To avoid audio discontinuity when the delay value changes.	1 (Crossfade)	uint
DelayPool	Max Delay determines the total DelayPool size which is common for all the channels. When the delay of individual channel is configured, the sum of delay values (of all the channels) can not exceed Max Delay. Changes in delay values are accepted by the audio object only when sum does not exceed Max Delay. It does not support fading and no control inputs are added in this mode. When the sum of delay values exceeds the Max Delay and preset is applied in parameter-sets of GTT, then the UI may group some delay changes into one xTP command. This may cause audio objects to accept some delay value changes and reject other delay value changes. This accept/reject can happen because, the audio object checks to see if the sum exceeds Max Delay on receiving xtp command. Audio object would accept the delay values when the sum returns back to acceptable limit (sum <= Max delay).	2 (DelayPool)	uint

Additional Parameters

Parameter	Description
Crossfading Duration in ms	Fade time, only effective when the delay is operating in Crossfade mode. Range: 1 to 1000 Data type: Float The default value is set to 50.
Configuration Control Input(s)	Configuration control inputs (Enable/Disable). If set to 0 – Disables control inputs. If set to 1 – Enables one control input to configure the delay value for all channels. If set to 2 – Enables one control input per channel for individual configuration.

Tuning Parameters

Parameter	Details	Default Value	Range	Data type
Delay	Delay to be applied across each channel	0 (sec)	0 – Max.delay (sec)	Float

Control Parameters

Parameter	Details	Default Value	Range	Data type
Delay(OneSet)	One control input is added to set the delay value for all audio channel to the same configured value.	0 (sec)	0 – Max.delay (sec)	Float
Delay(MultiSet)	One control input per channel is added to set the delay for individual channel.	0 (sec)	0 – Max.delay (sec)	Float

The Delay panel associated with Delay audio object. The Delay panel is used for changing the delay of the signal for each channel.

• Maximum / Minimum Delay Value:  The maximum and minimum delay values are from corresponding state variable of Delay.
• Threshold Values: The maximum and minimum threshold values are derived from the GTT in the ParameterStore. Once the threshold value is reached, the Delay value bar will change to red color.
  • Maximum threshold value: 95 %
  • Minimum threshold value: Not set
    
    
• Changing Units: You can switch between the milliseconds, samples, centimeters.

Milliseconds

Samples

Centimeters

• Object Mode (Instant/CrossFade): In GTT the delay values are derived from the parameter store. Each channel’s delay value is configurable from 0 to Max Delay.
  
• Object Mode (DelayPool): In GTT the delay values are derived from the parameter store. When the object mode is set to DelayPool, the “Overall delay used” shown is sum of delay values of all the channels. Sum of the delay of channels is expected not to exceed Max Delay. Changes in delay values are accepted by the audio object only when sum does not exceed Max Delay.
  
  You can find the overall “delay value used” at the top of the Delay panel. The value in text area changes its color depending on the percentage of the maximum overall delay value.

• • Up to 80 % of the delay pool
    
  • From 80 % – 100 % of the delay pool
    
  • 100 % of the delay pool
    
• Step Size for delay: In the application settings, you can change the global step size. The local step size in the delay audio object is derived from the global step size specified in the application settings. When you change the value of the local step size, the global step size value is no longer used.
  

To change the Delay Value

You can change the delay value in four ways:

• Using slider button: Select the slider to adjust the delay value.
• Using mouse scroll: Hover on the respective column and use mouse scroll to adjust the delay value.
• Using text box: Select the respective column and enter the dB value within the specified minimum and maximum range. Once you’ve entered the value, press Enter, and the slider will automatically adjust based on the input.
• Using the increase and decrease buttons the delay calculated step value (based on max delay (ms)).

The purpose of the Gain audio object is to provide amplitude scaling of the signal for each channel. The gain object also supports invert and mute feature.

Use Case: This object is deployed whenever a gain is required in the audio pipeline.

Gain Object Properties

Details about the Gain audio object properties and functionality.

Properties	Descriptions
# of Channels	In the Signal Flow Designer (SFD), you can specify the maximum possible gain for the audio object. The number of channels is configurable in the SFD and is always equal to both, the number of input and output channels. Range: 1 to 225 Data type: uint The default value is set to 1.
Display Name	Display name of the gain audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Gain audio object.

Additional Parameters

There are no additional parameters available for Gain audio object.

Tuning Parameters

The gain audio object supports in-place computation based on the core type.

The following are the paraments you can tune in to GTT.

Parameter	Description	Unit	Range
Gain	Applied on the input channel.	dB	-128 to 20
Invert	If set to 1, the input value is multiplied by -1. If set to 0, the input value is multiplied by 1.	None	0 or 1
Mute	If set to 1, the output is muted. If set to 0, the output is not muted.	None	0 or 1

Control Parameters

There are no control parameters available for Gain audio object.

The Gain panel associated with Gain audio object. The Gain panel is used for changing the gain of a signal for each channel.

When you open a gain native panel, the Logarithmic scale is set to the default value. You can toggle option to switch between Linear and Logarithmic scale.

The gain values in the Logarithmic scale are rounded off to nearest next digit. For Linear scale values are retained as user entered.

• Logarithmic Scale: Gain values are displayed rounded to the nearest whole number.
  Example:
  If the gain value is -10.4 in Logarithmic scale it will be shown as -10.
  If the gain value is -10.7 in Logarithmic scale it will be shown as -11.

All Gain panel functionalities are fully supported and work seamlessly when using the logarithmic scale.

• Linear Scale: Gain values are shown exactly as entered.
  Example:
  If the gain value is -10.8 in Linear scale it will be shown as -10.8.
  

On switching between these two options only scale is changed, State variable values and Tunning data remain same, Unless user changes the actual value.

When switching between logarithmic and linear scales, only the way gain values are displayed is affected. The underlying state variable values and tuning data remain unchanged unless you manually change the actual value.

• Maximum / Minimum Gain Value:  The maximum and minimum gain values are from corresponding state variable of Gain.
  • Maximum value: 20 dB
  • Minimum value: – 120 dB
• Threshold Values: The maximum and minimum threshold values are derived from the ParameterStore in GTT. Once either of the threshold values is reached, the Gain value bar will change to the color red.
  
  
• In Phase / Invert: To invert or Inphase the gain value
  • Click on the In Phase to invert the gain value.
  • Click on the Inverted to in phase the gain value.
    
• Mute: The Mute button sets the gain value to a minimum gain value. Even if the gain value is muted, you can change it. 
  
• Mute all: The Mute all button sets all gain values to minimum gain values. If all gains are muted, the Mute all button will change to Muted. 
  
• Solo:  The Solo button mutes all the channel except the selected one. Additionally, the phase of all the muted channels get disabled. Click on the Solo button again, to unmute all the channels.
  
  

To change the Gain value

You can change the gain value in four ways:

• Using slider button: Select the slider to adjust the value.
• Using mouse scroll: Hover on the respective column and use mouse scroll to adjust the value.
• Using text box: Select the respective column and enter the dB value within the specified minimum and maximum range. Once you’ve entered the value, press Enter, and the slider will automatically adjust based on the input.
• Using the increment and decrement buttons  you can change the gain value.

The Level Monitor is intended to measure the level of input; the audio samples are sent to the output without modification.

Use case: This object can be deployed in Level Monitor mode whenever there is a need to measure level of signal level and in Clip Meter mode to check if the level is causing clipping. The same input is sent as output without modification.

Level Monitor Properties

Below table describes about the Level Monitor audio object properties and functionality.

Properties	Descriptions
# of Channels	In the Signal Flow Designer (SFD), the number of control outputs is equal to the number of audio channels. Each control output writes out the channel level/clip indication value based on the MODE selected. Range: 1 to 254 Data type: Signed Short The default value is set to 1.
Display Name	Display name of the Level Monitor audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	During design time, the audio object channel can be configured in one of the two operation modes. Level Monitor Clip Meter

Mode

During design time, the audio object can be configured in one of the two operation modes.

• Level Monitor
• Clip Meter

Mode	Description
Level Monitor	This is the default mode. In this mode, the signal level is measured and the value is sent to the control output.
Clip Meter	In this mode, object computes the signal level and compares it with the threshold set through the tuning parameters. A flag is set / reset if the signal level is above / below the threshold and this flag is sent to the control output.

Additional Parameters

There are no additional parameters available for Level Monitor audio object.

Tuning Parameters

Under Level Monitor mode, following are the tuning parameters available for each channel.

Parameter	Description	Range	Default	Data Type	Unit
LEV_MODE	To select the method of computation of input signal level RMS: It is the RMS value of the input signal Linear: It is average of the input signal Peak: It is the peak/max sample value In all the above types, the computed level is always presented in dB (logarithmic scale)	0 – RMS 1 – LINEAR 2 – PEAK	0	Float	NA
DB_LEAK_PER_SEC	Amount of dB drop per second in Peak Level mode.	1 to 60	30	Float	dB
PEAK_HOLD_TIME	Amount of time peak is held.	0 to 1	0.05	Float	second

Under Clip Meter mode, following is the tuning parameter available for each channel.

Parameter	Description	Range	Default	Data Type	Unit
Threshold	Threshold value for the channel to treat a signal as being clipped.	-20 to 20	-0.25	Float	dB

State Parameters

Under Level Monitor mode, following is the state parameter available for each channel.

Parameter	Description	Range	Default	Data Type	Unit
LEVEL_VALUE	Measured signal level for the channel	-128 to 20	0	Float	dB

Under Clip Meter mode, following is the state parameter available for each channel.

Parameter	Description	Range	Default	Data Type	Unit
Clip Indicator	Clip Indicator for the channel based on the tuned threshold parameter	0 or 1	0	Unsigned Long	None

Control Parameters

Under Level Monitor mode, following is the control output available for each channel.

Parameter	Description	Range	Data Type	Unit
Signal Level	Measured signal level for the channel	-128 to 20	Float	dB

Under Clip Meter mode, following is the control output available for each channel.

Parameter	Description	Range	Data Type	Unit
Clip Indicator	Clip Indicator per channel based on the tuned threshold parameter	0 or 1	Float	None

 

Level monitor custom native panel can be used to visualize measurements and to tune measurement parameters, like types of level values. Panel shows as many channels as it is specified in SFD.

Level Monitor object has 2 working mode.

• Level Monitor: Level Monitor mode is used by engineers to measure level of volume in audio pipeline.

• Clip Meter: Clip Meter mode is used to check if the level is causing clipping.
  

State tab is used to show the level values or clipping indicators. This tab is read only.
Tune and custom tabs are used to adjust measurement parameters.

The primary purpose of Fader Balancer audio object is to optimize the audio quality within the vehicle’s cabin by adjusting the sound distribution. Basically, this audio object allows to identify the “sweet spot” of the sound by moving in the x and y directions. 

The Fader Balance object has only one operating mode and has three additional configuration parameters – Speaker Groups, Number of Steps, and Block Control. Using these additional parameters, you can configure the setup during design time.

Each audio channel may belong to one or two speaker group as set in the additional variable. Fader speaker group has the following speaker types:

• CENTER
• SIDE
• BASS
• FRONT
• REAR

Balance speaker group has the following speaker types:

• CENTER
• LEFT
• RIGHT

Each speaker type in each speaker group has its own gain table.

The output samples are generated by multiplying the input samples with the composite gain value that is a product of the gain levels of the Balance and Fader gain tables assigned to this channel and as pointed by the control inputs – Control_Balance and Control_Fader. The composite gain value is morphed to avoid pops.

Channel configuration (assignment to speaker types of the selected speaker groups), morphing time, and the gain level of each step are configurable through xTP interface. Basically, we are mixing run-time tuning (add cfg params) and design-time tuning (add cfg params). GTT is used for configuration in general, and xTP is the protocol used to deliver tuning data.

Fader and Balance positions are provided through control inputs.

Fader Balance is ported from the Summit version with the following differences:

• The option for 4 modes is not supported. This shall be handled with the preset files. The number of control inputs is brought down to 2 due to this change.
• Stand-alone Fader AO and Balance AO can be achieved by configuring the additional parameters in the SFD.
• The step count is made as an additional variable instead of using the “Number of Elements” field.
• The channel configuration is done using a drop-down menu to select only one speaker type in each speaker group. This prevents the selection of multiple speaker types by mistake.

Use Case: Using this method, you can optimize the sound loudness on the left or back of the cabin.

Fader Balance Properties

Below table describes about the Fader Balance audio object properties and functionality.

Properties	Descriptions
# of Channels	The number of audio channels it can process is configurable in the SFD and ranges from 1 to 255. The number of audio inputs is always equal to the number of audio outputs. Range: 1 to 225 The default number of channels is set to 8.
Display Name	Display name of the Fader Balance audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Fader Balancer.

Additional Parameters

Parameters	Description
Speaker Groups	Speaker Groups can be set to one of the following three options: Fader and Balance speakers (0) – Default Balance speakers only (1) Fader speakers only (2)
Number of Steps	The “Number of Steps” is a common variable that controls the number of gain levels that the user can operate. To control the gain level of fader and balance speakers the value shall be odd, and this value is common for balance and fader speaker groups. The number of steps need to be an odd number and shall range from 3 to 65 with the default value at 31. The xAF data order is set as “xAF_ODD” to communicate to the GTT through DDF to prevent entering even numbers by the user.
Block Control	Block Control Disabled (0) – Default Block Control Enabled (1)

Tuning Parameters

The following tuning parameters available for Fader Balancer audio object.

Parameter Name	Description	Type	Unit	Default value
MorphingTime	Morphing time. The range is from 0 ms (no morphing) to 100 ms. Morphing time follows time constant and the morphing time is denoted as M. Following is the percentage of change achieved:  – After M: 63% – After 2M: 86%  – After 3M: 95%  – After 4M: 98%  – After 5M: 99% Hence the morphing time can be configured accordingly.	float	ms	0.01
Channel # Assignment	This parameter assigns particular audio channel to one or none of the speaker types in each group. The following pair of speaker type assignment is available for each channel. Balance Speaker Types: CENTER, LEFT, RIGHT and None Fader Speaker Types: CENTER, SIDE, BASS, FRONT, REAR and None	ULong ULong	— —	BAL_CENTER FAD_CENTER
BalanceCenterTable	Balance table for center speaker group. The gain value for each step is tunable. Range: -128 to 0 dB	float	dB	0
BalanceLeftTable	Balance table for left speaker group. The gain value for each step is tunable. Range: -128 to 0 dB	float	dB	0 dB for the first (NUMBER_OF_STEPS+1)/2 steps, next are linearly decreased with equal step in dB scale to -128 dB.
BalanceRightTable	Balance table for right speaker group. The gain value for each step is tunable. Range: -128 to 0 dB	float	dB	Start from -128 dB and are linearly increased with equal step in dB scale to 0dB to (NUMBER_OF_STEPS-1)/2 step, next their value is 0 dB.
FaderCenterTable	Fader table for center speaker group. The gain value for each step is tunable.Range: -128 to 0 dB	float	dB	0
FaderSideTable	Fader table for side speaker group. The gain value for each step is tunable. Range: -128 to 0 dB	float	dB	0
FaderBassTable	Fader table for bass speaker group. The gain value for each step is tunable.Range: -128 to 0 dB	float	dB	0
FaderFrontTable	Fader table for front speaker group. The gain value for each step is tunable. Range: -128 to 0 dB	float	dB	0 dB for the first (NUMBER_OF_STEPS+1)/2 steps, next are linearly decreased with equal step in dB scale to -128 dB.
FaderRearTable	Fader table for rear speaker group. The gain value for each step is tunable. Range: -128 to 0 dB	float	dB	Start from -128 dB and are linearly increased with equal step in dB scale to 0dB to (NUMBER_OF_STEPS-1)/2 step, next their value is 0 dB.

Control Parameters

The following two control parameters available for Fader Balancer audio object.

• Balance – To set the Balance knob position
• Fader – To set the Fader knob position

General tab

Basically, this audio object allows to identify the “sweet spot” of the sound by moving in the x and y directions. Using this method, you can optimize the sound loudness on the left or back of the cabin.

Used to map the channels to Balance Speaker group and Fader speaker group.

• Morphing time: The range is from 0 s (no morphing) to 0.1 s.
  Morphing time follows time constant and the morphing time is denoted as M. Following is the percentage of change achieved:
  – After M: 63%
  – After 2M: 86%
  – After 3M: 95%
  – After 4M: 98%
  – After 5M: 99%
  Hence the morphing time can be configured accordingly.

The morphing time (through V release) is actually a time constant.  Therefore if you want your morph 99+% complete in 100ms you should specify 20ms, not 100.  One time constant will morph 63% of the way there.

• Channel assignment: Assigns a particular audio channel to one or none of the speaker types in each group.
  • Balance Speaker Types: CENTER, LEFT & RIGHT
  • Fader Speaker Types: CENTER, SIDE, BASS, FRONT & REAR

Fader tab

Used to control the gain level of fader in the range -128  to 0 dB.

• Front
• Center
• Side
• Rear
• Bass

Balance tab

Used to control the gain level of balance in range -128 dB to 0 dB.

• Center
• Left
• Right

The purpose of the Volume and Mute audio object is to control the volume or mute in the audio pipeline. Additionally, Volume block also amplitude scaling with ramps.
Use a custom native panel to change the Volume and Mute audio object parameters. The mode and tune type may also be selected at design time from within SFD.

The Volume and Mute audio object supports in-place computation based on the core type.

Volume and Mute Properties

Below table describes about the Volume and Mute audio object properties and functionality.

Properties	Descriptions
# of Channels	In SFD, the number of channels is specified, and the number of input channels is equal to the number of output channels. Range: 1 to 128 Default: 1
Display Name	Enter the display name of the audio object. It can be changed based on the intended usage of the object.
Object Mode	Volume object operates in one of the three modes. One Set Multi Set Multi Set Ramp

Mode

Volume object operates in one of the three modes.

Mode	Description
One Set	In this mode, the volume object exposes these six values. Volume value Mute Invert Ramp Up Rate (in dB/s) Ramp Down Rate (in dB/s) Ramp Shape Jump – Ramping between two states is non-existent – immediate transition. The ramp up and down rates are ignored in this case. Linear – Ramping between two states is linear. Exponential – Ramping between two states follows an exponential curve. These values are applied across all channels of the module. The ramping variables are only available via parameter tuning in this mode.
Multi Set:	In this mode, Volume, Mute, and Invert values are available per channel. One set of ramp rates and shape however is applied to all channels. The ramping variables are only available via parameter tuning.
Multi Set Ramp:	In this mode, Volume, Mute, Invert, Ramp Up rate, Ramp Down Rate, and Ramp shape values are all available per channel.

 

Additional Parameters

Volume and Mute audio object consist of following additional parameters.

• Ramp Tuning Mode
• Boot State
• Boot Level
• Mute state on volume change

Parameters	Description
Ramp Tuning Mode	Ramping is applied when a transition or change occurs and is specified in terms of rate (ms/dB) or time (ms). 0 – Ramp rate in ms/dB. 1 – Ramp time in ms.
Boot State	The boot-up or start-up state of the Volume AO can be specified in 0 or 1. 0 – Unmuted (default) 1 – Muted
Boot Level	The amplitude level of the Volume AO at boot-up or start-up time can be specified. Range: -128 dB to + 20 dB The default value shall be 0 dB.
Mute state on volume change	The desired state of the AO when the volume parameter is changed while the object is in Mute state is specified here. 0 – Unmute on volume change (default) 1 – Remain muted (apply the last set volume level after unmuting specifically)

Tuning Parameters

Ramp Parameters: The Volume audio object exposes ramp rate/time settings that can be adjusted from GTT. 

Parameters	Descriptions	Range	Unit
Ramp Up Rate or Time	Ramp up rate in ms/dB or ramp time in ms.	0 to 1000	ms/dB or ms
Ramp Down Rate or Time	Ramp down rate in ms/dB or ramp time in ms.	0 to 1000	ms/dB or ms
Ramp Shape	The shape the volume will change according to once a volume or mute control is triggered.	Volume_Jump Volume_Lin Volume_Exp

Volume Parameters: The Volume object has three state parameters volume, mute and invert (phase shift of 0 or 180) per channel.

This functionality is only triggered in the multi-set mode.

Parameters	Descriptions	Range	Unit
Volume	Volume to be applied on all input channels	-128 to 20	dB
Mute	Mute to be applied on all input channels	0 or 1
Invert	If set to 1, all input channels will be multiplied by -1 If set to 0, all input channels will be multiplied by 1	0 or 1

Dynamic Control

Parameters	Descriptions	Range	Unit
Volume	Volume to be applied on all input channels	-128 to 20	dB
Mute	Mute to be applied on all input channels	0 or 1

Control Parameters

The Volume control is triggered whenever a control message is addressed to the audio object.  The volume object has 2 control pins or indexes for Volume and Mute.

Parameters	Descriptions	Range	Unit
Volume	Volume to be applied on all input channels	-128 to 20	dB
Mute	Mute to be applied on all input channels	0 – Un mute 1 – Mute

When engineers need to control the volume or mute settings in their audio pipeline, they utilize the Volume and Mute audio objects. To modify the parameters of these objects, a custom native panel is used.

Possible configuration and its effects are shown in the table below.

Configuration	Effect
Mode	Tune and State	Ramp Characteristic
OneSet	Volume , Mute, and Invert is common to all channels.	Ramping values is common to all channels.
MultiSet	Volume ,Mute and Invert is for each individual channels.	Ramping values is common to all channels.
MultiSet Ramp	Volume, Mute, and Invert and Ramping values is for each individual channels.

Based on the configuration, user interface of the panel can vary.

As a result of this fact, the user interface of the current panel also undergoes changes to accommodate all the controls necessary for handling the audio object configuration.

 You can modify any available state variables.

• To change volume, down or up ramp rate/time please use vertical faders or textboxes under them.
• To mute a specific channel in “Multi Set” modes or all channels in “Single Set” mode, simply click on the “Muted” or “Unmuted” button.
• To shift the phase of a specific channel in “Multi Set” modes or all channels in “Single Set” mode, click on the “In Phase or Inverted” button.

For ramping parameters, ramp shape can be set in one out of three shapes.

• Linear ramp shape
• Exponential ramp shape
• Jump ramp shape (volume increases immediately without any ramp shape)

The purpose of the VolumeLite audio object is to control the volume in the audio pipeline. The VolumeLite audio object is light weight and different from “Volume Mute” AO. The object can alter the output volume by either attenuating or amplifying the audio.
This audio object supports ramping and each channel has its own set of – state variables as well as ramping parameters.

Use Case: The object can be used to control the volume of  an audio channel.

VolumeLite Properties

Below table describes about the VolumeLite audio object properties and functionality.

Properties	Description
# of Channels	In SFD, the number of channels is specified, and the number of input channels is equal to the number of output channels. Range: 1 to 128 Default: 1
Block Control	The object  supports Block Control when the object is configured with more than one channel. It has one block control input which controls the output volume of which size is equal to the number of channels configured for the audio object. Block Control is enabled by default and cannot be disabled.

Mode

There are no mode available for VolumeLite audio object.

Additional Parameters

Parameter	Description
Boot Level	It specifies the required volume level at boot time when configured. It is applicable for all the channels. Range: -128 dB to +20 dB. Default: 0 dB

Tuning Parameters

The following are the tuning parameters that can configure from GTT.

Parameters	Description	Range	Default	Data Type
Ramp Up Time	Ramp up time in ms per channel.	0 to 1000 ms	5 ms	Float
Ramp Down Time	Ramp down time in ms per channel.	0 to 1000 ms	5 ms	Float
Ramp Shape	The shape of the  volume will change accordingly once it  is triggered and applies across all channels.	Linear Exponential	Linear	ULong
Volume	Volume to be applied per input channel	-128 to 20 dB	0 dB	Float

All the channels can be tuned with one command as  all are in the same subblock compared to Volume Mute object.

Control Parameters

The Volume control is triggered whenever a control message is addressed to the audio object. Block Control is deployed only when object has more than one channel. It has one block control input, the size of which is equal to the number of channels configured for the audio object.

Parameters	Description	Range	Unit
Volume	Volume to be applied per input channel	-128 to 20 dB	dB

Native Panel

The native panel for VolumeLite audio object is under development.

Control objects category contains following audio objects.

• Control Math
• Control Grouper
• Control GroupSplitter
• Control Multi Adder
• Control Mixer
• Control Router
• Control Smooth
• MultiStage Envelope
• AudioToControl
• Lookup Table (LUT)
  

The Control Math audio object provides the ability to manipulate input control signals.

Control Math Properties

Below table describes about the Control Math audio object properties and functionality.

Properties	Description
Number of outputs/inputs	Enter the number of control outputs or inputs. When the object mode is set to ADD/SUBTRACT/MULTIPLY/    MAXIMUM/MINIMUM/EQUAL / AND / OR / NOR / NAND / XOR the input control pin is enabled. Input value range 2 to 16. Output value is 1. Default value is set to 2. When the object mode is set to LIN2DB / DB2LIN /INVERT / RECIPROCAL / SQUARE / SQUAREROOT the input control pin is equal to output control pin. When the object mode is set to DIVIDE/GREATER/LESS, the input control pins are 2 and output control pin is 1. When the object mode is set to NOT/CTRLDELAY, the input and output control pin is 1. When the object mode is set to CTRLSPLIT, the input control pin is 1 and output control pins are configurable between 2 to 32. When the object mode is set to CTRLDUPLICATE, the input control pins are  configurable between  1 to 16 and output control pins are twice the input control pins. When the object mode is set to NONLINEARCLIP, the input control pins are 3 and output control pin is 1. When the object mode is set to INDEX, the input control pins are  configurable between  2 to 255 and output control pins are 2.
Display Name	Display name of the control math audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	Control Math audio object supports twenty-six modes of operation. This audio object can be configured in the SFD to operate in one of the following modes: Add Subtract Divide Multiply Minimum Maximum Lin2dB dB2Lin Invert Square Reciprocal SquareRoot And Or Xor Not Nand Nor Greater Less CtrlSplit CtrlDuplicate CtrlDelay NonLinearClip Equal Index Default object mode is set to Add.

Mode

The Control Math audio object supports following modes.

Mode	Description
ADD	In this mode, control inputs into the object are summed up and their sum is fed to the output of the object.
SUBTRACT	The difference between the first control input and the summation of the remaining control inputs into this object is sent out at the output.
MULTIPLY	Takes in input controls and writes their product to the output of the object.
DIVIDE	Takes 2 input controls and writes the result of their division to the output. If the divisor is zero, the result is set to the maximum float value.
MAXIMUM	Takes the input controls and writes out the maximum of the values.
MINIMUM	Takes in input controls and writes out the minimum of the values.
LIN2DB	Takes a linear control value as an input and outputs it’s logarithmic equivalent to the specific output pin. If the input is less than or equal to zero, the result is set to zero.
DB2LIN	Takes a logarithmic control value as an input and outputs it’s linear equivalent to the specific output pin.
INVERT	Reads in a control value and outputs the negative (inverse) of that value to the specific output pin.
RECIPROCAL	Takes in a value, x, and outputs its reciprocal (1/x). If the input value is zero, the result is set to the maximum float value to the specific output pin.
SQUARE	Takes in a value, x, and outputs its squared value to the specific output pin.
SQUAREROOT	Takes in an input value, x, and outputs its square root, . If the input is negative, the result is set to zero to the specific output pin.
AND	Takes in multiple inputs and outputs the logical AND operation of these inputs.
OR	Takes in multiple inputs and outputs the logical OR operation of these inputs.
XOR	Takes in multiple inputs (x1, x2, x3, xn) and outputs the logical XOR operation (((x1 xor x2) xor x3) xor xn) of these inputs.
NOT	Takes in an input, and outputs the NOT
NAND	Takes in multiple inputs (x1, x2, x3, xn) and outputs the logical NAND operation (((x1 nand x2) nand x3) nand xn) of these inputs.
NOR	Takes in multiple inputs (x1, x2, x3, xn) and outputs the logical NOR operation (((x1 nor x2) nor x3) nor xn) of these inputs.
GREATER	Takes in 2 inputs, and and outputs true if .
LESS	Takes in 2 inputs, and and outputs true if .
EQUAL	Takes in multiple inputs and outputs true if all the input values are equal.
SPLITTER	Takes in an input control and writes the output to a user specified number of output pins.
DUPLICATE	Takes in a user specified number of inputs and writes each input out to 2 output pins.
DELAY	Takes in a user setting delay (in ms) and writes out the output only after that delay time has passed.
NONLINEARCLIP	Takes in 3 inputs, x, min, and max. Provide the output as max if x is greater than max. Provide the output as min if x is less that min. Provide the output as x if x is greater that min and less than max.
INDEX	It takes in multiple control inputs and outputs two control values. The first control output returns the index of the minimum value among the control inputs. The second control output returns the index of the maximum value among the control inputs. In case of maximum or minimum values being the same, it returns the index of the first encounter.

Additional Parameters

Control Math audio object supports additional configuration which allows to enabled or disabled Block Control. Which can be enabled or disabled by selecting between Block Control Disabled and Block Control Enabled. The object shall support Block Control in the following operating modes:

Block Control Enabled –

• Set “Object Mode” to EQUAL / AND / OR / NOR / NAND / XOR to enable the Block control, the number of input control pins can be grouped to one input block control pin.
• Set “Object Mode” to LIN2DB / DB2LIN /INVERT / RECIPROCAL / SQUARE / SQUAREROOT to enable the Block control, the number of input and output control pins can be grouped to one input block control pin and one output block control pin respectively.

By default, the Block Control function is disabled.

Tuning Parameters

There are no tuning parameters available for Control Math audio object.

Control Parameters

There are no control parameters available for Control Math audio object.

Native Panel

Control Math audio object does not support native panel.

The Control Grouper audio object allows to merge two or more individual controls and combining them into a single output group, and then send as one signal output group to the connected object.

Use Case: The Control Grouper audio object is useful in context of the Block Control feature. When control signals are received from controlIn AO it will be received as individual control signals. If audio object needs all control signals together then control grouper can be used to combine the control signals. 

Refer block control documentation for more details. 

Control Grouper Properties

Below table describes about the Control Grouper audio object properties and functionality.

Properties	Description
# of controls in Group	Enter the number of control inputs. It is also the number of signals within the one group to control output. The number of control group output is always 1. Range: 2 to 128 Data type: Float The default value is set to 2.
Display Name	Display name of the Control Grouper audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	The audio object supports two modes of operations. Send When All Received (Default mode) Send On Apply

Mode

Control Grouper supports two modes.

• Send When All Received (Default mode)
• Send On Apply

Mode	Description
Send When All Received	In this mode Control Grouper AO does not send a control group output every time a control input is received. The Control Grouper AO waits till all the control inputs are received and then sends the control group output. If the control inputs are coming at a different rate, the object sends the control group output at the rate of the slowest incoming control input.
Send On Apply	In this mode, Control Grouper AO has an additional “Apply” input pin. When input is received on apply pin, Control Grouper AO sends the group output. Control inputs have default values. These values are exposed as tuning parameters, these values can be modified using state variable explorer. These values are used, when one or more inputs are not received before the input on apply pin is received.

Additional Parameters

There are no additional parameters available for Control Grouper audio object.

Tuning Parameters

There are no tuning parameters available for Control Grouper audio object.

Control Parameters

There are no control parameters available for Control Grouper audio object.

Native Panel

Control Grouper audio object does not support native panel.

The Control GroupSplitter audio object splits one control group input into multiple individual control outputs.

Use Case: This object can be deployed if user wants to split the block control to individual control signals which needs to be connected to different audio objects.  

Control GrouperSplitter Properties

Below table describes about the Control GroupSplitter audio object properties and functionality.

Properties	Description
# of controls in Group	Enter the number of control outputs. It is also the number of signals within the one group to control input. The number of control group input is always 1. Range: 2 to 128 Data type: xFloat32 The default value is set to 2. The Control GroupSplitter audio object accepts a single block control at its input and splits it into a user-configurable number of single control outputs.
Display Name	Display name of the Control GrouperSplitter audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Control GroupSplitter audio object.

Additional parameters

There are no additional parameters available for Control GroupSplitter audio object.

Tuning Parameters

There are no tuning parameters available for Control GroupSplitter audio object.

Control Parameters

The object always has N single control outputs. The number N is described via the number of elements variable in SFD. The object always has one group control input.

Native Panel

Control GroupSplitter audio object does not support native panel.

The Control MultiAdder audio object provides the ability to manipulate input control signals. Refer description column of num elements for algorithm description. 

Use Case: This object can be deployed whenever the addition of control inputs is required. Additionally, this object is used as the LUT Adder in Halosonic.

ControlMultiAdder Properties

Below table describes about the Control MultiAdder audio object audio object properties and functionality.

Properties	Description
Number of Elements	A minimum of three control inputs into the object are summed up and their sum is fed to the control output of the object. Each time the Control Multi Adder control input is set, it calls the corresponding control output. The object has 3 control inputs for elemental addition and forwards control value into an output. Example: If the numElements is 4, there will be 4 control outputs [y1, y2, y3 and y4] and 12 control inputs [x1 to x12]. The control outputs are computed as shown in the figure below. Maximum control inputs possible for a control multi adder instance are 255. For N elements specified from the configuration, 3N control input values would give N control output values. The number of control outputs is selected by numElements. The number of control inputs = 3 * numElements. The maximum number of control outputs is limited to 85, So the maximum number of control inputs is 85*3 = 255.
Display Name	Display name of the Control MultiAdder audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Control MultiAdder audio object.

Additional parameters

There are no additional parameters available for Control MultiAdder audio object.

Tuning Parameters

There are no tuning parameters available for Control MultiAdder audio object.

Control Parameters

There are no control parameters available for Control MultiAdder audio object.

Native Panel

Control MultiAdder audio object does not support native panel.

The Control Mixer audio object provides a mechanism to mix and route control signal from input to output. The mixer sums values from selected control inputs and pushes the sum to the output. Numbers of inputs and outputs are configurable via GTT. It enables N inputs to be connected to M outputs which is configurable ranging from 1 to 254. If there isn’t any input signal associated with output, the output wouldn’t be changed.

The non-weighted mode with one connected control input output channel. Connection can be changed from state variable window in GTT during tuning, but its impact will be visible once input at that control pins is changed.

It takes control signals as inputs and emits control signals as outputs. Many inputs can also be connected to one output and output can be left unconnected also. It can copy any input to arbitrary number of outputs (from 0 to number_of_outputs). It means that some inputs can be copied to multiple outputs, or some inputs can be cut (not used further in the pipeline). On the other hand, one output can have at most single input connected to it. Below picture illustrates the idea.

Control Mixer Properties

Below table describes about the Control Mixer audio object properties and functionality.

Properties	Description
Display Name	Display name of the control mixer audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	Based on the weighing factor of the control inputs to be mixed, the Control Mixer works in two different modes. Non-weight mixer(default) Weight mixer

Mode

The Control Mixer supports in two modes.

• Non-weight mixer(default)
• Weight mixer

Additional Parameter

Parameter	Description
Number of control input and output	The max input and output in additional configuration is 100. Range: 1 to 254 The default number of control input and output pin is 1.

Tuning Parameters

There are no tuning parameters available for Control Mixer audio object.

Control Parameters

Default control input output is 1 and configurable through additional configuration from 1 to 254 (max).

The Control Mixer object supports native panel. The native panel window consists of rows and column. The number of row and column depends on “number of control inputs and outputs” configured. 

In Non Weight Mode, table cells can have only two values 0 or 1.

In Weight Mode, table cells can have values from 0 to 1.

Control Mixer supports copy-pasting values from and into Excel sheets.

You can store the specific configuration and recalled via Store Preset option available on the panel. Configure the tuning parameters and select the free preset slot numbers, enter the name of the slot, and click Store preset. This saves and stores the current tuning data to the selected slot.

If you do not enter a name of the slot, then it will take the default named “New Preset”.

You can switch between presets slots and apply their values by simply clicking on them. Additionally, after clicking to override the preset, you can modify the tuning values in that tab or change the preset name.

To reset the selected preset or all the preset values.

• Click Reset Selected to clear the preset that is currently selected.
• Click Reset All to clear every preset in the corresponding native panel.

The Control Router audio object provide a mechanism to route control signal from input to output. The router allows to change path of control signal during runtime, which allows for flexibility when designing audio signal pipeline.

This object can be deployed whenever different control inputs to be routed to an object.

It can have arbitrary number of inputs and outputs ranging from 1 to 254 and enables the inputs to be cut or copied to any number of outputs.

Control Router Properties

Properties	Description
Display Name	Display name of the Control Router audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Control Router audio object.

Additional Parameters

Parameter	Description
Number of control input and output	The max input and output in additional configuration is 100. Range: 1 to 254 The default number of control input and output pin is 1.

Tuning Parameters

There are no tuning parameters available for Control Router audio object.

Control Parameters

Default control input output is 1 and configurable through additional configuration from 1 to 254 max.

The Control Router audio object supports native panel. The native panel window is a dynamic native panel. Panel get adapted in size based on the Router AO configuration. 

By default, all outputs are disconnected.

Every output has an input that can be configured. More than one output can be assigned to a single input signal.
It is possible that some input signals are not assigned to any output.

Additionally, this panel enables to store presets for specific configuration.

Name of preset is configurable in separate window after click Store button:

The Control Smooth audio object is used to smoothen the sharp changes in the control values before feeding them as control inputs to another AO. Sharp changes in the control value could cause artifacts in the audio output; in these situations, the Control Smooth audio object can be used to prevent artifacts.
For smoothening, this audio object uses a simple one pole filter that offers exponentially raising step response. 

Use Case: This Control Smooth audio object can be used where there is a necessity to avoid drastic changes in control values that are fed as control inputs to an audio object.  Below are a few examples:

• Interpolation between CAN updates.
• Control value smoothing to help avoid chatter in AO blocks with control thresholds or hysteresis (eg. gearshift simulator, steady state fade-out control, RNC control for vehicle speed ON/OFF control).
• Audio Objects that do not have support for ramping for change in control values.

Control Smooth Properties

Below table describes about the Control Smooth audio object properties and functionality.

Properties	Description
Number of Controls	Enter the number of control IO. The number of control inputs is same as the number of control outputs and the same is configurable via GTT.  Range: 1 to 16 Default: 1
Display Name	Display name of the Control Smooth audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

The Control Smooth object does not support any modes.

Additional Parameter

Parameter	Description
Block Control	This variable is used to enable or disable block control. 0 – Block Control Disabled (Default) 1 – Block Control Enabled

Tuning Parameters

The object has the below three tuning parameters that are applicable for all the control inputs.

Parameter	Description	Data Type	Range	Default	Unit
Bypass	The Control Smooth object functionality can be bypassed with this option	ULong	0 – Bypass OFF 1 – Bypass ON	0	None
Smooth Time	Time taken by the smoothening filter to reach the target control value	Float	Block length duration to 10000	Block length duration	ms
Hysteresis	The tolerance below or above which the filter starts adapting to new target value	Float	0 to 100	0	percent

Control Parameters

Default number of control IO is 1 and configurable through the AO property – NumElements.

Native Panel

The Control Smooth object does not support native panel.

The MultiStage Envelope creates a control signal that changes over time in both deterministic and non-deterministic ways. It is a control-signal generator that generates a signal that changes over time by successively interpolating from one stage to the next, where each stage consists of a time and level pair.

It enables the randomization or adjustment of time, level, and curve shape within deterministic ranges. When the final stage is reached, it is possible to loop back to a specific segment.

MultiStage Envelope Properties

Below table describes about the MultiStage Envelope audio object properties and functionality.

Properties	Description
No. of Steps	Enter the number of stages or steps (nSteps). Multistage Envelope supports up to a maximum of 16 stages and looping back to any stage based on the configuration is allowed. So, the envelope generation can be continued in loop between stages. Time and level of each step is controlled by a fade parameter enabling the randomness and adjustments. Range: 2 to 16 Data Type: uint32_t Default number of stages or steps (nSteps) is set to 2.
Display Name	Display name of the MultiStage Envelope audio object in signal flow design. It can be changed based on the intended usage of the object.

Below are the control input params:

• Reset
• Loop
• Shape
• Shape_Random
• Fader
• Fader_Random

First 6 of the Tuning params mentioned below are same as the control input params above. So, these 6 params can be controlled externally as well as internally.

Mode

There are no mode available for MultiStage Envelope audio object.

Additional Parameters

There are no additional parameters available for MultiStage Envelope audio object.

Tuning Parameters

The following are the parameters you can tune in GTT.

Parameter	Data Type	Default Value	Range	Details
Reset	UInt	0	0 to 2	RESET =1: Reset the envelope generation from initial stage. RESET =2: AO stops envelope generation immediately and continue outputting last stage target value RESET=0: Do nothing and continue generation.
Loop	UInt	0	0 to nSteps	Loop back to specified segment when last step is completed and continues envelope generation in loop when Loop is not 0.
Shape	Float	0.0	-1.0 to 1.0	Specify shape or slope of envelope segments. The shape shall be varied in between the values. -1.0 (inverse exponential) 0.0 (linear) 1.0 (quasi exponential)
Shape_Random	Float	0.0	0.0 to 1.0	For a new random value to be created on start of each new segment, the value is added to SHAPE, and result is limited to [-1:1]. Full scale generated shape value will then be in the range [SHAPE_RND to SHAPE_RANDOM]
Fader	Float	0.0	0.0 to 1.0	Specify fade to linearly vary between levels/times. Pair of values of level and time is configured for each step. For each next level/time, the value is varied linearly between the pairs with FADER and FADER_RANDOM to get the target level/time.
Fader_Random	Float	0.0	0.0 to 1.0	For a new random value to be created on start of each new segment, the value is added to FADER and result is limited to [0:1]. Full scale generated fader value will then be in the range[-FADER_RANDOM to SHAPE_RANDOM]
OutScalFac	Float	1.0	-32767.0 to 32767.0	Scale the envelope output level. This parameter is used to scale the envelope output range. By default, the env output range will be between 0.0 to 1.0. So, this param value is used to scale that value to a bigger range specified in the next column.
LevelMinValue	Float	0.0	-32767.0 to 32767.0	Used to set lower value of envelope output range. By default, the env output range is  between 0.0 to 1.0. The output envelope is scaled in range LevelMinValue and LevelMaxValue.
LevelMaxValue	Float	1.0	-32767.0 to 32767.0	Used to set highest value of envelope output range. By default, the env output range will be between 0.0 to 1.0. The output envelope is scaled in range LevelMinValue and LevelMaxValue.
TimeA1	Float	100.0 ms	1.0 to 10000.0 ms	First time value from the time pair of Step 1. The time duration to reach next step from Step1 is varied between TimeA1 and TimeB1.
TimeB1	Float	100.0 ms	1.0 to 10000.0 ms	Second time value from the time pair of Step 1. The time duration to reach next step from Step1 is varied between TimeA1 and TimeB1.
LevelA1	Float	0.0	0.0 to 1.0	First level value from the level pair of Step1. The source level of Step1 is varied between LevelA1 and LevelB1.
LevelB1	Float	0.0	0.0 to 1.0	Second level value from the level pair of Step1. The source level of Step1 is varied between LevelA1 and LevelB1.
Shape1	Float	0.0	-1.0 to 1.0	This value determines the shape of the envelope from step1 to the next step. This value can be overridden by the 3rd tuning param, i.e. Shape which overwrites the shape of all steps.
TimeAN	Float	100.0 ms	1.0 to 10000.0 ms	First time value from the time pair of Step N. The time duration to reach next step from Step N is varied between TimeAN and TimeBN.
TimeBN	Float	100.0 ms	1.0 to 10000.0 ms	Second time value from the time pair of Step N. The time duration to reach next step from Step N is varied between TimeAN and TimeBN.
LevelAN	Float	0.0 if N is odd 1.0 if N is even	0.0 to 1.0	First level value from the level pair of Step N. The source level of Step N is varied between LevelAN and LevelBN.
LevelBN	Float	0.0 if N is odd 1.0 if N is even	0.0 to 1.0	Second level value from the level pair of Step N. The source level of Step N is varied between LevelAN and LevelBN.
ShapeN	Float	0.0	-1.0 to 1.0	Specify shape of the envelope between Step N and the next Step. This value can be overridden by the 3rd Tuning param, i.e. Shape, which is common for all the steps.

State Parameters

Parameter	Data Type	Default Value	Range	Notes
Envelope	Float	0.0	-32767.0 to 32767.0	To stream the control output. This parameter is streamable.

 

Control Parameters

The following are the control input parameters in GTT, there are 6 control inputs.

Parameter	Description	Range
RESET	RESET = 1: Reset the envelope generation from initial stage. RESET = 2: Deactivate envelope generation. Outputs last stage level value. RESET = 0: Do nothing	0 or 2
LOOP	Loop back to specified segment when last step is completed and continues envelope generation in loop.	0 to nSteps
SHAPE	Specify shape or slope of envelope segments. The shape shall be varied in between the values. -1.0: inverse exponantial 0.0: linear 1.0: quasi exponential	-1.0 to 1.0
SHAPE_RND	For a new random value to be created on start of each new segment, the value is added to SHAPE and result limited to [-1:1] Full scale generated random value is in the range -SHAPE_RND…SHAPE_RND,	0.0 to 1.0
FADER	Specify fade to linearly vary between levels/times. Pair of values of level and time is configured for each step. For each next level/time, the value is varied linearly between the pairs with FADER and FADER_RND to get the target level/time.	0.0 to 1.0
FADER_RND	For a new random value to be created on start of each new segment. the value is added to FADER and result limited to [0:1] Full scale generated random value is in the range 0…FADER_RND,	0.0 to 1.0

Illustration

The below diagram shows four 8-stage envelopes obtained from different settings of Time, Level and Shape. Each color-coding describes envelopes obtained from different runs of the algorithm.

For Example, settings of orange color envelope are show below.

1. nSteps = 8
2. So, Time and Level pairs will be: TimeA1,TimeB1,LevelA1,LevelB1,…,TimeA8,TimeB8,LevelA8,LevelB8
3. TimeA1=30ms, TimeB1=30ms
4. TimeA2=20ms, TimeB2=100ms
5. Fader=1.0
6. Fader_Random=0.0
7. LevelA1=0.8, LevelB1=0.8
8. LevelA2=0.1, LevelB2=0.03

To scale envelope output tuning parameter “LevelMinValue” and “LevelMaxValue” are used. There is no restriction added for “LevelMinValue” to be lower than “LevelMaxValue” in Tuning. It is required to set “LevelMinValue” to be smaller than “LevelMaxValue”. User can choose the values as per requirement of envelope output scaling.
Linear regrssion is used to scale the envelope output. Below is formula used for scaling the output.
outValue = LevelMinValue + (LevelMaxValue – LevelMinValue)*stepLevelValue
if want to scale level value from 0 to 1 to -128 to 128 LevelMinValue and LevelMaxValue value used should be
LevelMinValue = -128
LevelMaxValue = 128

Native Panel

MultiStage Envelope audio object does not support native panel.

The AudioToControl audio object receives audio data, it calculates the envelope based on the mode of operation (either RMS or Peak) and forwards them onto control outputs.
This object accepts N number of input audio signals and calculates the envelope and sends them into corresponding control outputs.

Below are the features of AudioToControl audio object.

• The control outputs / state values are in linear scale.
• The AO supports all sample rates and blocklengths supported by xAF. The AO only reads the audio samples for calculating RMS or peak values. The AO supports in-place computation.

AudioToControl Properties

Below table describes about the AudioToControl audio object properties and functionality.

Properties	Description
# of Channels	Enter the number of channels. The number of control outputs are equal to number of channels. This audio object operates in RMS and Peak modes. Range: 1 to 254 By default, the number of channels is set to 1.
Display Name	Display name of the AudioToControl audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	This audio object works in two modes. RMS Peak

Mode

• RMS: The RMS value of input audio channels are calculated and sent out in corresponding control out channel.
• Peak: The Peak value of input audio channels are calculated and sent out in corresponding control out channel.

Additional Parameters

There are no additional parameters available for AudioToControl audio object.

Tuning Parameters

It has tunable parameters attack and release time.  Attack and release time are common for all channels.

Parameter	Data Format	Memory Offset	Unit	Range	Default Value
Attack time	float	0	Msec	0 to 1000	100
Release time	Float	4	Msec	0 to 1000	10

The AudioToControl audio object has state parameters envelope value for all channels, rate attack and rate release. The states are read-only.

Parameter	Data Format	Memory Offset	Unit	Range	Default Value
Channel 1 envelope	Float	0	None	– 9999 to 9999	None
Channel 2 envelope	Float	4	None	– 9999 to 9999	None
Channel N envelope	Float	(N – 1) * 4	None	– 9999 to 9999	None

Control Parameters

There are no control inputs. The number of control outputs is always equal to the number of audio inputs.

Native Panel

AudioToControl audio object does not support native panel.

The Lookup Table (LUT) audio object performs a table lookup to create a relationship between a control input and a control output.

For example, The LUT converts vehicle speed value to gain by manipulating the speed values using a look up table. LUT module interpolates values of multiple 1-D functions (i.e. control outputs) at specific query points using ‘linear’ or ‘none’ interpolation.

The number of columns in the LUT is configurable by modifying the number of control outputs from the SFD. The first column of the table contains one independent vector which corresponds to the x axis of the interpolation. Each of the corresponding columns corresponds to the interpolation slopes for the outputs. The number of rows of LUT denote the number of steps in interpolation of each control output.

The LUT performs linear interpolation between values.

• If the control input is below the minimum value in the x- axis, the LUT will output the minimum value in the table.
• If the control output is above the maximum value, the output is limited to the maximum value in the table.

The LUT supports Axis Linearity and when enabled, LUT optimizes interpolation and assumes equally spaced steps of interpolation i.e., x-axis interpolation.

• If ‘Linear’ Interpolation (interpolation type = 1) is selected and the control input has value between two rows, then it is manipulated to create the control output vector.
• If ‘None’ (interpolation type = 2) is selected and the control input has value between two rows, then control output is the previous known control output. This follows for the other control inputs.

LUT Axis linearity is to be used with linearly spaced axis values.

Every time the LUT receives an input on its control pin, it will output on each control pin output (one per element).

Currently, the LUT is a series of dimensional tables of resolutions from 2-200. The number of elements corresponds to the number of columns. The table resolution on columns is configurable by modifying the first additional variable ‘Table Height’. Both the dependent and independent table values are configurable in the GTT. The x-axis (control-input) needs to be in ascending order and is configurable through the tuning tool.

Lookup Table Properties

Below table describes about the Lookup Table (LUT) audio object properties and functionality.

Properties	Description
Number of elements	Enter the number of channels. Range: 1 to 254 Default is set to 1.
Display Name	Display name of the LUT audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	LUT works in two modes. LUT 2d LUT Index

Mode

LUT audio object is used to manipulate some control input to pass to one or multiple connected objects. The object operates in two modes.

Mode	Description
LUT 2d	In the 2D mode, there is one control input, and the number of outputs varies based on the number of elements selected. The objective of this LUT mode is to take in a control input, such as vehicle speed, and interpolate an output value, such as gain, based on values set during tuning. The output is then sent as input to other audio blocks. Primary Success Scenario The user will tune the object and initialize from GTT. Capture input parameter. Perform interpolation to determine output, based on the selected interpolation type. Output to next object in signal flow.
LUT Index	In the Index mode, there is a second control input. This control input selects which ‘set’ of tables to use. Otherwise the modes behave the same. The number of sets is configured by the additional variable ‘LUT Depth’. The maximum depth is 8. The objective of this mode of LUT operation is to determine output given an indexed set of tables. Primary Success Scenario The user will tune the object and initialize from GTT Capture input parameters Determine which indexed table to use Perform interpolation to determine output, based on the selected interpolation type Output to next object in signal flow

Additional Parameters

Following are additional parameters you can configure, for more details refer to Additional Parameters.

• Table Height
• UNUSED_VAR
• LUT Axis Linearity
• LUT Depth
• Interpolation Type
• Block Control
• Group

Parameter	Description
Table Height	This parameter corresponds to the size of each table in linear steps which can be configured through an additional configuration variable. Default height of each table in linear steps is 2. Min height of each table in linear steps is 2. Max height of each table in linear steps is 200.
UNUSED_VAR	This parameter is used to configure old variable through an additional configuration variable which is used to control how values were ramped outside of table ranges.
LUT Axis Linearity	This parameter is used to set the manipulation logic for interpolation through an additional configuration variable. Manipulation logic 0: Input axis may be unevenly spaced. This allows the user to specify table resolution where needed but requires greater effort by the object resulting in slower execution time. 1: Object assumes evenly spaced values on the input axis in order to speed operations. Default value of LUT Axis Linearity is 0.
LUT Depth	This parameter is used to determine the depth of the table which can be configured through an additional configuration variable. Default depth of each table in linear steps is 1. Min depth of each table in linear steps is 1. Max depth of each table in linear steps is 8.
Interpolation Type	This parameter supports one additional configuration of Interpolation type which decides the type of interpolation for values on the output axis. This decides how output is computed for an input value that is between two given input axis values. Linear = 1: This is the default type. It provides standard linear interpolation of output between two axis points. None = 2: This is Zero-hold or “previous” type of interpolation. For a given input, control output is the value of the output that corresponds to most previous input.
Block Control	This parameter supports additional configuration of Block Control which can be enabled or disabled by selecting between Block Control Disabled (default) and Block Control Enabled. If it is enabled, all the control output signals are grouped into one control pin.
Group	The Group feature allows organizing the LUT audio objects into different groups. When the native panel of any LUT audio object is opened, all the LUT audio objects with the same group name are displayed in that native panel. If no LUT objects are assigned to any group, native panel displays all the LUT audio objects.

Tuning Parameters

The total number of tuning parameters depends on the LUT table height, table depth, and number of elements; which specifies the number of dependent output values and is equal to the number of columns in the LUT parameter table.

Hence, the number of elements = number of control outputs = number of LUT table columns.

In the LUT table, there is also an additional column for ‘LUT Index’ mode, which stores the values of x-axis interpolation points. As a result, the total number of elements in the LUT’s parameter memory is as follows.

Parameter	Description	Data Type	Range	Unit
m_Params for ‘LUT 2D’ mode	Total tuning parameters = (NUM_ELEMENTS+1) * TableHeight	Float	-99999.0 to 99999.0	None
m_Params for ‘LUT Index’ mode	Total tuning parameters = (NUM_ELEMENTS+1) * TableHeight * TableDepth	Float	-99999.0 to 99999.0	None

Control Parameters

There are one or two control input values for LUT based on the mode selected.

• LUT 2D: 1 float word
• LUT Index: 2 float words

The first corresponds to the value that needs to be converted to control output. The second determines which table index to use for interpolation.

Name	Description	Data Type	Range	Unit
m_states [0]	Corresponds to the control input value that needs to be modified.	Float	-32768.0 to 32767.0	None
m_states [1]	Determines which table index to use for interpolation.	Float	1.0 to 8.0	None

Create LUT Object

1. Load xAF DLL in GTT that supports LUT.
2. Open the Signal Flow Designer.
3. Drag and drop LUT audio object into the Signal flow design view.
   
4. Verify the object is created with no error messages.

The properties and compare to these defaults.

The additional variables below are not actually object variables, they only belong to the GUI object are not covered by this document. See GTT documentation for further information.

AudioObject Properties		Additional Variables
number of elements	1	Table Height	2
Object Mode	LUT 2D	UNUSED_VAR	0
		LUT Axis Linearity	0
		LUT Depth	1
		Interpolation type	1
		Block Control	0

Create LUT Object in Mode 0 (LUT 2D)

1. The object should already be in mode 0 (LUT 2D).
2. Verify there is one control input and one control output. Change the number of elements to three.
3. Verify the object now has three control outputs.
   

Create LUT Object in Mode 1 (LUT Index)

1. Change the object mode to LUT Index.
2. Verify the object now has two control inputs.
3. Change the number of elements to six.
4. Verify the object now has six control outputs.
   

LUT object supports native panel. The native panel window consists of the options to enter the values.

To open the native panel, double-click on the LUT object in the SFD. Set the values accordingly.

Routing objects category contains following audio objects.

• Router
• Splitter
• Demux
• Selector
  

The Router audio object routes any of the input channel to any output channel without changing samples of the source. Additionally, you can route the same input channel to multiple output channels.

In the SFD, you can select the values that they prefer for “# Input channels” and “# Output channels”. These values can be distinct.

Use Case: This object can be deployed whenever each output channel is routed to any one of the input channels.

Router Properties

Below table describes about the Router audio object properties and functionality.

Properties	Description
# of Audio In	Enter the number of input channels. Range: 1 to 255 Data type: Unsigned short The default value is set to 1.
# of Audio Out	Enter the number of output channels. Range: 1 to 255 Data type: Unsigned short The default value is set to 1.
Display Name	Display the name of the Router audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	Router object operates in one of the following two modes. Jump Ramping

Mode

Router object supports two different modes of operation. After selecting the router object in GTT, one can configure the modes as described below.

By default, the router object is configured to operate in the Jump mode.

• Jump: In this mode, the object performs the tuning or routing without any ramping and switches the input to output routing between two calc calls. This might cause clicks and pops if no fading or mute stage is performed on an instance or core level.
• Ramping: In this mode, the object will perform a ramping while changing the input to output routing. In addition to the routing parameters this mode supports a tuning of the ramp time in the range of 0 to 5 seconds.

Presently, the object supports only linear ramping. The ramping type is not configurable.

If the router is configured with six input and six output channels, the tuning parameters will be displayed in GTT as shown below.

Additional Parameters

There are no additional parameters available for Router audio object.

Tuning Parameters

Below table describes the tuning parameters of Router audio object.

Parameter	Description	Unit	Data Type	Default	Range
Router	Each output channel has this parameter to configure the Input channel number to route to the particular output channel. This parameter is available in both modes.	None	ULong	1	1 to Number of Audio Inputs
RampTime	Ramping time This parameter is available only in Ramping mode	Seconds	Float	0.5	0 to 5

Control Parameters

There are no control parameters available for Router audio object.

Router panel is a dynamic native panel. Panel get adapted in size based on the Router AO configuration.

The Splitter audio object copies the samples of one input channel to multiple output channels. 

Use Case: This object can be deployed whenever an input channel to an object is required to be replicated to multiple channels at the output.

Splitter Properties

Below table describes about the Splitter audio object properties and functionality.

   

Properties	Description
# of Audio Out # of Audio In	In Splitter, the number of input and output channels depends on the selection of object mode. –  # of Audio Out: When the object mode set as “Splitter”, you can configure number of the output channel in the “# of Audio Out” field. The number of the input channel is always 1 and the output channel can set between below range. Range: 2 to 225 The default value is set to 2. # of Audio Out is the default configuration.  – # of Audio In: When the object mode set as “MultiInput”, you can configure number of the input channel in the “# of Audio In” field as per below range. Range: 1 to 127 The default value is set to 1.
Display Name	Display the name of the Splitter audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	The audio object channel can be configured in one of the two operation modes. Splitter MultiInput

Mode

Splitter object operates in one of the two modes.

• Splitter
• MultiInput

Mode	Description
Splitter	The purpose of Splitter mode is to copy the input audio data N times to the output buffers. In this mode you can set the number of output channels and number of input channel is always fixed to one.  The object replicates the single input channel to all output channels of the object. This is the default mode. The additional parameter “Number of Outputs per Input channel” is not supported in Splitter mode.
MultiInput	The purpose of the MultiInput mode is to use one instance of the audio object instead of instantiating it N times if you have N channels.  The number of output channels equals the number of audio inputs multiplied by the value entered in the additional configuration variable “Number of Outputs per Input channel”. The maximum number of audio outputs is determined by the number of inputs, as number of output channel per object cannot exceed 255. It splits multiple signals the same number of times. The number of copies of each input channel produced at the output is determined by the value set in the additional configuration variable.

Additional Parameters

Parameters	Description
Number of Outputs per Input channel	The object has an additional configuration variable “Number of Outputs per Input channel”  for MultiInput mode. It denotes the number of copies of each input channel. It is configurable between 2 to (255/Number of Audio Inputs).For example, if number of audio inputs are set to 25. Then the “Number of Outputs per Input channel” value is configurable  between 2 to 10 as the maximum number of output channels supported cannot exceed 255.  Default : 2

Tuning Parameters

There are no tuning parameters available for the Splitter audio object.

Control Parameters

There are no control parameters available for the Splitter audio object.

Native Panel

Splitter audio object does not support a native panel.

The Demux audio object routes input channel samples to any one of the output channels without any change in sample values whereas the rest of the output channels have zero values.
This audio object has a single input audio buffer and several output buffers. The number of output channels is configurable in the SFD.

The Demux object always has one variable that the GTT can access, and that variable is the one that determines which output channel the input should be written.

Use Case: This object can be deployed whenever an input channel to an object is required to be routed to one specific output channel (selected via tuning).

Demux Properties

Below table describes about the Demux audio object properties and functionality.

Properties	Description
# of Audio Out	Enter the number of output channels. Based on a tuning variable, it selects the output where the input should be sent. Only one of the Demux audio objects output channels will have data at any one time. Range: 2 to 255 Data type: Unsigned short The default value is set to 2. The Demux object always has 1 input channel.
Display Name	Display the name of the Demux audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Demux audio object.

Additional Parameters

There are no additional parameters available for Demux audio object.

Tuning Parameters

Below table describes the tuning parameters of Demux audio object.

Parameter	Description	Data type	Unit	Default	Range
Demux_Ch	Output channel index to route the input to (starting from channel index 1)	Unsigned Long	None	1	1 to Number of output channels

Control Parameters

There are no control parameters available for Demux audio object.

Native Panel

Demux audio object does not support native panel

The Selector audio object allows you to switches between two sets of consecutive input channels and routes one of the sets to the output. While switching between the two sets, it applies ramping.

The Selector object has user configurable number of outputs which would imply that the number of inputs would be twice the output channels. The first n channels would be first group and n+1 to 2n channels would be next group.

For example: If the output configured is 2, then number of inputs would be 4. There would be 2 groups. 1 and 2 channels would form first group, 3 and 4 channels would be next group. The 2 output channels would be routed either from group 1 or group 2 based on selection.

Use case: This object can be deployed whenever a selected input channels are required in output channels in the audio pipeline.

Selector Properties

Below table describes about the Selector audio object properties and functionality.

Properties	Description
# of Audio Out	Enter the number of output channels. Range: 1 to 127 Data type: Unsigned short The default value is set to 1. The number of inputs are always twice the number of output channels.
Display Name	Display the name of the Selector audio object in signal flow design. It can be changed based on the intended usage of the object.

Mode

There are no mode available for Selector audio object.

Additional Parameters

There are no additional parameters available for Selector audio object.

Tuning Parameters

Below table describes the tuning parameters of Selector audio object.

The object exposes one variable for tuning, which is the ramp time.

Parameter	Description	Type	Unit	Default	Range
Ramp time	The selected input channels are available at output channels within ramp time.	float	ms	1 ms	0 to 10000
Selector Control	The object also has tuning parameter SelectorControl for switching between two groups.	Unsigned Long	None	0	0 – channel 1 to m_NumAudioOut 1 – channel m_NumAudioOut +1 to m_NumAudioIn

Control Parameters

The Selector exposes one control, which is the actual switch that triggers switching between the two sets. Below table describes the control parameters of Selector audio object.

Parameter	Description	Type	Unit	Default	Range
selector Val	This is the actual switch that triggers switching between the input groups similar to SelectorControl of tuning parameter.	unsigned integer	None	0	0 – channel 1 to m_NumAudioOut 1 – channel m_NumAudioOut +1 to m_NumAudioIn

Native Panel

Selector audio object does not support native panel.

Source objects category contains following audio objects.

• Noise Generator
• Wave Generator
• DC Generator
• FilePlayer

The Noise Generator audio object generates noise audio samples scaled by a specified gain value.

Use Case: This object can be deployed to generate noise of different types with different gain values.

Noise Generator Properties

Below table describes about the Noise Generator audio object properties and functionality.

Properties	Description
# of Audio Out	Enter the number of output channels. Range: 1 to 255 Data type: Unsigned Short The default value is set to 1.
Display Name	Display the name of the Noise Generator audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	Noise generator operates in one of the following two modes. WhiteNoise PinkNoise Pro-Prbs Pro-Lcg

Mode

The Noise generator object supports four different modes of operation.

Mode	Description
White Noise (Mode 0)	The White noise is generated based on the initial seed value. The initial seed value is multiplied by a scale factor to get white noise. This is the default mode.
Pink Noise (Mode 1)	To generate pink noise, white noise is generated first and pink filter is applied over that.
Pro-Prbs (Mode 2)	The Pro-Prbs (Pseudo Random Bit Sequence) mode generates white and pink noise that can be chosen through tuning parameter. White Noise Generation: In this mode pseudo random binary sequence generator is used to generate the white noise signal. It is a deterministic algorithm. Pink Noise Generation: In this mode Paul kellet’s algorithm is used to generate Pink noise signal.
Pro-Lcg (Mode 3)	The Pro-Lcg (Linear Congruential Generator) mode generates white and pink noise that can be chosen through tuning parameter. White Noise Generation: In this mode “Minimal” random number generator of Park and Miller with Bays-Durham shuffle method is used to generate white noise. Pink Noise Generation: In this mode the White Noise that is generated through the linear congruential method is passed through Pink filter 0 and Pink filter 1 to generate the pink noise. The pink noise is passed through the HPF and LPF filters to limit the frequency spectrum to 20 to 20 kHz.

In all the modes, the gain (Noise Level) is in dB scale ranging from -128 dB to 0 dB. The same gain value applies to all channels of the Noise Generator object. It also exposes that same variable for control purposes.

Additional Parameters

There are no additional parameters available for Noise Generator audio object .

Tuning Parameters

Below table describes the tuning parameters of Noise Generator audio object.

For White Noise and Pink Noise mode

Parameter	Description	Unit	Data Type	Default	Range
Noise Level	Generates noise in output channel with gain as tuneable.	db	Float	-60	-128 to 0

For Pro-Prbs and Pro-Lcg modes

Parameter	Description	Unit	Data Type	Default	Range
Noise Level	Generates noise in output channel with gain as tuneable.	db	Float	-100	-128 to 0
Noise Type	Generates white or pink noise in output channel with noise type as a tuneable parameter. This is applicable only for Mode 2 (Pro-Prbs) and Mode 3 (Pro-Lcg).The noise type parameter allows the user to choose white noise or pink noise dynamically.	None	Float	1	0 (White) or 1 (Pink)

Control Parameters

The Noise Generator object has one control input – Gain (Noise Level) ranging from -128 dB to 0 dB and this value is applicable to all the channels. This control input is available in all the four modes.

This  audio object does not have any control output.

The Noise Generator Panel is used to change noise type and noise level. In SFD you can configure several output channels. The same noise type and level will be applied to each channel.

Noise Generator panel works only with PRO object modes “Pro-Prbs” and “Pro-Lcg”. Panel will not work in “WhiteNoise” and “PinkNoise” object modes.

Changing Noise Level

You can change the noise level by three ways:

• Using slider button: Select the slider to adjust the value.
• Using mouse scroll: Use mouse scroll to adjust the value.
• Enter an exact value in the text box.

Changes will take place after hitting the “Enter” key or by moving the focus away from the text box.

Changing Noise Type

You can change the noise type by clicking on the combo-box and selecting the type.

Possible noise generator types are:

• White Noise
• Pink Noise

The Wave Generator audio object generates the sine tone for a given frequency and gain depending on control pins. This audio object has either no input or one input channel. It has one output channel and two control pins.

Use case: The purpose of Wave Generator audio object is to generate sine waves for a specified frequency and gain in Signal Flow Designer, mostly to test the speakers.

Wave Generator Properties

Below table describes about the Wave Generator audio object properties and functionality.

Properties	Description
Display Name	Display the name of the Wave Generator audio object in signal flow design. It can be changed based on the intended usage of the object.
Object Mode	Wave generator objects operate in one of the following two modes. Sine – Without Input Sine – With Input Sweep

Mode

The Wave Generator object supports three different modes of operation.

Mode	Description
Sine – Without Input	This mode generates sine wave signal for specified frequency and gain. This is the default mode.
Sine – With Input	This mode generates sine wave signal for specified frequency and gain and mixes the generated signal with input signal. This mode is used for cascading sines.
Sweep	This mode generates frequency sweep signal for specified start and end frequency, gain, sweep time, sweep type, and loop type.

Additional Parameters

There are no additional parameters available for Wave Generator audio object.

Tuning Parameters

Below table describes the tuning parameters of Wave Generator audio object.

Mode	Parameter	Description	Unit	Data Type	Range	Default
Sine – Without input	Bypass	The generator is turned ON(0)/OFF(1)	None	ULong	0 or 1	0
	Gain	Gain of generated signal	dB	Float	-128 to 0	-128
	Frequency	Frequency of generated signal	Hz	Float	0 to 20000	0
Sine – With input	Bypass	The generator is turned ON(0)/OFF(1)	None	ULong	0 or 1	0
	Gain	Gain of generated signal	dB	Float	-128 to 0	-128
	Frequency	Frequency of generated signal	Hz	Float	0 to 20000	0.0
Sweep	StartFreq	Start frequency of sweep signal to be generated	Hz	Float	20 to 20000	20
	EndFreq	End frequency of sweep signal to be generated	Hz	Float	20 to 20000	20000
	SweepTime	Duration of sweep	s	Float	0.1 to 20	2
	Gain	Gain of generated signal	dB	Float	-120 to 20	-20
	SweepMethod	Type of frequency sweep. LOG (0) method varies the frequency sweep logarithmically. LINEAR (1) method varies the frequency linearly.	None	Signed Integer	0 – Logarithmic 1 – Linear	0
	LoopType	Type of looping/repetition of the signal after “SweepTime”. The loop type can be NONE (0) where the signal is generated once from “StartFreq” to “EndFreq” and stopped. STARTTOEND (1) where the signal is generated and repeated starting from “StartFreq” to “EndFreq” WARBLE (2) where the signal is generated and repeated from “StartFreq” to “EndFreq” and “EndFreq” to “StartFreq” in succession	None	Signed Integer	0 – None 1 – START_TO_ END 2 – WARBLE	0

Control Parameters

Below table describes the control parameters of Wave Generator audio object.

Mode	Parameter	Description	Unit	Range
Sine – Without input	Frequency	Frequency of generated signal	Hz	0 to 20,000
	Gain	Gain of generated signal	dB	-128 to 0
	Active	When transition from high to low (Inactive): Completes the signal generation until zero cross over and mute the output and mute input signal for object mode Sine – with input. When transition from low to high (Active): Reset phase of the signal and signal generation is active and unmute input signal for object mode Sine – with input.	None	0 to 1
Sine – With input	Frequency	Frequency of generated signal	Hz	0 to 20,000
	Gain	Gain of generated signal	dB	-128 to 0
	Active	When transition from high to low (Inactive): Completes the signal generation until zero cross over and mute the output and mute input signal for object mode Sine – with input. When transition from low to high (Active): Reset phase of the signal and signal generation is active and unmute input signal for object mode Sine – with input.		0 to 1

There are no control inputs in ‘Sweep’ mode.

There are no control outputs for this audio object.

Native Panel

Wave Generator object t does not support native panel.

This Audio Object generates DC signal with the amplitude specified in the tuning parameter or the control input. The output amplitude is a floating point value that ranges from -1.0 to +1.0.

The object is not configurable during design time and always generates only one output. The object has one tuning parameter (outputAmp) and one control input (Sets output amplitude) and both of them are used to vary the DC output amplitude.

The object does not have any audio input or control outputs.

The FilePlayer audio object is used to read the audio content from a file and present them in real time on the output channels. Additionally, this audio object can also be used to add or mix the file content with the audio fed into the input channel buffers of this object.

A background thread is used to read the file contents in bulk and place them in the intermediate cache buffer, while in the main thread for each audio interrupt, the required audio data (of framework block length size) is copied from the intermediate cache buffer to the output channel buffers. The background thread periodically checks for the number of samples available in the cache buffer and replenishes the needed files.

Use Case:  The FilePlayer has following use case.

• Stream wav files from local filesystem in realtime
• Resample to target sample rate if needed
• Option to support play speed from 0.1 to 10
• Shall support option to disable / enable pitch shifting (linear and polyphase)
• Shall support mixing the file content with the output of another AO
• Support configurable number of output channels (up to 16)
• Support WAV / PCM Files configurable during design time. Furthermore, WAV / PCM files with all of these data types are supported.
  • 8 bit mu-law
  • 8 bit A-law
  • 16 bit integer
  • 24 bit integer
  • 32 bit float

Internally, all samples are converted to 32 bit floating point numbers. For both the 8 bit command formats, the conversion is done via a lookup table with 256 entries. This look-up table is filled based on the encoding format.

File Player Properties

Properties	Descriptions
# of channels	The number of channels are configurable. Range: 1 to 16 Data type: Unsigned Short The default value is set to 1.
Display Name	Display the name of the FilePlayer audio object in signal flow design. It can be changed based on the intended usage of the object.
Object mode	The object has two modes. WAV (Default) PCM
Additional Parameters	Pitch shifting options Add file data with inputs Cache Buffer size File Type Data format (only for PCM mode) Content Sampe Rate (only for PCM mode)

Mode

FilePlayer audio object supports two different modes of operation. The audio object can read from both WAV and PCM files. 

• WAV (Default): The WAV file contains a header that has the necessary details about the stored audio content in the file
• PCM: the PCM file contains only the audio data and the details such as sampling rate and data format of the stored audio data must be provided separately.

Additional Parameters

The FilePlayer audio object can be configured with the following additional parameters:

Parameter	Descriptions
Pitch shifting	This feature is provided to increase or decrease the playing speed (sample rate at which the content is played). 0 – Disabled (Default) 1 – Polyphase Resampling Enabled 2 – Linear Interpolation Enabled (from W Release)
Add file data with inputs	If this feature is enabled, an equal number of input channels will be supported. Add the content of the audio file with the output of previous AO to generate the output. By default, the AO will have only output channels and no input channels. 0 – Disabled (Default) 1 – Enabled
CacheBuffer size	Allocate internal memory for reading data in the background thread. Range: 1024 to 16384 float words per channel with power of 2. Default: 16384 float words per channel. If the background thread is having significantly lower priority, the buffer underrun is likely to occur for lower cache sizes. In such cases, the cache buffer size shall be increased.
File Type	The object supports the below files: 0 – Single Multichannel file (Default) 1 – Multiple Mono files
Data format (only for PCM mode)	0 – Invalid 1 – 8 bit A-Law companded 2 – 8 bit Mu-Law companded 3 – 16 bit integer 4 – 24 bit integer 5 – 32 bit Float (Default)
Content Sample Rate (only for PCM mode)	All sample rates supported by framework shall be supported Default sample rate is 48000 Hz.

Tuning Parameters

Below table describes the tuning parameters of FilePlayer audio object.

Parameters	Description	Unit	Range	Default
Ramping Params Sub block: This subblock has ramping related tuning parameters applicable to all the channels. All the parameters in this sub-block as stored as unsigned integers.
Fade-in time	Applied for control change from Stop / Pause to Play	ms	0 to 1000	100
Fade-in type	Linear type only is implemented 0 – Linear 1 – Exponential (not implemented)	None	0 or 1 (Enum)	0
Fade-out time	Applied for control change from Play to Stop / Pause	ms	0 to 1000	100
Fade-out type	Linear type only is implemented 0 – Linear 1 – Exponential (not implemented)	None	0 or 1 (Enum)	0
Fade-out delay	Delay period before starting fade-out process	ms	0 or 100	0
Quick Fade-out time	Applied when play command is received during fade-out or fade-out delay phase to quickly end the fade-out phase and start playback. Also quick fade-out is applied only when this value is less than fade-out time. By default, this feature is disabled as the default value is not less than the fade-out time. Only linear ramping is applied. This parameter is available from W Release	ms	0 to 1000	1000
Pitch ramp time	This parameter is available only when pitch shifting is enabled and is applied for any change in play speed value	ms	0 to 100	0
Pitch ramp type	This parameter is available only when pitch shifting is enabled. Linear type only is implemented. 0 – Linear 1 – Exponential (not implemented)	None	0 or 1 (Enum)	0
File_Config sub block: There is a separate file configuration sub block for each file. In SingleMultiChannel mode, only one sub block is present whose parameters are applicable for all the channels. In MultipleMonoFiles mode, each file has its own sub block where the parameters in each sub block is applicable for the respective mono channel. This sub block is available from W Release
File ID	The files shall be placed in the device folder using FileController.	None	1 to 255  Data Type: Unsigned Integer	1
Play Setup	1 – One Shot mode 2 – Loop mode 3 – Intermittent mode (From W Release)	None	1 to 3 (Enum) Data Type: Unsigned Integer	1
Start Position	Start position in percentage from where file will be played. In LOOP mode, this is applicable only at the start of the play and not on every loop back	None	0 to 99.99  Data Type: Float	0
Function	1 – STOP 2 – PLAY 3 – RESET (STOP and PLAY) 4 – PAUSE	None	1 to 4 (Enum) Data Type: Unsigned Integer	1
Interval#	This is applicable only in Intermittent mode. This is the interval period at which the file will be played from the beginning periodically.	s	0.01 to 1000 Data Type:  Float	10
Play Speed*	This is available only when pitch shifting is enabled. This is the play speed at which the file is played	None	0.1 to 10 Data Type: Float	1

# The interval period normally shall be greater than the waveform playback duration. If the interval is less than or equal to the waveform playback duration, glitch / pop noise with a short mute period is seen.

* Playback Duration = File Duration / Play Speed

State Parameters

Parameters	Description	Unit	Range	Default
Function State Sub block: This subblock has the function state parameter for each file. This parameter is used to configure and readback the present function state of the given channel(s). In SingleMultiChannel mode, only one state parameter is present that is applicable for all the channels. In MultipleMonoFiles mode, each file has its own state parameter applicable for the respective mono channel.
Function_Ch	1 – STOP 2 – PLAY 3 – RESET (STOP and PLAY) 4 – PAUSE	None	1 to 4 (Enum) Data Type: Unsigned Integer	1
File State Sub block: This subblock has the file state parameter for each file. This parameter is used only to readback the present file state of the given file(s) and any parameter change is ignored. In SingleMultiChannel mode, only one state parameter is present for the given file. In MultipleMonoFiles mode, each file has its own state parameter. This sub block is available from W Release
File_State	This reflects the present file status. 0 – FILEPLAYER_IDLE 1 – FILE_READY 2 – FILE_PLAY_ACTIVE 3 – FILE_STOPPED 4 – FILE_OPEN_ERROR 5 – FILE_PAUSED	None	0 to 5 (Enum) Data Type: Unsigned Integer	0

Control Parameters

The FilePlayer audio object can be configured with multiple channels. The channel count of the object and the number of channels in the wav file may differ. Error message is returned if extra channels are present in the audio file. If extra channels are configured in the object, those extra channels are filled with silence.

Control Inputs

The FilePlayer has the following Control Inputs.

Control       Input	Description	Size in Float Words	Range
Block Control: There are FOUR control pins under this block control pin. For SingleMultiChannel mode, only one set of block control input needs to be sent. For Multiple Mono mode, for each channel a set of block controls needs to be sent separately.
Channel ID	Channel ID to associate with each output channel.	1 of 4	1 to 16
File ID	Till V Release: The file name needs to be a numeral in this range with .wav or .pcm extension. The files shall be placed in the dll folder. From W Release: The files shall be sent through the FileController.	2 of 4	1 to 255
File Setup	1 – One Shot mode 2 – Loop mode 3 – Intermittent mode	3 of 4	1 to 3
Start Position	Start position in percentage from where file will be played.	4 of 4	0 to 99.99
Function Control Pins: This control pin is used to change the function of the AO. For AOs configured in Single Multichannel mode, only one (N = 1) control input pin will be available applicable to all the channels. For AOs configured in Multiple Mono mode with N channels, there will be equal number (N) of control inputs for each file (channel).
Function	STOP (default on boot-up) PLAY RESET (STOP followed by PLAY) PAUSE	N	1 to 4
Interval Control Pins: This control pin is applicable only in INTERMITTENT play mode and is used to change the interval period of the playback. For AOs configured in Single Multichannel mode, only one (N = 1) control input pin will be available applicable to all the channels. For AOs configured in Multiple Mono mode with N channels, there will be equal number (N) of control inputs for each file (channel). These Interval control pins are available from W Release
Interval	This is the interval period at which the file will be played from the beginning periodically.	N	0.01 to 1000 s
Pitch Control Pins: This control pin(s) is/are available only when pitch shifting is enabled and is used to change the play speed of waveform playback. For AOs configured in Single Multichannel mode, only one (N = 1) control input pin will be available that is applicable to all the channels. For AOs configured in Multiple Mono mode with N channels, there will be equal number (N) of control inputs for each file (channel).
Play Speed	This is the play speed at which the file is played Till V Release: The control input is in terms of deviation in semi-tones. From W Release: The control input is in terms of play speed.	N	Till V Release:  -40 to 40 From W Release: 0.1 to 10

Control Outputs

The FilePlayer has the following Control Output.

Control      Output	Description	Size in Float Words	Range
There are two control output pins – either two single control pins or two block control pins. When the AO is configured in Single Multichannel mode, two single control (N = 1) pins are available for the control outputs listed below.  When the AO is configured in Multiple Mono mode with N channels, two block control (N) pins are available for the control outputs listed below.
Play Position	During active playback, for every audio interrupt, the AO outputs the play position in terms of percentage covered in the file.	N	0 to 99.99
File State	These Control output pins are available from W Release Whenever there is a change in the file status, the AO outputs the file state: 0 – FILEPLAYER_IDLE 1 – FILE_READY 2 – FILE_PLAY_ACTIVE 3 – FILE_STOPPED 4 – FILE_OPEN_ERROR 5 – FILE_PAUSED	N	0 to 5

 

In Single Multichannel file mode, mono file also can be played.

Multiple Mono file mode, all the files need to be mono files. In WAV mode, if the file is seen having more than 1 channel, that file will be ignored. In PCM mode, the file will be taken as a mono file and played leading to improper output.

In Multiple Mono file mode, all the mono files need to be in the same data format and sampling rate. If files with different data format are used, the data format of the last configured file will be considered and the same will be applied to all other mono files leading to improper output.

In cases with low intermediate cache buffer size, the background thread need to run frequently to replenish the data available in the cache buffer. If distortion is observed with low cache size, buffer underrun could be the cause and background thread shall be moved to higher priority or the cache buffer size shall be increased.

It is recommended to configure the sound card block length to 1024 under Sound Card Configuration while using IVP.

The memory required for the supporting the intermediate cache buffer size will be slightly more than double the size specified in the additional parameters as it is required to support ping-pong concept and extra data for supporting filtering. The memory latency table shall be referred for exact memory requirements.

In Single Multichannel file, let the number of files present in the file content be M and the number of channels configured for the object be N.
In WAV mode:
– If M = N, all the N channels will be played with the file content.
– If M < N, first M channels buffers will be populated with the file content and the remaining N-M channels will be muted.
– If M > N, none of the channels will be played and all channels will be muted.
In PCM mode:
– If M = N, all the N channels will be played properly with the file content.
– If M != N, the file will be taken as a N channel file and played leading to improper output.

Native Panel

FilePlayer audio object does not support native panel.