Tiny documentation fix
[asterisk/asterisk.git] / doc / speechrec.txt
1 The Asterisk Speech Recognition API
2 ===================================
3
4 The generic speech recognition engine is implemented in the res_speech.so module.
5 This module connects through the API to speech recognition software, that is
6 not included in the module.
7
8 To use the API, you must load the res_speech.so module before any connectors.
9 For your convenience, there is a preload line commented out in the modules.conf 
10 sample file.
11
12 * Dialplan Applications:
13 ------------------------
14
15 The dialplan API is based around a single speech utilities application file,
16 which exports many applications to be used for speech recognition. These include an 
17 application to prepare for speech recognition, activate a grammar, and play back a 
18 sound file while waiting for the person to speak. Using a combination of these applications 
19 you can easily make a dialplan use speech recognition without worrying about what 
20 speech recognition engine is being used.
21
22 - SpeechCreate(Engine Name):
23
24 This application creates information to be used by all the other applications. 
25 It must be called before doing any speech recognition activities such as activating a 
26 grammar. It takes the engine name to use as the argument, if not specified the default 
27 engine will be used.
28
29 If an error occurs are you are not able to create an object, the variable ERROR will be 
30 set to 1. You can then exit your speech recognition specific context and play back an 
31 error message, or resort to a DTMF based IVR.
32
33 - SpeechLoadGrammar(Grammar Name|Path):
34
35 Loads grammar locally on a channel. Note that the grammar is only available as long as the 
36 channel exists, and you must call SpeechUnloadGrammar before all is done or you may cause a 
37 memory leak. First argument is the grammar name that it will be loaded as and second 
38 argument is the path to the grammar.
39
40 - SpeechUnloadGrammar(Grammar Name):
41
42 Unloads a locally loaded grammar and frees any memory used by it. The only argument is the 
43 name of the grammar to unload.
44
45 - SpeechActivateGrammar(Grammar Name):
46
47 This activates the specified grammar to be recognized by the engine. A grammar tells the 
48 speech recognition engine what to recognize, and how to portray it back to you in the 
49 dialplan. The grammar name is the only argument to this application.
50
51 - SpeechStart():
52
53 Tell the speech recognition engine that it should start trying to get results from audio 
54 being fed to it. This has no arguments.
55
56 - SpeechBackground(Sound File|Timeout):
57
58 This application plays a sound file and waits for the person to speak. Once they start 
59 speaking playback of the file stops, and silence is heard. Once they stop talking the 
60 processing sound is played to indicate the speech recognition engine is working. Note it is 
61 possible to have more then one result. The first argument is the sound file and the second is the 
62 timeout. Note the timeout will only start once the sound file has stopped playing.
63
64 - SpeechDeactivateGrammar(Grammar Name):
65
66 This deactivates the specified grammar so that it is no longer recognized. The 
67 only argument is the grammar name to deactivate.
68
69 - SpeechProcessingSound(Sound File):
70
71 This changes the processing sound that SpeechBackground plays back when the speech 
72 recognition engine is processing and working to get results. It takes the sound file as the 
73 only argument.
74
75 - SpeechDestroy():
76
77 This destroys the information used by all the other speech recognition applications. 
78 If you call this application but end up wanting to recognize more speech, you must call 
79 SpeechCreate again before calling any other application. It takes no arguments.
80
81 * Getting Result Information:
82 -----------------------------
83
84 The speech recognition utilities module exports several dialplan functions that you can use to 
85 examine results.
86
87 - ${SPEECH(status)}:
88
89 Returns 1 if SpeechCreate has been called. This uses the same check that applications do to see if a 
90 speech object is setup. If it returns 0 then you know you can not use other speech applications.
91
92 - ${SPEECH(spoke)}:
93
94 Returns 1 if the speaker spoke something, or 0 if they were silent.
95
96 - ${SPEECH(results)}:
97
98 Returns the number of results that are available.
99
100 - ${SPEECH_SCORE(result number)}:
101
102 Returns the score of a result.
103
104 - ${SPEECH_TEXT(result number)}:
105
106 Returns the recognized text of a result.
107
108 - ${SPEECH_GRAMMAR(result number)}:
109
110 Returns the matched grammar of the result.
111
112 * Dialplan Flow:
113 -----------------
114
115 1. Create a speech recognition object using SpeechCreate()
116 2. Activate your grammars using SpeechActivateGrammar(Grammar Name)
117 3. Call SpeechStart() to indicate you are going to do speech recognition immediately
118 4. Play back your audio and wait for recognition using SpeechBackground(Sound File|Timeout)
119 5. Check the results and do things based on them
120 6. Deactivate your grammars using SpeechDeactivateGrammar(Grammar Name)
121 7. Destroy your speech recognition object using SpeechDestroy()
122
123 * Dialplan Examples:
124
125 This is pretty cheeky in that it does not confirmation of results. As well the way the 
126 grammar is written it returns the person's extension instead of their name so we can 
127 just do a Goto based on the result text.
128
129 - Grammar: company-directory.gram
130
131 #ABNF 1.0;
132 language en-US;
133 mode voice;
134 tag-format <lumenvox/1.0>;
135 root $company_directory;
136
137 $josh = ((Joshua | Josh) [Colp]):"6066";
138 $mark = (Mark [Spencer] | Markster):"4569";
139 $kevin = (Kevin [Fleming]):"2567";
140
141 $company_directory = ($josh | $mark | $kevin) { $ = $$ };
142
143 - Dialplan logic
144
145         [dial-by-name]
146         exten => s,1,SpeechCreate()
147         exten => s,2,SpeechActivateGrammar(company-directory)
148         exten => s,3,SpeechStart()
149         exten => s,4,SpeechBackground(who-would-you-like-to-dial)
150         exten => s,5,SpeechDeactivateGrammar(company-directory)
151         exten => s,6,Goto(internal-extensions-${SPEECH_TEXT(0)})
152
153 - Useful Dialplan Tidbits:
154
155 A simple macro that can be used for confirm of a result. Requires some sound files. 
156 ARG1 is equal to the file to play back after "I heard..." is played.
157
158         [macro-speech-confirm]
159         exten => s,1,SpeechActivateGrammar(yes_no)
160         exten => s,2,Set(OLDTEXT0=${SPEECH_TEXT(0)})
161         exten => s,3,Playback(heard)
162         exten => s,4,Playback(${ARG1})
163         exten => s,5,SpeechStart()
164         exten => s,6,SpeechBackground(correct)
165         exten => s,7,Set(CONFIRM=${SPEECH_TEXT(0)})
166         exten => s,8,GotoIf($["${SPEECH_TEXT(0)}" = "1"]?9:10)
167         exten => s,9,Set(CONFIRM=yes)
168         exten => s,10,Set(${CONFIRMED}=${OLDTEXT0})
169         exten => s,11,SpeechDeactivateGrammar(yes_no)
170
171 * The Asterisk Speech Recognition C API
172 ---------------------------------------
173
174 The module res_speech.so exports a C based API that any developer can use to speech 
175 recognize enable their application. The API gives greater control, but requires the 
176 developer to do more on their end in comparison to the dialplan speech utilities.
177
178 For all API calls that return an integer value a non-zero value indicates an error has occured.
179
180 - Creating a speech structure:
181
182         struct ast_speech *ast_speech_new(char *engine_name, int format)
183
184         struct ast_speech *speech = ast_speech_new(NULL, AST_FORMAT_SLINEAR);
185
186 This will create a new speech structure that will be returned to you. The speech recognition 
187 engine name is optional and if NULL the default one will be used. As well for now format should 
188 always be AST_FORMAT_SLINEAR.
189
190 - Activating a grammar:
191
192         int ast_speech_grammar_activate(struct ast_speech *speech, char *grammar_name)
193
194         res = ast_speech_grammar_activate(speech, "yes_no");
195
196 This activates the specified grammar on the speech structure passed to it.
197
198 - Start recognizing audio:
199
200         void ast_speech_start(struct ast_speech *speech)
201
202         ast_speech_start(speech);
203
204 This essentially tells the speech recognition engine that you will be feeding audio to it from 
205 then on. It MUST be called every time before you start feeding audio to the speech structure.
206
207 - Send audio to be recognized:
208
209         int ast_speech_write(struct ast_speech *speech, void *data, int len)
210
211         res = ast_speech_write(speech, fr->data, fr->datalen);
212
213 This writes audio to the speech structure that will then be recognized. It must be written 
214 signed linear only at this time. In the future other formats may be supported.
215
216 - Checking for results:
217
218 The way the generic speech recognition API is written is that the speech structure will 
219 undergo state changes to indicate progress of recognition. The states are outlined below:
220
221         AST_SPEECH_STATE_NOT_READY - The speech structure is not ready to accept audio
222         AST_SPEECH_STATE_READY - You may write audio to the speech structure
223         AST_SPEECH_STATE_WAIT - No more audio should be written, and results will be available soon.
224         AST_SPEECH_STATE_DONE - Results are available and the speech structure can only be used again by 
225                                 calling ast_speech_start
226
227 It is up to you to monitor these states. Current state is available via a variable on the speech 
228 structure. (state)
229
230 - Knowing when to stop playback:
231
232 If you are playing back a sound file to the user and you want to know when to stop play back because the 
233 individual started talking use the following.
234
235         ast_test_flag(speech, AST_SPEECH_QUIET) - This will return a positive value when the person has started talking.
236
237 - Getting results:
238
239         struct ast_speech_result *ast_speech_results_get(struct ast_speech *speech)
240
241         struct ast_speech_result *results = ast_speech_results_get(speech);
242
243 This will return a linked list of result structures. A result structure looks like the following:
244
245         struct ast_speech_result {
246                 char *text;                     /*!< Recognized text */
247                 int score;                      /*!< Result score */
248                 char *grammar;                  /*!< Matched grammar */
249                 struct ast_speech_result *next; /*!< List information */
250         };
251
252 - Freeing a set of results:
253
254         int ast_speech_results_free(struct ast_speech_result *result)
255
256         res = ast_speech_results_free(results);
257
258 This will free all results on a linked list. Results MAY NOT be used as the memory will have been freed.
259
260 - Deactivating a grammar:
261
262         int ast_speech_grammar_deactivate(struct ast_speech *speech, char *grammar_name)
263
264         res = ast_speech_grammar_deactivate(speech, "yes_no");
265
266 This deactivates the specified grammar on the speech structure.
267
268 - Destroying a speech structure:
269
270         int ast_speech_destroy(struct ast_speech *speech)
271
272         res = ast_speech_destroy(speech);
273
274 This will free all associated memory with the speech structure and destroy it with the speech recognition engine.
275
276 - Loading a grammar on a speech structure:
277
278         int ast_speech_grammar_load(struct ast_speech *speech, char *grammar_name, char *grammar)
279
280         res = ast_speech_grammar_load(speech, "builtin:yes_no", "yes_no");
281
282 - Unloading a grammar on a speech structure:
283
284 If you load a grammar on a speech structure it is preferred that you unload it as well, 
285 or you may cause a memory leak. Don't say I didn't warn you.
286
287         int ast_speech_grammar_unload(struct ast_speech *speech, char *grammar_name)
288
289         res = ast_speech_grammar_unload(speech, "yes_no");
290
291 This unloads the specified grammar from the speech structure.