Posted on by Debanka

Volume and Mute

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 the Volume and Mute audio object properties and functionality.

A screenshot of a computer Description automatically generated

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 objects consist of the 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.
 A screenshot of a computer Description automatically generated
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
 A screenshot of a computer Description automatically generated
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.

 A screenshot of a computer Description automatically generated
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)
 A screenshot of a computer Description automatically generated

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

Control Interface

The Volume control is triggered whenever a control message is addressed to the audio object. In One Set mode, the object supports two control inputs and one control output.
Control IO is not available for the other two modes.

Control Inputs

Volume and Mute object has two control inputs as follows:

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
 None

Control Outputs

Volume and Mute object has one control output as follows:

Parameters Descriptions Range Unit
Volume Gain applied for a particular frame (blocklength of samples) -128 to 20 dB