Codec Engine Application Programming Interface (API)  ce-w08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
XDM_DataSyncDesc Struct Reference
XDM - Shared XDM Definitions

Descriptor for the chunk of data being transferred in one call to putData or getData. More...

#include <xdm.h>

Collaboration diagram for XDM_DataSyncDesc:
Collaboration graph

Data Fields

XDAS_Int32 size
XDAS_Int32 scatteredBlocksFlag
XDAS_Int32 * baseAddr
XDAS_Int32 numBlocks
XDAS_Int32 varBlockSizesFlag
XDAS_Int32 * blockSizes

Detailed Description

Descriptor for the chunk of data being transferred in one call to putData or getData.

Field Documentation

XDAS_Int32 XDM_DataSyncDesc::size

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int32 XDM_DataSyncDesc::scatteredBlocksFlag

Flag indicating whether the individual data blocks may be scattered in memory.

Remarks:
Note that each individual block must be physically contiguous.
Valid values are XDAS_TRUE and XDAS_FALSE.
If set to XDAS_FALSE, the baseAddr field points directly to the start of the first block, and is not treated as a pointer to an array.
If set to XDAS_TRUE, the baseAddr array must contain the base address of each individual block.
XDAS_Int32* XDM_DataSyncDesc::baseAddr

Base address of single data block or pointer to an array of data block addresses of size numBlocks.

Remarks:
If scatteredBlocksFlag is set to XDAS_FALSE, this field points directly to the start of the first block, and is not treated as a pointer to an array.
If scatteredBlocksFlag is set to XDAS_TRUE, this field points to an array of pointers to the data blocks.
XDAS_Int32 XDM_DataSyncDesc::numBlocks

Number of blocks available

XDAS_Int32 XDM_DataSyncDesc::varBlockSizesFlag

Flag indicating whether any of the data blocks vary in size.

Remarks:
Valid values are XDAS_TRUE and XDAS_FALSE.
XDAS_Int32* XDM_DataSyncDesc::blockSizes

Variable block sizes array. 

                               @remarks     If @c varBlockSizesFlag is
                                            XDAS_TRUE, this array
                                            contains the sizes of each
                                            block.  If @c varBlockSizesFlag
                                            is XDAS_FALSE, this contains
                                            the size of same-size blocks.

                                @remarks    Memory for this array
                                            (of size @c numBlocks) has
                                            to be allocated by the
                                            caller of the putData API.
The documentation for this struct was generated from the following file:
Copyright 2013, Texas Instruments Incorporated