pipewire/pipewire/gst/gstpipewiredeviceprovider.c

/* GStreamer
 * Copyright (C) 2012 Olivier Crete <olivier.crete@collabora.com>
 *           (C) 2015 Wim Taymans <wim.taymans@gmail.com>
 *
 * pipewiredeviceprovider.c: PipeWire device probing and monitoring
 *
 * 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <string.h>

#include <gst/gst.h>

#include "gstpipewireformat.h"
#include "gstpipewiredeviceprovider.h"
#include "gstpipewiresrc.h"
#include "gstpipewiresink.h"

GST_DEBUG_CATEGORY_EXTERN (pipewire_debug);
#define GST_CAT_DEFAULT pipewire_debug

G_DEFINE_TYPE (GstPipeWireDevice, gst_pipewire_device, GST_TYPE_DEVICE);

enum
{
  PROP_ID = 1,
};

static GstDevice *
gst_pipewire_device_new (uint32_t id, const gchar * device_name,
    GstCaps * caps, const gchar *klass,
    GstPipeWireDeviceType type, GstStructure *props)
{
  GstPipeWireDevice *gstdev;
  const gchar *element = NULL;

  g_return_val_if_fail (device_name, NULL);
  g_return_val_if_fail (caps, NULL);

  switch (type) {
    case GST_PIPEWIRE_DEVICE_TYPE_SOURCE:
      element = "pipewiresrc";
      break;
    case GST_PIPEWIRE_DEVICE_TYPE_SINK:
      element = "pipewiresink";
      break;
    default:
      g_assert_not_reached ();
      break;
  }

  gstdev = g_object_new (GST_TYPE_PIPEWIRE_DEVICE,
      "display-name", device_name, "caps", caps, "device-class", klass,
      "id", id, "properties", props, NULL);

  gstdev->id = id;
  gstdev->type = type;
  gstdev->element = element;

  return GST_DEVICE (gstdev);
}

static GstElement *
gst_pipewire_device_create_element (GstDevice * device, const gchar * name)
{
  GstPipeWireDevice *pipewire_dev = GST_PIPEWIRE_DEVICE (device);
  GstElement *elem;
  gchar *str;

  elem = gst_element_factory_make (pipewire_dev->element, name);
  str = g_strdup_printf ("%u", pipewire_dev->id);
  g_object_set (elem, "path", str, NULL);
  g_free (str);

  return elem;
}

static gboolean
gst_pipewire_device_reconfigure_element (GstDevice * device, GstElement * element)
{
  GstPipeWireDevice *pipewire_dev = GST_PIPEWIRE_DEVICE (device);
  gchar *str;

  if (!strcmp (pipewire_dev->element, "pipewiresrc")) {
    if (!GST_IS_PIPEWIRE_SRC (element))
      return FALSE;
  } else if (!strcmp (pipewire_dev->element, "pipewiresink")) {
    if (!GST_IS_PIPEWIRE_SINK (element))
      return FALSE;
  } else {
    g_assert_not_reached ();
  }

  str = g_strdup_printf ("%u", pipewire_dev->id);
  g_object_set (element, "path", str, NULL);
  g_free (str);

  return TRUE;
}


static void
gst_pipewire_device_get_property (GObject * object, guint prop_id,
    GValue * value, GParamSpec * pspec)
{
  GstPipeWireDevice *device;

  device = GST_PIPEWIRE_DEVICE_CAST (object);

  switch (prop_id) {
    case PROP_ID:
      g_value_set_uint (value, device->id);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
gst_pipewire_device_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec)
{
  GstPipeWireDevice *device;

  device = GST_PIPEWIRE_DEVICE_CAST (object);

  switch (prop_id) {
    case PROP_ID:
      device->id = g_value_get_uint (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
gst_pipewire_device_finalize (GObject * object)
{
  G_OBJECT_CLASS (gst_pipewire_device_parent_class)->finalize (object);
}

static void
gst_pipewire_device_class_init (GstPipeWireDeviceClass * klass)
{
  GstDeviceClass *dev_class = GST_DEVICE_CLASS (klass);
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  dev_class->create_element = gst_pipewire_device_create_element;
  dev_class->reconfigure_element = gst_pipewire_device_reconfigure_element;

  object_class->get_property = gst_pipewire_device_get_property;
  object_class->set_property = gst_pipewire_device_set_property;
  object_class->finalize = gst_pipewire_device_finalize;

  g_object_class_install_property (object_class, PROP_ID,
      g_param_spec_uint ("id", "Id",
          "The internal id of the PipeWire device", 0, G_MAXUINT32, SPA_ID_INVALID,
          G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
}

static void
gst_pipewire_device_init (GstPipeWireDevice * device)
{
}

G_DEFINE_TYPE (GstPipeWireDeviceProvider, gst_pipewire_device_provider,
    GST_TYPE_DEVICE_PROVIDER);

enum
{
  PROP_0,
  PROP_CLIENT_NAME,
  PROP_LAST
};

static GstDevice *
new_node (const struct pw_node_info *info)
{
  GstCaps *caps = NULL;
  GstStructure *props;
  const gchar *klass = NULL;
  SpaDictItem *item;
  GstPipeWireDeviceType type;
  int i;

  caps = gst_caps_new_empty ();
  if (info->max_inputs > 0 && info->max_outputs == 0) {
    type = GST_PIPEWIRE_DEVICE_TYPE_SINK;

    for (i = 0; i < info->n_input_formats; i++) {
      GstCaps *c1 = gst_caps_from_format (info->input_formats[i]);
      if (c1)
        gst_caps_append (caps, c1);
    }
  }
  else if (info->max_outputs > 0 && info->max_inputs == 0) {
    type = GST_PIPEWIRE_DEVICE_TYPE_SOURCE;
    for (i = 0; i < info->n_output_formats; i++) {
      GstCaps *c1 = gst_caps_from_format (info->output_formats[i]);
      if (c1)
        gst_caps_append (caps, c1);
    }
  } else {
    type = GST_PIPEWIRE_DEVICE_TYPE_UNKNOWN;
  }

  props = gst_structure_new_empty ("pipewire-proplist");
  if (info->props) {
    spa_dict_for_each (item, info->props)
      gst_structure_set (props, item->key, G_TYPE_STRING, item->value, NULL);

    klass = spa_dict_lookup (info->props, "media.class");
  }
  if (klass == NULL)
    klass = "unknown/unknown";

  return gst_pipewire_device_new (info->id,
                               info->name,
                               caps,
                               klass,
                               type,
                               props);
}

static void
get_node_info_cb (struct pw_context        *context,
                  SpaResult            res,
                  const struct pw_node_info *info,
                  gpointer             user_data)
{
  GstPipeWireDeviceProvider *self = user_data;

  if (info) {
    GstDevice *dev;
    dev = new_node (info);
    if (dev)
      gst_device_provider_device_add (GST_DEVICE_PROVIDER (self), dev);
  }
}

static GstPipeWireDevice *
find_device (GstDeviceProvider *provider, uint32_t id)
{
  GList *item;
  GstPipeWireDevice *dev = NULL;

  GST_OBJECT_LOCK (provider);
  for (item = provider->devices; item; item = item->next) {
    dev = item->data;
    if (dev->id == id) {
      gst_object_ref (dev);
      break;
    }
    dev = NULL;
  }
  GST_OBJECT_UNLOCK (provider);

  return dev;
}

static void
on_context_subscription (struct pw_listener         *listener,
                         struct pw_context          *context,
                         enum pw_subscription_event  event,
                         uint32_t                    type,
                         uint32_t                    id)
{
  GstPipeWireDeviceProvider *self = SPA_CONTAINER_OF (listener, GstPipeWireDeviceProvider, ctx_subscription);
  GstDeviceProvider *provider = GST_DEVICE_PROVIDER (self);
  GstPipeWireDevice *dev;

  if (type != context->type.node)
    return;

  dev = find_device (provider, id);

  if (event == PW_SUBSCRIPTION_EVENT_NEW) {
    if (dev == NULL)
      pw_context_get_node_info_by_id (context,
                                      id,
                                      get_node_info_cb,
                                      self);
  } else if (event == PW_SUBSCRIPTION_EVENT_REMOVE) {
    if (dev != NULL) {
      gst_device_provider_device_remove (GST_DEVICE_PROVIDER (self),
                                         GST_DEVICE (dev));
    }
  }
  if (dev)
    gst_object_unref (dev);
}

typedef struct {
  gboolean end;
  GList **devices;
} InfoData;

static void
list_node_info_cb (struct pw_context        *c,
                   SpaResult            res,
                   const struct pw_node_info *info,
                   void                *user_data)
{
  InfoData *data = user_data;
  if (info) {
    *data->devices = g_list_prepend (*data->devices, gst_object_ref_sink (new_node (info)));
  } else {
    data->end = TRUE;
  }
}

static void
get_core_info_cb (struct pw_context         *c,
                  SpaResult                  res,
                  const struct pw_core_info *info,
                  void                      *user_data)
{
  GstDeviceProvider *provider = user_data;
  const gchar *value;

  if (info == NULL || info->props == NULL)
    return;

  value = spa_dict_lookup (info->props, "monitors");
  if (value) {
    gchar **monitors = g_strsplit (value, ",", -1);
    gint i;

    GST_DEBUG_OBJECT (provider, "have hidden providers: %s", value);

    for (i = 0; monitors[i]; i++) {
      if (strcmp (monitors[i], "v4l2") == 0)
        gst_device_provider_hide_provider (provider, "v4l2deviceprovider");
      else if (strcmp (monitors[i], "alsa") == 0)
        gst_device_provider_hide_provider (provider, "pulsedeviceprovider");
    }
    g_strfreev (monitors);
  }
}

static GList *
gst_pipewire_device_provider_probe (GstDeviceProvider * provider)
{
  GstPipeWireDeviceProvider *self = GST_PIPEWIRE_DEVICE_PROVIDER (provider);
  struct pw_loop *l = NULL;
  struct pw_context *c = NULL;
  InfoData data;

  GST_DEBUG_OBJECT (self, "starting probe");

  if (!(l = pw_loop_new ()))
    return NULL;

  if (!(c = pw_context_new (l, self->client_name, NULL)))
    goto failed;

  pw_context_connect (c, 0);

  for (;;) {
    enum pw_context_state state;

    state = c->state;

    if (state <= 0) {
      GST_ERROR_OBJECT (self, "Failed to connect: %s", c->error);
      goto failed;
    }

    if (state == PW_CONTEXT_STATE_CONNECTED)
      break;

    /* Wait until something happens */
    pw_loop_iterate (l, -1);
  }
  GST_DEBUG_OBJECT (self, "connected");

  pw_context_get_core_info (c,
                            get_core_info_cb,
                            self);


  data.end = FALSE;
  data.devices = NULL;
  pw_context_list_node_info (c,
                             list_node_info_cb,
                             &data);
  for (;;) {
    if (c->state <= 0)
      break;
    if (data.end)
      break;
    pw_loop_iterate (l, -1);
  }

  pw_context_disconnect (c);
  pw_context_destroy (c);
  pw_loop_destroy (l);

  return *data.devices;

failed:
  pw_loop_destroy (l);
  return NULL;
}

static void
on_context_state_changed (struct pw_listener *listener,
                          struct pw_context  *context)
{
  GstPipeWireDeviceProvider *self = SPA_CONTAINER_OF (listener, GstPipeWireDeviceProvider, ctx_state_changed);
  enum pw_context_state state;

  state= context->state;

  GST_DEBUG ("got context state %d", state);

  switch (state) {
    case PW_CONTEXT_STATE_CONNECTING:
      break;
    case PW_CONTEXT_STATE_UNCONNECTED:
    case PW_CONTEXT_STATE_CONNECTED:
      break;
    case PW_CONTEXT_STATE_ERROR:
      GST_ERROR_OBJECT (self, "context error: %s", context->error);
      break;
  }
  pw_thread_main_loop_signal (self->main_loop, FALSE);
}

static gboolean
gst_pipewire_device_provider_start (GstDeviceProvider * provider)
{
  GstPipeWireDeviceProvider *self = GST_PIPEWIRE_DEVICE_PROVIDER (provider);

  GST_DEBUG_OBJECT (self, "starting provider");

  self->loop = pw_loop_new ();

  if (!(self->main_loop = pw_thread_main_loop_new (self->loop, "pipewire-device-monitor"))) {
    GST_ERROR_OBJECT (self, "Could not create PipeWire mainloop");
    goto failed_main_loop;
  }

  if (pw_thread_main_loop_start (self->main_loop) != SPA_RESULT_OK) {
    GST_ERROR_OBJECT (self, "Could not start PipeWire mainloop");
    goto failed_start;
  }

  pw_thread_main_loop_lock (self->main_loop);

  if (!(self->context = pw_context_new (self->loop, self->client_name, NULL))) {
    GST_ERROR_OBJECT (self, "Failed to create context");
    goto failed_context;
  }

  pw_signal_add (&self->context->state_changed,
                    &self->ctx_state_changed,
                    on_context_state_changed);
  pw_signal_add (&self->context->subscription,
                    &self->ctx_subscription,
                    on_context_subscription);

  pw_context_connect (self->context, 0);
  for (;;) {
    enum pw_context_state state;

    state = self->context->state;

    if (state <= 0) {
      GST_WARNING_OBJECT (self, "Failed to connect: %s", self->context->error);
      goto not_running;
    }

    if (state == PW_CONTEXT_STATE_CONNECTED)
      break;

    /* Wait until something happens */
    pw_thread_main_loop_wait (self->main_loop);
  }
  GST_DEBUG_OBJECT (self, "connected");
  pw_context_get_core_info (self->context,
                            get_core_info_cb,
                            self);
  pw_thread_main_loop_unlock (self->main_loop);

  return TRUE;

not_running:
  pw_context_destroy (self->context);
  self->context = NULL;
failed_context:
  pw_thread_main_loop_unlock (self->main_loop);
failed_start:
  pw_thread_main_loop_destroy (self->main_loop);
  self->main_loop = NULL;
failed_main_loop:
  pw_loop_destroy (self->loop);
  self->loop = NULL;
  return TRUE;
}

static void
gst_pipewire_device_provider_stop (GstDeviceProvider * provider)
{
  GstPipeWireDeviceProvider *self = GST_PIPEWIRE_DEVICE_PROVIDER (provider);

  if (self->context) {
    pw_context_disconnect (self->context);
    pw_context_destroy (self->context);
    self->context = NULL;
  }
  if (self->main_loop) {
    pw_thread_main_loop_destroy (self->main_loop);
    self->main_loop = NULL;
  }
  if (self->loop) {
    pw_loop_destroy (self->loop);
    self->loop = NULL;
  }
}

static void
gst_pipewire_device_provider_set_property (GObject * object,
    guint prop_id, const GValue * value, GParamSpec * pspec)
{
  GstPipeWireDeviceProvider *self = GST_PIPEWIRE_DEVICE_PROVIDER (object);

  switch (prop_id) {
    case PROP_CLIENT_NAME:
      g_free (self->client_name);
      if (!g_value_get_string (value)) {
        GST_WARNING_OBJECT (self,
            "Empty PipeWire client name not allowed. "
            "Resetting to default value");
        self->client_name = pw_client_name ();
      } else
        self->client_name = g_value_dup_string (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
gst_pipewire_device_provider_get_property (GObject * object,
    guint prop_id, GValue * value, GParamSpec * pspec)
{
  GstPipeWireDeviceProvider *self = GST_PIPEWIRE_DEVICE_PROVIDER (object);

  switch (prop_id) {
    case PROP_CLIENT_NAME:
      g_value_set_string (value, self->client_name);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
gst_pipewire_device_provider_finalize (GObject * object)
{
  GstPipeWireDeviceProvider *self = GST_PIPEWIRE_DEVICE_PROVIDER (object);

  g_free (self->client_name);

  G_OBJECT_CLASS (gst_pipewire_device_provider_parent_class)->finalize (object);
}

static void
gst_pipewire_device_provider_class_init (GstPipeWireDeviceProviderClass * klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  GstDeviceProviderClass *dm_class = GST_DEVICE_PROVIDER_CLASS (klass);
  gchar *client_name;

  gobject_class->set_property = gst_pipewire_device_provider_set_property;
  gobject_class->get_property = gst_pipewire_device_provider_get_property;
  gobject_class->finalize = gst_pipewire_device_provider_finalize;

  dm_class->probe = gst_pipewire_device_provider_probe;
  dm_class->start = gst_pipewire_device_provider_start;
  dm_class->stop = gst_pipewire_device_provider_stop;

  client_name = pw_client_name ();
  g_object_class_install_property (gobject_class,
      PROP_CLIENT_NAME,
      g_param_spec_string ("client-name", "Client Name",
          "The PipeWire client_name_to_use", client_name,
          G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS |
          GST_PARAM_MUTABLE_READY));
  g_free (client_name);

  gst_device_provider_class_set_static_metadata (dm_class,
      "PipeWire Device Provider", "Sink/Source/Audio/Video",
      "List and provide PipeWire source and sink devices",
      "Wim Taymans <wim.taymans@gmail.com>");
}

static void
gst_pipewire_device_provider_init (GstPipeWireDeviceProvider * self)
{
  self->client_name = pw_client_name ();
}