Codec Engine Application Programming Interface (API)  ce-w08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerations
ISPHENC1 - XDM Speech Encoder Interface

Data Structures

struct  ISPHENC1_Obj
 This must be the first field of all ISPHENC1 instance objects. More...
struct  ISPHENC1_Params
 Defines the creation time parameters for all ISPHENC1 instance objects. More...
struct  ISPHENC1_DynamicParams
 This structure defines the codec parameters that can be modified after creation via ISPHENC1_Fxns.control(). More...
struct  ISPHENC1_InArgs
 Defines the input arguments for all ISPHENC1 instance process function. More...
struct  ISPHENC1_Status
 Defines instance status parameters. More...
struct  ISPHENC1_OutArgs
 Defines the run time output arguments for all ISPHENC1 instance objects. More...
struct  ISPHENC1_Fxns
 Defines all of the operations on ISPHENC1 objects. More...

Macros

#define ISPHENC1_EOK   XDM_EOK
 
#define ISPHENC1_EFAIL   XDM_EFAIL
 
#define ISPHENC1_EUNSUPPORTED   XDM_EUNSUPPORTED
 
#define ISPHENC1_ENOOUTPUT   1
 This value signifies no output being available at encoder, for example in the case of intermediate calls in 10msec frame size execution.

Typedefs

typedef struct ISPHENC1_Obj ISPHENC1_Obj
 This must be the first field of all ISPHENC1 instance objects.
typedef struct ISPHENC1_ObjISPHENC1_Handle
 Opaque handle to an ISPHENC1 objects.
typedef struct ISPHENC1_Params ISPHENC1_Params
 Defines the creation time parameters for all ISPHENC1 instance objects.
typedef struct
ISPHENC1_DynamicParams 
ISPHENC1_DynamicParams
 This structure defines the codec parameters that can be modified after creation via ISPHENC1_Fxns.control().
typedef struct ISPHENC1_InArgs ISPHENC1_InArgs
 Defines the input arguments for all ISPHENC1 instance process function.
typedef struct ISPHENC1_Status ISPHENC1_Status
 Defines instance status parameters.
typedef struct ISPHENC1_OutArgs ISPHENC1_OutArgs
 Defines the run time output arguments for all ISPHENC1 instance objects.
typedef IALG_Cmd ISPHENC1_Cmd
 Defines the control commands for the ISPHENC1 module.
typedef struct ISPHENC1_Fxns ISPHENC1_Fxns
 Defines all of the operations on ISPHENC1 objects.

Enumerations

enum  ISPHENC1_FrameType {
  ISPHENC1_FTYPE_SPEECH = 0,
  ISPHENC1_FTYPE_SIDFRAME = 1,
  ISPHENC1_FTYPE_NODATA = 2
}
 Encoder frame types. More...

Detailed Description

This is the XDM ISPHENC1 Speech Encoder Interface.


Macro Definition Documentation

#define ISPHENC1_EOK   XDM_EOK

Success.

#define ISPHENC1_EFAIL   XDM_EFAIL

General failure.

#define ISPHENC1_EUNSUPPORTED   XDM_EUNSUPPORTED

Request is unsupported.

#define ISPHENC1_ENOOUTPUT   1

This value signifies no output being available at encoder, for example in the case of intermediate calls in 10msec frame size execution.


Typedef Documentation

typedef struct ISPHENC1_Obj ISPHENC1_Obj

This must be the first field of all ISPHENC1 instance objects.

typedef struct ISPHENC1_Obj* ISPHENC1_Handle

Opaque handle to an ISPHENC1 objects.

Defines the creation time parameters for all ISPHENC1 instance objects.

@remarks    Some of the fields in this structure are optional and depend
            on the class of speech encoder you're creating.

@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.
Remarks:
The size field must be correctly set by the caller. See http://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

This structure defines the codec parameters that can be modified after creation via ISPHENC1_Fxns.control().

@remarks    It is not necessary that a 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.
Remarks:
The size field must be correctly set by the caller. See http://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

Defines the input arguments for all ISPHENC1 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.
Remarks:
The size field must be correctly set by the caller. See http://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

Defines instance status parameters.

@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.
Remarks:
The size field must be correctly set by the caller. See http://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

Defines the run time output arguments for all ISPHENC1 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.
Remarks:
The size field must be correctly set by the caller. See http://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.
@sa         ISPHENC1_Fxns::process()

Defines the control commands for the ISPHENC1 module.

Remarks:
This ID can be extended in IMOD interface for additional control commands.
See also:
XDM_CmdId
ISPHENC1_Fxns::control()
typedef struct ISPHENC1_Fxns ISPHENC1_Fxns

Defines all of the operations on ISPHENC1 objects.


Enumeration Type Documentation

Encoder frame types.

Remarks:
This enumeration data type should not be used for storage, but rather only for its constant values.
Enumerator:
ISPHENC1_FTYPE_SPEECH 

Speech frame

ISPHENC1_FTYPE_SIDFRAME 

SID frames for codecs which support DTX.

ISPHENC1_FTYPE_NODATA 

Untransmitted frame for codecs which support DTX.

Copyright 2013, Texas Instruments Incorporated