XDAIS  dais-x04
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Structures | Macros | Typedefs | Enumerations
xdm.h File Reference

Detailed Description

This header defines all types, constants, and functions shared across the various XDM classes of algorithms.

#include <ti/xdais/ialg.h>
#include <ti/xdais/xdas.h>
Include dependency graph for xdm.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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...
Copyright 2013, Texas Instruments Incorporated