SoloMute

Overview

Solo and mute control module

Discussion

Solo and Mute Control module. When the second argument NUMPINS is 1, then the solo and mute control is applied to each individual channel. Otherwise the solo and mute control is applied to each individual input pin as a whole. The array .isMuted is used for mute control and the array .isSolo is for solo control. When both are selected, mute has higher priority over solo. 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

CODE

typedef struct _ModuleSoloMute
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 numControls;                            // Number of individual mute controls
    FLOAT32 smoothingTime;                        // Time constant of the smoothing process
    FLOAT32 smoothingCoeff;                       // Smoothing coefficient.
    INT32* isSolo;                                // Boolean that controls pin solo. One per each pin.
    INT32* isMuted;                               // Boolean that controls pin muted or unmuted. One per each pin.
    FLOAT32* currentGain;                         // Instantaneous gain applied by the module. This is also the starting gain of the module.
    FLOAT32* gain;                                // Target gain.
} ModuleSoloMuteClass;

Variables

Properties

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

Pins

Input Pins

Name: in1

Description: audio input

Data type: float

Channel range: Unrestricted

Block size range: Unrestricted

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: out1

Description: audio output

Data type: float

MATLAB Usage

File Name: solo_mute_module.m

CODE

 M=solo_mute_module(NAME, NUMPINS, NUMCHANNELS, TRANSPOSE)
 Creates a solo or mute control module.
 Arguments:
    NAME - name of the module.
    NUMPINS - optional argument that specifies the number of input pins.
       When NUMPINS is 1, the solo and mute control apply to each individual
       channel within the input pin.
       When NUMPINS is more than 1, the solo and mute control apply to
       those input pins. By default, NUMPINS=1.
    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 = 2.
    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.
 AudioWeaverModule [This tag makes it appear under awe_help]