Overview

ST Smart Volume

Discussion

ST Smart Volume.

Type Definition

typedef struct _ModuleSTSmartVolume
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    FLOAT32 target_volume_dB;                     // Target volume in dB (-80db:36dB, step 0.5dB)
    INT32 mute;                                   // mute (0 - unmuted, 1 - muted)
    INT32 enable_compr;                           // enable_compr (0 - disabled, 1 - enabled)
    FLOAT32 attack_time;                          // Attack time in ms (0.02ms:5.0ms)
    FLOAT32 release_time;                         // Release time in ms (50.0ms:300.0ms)
    INT32 quality;                                // 1- HIGH_Q mode, 0 - standard mode
    INT32 nAPIResult;                             // Return status for last call into the ST API
    INT32 sampleDelay;                            // (0:160) delay in samples
    INT32 jointStereo;                            // Joint Stereo
    void * pGlobals;                              // Points to the global variables structure
} ModuleSTSmartVolumeClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
target_volume_dB	float	parameter	0	0	-80:0.5:36	dB
mute	int	parameter	0	0	0:1:1
enable_compr	int	parameter	0	1	0:1:1
attack_time	float	parameter	0	1	0.02:0.01:5	ms
release_time	float	parameter	0	100	50:0.1:300	ms
quality	int	parameter	0	0	0:1:1
nAPIResult	int	state	1	0	Unrestricted
sampleDelay	int	const	1	96	0:1:160
jointStereo	int	const	1	1	0:1:1
pGlobals	void *	const	1		Unrestricted

Pins

Input Pins

Name: in

Description: audio input

Data type: fract32

Channel range: 1, 2, 4

Block size range: 96:480

Sample rate range: Unrestricted

Complex support: Real

Output Pins

Name: out

Description: audio output

Data type: fract32

MATLAB Usage

File Name: st_smart_volume_module.m

 M = st_smart_volume_module(NAME)
 Audio Weaver wrapper for the ST Smart Volume module.  Arguments:
   NAME - name of the module.
   SAMPLE_DELAY - (0:160) delay in samples.  96 samples by default.
   JOINT_STEREO - 1 - to enable joint stereo.  On by default.
 Copyright (c) 2017 DSP Concepts, Inc.  All Rights Reserved.
 Author:  Chris Perry

Documentation Hub [PUBLIC]

(8.D.2.7) STSmartVolume

Analytics