res_pjsip res_pjsip_mwi: Misc fixes and cleanups.
[asterisk/asterisk.git] / res / res_rtp_multicast.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, 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 /*!
21  * \file
22  *
23  * \brief Multicast RTP Engine
24  *
25  * \author Joshua Colp <jcolp@digium.com>
26  * \author Andreas 'MacBrody' Brodmann <andreas.brodmann@gmail.com>
27  *
28  * \ingroup rtp_engines
29  */
30
31 /*** MODULEINFO
32         <support_level>core</support_level>
33  ***/
34
35 #include "asterisk.h"
36
37 ASTERISK_REGISTER_FILE()
38
39 #include <sys/time.h>
40 #include <signal.h>
41 #include <fcntl.h>
42 #include <math.h>
43
44 #include "asterisk/pbx.h"
45 #include "asterisk/frame.h"
46 #include "asterisk/channel.h"
47 #include "asterisk/acl.h"
48 #include "asterisk/config.h"
49 #include "asterisk/lock.h"
50 #include "asterisk/utils.h"
51 #include "asterisk/cli.h"
52 #include "asterisk/manager.h"
53 #include "asterisk/unaligned.h"
54 #include "asterisk/module.h"
55 #include "asterisk/rtp_engine.h"
56 #include "asterisk/format_cache.h"
57 #include "asterisk/multicast_rtp.h"
58 #include "asterisk/app.h"
59
60 /*! Command value used for Linksys paging to indicate we are starting */
61 #define LINKSYS_MCAST_STARTCMD 6
62
63 /*! Command value used for Linksys paging to indicate we are stopping */
64 #define LINKSYS_MCAST_STOPCMD 7
65
66 /*! \brief Type of paging to do */
67 enum multicast_type {
68         /*! Type has not been set yet */
69         MULTICAST_TYPE_UNSPECIFIED = 0,
70         /*! Simple multicast enabled client/receiver paging like Snom and Barix uses */
71         MULTICAST_TYPE_BASIC,
72         /*! More advanced Linksys type paging which requires a start and stop packet */
73         MULTICAST_TYPE_LINKSYS,
74 };
75
76 /*! \brief Structure for a Linksys control packet */
77 struct multicast_control_packet {
78         /*! Unique identifier for the control packet */
79         uint32_t unique_id;
80         /*! Actual command in the control packet */
81         uint32_t command;
82         /*! IP address for the RTP */
83         uint32_t ip;
84         /*! Port for the RTP */
85         uint32_t port;
86 };
87
88 /*! \brief Structure for a multicast paging instance */
89 struct multicast_rtp {
90         /*! TYpe of multicast paging this instance is doing */
91         enum multicast_type type;
92         /*! Socket used for sending the audio on */
93         int socket;
94         /*! Synchronization source value, used when creating/sending the RTP packet */
95         unsigned int ssrc;
96         /*! Sequence number, used when creating/sending the RTP packet */
97         uint16_t seqno;
98         unsigned int lastts;    
99         struct timeval txcore;
100 };
101
102 enum {
103         OPT_CODEC = (1 << 0),
104         OPT_LOOP =  (1 << 1),
105         OPT_TTL =   (1 << 2),
106         OPT_IF =    (1 << 3),
107 };
108
109 enum {
110         OPT_ARG_CODEC = 0,
111         OPT_ARG_LOOP,
112         OPT_ARG_TTL,
113         OPT_ARG_IF,
114         OPT_ARG_ARRAY_SIZE,
115 };
116
117 AST_APP_OPTIONS(multicast_rtp_options, BEGIN_OPTIONS
118         /*! Set the codec to be used for multicast RTP */
119         AST_APP_OPTION_ARG('c', OPT_CODEC, OPT_ARG_CODEC),
120         /*! Set whether multicast RTP is looped back to the sender */
121         AST_APP_OPTION_ARG('l', OPT_LOOP, OPT_ARG_LOOP),
122         /*! Set the hop count for multicast RTP */
123         AST_APP_OPTION_ARG('t', OPT_TTL, OPT_ARG_TTL),
124         /*! Set the interface from which multicast RTP is sent */
125         AST_APP_OPTION_ARG('i', OPT_IF, OPT_ARG_IF),
126 END_OPTIONS );
127
128 struct ast_multicast_rtp_options {
129         char *type;
130         char *options;
131         struct ast_format *fmt;
132         struct ast_flags opts;
133         char *opt_args[OPT_ARG_ARRAY_SIZE];
134         /*! The type and options are stored in this buffer */
135         char buf[0];
136 };
137
138 struct ast_multicast_rtp_options *ast_multicast_rtp_create_options(const char *type,
139         const char *options)
140 {
141         struct ast_multicast_rtp_options *mcast_options;
142         char *pos;
143
144         mcast_options = ast_calloc(1, sizeof(*mcast_options)
145                         + strlen(type)
146                         + strlen(options) + 2);
147         if (!mcast_options) {
148                 return NULL;
149         }
150
151         pos = mcast_options->buf;
152
153         /* Safe */
154         strcpy(pos, type);
155         mcast_options->type = pos;
156         pos += strlen(type) + 1;
157
158         /* Safe */
159         strcpy(pos, options);
160         mcast_options->options = pos;
161
162         if (ast_app_parse_options(multicast_rtp_options, &mcast_options->opts,
163                 mcast_options->opt_args, mcast_options->options)) {
164                 ast_log(LOG_WARNING, "Error parsing multicast RTP options\n");
165                 ast_multicast_rtp_free_options(mcast_options);
166                 return NULL;
167         }
168
169         return mcast_options;
170 }
171
172 void ast_multicast_rtp_free_options(struct ast_multicast_rtp_options *mcast_options)
173 {
174         ast_free(mcast_options);
175 }
176
177 struct ast_format *ast_multicast_rtp_options_get_format(struct ast_multicast_rtp_options *mcast_options)
178 {
179         if (ast_test_flag(&mcast_options->opts, OPT_CODEC)
180                 && !ast_strlen_zero(mcast_options->opt_args[OPT_ARG_CODEC])) {
181                 return ast_format_cache_get(mcast_options->opt_args[OPT_ARG_CODEC]);
182         }
183
184         return NULL;
185 }
186
187 /* Forward Declarations */
188 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data);
189 static int multicast_rtp_activate(struct ast_rtp_instance *instance);
190 static int multicast_rtp_destroy(struct ast_rtp_instance *instance);
191 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
192 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
193
194 /* RTP Engine Declaration */
195 static struct ast_rtp_engine multicast_rtp_engine = {
196         .name = "multicast",
197         .new = multicast_rtp_new,
198         .activate = multicast_rtp_activate,
199         .destroy = multicast_rtp_destroy,
200         .write = multicast_rtp_write,
201         .read = multicast_rtp_read,
202 };
203
204 static int set_type(struct multicast_rtp *multicast, const char *type)
205 {
206         if (!strcasecmp(type, "basic")) {
207                 multicast->type = MULTICAST_TYPE_BASIC;
208         } else if (!strcasecmp(type, "linksys")) {
209                 multicast->type = MULTICAST_TYPE_LINKSYS;
210         } else {
211                 ast_log(LOG_WARNING, "Unrecognized multicast type '%s' specified.\n", type);
212                 return -1;
213         }
214
215         return 0;
216 }
217
218 static void set_ttl(int sock, const char *ttl_str)
219 {
220         int ttl;
221
222         if (ast_strlen_zero(ttl_str)) {
223                 return;
224         }
225
226         ast_debug(3, "Setting multicast TTL to %s\n", ttl_str);
227
228         if (sscanf(ttl_str, "%30d", &ttl) < 1) {
229                 ast_log(LOG_WARNING, "Invalid multicast ttl option '%s'\n", ttl_str);
230                 return;
231         }
232
233         if (setsockopt(sock, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl)) < 0) {
234                 ast_log(LOG_WARNING, "Could not set multicast ttl to '%s': %s\n",
235                         ttl_str, strerror(errno));
236         }
237 }
238
239 static void set_loop(int sock, const char *loop_str)
240 {
241         unsigned char loop;
242
243         if (ast_strlen_zero(loop_str)) {
244                 return;
245         }
246
247         ast_debug(3, "Setting multicast loop to %s\n", loop_str);
248
249         if (sscanf(loop_str, "%30hhu", &loop) < 1) {
250                 ast_log(LOG_WARNING, "Invalid multicast loop option '%s'\n", loop_str);
251                 return;
252         }
253
254         if (setsockopt(sock, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop)) < 0) {
255                 ast_log(LOG_WARNING, "Could not set multicast loop to '%s': %s\n",
256                         loop_str, strerror(errno));
257         }
258 }
259
260 static void set_if(int sock, const char *if_str)
261 {
262         struct in_addr iface;
263
264         if (ast_strlen_zero(if_str)) {
265                 return;
266         }
267
268         ast_debug(3, "Setting multicast if to %s\n", if_str);
269
270         if (!inet_aton(if_str, &iface)) {
271                 ast_log(LOG_WARNING, "Cannot parse if option '%s'\n", if_str);
272         }
273
274         if (setsockopt(sock, IPPROTO_IP, IP_MULTICAST_IF, &iface, sizeof(iface)) < 0) {
275                 ast_log(LOG_WARNING, "Could not set multicast if to '%s': %s\n",
276                         if_str, strerror(errno));
277         }
278 }
279
280 /*! \brief Function called to create a new multicast instance */
281 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data)
282 {
283         struct multicast_rtp *multicast;
284         struct ast_multicast_rtp_options *mcast_options = data;
285
286         if (!(multicast = ast_calloc(1, sizeof(*multicast)))) {
287                 return -1;
288         }
289
290         if (set_type(multicast, mcast_options->type)) {
291                 ast_free(multicast);
292                 return -1;
293         }
294
295         if ((multicast->socket = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
296                 ast_free(multicast);
297                 return -1;
298         }
299
300         if (ast_test_flag(&mcast_options->opts, OPT_LOOP)) {
301                 set_loop(multicast->socket, mcast_options->opt_args[OPT_ARG_LOOP]);
302         }
303
304         if (ast_test_flag(&mcast_options->opts, OPT_TTL)) {
305                 set_ttl(multicast->socket, mcast_options->opt_args[OPT_ARG_TTL]);
306         }
307
308         if (ast_test_flag(&mcast_options->opts, OPT_IF)) {
309                 set_if(multicast->socket, mcast_options->opt_args[OPT_ARG_IF]);
310         }
311
312         multicast->ssrc = ast_random();
313
314         ast_rtp_instance_set_data(instance, multicast);
315
316         return 0;
317 }
318
319 static int rtp_get_rate(struct ast_format *format)
320 {
321         return ast_format_cmp(format, ast_format_g722) == AST_FORMAT_CMP_EQUAL ?
322                 8000 : ast_format_get_sample_rate(format);
323 }
324
325 static unsigned int calc_txstamp(struct multicast_rtp *rtp, struct timeval *delivery)
326 {
327         struct timeval t;
328         long ms;
329
330         if (ast_tvzero(rtp->txcore)) {
331                 rtp->txcore = ast_tvnow();
332                 rtp->txcore.tv_usec -= rtp->txcore.tv_usec % 20000;
333         }
334
335         t = (delivery && !ast_tvzero(*delivery)) ? *delivery : ast_tvnow();
336         if ((ms = ast_tvdiff_ms(t, rtp->txcore)) < 0) {
337                 ms = 0;
338         }
339         rtp->txcore = t;
340
341         return (unsigned int) ms;
342 }
343
344 /*! \brief Helper function which populates a control packet with useful information and sends it */
345 static int multicast_send_control_packet(struct ast_rtp_instance *instance, struct multicast_rtp *multicast, int command)
346 {
347         struct multicast_control_packet control_packet = { .unique_id = htonl((u_long)time(NULL)),
348                                                            .command = htonl(command),
349         };
350         struct ast_sockaddr control_address, remote_address;
351
352         ast_rtp_instance_get_local_address(instance, &control_address);
353         ast_rtp_instance_get_remote_address(instance, &remote_address);
354
355         /* Ensure the user of us have given us both the control address and destination address */
356         if (ast_sockaddr_isnull(&control_address) ||
357             ast_sockaddr_isnull(&remote_address)) {
358                 return -1;
359         }
360
361         /* The protocol only supports IPv4. */
362         if (ast_sockaddr_is_ipv6(&remote_address)) {
363                 ast_log(LOG_WARNING, "Cannot send control packet for IPv6 "
364                         "remote address.\n");
365                 return -1;
366         }
367
368         control_packet.ip = htonl(ast_sockaddr_ipv4(&remote_address));
369         control_packet.port = htonl(ast_sockaddr_port(&remote_address));
370
371         /* Based on a recommendation by Brian West who did the FreeSWITCH implementation we send control packets twice */
372         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
373         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
374
375         return 0;
376 }
377
378 /*! \brief Function called to indicate that audio is now going to flow */
379 static int multicast_rtp_activate(struct ast_rtp_instance *instance)
380 {
381         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
382
383         if (multicast->type != MULTICAST_TYPE_LINKSYS) {
384                 return 0;
385         }
386
387         return multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STARTCMD);
388 }
389
390 /*! \brief Function called to destroy a multicast instance */
391 static int multicast_rtp_destroy(struct ast_rtp_instance *instance)
392 {
393         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
394
395         if (multicast->type == MULTICAST_TYPE_LINKSYS) {
396                 multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STOPCMD);
397         }
398
399         close(multicast->socket);
400
401         ast_free(multicast);
402
403         return 0;
404 }
405
406 /*! \brief Function called to broadcast some audio on a multicast instance */
407 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
408 {
409         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
410         struct ast_frame *f = frame;
411         struct ast_sockaddr remote_address;
412         int hdrlen = 12, res = 0, codec;
413         unsigned char *rtpheader;
414         unsigned int ms = calc_txstamp(multicast, &frame->delivery);
415         int rate = rtp_get_rate(frame->subclass.format) / 1000;
416
417         /* We only accept audio, nothing else */
418         if (frame->frametype != AST_FRAME_VOICE) {
419                 return 0;
420         }
421
422         /* Grab the actual payload number for when we create the RTP packet */
423         codec = ast_rtp_codecs_payload_code_tx(ast_rtp_instance_get_codecs(instance),
424                 1, frame->subclass.format, 0);
425         if (codec < 0) {
426                 return -1;
427         }
428
429         /* If we do not have space to construct an RTP header duplicate the frame so we get some */
430         if (frame->offset < hdrlen) {
431                 f = ast_frdup(frame);
432         }
433         
434         /* Calucate last TS */
435         multicast->lastts = multicast->lastts + ms * rate;
436         
437         /* Construct an RTP header for our packet */
438         rtpheader = (unsigned char *)(f->data.ptr - hdrlen);
439         put_unaligned_uint32(rtpheader, htonl((2 << 30) | (codec << 16) | (multicast->seqno)));
440         
441         if (ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO)) {
442                 put_unaligned_uint32(rtpheader + 4, htonl(f->ts * 8));
443         } else {
444                 put_unaligned_uint32(rtpheader + 4, htonl(multicast->lastts));
445         }
446
447         put_unaligned_uint32(rtpheader + 8, htonl(multicast->ssrc));
448
449         /* Increment sequence number and wrap to 0 if it overflows 16 bits. */
450         multicast->seqno = 0xFFFF & (multicast->seqno + 1);
451
452         /* Finally send it out to the eager phones listening for us */
453         ast_rtp_instance_get_remote_address(instance, &remote_address);
454
455         if (ast_sendto(multicast->socket, (void *) rtpheader, f->datalen + hdrlen, 0, &remote_address) < 0) {
456                 ast_log(LOG_ERROR, "Multicast RTP Transmission error to %s: %s\n",
457                         ast_sockaddr_stringify(&remote_address),
458                         strerror(errno));
459                 res = -1;
460         }
461
462         /* If we were forced to duplicate the frame free the new one */
463         if (frame != f) {
464                 ast_frfree(f);
465         }
466
467         return res;
468 }
469
470 /*! \brief Function called to read from a multicast instance */
471 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
472 {
473         return &ast_null_frame;
474 }
475
476 static int load_module(void)
477 {
478         if (ast_rtp_engine_register(&multicast_rtp_engine)) {
479                 return AST_MODULE_LOAD_DECLINE;
480         }
481
482         return AST_MODULE_LOAD_SUCCESS;
483 }
484
485 static int unload_module(void)
486 {
487         ast_rtp_engine_unregister(&multicast_rtp_engine);
488
489         return 0;
490 }
491
492 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Multicast RTP Engine",
493         .support_level = AST_MODULE_SUPPORT_CORE,
494         .load = load_module,
495         .unload = unload_module,
496         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
497 );