res_resolver_unbound: Fix config documentation.
[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(S_OR(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         if (!ast_strlen_zero(options)) {
159                 strcpy(pos, options); /* Safe */
160         }
161         mcast_options->options = pos;
162
163         if (ast_app_parse_options(multicast_rtp_options, &mcast_options->opts,
164                 mcast_options->opt_args, mcast_options->options)) {
165                 ast_log(LOG_WARNING, "Error parsing multicast RTP options\n");
166                 ast_multicast_rtp_free_options(mcast_options);
167                 return NULL;
168         }
169
170         return mcast_options;
171 }
172
173 void ast_multicast_rtp_free_options(struct ast_multicast_rtp_options *mcast_options)
174 {
175         ast_free(mcast_options);
176 }
177
178 struct ast_format *ast_multicast_rtp_options_get_format(struct ast_multicast_rtp_options *mcast_options)
179 {
180         if (ast_test_flag(&mcast_options->opts, OPT_CODEC)
181                 && !ast_strlen_zero(mcast_options->opt_args[OPT_ARG_CODEC])) {
182                 return ast_format_cache_get(mcast_options->opt_args[OPT_ARG_CODEC]);
183         }
184
185         return NULL;
186 }
187
188 /* Forward Declarations */
189 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data);
190 static int multicast_rtp_activate(struct ast_rtp_instance *instance);
191 static int multicast_rtp_destroy(struct ast_rtp_instance *instance);
192 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
193 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
194
195 /* RTP Engine Declaration */
196 static struct ast_rtp_engine multicast_rtp_engine = {
197         .name = "multicast",
198         .new = multicast_rtp_new,
199         .activate = multicast_rtp_activate,
200         .destroy = multicast_rtp_destroy,
201         .write = multicast_rtp_write,
202         .read = multicast_rtp_read,
203 };
204
205 static int set_type(struct multicast_rtp *multicast, const char *type)
206 {
207         if (!strcasecmp(type, "basic")) {
208                 multicast->type = MULTICAST_TYPE_BASIC;
209         } else if (!strcasecmp(type, "linksys")) {
210                 multicast->type = MULTICAST_TYPE_LINKSYS;
211         } else {
212                 ast_log(LOG_WARNING, "Unrecognized multicast type '%s' specified.\n", type);
213                 return -1;
214         }
215
216         return 0;
217 }
218
219 static void set_ttl(int sock, const char *ttl_str)
220 {
221         int ttl;
222
223         if (ast_strlen_zero(ttl_str)) {
224                 return;
225         }
226
227         ast_debug(3, "Setting multicast TTL to %s\n", ttl_str);
228
229         if (sscanf(ttl_str, "%30d", &ttl) < 1) {
230                 ast_log(LOG_WARNING, "Invalid multicast ttl option '%s'\n", ttl_str);
231                 return;
232         }
233
234         if (setsockopt(sock, IPPROTO_IP, IP_MULTICAST_TTL, &ttl, sizeof(ttl)) < 0) {
235                 ast_log(LOG_WARNING, "Could not set multicast ttl to '%s': %s\n",
236                         ttl_str, strerror(errno));
237         }
238 }
239
240 static void set_loop(int sock, const char *loop_str)
241 {
242         unsigned char loop;
243
244         if (ast_strlen_zero(loop_str)) {
245                 return;
246         }
247
248         ast_debug(3, "Setting multicast loop to %s\n", loop_str);
249
250         if (sscanf(loop_str, "%30hhu", &loop) < 1) {
251                 ast_log(LOG_WARNING, "Invalid multicast loop option '%s'\n", loop_str);
252                 return;
253         }
254
255         if (setsockopt(sock, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop)) < 0) {
256                 ast_log(LOG_WARNING, "Could not set multicast loop to '%s': %s\n",
257                         loop_str, strerror(errno));
258         }
259 }
260
261 static void set_if(int sock, const char *if_str)
262 {
263         struct in_addr iface;
264
265         if (ast_strlen_zero(if_str)) {
266                 return;
267         }
268
269         ast_debug(3, "Setting multicast if to %s\n", if_str);
270
271         if (!inet_aton(if_str, &iface)) {
272                 ast_log(LOG_WARNING, "Cannot parse if option '%s'\n", if_str);
273         }
274
275         if (setsockopt(sock, IPPROTO_IP, IP_MULTICAST_IF, &iface, sizeof(iface)) < 0) {
276                 ast_log(LOG_WARNING, "Could not set multicast if to '%s': %s\n",
277                         if_str, strerror(errno));
278         }
279 }
280
281 /*! \brief Function called to create a new multicast instance */
282 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data)
283 {
284         struct multicast_rtp *multicast;
285         struct ast_multicast_rtp_options *mcast_options = data;
286
287         if (!(multicast = ast_calloc(1, sizeof(*multicast)))) {
288                 return -1;
289         }
290
291         if (set_type(multicast, mcast_options->type)) {
292                 ast_free(multicast);
293                 return -1;
294         }
295
296         if ((multicast->socket = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
297                 ast_free(multicast);
298                 return -1;
299         }
300
301         if (ast_test_flag(&mcast_options->opts, OPT_LOOP)) {
302                 set_loop(multicast->socket, mcast_options->opt_args[OPT_ARG_LOOP]);
303         }
304
305         if (ast_test_flag(&mcast_options->opts, OPT_TTL)) {
306                 set_ttl(multicast->socket, mcast_options->opt_args[OPT_ARG_TTL]);
307         }
308
309         if (ast_test_flag(&mcast_options->opts, OPT_IF)) {
310                 set_if(multicast->socket, mcast_options->opt_args[OPT_ARG_IF]);
311         }
312
313         multicast->ssrc = ast_random();
314
315         ast_rtp_instance_set_data(instance, multicast);
316
317         return 0;
318 }
319
320 static int rtp_get_rate(struct ast_format *format)
321 {
322         return ast_format_cmp(format, ast_format_g722) == AST_FORMAT_CMP_EQUAL ?
323                 8000 : ast_format_get_sample_rate(format);
324 }
325
326 static unsigned int calc_txstamp(struct multicast_rtp *rtp, struct timeval *delivery)
327 {
328         struct timeval t;
329         long ms;
330
331         if (ast_tvzero(rtp->txcore)) {
332                 rtp->txcore = ast_tvnow();
333                 rtp->txcore.tv_usec -= rtp->txcore.tv_usec % 20000;
334         }
335
336         t = (delivery && !ast_tvzero(*delivery)) ? *delivery : ast_tvnow();
337         if ((ms = ast_tvdiff_ms(t, rtp->txcore)) < 0) {
338                 ms = 0;
339         }
340         rtp->txcore = t;
341
342         return (unsigned int) ms;
343 }
344
345 /*! \brief Helper function which populates a control packet with useful information and sends it */
346 static int multicast_send_control_packet(struct ast_rtp_instance *instance, struct multicast_rtp *multicast, int command)
347 {
348         struct multicast_control_packet control_packet = { .unique_id = htonl((u_long)time(NULL)),
349                                                            .command = htonl(command),
350         };
351         struct ast_sockaddr control_address, remote_address;
352
353         ast_rtp_instance_get_local_address(instance, &control_address);
354         ast_rtp_instance_get_remote_address(instance, &remote_address);
355
356         /* Ensure the user of us have given us both the control address and destination address */
357         if (ast_sockaddr_isnull(&control_address) ||
358             ast_sockaddr_isnull(&remote_address)) {
359                 return -1;
360         }
361
362         /* The protocol only supports IPv4. */
363         if (ast_sockaddr_is_ipv6(&remote_address)) {
364                 ast_log(LOG_WARNING, "Cannot send control packet for IPv6 "
365                         "remote address.\n");
366                 return -1;
367         }
368
369         control_packet.ip = htonl(ast_sockaddr_ipv4(&remote_address));
370         control_packet.port = htonl(ast_sockaddr_port(&remote_address));
371
372         /* Based on a recommendation by Brian West who did the FreeSWITCH implementation we send control packets twice */
373         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
374         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
375
376         return 0;
377 }
378
379 /*! \brief Function called to indicate that audio is now going to flow */
380 static int multicast_rtp_activate(struct ast_rtp_instance *instance)
381 {
382         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
383
384         if (multicast->type != MULTICAST_TYPE_LINKSYS) {
385                 return 0;
386         }
387
388         return multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STARTCMD);
389 }
390
391 /*! \brief Function called to destroy a multicast instance */
392 static int multicast_rtp_destroy(struct ast_rtp_instance *instance)
393 {
394         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
395
396         if (multicast->type == MULTICAST_TYPE_LINKSYS) {
397                 multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STOPCMD);
398         }
399
400         close(multicast->socket);
401
402         ast_free(multicast);
403
404         return 0;
405 }
406
407 /*! \brief Function called to broadcast some audio on a multicast instance */
408 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
409 {
410         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
411         struct ast_frame *f = frame;
412         struct ast_sockaddr remote_address;
413         int hdrlen = 12, res = 0, codec;
414         unsigned char *rtpheader;
415         unsigned int ms = calc_txstamp(multicast, &frame->delivery);
416         int rate = rtp_get_rate(frame->subclass.format) / 1000;
417
418         /* We only accept audio, nothing else */
419         if (frame->frametype != AST_FRAME_VOICE) {
420                 return 0;
421         }
422
423         /* Grab the actual payload number for when we create the RTP packet */
424         codec = ast_rtp_codecs_payload_code_tx(ast_rtp_instance_get_codecs(instance),
425                 1, frame->subclass.format, 0);
426         if (codec < 0) {
427                 return -1;
428         }
429
430         /* If we do not have space to construct an RTP header duplicate the frame so we get some */
431         if (frame->offset < hdrlen) {
432                 f = ast_frdup(frame);
433         }
434         
435         /* Calucate last TS */
436         multicast->lastts = multicast->lastts + ms * rate;
437         
438         /* Construct an RTP header for our packet */
439         rtpheader = (unsigned char *)(f->data.ptr - hdrlen);
440         put_unaligned_uint32(rtpheader, htonl((2 << 30) | (codec << 16) | (multicast->seqno)));
441         
442         if (ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO)) {
443                 put_unaligned_uint32(rtpheader + 4, htonl(f->ts * 8));
444         } else {
445                 put_unaligned_uint32(rtpheader + 4, htonl(multicast->lastts));
446         }
447
448         put_unaligned_uint32(rtpheader + 8, htonl(multicast->ssrc));
449
450         /* Increment sequence number and wrap to 0 if it overflows 16 bits. */
451         multicast->seqno = 0xFFFF & (multicast->seqno + 1);
452
453         /* Finally send it out to the eager phones listening for us */
454         ast_rtp_instance_get_remote_address(instance, &remote_address);
455
456         if (ast_sendto(multicast->socket, (void *) rtpheader, f->datalen + hdrlen, 0, &remote_address) < 0) {
457                 ast_log(LOG_ERROR, "Multicast RTP Transmission error to %s: %s\n",
458                         ast_sockaddr_stringify(&remote_address),
459                         strerror(errno));
460                 res = -1;
461         }
462
463         /* If we were forced to duplicate the frame free the new one */
464         if (frame != f) {
465                 ast_frfree(f);
466         }
467
468         return res;
469 }
470
471 /*! \brief Function called to read from a multicast instance */
472 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
473 {
474         return &ast_null_frame;
475 }
476
477 static int load_module(void)
478 {
479         if (ast_rtp_engine_register(&multicast_rtp_engine)) {
480                 return AST_MODULE_LOAD_DECLINE;
481         }
482
483         return AST_MODULE_LOAD_SUCCESS;
484 }
485
486 static int unload_module(void)
487 {
488         ast_rtp_engine_unregister(&multicast_rtp_engine);
489
490         return 0;
491 }
492
493 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Multicast RTP Engine",
494         .support_level = AST_MODULE_SUPPORT_CORE,
495         .load = load_module,
496         .unload = unload_module,
497         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
498 );