fd947dd661bd2570b317070c62427151a5e0ad85
[asterisk/asterisk.git] / apps / app_playtones.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Russell Bryant <russell@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 /*!
20  * \file
21  * \brief Playtones application
22  *
23  * \author Russell Bryant <russell@digium.com>
24  *
25  * \ingroup applications
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/module.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/indications.h"
40
41 static const char playtones_app[] = "PlayTones";
42 static const char stopplaytones_app[] = "StopPlayTones";
43
44 /*** DOCUMENTATION
45         <application name="PlayTones" language="en_US">
46                 <synopsis>
47                         Play a tone list.
48                 </synopsis>
49                 <syntax>
50                         <parameter name="arg" required="true">
51                                 <para>Arg is either the tone name defined in the <filename>indications.conf</filename>
52                                 configuration file, or a directly specified list of frequencies and durations.</para>
53                         </parameter>
54                 </syntax>
55                 <description>
56                         <para>Plays a tone list. Execution will continue with the next step in the dialplan
57                         immediately while the tones continue to play.</para>
58                         <para>See the sample <filename>indications.conf</filename> for a description of the
59                         specification of a tonelist.</para>
60                 </description>
61                 <see-also>
62                         <ref type="application">StopPlayTones</ref>
63                 </see-also>
64         </application>
65         <application name="StopPlayTones" language="en_US">
66                 <synopsis>
67                         Stop playing a tone list.
68                 </synopsis>
69                 <syntax />
70                 <description>
71                         <para>Stop playing a tone list, initiated by PlayTones().</para>
72                 </description>
73                 <see-also>
74                         <ref type="application">PlayTones</ref>
75                 </see-also>
76         </application>
77  ***/
78
79 static int handle_playtones(struct ast_channel *chan, const char *data)
80 {
81         struct ast_tone_zone_sound *ts;
82         int res;
83         const char *str = data;
84
85         if (ast_strlen_zero(str)) {
86                 ast_log(LOG_NOTICE,"Nothing to play\n");
87                 return -1;
88         }
89
90         ts = ast_get_indication_tone(ast_channel_zone(chan), str);
91
92         if (ts) {
93                 res = ast_playtones_start(chan, 0, ts->data, 0);
94                 ts = ast_tone_zone_sound_unref(ts);
95         } else {
96                 res = ast_playtones_start(chan, 0, str, 0);
97         }
98
99         if (res) {
100                 ast_log(LOG_NOTICE, "Unable to start playtones\n");
101         }
102
103         return res;
104 }
105
106 static int handle_stopplaytones(struct ast_channel *chan, const char *data)
107 {
108         ast_playtones_stop(chan);
109
110         return 0;
111 }
112
113 static int unload_module(void)
114 {
115         int res;
116
117         res = ast_unregister_application(playtones_app);
118         res |= ast_unregister_application(stopplaytones_app);
119
120         return res;
121 }
122
123 static int load_module(void)
124 {
125         int res;
126
127         res = ast_register_application_xml(playtones_app, handle_playtones);
128         res |= ast_register_application_xml(stopplaytones_app, handle_stopplaytones);
129
130         return res ? AST_MODULE_LOAD_DECLINE : AST_MODULE_LOAD_SUCCESS;
131 }
132
133 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Playtones Application");