Data Structures | |
struct | IVIDENC1_CodecClassConfig |
Definition of IVIDENC1 codec class configurable parameters. More... | |
Defines | |
#define | VIDENC1_EOK IVIDENC1_EOK |
#define | VIDENC1_EFAIL IVIDENC1_EFAIL |
#define | VIDENC1_EUNSUPPORTED IVIDENC1_EUNSUPPORTED |
#define | VIDENC1_ETIMEOUT VISA_ETIMEOUT |
#define | VIDENC1_FOREVER VISA_FOREVER |
#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 |
typedef IVIDENC1_InArgs | VIDENC1_InArgs |
typedef IVIDENC1_OutArgs | VIDENC1_OutArgs |
typedef IVIDENC1_Cmd | VIDENC1_Cmd |
typedef IVIDENC1_DynamicParams | VIDENC1_DynamicParams |
typedef IVIDENC1_Status | VIDENC1_Status |
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. |
This is the VIDENC1 video encoder interface. Several of the data types in this API are specified by the XDM IVIDENC1 interface; please see the XDM documentation for those details.
#define VIDENC1_EOK IVIDENC1_EOK |
Success.
#define VIDENC1_EFAIL IVIDENC1_EFAIL |
General failure.
Request is unsupported.
#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.
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.
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 IVIDENC1_InArgs VIDENC1_InArgs |
Defines the input arguments for all IVIDENC1 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 IVIDENC1_OutArgs VIDENC1_OutArgs |
Defines the run time output arguments for all IVIDENC1 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 IVIDENC1_Cmd VIDENC1_Cmd |
Defines the control commands for the IVIDENC1 module.
This structure defines the algorithm 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 IVIDENC1_Status VIDENC1_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 struct IVIDENC1_CodecClassConfig IVIDENC1_CodecClassConfig |
Definition of IVIDENC1 codec class configurable parameters.
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.
[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.VIDENC1_EOK | Success. |
VIDENC1_EFAIL | Failure. |
VIDENC1_EUNSUPPORTED | The requested operation is not supported. |
status->extendedError
may indicate further details about the error. See VIDENC1_Status::extendedError for details.VIDENC1_Handle VIDENC1_create | ( | Engine_Handle | e, |
String | name, | ||
VIDENC1_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 VIDENC1_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. Void VIDENC1_delete | ( | VIDENC1_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.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.
[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.VIDENC1_EOK | Success. |
VIDENC1_EFAIL | Failure. |
VIDENC1_EUNSUPPORTED | The requested operation is not supported. |
outArgs->extendedError
may indicate further details about the error. See VIDENC1_OutArgs::extendedError for details.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.
[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.VIDENC1_EOK | Success. |
VIDENC1_EFAIL | Failure. |
VIDENC1_EUNSUPPORTED | Unsupported request. |
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.
[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 -> VIDENC1_FOREVER) |
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.VIDENC1_EOK | Success. |
VIDENC1_EFAIL | Failure. |
VIDENC1_EUNSUPPORTED | Unsupported request. |
VIDENC1_ETIMEOUT | Operation timed out. |