SHAPE_FILTVOL_CONTEXT

The Filter/Volume (FLTVOL) context.

Syntax

typedef struct SHAPE_FILTVOL_CONTEXT {  
    UINT32 timestamp : 21;
    UINT32 reserved0 : 2;
    UINT32 internalSaturate : 1;
    UINT32 mixBufPeakMag : 4;
    UINT32 peakMag : 4;
    UINT32 delay1 : 30;
    UINT32 headroom : 2;
    UINT32 delay2 : 30;
    UINT32 svfMode : 2;
    UINT32 gainTarget : 16;
    UINT32 gain : 16;
    UINT32 qRecip : 24;
    UINT32 reserved1 : 8;
    UINT32 qRecipTarget : 24;
    UINT32 reserved2 : 8;
    UINT32 fc : 24;
    UINT32 reserved3 : 8;
    UINT32 fcTarget : 24;
    UINT32 reserved4 : 8;
} SHAPE_FILTVOL_CONTEXT  

Members

timestamp
Type: UINT32 Read: Time stamp for the completion of context processing. reserved0
Type: UINT32 Reserved. internalSaturate
Type: UINT32 Read: 1 if FLTVOL is saturated; 0 otherwise. mixBufPeakMag
Type: UINT32 Read: Peak magnitude of the output mix buffer. peakMag
Type: UINT32 Read: Peak magnitude of the output. delay1
Type: UINT32 Read: Band-pass delay for the filter, formatted as s1.28. headroom
Type: UINT32 Write: Input headroom. A member of the SHAPE_FILTER_HEADROOM enumeration. delay2
Type: UINT32 Read: Low-pass delay for the filter, formatted as s1.28. svfMode
Type: UINT32 Write: Mode of the state variable filter. A member of the SHAPE_FILTER_MODE enumeration. gainTarget
Type: UINT32 Write: Target for output gain, formatted as s1.14. gain
Type: UINT32 Read/Write: Current output gain, formatted as s1.14. qRecip
Type: UINT32 Read/Write: Reciprocal of the current Q (quality) factor, formatted as u1.23. reserved1
Type: UINT32 Reserved. qRecipTarget
Type: UINT32 Write: Reciprocal of the target Q (quality) factor, formatted as u1.23. reserved2
Type: UINT32 Reserved. fc
Type: UINT32 Read/Write: Current corner frequency, formatted as u.24. reserved3
Type: UINT32 Reserved. fcTarget
Type: UINT32 Write: Target corner frequency, formatted as u.24. reserved3
Type: UINT32 Reserved.

Remarks

This structure contains the context for the Filter/Volume (FLTVOL) block. The Scalable Hardware Audio Processing Engine (SHAPE) can process up to 2,560 FLTVOL contexts per audio frame. However, the number of contexts addressable in memory is larger to simplify stream reuse. Members that are marked as Read are written by the Audio Control Processor (ACP) library and should only be read by your application. Members that are marked as Write are set by your application and are not changed by the ACP library. Members that are marked as Read/Write are set by your application but can be changed by the ACP library. For more information, see the Filter/volume block (FLTVOL) section of Overview of SHAPE.

Requirements

Header: shapefiltvolcontext.h Supported platforms: XBOX One family consoles and XBOX Series consoles

Conceptual documentation

ACP overview

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

SHAPE_FILTVOL_CONTEXT

SHAPE_FILTVOL_CONTEXT

Syntax

Members

Remarks

Requirements

Conceptual documentation

See also

​SHAPE_FILTVOL_CONTEXT

​Syntax

​Members

​Remarks

​Requirements

​Conceptual documentation

​See also

SHAPE_FILTVOL_CONTEXT

Syntax

Members

Remarks

Requirements

Conceptual documentation

See also