CI130X SDK API手册  2.2.0
本手册用于描述CI130X SDK各个组件和驱动API
command_info_v4.h
浏览该文件的文档.
1 
11 #ifndef __COMMAND_INFO_H__
12 #define __COMMAND_INFO_H__
13 
14 
15 #include <stdint.h>
16 #include "product_semantic.h"
17 
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
23 #define INVALID_SHORT_ID 0xFFFF
24 
26 #define INVALID_LONG_ID 0xFFFFFFFF
27 
29 #define INVALID_HANDLE ((uint32_t)-1)
30 
32 #define get_product_id_from_semantic_id(semantic_id) ((semantic_id >> 18) & 0x00003FFF)
33 
35 #define get_function_id_from_semantic_id(semantic_id) ((semantic_id >> 6) & 0x00000FFF)
36 
37 
42 typedef enum
43 {
47 
49 typedef void* cmd_handle_t;
50 
51 #pragma pack(push)
52 #pragma pack(1)
53 
54 typedef struct
55 {
56  uint8_t combination_voice_number;
57  uint32_t *p_voice_data_address_table;
59 
60 typedef struct voice_st
61 {
63  uint8_t select_item_number;
65 }voice_t;
66 
67 #pragma pack(pop)
68 
69 
70 
71 
72 
73 
79 extern uint32_t cmd_info_init(uint32_t cmd_file_addr_in_flash, uint32_t voice_patition_addr, uint8_t model_group_id);
80 
85 extern void cmd_info_destroy();
86 
93 extern uint32_t cmd_info_change_cur_model_group(uint8_t model_group_id);
94 
101 extern cmd_handle_t cmd_info_find_command_by_string(const char * cmd_string);
102 
109 extern cmd_handle_t cmd_info_find_command_by_id(uint16_t cmd_id);
110 
117 extern cmd_handle_t cmd_info_find_command_by_semantic_id(uint32_t semantic_id);
124 extern uint16_t cmd_info_get_command_id(cmd_handle_t cmd_handle);
125 
132 extern char * cmd_info_get_command_string(cmd_handle_t cmd_handle);
133 
140 extern int16_t cmd_info_get_cmd_score(cmd_handle_t cmd_handle);
141 
148 extern uint32_t cmd_info_get_semantic_id(cmd_handle_t cmd_handle);
149 
156 extern uint32_t cmd_info_is_special_word(cmd_handle_t cmd_handle);
157 
164 extern uint32_t cmd_info_is_wakeup_word(cmd_handle_t cmd_handle);
165 
172 extern uint32_t cmd_info_is_combo_word(cmd_handle_t cmd_handle);
173 
180 extern int32_t cmd_info_get_special_wait_count(cmd_handle_t cmd_handle);
181 
190 extern uint32_t cmd_info_get_cur_model_id(uint32_t* p_dnn_id, uint32_t* p_asr_id, uint32_t* p_voice_group_id);
191 
198 extern uint8_t cmd_info_get_cmd_flag(cmd_handle_t cmd_handle);
199 
206 extern uint32_t cmd_info_is_expected_word(cmd_handle_t cmd_handle);
207 
214 extern uint32_t cmd_info_is_unexpected_word(cmd_handle_t cmd_handle);
215 
225 extern 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);
226 
232 extern uint32_t is_valid_cmd_handle(cmd_handle_t cmd_handle);
233 
241 extern uint32_t cmd_info_get_voice_index_from_handle(cmd_handle_t cmd_handle, uint16_t* start_index, uint16_t* end_index);
242 
243 
244 #ifdef __cplusplus
245 }
246 #endif
247 #endif
248 
249 
250 
251 
voice_select_type_t select_type
Definition: command_info_v2.h:67
uint8_t select_item_number
Definition: command_info_v2.h:68
cmd_handle_t cmd_info_find_command_by_semantic_id(uint32_t semantic_id)
通过命令词语义ID查找命令词信息句柄。使用此句柄和其他查询接口,可以获取命令词的每一项具体信息,比如命...
Definition: command_info_v2.c:231
uint8_t cmd_info_get_cmd_flag(cmd_handle_t cmd_handle)
获取命令词信息中的标记信息。
Definition: command_info_v2.c:323
uint32_t cmd_info_init(uint32_t cmd_file_addr_in_flash, uint32_t voice_patition_addr, uint8_t model_group_id)
初始化命令词信息模块。注意,每交切换识别模型后,都需要调用一次此接口。
Definition: command_info_v2.c:58
uint32_t cmd_info_is_expected_word(cmd_handle_t cmd_handle)
检查指定的命令词是否为期望词。
Definition: command_info_v2.c:393
uint32_t cmd_info_change_cur_model_group(uint8_t model_group_id)
切换当前的工作的识别模型组。也就是切换命令词信息excel表格中的多个sheet之间切换。
Definition: command_info_v2.c:132
Definition: command_info_v2.h:65
uint32_t cmd_info_get_semantic_id(cmd_handle_t cmd_handle)
通过命令词信息结构的句柄获取命令词的语义ID。
Definition: command_info_v2.c:308
int32_t cmd_info_get_special_wait_count(cmd_handle_t cmd_handle)
获取指定命令词的等待时间。
Definition: command_info_v2.c:443
uint32_t is_valid_cmd_handle(cmd_handle_t cmd_handle)
检查一个命令词信息结构句柄是否有效。
Definition: command_info_v2.c:53
uint32_t cmd_info_is_combo_word(cmd_handle_t cmd_handle)
检查指定的命令词是否是组合词。
Definition: command_info_v2.c:375
uint32_t cmd_info_is_special_word(cmd_handle_t cmd_handle)
检查指定的命令词是否是特殊词(特殊词在识别阈值分数达到后,还需要等待指定的识别次数才会输出识别结果)。 ...
Definition: command_info_v2.c:339
void cmd_info_destroy()
释放命令词信息模块所占用的内存资源,此模块的初cmd_info_init以外的接口都不能再使用。下次要调用要调用此...
Definition: command_info_v3.c:185
voice_select_type_t
定义了提示音的选择方式。
Definition: command_info_v4.h:42
uint16_t cmd_info_get_command_id(cmd_handle_t cmd_handle)
通过命令词信息结构的句柄获取命令词ID。
Definition: command_info_v2.c:249
uint32_t cmd_info_is_wakeup_word(cmd_handle_t cmd_handle)
检查指定的命令词是否是唤醒词。
Definition: command_info_v2.c:357
cmd_handle_t cmd_info_find_command_by_id(uint16_t cmd_id)
通过命令词ID查找命令词信息句柄。使用此句柄和其他查询接口,可以获取命令词的每一项具体信息,比如命令词I...
Definition: command_info_v2.c:197
Definition: command_info_v4.h:44
cmd_handle_t cmd_info_find_command_by_string(const char *cmd_string)
通过命令词字符串查找命令词信息句柄。使用此句柄和其他查询接口,可以获取命令词的每一项具体信息,比如命...
Definition: command_info_v2.c:214
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。
Definition: command_info_v2.c:163
void * cmd_handle_t
定义命令词信息结构的句柄类型。
Definition: command_info_v2.h:54
int16_t cmd_info_get_cmd_score(cmd_handle_t cmd_handle)
通过命令词信息结构的句柄获取命令词识别的阈值分数。
Definition: command_info_v2.c:293
voice_select_type_t
定义了提示音的选择方式。
Definition: command_info_v2.h:47
char * cmd_info_get_command_string(cmd_handle_t cmd_handle)
通过命令词信息结构的句柄获取命令词字符串。
Definition: command_info_v2.c:270
Definition: command_info_v2.h:59
void * cmd_handle_t
定义命令词信息结构的句柄类型。
Definition: command_info_v4.h:49
struct voice_st voice_t
Definition: command_info_v4.h:45
voice_select_item_t * p_select_table
Definition: command_info_v2.h:69
uint32_t cmd_info_get_voice_index_from_handle(cmd_handle_t cmd_handle, uint16_t *start_index, uint16_t *end_index)
通过命令词信息结构句柄获取命令词对应的提示间的起始索引和结束索引。
Definition: command_info_v2.c:555
uint32_t cmd_info_is_unexpected_word(cmd_handle_t cmd_handle)
检查指定的命令词是否为不期望词。
Definition: command_info_v2.c:411
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号,也就是打包固件时,提供的音频文件名中方括号中的数字。如果是组合播报或选择播报,...
Definition: command_info_v2.c:482