Audio 1.0 Encoder Codec Interface
Defines |
#define | AUDENC1_EOK IAUDENC1_EOK |
#define | AUDENC1_EFAIL IAUDENC1_EFAIL |
#define | AUDENC1_EUNSUPPORTED IAUDENC1_EUNSUPPORTED |
#define | AUDENC1_ETIMEOUT VISA_ETIMEOUT |
#define | AUDENC1_FOREVER VISA_FOREVER |
Typedefs |
typedef VISA_Handle | AUDENC1_Handle |
| Opaque handle to a AUDENC1 codec.
|
typedef struct IAUDENC1_Params | AUDENC1_Params |
| This structure defines the parameters necessary to create an instance of an audio encoder.
|
typedef IAUDENC1_InArgs | AUDENC1_InArgs |
typedef IAUDENC1_OutArgs | AUDENC1_OutArgs |
typedef IAUDENC1_Cmd | AUDENC1_Cmd |
typedef IAUDENC1_Status | AUDENC1_Status |
typedef IAUDENC1_DynamicParams | AUDENC1_DynamicParams |
Functions |
Int32 | AUDENC1_control (AUDENC1_Handle handle, AUDENC1_Cmd id, AUDENC1_DynamicParams *params, AUDENC1_Status *status) |
| Execute the control() method in this instance of an audio encoder algorithm.
|
AUDENC1_Handle | AUDENC1_create (Engine_Handle e, String name, AUDENC1_Params *params) |
| Create an instance of an audio encoder algorithm.
|
Void | AUDENC1_delete (AUDENC1_Handle handle) |
| Delete the instance of a audio encoder algorithm.
|
Int32 | AUDENC1_process (AUDENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDENC1_InArgs *inArgs, AUDENC1_OutArgs *outArgs) |
| Execute the process() method in this instance of a audio encoder algorithm.
|
Int32 | AUDENC1_processAsync (AUDENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDENC1_InArgs *inArgs, AUDENC1_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a audio encoder algorithm.
|
Int32 | AUDENC1_processWait (AUDENC1_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, AUDENC1_InArgs *inArgs, AUDENC1_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of AUDENC1_processAsync() in this instance of an audio encoder algorithm.
|
Detailed Description
This is the 1.0 audio encoder 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 AUDENC1_EOK IAUDENC1_EOK |
#define AUDENC1_EFAIL IAUDENC1_EFAIL |
#define AUDENC1_EUNSUPPORTED IAUDENC1_EUNSUPPORTED |
#define AUDENC1_ETIMEOUT VISA_ETIMEOUT |
#define AUDENC1_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
Typedef Documentation
Opaque handle to a AUDENC1 codec.
This structure defines the parameters necessary to create an instance of an audio encoder.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
- See also:
- IAUDENC1_Fxns::control()
Function Documentation
Execute the control() method in this instance of an audio encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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) audio encoder handle and the audio encoder is in the created state.
- Return values:
-
- See also:
- AUDENC1_create()
-
AUDENC1_delete()
-
IAUDENC1_Fxns::control()
Create an instance of an audio encoder algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via AUDENC1_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 encoder. to create. |
[in] | params | Creation parameters. |
- Return values:
-
| NULL | An error has occurred. |
| non-NULL | The handle to the newly created audio encoder instance. |
- See also:
- Engine_open()
-
AUDENC1_delete()
Delete the instance of a audio encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio encoder instance. |
- Precondition:
handle
is a valid (non-NULL) handle which is in the created state.
- Postcondition:
- All resources allocated as part of the AUDENC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- AUDENC1_create()
Execute the process() method in this instance of a audio encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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) audio encoder handle and the audio encoder is in the created state.
- Return values:
-
- See also:
- AUDENC1_create()
-
AUDENC1_delete()
-
AUDENC1_control()
-
AUDENC1_processWait()
-
IAUDENC1_Fxns::process()
-
VISA_setAsync()
-
VISA_setSync()
Perform asynchronous submission to this instance of a audio encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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) audio encoder handle and the audio encoder is in the created state.
- Return values:
-
- See also:
- AUDENC1_create()
-
AUDENC1_delete()
-
AUDENC1_control()
-
AUDENC1_process()
-
AUDENC1_processWait()
-
IAUDENC1_Fxns::process()
Wait for a return message from a previous invocation of AUDENC1_processAsync() in this instance of an audio encoder algorithm.
- Parameters:
-
[in] | handle | Handle to a created audio 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. |
[in] | timeout | Amount of "time" to wait (from 0 -> AUDENC1_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) audio encoder handle and the audio encoder is in the created state.
- Return values:
-
- See also:
- AUDENC1_create()
-
AUDENC1_delete()
-
AUDENC1_control()
-
AUDENC1_process()
-
AUDENC1_processAsync()