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 an 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 an 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 an 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 audio encoder interface. Several of the data types in this API are specified by the XDM IAUDENC1 interface; please see the XDM documentation for those details.
Macro Definition Documentation
Special value for timeout parameter indicating never timeout.
#define AUDENC1_VISATYPE "ti.sdo.ce.audio1.IAUDENC1" |
#define AUDENC1_STUBSNAME "AUDENC1_STUBS" |
Name of stub functions. Use this name when registering the AUDENC1_STUBS functions with Engine_addStubFxns.
- See also:
- Engine_addStubFxns
Typedef Documentation
Opaque handle to a AUDENC1 codec.
Defines the creation time parameters for all IAUDENC1 instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the input arguments for all IAUDENC1 instance process function.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines the run time output arguments for all IAUDENC1 instance objects.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
This structure defines the algorithm parameters that can be modified after creation via control() calls.
@remarks It is not necessary that given implementation support all
dynamic parameters to be configurable at run time. If a
particular algorithm does not support run-time updates to
a parameter that the application is attempting to change
at runtime, it may indicate this as an error.
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
Defines instance status parameters (read-only).
@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters. The presence of vendor specific extensions will be detected by the value of the @c size parameter.
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.
@param[in] e Handle to an opened engine.
@param[in] name String identifier of the type of audio encoder.
to create.
@param[in] params Creation parameters.
@retval NULL An error has occurred.
@retval non-NULL The handle to the newly created audio encoder
instance.
@remarks @c params is optional. If it's not supplied, codec-specific
default params will be used.
@remark Depending on the configuration of the engine opened, this
call may create a local or remote instance of the audio
encoder.
@remarks In general, @c name is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated, to be overridden. This optional argument string is of the form <b>":priority"</b>, <b>":priority:flag"</b>, or <b>"::flag"</b>.
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 AUDENC1_create() operation (memory, DMA channels, etc.) are freed.
- See also:
- AUDENC1_create()
Perform asynchronous submission to 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:
- 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()