XDAIS  dais-x04
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Data Fields
IIMGENC1_Fxns Struct Reference

Defines all of the operations on IIMGENC1 objects. More...

#include <iimgenc1.h>

Collaboration diagram for IIMGENC1_Fxns:
Collaboration graph

Data Fields

IALG_Fxns ialg
XDAS_Int32(* process )(IIMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs)
 Basic image encoding call.
XDAS_Int32(* control )(IIMGENC1_Handle handle, IIMGENC1_Cmd id, IIMGENC1_DynamicParams *params, IIMGENC1_Status *status)
 Control behaviour of an algorithm.

Detailed Description

Defines all of the operations on IIMGENC1 objects.


Field Documentation

IALG_Fxns IIMGENC1_Fxns::ialg

XDAIS algorithm interface.

See also:
IALG_Fxns
XDAS_Int32(* IIMGENC1_Fxns::process)(IIMGENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IIMGENC1_InArgs *inArgs, IIMGENC1_OutArgs *outArgs)

Basic image encoding call.

Parameters:
[in]handleHandle to an algorithm instance.
[in,out]inBufsInput buffer descriptors.
[in,out]outBufsOutput buffer descriptors. The algorithm may modify the output buffer pointers.
[in]inArgsInput arguments. This is a required parameter.
[out]outArgsOuput results. This is a required parameter.
Remarks:
process() is a blocking call. When process() returns, the algorithm's processing is complete.
Precondition:
handle must be a valid algorithm instance handle.
inArgs must not be NULL, and must point to a valid IIMGENC1_InArgs structure.
outArgs must not be NULL, and must point to a valid IIMGENC1_OutArgs structure.
inBufs must not be NULL, and must point to a valid XDM1_BufDesc structure.
inBufs->descs[0].buf must not be NULL, and must point to a valid buffer of data that is at least inBufs->descs[0].bufSize bytes in length.
outBufs must not be NULL, and must point to a valid XDM1_BufDesc structure.
outBufs->descs[0].buf must not be NULL, and must point to a valid buffer of data that is at least outBufs->descs[0].bufSize bytes in length.
The buffers in inBufs and outBufs are physically contiguous and owned by the calling application.
Postcondition:
The algorithm must not modify the contents of inArgs.
The algorithm must not modify the contents of inBufs, with the exception of inBufs.descs[].accessMask. That is, the data and buffers pointed to by these parameters must be treated as read-only.
The algorithm must appropriately set/clear the XDM1_BufDesc::descs[].accessMask field in both inBufs and outBufs. For example, if the algorithm only read from inBufs.descs[0].buf using the algorithm processor, it could utilize XDM_SETACCESSMODE_READ to update the appropriate accessMask fields. The application may utilize these returned values to appropriately manage cache.
The buffers in inBufs and outBufs are owned by the calling application.
Return values:
IIMGENC1_EOKSuccess.
IIMGENC1_EFAILGeneral failure. See IIMGENC1_Status::extendedError for more detailed further error conditions.
IIMGENC1_EUNSUPPORTEDRequest is unsupported.
XDAS_Int32(* IIMGENC1_Fxns::control)(IIMGENC1_Handle handle, IIMGENC1_Cmd id, IIMGENC1_DynamicParams *params, IIMGENC1_Status *status)

Control behaviour of an algorithm.

Parameters:
[in]handleHandle to an algorithm instance.
[in]idCommand id. See XDM_CmdId.
[in]paramsDynamic parameters. This is a required parameter.
[out]statusOutput results. This is a required parameter.
Precondition:
handle must be a valid algorithm instance handle.
params must not be NULL, and must point to a valid IIMGENC1_DynamicParams structure.
status must not be NULL, and must point to a valid IIMGENC1_Status structure.
If a buffer is provided in the status->data field, it must be physically contiguous and owned by the calling application.
Postcondition:
The algorithm must not modify the contents of params. That is, the data pointed to by this parameter must be treated as read-only.
If a buffer was provided in the status->data field, it is owned by the calling application.
Return values:
IIMGENC1_EOKSuccess.
IIMGENC1_EFAILGeneral failure. See IIMGDEN1_Status::extendedError for more detailed further error conditions.
IIMGENC1_EUNSUPPORTEDRequest is unsupported.

The documentation for this struct was generated from the following file:
Copyright 2013, Texas Instruments Incorporated