17ffd8985e8c35d9fe22fe3243d4a950585fcb78
[asterisk/asterisk.git] / apps / app_waitforsilence.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * WaitForSilence Application by David C. Troy <dave@popvox.com>
7  * Version 1.00 2004-01-29
8  *
9  * Mark Spencer <markster@digium.com>
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  * This program is free software, distributed under the terms of
18  * the GNU General Public License Version 2. See the LICENSE file
19  * at the top of the source tree.
20  */
21
22 /*! \file
23  *
24  * \brief Wait for Silence
25  *   - Waits for up to 'x' milliseconds of silence, 'y' times \n
26  *   - WaitForSilence(500,2) will wait for 1/2 second of silence, twice \n
27  *   - WaitForSilence(1000,1) will wait for 1 second of silence, once \n
28  *
29  * \author David C. Troy <dave@popvox.com>
30  *
31  * \ingroup applications
32  */
33
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <unistd.h>
38
39 #include "asterisk.h"
40
41 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
42
43 #include "asterisk/file.h"
44 #include "asterisk/logger.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/dsp.h"
48 #include "asterisk/module.h"
49 #include "asterisk/options.h"
50
51 static char *tdesc = "Wait For Silence";
52 static char *app = "WaitForSilence";
53 static char *synopsis = "Waits for a specified amount of silence";
54 static char *descrip = 
55 "  WaitForSilence(x[|y]) Wait for Silence: Waits for up to 'x' \n"
56 "milliseconds of silence, 'y' times or 1 if omitted\n"
57 "Set the channel variable WAITSTATUS with to one of these values:"
58 "SILENCE - if silence of x ms was detected"
59 "TIMEOUT - if silence of x ms was not detected."
60 "Examples:\n"
61 "  - WaitForSilence(500|2) will wait for 1/2 second of silence, twice\n"
62 "  - WaitForSilence(1000) will wait for 1 second of silence, once\n";
63
64 LOCAL_USER_DECL;
65
66 static int do_waiting(struct ast_channel *chan, int maxsilence) {
67
68         struct ast_frame *f;
69         int totalsilence = 0;
70         int dspsilence = 0;
71         int gotsilence = 0; 
72         static int silencethreshold = 64;
73         int rfmt = 0;
74         int res = 0;
75         struct ast_dsp *sildet;  /* silence detector dsp */
76         time_t start, now;
77         time(&start);
78
79         rfmt = chan->readformat; /* Set to linear mode */
80         res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
81         if (res < 0) {
82                 ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
83                 return -1;
84         }
85
86         sildet = ast_dsp_new(); /* Create the silence detector */
87         if (!sildet) {
88                 ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
89                 return -1;
90         }
91         ast_dsp_set_threshold(sildet, silencethreshold);
92
93         /* Await silence... */
94         f = NULL;
95         for(;;) {
96                 res = ast_waitfor(chan, 2000);
97                 if (!res) {
98                         ast_log(LOG_WARNING, "One waitfor failed, trying another\n");
99                         /* Try one more time in case of masq */
100                         res = ast_waitfor(chan, 2000);
101                         if (!res) {
102                                 ast_log(LOG_WARNING, "No audio available on %s??\n", chan->name);
103                                 res = -1;
104                         }
105                 }
106
107                 if (res < 0) {
108                         f = NULL;
109                         break;
110                 }
111                 f = ast_read(chan);
112                 if (!f)
113                         break;
114                 if (f->frametype == AST_FRAME_VOICE) {
115                         dspsilence = 0;
116                         ast_dsp_silence(sildet, f, &dspsilence);
117                         if (dspsilence) {
118                                 totalsilence = dspsilence;
119                                 time(&start);
120                         } else {
121                                 totalsilence = 0;
122                         }
123
124                         if (totalsilence >= maxsilence) {
125                                 if (option_verbose > 2)
126                                         ast_verbose(VERBOSE_PREFIX_3 "Exiting with %dms silence > %dms required\n", totalsilence, maxsilence);
127                                 /* Ended happily with silence */
128                                 gotsilence = 1;
129                                 pbx_builtin_setvar_helper(chan, "WAITSTATUS", "SILENCE");
130                                 ast_log(LOG_DEBUG, "WAITSTATUS was set to SILENCE\n");
131                                 ast_frfree(f);
132                                 break;
133                         } else if ( difftime(time(&now),start) >= maxsilence/1000 ) {
134                                 pbx_builtin_setvar_helper(chan, "WAITSTATUS", "TIMEOUT");
135                                 ast_log(LOG_DEBUG, "WAITSTATUS was set to TIMEOUT\n");
136                                 ast_frfree(f);
137                                 break;
138                         }
139                 }
140                 ast_frfree(f);
141         }
142         if (rfmt && ast_set_read_format(chan, rfmt)) {
143                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
144         }
145         ast_dsp_free(sildet);
146         return gotsilence;
147 }
148
149 static int waitforsilence_exec(struct ast_channel *chan, void *data)
150 {
151         int res = 1;
152         struct localuser *u;
153         int maxsilence = 1000;
154         int iterations = 1, i;
155
156         LOCAL_USER_ADD(u);
157         
158         res = ast_answer(chan); /* Answer the channel */
159
160         if (!data || ((sscanf(data, "%d|%d", &maxsilence, &iterations) != 2) &&
161                 (sscanf(data, "%d", &maxsilence) != 1))) {
162                 ast_log(LOG_WARNING, "Using default value of 1000ms, 1 iteration\n");
163         }
164
165         if (option_verbose > 2)
166                 ast_verbose(VERBOSE_PREFIX_3 "Waiting %d time(s) for %d ms silence\n", iterations, maxsilence);
167         
168         res = 1;
169         for (i=0; (i<iterations) && (res == 1); i++) {
170                 res = do_waiting(chan, maxsilence);
171         }
172         LOCAL_USER_REMOVE(u);
173         if (res > 0)
174                 res = 0;
175         return res;
176 }
177
178 static int unload_module(void *mod)
179 {
180         int res;
181
182         res = ast_unregister_application(app);
183         
184         STANDARD_HANGUP_LOCALUSERS;
185
186         return res;
187 }
188
189 static int load_module(void *mod)
190 {
191         return ast_register_application(app, waitforsilence_exec, synopsis, descrip);
192 }
193
194 static const char *description(void)
195 {
196         return tdesc;
197 }
198
199 static const char *key(void)
200 {
201         return ASTERISK_GPL_KEY;
202 }
203
204 STD_MOD1;