ACPHAL Structures and Unions

Structures and unions defined by the API.

In this section

ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXT
Command to enable or disable an XMA context.

ACP_COMMAND_ENABLE_OR_DISABLE_XMA_CONTEXTS
Command to enable or disable a series of XMA contexts.

ACP_COMMAND_INCREMENT_DMA_POINTER
Command to update a DMA read or write pointer.

ACP_COMMAND_INCREMENT_PCM_WRITE_POINTER
Command to update a PCM write pointer.

ACP_COMMAND_INCREMENT_XMA_WRITE_BUFFER_OFFSET_READ
Increments the output buffer read offset of a SHAPE_XMA_CONTEXT.

ACP_COMMAND_LOAD_SHAPE_FLOWGRAPH
Command to load a flowgraph.

ACP_COMMAND_MESSAGE
Registers or unregisters one or more command messages.

ACP_COMMAND_UPDATE_ALL_CONTEXTS
Command to update arrays of all SHAPE context types.

ACP_COMMAND_UPDATE_CONTEXTS
Command to update an array of a single SHAPE context type.

ACP_COMMAND_UPDATE_DMA_CONTEXT
Command to update a DMA context.

ACP_COMMAND_UPDATE_DMA_READ_CONTEXT_ENTRY
Entry to update SHAPE_DMA_CONTEXT that reads from a mixbuffer.

ACP_COMMAND_UPDATE_DMA_WRITE_CONTEXT_ENTRY
Entry to update SHAPE_DMA_CONTEXT that writes to a mixbuffer.

ACP_COMMAND_UPDATE_EQCOMP_CONTEXT
Command to update an EQ/Comp context.

ACP_COMMAND_UPDATE_EQCOMP_CONTEXT_ENTRY
Entry to update SHAPE_EQCOMP_CONTEXT.

ACP_COMMAND_UPDATE_FILTVOL_CONTEXT
Command to update a Filt/Vol context.

ACP_COMMAND_UPDATE_FILTVOL_CONTEXT_ENTRY
Entry to update SHAPE_FILTVOL_CONTEXT.

ACP_COMMAND_UPDATE_PCM_CONTEXT
Command to update a PCM context.

ACP_COMMAND_UPDATE_PCM_CONTEXT_ENTRY
Entry to update a SHAPE_PCM_CONTEXT.

ACP_COMMAND_UPDATE_SRC_CONTEXT
Command to update an SRC context.

ACP_COMMAND_UPDATE_SRC_CONTEXT_ENTRY
Entry to update SHAPE_SRC_CONTEXT.

ACP_COMMAND_UPDATE_XMA_CONTEXT
Command to update an XMA context.

ACP_COMMAND_UPDATE_XMA_CONTEXT_ENTRY
Entry to update a SHAPE_XMA_CONTEXT.

ACP_COMMAND_UPDATE_XMA_READ_BUFFER
Updates all the elements of a SHAPE_XMA_CONTEXT required for streaming encoded data.

ACP_MESSAGE
Message from the ACP.

ACP_MESSAGE_AUDIO_FRAME_START
Audio frame start message.

ACP_MESSAGE_COMMAND_COMPLETED
An ACP command has completed.

ACP_MESSAGE_SHAPE_COMMAND_BLOCKED
SHAPE command (SRC or DMA) context is blocked.

ACP_MESSAGE_ERROR
Error message.

ACP_MESSAGE_FLOWGRAPH_COMPLETED
Flowgraph completed message.

ACP_MESSAGE_FLOWGRAPH_TERMINATED
Flowgraph terminated message.

ApuHeapState
Contains the state of the physical heap, after calling ApuHeapGetState.

SHAPE_CONTEXTS
SHAPE context data.

SHARED_SHAPE_CONTEXTS
This structure is used when sharing SHAPE and XMA resources with XAudio2.

Context structures.

In this section

SHAPE_DMA_CONTEXT
The DMA context struture.

SHAPE_DMA_READ_WRITE_FULL
Structure used to query read/write pointers and full bit in one operation.

SHAPE_EQCOMP_CONTEXT
The EQCOMP context.

SHAPE_FILTVOL_CONTEXT
The Filter Volume context.

SHAPE_PCM_CONTEXT
The PCM context structure.

SHAPE_SRC_CONTEXT
The SRC context structure.

SHAPE_XMA_CONTEXT
The XMA context structure.

Flowgraph utility structures and unions.

In this section

SHAPE_FLOWGRAPH_ALLOC_MIXBUFFER_COMMAND
Allocates a physical mix buffer for subsequent use.

SHAPE_FLOWGRAPH_COMMAND_HEADER
Flowgraph command header.

SHAPE_FLOWGRAPH_COMMAND
Shape flowgraph command (union).

SHAPE_FLOWGRAPH_DMA_COMMAND
Indicates that data needs to be moved between a mix buffer and system memory.

SHAPE_FLOWGRAPH_EQCOMP_COMMAND
Indicates that an equalizer/compression pass is needed.

SHAPE_FLOWGRAPH_FILTVOL_COMMAND
Indicates that a filter/volume pass is needed.

SHAPE_FLOWGRAPH_SRC_COMMAND
Indicates that a sample rate conversion (SRC) pass is needed.