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