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