Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Scales all input channels by a single gain value. The first pin is the control pin. The gain (in dB) value is provided at the first sample of first pin. So the module has N+1 number of input pins and N number of output pins Internally, currentGain represents the instantaneous smoothed gain that is applied. currentGain exponentially approaches gain with a time constant equal to smoothingTime. The module can also handle complex data but in the case of complex data no smoothing is performed and the gain value is applied to both the real and imaginary parts.

Type Definition

Code Block
typedef struct _ModuleScalerDBControl
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    FLOAT32 smoothingTime;                        // Time constant of the smoothing process
    FLOAT32 currentGain;                          // Instantaneous gain applied by the module. This is also the starting gain of the module.
    FLOAT32 smoothingCoeff;                       // Smoothing coefficient
} ModuleScalerDBControlClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

smoothingTime

float

parameter

0

10

0:1000

msec

currentGain

float

state

1

0

Unrestricted

smoothingCoeff

float

derived

1

0.002081

Unrestricted

Pins

Input Pins

Name: g

Description: gain (in dB)

...