udp: Use the generic marshaller instead of generating marshallers
[platform/upstream/gst-plugins-good.git] / gst / udp / gstmultiudpsink.c
1 /* GStreamer
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>
6  *
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.
11  *
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.
16  *
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.
21  */
22
23 /**
24  * SECTION:element-multiudpsink
25  * @see_also: udpsink, multifdsink
26  *
27  * multiudpsink is a network sink that sends UDP packets to multiple
28  * clients.
29  * It can be combined with rtp payload encoders to implement RTP streaming.
30  */
31
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
35
36 #ifdef HAVE_CONFIG_H
37 #include "config.h"
38 #endif
39 #include "gstmultiudpsink.h"
40
41 #include <string.h>
42 #ifdef HAVE_SYS_SOCKET_H
43 #include <sys/socket.h>
44 #endif
45
46 #ifndef G_OS_WIN32
47 #include <netinet/in.h>
48 #endif
49
50 #include "gst/glib-compat-private.h"
51
52 GST_DEBUG_CATEGORY_STATIC (multiudpsink_debug);
53 #define GST_CAT_DEFAULT (multiudpsink_debug)
54
55 #define UDP_MAX_SIZE 65507
56
57 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
58     GST_PAD_SINK,
59     GST_PAD_ALWAYS,
60     GST_STATIC_CAPS_ANY);
61
62 /* MultiUDPSink signals and args */
63 enum
64 {
65   /* methods */
66   SIGNAL_ADD,
67   SIGNAL_REMOVE,
68   SIGNAL_CLEAR,
69   SIGNAL_GET_STATS,
70
71   /* signals */
72   SIGNAL_CLIENT_ADDED,
73   SIGNAL_CLIENT_REMOVED,
74
75   /* FILL ME */
76   LAST_SIGNAL
77 };
78
79 #define DEFAULT_SOCKET             NULL
80 #define DEFAULT_CLOSE_SOCKET       TRUE
81 #define DEFAULT_USED_SOCKET        NULL
82 #define DEFAULT_CLIENTS            NULL
83 /* FIXME, this should be disabled by default, we don't need to join a multicast
84  * group for sending, if this socket is also used for receiving, it should
85  * be configured in the element that does the receive. */
86 #define DEFAULT_AUTO_MULTICAST     TRUE
87 #define DEFAULT_MULTICAST_IFACE    NULL
88 #define DEFAULT_TTL                64
89 #define DEFAULT_TTL_MC             1
90 #define DEFAULT_LOOP               TRUE
91 #define DEFAULT_FORCE_IPV4         FALSE
92 #define DEFAULT_QOS_DSCP           -1
93 #define DEFAULT_SEND_DUPLICATES    TRUE
94 #define DEFAULT_BUFFER_SIZE        0
95
96 enum
97 {
98   PROP_0,
99   PROP_BYTES_TO_SERVE,
100   PROP_BYTES_SERVED,
101   PROP_SOCKET,
102   PROP_CLOSE_SOCKET,
103   PROP_USED_SOCKET,
104   PROP_CLIENTS,
105   PROP_AUTO_MULTICAST,
106   PROP_MULTICAST_IFACE,
107   PROP_TTL,
108   PROP_TTL_MC,
109   PROP_LOOP,
110   PROP_FORCE_IPV4,
111   PROP_QOS_DSCP,
112   PROP_SEND_DUPLICATES,
113   PROP_BUFFER_SIZE,
114   PROP_LAST
115 };
116
117 static void gst_multiudpsink_finalize (GObject * object);
118
119 static GstFlowReturn gst_multiudpsink_render (GstBaseSink * sink,
120     GstBuffer * buffer);
121
122 static gboolean gst_multiudpsink_start (GstBaseSink * bsink);
123 static gboolean gst_multiudpsink_stop (GstBaseSink * bsink);
124 static gboolean gst_multiudpsink_unlock (GstBaseSink * bsink);
125 static gboolean gst_multiudpsink_unlock_stop (GstBaseSink * bsink);
126
127 static void gst_multiudpsink_set_property (GObject * object, guint prop_id,
128     const GValue * value, GParamSpec * pspec);
129 static void gst_multiudpsink_get_property (GObject * object, guint prop_id,
130     GValue * value, GParamSpec * pspec);
131
132 static void gst_multiudpsink_add_internal (GstMultiUDPSink * sink,
133     const gchar * host, gint port, gboolean lock);
134 static void gst_multiudpsink_clear_internal (GstMultiUDPSink * sink,
135     gboolean lock);
136
137 static guint gst_multiudpsink_signals[LAST_SIGNAL] = { 0 };
138
139 #define gst_multiudpsink_parent_class parent_class
140 G_DEFINE_TYPE (GstMultiUDPSink, gst_multiudpsink, GST_TYPE_BASE_SINK);
141
142 static void
143 gst_multiudpsink_class_init (GstMultiUDPSinkClass * klass)
144 {
145   GObjectClass *gobject_class;
146   GstElementClass *gstelement_class;
147   GstBaseSinkClass *gstbasesink_class;
148
149   gobject_class = (GObjectClass *) klass;
150   gstelement_class = (GstElementClass *) klass;
151   gstbasesink_class = (GstBaseSinkClass *) klass;
152
153   gobject_class->set_property = gst_multiudpsink_set_property;
154   gobject_class->get_property = gst_multiudpsink_get_property;
155   gobject_class->finalize = gst_multiudpsink_finalize;
156
157   /**
158    * GstMultiUDPSink::add:
159    * @gstmultiudpsink: the sink on which the signal is emitted
160    * @host: the hostname/IP address of the client to add
161    * @port: the port of the client to add
162    *
163    * Add a client with destination @host and @port to the list of
164    * clients. When the same host/port pair is added multiple times, the
165    * send-duplicates property defines if the packets are sent multiple times to
166    * the same host/port pair or not.
167    *
168    * When a host/port pair is added multiple times, an equal amount of remove
169    * calls must be performed to actually remove the host/port pair from the list
170    * of destinations.
171    */
172   gst_multiudpsink_signals[SIGNAL_ADD] =
173       g_signal_new ("add", G_TYPE_FROM_CLASS (klass),
174       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
175       G_STRUCT_OFFSET (GstMultiUDPSinkClass, add),
176       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
177       G_TYPE_STRING, G_TYPE_INT);
178   /**
179    * GstMultiUDPSink::remove:
180    * @gstmultiudpsink: the sink on which the signal is emitted
181    * @host: the hostname/IP address of the client to remove
182    * @port: the port of the client to remove
183    *
184    * Remove the client with destination @host and @port from the list of
185    * clients.
186    */
187   gst_multiudpsink_signals[SIGNAL_REMOVE] =
188       g_signal_new ("remove", G_TYPE_FROM_CLASS (klass),
189       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
190       G_STRUCT_OFFSET (GstMultiUDPSinkClass, remove),
191       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
192       G_TYPE_STRING, G_TYPE_INT);
193   /**
194    * GstMultiUDPSink::clear:
195    * @gstmultiudpsink: the sink on which the signal is emitted
196    *
197    * Clear the list of clients.
198    */
199   gst_multiudpsink_signals[SIGNAL_CLEAR] =
200       g_signal_new ("clear", G_TYPE_FROM_CLASS (klass),
201       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
202       G_STRUCT_OFFSET (GstMultiUDPSinkClass, clear),
203       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 0);
204   /**
205    * GstMultiUDPSink::get-stats:
206    * @gstmultiudpsink: the sink on which the signal is emitted
207    * @host: the hostname/IP address of the client to get stats on
208    * @port: the port of the client to get stats on
209    *
210    * Get the statistics of the client with destination @host and @port.
211    *
212    * Returns: a GstStructure: bytes_sent, packets_sent,
213    *           connect_time (in epoch seconds), disconnect_time (in epoch seconds)
214    */
215   gst_multiudpsink_signals[SIGNAL_GET_STATS] =
216       g_signal_new ("get-stats", G_TYPE_FROM_CLASS (klass),
217       G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
218       G_STRUCT_OFFSET (GstMultiUDPSinkClass, get_stats),
219       NULL, NULL, g_cclosure_marshal_generic, GST_TYPE_STRUCTURE, 2,
220       G_TYPE_STRING, G_TYPE_INT);
221   /**
222    * GstMultiUDPSink::client-added:
223    * @gstmultiudpsink: the sink emitting the signal
224    * @host: the hostname/IP address of the added client
225    * @port: the port of the added client
226    *
227    * Signal emited when a new client is added to the list of
228    * clients.
229    */
230   gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED] =
231       g_signal_new ("client-added", G_TYPE_FROM_CLASS (klass),
232       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass, client_added),
233       NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2,
234       G_TYPE_STRING, G_TYPE_INT);
235   /**
236    * GstMultiUDPSink::client-removed:
237    * @gstmultiudpsink: the sink emitting the signal
238    * @host: the hostname/IP address of the removed client
239    * @port: the port of the removed client
240    *
241    * Signal emited when a client is removed from the list of
242    * clients.
243    */
244   gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED] =
245       g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass),
246       G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstMultiUDPSinkClass,
247           client_removed), NULL, NULL, g_cclosure_marshal_generic,
248       G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_INT);
249
250   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BYTES_TO_SERVE,
251       g_param_spec_uint64 ("bytes-to-serve", "Bytes to serve",
252           "Number of bytes received to serve to clients", 0, G_MAXUINT64, 0,
253           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
254   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BYTES_SERVED,
255       g_param_spec_uint64 ("bytes-served", "Bytes served",
256           "Total number of bytes sent to all clients", 0, G_MAXUINT64, 0,
257           G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
258   g_object_class_install_property (gobject_class, PROP_SOCKET,
259       g_param_spec_object ("socket", "Socket Handle",
260           "Socket to use for UDP sending. (NULL == allocate)",
261           G_TYPE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
262   g_object_class_install_property (gobject_class, PROP_CLOSE_SOCKET,
263       g_param_spec_boolean ("close-socket", "Close socket",
264           "Close socket if passed as property on state change",
265           DEFAULT_CLOSE_SOCKET, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
266   g_object_class_install_property (gobject_class, PROP_USED_SOCKET,
267       g_param_spec_object ("used-socket", "Used Socket Handle",
268           "Socket currently in use for UDP sending. (NULL == no socket)",
269           G_TYPE_SOCKET, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
270   g_object_class_install_property (gobject_class, PROP_CLIENTS,
271       g_param_spec_string ("clients", "Clients",
272           "A comma separated list of host:port pairs with destinations",
273           DEFAULT_CLIENTS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
274   g_object_class_install_property (gobject_class, PROP_AUTO_MULTICAST,
275       g_param_spec_boolean ("auto-multicast",
276           "Automatically join/leave multicast groups",
277           "Automatically join/leave the multicast groups, FALSE means user"
278           " has to do it himself", DEFAULT_AUTO_MULTICAST,
279           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
280   g_object_class_install_property (gobject_class, PROP_MULTICAST_IFACE,
281       g_param_spec_string ("multicast-iface", "Multicast Interface",
282           "The network interface on which to join the multicast group",
283           DEFAULT_MULTICAST_IFACE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
284   g_object_class_install_property (gobject_class, PROP_TTL,
285       g_param_spec_int ("ttl", "Unicast TTL",
286           "Used for setting the unicast TTL parameter",
287           0, 255, DEFAULT_TTL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
288   g_object_class_install_property (gobject_class, PROP_TTL_MC,
289       g_param_spec_int ("ttl-mc", "Multicast TTL",
290           "Used for setting the multicast TTL parameter",
291           0, 255, DEFAULT_TTL_MC, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
292   g_object_class_install_property (gobject_class, PROP_LOOP,
293       g_param_spec_boolean ("loop", "Multicast Loopback",
294           "Used for setting the multicast loop parameter. TRUE = enable,"
295           " FALSE = disable", DEFAULT_LOOP,
296           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
297   /**
298    * GstMultiUDPSink::force-ipv4
299    *
300    * Force the use of an IPv4 socket.
301    *
302    * Since: 1.0.2
303    */
304   g_object_class_install_property (gobject_class, PROP_FORCE_IPV4,
305       g_param_spec_boolean ("force-ipv4", "Force IPv4",
306           "Forcing the use of an IPv4 socket", DEFAULT_FORCE_IPV4,
307           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
308
309   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QOS_DSCP,
310       g_param_spec_int ("qos-dscp", "QoS diff srv code point",
311           "Quality of Service, differentiated services code point (-1 default)",
312           -1, 63, DEFAULT_QOS_DSCP,
313           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
314   /**
315    * GstMultiUDPSink::send-duplicates
316    *
317    * When a host/port pair is added mutliple times, send the packet to the host
318    * multiple times as well.
319    *
320    * Since: 0.10.26
321    */
322   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_SEND_DUPLICATES,
323       g_param_spec_boolean ("send-duplicates", "Send Duplicates",
324           "When a distination/port pair is added multiple times, send packets "
325           "multiple times as well", DEFAULT_SEND_DUPLICATES,
326           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
327
328   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_BUFFER_SIZE,
329       g_param_spec_int ("buffer-size", "Buffer Size",
330           "Size of the kernel send buffer in bytes, 0=default", 0, G_MAXINT,
331           DEFAULT_BUFFER_SIZE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
332
333   gst_element_class_add_pad_template (gstelement_class,
334       gst_static_pad_template_get (&sink_template));
335
336   gst_element_class_set_static_metadata (gstelement_class, "UDP packet sender",
337       "Sink/Network",
338       "Send data over the network via UDP",
339       "Wim Taymans <wim.taymans@gmail.com>");
340
341   gstbasesink_class->render = gst_multiudpsink_render;
342   gstbasesink_class->start = gst_multiudpsink_start;
343   gstbasesink_class->stop = gst_multiudpsink_stop;
344   gstbasesink_class->unlock = gst_multiudpsink_unlock;
345   gstbasesink_class->unlock_stop = gst_multiudpsink_unlock_stop;
346   klass->add = gst_multiudpsink_add;
347   klass->remove = gst_multiudpsink_remove;
348   klass->clear = gst_multiudpsink_clear;
349   klass->get_stats = gst_multiudpsink_get_stats;
350
351   GST_DEBUG_CATEGORY_INIT (multiudpsink_debug, "multiudpsink", 0, "UDP sink");
352 }
353
354
355 static void
356 gst_multiudpsink_init (GstMultiUDPSink * sink)
357 {
358   guint max_mem;
359
360   g_mutex_init (&sink->client_lock);
361   sink->socket = DEFAULT_SOCKET;
362   sink->used_socket = DEFAULT_USED_SOCKET;
363   sink->close_socket = DEFAULT_CLOSE_SOCKET;
364   sink->external_socket = (sink->socket != NULL);
365   sink->auto_multicast = DEFAULT_AUTO_MULTICAST;
366   sink->ttl = DEFAULT_TTL;
367   sink->ttl_mc = DEFAULT_TTL_MC;
368   sink->loop = DEFAULT_LOOP;
369   sink->force_ipv4 = DEFAULT_FORCE_IPV4;
370   sink->qos_dscp = DEFAULT_QOS_DSCP;
371   sink->send_duplicates = DEFAULT_SEND_DUPLICATES;
372   sink->multi_iface = g_strdup (DEFAULT_MULTICAST_IFACE);
373
374   sink->cancellable = g_cancellable_new ();
375
376   /* allocate OutputVector and MapInfo for use in the render function, buffers can
377    * hold up to a maximum amount of memory so we can create a maximally sized
378    * array for them.  */
379   max_mem = gst_buffer_get_max_memory ();
380
381   sink->vec = g_new (GOutputVector, max_mem);
382   sink->map = g_new (GstMapInfo, max_mem);
383 }
384
385 static GstUDPClient *
386 create_client (GstMultiUDPSink * sink, const gchar * host, gint port)
387 {
388   GstUDPClient *client;
389   GInetAddress *addr;
390   GResolver *resolver;
391   GError *err = NULL;
392
393   addr = g_inet_address_new_from_string (host);
394   if (!addr) {
395     GList *results;
396
397     resolver = g_resolver_get_default ();
398     results =
399         g_resolver_lookup_by_name (resolver, host, sink->cancellable, &err);
400     if (!results)
401       goto name_resolve;
402     addr = G_INET_ADDRESS (g_object_ref (results->data));
403
404     g_resolver_free_addresses (results);
405     g_object_unref (resolver);
406   }
407 #ifndef GST_DISABLE_GST_DEBUG
408   {
409     gchar *ip = g_inet_address_to_string (addr);
410
411     GST_DEBUG_OBJECT (sink, "IP address for host %s is %s", host, ip);
412     g_free (ip);
413   }
414 #endif
415
416   client = g_slice_new0 (GstUDPClient);
417   client->refcount = 1;
418   client->host = g_strdup (host);
419   client->port = port;
420   client->addr = g_inet_socket_address_new (addr, port);
421   g_object_unref (addr);
422
423   return client;
424
425 name_resolve:
426   {
427     g_object_unref (resolver);
428
429     return NULL;
430   }
431 }
432
433 static void
434 free_client (GstUDPClient * client)
435 {
436   g_object_unref (client->addr);
437   g_free (client->host);
438   g_slice_free (GstUDPClient, client);
439 }
440
441 static gint
442 client_compare (GstUDPClient * a, GstUDPClient * b)
443 {
444   if ((a->port == b->port) && (strcmp (a->host, b->host) == 0))
445     return 0;
446
447   return 1;
448 }
449
450 static void
451 gst_multiudpsink_finalize (GObject * object)
452 {
453   GstMultiUDPSink *sink;
454
455   sink = GST_MULTIUDPSINK (object);
456
457   g_list_foreach (sink->clients, (GFunc) free_client, NULL);
458   g_list_free (sink->clients);
459
460   if (sink->socket)
461     g_object_unref (sink->socket);
462   sink->socket = NULL;
463
464   if (sink->used_socket)
465     g_object_unref (sink->used_socket);
466   sink->used_socket = NULL;
467
468   if (sink->cancellable)
469     g_object_unref (sink->cancellable);
470   sink->cancellable = NULL;
471
472   g_free (sink->multi_iface);
473   sink->multi_iface = NULL;
474
475   g_free (sink->vec);
476   g_free (sink->map);
477
478   g_mutex_clear (&sink->client_lock);
479
480   G_OBJECT_CLASS (parent_class)->finalize (object);
481 }
482
483 static GstFlowReturn
484 gst_multiudpsink_render (GstBaseSink * bsink, GstBuffer * buffer)
485 {
486   GstMultiUDPSink *sink;
487   GList *clients;
488   GOutputVector *vec;
489   GstMapInfo *map;
490   guint n_mem, i;
491   gsize size;
492   GstMemory *mem;
493   gint num, no_clients;
494   GError *err = NULL;
495
496   sink = GST_MULTIUDPSINK (bsink);
497
498   n_mem = gst_buffer_n_memory (buffer);
499   if (n_mem == 0)
500     goto no_data;
501
502   /* allocated on the stack, the max number of memory blocks is limited so this
503    * should not cause stack overflows */
504   vec = sink->vec;
505   map = sink->map;
506
507   size = 0;
508   for (i = 0; i < n_mem; i++) {
509     mem = gst_buffer_get_memory (buffer, i);
510     gst_memory_map (mem, &map[i], GST_MAP_READ);
511
512     vec[i].buffer = map[i].data;
513     vec[i].size = map[i].size;
514
515     size += map[i].size;
516   }
517
518   sink->bytes_to_serve += size;
519
520   /* grab lock while iterating and sending to clients, this should be
521    * fast as UDP never blocks */
522   g_mutex_lock (&sink->client_lock);
523   GST_LOG_OBJECT (bsink, "about to send %" G_GSIZE_FORMAT " bytes in %u blocks",
524       size, n_mem);
525
526   no_clients = 0;
527   num = 0;
528   for (clients = sink->clients; clients; clients = g_list_next (clients)) {
529     GstUDPClient *client;
530     gint count;
531
532     client = (GstUDPClient *) clients->data;
533     no_clients++;
534     GST_LOG_OBJECT (sink, "sending %" G_GSIZE_FORMAT " bytes to client %p",
535         size, client);
536
537     count = sink->send_duplicates ? client->refcount : 1;
538
539     while (count--) {
540       gssize ret;
541
542       ret =
543           g_socket_send_message (sink->used_socket, client->addr, vec, n_mem,
544           NULL, 0, 0, sink->cancellable, &err);
545
546       if (G_UNLIKELY (ret < 0)) {
547         if (g_error_matches (err, G_IO_ERROR, G_IO_ERROR_CANCELLED))
548           goto flushing;
549
550         /* we continue after posting a warning, next packets might be ok
551          * again */
552         if (size > UDP_MAX_SIZE) {
553           GST_ELEMENT_WARNING (sink, RESOURCE, WRITE,
554               ("Attempting to send a UDP packet larger than maximum size "
555                   "(%" G_GSIZE_FORMAT " > %d)", size, UDP_MAX_SIZE),
556               ("Reason: %s", err ? err->message : "unknown reason"));
557         } else {
558           GST_ELEMENT_WARNING (sink, RESOURCE, WRITE,
559               ("Error sending UDP packet"), ("Reason: %s",
560                   err ? err->message : "unknown reason"));
561         }
562         g_clear_error (&err);
563       } else {
564         num++;
565         client->bytes_sent += ret;
566         client->packets_sent++;
567         sink->bytes_served += ret;
568       }
569     }
570   }
571   g_mutex_unlock (&sink->client_lock);
572
573   /* unmap all memory again */
574   for (i = 0; i < n_mem; i++) {
575     gst_memory_unmap (map[i].memory, &map[i]);
576     gst_memory_unref (map[i].memory);
577   }
578
579   GST_LOG_OBJECT (sink, "sent %" G_GSIZE_FORMAT " bytes to %d (of %d) clients",
580       size, num, no_clients);
581
582   return GST_FLOW_OK;
583
584 no_data:
585   {
586     return GST_FLOW_OK;
587   }
588 flushing:
589   {
590     GST_DEBUG ("we are flushing");
591     g_mutex_unlock (&sink->client_lock);
592     g_clear_error (&err);
593
594     return GST_FLOW_FLUSHING;
595   }
596 }
597
598 static void
599 gst_multiudpsink_set_clients_string (GstMultiUDPSink * sink,
600     const gchar * string)
601 {
602   gchar **clients;
603   gint i;
604
605   clients = g_strsplit (string, ",", 0);
606
607   g_mutex_lock (&sink->client_lock);
608   /* clear all existing clients */
609   gst_multiudpsink_clear_internal (sink, FALSE);
610   for (i = 0; clients[i]; i++) {
611     gchar *host, *p;
612     gint64 port = 0;
613
614     host = clients[i];
615     p = strstr (clients[i], ":");
616     if (p != NULL) {
617       *p = '\0';
618       port = g_ascii_strtoll (p + 1, NULL, 10);
619     }
620     if (port != 0)
621       gst_multiudpsink_add_internal (sink, host, port, FALSE);
622   }
623   g_mutex_unlock (&sink->client_lock);
624
625   g_strfreev (clients);
626 }
627
628 static gchar *
629 gst_multiudpsink_get_clients_string (GstMultiUDPSink * sink)
630 {
631   GString *str;
632   GList *clients;
633
634   str = g_string_new ("");
635
636   g_mutex_lock (&sink->client_lock);
637   clients = sink->clients;
638   while (clients) {
639     GstUDPClient *client;
640     gint count;
641
642     client = (GstUDPClient *) clients->data;
643
644     clients = g_list_next (clients);
645
646     count = client->refcount;
647     while (count--) {
648       g_string_append_printf (str, "%s:%d%s", client->host, client->port,
649           (clients || count > 1 ? "," : ""));
650     }
651   }
652   g_mutex_unlock (&sink->client_lock);
653
654   return g_string_free (str, FALSE);
655 }
656
657 static void
658 gst_multiudpsink_setup_qos_dscp (GstMultiUDPSink * sink)
659 {
660   /* don't touch on -1 */
661   if (sink->qos_dscp < 0)
662     return;
663
664   if (sink->used_socket == NULL)
665     return;
666
667 #ifdef IP_TOS
668   {
669     gint tos;
670     gint fd;
671
672     fd = g_socket_get_fd (sink->used_socket);
673
674     GST_DEBUG_OBJECT (sink, "setting TOS to %d", sink->qos_dscp);
675
676     /* Extract and shift 6 bits of DSFIELD */
677     tos = (sink->qos_dscp & 0x3f) << 2;
678
679     if (setsockopt (fd, IPPROTO_IP, IP_TOS, &tos, sizeof (tos)) < 0) {
680       GST_ERROR_OBJECT (sink, "could not set TOS: %s", g_strerror (errno));
681     }
682 #ifdef IPV6_TCLASS
683     if (setsockopt (fd, IPPROTO_IPV6, IPV6_TCLASS, &tos, sizeof (tos)) < 0) {
684       GST_ERROR_OBJECT (sink, "could not set TCLASS: %s", g_strerror (errno));
685     }
686 #endif
687   }
688 #endif
689 }
690
691 static void
692 gst_multiudpsink_set_property (GObject * object, guint prop_id,
693     const GValue * value, GParamSpec * pspec)
694 {
695   GstMultiUDPSink *udpsink;
696
697   udpsink = GST_MULTIUDPSINK (object);
698
699   switch (prop_id) {
700     case PROP_SOCKET:
701       if (udpsink->socket != NULL && udpsink->socket != udpsink->used_socket &&
702           udpsink->close_socket) {
703         GError *err = NULL;
704
705         if (!g_socket_close (udpsink->socket, &err)) {
706           GST_ERROR ("failed to close socket %p: %s", udpsink->socket,
707               err->message);
708           g_clear_error (&err);
709         }
710       }
711       if (udpsink->socket)
712         g_object_unref (udpsink->socket);
713       udpsink->socket = g_value_dup_object (value);
714       GST_DEBUG_OBJECT (udpsink, "setting socket to %p", udpsink->socket);
715       break;
716     case PROP_CLOSE_SOCKET:
717       udpsink->close_socket = g_value_get_boolean (value);
718       break;
719     case PROP_CLIENTS:
720       gst_multiudpsink_set_clients_string (udpsink, g_value_get_string (value));
721       break;
722     case PROP_AUTO_MULTICAST:
723       udpsink->auto_multicast = g_value_get_boolean (value);
724       break;
725     case PROP_MULTICAST_IFACE:
726       g_free (udpsink->multi_iface);
727
728       if (g_value_get_string (value) == NULL)
729         udpsink->multi_iface = g_strdup (DEFAULT_MULTICAST_IFACE);
730       else
731         udpsink->multi_iface = g_value_dup_string (value);
732       break;
733     case PROP_TTL:
734       udpsink->ttl = g_value_get_int (value);
735       break;
736     case PROP_TTL_MC:
737       udpsink->ttl_mc = g_value_get_int (value);
738       break;
739     case PROP_LOOP:
740       udpsink->loop = g_value_get_boolean (value);
741       break;
742     case PROP_FORCE_IPV4:
743       udpsink->force_ipv4 = g_value_get_boolean (value);
744       break;
745     case PROP_QOS_DSCP:
746       udpsink->qos_dscp = g_value_get_int (value);
747       gst_multiudpsink_setup_qos_dscp (udpsink);
748       break;
749     case PROP_SEND_DUPLICATES:
750       udpsink->send_duplicates = g_value_get_boolean (value);
751       break;
752     case PROP_BUFFER_SIZE:
753       udpsink->buffer_size = g_value_get_int (value);
754       break;
755     default:
756       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
757       break;
758   }
759 }
760
761 static void
762 gst_multiudpsink_get_property (GObject * object, guint prop_id, GValue * value,
763     GParamSpec * pspec)
764 {
765   GstMultiUDPSink *udpsink;
766
767   udpsink = GST_MULTIUDPSINK (object);
768
769   switch (prop_id) {
770     case PROP_BYTES_TO_SERVE:
771       g_value_set_uint64 (value, udpsink->bytes_to_serve);
772       break;
773     case PROP_BYTES_SERVED:
774       g_value_set_uint64 (value, udpsink->bytes_served);
775       break;
776     case PROP_SOCKET:
777       g_value_set_object (value, udpsink->socket);
778       break;
779     case PROP_CLOSE_SOCKET:
780       g_value_set_boolean (value, udpsink->close_socket);
781       break;
782     case PROP_USED_SOCKET:
783       g_value_set_object (value, udpsink->used_socket);
784       break;
785     case PROP_CLIENTS:
786       g_value_take_string (value,
787           gst_multiudpsink_get_clients_string (udpsink));
788       break;
789     case PROP_AUTO_MULTICAST:
790       g_value_set_boolean (value, udpsink->auto_multicast);
791       break;
792     case PROP_MULTICAST_IFACE:
793       g_value_set_string (value, udpsink->multi_iface);
794       break;
795     case PROP_TTL:
796       g_value_set_int (value, udpsink->ttl);
797       break;
798     case PROP_TTL_MC:
799       g_value_set_int (value, udpsink->ttl_mc);
800       break;
801     case PROP_LOOP:
802       g_value_set_boolean (value, udpsink->loop);
803       break;
804     case PROP_FORCE_IPV4:
805       g_value_set_boolean (value, udpsink->force_ipv4);
806       break;
807     case PROP_QOS_DSCP:
808       g_value_set_int (value, udpsink->qos_dscp);
809       break;
810     case PROP_SEND_DUPLICATES:
811       g_value_set_boolean (value, udpsink->send_duplicates);
812       break;
813     case PROP_BUFFER_SIZE:
814       g_value_set_int (value, udpsink->buffer_size);
815       break;
816     default:
817       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
818       break;
819   }
820 }
821
822 static gboolean
823 gst_multiudpsink_configure_client (GstMultiUDPSink * sink,
824     GstUDPClient * client)
825 {
826   GInetSocketAddress *saddr = G_INET_SOCKET_ADDRESS (client->addr);
827   GInetAddress *addr = g_inet_socket_address_get_address (saddr);
828   GError *err = NULL;
829
830   GST_DEBUG_OBJECT (sink, "configuring client %p", client);
831
832   if (g_inet_address_get_is_multicast (addr)) {
833     GST_DEBUG_OBJECT (sink, "we have a multicast client %p", client);
834     if (sink->auto_multicast) {
835       GST_DEBUG_OBJECT (sink, "autojoining group");
836       if (!g_socket_join_multicast_group (sink->used_socket, addr, FALSE,
837               sink->multi_iface, &err))
838         goto join_group_failed;
839     }
840     GST_DEBUG_OBJECT (sink, "setting loop to %d", sink->loop);
841     g_socket_set_multicast_loopback (sink->used_socket, sink->loop);
842     GST_DEBUG_OBJECT (sink, "setting ttl to %d", sink->ttl_mc);
843     g_socket_set_multicast_ttl (sink->used_socket, sink->ttl_mc);
844   } else {
845     GST_DEBUG_OBJECT (sink, "setting unicast ttl to %d", sink->ttl);
846     g_socket_set_ttl (sink->used_socket, sink->ttl);
847   }
848   return TRUE;
849
850   /* ERRORS */
851 join_group_failed:
852   {
853     gst_multiudpsink_stop (GST_BASE_SINK (sink));
854     GST_ELEMENT_ERROR (sink, RESOURCE, SETTINGS, (NULL),
855         ("Could not join multicast group: %s",
856             err ? err->message : "unknown reason"));
857     g_clear_error (&err);
858     return FALSE;
859   }
860 }
861
862 /* create a socket for sending to remote machine */
863 static gboolean
864 gst_multiudpsink_start (GstBaseSink * bsink)
865 {
866   GstMultiUDPSink *sink;
867   GList *clients;
868   GstUDPClient *client;
869   GError *err = NULL;
870
871   sink = GST_MULTIUDPSINK (bsink);
872
873   if (sink->socket == NULL) {
874     GST_DEBUG_OBJECT (sink, "creating sockets");
875     /* create sender socket try IP6, fall back to IP4 */
876     if (sink->force_ipv4 || (sink->used_socket =
877             g_socket_new (G_SOCKET_FAMILY_IPV6,
878                 G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP, &err)) == NULL) {
879       if ((sink->used_socket = g_socket_new (G_SOCKET_FAMILY_IPV4,
880                   G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP, &err)) == NULL)
881         goto no_socket;
882     }
883
884     GST_DEBUG_OBJECT (sink, "have socket");
885     sink->external_socket = FALSE;
886   } else {
887     GST_DEBUG_OBJECT (sink, "using configured socket");
888     /* we use the configured socket */
889     sink->used_socket = G_SOCKET (g_object_ref (sink->socket));
890     sink->external_socket = TRUE;
891   }
892
893 #ifdef SO_SNDBUF
894   {
895     socklen_t len;
896     gint sndsize, ret;
897
898     len = sizeof (sndsize);
899     if (sink->buffer_size != 0) {
900       sndsize = sink->buffer_size;
901
902       GST_DEBUG_OBJECT (sink, "setting udp buffer of %d bytes", sndsize);
903       /* set buffer size, Note that on Linux this is typically limited to a
904        * maximum of around 100K. Also a minimum of 128 bytes is required on
905        * Linux. */
906       ret =
907           setsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET,
908           SO_SNDBUF, (void *) &sndsize, len);
909       if (ret != 0) {
910         GST_ELEMENT_WARNING (sink, RESOURCE, SETTINGS, (NULL),
911             ("Could not create a buffer of requested %d bytes, %d: %s",
912                 sndsize, ret, g_strerror (errno)));
913       }
914     }
915
916     /* read the value of the receive buffer. Note that on linux this returns 2x the
917      * value we set because the kernel allocates extra memory for metadata.
918      * The default on Linux is about 100K (which is about 50K without metadata) */
919     ret =
920         getsockopt (g_socket_get_fd (sink->used_socket), SOL_SOCKET, SO_SNDBUF,
921         (void *) &sndsize, &len);
922     if (ret == 0)
923       GST_DEBUG_OBJECT (sink, "have udp buffer of %d bytes", sndsize);
924     else
925       GST_DEBUG_OBJECT (sink, "could not get udp buffer size");
926   }
927 #endif
928
929   g_socket_set_broadcast (sink->used_socket, TRUE);
930
931   sink->bytes_to_serve = 0;
932   sink->bytes_served = 0;
933
934   gst_multiudpsink_setup_qos_dscp (sink);
935
936   /* look for multicast clients and join multicast groups appropriately
937      set also ttl and multicast loopback delivery appropriately  */
938   for (clients = sink->clients; clients; clients = g_list_next (clients)) {
939     client = (GstUDPClient *) clients->data;
940
941     if (!gst_multiudpsink_configure_client (sink, client))
942       return FALSE;
943   }
944   return TRUE;
945
946   /* ERRORS */
947 no_socket:
948   {
949     GST_ELEMENT_ERROR (sink, RESOURCE, FAILED, (NULL),
950         ("Could not create socket: %s", err->message));
951     g_clear_error (&err);
952     return FALSE;
953   }
954 }
955
956 static gboolean
957 gst_multiudpsink_stop (GstBaseSink * bsink)
958 {
959   GstMultiUDPSink *udpsink;
960
961   udpsink = GST_MULTIUDPSINK (bsink);
962
963   if (udpsink->used_socket) {
964     if (udpsink->close_socket || !udpsink->external_socket) {
965       GError *err = NULL;
966
967       if (!g_socket_close (udpsink->used_socket, &err)) {
968         GST_ERROR_OBJECT (udpsink, "Failed to close socket: %s", err->message);
969         g_clear_error (&err);
970       }
971     }
972
973     g_object_unref (udpsink->used_socket);
974     udpsink->used_socket = NULL;
975   }
976
977   return TRUE;
978 }
979
980 static void
981 gst_multiudpsink_add_internal (GstMultiUDPSink * sink, const gchar * host,
982     gint port, gboolean lock)
983 {
984   GstUDPClient *client;
985   GstUDPClient udpclient;
986   GTimeVal now;
987   GList *find;
988
989   udpclient.host = (gchar *) host;
990   udpclient.port = port;
991
992   GST_DEBUG_OBJECT (sink, "adding client on host %s, port %d", host, port);
993
994   if (lock)
995     g_mutex_lock (&sink->client_lock);
996
997   find = g_list_find_custom (sink->clients, &udpclient,
998       (GCompareFunc) client_compare);
999   if (find) {
1000     client = (GstUDPClient *) find->data;
1001
1002     GST_DEBUG_OBJECT (sink, "found %d existing clients with host %s, port %d",
1003         client->refcount, host, port);
1004     client->refcount++;
1005   } else {
1006     client = create_client (sink, host, port);
1007     if (!client)
1008       goto error;
1009
1010     g_get_current_time (&now);
1011     client->connect_time = GST_TIMEVAL_TO_TIME (now);
1012
1013     if (sink->used_socket)
1014       gst_multiudpsink_configure_client (sink, client);
1015
1016     GST_DEBUG_OBJECT (sink, "add client with host %s, port %d", host, port);
1017     sink->clients = g_list_prepend (sink->clients, client);
1018   }
1019
1020   if (lock)
1021     g_mutex_unlock (&sink->client_lock);
1022
1023   g_signal_emit (G_OBJECT (sink),
1024       gst_multiudpsink_signals[SIGNAL_CLIENT_ADDED], 0, host, port);
1025
1026   GST_DEBUG_OBJECT (sink, "added client on host %s, port %d", host, port);
1027   return;
1028
1029   /* ERRORS */
1030 error:
1031   {
1032     GST_DEBUG_OBJECT (sink, "did not add client on host %s, port %d", host,
1033         port);
1034     if (lock)
1035       g_mutex_unlock (&sink->client_lock);
1036     return;
1037   }
1038 }
1039
1040 void
1041 gst_multiudpsink_add (GstMultiUDPSink * sink, const gchar * host, gint port)
1042 {
1043   gst_multiudpsink_add_internal (sink, host, port, TRUE);
1044 }
1045
1046 void
1047 gst_multiudpsink_remove (GstMultiUDPSink * sink, const gchar * host, gint port)
1048 {
1049   GList *find;
1050   GstUDPClient udpclient;
1051   GstUDPClient *client;
1052   GTimeVal now;
1053
1054   udpclient.host = (gchar *) host;
1055   udpclient.port = port;
1056
1057   g_mutex_lock (&sink->client_lock);
1058   find = g_list_find_custom (sink->clients, &udpclient,
1059       (GCompareFunc) client_compare);
1060   if (!find)
1061     goto not_found;
1062
1063   client = (GstUDPClient *) find->data;
1064
1065   GST_DEBUG_OBJECT (sink, "found %d clients with host %s, port %d",
1066       client->refcount, host, port);
1067
1068   client->refcount--;
1069   if (client->refcount == 0) {
1070     GInetSocketAddress *saddr = G_INET_SOCKET_ADDRESS (client->addr);
1071     GInetAddress *addr = g_inet_socket_address_get_address (saddr);
1072
1073     GST_DEBUG_OBJECT (sink, "remove client with host %s, port %d", host, port);
1074
1075     g_get_current_time (&now);
1076     client->disconnect_time = GST_TIMEVAL_TO_TIME (now);
1077
1078     if (sink->used_socket && sink->auto_multicast
1079         && g_inet_address_get_is_multicast (addr)) {
1080       GError *err = NULL;
1081
1082       if (!g_socket_leave_multicast_group (sink->used_socket, addr, FALSE,
1083               sink->multi_iface, &err)) {
1084         GST_DEBUG_OBJECT (sink, "Failed to leave multicast group: %s",
1085             err->message);
1086         g_clear_error (&err);
1087       }
1088     }
1089
1090     /* Unlock to emit signal before we delete the actual client */
1091     g_mutex_unlock (&sink->client_lock);
1092     g_signal_emit (G_OBJECT (sink),
1093         gst_multiudpsink_signals[SIGNAL_CLIENT_REMOVED], 0, host, port);
1094     g_mutex_lock (&sink->client_lock);
1095
1096     sink->clients = g_list_delete_link (sink->clients, find);
1097
1098     free_client (client);
1099   }
1100   g_mutex_unlock (&sink->client_lock);
1101
1102   return;
1103
1104   /* ERRORS */
1105 not_found:
1106   {
1107     g_mutex_unlock (&sink->client_lock);
1108     GST_WARNING_OBJECT (sink, "client at host %s, port %d not found",
1109         host, port);
1110     return;
1111   }
1112 }
1113
1114 static void
1115 gst_multiudpsink_clear_internal (GstMultiUDPSink * sink, gboolean lock)
1116 {
1117   GST_DEBUG_OBJECT (sink, "clearing");
1118   /* we only need to remove the client structure, there is no additional
1119    * socket or anything to free for UDP */
1120   if (lock)
1121     g_mutex_lock (&sink->client_lock);
1122   g_list_foreach (sink->clients, (GFunc) free_client, sink);
1123   g_list_free (sink->clients);
1124   sink->clients = NULL;
1125   if (lock)
1126     g_mutex_unlock (&sink->client_lock);
1127 }
1128
1129 void
1130 gst_multiudpsink_clear (GstMultiUDPSink * sink)
1131 {
1132   gst_multiudpsink_clear_internal (sink, TRUE);
1133 }
1134
1135 GstStructure *
1136 gst_multiudpsink_get_stats (GstMultiUDPSink * sink, const gchar * host,
1137     gint port)
1138 {
1139   GstUDPClient *client;
1140   GstStructure *result = NULL;
1141   GstUDPClient udpclient;
1142   GList *find;
1143
1144   udpclient.host = (gchar *) host;
1145   udpclient.port = port;
1146
1147   g_mutex_lock (&sink->client_lock);
1148
1149   find = g_list_find_custom (sink->clients, &udpclient,
1150       (GCompareFunc) client_compare);
1151   if (!find)
1152     goto not_found;
1153
1154   GST_DEBUG_OBJECT (sink, "stats for client with host %s, port %d", host, port);
1155
1156   client = (GstUDPClient *) find->data;
1157
1158   result = gst_structure_new_empty ("multiudpsink-stats");
1159
1160   gst_structure_set (result,
1161       "bytes-sent", G_TYPE_UINT64, client->bytes_sent,
1162       "packets-sent", G_TYPE_UINT64, client->packets_sent,
1163       "connect-time", G_TYPE_UINT64, client->connect_time,
1164       "disconnect-time", G_TYPE_UINT64, client->disconnect_time, NULL);
1165
1166   g_mutex_unlock (&sink->client_lock);
1167
1168   return result;
1169
1170   /* ERRORS */
1171 not_found:
1172   {
1173     g_mutex_unlock (&sink->client_lock);
1174     GST_WARNING_OBJECT (sink, "client with host %s, port %d not found",
1175         host, port);
1176     /* Apparently (see comment in gstmultifdsink.c) returning NULL from here may
1177      * confuse/break python bindings */
1178     return gst_structure_new_empty ("multiudpsink-stats");
1179   }
1180 }
1181
1182 static gboolean
1183 gst_multiudpsink_unlock (GstBaseSink * bsink)
1184 {
1185   GstMultiUDPSink *sink;
1186
1187   sink = GST_MULTIUDPSINK (bsink);
1188
1189   g_cancellable_cancel (sink->cancellable);
1190
1191   return TRUE;
1192 }
1193
1194 static gboolean
1195 gst_multiudpsink_unlock_stop (GstBaseSink * bsink)
1196 {
1197   GstMultiUDPSink *sink;
1198
1199   sink = GST_MULTIUDPSINK (bsink);
1200
1201   g_cancellable_reset (sink->cancellable);
1202
1203   return TRUE;
1204 }