2004-11-24 05:01:49 +00:00
|
|
|
/*
|
2005-09-14 20:46:50 +00:00
|
|
|
* Asterisk -- An open source telephony toolkit.
|
|
|
|
*
|
2005-01-21 07:06:25 +00:00
|
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
2004-11-24 05:01:49 +00:00
|
|
|
*
|
2005-09-14 20:46:50 +00:00
|
|
|
* WaitForSilence Application by David C. Troy <dave@popvox.com>
|
2006-09-03 20:23:41 +00:00
|
|
|
* Version 1.11 2006-06-29
|
2005-09-14 20:46:50 +00:00
|
|
|
*
|
2004-11-24 05:01:49 +00:00
|
|
|
* Mark Spencer <markster@digium.com>
|
2005-09-14 20:46:50 +00:00
|
|
|
*
|
|
|
|
* See http://www.asterisk.org for more information about
|
|
|
|
* the Asterisk project. Please do not directly contact
|
|
|
|
* any of the maintainers of this project for assistance;
|
|
|
|
* the project provides a web site, mailing lists and IRC
|
|
|
|
* channels for your use.
|
|
|
|
*
|
|
|
|
* This program is free software, distributed under the terms of
|
|
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
|
|
* at the top of the source tree.
|
|
|
|
*/
|
|
|
|
|
2005-10-24 20:12:06 +00:00
|
|
|
/*! \file
|
2004-11-24 05:01:49 +00:00
|
|
|
*
|
2005-10-24 20:12:06 +00:00
|
|
|
* \brief Wait for Silence
|
2005-11-06 15:09:47 +00:00
|
|
|
* - Waits for up to 'x' milliseconds of silence, 'y' times \n
|
|
|
|
* - WaitForSilence(500,2) will wait for 1/2 second of silence, twice \n
|
|
|
|
* - WaitForSilence(1000,1) will wait for 1 second of silence, once \n
|
2006-09-03 20:23:41 +00:00
|
|
|
* - WaitForSilence(300,3,10) will wait for 300ms of silence, 3 times, and return after 10sec \n
|
2004-11-24 05:01:49 +00:00
|
|
|
*
|
2005-12-30 21:18:06 +00:00
|
|
|
* \author David C. Troy <dave@popvox.com>
|
|
|
|
*
|
2005-11-06 15:09:47 +00:00
|
|
|
* \ingroup applications
|
2004-11-24 05:01:49 +00:00
|
|
|
*/
|
|
|
|
|
2006-06-07 18:54:56 +00:00
|
|
|
#include "asterisk.h"
|
|
|
|
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
|
2005-06-06 22:39:32 +00:00
|
|
|
#include <stdlib.h>
|
2005-11-08 04:48:00 +00:00
|
|
|
#include <stdio.h>
|
2005-06-06 22:39:32 +00:00
|
|
|
#include <string.h>
|
2005-11-08 04:48:00 +00:00
|
|
|
#include <unistd.h>
|
2005-06-06 22:39:32 +00:00
|
|
|
|
2005-04-21 06:02:45 +00:00
|
|
|
#include "asterisk/file.h"
|
|
|
|
#include "asterisk/logger.h"
|
|
|
|
#include "asterisk/channel.h"
|
|
|
|
#include "asterisk/pbx.h"
|
|
|
|
#include "asterisk/dsp.h"
|
|
|
|
#include "asterisk/module.h"
|
|
|
|
#include "asterisk/options.h"
|
2004-11-24 05:01:49 +00:00
|
|
|
|
|
|
|
static char *app = "WaitForSilence";
|
|
|
|
static char *synopsis = "Waits for a specified amount of silence";
|
2006-09-03 20:23:41 +00:00
|
|
|
static char *descrip =
|
|
|
|
" WaitForSilence(silencerequired[|iterations][|timeout]) \n"
|
|
|
|
"Wait for Silence: Waits for up to 'silencerequired' \n"
|
|
|
|
"milliseconds of silence, 'iterations' times or once if omitted.\n"
|
|
|
|
"An optional timeout specified the number of seconds to return\n"
|
|
|
|
"after, even if we do not receive the specified amount of silence.\n"
|
|
|
|
"Use 'timeout' with caution, as it may defeat the purpose of this\n"
|
|
|
|
"application, which is to wait indefinitely until silence is detected\n"
|
|
|
|
"on the line. This is particularly useful for reverse-911-type\n"
|
|
|
|
"call broadcast applications where you need to wait for an answering\n"
|
|
|
|
"machine to complete its spiel before playing a message.\n"
|
|
|
|
"The timeout parameter is specified only to avoid an infinite loop in\n"
|
|
|
|
"cases where silence is never achieved. Typically you will want to\n"
|
|
|
|
"include two or more calls to WaitForSilence when dealing with an answering\n"
|
|
|
|
"machine; first waiting for the spiel to finish, then waiting for the beep, etc.\n\n"
|
|
|
|
"Examples:\n"
|
2005-12-22 23:59:13 +00:00
|
|
|
" - WaitForSilence(500|2) will wait for 1/2 second of silence, twice\n"
|
2006-09-03 20:23:41 +00:00
|
|
|
" - WaitForSilence(1000) will wait for 1 second of silence, once\n"
|
|
|
|
" - WaitForSilence(300|3|10) will wait for 300ms silence, 3 times,\n"
|
|
|
|
" and returns after 10 sec, even if silence is not detected\n\n"
|
|
|
|
"Sets the channel variable WAITSTATUS with to one of these values:\n"
|
|
|
|
"SILENCE - if exited with silence detected\n"
|
|
|
|
"TIMEOUT - if exited without silence detected after timeout\n";
|
|
|
|
|
|
|
|
static int do_waiting(struct ast_channel *chan, int silencereqd, time_t waitstart, int timeout) {
|
2004-11-24 05:01:49 +00:00
|
|
|
struct ast_frame *f;
|
|
|
|
int dspsilence = 0;
|
2006-05-22 21:28:32 +00:00
|
|
|
static int silencethreshold = 128;
|
2004-11-24 05:01:49 +00:00
|
|
|
int rfmt = 0;
|
|
|
|
int res = 0;
|
|
|
|
struct ast_dsp *sildet; /* silence detector dsp */
|
2006-09-03 20:23:41 +00:00
|
|
|
time_t now;
|
2004-11-24 05:01:49 +00:00
|
|
|
|
|
|
|
rfmt = chan->readformat; /* Set to linear mode */
|
|
|
|
res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
|
|
|
|
if (res < 0) {
|
2006-09-03 20:23:41 +00:00
|
|
|
ast_log(LOG_WARNING, "Unable to set channel to linear mode, giving up\n");
|
2004-11-24 05:01:49 +00:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
sildet = ast_dsp_new(); /* Create the silence detector */
|
|
|
|
if (!sildet) {
|
|
|
|
ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
ast_dsp_set_threshold(sildet, silencethreshold);
|
|
|
|
|
|
|
|
/* Await silence... */
|
|
|
|
f = NULL;
|
|
|
|
for(;;) {
|
2006-09-03 20:23:41 +00:00
|
|
|
/* Start with no silence received */
|
|
|
|
dspsilence = 0;
|
|
|
|
|
|
|
|
res = ast_waitfor(chan, silencereqd);
|
2004-11-24 05:01:49 +00:00
|
|
|
|
2006-09-03 20:23:41 +00:00
|
|
|
/* Must have gotten a hangup; let's exit */
|
|
|
|
if (res <= 0) {
|
2004-11-24 05:01:49 +00:00
|
|
|
f = NULL;
|
|
|
|
break;
|
|
|
|
}
|
2006-09-03 20:23:41 +00:00
|
|
|
|
|
|
|
/* We waited and got no frame; sounds like digital silence or a muted digital channel */
|
|
|
|
if (!res) {
|
|
|
|
dspsilence = silencereqd;
|
|
|
|
} else {
|
|
|
|
/* Looks like we did get a frame, so let's check it out */
|
|
|
|
f = ast_read(chan);
|
|
|
|
if (!f)
|
2005-06-09 21:04:16 +00:00
|
|
|
break;
|
2006-09-03 20:23:41 +00:00
|
|
|
if (f && f->frametype == AST_FRAME_VOICE) {
|
|
|
|
ast_dsp_silence(sildet, f, &dspsilence);
|
2005-06-09 21:04:16 +00:00
|
|
|
ast_frfree(f);
|
2004-11-24 05:01:49 +00:00
|
|
|
}
|
|
|
|
}
|
2006-09-03 20:23:41 +00:00
|
|
|
|
|
|
|
if (option_verbose > 6)
|
|
|
|
ast_verbose(VERBOSE_PREFIX_3 "Got %dms silence< %dms required\n", dspsilence, silencereqd);
|
|
|
|
|
|
|
|
if (dspsilence >= silencereqd) {
|
|
|
|
if (option_verbose > 2)
|
|
|
|
ast_verbose(VERBOSE_PREFIX_3 "Exiting with %dms silence >= %dms required\n", dspsilence, silencereqd);
|
|
|
|
/* Ended happily with silence */
|
|
|
|
res = 1;
|
|
|
|
pbx_builtin_setvar_helper(chan, "WAITSTATUS", "SILENCE");
|
2007-06-14 19:39:12 +00:00
|
|
|
ast_debug(1, "WAITSTATUS was set to SILENCE\n");
|
2006-09-03 20:23:41 +00:00
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( timeout && (difftime(time(&now),waitstart) >= timeout) ) {
|
|
|
|
pbx_builtin_setvar_helper(chan, "WAITSTATUS", "TIMEOUT");
|
2007-06-14 19:39:12 +00:00
|
|
|
ast_debug(1, "WAITSTATUS was set to TIMEOUT\n");
|
2006-09-03 20:23:41 +00:00
|
|
|
res = 0;
|
|
|
|
break;
|
|
|
|
}
|
2004-11-24 05:01:49 +00:00
|
|
|
}
|
2006-09-03 20:23:41 +00:00
|
|
|
|
|
|
|
|
2005-03-12 06:00:05 +00:00
|
|
|
if (rfmt && ast_set_read_format(chan, rfmt)) {
|
|
|
|
ast_log(LOG_WARNING, "Unable to restore format %s to channel '%s'\n", ast_getformatname(rfmt), chan->name);
|
|
|
|
}
|
2004-11-24 05:01:49 +00:00
|
|
|
ast_dsp_free(sildet);
|
2006-09-03 20:23:41 +00:00
|
|
|
return res;
|
2004-11-24 05:01:49 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static int waitforsilence_exec(struct ast_channel *chan, void *data)
|
|
|
|
{
|
2005-03-12 06:00:05 +00:00
|
|
|
int res = 1;
|
2006-09-03 20:23:41 +00:00
|
|
|
int silencereqd = 1000;
|
|
|
|
int timeout = 0;
|
2004-11-24 05:01:49 +00:00
|
|
|
int iterations = 1, i;
|
2006-09-03 20:23:41 +00:00
|
|
|
time_t waitstart;
|
2004-11-24 05:01:49 +00:00
|
|
|
|
|
|
|
res = ast_answer(chan); /* Answer the channel */
|
|
|
|
|
2006-09-03 20:23:41 +00:00
|
|
|
if (!data || ( (sscanf(data, "%d|%d|%d", &silencereqd, &iterations, &timeout) != 3) &&
|
|
|
|
(sscanf(data, "%d|%d", &silencereqd, &iterations) != 2) &&
|
|
|
|
(sscanf(data, "%d", &silencereqd) != 1) ) ) {
|
|
|
|
ast_log(LOG_WARNING, "Using default value of 1000ms, 1 iteration, no timeout\n");
|
2004-11-24 05:01:49 +00:00
|
|
|
}
|
|
|
|
|
2005-03-12 06:00:05 +00:00
|
|
|
if (option_verbose > 2)
|
2006-09-03 20:23:41 +00:00
|
|
|
ast_verbose(VERBOSE_PREFIX_3 "Waiting %d time(s) for %d ms silence with %d timeout\n", iterations, silencereqd, timeout);
|
|
|
|
|
|
|
|
time(&waitstart);
|
2004-11-24 05:01:49 +00:00
|
|
|
res = 1;
|
2005-03-12 06:00:05 +00:00
|
|
|
for (i=0; (i<iterations) && (res == 1); i++) {
|
2006-09-03 20:23:41 +00:00
|
|
|
res = do_waiting(chan, silencereqd, waitstart, timeout);
|
2004-11-24 05:01:49 +00:00
|
|
|
}
|
|
|
|
if (res > 0)
|
|
|
|
res = 0;
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2006-09-03 20:23:41 +00:00
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
static int unload_module(void)
|
2004-11-24 05:01:49 +00:00
|
|
|
{
|
2005-10-18 22:52:21 +00:00
|
|
|
int res;
|
|
|
|
|
|
|
|
res = ast_unregister_application(app);
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
ast_module_user_hangup_all();
|
2005-10-18 22:52:21 +00:00
|
|
|
|
|
|
|
return res;
|
2004-11-24 05:01:49 +00:00
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
static int load_module(void)
|
2004-11-24 05:01:49 +00:00
|
|
|
{
|
|
|
|
return ast_register_application(app, waitforsilence_exec, synopsis, descrip);
|
|
|
|
}
|
|
|
|
|
2006-08-21 02:11:39 +00:00
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Wait For Silence");
|
2006-09-03 20:23:41 +00:00
|
|
|
|