Tone detection module. More...

#include "asterisk.h"
#include <math.h>
#include "asterisk/module.h"
#include "asterisk/frame.h"
#include "asterisk/format_cache.h"
#include "asterisk/channel.h"
#include "asterisk/dsp.h"
#include "asterisk/pbx.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/audiohook.h"
#include "asterisk/app.h"
#include "asterisk/indications.h"
#include "asterisk/conversions.h"

Include dependency graph for res_tonedetect.c:

Go to the source code of this file.

Data Structures
struct	detect_information

Enumerations
enum	{ OPT_ARG_DECIBEL , OPT_ARG_GOTO_RX , OPT_ARG_GOTO_TX , OPT_ARG_HITS_REQ , OPT_ARG_ARRAY_SIZE }

enum	{ OPT_APP_DECIBEL = (1 << 0) , OPT_APP_SQUELCH = (1 << 1) }

enum	{ OPT_APP_ARG_DECIBEL , OPT_APP_ARG_ARRAY_SIZE }

enum	td_opts { OPT_TX = (1 << 1) , OPT_RX = (1 << 2) , OPT_END_FILTER = (1 << 3) , OPT_GOTO_RX = (1 << 4) , OPT_GOTO_TX = (1 << 5) , OPT_DECIBEL = (1 << 6) , OPT_SQUELCH = (1 << 7) , OPT_HITS_REQ = (1 << 8) , OPT_SIT = (1 << 9) , OPT_BUSY = (1 << 10) , OPT_DIALTONE = (1 << 11) , OPT_RINGING = (1 << 12) }

Functions
	AST_MODULE_INFO_STANDARD_EXTENDED (ASTERISK_GPL_KEY, "Tone detection module")

static void	destroy_callback (void *data)

static int	detect_callback (struct ast_audiohook audiohook, struct ast_channel chan, struct ast_frame *frame, enum ast_audiohook_direction direction)

static int	detect_read (struct ast_channel chan, const char cmd, char data, char buffer, size_t buflen)

static int	detect_write (struct ast_channel chan, const char cmd, char data, const char value)

static int	freq_parser (char freqs, int freq1, int *freq2)

static char *	goto_parser (struct ast_channel chan, char loc)

static int	load_module (void)

static int	parse_signal_features (struct ast_flags *flags)

static int	remove_detect (struct ast_channel *chan)

static int	scan_exec (struct ast_channel chan, const char data)

static int	unload_module (void)

static int	wait_exec (struct ast_channel chan, const char data)

Variables
static const struct ast_datastore_info	detect_datastore

static struct ast_custom_function	detect_function

static char *	scanapp = "ToneScan"

static const struct ast_app_option	td_opts [128] = { [ 'a' ] = { .flag = OPT_SIT }, [ 'b' ] = { .flag = OPT_BUSY }, [ 'c' ] = { .flag = OPT_DIALTONE }, [ 'd' ] = { .flag = OPT_DECIBEL , .arg_index = OPT_ARG_DECIBEL + 1 }, [ 'g' ] = { .flag = OPT_GOTO_RX , .arg_index = OPT_ARG_GOTO_RX + 1 }, [ 'h' ] = { .flag = OPT_GOTO_TX , .arg_index = OPT_ARG_GOTO_TX + 1 }, [ 'n' ] = { .flag = OPT_HITS_REQ , .arg_index = OPT_ARG_HITS_REQ + 1 }, [ 'p' ] = { .flag = OPT_RINGING }, [ 's' ] = { .flag = OPT_SQUELCH }, [ 't' ] = { .flag = OPT_TX }, [ 'r' ] = { .flag = OPT_RX }, [ 'x' ] = { .flag = OPT_END_FILTER }, }

static const struct ast_app_option	wait_exec_options [128] = { [ 'd' ] = { .flag = OPT_APP_DECIBEL , .arg_index = OPT_APP_ARG_DECIBEL + 1 }, [ 's' ] = { .flag = OPT_APP_SQUELCH }, }

static char *	waitapp = "WaitForTone"

Detailed Description

Tone detection module.

Author: Naveen Albert aster.nosp@m.isk@.nosp@m.phrea.nosp@m.knet.nosp@m..org

Definition in file res_tonedetect.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
OPT_ARG_DECIBEL
OPT_ARG_GOTO_RX
OPT_ARG_GOTO_TX
OPT_ARG_HITS_REQ
OPT_ARG_ARRAY_SIZE

Definition at line 308 of file res_tonedetect.c.

     {
    OPT_ARG_DECIBEL,
    OPT_ARG_GOTO_RX,
    OPT_ARG_GOTO_TX,
    OPT_ARG_HITS_REQ,
    /* note: this entry _MUST_ be the last one in the enum */
    OPT_ARG_ARRAY_SIZE,
};

◆ anonymous enum

anonymous enum

Enumerator
OPT_APP_DECIBEL
OPT_APP_SQUELCH

Definition at line 746 of file res_tonedetect.c.

     {
    OPT_APP_DECIBEL =  (1 << 0),
    OPT_APP_SQUELCH =  (1 << 1),
};

◆ anonymous enum

anonymous enum

Enumerator
OPT_APP_ARG_DECIBEL
OPT_APP_ARG_ARRAY_SIZE

Definition at line 751 of file res_tonedetect.c.

     {
    OPT_APP_ARG_DECIBEL,
    /* note: this entry _MUST_ be the last one in the enum */
    OPT_APP_ARG_ARRAY_SIZE,
};

◆ td_opts

enum td_opts

Enumerator
OPT_TX
OPT_RX
OPT_END_FILTER
OPT_GOTO_RX
OPT_GOTO_TX
OPT_DECIBEL
OPT_SQUELCH
OPT_HITS_REQ
OPT_SIT
OPT_BUSY
OPT_DIALTONE
OPT_RINGING

Definition at line 293 of file res_tonedetect.c.

             {
    OPT_TX = (1 << 1),
    OPT_RX = (1 << 2),
    OPT_END_FILTER = (1 << 3),
    OPT_GOTO_RX = (1 << 4),
    OPT_GOTO_TX = (1 << 5),
    OPT_DECIBEL = (1 << 6),
    OPT_SQUELCH = (1 << 7),
    OPT_HITS_REQ = (1 << 8),
    OPT_SIT = (1 << 9),
    OPT_BUSY = (1 << 10),
    OPT_DIALTONE = (1 << 11),
    OPT_RINGING = (1 << 12),
};

Function Documentation

◆ AST_MODULE_INFO_STANDARD_EXTENDED()

AST_MODULE_INFO_STANDARD_EXTENDED	(	ASTERISK_GPL_KEY	,
		"Tone detection module"
	)

◆ destroy_callback()

static void destroy_callback ( void * data )

static

Definition at line 332 of file res_tonedetect.c.

{
    struct detect_information *di = data;
    ast_dsp_free(di->dsp);
    if (di->gotorx) {
        ast_free(di->gotorx);
    }
    if (di->gototx) {
        ast_free(di->gototx);
    }
    ast_audiohook_lock(&di->audiohook);
    ast_audiohook_detach(&di->audiohook);
    ast_audiohook_unlock(&di->audiohook);
    ast_audiohook_destroy(&di->audiohook);
    ast_free(di);
    return;
}

References ast_audiohook_destroy(), ast_audiohook_detach(), ast_audiohook_lock, ast_audiohook_unlock, ast_dsp_free(), ast_free, and di.

◆ detect_callback()

static int detect_callback	(	struct ast_audiohook *	audiohook,
		struct ast_channel *	chan,
		struct ast_frame *	frame,
		enum ast_audiohook_direction	direction
	)

static

Definition at line 355 of file res_tonedetect.c.

{
    struct ast_datastore *datastore = NULL;
    struct detect_information *di = NULL;
    struct stasis_message *message;
    int match = 0;
 
    /* If the audiohook is stopping it means the channel is shutting down.... but we let the datastore destroy take care of it */
    if (audiohook->status == AST_AUDIOHOOK_STATUS_DONE) {
        return 0;
    }
 
    /* Grab datastore which contains our gain information */
    if (!(datastore = ast_channel_datastore_find(chan, &detect_datastore, NULL))) {
        return 0;
    }
 
    di = datastore->data;
 
    if (!frame || frame->frametype != AST_FRAME_VOICE) {
        return 0;
    }
 
    if (!(direction == AST_AUDIOHOOK_DIRECTION_READ ? di->rx : di->tx)) {
        return 0;
    }
 
    /* ast_dsp_process may free the frame and return a new one */
    frame = ast_frdup(frame);
    frame = ast_dsp_process(chan, di->dsp, frame);
    if (frame->frametype == AST_FRAME_DTMF) {
        char result = frame->subclass.integer;
        if (result == 'q') {
            int now;
            match = 1;
            if (direction == AST_AUDIOHOOK_DIRECTION_READ) {
                di->rxcount = di->rxcount + 1;
                now = di->rxcount;
            } else {
                di->txcount = di->txcount + 1;
                now = di->txcount;
            }
            ast_debug(1, "TONE_DETECT just got a hit (#%d in this direction, waiting for %d total)\n", now, di->hitsrequired);
            if (now >= di->hitsrequired) {
                message = ast_channel_blob_create_from_cache(ast_channel_uniqueid(chan), ast_channel_tone_detect(), NULL);
 
                if (!message) {
                    ast_log(LOG_ERROR, "Unable to publish tone detected event for ARI on channel '%s'", ast_channel_name(chan));
                    return 1;
                } else {
                    stasis_publish(ast_channel_topic(chan), message);
                    ao2_ref(message, -1);
                }
 
                if (direction == AST_AUDIOHOOK_DIRECTION_READ && di->gotorx) {
                    ast_async_parseable_goto(chan, di->gotorx);
                } else if (di->gototx) {
                    ast_async_parseable_goto(chan, di->gototx);
                }
            }
        }
    }
    if (di->signalfeatures && !match) { /* skip unless there are call progress/signal options */
        int tstate, tcount;
        tcount = ast_dsp_get_tcount(di->dsp);
        tstate = ast_dsp_get_tstate(di->dsp);
        if (tstate > 0) {
            ast_debug(3, "tcount: %d, tstate: %d\n", tcount, tstate);
            switch (tstate) {
            case DSP_TONE_STATE_RINGING:
                if (di->signalfeatures & DSP_PROGRESS_RINGING) {
                    ast_debug(1, "Detected ringing on %s in %s direction\n", ast_channel_name(chan),
                        direction == AST_AUDIOHOOK_DIRECTION_READ ? "read" : "write");
                    match = 1;
                }
                break;
            case DSP_TONE_STATE_DIALTONE:
                if (di->signalfeatures & DSP_FEATURE_WAITDIALTONE) {
                    ast_debug(1, "Detected dial tone on %s in %s direction\n", ast_channel_name(chan),
                        direction == AST_AUDIOHOOK_DIRECTION_READ ? "read" : "write");
                    match = 1;
                }
                break;
            case DSP_TONE_STATE_BUSY:
                if (di->signalfeatures & DSP_PROGRESS_BUSY) {
                    ast_debug(1, "Detected busy tone on %s in %s direction\n", ast_channel_name(chan),
                        direction == AST_AUDIOHOOK_DIRECTION_READ ? "read" : "write");
                    match = 1;
                }
                break;
            case DSP_TONE_STATE_SPECIAL3:
                if (di->signalfeatures & DSP_PROGRESS_CONGESTION) {
                    ast_debug(1, "Detected SIT on %s in %s direction\n", ast_channel_name(chan),
                        direction == AST_AUDIOHOOK_DIRECTION_READ ? "read" : "write");
                    match = 1;
                }
                break;
            default: /* ignore */
                break;
            }
            if (match) {
                if (direction == AST_AUDIOHOOK_DIRECTION_READ && di->gotorx) {
                    ast_async_parseable_goto(chan, di->gotorx);
                } else if (di->gototx) {
                    ast_async_parseable_goto(chan, di->gototx);
                } else {
                    ast_debug(3, "Detected call progress signal in %s direction, but don't know where to go\n",
                        direction == AST_AUDIOHOOK_DIRECTION_READ ? "read" : "write");
                }
            }
        }
    }
    /* this could be the duplicated frame or a new one, doesn't matter */
    ast_frfree(frame);
    return 0;
}

References ao2_ref, ast_async_parseable_goto(), AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_STATUS_DONE, ast_channel_blob_create_from_cache(), ast_channel_datastore_find(), ast_channel_name(), ast_channel_tone_detect(), ast_channel_topic(), ast_channel_uniqueid(), ast_debug, ast_dsp_get_tcount(), ast_dsp_get_tstate(), ast_dsp_process(), AST_FRAME_DTMF, AST_FRAME_VOICE, ast_frdup, ast_frfree, ast_log, ast_datastore::data, detect_datastore, di, DSP_FEATURE_WAITDIALTONE, DSP_PROGRESS_BUSY, DSP_PROGRESS_CONGESTION, DSP_PROGRESS_RINGING, DSP_TONE_STATE_BUSY, DSP_TONE_STATE_DIALTONE, DSP_TONE_STATE_RINGING, DSP_TONE_STATE_SPECIAL3, ast_frame::frametype, ast_frame_subclass::integer, LOG_ERROR, match(), NULL, result, stasis_publish(), ast_audiohook::status, and ast_frame::subclass.

Referenced by detect_write().

◆ detect_read()

static int detect_read	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		char *	buffer,
		size_t	buflen
	)

static

Definition at line 575 of file res_tonedetect.c.

{
    struct ast_datastore *datastore = NULL;
    struct detect_information *di = NULL;
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
        return -1;
    }
 
    ast_channel_lock(chan);
    if (!(datastore = ast_channel_datastore_find(chan, &detect_datastore, NULL))) {
        ast_channel_unlock(chan);
        return -1; /* function not initiated yet, so nothing to read */
    } else {
        ast_channel_unlock(chan);
        di = datastore->data;
    }
 
    if (strchr(data, 't')) {
        snprintf(buffer, buflen, "%d", di->txcount);
    } else if (strchr(data, 'r')) {
        snprintf(buffer, buflen, "%d", di->rxcount);
    } else {
        ast_log(LOG_WARNING, "Invalid direction: %s\n", data);
    }
 
    return 0;
}

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_log, ast_datastore::data, detect_datastore, di, LOG_WARNING, and NULL.

◆ detect_write()

static int detect_write	(	struct ast_channel *	chan,
		const char *	cmd,
		char *	data,
		const char *	value
	)

static

Definition at line 625 of file res_tonedetect.c.

{
    char *parse;
    struct ast_datastore *datastore = NULL;
    struct detect_information *di = NULL;
    struct ast_flags flags = { 0 };
    char *opt_args[OPT_ARG_ARRAY_SIZE];
    struct ast_dsp *dsp;
    int freq1 = 0, freq2 = 0, duration = 500, db = 16, squelch = 0, hitsrequired = 1;
    int signalfeatures = 0;
 
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(freqs);
        AST_APP_ARG(duration);
        AST_APP_ARG(options);
    );
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
        return -1;
    }
    parse = ast_strdupa(data);
    AST_STANDARD_APP_ARGS(args, parse);
 
    if (!ast_strlen_zero(args.options)) {
        ast_app_parse_options(td_opts, &flags, opt_args, args.options);
    }
    if (ast_test_flag(&flags, OPT_END_FILTER)) {
        return remove_detect(chan);
    }
    if (freq_parser(args.freqs, &freq1, &freq2)) {
        return -1;
    }
    if (!ast_strlen_zero(args.duration) && (ast_str_to_int(args.duration, &duration) || duration < 1)) {
        ast_log(LOG_WARNING, "Invalid duration: %s\n", args.duration);
        return -1;
    }
    if (ast_test_flag(&flags, OPT_HITS_REQ) && !ast_strlen_zero(opt_args[OPT_ARG_HITS_REQ])) {
        if ((ast_str_to_int(opt_args[OPT_ARG_HITS_REQ], &hitsrequired) || hitsrequired < 1)) {
            ast_log(LOG_WARNING, "Invalid number hits required: %s\n", opt_args[OPT_ARG_HITS_REQ]);
            return -1;
        }
    }
    if (ast_test_flag(&flags, OPT_DECIBEL) && !ast_strlen_zero(opt_args[OPT_ARG_DECIBEL])) {
        if ((ast_str_to_int(opt_args[OPT_ARG_DECIBEL], &db) || db < 1)) {
            ast_log(LOG_WARNING, "Invalid decibel level: %s\n", opt_args[OPT_ARG_DECIBEL]);
            return -1;
        }
    }
    signalfeatures = parse_signal_features(&flags);
 
    ast_channel_lock(chan);
    if (!(datastore = ast_channel_datastore_find(chan, &detect_datastore, NULL))) {
        if (!(datastore = ast_datastore_alloc(&detect_datastore, NULL))) {
            ast_channel_unlock(chan);
            return 0;
        }
        if (!(di = ast_calloc(1, sizeof(*di)))) {
            ast_datastore_free(datastore);
            ast_channel_unlock(chan);
            return 0;
        }
        ast_audiohook_init(&di->audiohook, AST_AUDIOHOOK_TYPE_MANIPULATE, "Tone Detector", AST_AUDIOHOOK_MANIPULATE_ALL_RATES);
        di->audiohook.manipulate_callback = detect_callback;
        if (!(dsp = ast_dsp_new())) {
            ast_datastore_free(datastore);
            ast_channel_unlock(chan);
            ast_log(LOG_WARNING, "Unable to allocate DSP!\n");
            return -1;
        }
        di->signalfeatures = signalfeatures; /* we're not including freq detect */
        if (freq1 > 0) {
            signalfeatures |= DSP_FEATURE_FREQ_DETECT;
            ast_dsp_set_freqmode(dsp, freq1, duration, db, squelch);
        }
        ast_dsp_set_features(dsp, signalfeatures);
        di->dsp = dsp;
        di->txcount = 0;
        di->rxcount = 0;
        ast_debug(1, "Keeping our ears open for %s Hz, %d db\n", args.freqs, db);
        datastore->data = di;
        ast_channel_datastore_add(chan, datastore);
        ast_audiohook_attach(chan, &di->audiohook);
    } else {
        di = datastore->data;
        dsp = di->dsp;
        di->signalfeatures = signalfeatures; /* we're not including freq detect */
        if (freq1 > 0) {
            signalfeatures |= DSP_FEATURE_FREQ_DETECT;
            ast_dsp_set_freqmode(dsp, freq1, duration, db, squelch);
        }
        ast_dsp_set_features(dsp, signalfeatures);
    }
    di->duration = duration;
    di->gotorx = NULL;
    di->gototx = NULL;
    /* resolve gotos now, in case a full context,exten,pri wasn't specified */
    if (ast_test_flag(&flags, OPT_GOTO_RX) && !ast_strlen_zero(opt_args[OPT_ARG_GOTO_RX])) {
        di->gotorx = goto_parser(chan, opt_args[OPT_ARG_GOTO_RX]);
    }
    if (ast_test_flag(&flags, OPT_GOTO_TX) && !ast_strlen_zero(opt_args[OPT_ARG_GOTO_TX])) {
        di->gototx = goto_parser(chan, opt_args[OPT_ARG_GOTO_TX]);
    }
    di->db = db;
    di->hitsrequired = hitsrequired;
    di->squelch = ast_test_flag(&flags, OPT_SQUELCH);
    di->tx = 1;
    di->rx = 1;
    if (ast_strlen_zero(args.options) || ast_test_flag(&flags, OPT_TX)) {
        di->tx = 1;
        di->rx = 0;
    }
    if (ast_strlen_zero(args.options) || ast_test_flag(&flags, OPT_RX)) {
        di->rx = 1;
        di->tx = 0;
    }
    ast_channel_unlock(chan);
 
    return 0;
}

References args, AST_APP_ARG, ast_app_parse_options(), ast_audiohook_attach(), ast_audiohook_init(), AST_AUDIOHOOK_MANIPULATE_ALL_RATES, AST_AUDIOHOOK_TYPE_MANIPULATE, ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), ast_debug, AST_DECLARE_APP_ARGS, ast_dsp_new(), ast_dsp_set_features(), ast_dsp_set_freqmode(), ast_log, AST_STANDARD_APP_ARGS, ast_str_to_int(), ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_datastore::data, db, detect_callback(), detect_datastore, di, DSP_FEATURE_FREQ_DETECT, ast_flags::flags, freq_parser(), ast_dsp::freqs, goto_parser(), LOG_WARNING, NULL, OPT_ARG_ARRAY_SIZE, OPT_ARG_DECIBEL, OPT_ARG_GOTO_RX, OPT_ARG_GOTO_TX, OPT_ARG_HITS_REQ, OPT_DECIBEL, OPT_END_FILTER, OPT_GOTO_RX, OPT_GOTO_TX, OPT_HITS_REQ, OPT_RX, OPT_SQUELCH, OPT_TX, options, parse_signal_features(), and remove_detect().

◆ freq_parser()

static int freq_parser	(	char *	freqs,
		int *	freq1,
		int *	freq2
	)

static

Definition at line 501 of file res_tonedetect.c.

                                                            {
    char *f1, *f2, *f3;
    if (ast_strlen_zero(freqs)) {
        ast_log(LOG_ERROR, "No frequency specified\n");
        return -1;
    }
    f3 = ast_strdupa(freqs);
    f1 = strsep(&f3, "+");
    f2 = strsep(&f3, "+");
    if (!ast_strlen_zero(f3)) {
        ast_log(LOG_WARNING, "Only up to 2 frequencies may be specified: %s\n", freqs);
        return -1;
    }
    if (ast_str_to_int(f1, freq1)) {
        ast_log(LOG_WARNING, "Frequency must be an integer: %s\n", f1);
        return -1;
    }
    if (*freq1 < 0) {
        ast_log(LOG_WARNING, "Sorry, no negative frequencies: %d\n", *freq1);
        return -1;
    }
    if (!ast_strlen_zero(f2)) {
        ast_log(LOG_WARNING, "Sorry, currently only 1 frequency is supported\n");
        return -1;
        /* not supported just yet, but possibly will be in the future */
        if (ast_str_to_int(f2, freq2)) {
            ast_log(LOG_WARNING, "Frequency must be an integer: %s\n", f2);
            return -1;
        }
        if (*freq2 < 1) {
            ast_log(LOG_WARNING, "Sorry, positive frequencies only: %d\n", *freq2);
            return -1;
        }
    }
    return 0;
}

References ast_log, ast_str_to_int(), ast_strdupa, ast_strlen_zero(), detect_information::freq1, detect_information::freq2, LOG_ERROR, LOG_WARNING, and strsep().

Referenced by detect_write(), and wait_exec().

◆ goto_parser()

static char * goto_parser	(	struct ast_channel *	chan,
		char *	loc
	)

static

Definition at line 538 of file res_tonedetect.c.

                                                              {
    char *exten, *pri, *context, *parse;
    char *dest;
    int size;
    parse = ast_strdupa(loc);
    context = strsep(&parse, ",");
    exten = strsep(&parse, ",");
    pri = strsep(&parse, ",");
    if (!exten) {
        pri = context;
        exten = NULL;
        context = NULL;
    } else if (!pri) {
        pri = exten;
        exten = context;
        context = NULL;
    }
    ast_channel_lock(chan);
    if (ast_strlen_zero(exten)) {
        exten = ast_strdupa(ast_channel_exten(chan));
    }
    if (ast_strlen_zero(context)) {
        context = ast_strdupa(ast_channel_context(chan));
    }
    ast_channel_unlock(chan);
 
    /* size + 3: for 1 null terminator + 2 commas */
    size = strlen(context) + strlen(exten) + strlen(pri) + 3;
    dest = ast_malloc(size + 1);
    if (!dest) {
        ast_log(LOG_ERROR, "Failed to parse goto: %s,%s,%s\n", context, exten, pri);
        return NULL;
    }
    snprintf(dest, size, "%s,%s,%s", context, exten, pri);
    return dest;
}

References ast_channel_context(), ast_channel_exten(), ast_channel_lock, ast_channel_unlock, ast_log, ast_malloc, ast_strdupa, ast_strlen_zero(), voicemailpwcheck::context, LOG_ERROR, NULL, and strsep().

Referenced by detect_write().

◆ load_module()

static int load_module ( void )

static

Definition at line 1061 of file res_tonedetect.c.

{
    int res;
 
    res = ast_register_application_xml(waitapp, wait_exec);
    res |= ast_register_application_xml(scanapp, scan_exec);
    res |= ast_custom_function_register(&detect_function);
 
    return res;
}

References ast_custom_function_register, ast_register_application_xml, detect_function, scan_exec(), scanapp, wait_exec(), and waitapp.

◆ parse_signal_features()

static int parse_signal_features ( struct ast_flags * flags )

static

Definition at line 605 of file res_tonedetect.c.

{
    int features = 0;
 
    if (ast_test_flag(flags, OPT_SIT)) {
        features |= DSP_PROGRESS_CONGESTION;
    }
    if (ast_test_flag(flags, OPT_BUSY)) {
        features |= DSP_PROGRESS_BUSY;
    }
    if (ast_test_flag(flags, OPT_DIALTONE)) {
        features |= DSP_FEATURE_WAITDIALTONE;
    }
    if (ast_test_flag(flags, OPT_RINGING)) {
        features |= DSP_PROGRESS_RINGING;
    }
 
    return features;
}

References ast_test_flag, DSP_FEATURE_WAITDIALTONE, DSP_PROGRESS_BUSY, DSP_PROGRESS_CONGESTION, DSP_PROGRESS_RINGING, OPT_BUSY, OPT_DIALTONE, OPT_RINGING, and OPT_SIT.

Referenced by detect_write().

◆ remove_detect()

static int remove_detect ( struct ast_channel * chan )

static

Definition at line 472 of file res_tonedetect.c.

{
    struct ast_datastore *datastore = NULL;
    struct detect_information *data;
    SCOPED_CHANNELLOCK(chan_lock, chan);
 
    datastore = ast_channel_datastore_find(chan, &detect_datastore, NULL);
    if (!datastore) {
        ast_log(AST_LOG_WARNING, "Cannot remove TONE_DETECT from %s: TONE_DETECT not currently enabled\n",
                ast_channel_name(chan));
        return -1;
    }
    data = datastore->data;
 
    if (ast_audiohook_remove(chan, &data->audiohook)) {
        ast_log(AST_LOG_WARNING, "Failed to remove TONE_DETECT audiohook from channel %s\n", ast_channel_name(chan));
        return -1;
    }
 
    if (ast_channel_datastore_remove(chan, datastore)) {
        ast_log(AST_LOG_WARNING, "Failed to remove TONE_DETECT datastore from channel %s\n",
                ast_channel_name(chan));
        return -1;
    }
    ast_datastore_free(datastore);
 
    return 0;
}

References ast_audiohook_remove(), ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_name(), ast_datastore_free(), ast_log, AST_LOG_WARNING, detect_information::audiohook, ast_datastore::data, detect_datastore, NULL, and SCOPED_CHANNELLOCK.

Referenced by detect_write().

◆ scan_exec()

static int scan_exec	(	struct ast_channel *	chan,
		const char *	data
	)

static

Definition at line 866 of file res_tonedetect.c.

{
    char *appdata;
    double timeoutf = 0;
    int timeout = 0;
    struct ast_frame *frame = NULL, *frame2 = NULL;
    struct ast_dsp *dsp = NULL, *dsp2 = NULL;
    struct timeval start;
    int remaining_time = 0;
    int features, match = 0, fax = 0, voice = 0, threshold = 1;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(zone);
        AST_APP_ARG(timeout);
        AST_APP_ARG(threshold);
        AST_APP_ARG(options);
    );
 
    appdata = ast_strdupa(data);
    AST_STANDARD_APP_ARGS(args, appdata);
 
    if (!ast_strlen_zero(args.timeout) && (sscanf(args.timeout, "%30lf", &timeoutf) != 1 || timeout < 0)) {
        ast_log(LOG_WARNING, "Invalid timeout: %s\n", args.timeout);
        pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "ERROR");
        return -1;
    }
    if (!ast_strlen_zero(args.threshold) && (ast_str_to_int(args.threshold, &threshold) || threshold < 1)) {
        ast_log(LOG_WARNING, "Invalid threshold: %s\n", args.threshold);
        pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "ERROR");
        return -1;
    }
    timeout = 1000 * timeoutf;
 
    if (!ast_strlen_zero(args.options) && strchr(args.options, 'f')) {
        fax = 1;
    }
    if (!ast_strlen_zero(args.options) && strchr(args.options, 'v')) {
        voice = 1;
    }
 
    if (!(dsp = ast_dsp_new())) {
        ast_log(LOG_WARNING, "Unable to allocate DSP!\n");
        pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "ERROR");
        return -1;
    }
 
    if (!ast_strlen_zero(args.zone)) {
        if (ast_dsp_set_call_progress_zone(dsp, args.zone)) {
            ast_log(LOG_WARNING, "Invalid call progress zone: %s\n", args.zone);
            pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "ERROR");
            ast_dsp_free(dsp);
            return -1;
        }
    }
 
    if (fax) {
        if (!(dsp2 = ast_dsp_new())) {
            ast_dsp_free(dsp);
            ast_log(LOG_WARNING, "Unable to allocate DSP!\n");
            pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "ERROR");
            return -1;
        }
    }
 
    features = DSP_PROGRESS_RINGING; /* audible ringback tone */
    features |= DSP_PROGRESS_BUSY; /* busy signal */
    features |= DSP_PROGRESS_CONGESTION; /* SIT tones (not reorder!) */
    features |= DSP_PROGRESS_TALK; /* voice. */
    features |= DSP_FEATURE_WAITDIALTONE; /* dial tone */
    features |= DSP_FEATURE_FREQ_DETECT; /* modem answer */
    if (voice) {
        features |= DSP_TONE_STATE_TALKING; /* voice */
    }
    ast_dsp_set_features(dsp, features);
    /* all modems begin negotiating with Bell 103. An answering modem just sends mark tone, or 2225 Hz */
    ast_dsp_set_freqmode(dsp, 2225, 400, 16, 0); /* this needs to be pretty short, or the progress tones code will think this is voice */
 
    if (fax) { /* fax detect uses same tone detect internals as modem and causes things to not work as intended, so use a separate DSP if needed. */
        ast_dsp_set_features(dsp2, DSP_FEATURE_FAX_DETECT); /* fax tone */
        ast_dsp_set_faxmode(dsp2, DSP_FAXMODE_DETECT_CED); /* we only care about the answering side (CED), not originating (CNG) */
    }
 
    ast_debug(1, "Starting tone scan, timeout: %d ms, threshold: %d\n", timeout, threshold);
    start = ast_tvnow();
    do {
        if (timeout > 0) {
            remaining_time = ast_remaining_ms(start, timeout);
            if (remaining_time <= 0) {
                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "TIMEOUT");
                break;
            }
        }
        if (ast_waitfor(chan, 1000) > 0) {
            if (!(frame = ast_read(chan))) {
                ast_debug(1, "Channel '%s' did not return a frame; probably hung up.\n", ast_channel_name(chan));
                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "HANGUP");
                break;
            } else if (frame->frametype == AST_FRAME_VOICE) {
                if (fax) {
                    frame2 = ast_frdup(frame);
                }
                frame = ast_dsp_process(chan, dsp, frame);
                if (frame->frametype == AST_FRAME_DTMF) {
                    char result = frame->subclass.integer;
                    match = 1;
                    if (result == 'q') {
                        pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "MODEM");
                    } else {
                        pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "DTMF");
                    }
                } else if (fax) {
                    char result;
                    frame2 = ast_dsp_process(chan, dsp2, frame2);
                    result = frame2->subclass.integer;
                    if (frame2->frametype == AST_FRAME_DTMF) {
                        if (result == 'e') {
                            pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "FAX");
                            match = 1;
                        } else {
                            ast_debug(1, "Ignoring inactionable event\n"); /* shouldn't happen */
                        }
                    }
                    ast_frfree(frame2);
                }
                if (!match) {
                    int tstate, tcount;
                    tcount = ast_dsp_get_tcount(dsp);
                    tstate = ast_dsp_get_tstate(dsp);
                    if (tstate > 0) {
                        ast_debug(3, "tcount: %d, tstate: %d\n", tcount, tstate);
                        if (tcount >= threshold) {
                            match = 1;
                            switch (tstate) {
                            case DSP_TONE_STATE_RINGING:
                                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "RINGING");
                                break;
                            case DSP_TONE_STATE_DIALTONE:
                                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "DIALTONE");
                                break;
                            case DSP_TONE_STATE_TALKING:
                                /* even if we don't specify this feature, it's still checked, so we always need to handle it.
                                    Even if we are looking for it, we need to wait a while or tones will be interpreted
                                    as voice, because this will match first (and this should match last). */
                                if (voice && tcount > 15 && tcount >= threshold) {
                                    pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "VOICE");
                                } else {
                                    match = 0;
                                }
                                break;
                            case DSP_TONE_STATE_BUSY:
                                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "BUSY");
                                break;
                            case DSP_TONE_STATE_SPECIAL3:
                                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "SIT");
                                break;
                            case DSP_TONE_STATE_HUNGUP: /* UK only */
                                pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "NUT");
                                break;
                            default:
                                match = 0;
                                ast_debug(1, "Something else we weren't expecting? tstate: %d, #%d\n", tstate, tcount);
                            }
                        }
                    }
                }
            }
            ast_frfree(frame);
        } else {
            pbx_builtin_setvar_helper(chan, "TONESCANSTATUS", "HANGUP");
        }
    } while (!match && (timeout == 0 || remaining_time > 0));
    ast_dsp_free(dsp);
    if (dsp2) {
        ast_dsp_free(dsp2);
        }
 
    return 0;
}

References args, AST_APP_ARG, ast_channel_name(), ast_debug, AST_DECLARE_APP_ARGS, ast_dsp_free(), ast_dsp_get_tcount(), ast_dsp_get_tstate(), ast_dsp_new(), ast_dsp_process(), ast_dsp_set_call_progress_zone(), ast_dsp_set_faxmode(), ast_dsp_set_features(), ast_dsp_set_freqmode(), AST_FRAME_DTMF, AST_FRAME_VOICE, ast_frdup, ast_frfree, ast_log, ast_read(), ast_remaining_ms(), AST_STANDARD_APP_ARGS, ast_str_to_int(), ast_strdupa, ast_strlen_zero(), ast_tvnow(), ast_waitfor(), DSP_FAXMODE_DETECT_CED, DSP_FEATURE_FAX_DETECT, DSP_FEATURE_FREQ_DETECT, DSP_FEATURE_WAITDIALTONE, DSP_PROGRESS_BUSY, DSP_PROGRESS_CONGESTION, DSP_PROGRESS_RINGING, DSP_PROGRESS_TALK, DSP_TONE_STATE_BUSY, DSP_TONE_STATE_DIALTONE, DSP_TONE_STATE_HUNGUP, DSP_TONE_STATE_RINGING, DSP_TONE_STATE_SPECIAL3, DSP_TONE_STATE_TALKING, ast_frame::frametype, ast_frame_subclass::integer, LOG_WARNING, match(), NULL, options, pbx_builtin_setvar_helper(), result, and ast_frame::subclass.

Referenced by load_module().

◆ unload_module()

static int unload_module ( void )

static

Definition at line 1050 of file res_tonedetect.c.

{
    int res;
 
    res = ast_unregister_application(waitapp);
    res |= ast_unregister_application(scanapp);
    res |= ast_custom_function_unregister(&detect_function);
 
    return res;
}

References ast_custom_function_unregister(), ast_unregister_application(), detect_function, scanapp, and waitapp.

◆ wait_exec()

static int wait_exec	(	struct ast_channel *	chan,
		const char *	data
	)

static

Definition at line 762 of file res_tonedetect.c.

{
    char *appdata;
    struct ast_flags flags = {0};
    char *opt_args[OPT_APP_ARG_ARRAY_SIZE];
    double timeoutf = 0;
    int freq1 = 0, freq2 = 0, timeout = 0, duration = 500, times = 1, db = 16, squelch = 0;
    struct ast_frame *frame = NULL;
    struct ast_dsp *dsp;
    struct timeval start;
    int remaining_time = 0;
    int hits = 0;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(freqs);
        AST_APP_ARG(duration);
        AST_APP_ARG(timeout);
        AST_APP_ARG(times);
        AST_APP_ARG(options);
    );
 
    appdata = ast_strdupa(data);
    AST_STANDARD_APP_ARGS(args, appdata);
 
    if (!ast_strlen_zero(args.options)) {
        ast_app_parse_options(wait_exec_options, &flags, opt_args, args.options);
    }
    if (freq_parser(args.freqs, &freq1, &freq2)) {
        pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "ERROR");
        return -1;
    }
    if (!ast_strlen_zero(args.timeout) && (sscanf(args.timeout, "%30lf", &timeoutf) != 1 || timeoutf < 0)) {
        ast_log(LOG_WARNING, "Invalid timeout: %s\n", args.timeout);
        pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "ERROR");
        return -1;
    }
    timeout = 1000 * timeoutf;
    if (!ast_strlen_zero(args.duration) && (ast_str_to_int(args.duration, &duration) || duration < 1)) {
        ast_log(LOG_WARNING, "Invalid duration: %s\n", args.duration);
        pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "ERROR");
        return -1;
    }
    if (!ast_strlen_zero(args.times) && (ast_str_to_int(args.times, &times) || times < 1)) {
        ast_log(LOG_WARNING, "Invalid number of times: %s\n", args.times);
        pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "ERROR");
        return -1;
    }
    if (ast_test_flag(&flags, OPT_APP_DECIBEL) && !ast_strlen_zero(opt_args[OPT_APP_ARG_DECIBEL])) {
        if ((ast_str_to_int(opt_args[OPT_APP_ARG_DECIBEL], &db) || db < 1)) {
            ast_log(LOG_WARNING, "Invalid decibel level: %s\n", opt_args[OPT_APP_ARG_DECIBEL]);
            pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "ERROR");
            return -1;
        }
    }
    squelch = ast_test_flag(&flags, OPT_APP_SQUELCH);
    if (!(dsp = ast_dsp_new())) {
        ast_log(LOG_WARNING, "Unable to allocate DSP!\n");
        pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "ERROR");
        return -1;
    }
    ast_dsp_set_features(dsp, DSP_FEATURE_FREQ_DETECT);
    ast_dsp_set_freqmode(dsp,  freq1, duration, db, squelch);
    ast_debug(1, "Waiting for %s Hz, %d time(s), timeout %d ms, %d db\n", args.freqs, times, timeout, db);
    start = ast_tvnow();
    do {
        if (timeout > 0) {
            remaining_time = ast_remaining_ms(start, timeout);
            if (remaining_time <= 0) {
                pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "TIMEOUT");
                break;
            }
        }
        if (ast_waitfor(chan, 1000) > 0) {
            if (!(frame = ast_read(chan))) {
                ast_debug(1, "Channel '%s' did not return a frame; probably hung up.\n", ast_channel_name(chan));
                pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "HANGUP");
                break;
            } else if (frame->frametype == AST_FRAME_VOICE) {
                frame = ast_dsp_process(chan, dsp, frame);
                if (frame->frametype == AST_FRAME_DTMF) {
                    char result = frame->subclass.integer;
                    if (result == 'q') {
                        hits++;
                        ast_debug(1, "We just detected %s Hz (hit #%d)\n", args.freqs, hits);
                        if (hits >= times) {
                            ast_frfree(frame);
                            pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "SUCCESS");
                            break;
                        }
                    }
                }
            }
            ast_frfree(frame);
        } else {
            pbx_builtin_setvar_helper(chan, "WAITFORTONESTATUS", "HANGUP");
        }
    } while (timeout == 0 || remaining_time > 0);
    ast_dsp_free(dsp);
 
    return 0;
}

References args, AST_APP_ARG, ast_app_parse_options(), ast_channel_name(), ast_debug, AST_DECLARE_APP_ARGS, ast_dsp_free(), ast_dsp_new(), ast_dsp_process(), ast_dsp_set_features(), ast_dsp_set_freqmode(), AST_FRAME_DTMF, AST_FRAME_VOICE, ast_frfree, ast_log, ast_read(), ast_remaining_ms(), AST_STANDARD_APP_ARGS, ast_str_to_int(), ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_tvnow(), ast_waitfor(), db, DSP_FEATURE_FREQ_DETECT, ast_flags::flags, ast_frame::frametype, freq_parser(), ast_frame_subclass::integer, LOG_WARNING, NULL, OPT_APP_ARG_ARRAY_SIZE, OPT_APP_ARG_DECIBEL, OPT_APP_DECIBEL, OPT_APP_SQUELCH, options, pbx_builtin_setvar_helper(), result, ast_frame::subclass, and wait_exec_options.

Referenced by load_module().

Variable Documentation

◆ detect_datastore

const struct ast_datastore_info detect_datastore

static

Initial value:

= {
    .type = "detect",
    .destroy = destroy_callback
}

Definition at line 350 of file res_tonedetect.c.

Referenced by detect_callback(), detect_read(), detect_write(), and remove_detect().

◆ detect_function

struct ast_custom_function detect_function

static

Initial value:

= {
    .name = "TONE_DETECT",
    .read = detect_read,
    .write = detect_write,
}

Definition at line 1044 of file res_tonedetect.c.

Referenced by load_module(), and unload_module().

◆ scanapp

char* scanapp = "ToneScan"

static

Definition at line 864 of file res_tonedetect.c.

Referenced by load_module(), and unload_module().

◆ td_opts

const struct ast_app_option td_opts[128] = { [ 'a' ] = { .flag = OPT_SIT }, [ 'b' ] = { .flag = OPT_BUSY }, [ 'c' ] = { .flag = OPT_DIALTONE }, [ 'd' ] = { .flag = OPT_DECIBEL , .arg_index = OPT_ARG_DECIBEL + 1 }, [ 'g' ] = { .flag = OPT_GOTO_RX , .arg_index = OPT_ARG_GOTO_RX + 1 }, [ 'h' ] = { .flag = OPT_GOTO_TX , .arg_index = OPT_ARG_GOTO_TX + 1 }, [ 'n' ] = { .flag = OPT_HITS_REQ , .arg_index = OPT_ARG_HITS_REQ + 1 }, [ 'p' ] = { .flag = OPT_RINGING }, [ 's' ] = { .flag = OPT_SQUELCH }, [ 't' ] = { .flag = OPT_TX }, [ 'r' ] = { .flag = OPT_RX }, [ 'x' ] = { .flag = OPT_END_FILTER }, }

static

Definition at line 330 of file res_tonedetect.c.

◆ wait_exec_options

const struct ast_app_option wait_exec_options[128] = { [ 'd' ] = { .flag = OPT_APP_DECIBEL , .arg_index = OPT_APP_ARG_DECIBEL + 1 }, [ 's' ] = { .flag = OPT_APP_SQUELCH }, }

static

Definition at line 760 of file res_tonedetect.c.

Referenced by wait_exec().

◆ waitapp

char* waitapp = "WaitForTone"

static

Definition at line 863 of file res_tonedetect.c.

Referenced by load_module(), and unload_module().

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ td_opts

Function Documentation

◆ AST_MODULE_INFO_STANDARD_EXTENDED()

◆ destroy_callback()

◆ detect_callback()

◆ detect_read()

◆ detect_write()

◆ freq_parser()

◆ goto_parser()

◆ load_module()

◆ parse_signal_features()

◆ remove_detect()

◆ scan_exec()

◆ unload_module()

◆ wait_exec()

Variable Documentation

◆ detect_datastore

◆ detect_function

◆ scanapp

◆ td_opts

◆ wait_exec_options

◆ waitapp