Overview

Multichannel mute module

Discussion

Multichannel smoothly varying mute module. The array .isMuted has a separate value for each channel in the signal. The size of .isMuted is set by the prebuild function. You can also separately specify the initial length of the array using the optional second argument to the function. In all cases, the array length is updated by the prebuild function.

The module does smooth muting and unmuting. The speed of the smoothing operation is set by the .smoothingTime variable. The module's set function translates the smoothingTime to an internal smoothingCoeff. When the module is built it starts out in a converged state.

By default, the inspector for the module has the control checkboxes organized in a vertical stack. By setting the optional third argument TRANSPOSE = 1 turns the control into a horizontal stack.

Type Definition

typedef struct _ModuleMuteNSmoothed
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    FLOAT32 smoothingTime;                        // Time constant of the smoothing process
    FLOAT32 smoothingCoeff;                       // Smoothing coefficient.
    INT32* isMuted;                               // Boolean that controls muting/unmuting. One per channel.
    FLOAT32* currentGain;                         // Instantaneous gain applied by the module. This is also the starting gain of the module.
    FLOAT32* gain;                                // Target gain.
} ModuleMuteNSmoothedClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
smoothingTime	float	parameter	0	10	0:1000	msec
smoothingCoeff	float	derived	1	0.002081	Unrestricted
isMuted	int*	parameter	0	[1 x 1]	0:1
currentGain	float*	state	1	[1 x 1]	0:1	linear
gain	float*	derived	1	[1 x 1]	0:1	linear

Pins

Input Pins

Name: in

Description: audio input

Data type: float

Channel range: Unrestricted

Block size range: Unrestricted

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: out

Description: audio output

Data type: float

Name: FS

Description: boolean fader state

Data type: int

MATLAB Usage

File Name: muten_smoothed_module.m

 M=muten_smoothed_module(NAME, NUMCHANNELS, TRANSPOSE)
 Creates a multichannel mute module in which there is a separate control
 per channel.  Arguments:
    NAME - name of the module.
    NUMCHANNELS - optional argument that specifies the initial number
       of channels in the wire.  When the system is built, the number
       of channels is derived by pin propagation.  This value is only
       for the initial behavior before the system is built.  By default,
       NUMCHANNELS = 1.
    TRANSPOSE - an optional argument which controls how the inspector
       for the module is drawn.  By default, if there are N channels
       then the inspector control is a vertical stack of N checkboxes.
       (TRANSPOSE = 0 by default).  If TRANSPOSE = 1, then the inspector
       is drawn as a horizontal array of N checkboxes.

Documentation Hub [PUBLIC]

(8.D.2.3) MuteNSmoothed