用于读取命令词表格相关的信息，包含命令词ID、语义ID、命令词字符串等。命令词表位于工程目录（）下，名为[60000]xxx.xsl。更多...

结构体
struct	voice_select_item_t

struct	voice_st

宏定义
#define	INVALID_SHORT_ID 0xFFFF
	用于表示16bit的无效ID。更多...

#define	INVALID_LONG_ID 0xFFFFFFFF
	用于表示32bit的无效ID。更多...

#define	INVALID_HANDLE ((uint32_t)-1)
	用于表示无效的句柄。更多...

#define	get_product_id_from_semantic_id(semantic_id) ((semantic_id >> 18) & 0x00003FFF)
	用于从语义ID中提取产品号。更多...

#define	get_function_id_from_semantic_id(semantic_id) ((semantic_id >> 6) & 0x00000FFF)
	用于从语义ID中提取功能号。更多...

类型定义
typedef void *	cmd_handle_t
	定义命令词信息结构的句柄类型。更多...

typedef struct voice_st	voice_t

枚举
enum	voice_select_type_t { VOICE_SELECT_RANDOM, VOICE_SELECT_USER, VOICE_SELECT_RANDOM, VOICE_SELECT_USER, VOICE_SELECT_RANDOM, VOICE_SELECT_USER }
	定义了提示音的选择方式。更多...

函数
uint32_t	cmd_info_init (uint32_t cmd_file_addr_in_flash, uint32_t voice_patition_addr, uint8_t model_group_id)
	初始化命令词信息模块。注意，每交切换识别模型后，都需要调用一次此接口。更多...

void	cmd_info_destroy ()
	释放命令词信息模块所占用的内存资源，此模块的初cmd_info_init以外的接口都不能再使用。下次要调用要调用此模块的其他查询接口，必须要先通过cmd_info_init接口初始化。更多...

uint32_t	cmd_info_change_cur_model_group (uint8_t model_group_id)
	切换当前的工作的识别模型组。也就是切换命令词信息excel表格中的多个sheet之间切换。更多...

cmd_handle_t	cmd_info_find_command_by_string (const char *cmd_string)
	通过命令词字符串查找命令词信息句柄。使用此句柄和其他查询接口，可以获取命令词的每一项具体信息，比如命令词ID、语言ID、识别阈值分数、对应的提示音等等。更多...

cmd_handle_t	cmd_info_find_command_by_id (uint16_t cmd_id)
	通过命令词ID查找命令词信息句柄。使用此句柄和其他查询接口，可以获取命令词的每一项具体信息，比如命令词ID、语言ID、识别阈值分数、对应的提示音等等。更多...

cmd_handle_t	cmd_info_find_command_by_semantic_id (uint32_t semantic_id)
	通过命令词语义ID查找命令词信息句柄。使用此句柄和其他查询接口，可以获取命令词的每一项具体信息，比如命令词ID、语言ID、识别阈值分数、对应的提示音等等。更多...

uint16_t	cmd_info_get_command_id (cmd_handle_t cmd_handle)
	通过命令词信息结构的句柄获取命令词ID。更多...

char *	cmd_info_get_command_string (cmd_handle_t cmd_handle)
	通过命令词信息结构的句柄获取命令词字符串。更多...

uint8_t	cmd_info_get_cmd_score (cmd_handle_t cmd_handle)
	通过命令词信息结构的句柄获取命令词识别的阈值分数。更多...

uint32_t	cmd_info_get_semantic_id (cmd_handle_t cmd_handle)
	通过命令词信息结构的句柄获取命令词的语义ID。更多...

uint32_t	cmd_info_is_special_word (cmd_handle_t cmd_handle)
	检查指定的命令词是否是特殊词(特殊词在识别阈值分数达到后，还需要等待指定的识别次数才会输出识别结果)。更多...

uint32_t	cmd_info_is_wakeup_word (cmd_handle_t cmd_handle)
	检查指定的命令词是否是唤醒词。更多...

uint32_t	cmd_info_is_combo_word (cmd_handle_t cmd_handle)
	检查指定的命令词是否是组合词。更多...

int32_t	cmd_info_get_special_wait_count (cmd_handle_t cmd_handle)
	获取指定命令词的等待时间。更多...

uint32_t	cmd_info_get_cur_model_id (uint32_t p_dnn_id, uint32_t p_asr_id, uint32_t *p_voice_group_id)
	获取当前正在运行的模型ID。更多...

uint8_t	cmd_info_get_cmd_flag (cmd_handle_t cmd_handle)
	获取命令词信息中的标记信息。更多...

uint32_t	cmd_info_is_expected_word (cmd_handle_t cmd_handle)
	检查指定的命令词是否为期望词。更多...

uint32_t	cmd_info_is_unexpected_word (cmd_handle_t cmd_handle)
	检查指定的命令词是否为不期望词。更多...

int32_t	cmd_info_get_voice_index (uint16_t start_index, uint16_t end_index, uint8_t select_index, uint16_t *id_buffer, int buffer_length)
	获取提示音数据的ID号，也就是打包固件时，提供的音频文件名中方括号中的数字。如果是组合播报或选择播报，会返回多个ID，所以需要调用者提供一个uint16_t的数组来接收多个ID。更多...

uint32_t	is_valid_cmd_handle (cmd_handle_t cmd_handle)
	检查一个命令词信息结构句柄是否有效。更多...

uint32_t	cmd_info_get_voice_index_from_handle (cmd_handle_t cmd_handle, uint16_t start_index, uint16_t end_index)
	通过命令词信息结构句柄获取命令词对应的提示间的起始索引和结束索引。更多...

详细描述

用于读取命令词表格相关的信息，包含命令词ID、语义ID、命令词字符串等。命令词表位于工程目录（）下，名为[60000]xxx.xsl。

结构体说明

◆ voice_select_item_t

struct voice_select_item_t

成员变量
uint8_t	combination_voice_number
uint32_t *	p_voice_data_address_table

◆ voice_st

struct voice_st

成员变量
voice_select_item_t *	p_select_table
uint8_t	select_item_number
voice_select_type_t	select_type

宏定义说明

◆ get_function_id_from_semantic_id

#define get_function_id_from_semantic_id ( semantic_id ) ((semantic_id >> 6) & 0x00000FFF)

用于从语义ID中提取功能号。

◆ get_product_id_from_semantic_id

#define get_product_id_from_semantic_id ( semantic_id ) ((semantic_id >> 18) & 0x00003FFF)

用于从语义ID中提取产品号。

◆ INVALID_HANDLE

#define INVALID_HANDLE ((uint32_t)-1)

用于表示无效的句柄。

◆ INVALID_LONG_ID

#define INVALID_LONG_ID 0xFFFFFFFF

用于表示32bit的无效ID。

◆ INVALID_SHORT_ID

#define INVALID_SHORT_ID 0xFFFF

用于表示16bit的无效ID。

类型定义说明

◆ cmd_handle_t

typedef void* cmd_handle_t

定义命令词信息结构的句柄类型。

◆ voice_t

typedef struct voice_st voice_t

枚举类型说明

◆ voice_select_type_t

enum voice_select_type_t

定义了提示音的选择方式。

枚举值
VOICE_SELECT_RANDOM	从提供的多个提示音中随机选择一个播报。
VOICE_SELECT_USER	由用户自定的算法从提供的多个提示音中选择一个播报。
VOICE_SELECT_RANDOM	从提供的多个提示音中随机选择一个播报。
VOICE_SELECT_USER	由用户自定的算法从提供的多个提示音中选择一个播报。
VOICE_SELECT_RANDOM	从提供的多个提示音中随机选择一个播报。
VOICE_SELECT_USER	由用户自定的算法从提供的多个提示音中选择一个播报。

函数说明

◆ cmd_info_change_cur_model_group()

uint32_t cmd_info_change_cur_model_group ( uint8_t model_group_id )

切换当前的工作的识别模型组。也就是切换命令词信息excel表格中的多个sheet之间切换。

参数

model_group_id 模型组的识别号，也就是命令词信息excel表格中，sheet全称中的尖括号中的数字。

返回: uint32_t 0:切换成功, 其他非0值:错误号。

◆ cmd_info_destroy()

void cmd_info_destroy ( )

释放命令词信息模块所占用的内存资源，此模块的初cmd_info_init以外的接口都不能再使用。下次要调用要调用此模块的其他查询接口，必须要先通过cmd_info_init接口初始化。

◆ cmd_info_find_command_by_id()

cmd_handle_t cmd_info_find_command_by_id ( uint16_t cmd_id )

通过命令词ID查找命令词信息句柄。使用此句柄和其他查询接口，可以获取命令词的每一项具体信息，比如命令词ID、语言ID、识别阈值分数、对应的提示音等等。

参数

cmd_id 用于传入要查找的命令词的命令词ID。

返回: cmd_handle_t 返回与所给命令词ID匹配的命令词信息结构的句柄。

◆ cmd_info_find_command_by_semantic_id()

cmd_handle_t cmd_info_find_command_by_semantic_id ( uint32_t semantic_id )

通过命令词语义ID查找命令词信息句柄。使用此句柄和其他查询接口，可以获取命令词的每一项具体信息，比如命令词ID、语言ID、识别阈值分数、对应的提示音等等。

参数

semantic_id 用于传入要查找的命令词的语义ID。

返回: cmd_handle_t 返回与所给命令词ID匹配的命令词信息结构的句柄。

◆ cmd_info_find_command_by_string()

cmd_handle_t cmd_info_find_command_by_string ( const char * cmd_string )

通过命令词字符串查找命令词信息句柄。使用此句柄和其他查询接口，可以获取命令词的每一项具体信息，比如命令词ID、语言ID、识别阈值分数、对应的提示音等等。

参数

cmd_string 字符串指针，指向要查找的命令词字符串。

返回: cmd_handle_t 返回与所给字符串匹配的命令词信息结构的句柄。

◆ cmd_info_get_cmd_flag()

uint8_t cmd_info_get_cmd_flag ( cmd_handle_t cmd_handle )

获取命令词信息中的标记信息。

参数

cmd_handle 命令词信息结构句柄。

返回: uint8_t 返回要获取的标记值。

◆ cmd_info_get_cmd_score()

uint8_t cmd_info_get_cmd_score ( cmd_handle_t cmd_handle )

通过命令词信息结构的句柄获取命令词识别的阈值分数。

参数

cmd_handle 命令词信息结构句柄。

返回: uint8_t 返回命令词的识别阈值分数。

◆ cmd_info_get_command_id()

uint16_t cmd_info_get_command_id ( cmd_handle_t cmd_handle )

通过命令词信息结构的句柄获取命令词ID。

参数

cmd_handle 命令词信息结构句柄。

返回: uint16_t 返回命令词ID。

◆ cmd_info_get_command_string()

char* cmd_info_get_command_string ( cmd_handle_t cmd_handle )

通过命令词信息结构的句柄获取命令词字符串。

参数

cmd_handle 命令词信息结构句柄。

返回: char* 返回指向命令词字符串字符串的指针。

◆ cmd_info_get_cur_model_id()

uint32_t cmd_info_get_cur_model_id	(	uint32_t *	p_dnn_id,
		uint32_t *	p_asr_id,
		uint32_t *	p_voice_group_id
	)

获取当前正在运行的模型ID。

参数

p_dnn_id	指向无符号整型变量的指针，用于接收声学模型的ID。
p_asr_id	指向无符号整型变量的指针，用于接收语言模型的ID。
p_voice_group_id	指向无符号整型变量的指针，用于接收提示音分组ID。

返回: uint32_t 0:成功, 其他非0值:错误号。

◆ cmd_info_get_semantic_id()

uint32_t cmd_info_get_semantic_id ( cmd_handle_t cmd_handle )

通过命令词信息结构的句柄获取命令词的语义ID。

参数

cmd_handle 命令词信息结构句柄。

返回: uint32_t 返回命令词的语义ID。

◆ cmd_info_get_special_wait_count()

int32_t cmd_info_get_special_wait_count ( cmd_handle_t cmd_handle )

获取指定命令词的等待时间。

参数

cmd_handle 命令词信息结构句柄。

返回: int32_t 返回等待时间，单位为音频帧数。

◆ cmd_info_get_voice_index()

int32_t cmd_info_get_voice_index	(	uint16_t	start_index,
		uint16_t	end_index,
		uint8_t	select_index,
		uint16_t *	id_buffer,
		int	buffer_length
	)

获取提示音数据的ID号，也就是打包固件时，提供的音频文件名中方括号中的数字。如果是组合播报或选择播报，会返回多个ID，所以需要调用者提供一个uint16_t的数组来接收多个ID。

参数

start_index	指定提示音的起始索引号，可以通过接口cmd_info_get_voice_index_from_handle从命令词信息结构中获取。
end_index	指定提示音的结束索引号，可以通过接口cmd_info_get_voice_index_from_handle从命令词信息结构中获取。
select_index	当有多个可选择的提示音时，通过此参数指定要选择提示音。
id_buffer	用于接收音频文件ID的数组，由调用者申请内存。
buffer_length	用于传入id_buffer所指向的数组的大小，指定可接收的最大数量，防止写内存越界。

返回: uint32_t 0:读取失败，其他非0值:提示音中组合音频文件的数量。

◆ cmd_info_get_voice_index_from_handle()

uint32_t cmd_info_get_voice_index_from_handle	(	cmd_handle_t	cmd_handle,
		uint16_t *	start_index,
		uint16_t *	end_index
	)

通过命令词信息结构句柄获取命令词对应的提示间的起始索引和结束索引。

参数

cmd_handle	命令词信息结构句柄。
start_index	指向uint16_t类型的指针，用于接收起始索引号。
end_index	指向uint16_t类型的指针，用于接收结束索引号。

返回: uint32_t 返回值固定为0。

◆ cmd_info_init()

uint32_t cmd_info_init	(	uint32_t	cmd_file_addr_in_flash,
		uint32_t	voice_patition_addr,
		uint8_t	model_group_id
	)

初始化命令词信息模块。注意，每交切换识别模型后，都需要调用一次此接口。

返回: uint32_t 0:成功, others:错误号。

◆ cmd_info_is_combo_word()

uint32_t cmd_info_is_combo_word ( cmd_handle_t cmd_handle )

检查指定的命令词是否是组合词。

参数

cmd_handle 命令词信息结构句柄。

返回: uint32_t 1:是组合词, 0:不是组合词。

◆ cmd_info_is_expected_word()

uint32_t cmd_info_is_expected_word ( cmd_handle_t cmd_handle )

检查指定的命令词是否为期望词。

参数

cmd_handle 命令词信息结构句柄。

返回: uint32_t 1:是期望词, 0:不是期望词。

◆ cmd_info_is_special_word()

uint32_t cmd_info_is_special_word ( cmd_handle_t cmd_handle )

检查指定的命令词是否是特殊词(特殊词在识别阈值分数达到后，还需要等待指定的识别次数才会输出识别结果)。

参数

cmd_handle 命令词信息结构句柄。

返回: uint32_t 1:是特殊词, 0:不是特殊词。

◆ cmd_info_is_unexpected_word()

uint32_t cmd_info_is_unexpected_word ( cmd_handle_t cmd_handle )

检查指定的命令词是否为不期望词。

参数

cmd_handle 命令词信息结构句柄。

返回: uint32_t 1:是不期望词, 0:不是不期望词。

◆ cmd_info_is_wakeup_word()

uint32_t cmd_info_is_wakeup_word ( cmd_handle_t cmd_handle )

检查指定的命令词是否是唤醒词。

参数

cmd_handle 命令词信息结构句柄。

返回: uint32_t 1:是唤醒词 , 0:不是唤醒词。

◆ is_valid_cmd_handle()

uint32_t is_valid_cmd_handle ( cmd_handle_t cmd_handle )

检查一个命令词信息结构句柄是否有效。

参数

cmd_handle 要检查的命令词信息结构句柄。

返回: uint32_t 0:无效, 其他非0值:有效。