SHAPE_FILTVOL_CONTEXT Structure

The Filter Volume context.

Syntax

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;
};  

Members

timestamp
Read: Timestamp context processing was completed.

reserved0
Reserved.

internalSaturate
Read: 1 if FILTVOL saturated, 0 otherwise.

mixBufPeakMag
Read: Peak Magnitude of output mix buffer.

peakMag
Read: Peak Magnitude of output.

delay1
Read: Saved Band Pass delay element state for the filter, in format s1.28.

headroom
Write: Headroom for filter processing. One member of the SHAPE_FILTER_HEADROOM enum.

delay2
Read: Saved Low Pass delay element state for the filter, in format s1.28.

svfMode
Write: One member of the SHAPE_FILTER_MODE enum.

gainTarget
Write: Volume target level, in format s1.14. There are no range restrictions within the specified bit width.

gain
Read/write: The current volume value, in format s1.14. There are no range restrictions within the specified bit width.

qRecip
Read/write: Current 1-over-Q value, in format u1.23. The restricted range is 1 to 12582912.

reserved1
Reserved.

qRecipTarget
Write: Target 1-over-Q value, in format u1.23. The restricted range is 1 to 12582912.

reserved2
Reserved.

fc
Read/write: Current frequency value, in format u.24. There are no range restrictions within the specified bit width.

reserved3
Reserved.

fcTarget
Write: Target frequency value, in format u.24. There are no range restrictions within the specified bit width.

reserved4
Reserved.

Remarks

The fields marked as Read: are written to by the ACP library and should only be read by your application. The fields marked Write: are set by your application and not changed by the ACP library. The fields marked Read:write are set by your application but can be changed by the ACP library.

Refer to the SHAPE Overview for a description of peak magnitude.

Requirements

Header: Declared in shapefiltvolcontext.h.

Library: Use acphal.lib.