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 |
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.
|
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.
Define Documentation
#define VIDENC1_EOK IVIDENC1_EOK |
#define VIDENC1_EFAIL IVIDENC1_EFAIL |
General failure.
Request is unsupported.
#define VIDENC1_EUNSUPPORTED IVIDENC1_EUNSUPPORTED |
#define VIDENC1_ETIMEOUT VISA_ETIMEOUT |
#define VIDENC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a VIDENC1 codec.
Defines the creation time parameters for all IVIDENC1 instance objects.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
- See also:
- IVIDENC1_Fxns::control()
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::process()
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.
- 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()
-
VIDENC1_delete()
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()
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()