SHAPE_XMA_CONTEXT

The XBOX Media Audio (XMA) context.

Syntax

typedef struct SHAPE_XMA_CONTEXT {  
    UINT32 sizeRead0 : 12;  
    UINT32 numLoops : 8;  
    UINT32 validBuffer : 2;  
    UINT32 sizeWrite : 5;  
    UINT32 offsetWrite : 5;  
    UINT32 sizeRead1 : 12;  
    UINT32 loopSubframeEnd : 2;  
    UINT32 reserved0 : 3;  
    UINT32 loopSubframeSkip : 3;  
    UINT32 numSubframesToDecode : 4;  
    UINT32 numSubframesToSkip : 3;  
    UINT32 sampleRate : 2;  
    UINT32 numChannels : 1;  
    UINT32 reserved1 : 1;  
    UINT32 validWrite : 1;  
    UINT32 offsetRead : 26;  
    UINT32 errorStatus : 5;  
    UINT32 errorSet : 1;  
    UINT32 loopStartOffset : 26;  
    UINT32 parserErrorStatus : 5;  
    UINT32 parserErrorSet : 1;  
    UINT32 loopEndOffset : 26;  
    UINT32 packetMetaData : 5;  
    UINT32 currentBuffer : 1;  
    UINT32 ptrRead0;  
    UINT32 ptrRead1;  
    UINT32 ptrWrite;  
    UINT32 ptrOverlapAdd;  
    UINT32 writeBufferOffsetRead : 5;  
    UINT32 reserved2 : 25;  
    UINT32 stopWhenDone : 1;  
    UINT32 interruptWhenDone : 1;  
    UINT32 reserved[6];  
} SHAPE_XMA_CONTEXT  

Members

sizeRead0
Type: UINT32 Write: Size, in 2-KB blocks, of the left input buffer. numLoops
Type: UINT32 Read/Write: Number of loops. 255 specifies infinite (continuous) looping. validBuffer
Type: UINT32 Read/Write: Validity flags for the input buffers.

Value	Description
00	Neither buffer is valid.
01	Only buffer 0 (left) is valid.
10	Only buffer 1 (right) is valid.
11	Both buffers are valid.

sizeWrite
Type: UINT32 Write: Size, in 256-byte blocks, of the output buffer. offsetWrite
Type: UINT32 Read: Offset, in 256-byte blocks, into the output buffer where the hardware will write. sizeRead1
Type: UINT32 Write: Size, in 2-KB blocks, of the right input buffer. loopSubframeEnd
Type: UINT32 Write: Subframe number of the loop endpoint, inclusive. reserved0
Type: UINT32 Reserved. loopSubframeSkip
Type: UINT32 Write: Number of subframes to skip at the beginning of the loop. Valid values are 0, 1, 2, 3, and 4. numSubframesToDecode
Type: UINT32 Write: Number of subframes to decode per pass. Valid values are 1, 2, 4, and 8. numSubframesToSkip
Type: UINT32 Write: Number of subframes to skip. Valid values are 0, 1, 2, 3, and 4. sampleRate
Type: UINT32 Write: Sample rate of the stream. Valid values are in the SHAPE_XMA_SAMPLE_RATE enumeration. numChannels
Type: UINT32 Write: Number of channels in the stream. 0 specifies mono (one channel); 1 specifies stereo (two channels). reserved1
Type: UINT32 Reserved. validWrite
Type: UINT32 Read/Write: Validity flag for the write buffer. 1 indicates that the hardware can write; 0 indicates that the hardware cannot write. offsetRead
Type: UINT32 Read/Write: Offset, in bits, from the beginning of the input buffer. errorStatus
Type: UINT32 Read: One or more error values.

Error	Value
SHAPE_XMA_ERROR_STATUS_NO_ERROR_OCCURRED_ERRORSET_IS_0	0
SHAPE_XMA_ERROR_STATUS_WRITE_BUFFER_INVALID_VALIDWR_IS_0	1
SHAPE_XMA_ERROR_STATUS_INSUFFICIENT_WRITE_BUFFER_SPACE_VALIDWR_IS_1	2
SHAPE_XMA_ERROR_STATUS_READ_BUFFER_INVALID_VALIDBUFFER_CURRBUF_IS_0	4
SHAPE_XMA_ERROR_STATUS_FRAME_CROSSES_BOUNDARY_INTO_INVALID_READ_BUFFER_VALIDBUFFER_CURRBUF_IS_0	8
SHAPE_XMA_ERROR_STATUS_FRAME_CROSSES_BOTH_READ_BUFFER_BOUNDARIES	16

errorSet
Type: UINT32 Read: Error flag. 0 if no error has occurred; 1 if an error has occurred. Use GetShapeXmaErrorStatus to retrieve error values. loopStartOffset
Type: UINT32 Write: Offset, in bits, from the read-buffer pointer where the hardware will start decoding. parserErrorStatus
Type: UINT32 Read: Parser error value.

Error	Value
SHAPE_XMA_PARSER_ERROR_STATUS_UNKNOWN_STATE	1
SHAPE_XMA_PARSER_ERROR_STATUS_OUT_OF_RANGE	2
SHAPE_XMA_PARSER_ERROR_STATUS_FRAME_SIZE_EXCEEDED	3
SHAPE_XMA_PARSER_ERROR_STATUS_BITSTREAM_CORRUPTION	4
SHAPE_XMA_PARSER_ERROR_STATUS_BARKVLC_ERROR	5
SHAPE_XMA_PARSER_ERROR_STATUS_BARKRLC_ERROR	6
SHAPE_XMA_PARSER_ERROR_STATUS_VLC4D_ERROR	7
SHAPE_XMA_PARSER_ERROR_STATUS_VLC2D_ERROR	8
SHAPE_XMA_PARSER_ERROR_STATUS_VLC1D_ERROR	9
SHAPE_XMA_PARSER_ERROR_STATUS_RLC0_ERROR	10
SHAPE_XMA_PARSER_ERROR_STATUS_RLC1_ERROR	11
SHAPE_XMA_PARSER_ERROR_STATUS_LARGEVAL24_ERROR	15

parserErrorSet
Type: UINT32 Read: Parser error flag. 0 if no error has occurred; 1 if an error has occurred. Use GetShapeXmaParserErrorStatus to retrieve error value. loopEndOffset
Type: UINT32 Write: Offset, in bits, from the read-buffer pointer where the hardware will end decoding. packetMetaData
Type: UINT32 Reserved for internal use. currentBuffer
Type: UINT32 Read/Write: Current input buffer. 0 specifies the left buffer, and 1 specifies the right buffer. ptrRead0
Type: UINT32 Write: Pointer to the left input buffer. Aligned on 2-KB boundaries; lower 11 bits are ignored. ptrRead1
Type: UINT32 Write: Pointer to the right input buffer. Aligned on 2-KB boundaries; lower 11 bits are ignored. ptrWrite
Type: UINT32 Write: Pointer to the output buffer. Aligned on 64-byte boundaries. ptrOverlapAdd
Type: UINT32 Write: Pointer to the working buffer. Aligned on 128-byte boundaries. writeBufferOffsetRead
Type: UINT32 Write: Offset, in 256-byte blocks, of the read pointer in the output buffer. reserved2
Type: UINT32 Reserved. stopWhenDone
Type: UINT32 Reserved for internal use. interruptWhenDone
Type: UINT32 Reserved for internal use. reserved
Type: UINT32[6] Reserved.

Remarks

This structure contains the context for the XMA decoder block. The maximum size of an input buffer is 8 MB. To determine the status of an input buffer’s consumption, examine the offsetRead, currentBuffer, and validBuffer members. 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 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 XMA section of Overview of SHAPE.

Requirements

Header: shapexmacontext.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_XMA_CONTEXT

SHAPE_XMA_CONTEXT

Syntax

Members

Remarks

Requirements

Conceptual documentation

See also

​SHAPE_XMA_CONTEXT

​Syntax

​Members

​Remarks

​Requirements

​Conceptual documentation

​See also

SHAPE_XMA_CONTEXT

Syntax

Members

Remarks

Requirements

Conceptual documentation

See also