gst/udp/: Rework the socket allocation a bit based on the sockfd argument so that it becomes usable.

Original commit message from CVS:
Patch by: Laurent Glayal <spglegle at yahoo dot fr>
* gst/udp/gstdynudpsink.c: (gst_dynudpsink_class_init),
(gst_dynudpsink_init), (gst_dynudpsink_set_property),
(gst_dynudpsink_get_property), (gst_dynudpsink_init_send),
(gst_dynudpsink_close):
* gst/udp/gstdynudpsink.h:
* gst/udp/gstudpsrc.c: (gst_udpsrc_class_init), (gst_udpsrc_init),
(gst_udpsrc_create), (gst_udpsrc_set_property),
(gst_udpsrc_get_property), (gst_udpsrc_start), (gst_udpsrc_stop):
* gst/udp/gstudpsrc.h:
Rework the socket allocation a bit based on the sockfd argument so that
it becomes usable.
Add a closefd property to instruct the udp elements to close the custom
file descriptors when going to READY. Fixes #423304.
API:GstUDPSrc::closefd property
API:GstDynUDPSink::closefd property

4 files changed, 94 insertions, 34 deletions

diff --git a/gst/udp/gstdynudpsink.c b/gst/udp/gstdynudpsink.c
index 16903712..59b323de 100644
--- a/gst/udp/gstdynudpsink.c
+++ b/gst/udp/gstdynudpsink.c
@@ -29,6 +29,11 @@
 GST_DEBUG_CATEGORY_STATIC (dynudpsink_debug);
 #define GST_CAT_DEFAULT (dynudpsink_debug)
 
+#define CLOSE_IF_REQUESTED(udpctx)                                      \
+  if ((!udpctx->externalfd) || (udpctx->externalfd && udpctx->closefd)) \
+    CLOSE_SOCKET(udpctx->sock);                                         \
+  udpctx->sock = -1;
+
 static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
     GST_PAD_SINK,
     GST_PAD_ALWAYS,
@@ -53,11 +58,14 @@ enum
   LAST_SIGNAL
 };
 
+#define UDP_DEFAULT_SOCKFD		-1
+#define UDP_DEFAULT_CLOSEFD		TRUE
+
 enum
 {
   PROP_0,
-  PROP_SOCKFD
-      /* FILL ME */
+  PROP_SOCKFD,
+  PROP_CLOSEFD
 };
 
 static void gst_dynudpsink_base_init (gpointer g_class);
@@ -142,8 +150,12 @@ gst_dynudpsink_class_init (GstDynUDPSink * klass)
 
   g_object_class_install_property (gobject_class, PROP_SOCKFD,
       g_param_spec_int ("sockfd", "socket handle",
-          "Socket to use for UDP reception.",
-          0, G_MAXINT16, 0, G_PARAM_READWRITE));
+          "Socket to use for UDP sending. (-1 == allocate)",
+          -1, G_MAXINT16, UDP_DEFAULT_SOCKFD, G_PARAM_READWRITE));
+  g_object_class_install_property (gobject_class, PROP_CLOSEFD,
+      g_param_spec_boolean ("closefd", "Close sockfd",
+          "Close sockfd if passed as property on state change",
+          UDP_DEFAULT_CLOSEFD, G_PARAM_READWRITE));
 
   gstelement_class->change_state = gst_dynudpsink_change_state;
 
@@ -152,7 +164,6 @@ gst_dynudpsink_class_init (GstDynUDPSink * klass)
   GST_DEBUG_CATEGORY_INIT (dynudpsink_debug, "dynudpsink", 0, "UDP sink");
 }
 
-
 static void
 gst_dynudpsink_init (GstDynUDPSink * sink)
 {
@@ -162,6 +173,10 @@ gst_dynudpsink_init (GstDynUDPSink * sink)
 
   udpsink = GST_DYNUDPSINK (sink);
 
+  sink->sockfd = UDP_DEFAULT_SOCKFD;
+  sink->closefd = UDP_DEFAULT_CLOSEFD;
+  sink->externalfd = FALSE;
+
   sink->sock = -1;
 }
 
@@ -238,8 +253,11 @@ gst_dynudpsink_set_property (GObject * object, guint prop_id,
 
   switch (prop_id) {
     case PROP_SOCKFD:
-      udpsink->sock = g_value_get_int (value);
-      GST_DEBUG ("setting SOCKFD to %d", udpsink->sock);
+      udpsink->sockfd = g_value_get_int (value);
+      GST_DEBUG ("setting SOCKFD to %d", udpsink->sockfd);
+      break;
+    case PROP_CLOSEFD:
+      udpsink->closefd = g_value_get_boolean (value);
       break;
 
     default:
@@ -258,9 +276,11 @@ gst_dynudpsink_get_property (GObject * object, guint prop_id, GValue * value,
 
   switch (prop_id) {
     case PROP_SOCKFD:
-      g_value_set_int (value, udpsink->sock);
+      g_value_set_int (value, udpsink->sockfd);
+      break;
+    case PROP_CLOSEFD:
+      g_value_set_boolean (value, udpsink->closefd);
       break;
-
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -275,9 +295,8 @@ gst_dynudpsink_init_send (GstDynUDPSink * sink)
   guint bc_val;
   gint ret;
 
-  if (sink->sock == -1) {
+  if (sink->sockfd == -1) {
     /* create sender socket if none available */
-
     if ((sink->sock = socket (AF_INET, SOCK_DGRAM, 0)) == -1)
       goto no_socket;
 
@@ -286,8 +305,12 @@ gst_dynudpsink_init_send (GstDynUDPSink * sink)
             setsockopt (sink->sock, SOL_SOCKET, SO_BROADCAST, &bc_val,
                 sizeof (bc_val))) < 0)
       goto no_broadcast;
-  }
 
+    sink->externalfd = TRUE;
+  } else {
+    sink->sock = sink->sockfd;
+    sink->externalfd = TRUE;
+  }
   return TRUE;
 
   /* ERRORS */
@@ -299,6 +322,7 @@ no_socket:
 no_broadcast:
   {
     perror ("setsockopt");
+    CLOSE_IF_REQUESTED (sink);
     return FALSE;
   }
 }
@@ -312,7 +336,8 @@ gst_dynudpsink_get_stats (GstDynUDPSink * sink, const gchar * host, gint port)
 static void
 gst_dynudpsink_close (GstDynUDPSink * sink)
 {
-  CLOSE_SOCKET (sink->sock);
+  if (sink->sock != -1)
+    CLOSE_IF_REQUESTED (sink);
 }
 
 static GstStateChangeReturn
diff --git a/gst/udp/gstdynudpsink.h b/gst/udp/gstdynudpsink.h
index 0c300c95..f912b8a2 100644
--- a/gst/udp/gstdynudpsink.h
+++ b/gst/udp/gstdynudpsink.h
@@ -54,7 +54,13 @@ typedef struct _GstDynUDPSinkClass GstDynUDPSinkClass;
 struct _GstDynUDPSink {
   GstBaseSink parent;
 
+  /* properties */
+  gint sockfd;
+  gboolean closefd;
+
+  /* the socket in use */
   int sock;
+  gboolean externalfd;
 };
 
 struct _GstDynUDPSinkClass {
diff --git a/gst/udp/gstudpsrc.c b/gst/udp/gstudpsrc.c
index 322523c4..e80a74c8 100644
--- a/gst/udp/gstudpsrc.c
+++ b/gst/udp/gstudpsrc.c
@@ -103,7 +103,14 @@
  * because it is blocked by a firewall.
  * </para>
  * <para>
- * Last reviewed on 2007-03-02 (0.10.6)
+ * A custom file descriptor can be configured with the 
+ * <link linkend="GstUDPSrc--sockfd">sockfd property</link>. The socket will be
+ * closed when setting the element to READY by default. This behaviour can be
+ * overriden with the <link linkend="GstUDPSrc--closefd">closefd property</link>,
+ * in which case the application is responsible for closing the file descriptor.
+ * </para>
+ * <para>
+ * Last reviewed on 2007-03-29 (0.10.6)
  * </para>
  * </refsect2>
  */
@@ -146,6 +153,11 @@ G_STMT_START {                                  \
   res = read(READ_SOCKET(src), &command, 1);    \
 } G_STMT_END
 
+#define CLOSE_IF_REQUESTED(udpctx)                                        \
+  if ((!udpctx->externalfd) || (udpctx->externalfd && udpctx->closefd))   \
+    CLOSE_SOCKET(udpctx->sock);                                           \
+  udpctx->sock = -1;
+
 static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
     GST_PAD_SRC,
     GST_PAD_ALWAYS,
@@ -166,6 +178,7 @@ GST_ELEMENT_DETAILS ("UDP packet receiver",
 #define UDP_DEFAULT_BUFFER_SIZE		0
 #define UDP_DEFAULT_TIMEOUT             0
 #define UDP_DEFAULT_SKIP_FIRST_BYTES	0
+#define UDP_DEFAULT_CLOSEFD            TRUE
 
 enum
 {
@@ -177,7 +190,8 @@ enum
   PROP_SOCKFD,
   PROP_BUFFER_SIZE,
   PROP_TIMEOUT,
-  PROP_SKIP_FIRST_BYTES
+  PROP_SKIP_FIRST_BYTES,
+  PROP_CLOSEFD
 };
 
 static void gst_udpsrc_uri_handler_init (gpointer g_iface, gpointer iface_data);
@@ -268,6 +282,10 @@ gst_udpsrc_class_init (GstUDPSrcClass * klass)
       PROP_SKIP_FIRST_BYTES, g_param_spec_int ("skip-first-bytes",
           "Skip first bytes", "number of bytes to skip for each udp packet", 0,
           G_MAXINT, UDP_DEFAULT_SKIP_FIRST_BYTES, G_PARAM_READWRITE));
+  g_object_class_install_property (gobject_class, PROP_CLOSEFD,
+      g_param_spec_boolean ("closefd", "Close sockfd",
+          "Close sockfd if passed as property on state change",
+          UDP_DEFAULT_CLOSEFD, G_PARAM_READWRITE));
 
   gstbasesrc_class->start = gst_udpsrc_start;
   gstbasesrc_class->stop = gst_udpsrc_stop;
@@ -284,13 +302,16 @@ gst_udpsrc_init (GstUDPSrc * udpsrc, GstUDPSrcClass * g_class)
 
   gst_base_src_set_live (GST_BASE_SRC (udpsrc), TRUE);
   udpsrc->port = UDP_DEFAULT_PORT;
-  udpsrc->sock = UDP_DEFAULT_SOCKFD;
+  udpsrc->sockfd = UDP_DEFAULT_SOCKFD;
   udpsrc->multi_group = g_strdup (UDP_DEFAULT_MULTICAST_GROUP);
   udpsrc->uri = g_strdup (UDP_DEFAULT_URI);
   udpsrc->buffer_size = UDP_DEFAULT_BUFFER_SIZE;
   udpsrc->timeout = UDP_DEFAULT_TIMEOUT;
   udpsrc->skip_first_bytes = UDP_DEFAULT_SKIP_FIRST_BYTES;
+  udpsrc->closefd = UDP_DEFAULT_CLOSEFD;
+  udpsrc->externalfd = (udpsrc->sockfd != -1);
 
+  udpsrc->sock = -1;
   udpsrc->control_sock[0] = -1;
   udpsrc->control_sock[1] = -1;
 }
@@ -606,8 +627,8 @@ gst_udpsrc_set_property (GObject * object, guint prop_id, const GValue * value,
       break;
     }
     case PROP_SOCKFD:
-      udpsrc->sock = g_value_get_int (value);
-      GST_DEBUG ("setting SOCKFD to %d", udpsrc->sock);
+      udpsrc->sockfd = g_value_get_int (value);
+      GST_DEBUG ("setting SOCKFD to %d", udpsrc->sockfd);
       break;
     case PROP_TIMEOUT:
       udpsrc->timeout = g_value_get_uint64 (value);
@@ -615,6 +636,9 @@ gst_udpsrc_set_property (GObject * object, guint prop_id, const GValue * value,
     case PROP_SKIP_FIRST_BYTES:
       udpsrc->skip_first_bytes = g_value_get_int (value);
       break;
+    case PROP_CLOSEFD:
+      udpsrc->closefd = g_value_get_boolean (value);
+      break;
     default:
       break;
   }
@@ -643,7 +667,7 @@ gst_udpsrc_get_property (GObject * object, guint prop_id, GValue * value,
       gst_value_set_caps (value, udpsrc->caps);
       break;
     case PROP_SOCKFD:
-      g_value_set_int (value, udpsrc->sock);
+      g_value_set_int (value, udpsrc->sockfd);
       break;
     case PROP_TIMEOUT:
       g_value_set_uint64 (value, udpsrc->timeout);
@@ -651,6 +675,9 @@ gst_udpsrc_get_property (GObject * object, guint prop_id, GValue * value,
     case PROP_SKIP_FIRST_BYTES:
       g_value_set_int (value, udpsrc->skip_first_bytes);
       break;
+    case PROP_CLOSEFD:
+      g_value_set_boolean (value, udpsrc->closefd);
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -691,11 +718,13 @@ gst_udpsrc_start (GstBaseSrc * bsrc)
   if (!inet_aton (src->multi_group, &(src->multi_addr.imr_multiaddr)))
     src->multi_addr.imr_multiaddr.s_addr = 0;
 
-  if (src->sock == -1) {
+  if (src->sockfd == -1) {
+    /* need to allocate a socket */
     if ((ret = socket (PF_INET, SOCK_DGRAM, IPPROTO_UDP)) < 0)
       goto no_socket;
 
     src->sock = ret;
+    src->externalfd = FALSE;
 
     reuse = 1;
     if ((ret =
@@ -716,6 +745,10 @@ gst_udpsrc_start (GstBaseSrc * bsrc)
     if ((ret = bind (src->sock, (struct sockaddr *) &src->myaddr,
                 sizeof (src->myaddr))) < 0)
       goto bind_error;
+  } else {
+    /* we use the configured socket */
+    src->sock = src->sockfd;
+    src->externalfd = TRUE;
   }
 
   if (src->multi_addr.imr_multiaddr.s_addr) {
@@ -784,40 +817,35 @@ no_socket:
   }
 setsockopt_error:
   {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
         ("setsockopt failed %d: %s (%d)", ret, g_strerror (errno), errno));
     return FALSE;
   }
 bind_error:
   {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
         ("bind failed %d: %s (%d)", ret, g_strerror (errno), errno));
     return FALSE;
   }
 membership:
   {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
         ("could add membership %d: %s (%d)", ret, g_strerror (errno), errno));
     return FALSE;
   }
 getsockname_error:
   {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
         ("getsockname failed %d: %s (%d)", ret, g_strerror (errno), errno));
     return FALSE;
   }
 udpbuffer_error:
   {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
         ("Could not create a buffer of the size requested, %d: %s (%d)", ret,
             g_strerror (errno), errno));
@@ -825,8 +853,7 @@ udpbuffer_error:
   }
 no_broadcast:
   {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
     GST_ELEMENT_ERROR (src, RESOURCE, SETTINGS, (NULL),
         ("could not configure socket for broadcast %d: %s (%d)", ret,
             g_strerror (errno), errno));
@@ -859,8 +886,7 @@ gst_udpsrc_stop (GstBaseSrc * bsrc)
   GST_DEBUG ("stopping, closing sockets");
 
   if (src->sock != -1) {
-    CLOSE_SOCKET (src->sock);
-    src->sock = -1;
+    CLOSE_IF_REQUESTED (src);
   }
 
   /* pipes on WIN32 else sockets */
diff --git a/gst/udp/gstudpsrc.h b/gst/udp/gstudpsrc.h
index 09df444d..c672d2a2 100644
--- a/gst/udp/gstudpsrc.h
+++ b/gst/udp/gstudpsrc.h
@@ -60,10 +60,13 @@ struct _GstUDPSrc {
   gint     buffer_size;
   guint64  timeout;
   gint     skip_first_bytes;
+  int      sockfd;
+  gboolean closefd;
 
   /* our sockets */
   int      sock;
   int      control_sock[2];
+  gboolean externalfd;
 
   struct   sockaddr_in myaddr;
   struct   ip_mreq multi_addr;