Data Structures | |
struct | IVIDENC_CodecClassConfig |
Definition of IVIDENC codec class configurable parameters. More... | |
Defines | |
#define | VIDENC_EOK IVIDENC_EOK |
#define | VIDENC_EFAIL IVIDENC_EFAIL |
#define | VIDENC_ERUNTIME IVIDENC_ERUNTIME |
#define | VIDENC_ETIMEOUT VISA_ETIMEOUT |
#define | VIDENC_FOREVER VISA_FOREVER |
#define | VIDENC_VISATYPE "ti.sdo.ce.video.IVIDENC" |
The VISA type. | |
#define | VIDENC_STUBSNAME "VIDENC_STUBS" |
Name of stub functions. Use this name when registering the VIDENC_STUBS functions with Engine_addStubFxns. | |
Typedefs | |
typedef IVIDENC_Status | VIDENC_Status |
typedef VISA_Handle | VIDENC_Handle |
Opaque handle to a VIDENC codec. | |
typedef struct IVIDENC_Params | VIDENC_Params |
This structure defines the parameters necessary to create an instance of a video encoder object. | |
typedef IVIDENC_InArgs | VIDENC_InArgs |
typedef IVIDENC_OutArgs | VIDENC_OutArgs |
typedef IVIDENC_Cmd | VIDENC_Cmd |
typedef IVIDENC_DynamicParams | VIDENC_DynamicParams |
typedef struct IVIDENC_CodecClassConfig | IVIDENC_CodecClassConfig |
Definition of IVIDENC codec class configurable parameters. | |
Functions | |
VIDENC_Handle | VIDENC_create (Engine_Handle e, String name, VIDENC_Params *params) |
Create an instance of a video encoder algorithm. | |
Int32 | VIDENC_process (VIDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDENC_InArgs *inArgs, VIDENC_OutArgs *outArgs) |
Execute the process() method in this instance of a video encoder algorithm. | |
Int32 | VIDENC_control (VIDENC_Handle handle, VIDENC_Cmd id, VIDENC_DynamicParams *params, VIDENC_Status *status) |
Execute the control() method in this instance of a video encoder algorithm. | |
Void | VIDENC_delete (VIDENC_Handle handle) |
Delete the instance of a video encoder algorithm. | |
XDAS_Int32 | VIDENC_processAsync (VIDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IVIDENC_InArgs *inArgs, IVIDENC_OutArgs *outArgs) |
Perform asynchronous submission to this instance of a video decoder algorithm. | |
XDAS_Int32 | VIDENC_processWait (VIDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IVIDENC_InArgs *inArgs, IVIDENC_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of VIDENC_processAsync() in this instance of an video decoder algorithm. |
This is the VIDENC video encoder codec interface. Several of the data types in this API are specified by the XDM interface; please see the XDM documentation for those details.
#define VIDENC_EOK IVIDENC_EOK |
Success.
#define VIDENC_EFAIL IVIDENC_EFAIL |
General failure.
#define VIDENC_ERUNTIME IVIDENC_ERUNTIME |
General runtime failure.
#define VIDENC_ETIMEOUT VISA_ETIMEOUT |
Timeout occurred.
#define VIDENC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define VIDENC_VISATYPE "ti.sdo.ce.video.IVIDENC" |
The VISA type.
#define VIDENC_STUBSNAME "VIDENC_STUBS" |
Name of stub functions. Use this name when registering the VIDENC_STUBS functions with Engine_addStubFxns.
typedef IVIDENC_Status VIDENC_Status |
Defines instance status parameters.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef VISA_Handle VIDENC_Handle |
Opaque handle to a VIDENC codec.
typedef struct IVIDENC_Params VIDENC_Params |
This structure defines the parameters necessary to create an instance of a video encoder object.
typedef IVIDENC_InArgs VIDENC_InArgs |
Defines the input arguments for all IVIDENC instance process function.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef IVIDENC_OutArgs VIDENC_OutArgs |
Defines the run time output arguments for all IVIDENC instance objects.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef IVIDENC_Cmd VIDENC_Cmd |
Defines the control commands for the IVIDENC module.
This structure defines the codec parameters that can be modified after creation via control() calls.
size
parameter. size
field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.typedef struct IVIDENC_CodecClassConfig IVIDENC_CodecClassConfig |
Definition of IVIDENC codec class configurable parameters.
VIDENC_Handle VIDENC_create | ( | Engine_Handle | e, |
String | name, | ||
VIDENC_Params * | params | ||
) |
Create an instance of a video encoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDENC_create()) or explicitly serialize access to a shared handle.
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of video encoder to create. |
[in] | params | Creation parameters. |
NULL | An error has occurred. |
non-NULL | The handle to the newly created video encoder instance. |
params
is optional. If it's not supplied, codec-specific default params will be used.name
is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated, to be overridden. This optional argument string is of the form ":priority", ":priority:flag", or "::flag". IALG_EXTERNAL
. If flag is 0, the memory for the codec will be allocated from the heaps it has requested. For example, if a codec named "mp3" has been configured into the system, setting name to "mp3:4" would cause the codec to be created at priority 4, instead of whatever priority was configured. This feature is useful if more than one instance of the codec are to be created at different priorities. Int32 VIDENC_process | ( | VIDENC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
VIDENC_InArgs * | inArgs, | ||
VIDENC_OutArgs * | outArgs | ||
) |
Execute the process() method in this instance of a video encoder algorithm.
[in] | handle | Handle to a created video encoder instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
handle
is a valid (non-NULL) video encoder handle and the video encoder is in the created state.VIDENC_EOK | Success. |
VIDENC_EFAIL | Failure. |
VIDENC_ERUNTIME | Internal Runtime Error. |
outArgs->extendedError
may indicate further details about the error. See VIDENC_OutArgs::extendedError for details.Int32 VIDENC_control | ( | VIDENC_Handle | handle, |
VIDENC_Cmd | id, | ||
VIDENC_DynamicParams * | params, | ||
VIDENC_Status * | status | ||
) |
Execute the control() method in this instance of a video encoder algorithm.
[in] | handle | Handle to a created video encoder instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for encoding. |
[out] | status | Status info upon completion of encode operation. |
handle
is a valid (non-NULL) video encoder handle and the video encoder is in the created state.VIDENC_EOK | Success. |
VIDENC_EFAIL | Failure. |
VIDENC_ERUNTIME | Internal Runtime Error. |
status->extendedError
may indicate further details about the error. See VIDENC_Status::extendedError for details.Void VIDENC_delete | ( | VIDENC_Handle | handle ) |
Delete the instance of a video encoder algorithm.
[in] | handle | Handle to a created video encoder instance. |
handle
is a valid (non-NULL) handle which is in the created state.XDAS_Int32 VIDENC_processAsync | ( | VIDENC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
IVIDENC_InArgs * | inArgs, | ||
IVIDENC_OutArgs * | outArgs | ||
) |
Perform asynchronous submission to this instance of a video decoder algorithm.
[in] | handle | Handle to a created video decoder instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDENC_EOK | Success. |
VIDENC_EFAIL | Failure. |
VIDENC_ERUNTIME | Internal Runtime Error. |
XDAS_Int32 VIDENC_processWait | ( | VIDENC_Handle | handle, |
XDM_BufDesc * | inBufs, | ||
XDM_BufDesc * | outBufs, | ||
IVIDENC_InArgs * | inArgs, | ||
IVIDENC_OutArgs * | outArgs, | ||
UInt | timeout | ||
) |
Wait for a return message from a previous invocation of VIDENC_processAsync() in this instance of an video decoder algorithm.
[in] | handle | Handle to a created video decoder instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
[in] | timeout | Amount of "time" to wait (from 0 -> VIDENC_FOREVER) |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDENC_EOK | Success. |
VIDENC_EFAIL | Failure. |
VIDENC_ERUNTIME | Internal Runtime Error. |
VIDENC_ETIMEOUT | Operation timed out. |