Amdb API - Qualcomm Dragonwing Documentation

Header: spf/api/modules/amdb_api.h

Structures

`amdb_module_reg_info_t`

Payload for AMDB_CMD_REGISTER_MODULES. Members

uint16_t

Type of the module interface.

uint16_t

Version of the module interface.

`amdb_capi_module_reg_info_t`

Payload for AMDB_CMD_REGISTER_MODULES. Members

uint32_t

Type of module.

uint32_t

ID for the module.

uint16_t

Length of the SO filename (in bytes).

uint16_t

Length of tag in bytes.

uint32_t

Result of the module registration.

`amdb_module_registration_t`

Payload for AMDB_CMD_REGISTER_MODULES. Members

uint32_t

ID for the processor domain in which the AMDB is running.

uint32_t

Number of modules being registered.

uint32_t

Version of the amdb_module_reg_info_t structure.

amdb_module_reg_info_t

Array of registration information for num_modules (of type reg_info[num_modules]).

`amdb_module_deregistration_t`

Payload for AMDB_CMD_DEREGISTER_MODULES. Members

uint32_t

ID for the processor domain in which the AMDB is running.

uint32_t

Number of modules being registered.

uint32_t

Array of module IDs for num_modules (module_id[num_modules]).

`amdb_load_unload_info_t`

Payload for AMDB_CMD_LOAD_MODULES, AMDB_CMD_RSP_LOAD_MODULES, and AMDB_CMD_UNLOAD_MODULES. Members

uint32_t

ID for the module.

uint32_t

Lower 32 bits of the 64-bit handle to the module.

uint32_t

Upper 32 bits of the 64-bit handle to the module.

`amdb_module_load_unload_t`

Payload for AMDB_CMD_LOAD_MODULES, AMDB_CMD_RSP_LOAD_MODULES, and AMDB_CMD_UNLOAD_MODULES. Members

uint32_t

ID for the processor domain in which the AMDB is running.

uint32_t

Result of module loading.

uint32_t

Number of modules being registered.

amdb_load_unload_info_t

Array of load or unload information for num_modules (of type load_unload_info[num_modules]).

`amdb_param_id_module_version_info_t`

Payload for AMDB_PARAM_ID_MODULE_VERSION_INFO. Members

uint32_t

ID for the processor domain.

uint32_t

Number of modules in the array.

`amdb_module_build_ts_info_t`

Members

uint16_t

Year that the build was produced.

uint16_t

month the build was produced

uint16_t

day the build was produced

uint16_t

hour the build was produced

uint16_t

minute the build was produced

uint16_t

second the build was produced

`amdb_module_version_info_payload_t`

Members

uint32_t

Requested module id, to be filled in by the client.

uint32_t

Indicates whether an error has occurred loading the module.

uint32_t

1 if and only if the module is present and not stubbed in the AMDB.

uint32_t

Major version of the requested module.

uint32_t

Minor version of the requested module.

amdb_module_build_ts_info_t

Indicates the time at which the build for the given module was created.

Type Definitions

`amdb_module_reg_info_t`

typedef struct amdb_module_reg_info_t amdb_module_reg_info_t

`amdb_capi_module_reg_info_t`

typedef struct amdb_capi_module_reg_info_t amdb_capi_module_reg_info_t

`amdb_module_registration_t`

typedef struct amdb_module_registration_t amdb_module_registration_t

`amdb_module_deregistration_t`

typedef struct amdb_module_deregistration_t amdb_module_deregistration_t

`amdb_load_unload_info_t`

typedef struct amdb_load_unload_info_t amdb_load_unload_info_t

`amdb_module_load_unload_t`

typedef struct amdb_module_load_unload_t amdb_module_load_unload_t

`amdb_param_id_module_version_info_t`

typedef struct amdb_param_id_module_version_info_t amdb_param_id_module_version_info_t

`amdb_module_build_ts_info_t`

typedef struct amdb_module_build_ts_info_t amdb_module_build_ts_info_t

`amdb_module_version_info_payload_t`

typedef struct amdb_module_version_info_payload_t amdb_module_version_info_payload_t

Macros

`AMDB_MODULE_REG_STRUCT_V1`

#define AMDB_MODULE_REG_STRUCT_V1 1

`AMDB_INTERFACE_TYPE_CAPI`

Interface type is the Common Audio Processor Interface.

#define AMDB_INTERFACE_TYPE_CAPI 2

`AMDB_INTERFACE_VERSION_CAPI_V3`

Interface version is the Common Audio Processor Interface version 3.

#define AMDB_INTERFACE_VERSION_CAPI_V3 3

`AMDB_MODULE_TYPE_GENERIC`

Module is generic, such as a preprocessor, postprocessor, and so on.

#define AMDB_MODULE_TYPE_GENERIC 2

`AMDB_MODULE_TYPE_DECODER`

Module is a decoder.

#define AMDB_MODULE_TYPE_DECODER 3

`AMDB_MODULE_TYPE_ENCODER`

Module is an encoder.

#define AMDB_MODULE_TYPE_ENCODER 4

`AMDB_MODULE_TYPE_CONVERTER`

Module is a converter.

#define AMDB_MODULE_TYPE_CONVERTER 5

`AMDB_MODULE_TYPE_PACKETIZER`

Module is a packetizer.

#define AMDB_MODULE_TYPE_PACKETIZER 6

`AMDB_MODULE_TYPE_DEPACKETIZER`

Module is a de-packetizer.

#define AMDB_MODULE_TYPE_DEPACKETIZER 7

`AMDB_MODULE_TYPE_DETECTOR`

Module is a detector (such as DTMF, VoiceUI).

#define AMDB_MODULE_TYPE_DETECTOR 8

`AMDB_MODULE_TYPE_GENERATOR`

Module is a generator (such as DTMF, Ultrasound).

#define AMDB_MODULE_TYPE_GENERATOR 9

`AMDB_MODULE_TYPE_PP`

Module is a pre or post-processor (such as filters).

#define AMDB_MODULE_TYPE_PP 10

`AMDB_MODULE_TYPE_END_POINT`

Module is a an end point (software or hardware end point, such as I2S source or sink).

#define AMDB_MODULE_TYPE_END_POINT 11

`AMDB_MODULE_INSTANCE_ID`

Instance ID for the AMDB module.

#define AMDB_MODULE_INSTANCE_ID 0x00000003

`AMDB_CMD_REGISTER_MODULES`

Registers a module with the AMDB to enable the module for dynamic loading.

#define AMDB_CMD_REGISTER_MODULES 0x0100101E

`AMDB_CMD_DEREGISTER_MODULES`

Deregisters one or more registered modules.

#define AMDB_CMD_DEREGISTER_MODULES 0x0100101F

`AMDB_CMD_LOAD_MODULES`

Loads one or more modules if they were successfully registered with the AMDB.

#define AMDB_CMD_LOAD_MODULES 0x01001020

`AMDB_CMD_RSP_LOAD_MODULES`

Sent in response to an AMDB_CMD_LOAD_MODULES command.

#define AMDB_CMD_RSP_LOAD_MODULES 0x02001008

`AMDB_CMD_UNLOAD_MODULES`

Unloads a module that was loaded via the AMDB_CMD_LOAD_MODULES command.

#define AMDB_CMD_UNLOAD_MODULES 0x01001022

`AMDB_PARAM_ID_MODULE_VERSION_INFO`

Identifier for the parameter that gets the module version info.

#define AMDB_PARAM_ID_MODULE_VERSION_INFO 0x080013D6

`AMDB_MODULE_INFO_OK`

#define AMDB_MODULE_INFO_OK 0

`AMDB_MODULE_INFO_ERR_FILE_NOT_FOUND`

#define AMDB_MODULE_INFO_ERR_FILE_NOT_FOUND 1

`AMDB_MODULE_INFO_ERR_DYNAMIC_LINK`

#define AMDB_MODULE_INFO_ERR_DYNAMIC_LINK 2

`AMDB_MODULE_INFO_ERR_GENERAL`

#define AMDB_MODULE_INFO_ERR_GENERAL 0xFFFFFFFF

​Structures

​amdb_module_reg_info_t

​amdb_capi_module_reg_info_t

​amdb_module_registration_t

​amdb_module_deregistration_t

​amdb_load_unload_info_t

​amdb_module_load_unload_t

​amdb_param_id_module_version_info_t

​amdb_module_build_ts_info_t

​amdb_module_version_info_payload_t

​Type Definitions

​amdb_module_reg_info_t

​amdb_capi_module_reg_info_t

​amdb_module_registration_t

​amdb_module_deregistration_t

​amdb_load_unload_info_t

​amdb_module_load_unload_t

​amdb_param_id_module_version_info_t

​amdb_module_build_ts_info_t

​amdb_module_version_info_payload_t

​Macros

​AMDB_MODULE_REG_STRUCT_V1

​AMDB_INTERFACE_TYPE_CAPI

​AMDB_INTERFACE_VERSION_CAPI_V3

​AMDB_MODULE_TYPE_GENERIC

​AMDB_MODULE_TYPE_DECODER

​AMDB_MODULE_TYPE_ENCODER

​AMDB_MODULE_TYPE_CONVERTER

​AMDB_MODULE_TYPE_PACKETIZER

​AMDB_MODULE_TYPE_DEPACKETIZER

​AMDB_MODULE_TYPE_DETECTOR

​AMDB_MODULE_TYPE_GENERATOR

​AMDB_MODULE_TYPE_PP

​AMDB_MODULE_TYPE_END_POINT

​AMDB_MODULE_INSTANCE_ID

​AMDB_CMD_REGISTER_MODULES

​AMDB_CMD_DEREGISTER_MODULES

​AMDB_CMD_LOAD_MODULES

​AMDB_CMD_RSP_LOAD_MODULES

​AMDB_CMD_UNLOAD_MODULES

​AMDB_PARAM_ID_MODULE_VERSION_INFO

​AMDB_MODULE_INFO_OK

​AMDB_MODULE_INFO_ERR_FILE_NOT_FOUND

​AMDB_MODULE_INFO_ERR_DYNAMIC_LINK

​AMDB_MODULE_INFO_ERR_GENERAL

Structures

`amdb_module_reg_info_t`

`amdb_capi_module_reg_info_t`

`amdb_module_registration_t`

`amdb_module_deregistration_t`

`amdb_load_unload_info_t`

`amdb_module_load_unload_t`

`amdb_param_id_module_version_info_t`

`amdb_module_build_ts_info_t`

`amdb_module_version_info_payload_t`

Type Definitions

`amdb_module_reg_info_t`

`amdb_capi_module_reg_info_t`

`amdb_module_registration_t`

`amdb_module_deregistration_t`

`amdb_load_unload_info_t`

`amdb_module_load_unload_t`

`amdb_param_id_module_version_info_t`

`amdb_module_build_ts_info_t`

`amdb_module_version_info_payload_t`

Macros

`AMDB_MODULE_REG_STRUCT_V1`

`AMDB_INTERFACE_TYPE_CAPI`

`AMDB_INTERFACE_VERSION_CAPI_V3`

`AMDB_MODULE_TYPE_GENERIC`

`AMDB_MODULE_TYPE_DECODER`

`AMDB_MODULE_TYPE_ENCODER`

`AMDB_MODULE_TYPE_CONVERTER`

`AMDB_MODULE_TYPE_PACKETIZER`

`AMDB_MODULE_TYPE_DEPACKETIZER`

`AMDB_MODULE_TYPE_DETECTOR`

`AMDB_MODULE_TYPE_GENERATOR`

`AMDB_MODULE_TYPE_PP`

`AMDB_MODULE_TYPE_END_POINT`

`AMDB_MODULE_INSTANCE_ID`

`AMDB_CMD_REGISTER_MODULES`

`AMDB_CMD_DEREGISTER_MODULES`

`AMDB_CMD_LOAD_MODULES`

`AMDB_CMD_RSP_LOAD_MODULES`

`AMDB_CMD_UNLOAD_MODULES`

`AMDB_PARAM_ID_MODULE_VERSION_INFO`

`AMDB_MODULE_INFO_OK`

`AMDB_MODULE_INFO_ERR_FILE_NOT_FOUND`

`AMDB_MODULE_INFO_ERR_DYNAMIC_LINK`

`AMDB_MODULE_INFO_ERR_GENERAL`