use double-quotes instead of angle-brackets for non-system include files (bug #4058)
[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 "asterisk/file.h"
21 #include "asterisk/logger.h"
22 #include "asterisk/channel.h"
23 #include "asterisk/pbx.h"
24 #include "asterisk/dsp.h"
25 #include "asterisk/module.h"
26 #include "asterisk/options.h"
27 #include <stdlib.h>
28 #include <unistd.h>
29 #include <string.h>
30 #include <pthread.h>
31
32 static char *tdesc = "Wait For Silence";
33 static char *app = "WaitForSilence";
34 static char *synopsis = "Waits for a specified amount of silence";
35 static char *descrip = 
36 "  WaitForSilence(x[|y]) Wait for Silence: Waits for up to 'x' \n"
37 "milliseconds of silence, 'y' times or 1 if omitted\n"
38 "Examples:\n"
39 "  - WaitForSilence(500,2) will wait for 1/2 second of silence, twice\n"
40 "  - WaitForSilence(1000) will wait for 1 second of silence, once\n";
41
42 STANDARD_LOCAL_USER;
43
44 LOCAL_USER_DECL;
45
46 static int do_waiting(struct ast_channel *chan, int maxsilence) {
47
48         struct ast_frame *f;
49         int totalsilence = 0;
50         int dspsilence = 0;
51         int gotsilence = 0; 
52         static int silencethreshold = 64;
53         int rfmt = 0;
54         int res = 0;
55         struct ast_dsp *sildet;  /* silence detector dsp */
56
57         rfmt = chan->readformat; /* Set to linear mode */
58         res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
59         if (res < 0) {
60                 ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
61                 return -1;
62         }
63
64         sildet = ast_dsp_new(); /* Create the silence detector */
65         if (!sildet) {
66                 ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
67                 return -1;
68         }
69         ast_dsp_set_threshold(sildet, silencethreshold);
70
71         /* Await silence... */
72         f = NULL;
73         for(;;) {
74                 res = ast_waitfor(chan, 2000);
75                 if (!res) {
76                         ast_log(LOG_WARNING, "One waitfor failed, trying another\n");
77                         /* Try one more time in case of masq */
78                         res = ast_waitfor(chan, 2000);
79                         if (!res) {
80                                 ast_log(LOG_WARNING, "No audio available on %s??\n", chan->name);
81                                 res = -1;
82                         }
83                 }
84
85                 if (res < 0) {
86                         f = NULL;
87                         break;
88                 }
89                 f = ast_read(chan);
90                 if (!f)
91                         break;
92                 if (f->frametype == AST_FRAME_VOICE) {
93                         dspsilence = 0;
94                         ast_dsp_silence(sildet, f, &dspsilence);
95                         if (dspsilence)
96                                 totalsilence = dspsilence;
97                         else
98                                 totalsilence = 0;
99
100                         if (totalsilence >= maxsilence) {
101                                 if (option_verbose > 2)
102                                         ast_verbose(VERBOSE_PREFIX_3 "Exiting with %dms silence > %dms required\n", totalsilence, maxsilence);
103                                 /* Ended happily with silence */
104                                 ast_frfree(f);
105                                 gotsilence = 1;
106                                 break;
107                         }
108                 }
109                 ast_frfree(f);
110         }
111         if (rfmt && ast_set_read_format(chan, rfmt)) {
112                 ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
113         }
114         ast_dsp_free(sildet);
115         return gotsilence;
116 }
117
118 static int waitforsilence_exec(struct ast_channel *chan, void *data)
119 {
120         int res = 1;
121         struct localuser *u;
122         int maxsilence = 1000;
123         int iterations = 1, i;
124
125         res = ast_answer(chan); /* Answer the channel */
126
127         if (!data || ((sscanf(data, "%d|%d", &maxsilence, &iterations) != 2) &&
128                 (sscanf(data, "%d", &maxsilence) != 1))) {
129                 ast_log(LOG_WARNING, "Using default value of 1000ms, 1 iteration\n");
130         }
131
132         if (option_verbose > 2)
133                 ast_verbose(VERBOSE_PREFIX_3 "Waiting %d time(s) for %d ms silence\n", iterations, maxsilence);
134         LOCAL_USER_ADD(u);
135         res = 1;
136         for (i=0; (i<iterations) && (res == 1); i++) {
137                 res = do_waiting(chan, maxsilence);
138         }
139         LOCAL_USER_REMOVE(u);
140         if (res > 0)
141                 res = 0;
142         return res;
143 }
144
145 int unload_module(void)
146 {
147         STANDARD_HANGUP_LOCALUSERS;
148         return ast_unregister_application(app);
149 }
150
151 int load_module(void)
152 {
153         return ast_register_application(app, waitforsilence_exec, synopsis, descrip);
154 }
155
156 char *description(void)
157 {
158         return tdesc;
159 }
160
161 int usecount(void)
162 {
163         int res;
164         STANDARD_USECOUNT(res);
165         return res;
166 }
167
168 char *key()
169 {
170         return ASTERISK_GPL_KEY;
171 }
172