nd-sink: Add URI helpers and to_uri method

Prep for turning GND into a daemon.

Co-authored-by: Christian Glombek <[email protected]>

Author: pesader

Diff for: src/meson.build

@@ -24,6 +24,7 @@ gnome_nd_sources = [
   'nd-dummy-wfd-sink.c',
   'nd-dummy-cc-sink.c',
   'nd-pulseaudio.c',
+  'nd-uri-helpers.c',
 ]
 
 enum_headers = files('nd-sink.h')

Diff for: src/nd-cc-sink.c

@@ -17,11 +17,13 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "gnome-network-displays-config.h"
-#include "nd-cc-sink.h"
 #include "cc/cc-ctrl.h"
 #include "cc/cc-common.h"
 #include "cc/cc-http-server.h"
+#include "gnome-network-displays-config.h"
+#include "nd-cc-sink.h"
+#include "nd-enum-types.h"
+#include "nd-uri-helpers.h"
 
 struct _NdCCSink
 {
@@ -69,6 +71,7 @@ const static NdSinkProtocol protocol = ND_SINK_PROTOCOL_CC;
 static void nd_cc_sink_sink_iface_init (NdSinkIface *iface);
 static NdSink * nd_cc_sink_sink_start_stream (NdSink *sink);
 static void nd_cc_sink_sink_stop_stream (NdSink *sink);
+static gchar * nd_cc_sink_sink_to_uri (NdSink *sink);
 
 static void nd_cc_sink_sink_stop_stream_int (NdCCSink *self);
 
@@ -304,6 +307,24 @@ nd_cc_sink_init (NdCCSink *self)
   srand (time (NULL));
 }
 
+static gchar *
+nd_cc_sink_sink_to_uri (NdSink *sink)
+{
+  NdCCSink *self = ND_CC_SINK (sink);
+  GHashTable *params = g_hash_table_new (g_str_hash, g_str_equal);
+
+  /* protocol */
+  g_hash_table_insert (params, "protocol", (gpointer *) g_strdup_printf ("%d", protocol));
+
+  /* remote name */
+  g_hash_table_insert (params, "name", (gpointer *) g_strdup (self->name));
+
+  /* remote address */
+  g_hash_table_insert (params, "ip", (gpointer *) g_strdup (self->ip));
+
+  return nd_uri_helpers_generate_uri (params);
+}
+
 /******************************************************************
 * NdSink interface implementation
 ******************************************************************/
@@ -313,6 +334,7 @@ nd_cc_sink_sink_iface_init (NdSinkIface *iface)
 {
   iface->start_stream = nd_cc_sink_sink_start_stream;
   iface->stop_stream = nd_cc_sink_sink_stop_stream;
+  iface->to_uri = nd_cc_sink_sink_to_uri;
 }
 
 static GstElement *
@@ -436,6 +458,59 @@ nd_cc_sink_new (GSocketClient *client,
                        NULL);
 }
 
+/**
+ * nd_cc_sink_from_uri
+ * @uri: a URI string
+ *
+ * Construct a #NdCCSink using the information encoded in the URI string
+ *
+ * Returns: The newly constructed #NdCCSink or #NULL if failed
+ */
+NdCCSink *
+nd_cc_sink_from_uri (gchar *uri)
+{
+  GHashTable *params = nd_uri_helpers_parse_uri (uri);
+
+  /* protocol */
+  const gchar *protocol_in_uri_str = g_hash_table_lookup (params, "protocol");
+
+  ;
+  NdSinkProtocol protocol_in_uri = g_ascii_strtoll (protocol_in_uri_str, NULL, 10);
+  if (protocol != protocol_in_uri)
+    {
+      g_warning ("NdCCSink: Attempted to create sink whose protocol (%s) doesn't match the URI (%s)",
+                 g_enum_to_string (ND_TYPE_SINK_PROTOCOL, protocol),
+                 g_enum_to_string (ND_TYPE_SINK_PROTOCOL, protocol_in_uri));
+      return NULL;
+    }
+
+  /* client */
+  GSocketClient *client = g_socket_client_new ();
+  if (!client)
+    {
+      g_warning ("NdCCSink: Failed to instantiate GSocketClient");
+      return NULL;
+    }
+
+  /* remote name */
+  gchar *name = g_hash_table_lookup (params, "name");
+  if (!name)
+    {
+      g_warning ("NdCCSink: Failed to find remote name in the URI %s", uri);
+      return NULL;
+    }
+
+  /* remote ip */
+  gchar *ip = g_hash_table_lookup (params, "ip");
+  if (!ip)
+    {
+      g_warning ("NdCCSink: Failed to find remote IP address in the URI %s", uri);
+      return NULL;
+    }
+
+  return nd_cc_sink_new (client, name, ip);
+}
+
 NdSinkState
 nd_cc_sink_get_state (NdCCSink *self)
 {

Diff for: src/nd-cc-sink.h

@@ -32,5 +32,6 @@ NdCCSink * nd_cc_sink_new (GSocketClient * client,
                            gchar         * ip);
 
 NdSinkState nd_cc_sink_get_state (NdCCSink *sink);
+NdCCSink * nd_cc_sink_from_uri (gchar *uri);
 
 G_END_DECLS

Diff for: src/nd-dummy-cc-sink.c

@@ -17,9 +17,11 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "cc/cc-http-server.h"
 #include "gnome-network-displays-config.h"
 #include "nd-dummy-cc-sink.h"
-#include "cc/cc-http-server.h"
+#include "nd-enum-types.h"
+#include "nd-uri-helpers.h"
 
 struct _NdDummyCCSink
 {
@@ -59,6 +61,7 @@ const static NdSinkProtocol protocol = ND_SINK_PROTOCOL_DUMMY_CC;
 static void nd_dummy_cc_sink_sink_iface_init (NdSinkIface *iface);
 static NdSink * nd_dummy_cc_sink_sink_start_stream (NdSink *sink);
 static void nd_dummy_cc_sink_sink_stop_stream (NdSink *sink);
+static gchar * nd_dummy_cc_sink_sink_to_uri (NdSink *sink);
 
 G_DEFINE_TYPE_EXTENDED (NdDummyCCSink, nd_dummy_cc_sink, G_TYPE_OBJECT, 0,
                         G_IMPLEMENT_INTERFACE (ND_TYPE_SINK,
@@ -165,6 +168,17 @@ nd_dummy_cc_sink_init (NdDummyCCSink *sink)
   sink->state = ND_SINK_STATE_DISCONNECTED;
 }
 
+static gchar *
+nd_dummy_cc_sink_sink_to_uri (NdSink *sink)
+{
+  GHashTable *params = g_hash_table_new (g_str_hash, g_str_equal);
+
+  /* protocol */
+  g_hash_table_insert (params, "protocol", (gpointer *) g_strdup_printf ("%d", protocol));
+
+  return nd_uri_helpers_generate_uri (params);
+}
+
 /******************************************************************
 * NdSink interface implementation
 ******************************************************************/
@@ -174,6 +188,7 @@ nd_dummy_cc_sink_sink_iface_init (NdSinkIface *iface)
 {
   iface->start_stream = nd_dummy_cc_sink_sink_start_stream;
   iface->stop_stream = nd_dummy_cc_sink_sink_stop_stream;
+  iface->to_uri = nd_dummy_cc_sink_sink_to_uri;
 }
 
 static void
@@ -322,3 +337,32 @@ nd_dummy_cc_sink_new (void)
   return g_object_new (ND_TYPE_DUMMY_CC_SINK,
                        NULL);
 }
+
+/**
+ * nd_dummy_cc_sink_from_uri
+ * @uri: a URI string
+ *
+ * Construct a #NdDummyCCSink using the information encoded in the URI string
+ *
+ * Returns: The newly constructed #NdDummyCCSink
+ */
+NdDummyCCSink *
+nd_dummy_cc_sink_from_uri (gchar *uri)
+{
+  GHashTable *params = nd_uri_helpers_parse_uri (uri);
+
+  /* protocol */
+  const gchar *protocol_in_uri_str = g_hash_table_lookup (params, "protocol");
+
+  ;
+  NdSinkProtocol protocol_in_uri = g_ascii_strtoll (protocol_in_uri_str, NULL, 10);
+  if (protocol != protocol_in_uri)
+    {
+      g_warning ("NdDummyCCSink: Attempted to create sink whose protocol (%s) doesn't match the URI (%s)",
+                 g_enum_to_string (ND_TYPE_SINK_PROTOCOL, protocol),
+                 g_enum_to_string (ND_TYPE_SINK_PROTOCOL, protocol_in_uri));
+      return NULL;
+    }
+
+  return nd_dummy_cc_sink_new ();
+}

Diff for: src/nd-dummy-cc-sink.h

@@ -9,5 +9,6 @@ G_BEGIN_DECLS
 G_DECLARE_FINAL_TYPE (NdDummyCCSink, nd_dummy_cc_sink, ND, DUMMY_CC_SINK, GObject)
 
 NdDummyCCSink * nd_dummy_cc_sink_new (void);
+NdDummyCCSink * nd_dummy_cc_sink_from_uri (gchar *uri);
 
 G_END_DECLS

Diff for: src/nd-dummy-wfd-sink.c

@@ -16,10 +16,13 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "wfd/wfd-client.h"
-#include "wfd/wfd-server.h"
 #include "gnome-network-displays-config.h"
 #include "nd-dummy-wfd-sink.h"
+#include "nd-enum-types.h"
+#include "nd-uri-helpers.h"
+#include "wfd/wfd-client.h"
+#include "wfd/wfd-media-factory.h"
+#include "wfd/wfd-server.h"
 
 struct _NdDummyWFDSink
 {
@@ -59,6 +62,7 @@ const static NdSinkProtocol protocol = ND_SINK_PROTOCOL_DUMMY_WFD_P2P;
 static void nd_dummy_wfd_sink_sink_iface_init (NdSinkIface *iface);
 static NdSink * nd_dummy_wfd_sink_sink_start_stream (NdSink *sink);
 static void nd_dummy_wfd_sink_sink_stop_stream (NdSink *sink);
+static gchar * nd_dummy_wfd_sink_sink_to_uri (NdSink *sink);
 
 G_DEFINE_TYPE_EXTENDED (NdDummyWFDSink, nd_dummy_wfd_sink, G_TYPE_OBJECT, 0,
                         G_IMPLEMENT_INTERFACE (ND_TYPE_SINK,
@@ -164,6 +168,17 @@ nd_dummy_wfd_sink_init (NdDummyWFDSink *sink)
   sink->state = ND_SINK_STATE_DISCONNECTED;
 }
 
+static gchar *
+nd_dummy_wfd_sink_sink_to_uri (NdSink *sink)
+{
+  GHashTable *params = g_hash_table_new (g_str_hash, g_str_equal);
+
+  /* protocol */
+  g_hash_table_insert (params, "protocol", (gpointer *) g_strdup_printf ("%d", protocol));
+
+  return nd_uri_helpers_generate_uri (params);
+}
+
 /******************************************************************
 * NdSink interface implementation
 ******************************************************************/
@@ -173,6 +188,7 @@ nd_dummy_wfd_sink_sink_iface_init (NdSinkIface *iface)
 {
   iface->start_stream = nd_dummy_wfd_sink_sink_start_stream;
   iface->stop_stream = nd_dummy_wfd_sink_sink_stop_stream;
+  iface->to_uri = nd_dummy_wfd_sink_sink_to_uri;
 }
 
 static void
@@ -337,3 +353,32 @@ nd_dummy_wfd_sink_new (void)
   return g_object_new (ND_TYPE_DUMMY_WFD_SINK,
                        NULL);
 }
+
+/**
+ * nd_dummy_wfd_sink_from_uri
+ * @uri: a URI string
+ *
+ * Construct a #NdDummyWFDSink using the information encoded in the URI string
+ *
+ * Returns: The newly constructed #NdDummyWFDSink
+ */
+NdDummyWFDSink *
+nd_dummy_wfd_sink_from_uri (gchar *uri)
+{
+  GHashTable *params = nd_uri_helpers_parse_uri (uri);
+
+  /* protocol */
+  const gchar *protocol_in_uri_str = g_hash_table_lookup (params, "protocol");
+
+  ;
+  NdSinkProtocol protocol_in_uri = g_ascii_strtoll (protocol_in_uri_str, NULL, 10);
+  if (protocol != protocol_in_uri)
+    {
+      g_warning ("NdDummyWFDSink: Attempted to create sink whose protocol (%s) doesn't match the URI (%s)",
+                 g_enum_to_string (ND_TYPE_SINK_PROTOCOL, protocol),
+                 g_enum_to_string (ND_TYPE_SINK_PROTOCOL, protocol_in_uri));
+      return NULL;
+    }
+
+  return nd_dummy_wfd_sink_new ();
+}

Diff for: src/nd-dummy-wfd-sink.h

@@ -9,5 +9,6 @@ G_BEGIN_DECLS
 G_DECLARE_FINAL_TYPE (NdDummyWFDSink, nd_dummy_wfd_sink, ND, DUMMY_WFD_SINK, GObject)
 
 NdDummyWFDSink * nd_dummy_wfd_sink_new (void);
+NdDummyWFDSink * nd_dummy_wfd_sink_from_uri (gchar *uri);
 
 G_END_DECLS

Diff for: src/nd-meta-sink.c

@@ -18,6 +18,7 @@
 
 #include "gnome-network-displays-config.h"
 #include "nd-meta-sink.h"
+#include "nd-sink.h"
 
 struct _NdMetaSink
 {
@@ -50,6 +51,7 @@ const static NdSinkProtocol protocol = ND_SINK_PROTOCOL_META;
 static void nd_meta_sink_sink_iface_init (NdSinkIface *iface);
 static NdSink * nd_meta_sink_sink_start_stream (NdSink *sink);
 static void nd_meta_sink_sink_stop_stream (NdSink *sink);
+static gchar * nd_meta_sink_sink_to_uri (NdSink *sink);
 
 G_DEFINE_TYPE_EXTENDED (NdMetaSink, nd_meta_sink, G_TYPE_OBJECT, 0,
                         G_IMPLEMENT_INTERFACE (ND_TYPE_SINK,
@@ -287,6 +289,16 @@ nd_meta_sink_init (NdMetaSink *meta_sink)
   meta_sink->sinks = g_ptr_array_new_with_free_func (g_object_unref);
 }
 
+static gchar *
+nd_meta_sink_sink_to_uri (NdSink *sink)
+{
+  NdMetaSink *meta_sink = ND_META_SINK (sink);
+
+  g_assert (meta_sink->current_sink);
+
+  return nd_sink_to_uri (meta_sink->current_sink);
+}
+
 /******************************************************************
 * NdSink interface implementation
 ******************************************************************/
@@ -296,6 +308,7 @@ nd_meta_sink_sink_iface_init (NdSinkIface *iface)
 {
   iface->start_stream = nd_meta_sink_sink_start_stream;
   iface->stop_stream = nd_meta_sink_sink_stop_stream;
+  iface->to_uri = nd_meta_sink_sink_to_uri;
 }
 
 static NdSink *

Diff for: src/nd-sink.c

@@ -18,8 +18,9 @@
 
 #include <gio/gio.h>
 #include <gst/gst.h>
-#include "nd-sink.h"
 #include "gnome-network-displays-config.h"
+#include "nd-sink.h"
+#include "nd-enum-types.h"
 
 typedef NdSinkIface NdSinkInterface;
 G_DEFINE_INTERFACE (NdSink, nd_sink, G_TYPE_OBJECT);
@@ -141,3 +142,17 @@ nd_sink_stop_stream (NdSink *sink)
 
   iface->stop_stream (sink);
 }
+
+/**
+ * nd_sink_to_uri
+ * @sink: the #NdSink
+ *
+ * Create a URI string for the given sink
+ */
+gchar *
+nd_sink_to_uri (NdSink *sink)
+{
+  NdSinkIface *iface = ND_SINK_GET_IFACE (sink);
+
+  return iface->to_uri (sink);
+}

Diff for: src/nd-sink.h

@@ -68,12 +68,14 @@ struct _NdSinkIface
   /*< public >*/
   NdSink * (* start_stream) (NdSink *sink);
   void     (* stop_stream)  (NdSink *sink);
+  gchar  * (* to_uri)       (NdSink *sink);
 };
 
 GType nd_sink_get_type (void) G_GNUC_CONST;
 
 NdSink *nd_sink_start_stream (NdSink *sink);
-void            nd_sink_stop_stream (NdSink *sink);
+void    nd_sink_stop_stream (NdSink *sink);
+gchar  *nd_sink_to_uri (NdSink *sink);
 
 G_DEFINE_AUTOPTR_CLEANUP_FUNC (NdSink, g_object_unref)