Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Documents: Update page title prefix

Overview

Phase invert module

Discussion

This module inverts the phase of a signal. Inverting the phase is simply multiplying by -1. When the second argument NUMPINS is 1, then the phase invert control is applied to each individual channel. Otherwise the phase invert control is applied to each individual input pin as a whole. The array .isInverted is used for phase invert control. The array length is updated by the prebuild function.

...

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 Block
typedef struct _ModuleInvertN
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 numControls;                            // Number of individual invert controls
    FLOAT32 smoothingTime;                        // Time constant of the smoothing process
    FLOAT32 smoothingCoeff;                       // Smoothing coefficient.
    INT32* isInverted;                            // Boolean that specifies whether the signal is inverted (=1) or not (=0). 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.
} ModuleInvertNClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

numControls

int

const

0

1

Unrestricted

smoothingTime

float

parameter

0

10

0:1000

msec

smoothingCoeff

float

derived

1

0.002081

Unrestricted

isInverted

int*

parameter

0

[1 x 1]

0:1

currentGain

float*

state

1

[1 x 1]

-1:1

linear

gain

float*

derived

1

[1 x 1]

-1:1

linear

Pins

Input Pins

Name: in1

Description: audio input

...

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: out1

Description: audio output

Data type: float

MATLAB Usage

File Name: invertn_module.m

...