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