Asterisk data retrieval API.
[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.11 2006-06-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  *   - WaitForSilence(300,3,10) will wait for 300ms of silence, 3 times, and return after 10sec \n
29  *
30  * \author David C. Troy <dave@popvox.com>
31  *
32  * \brief Wait For Noise
33  * The same as Wait For Silence but listenes noise on the chennel that is above \n
34  * the pre-configured silence threshold from dsp.conf
35  *
36  * \author Philipp Skadorov <skadorov@yahoo.com>
37  *
38  * \ingroup applications
39  */
40
41 #include "asterisk.h"
42
43 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
44
45 #include "asterisk/file.h"
46 #include "asterisk/channel.h"
47 #include "asterisk/pbx.h"
48 #include "asterisk/dsp.h"
49 #include "asterisk/module.h"
50
51 /*** DOCUMENTATION
52         <application name="WaitForSilence" language="en_US">
53                 <synopsis>
54                         Waits for a specified amount of silence.
55                 </synopsis>
56                 <syntax>
57                         <parameter name="silencerequired" required="true" />
58                         <parameter name="iterations">
59                                 <para>If not specified, defaults to <literal>1</literal>.</para>
60                         </parameter>
61                         <parameter name="timeout">
62                                 <para>Is specified only to avoid an infinite loop in cases where silence is never achieved.</para>
63                         </parameter>
64                 </syntax>
65                 <description>
66                         <para>Waits for up to <replaceable>silencerequired</replaceable> milliseconds of silence,
67                         <replaceable>iterations</replaceable> times. An optional <replaceable>timeout</replaceable>
68                         specified the number of seconds to return after, even if we do not receive the specified amount of silence.
69                         Use <replaceable>timeout</replaceable> with caution, as it may defeat the purpose of this application, which
70                         is to wait indefinitely until silence is detected on the line. This is particularly useful for reverse-911-type
71                         call broadcast applications where you need to wait for an answering machine to complete its spiel before
72                         playing a message.</para>
73                         <para>Typically you will want to include two or more calls to WaitForSilence when dealing with an answering
74                         machine; first waiting for the spiel to finish, then waiting for the beep, etc.</para>
75                         <para>Examples:</para>
76                         <para>WaitForSilence(500,2) will wait for 1/2 second of silence, twice</para>
77                         <para>WaitForSilence(1000) will wait for 1 second of silence, once</para>
78                         <para>WaitForSilence(300,3,10) will wait for 300ms silence, 3 times, and returns after 10 sec, even if silence
79                         is not detected</para>
80                         <para>Sets the channel variable <variable>WAITSTATUS</variable> to one of these values:</para>
81                         <variablelist>
82                                 <variable name="WAITSTATUS">
83                                         <value name="SILENCE">
84                                                 if exited with silence detected.
85                                         </value>
86                                         <value name="TIMEOUT">
87                                                 if exited without silence detected after timeout.
88                                         </value>
89                                 </variable>
90                         </variablelist>
91                 </description>
92                 <see-also>
93                         <ref type="application">WaitForNoise</ref>
94                 </see-also>
95         </application>
96         <application name="WaitForNoise" language="en_US">
97                 <synopsis>
98                         Waits for a specified amount of noise.
99                 </synopsis>
100                 <syntax>
101                         <parameter name="noiserequired" required="true" />
102                         <parameter name="iterations">
103                                 <para>If not specified, defaults to <literal>1</literal>.</para>
104                         </parameter>
105                         <parameter name="timeout">
106                                 <para>Is specified only to avoid an infinite loop in cases where silence is never achieved.</para>
107                         </parameter>
108                 </syntax>
109                 <description>
110                         <para>Waits for up to <replaceable>noiserequired</replaceable> milliseconds of noise,
111                         <replaceable>iterations</replaceable> times. An optional <replaceable>timeout</replaceable>
112                         specified the number of seconds to return after, even if we do not receive the specified amount of noise.
113                         Use <replaceable>timeout</replaceable> with caution, as it may defeat the purpose of this application, which
114                         is to wait indefinitely until noise is detected on the line.</para>
115                 </description>
116                 <see-also>
117                         <ref type="application">WaitForSilence</ref>
118                 </see-also>
119         </application>
120  ***/
121
122 static char *app_silence = "WaitForSilence";
123 static char *app_noise = "WaitForNoise";
124
125 static int do_waiting(struct ast_channel *chan, int timereqd, time_t waitstart, int timeout, int wait_for_silence) {
126         struct ast_frame *f = NULL;
127         int dsptime = 0;
128         int rfmt = 0;
129         int res = 0;
130         struct ast_dsp *sildet;  /* silence detector dsp */
131         time_t now;
132
133         /*Either silence or noise calc depending on wait_for_silence flag*/
134         int (*ast_dsp_func)(struct ast_dsp*, struct ast_frame*, int*) =
135                                 wait_for_silence ? ast_dsp_silence : ast_dsp_noise;
136
137         rfmt = chan->readformat; /* Set to linear mode */
138         if ((res = ast_set_read_format(chan, AST_FORMAT_SLINEAR)) < 0) {
139                 ast_log(LOG_WARNING, "Unable to set channel to linear mode, giving up\n");
140                 return -1;
141         }
142
143         /* Create the silence detector */
144         if (!(sildet = ast_dsp_new())) {
145                 ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
146                 return -1;
147         }
148         ast_dsp_set_threshold(sildet, ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE));
149
150         /* Await silence... */
151         for (;;) {
152                 /* Start with no silence received */
153                 dsptime = 0;
154
155                 res = ast_waitfor(chan, timereqd);
156
157                 /* Must have gotten a hangup; let's exit */
158                 if (res < 0) {
159                         pbx_builtin_setvar_helper(chan, "WAITSTATUS", "HANGUP");
160                         break;
161                 }
162                 
163                 /* We waited and got no frame; sounds like digital silence or a muted digital channel */
164                 if (res == 0) {
165                         dsptime = timereqd;
166                 } else {
167                         /* Looks like we did get a frame, so let's check it out */
168                         if (!(f = ast_read(chan))) {
169                                 pbx_builtin_setvar_helper(chan, "WAITSTATUS", "HANGUP");
170                                 break;
171                         }
172                         if (f->frametype == AST_FRAME_VOICE) {
173                                 ast_dsp_func(sildet, f, &dsptime);
174                         }
175                         ast_frfree(f);
176                 }
177
178                 ast_verb(6, "Got %dms %s < %dms required\n", dsptime, wait_for_silence ? "silence" : "noise", timereqd);
179
180                 if (dsptime >= timereqd) {
181                         ast_verb(3, "Exiting with %dms %s >= %dms required\n", dsptime, wait_for_silence ? "silence" : "noise", timereqd);
182                         /* Ended happily with silence */
183                         res = 1;
184                         pbx_builtin_setvar_helper(chan, "WAITSTATUS", wait_for_silence ? "SILENCE" : "NOISE");
185                         ast_debug(1, "WAITSTATUS was set to %s\n", wait_for_silence ? "SILENCE" : "NOISE");
186                         break;
187                 }
188
189                 if (timeout && (difftime(time(&now), waitstart) >= timeout)) {
190                         pbx_builtin_setvar_helper(chan, "WAITSTATUS", "TIMEOUT");
191                         ast_debug(1, "WAITSTATUS was set to TIMEOUT\n");
192                         res = 0;
193                         break;
194                 }
195         }
196
197
198         if (rfmt && ast_set_read_format(chan, rfmt)) {
199                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
200         }
201         ast_dsp_free(sildet);
202         return res;
203 }
204
205 static int waitfor_exec(struct ast_channel *chan, const char *data, int wait_for_silence)
206 {
207         int res = 1;
208         int timereqd = 1000;
209         int timeout = 0;
210         int iterations = 1, i;
211         time_t waitstart;
212         struct ast_silence_generator *silgen = NULL;
213
214         if (chan->_state != AST_STATE_UP) {
215                 res = ast_answer(chan); /* Answer the channel */
216         }
217
218         if (!data || ( (sscanf(data, "%30d,%30d,%30d", &timereqd, &iterations, &timeout) != 3) &&
219                 (sscanf(data, "%30d,%30d", &timereqd, &iterations) != 2) &&
220                 (sscanf(data, "%30d", &timereqd) != 1) ) ) {
221                 ast_log(LOG_WARNING, "Using default value of 1000ms, 1 iteration, no timeout\n");
222         }
223
224         ast_verb(3, "Waiting %d time(s) for %d ms silence with %d timeout\n", iterations, timereqd, timeout);
225
226         if (ast_opt_transmit_silence) {
227                 silgen = ast_channel_start_silence_generator(chan);
228         }
229         time(&waitstart);
230         res = 1;
231         for (i=0; (i<iterations) && (res == 1); i++) {
232                 res = do_waiting(chan, timereqd, waitstart, timeout, wait_for_silence);
233         }
234         if (silgen) {
235                 ast_channel_stop_silence_generator(chan, silgen);
236         }
237
238
239         if (res > 0)
240                 res = 0;
241         return res;
242 }
243
244 static int waitforsilence_exec(struct ast_channel *chan, const char *data)
245 {
246         return waitfor_exec(chan, data, 1);
247 }
248
249 static int waitfornoise_exec(struct ast_channel *chan, const char *data)
250 {
251         return waitfor_exec(chan, data, 0);
252 }
253
254 static int unload_module(void)
255 {
256         int res;
257         res = ast_unregister_application(app_silence);
258         res |= ast_unregister_application(app_noise);
259
260         return res;
261 }
262
263 static int load_module(void)
264 {
265         int res;
266
267         res = ast_register_application_xml(app_silence, waitforsilence_exec);
268         res |= ast_register_application_xml(app_noise, waitfornoise_exec);
269         return res;
270 }
271
272 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Wait For Silence");
273