viddec1.h File Reference

---

Detailed Description

The VIDDEC1 video decoder interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined IVIDDEC1 video decoder interface.

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

Include dependency graph for viddec1.h:

Go to the source code of this file.

Data Structures
struct	IVIDDEC1_CodecClassConfig
	Definition of IVIDDEC1 codec class configurable parameters. More...

Macros
#define	VIDDEC1_EOK   IVIDDEC1_EOK
#define	VIDDEC1_EFAIL   IVIDDEC1_EFAIL
#define	VIDDEC1_EUNSUPPORTED   IVIDDEC1_EUNSUPPORTED
#define	VIDDEC1_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	VIDDEC1_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	VIDDEC1_VISATYPE   "ti.sdo.ce.video1.IVIDDEC1"
	The VISA type.
#define	VIDDEC1_STUBSNAME   "VIDDEC1_STUBS"
	Name of stub functions. Use this name when registering the VIDDEC1_STUBS functions with Engine_addStubFxns.

Typedefs
typedef IVIDDEC1_Status	VIDDEC1_Status
	Defines instance status parameters.
typedef VISA_Handle	VIDDEC1_Handle
	Opaque handle to a VIDDEC1 codec.
typedef struct IVIDDEC1_Params	VIDDEC1_Params
	This structure defines the parameters necessary to create an instance of a Video Decoder object.
typedef IVIDDEC1_InArgs	VIDDEC1_InArgs
	Defines the input arguments for all IVIDDEC1 instance process function.
typedef IVIDDEC1_OutArgs	VIDDEC1_OutArgs
	Defines the run time output arguments for all IVIDDEC1 instance objects.
typedef IVIDDEC1_Cmd	VIDDEC1_Cmd
	Defines the control commands for the IVIDDEC1 module.
typedef IVIDDEC1_DynamicParams	VIDDEC1_DynamicParams
	This structure defines the codec parameters that can be modified after creation via control() calls.
typedef struct IVIDDEC1_CodecClassConfig	IVIDDEC1_CodecClassConfig
	Definition of IVIDDEC1 codec class configurable parameters.

Functions
VIDDEC1_Handle	VIDDEC1_create (Engine_Handle e, String name, VIDDEC1_Params *params)
	Create an instance of a video decoder algorithm.
Int32	VIDDEC1_process (VIDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC1_InArgs *inArgs, VIDDEC1_OutArgs *outArgs)
	Execute the process() method in this instance of a video decoder algorithm.
Int32	VIDDEC1_control (VIDDEC1_Handle handle, VIDDEC1_Cmd id, VIDDEC1_DynamicParams *params, VIDDEC1_Status *status)
	Execute the control() method in this instance of a video decoder algorithm.
Void	VIDDEC1_delete (VIDDEC1_Handle handle)
	Delete the instance of a video decoder algorithm.
XDAS_Int32	VIDDEC1_processAsync (VIDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC1_InArgs *inArgs, VIDDEC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a video decoder algorithm.
XDAS_Int32	VIDDEC1_processWait (VIDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC1_InArgs *inArgs, VIDDEC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of VIDDEC1_processAsync() in this instance of an video decoder algorithm.