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., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, 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.
32 /* FIXME 0.11: suppress warnings for deprecated API such as GValueArray
33 * with newer GLib versions (>= 2.31.0) */
34 #define GLIB_DISABLE_DEPRECATION_WARNINGS
39 #include "gstudp-marshal.h"
40 #include "gstmultiudpsink.h"
44 #include "gst/glib-compat-private.h"
46 GST_DEBUG_CATEGORY_STATIC (multiudpsink_debug);
47 #define GST_CAT_DEFAULT (multiudpsink_debug)
49 #define UDP_MAX_SIZE 65507
51 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
56 /* MultiUDPSink signals and args */
67 SIGNAL_CLIENT_REMOVED,
73 #define DEFAULT_SOCKET NULL
74 #define DEFAULT_CLOSE_SOCKET TRUE
75 #define DEFAULT_USED_SOCKET NULL
76 #define DEFAULT_CLIENTS NULL
77 #define DEFAULT_FAMILY G_SOCKET_FAMILY_IPV6
78 /* FIXME, this should be disabled by default, we don't need to join a multicast
79 * group for sending, if this socket is also used for receiving, it should
80 * be configured in the element that does the receive. */
81 #define DEFAULT_AUTO_MULTICAST TRUE
82 #define DEFAULT_TTL 64
83 #define DEFAULT_TTL_MC 1
84 #define DEFAULT_LOOP TRUE
85 #define DEFAULT_QOS_DSCP -1
86 #define DEFAULT_SEND_DUPLICATES TRUE
87 #define DEFAULT_BUFFER_SIZE 0
103 PROP_SEND_DUPLICATES,
108 static void gst_multiudpsink_finalize (GObject * object);
110 static GstFlowReturn gst_multiudpsink_render (GstBaseSink * sink,
113 static gboolean gst_multiudpsink_start (GstBaseSink * bsink);
114 static gboolean gst_multiudpsink_stop (GstBaseSink * bsink);
115 static gboolean gst_multiudpsink_unlock (GstBaseSink * bsink);
116 static gboolean gst_multiudpsink_unlock_stop (GstBaseSink * bsink);
118 static void gst_multiudpsink_set_property (GObject * object, guint prop_id,
119 const GValue * value, GParamSpec * pspec);
120 static void gst_multiudpsink_get_property (GObject * object, guint prop_id,
121 GValue * value, GParamSpec * pspec);
123 static void gst_multiudpsink_add_internal (GstMultiUDPSink * sink,
124 const gchar * host, gint port, gboolean lock);
125 static void gst_multiudpsink_clear_internal (GstMultiUDPSink * sink,
128 static guint gst_multiudpsink_signals[LAST_SIGNAL] = { 0 };
130 #define gst_multiudpsink_parent_class parent_class
131 G_DEFINE_TYPE (GstMultiUDPSink, gst_multiudpsink, GST_TYPE_BASE_SINK);
134 gst_multiudpsink_class_init (GstMultiUDPSinkClass * klass)
136 GObjectClass *gobject_class;
137 GstElementClass *gstelement_class;
138 GstBaseSinkClass *gstbasesink_class;
140 gobject_class = (GObjectClass *) klass;
141 gstelement_class = (GstElementClass *) klass;
142 gstbasesink_class = (GstBaseSinkClass *) klass;
144 gobject_class->set_property = gst_multiudpsink_set_property;
145 gobject_class->get_property = gst_multiudpsink_get_property;
146 gobject_class->finalize = gst_multiudpsink_finalize;
149 * GstMultiUDPSink::add:
150 * @gstmultiudpsink: the sink on which the signal is emitted
151 * @host: the hostname/IP address of the client to add
152 * @port: the port of the client to add
154 * Add a client with destination @host and @port to the list of
155 * clients. When the same host/port pair is added multiple times, the
156 * send-duplicates property defines if the packets are sent multiple times to
157 * the same host/port pair or not.
159 * When a host/port pair is added multiple times, an equal amount of remove
160 * calls must be performed to actually remove the host/port pair from the list
163 gst_multiudpsink_signals[SIGNAL_ADD] =
164 g_signal_new ("add", G_TYPE_FROM_CLASS (klass),
165 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
166 G_STRUCT_OFFSET (GstMultiUDPSinkClass, add),
167 NULL, NULL, gst_udp_marshal_VOID__STRING_INT, G_TYPE_NONE, 2,
168 G_TYPE_STRING, G_TYPE_INT);
170 * GstMultiUDPSink::remove:
171 * @gstmultiudpsink: the sink on which the signal is emitted
172 * @host: the hostname/IP address of the client to remove
173 * @port: the port of the client to remove
175 * Remove the client with destination @host and @port from the list of
178 gst_multiudpsink_signals[SIGNAL_REMOVE] =
179 g_signal_new ("remove", G_TYPE_FROM_CLASS (klass),
180 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
181 G_STRUCT_OFFSET (GstMultiUDPSinkClass, remove),
182 NULL, NULL, gst_udp_marshal_VOID__STRING_INT, G_TYPE_NONE, 2,
183 G_TYPE_STRING, G_TYPE_INT);
185 * GstMultiUDPSink::clear:
186 * @gstmultiudpsink: the sink on which the signal is emitted
188 * Clear the list of clients.
190 gst_multiudpsink_signals[SIGNAL_CLEAR] =
191 g_signal_new ("clear", G_TYPE_FROM_CLASS (klass),
192 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
193 G_STRUCT_OFFSET (GstMultiUDPSinkClass, clear),
194 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
196 * GstMultiUDPSink::get-stats:
197 * @gstmultiudpsink: the sink on which the signal is emitted
198 * @host: the hostname/IP address of the client to get stats on
199 * @port: the port of the client to get stats on
201 * Get the statistics of the client with destination @host and @port.
203 * Returns: a GstStructure: bytes_sent, packets_sent,
204 * connect_time (in epoch seconds), disconnect_time (in epoch seconds)
206 gst_multiudpsink_signals[SIGNAL_GET_STATS] =
207 g_signal_new ("get-stats", G_TYPE_FROM_CLASS (klass),
208 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
209 G_STRUCT_OFFSET (GstMultiUDPSinkClass, get_stats),
210 NULL, NULL, gst_udp_marshal_BOXED__STRING_INT, GST_TYPE_STRUCTURE, 2,
211 G_TYPE_STRING, G_TYPE_INT);
213 * GstMultiUDPSink::client-added:
214 * @gstmultiudpsink: the sink emitting the signal
215 * @host: the hostname/IP address of the added client
216 * @port: the port of the added client
218 * Signal emited when a new client is added to the list of
221 gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED] =
222 g_signal_new ("client-added", G_TYPE_FROM_CLASS (klass),
223 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, client_added),
224 NULL, NULL, gst_udp_marshal_VOID__STRING_INT, G_TYPE_NONE, 2,
225 G_TYPE_STRING, G_TYPE_INT);
227 * GstMultiUDPSink::client-removed:
228 * @gstmultiudpsink: the sink emitting the signal
229 * @host: the hostname/IP address of the removed client
230 * @port: the port of the removed client
232 * Signal emited when a client is removed from the list of
235 gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED] =
236 g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass),
237 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass,
238 client_removed), NULL, NULL, gst_udp_marshal_VOID__STRING_INT,
239 G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
241 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BYTES_TO_SERVE,
242 g_param_spec_uint64 ("bytes-to-serve", "Bytes to serve",
243 "Number of bytes received to serve to clients", 0, G_MAXUINT64, 0,
244 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
245 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BYTES_SERVED,
246 g_param_spec_uint64 ("bytes-served", "Bytes served",
247 "Total number of bytes sent to all clients", 0, G_MAXUINT64, 0,
248 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
249 g_object_class_install_property (gobject_class, PROP_SOCKET,
250 g_param_spec_object ("socket", "Socket Handle",
251 "Socket to use for UDP sending. (NULL == allocate)",
252 G_TYPE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
253 g_object_class_install_property (gobject_class, PROP_CLOSE_SOCKET,
254 g_param_spec_boolean ("close-socket", "Close socket",
255 "Close socket if passed as property on state change",
256 DEFAULT_CLOSE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
257 g_object_class_install_property (gobject_class, PROP_USED_SOCKET,
258 g_param_spec_object ("used-socket", "Used Socket Handle",
259 "Socket currently in use for UDP sending. (NULL == no socket)",
260 G_TYPE_SOCKET, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
261 g_object_class_install_property (gobject_class, PROP_CLIENTS,
262 g_param_spec_string ("clients", "Clients",
263 "A comma separated list of host:port pairs with destinations",
264 DEFAULT_CLIENTS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
265 g_object_class_install_property (gobject_class, PROP_AUTO_MULTICAST,
266 g_param_spec_boolean ("auto-multicast",
267 "Automatically join/leave multicast groups",
268 "Automatically join/leave the multicast groups, FALSE means user"
269 " has to do it himself", DEFAULT_AUTO_MULTICAST,
270 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
271 g_object_class_install_property (gobject_class, PROP_TTL,
272 g_param_spec_int ("ttl", "Unicast TTL",
273 "Used for setting the unicast TTL parameter",
274 0, 255, DEFAULT_TTL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
275 g_object_class_install_property (gobject_class, PROP_TTL_MC,
276 g_param_spec_int ("ttl-mc", "Multicast TTL",
277 "Used for setting the multicast TTL parameter",
278 0, 255, DEFAULT_TTL_MC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
279 g_object_class_install_property (gobject_class, PROP_LOOP,
280 g_param_spec_boolean ("loop", "Multicast Loopback",
281 "Used for setting the multicast loop parameter. TRUE = enable,"
282 " FALSE = disable", DEFAULT_LOOP,
283 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
284 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QOS_DSCP,
285 g_param_spec_int ("qos-dscp", "QoS diff srv code point",
286 "Quality of Service, differentiated services code point (-1 default)",
287 -1, 63, DEFAULT_QOS_DSCP,
288 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
290 * GstMultiUDPSink::send-duplicates
292 * When a host/port pair is added mutliple times, send the packet to the host
293 * multiple times as well.
297 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEND_DUPLICATES,
298 g_param_spec_boolean ("send-duplicates", "Send Duplicates",
299 "When a distination/port pair is added multiple times, send packets "
300 "multiple times as well", DEFAULT_SEND_DUPLICATES,
301 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
303 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BUFFER_SIZE,
304 g_param_spec_int ("buffer-size", "Buffer Size",
305 "Size of the kernel send buffer in bytes, 0=default", 0, G_MAXINT,
306 DEFAULT_BUFFER_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
308 gst_element_class_add_pad_template (gstelement_class,
309 gst_static_pad_template_get (&sink_template));
311 gst_element_class_set_details_simple (gstelement_class, "UDP packet sender",
313 "Send data over the network via UDP",
314 "Wim Taymans <wim.taymans@gmail.com>");
316 gstbasesink_class->render = gst_multiudpsink_render;
317 gstbasesink_class->start = gst_multiudpsink_start;
318 gstbasesink_class->stop = gst_multiudpsink_stop;
319 gstbasesink_class->unlock = gst_multiudpsink_unlock;
320 gstbasesink_class->unlock_stop = gst_multiudpsink_unlock_stop;
321 klass->add = gst_multiudpsink_add;
322 klass->remove = gst_multiudpsink_remove;
323 klass->clear = gst_multiudpsink_clear;
324 klass->get_stats = gst_multiudpsink_get_stats;
326 GST_DEBUG_CATEGORY_INIT (multiudpsink_debug, "multiudpsink", 0, "UDP sink");
331 gst_multiudpsink_init (GstMultiUDPSink * sink)
333 g_mutex_init (&sink->client_lock);
334 sink->socket = DEFAULT_SOCKET;
335 sink->used_socket = DEFAULT_USED_SOCKET;
336 sink->close_socket = DEFAULT_CLOSE_SOCKET;
337 sink->external_socket = (sink->socket != NULL);
338 sink->auto_multicast = DEFAULT_AUTO_MULTICAST;
339 sink->ttl = DEFAULT_TTL;
340 sink->ttl_mc = DEFAULT_TTL_MC;
341 sink->loop = DEFAULT_LOOP;
342 sink->qos_dscp = DEFAULT_QOS_DSCP;
343 sink->family = DEFAULT_FAMILY;
344 sink->send_duplicates = DEFAULT_SEND_DUPLICATES;
346 sink->cancellable = g_cancellable_new ();
349 static GstUDPClient *
350 create_client (GstMultiUDPSink * sink, const gchar * host, gint port)
352 GstUDPClient *client;
357 addr = g_inet_address_new_from_string (host);
361 resolver = g_resolver_get_default ();
363 g_resolver_lookup_by_name (resolver, host, sink->cancellable, &err);
366 addr = G_INET_ADDRESS (g_object_ref (results->data));
368 g_resolver_free_addresses (results);
369 g_object_unref (resolver);
371 #ifndef GST_DISABLE_GST_DEBUG
373 gchar *ip = g_inet_address_to_string (addr);
375 GST_DEBUG_OBJECT (sink, "IP address for host %s is %s", host, ip);
380 client = g_slice_new0 (GstUDPClient);
381 client->refcount = 1;
382 client->host = g_strdup (host);
384 client->addr = g_inet_socket_address_new (addr, port);
385 g_object_unref (addr);
391 g_object_unref (resolver);
398 free_client (GstUDPClient * client)
400 g_object_unref (client->addr);
401 g_free (client->host);
402 g_slice_free (GstUDPClient, client);
406 client_compare (GstUDPClient * a, GstUDPClient * b)
408 if ((a->port == b->port) && (strcmp (a->host, b->host) == 0))
415 gst_multiudpsink_finalize (GObject * object)
417 GstMultiUDPSink *sink;
419 sink = GST_MULTIUDPSINK (object);
421 g_list_foreach (sink->clients, (GFunc) free_client, NULL);
422 g_list_free (sink->clients);
425 g_object_unref (sink->socket);
428 if (sink->used_socket)
429 g_object_unref (sink->used_socket);
430 sink->used_socket = NULL;
432 if (sink->cancellable)
433 g_object_unref (sink->cancellable);
434 sink->cancellable = NULL;
436 g_mutex_clear (&sink->client_lock);
438 G_OBJECT_CLASS (parent_class)->finalize (object);
442 gst_multiudpsink_render (GstBaseSink * bsink, GstBuffer * buffer)
444 GstMultiUDPSink *sink;
451 gint num, no_clients;
454 sink = GST_MULTIUDPSINK (bsink);
456 n_mem = gst_buffer_n_memory (buffer);
460 vec = g_new (GOutputVector, n_mem);
461 map = g_new (GstMapInfo, n_mem);
464 for (i = 0; i < n_mem; i++) {
465 mem = gst_buffer_get_memory (buffer, i);
466 gst_memory_map (mem, &map[i], GST_MAP_READ);
468 if (map[i].size > UDP_MAX_SIZE) {
469 GST_WARNING ("Attempting to send a UDP packet larger than maximum "
470 "size (%" G_GSIZE_FORMAT " > %d)", map[i].size, UDP_MAX_SIZE);
473 vec[i].buffer = map[i].data;
474 vec[i].size = map[i].size;
479 sink->bytes_to_serve += size;
481 /* grab lock while iterating and sending to clients, this should be
482 * fast as UDP never blocks */
483 g_mutex_lock (&sink->client_lock);
484 GST_LOG_OBJECT (bsink, "about to send %" G_GSIZE_FORMAT " bytes", size);
488 for (clients = sink->clients; clients; clients = g_list_next (clients)) {
489 GstUDPClient *client;
492 client = (GstUDPClient *) clients->data;
494 GST_LOG_OBJECT (sink, "sending %" G_GSIZE_FORMAT " bytes to client %p",
497 count = sink->send_duplicates ? client->refcount : 1;
503 g_socket_send_message (sink->used_socket, client->addr, vec, n_mem,
504 NULL, 0, 0, sink->cancellable, &err);
510 client->bytes_sent += ret;
511 client->packets_sent++;
512 sink->bytes_served += ret;
515 g_mutex_unlock (&sink->client_lock);
517 /* unmap all memory again */
518 for (i = 0; i < n_mem; i++) {
519 gst_memory_unmap (map[i].memory, &map[i]);
520 gst_memory_unref (map[i].memory);
526 GST_LOG_OBJECT (sink, "sent %" G_GSIZE_FORMAT " bytes to %d (of %d) clients",
527 size, num, no_clients);
537 GST_DEBUG ("got send error %s", err->message);
538 g_clear_error (&err);
539 return GST_FLOW_ERROR;
544 gst_multiudpsink_set_clients_string (GstMultiUDPSink * sink,
545 const gchar * string)
550 clients = g_strsplit (string, ",", 0);
552 g_mutex_lock (&sink->client_lock);
553 /* clear all existing clients */
554 gst_multiudpsink_clear_internal (sink, FALSE);
555 for (i = 0; clients[i]; i++) {
560 p = strstr (clients[i], ":");
563 port = g_ascii_strtoll (p + 1, NULL, 10);
566 gst_multiudpsink_add_internal (sink, host, port, FALSE);
568 g_mutex_unlock (&sink->client_lock);
570 g_strfreev (clients);
574 gst_multiudpsink_get_clients_string (GstMultiUDPSink * sink)
579 str = g_string_new ("");
581 g_mutex_lock (&sink->client_lock);
582 clients = sink->clients;
584 GstUDPClient *client;
587 client = (GstUDPClient *) clients->data;
589 clients = g_list_next (clients);
591 count = client->refcount;
593 g_string_append_printf (str, "%s:%d%s", client->host, client->port,
594 (clients || count > 1 ? "," : ""));
597 g_mutex_unlock (&sink->client_lock);
599 return g_string_free (str, FALSE);
603 gst_multiudpsink_setup_qos_dscp (GstMultiUDPSink * sink)
605 /* don't touch on -1 */
606 if (sink->qos_dscp < 0)
609 if (sink->used_socket == NULL)
617 fd = g_socket_get_fd (sink->used_socket);
619 GST_DEBUG_OBJECT (sink, "setting TOS to %d", sink->qos_dscp);
621 /* Extract and shift 6 bits of DSFIELD */
622 tos = (sink->qos_dscp & 0x3f) << 2;
624 if (setsockopt (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0) {
625 GST_ERROR_OBJECT (sink, "could not set TOS: %s", g_strerror (errno));
628 if (setsockopt (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0) {
629 GST_ERROR_OBJECT (sink, "could not set TCLASS: %s", g_strerror (errno));
637 gst_multiudpsink_set_property (GObject * object, guint prop_id,
638 const GValue * value, GParamSpec * pspec)
640 GstMultiUDPSink *udpsink;
642 udpsink = GST_MULTIUDPSINK (object);
646 if (udpsink->socket != NULL && udpsink->socket != udpsink->used_socket &&
647 udpsink->close_socket) {
650 if (!g_socket_close (udpsink->socket, &err)) {
651 GST_ERROR ("failed to close socket %p: %s", udpsink->socket,
653 g_clear_error (&err);
657 g_object_unref (udpsink->socket);
658 udpsink->socket = g_value_dup_object (value);
659 GST_DEBUG_OBJECT (udpsink, "setting socket to %p", udpsink->socket);
661 case PROP_CLOSE_SOCKET:
662 udpsink->close_socket = g_value_get_boolean (value);
665 gst_multiudpsink_set_clients_string (udpsink, g_value_get_string (value));
667 case PROP_AUTO_MULTICAST:
668 udpsink->auto_multicast = g_value_get_boolean (value);
671 udpsink->ttl = g_value_get_int (value);
674 udpsink->ttl_mc = g_value_get_int (value);
677 udpsink->loop = g_value_get_boolean (value);
680 udpsink->qos_dscp = g_value_get_int (value);
681 gst_multiudpsink_setup_qos_dscp (udpsink);
683 case PROP_SEND_DUPLICATES:
684 udpsink->send_duplicates = g_value_get_boolean (value);
686 case PROP_BUFFER_SIZE:
687 udpsink->buffer_size = g_value_get_int (value);
690 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
696 gst_multiudpsink_get_property (GObject * object, guint prop_id, GValue * value,
699 GstMultiUDPSink *udpsink;
701 udpsink = GST_MULTIUDPSINK (object);
704 case PROP_BYTES_TO_SERVE:
705 g_value_set_uint64 (value, udpsink->bytes_to_serve);
707 case PROP_BYTES_SERVED:
708 g_value_set_uint64 (value, udpsink->bytes_served);
711 g_value_set_object (value, udpsink->socket);
713 case PROP_CLOSE_SOCKET:
714 g_value_set_boolean (value, udpsink->close_socket);
716 case PROP_USED_SOCKET:
717 g_value_set_object (value, udpsink->used_socket);
720 g_value_take_string (value,
721 gst_multiudpsink_get_clients_string (udpsink));
723 case PROP_AUTO_MULTICAST:
724 g_value_set_boolean (value, udpsink->auto_multicast);
727 g_value_set_int (value, udpsink->ttl);
730 g_value_set_int (value, udpsink->ttl_mc);
733 g_value_set_boolean (value, udpsink->loop);
736 g_value_set_int (value, udpsink->qos_dscp);
738 case PROP_SEND_DUPLICATES:
739 g_value_set_boolean (value, udpsink->send_duplicates);
741 case PROP_BUFFER_SIZE:
742 g_value_set_int (value, udpsink->buffer_size);
745 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
751 gst_multiudpsink_configure_client (GstMultiUDPSink * sink,
752 GstUDPClient * client)
754 GInetSocketAddress *saddr = G_INET_SOCKET_ADDRESS (client->addr);
755 GInetAddress *addr = g_inet_socket_address_get_address (saddr);
758 GST_DEBUG_OBJECT (sink, "configuring client %p", client);
760 if (g_inet_address_get_is_multicast (addr)) {
761 GST_DEBUG_OBJECT (sink, "we have a multicast client %p", client);
762 if (sink->auto_multicast) {
763 GST_DEBUG_OBJECT (sink, "autojoining group");
764 if (!g_socket_join_multicast_group (sink->used_socket, addr, FALSE, NULL,
766 goto join_group_failed;
768 GST_DEBUG_OBJECT (sink, "setting loop to %d", sink->loop);
769 g_socket_set_multicast_loopback (sink->used_socket, sink->loop);
770 GST_DEBUG_OBJECT (sink, "setting ttl to %d", sink->ttl_mc);
771 g_socket_set_multicast_ttl (sink->used_socket, sink->ttl_mc);
773 GST_DEBUG_OBJECT (sink, "setting unicast ttl to %d", sink->ttl);
774 g_socket_set_ttl (sink->used_socket, sink->ttl);
781 gst_multiudpsink_stop (GST_BASE_SINK (sink));
782 GST_ELEMENT_ERROR (sink, RESOURCE, SETTINGS, (NULL),
783 ("Could not join multicast group: %s", err->message));
784 g_clear_error (&err);
789 /* create a socket for sending to remote machine */
791 gst_multiudpsink_start (GstBaseSink * bsink)
793 GstMultiUDPSink *sink;
795 GstUDPClient *client;
798 sink = GST_MULTIUDPSINK (bsink);
800 if (sink->socket == NULL) {
801 GST_DEBUG_OBJECT (sink, "creating sockets");
802 /* create sender socket try IP6, fall back to IP4 */
803 sink->family = G_SOCKET_FAMILY_IPV6;
804 if ((sink->used_socket =
805 g_socket_new (G_SOCKET_FAMILY_IPV6,
806 G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP, &err)) == NULL) {
807 sink->family = G_SOCKET_FAMILY_IPV4;
808 if ((sink->used_socket = g_socket_new (G_SOCKET_FAMILY_IPV4,
809 G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP, &err)) == NULL)
813 GST_DEBUG_OBJECT (sink, "have socket");
814 sink->external_socket = FALSE;
816 GST_DEBUG_OBJECT (sink, "using configured socket");
817 /* we use the configured socket */
818 sink->used_socket = G_SOCKET (g_object_ref (sink->socket));
819 sink->family = g_socket_get_family (sink->used_socket);
820 sink->external_socket = TRUE;
829 len = sizeof (sndsize);
830 if (sink->buffer_size != 0) {
831 sndsize = sink->buffer_size;
833 GST_DEBUG_OBJECT (sink, "setting udp buffer of %d bytes", sndsize);
834 /* set buffer size, Note that on Linux this is typically limited to a
835 * maximum of around 100K. Also a minimum of 128 bytes is required on
838 setsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET,
839 SO_SNDBUF, (void *) &sndsize, len);
841 GST_ELEMENT_WARNING (sink, RESOURCE, SETTINGS, (NULL),
842 ("Could not create a buffer of requested %d bytes, %d: %s",
843 sndsize, ret, g_strerror (errno)));
847 /* read the value of the receive buffer. Note that on linux this returns 2x the
848 * value we set because the kernel allocates extra memory for metadata.
849 * The default on Linux is about 100K (which is about 50K without metadata) */
851 getsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET, SO_SNDBUF,
852 (void *) &sndsize, &len);
854 GST_DEBUG_OBJECT (sink, "have udp buffer of %d bytes", sndsize);
856 GST_DEBUG_OBJECT (sink, "could not get udp buffer size");
860 g_socket_set_broadcast (sink->used_socket, TRUE);
862 sink->bytes_to_serve = 0;
863 sink->bytes_served = 0;
865 gst_multiudpsink_setup_qos_dscp (sink);
867 /* look for multicast clients and join multicast groups appropriately
868 set also ttl and multicast loopback delivery appropriately */
869 for (clients = sink->clients; clients; clients = g_list_next (clients)) {
870 client = (GstUDPClient *) clients->data;
872 if (!gst_multiudpsink_configure_client (sink, client))
880 GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (NULL),
881 ("Could not create socket: %s", err->message));
882 g_clear_error (&err);
888 gst_multiudpsink_stop (GstBaseSink * bsink)
890 GstMultiUDPSink *udpsink;
892 udpsink = GST_MULTIUDPSINK (bsink);
894 if (udpsink->used_socket) {
895 if (udpsink->close_socket || !udpsink->external_socket) {
898 if (!g_socket_close (udpsink->used_socket, &err)) {
899 GST_ERROR_OBJECT (udpsink, "Failed to close socket: %s", err->message);
900 g_clear_error (&err);
904 g_object_unref (udpsink->used_socket);
905 udpsink->used_socket = NULL;
912 gst_multiudpsink_add_internal (GstMultiUDPSink * sink, const gchar * host,
913 gint port, gboolean lock)
915 GstUDPClient *client;
916 GstUDPClient udpclient;
920 udpclient.host = (gchar *) host;
921 udpclient.port = port;
923 GST_DEBUG_OBJECT (sink, "adding client on host %s, port %d", host, port);
926 g_mutex_lock (&sink->client_lock);
928 find = g_list_find_custom (sink->clients, &udpclient,
929 (GCompareFunc) client_compare);
931 client = (GstUDPClient *) find->data;
933 GST_DEBUG_OBJECT (sink, "found %d existing clients with host %s, port %d",
934 client->refcount, host, port);
937 client = create_client (sink, host, port);
941 g_get_current_time (&now);
942 client->connect_time = GST_TIMEVAL_TO_TIME (now);
944 if (sink->used_socket)
945 gst_multiudpsink_configure_client (sink, client);
947 GST_DEBUG_OBJECT (sink, "add client with host %s, port %d", host, port);
948 sink->clients = g_list_prepend (sink->clients, client);
952 g_mutex_unlock (&sink->client_lock);
954 g_signal_emit (G_OBJECT (sink),
955 gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED], 0, host, port);
957 GST_DEBUG_OBJECT (sink, "added client on host %s, port %d", host, port);
963 GST_DEBUG_OBJECT (sink, "did not add client on host %s, port %d", host,
966 g_mutex_unlock (&sink->client_lock);
972 gst_multiudpsink_add (GstMultiUDPSink * sink, const gchar * host, gint port)
974 gst_multiudpsink_add_internal (sink, host, port, TRUE);
978 gst_multiudpsink_remove (GstMultiUDPSink * sink, const gchar * host, gint port)
981 GstUDPClient udpclient;
982 GstUDPClient *client;
985 udpclient.host = (gchar *) host;
986 udpclient.port = port;
988 g_mutex_lock (&sink->client_lock);
989 find = g_list_find_custom (sink->clients, &udpclient,
990 (GCompareFunc) client_compare);
994 client = (GstUDPClient *) find->data;
996 GST_DEBUG_OBJECT (sink, "found %d clients with host %s, port %d",
997 client->refcount, host, port);
1000 if (client->refcount == 0) {
1001 GInetSocketAddress *saddr = G_INET_SOCKET_ADDRESS (client->addr);
1002 GInetAddress *addr = g_inet_socket_address_get_address (saddr);
1004 GST_DEBUG_OBJECT (sink, "remove client with host %s, port %d", host, port);
1006 g_get_current_time (&now);
1007 client->disconnect_time = GST_TIMEVAL_TO_TIME (now);
1009 if (sink->used_socket && sink->auto_multicast
1010 && g_inet_address_get_is_multicast (addr)) {
1013 if (!g_socket_leave_multicast_group (sink->used_socket, addr, FALSE, NULL,
1015 GST_DEBUG_OBJECT (sink, "Failed to leave multicast group: %s",
1017 g_clear_error (&err);
1021 /* Unlock to emit signal before we delete the actual client */
1022 g_mutex_unlock (&sink->client_lock);
1023 g_signal_emit (G_OBJECT (sink),
1024 gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED], 0, host, port);
1025 g_mutex_lock (&sink->client_lock);
1027 sink->clients = g_list_delete_link (sink->clients, find);
1029 free_client (client);
1031 g_mutex_unlock (&sink->client_lock);
1038 g_mutex_unlock (&sink->client_lock);
1039 GST_WARNING_OBJECT (sink, "client at host %s, port %d not found",
1046 gst_multiudpsink_clear_internal (GstMultiUDPSink * sink, gboolean lock)
1048 GST_DEBUG_OBJECT (sink, "clearing");
1049 /* we only need to remove the client structure, there is no additional
1050 * socket or anything to free for UDP */
1052 g_mutex_lock (&sink->client_lock);
1053 g_list_foreach (sink->clients, (GFunc) free_client, sink);
1054 g_list_free (sink->clients);
1055 sink->clients = NULL;
1057 g_mutex_unlock (&sink->client_lock);
1061 gst_multiudpsink_clear (GstMultiUDPSink * sink)
1063 gst_multiudpsink_clear_internal (sink, TRUE);
1067 gst_multiudpsink_get_stats (GstMultiUDPSink * sink, const gchar * host,
1070 GstUDPClient *client;
1071 GstStructure *result = NULL;
1072 GstUDPClient udpclient;
1075 udpclient.host = (gchar *) host;
1076 udpclient.port = port;
1078 g_mutex_lock (&sink->client_lock);
1080 find = g_list_find_custom (sink->clients, &udpclient,
1081 (GCompareFunc) client_compare);
1085 GST_DEBUG_OBJECT (sink, "stats for client with host %s, port %d", host, port);
1087 client = (GstUDPClient *) find->data;
1089 result = gst_structure_new_empty ("multiudpsink-stats");
1091 gst_structure_set (result,
1092 "bytes-sent", G_TYPE_UINT64, client->bytes_sent,
1093 "packets-sent", G_TYPE_UINT64, client->packets_sent,
1094 "connect-time", G_TYPE_UINT64, client->connect_time,
1095 "disconnect-time", G_TYPE_UINT64, client->disconnect_time, NULL);
1097 g_mutex_unlock (&sink->client_lock);
1104 g_mutex_unlock (&sink->client_lock);
1105 GST_WARNING_OBJECT (sink, "client with host %s, port %d not found",
1107 /* Apparently (see comment in gstmultifdsink.c) returning NULL from here may
1108 * confuse/break python bindings */
1109 return gst_structure_new_empty ("multiudpsink-stats");
1114 gst_multiudpsink_unlock (GstBaseSink * bsink)
1116 GstMultiUDPSink *sink;
1118 sink = GST_MULTIUDPSINK (bsink);
1120 g_cancellable_cancel (sink->cancellable);
1126 gst_multiudpsink_unlock_stop (GstBaseSink * bsink)
1128 GstMultiUDPSink *sink;
1130 sink = GST_MULTIUDPSINK (bsink);
1132 g_cancellable_reset (sink->cancellable);