2 * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
3 * Copyright (C) <2009> Jarkko Palviainen <jarkko.palviainen@sesca.com>
4 * Copyright (C) <2012> Collabora Ltd.
5 * Author: Sebastian Dröge <sebastian.droege@collabora.co.uk>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 * SECTION:element-multiudpsink
25 * @see_also: udpsink, multifdsink
27 * multiudpsink is a network sink that sends UDP packets to multiple
29 * It can be combined with rtp payload encoders to implement RTP streaming.
35 #include "gstmultiudpsink.h"
38 #ifdef HAVE_SYS_SOCKET_H
39 #include <sys/socket.h>
43 #include <netinet/in.h>
46 #include "gst/glib-compat-private.h"
48 GST_DEBUG_CATEGORY_STATIC (multiudpsink_debug);
49 #define GST_CAT_DEFAULT (multiudpsink_debug)
51 #define UDP_MAX_SIZE 65507
53 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
58 /* MultiUDPSink signals and args */
69 SIGNAL_CLIENT_REMOVED,
75 #define DEFAULT_SOCKET NULL
76 #define DEFAULT_CLOSE_SOCKET TRUE
77 #define DEFAULT_USED_SOCKET NULL
78 #define DEFAULT_CLIENTS NULL
79 /* FIXME, this should be disabled by default, we don't need to join a multicast
80 * group for sending, if this socket is also used for receiving, it should
81 * be configured in the element that does the receive. */
82 #define DEFAULT_AUTO_MULTICAST TRUE
83 #define DEFAULT_MULTICAST_IFACE NULL
84 #define DEFAULT_TTL 64
85 #define DEFAULT_TTL_MC 1
86 #define DEFAULT_LOOP TRUE
87 #define DEFAULT_FORCE_IPV4 FALSE
88 #define DEFAULT_QOS_DSCP -1
89 #define DEFAULT_SEND_DUPLICATES TRUE
90 #define DEFAULT_BUFFER_SIZE 0
91 #define DEFAULT_BIND_ADDRESS NULL
92 #define DEFAULT_BIND_PORT 0
106 PROP_MULTICAST_IFACE,
112 PROP_SEND_DUPLICATES,
118 static void gst_multiudpsink_finalize (GObject * object);
120 static GstFlowReturn gst_multiudpsink_render (GstBaseSink * sink,
122 static GstFlowReturn gst_multiudpsink_render_list (GstBaseSink * bsink,
123 GstBufferList * buffer_list);
125 static gboolean gst_multiudpsink_start (GstBaseSink * bsink);
126 static gboolean gst_multiudpsink_stop (GstBaseSink * bsink);
127 static gboolean gst_multiudpsink_unlock (GstBaseSink * bsink);
128 static gboolean gst_multiudpsink_unlock_stop (GstBaseSink * bsink);
130 static void gst_multiudpsink_set_property (GObject * object, guint prop_id,
131 const GValue * value, GParamSpec * pspec);
132 static void gst_multiudpsink_get_property (GObject * object, guint prop_id,
133 GValue * value, GParamSpec * pspec);
135 static void gst_multiudpsink_add_internal (GstMultiUDPSink * sink,
136 const gchar * host, gint port, gboolean lock);
137 static void gst_multiudpsink_clear_internal (GstMultiUDPSink * sink,
140 static guint gst_multiudpsink_signals[LAST_SIGNAL] = { 0 };
142 #define gst_multiudpsink_parent_class parent_class
143 G_DEFINE_TYPE (GstMultiUDPSink, gst_multiudpsink, GST_TYPE_BASE_SINK);
146 gst_multiudpsink_class_init (GstMultiUDPSinkClass * klass)
148 GObjectClass *gobject_class;
149 GstElementClass *gstelement_class;
150 GstBaseSinkClass *gstbasesink_class;
152 gobject_class = (GObjectClass *) klass;
153 gstelement_class = (GstElementClass *) klass;
154 gstbasesink_class = (GstBaseSinkClass *) klass;
156 gobject_class->set_property = gst_multiudpsink_set_property;
157 gobject_class->get_property = gst_multiudpsink_get_property;
158 gobject_class->finalize = gst_multiudpsink_finalize;
161 * GstMultiUDPSink::add:
162 * @gstmultiudpsink: the sink on which the signal is emitted
163 * @host: the hostname/IP address of the client to add
164 * @port: the port of the client to add
166 * Add a client with destination @host and @port to the list of
167 * clients. When the same host/port pair is added multiple times, the
168 * send-duplicates property defines if the packets are sent multiple times to
169 * the same host/port pair or not.
171 * When a host/port pair is added multiple times, an equal amount of remove
172 * calls must be performed to actually remove the host/port pair from the list
175 gst_multiudpsink_signals[SIGNAL_ADD] =
176 g_signal_new ("add", G_TYPE_FROM_CLASS (klass),
177 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
178 G_STRUCT_OFFSET (GstMultiUDPSinkClass, add),
179 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
180 G_TYPE_STRING, G_TYPE_INT);
182 * GstMultiUDPSink::remove:
183 * @gstmultiudpsink: the sink on which the signal is emitted
184 * @host: the hostname/IP address of the client to remove
185 * @port: the port of the client to remove
187 * Remove the client with destination @host and @port from the list of
190 gst_multiudpsink_signals[SIGNAL_REMOVE] =
191 g_signal_new ("remove", G_TYPE_FROM_CLASS (klass),
192 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
193 G_STRUCT_OFFSET (GstMultiUDPSinkClass, remove),
194 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
195 G_TYPE_STRING, G_TYPE_INT);
197 * GstMultiUDPSink::clear:
198 * @gstmultiudpsink: the sink on which the signal is emitted
200 * Clear the list of clients.
202 gst_multiudpsink_signals[SIGNAL_CLEAR] =
203 g_signal_new ("clear", G_TYPE_FROM_CLASS (klass),
204 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
205 G_STRUCT_OFFSET (GstMultiUDPSinkClass, clear),
206 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 0);
208 * GstMultiUDPSink::get-stats:
209 * @gstmultiudpsink: the sink on which the signal is emitted
210 * @host: the hostname/IP address of the client to get stats on
211 * @port: the port of the client to get stats on
213 * Get the statistics of the client with destination @host and @port.
215 * Returns: a GstStructure: bytes_sent, packets_sent,
216 * connect_time (in epoch seconds), disconnect_time (in epoch seconds)
218 gst_multiudpsink_signals[SIGNAL_GET_STATS] =
219 g_signal_new ("get-stats", G_TYPE_FROM_CLASS (klass),
220 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
221 G_STRUCT_OFFSET (GstMultiUDPSinkClass, get_stats),
222 NULL, NULL, g_cclosure_marshal_generic, GST_TYPE_STRUCTURE, 2,
223 G_TYPE_STRING, G_TYPE_INT);
225 * GstMultiUDPSink::client-added:
226 * @gstmultiudpsink: the sink emitting the signal
227 * @host: the hostname/IP address of the added client
228 * @port: the port of the added client
230 * Signal emited when a new client is added to the list of
233 gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED] =
234 g_signal_new ("client-added", G_TYPE_FROM_CLASS (klass),
235 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, client_added),
236 NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
237 G_TYPE_STRING, G_TYPE_INT);
239 * GstMultiUDPSink::client-removed:
240 * @gstmultiudpsink: the sink emitting the signal
241 * @host: the hostname/IP address of the removed client
242 * @port: the port of the removed client
244 * Signal emited when a client is removed from the list of
247 gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED] =
248 g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass),
249 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass,
250 client_removed), NULL, NULL, g_cclosure_marshal_generic,
251 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
253 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BYTES_TO_SERVE,
254 g_param_spec_uint64 ("bytes-to-serve", "Bytes to serve",
255 "Number of bytes received to serve to clients", 0, G_MAXUINT64, 0,
256 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
257 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BYTES_SERVED,
258 g_param_spec_uint64 ("bytes-served", "Bytes served",
259 "Total number of bytes sent to all clients", 0, G_MAXUINT64, 0,
260 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
261 g_object_class_install_property (gobject_class, PROP_SOCKET,
262 g_param_spec_object ("socket", "Socket Handle",
263 "Socket to use for UDP sending. (NULL == allocate)",
264 G_TYPE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
265 g_object_class_install_property (gobject_class, PROP_SOCKET_V6,
266 g_param_spec_object ("socket-v6", "Socket Handle IPv6",
267 "Socket to use for UDPv6 sending. (NULL == allocate)",
268 G_TYPE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
269 g_object_class_install_property (gobject_class, PROP_CLOSE_SOCKET,
270 g_param_spec_boolean ("close-socket", "Close socket",
271 "Close socket if passed as property on state change",
272 DEFAULT_CLOSE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
273 g_object_class_install_property (gobject_class, PROP_USED_SOCKET,
274 g_param_spec_object ("used-socket", "Used Socket Handle",
275 "Socket currently in use for UDP sending. (NULL == no socket)",
276 G_TYPE_SOCKET, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
277 g_object_class_install_property (gobject_class, PROP_USED_SOCKET_V6,
278 g_param_spec_object ("used-socket-v6", "Used Socket Handle IPv6",
279 "Socket currently in use for UDPv6 sending. (NULL == no socket)",
280 G_TYPE_SOCKET, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
281 g_object_class_install_property (gobject_class, PROP_CLIENTS,
282 g_param_spec_string ("clients", "Clients",
283 "A comma separated list of host:port pairs with destinations",
284 DEFAULT_CLIENTS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
285 g_object_class_install_property (gobject_class, PROP_AUTO_MULTICAST,
286 g_param_spec_boolean ("auto-multicast",
287 "Automatically join/leave multicast groups",
288 "Automatically join/leave the multicast groups, FALSE means user"
289 " has to do it himself", DEFAULT_AUTO_MULTICAST,
290 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
291 g_object_class_install_property (gobject_class, PROP_MULTICAST_IFACE,
292 g_param_spec_string ("multicast-iface", "Multicast Interface",
293 "The network interface on which to join the multicast group",
294 DEFAULT_MULTICAST_IFACE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
295 g_object_class_install_property (gobject_class, PROP_TTL,
296 g_param_spec_int ("ttl", "Unicast TTL",
297 "Used for setting the unicast TTL parameter",
298 0, 255, DEFAULT_TTL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
299 g_object_class_install_property (gobject_class, PROP_TTL_MC,
300 g_param_spec_int ("ttl-mc", "Multicast TTL",
301 "Used for setting the multicast TTL parameter",
302 0, 255, DEFAULT_TTL_MC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
303 g_object_class_install_property (gobject_class, PROP_LOOP,
304 g_param_spec_boolean ("loop", "Multicast Loopback",
305 "Used for setting the multicast loop parameter. TRUE = enable,"
306 " FALSE = disable", DEFAULT_LOOP,
307 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
309 * GstMultiUDPSink::force-ipv4:
311 * Force the use of an IPv4 socket.
315 #ifndef GST_REMOVE_DEPRECATED
316 g_object_class_install_property (gobject_class, PROP_FORCE_IPV4,
317 g_param_spec_boolean ("force-ipv4", "Force IPv4",
318 "Forcing the use of an IPv4 socket (DEPRECATED, has no effect anymore)",
320 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_DEPRECATED));
322 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QOS_DSCP,
323 g_param_spec_int ("qos-dscp", "QoS diff srv code point",
324 "Quality of Service, differentiated services code point (-1 default)",
325 -1, 63, DEFAULT_QOS_DSCP,
326 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
328 * GstMultiUDPSink::send-duplicates:
330 * When a host/port pair is added mutliple times, send the packet to the host
331 * multiple times as well.
333 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEND_DUPLICATES,
334 g_param_spec_boolean ("send-duplicates", "Send Duplicates",
335 "When a distination/port pair is added multiple times, send packets "
336 "multiple times as well", DEFAULT_SEND_DUPLICATES,
337 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
339 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BUFFER_SIZE,
340 g_param_spec_int ("buffer-size", "Buffer Size",
341 "Size of the kernel send buffer in bytes, 0=default", 0, G_MAXINT,
342 DEFAULT_BUFFER_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
344 g_object_class_install_property (gobject_class, PROP_BIND_ADDRESS,
345 g_param_spec_string ("bind-address", "Bind Address",
346 "Address to bind the socket to", DEFAULT_BIND_ADDRESS,
347 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
348 g_object_class_install_property (gobject_class, PROP_BIND_PORT,
349 g_param_spec_int ("bind-port", "Bind Port",
350 "Port to bind the socket to", 0, G_MAXUINT16,
351 DEFAULT_BIND_PORT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
353 gst_element_class_add_static_pad_template (gstelement_class, &sink_template);
355 gst_element_class_set_static_metadata (gstelement_class, "UDP packet sender",
357 "Send data over the network via UDP to one or multiple recipients "
358 "which can be added or removed at runtime using action signals",
359 "Wim Taymans <wim.taymans@gmail.com>");
361 gstbasesink_class->render = gst_multiudpsink_render;
362 gstbasesink_class->render_list = gst_multiudpsink_render_list;
363 gstbasesink_class->start = gst_multiudpsink_start;
364 gstbasesink_class->stop = gst_multiudpsink_stop;
365 gstbasesink_class->unlock = gst_multiudpsink_unlock;
366 gstbasesink_class->unlock_stop = gst_multiudpsink_unlock_stop;
367 klass->add = gst_multiudpsink_add;
368 klass->remove = gst_multiudpsink_remove;
369 klass->clear = gst_multiudpsink_clear;
370 klass->get_stats = gst_multiudpsink_get_stats;
372 GST_DEBUG_CATEGORY_INIT (multiudpsink_debug, "multiudpsink", 0, "UDP sink");
376 gst_multiudpsink_create_cancellable (GstMultiUDPSink * sink)
380 sink->cancellable = g_cancellable_new ();
381 sink->made_cancel_fd = g_cancellable_make_pollfd (sink->cancellable, &pollfd);
385 gst_multiudpsink_free_cancellable (GstMultiUDPSink * sink)
387 if (sink->made_cancel_fd) {
388 g_cancellable_release_fd (sink->cancellable);
389 sink->made_cancel_fd = FALSE;
391 g_object_unref (sink->cancellable);
392 sink->cancellable = NULL;
396 gst_multiudpsink_init (GstMultiUDPSink * sink)
400 g_mutex_init (&sink->client_lock);
401 sink->clients = NULL;
402 sink->num_v4_unique = 0;
403 sink->num_v4_all = 0;
404 sink->num_v6_unique = 0;
405 sink->num_v6_all = 0;
407 sink->socket = DEFAULT_SOCKET;
408 sink->socket_v6 = DEFAULT_SOCKET;
409 sink->used_socket = DEFAULT_USED_SOCKET;
410 sink->used_socket_v6 = DEFAULT_USED_SOCKET;
411 sink->close_socket = DEFAULT_CLOSE_SOCKET;
412 sink->external_socket = (sink->socket != NULL);
413 sink->auto_multicast = DEFAULT_AUTO_MULTICAST;
414 sink->ttl = DEFAULT_TTL;
415 sink->ttl_mc = DEFAULT_TTL_MC;
416 sink->loop = DEFAULT_LOOP;
417 sink->force_ipv4 = DEFAULT_FORCE_IPV4;
418 sink->qos_dscp = DEFAULT_QOS_DSCP;
419 sink->send_duplicates = DEFAULT_SEND_DUPLICATES;
420 sink->multi_iface = g_strdup (DEFAULT_MULTICAST_IFACE);
422 gst_multiudpsink_create_cancellable (sink);
424 /* pre-allocate OutputVector, MapInfo and OutputMessage arrays
425 * for use in the render and render_list functions */
426 max_mem = gst_buffer_get_max_memory ();
428 sink->n_vecs = max_mem;
429 sink->vecs = g_new (GOutputVector, sink->n_vecs);
431 sink->n_maps = max_mem;
432 sink->maps = g_new (GstMapInfo, sink->n_maps);
434 sink->n_messages = 1;
435 sink->messages = g_new (GstOutputMessage, sink->n_messages);
437 /* we assume that the number of memories per buffer can fit into a guint8 */
438 g_warn_if_fail (max_mem <= G_MAXUINT8);
441 static GstUDPClient *
442 gst_udp_client_new (GstMultiUDPSink * sink, const gchar * host, gint port)
444 GstUDPClient *client;
449 addr = g_inet_address_new_from_string (host);
453 resolver = g_resolver_get_default ();
455 g_resolver_lookup_by_name (resolver, host, sink->cancellable, &err);
458 addr = G_INET_ADDRESS (g_object_ref (results->data));
460 g_resolver_free_addresses (results);
461 g_object_unref (resolver);
463 #ifndef GST_DISABLE_GST_DEBUG
465 gchar *ip = g_inet_address_to_string (addr);
467 GST_DEBUG_OBJECT (sink, "IP address for host %s is %s", host, ip);
472 client = g_slice_new0 (GstUDPClient);
473 client->ref_count = 1;
474 client->add_count = 0;
475 client->host = g_strdup (host);
477 client->addr = g_inet_socket_address_new (addr, port);
478 g_object_unref (addr);
484 g_clear_error (&err);
485 g_object_unref (resolver);
491 /* call with client lock held */
493 gst_udp_client_unref (GstUDPClient * client)
495 if (--client->ref_count == 0) {
496 g_object_unref (client->addr);
497 g_free (client->host);
498 g_slice_free (GstUDPClient, client);
502 /* call with client lock held */
503 static inline GstUDPClient *
504 gst_udp_client_ref (GstUDPClient * client)
511 client_compare (GstUDPClient * a, GstUDPClient * b)
513 if ((a->port == b->port) && (strcmp (a->host, b->host) == 0))
520 gst_multiudpsink_finalize (GObject * object)
522 GstMultiUDPSink *sink;
524 sink = GST_MULTIUDPSINK (object);
526 g_list_foreach (sink->clients, (GFunc) gst_udp_client_unref, NULL);
527 g_list_free (sink->clients);
530 g_object_unref (sink->socket);
534 g_object_unref (sink->socket_v6);
535 sink->socket_v6 = NULL;
537 if (sink->used_socket)
538 g_object_unref (sink->used_socket);
539 sink->used_socket = NULL;
541 if (sink->used_socket_v6)
542 g_object_unref (sink->used_socket_v6);
543 sink->used_socket_v6 = NULL;
545 gst_multiudpsink_free_cancellable (sink);
547 g_free (sink->multi_iface);
548 sink->multi_iface = NULL;
554 g_free (sink->messages);
555 sink->messages = NULL;
557 g_free (sink->bind_address);
558 sink->bind_address = NULL;
560 g_mutex_clear (&sink->client_lock);
562 G_OBJECT_CLASS (parent_class)->finalize (object);
565 /* replacement until we can depend unconditionally on the real one in GLib */
566 #ifndef HAVE_G_SOCKET_SEND_MESSAGES
567 #define g_socket_send_messages gst_socket_send_messages
570 gst_socket_send_messages (GSocket * socket, GstOutputMessage * messages,
571 guint num_messages, gint flags, GCancellable * cancellable, GError ** error)
576 for (i = 0; i < num_messages; ++i) {
577 GstOutputMessage *msg = &messages[i];
578 GError *msg_error = NULL;
580 result = g_socket_send_message (socket, msg->address,
581 msg->vectors, msg->num_vectors,
582 msg->control_messages, msg->num_control_messages,
583 flags, cancellable, &msg_error);
586 /* if we couldn't send all messages, just return how many we did
587 * manage to send, provided we managed to send at least one */
588 if (msg_error->code == G_IO_ERROR_WOULD_BLOCK && i > 0) {
589 g_error_free (msg_error);
592 g_propagate_error (error, msg_error);
597 msg->bytes_sent = result;
602 #endif /* HAVE_G_SOCKET_SEND_MESSAGES */
605 fill_vectors (GOutputVector * vecs, GstMapInfo * maps, guint n, GstBuffer * buf)
611 g_assert (gst_buffer_n_memory (buf) == n);
613 for (i = 0; i < n; ++i) {
614 mem = gst_buffer_peek_memory (buf, i);
615 if (gst_memory_map (mem, &maps[i], GST_MAP_READ)) {
616 vecs[i].buffer = maps[i].data;
617 vecs[i].size = maps[i].size;
619 GST_WARNING ("Failed to map memory %p for reading", mem);
623 size += vecs[i].size;
630 gst_udp_calc_message_size (GstOutputMessage * msg)
635 for (i = 0; i < msg->num_vectors; ++i)
636 size += msg->vectors[i].size;
642 gst_udp_messsages_find_first_not_sent (GstOutputMessage * messages,
647 for (i = 0; i < num_messages; ++i) {
648 GstOutputMessage *msg = &messages[i];
650 if (msg->bytes_sent == 0 && gst_udp_calc_message_size (msg) > 0)
657 static inline gchar *
658 gst_udp_address_get_string (GSocketAddress * addr, gchar * s, gsize size)
660 GInetSocketAddress *isa = G_INET_SOCKET_ADDRESS (addr);
664 ia = g_inet_socket_address_get_address (isa);
665 addr_str = g_inet_address_to_string (ia);
666 g_snprintf (s, size, "%s:%u", addr_str, g_inet_socket_address_get_port (isa));
672 /* Wrapper around g_socket_send_messages() plus error handling (ignoring).
673 * Returns FALSE if we got cancelled, otherwise TRUE. */
675 gst_multiudpsink_send_messages (GstMultiUDPSink * sink, GSocket * socket,
676 GstOutputMessage * messages, guint num_messages)
678 gboolean sent_max_size_warning = FALSE;
680 while (num_messages > 0) {
681 gchar astr[64] G_GNUC_UNUSED;
683 guint msg_size, skip, i;
686 ret = g_socket_send_messages (socket, messages, num_messages, 0,
687 sink->cancellable, &err);
689 if (G_UNLIKELY (ret < 0)) {
690 GstOutputMessage *msg;
692 if (g_error_matches (err, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
693 g_clear_error (&err);
697 err_idx = gst_udp_messsages_find_first_not_sent (messages, num_messages);
701 msg = &messages[err_idx];
702 msg_size = gst_udp_calc_message_size (msg);
704 GST_LOG_OBJECT (sink, "error sending %u bytes to client %s: %s", msg_size,
705 gst_udp_address_get_string (msg->address, astr, sizeof (astr)),
709 if (msg_size > UDP_MAX_SIZE) {
710 if (!sent_max_size_warning) {
711 GST_ELEMENT_WARNING (sink, RESOURCE, WRITE,
712 ("Attempting to send a UDP packets larger than maximum size "
713 "(%u > %d)", msg_size, UDP_MAX_SIZE),
714 ("Reason: %s", err ? err->message : "unknown reason"));
715 sent_max_size_warning = FALSE;
718 GST_ELEMENT_WARNING (sink, RESOURCE, WRITE,
719 ("Error sending UDP packets"), ("client %s, reason: %s",
720 gst_udp_address_get_string (msg->address, astr, sizeof (astr)),
721 (err != NULL) ? err->message : "unknown reason"));
723 for (i = err_idx + 1; i < num_messages; ++i, ++skip) {
724 if (messages[i].address != msg->address)
727 GST_DEBUG_OBJECT (sink, "skipping %d message(s) to same client", skip);
730 /* ignore any errors and try sending the rest */
731 g_clear_error (&err);
735 g_assert (ret <= num_messages);
745 gst_multiudpsink_render_buffers (GstMultiUDPSink * sink, GstBuffer ** buffers,
746 guint num_buffers, guint8 * mem_nums, guint total_mem_num)
748 GstOutputMessage *msgs;
749 gboolean send_duplicates;
750 GstUDPClient **clients;
752 GstMapInfo *map_infos;
753 GstFlowReturn flow_ret;
754 guint num_addr_v4, num_addr_v6;
755 guint num_addr, num_msgs;
760 send_duplicates = sink->send_duplicates;
762 g_mutex_lock (&sink->client_lock);
764 if (send_duplicates) {
765 num_addr_v4 = sink->num_v4_all;
766 num_addr_v6 = sink->num_v6_all;
768 num_addr_v4 = sink->num_v4_unique;
769 num_addr_v6 = sink->num_v6_unique;
771 num_addr = num_addr_v4 + num_addr_v6;
776 clients = g_newa (GstUDPClient *, num_addr);
777 for (l = sink->clients, i = 0; l != NULL; l = l->next) {
778 GstUDPClient *client = l->data;
780 clients[i++] = gst_udp_client_ref (client);
781 for (j = 1; send_duplicates && j < client->add_count; ++j)
782 clients[i++] = gst_udp_client_ref (client);
784 g_assert_cmpuint (i, ==, num_addr);
786 g_mutex_unlock (&sink->client_lock);
788 GST_LOG_OBJECT (sink, "%u buffers, %u memories -> to be sent to %u clients",
789 num_buffers, total_mem_num, num_addr);
791 /* ensure our pre-allocated scratch space arrays are large enough */
792 if (sink->n_vecs < total_mem_num) {
793 sink->n_vecs = GST_ROUND_UP_16 (total_mem_num);
795 sink->vecs = g_new (GOutputVector, sink->n_vecs);
799 if (sink->n_maps < total_mem_num) {
800 sink->n_maps = GST_ROUND_UP_16 (total_mem_num);
802 sink->maps = g_new (GstMapInfo, sink->n_maps);
804 map_infos = sink->maps;
806 num_msgs = num_addr * num_buffers;
807 if (sink->n_messages < num_msgs) {
808 sink->n_messages = GST_ROUND_UP_16 (num_msgs);
809 g_free (sink->messages);
810 sink->messages = g_new (GstOutputMessage, sink->n_messages);
812 msgs = sink->messages;
814 /* populate first num_buffers messages with output vectors for the buffers */
815 for (i = 0, mem = 0; i < num_buffers; ++i) {
816 size += fill_vectors (&vecs[mem], &map_infos[mem], mem_nums[i], buffers[i]);
817 msgs[i].vectors = &vecs[mem];
818 msgs[i].num_vectors = mem_nums[i];
819 msgs[i].num_control_messages = 0;
820 msgs[i].bytes_sent = 0;
821 msgs[i].control_messages = NULL;
822 msgs[i].address = clients[0]->addr;
826 /* FIXME: how about some locking? (there wasn't any before either, but..) */
827 sink->bytes_to_serve += size;
829 /* now copy the pre-filled num_buffer messages over to the next num_buffer
830 * messages for the next client, where we also change the target adddress */
831 for (i = 1; i < num_addr; ++i) {
832 for (j = 0; j < num_buffers; ++j) {
833 msgs[i * num_buffers + j] = msgs[j];
834 msgs[i * num_buffers + j].address = clients[i]->addr;
842 /* no IPv4 socket? Send it all from the IPv6 socket then.. */
843 if (sink->used_socket == NULL) {
844 ret = gst_multiudpsink_send_messages (sink, sink->used_socket_v6,
847 guint num_msgs_v4 = num_buffers * num_addr_v4;
848 guint num_msgs_v6 = num_buffers * num_addr_v6;
850 /* our client list is sorted with IPv4 clients first and IPv6 ones last */
851 ret = gst_multiudpsink_send_messages (sink, sink->used_socket,
857 ret = gst_multiudpsink_send_messages (sink, sink->used_socket_v6,
858 msgs + num_msgs_v4, num_msgs_v6);
865 flow_ret = GST_FLOW_OK;
867 /* now update stats */
868 g_mutex_lock (&sink->client_lock);
870 for (i = 0; i < num_addr; ++i) {
871 GstUDPClient *client = clients[i];
873 for (j = 0; j < num_buffers; ++j) {
876 bytes_sent = msgs[i * num_buffers + j].bytes_sent;
878 client->bytes_sent += bytes_sent;
879 client->packets_sent++;
880 sink->bytes_served += bytes_sent;
882 gst_udp_client_unref (client);
885 g_mutex_unlock (&sink->client_lock);
889 for (i = 0; i < mem; ++i)
890 gst_memory_unmap (map_infos[i].memory, &map_infos[i]);
896 g_mutex_unlock (&sink->client_lock);
897 GST_LOG_OBJECT (sink, "no clients");
902 GST_INFO_OBJECT (sink, "cancelled");
903 flow_ret = GST_FLOW_FLUSHING;
905 g_mutex_lock (&sink->client_lock);
906 for (i = 0; i < num_addr; ++i)
907 gst_udp_client_unref (clients[i]);
908 g_mutex_unlock (&sink->client_lock);
914 gst_multiudpsink_render_list (GstBaseSink * bsink, GstBufferList * buffer_list)
916 GstMultiUDPSink *sink;
921 guint i, num_buffers;
923 sink = GST_MULTIUDPSINK_CAST (bsink);
925 num_buffers = gst_buffer_list_length (buffer_list);
926 if (num_buffers == 0)
929 buffers = g_newa (GstBuffer *, num_buffers);
930 mem_nums = g_newa (guint8, num_buffers);
931 for (i = 0, total_mems = 0; i < num_buffers; ++i) {
932 buffers[i] = gst_buffer_list_get (buffer_list, i);
933 mem_nums[i] = gst_buffer_n_memory (buffers[i]);
934 total_mems += mem_nums[i];
937 flow = gst_multiudpsink_render_buffers (sink, buffers, num_buffers,
938 mem_nums, total_mems);
944 GST_LOG_OBJECT (sink, "empty buffer");
950 gst_multiudpsink_render (GstBaseSink * bsink, GstBuffer * buffer)
952 GstMultiUDPSink *sink;
956 sink = GST_MULTIUDPSINK_CAST (bsink);
958 n_mem = gst_buffer_n_memory (buffer);
961 flow = gst_multiudpsink_render_buffers (sink, &buffer, 1, &n_mem, n_mem);
969 gst_multiudpsink_set_clients_string (GstMultiUDPSink * sink,
970 const gchar * string)
975 clients = g_strsplit (string, ",", 0);
977 g_mutex_lock (&sink->client_lock);
978 /* clear all existing clients */
979 gst_multiudpsink_clear_internal (sink, FALSE);
980 for (i = 0; clients[i]; i++) {
985 p = strstr (clients[i], ":");
988 port = g_ascii_strtoll (p + 1, NULL, 10);
991 gst_multiudpsink_add_internal (sink, host, port, FALSE);
993 g_mutex_unlock (&sink->client_lock);
995 g_strfreev (clients);
999 gst_multiudpsink_get_clients_string (GstMultiUDPSink * sink)
1004 str = g_string_new ("");
1006 g_mutex_lock (&sink->client_lock);
1007 clients = sink->clients;
1009 GstUDPClient *client;
1012 client = (GstUDPClient *) clients->data;
1014 clients = g_list_next (clients);
1016 count = client->add_count;
1018 g_string_append_printf (str, "%s:%d%s", client->host, client->port,
1019 (clients || count > 1 ? "," : ""));
1022 g_mutex_unlock (&sink->client_lock);
1024 return g_string_free (str, FALSE);
1028 gst_multiudpsink_setup_qos_dscp (GstMultiUDPSink * sink, GSocket * socket)
1030 /* don't touch on -1 */
1031 if (sink->qos_dscp < 0)
1042 fd = g_socket_get_fd (socket);
1044 GST_DEBUG_OBJECT (sink, "setting TOS to %d", sink->qos_dscp);
1046 /* Extract and shift 6 bits of DSFIELD */
1047 tos = (sink->qos_dscp & 0x3f) << 2;
1049 if (setsockopt (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0) {
1050 GST_ERROR_OBJECT (sink, "could not set TOS: %s", g_strerror (errno));
1053 if (setsockopt (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0) {
1054 GST_ERROR_OBJECT (sink, "could not set TCLASS: %s", g_strerror (errno));
1062 gst_multiudpsink_set_property (GObject * object, guint prop_id,
1063 const GValue * value, GParamSpec * pspec)
1065 GstMultiUDPSink *udpsink;
1067 udpsink = GST_MULTIUDPSINK (object);
1071 if (udpsink->socket != NULL && udpsink->socket != udpsink->used_socket &&
1072 udpsink->close_socket) {
1075 if (!g_socket_close (udpsink->socket, &err)) {
1076 GST_ERROR ("failed to close socket %p: %s", udpsink->socket,
1078 g_clear_error (&err);
1081 if (udpsink->socket)
1082 g_object_unref (udpsink->socket);
1083 udpsink->socket = g_value_dup_object (value);
1084 GST_DEBUG_OBJECT (udpsink, "setting socket to %p", udpsink->socket);
1086 case PROP_SOCKET_V6:
1087 if (udpsink->socket_v6 != NULL
1088 && udpsink->socket_v6 != udpsink->used_socket_v6
1089 && udpsink->close_socket) {
1092 if (!g_socket_close (udpsink->socket_v6, &err)) {
1093 GST_ERROR ("failed to close socket %p: %s", udpsink->socket_v6,
1095 g_clear_error (&err);
1098 if (udpsink->socket_v6)
1099 g_object_unref (udpsink->socket_v6);
1100 udpsink->socket_v6 = g_value_dup_object (value);
1101 GST_DEBUG_OBJECT (udpsink, "setting socket to %p", udpsink->socket_v6);
1103 case PROP_CLOSE_SOCKET:
1104 udpsink->close_socket = g_value_get_boolean (value);
1107 gst_multiudpsink_set_clients_string (udpsink, g_value_get_string (value));
1109 case PROP_AUTO_MULTICAST:
1110 udpsink->auto_multicast = g_value_get_boolean (value);
1112 case PROP_MULTICAST_IFACE:
1113 g_free (udpsink->multi_iface);
1115 if (g_value_get_string (value) == NULL)
1116 udpsink->multi_iface = g_strdup (DEFAULT_MULTICAST_IFACE);
1118 udpsink->multi_iface = g_value_dup_string (value);
1121 udpsink->ttl = g_value_get_int (value);
1124 udpsink->ttl_mc = g_value_get_int (value);
1127 udpsink->loop = g_value_get_boolean (value);
1129 case PROP_FORCE_IPV4:
1130 udpsink->force_ipv4 = g_value_get_boolean (value);
1133 udpsink->qos_dscp = g_value_get_int (value);
1134 gst_multiudpsink_setup_qos_dscp (udpsink, udpsink->used_socket);
1135 gst_multiudpsink_setup_qos_dscp (udpsink, udpsink->used_socket_v6);
1137 case PROP_SEND_DUPLICATES:
1138 udpsink->send_duplicates = g_value_get_boolean (value);
1140 case PROP_BUFFER_SIZE:
1141 udpsink->buffer_size = g_value_get_int (value);
1143 case PROP_BIND_ADDRESS:
1144 g_free (udpsink->bind_address);
1145 udpsink->bind_address = g_value_dup_string (value);
1147 case PROP_BIND_PORT:
1148 udpsink->bind_port = g_value_get_int (value);
1151 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1157 gst_multiudpsink_get_property (GObject * object, guint prop_id, GValue * value,
1160 GstMultiUDPSink *udpsink;
1162 udpsink = GST_MULTIUDPSINK (object);
1165 case PROP_BYTES_TO_SERVE:
1166 g_value_set_uint64 (value, udpsink->bytes_to_serve);
1168 case PROP_BYTES_SERVED:
1169 g_value_set_uint64 (value, udpsink->bytes_served);
1172 g_value_set_object (value, udpsink->socket);
1174 case PROP_SOCKET_V6:
1175 g_value_set_object (value, udpsink->socket_v6);
1177 case PROP_CLOSE_SOCKET:
1178 g_value_set_boolean (value, udpsink->close_socket);
1180 case PROP_USED_SOCKET:
1181 g_value_set_object (value, udpsink->used_socket);
1183 case PROP_USED_SOCKET_V6:
1184 g_value_set_object (value, udpsink->used_socket_v6);
1187 g_value_take_string (value,
1188 gst_multiudpsink_get_clients_string (udpsink));
1190 case PROP_AUTO_MULTICAST:
1191 g_value_set_boolean (value, udpsink->auto_multicast);
1193 case PROP_MULTICAST_IFACE:
1194 g_value_set_string (value, udpsink->multi_iface);
1197 g_value_set_int (value, udpsink->ttl);
1200 g_value_set_int (value, udpsink->ttl_mc);
1203 g_value_set_boolean (value, udpsink->loop);
1205 case PROP_FORCE_IPV4:
1206 g_value_set_boolean (value, udpsink->force_ipv4);
1209 g_value_set_int (value, udpsink->qos_dscp);
1211 case PROP_SEND_DUPLICATES:
1212 g_value_set_boolean (value, udpsink->send_duplicates);
1214 case PROP_BUFFER_SIZE:
1215 g_value_set_int (value, udpsink->buffer_size);
1217 case PROP_BIND_ADDRESS:
1218 g_value_set_string (value, udpsink->bind_address);
1220 case PROP_BIND_PORT:
1221 g_value_set_int (value, udpsink->bind_port);
1224 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1230 gst_multiudpsink_configure_client (GstMultiUDPSink * sink,
1231 GstUDPClient * client)
1233 GInetSocketAddress *saddr = G_INET_SOCKET_ADDRESS (client->addr);
1234 GInetAddress *addr = g_inet_socket_address_get_address (saddr);
1235 GSocketFamily family = g_socket_address_get_family (G_SOCKET_ADDRESS (saddr));
1239 GST_DEBUG_OBJECT (sink, "configuring client %p", client);
1241 if (family == G_SOCKET_FAMILY_IPV6 && !sink->used_socket_v6)
1242 goto invalid_family;
1244 /* Select socket to send from for this address */
1245 if (family == G_SOCKET_FAMILY_IPV6 || !sink->used_socket)
1246 socket = sink->used_socket_v6;
1248 socket = sink->used_socket;
1250 if (g_inet_address_get_is_multicast (addr)) {
1251 GST_DEBUG_OBJECT (sink, "we have a multicast client %p", client);
1252 if (sink->auto_multicast) {
1253 GST_DEBUG_OBJECT (sink, "autojoining group");
1254 if (!g_socket_join_multicast_group (socket, addr, FALSE,
1255 sink->multi_iface, &err))
1256 goto join_group_failed;
1258 GST_DEBUG_OBJECT (sink, "setting loop to %d", sink->loop);
1259 g_socket_set_multicast_loopback (socket, sink->loop);
1260 GST_DEBUG_OBJECT (sink, "setting ttl to %d", sink->ttl_mc);
1261 g_socket_set_multicast_ttl (socket, sink->ttl_mc);
1263 GST_DEBUG_OBJECT (sink, "setting unicast ttl to %d", sink->ttl);
1264 g_socket_set_ttl (socket, sink->ttl);
1271 gst_multiudpsink_stop (GST_BASE_SINK (sink));
1272 GST_ELEMENT_ERROR (sink, RESOURCE, SETTINGS, (NULL),
1273 ("Could not join multicast group: %s",
1274 err ? err->message : "unknown reason"));
1275 g_clear_error (&err);
1280 gst_multiudpsink_stop (GST_BASE_SINK (sink));
1281 GST_ELEMENT_ERROR (sink, RESOURCE, SETTINGS, (NULL),
1282 ("Invalid address family (got %d)", family));
1287 /* create a socket for sending to remote machine */
1289 gst_multiudpsink_start (GstBaseSink * bsink)
1291 GstMultiUDPSink *sink;
1293 GstUDPClient *client;
1296 sink = GST_MULTIUDPSINK (bsink);
1298 sink->external_socket = FALSE;
1301 GST_DEBUG_OBJECT (sink, "using configured socket");
1302 if (g_socket_get_family (sink->socket) == G_SOCKET_FAMILY_IPV6) {
1303 sink->used_socket_v6 = G_SOCKET (g_object_ref (sink->socket));
1304 sink->external_socket = TRUE;
1306 sink->used_socket = G_SOCKET (g_object_ref (sink->socket));
1307 sink->external_socket = TRUE;
1311 if (sink->socket_v6) {
1312 GST_DEBUG_OBJECT (sink, "using configured IPv6 socket");
1313 g_return_val_if_fail (!sink->socket || g_socket_get_family (sink->socket) !=
1314 G_SOCKET_FAMILY_IPV6, FALSE);
1316 if (sink->used_socket_v6 && sink->used_socket_v6 != sink->socket_v6) {
1317 GST_ERROR_OBJECT (sink,
1318 "Provided different IPv6 sockets in socket and socket-v6 properties");
1322 sink->used_socket_v6 = G_SOCKET (g_object_ref (sink->socket_v6));
1323 sink->external_socket = TRUE;
1326 if (!sink->used_socket && !sink->used_socket_v6) {
1327 GSocketAddress *bind_addr;
1328 GInetAddress *bind_iaddr;
1330 if (sink->bind_address) {
1331 GSocketFamily family;
1333 bind_iaddr = g_inet_address_new_from_string (sink->bind_address);
1336 GResolver *resolver;
1338 resolver = g_resolver_get_default ();
1340 g_resolver_lookup_by_name (resolver, sink->bind_address,
1341 sink->cancellable, &err);
1343 g_object_unref (resolver);
1346 bind_iaddr = G_INET_ADDRESS (g_object_ref (results->data));
1347 g_resolver_free_addresses (results);
1348 g_object_unref (resolver);
1351 bind_addr = g_inet_socket_address_new (bind_iaddr, sink->bind_port);
1352 g_object_unref (bind_iaddr);
1353 family = g_socket_address_get_family (G_SOCKET_ADDRESS (bind_addr));
1355 if ((sink->used_socket =
1356 g_socket_new (family, G_SOCKET_TYPE_DATAGRAM,
1357 G_SOCKET_PROTOCOL_UDP, &err)) == NULL) {
1358 g_object_unref (bind_addr);
1362 g_socket_bind (sink->used_socket, bind_addr, TRUE, &err);
1363 g_object_unref (bind_addr);
1367 /* create sender sockets if none available */
1368 if ((sink->used_socket = g_socket_new (G_SOCKET_FAMILY_IPV4,
1369 G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP, &err)) == NULL)
1372 bind_iaddr = g_inet_address_new_any (G_SOCKET_FAMILY_IPV4);
1373 bind_addr = g_inet_socket_address_new (bind_iaddr, sink->bind_port);
1374 g_socket_bind (sink->used_socket, bind_addr, TRUE, &err);
1375 g_object_unref (bind_addr);
1376 g_object_unref (bind_iaddr);
1380 if ((sink->used_socket_v6 = g_socket_new (G_SOCKET_FAMILY_IPV6,
1381 G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP,
1383 GST_INFO_OBJECT (sink, "Failed to create IPv6 socket: %s",
1385 g_clear_error (&err);
1387 bind_iaddr = g_inet_address_new_any (G_SOCKET_FAMILY_IPV6);
1388 bind_addr = g_inet_socket_address_new (bind_iaddr, sink->bind_port);
1389 g_socket_bind (sink->used_socket_v6, bind_addr, TRUE, &err);
1390 g_object_unref (bind_addr);
1391 g_object_unref (bind_iaddr);
1402 len = sizeof (sndsize);
1403 if (sink->buffer_size != 0) {
1404 sndsize = sink->buffer_size;
1406 GST_DEBUG_OBJECT (sink, "setting udp buffer of %d bytes", sndsize);
1407 /* set buffer size, Note that on Linux this is typically limited to a
1408 * maximum of around 100K. Also a minimum of 128 bytes is required on
1411 if (sink->used_socket) {
1413 setsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET,
1414 SO_SNDBUF, (void *) &sndsize, len);
1416 GST_ELEMENT_WARNING (sink, RESOURCE, SETTINGS, (NULL),
1417 ("Could not create a buffer of requested %d bytes, %d: %s",
1418 sndsize, ret, g_strerror (errno)));
1422 if (sink->used_socket_v6) {
1424 setsockopt (g_socket_get_fd (sink->used_socket_v6), SOL_SOCKET,
1425 SO_SNDBUF, (void *) &sndsize, len);
1427 GST_ELEMENT_WARNING (sink, RESOURCE, SETTINGS, (NULL),
1428 ("Could not create a buffer of requested %d bytes, %d: %s",
1429 sndsize, ret, g_strerror (errno)));
1434 /* read the value of the receive buffer. Note that on linux this returns 2x the
1435 * value we set because the kernel allocates extra memory for metadata.
1436 * The default on Linux is about 100K (which is about 50K without metadata) */
1437 if (sink->used_socket) {
1439 getsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET,
1440 SO_SNDBUF, (void *) &sndsize, &len);
1442 GST_DEBUG_OBJECT (sink, "have UDP buffer of %d bytes", sndsize);
1444 GST_DEBUG_OBJECT (sink, "could not get UDP buffer size");
1447 if (sink->used_socket_v6) {
1449 getsockopt (g_socket_get_fd (sink->used_socket_v6), SOL_SOCKET,
1450 SO_SNDBUF, (void *) &sndsize, &len);
1452 GST_DEBUG_OBJECT (sink, "have UDPv6 buffer of %d bytes", sndsize);
1454 GST_DEBUG_OBJECT (sink, "could not get UDPv6 buffer size");
1459 #ifdef SO_BINDTODEVICE
1460 if (sink->multi_iface) {
1461 if (sink->used_socket) {
1462 if (setsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET,
1463 SO_BINDTODEVICE, sink->multi_iface,
1464 strlen (sink->multi_iface)) < 0)
1465 GST_WARNING_OBJECT (sink, "setsockopt SO_BINDTODEVICE failed: %s",
1468 if (sink->used_socket_v6) {
1469 if (setsockopt (g_socket_get_fd (sink->used_socket_v6), SOL_SOCKET,
1470 SO_BINDTODEVICE, sink->multi_iface,
1471 strlen (sink->multi_iface)) < 0)
1472 GST_WARNING_OBJECT (sink, "setsockopt SO_BINDTODEVICE failed (v6): %s",
1478 if (sink->used_socket)
1479 g_socket_set_broadcast (sink->used_socket, TRUE);
1480 if (sink->used_socket_v6)
1481 g_socket_set_broadcast (sink->used_socket_v6, TRUE);
1483 sink->bytes_to_serve = 0;
1484 sink->bytes_served = 0;
1486 gst_multiudpsink_setup_qos_dscp (sink, sink->used_socket);
1487 gst_multiudpsink_setup_qos_dscp (sink, sink->used_socket_v6);
1489 /* look for multicast clients and join multicast groups appropriately
1490 set also ttl and multicast loopback delivery appropriately */
1491 for (clients = sink->clients; clients; clients = g_list_next (clients)) {
1492 client = (GstUDPClient *) clients->data;
1494 if (!gst_multiudpsink_configure_client (sink, client))
1502 GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (NULL),
1503 ("Could not create socket: %s", err->message));
1504 g_clear_error (&err);
1509 GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (NULL),
1510 ("Failed to bind socket: %s", err->message));
1511 g_clear_error (&err);
1516 GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (NULL),
1517 ("Failed to resolve bind address %s: %s", sink->bind_address,
1519 g_clear_error (&err);
1525 gst_multiudpsink_stop (GstBaseSink * bsink)
1527 GstMultiUDPSink *udpsink;
1529 udpsink = GST_MULTIUDPSINK (bsink);
1531 if (udpsink->used_socket) {
1532 if (udpsink->close_socket || !udpsink->external_socket) {
1535 if (!g_socket_close (udpsink->used_socket, &err)) {
1536 GST_ERROR_OBJECT (udpsink, "Failed to close socket: %s", err->message);
1537 g_clear_error (&err);
1541 g_object_unref (udpsink->used_socket);
1542 udpsink->used_socket = NULL;
1545 if (udpsink->used_socket_v6) {
1546 if (udpsink->close_socket || !udpsink->external_socket) {
1549 if (!g_socket_close (udpsink->used_socket_v6, &err)) {
1550 GST_ERROR_OBJECT (udpsink, "Failed to close socket: %s", err->message);
1551 g_clear_error (&err);
1555 g_object_unref (udpsink->used_socket_v6);
1556 udpsink->used_socket_v6 = NULL;
1563 gst_udp_client_compare_socket_family (GstUDPClient * a, GstUDPClient * b)
1565 GSocketFamily fa = g_socket_address_get_family (a->addr);
1566 GSocketFamily fb = g_socket_address_get_family (b->addr);
1571 /* a should go before b */
1572 if (fa == G_SOCKET_FAMILY_IPV4 && fb == G_SOCKET_FAMILY_IPV6)
1575 /* b should go before a */
1580 gst_multiudpsink_add_internal (GstMultiUDPSink * sink, const gchar * host,
1581 gint port, gboolean lock)
1583 GSocketFamily family;
1584 GstUDPClient *client;
1585 GstUDPClient udpclient;
1589 udpclient.host = (gchar *) host;
1590 udpclient.port = port;
1592 GST_DEBUG_OBJECT (sink, "adding client on host %s, port %d", host, port);
1595 g_mutex_lock (&sink->client_lock);
1597 find = g_list_find_custom (sink->clients, &udpclient,
1598 (GCompareFunc) client_compare);
1601 find = g_list_find_custom (sink->clients_to_be_removed, &udpclient,
1602 (GCompareFunc) client_compare);
1604 gst_udp_client_ref (find->data);
1608 client = (GstUDPClient *) find->data;
1610 family = g_socket_address_get_family (client->addr);
1612 GST_DEBUG_OBJECT (sink, "found %d existing clients with host %s, port %d",
1613 client->add_count, host, port);
1615 client = gst_udp_client_new (sink, host, port);
1619 family = g_socket_address_get_family (client->addr);
1621 g_get_current_time (&now);
1622 client->connect_time = GST_TIMEVAL_TO_TIME (now);
1624 if (sink->used_socket)
1625 gst_multiudpsink_configure_client (sink, client);
1627 GST_DEBUG_OBJECT (sink, "add client with host %s, port %d", host, port);
1629 /* keep IPv4 clients at the beginning, and IPv6 at the end, we can make
1630 * use of this in gst_multiudpsink_render_buffers() */
1631 sink->clients = g_list_insert_sorted (sink->clients, client,
1632 (GCompareFunc) gst_udp_client_compare_socket_family);
1634 if (family == G_SOCKET_FAMILY_IPV4)
1635 ++sink->num_v4_unique;
1637 ++sink->num_v6_unique;
1640 ++client->add_count;
1642 if (family == G_SOCKET_FAMILY_IPV4)
1648 g_mutex_unlock (&sink->client_lock);
1650 g_signal_emit (G_OBJECT (sink),
1651 gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED], 0, host, port);
1653 GST_DEBUG_OBJECT (sink, "added client on host %s, port %d", host, port);
1659 GST_DEBUG_OBJECT (sink, "did not add client on host %s, port %d", host,
1662 g_mutex_unlock (&sink->client_lock);
1668 gst_multiudpsink_add (GstMultiUDPSink * sink, const gchar * host, gint port)
1670 gst_multiudpsink_add_internal (sink, host, port, TRUE);
1674 gst_multiudpsink_remove (GstMultiUDPSink * sink, const gchar * host, gint port)
1676 GSocketFamily family;
1678 GstUDPClient udpclient;
1679 GstUDPClient *client;
1682 udpclient.host = (gchar *) host;
1683 udpclient.port = port;
1685 g_mutex_lock (&sink->client_lock);
1686 find = g_list_find_custom (sink->clients, &udpclient,
1687 (GCompareFunc) client_compare);
1691 client = (GstUDPClient *) find->data;
1693 GST_DEBUG_OBJECT (sink, "found %d clients with host %s, port %d",
1694 client->add_count, host, port);
1696 --client->add_count;
1698 family = g_socket_address_get_family (client->addr);
1699 if (family == G_SOCKET_FAMILY_IPV4)
1704 if (client->add_count == 0) {
1705 GInetSocketAddress *saddr = G_INET_SOCKET_ADDRESS (client->addr);
1706 GInetAddress *addr = g_inet_socket_address_get_address (saddr);
1709 /* Select socket to send from for this address */
1710 if (family == G_SOCKET_FAMILY_IPV6 || !sink->used_socket)
1711 socket = sink->used_socket_v6;
1713 socket = sink->used_socket;
1715 GST_DEBUG_OBJECT (sink, "remove client with host %s, port %d", host, port);
1717 g_get_current_time (&now);
1718 client->disconnect_time = GST_TIMEVAL_TO_TIME (now);
1720 if (socket && sink->auto_multicast
1721 && g_inet_address_get_is_multicast (addr)) {
1724 if (!g_socket_leave_multicast_group (socket, addr, FALSE,
1725 sink->multi_iface, &err)) {
1726 GST_DEBUG_OBJECT (sink, "Failed to leave multicast group: %s",
1728 g_clear_error (&err);
1732 if (family == G_SOCKET_FAMILY_IPV4)
1733 --sink->num_v4_unique;
1735 --sink->num_v6_unique;
1737 /* Keep state consistent for streaming thread, so remove from client list,
1738 * but keep it around until after the signal has been emitted, in case a
1739 * callback wants to get stats for that client or so */
1740 sink->clients = g_list_delete_link (sink->clients, find);
1742 sink->clients_to_be_removed =
1743 g_list_prepend (sink->clients_to_be_removed, client);
1745 /* Unlock to emit signal before we delete the actual client */
1746 g_mutex_unlock (&sink->client_lock);
1747 g_signal_emit (G_OBJECT (sink),
1748 gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED], 0, host, port);
1749 g_mutex_lock (&sink->client_lock);
1751 sink->clients_to_be_removed =
1752 g_list_remove (sink->clients_to_be_removed, client);
1754 gst_udp_client_unref (client);
1756 g_mutex_unlock (&sink->client_lock);
1763 g_mutex_unlock (&sink->client_lock);
1764 GST_WARNING_OBJECT (sink, "client at host %s, port %d not found",
1771 gst_multiudpsink_clear_internal (GstMultiUDPSink * sink, gboolean lock)
1773 GST_DEBUG_OBJECT (sink, "clearing");
1774 /* we only need to remove the client structure, there is no additional
1775 * socket or anything to free for UDP */
1777 g_mutex_lock (&sink->client_lock);
1778 g_list_foreach (sink->clients, (GFunc) gst_udp_client_unref, sink);
1779 g_list_free (sink->clients);
1780 sink->clients = NULL;
1781 sink->num_v4_unique = 0;
1782 sink->num_v4_all = 0;
1783 sink->num_v6_unique = 0;
1784 sink->num_v6_all = 0;
1786 g_mutex_unlock (&sink->client_lock);
1790 gst_multiudpsink_clear (GstMultiUDPSink * sink)
1792 gst_multiudpsink_clear_internal (sink, TRUE);
1796 gst_multiudpsink_get_stats (GstMultiUDPSink * sink, const gchar * host,
1799 GstUDPClient *client;
1800 GstStructure *result = NULL;
1801 GstUDPClient udpclient;
1804 udpclient.host = (gchar *) host;
1805 udpclient.port = port;
1807 g_mutex_lock (&sink->client_lock);
1809 find = g_list_find_custom (sink->clients, &udpclient,
1810 (GCompareFunc) client_compare);
1813 find = g_list_find_custom (sink->clients_to_be_removed, &udpclient,
1814 (GCompareFunc) client_compare);
1819 GST_DEBUG_OBJECT (sink, "stats for client with host %s, port %d", host, port);
1821 client = (GstUDPClient *) find->data;
1823 result = gst_structure_new_empty ("multiudpsink-stats");
1825 gst_structure_set (result,
1826 "bytes-sent", G_TYPE_UINT64, client->bytes_sent,
1827 "packets-sent", G_TYPE_UINT64, client->packets_sent,
1828 "connect-time", G_TYPE_UINT64, client->connect_time,
1829 "disconnect-time", G_TYPE_UINT64, client->disconnect_time, NULL);
1831 g_mutex_unlock (&sink->client_lock);
1838 g_mutex_unlock (&sink->client_lock);
1839 GST_WARNING_OBJECT (sink, "client with host %s, port %d not found",
1841 /* Apparently (see comment in gstmultifdsink.c) returning NULL from here may
1842 * confuse/break python bindings */
1843 return gst_structure_new_empty ("multiudpsink-stats");
1848 gst_multiudpsink_unlock (GstBaseSink * bsink)
1850 GstMultiUDPSink *sink;
1852 sink = GST_MULTIUDPSINK (bsink);
1854 g_cancellable_cancel (sink->cancellable);
1860 gst_multiudpsink_unlock_stop (GstBaseSink * bsink)
1862 GstMultiUDPSink *sink;
1864 sink = GST_MULTIUDPSINK (bsink);
1866 gst_multiudpsink_free_cancellable (sink);
1867 gst_multiudpsink_create_cancellable (sink);