since the module API is changing, it's a good time to const-ify the description(...
[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
47 static char *tdesc = "Send DTMF digits Application";
48
49 static char *app = "SendDTMF";
50
51 static char *synopsis = "Sends arbitrary DTMF digits";
52
53 static char *descrip = 
54 " SendDTMF(digits[|timeout_ms]): Sends DTMF digits on a channel. \n"
55 " Accepted digits: 0-9, *#abcd, w (.5s pause)\n"
56 " The application will either pass the assigned digits or terminate if it\n"
57 " encounters an error.\n";
58
59 LOCAL_USER_DECL;
60
61 static int senddtmf_exec(struct ast_channel *chan, void *data)
62 {
63         int res = 0;
64         struct localuser *u;
65         char *digits = NULL, *to = NULL;
66         int timeout = 250;
67
68         if (ast_strlen_zero(data)) {
69                 ast_log(LOG_WARNING, "SendDTMF requires an argument (digits or *#aAbBcCdD)\n");
70                 return 0;
71         }
72
73         LOCAL_USER_ADD(u);
74
75         if (!(digits = ast_strdupa(data))) {
76                 LOCAL_USER_REMOVE(u);
77                 return -1;
78         }
79
80         if ((to = strchr(digits,'|'))) {
81                 *to = '\0';
82                 to++;
83                 timeout = atoi(to);
84         }
85                 
86         if(timeout <= 0)
87                 timeout = 250;
88
89         res = ast_dtmf_stream(chan,NULL,digits,timeout);
90                 
91         LOCAL_USER_REMOVE(u);
92
93         return res;
94 }
95
96 int unload_module(void)
97 {
98         int res;
99
100         res = ast_unregister_application(app);
101
102         STANDARD_HANGUP_LOCALUSERS;
103
104         return res;     
105 }
106
107 int load_module(void)
108 {
109         return ast_register_application(app, senddtmf_exec, synopsis, descrip);
110 }
111
112 const char *description(void)
113 {
114         return tdesc;
115 }
116
117 int usecount(void)
118 {
119         int res;
120         STANDARD_USECOUNT(res);
121         return res;
122 }
123
124 const char *key()
125 {
126         return ASTERISK_GPL_KEY;
127 }