imgdec.h File Reference

---

Detailed Description

The IMGDEC image decoder interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined IIMGDEC image decoder interface.

#include <ti/xdais/dm/xdm.h>
#include <ti/xdais/dm/iimgdec.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/visa.h>
#include <ti/sdo/ce/skel.h>

Include dependency graph for imgdec.h:

Go to the source code of this file.

Data Structures
struct	IIMGDEC_CodecClassConfig
	Definition of IIMGDEC codec class configurable parameters. More...

Macros
#define	IMGDEC_EOK   IIMGDEC_EOK
#define	IMGDEC_EFAIL   IIMGDEC_EFAIL
#define	IMGDEC_ERUNTIME   IIMGDEC_ERUNTIME
#define	IMGDEC_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	IMGDEC_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	IMGDEC_VISATYPE   "ti.sdo.ce.image.IIMGDEC"
	The VISA type.
#define	IMGDEC_STUBSNAME   "IMGDEC_STUBS"
	Name of stub functions. Use this name when registering the IMGDEC_STUBS functions with Engine_addStubFxns.

Typedefs
typedef IIMGDEC_Status	IMGDEC_Status
	Defines instance status parameters (read-only).
typedef VISA_Handle	IMGDEC_Handle
	Opaque handle to a IMGDEC codec.
typedef struct IIMGDEC_Params	IMGDEC_Params
	This structure defines the parameters necessary to create an instance of a image decoder object.
typedef IIMGDEC_InArgs	IMGDEC_InArgs
	Defines the input arguments for all IIMGDEC instance process() function.
typedef IIMGDEC_OutArgs	IMGDEC_OutArgs
	Defines the run time output arguments for all IIMGDEC instance objects.
typedef IIMGDEC_Cmd	IMGDEC_Cmd
	Defines the control commands for the IIMGDEC module.
typedef IIMGDEC_DynamicParams	IMGDEC_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IIMGDEC_CodecClassConfig	IIMGDEC_CodecClassConfig
	Definition of IIMGDEC codec class configurable parameters.

Functions
IMGDEC_Handle	IMGDEC_create (Engine_Handle e, String name, IMGDEC_Params *params)
	Create an instance of an image decoder algorithm.
Int32	IMGDEC_process (IMGDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGDEC_InArgs *inArgs, IMGDEC_OutArgs *outArgs)
	Execute the process() method in this instance of a image decoder algorithm.
Int32	IMGDEC_control (IMGDEC_Handle handle, IMGDEC_Cmd id, IMGDEC_DynamicParams *params, IMGDEC_Status *status)
	Execute the control() method in this instance of an image decoder algorithm.
Void	IMGDEC_delete (IMGDEC_Handle handle)
	Delete the instance of a image decoder algorithm.
XDAS_Int32	IMGDEC_processAsync (IMGDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGDEC_InArgs *inArgs, IMGDEC_OutArgs *outArgs)
	Perform asynchronous submission to this instance of an image decoder algorithm.
XDAS_Int32	IMGDEC_processWait (IMGDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IMGDEC_InArgs *inArgs, IMGDEC_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of IMGDEC_processAsync() in this instance of an image decoder algorithm.