XDM IVIDDEC1 Video Decoder Interface


Detailed Description

This is the XDM IVIDDEC1 Video Decoder Interface.


Data Structures

struct  IVIDDEC1_Obj
 This must be the first field of all IVIDDEC1 instance objects. More...
struct  IVIDDEC1_Params
 Defines the creation time parameters for all IVIDDEC1 instance objects. More...
struct  IVIDDEC1_DynamicParams
 This structure defines the codec parameters that can be modified after creation via control() calls. More...
struct  IVIDDEC1_InArgs
 Defines the input arguments for all IVIDDEC1 instance process function. More...
struct  IVIDDEC1_Status
 Defines instance status parameters. More...
struct  IVIDDEC1_OutArgs
 Defines the run time output arguments for all IVIDDEC1 instance objects. More...
struct  IVIDDEC1_Fxns
 Defines all of the operations on IVIDDEC1 objects. More...

Defines

#define IVIDDEC1_EOK   XDM_EOK
#define IVIDDEC1_EFAIL   XDM_EFAIL
#define IVIDDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED
#define IVIDDEC1_FREE_BUFF_SIZE   16

Typedefs

typedef IVIDDEC1_ObjIVIDDEC1_Handle
 Opaque handle to an IVIDDEC1 objects.
typedef IALG_Cmd IVIDDEC1_Cmd
 Defines the control commands for the IVIDDEC1 module.

Enumerations

enum  IVIDDEC1_FrameOrder {
  IVIDDEC_DISPLAY_ORDER = 0,
  IVIDDEC_DECODE_ORDER = 1,
  IVIDDEC_FRAMEORDER_DEFAULT = IVIDDEC_DISPLAY_ORDER
}
 Video decoder output frame order. More...


Define Documentation

#define IVIDDEC1_EOK   XDM_EOK

Success.

#define IVIDDEC1_EFAIL   XDM_EFAIL

General failure.

#define IVIDDEC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

#define IVIDDEC1_FREE_BUFF_SIZE   16

Maximum buffer that can be freed up in a single process call


Typedef Documentation

typedef struct IVIDDEC1_Obj* IVIDDEC1_Handle

Opaque handle to an IVIDDEC1 objects.

typedef IALG_Cmd IVIDDEC1_Cmd

Defines the control commands for the IVIDDEC1 module.

Remarks:
This ID can be extended in IMOD interface for additional controls.
See also:
XDM_CmdId

IVIDDEC1_Fxns::control()


Enumeration Type Documentation

enum IVIDDEC1_FrameOrder

Video decoder output frame order.

Remarks:
This enumeration data type should not be used for storage, but rather only for its constant values.
See also:
IVIDDEC1_DynamicParams::frameOrder
Enumerator:
IVIDDEC_DISPLAY_ORDER  The decoder provides decoded output in in the actual order of displaying the output buffer. The codec assumes the responsibility of reordering the frames.

Remarks:
The output buffer will be delayed by one frame, regardless of whether the frame contains I/P or I/P/B frames.

This is the default mode.

This mode is required to be supported by all video decoder codecs.

IVIDDEC_DECODE_ORDER  The decoder provides decoded output in the the order of decoding. There will be no delay in the output buffers.

Remarks:
It is the application's responsibility to handle the frame re-ordering.

This mode is optional. If it is not supported by the decoder, IVIDDEC_EUNSUPPORTED will be returned.

IVIDDEC_FRAMEORDER_DEFAULT  Default setting.


Copyright 2009, Texas Instruments Incorporated