XDM - Shared XDM Definitions

Data Structures
struct	XDM_BufDesc
	Buffer descriptor for multiple buffers. More...
struct	XDM_SingleBufDesc
	Single buffer descriptor. More...
struct	XDM1_SingleBufDesc
	Single buffer descriptor. More...
union	XDM2_BufSize
	Union describing a buffer size. More...
struct	XDM2_SingleBufDesc
	Single buffer descriptor. More...
struct	XDM1_BufDesc
	Buffer descriptor. More...
struct	XDM2_BufDesc
	Buffer descriptor. More...
struct	XDM1_AlgBufInfo
	Buffer information descriptor for input and output buffers. More...
struct	XDM_AlgBufInfo
	Buffer information descriptor for input and output buffers. More...
struct	XDM2_MoveBufDesc
	Descriptor for a buffer to move. More...
struct	XDM_Date
	Date and time. More...
struct	XDM_Point
	2-dimensional point More...
struct	XDM_Rect
	Rectangle. More...
struct	XDM_ContextInfo
	Buffer information descriptor for input and output buffers. More...
struct	XDM_Context
	Context used by split codecs. More...
struct	XDM_DataSyncDesc
	Descriptor for the chunk of data being transferred in one call to putData or getData. More...

Macros
#define	XDM_EOK   IALG_EOK
#define	XDM_EFAIL   IALG_EFAIL
#define	XDM_EUNSUPPORTED   -3
#define	XDM_ERUNTIME   -2
	General runtime failure.
#define	XDM_MAX_IO_BUFFERS   16
#define	XDM_ISACCESSMODE_READ(x)   (((x) >> XDM_ACCESSMODE_READ) & 0x1)
	Check an access mask for CPU read access.
#define	XDM_ISACCESSMODE_WRITE(x)   (((x) >> XDM_ACCESSMODE_WRITE) & 0x1)
	Check an access mask for CPU write access.
#define	XDM_CLEARACCESSMODE_READ(x)   ((x) &= (~(0x1 << XDM_ACCESSMODE_READ)))
	Clear the "CPU read access" bit in an access mask.
#define	XDM_CLEARACCESSMODE_WRITE(x)   ((x) &= (~(0x1 << XDM_ACCESSMODE_WRITE)))
	Clear the "CPU write access" bit in an access mask.
#define	XDM_SETACCESSMODE_READ(x)   ((x) |= (0x1 << XDM_ACCESSMODE_READ))
	Set the bit to indicate CPU read access in an access mask.
#define	XDM_SETACCESSMODE_WRITE(x)   ((x) |= (0x1 << XDM_ACCESSMODE_WRITE))
	Set the bit to indicate CPU write access in an access mask.
#define	XDM_CUSTOMENUMBASE   0x100
	Base of algorithm-specific enum values.
#define	XDM_CUSTOMCMDBASE   0x100
	Base of algorithm-specific commands.
#define	XDM_ISFATALERROR(x)   (((x) >> XDM_FATALERROR) & 0x1)
#define	XDM_ISUNSUPPORTEDPARAM(x)   (((x) >> XDM_UNSUPPORTEDPARAM) & 0x1)
#define	XDM_ISUNSUPPORTEDINPUT(x)   (((x) >> XDM_UNSUPPORTEDINPUT) & 0x1)
#define	XDM_ISCORRUPTEDHEADER(x)   (((x) >> XDM_CORRUPTEDHEADER) & 0x1)
#define	XDM_ISCORRUPTEDDATA(x)   (((x) >> XDM_CORRUPTEDDATA) & 0x1)
#define	XDM_ISINSUFFICIENTDATA(x)   (((x) >> XDM_INSUFFICIENTDATA) & 0x1)
#define	XDM_ISAPPLIEDCONCEALMENT(x)   (((x) >> XDM_APPLIEDCONCEALMENT) & 0x1)
#define	XDM_SETFATALERROR(x)   ((x) |= (0x1 << XDM_FATALERROR))
#define	XDM_SETUNSUPPORTEDPARAM(x)   ((x) |= (0x1 << XDM_UNSUPPORTEDPARAM))
#define	XDM_SETUNSUPPORTEDINPUT(x)   ((x) |= (0x1 << XDM_UNSUPPORTEDINPUT))
#define	XDM_SETCORRUPTEDHEADER(x)   ((x) |= (0x1 << XDM_CORRUPTEDHEADER))
#define	XDM_SETCORRUPTEDDATA(x)   ((x) |= (0x1 << XDM_CORRUPTEDDATA))
#define	XDM_SETINSUFFICIENTDATA(x)   ((x) |= (0x1 << XDM_INSUFFICIENTDATA))
#define	XDM_SETAPPLIEDCONCEALMENT(x)   ((x) |= (0x1 << XDM_APPLIEDCONCEALMENT))
#define	XDM_MAX_CONTEXT_BUFFERS   32
	Maximum number of context buffers.

Typedefs
typedef struct XDM_BufDesc	XDM_BufDesc
	Buffer descriptor for multiple buffers.
typedef struct XDM_SingleBufDesc	XDM_SingleBufDesc
	Single buffer descriptor.
typedef struct XDM1_SingleBufDesc	XDM1_SingleBufDesc
	Single buffer descriptor.
typedef struct XDM2_SingleBufDesc	XDM2_SingleBufDesc
	Single buffer descriptor.
typedef struct XDM1_BufDesc	XDM1_BufDesc
	Buffer descriptor.
typedef struct XDM2_BufDesc	XDM2_BufDesc
	Buffer descriptor.
typedef struct XDM1_AlgBufInfo	XDM1_AlgBufInfo
	Buffer information descriptor for input and output buffers.
typedef struct XDM_AlgBufInfo	XDM_AlgBufInfo
	Buffer information descriptor for input and output buffers.
typedef struct XDM2_MoveBufDesc	XDM2_MoveBufDesc
	Descriptor for a buffer to move.
typedef struct XDM_Date	XDM_Date
	Date and time.
typedef struct XDM_Point	XDM_Point
	2-dimensional point
typedef struct XDM_Rect	XDM_Rect
	Rectangle.
typedef struct XDM_ContextInfo	XDM_ContextInfo
	Buffer information descriptor for input and output buffers.
typedef struct XDM_Context	XDM_Context
	Context used by split codecs.
typedef struct XDM_DataSyncDesc	XDM_DataSyncDesc
	Descriptor for the chunk of data being transferred in one call to putData or getData.
typedef Void *	XDM_DataSyncHandle
	Handle that identifies the DataSync FIFO.
typedef Void(*	XDM_DataSyncPutFxn )(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)
	Non-blocking API to signal "data ready" to one or more consumers.
typedef XDAS_Int32(*	XDM_DataSyncGetFxn )(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)
	API to obtain data information from a consumer.
typedef XDAS_Int32(*	XDM_DataSyncGetBufferFxn )(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)
	API to obtain empty bitstream buffers from an allocator to be filled by the algorithm.
typedef XDAS_Int32(*	XDM_DataSyncPutBufferFxn )(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)
	API to return consumed bitstream buffers to the original provider.

Enumerations
enum	XDM_AccessMode {   XDM_ACCESSMODE_READ = 0,   XDM_ACCESSMODE_WRITE = 1 }
	Access modes used to declare how the algorithm accessed buffers. More...
enum	XDM_CmdId {   XDM_GETSTATUS = 0,   XDM_SETPARAMS = 1,   XDM_RESET = 2,   XDM_SETDEFAULT = 3,   XDM_FLUSH = 4,   XDM_GETBUFINFO = 5,   XDM_GETVERSION = 6,   XDM_GETCONTEXTINFO = 7,   XDM_GETDYNPARAMSDEFAULT = 8,   XDM_SETLATEACQUIREARG = 9,   XDM_MOVEBUFS = 10 }
	Standard control commands that must be implemented by XDM compliant multimedia algorithms. More...
enum	XDM_ErrorBit {   XDM_PARAMSCHANGE = 8,   XDM_APPLIEDCONCEALMENT = 9,   XDM_INSUFFICIENTDATA = 10,   XDM_CORRUPTEDDATA = 11,   XDM_CORRUPTEDHEADER = 12,   XDM_UNSUPPORTEDINPUT = 13,   XDM_UNSUPPORTEDPARAM = 14,   XDM_FATALERROR = 15 }
	Extended error information. More...
enum	XDM_DataFormat {   XDM_BYTE = 1,   XDM_LE_16 = 2,   XDM_LE_32 = 3,   XDM_LE_64 = 4,   XDM_BE_16 = 5,   XDM_BE_32 = 6,   XDM_BE_64 = 7 }
	Endianness of data. More...
enum	XDM_EncodingPreset {   XDM_DEFAULT = 0,   XDM_HIGH_QUALITY = 1,   XDM_HIGH_SPEED = 2,   XDM_USER_DEFINED = 3,   XDM_HIGH_SPEED_MED_QUALITY = 4,   XDM_MED_SPEED_MED_QUALITY = 5,   XDM_MED_SPEED_HIGH_QUALITY = 6,   XDM_ENCODING_PRESET_MAX = 7,   XDM_PRESET_DEFAULT = XDM_MED_SPEED_MED_QUALITY }
	Encoding presets. More...
enum	XDM_DecMode {   XDM_DECODE_AU = 0,   XDM_PARSE_HEADER = 1 }
	Decode entire access unit or only header. More...
enum	XDM_EncMode {   XDM_ENCODE_AU = 0,   XDM_GENERATE_HEADER = 1 }
	Encode entire access unit or only header. More...
enum	XDM_ChromaFormat {   XDM_CHROMA_NA = -1,   XDM_YUV_420P = 1,   XDM_YUV_422P = 2,   XDM_YUV_422IBE = 3,   XDM_YUV_422ILE = 4,   XDM_YUV_444P = 5,   XDM_YUV_411P = 6,   XDM_GRAY = 7,   XDM_RGB = 8,   XDM_YUV_420SP = 9,   XDM_ARGB8888 = 10,   XDM_RGB555 = 11,   XDM_RGB565 = 12,   XDM_YUV_444ILE = 13,   XDM_CHROMAFORMAT_DEFAULT = XDM_YUV_422ILE }
	Chroma formats. More...
enum	XDM_MemoryType {   XDM_MEMTYPE_ROW = 0,   XDM_MEMTYPE_RAW = 0,   XDM_MEMTYPE_TILED8 = 1,   XDM_MEMTYPE_TILED16 = 2,   XDM_MEMTYPE_TILED32 = 3,   XDM_MEMTYPE_TILEDPAGE = 4 }
	Memory space attributes. More...
enum	XDM_MemoryUsageMode { XDM_MEMUSAGE_DATASYNC = 0 }
	Memory space attributes. More...

---

Detailed Description

This is the XDM interface.

---

Macro Definition Documentation

#define XDM_EOK   IALG_EOK

Success.

#define XDM_EFAIL   IALG_EFAIL

General failure.

#define XDM_EUNSUPPORTED   -3

Request is unsupported.

#define XDM_ERUNTIME   -2

General runtime failure.

Deprecated:

This is only supported on 0.9 XDM. To use it, you must define "XDM_INCLUDE_DOT9_SUPPORT". In XDM 1.00+, it is required that codecs return "EFAIL", as "ERUNTIME" is not supported.

#define XDM_MAX_IO_BUFFERS   16

Max I/O Buffers

#define XDM_ISACCESSMODE_READ

(

x

)

(((x) >> XDM_ACCESSMODE_READ) & 0x1)

Check an access mask for CPU read access.

Parameters:

x	access mask.

Remarks:

This is typically used by an application.

See also:

XDM1_SingleBufDesc::accessMask

XDM_ISACCESSMODE_WRITE

#define XDM_ISACCESSMODE_WRITE

(

x

)

(((x) >> XDM_ACCESSMODE_WRITE) & 0x1)

Check an access mask for CPU write access.

Parameters:

x	access mask.

Remarks:

This is typically used by an application.

See also:

XDM1_SingleBufDesc::accessMask

XDM_ISACCESSMODE_READ

#define XDM_CLEARACCESSMODE_READ

(

x

)

((x) &= (~(0x1 << XDM_ACCESSMODE_READ)))

Clear the "CPU read access" bit in an access mask.

Parameters:

x	access mask.

Remarks:

This is typically used by an algorithm.

See also:

XDM_SETACCESSMODE_READ

XDM1_SingleBufDesc::accessMask

#define XDM_CLEARACCESSMODE_WRITE

(

x

)

((x) &= (~(0x1 << XDM_ACCESSMODE_WRITE)))

Clear the "CPU write access" bit in an access mask.

Parameters:

x	access mask.

Remarks:

This is typically used by an algorithm.

See also:

XDM_SETACCESSMODE_WRITE

XDM1_SingleBufDesc::accessMask

#define XDM_SETACCESSMODE_READ

(

x

)

((x) |= (0x1 << XDM_ACCESSMODE_READ))

Set the bit to indicate CPU read access in an access mask.

Parameters:

x	access mask.

Remarks:

This is typically used by an algorithm.

See also:

XDM1_SingleBufDesc::accessMask

#define XDM_SETACCESSMODE_WRITE

(

x

)

((x) |= (0x1 << XDM_ACCESSMODE_WRITE))

Set the bit to indicate CPU write access in an access mask.

Parameters:

x	access mask.

Remarks:

This is typically used by an algorithm.

See also:

XDM1_SingleBufDesc::accessMask

#define XDM_CUSTOMENUMBASE   0x100

Base of algorithm-specific enum values.

Remarks:

This is provided to ensure that future updates to XDM-defined enumerations don't conflict with algorithm-proprietary enumerations.

Custom enumerations should be defined like the following (USERENUM0 and USERENUM1 are simply examples):

    #define MYMODULE_MYVENDOR_USERENUM0 (XDM_CUSTOMENUMBASE + 0)
    #define MYMODULE_MYVENDOR_USERENUM1 (XDM_CUSTOMENUMBASE + 1)

#define XDM_CUSTOMCMDBASE   0x100

Base of algorithm-specific commands.

Remarks:

This is provided to ensure that future updates to XDM_CmdId's enumeration don't conflict with algorithm-proprietary command ID's.

Custom command ID's should be defined like the following (USERCMD0 and USERCMD1 are simply examples):

    #define MYMODULE_MYVENDOR_USERCMD0 (XDM_CUSTOMCMDBASE + 0)
    #define MYMODULE_MYVENDOR_USERCMD1 (XDM_CUSTOMCMDBASE + 1)

See also:

XDM_CmdId

#define XDM_ISFATALERROR

(

x

)

(((x) >> XDM_FATALERROR) & 0x1)

Check for fatal error

#define XDM_ISUNSUPPORTEDPARAM

(

x

)

(((x) >> XDM_UNSUPPORTEDPARAM) & 0x1)

Check for unsupported parameter

#define XDM_ISUNSUPPORTEDINPUT

(

x

)

(((x) >> XDM_UNSUPPORTEDINPUT) & 0x1)

Check for unsupported input

#define XDM_ISCORRUPTEDHEADER

(

x

)

(((x) >> XDM_CORRUPTEDHEADER) & 0x1)

Check for corrupted header

#define XDM_ISCORRUPTEDDATA

(

x

)

(((x) >> XDM_CORRUPTEDDATA) & 0x1)

Check for corrupted data

#define XDM_ISINSUFFICIENTDATA

(

x

)

(((x) >> XDM_INSUFFICIENTDATA) & 0x1)

Check for insufficient data

#define XDM_ISAPPLIEDCONCEALMENT

(

x

)

(((x) >> XDM_APPLIEDCONCEALMENT) & 0x1)

Check for applied concealment

#define XDM_SETFATALERROR

(

x

)

((x) |= (0x1 << XDM_FATALERROR))

Set fatal error bit

#define XDM_SETUNSUPPORTEDPARAM

(

x

)

((x) |= (0x1 << XDM_UNSUPPORTEDPARAM))

Set unsupported parameter bit

#define XDM_SETUNSUPPORTEDINPUT

(

x

)

((x) |= (0x1 << XDM_UNSUPPORTEDINPUT))

Set unsupported input bit

#define XDM_SETCORRUPTEDHEADER

(

x

)

((x) |= (0x1 << XDM_CORRUPTEDHEADER))

Set corrupted header bit

#define XDM_SETCORRUPTEDDATA

(

x

)

((x) |= (0x1 << XDM_CORRUPTEDDATA))

Set corrupted data bit

#define XDM_SETINSUFFICIENTDATA

(

x

)

((x) |= (0x1 << XDM_INSUFFICIENTDATA))

Set insufficient data bit

#define XDM_SETAPPLIEDCONCEALMENT

(

x

)

((x) |= (0x1 << XDM_APPLIEDCONCEALMENT))

Set applied concealment bit

#define XDM_MAX_CONTEXT_BUFFERS   32

Maximum number of context buffers.

---

Typedef Documentation

typedef struct XDM_BufDesc XDM_BufDesc

Buffer descriptor for multiple buffers.

Precondition:

numBufs can not be larger than XDM_MAX_IO_BUFFERS. Related, *bufs and *bufSizes will never be indexed beyond XDM_MAX_IO_BUFFERS elements.

Remarks:

This data type is commonly used to manage input and output buffers.

If *bufs is a sparse array, *bufSizes will be a similar sparse array. The NULL indexes in bufs will be ignored in bufSizes.

numBufs describes the number of buffers in this descriptor. if *bufs is a sparse array, numBufs describes the number of non-NULL buffers in this descriptor; this is not necessarily the maximum index of the last buffer pointed to by *bufs.

An example utilizing XDM_BufDesc as a sparse array would be the following:

                XDM_BufDesc outBufs;
                XDAS_Int32  bufSizeArray[XDM_MAX_IO_BUFFERS];
                XDAS_Int8  *pBuffers[XDM_MAX_IO_BUFFERS];
                XDAS_Int8   buffer1[4096];
                XDAS_Int8   buffer2[1024];
  
                // ensure all pBuffers and bufSizeArray are initially NULL
                memset(pBuffers, 0, sizeof(pBuffers[0]) * XDM_MAX_IO_BUFFERS);
                memset(bufSizeArray, 0,
                    sizeof(bufSizeArray[0]) * XDM_MAX_IO_BUFFERS);
  
                pBuffers[0] = buffer1;
                pBuffers[4] = buffer2;
  
                bufSizeArray[0] = 4096;
                bufSizeArray[4] = 1024;
  
                outBufs.bufs = pBuffers;
                outBufs.numBufs = 2;
                outBufs.bufSizes = bufSizeArray;

The following diagram describes graphically the example above.

typedef struct XDM_SingleBufDesc XDM_SingleBufDesc

Single buffer descriptor.

typedef struct XDM1_SingleBufDesc XDM1_SingleBufDesc

Single buffer descriptor.

typedef struct XDM2_SingleBufDesc XDM2_SingleBufDesc

Single buffer descriptor.

Remarks:

This buffer descriptor contains a memType field, and uses the XDM_BufSize union to indicate the size of the buffer. As a result, this data type can be used to describe complex memory types (e.g. tiled memory).

typedef struct XDM1_BufDesc XDM1_BufDesc

Buffer descriptor.

typedef struct XDM2_BufDesc XDM2_BufDesc

Buffer descriptor.

Remarks:

This advanced buffer uses the XDM2_SingleBufDesc, and is typically used for codecs which must reflect types of memory. For example, video codecs may need to indicate whether tiled memory is used.

typedef struct XDM1_AlgBufInfo XDM1_AlgBufInfo

Buffer information descriptor for input and output buffers.

typedef struct XDM_AlgBufInfo XDM_AlgBufInfo

Buffer information descriptor for input and output buffers.

typedef struct XDM2_MoveBufDesc XDM2_MoveBufDesc

Descriptor for a buffer to move.

typedef struct XDM_Date XDM_Date

Date and time.

typedef struct XDM_Point XDM_Point

2-dimensional point

typedef struct XDM_Rect XDM_Rect

Rectangle.

typedef struct XDM_ContextInfo XDM_ContextInfo

Buffer information descriptor for input and output buffers.

typedef struct XDM_Context XDM_Context

Context used by split codecs.

typedef struct XDM_DataSyncDesc XDM_DataSyncDesc

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

typedef Void* XDM_DataSyncHandle

Handle that identifies the DataSync FIFO.

See also:

XDM_DataSyncPutFxn()

XDM_DataSyncGetFxn()

XDM_DataSyncGetBufferFxn()

XDM_DataSyncPutBufferFxn()

typedef Void(* XDM_DataSyncPutFxn)(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)

Non-blocking API to signal "data ready" to one or more consumers.

Parameters:

[in]	dataSyncHandle	Handle to a data sync instance.
[out]	dataSyncDesc	Full data sync descriptor. This includes one or more filled data buffers.

Todo:

Needs review

See also:

IVIDDEC3_DynamicParams::putDataFxn()

IVIDENC2_DynamicParams::putDataFxn()

IVIDENC2_DynamicParams::getBufferFxn()

XDM_DataSyncGetBufferFxn

typedef XDAS_Int32(* XDM_DataSyncGetFxn)(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)

API to obtain data information from a consumer.

Parameters:

[in]	dataSyncHandle	Handle to a data sync instance.
[out]	dataSyncDesc	Empty data sync descriptor to be filled by the producer. Only the size field must be initialized by the caller.

Postcondition:

Upon return, the dataSyncDesc will contain details about the provided data.

Remarks:

Given that this is an input buffer, the implementation of this fxn must make the provided external or shared memory coherent with respect to the algorithm processor's cache.

Todo:

Needs review

See also:

IVIDDEC3_DynamicParams::getDataFxn()

IVIDDEC3_DynamicParams::putBufferFxn()

IVIDENC2_DynamicParams::getDataFxn()

XDM_DataSyncPutBufferFxn

typedef XDAS_Int32(* XDM_DataSyncGetBufferFxn)(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)

API to obtain empty bitstream buffers from an allocator to be filled by the algorithm.

Parameters:

[in]	dataSyncHandle	Handle to a data sync instance.
[out]	dataSyncDesc	Empty data sync descriptor to be filled by the allocator. Only the size field must be initialized by the caller.

Postcondition:

Upon return, the dataSyncDesc will contain details about the allocated buffer(s).

Remarks:

Given that this is an output buffer, the implementation of this fxn (i.e., the allocator) must make the provided external or shared memory coherent with respect to the algorithm processor's cache. This typically implies it must be cache invalidated since the alg may fill this buffer via DMA.

The allocator may not zero-initialize this buffer. If the allocator does initialize the buffer, it must ensure the cache coherency via writeback-invalidate.

Return values:

XDM_EOK	Allocator is able to provide the buffer or is not able to provide the buffer but indicates that it can provide the buffers in future such calls.
XDM_EFAIL	Allocator is unable to provide the buffer and it will not be able to provide the buffer in the future.

See also:

IVIDENC2_DynamicParams::putDataFxn()

IVIDENC2_Fxns::process()

typedef XDAS_Int32(* XDM_DataSyncPutBufferFxn)(XDM_DataSyncHandle dataSyncHandle, XDM_DataSyncDesc *dataSyncDesc)

API to return consumed bitstream buffers to the original provider.

Parameters:

[in]	dataSyncHandle	Handle to a data sync instance.
[out]	dataSyncDesc	Data sync descriptor.

Todo:

What cache coherency responsibilities are placed on this buffer?

Todo:

Needs review and further detail

See also:

IVIDDEC3_DynamicParams::getDataFxn()

IVIDDEC3_Fxns::process()

---

Enumeration Type Documentation

enum XDM_AccessMode

Access modes used to declare how the algorithm accessed buffers.

Remarks:

This indicates how the algorithm's CPU accessed the buffer, independent of DMA or other hardware accellerators. For example, if the buffer was written to with DMA (as opposed to writing to the buffer with the CPU write instructions), the algorithm should not set the XDM_ACCESSMODE_WRITE bit.

The value of the enum is the bit offset into a mask. The value of the enum is not the value to assign the mask.

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:

XDM1_SingleBufDesc

XDM1_BufDesc

Enumerator:

XDM_ACCESSMODE_READ	The algorithm read from the buffer using the CPU. See also: XDM_SETACCESSMODE_READ XDM_ISACCESSMODE_READ
XDM_ACCESSMODE_WRITE	The algorithm wrote to the buffer using the CPU. See also: XDM_SETACCESSMODE_WRITE XDM_ISACCESSMODE_WRITE

enum XDM_CmdId

Standard control commands that must be implemented by XDM compliant multimedia algorithms.

Remarks:

If an algorithm receives a command it doesn't handle or understand, it must return EUNSUPPORTED.

XDM_GETCONTEXTINFO need only be implemented by split codecs. Standard algorithms should return EUNSUPPORTED if they receive the XDM_GETCONTEXTINFO command.

Any control ID extension in IMOD interface should start from XDM_CUSTOMCMDBASE onward. The ID range from 0 to XDM_CUSTOMCMDBASE is reserved.

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:

XDM_CUSTOMCMDBASE

Enumerator:

XDM_GETSTATUS	Query algorithm to fill status structure. Remarks: Some XDM interfaces provide an embedded "DynamicParams" struct in the base class "Status" struct in which the current state of an algorithm's dynamic params can be returned (e.g. IVIDENC2_Status.encDynamicParams); other codec classes do not (and algs could provide this via an extended Status struct).
XDM_SETPARAMS	Set run time dynamic parameters.
XDM_RESET	Reset the algorithm. All fields in the internal data structures are reset and all internal buffers are flushed.
XDM_SETDEFAULT	Restore the algorithm's internal state to its original, default values. Remarks: The application only needs to initialize the dynamicParams.size and status.size fields prior to calling control() with XDM_SETDEFAULT. The algorithm must only write to the status.extendedError field, and potentially algorithm specific, extended fields. XDM_SETDEFAULT differs from XDM_RESET. In addition to restoring the algorithm's internal state, XDM_RESET additionally resets any channel related state.
XDM_FLUSH	Handle end of stream conditions. This command forces the algorithm to output data without additional input. The recommended sequence is to call the control() function (with XDM_FLUSH) followed by repeated calls to the process() function until it returns an error. Remarks: The algorithm should return the appropriate, class-specific "EFAIL" error (e.g. ISPHDEC1_EFAIL, IVIDENC1_EFAIL, etc), when flushing is complete.
XDM_GETBUFINFO	Query algorithm instance regarding its properties of input and output buffers. Remarks: The application only needs to initialize the dynamicParams.size, the status.size, and set any buffer descriptor fields (e.g. status.data) to NULL prior to calling control() with XDM_GETBUFINFO.
XDM_GETVERSION	Query the algorithm's version. The result will be returned in the data field of the respective _Status structure. Remarks: There is no specific format defined for version returned by the algorithm.
XDM_GETCONTEXTINFO	Query a split codec part for its context needs. Remarks: Only split codecs are required to implement this command.
XDM_GETDYNPARAMSDEFAULT	Query the algorithm to fill the default values for the parameters which can be configured dynamically. Remarks: The algorithm provides the default dynamic params by writing into the dynamicParams structure. Note that this is an exception to the general rule that the algorithm should not write into dynamicParams. The application only needs to initialize the dynamicParams.size and status.size fields prior to calling control() with XDM_GETDYNPARAMSDEFAULT. Other than the .size field, values in the status struct are undefined upon returning from this call. To get the current value of an algorithm instance's dynamic parameters, it's recommended that the alg provide them via the XDM_GETSTATUS call.
XDM_SETLATEACQUIREARG	Set an algorithm's 'late acquire' argument. Remarks: Handling this command is optional. Only algorithms that utilize the late acquire IRES feature may implement this command.
XDM_MOVEBUFS	Move (replace) data buffers an algorithm is currently referencing. Remarks: Handling this command is optional. An application can use this command to move data buffers that an algorithm is currently referencing. Only algorithms tracking buffers with id's (e.g. IVIDDEC3) can implement this command. Only algorithms who's _Status struct includes a data field (e.g. IVIDDEC3) can implement this command. This data field is a buffer descriptor. When using the XDM_MOVEBUFS command, this data buffer is an IN buffer (read-only to the algorithm) which contains an array of one or more XDM2_MoveBufDesc elements. Each element indicates (via the id field), a buffer which the algorithm is referencing that needs to be "moved". The application is responsible for indicating the number of XDM2_MoveBufDesc elements by appropriately setting the _Status.data.bufSize field. As with all control() processing, the algorithm is responsible for appropriately setting the _Status.data.accessMask field indicating if/how the algorithm accessed the data buffer. Typically for this cmd, the algorithm reads from the data buffer, so it should set the XDM_ACCESSMODE_READ bit in the _Status.data.accessMask field. Frameworks/apps can use this to appropriately handle cache for that data buffer. See also: XDM2_MoveBufDesc

enum XDM_ErrorBit

Extended error information.

Remarks:

When an internal error occurs, the algorithm will return an error return value (e.g. EFAIL, EUNSUPPORTED)

The value of each enum is the bit which is set.

Bits 31-16 are reserved. Bits 7-0 are codec and implementation specific.

The algorithm can set multiple bits to 1 based on conditions. e.g. it will set bits XDM_FATALERROR (fatal) and XDM_UNSUPPORTEDPARAM (unsupported params) in case of unsupported run time parameters.

This enumeration data type should not be used for storage, but rather only for its constant values.

Enumerator:

XDM_PARAMSCHANGE	Bit 8 - Sequence Parameters Change. Remarks: This error is applicable for transcoders. It is set when some key parameter of the input sequence changes. The transcoder simply returns after setting this error field and the correct input sequence parameters are updated in outArgs.
XDM_APPLIEDCONCEALMENT	Bit 9 - Applied concealment. Remarks: This error is applicable for decoders. It is set when the decoder was not able to able to decode the bitstream, and the decoder has concealed the bitstream error and produced the concealed output.
XDM_INSUFFICIENTDATA	Bit 10 - Insufficient input data. Remarks: This error is typically applicable for decoders. This is set when the input data provided is not sufficient to produce of one frame of data. This can be also be set for encoders when the number of valid samples in the input frame is not sufficient to process a frame.
XDM_CORRUPTEDDATA	Bit 11 - Data problem/corruption. Remarks: This error is typically applicable for decoders. This is set when the bitstream has an error and not compliant to the standard syntax.
XDM_CORRUPTEDHEADER	Bit 12 - Header problem/corruption. Remarks: This error is typically applicable for decoders. This is set when the header information in the bitstream is incorrect. For example, it is set when Sequence/Picture/Slice etc. are incorrect in video decoders.
XDM_UNSUPPORTEDINPUT	Bit 13 - Unsupported feature/parameter in input. Remarks: This error is set when the algorithm is not able process a certain input data/bitstream format. It can also be set when a subset of features in a standard are not supported by the algorithm. For example, if a video encoder only supports 4:2:2 format, it can set this error for any other type of input video format.
XDM_UNSUPPORTEDPARAM	Bit 14 - Unsupported input parameter or configuration. Remarks: This error is set when the algorithm doesn't support certain configurable parameters. For example, if the video decoder doesn't support the "display width" feature, it shall return XDM_UNSUPPORTEDPARAM when the control function is called for setting the displayWidth attribute.
XDM_FATALERROR	Bit 15 - Fatal error (stop the codec). If there is an error and this bit is not set, the error is a recoverable one. Remarks: This error is set when the algorithm cannot recover from the current state. It informs the system not to try the next frame and possibly delete the multimedia algorithm instance. It implies the codec shall not work when reset. The user should delete the current instance of the codec.

enum XDM_DataFormat

Endianness of data.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

XDM_BYTE	Big endian stream.
XDM_LE_16	16 bit little endian stream.
XDM_LE_32	32 bit little endian stream.
XDM_LE_64	64 bit little endian stream.
XDM_BE_16	16 bit big endian stream.
XDM_BE_32	32 bit big endian stream.
XDM_BE_64	64 bit big endian stream.

enum XDM_EncodingPreset

Encoding presets.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

XDM_DEFAULT	Default setting of encoder. See codec specific documentation for its encoding behaviour.
XDM_HIGH_QUALITY	High quality encoding.
XDM_HIGH_SPEED	High speed encoding.
XDM_USER_DEFINED	User defined configuration, using advanced parameters.
XDM_HIGH_SPEED_MED_QUALITY	High speed, medium quality encoding.
XDM_MED_SPEED_MED_QUALITY	Medium speed, medium quality encoding.
XDM_MED_SPEED_HIGH_QUALITY	Medium speed, high quality encoding.
XDM_ENCODING_PRESET_MAX	Todo: need to add documentation
XDM_PRESET_DEFAULT	Default setting of encoder. See codec specific documentation for its encoding behaviour.

enum XDM_DecMode

Decode entire access unit or only header.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

XDM_DECODE_AU	Decode entire access unit, including all the headers.
XDM_PARSE_HEADER	Decode only header.

enum XDM_EncMode

Encode entire access unit or only header.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

XDM_ENCODE_AU	Encode entire access unit, including the headers.
XDM_GENERATE_HEADER	Encode only header.

enum XDM_ChromaFormat

Chroma formats.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

XDM_CHROMA_NA	Chroma format not applicable.
XDM_YUV_420P	YUV 4:2:0 planer.
XDM_YUV_422P	YUV 4:2:2 planer.
XDM_YUV_422IBE	YUV 4:2:2 interleaved (big endian).
XDM_YUV_422ILE	YUV 4:2:2 interleaved (little endian).
XDM_YUV_444P	YUV 4:4:4 planer.
XDM_YUV_411P	YUV 4:1:1 planer.
XDM_GRAY	Gray format.
XDM_RGB	RGB color format.
XDM_YUV_420SP	YUV 420 semi_planar format.(Luma 1st plane, CbCr interleaved 2nd plane)
XDM_ARGB8888	Alpha plane.
XDM_RGB555	RGB 555 color format.
XDM_RGB565	RGB 565 color format.
XDM_YUV_444ILE	YUV 4:4:4 interleaved (little endian).
XDM_CHROMAFORMAT_DEFAULT	Default setting.

enum XDM_MemoryType

Memory space attributes.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

This enumeration defines a base set of values. Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures. These extended enums should be between XDM_CUSTOMENUMBASE and 0x7FFF.

See also:

XDM_CUSTOMENUMBASE

Enumerator:

XDM_MEMTYPE_ROW	Linear (standard) memory. Deprecated: The XDM_MEMTYPE_ROW value is deprecated. Please use XDM_MEMTYPE_RAW (which, by design, has the same underyling value) instead. Remarks: XDM_MEMTYPE_ROW may be removed in a future release. See also: XDM_MemoryType::XDM_MEMTYPE_RAW
XDM_MEMTYPE_RAW	Linear (standard) memory. Todo: add documentation
XDM_MEMTYPE_TILED8	Todo: add documentation
XDM_MEMTYPE_TILED16	Todo: add documentation
XDM_MEMTYPE_TILED32	Todo: add documentation
XDM_MEMTYPE_TILEDPAGE	Todo: add documentation

enum XDM_MemoryUsageMode

Memory space attributes.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

Enumerator:

XDM_MEMUSAGE_DATASYNC

Bit 0 - Data Sync mode Remarks: If this bit is set, the memory will be used in data sync mode. When in data sync mode, the algorithm is responsible for ensuring any XDAIS rules are met for the buffer (e.g. managing cache coherency). If an algorithm is running in mode other than data sync, and receives a buffer with this bit set, it should return an error, likely XDM_UNSUPPORTEDINPUT.