ISPHENC1_Params Struct Reference
[xDM 1.0 Speech/Voice Encoder Interface]

#include <isphenc1.h>

Detailed Description

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.

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 size parameter.

The size field must be correctly set by the caller.


Data Fields

XDAS_Int16 size
XDAS_Int16 frameSize
XDAS_Int16 compandingLaw
XDAS_Int16 packingType
XDAS_Int16 vadSelection
XDAS_Int16 codecSelection
XDAS_Int8 ** tablesPtr

Field Documentation

XDAS_Int16 ISPHENC1_Params::size
 

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int16 ISPHENC1_Params::frameSize
 

Input frame size in bytes for sample based codecs.

XDAS_Int16 ISPHENC1_Params::compandingLaw
 

Optional, codec-specific companding law. See your codec-specific interface documentation options.

See also:
ISPEECH1_PCM_CompandingLaw

ISPEECH1_G726_CompandingLaw

XDAS_Int16 ISPHENC1_Params::packingType
 

Optional, codec-specific packing type. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_PackingType

ISPEECH1_G726_PackingType

ISPEECH1_WBAMR_PackingType

XDAS_Int16 ISPHENC1_Params::vadSelection
 

Optional, codec-specific voice activity detection selection. See your codec-specific interface documentation options.

See also:
ISPEECH1_AMR_VADSelect

ISPEECH1_SMV_VADSelect

XDAS_Int16 ISPHENC1_Params::codecSelection
 

Codec selection if codec supports multiple options.

Remarks:
This parameter is used to select the codec in cases where multiple codecs are supported from the same code base (e.g. GSMEFR can be supported from GSMAMR codebase). This parameter is also used for codecs which support multiple rates as initialization time option (like g726 supports 16, 24,32 and 40KBPS). In this case each rate is configured as a different codec.

See the codec-specific documentation for further details describing valid values for these fields.

See also:
ISPEECH1_CodecSelect

ISPHENC1_Status.codecSelection

XDAS_Int8** ISPHENC1_Params::tablesPtr
 

Optional pointer to the codec's initialization tables.

Remarks:
This parameter specifies a pointer to the array of the codec's table block pointers. If the application requires the codec to select the default table address array pointer, it should set this to NULL.

The documentation for this struct was generated from the following file:
Copyright 2006, Texas Instruments Incorporated