Merged revisions 328247 via svnmerge from
[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         unsigned int seqno;
93 };
94
95 /* Forward Declarations */
96 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data);
97 static int multicast_rtp_activate(struct ast_rtp_instance *instance);
98 static int multicast_rtp_destroy(struct ast_rtp_instance *instance);
99 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame);
100 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp);
101
102 /* RTP Engine Declaration */
103 static struct ast_rtp_engine multicast_rtp_engine = {
104         .name = "multicast",
105         .new = multicast_rtp_new,
106         .activate = multicast_rtp_activate,
107         .destroy = multicast_rtp_destroy,
108         .write = multicast_rtp_write,
109         .read = multicast_rtp_read,
110 };
111
112 /*! \brief Function called to create a new multicast instance */
113 static int multicast_rtp_new(struct ast_rtp_instance *instance, struct ast_sched_context *sched, struct ast_sockaddr *addr, void *data)
114 {
115         struct multicast_rtp *multicast;
116         const char *type = data;
117
118         if (!(multicast = ast_calloc(1, sizeof(*multicast)))) {
119                 return -1;
120         }
121
122         if (!strcasecmp(type, "basic")) {
123                 multicast->type = MULTICAST_TYPE_BASIC;
124         } else if (!strcasecmp(type, "linksys")) {
125                 multicast->type = MULTICAST_TYPE_LINKSYS;
126         } else {
127                 ast_free(multicast);
128                 return -1;
129         }
130
131         if ((multicast->socket = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
132                 ast_free(multicast);
133                 return -1;
134         }
135
136         multicast->ssrc = ast_random();
137
138         ast_rtp_instance_set_data(instance, multicast);
139
140         return 0;
141 }
142
143 /*! \brief Helper function which populates a control packet with useful information and sends it */
144 static int multicast_send_control_packet(struct ast_rtp_instance *instance, struct multicast_rtp *multicast, int command)
145 {
146         struct multicast_control_packet control_packet = { .unique_id = htonl((u_long)time(NULL)),
147                                                            .command = htonl(command),
148         };
149         struct ast_sockaddr control_address, remote_address;
150
151         ast_rtp_instance_get_local_address(instance, &control_address);
152         ast_rtp_instance_get_remote_address(instance, &remote_address);
153
154         /* Ensure the user of us have given us both the control address and destination address */
155         if (ast_sockaddr_isnull(&control_address) ||
156             ast_sockaddr_isnull(&remote_address)) {
157                 return -1;
158         }
159
160         /* The protocol only supports IPv4. */
161         if (ast_sockaddr_is_ipv6(&remote_address)) {
162                 ast_log(LOG_WARNING, "Cannot send control packet for IPv6 "
163                         "remote address.\n");
164                 return -1;
165         }
166
167         control_packet.ip = htonl(ast_sockaddr_ipv4(&remote_address));
168         control_packet.port = htonl(ast_sockaddr_port(&remote_address));
169
170         /* Based on a recommendation by Brian West who did the FreeSWITCH implementation we send control packets twice */
171         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
172         ast_sendto(multicast->socket, &control_packet, sizeof(control_packet), 0, &control_address);
173
174         return 0;
175 }
176
177 /*! \brief Function called to indicate that audio is now going to flow */
178 static int multicast_rtp_activate(struct ast_rtp_instance *instance)
179 {
180         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
181
182         if (multicast->type != MULTICAST_TYPE_LINKSYS) {
183                 return 0;
184         }
185
186         return multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STARTCMD);
187 }
188
189 /*! \brief Function called to destroy a multicast instance */
190 static int multicast_rtp_destroy(struct ast_rtp_instance *instance)
191 {
192         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
193
194         if (multicast->type == MULTICAST_TYPE_LINKSYS) {
195                 multicast_send_control_packet(instance, multicast, LINKSYS_MCAST_STOPCMD);
196         }
197
198         close(multicast->socket);
199
200         ast_free(multicast);
201
202         return 0;
203 }
204
205 /*! \brief Function called to broadcast some audio on a multicast instance */
206 static int multicast_rtp_write(struct ast_rtp_instance *instance, struct ast_frame *frame)
207 {
208         struct multicast_rtp *multicast = ast_rtp_instance_get_data(instance);
209         struct ast_frame *f = frame;
210         struct ast_sockaddr remote_address;
211         int hdrlen = 12, res, codec;
212         unsigned char *rtpheader;
213
214         /* We only accept audio, nothing else */
215         if (frame->frametype != AST_FRAME_VOICE) {
216                 return 0;
217         }
218
219         /* Grab the actual payload number for when we create the RTP packet */
220         if ((codec = ast_rtp_codecs_payload_code(ast_rtp_instance_get_codecs(instance), 1, &frame->subclass.format, 0)) < 0) {
221                 return -1;
222         }
223
224         /* If we do not have space to construct an RTP header duplicate the frame so we get some */
225         if (frame->offset < hdrlen) {
226                 f = ast_frdup(frame);
227         }
228
229         /* Construct an RTP header for our packet */
230         rtpheader = (unsigned char *)(f->data.ptr - hdrlen);
231         put_unaligned_uint32(rtpheader, htonl((2 << 30) | (codec << 16) | (multicast->seqno++) | (0 << 23)));
232         put_unaligned_uint32(rtpheader + 4, htonl(f->ts * 8));
233         put_unaligned_uint32(rtpheader + 8, htonl(multicast->ssrc));
234
235         /* Finally send it out to the eager phones listening for us */
236         ast_rtp_instance_get_remote_address(instance, &remote_address);
237         res = ast_sendto(multicast->socket, (void *) rtpheader, f->datalen + hdrlen, 0, &remote_address);
238
239         if (res < 0) {
240                 ast_log(LOG_ERROR, "Multicast RTP Transmission error to %s: %s\n",
241                         ast_sockaddr_stringify(&remote_address),
242                         strerror(errno));
243         }
244
245         /* If we were forced to duplicate the frame free the new one */
246         if (frame != f) {
247                 ast_frfree(f);
248         }
249
250         return res;
251 }
252
253 /*! \brief Function called to read from a multicast instance */
254 static struct ast_frame *multicast_rtp_read(struct ast_rtp_instance *instance, int rtcp)
255 {
256         return &ast_null_frame;
257 }
258
259 static int load_module(void)
260 {
261         if (ast_rtp_engine_register(&multicast_rtp_engine)) {
262                 return AST_MODULE_LOAD_DECLINE;
263         }
264
265         return AST_MODULE_LOAD_SUCCESS;
266 }
267
268 static int unload_module(void)
269 {
270         ast_rtp_engine_unregister(&multicast_rtp_engine);
271
272         return 0;
273 }
274
275 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Multicast RTP Engine",
276         .load = load_module,
277         .unload = unload_module,
278         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
279 );