Defines |
#define | AUDENC_EOK IAUDENC_EOK |
#define | AUDENC_EFAIL IAUDENC_EFAIL |
#define | AUDENC_ERUNTIME IAUDENC_ERUNTIME |
#define | AUDENC_ETIMEOUT VISA_ETIMEOUT |
#define | AUDENC_FOREVER VISA_FOREVER |
#define | AUDENC_VISATYPE "ti.sdo.ce.audio.IAUDENC" |
| The VISA type.
|
#define | AUDENC_STUBSNAME "AUDENC_STUBS" |
| Name of stub functions. Use this name when registering the AUDENC_STUBS functions with Engine_addStubFxns.
|
Typedefs |
typedef VISA_Handle | AUDENC_Handle |
| Opaque handle to a AUDENC codec.
|
typedef IAUDENC_Params | AUDENC_Params |
typedef IAUDENC_InArgs | AUDENC_InArgs |
typedef IAUDENC_OutArgs | AUDENC_OutArgs |
typedef IAUDENC_Cmd | AUDENC_Cmd |
typedef IAUDENC_Status | AUDENC_Status |
typedef IAUDENC_DynamicParams | AUDENC_DynamicParams |
Functions |
Int32 | AUDENC_control (AUDENC_Handle handle, AUDENC_Cmd id, AUDENC_DynamicParams *params, AUDENC_Status *status) |
| Execute the control() method in this instance of an audio encoder algorithm.
|
AUDENC_Handle | AUDENC_create (Engine_Handle e, String name, AUDENC_Params *params) |
| Create an instance of an audio encoder algorithm.
|
Void | AUDENC_delete (AUDENC_Handle handle) |
| Delete the instance of an audio encoder algorithm.
|
Int32 | AUDENC_process (AUDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, AUDENC_InArgs *inArgs, AUDENC_OutArgs *outArgs) |
| Execute the process() method in this instance of an audio encoder algorithm.
|
XDAS_Int32 | AUDENC_processAsync (AUDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs, IAUDENC_OutArgs *outArgs) |
| Perform asynchronous submission to this instance of a audio encoder algorithm.
|
XDAS_Int32 | AUDENC_processWait (AUDENC_Handle handle, XDM_BufDesc *inBufs, XDM_BufDesc *outBufs, IAUDENC_InArgs *inArgs, IAUDENC_OutArgs *outArgs, UInt timeout) |
| Wait for a return message from a previous invocation of AUDENC_processAsync() in this instance of an audio encoder algorithm.
|
Detailed Description
This is the audio encoder codec interface. Several of the data types in this API are specified by the XDM IAUDENC interface; please see the XDM documentation for those details.
Define Documentation
#define AUDENC_EOK IAUDENC_EOK |
#define AUDENC_EFAIL IAUDENC_EFAIL |
#define AUDENC_ERUNTIME IAUDENC_ERUNTIME |
#define AUDENC_ETIMEOUT VISA_ETIMEOUT |
#define AUDENC_FOREVER VISA_FOREVER |
Special value for timeout parameter indicating never timeout.
#define AUDENC_VISATYPE "ti.sdo.ce.audio.IAUDENC" |
#define AUDENC_STUBSNAME "AUDENC_STUBS" |
Name of stub functions. Use this name when registering the AUDENC_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
Typedef Documentation
Opaque handle to a AUDENC codec.
Defines the creation time parameters for all IAUDENC instance objects.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
- See also:
- IAUDENC_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:
- AUDENC_create()
-
AUDENC_delete()
-
IAUDENC_Fxns::control() - the reflected algorithm interface, which may contain further usage details.
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 AUDENC_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()
-
AUDENC_delete()
Delete the instance of an 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 AUDENC_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- AUDENC_create()
Execute the process() method 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. |
- Precondition:
handle
is a valid (non-NULL) audio encoder handle and the audio encoder is in the created state.
- Return values:
-
- See also:
- AUDENC_create()
-
AUDENC_delete()
-
AUDENC_control()
-
AUDENC_processAsync()
-
AUDENC_processWait()
-
IAUDENC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
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:
- AUDENC_create()
-
AUDENC_delete()
-
AUDENC_control()
-
AUDENC_process()
-
AUDENC_processWait()
-
IAUDENC_Fxns::process()
-
IAUDENC_Fxns::process() - the reflected algorithm interface, which may contain further usage details.
Wait for a return message from a previous invocation of AUDENC_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 -> AUDENC_FOREVER) |
- Precondition:
handle
is a valid (non-NULL) audio encoder handle and the audio encoder is in the created state.
- Return values:
-
- See also:
- AUDENC_create()
-
AUDENC_delete()
-
AUDENC_control()
-
AUDENC_process()
-
AUDENC_processAsync()