- formatting fixes
[asterisk/asterisk.git] / apps / app_senddtmf.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief App to send DTMF digits
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27  
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/translate.h"
43 #include "asterisk/options.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/app.h"
46 #include "asterisk/manager.h"
47
48 static char *tdesc = "Send DTMF digits Application";
49
50 static char *app = "SendDTMF";
51
52 static char *synopsis = "Sends arbitrary DTMF digits";
53
54 static char *descrip = 
55 " SendDTMF(digits[|timeout_ms]): Sends DTMF digits on a channel. \n"
56 " Accepted digits: 0-9, *#abcd, w (.5s pause)\n"
57 " The application will either pass the assigned digits or terminate if it\n"
58 " encounters an error.\n";
59
60 LOCAL_USER_DECL;
61
62 static int senddtmf_exec(struct ast_channel *chan, void *data)
63 {
64         int res = 0;
65         struct localuser *u;
66         char *digits = NULL, *to = NULL;
67         int timeout = 250;
68
69         if (ast_strlen_zero(data)) {
70                 ast_log(LOG_WARNING, "SendDTMF requires an argument (digits or *#aAbBcCdD)\n");
71                 return 0;
72         }
73
74         LOCAL_USER_ADD(u);
75
76         if (!(digits = ast_strdupa(data))) {
77                 LOCAL_USER_REMOVE(u);
78                 return -1;
79         }
80
81         if ((to = strchr(digits,'|'))) {
82                 *to = '\0';
83                 to++;
84                 timeout = atoi(to);
85         }
86                 
87         if (timeout <= 0)
88                 timeout = 250;
89
90         res = ast_dtmf_stream(chan,NULL,digits,timeout);
91                 
92         LOCAL_USER_REMOVE(u);
93
94         return res;
95 }
96
97 static char mandescr_playdtmf[] =
98 "Description: Plays a dtmf digit on the specified channel.\n"
99 "Variables: (all are required)\n"
100 "       Channel: Channel name to send digit to\n"
101 "       Digit: The dtmf digit to play\n";
102
103 static int manager_play_dtmf(struct mansession *s, struct message *m)
104 {
105         char *channel = astman_get_header(m, "Channel");
106         char *digit = astman_get_header(m, "Digit");
107         struct ast_channel *chan = ast_get_channel_by_name_locked(channel);
108         
109         if (!chan) {
110                 astman_send_error(s, m, "Channel not specified");
111                 ast_mutex_unlock(&chan->lock);
112                 return 0;
113         }
114         if (!digit) {
115                 astman_send_error(s, m, "No digit specified");
116                 ast_mutex_unlock(&chan->lock);
117                 return 0;
118         }
119
120         ast_senddigit(chan, *digit);
121
122         ast_mutex_unlock(&chan->lock);
123         astman_send_ack(s, m, "DTMF successfully queued");
124         
125         return 0;
126 }
127
128 static int unload_module(void *mod)
129 {
130         int res;
131
132         res = ast_unregister_application(app);
133         res |= ast_manager_unregister("PlayDTMF");
134
135         STANDARD_HANGUP_LOCALUSERS;
136
137         return res;     
138 }
139
140 static int load_module(void *mod)
141 {
142         int res;
143
144         res = ast_manager_register2( "PlayDTMF", EVENT_FLAG_CALL, manager_play_dtmf, "Play DTMF signal on a specific channel.", mandescr_playdtmf );
145         res |= ast_register_application(app, senddtmf_exec, synopsis, descrip);
146
147         return res;
148 }
149
150 static const char *description(void)
151 {
152         return tdesc;
153 }
154
155 static const char *key(void)
156 {
157         return ASTERISK_GPL_KEY;
158 }
159
160 STD_MOD1;