97fbf9f31813553176806fa24b94358ffebd165c
[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_FILE_VERSION(__FILE__, "$Revision$")
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         fmt = ast_format_cap_get_format(cap, 0);
145
146         ast_sockaddr_setnull(&control_address);
147
148         if (!ast_strlen_zero(args.control) &&
149                 !ast_sockaddr_parse(&control_address, args.control, PARSE_PORT_REQUIRE)) {
150                 ast_log(LOG_ERROR, "Control address '%s' could not be parsed\n", args.control);
151                 goto failure;
152         }
153
154         if (!ast_sockaddr_parse(&destination_address, args.destination,
155                                 PARSE_PORT_REQUIRE)) {
156                 ast_log(LOG_ERROR, "Destination address '%s' could not be parsed\n", args.destination);
157                 goto failure;
158         }
159
160         caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
161         if (!caps) {
162                 goto failure;
163         }
164
165         if (!(instance = ast_rtp_instance_new("multicast", NULL, &control_address, args.type))) {
166                 ast_log(LOG_ERROR, "Could not create RTP instance for sending media to '%s'\n", args.destination);
167                 goto failure;
168         }
169
170         if (!(chan = ast_channel_alloc(1, AST_STATE_DOWN, "", "", "", "", "", assignedids, requestor, 0, "MulticastRTP/%p", instance))) {
171                 ast_rtp_instance_destroy(instance);
172                 goto failure;
173         }
174         ast_rtp_instance_set_channel_id(instance, ast_channel_uniqueid(chan));
175         ast_rtp_instance_set_remote_address(instance, &destination_address);
176
177         ast_channel_tech_set(chan, &multicast_rtp_tech);
178
179         ast_format_cap_append(caps, fmt, 0);
180         ast_channel_nativeformats_set(chan, caps);
181         ast_channel_set_writeformat(chan, fmt);
182         ast_channel_set_rawwriteformat(chan, fmt);
183         ast_channel_set_readformat(chan, fmt);
184         ast_channel_set_rawreadformat(chan, fmt);
185
186         ast_channel_tech_pvt_set(chan, instance);
187
188         ast_channel_unlock(chan);
189
190         ao2_ref(fmt, -1);
191         ao2_ref(caps, -1);
192
193         return chan;
194
195 failure:
196         ao2_cleanup(fmt);
197         ao2_cleanup(caps);
198         *cause = AST_CAUSE_FAILURE;
199         return NULL;
200 }
201
202 /*! \brief Function called when we should prepare to call the unicast destination */
203 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)
204 {
205         char *parse;
206         struct ast_rtp_instance *instance;
207         struct ast_sockaddr address;
208         struct ast_sockaddr local_address;
209         struct ast_channel *chan;
210         struct ast_format_cap *caps = NULL;
211         struct ast_format *fmt = NULL;
212         AST_DECLARE_APP_ARGS(args,
213                 AST_APP_ARG(destination);
214                 AST_APP_ARG(engine);
215                 AST_APP_ARG(format);
216         );
217
218         if (ast_strlen_zero(data)) {
219                 goto failure;
220         }
221         parse = ast_strdupa(data);
222         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
223
224         if (!ast_strlen_zero(args.format)) {
225                 fmt = ast_format_cache_get(args.format);
226         } else {
227                 fmt = ast_format_cap_get_format(cap, 0);
228         }
229
230         if (!fmt) {
231                 ast_log(LOG_ERROR, "No format specified for sending RTP to '%s'\n", args.destination);
232                 goto failure;
233         }
234
235         if (!ast_sockaddr_parse(&address, args.destination,
236                                 PARSE_PORT_REQUIRE)) {
237                 ast_log(LOG_ERROR, "Destination '%s' could not be parsed\n", args.destination);
238                 goto failure;
239         }
240
241         caps = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
242         if (!caps) {
243                 goto failure;
244         }
245
246         ast_ouraddrfor(&address, &local_address);
247         if (!(instance = ast_rtp_instance_new(args.engine, NULL, &local_address, NULL))) {
248                 ast_log(LOG_ERROR, "Could not create RTP instance for sending media to '%s'\n", args.destination);
249                 goto failure;
250         }
251
252         if (!(chan = ast_channel_alloc(1, AST_STATE_DOWN, "", "", "", "", "", assignedids, requestor, 0, "UnicastRTP/%s-%p", args.destination, instance))) {
253                 ast_rtp_instance_destroy(instance);
254                 goto failure;
255         }
256         ast_rtp_instance_set_channel_id(instance, ast_channel_uniqueid(chan));
257         ast_rtp_instance_set_remote_address(instance, &address);
258         ast_channel_set_fd(chan, 0, ast_rtp_instance_fd(instance, 0));
259
260         ast_channel_tech_set(chan, &unicast_rtp_tech);
261
262         ast_format_cap_append(caps, fmt, 0);
263         ast_channel_nativeformats_set(chan, caps);
264         ast_channel_set_writeformat(chan, fmt);
265         ast_channel_set_rawwriteformat(chan, fmt);
266         ast_channel_set_readformat(chan, fmt);
267         ast_channel_set_rawreadformat(chan, fmt);
268
269         ast_channel_tech_pvt_set(chan, instance);
270
271         pbx_builtin_setvar_helper(chan, "UNICASTRTP_LOCAL_ADDRESS", ast_sockaddr_stringify_addr(&local_address));
272         ast_rtp_instance_get_local_address(instance, &local_address);
273         pbx_builtin_setvar_helper(chan, "UNICASTRTP_LOCAL_PORT", ast_sockaddr_stringify_port(&local_address));
274
275         ast_channel_unlock(chan);
276
277         ao2_ref(fmt, -1);
278         ao2_ref(caps, -1);
279
280         return chan;
281
282 failure:
283         ao2_cleanup(fmt);
284         ao2_cleanup(caps);
285         *cause = AST_CAUSE_FAILURE;
286         return NULL;
287 }
288
289 /*! \brief Function called when our module is unloaded */
290 static int unload_module(void)
291 {
292         ast_channel_unregister(&multicast_rtp_tech);
293         ao2_cleanup(multicast_rtp_tech.capabilities);
294         multicast_rtp_tech.capabilities = NULL;
295
296         ast_channel_unregister(&unicast_rtp_tech);
297         ao2_cleanup(unicast_rtp_tech.capabilities);
298         unicast_rtp_tech.capabilities = NULL;
299
300         return 0;
301 }
302
303 /*! \brief Function called when our module is loaded */
304 static int load_module(void)
305 {
306         if (!(multicast_rtp_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
307                 return AST_MODULE_LOAD_DECLINE;
308         }
309         ast_format_cap_append_by_type(multicast_rtp_tech.capabilities, AST_MEDIA_TYPE_UNKNOWN);
310         if (ast_channel_register(&multicast_rtp_tech)) {
311                 ast_log(LOG_ERROR, "Unable to register channel class 'MulticastRTP'\n");
312                 unload_module();
313                 return AST_MODULE_LOAD_DECLINE;
314         }
315
316         if (!(unicast_rtp_tech.capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
317                 unload_module();
318                 return AST_MODULE_LOAD_DECLINE;
319         }
320         ast_format_cap_append_by_type(unicast_rtp_tech.capabilities, AST_MEDIA_TYPE_UNKNOWN);
321         if (ast_channel_register(&unicast_rtp_tech)) {
322                 ast_log(LOG_ERROR, "Unable to register channel class 'UnicastRTP'\n");
323                 unload_module();
324                 return AST_MODULE_LOAD_DECLINE;
325         }
326
327         return AST_MODULE_LOAD_SUCCESS;
328 }
329
330 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "RTP Media Channel",
331         .support_level = AST_MODULE_SUPPORT_CORE,
332         .load = load_module,
333         .unload = unload_module,
334         .load_pri = AST_MODPRI_CHANNEL_DRIVER,
335 );