]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - glsdk/gstreamer0-10.git/blobdiff - libs/gst/net/gstnettimeprovider.c
g_thread_create() is deprecated in GLib master, use g_thread_try_new() instead
[glsdk/gstreamer0-10.git] / libs / gst / net / gstnettimeprovider.c
index 07a0a45e98f258c1b22b5ab1797005862e684ce0..8e3e7f6d1eb23753df7581b2367893e92779a08b 100644 (file)
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-
+/**
+ * SECTION:gstnettimeprovider
+ * @short_description: Special object that exposed the time of a clock
+ *                     on the network.
+ * @see_also: #GstClock, #GstNetClientClock, #GstPipeline
+ *
+ * This object exposes the time of a #GstClock on the network.
+ *
+ * A #GstNetTimeProvider is created with gst_net_time_provider_new() which
+ * takes a #GstClock, an address and a port number as arguments.
+ *
+ * After creating the object, a client clock such as #GstNetClientClock can
+ * query the exposed clock over the network for its values.
+ *
+ * The #GstNetTimeProvider typically wraps the clock used by a #GstPipeline.
+ *
+ * Last reviewed on 2005-11-23 (0.9.5)
+ */
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
 #include "gstnettimeprovider.h"
+#include "gstnettimepacket.h"
+
+#include <glib.h>
+
+#ifdef HAVE_UNISTD_H
 #include <unistd.h>
+#endif
+
+#if defined (_MSC_VER) && _MSC_VER >= 1400
+#include <io.h>
+#endif
+
+#ifndef G_OS_WIN32
 #include <sys/ioctl.h>
+#endif
 
 #ifdef HAVE_FIONREAD_IN_SYS_FILIO
 #include <sys/filio.h>
 #endif
 
-GST_DEBUG_CATEGORY (ntp_debug);
+GST_DEBUG_CATEGORY_STATIC (ntp_debug);
 #define GST_CAT_DEFAULT (ntp_debug)
 
-/* the select call is also performed on the control sockets, that way
- * we can send special commands to unblock or restart the select call */
-#define CONTROL_RESTART        'R'      /* restart the select call */
-#define CONTROL_STOP           'S'      /* stop the select call */
-#define CONTROL_SOCKETS(self)   self->control_sock
-#define WRITE_SOCKET(self)      self->control_sock[1]
-#define READ_SOCKET(self)       self->control_sock[0]
-
-#define SEND_COMMAND(self, command)                    \
-G_STMT_START {                                         \
-  unsigned char c; c = command;                        \
-  write (WRITE_SOCKET(self), &c, 1);           \
-} G_STMT_END
-
-#define READ_COMMAND(self, command, res)               \
-G_STMT_START {                                 \
-  res = read(READ_SOCKET(self), &command, 1);    \
-} G_STMT_END
-
-#define DEFAULT_ADDRESS                "0.0.0.0"
-#define DEFAULT_PORT           5637
-
-typedef struct
-{
-  GstClockTime slave_time_sent;
-  GstClockTime master_time_received;
-} NetworkTimePacket;
+#ifdef G_OS_WIN32
+#define close(sock) closesocket(sock)
+#endif
 
- /* 2 * sizeof(GstClockTime), verified in base_init */
-#define NETWORK_TIME_PACKET_SIZE 16
-#define NETWORK_TIME_PACKET_SET_MASTER_TIME(p, t) \
-  GST_WRITE_UINT64_BE(p+8, t)
+#define DEFAULT_ADDRESS         "0.0.0.0"
+#define DEFAULT_PORT            5637
 
+#define IS_ACTIVE(self) (g_atomic_int_get (&((self)->active.active)))
+
+#ifdef G_OS_WIN32
+#define setsockopt(sock, sol_flags, reuse_flags, ru, sizeofru) setsockopt (sock, sol_flags, reuse_flags, (char *)ru, sizeofru)
+#endif
 enum
 {
   PROP_0,
   PROP_PORT,
   PROP_ADDRESS,
-  PROP_CLOCK
+  PROP_CLOCK,
+  PROP_ACTIVE
       /* FILL ME */
 };
 
+#define GST_NET_TIME_PROVIDER_GET_PRIVATE(obj)  \
+   (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_NET_TIME_PROVIDER, GstNetTimeProviderPrivate))
+
+struct _GstNetTimeProviderPrivate
+{
+  GstPollFD sock;
+  GstPoll *fdset;
+};
+
 static gboolean gst_net_time_provider_start (GstNetTimeProvider * bself);
 static void gst_net_time_provider_stop (GstNetTimeProvider * bself);
 
@@ -92,10 +111,22 @@ static void gst_net_time_provider_get_property (GObject * object, guint prop_id,
 GST_BOILERPLATE_FULL (GstNetTimeProvider, gst_net_time_provider, GstObject,
     GST_TYPE_OBJECT, _do_init);
 
+#ifdef G_OS_WIN32
+static int
+inet_aton (const char *c, struct in_addr *paddr)
+{
+  paddr->s_addr = inet_addr (c);
+  if (paddr->s_addr == INADDR_NONE)
+    return 0;
+
+  return 1;
+}
+#endif
+
 static void
 gst_net_time_provider_base_init (gpointer g_class)
 {
-  g_assert (sizeof (GstClockTime) == 8);
+  /* Do nothing here */
 }
 
 static void
@@ -103,37 +134,56 @@ gst_net_time_provider_class_init (GstNetTimeProviderClass * klass)
 {
   GObjectClass *gobject_class;
 
-  gobject_class = (GObjectClass *) klass;
+  gobject_class = G_OBJECT_CLASS (klass);
+
+  g_assert (sizeof (GstClockTime) == 8);
+
+  g_type_class_add_private (klass, sizeof (GstNetTimeProviderPrivate));
 
   gobject_class->finalize = gst_net_time_provider_finalize;
   gobject_class->set_property = gst_net_time_provider_set_property;
   gobject_class->get_property = gst_net_time_provider_get_property;
 
-  g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PORT,
+  g_object_class_install_property (gobject_class, PROP_PORT,
       g_param_spec_int ("port", "port",
-          "The port to receive the packets from, -1=allocate", -1, 32768,
-          DEFAULT_PORT, G_PARAM_READWRITE));
+          "The port to receive the packets from, 0=allocate", 0, G_MAXUINT16,
+          DEFAULT_PORT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
   g_object_class_install_property (gobject_class, PROP_ADDRESS,
       g_param_spec_string ("address", "address",
           "The address to bind on, as a dotted quad (x.x.x.x)",
-          DEFAULT_ADDRESS, G_PARAM_READWRITE));
+          DEFAULT_ADDRESS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
   g_object_class_install_property (gobject_class, PROP_CLOCK,
       g_param_spec_object ("clock", "Clock",
           "The clock to export over the network", GST_TYPE_CLOCK,
-          G_PARAM_READWRITE));
+          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+  g_object_class_install_property (gobject_class, PROP_ACTIVE,
+      g_param_spec_boolean ("active", "Active",
+          "TRUE if the clock will respond to queries over the network", TRUE,
+          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 }
 
 static void
 gst_net_time_provider_init (GstNetTimeProvider * self,
     GstNetTimeProviderClass * g_class)
 {
+#ifdef G_OS_WIN32
+  WSADATA w;
+  int error = WSAStartup (0x0202, &w);
+
+  if (error) {
+    GST_DEBUG_OBJECT (self, "Error on WSAStartup");
+  }
+  if (w.wVersion != 0x0202) {
+    WSACleanup ();
+  }
+#endif
+  self->priv = GST_NET_TIME_PROVIDER_GET_PRIVATE (self);
+
   self->port = DEFAULT_PORT;
-  self->sock = -1;
+  self->priv->sock.fd = -1;
   self->address = g_strdup (DEFAULT_ADDRESS);
   self->thread = NULL;
-
-  READ_SOCKET (self) = -1;
-  WRITE_SOCKET (self) = -1;
+  self->active.active = TRUE;
 }
 
 static void
@@ -146,11 +196,9 @@ gst_net_time_provider_finalize (GObject * object)
     g_assert (self->thread == NULL);
   }
 
-  if (READ_SOCKET (self) != -1) {
-    close (READ_SOCKET (self));
-    close (WRITE_SOCKET (self));
-    READ_SOCKET (self) = -1;
-    WRITE_SOCKET (self) = -1;
+  if (self->priv->fdset) {
+    gst_poll_free (self->priv->fdset);
+    self->priv->fdset = NULL;
   }
 
   g_free (self->address);
@@ -160,6 +208,10 @@ gst_net_time_provider_finalize (GObject * object)
     gst_object_unref (self->clock);
   self->clock = NULL;
 
+#ifdef G_OS_WIN32
+  WSACleanup ();
+#endif
+
   G_OBJECT_CLASS (parent_class)->finalize (object);
 }
 
@@ -169,85 +221,43 @@ gst_net_time_provider_thread (gpointer data)
   GstNetTimeProvider *self = data;
   struct sockaddr_in tmpaddr;
   socklen_t len;
-  fd_set read_fds;
-  guint max_sock;
-  gchar *pktdata;
+  GstNetTimePacket *packet;
   gint ret;
 
   while (TRUE) {
-    FD_ZERO (&read_fds);
-    FD_SET (self->sock, &read_fds);
-    FD_SET (READ_SOCKET (self), &read_fds);
-    max_sock = MAX (self->sock, READ_SOCKET (self));
-
     GST_LOG_OBJECT (self, "doing select");
-    ret = select (max_sock + 1, &read_fds, NULL, NULL, NULL);
+    ret = gst_poll_wait (self->priv->fdset, GST_CLOCK_TIME_NONE);
     GST_LOG_OBJECT (self, "select returned %d", ret);
 
     if (ret <= 0) {
-      if (errno != EAGAIN && errno != EINTR)
+      if (errno == EBUSY) {
+        GST_LOG_OBJECT (self, "stop");
+        goto stopped;
+      } else if (errno != EAGAIN && errno != EINTR)
         goto select_error;
       else
         continue;
-    } else if (FD_ISSET (READ_SOCKET (self), &read_fds)) {
-      /* got control message */
-      while (TRUE) {
-        gchar command;
-        int res;
-
-        READ_COMMAND (self, command, res);
-        if (res < 0) {
-          GST_LOG_OBJECT (self, "no more commands");
-          break;
-        }
-
-        switch (command) {
-          case CONTROL_STOP:
-            /* break out of the select loop */
-            GST_LOG_OBJECT (self, "stop");
-            goto stopped;
-          default:
-            GST_WARNING_OBJECT (self, "unkown");
-            g_warning ("nettimeprovider: unknown control message received");
-            continue;
-        }
-
-        g_assert_not_reached ();
-      }
-
-      continue;
     } else {
       /* got data in */
-      pktdata = g_malloc (NETWORK_TIME_PACKET_SIZE);
-
       len = sizeof (struct sockaddr);
-      while (TRUE) {
-        ret = recvfrom (self->sock, pktdata, NETWORK_TIME_PACKET_SIZE,
-            0, (struct sockaddr *) &tmpaddr, &len);
-        if (ret < 0) {
-          if (errno != EAGAIN && errno != EINTR)
-            goto receive_error;
-          else
-            continue;
-        } else if (ret < NETWORK_TIME_PACKET_SIZE) {
-          goto short_packet;
-        } else {
-          GstClockTime now;
-
-          now = gst_clock_get_time (self->clock);
-
-          NETWORK_TIME_PACKET_SET_MASTER_TIME (pktdata, time);
-
-          /* ignore errors */
-          sendto (self->sock, pktdata, ret, MSG_DONTWAIT,
-              (struct sockaddr *) &tmpaddr, len);
-
-          break;
-        }
-
-        g_assert_not_reached ();
+
+      packet = gst_net_time_packet_receive (self->priv->sock.fd,
+          (struct sockaddr *) &tmpaddr, &len);
+
+      if (!packet)
+        goto receive_error;
+
+      if (IS_ACTIVE (self)) {
+        /* do what we were asked to and send the packet back */
+        packet->remote_time = gst_clock_get_time (self->clock);
+
+        /* ignore errors */
+        gst_net_time_packet_send (packet, self->priv->sock.fd,
+            (struct sockaddr *) &tmpaddr, len);
       }
 
+      g_free (packet);
+
       continue;
     }
 
@@ -260,12 +270,6 @@ gst_net_time_provider_thread (gpointer data)
           g_strerror (errno), errno);
       continue;
     }
-  short_packet:
-    {
-      GST_DEBUG_OBJECT (self, "someone sent us a short packet (%d < %d)",
-          ret, NETWORK_TIME_PACKET_SIZE);
-      continue;
-    }
   stopped:
     {
       GST_DEBUG_OBJECT (self, "shutting down");
@@ -274,9 +278,7 @@ gst_net_time_provider_thread (gpointer data)
     }
   receive_error:
     {
-      g_free (pktdata);
-      GST_DEBUG_OBJECT (self, "receive error %d: %s (%d)", ret,
-          g_strerror (errno), errno);
+      GST_DEBUG_OBJECT (self, "receive error");
       continue;
     }
 
@@ -294,6 +296,7 @@ gst_net_time_provider_set_property (GObject * object, guint prop_id,
     const GValue * value, GParamSpec * pspec)
 {
   GstNetTimeProvider *self = GST_NET_TIME_PROVIDER (object);
+  GstClock **clock_p = &self->clock;
 
   switch (prop_id) {
     case PROP_PORT:
@@ -307,9 +310,12 @@ gst_net_time_provider_set_property (GObject * object, guint prop_id,
         self->address = g_strdup (g_value_get_string (value));
       break;
     case PROP_CLOCK:
-      gst_object_replace ((GstObject **) & self->clock,
+      gst_object_replace ((GstObject **) clock_p,
           (GstObject *) g_value_get_object (value));
       break;
+    case PROP_ACTIVE:
+      g_atomic_int_set (&self->active.active, g_value_get_boolean (value));
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -332,6 +338,9 @@ gst_net_time_provider_get_property (GObject * object, guint prop_id,
     case PROP_CLOCK:
       g_value_set_object (value, self->clock);
       break;
+    case PROP_ACTIVE:
+      g_value_set_boolean (value, IS_ACTIVE (self));
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -343,7 +352,7 @@ gst_net_time_provider_start (GstNetTimeProvider * self)
 {
   gint ru;
   struct sockaddr_in my_addr;
-  guint len;
+  socklen_t len;
   int port;
   gint ret;
   GError *error;
@@ -351,41 +360,58 @@ gst_net_time_provider_start (GstNetTimeProvider * self)
   if ((ret = socket (AF_INET, SOCK_DGRAM, 0)) < 0)
     goto no_socket;
 
-  self->sock = ret;
+  self->priv->sock.fd = ret;
 
   ru = 1;
-  ret = setsockopt (self->sock, SOL_SOCKET, SO_REUSEADDR, &ru, sizeof (ru));
+  ret =
+      setsockopt (self->priv->sock.fd, SOL_SOCKET, SO_REUSEADDR, &ru,
+      sizeof (ru));
   if (ret < 0)
     goto setsockopt_error;
 
   memset (&my_addr, 0, sizeof (my_addr));
   my_addr.sin_family = AF_INET; /* host byte order */
-  my_addr.sin_port = htons (self->port);        /* short, network byte order */
+  my_addr.sin_port = htons ((gint16) self->port);       /* short, network byte order */
   my_addr.sin_addr.s_addr = INADDR_ANY;
-  if (self->address)
-    inet_aton (self->address, &my_addr.sin_addr);
+  if (self->address) {
+    ret = inet_aton (self->address, &my_addr.sin_addr);
+    if (ret == 0)
+      goto invalid_address_error;
+  }
 
   GST_DEBUG_OBJECT (self, "binding on port %d", self->port);
-  ret = bind (self->sock, (struct sockaddr *) &my_addr, sizeof (my_addr));
+  ret =
+      bind (self->priv->sock.fd, (struct sockaddr *) &my_addr,
+      sizeof (my_addr));
   if (ret < 0)
     goto bind_error;
 
   len = sizeof (my_addr);
-  ret = getsockname (self->sock, (struct sockaddr *) &my_addr, &len);
+  ret = getsockname (self->priv->sock.fd, (struct sockaddr *) &my_addr, &len);
   if (ret < 0)
     goto getsockname_error;
 
   port = ntohs (my_addr.sin_port);
   GST_DEBUG_OBJECT (self, "bound, on port %d", port);
+
   if (port != self->port) {
     self->port = port;
     GST_DEBUG_OBJECT (self, "notifying %d", port);
     g_object_notify (G_OBJECT (self), "port");
   }
 
+  gst_poll_add_fd (self->priv->fdset, &self->priv->sock);
+  gst_poll_fd_ctl_read (self->priv->fdset, &self->priv->sock, TRUE);
+
+#if !GLIB_CHECK_VERSION (2, 31, 0)
   self->thread = g_thread_create (gst_net_time_provider_thread, self, TRUE,
       &error);
-  if (!self->thread)
+#else
+  self->thread = g_thread_try_new ("GstNetTimeProvider",
+      gst_net_time_provider_thread, self, &error);
+#endif
+
+  if (error != NULL)
     goto no_thread;
 
   return TRUE;
@@ -399,32 +425,41 @@ no_socket:
   }
 setsockopt_error:
   {
-    close (self->sock);
-    self->sock = -1;
+    close (self->priv->sock.fd);
+    self->priv->sock.fd = -1;
     GST_ERROR_OBJECT (self, "setsockopt failed %d: %s (%d)", ret,
         g_strerror (errno), errno);
     return FALSE;
   }
+invalid_address_error:
+  {
+    close (self->priv->sock.fd);
+    self->priv->sock.fd = -1;
+    GST_ERROR_OBJECT (self, "invalid network address %s: %s (%d)",
+        self->address, g_strerror (errno), errno);
+    return FALSE;
+  }
 bind_error:
   {
-    close (self->sock);
-    self->sock = -1;
+    close (self->priv->sock.fd);
+    self->priv->sock.fd = -1;
     GST_ERROR_OBJECT (self, "bind failed %d: %s (%d)", ret,
         g_strerror (errno), errno);
     return FALSE;
   }
 getsockname_error:
   {
-    close (self->sock);
-    self->sock = -1;
+    close (self->priv->sock.fd);
+    self->priv->sock.fd = -1;
     GST_ERROR_OBJECT (self, "getsockname failed %d: %s (%d)", ret,
         g_strerror (errno), errno);
     return FALSE;
   }
 no_thread:
   {
-    close (self->sock);
-    self->sock = -1;
+    gst_poll_remove_fd (self->priv->fdset, &self->priv->sock);
+    close (self->priv->sock.fd);
+    self->priv->sock.fd = -1;
     GST_ERROR_OBJECT (self, "could not create thread: %s", error->message);
     g_error_free (error);
     return FALSE;
@@ -434,13 +469,14 @@ no_thread:
 static void
 gst_net_time_provider_stop (GstNetTimeProvider * self)
 {
-  SEND_COMMAND (self, CONTROL_STOP);
+  gst_poll_set_flushing (self->priv->fdset, TRUE);
   g_thread_join (self->thread);
   self->thread = NULL;
 
-  if (self->sock != -1) {
-    close (self->sock);
-    self->sock = -1;
+  if (self->priv->sock.fd != -1) {
+    gst_poll_remove_fd (self->priv->fdset, &self->priv->sock);
+    close (self->priv->sock.fd);
+    self->priv->sock.fd = -1;
   }
 }
 
@@ -449,30 +485,25 @@ gst_net_time_provider_stop (GstNetTimeProvider * self)
  * @clock: a #GstClock to export over the network
  * @address: an address to bind on as a dotted quad (xxx.xxx.xxx.xxx), or NULL
  *           to bind to all addresses
- * @port: a port to bind on, or -1 to let the kernel choose
+ * @port: a port to bind on, or 0 to let the kernel choose
  *
  * Allows network clients to get the current time of @clock.
  *
- * Returns: The new #GstNetTimeProvider, or NULL on error.
+ * Returns: the new #GstNetTimeProvider, or NULL on error
  */
 GstNetTimeProvider *
 gst_net_time_provider_new (GstClock * clock, const gchar * address, gint port)
 {
   GstNetTimeProvider *ret;
-  gint iret;
 
   g_return_val_if_fail (clock && GST_IS_CLOCK (clock), NULL);
-  g_return_val_if_fail (port == -1 || port >= 0, NULL);
+  g_return_val_if_fail (port >= 0 && port <= G_MAXUINT16, NULL);
 
   ret = g_object_new (GST_TYPE_NET_TIME_PROVIDER, "clock", clock, "address",
       address, "port", port, NULL);
 
-  GST_DEBUG_OBJECT (ret, "creating socket pair");
-  if ((iret = socketpair (PF_UNIX, SOCK_STREAM, 0, CONTROL_SOCKETS (ret))) < 0)
-    goto no_socket_pair;
-
-  fcntl (READ_SOCKET (ret), F_SETFL, O_NONBLOCK);
-  fcntl (WRITE_SOCKET (ret), F_SETFL, O_NONBLOCK);
+  if ((ret->priv->fdset = gst_poll_new (TRUE)) == NULL)
+    goto no_fdset;
 
   if (!gst_net_time_provider_start (ret))
     goto failed_start;
@@ -480,9 +511,9 @@ gst_net_time_provider_new (GstClock * clock, const gchar * address, gint port)
   /* all systems go, cap'n */
   return ret;
 
-no_socket_pair:
+no_fdset:
   {
-    GST_ERROR_OBJECT (ret, "no socket pair %d: %s (%d)", iret,
+    GST_ERROR_OBJECT (ret, "could not create an fdset: %s (%d)",
         g_strerror (errno), errno);
     gst_object_unref (ret);
     return NULL;
@@ -493,5 +524,4 @@ failed_start:
     gst_object_unref (ret);
     return NULL;
   }
-
 }