Data Structures |
struct | IVIDDEC_CodecClassConfig |
| Definition of VIDDEC codec class configurable parameters. More...
|
Defines |
#define | VIDDEC_EOK IVIDDEC_EOK |
#define | VIDDEC_EFAIL IVIDDEC_EFAIL |
#define | VIDDEC_ERUNTIME IVIDDEC_ERUNTIME |
#define | VIDDEC_ETIMEOUT VISA_ETIMEOUT |
#define | VIDDEC_FOREVER VISA_FOREVER |
Typedefs |
typedef IVIDDEC_Status | VIDDEC_Status |
typedef VISA_Handle | VIDDEC_Handle |
| Opaque handle to a VIDDEC codec.
|
typedef struct IVIDDEC_Params | VIDDEC_Params |
| This structure defines the parameters necessary to create an instance of a video decoder object.
|
typedef IVIDDEC_InArgs | VIDDEC_InArgs |
typedef IVIDDEC_OutArgs | VIDDEC_OutArgs |
typedef IVIDDEC_Cmd | VIDDEC_Cmd |
typedef IVIDDEC_DynamicParams | VIDDEC_DynamicParams |
typedef struct
IVIDDEC_CodecClassConfig | IVIDDEC_CodecClassConfig |
| Definition of VIDDEC codec class configurable parameters.
|
Functions |
VIDDEC_Handle | VIDDEC_create (Engine_Handle e, String name, VIDDEC_Params *params) |
| Create an instance of a video decoder algorithm.
|
Int32 | VIDDEC_process (VIDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC_InArgs *inArgs, VIDDEC_OutArgs *outArgs) |
| Execute the process() method in this instance of a video decoder algorithm.
|
Int32 | VIDDEC_control (VIDDEC_Handle handle, VIDDEC_Cmd id, VIDDEC_DynamicParams *params, VIDDEC_Status *status) |
| Execute the "control" method in this instance of a video decoder algorithm.
|
Void | VIDDEC_delete (VIDDEC_Handle handle) |
| Delete the instance of a video decoder algorithm.
|
XDAS_Int32 | VIDDEC_processAsync (VIDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC_InArgs *inArgs, VIDDEC_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a video decoder algorithm.
|
XDAS_Int32 | VIDDEC_processWait (VIDDEC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC_InArgs *inArgs, VIDDEC_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of VIDDEC_processAsync() in this instance of an video decoder algorithm.
|
Detailed Description
This is the VIDDEC video decoder 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 VIDDEC_EOK IVIDDEC_EOK |
#define VIDDEC_EFAIL IVIDDEC_EFAIL |
#define VIDDEC_ERUNTIME IVIDDEC_ERUNTIME |
#define VIDDEC_ETIMEOUT VISA_ETIMEOUT |
#define VIDDEC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a VIDDEC codec.
This structure defines the parameters necessary to create an instance of a video decoder object.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- IVIDDEC_Fxns::control()
Function Documentation
Create an instance of a video decoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDDEC_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 decoder. to create. |
[in] | params | Creation parameters. |
- Return values:
-
NULL | An error has occurred. |
non-NULL | The handle to the newly created video decoder instance. |
- See also:
- Engine_open()
-
VIDDEC_delete()
Execute the process() method in 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:
- VIDDEC_create()
-
VIDDEC_delete()
-
VIDDEC_control()
-
VIDDEC_processAsync()
-
VIDDEC_processWait()
-
IVIDDEC_Fxns::process()
Execute the "control" method in this instance of a video decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created video decoder instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for decoding. |
[out] | status | Status info upon completion of decode operation. |
- Precondition:
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.
- Return values:
-
- See also:
- VIDDEC_create()
-
VIDDEC_delete()
-
IVIDDEC_Fxns::control()
Delete the instance of a video decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created video decoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the VIDDEC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- VIDDEC_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:
- VIDDEC_create()
-
VIDDEC_delete()
-
VIDDEC_control()
-
VIDDEC_process()
-
VIDDEC_processWait()
-
IVIDDEC_Fxns::process()
Wait for a return message from a previous invocation of VIDDEC_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 -> VIDDEC_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.
- Return values:
-
- See also:
- VIDDEC_create()
-
VIDDEC_delete()
-
VIDDEC_control()
-
VIDDEC_process()
-
VIDDEC_processAsync()