Add support for multicast RTP paging.
[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
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include <sys/time.h>
34 #include <signal.h>
35 #include <fcntl.h>
36 #include <math.h>
37
38 #include "asterisk/pbx.h"
39 #include "asterisk/frame.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/acl.h"
42 #include "asterisk/config.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/utils.h"
45 #include "asterisk/netsock.h"
46 #include "asterisk/cli.h"
47 #include "asterisk/manager.h"
48 #include "asterisk/unaligned.h"
49 #include "asterisk/module.h"
50 #include "asterisk/rtp_engine.h"
51
52 /*! Command value used for Linksys paging to indicate we are starting */
53 #define LINKSYS_MCAST_STARTCMD 6
54
55 /*! Command value used for Linksys paging to indicate we are stopping */
56 #define LINKSYS_MCAST_STOPCMD 7
57
58 /*! \brief Type of paging to do */
59 enum multicast_type {
60         /*! Simple multicast enabled client/receiver paging like Snom and Barix uses */
61         MULTICAST_TYPE_BASIC = 0,
62         /*! More advanced Linksys type paging which requires a start and stop packet */
63         MULTICAST_TYPE_LINKSYS,
64 };
65
66 /*! \brief Structure for a Linksys control packet */
67 struct multicast_control_packet {
68         /*! Unique identifier for the control packet */
69         uint32_t unique_id;
70         /*! Actual command in the control packet */
71         uint32_t command;
72         /*! IP address for the RTP */
73         uint32_t ip;
74         /*! Port for the RTP */
75         uint32_t port;
76 };
77
78 /*! \brief Structure for a multicast paging instance */
79 struct multicast_rtp {
80         /*! TYpe of multicast paging this instance is doing */
81         enum multicast_type type;
82         /*! Socket used for sending the audio on */
83         int socket;
84         /*! Synchronization source value, used when creating/sending the RTP packet */
85         unsigned int ssrc;
86         /*! Sequence number, used when creating/sending the RTP packet */
87         unsigned int seqno;
88 };
89
90 /* Forward Declarations */
91 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct sched_context *sched, struct sockaddr_in *sin, void *data);
92 static int multicast_rtp_activate(struct ast_rtp_instance *instance);
93 static int multicast_rtp_destroy(struct ast_rtp_instance *instance);
94 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
95 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
96
97 /* RTP Engine Declaration */
98 static struct ast_rtp_engine multicast_rtp_engine = {
99         .name = "multicast",
100         .new = multicast_rtp_new,
101         .activate = multicast_rtp_activate,
102         .destroy = multicast_rtp_destroy,
103         .write = multicast_rtp_write,
104         .read = multicast_rtp_read,
105 };
106
107 /*! \brief Function called to create a new multicast instance */
108 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct sched_context *sched, struct sockaddr_in *sin, void *data)
109 {
110         struct multicast_rtp *multicast;
111         const char *type = data;
112
113         if (!(multicast = ast_calloc(1, sizeof(*multicast)))) {
114                 return -1;
115         }
116
117         if (!strcasecmp(type, "basic")) {
118                 multicast->type = MULTICAST_TYPE_BASIC;
119         } else if (!strcasecmp(type, "linksys")) {
120                 multicast->type = MULTICAST_TYPE_LINKSYS;
121         } else {
122                 ast_free(multicast);
123                 return -1;
124         }
125
126         if ((multicast->socket = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
127                 ast_free(multicast);
128                 return -1;
129         }
130
131         multicast->ssrc = ast_random();
132
133         ast_rtp_instance_set_data(instance, multicast);
134
135         return 0;
136 }
137
138 /*! \brief Helper function which populates a control packet with useful information and sends it */
139 static int multicast_send_control_packet(struct ast_rtp_instance *instance, struct multicast_rtp *multicast, int command)
140 {
141         struct multicast_control_packet control_packet = { .unique_id = htonl((u_long)time(NULL)),
142                                                            .command = htonl(command),
143         };
144         struct sockaddr_in control_address, remote_address;
145
146         ast_rtp_instance_get_local_address(instance, &control_address);
147         ast_rtp_instance_get_remote_address(instance, &remote_address);
148
149         /* Ensure the user of us have given us both the control address and destination address */
150         if (!control_address.sin_addr.s_addr || !remote_address.sin_addr.s_addr) {
151                 return -1;
152         }
153
154         control_packet.ip = remote_address.sin_addr.s_addr;
155         control_packet.port = htonl(ntohs(remote_address.sin_port));
156
157         /* Based on a recommendation by Brian West who did the FreeSWITCH implementation we send control packets twice */
158         sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, (struct sockaddr *)&control_address, sizeof(control_address));
159         sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, (struct sockaddr *)&control_address, sizeof(control_address));
160
161         return 0;
162 }
163
164 /*! \brief Function called to indicate that audio is now going to flow */
165 static int multicast_rtp_activate(struct ast_rtp_instance *instance)
166 {
167         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
168
169         if (multicast->type != MULTICAST_TYPE_LINKSYS) {
170                 return 0;
171         }
172
173         return multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STARTCMD);
174 }
175
176 /*! \brief Function called to destroy a multicast instance */
177 static int multicast_rtp_destroy(struct ast_rtp_instance *instance)
178 {
179         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
180
181         if (multicast->type == MULTICAST_TYPE_LINKSYS) {
182                 multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STOPCMD);
183         }
184
185         close(multicast->socket);
186
187         ast_free(multicast);
188
189         return 0;
190 }
191
192 /*! \brief Function called to broadcast some audio on a multicast instance */
193 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
194 {
195         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
196         struct ast_frame *f = frame;
197         struct sockaddr_in remote_address;
198         int hdrlen = 12, res, codec;
199         unsigned char *rtpheader;
200
201         /* We only accept audio, nothing else */
202         if (frame->frametype != AST_FRAME_VOICE) {
203                 return 0;
204         }
205
206         /* Grab the actual payload number for when we create the RTP packet */
207         if ((codec = ast_rtp_codecs_payload_code(ast_rtp_instance_get_codecs(instance), 1, frame->subclass)) < 0) {
208                 return -1;
209         }
210
211         /* If we do not have space to construct an RTP header duplicate the frame so we get some */
212         if (frame->offset < hdrlen) {
213                 f = ast_frdup(frame);
214         }
215
216         /* Construct an RTP header for our packet */
217         rtpheader = (unsigned char *)(f->data.ptr - hdrlen);
218         put_unaligned_uint32(rtpheader, htonl((2 << 30) | (codec << 16) | (multicast->seqno++) | (0 << 23)));
219         put_unaligned_uint32(rtpheader + 4, htonl(f->ts * 8));
220         put_unaligned_uint32(rtpheader + 8, htonl(multicast->ssrc));
221
222         /* Finally send it out to the eager phones listening for us */
223         ast_rtp_instance_get_remote_address(instance, &remote_address);
224         res = sendto(multicast->socket, (void *) rtpheader, f->datalen + hdrlen, 0, (struct sockaddr *) &remote_address, sizeof(remote_address));
225
226         if (res < 0) {
227                 ast_log(LOG_ERROR, "Multicast RTP Transmission error to %s:%u: %s\n",
228                         ast_inet_ntoa(remote_address.sin_addr), ntohs(remote_address.sin_port), strerror(errno));
229         }
230
231         /* If we were forced to duplicate the frame free the new one */
232         if (frame != f) {
233                 ast_frfree(f);
234         }
235
236         return res;
237 }
238
239 /*! \brief Function called to read from a multicast instance */
240 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
241 {
242         return &ast_null_frame;
243 }
244
245 static int load_module(void)
246 {
247         if (ast_rtp_engine_register(&multicast_rtp_engine)) {
248                 return AST_MODULE_LOAD_DECLINE;
249         }
250
251         return AST_MODULE_LOAD_SUCCESS;
252 }
253
254 static int unload_module(void)
255 {
256         ast_rtp_engine_unregister(&multicast_rtp_engine);
257
258         return 0;
259 }
260
261 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Multicast RTP Engine");