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