gstreamer/libs/gst/net/gstnettimeprovider.c
Robert Rosengren 5d885b9dc7 netutils: Add util for setting socket DSCP
Util function for setting QoS DSCP added, to remove duplicated code in
netclientclock and nettimeprovider. Fix build error if missing IP_TOS.

https://bugzilla.gnome.org/show_bug.cgi?id=784737
2017-11-01 11:00:47 +02:00

482 lines
14 KiB
C

/* GStreamer
* Copyright (C) 2005 Andy Wingo <wingo@pobox.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:gstnettimeprovider
* @title: 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.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "gstnettimeprovider.h"
#include "gstnettimepacket.h"
#include "gstnetutils.h"
GST_DEBUG_CATEGORY_STATIC (ntp_debug);
#define GST_CAT_DEFAULT (ntp_debug)
#define DEFAULT_ADDRESS "0.0.0.0"
#define DEFAULT_PORT 5637
#define DEFAULT_QOS_DSCP -1
#define IS_ACTIVE(self) (g_atomic_int_get (&((self)->priv->active)))
enum
{
PROP_0,
PROP_PORT,
PROP_ADDRESS,
PROP_CLOCK,
PROP_ACTIVE,
PROP_QOS_DSCP
};
#define GST_NET_TIME_PROVIDER_GET_PRIVATE(obj) \
(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GST_TYPE_NET_TIME_PROVIDER, GstNetTimeProviderPrivate))
struct _GstNetTimeProviderPrivate
{
gchar *address;
int port;
gint qos_dscp; /* ATOMIC */
GThread *thread;
GstClock *clock;
gboolean active; /* ATOMIC */
GSocket *socket;
GCancellable *cancel;
gboolean made_cancel_fd;
};
static void gst_net_time_provider_initable_iface_init (gpointer g_iface);
static gboolean gst_net_time_provider_start (GstNetTimeProvider * bself,
GError ** error);
static void gst_net_time_provider_stop (GstNetTimeProvider * bself);
static gpointer gst_net_time_provider_thread (gpointer data);
static void gst_net_time_provider_finalize (GObject * object);
static void gst_net_time_provider_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_net_time_provider_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
#define _do_init \
GST_DEBUG_CATEGORY_INIT (ntp_debug, "nettime", 0, "Network time provider"); \
G_IMPLEMENT_INTERFACE (G_TYPE_INITABLE, gst_net_time_provider_initable_iface_init)
#define gst_net_time_provider_parent_class parent_class
G_DEFINE_TYPE_WITH_CODE (GstNetTimeProvider, gst_net_time_provider,
GST_TYPE_OBJECT, _do_init);
static void
gst_net_time_provider_class_init (GstNetTimeProviderClass * klass)
{
GObjectClass *gobject_class;
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 (gobject_class, PROP_PORT,
g_param_spec_int ("port", "port",
"The port to receive the packets from, 0=allocate", 0, G_MAXUINT16,
DEFAULT_PORT,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | 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 | G_PARAM_CONSTRUCT_ONLY | 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_CONSTRUCT_ONLY | 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));
g_object_class_install_property (gobject_class, PROP_QOS_DSCP,
g_param_spec_int ("qos-dscp", "QoS diff srv code point",
"Quality of Service, differentiated services code point (-1 default)",
-1, 63, DEFAULT_QOS_DSCP,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
}
static void
gst_net_time_provider_init (GstNetTimeProvider * self)
{
self->priv = GST_NET_TIME_PROVIDER_GET_PRIVATE (self);
self->priv->port = DEFAULT_PORT;
self->priv->address = g_strdup (DEFAULT_ADDRESS);
self->priv->qos_dscp = DEFAULT_QOS_DSCP;
self->priv->thread = NULL;
self->priv->active = TRUE;
}
static void
gst_net_time_provider_finalize (GObject * object)
{
GstNetTimeProvider *self = GST_NET_TIME_PROVIDER (object);
if (self->priv->thread) {
gst_net_time_provider_stop (self);
g_assert (self->priv->thread == NULL);
}
g_free (self->priv->address);
self->priv->address = NULL;
if (self->priv->clock)
gst_object_unref (self->priv->clock);
self->priv->clock = NULL;
G_OBJECT_CLASS (parent_class)->finalize (object);
}
static gpointer
gst_net_time_provider_thread (gpointer data)
{
GstNetTimeProvider *self = data;
GCancellable *cancel = self->priv->cancel;
GSocket *socket = self->priv->socket;
GstNetTimePacket *packet;
GError *err = NULL;
gint cur_qos_dscp = DEFAULT_QOS_DSCP;
gint new_qos_dscp;
GST_INFO_OBJECT (self, "time provider thread is running");
while (TRUE) {
GSocketAddress *sender_addr = NULL;
GST_LOG_OBJECT (self, "waiting on socket");
if (!g_socket_condition_wait (socket, G_IO_IN, cancel, &err)) {
GST_INFO_OBJECT (self, "socket error: %s", err->message);
if (err->code == G_IO_ERROR_CANCELLED)
break;
/* try again */
g_usleep (G_USEC_PER_SEC / 10);
g_error_free (err);
err = NULL;
continue;
}
/* got data in */
packet = gst_net_time_packet_receive (socket, &sender_addr, &err);
if (err != NULL) {
GST_DEBUG_OBJECT (self, "receive error: %s", err->message);
g_usleep (G_USEC_PER_SEC / 10);
g_error_free (err);
err = NULL;
continue;
}
/* before next sending check if need to change QoS */
new_qos_dscp = self->priv->qos_dscp;
if (cur_qos_dscp != new_qos_dscp &&
gst_net_utils_set_socket_dscp (socket, new_qos_dscp)) {
GST_DEBUG_OBJECT (self, "changed QoS DSCP to: %d", new_qos_dscp);
cur_qos_dscp = new_qos_dscp;
}
if (IS_ACTIVE (self)) {
/* do what we were asked to and send the packet back */
packet->remote_time = gst_clock_get_time (self->priv->clock);
/* ignore errors */
gst_net_time_packet_send (packet, socket, sender_addr, NULL);
g_object_unref (sender_addr);
g_free (packet);
}
}
g_error_free (err);
GST_INFO_OBJECT (self, "time provider thread is stopping");
return NULL;
}
static void
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->priv->clock;
switch (prop_id) {
case PROP_PORT:
self->priv->port = g_value_get_int (value);
break;
case PROP_ADDRESS:
g_free (self->priv->address);
if (g_value_get_string (value) == NULL)
self->priv->address = g_strdup (DEFAULT_ADDRESS);
else
self->priv->address = g_strdup (g_value_get_string (value));
break;
case PROP_CLOCK:
gst_object_replace ((GstObject **) clock_p,
(GstObject *) g_value_get_object (value));
break;
case PROP_ACTIVE:
g_atomic_int_set (&self->priv->active, g_value_get_boolean (value));
break;
case PROP_QOS_DSCP:
g_atomic_int_set (&self->priv->qos_dscp, g_value_get_int (value));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_net_time_provider_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstNetTimeProvider *self = GST_NET_TIME_PROVIDER (object);
switch (prop_id) {
case PROP_PORT:
g_value_set_int (value, self->priv->port);
break;
case PROP_ADDRESS:
g_value_set_string (value, self->priv->address);
break;
case PROP_CLOCK:
g_value_set_object (value, self->priv->clock);
break;
case PROP_ACTIVE:
g_value_set_boolean (value, IS_ACTIVE (self));
break;
case PROP_QOS_DSCP:
g_value_set_int (value, self->priv->qos_dscp);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static gboolean
gst_net_time_provider_start (GstNetTimeProvider * self, GError ** error)
{
GSocketAddress *socket_addr, *bound_addr;
GInetAddress *inet_addr;
GPollFD dummy_pollfd;
GSocket *socket;
int port;
gchar *address;
GError *err = NULL;
if (self->priv->address) {
inet_addr = g_inet_address_new_from_string (self->priv->address);
if (inet_addr == NULL) {
err =
g_error_new (G_IO_ERROR, G_IO_ERROR_FAILED,
"Failed to parse address '%s'", self->priv->address);
goto invalid_address;
}
} else {
inet_addr = g_inet_address_new_any (G_SOCKET_FAMILY_IPV4);
}
GST_LOG_OBJECT (self, "creating socket");
socket = g_socket_new (g_inet_address_get_family (inet_addr),
G_SOCKET_TYPE_DATAGRAM, G_SOCKET_PROTOCOL_UDP, &err);
if (!socket)
goto no_socket;
GST_DEBUG_OBJECT (self, "binding on port %d", self->priv->port);
socket_addr = g_inet_socket_address_new (inet_addr, self->priv->port);
if (!g_socket_bind (socket, socket_addr, TRUE, &err)) {
g_object_unref (socket_addr);
g_object_unref (inet_addr);
goto bind_error;
}
g_object_unref (socket_addr);
g_object_unref (inet_addr);
bound_addr = g_socket_get_local_address (socket, NULL);
port = g_inet_socket_address_get_port (G_INET_SOCKET_ADDRESS (bound_addr));
inet_addr =
g_inet_socket_address_get_address (G_INET_SOCKET_ADDRESS (bound_addr));
address = g_inet_address_to_string (inet_addr);
if (g_strcmp0 (address, self->priv->address)) {
g_free (self->priv->address);
self->priv->address = address;
GST_DEBUG_OBJECT (self, "notifying address %s", address);
g_object_notify (G_OBJECT (self), "address");
} else {
g_free (address);
}
if (port != self->priv->port) {
self->priv->port = port;
GST_DEBUG_OBJECT (self, "notifying port %d", port);
g_object_notify (G_OBJECT (self), "port");
}
GST_DEBUG_OBJECT (self, "bound on UDP address %s, port %d",
self->priv->address, port);
g_object_unref (bound_addr);
self->priv->socket = socket;
self->priv->cancel = g_cancellable_new ();
self->priv->made_cancel_fd =
g_cancellable_make_pollfd (self->priv->cancel, &dummy_pollfd);
self->priv->thread = g_thread_try_new ("GstNetTimeProvider",
gst_net_time_provider_thread, self, &err);
if (!self->priv->thread)
goto no_thread;
return TRUE;
/* ERRORS */
invalid_address:
{
GST_ERROR_OBJECT (self, "invalid address: %s", self->priv->address);
g_propagate_error (error, err);
return FALSE;
}
no_socket:
{
GST_ERROR_OBJECT (self, "could not create socket: %s", err->message);
g_propagate_error (error, err);
g_object_unref (inet_addr);
return FALSE;
}
bind_error:
{
GST_ERROR_OBJECT (self, "bind failed: %s", err->message);
g_propagate_error (error, err);
g_object_unref (socket);
return FALSE;
}
no_thread:
{
GST_ERROR_OBJECT (self, "could not create thread: %s", err->message);
g_propagate_error (error, err);
g_object_unref (self->priv->socket);
self->priv->socket = NULL;
g_object_unref (self->priv->cancel);
self->priv->cancel = NULL;
return FALSE;
}
}
static void
gst_net_time_provider_stop (GstNetTimeProvider * self)
{
g_return_if_fail (self->priv->thread != NULL);
GST_INFO_OBJECT (self, "stopping..");
g_cancellable_cancel (self->priv->cancel);
g_thread_join (self->priv->thread);
self->priv->thread = NULL;
if (self->priv->made_cancel_fd)
g_cancellable_release_fd (self->priv->cancel);
g_object_unref (self->priv->cancel);
self->priv->cancel = NULL;
g_object_unref (self->priv->socket);
self->priv->socket = NULL;
GST_INFO_OBJECT (self, "stopped");
}
static gboolean
gst_net_time_provider_initable_init (GInitable * initable,
GCancellable * cancellable, GError ** error)
{
GstNetTimeProvider *self = GST_NET_TIME_PROVIDER (initable);
return gst_net_time_provider_start (self, error);
}
static void
gst_net_time_provider_initable_iface_init (gpointer g_iface)
{
GInitableIface *iface = g_iface;
iface->init = gst_net_time_provider_initable_init;
}
/**
* gst_net_time_provider_new:
* @clock: a #GstClock to export over the network
* @address: (allow-none): an address to bind on as a dotted quad
* (xxx.xxx.xxx.xxx), IPv6 address, or NULL to bind to all addresses
* @port: a port to bind on, or 0 to let the kernel choose
*
* Allows network clients to get the current time of @clock.
*
* Returns: (transfer full): the new #GstNetTimeProvider, or NULL on error
*/
GstNetTimeProvider *
gst_net_time_provider_new (GstClock * clock, const gchar * address, gint port)
{
GstNetTimeProvider *ret;
g_return_val_if_fail (clock && GST_IS_CLOCK (clock), NULL);
g_return_val_if_fail (port >= 0 && port <= G_MAXUINT16, NULL);
ret =
g_initable_new (GST_TYPE_NET_TIME_PROVIDER, NULL, NULL, "clock", clock,
"address", address, "port", port, NULL);
/* Clear floating flag */
g_object_ref_sink (ret);
return ret;
}