chan_rtp.c: Cleanup ast_request() parameter parsing.
[asterisk/asterisk.git] / channels / chan_rtp.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009 - 2014, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  * Andreas 'MacBrody' Brodmann <andreas.brodmann@gmail.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \author Joshua Colp <jcolp@digium.com>
23  * \author Andreas 'MacBrody' Broadmann <andreas.brodmann@gmail.com>
24  *
25  * \brief RTP (Multicast and Unicast) Media Channel
26  *
27  * \ingroup channel_drivers
28  */
29
30 /*** MODULEINFO
31         <support_level>core</support_level>
32  ***/
33
34 #include "asterisk.h"
35
36 ASTERISK_REGISTER_FILE()
37
38 #include "asterisk/channel.h"
39 #include "asterisk/module.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/acl.h"
42 #include "asterisk/app.h"
43 #include "asterisk/rtp_engine.h"
44 #include "asterisk/causes.h"
45 #include "asterisk/format_cache.h"
46
47 /* Forward declarations */
48 static struct ast_channel *multicast_rtp_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);
49 static struct ast_channel *unicast_rtp_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause);
50 static int rtp_call(struct ast_channel *ast, const char *dest, int timeout);
51 static int rtp_hangup(struct ast_channel *ast);
52 static struct ast_frame *rtp_read(struct ast_channel *ast);
53 static int rtp_write(struct ast_channel *ast, struct ast_frame *f);
54
55 /* Multicast channel driver declaration */
56 static struct ast_channel_tech multicast_rtp_tech = {
57         .type = "MulticastRTP",
58         .description = "Multicast RTP Paging Channel Driver",
59         .requester = multicast_rtp_request,
60         .call = rtp_call,
61         .hangup = rtp_hangup,
62         .read = rtp_read,
63         .write = rtp_write,
64 };
65
66 /* Unicast channel driver declaration */
67 static struct ast_channel_tech unicast_rtp_tech = {
68         .type = "UnicastRTP",
69         .description = "Unicast RTP Media Channel Driver",
70         .requester = unicast_rtp_request,
71         .call = rtp_call,
72         .hangup = rtp_hangup,
73         .read = rtp_read,
74         .write = rtp_write,
75 };
76
77 /*! \brief Function called when we should read a frame from the channel */
78 static struct ast_frame  *rtp_read(struct ast_channel *ast)
79 {
80         struct ast_rtp_instance *instance = ast_channel_tech_pvt(ast);
81         int fdno = ast_channel_fdno(ast);
82
83         switch (fdno) {
84         case 0:
85                 return ast_rtp_instance_read(instance, 0);
86         default:
87                 return &ast_null_frame;
88         }
89 }
90
91 /*! \brief Function called when we should write a frame to the channel */
92 static int rtp_write(struct ast_channel *ast, struct ast_frame *f)
93 {
94         struct ast_rtp_instance *instance = ast_channel_tech_pvt(ast);
95
96         return ast_rtp_instance_write(instance, f);
97 }
98
99 /*! \brief Function called when we should actually call the destination */
100 static int rtp_call(struct ast_channel *ast, const char *dest, int timeout)
101 {
102         struct ast_rtp_instance *instance = ast_channel_tech_pvt(ast);
103
104         ast_queue_control(ast, AST_CONTROL_ANSWER);
105
106         return ast_rtp_instance_activate(instance);
107 }
108
109 /*! \brief Function called when we should hang the channel up */
110 static int rtp_hangup(struct ast_channel *ast)
111 {
112         struct ast_rtp_instance *instance = ast_channel_tech_pvt(ast);
113
114         ast_rtp_instance_destroy(instance);
115
116         ast_channel_tech_pvt_set(ast, NULL);
117
118         return 0;
119 }
120
121 /*! \brief Function called when we should prepare to call the multicast destination */
122 static struct ast_channel *multicast_rtp_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause)
123 {
124         char *parse;
125         struct ast_rtp_instance *instance;
126         struct ast_sockaddr control_address;
127         struct ast_sockaddr destination_address;
128         struct ast_channel *chan;
129         struct ast_format_cap *caps = NULL;
130         struct ast_format *fmt = NULL;
131         AST_DECLARE_APP_ARGS(args,
132                 AST_APP_ARG(type);
133                 AST_APP_ARG(destination);
134                 AST_APP_ARG(control);
135         );
136
137         if (ast_strlen_zero(data)) {
138                 ast_log(LOG_ERROR, "A multicast type and destination must be given to the 'MulticastRTP' channel\n");
139                 goto failure;
140         }
141         parse = ast_strdupa(data);
142         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
143
144         if (ast_strlen_zero(args.type)) {
145                 ast_log(LOG_ERROR, "Type is required for the 'MulticastRTP' channel\n");
146                 goto failure;
147         }
148
149         if (ast_strlen_zero(args.destination)) {
150                 ast_log(LOG_ERROR, "Destination is required for the 'MulticastRTP' channel\n");
151                 goto failure;
152         }
153         if (!ast_sockaddr_parse(&destination_address, args.destination, PARSE_PORT_REQUIRE)) {
154                 ast_log(LOG_ERROR, "Destination address '%s' could not be parsed\n",
155                         args.destination);
156                 goto failure;
157         }
158
159         ast_sockaddr_setnull(&control_address);
160         if (!ast_strlen_zero(args.control)
161                 && !ast_sockaddr_parse(&control_address, args.control, PARSE_PORT_REQUIRE)) {
162                 ast_log(LOG_ERROR, "Control address '%s' could not be parsed\n", args.control);
163                 goto failure;
164         }
165
166         fmt = ast_format_cap_get_format(cap, 0);
167         if (!fmt) {
168                 ast_log(LOG_ERROR, "No format available for sending RTP to '%s'\n",
169                         args.destination);
170                 goto failure;
171         }
172
173         caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
174         if (!caps) {
175                 goto failure;
176         }
177
178         instance = ast_rtp_instance_new("multicast", NULL, &control_address, args.type);
179         if (!instance) {
180                 ast_log(LOG_ERROR,
181                         "Could not create '%s' multicast RTP instance for sending media to '%s'\n",
182                         args.type, args.destination);
183                 goto failure;
184         }
185
186         chan = ast_channel_alloc(1, AST_STATE_DOWN, "", "", "", "", "", assignedids,
187                 requestor, 0, "MulticastRTP/%p", instance);
188         if (!chan) {
189                 ast_rtp_instance_destroy(instance);
190                 goto failure;
191         }
192         ast_rtp_instance_set_channel_id(instance, ast_channel_uniqueid(chan));
193         ast_rtp_instance_set_remote_address(instance, &destination_address);
194
195         ast_channel_tech_set(chan, &multicast_rtp_tech);
196
197         ast_format_cap_append(caps, fmt, 0);
198         ast_channel_nativeformats_set(chan, caps);
199         ast_channel_set_writeformat(chan, fmt);
200         ast_channel_set_rawwriteformat(chan, fmt);
201         ast_channel_set_readformat(chan, fmt);
202         ast_channel_set_rawreadformat(chan, fmt);
203
204         ast_channel_tech_pvt_set(chan, instance);
205
206         ast_channel_unlock(chan);
207
208         ao2_ref(fmt, -1);
209         ao2_ref(caps, -1);
210
211         return chan;
212
213 failure:
214         ao2_cleanup(fmt);
215         ao2_cleanup(caps);
216         *cause = AST_CAUSE_FAILURE;
217         return NULL;
218 }
219
220 /*! \brief Function called when we should prepare to call the unicast destination */
221 static struct ast_channel *unicast_rtp_request(const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *data, int *cause)
222 {
223         char *parse;
224         struct ast_rtp_instance *instance;
225         struct ast_sockaddr address;
226         struct ast_sockaddr local_address;
227         struct ast_channel *chan;
228         struct ast_format_cap *caps = NULL;
229         struct ast_format *fmt = NULL;
230         AST_DECLARE_APP_ARGS(args,
231                 AST_APP_ARG(destination);
232                 AST_APP_ARG(engine);
233                 AST_APP_ARG(format);
234         );
235
236         if (ast_strlen_zero(data)) {
237                 ast_log(LOG_ERROR, "Destination is required for the 'UnicastRTP' channel\n");
238                 goto failure;
239         }
240         parse = ast_strdupa(data);
241         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
242
243         if (ast_strlen_zero(args.destination)) {
244                 ast_log(LOG_ERROR, "Destination is required for the 'UnicastRTP' channel\n");
245                 goto failure;
246         }
247         if (!ast_sockaddr_parse(&address, args.destination, PARSE_PORT_REQUIRE)) {
248                 ast_log(LOG_ERROR, "Destination '%s' could not be parsed\n", args.destination);
249                 goto failure;
250         }
251
252         if (!ast_strlen_zero(args.format)) {
253                 fmt = ast_format_cache_get(args.format);
254                 if (!fmt) {
255                         ast_log(LOG_ERROR, "Format '%s' not found for sending RTP to '%s'\n",
256                                 args.format, args.destination);
257                         goto failure;
258                 }
259         } else {
260                 fmt = ast_format_cap_get_format(cap, 0);
261                 if (!fmt) {
262                         ast_log(LOG_ERROR, "No format available for sending RTP to '%s'\n",
263                                 args.destination);
264                         goto failure;
265                 }
266         }
267
268         caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
269         if (!caps) {
270                 goto failure;
271         }
272
273         ast_ouraddrfor(&address, &local_address);
274         instance = ast_rtp_instance_new(args.engine, NULL, &local_address, NULL);
275         if (!instance) {
276                 ast_log(LOG_ERROR,
277                         "Could not create %s RTP instance for sending media to '%s'\n",
278                         S_OR(args.engine, "default"), args.destination);
279                 goto failure;
280         }
281
282         chan = ast_channel_alloc(1, AST_STATE_DOWN, "", "", "", "", "", assignedids,
283                 requestor, 0, "UnicastRTP/%s-%p", args.destination, instance);
284         if (!chan) {
285                 ast_rtp_instance_destroy(instance);
286                 goto failure;
287         }
288         ast_rtp_instance_set_channel_id(instance, ast_channel_uniqueid(chan));
289         ast_rtp_instance_set_remote_address(instance, &address);
290         ast_channel_set_fd(chan, 0, ast_rtp_instance_fd(instance, 0));
291
292         ast_channel_tech_set(chan, &unicast_rtp_tech);
293
294         ast_format_cap_append(caps, fmt, 0);
295         ast_channel_nativeformats_set(chan, caps);
296         ast_channel_set_writeformat(chan, fmt);
297         ast_channel_set_rawwriteformat(chan, fmt);
298         ast_channel_set_readformat(chan, fmt);
299         ast_channel_set_rawreadformat(chan, fmt);
300
301         ast_channel_tech_pvt_set(chan, instance);
302
303         pbx_builtin_setvar_helper(chan, "UNICASTRTP_LOCAL_ADDRESS",
304                 ast_sockaddr_stringify_addr(&local_address));
305         ast_rtp_instance_get_local_address(instance, &local_address);
306         pbx_builtin_setvar_helper(chan, "UNICASTRTP_LOCAL_PORT",
307                 ast_sockaddr_stringify_port(&local_address));
308
309         ast_channel_unlock(chan);
310
311         ao2_ref(fmt, -1);
312         ao2_ref(caps, -1);
313
314         return chan;
315
316 failure:
317         ao2_cleanup(fmt);
318         ao2_cleanup(caps);
319         *cause = AST_CAUSE_FAILURE;
320         return NULL;
321 }
322
323 /*! \brief Function called when our module is unloaded */
324 static int unload_module(void)
325 {
326         ast_channel_unregister(&multicast_rtp_tech);
327         ao2_cleanup(multicast_rtp_tech.capabilities);
328         multicast_rtp_tech.capabilities = NULL;
329
330         ast_channel_unregister(&unicast_rtp_tech);
331         ao2_cleanup(unicast_rtp_tech.capabilities);
332         unicast_rtp_tech.capabilities = NULL;
333
334         return 0;
335 }
336
337 /*! \brief Function called when our module is loaded */
338 static int load_module(void)
339 {
340         if (!(multicast_rtp_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
341                 return AST_MODULE_LOAD_DECLINE;
342         }
343         ast_format_cap_append_by_type(multicast_rtp_tech.capabilities, AST_MEDIA_TYPE_UNKNOWN);
344         if (ast_channel_register(&multicast_rtp_tech)) {
345                 ast_log(LOG_ERROR, "Unable to register channel class 'MulticastRTP'\n");
346                 unload_module();
347                 return AST_MODULE_LOAD_DECLINE;
348         }
349
350         if (!(unicast_rtp_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
351                 unload_module();
352                 return AST_MODULE_LOAD_DECLINE;
353         }
354         ast_format_cap_append_by_type(unicast_rtp_tech.capabilities, AST_MEDIA_TYPE_UNKNOWN);
355         if (ast_channel_register(&unicast_rtp_tech)) {
356                 ast_log(LOG_ERROR, "Unable to register channel class 'UnicastRTP'\n");
357                 unload_module();
358                 return AST_MODULE_LOAD_DECLINE;
359         }
360
361         return AST_MODULE_LOAD_SUCCESS;
362 }
363
364 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "RTP Media Channel",
365         .support_level = AST_MODULE_SUPPORT_CORE,
366         .load = load_module,
367         .unload = unload_module,
368         .load_pri = AST_MODPRI_CHANNEL_DRIVER,
369 );