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