265d4639e08a68beeae3ba9dce8a288ac77dbf1a
[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  * \ingroup applications
33  */
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/dsp.h"
44 #include "asterisk/module.h"
45 #include "asterisk/options.h"
46
47 static char *app = "WaitForSilence";
48 static char *synopsis = "Waits for a specified amount of silence";
49 static char *descrip =
50 "  WaitForSilence(silencerequired[,iterations][,timeout]):\n"
51 "Wait for Silence: Waits for up to 'silencerequired' \n"
52 "milliseconds of silence, 'iterations' times or once if omitted.\n"
53 "An optional timeout specified the number of seconds to return\n"
54 "after, even if we do not receive the specified amount of silence.\n"
55 "Use 'timeout' with caution, as it may defeat the purpose of this\n"
56 "application, which is to wait indefinitely until silence is detected\n"
57 "on the line.  This is particularly useful for reverse-911-type\n"
58 "call broadcast applications where you need to wait for an answering\n"
59 "machine to complete its spiel before playing a message.\n"
60 "The timeout parameter is specified only to avoid an infinite loop in\n"
61 "cases where silence is never achieved.  Typically you will want to\n"
62 "include two or more calls to WaitForSilence when dealing with an answering\n"
63 "machine; first waiting for the spiel to finish, then waiting for the beep, etc.\n\n"
64   "Examples:\n"
65 "  - WaitForSilence(500,2) will wait for 1/2 second of silence, twice\n"
66 "  - WaitForSilence(1000) will wait for 1 second of silence, once\n"
67 "  - WaitForSilence(300,3,10) will wait for 300ms silence, 3 times,\n"
68 "     and returns after 10 sec, even if silence is not detected\n\n"
69 "Sets the channel variable WAITSTATUS with to one of these values:\n"
70 "SILENCE - if exited with silence detected\n"
71 "TIMEOUT - if exited without silence detected after timeout\n";
72
73 static int do_waiting(struct ast_channel *chan, int silencereqd, time_t waitstart, int timeout) {
74         struct ast_frame *f;
75         int dspsilence = 0;
76         static int silencethreshold = 128;
77         int rfmt = 0;
78         int res = 0;
79         struct ast_dsp *sildet;  /* silence detector dsp */
80         time_t now;
81
82         rfmt = chan->readformat; /* Set to linear mode */
83         res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
84         if (res < 0) {
85                 ast_log(LOG_WARNING, "Unable to set channel to linear mode, giving up\n");
86                 return -1;
87         }
88
89         sildet = ast_dsp_new(); /* Create the silence detector */
90         if (!sildet) {
91                 ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
92                 return -1;
93         }
94         ast_dsp_set_threshold(sildet, silencethreshold);
95
96         /* Await silence... */
97         f = NULL;
98         for(;;) {
99                 /* Start with no silence received */
100                 dspsilence = 0;
101
102                 res = ast_waitfor(chan, silencereqd);
103
104                 /* Must have gotten a hangup; let's exit */
105                 if (res <= 0) {
106                         f = NULL;
107                         break;
108                 }
109                 
110                 /* We waited and got no frame; sounds like digital silence or a muted digital channel */
111                 if (!res) {
112                         dspsilence = silencereqd;
113                 } else {
114                         /* Looks like we did get a frame, so let's check it out */
115                         f = ast_read(chan);
116                         if (!f)
117                                 break;
118                         if (f && f->frametype == AST_FRAME_VOICE) {
119                                 ast_dsp_silence(sildet, f, &dspsilence);
120                                 ast_frfree(f);
121                         }
122                 }
123
124                 ast_verb(3, "Got %dms silence< %dms required\n", dspsilence, silencereqd);
125
126                 if (dspsilence >= silencereqd) {
127                         ast_verb(3, "Exiting with %dms silence >= %dms required\n", dspsilence, silencereqd);
128                         /* Ended happily with silence */
129                         res = 1;
130                         pbx_builtin_setvar_helper(chan, "WAITSTATUS", "SILENCE");
131                         ast_debug(1, "WAITSTATUS was set to SILENCE\n");
132                         break;
133                 }
134
135                 if ( timeout && (difftime(time(&now),waitstart) >= timeout) ) {
136                         pbx_builtin_setvar_helper(chan, "WAITSTATUS", "TIMEOUT");
137                         ast_debug(1, "WAITSTATUS was set to TIMEOUT\n");
138                         res = 0;
139                         break;
140                 }
141         }
142
143
144         if (rfmt && ast_set_read_format(chan, rfmt)) {
145                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
146         }
147         ast_dsp_free(sildet);
148         return res;
149 }
150
151 static int waitforsilence_exec(struct ast_channel *chan, void *data)
152 {
153         int res = 1;
154         int silencereqd = 1000;
155         int timeout = 0;
156         int iterations = 1, i;
157         time_t waitstart;
158
159         res = ast_answer(chan); /* Answer the channel */
160
161         if (!data || ( (sscanf(data, "%d,%d,%d", &silencereqd, &iterations, &timeout) != 3) &&
162                 (sscanf(data, "%d|%d", &silencereqd, &iterations) != 2) &&
163                 (sscanf(data, "%d", &silencereqd) != 1) ) ) {
164                 ast_log(LOG_WARNING, "Using default value of 1000ms, 1 iteration, no timeout\n");
165         }
166
167         ast_verb(3, "Waiting %d time(s) for %d ms silence with %d timeout\n", iterations, silencereqd, timeout);
168
169         time(&waitstart);
170         res = 1;
171         for (i=0; (i<iterations) && (res == 1); i++) {
172                 res = do_waiting(chan, silencereqd, waitstart, timeout);
173         }
174         if (res > 0)
175                 res = 0;
176         return res;
177 }
178
179
180 static int unload_module(void)
181 {
182         return ast_unregister_application(app);
183 }
184
185 static int load_module(void)
186 {
187         return ast_register_application(app, waitforsilence_exec, synopsis, descrip);
188 }
189
190 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Wait For Silence");
191