res/res_pjsip/pjsip_options.c: Eliminate excessive RAII_VAR usage.
[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_FILE_VERSION(__FILE__, "$Revision$")
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
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         /*! Simple multicast enabled client/receiver paging like Snom and Barix uses */
67         MULTICAST_TYPE_BASIC = 0,
68         /*! More advanced Linksys type paging which requires a start and stop packet */
69         MULTICAST_TYPE_LINKSYS,
70 };
71
72 /*! \brief Structure for a Linksys control packet */
73 struct multicast_control_packet {
74         /*! Unique identifier for the control packet */
75         uint32_t unique_id;
76         /*! Actual command in the control packet */
77         uint32_t command;
78         /*! IP address for the RTP */
79         uint32_t ip;
80         /*! Port for the RTP */
81         uint32_t port;
82 };
83
84 /*! \brief Structure for a multicast paging instance */
85 struct multicast_rtp {
86         /*! TYpe of multicast paging this instance is doing */
87         enum multicast_type type;
88         /*! Socket used for sending the audio on */
89         int socket;
90         /*! Synchronization source value, used when creating/sending the RTP packet */
91         unsigned int ssrc;
92         /*! Sequence number, used when creating/sending the RTP packet */
93         uint16_t seqno;
94         unsigned int lastts;    
95         struct timeval txcore;
96 };
97
98 /* Forward Declarations */
99 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data);
100 static int multicast_rtp_activate(struct ast_rtp_instance *instance);
101 static int multicast_rtp_destroy(struct ast_rtp_instance *instance);
102 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
103 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
104
105 /* RTP Engine Declaration */
106 static struct ast_rtp_engine multicast_rtp_engine = {
107         .name = "multicast",
108         .new = multicast_rtp_new,
109         .activate = multicast_rtp_activate,
110         .destroy = multicast_rtp_destroy,
111         .write = multicast_rtp_write,
112         .read = multicast_rtp_read,
113 };
114
115 /*! \brief Function called to create a new multicast instance */
116 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data)
117 {
118         struct multicast_rtp *multicast;
119         const char *type = data;
120
121         if (!(multicast = ast_calloc(1, sizeof(*multicast)))) {
122                 return -1;
123         }
124
125         if (!strcasecmp(type, "basic")) {
126                 multicast->type = MULTICAST_TYPE_BASIC;
127         } else if (!strcasecmp(type, "linksys")) {
128                 multicast->type = MULTICAST_TYPE_LINKSYS;
129         } else {
130                 ast_free(multicast);
131                 return -1;
132         }
133
134         if ((multicast->socket = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
135                 ast_free(multicast);
136                 return -1;
137         }
138
139         multicast->ssrc = ast_random();
140
141         ast_rtp_instance_set_data(instance, multicast);
142
143         return 0;
144 }
145
146 static int rtp_get_rate(struct ast_format *format)
147 {
148         return ast_format_cmp(format, ast_format_g722) == AST_FORMAT_CMP_EQUAL ?
149                 8000 : ast_format_get_sample_rate(format);
150 }
151
152 static unsigned int calc_txstamp(struct multicast_rtp *rtp, struct timeval *delivery)
153 {
154         struct timeval t;
155         long ms;
156
157         if (ast_tvzero(rtp->txcore)) {
158                 rtp->txcore = ast_tvnow();
159                 rtp->txcore.tv_usec -= rtp->txcore.tv_usec % 20000;
160         }
161
162         t = (delivery && !ast_tvzero(*delivery)) ? *delivery : ast_tvnow();
163         if ((ms = ast_tvdiff_ms(t, rtp->txcore)) < 0) {
164                 ms = 0;
165         }
166         rtp->txcore = t;
167
168         return (unsigned int) ms;
169 }
170
171 /*! \brief Helper function which populates a control packet with useful information and sends it */
172 static int multicast_send_control_packet(struct ast_rtp_instance *instance, struct multicast_rtp *multicast, int command)
173 {
174         struct multicast_control_packet control_packet = { .unique_id = htonl((u_long)time(NULL)),
175                                                            .command = htonl(command),
176         };
177         struct ast_sockaddr control_address, remote_address;
178
179         ast_rtp_instance_get_local_address(instance, &control_address);
180         ast_rtp_instance_get_remote_address(instance, &remote_address);
181
182         /* Ensure the user of us have given us both the control address and destination address */
183         if (ast_sockaddr_isnull(&control_address) ||
184             ast_sockaddr_isnull(&remote_address)) {
185                 return -1;
186         }
187
188         /* The protocol only supports IPv4. */
189         if (ast_sockaddr_is_ipv6(&remote_address)) {
190                 ast_log(LOG_WARNING, "Cannot send control packet for IPv6 "
191                         "remote address.\n");
192                 return -1;
193         }
194
195         control_packet.ip = htonl(ast_sockaddr_ipv4(&remote_address));
196         control_packet.port = htonl(ast_sockaddr_port(&remote_address));
197
198         /* Based on a recommendation by Brian West who did the FreeSWITCH implementation we send control packets twice */
199         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
200         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
201
202         return 0;
203 }
204
205 /*! \brief Function called to indicate that audio is now going to flow */
206 static int multicast_rtp_activate(struct ast_rtp_instance *instance)
207 {
208         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
209
210         if (multicast->type != MULTICAST_TYPE_LINKSYS) {
211                 return 0;
212         }
213
214         return multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STARTCMD);
215 }
216
217 /*! \brief Function called to destroy a multicast instance */
218 static int multicast_rtp_destroy(struct ast_rtp_instance *instance)
219 {
220         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
221
222         if (multicast->type == MULTICAST_TYPE_LINKSYS) {
223                 multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STOPCMD);
224         }
225
226         close(multicast->socket);
227
228         ast_free(multicast);
229
230         return 0;
231 }
232
233 /*! \brief Function called to broadcast some audio on a multicast instance */
234 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
235 {
236         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
237         struct ast_frame *f = frame;
238         struct ast_sockaddr remote_address;
239         int hdrlen = 12, res = 0, codec;
240         unsigned char *rtpheader;
241         unsigned int ms = calc_txstamp(multicast, &frame->delivery);
242         int rate = rtp_get_rate(frame->subclass.format) / 1000;
243
244         /* We only accept audio, nothing else */
245         if (frame->frametype != AST_FRAME_VOICE) {
246                 return 0;
247         }
248
249         /* Grab the actual payload number for when we create the RTP packet */
250         if ((codec = ast_rtp_codecs_payload_code(ast_rtp_instance_get_codecs(instance), 1, frame->subclass.format, 0)) < 0) {
251                 return -1;
252         }
253
254         /* If we do not have space to construct an RTP header duplicate the frame so we get some */
255         if (frame->offset < hdrlen) {
256                 f = ast_frdup(frame);
257         }
258         
259         /* Calucate last TS */
260         multicast->lastts = multicast->lastts + ms * rate;
261         
262         /* Construct an RTP header for our packet */
263         rtpheader = (unsigned char *)(f->data.ptr - hdrlen);
264         put_unaligned_uint32(rtpheader, htonl((2 << 30) | (codec << 16) | (multicast->seqno)));
265         
266         if (ast_test_flag(f, AST_FRFLAG_HAS_TIMING_INFO)) {
267                 put_unaligned_uint32(rtpheader + 4, htonl(f->ts * 8));
268         } else {
269                 put_unaligned_uint32(rtpheader + 4, htonl(multicast->lastts));
270         }
271
272         put_unaligned_uint32(rtpheader + 8, htonl(multicast->ssrc));
273
274         /* Increment sequence number and wrap to 0 if it overflows 16 bits. */
275         multicast->seqno = 0xFFFF & (multicast->seqno + 1);
276
277         /* Finally send it out to the eager phones listening for us */
278         ast_rtp_instance_get_remote_address(instance, &remote_address);
279
280         if (ast_sendto(multicast->socket, (void *) rtpheader, f->datalen + hdrlen, 0, &remote_address) < 0) {
281                 ast_log(LOG_ERROR, "Multicast RTP Transmission error to %s: %s\n",
282                         ast_sockaddr_stringify(&remote_address),
283                         strerror(errno));
284                 res = -1;
285         }
286
287         /* If we were forced to duplicate the frame free the new one */
288         if (frame != f) {
289                 ast_frfree(f);
290         }
291
292         return res;
293 }
294
295 /*! \brief Function called to read from a multicast instance */
296 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
297 {
298         return &ast_null_frame;
299 }
300
301 static int load_module(void)
302 {
303         if (ast_rtp_engine_register(&multicast_rtp_engine)) {
304                 return AST_MODULE_LOAD_DECLINE;
305         }
306
307         return AST_MODULE_LOAD_SUCCESS;
308 }
309
310 static int unload_module(void)
311 {
312         ast_rtp_engine_unregister(&multicast_rtp_engine);
313
314         return 0;
315 }
316
317 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Multicast RTP Engine",
318         .support_level = AST_MODULE_SUPPORT_CORE,
319         .load = load_module,
320         .unload = unload_module,
321         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
322 );