This rather large commit changes the way modules are loaded.
[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
45 static AST_LIST_HEAD_STATIC(engines, ast_speech_engine);
46 static struct ast_speech_engine *default_engine = NULL;
47
48 /*! \brief Find a speech recognition engine of specified name, if NULL then use the default one */
49 static struct ast_speech_engine *find_engine(char *engine_name)
50 {
51         struct ast_speech_engine *engine = NULL;
52
53         /* If no name is specified -- use the default engine */
54         if (engine_name == NULL || strlen(engine_name) == 0) {
55                 return default_engine;
56         }
57
58         AST_LIST_LOCK(&engines);
59         AST_LIST_TRAVERSE_SAFE_BEGIN(&engines, engine, list) {
60                 if (!strcasecmp(engine->name, engine_name)) {
61                         break;
62                 }
63         }
64         AST_LIST_TRAVERSE_SAFE_END
65         AST_LIST_UNLOCK(&engines);
66
67         return engine;
68 }
69
70 /*! \brief Activate a loaded (either local or global) grammar */
71 int ast_speech_grammar_activate(struct ast_speech *speech, char *grammar_name)
72 {
73         int res = 0;
74
75         if (speech->engine->activate != NULL) {
76                 res = speech->engine->activate(speech, grammar_name);
77         }
78
79         return res;
80 }
81
82 /*! \brief Deactivate a loaded grammar on a speech structure */
83 int ast_speech_grammar_deactivate(struct ast_speech *speech, char *grammar_name)
84 {
85         int res = 0;
86
87         if (speech->engine->deactivate != NULL) {
88                 res = speech->engine->deactivate(speech, grammar_name);
89         }
90
91         return res;
92 }
93
94 /*! \brief Load a local grammar on a speech structure */
95 int ast_speech_grammar_load(struct ast_speech *speech, char *grammar_name, char *grammar)
96 {
97         int res = 0;
98
99         if (speech->engine->load != NULL) {
100                 res = speech->engine->load(speech, grammar_name, grammar);
101         }
102
103         return res;
104 }
105
106 /*! \brief Unload a local grammar from a speech structure */
107 int ast_speech_grammar_unload(struct ast_speech *speech, char *grammar_name)
108 {
109         int res = 0;
110
111         if (speech->engine->unload != NULL) {
112                 res = speech->engine->unload(speech, grammar_name);
113         }
114
115         return res;
116 }
117
118 /*! \brief Return the results of a recognition from the speech structure */
119 struct ast_speech_result *ast_speech_results_get(struct ast_speech *speech)
120 {
121         struct ast_speech_result *result = NULL;
122
123         if (speech->engine->get != NULL) {
124                 result = speech->engine->get(speech);
125         }
126
127         return result;
128 }
129
130 /*! \brief Free a list of results */
131 int ast_speech_results_free(struct ast_speech_result *result)
132 {
133         struct ast_speech_result *current_result = result, *prev_result = NULL;
134         int res = 0;
135
136         while (current_result != NULL) {
137                 prev_result = current_result;
138                 /* Deallocate what we can */
139                 if (current_result->text != NULL) {
140                         free(current_result->text);
141                         current_result->text = NULL;
142                 }
143                 if (current_result->grammar != NULL) {
144                         free(current_result->grammar);
145                         current_result->grammar = NULL;
146                 }
147                 /* Move on and then free ourselves */
148                 current_result = current_result->next;
149                 free(prev_result);
150                 prev_result = NULL;
151         }
152
153         return res;
154 }
155
156 /*! \brief Start speech recognition on a speech structure */
157 void ast_speech_start(struct ast_speech *speech)
158 {
159
160         /* Clear any flags that may affect things */
161         ast_clear_flag(speech, AST_SPEECH_SPOKE);
162
163         /* If results are on the structure, free them since we are starting again */
164         if (speech->results != NULL) {
165                 ast_speech_results_free(speech->results);
166                 speech->results = NULL;
167         }
168
169         /* If the engine needs to start stuff up, do it */
170         if (speech->engine->start != NULL) {
171                 speech->engine->start(speech);
172         }
173
174         return;
175 }
176
177 /*! \brief Write in signed linear audio to be recognized */
178 int ast_speech_write(struct ast_speech *speech, void *data, int len)
179 {
180         int res = 0;
181
182         /* Make sure the speech engine is ready to accept audio */
183         if (speech->state != AST_SPEECH_STATE_READY) {
184                 return -1;
185         }
186
187         if (speech->engine->write != NULL) {
188                 speech->engine->write(speech, data, len);
189         }
190
191         return res;
192 }
193
194 /*! \brief Create a new speech structure using the engine specified */
195 struct ast_speech *ast_speech_new(char *engine_name, int format)
196 {
197         struct ast_speech_engine *engine = NULL;
198         struct ast_speech *new_speech = NULL;
199
200         /* Try to find the speech recognition engine that was requested */
201         engine = find_engine(engine_name);
202         if (engine == NULL) {
203                 /* Invalid engine or no engine available */
204                 return NULL;
205         }
206
207         /* Allocate our own speech structure, and try to allocate a structure from the engine too */
208         new_speech = ast_calloc(1, sizeof(*new_speech));
209         if (new_speech == NULL) {
210                 /* Ran out of memory while trying to allocate some for a speech structure */
211                 return NULL;
212         }
213
214         /* Initialize the lock */
215         ast_mutex_init(&new_speech->lock);
216
217         /* Make sure no results are present */
218         new_speech->results = NULL;
219
220         /* Copy over our engine pointer */
221         new_speech->engine = engine;
222
223         /* We are not ready to accept audio yet */
224         ast_speech_change_state(new_speech, AST_SPEECH_STATE_NOT_READY);
225
226         /* Pass ourselves to the engine so they can set us up some more */
227         engine->new(new_speech);
228
229         return new_speech;
230 }
231
232 /*! \brief Destroy a speech structure */
233 int ast_speech_destroy(struct ast_speech *speech)
234 {
235         int res = 0;
236
237         /* Call our engine so we are destroyed properly */
238         speech->engine->destroy(speech);
239
240         /* Deinitialize the lock */
241         ast_mutex_destroy(&speech->lock);
242
243         /* If results exist on the speech structure, destroy them */
244         if (speech->results != NULL) {
245                 ast_speech_results_free(speech->results);
246                 speech->results = NULL;
247         }
248
249         /* If a processing sound is set - free the memory used by it */
250         if (speech->processing_sound != NULL) {
251                 free(speech->processing_sound);
252                 speech->processing_sound = NULL;
253         }
254
255         /* Aloha we are done */
256         free(speech);
257         speech = NULL;
258
259         return res;
260 }
261
262 /*! \brief Change state of a speech structure */
263 int ast_speech_change_state(struct ast_speech *speech, int state)
264 {
265         int res = 0;
266
267         switch (state) {
268         case AST_SPEECH_STATE_WAIT:
269                 /* The engine heard audio, so they spoke */
270                 ast_set_flag(speech, AST_SPEECH_SPOKE);
271         default:
272                 speech->state = state;
273                 break;
274         }
275
276         return res;
277 }
278
279 /*! \brief Register a speech recognition engine */
280 int ast_speech_register(struct ast_speech_engine *engine)
281 {
282         struct ast_speech_engine *existing_engine = NULL;
283         int res = 0;
284
285         existing_engine = find_engine(engine->name);
286         if (existing_engine != NULL) {
287                 /* Engine already loaded */
288                 return -1;
289         }
290
291         if (option_verbose > 1)
292                 ast_verbose(VERBOSE_PREFIX_2 "Registered speech recognition engine '%s'\n", engine->name);
293
294         /* Add to the engine linked list and make default if needed */
295         AST_LIST_LOCK(&engines);
296         AST_LIST_INSERT_HEAD(&engines, engine, list);
297         if (default_engine == NULL) {
298                 default_engine = engine;
299                 if (option_verbose > 1)
300                         ast_verbose(VERBOSE_PREFIX_2 "Made '%s' the default speech recognition engine\n", engine->name);
301         }
302         AST_LIST_UNLOCK(&engines);
303
304         return res;
305 }
306
307 /*! \brief Unregister a speech recognition engine */
308 int ast_speech_unregister(char *engine_name)
309 {
310         struct ast_speech_engine *engine = NULL;
311         int res = -1;
312
313         if (engine_name == NULL) {
314                 return res;
315         }
316
317         AST_LIST_LOCK(&engines);
318         AST_LIST_TRAVERSE_SAFE_BEGIN(&engines, engine, list) {
319                 if (!strcasecmp(engine->name, engine_name)) {
320                         /* We have our engine... removed it */
321                         AST_LIST_REMOVE_CURRENT(&engines, list);
322                         /* If this was the default engine, we need to pick a new one */
323                         if (default_engine == engine) {
324                                 default_engine = AST_LIST_FIRST(&engines);
325                         }
326                         if (option_verbose > 1)
327                                 ast_verbose(VERBOSE_PREFIX_2 "Unregistered speech recognition engine '%s'\n", engine_name);
328                         /* All went well */
329                         res = 0;
330                         break;
331                 }
332         }
333         AST_LIST_TRAVERSE_SAFE_END
334         AST_LIST_UNLOCK(&engines);
335
336         return res;
337 }
338
339 static int unload_module(void *mod)
340 {
341         /* We can not be unloaded */
342         return -1;
343 }
344
345 static int load_module(void *mod)
346 {
347         int res = 0;
348
349         /* Initialize our list of engines */
350         AST_LIST_HEAD_INIT_NOLOCK(&engines);
351
352         return res;
353 }
354
355 static const char *description(void)
356 {
357         return "Generic Speech Recognition API";
358 }
359
360 static const char *key(void)
361 {
362         return ASTERISK_GPL_KEY;
363 }
364
365 STD_MOD(MOD_0 | NO_USECOUNT | NO_UNLOAD, NULL, NULL, NULL);