Presenting a revised data stores and oh my, a generic speech recognition API! I wonde...
[asterisk/asterisk.git] / res / res_speech.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Generic Speech Recognition API
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <unistd.h>
29 #include <string.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
34
35 #include "asterisk/channel.h"
36 #include "asterisk/module.h"
37 #include "asterisk/lock.h"
38 #include "asterisk/linkedlists.h"
39 #include "asterisk/cli.h"
40 #include "asterisk/term.h"
41 #include "asterisk/options.h"
42 #include "asterisk/speech.h"
43
44 static char *tdesc = "Generic Speech Recognition API";
45
46 static AST_LIST_HEAD_STATIC(engines, ast_speech_engine);
47 static struct ast_speech_engine *default_engine = NULL;
48
49 /*! \brief Find a speech recognition engine of specified name, if NULL then use the default one */
50 static struct ast_speech_engine *find_engine(char *engine_name)
51 {
52         struct ast_speech_engine *engine = NULL;
53
54         /* If no name is specified -- use the default engine */
55         if (engine_name == NULL || strlen(engine_name) == 0) {
56                 return default_engine;
57         }
58
59         AST_LIST_LOCK(&engines);
60         AST_LIST_TRAVERSE_SAFE_BEGIN(&engines, engine, list) {
61                 if (!strcasecmp(engine->name, engine_name)) {
62                         break;
63                 }
64         }
65         AST_LIST_TRAVERSE_SAFE_END
66         AST_LIST_UNLOCK(&engines);
67
68         return engine;
69 }
70
71 /*! \brief Activate a loaded (either local or global) grammar */
72 int ast_speech_grammar_activate(struct ast_speech *speech, char *grammar_name)
73 {
74         int res = 0;
75
76         if (speech->engine->activate != NULL) {
77                 res = speech->engine->activate(speech, grammar_name);
78         }
79
80         return res;
81 }
82
83 /*! \brief Deactivate a loaded grammar on a speech structure */
84 int ast_speech_grammar_deactivate(struct ast_speech *speech, char *grammar_name)
85 {
86         int res = 0;
87
88         if (speech->engine->deactivate != NULL) {
89                 res = speech->engine->deactivate(speech, grammar_name);
90         }
91
92         return res;
93 }
94
95 /*! \brief Load a local grammar on a speech structure */
96 int ast_speech_grammar_load(struct ast_speech *speech, char *grammar_name, char *grammar)
97 {
98         int res = 0;
99
100         if (speech->engine->load != NULL) {
101                 res = speech->engine->load(speech, grammar_name, grammar);
102         }
103
104         return res;
105 }
106
107 /*! \brief Unload a local grammar from a speech structure */
108 int ast_speech_grammar_unload(struct ast_speech *speech, char *grammar_name)
109 {
110         int res = 0;
111
112         if (speech->engine->unload != NULL) {
113                 res = speech->engine->unload(speech, grammar_name);
114         }
115
116         return res;
117 }
118
119 /*! \brief Return the results of a recognition from the speech structure */
120 struct ast_speech_result *ast_speech_results_get(struct ast_speech *speech)
121 {
122         struct ast_speech_result *result = NULL;
123
124         if (speech->engine->get != NULL) {
125                 result = speech->engine->get(speech);
126         }
127
128         return result;
129 }
130
131 /*! \brief Free a list of results */
132 int ast_speech_results_free(struct ast_speech_result *result)
133 {
134         struct ast_speech_result *current_result = result, *prev_result = NULL;
135         int res = 0;
136
137         while (current_result != NULL) {
138                 prev_result = current_result;
139                 /* Deallocate what we can */
140                 if (current_result->text != NULL) {
141                         free(current_result->text);
142                         current_result->text = NULL;
143                 }
144                 /* Move on and then free ourselves */
145                 current_result = current_result->next;
146                 free(prev_result);
147                 prev_result = NULL;
148         }
149
150         return res;
151 }
152
153 /*! \brief Start speech recognition on a speech structure */
154 void ast_speech_start(struct ast_speech *speech)
155 {
156         /* If the engine needs to start stuff up, do it */
157         if (speech->engine->start != NULL) {
158                 speech->engine->start(speech);
159         }
160
161         return;
162 }
163
164 /*! \brief Write in signed linear audio to be recognized */
165 int ast_speech_write(struct ast_speech *speech, void *data, int len)
166 {
167         int res = 0;
168
169         /* Make sure the speech engine is ready to accept audio */
170         if (speech->state != AST_SPEECH_STATE_READY) {
171                 return -1;
172         }
173
174         if (speech->engine->write != NULL) {
175                 speech->engine->write(speech, data, len);
176         }
177
178         return res;
179 }
180
181 /*! \brief Create a new speech structure using the engine specified */
182 struct ast_speech *ast_speech_new(char *engine_name, int format)
183 {
184         struct ast_speech_engine *engine = NULL;
185         struct ast_speech *new_speech = NULL;
186
187         /* Try to find the speech recognition engine that was requested */
188         engine = find_engine(engine_name);
189         if (engine == NULL) {
190                 /* Invalid engine or no engine available */
191                 return NULL;
192         }
193
194         /* Allocate our own speech structure, and try to allocate a structure from the engine too */
195         new_speech = ast_calloc(1, sizeof(*new_speech));
196         if (new_speech == NULL) {
197                 /* Ran out of memory while trying to allocate some for a speech structure */
198                 return NULL;
199         }
200
201         /* Initialize the lock */
202         ast_mutex_init(&new_speech->lock);
203
204         /* Copy over our engine pointer */
205         new_speech->engine = engine;
206
207         /* We are not ready to accept audio yet */
208         ast_speech_change_state(new_speech, AST_SPEECH_STATE_NOT_READY);
209
210         /* Pass ourselves to the engine so they can set us up some more */
211         engine->new(new_speech);
212
213         return new_speech;
214 }
215
216 /*! \brief Destroy a speech structure */
217 int ast_speech_destroy(struct ast_speech *speech)
218 {
219         int res = 0;
220
221         /* Call our engine so we are destroyed properly */
222         speech->engine->destroy(speech);
223
224         /* Deinitialize the lock */
225         ast_mutex_destroy(&speech->lock);
226
227         /* If a processing sound is set - free the memory used by it */
228         if (speech->processing_sound != NULL) {
229                 free(speech->processing_sound);
230                 speech->processing_sound = NULL;
231         }
232
233         /* Aloha we are done */
234         free(speech);
235         speech = NULL;
236
237         return res;
238 }
239
240 /*! \brief Change state of a speech structure */
241 int ast_speech_change_state(struct ast_speech *speech, int state)
242 {
243         int res = 0;
244
245         speech->state = state;
246
247         return res;
248 }
249
250 /*! \brief Register a speech recognition engine */
251 int ast_speech_register(struct ast_speech_engine *engine)
252 {
253         struct ast_speech_engine *existing_engine = NULL;
254         int res = 0;
255
256         existing_engine = find_engine(engine->name);
257         if (existing_engine != NULL) {
258                 /* Engine already loaded */
259                 return -1;
260         }
261
262         if (option_verbose > 1)
263                 ast_verbose(VERBOSE_PREFIX_2 "Registered speech recognition engine '%s'\n", engine->name);
264
265         /* Add to the engine linked list and make default if needed */
266         AST_LIST_LOCK(&engines);
267         AST_LIST_INSERT_HEAD(&engines, engine, list);
268         if (default_engine == NULL) {
269                 default_engine = engine;
270                 if (option_verbose > 1)
271                         ast_verbose(VERBOSE_PREFIX_2 "Made '%s' the default speech recognition engine\n", engine->name);
272         }
273         AST_LIST_UNLOCK(&engines);
274
275         return res;
276 }
277
278 /*! \brief Unregister a speech recognition engine */
279 int ast_speech_unregister(char *engine_name)
280 {
281         struct ast_speech_engine *engine = NULL;
282         int res = -1;
283
284         if (engine_name == NULL) {
285                 return res;
286         }
287
288         AST_LIST_LOCK(&engines);
289         AST_LIST_TRAVERSE_SAFE_BEGIN(&engines, engine, list) {
290                 if (!strcasecmp(engine->name, engine_name)) {
291                         /* We have our engine... removed it */
292                         AST_LIST_REMOVE_CURRENT(&engines, list);
293                         /* If this was the default engine, we need to pick a new one */
294                         if (default_engine == engine) {
295                                 default_engine = AST_LIST_FIRST(&engines);
296                         }
297                         if (option_verbose > 1)
298                                 ast_verbose(VERBOSE_PREFIX_2 "Unregistered speech recognition engine '%s'\n", engine_name);
299                         /* All went well */
300                         res = 0;
301                         break;
302                 }
303         }
304         AST_LIST_TRAVERSE_SAFE_END
305         AST_LIST_UNLOCK(&engines);
306
307         return res;
308 }
309
310 int unload_module(void)
311 {
312         /* We can not be unloaded */
313         return -1;
314 }
315
316 int load_module(void)
317 {
318         int res = 0;
319
320         /* Initialize our list of engines */
321         AST_LIST_HEAD_INIT_NOLOCK(&engines);
322
323         return res;
324 }
325
326 int reload(void)
327 {
328         return 0;
329 }
330
331 const char *description(void)
332 {
333         return tdesc;
334 }
335
336 int usecount(void)
337 {
338         int res = 0;
339
340         return res;
341 }
342
343 const char *key()
344 {
345         return ASTERISK_GPL_KEY;
346 }