app_senddtmf.c File Reference

App to send DTMF digits. More...

#include "asterisk.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/manager.h"
#include "asterisk/channel.h"

Include dependency graph for app_senddtmf.c:

Go to the source code of this file.

Enumerations
enum	{ OPT_ARG_ARRAY_SIZE }
enum	read_option_flags {   OPT_DELAY = (1 << 0) , OPT_MUTE = (1 << 1) , OPT_QUELCH = (1 << 2) , OPT_RELAXED = (1 << 3) ,   OPT_LAX_KP = (1 << 4) , OPT_PROCESS = (1 << 5) , OPT_NO_KP = (1 << 6) , OPT_NO_ST = (1 << 7) ,   OPT_KP_OVERRIDE = (1 << 8) , OPT_MAXDIGITS = (1 << 9) , OPT_SKIP = (1 << 0) , OPT_INDICATION = (1 << 1) ,   OPT_NOANSWER = (1 << 2) , OPT_TERMINATOR = (1 << 3) , OPT_KEEP_TERMINATOR = (1 << 4) , OPT_ANSWER = (1 << 0) ,   OPT_DELAY = (1 << 0) , OPT_MUTE = (1 << 1) , OPT_QUELCH = (1 << 2) , OPT_RELAXED = (1 << 3) ,   OPT_EXTRAPULSES = (1 << 4) }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static int	manager_play_dtmf (struct mansession *s, const struct message *m)
static int	manager_send_flash (struct mansession *s, const struct message *m)
static int	senddtmf_exec (struct ast_channel *chan, const char *vdata)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Send DTMF digits Application" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static const struct ast_app_option	senddtmf_app_options [128] = { [ 'a' ] = { .flag = OPT_ANSWER }, }
static const char	senddtmf_name [] = "SendDTMF"

Detailed Description

App to send DTMF digits.

Author

Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file app_senddtmf.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
OPT_ARG_ARRAY_SIZE

Definition at line 127 of file app_senddtmf.c.

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

read_option_flags

enum read_option_flags

Enumerator
OPT_DELAY
OPT_MUTE
OPT_QUELCH
OPT_RELAXED
OPT_LAX_KP
OPT_PROCESS
OPT_NO_KP
OPT_NO_ST
OPT_KP_OVERRIDE
OPT_MAXDIGITS
OPT_SKIP
OPT_INDICATION
OPT_NOANSWER
OPT_TERMINATOR
OPT_KEEP_TERMINATOR
OPT_ANSWER
OPT_DELAY
OPT_MUTE
OPT_QUELCH
OPT_RELAXED
OPT_EXTRAPULSES

Definition at line 119 of file app_senddtmf.c.

                       {
    OPT_ANSWER = (1 << 0),
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 288 of file app_senddtmf.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 288 of file app_senddtmf.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 288 of file app_senddtmf.c.

load_module()

static int load_module ( void  )

static

Definition at line 277 of file app_senddtmf.c.

{
    int res;
 
    res = ast_manager_register_xml("PlayDTMF", EVENT_FLAG_CALL, manager_play_dtmf);
    res |= ast_manager_register_xml("SendFlash", EVENT_FLAG_CALL, manager_send_flash);
    res |= ast_register_application_xml(senddtmf_name, senddtmf_exec);
 
    return res;
}

References ast_manager_register_xml, ast_register_application_xml, EVENT_FLAG_CALL, manager_play_dtmf(), manager_send_flash(), senddtmf_exec(), and senddtmf_name.

manager_play_dtmf()

static int manager_play_dtmf ( struct mansession *  s, const struct message *  m  )

static

Definition at line 196 of file app_senddtmf.c.

{
    const char *channel = astman_get_header(m, "Channel");
    const char *digit = astman_get_header(m, "Digit");
    const char *duration = astman_get_header(m, "Duration");
    const char *receive_s = astman_get_header(m, "Receive");
    struct ast_channel *chan;
    unsigned int duration_ms = 0;
 
    if (!(chan = ast_channel_get_by_name(channel))) {
        astman_send_error(s, m, "Channel not found");
        return 0;
    }
 
    if (ast_strlen_zero(digit)) {
        astman_send_error(s, m, "No digit specified");
        chan = ast_channel_unref(chan);
        return 0;
    }
 
    if (!ast_strlen_zero(duration) && (sscanf(duration, "%30u", &duration_ms) != 1)) {
        astman_send_error(s, m, "Could not convert Duration parameter");
        chan = ast_channel_unref(chan);
        return 0;
    }
 
    if (ast_true(receive_s)) {
        struct ast_frame f = { AST_FRAME_DTMF, };
        f.len = duration_ms;
        f.subclass.integer = *digit;
        ast_queue_frame(chan, &f);
    } else {
        ast_senddigit_external(chan, *digit, duration_ms);
    }
 
    chan = ast_channel_unref(chan);
 
    astman_send_ack(s, m, "DTMF successfully queued");
 
    return 0;
}

References ast_channel_get_by_name(), ast_channel_unref, AST_FRAME_DTMF, ast_queue_frame(), ast_senddigit_external(), ast_strlen_zero(), ast_true(), astman_get_header(), astman_send_ack(), astman_send_error(), digit, ast_frame_subclass::integer, ast_frame::len, and ast_frame::subclass.

Referenced by load_module().

manager_send_flash()

static int manager_send_flash ( struct mansession *  s, const struct message *  m  )

static

Definition at line 238 of file app_senddtmf.c.

{
    const char *channel = astman_get_header(m, "Channel");
    const char *receive_s = astman_get_header(m, "Receive");
    struct ast_channel *chan;
 
    if (!(chan = ast_channel_get_by_name(channel))) {
        astman_send_error(s, m, "Channel not found");
        return 0;
    }
 
    if (ast_true(receive_s)) {
        struct ast_frame f = { AST_FRAME_CONTROL, };
        f.subclass.integer = AST_CONTROL_FLASH;
        ast_queue_frame(chan, &f);
    } else {
        struct ast_frame f = { AST_FRAME_CONTROL, };
        f.subclass.integer = AST_CONTROL_FLASH;
        ast_channel_lock(chan);
        ast_write(chan, &f);
        ast_channel_unlock(chan);
    }
 
    chan = ast_channel_unref(chan);
    astman_send_ack(s, m, "Flash successfully queued");
    return 0;
}

References ast_channel_get_by_name(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, AST_CONTROL_FLASH, AST_FRAME_CONTROL, ast_queue_frame(), ast_true(), ast_write(), astman_get_header(), astman_send_ack(), astman_send_error(), ast_frame_subclass::integer, and ast_frame::subclass.

Referenced by load_module().

senddtmf_exec()

static int senddtmf_exec ( struct ast_channel *  chan, const char *  vdata  )

static

Definition at line 134 of file app_senddtmf.c.

{
    int res;
    char *data;
    int dinterval = 0, duration = 0;
    struct ast_channel *chan_found = NULL;
    struct ast_channel *chan_dest = chan;
    struct ast_channel *chan_autoservice = NULL;
    char *opt_args[OPT_ARG_ARRAY_SIZE];
    struct ast_flags flags = {0};
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(digits);
        AST_APP_ARG(dinterval);
        AST_APP_ARG(duration);
        AST_APP_ARG(channel);
        AST_APP_ARG(options);
    );
 
    if (ast_strlen_zero(vdata)) {
        ast_log(LOG_WARNING, "SendDTMF requires an argument\n");
        return 0;
    }
 
    data = ast_strdupa(vdata);
    AST_STANDARD_APP_ARGS(args, data);
 
    if (ast_strlen_zero(args.digits)) {
        ast_log(LOG_WARNING, "The digits argument is required (0-9,*#,a-d,A-D,wfF)\n");
        return 0;
    }
    if (!ast_strlen_zero(args.dinterval)) {
        ast_app_parse_timelen(args.dinterval, &dinterval, TIMELEN_MILLISECONDS);
    }
    if (!ast_strlen_zero(args.duration)) {
        ast_app_parse_timelen(args.duration, &duration, TIMELEN_MILLISECONDS);
    }
    if (!ast_strlen_zero(args.channel)) {
        chan_found = ast_channel_get_by_name(args.channel);
        if (!chan_found) {
            ast_log(LOG_WARNING, "No such channel: %s\n", args.channel);
            return 0;
        }
        chan_dest = chan_found;
        if (chan_found != chan) {
            chan_autoservice = chan;
        }
    }
    if (!ast_strlen_zero(args.options)) {
        ast_app_parse_options(senddtmf_app_options, &flags, opt_args, args.options);
    }
    if (ast_test_flag(&flags, OPT_ANSWER)) {
        ast_auto_answer(chan_dest);
    }
    res = ast_dtmf_stream(chan_dest, chan_autoservice, args.digits,
        dinterval <= 0 ? 250 : dinterval, duration);
    if (chan_found) {
        ast_channel_unref(chan_found);
    }
 
    return chan_autoservice ? 0 : res;
}

References args, AST_APP_ARG, ast_app_parse_options(), ast_app_parse_timelen(), ast_auto_answer(), ast_channel_get_by_name(), ast_channel_unref, AST_DECLARE_APP_ARGS, ast_dtmf_stream(), ast_log, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_flags::flags, LOG_WARNING, NULL, OPT_ANSWER, OPT_ARG_ARRAY_SIZE, options, senddtmf_app_options, and TIMELEN_MILLISECONDS.

Referenced by load_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 266 of file app_senddtmf.c.

{
    int res;
 
    res = ast_unregister_application(senddtmf_name);
    res |= ast_manager_unregister("PlayDTMF");
    res |= ast_manager_unregister("SendFlash");
 
    return res;
}

References ast_manager_unregister(), ast_unregister_application(), and senddtmf_name.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Send DTMF digits Application" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 288 of file app_senddtmf.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 288 of file app_senddtmf.c.

senddtmf_app_options

const struct ast_app_option senddtmf_app_options[128] = { [ 'a' ] = { .flag = OPT_ANSWER }, }

static

Definition at line 125 of file app_senddtmf.c.

Referenced by senddtmf_exec().

senddtmf_name

const char senddtmf_name[] = "SendDTMF"

static

Definition at line 132 of file app_senddtmf.c.

Referenced by load_module(), and unload_module().