Video 1.0 decoder codec interface
Data Structures |
struct | IVIDDEC1_CodecClassConfig |
| Definition of IVIDDEC1 codec class configurable parameters. More...
|
Defines |
#define | VIDDEC1_EOK IVIDDEC1_EOK |
#define | VIDDEC1_EFAIL IVIDDEC1_EFAIL |
#define | VIDDEC1_EUNSUPPORTED IVIDDEC1_EUNSUPPORTED |
#define | VIDDEC1_ETIMEOUT VISA_ETIMEOUT |
#define | VIDDEC1_FOREVER VISA_FOREVER |
Typedefs |
typedef IVIDDEC1_Status | VIDDEC1_Status |
typedef VISA_Handle | VIDDEC1_Handle |
| Opaque handle to a VIDDEC1 codec.
|
typedef struct IVIDDEC1_Params | VIDDEC1_Params |
| This structure defines the parameters necessary to create an instance of a Video Decoder object.
|
typedef IVIDDEC1_InArgs | VIDDEC1_InArgs |
typedef IVIDDEC1_OutArgs | VIDDEC1_OutArgs |
typedef IVIDDEC1_Cmd | VIDDEC1_Cmd |
typedef IVIDDEC1_DynamicParams | VIDDEC1_DynamicParams |
Functions |
VIDDEC1_Handle | VIDDEC1_create (Engine_Handle e, String name, VIDDEC1_Params *params) |
| Create an instance of a video decoder algorithm.
|
Int32 | VIDDEC1_process (VIDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC1_InArgs *inArgs, VIDDEC1_OutArgs *outArgs) |
| Execute the process() method in this instance of a video decoder algorithm.
|
Int32 | VIDDEC1_control (VIDDEC1_Handle handle, VIDDEC1_Cmd id, VIDDEC1_DynamicParams *params, VIDDEC1_Status *status) |
| Execute the control() method in this instance of a video decoder algorithm.
|
Void | VIDDEC1_delete (VIDDEC1_Handle handle) |
| Delete the instance of a video decoder algorithm.
|
XDAS_Int32 | VIDDEC1_processAsync (VIDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC1_InArgs *inArgs, VIDDEC1_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a video decoder algorithm.
|
XDAS_Int32 | VIDDEC1_processWait (VIDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM_BufDesc *outBufs, VIDDEC1_InArgs *inArgs, VIDDEC1_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of VIDDEC1_processAsync() in this instance of an video decoder algorithm.
|
Detailed Description
This is the 1.0 video decoder codec interface. Several of the data types in this API are specified by the XDM 1.0 interface; please see the XDM documentation for those details.
Define Documentation
#define VIDDEC1_EOK IVIDDEC1_EOK |
#define VIDDEC1_EFAIL IVIDDEC1_EFAIL |
General failure. Request is unsupported.
#define VIDDEC1_EUNSUPPORTED IVIDDEC1_EUNSUPPORTED |
#define VIDDEC1_ETIMEOUT VISA_ETIMEOUT |
#define VIDDEC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a VIDDEC1 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:
- IVIDDEC1_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 VIDDEC1_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()
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:
- VIDDEC1_create()
-
VIDDEC1_delete()
-
IVIDDEC1_Fxns::process()
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 VIDDEC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- VIDDEC1_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:
- VIDDEC1_create()
-
VIDDEC1_delete()
-
VIDDEC1_control()
-
VIDDEC1_process()
-
VIDDEC1_processWait()
-
IVIDDEC1_Fxns::process()
Wait for a return message from a previous invocation of VIDDEC1_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 -> VIDDEC1_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) video decoder handle and the video decoder is in the created state.
- Return values:
-
- See also:
- VIDDEC1_create()
-
VIDDEC1_delete()
-
VIDDEC1_control()
-
VIDDEC1_process()
-
VIDDEC1_processAsync()