audiosocket: Fix module menuselect descriptions
[asterisk/asterisk.git] / channels / chan_audiosocket.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2019, CyCore Systems, Inc
5  *
6  * Seán C McCord <scm@cycoresys.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  * \author Seán C McCord <scm@cycoresys.com>
22  *
23  * \brief AudioSocket Channel
24  *
25  * \ingroup channel_drivers
26  */
27
28 /*** MODULEINFO
29         <depend>res_audiosocket</depend>
30         <support_level>extended</support_level>
31  ***/
32
33 #include "asterisk.h"
34 #include <uuid/uuid.h>
35
36 #include "asterisk/channel.h"
37 #include "asterisk/module.h"
38 #include "asterisk/res_audiosocket.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/acl.h"
41 #include "asterisk/app.h"
42 #include "asterisk/causes.h"
43 #include "asterisk/format_cache.h"
44
45 #define FD_OUTPUT 1     /* A fd of -1 means an error, 0 is stdin */
46
47 struct audiosocket_instance {
48         int svc;        /* The file descriptor for the AudioSocket instance */
49         char id[38];    /* The UUID identifying this AudioSocket instance */
50 } audiosocket_instance;
51
52 /* Forward declarations */
53 static struct ast_channel *audiosocket_request(const char *type,
54         struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids,
55         const struct ast_channel *requestor, const char *data, int *cause);
56 static int audiosocket_call(struct ast_channel *ast, const char *dest, int timeout);
57 static int audiosocket_hangup(struct ast_channel *ast);
58 static struct ast_frame *audiosocket_read(struct ast_channel *ast);
59 static int audiosocket_write(struct ast_channel *ast, struct ast_frame *f);
60
61 /* AudioSocket channel driver declaration */
62 static struct ast_channel_tech audiosocket_channel_tech = {
63         .type = "AudioSocket",
64         .description = "AudioSocket Channel Driver",
65         .requester = audiosocket_request,
66         .call = audiosocket_call,
67         .hangup = audiosocket_hangup,
68         .read = audiosocket_read,
69         .write = audiosocket_write,
70 };
71
72 /*! \brief Function called when we should read a frame from the channel */
73 static struct ast_frame *audiosocket_read(struct ast_channel *ast)
74 {
75         struct audiosocket_instance *instance;
76
77         /* The channel should always be present from the API */
78         instance = ast_channel_tech_pvt(ast);
79         if (instance == NULL || instance->svc < FD_OUTPUT) {
80                 return NULL;
81         }
82         return ast_audiosocket_receive_frame(instance->svc);
83 }
84
85 /*! \brief Function called when we should write a frame to the channel */
86 static int audiosocket_write(struct ast_channel *ast, struct ast_frame *f)
87 {
88         struct audiosocket_instance *instance;
89
90         /* The channel should always be present from the API */
91         instance = ast_channel_tech_pvt(ast);
92         if (instance == NULL || instance->svc < 1) {
93                 return -1;
94         }
95         return ast_audiosocket_send_frame(instance->svc, f);
96 }
97
98 /*! \brief Function called when we should actually call the destination */
99 static int audiosocket_call(struct ast_channel *ast, const char *dest, int timeout)
100 {
101         struct audiosocket_instance *instance = ast_channel_tech_pvt(ast);
102
103         ast_queue_control(ast, AST_CONTROL_ANSWER);
104
105         return ast_audiosocket_init(instance->svc, instance->id);
106 }
107
108 /*! \brief Function called when we should hang the channel up */
109 static int audiosocket_hangup(struct ast_channel *ast)
110 {
111         struct audiosocket_instance *instance;
112
113         /* The channel should always be present from the API */
114         instance = ast_channel_tech_pvt(ast);
115         if (instance != NULL && instance->svc > 0) {
116                 close(instance->svc);
117         }
118
119         ast_channel_tech_pvt_set(ast, NULL);
120         ast_free(instance);
121
122         return 0;
123 }
124
125 enum {
126         OPT_AUDIOSOCKET_CODEC = (1 << 0),
127 };
128
129 enum {
130         OPT_ARG_AUDIOSOCKET_CODEC = (1 << 0),
131         OPT_ARG_ARRAY_SIZE
132 };
133
134 AST_APP_OPTIONS(audiosocket_options, BEGIN_OPTIONS
135         AST_APP_OPTION_ARG('c', OPT_AUDIOSOCKET_CODEC, OPT_ARG_AUDIOSOCKET_CODEC),
136 END_OPTIONS );
137
138 /*! \brief Function called when we should prepare to call the unicast destination */
139 static struct ast_channel *audiosocket_request(const char *type,
140         struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids,
141         const struct ast_channel *requestor, const char *data, int *cause)
142 {
143         char *parse;
144         struct audiosocket_instance *instance = NULL;
145         struct ast_sockaddr address;
146         struct ast_channel *chan;
147         struct ast_format_cap *caps = NULL;
148         struct ast_format *fmt = NULL;
149         uuid_t uu;
150         int fd;
151         AST_DECLARE_APP_ARGS(args,
152                 AST_APP_ARG(destination);
153                 AST_APP_ARG(idStr);
154                 AST_APP_ARG(options);
155         );
156         struct ast_flags opts = { 0, };
157         char *opt_args[OPT_ARG_ARRAY_SIZE];
158
159         if (ast_strlen_zero(data)) {
160                 ast_log(LOG_ERROR, "Destination is required for the 'AudioSocket' channel\n");
161                 goto failure;
162         }
163         parse = ast_strdupa(data);
164         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
165
166         if (ast_strlen_zero(args.destination)) {
167                 ast_log(LOG_ERROR, "Destination is required for the 'AudioSocket' channel\n");
168                 goto failure;
169         }
170         if (ast_sockaddr_resolve_first_af
171                 (&address, args.destination, PARSE_PORT_REQUIRE, AST_AF_UNSPEC)) {
172                 ast_log(LOG_ERROR, "Destination '%s' could not be parsed\n", args.destination);
173                 goto failure;
174         }
175
176         if (ast_strlen_zero(args.idStr)) {
177                 ast_log(LOG_ERROR, "UUID is required for the 'AudioSocket' channel\n");
178                 goto failure;
179         }
180         if (uuid_parse(args.idStr, uu)) {
181                 ast_log(LOG_ERROR, "Failed to parse UUID '%s'\n", args.idStr);
182                 goto failure;
183         }
184
185         if (!ast_strlen_zero(args.options)
186                 && ast_app_parse_options(audiosocket_options, &opts, opt_args,
187                         ast_strdupa(args.options))) {
188                 ast_log(LOG_ERROR, "'AudioSocket' channel options '%s' parse error\n",
189                         args.options);
190                 goto failure;
191         }
192
193         if (ast_test_flag(&opts, OPT_AUDIOSOCKET_CODEC)
194                 && !ast_strlen_zero(opt_args[OPT_ARG_AUDIOSOCKET_CODEC])) {
195                 fmt = ast_format_cache_get(opt_args[OPT_ARG_AUDIOSOCKET_CODEC]);
196                 if (!fmt) {
197                         ast_log(LOG_ERROR, "Codec '%s' not found for AudioSocket connection to '%s'\n",
198                                 opt_args[OPT_ARG_AUDIOSOCKET_CODEC], args.destination);
199                         goto failure;
200                 }
201         } else {
202                 fmt = ast_format_cap_get_format(cap, 0);
203                 if (!fmt) {
204                         ast_log(LOG_ERROR, "No codec available for AudioSocket connection to '%s'\n",
205                                 args.destination);
206                         goto failure;
207                 }
208         }
209
210         caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
211         if (!caps) {
212                 goto failure;
213         }
214
215         instance = ast_calloc(1, sizeof(*instance));
216         if (!instance) {
217                 ast_log(LOG_ERROR, "Failed to allocate AudioSocket channel pvt\n");
218                 goto failure;
219         }
220         ast_copy_string(instance->id, args.idStr, sizeof(instance->id));
221
222         if ((fd = ast_audiosocket_connect(args.destination, NULL)) < 0) {
223                 goto failure;
224         }
225         instance->svc = fd;
226
227         chan = ast_channel_alloc(1, AST_STATE_DOWN, "", "", "", "", "", assignedids,
228                 requestor, 0, "AudioSocket/%s-%s", args.destination, args.idStr);
229         if (!chan) {
230                 goto failure;
231         }
232         ast_channel_set_fd(chan, 0, fd);
233
234         ast_channel_tech_set(chan, &audiosocket_channel_tech);
235
236         ast_format_cap_append(caps, fmt, 0);
237         ast_channel_nativeformats_set(chan, caps);
238         ast_channel_set_writeformat(chan, fmt);
239         ast_channel_set_rawwriteformat(chan, fmt);
240         ast_channel_set_readformat(chan, fmt);
241         ast_channel_set_rawreadformat(chan, fmt);
242
243         ast_channel_tech_pvt_set(chan, instance);
244
245         pbx_builtin_setvar_helper(chan, "AUDIOSOCKET_UUID", args.idStr);
246         pbx_builtin_setvar_helper(chan, "AUDIOSOCKET_SERVICE", args.destination);
247
248         ast_channel_unlock(chan);
249
250         ao2_ref(fmt, -1);
251         ao2_ref(caps, -1);
252         return chan;
253
254 failure:
255         *cause = AST_CAUSE_FAILURE;
256         ao2_cleanup(fmt);
257         ao2_cleanup(caps);
258         if (instance != NULL) {
259                 ast_free(instance);
260                 if (fd >= 0) {
261                         close(fd);
262                 }
263         }
264
265         return NULL;
266 }
267
268 /*! \brief Function called when our module is unloaded */
269 static int unload_module(void)
270 {
271         ast_channel_unregister(&audiosocket_channel_tech);
272         ao2_cleanup(audiosocket_channel_tech.capabilities);
273         audiosocket_channel_tech.capabilities = NULL;
274
275         return 0;
276 }
277
278 /*! \brief Function called when our module is loaded */
279 static int load_module(void)
280 {
281         if (!(audiosocket_channel_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
282                 return AST_MODULE_LOAD_DECLINE;
283         }
284         ast_format_cap_append_by_type(audiosocket_channel_tech.capabilities, AST_MEDIA_TYPE_UNKNOWN);
285         if (ast_channel_register(&audiosocket_channel_tech)) {
286                 ast_log(LOG_ERROR, "Unable to register channel class AudioSocket");
287                 ao2_ref(audiosocket_channel_tech.capabilities, -1);
288                 audiosocket_channel_tech.capabilities = NULL;
289                 return AST_MODULE_LOAD_DECLINE;
290         }
291
292         return AST_MODULE_LOAD_SUCCESS;
293 }
294
295 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "AudioSocket Channel",
296         .support_level = AST_MODULE_SUPPORT_EXTENDED,
297         .load = load_module,
298         .unload = unload_module,
299         .load_pri = AST_MODPRI_CHANNEL_DRIVER,
300         .requires = "res_audiosocket",
301 );