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