AUDDEC1 Audio Decoder Interface
Defines |
#define | AUDDEC1_EOK IAUDDEC1_EOK |
#define | AUDDEC1_EFAIL IAUDDEC1_EFAIL |
#define | AUDDEC1_EUNSUPPORTED IAUDDEC1_EUNSUPPORTED |
#define | AUDDEC1_ETIMEOUT VISA_ETIMEOUT |
#define | AUDDEC1_FOREVER VISA_FOREVER |
Typedefs |
typedef VISA_Handle | AUDDEC1_Handle |
| Opaque handle to a AUDDEC1 codec.
|
typedef struct IAUDDEC1_Params | AUDDEC1_Params |
| This structure defines the parameters necessary to create an instance of an audio decoder object.
|
typedef IAUDDEC1_InArgs | AUDDEC1_InArgs |
typedef IAUDDEC1_OutArgs | AUDDEC1_OutArgs |
typedef IAUDDEC1_Cmd | AUDDEC1_Cmd |
typedef IAUDDEC1_Status | AUDDEC1_Status |
typedef IAUDDEC1_DynamicParams | AUDDEC1_DynamicParams |
Functions |
Int32 | AUDDEC1_control (AUDDEC1_Handle handle, AUDDEC1_Cmd id, AUDDEC1_DynamicParams *params, AUDDEC1_Status *status) |
| Execute the control() method in this instance of an audio1 decoder algorithm.
|
AUDDEC1_Handle | AUDDEC1_create (Engine_Handle e, String name, AUDDEC1_Params *params) |
| Create an instance of an audio decoder algorithm.
|
Void | AUDDEC1_delete (AUDDEC1_Handle handle) |
| Delete the instance of an audio decoder algorithm.
|
Int32 | AUDDEC1_process (AUDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDDEC1_InArgs *inArgs, AUDDEC1_OutArgs *outArgs) |
| Execute the process() method in this instance of a audio decoder algorithm.
|
Int32 | AUDDEC1_processAsync (AUDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDDEC1_InArgs *inArgs, AUDDEC1_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a audio decoder algorithm.
|
Int32 | AUDDEC1_processWait (AUDDEC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDDEC1_InArgs *inArgs, AUDDEC1_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of AUDDEC1_processAsync() in this instance of an audio decoder algorithm.
|
Detailed Description
This is the AUDDEC1 audio decoder 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 AUDDEC1_EOK IAUDDEC1_EOK |
#define AUDDEC1_EFAIL IAUDDEC1_EFAIL |
#define AUDDEC1_EUNSUPPORTED IAUDDEC1_EUNSUPPORTED |
#define AUDDEC1_ETIMEOUT VISA_ETIMEOUT |
#define AUDDEC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a AUDDEC1 codec.
This structure defines the parameters necessary to create an instance of an audio decoder object.
This structure defines the codec parameters that can be modified after creation via control() calls.
- See also:
- IAUDDEC1_Fxns::control()
Function Documentation
Execute the control() method in this instance of an audio1 decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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) audio decoder handle and the audio decoder is in the created state.
- Return values:
-
- See also:
- AUDDEC1_create()
-
AUDDEC1_delete()
-
IAUDDEC1_Fxns()control()
Create an instance of an audio decoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via AUDDEC1_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 audio decoder. to create. |
[in] | params | Creation parameters. |
- Return values:
-
| NULL | An error has occurred. |
| non-NULL | The handle to the newly created audio decoder instance. |
- See also:
- Engine_open()
-
AUDDEC1_delete()
Delete the instance of an audio decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio decoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the AUDDEC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- AUDDEC1_create()
Perform asynchronous submission to this instance of a audio decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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) audio decoder handle and the audio decoder is in the created state.
- Return values:
-
- See also:
- AUDDEC1_create()
-
AUDDEC1_delete()
-
AUDDEC1_control()
-
AUDDEC1_process()
-
AUDDEC1_processWait()
-
IAUDDEC1_Fxns::process()
Wait for a return message from a previous invocation of AUDDEC1_processAsync() in this instance of an audio decoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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 -> AUDDEC1_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) audio decoder handle and the audio decoder is in the created state.
- Return values:
-
- See also:
- AUDDEC1_create()
-
AUDDEC1_delete()
-
AUDDEC1_control()
-
AUDDEC1_process()
-
AUDDEC1_processAsync()