Shared xDM Definitions

Detailed Description

This is the xDM interface.


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...
struct  XDM1_BufDesc
 Buffer descriptor. More...
struct  XDM_AlgBufInfo
 Buffer information descriptor for input and output buffers. More...

Defines

#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_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))

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
}
 Standard control commands that must be implemented by xDM compliant multimedia algorithms. More...
enum  XDM_ErrorBit {
  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
}
 Endianness of data. More...
enum  XDM_EncodingPreset {
  XDM_DEFAULT = 0,
  XDM_HIGH_QUALITY = 1,
  XDM_HIGH_SPEED = 2,
  XDM_USER_DEFINED = 3
}
 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_CHROMAFORMAT_DEFAULT = XDM_YUV_422ILE
}
 Chroma formats. More...

Define 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

XDM1_BufDesc::accessMask

#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

XDM1_BufDesc::accessMask

#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

XDM1_BufDesc::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

XDM1_BufDesc::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

XDM1_BufDesc::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

XDM1_BufDesc::accessMask

#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

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.

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:
Any control ID extension in IMOD interface should start from 256 onward. The ID range from 0 to 255 is reserved.
Enumerator:
XDM_GETSTATUS  Query algorithm to fill status structure.
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  Initialize all fields in the param structure to their default values. The application can change specific parameters using XDM_SETPARAMS.
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.
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.

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 32-16 and bit 8 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.

Enumerator:
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.

Enumerator:
XDM_BYTE  Big endian stream.
XDM_LE_16  16 bit little endian stream.
XDM_LE_32  32 bit little endian stream.

enum XDM_EncodingPreset

Encoding presets.

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.

enum XDM_DecMode

Decode entire access unit or only header.

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.

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

enum XDM_ChromaFormat

Chroma formats.

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_CHROMAFORMAT_DEFAULT  Default setting.

Copyright 2007, Texas Instruments Incorporated