imgenc1.h File Reference

---

Detailed Description

The IMGENC1 image encoder interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined IIMGENC1 image encoder interface.

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

Include dependency graph for imgenc1.h:

Go to the source code of this file.

Data Structures
struct	IIMGENC1_CodecClassConfig
	Definition of IIMGENC1 codec class configurable parameters. More...

Macros
#define	IMGENC1_EOK   IIMGENC1_EOK
#define	IMGENC1_EFAIL   IIMGENC1_EFAIL
#define	IMGENC1_EUNSUPPORTED   IIMGENC1_EUNSUPPORTED
#define	IMGENC1_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	IMGENC1_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	IMGENC1_VISATYPE   "ti.sdo.ce.image1.IIMGENC1"
	The VISA type.
#define	IMGENC1_STUBSNAME   "IMGENC1_STUBS"
	Name of stub functions. Use this name when registering the IMGENC1_STUBS functions with Engine_addStubFxns.

Typedefs
typedef VISA_Handle	IMGENC1_Handle
	Opaque handle to a IMGENC1 codec.
typedef struct IIMGENC1_Params	IMGENC1_Params
	Defines the creation time parameters for all IIMGENC1 instance objects.
typedef IIMGENC1_InArgs	IMGENC1_InArgs
	Defines the input arguments for all IIMGENC1 instance process() function.
typedef IIMGENC1_OutArgs	IMGENC1_OutArgs
	Defines the run time output arguments for all IIMGENC1 instance objects.
typedef IIMGENC1_Cmd	IMGENC1_Cmd
	Defines the control commands for the IIMGENC1 module.
typedef IIMGENC1_DynamicParams	IMGENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef IIMGENC1_Status	IMGENC1_Status
	Defines instance status parameters.
typedef struct IIMGENC1_CodecClassConfig	IIMGENC1_CodecClassConfig
	Definition of IIMGENC1 codec class configurable parameters.

Functions
Int32	IMGENC1_control (IMGENC1_Handle handle, IMGENC1_Cmd id, IMGENC1_DynamicParams *params, IMGENC1_Status *status)
	Execute the control() method in this instance of an image encoder algorithm.
IMGENC1_Handle	IMGENC1_create (Engine_Handle e, String name, IMGENC1_Params *params)
	Create an instance of an image encoder algorithm.
Void	IMGENC1_delete (IMGENC1_Handle handle)
	Delete the instance of an image encoder algorithm.
Int32	IMGENC1_process (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IMGENC1_InArgs *inArgs, IMGENC1_OutArgs *outArgs)
	Execute the process() method in this instance of an image encoder algorithm.
XDAS_Int32	IMGENC1_processAsync (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of an image encoder algorithm.
XDAS_Int32	IMGENC1_processWait (IMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of IMGENC1_processAsync() in this instance of an image encoder algorithm.