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