113ff6bdd2c3e64107f82ac18ee42be7475de1cb
[asterisk/asterisk.git] / apps / app_speech_utils.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 Speech Recognition Utility Applications
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  *
25  * \ingroup applications
26  */
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$");
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <unistd.h>
35 #include <string.h>
36
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/app.h"
44 #include "asterisk/speech.h"
45
46 /* Descriptions for each application */
47 static char *speechcreate_descrip =
48 "SpeechCreate(engine name)\n"
49 "This application creates information to be used by all the other applications. It must be called before doing any speech recognition activities such as activating a grammar.\n"
50 "It takes the engine name to use as the argument, if not specified the default engine will be used.\n";
51
52 static char *speechactivategrammar_descrip =
53 "SpeechActivateGrammar(Grammar Name)\n"
54 "This activates the specified grammar to be recognized by the engine. A grammar tells the speech recognition engine what to recognize, \n"
55         "and how to portray it back to you in the dialplan. The grammar name is the only argument to this application.\n";
56
57 static char *speechstart_descrip =
58 "SpeechStart()\n"
59         "Tell the speech recognition engine that it should start trying to get results from audio being fed to it. This has no arguments.\n";
60
61 static char *speechbackground_descrip =
62 "SpeechBackground(Sound File|Timeout)\n"
63 "This application plays a sound file and waits for the person to speak. Once they start speaking playback of the file stops, and silence is heard.\n"
64 "Once they stop talking the processing sound is played to indicate the speech recognition engine is working.\n"
65 "Once results are available the application returns and results (score and text) are available using dialplan functions.\n"
66 "The first text and score are ${SPEECH_TEXT(0)} AND ${SPEECH_SCORE(0)} while the second are ${SPEECH_TEXT(1)} and ${SPEECH_SCORE(1)}.\n"
67 "The first argument is the sound file and the second is the timeout integer in seconds. Note the timeout will only start once the sound file has stopped playing.\n";
68
69 static char *speechdeactivategrammar_descrip =
70 "SpeechDeactivateGrammar(Grammar Name)\n"
71         "This deactivates the specified grammar so that it is no longer recognized. The only argument is the grammar name to deactivate.\n";
72
73 static char *speechprocessingsound_descrip =
74 "SpeechProcessingSound(Sound File)\n"
75 "This changes the processing sound that SpeechBackground plays back when the speech recognition engine is processing and working to get results.\n"
76         "It takes the sound file as the only argument.\n";
77
78 static char *speechdestroy_descrip =
79 "SpeechDestroy()\n"
80 "This destroys the information used by all the other speech recognition applications.\n"
81 "If you call this application but end up wanting to recognize more speech, you must call SpeechCreate\n"
82         "again before calling any other application. It takes no arguments.\n";
83
84 static char *speechload_descrip =
85 "SpeechLoadGrammar(Grammar Name|Path)\n"
86 "Load a grammar only on the channel, not globally.\n"
87 "It takes the grammar name as first argument and path as second.\n";
88
89 static char *speechunload_descrip =
90 "SpeechUnloadGrammar(Grammar Name)\n"
91 "Unload a grammar. It takes the grammar name as the only argument.\n";
92
93 /*! \brief Helper function used by datastores to destroy the speech structure upon hangup */
94 static void destroy_callback(void *data)
95 {
96         struct ast_speech *speech = (struct ast_speech*)data;
97
98         if (speech == NULL) {
99                 return;
100         }
101
102         /* Deallocate now */
103         ast_speech_destroy(speech);
104
105         return;
106 }
107
108 /*! \brief Static structure for datastore information */
109 static const struct ast_datastore_info speech_datastore = {
110         .type = "speech",
111         .destroy = destroy_callback
112 };
113
114 /*! \brief Helper function used to find the speech structure attached to a channel */
115 static struct ast_speech *find_speech(struct ast_channel *chan)
116 {
117         struct ast_speech *speech = NULL;
118         struct ast_datastore *datastore = NULL;
119         
120         datastore = ast_channel_datastore_find(chan, &speech_datastore, NULL);
121         if (datastore == NULL) {
122                 return NULL;
123         }
124         speech = datastore->data;
125
126         return speech;
127 }
128
129 /* Helper function to find a specific speech recognition result by number and nbest alternative */
130 static struct ast_speech_result *find_result(struct ast_speech_result *results, char *result_num)
131 {
132         struct ast_speech_result *result = results;
133         char *tmp = NULL;
134         int nbest_num = 0, wanted_num = 0, i = 0;
135
136         if (!result)
137                 return NULL;
138
139         if ((tmp = strchr(result_num, '/'))) {
140                 *tmp++ = '\0';
141                 nbest_num = atoi(result_num);
142                 wanted_num = atoi(tmp);
143         } else {
144                 wanted_num = atoi(result_num);
145         }
146
147         do {
148                 if (result->nbest_num != nbest_num)
149                         continue;
150                 if (i == wanted_num)
151                         break;
152                 i++;
153         } while ((result = AST_LIST_NEXT(result, list)));
154
155         return result;
156 }
157
158 /*! \brief SPEECH_SCORE() Dialplan Function */
159 static int speech_score(struct ast_channel *chan, const char *cmd, char *data,
160                        char *buf, size_t len)
161 {
162         struct ast_speech_result *result = NULL;
163         struct ast_speech *speech = find_speech(chan);
164         char tmp[128] = "";
165
166         if (data == NULL || speech == NULL || !(result = find_result(speech->results, data)))
167                 return -1;
168         
169         snprintf(tmp, sizeof(tmp), "%d", result->score);
170         
171         ast_copy_string(buf, tmp, len);
172
173         return 0;
174 }
175
176 static struct ast_custom_function speech_score_function = {
177         .name = "SPEECH_SCORE",
178         .synopsis = "Gets the confidence score of a result.",
179         .syntax = "SPEECH_SCORE([nbest number/]result number)",
180         .desc =
181         "Gets the confidence score of a result.\n",
182         .read = speech_score,
183         .write = NULL,
184 };
185
186 /*! \brief SPEECH_TEXT() Dialplan Function */
187 static int speech_text(struct ast_channel *chan, const char *cmd, char *data,
188                         char *buf, size_t len)
189 {
190         struct ast_speech_result *result = NULL;
191         struct ast_speech *speech = find_speech(chan);
192
193         if (data == NULL || speech == NULL || !(result = find_result(speech->results, data)))
194                 return -1;
195
196         if (result->text != NULL)
197                 ast_copy_string(buf, result->text, len);
198
199         return 0;
200 }
201
202 static struct ast_custom_function speech_text_function = {
203         .name = "SPEECH_TEXT",
204         .synopsis = "Gets the recognized text of a result.",
205         .syntax = "SPEECH_TEXT([nbest number/]result number)",
206         .desc =
207         "Gets the recognized text of a result.\n",
208         .read = speech_text,
209         .write = NULL,
210 };
211
212 /*! \brief SPEECH_GRAMMAR() Dialplan Function */
213 static int speech_grammar(struct ast_channel *chan, const char *cmd, char *data,
214                         char *buf, size_t len)
215 {
216         struct ast_speech_result *result = NULL;
217         struct ast_speech *speech = find_speech(chan);
218
219         if (data == NULL || speech == NULL || !(result = find_result(speech->results, data)))
220                 return -1;
221
222         if (result->grammar != NULL)
223                 ast_copy_string(buf, result->grammar, len);
224
225         return 0;
226 }
227
228 static struct ast_custom_function speech_grammar_function = {
229         .name = "SPEECH_GRAMMAR",
230         .synopsis = "Gets the matched grammar of a result if available.",
231         .syntax = "SPEECH_GRAMMAR([nbest number/]result number)",
232         .desc =
233         "Gets the matched grammar of a result if available.\n",
234         .read = speech_grammar,
235         .write = NULL,
236 };
237
238 /*! \brief SPEECH_ENGINE() Dialplan Function */
239 static int speech_engine_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
240 {
241         struct ast_speech *speech = find_speech(chan);
242
243         if (data == NULL || speech == NULL)
244                 return -1;
245
246         ast_speech_change(speech, data, value);
247
248         return 0;
249 }
250
251 static struct ast_custom_function speech_engine_function = {
252         .name = "SPEECH_ENGINE",
253         .synopsis = "Change a speech engine specific attribute.",
254         .syntax = "SPEECH_ENGINE(name)=value",
255         .desc =
256         "Changes a speech engine specific attribute.\n",
257         .read = NULL,
258         .write = speech_engine_write,
259 };
260
261 /*! \brief SPEECH_RESULTS_TYPE() Dialplan Function */
262 static int speech_results_type_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
263 {
264         struct ast_speech *speech = find_speech(chan);
265
266         if (data == NULL || speech == NULL)
267                 return -1;
268
269         if (!strcasecmp(value, "normal"))
270                 ast_speech_change_results_type(speech, AST_SPEECH_RESULTS_TYPE_NORMAL);
271         else if (!strcasecmp(value, "nbest"))
272                 ast_speech_change_results_type(speech, AST_SPEECH_RESULTS_TYPE_NBEST);
273
274         return 0;
275 }
276
277 static struct ast_custom_function speech_results_type_function = {
278         .name = "SPEECH_RESULTS_TYPE",
279         .synopsis = "Sets the type of results that will be returned.",
280         .syntax = "SPEECH_RESULTS_TYPE()=results type",
281         .desc =
282         "Sets the type of results that will be returned. Valid options are normal or nbest.",
283         .read = NULL,
284         .write = speech_results_type_write,
285 };
286
287 /*! \brief SPEECH() Dialplan Function */
288 static int speech_read(struct ast_channel *chan, const char *cmd, char *data,
289                         char *buf, size_t len)
290 {
291         int results = 0;
292         struct ast_speech_result *result = NULL;
293         struct ast_speech *speech = find_speech(chan);
294         char tmp[128] = "";
295
296         /* Now go for the various options */
297         if (!strcasecmp(data, "status")) {
298                 if (speech != NULL)
299                         ast_copy_string(buf, "1", len);
300                 else
301                         ast_copy_string(buf, "0", len);
302                 return 0;
303         }
304
305         /* Make sure we have a speech structure for everything else */
306         if (speech == NULL) {
307                 return -1;
308         }
309
310         /* Check to see if they are checking for silence */
311         if (!strcasecmp(data, "spoke")) {
312                 if (ast_test_flag(speech, AST_SPEECH_SPOKE))
313                         ast_copy_string(buf, "1", len);
314                 else
315                         ast_copy_string(buf, "0", len);
316         } else if (!strcasecmp(data, "results")) {
317                 /* Count number of results */
318                 for (result = speech->results; result; result = AST_LIST_NEXT(result, list))
319                         results++;
320                 snprintf(tmp, sizeof(tmp), "%d", results);
321                 ast_copy_string(buf, tmp, len);
322         }
323
324         return 0;
325 }
326
327 static struct ast_custom_function speech_function = {
328         .name = "SPEECH",
329         .synopsis = "Gets information about speech recognition results.",
330         .syntax = "SPEECH(argument)",
331         .desc =
332         "Gets information about speech recognition results.\n"
333         "status:   Returns 1 upon speech object existing, or 0 if not\n"
334         "spoke:  Returns 1 if spoker spoke, or 0 if not\n"
335         "results:  Returns number of results that were recognized\n",
336         .read = speech_read,
337         .write = NULL,
338 };
339
340
341
342 /*! \brief SpeechCreate() Dialplan Application */
343 static int speech_create(struct ast_channel *chan, void *data)
344 {
345         struct ast_speech *speech = NULL;
346         struct ast_datastore *datastore = NULL;
347
348         /* Request a speech object */
349         speech = ast_speech_new(data, chan->nativeformats);
350         if (speech == NULL) {
351                 /* Not available */
352                 pbx_builtin_setvar_helper(chan, "ERROR", "1");
353                 return 0;
354         }
355
356         datastore = ast_channel_datastore_alloc(&speech_datastore, NULL);
357         if (datastore == NULL) {
358                 ast_speech_destroy(speech);
359                 pbx_builtin_setvar_helper(chan, "ERROR", "1");
360                 return 0;
361         }
362         datastore->data = speech;
363         ast_channel_datastore_add(chan, datastore);
364
365         return 0;
366 }
367
368 /*! \brief SpeechLoadGrammar(Grammar Name|Path) Dialplan Application */
369 static int speech_load(struct ast_channel *chan, void *data)
370 {
371         int res = 0, argc = 0;
372         struct ast_speech *speech = find_speech(chan);
373         char *argv[2], *args = NULL, *name = NULL, *path = NULL;
374
375         args = ast_strdupa(data);
376
377         if (speech == NULL)
378                 return -1;
379
380         /* Parse out arguments */
381         argc = ast_app_separate_args(args, '|', argv, sizeof(argv) / sizeof(argv[0]));
382         if (argc != 2)
383                 return -1;
384         name = argv[0];
385         path = argv[1];
386
387         /* Load the grammar locally on the object */
388         res = ast_speech_grammar_load(speech, name, path);
389
390         return res;
391 }
392
393 /*! \brief SpeechUnloadGrammar(Grammar Name) Dialplan Application */
394 static int speech_unload(struct ast_channel *chan, void *data)
395 {
396         int res = 0;
397         struct ast_speech *speech = find_speech(chan);
398
399         if (speech == NULL)
400                 return -1;
401
402         /* Unload the grammar */
403         res = ast_speech_grammar_unload(speech, data);
404
405         return res;
406 }
407
408 /*! \brief SpeechDeactivateGrammar(Grammar Name) Dialplan Application */
409 static int speech_deactivate(struct ast_channel *chan, void *data)
410 {
411         int res = 0;
412         struct ast_speech *speech = find_speech(chan);
413
414         if (speech == NULL)
415                 return -1;
416
417         /* Deactivate the grammar on the speech object */
418         res = ast_speech_grammar_deactivate(speech, data);
419
420         return res;
421 }
422
423 /*! \brief SpeechActivateGrammar(Grammar Name) Dialplan Application */
424 static int speech_activate(struct ast_channel *chan, void *data)
425 {
426         int res = 0;
427         struct ast_speech *speech = find_speech(chan);
428
429         if (speech == NULL)
430                 return -1;
431
432         /* Activate the grammar on the speech object */
433         res = ast_speech_grammar_activate(speech, data);
434
435         return res;
436 }
437
438 /*! \brief SpeechStart() Dialplan Application */
439 static int speech_start(struct ast_channel *chan, void *data)
440 {
441         int res = 0;
442         struct ast_speech *speech = find_speech(chan);
443
444         if (speech == NULL)
445                 return -1;
446
447         ast_speech_start(speech);
448
449         return res;
450 }
451
452 /*! \brief SpeechProcessingSound(Sound File) Dialplan Application */
453 static int speech_processing_sound(struct ast_channel *chan, void *data)
454 {
455         int res = 0;
456         struct ast_speech *speech = find_speech(chan);
457
458         if (speech == NULL)
459                 return -1;
460
461         if (speech->processing_sound != NULL) {
462                 ast_free(speech->processing_sound);
463                 speech->processing_sound = NULL;
464         }
465
466         speech->processing_sound = ast_strdup(data);
467
468         return res;
469 }
470
471 /*! \brief Helper function used by speech_background to playback a soundfile */
472 static int speech_streamfile(struct ast_channel *chan, const char *filename, const char *preflang)
473 {
474         struct ast_filestream *fs = NULL;
475
476         if (!(fs = ast_openstream(chan, filename, preflang)))
477                 return -1;
478         
479         if (ast_applystream(chan, fs))
480                 return -1;
481         
482         ast_playstream(fs);
483
484         return 0;
485 }
486
487 /*! \brief SpeechBackground(Sound File|Timeout) Dialplan Application */
488 static int speech_background(struct ast_channel *chan, void *data)
489 {
490         unsigned int timeout = 0;
491         int res = 0, done = 0, argc = 0, started = 0, quieted = 0, max_dtmf_len = 0;
492         struct ast_speech *speech = find_speech(chan);
493         struct ast_frame *f = NULL;
494         int oldreadformat = AST_FORMAT_SLINEAR;
495         char dtmf[AST_MAX_EXTENSION] = "";
496         time_t start, current;
497         struct ast_datastore *datastore = NULL;
498         char *argv[2], *args = NULL, *filename_tmp = NULL, *filename = NULL, tmp[2] = "", dtmf_terminator = '#';
499         const char *tmp2 = NULL;
500
501         args = ast_strdupa(data);
502
503         if (speech == NULL)
504                 return -1;
505
506         /* If channel is not already answered, then answer it */
507         if (chan->_state != AST_STATE_UP && ast_answer(chan))
508                 return -1;
509
510         /* Record old read format */
511         oldreadformat = chan->readformat;
512
513         /* Change read format to be signed linear */
514         if (ast_set_read_format(chan, speech->format))
515                 return -1;
516
517         /* Parse out options */
518         argc = ast_app_separate_args(args, '|', argv, sizeof(argv) / sizeof(argv[0]));
519         if (argc > 0) {
520                 /* Yay sound file */
521                 filename_tmp = ast_strdupa(argv[0]);
522                 if (!ast_strlen_zero(argv[1])) {
523                         if ((timeout = atoi(argv[1])) == 0)
524                                 timeout = -1;
525                 } else
526                         timeout = 0;
527         }
528
529         /* See if the maximum DTMF length variable is set... we use a variable in case they want to carry it through their entire dialplan */
530         if ((tmp2 = pbx_builtin_getvar_helper(chan, "SPEECH_DTMF_MAXLEN")) && !ast_strlen_zero(tmp2))
531                 max_dtmf_len = atoi(tmp2);
532
533         /* See if a terminator is specified */
534         if ((tmp2 = pbx_builtin_getvar_helper(chan, "SPEECH_DTMF_TERMINATOR"))) {
535                 if (ast_strlen_zero(tmp2))
536                         dtmf_terminator = '\0';
537                 else
538                         dtmf_terminator = tmp2[0];
539         }
540
541         /* Before we go into waiting for stuff... make sure the structure is ready, if not - start it again */
542         if (speech->state == AST_SPEECH_STATE_NOT_READY || speech->state == AST_SPEECH_STATE_DONE) {
543                 ast_speech_change_state(speech, AST_SPEECH_STATE_NOT_READY);
544                 ast_speech_start(speech);
545         }
546
547         /* Ensure no streams are currently running */
548         ast_stopstream(chan);
549
550         /* Okay it's streaming so go into a loop grabbing frames! */
551         while (done == 0) {
552                 /* If the filename is null and stream is not running, start up a new sound file */
553                 if (!quieted && (chan->streamid == -1 && chan->timingfunc == NULL) && (filename = strsep(&filename_tmp, "&"))) {
554                         /* Discard old stream information */
555                         ast_stopstream(chan);
556                         /* Start new stream */
557                         speech_streamfile(chan, filename, chan->language);
558                 }
559
560                 /* Run scheduled stuff */
561                 ast_sched_runq(chan->sched);
562
563                 /* Yay scheduling */
564                 res = ast_sched_wait(chan->sched);
565                 if (res < 0) {
566                         res = 1000;
567                 }
568
569                 /* If there is a frame waiting, get it - if not - oh well */
570                 if (ast_waitfor(chan, res) > 0) {
571                         f = ast_read(chan);
572                         if (f == NULL) {
573                                 /* The channel has hung up most likely */
574                                 done = 3;
575                                 break;
576                         }
577                 }
578
579                 /* Do timeout check (shared between audio/dtmf) */
580                 if ((!quieted || strlen(dtmf)) && started == 1) {
581                         time(&current);
582                         if ((current-start) >= timeout) {
583                                 done = 1;
584                                 if (f)
585                                         ast_frfree(f);
586                                 break;
587                         }
588                 }
589
590                 /* Do checks on speech structure to see if it's changed */
591                 ast_mutex_lock(&speech->lock);
592                 if (ast_test_flag(speech, AST_SPEECH_QUIET)) {
593                         if (chan->stream)
594                                 ast_stopstream(chan);
595                         ast_clear_flag(speech, AST_SPEECH_QUIET);
596                         quieted = 1;
597                 }
598                 /* Check state so we can see what to do */
599                 switch (speech->state) {
600                 case AST_SPEECH_STATE_READY:
601                         /* If audio playback has stopped do a check for timeout purposes */
602                         if (chan->streamid == -1 && chan->timingfunc == NULL)
603                                 ast_stopstream(chan);
604                         if (!quieted && chan->stream == NULL && timeout && started == 0 && !filename_tmp) {
605                                 if (timeout == -1) {
606                                         done = 1;
607                                         if (f)
608                                                 ast_frfree(f);
609                                         break;
610                                 }
611                                 time(&start);
612                                 started = 1;
613                         }
614                         /* Write audio frame out to speech engine if no DTMF has been received */
615                         if (!strlen(dtmf) && f != NULL && f->frametype == AST_FRAME_VOICE) {
616                                 ast_speech_write(speech, f->data, f->datalen);
617                         }
618                         break;
619                 case AST_SPEECH_STATE_WAIT:
620                         /* Cue up waiting sound if not already playing */
621                         if (!strlen(dtmf)) {
622                                 if (chan->stream == NULL) {
623                                         if (speech->processing_sound != NULL) {
624                                                 if (strlen(speech->processing_sound) > 0 && strcasecmp(speech->processing_sound,"none")) {
625                                                         speech_streamfile(chan, speech->processing_sound, chan->language);
626                                                 }
627                                         }
628                                 } else if (chan->streamid == -1 && chan->timingfunc == NULL) {
629                                         ast_stopstream(chan);
630                                         if (speech->processing_sound != NULL) {
631                                                 if (strlen(speech->processing_sound) > 0 && strcasecmp(speech->processing_sound,"none")) {
632                                                         speech_streamfile(chan, speech->processing_sound, chan->language);
633                                                 }
634                                         }
635                                 }
636                         }
637                         break;
638                 case AST_SPEECH_STATE_DONE:
639                         /* Now that we are done... let's switch back to not ready state */
640                         ast_speech_change_state(speech, AST_SPEECH_STATE_NOT_READY);
641                         if (!strlen(dtmf)) {
642                                 /* Copy to speech structure the results, if available */
643                                 speech->results = ast_speech_results_get(speech);
644                                 /* Break out of our background too */
645                                 done = 1;
646                                 /* Stop audio playback */
647                                 if (chan->stream != NULL) {
648                                         ast_stopstream(chan);
649                                 }
650                         }
651                         break;
652                 default:
653                         break;
654                 }
655                 ast_mutex_unlock(&speech->lock);
656
657                 /* Deal with other frame types */
658                 if (f != NULL) {
659                         /* Free the frame we received */
660                         switch (f->frametype) {
661                         case AST_FRAME_DTMF:
662                                 if (dtmf_terminator != '\0' && f->subclass == dtmf_terminator) {
663                                         done = 1;
664                                 } else {
665                                         if (chan->stream != NULL) {
666                                                 ast_stopstream(chan);
667                                         }
668                                         if (!started) {
669                                                 /* Change timeout to be 5 seconds for DTMF input */
670                                                 timeout = (chan->pbx && chan->pbx->dtimeout) ? chan->pbx->dtimeout : 5;
671                                                 started = 1;
672                                         }
673                                         time(&start);
674                                         snprintf(tmp, sizeof(tmp), "%c", f->subclass);
675                                         strncat(dtmf, tmp, sizeof(dtmf));
676                                         /* If the maximum length of the DTMF has been reached, stop now */
677                                         if (max_dtmf_len && strlen(dtmf) == max_dtmf_len)
678                                                 done = 1;
679                                 }
680                                 break;
681                         case AST_FRAME_CONTROL:
682                                 switch (f->subclass) {
683                                 case AST_CONTROL_HANGUP:
684                                         /* Since they hung up we should destroy the speech structure */
685                                         done = 3;
686                                 default:
687                                         break;
688                                 }
689                         default:
690                                 break;
691                         }
692                         ast_frfree(f);
693                         f = NULL;
694                 }
695         }
696
697         if (strlen(dtmf)) {
698                 /* We sort of make a results entry */
699                 speech->results = ast_calloc(1, sizeof(*speech->results));
700                 if (speech->results != NULL) {
701                         speech->results->score = 1000;
702                         speech->results->text = ast_strdup(dtmf);
703                         speech->results->grammar = ast_strdup("dtmf");
704                 }
705         }
706
707         /* See if it was because they hung up */
708         if (done == 3) {
709                 /* Destroy speech structure */
710                 ast_speech_destroy(speech);
711                 datastore = ast_channel_datastore_find(chan, &speech_datastore, NULL);
712                 if (datastore != NULL) {
713                         ast_channel_datastore_remove(chan, datastore);
714                 }
715         } else {
716                 /* Channel is okay so restore read format */
717                 ast_set_read_format(chan, oldreadformat);
718         }
719
720         return 0;
721 }
722
723
724 /*! \brief SpeechDestroy() Dialplan Application */
725 static int speech_destroy(struct ast_channel *chan, void *data)
726 {
727         int res = 0;
728         struct ast_speech *speech = find_speech(chan);
729         struct ast_datastore *datastore = NULL;
730
731         if (speech == NULL)
732                 return -1;
733
734         /* Destroy speech structure */
735         ast_speech_destroy(speech);
736
737         datastore = ast_channel_datastore_find(chan, &speech_datastore, NULL);
738         if (datastore != NULL) {
739                 ast_channel_datastore_remove(chan, datastore);
740         }
741
742         return res;
743 }
744
745 static int unload_module(void)
746 {
747         int res = 0;
748
749         res = ast_unregister_application("SpeechCreate");
750         res |= ast_unregister_application("SpeechLoadGrammar");
751         res |= ast_unregister_application("SpeechUnloadGrammar");
752         res |= ast_unregister_application("SpeechActivateGrammar");
753         res |= ast_unregister_application("SpeechDeactivateGrammar");
754         res |= ast_unregister_application("SpeechStart");
755         res |= ast_unregister_application("SpeechBackground");
756         res |= ast_unregister_application("SpeechDestroy");
757         res |= ast_unregister_application("SpeechProcessingSound");
758         res |= ast_custom_function_unregister(&speech_function);
759         res |= ast_custom_function_unregister(&speech_score_function);
760         res |= ast_custom_function_unregister(&speech_text_function);
761         res |= ast_custom_function_unregister(&speech_grammar_function);
762         res |= ast_custom_function_unregister(&speech_engine_function);
763         res |= ast_custom_function_unregister(&speech_results_type_function);
764
765         return res;     
766 }
767
768 static int load_module(void)
769 {
770         int res = 0;
771
772         res = ast_register_application("SpeechCreate", speech_create, "Create a Speech Structure", speechcreate_descrip);
773         res |= ast_register_application("SpeechLoadGrammar", speech_load, "Load a Grammar", speechload_descrip);
774         res |= ast_register_application("SpeechUnloadGrammar", speech_unload, "Unload a Grammar", speechunload_descrip);
775         res |= ast_register_application("SpeechActivateGrammar", speech_activate, "Activate a Grammar", speechactivategrammar_descrip);
776         res |= ast_register_application("SpeechDeactivateGrammar", speech_deactivate, "Deactivate a Grammar", speechdeactivategrammar_descrip);
777         res |= ast_register_application("SpeechStart", speech_start, "Start recognizing voice in the audio stream", speechstart_descrip);
778         res |= ast_register_application("SpeechBackground", speech_background, "Play a sound file and wait for speech to be recognized", speechbackground_descrip);
779         res |= ast_register_application("SpeechDestroy", speech_destroy, "End speech recognition", speechdestroy_descrip);
780         res |= ast_register_application("SpeechProcessingSound", speech_processing_sound, "Change background processing sound", speechprocessingsound_descrip);
781         res |= ast_custom_function_register(&speech_function);
782         res |= ast_custom_function_register(&speech_score_function);
783         res |= ast_custom_function_register(&speech_text_function);
784         res |= ast_custom_function_register(&speech_grammar_function);
785         res |= ast_custom_function_register(&speech_engine_function);
786         res |= ast_custom_function_register(&speech_results_type_function);
787
788         return res;
789 }
790
791 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dialplan Speech Applications");