videnc1.h File Reference

---

Detailed Description

The VIDENC1 video encoder interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined IVIDENC1 video encoder interface.

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

Include dependency graph for videnc1.h:

Go to the source code of this file.

Data Structures
struct	IVIDENC1_CodecClassConfig
	Definition of IVIDENC1 codec class configurable parameters. More...

Macros
#define	VIDENC1_EOK   IVIDENC1_EOK
#define	VIDENC1_EFAIL   IVIDENC1_EFAIL
#define	VIDENC1_EUNSUPPORTED   IVIDENC1_EUNSUPPORTED
#define	VIDENC1_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	VIDENC1_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	VIDENC1_VISATYPE   "ti.sdo.ce.video1.IVIDENC1"
	The VISA type.
#define	VIDENC1_STUBSNAME   "VIDENC1_STUBS"
	Name of stub functions. Use this name when registering the VIDENC1_STUBS functions with Engine_addStubFxns.

Typedefs
typedef VISA_Handle	VIDENC1_Handle
	Opaque handle to a VIDENC1 codec.
typedef struct IVIDENC1_Params	VIDENC1_Params
	Defines the creation time parameters for all IVIDENC1 instance objects.
typedef IVIDENC1_InArgs	VIDENC1_InArgs
	Defines the input arguments for all IVIDENC1 instance process function.
typedef IVIDENC1_OutArgs	VIDENC1_OutArgs
	Defines the run time output arguments for all IVIDENC1 instance objects.
typedef IVIDENC1_Cmd	VIDENC1_Cmd
	Defines the control commands for the IVIDENC1 module.
typedef IVIDENC1_DynamicParams	VIDENC1_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef IVIDENC1_Status	VIDENC1_Status
	Defines instance status parameters.
typedef struct IVIDENC1_CodecClassConfig	IVIDENC1_CodecClassConfig
	Definition of IVIDENC1 codec class configurable parameters.

Functions
Int32	VIDENC1_control (VIDENC1_Handle handle, VIDENC1_Cmd id, VIDENC1_DynamicParams *params, VIDENC1_Status *status)
	Execute the control() method in this instance of a video encoder algorithm.
VIDENC1_Handle	VIDENC1_create (Engine_Handle e, String name, VIDENC1_Params *params)
	Create an instance of a video encoder algorithm.
Void	VIDENC1_delete (VIDENC1_Handle handle)
	Delete the instance of a video encoder algorithm.
Int32	VIDENC1_process (VIDENC1_Handle handle, IVIDEO1_BufDescIn *inBufs, XDM_BufDesc *outBufs, VIDENC1_InArgs *inArgs, VIDENC1_OutArgs *outArgs)
	Execute the process() method in this instance of a video encoder algorithm.
XDAS_Int32	VIDENC1_processAsync (VIDENC1_Handle handle, IVIDEO1_BufDescIn *inBufs, XDM_BufDesc *outBufs, IVIDENC1_InArgs *inArgs, IVIDENC1_OutArgs *outArgs)
	Perform asynchronous submission to this instance of a video decoder algorithm.
XDAS_Int32	VIDENC1_processWait (VIDENC1_Handle handle, IVIDEO1_BufDescIn *inBufs, XDM_BufDesc *outBufs, IVIDENC1_InArgs *inArgs, IVIDENC1_OutArgs *outArgs, UInt timeout)
	Wait for a return message from a previous invocation of VIDENC1_processAsync() in this instance of an video decoder algorithm.