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 |
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.
|
Detailed Description
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 Documentation
#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 |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a VIDENC codec.
This structure defines the parameters necessary to create an instance of a video encoder object.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- IVIDENC_Fxns::control()
Function Documentation
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.
- Parameters:
-
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of video encoder to create. |
[in] | params | Creation parameters. |
- Return values:
-
NULL | An error has occurred. |
non-NULL | The handle to the newly created video encoder instance. |
- See also:
- Engine_open()
-
VIDENC_delete()
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:
- VIDENC_create()
-
VIDENC_delete()
-
VIDENC_control()
-
VIDENC_processAsync()
-
VIDENC_processWait()
-
IVIDENC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
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:
- VIDENC_create()
-
VIDENC_delete()
-
IVIDENC_Fxns::control() - the reflected algorithm interface, which may contain further usage details.
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 VIDENC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- VIDENC_create()
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:
- VIDENC_create()
-
VIDENC_delete()
-
VIDENC_control()
-
VIDENC_process()
-
VIDENC_processWait()
-
IVIDENC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Wait for a return message from a previous invocation of VIDENC_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 -> VIDENC_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.
- Return values:
-
- See also:
- VIDENC_create()
-
VIDENC_delete()
-
VIDENC_control()
-
VIDENC_process()
-
VIDENC_processAsync()