Document toolboxDocument toolbox

(8.D.2.2) STOmniSurround

Overview

ST Omni-Surround module

Discussion

Omnisurround effect applies to Loudspeakers (not headphones). It supports 1.0, 2.0, 5.1 and 7.1 input channels for multichannel virtualization.

This version supports 48KHz sample frequency only and an input blocksize from 96 to 480 samples.

The module takes two arguments: Omni2CentreOutput and AudioMode.

Omni2CentreOutput : 0 to disable the center output (for 3.0), 1 to enable the center output (3.0)

AudioMode : Can be one of the eAcMode_Supported enumeration values (AMODE20t, AMODE10, AMODE20, AMODE30, AMODE30_LFE, AMODE32_LFE and AMODE34_LFE)

Type Definition

typedef struct _ModuleSTOmniSurround { ModuleInstanceDescriptor instance; // Common Audio Weaver module instance structure INT32 nAPIResult; // Return status for last call into the ST API INT32 audioMode; // Specifies input audio format INT32 centerEnable; // Enable center output INT32 enable; // Block enable INT32 strength; // Strength percent (0 - 100) INT32 listeningAngle; // Omni2 listening angle (10, 20, or 30 degrees) void * pGlobals; // Points to the global variables structure } ModuleSTOmniSurroundClass;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

nAPIResult

int

state

0

0

Unrestricted

 

audioMode

int

const

0

2

Unrestricted

 

centerEnable

int

const

0

0

Unrestricted

 

enable

int

parameter

0

1

0:1:1

 

strength

int

parameter

0

0

0:1:100

 

listeningAngle

int

parameter

0

1

Unrestricted

degrees

pGlobals

void *

const

1

 

Unrestricted

 

Pins

Input Pins

Name: in

Description: audio input

Data type: fract32

Channel range: 2

Block size range: 96:480

Sample rate range: 48000

Complex support: Real

Output Pins

Name: out

Description: audio output

Data type: fract32

MATLAB Usage

File Name: st_omni_surround_module.m

M = st_omni_surround_module(NAME, AUDIOMODE, CENTER_ENABLE) Audio Weaver wrapper for the ST Omni Surround module. Arguments: NAME - name of the module. AUDIOMODE - 1 - Mono, 2 - Stereo CENTER_ENABLE - enable center output (3.0) Copyright (c) 2017 DSP Concepts, Inc. All Rights Reserved. Author: Chris Perry

Â