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.
|
Detailed Description
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.
Macro Definition Documentation
General failure. Request is unsupported.
Special value for timeout parameter indicating never timeout.
#define VIDENC1_VISATYPE "ti.sdo.ce.video1.IVIDENC1" |
#define VIDENC1_STUBSNAME "VIDENC1_STUBS" |
Name of stub functions. Use this name when registering the VIDENC1_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
Typedef Documentation
Opaque handle to a VIDENC1 codec.
Defines the creation time parameters for all IVIDENC1 instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the input arguments for all IVIDENC1 instance process function.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the run time output arguments for all IVIDENC1 instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
@remarks It is not necessary that a given implementation support all
dynamic parameters to be configurable at run time. If a
particular algorithm does not support run-time updates to
a parameter that the application is attempting to change
at runtime, it may indicate this as an error.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines instance status parameters.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Function Documentation
Execute the control() method in this instance of a video encoder algorithm.
- Parameters:
-
[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. |
- Precondition:
handle
is a valid (non-NULL) video encoder handle and the video encoder is in the created state.
- Return values:
-
- See also:
- VIDENC1_create()
-
VIDENC1_delete()
-
IVIDENC1_Fxns::control() - the reflected algorithm interface, which may contain further usage details.
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.
@param[in] e Handle to an opened engine.
@param[in] name String identifier of the type of video encoder
to create.
@param[in] params Creation parameters.
@retval NULL An error has occurred.
@retval non-NULL The handle to the newly created video encoder
instance.
@remarks @c params is optional. If it's not supplied, codec-specific
default params will be used.
@remark Depending on the configuration of the engine opened, this
call may create a local or remote instance of the video
encoder.
@remarks In general, @c 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 <b>":priority"</b>, <b>":priority:flag"</b>, or <b>"::flag"</b>.
Delete the instance of a video encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created video encoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the VIDENC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- VIDENC1_create()
Execute the process() method in this instance of a video encoder algorithm.
- Parameters:
-
[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. |
- Precondition:
handle
is a valid (non-NULL) video encoder handle and the video encoder is in the created state.
- Return values:
-
- See also:
- VIDENC1_create()
-
VIDENC1_delete()
-
VIDENC1_control()
-
VIDENC1_processAsync()
-
VIDENC1_processWait()
-
IVIDENC1_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Perform asynchronous submission to this instance of a video decoder algorithm.
- Parameters:
-
[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. |
- Precondition:
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.
- Return values:
-
- See also:
- VIDENC1_create()
-
VIDENC1_delete()
-
VIDENC1_control()
-
VIDENC1_process()
-
VIDENC1_processWait()
-
IVIDENC1_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Wait for a return message from a previous invocation of VIDENC1_processAsync() in this instance of an video decoder algorithm.
- Parameters:
-
[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) |
- Precondition:
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.
- Return values:
-
- See also:
- VIDENC1_create()
-
VIDENC1_delete()
-
VIDENC1_control()
-
VIDENC1_process()
-
VIDENC1_processAsync()