wireplumber/tools/wireplumber-cli.c

/* WirePlumber
 *
 * Copyright © 2019-2020 Collabora Ltd.
 *    @author George Kiagiadakis <george.kiagiadakis@collabora.com>
 *
 * SPDX-License-Identifier: MIT
 */

#include <wp/wp.h>
#include <pipewire/pipewire.h>

static GOptionEntry entries[] =
{
  { NULL }
};

struct WpCliData
{
  WpCore *core;
  GMainLoop *loop;

  union {
    struct {
      guint32 id;
    } set_default;
    struct {
      guint32 id;
      gfloat volume;
    } set_volume;
  } params;
};

static void
async_quit (WpCore *core, GAsyncResult *res, struct WpCliData * d)
{
  g_print ("Success\n");
  g_main_loop_quit (d->loop);
}

static void
print_dev_endpoint (WpEndpoint *ep, WpSession *session, const gchar *type_name)
{
  guint32 id = wp_proxy_get_bound_id (WP_PROXY (ep));
  gboolean is_default = (session && type_name != NULL &&
          wp_session_get_default_endpoint (session, type_name) == id);
  g_autoptr (WpSpaPod) ctrl = NULL;
  gboolean has_audio_controls = FALSE;
  gfloat volume = 0.0;
  gboolean mute = FALSE;

  if ((ctrl = wp_proxy_get_control (WP_PROXY (ep), "volume"))) {
    wp_spa_pod_get_float (ctrl, &volume);
    has_audio_controls = TRUE;
  }
  if ((ctrl = wp_proxy_get_control (WP_PROXY (ep), "mute"))) {
    wp_spa_pod_get_boolean (ctrl, &mute);
    has_audio_controls = TRUE;
  }

  g_print (" %c %4u. %60s", is_default ? '*' : ' ', id,
      wp_endpoint_get_name (ep));

  if (has_audio_controls)
    g_print ("\tvol: %.2f %s\n", volume, mute ? "MUTE" : "");
  else
    g_print ("\n");
}

static void
print_client_endpoint (WpEndpoint *ep)
{
  guint32 id = wp_proxy_get_bound_id (WP_PROXY (ep));
  g_print ("   %4u. %s (%s)\n", id, wp_endpoint_get_name (ep),
      wp_endpoint_get_media_class (ep));
}

static void
list_endpoints (WpObjectManager * om, struct WpCliData * d)
{
  g_autoptr (WpIterator) it = NULL;
  g_auto (GValue) val = G_VALUE_INIT;

  it = wp_object_manager_iterate (om);
  for (; wp_iterator_next (it, &val); g_value_unset (&val)) {
    WpSession *session = g_value_get_object (&val);
    g_autoptr (WpIterator) ep_it = NULL;
    g_auto (GValue) ep_val = G_VALUE_INIT;
    g_autoptr (WpProperties) props = wp_proxy_get_properties (WP_PROXY (session));
    const gchar *name = wp_properties_get (props, "session.name");
    guint32 id = wp_proxy_get_bound_id (WP_PROXY (session));

    g_print ("Session %u (%s) capture devices:\n", id, name);
    ep_it = wp_session_iterate_endpoints_filtered (session,
        WP_CONSTRAINT_TYPE_PW_PROPERTY, "media.class", "#s", "*/Source",
        NULL);
    for (; wp_iterator_next (ep_it, &ep_val); g_value_unset (&ep_val)) {
      WpEndpoint *ep = g_value_get_object (&ep_val);
      print_dev_endpoint (ep, session, "Wp:defaultSource");
    }
    g_clear_pointer (&ep_it, wp_iterator_unref);

    g_print ("\nSession %u (%s) playback devices:\n", id, name);
    ep_it = wp_session_iterate_endpoints_filtered (session,
        WP_CONSTRAINT_TYPE_PW_PROPERTY, "media.class", "#s", "*/Sink",
        NULL);
    for (; wp_iterator_next (ep_it, &ep_val); g_value_unset (&ep_val)) {
      WpEndpoint *ep = g_value_get_object (&ep_val);
      print_dev_endpoint (ep, session, "Wp:defaultSink");
    }
    g_clear_pointer (&ep_it, wp_iterator_unref);

    g_print ("\nSession %u (%s) client streams:\n", id, name);
    ep_it = wp_session_iterate_endpoints_filtered (session,
        WP_CONSTRAINT_TYPE_PW_PROPERTY, "media.class", "#s", "Stream/*",
        NULL);
    for (; wp_iterator_next (ep_it, &ep_val); g_value_unset (&ep_val)) {
      WpEndpoint *ep = g_value_get_object (&ep_val);
      print_client_endpoint (ep);
    }

    g_print ("\n");
  }

  g_main_loop_quit (d->loop);
}

static void
set_default (WpObjectManager * om, struct WpCliData * d)
{
  g_autoptr (WpSession) session = NULL;
  g_autoptr (WpEndpoint) ep = NULL;
  guint32 id = d->params.set_default.id;

  ep = wp_object_manager_lookup (om, WP_TYPE_ENDPOINT,
      WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", id,
      NULL);
  if (ep) {
    const gchar * type_name;
    g_autoptr (WpProperties) props = wp_proxy_get_properties (WP_PROXY (ep));
    const gchar *sess_id_str = wp_properties_get (props, "session.id");
    guint32 sess_id = sess_id_str ? atoi (sess_id_str) : 0;

    session = wp_object_manager_lookup (om, WP_TYPE_SESSION,
        WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", sess_id, NULL);
    if (!session) {
      g_print ("%u: invalid sesssion %u\n", id, sess_id);
      g_main_loop_quit (d->loop);
      return;
    }

    if (g_strcmp0 (wp_endpoint_get_media_class (ep), "Audio/Sink") == 0)
      type_name = "Wp:defaultSink";
    else if (g_strcmp0 (wp_endpoint_get_media_class (ep), "Audio/Source") == 0)
      type_name = "Wp:defaultSource";
    else {
      g_print ("%u: not a device endpoint\n", id);
      g_main_loop_quit (d->loop);
      return;
    }

    wp_session_set_default_endpoint (session, type_name, id);
    wp_core_sync (d->core, NULL, (GAsyncReadyCallback) async_quit, d);
    return;
  }

  g_print ("endpoint not found\n");
  g_main_loop_quit (d->loop);
}

static void
set_volume (WpObjectManager * om, struct WpCliData * d)
{
  g_autoptr (WpEndpoint) ep = NULL;
  guint32 id = d->params.set_volume.id;

  ep = wp_object_manager_lookup (om, WP_TYPE_ENDPOINT,
      WP_CONSTRAINT_TYPE_G_PROPERTY, "bound-id", "=u", id,
      NULL);
  if (ep) {
    g_autoptr (WpSpaPod) vol = wp_spa_pod_new_float (d->params.set_volume.volume);
    wp_proxy_set_control (WP_PROXY (ep), "volume", vol);
    wp_core_sync (d->core, NULL, (GAsyncReadyCallback) async_quit, d);
    return;
  }

  g_print ("endpoint not found\n");
  g_main_loop_quit (d->loop);
}

static void
device_node_props (WpObjectManager * om, struct WpCliData * d)
{
  g_autoptr (WpIterator) it = NULL;
  g_auto (GValue) val = G_VALUE_INIT;
  const struct spa_dict * dict;
  const struct spa_dict_item *item;

  g_print ("Capture device nodes:\n");

  it = wp_object_manager_iterate_filtered (om, WP_TYPE_NODE,
      WP_CONSTRAINT_TYPE_PW_PROPERTY, "media.class", "=s", "Audio/Source",
      NULL);
  for (; wp_iterator_next (it, &val); g_value_unset (&val)) {
    WpProxy *node = g_value_get_object (&val);
    g_autoptr (WpProperties) props = wp_proxy_get_properties (node);

    g_print (" node id: %u\n", wp_proxy_get_bound_id (node));

    dict = wp_properties_peek_dict (props);
    spa_dict_for_each (item, dict) {
      g_print ("    %s = \"%s\"\n", item->key, item->value);
    }
    g_print ("\n");
  }
  g_clear_pointer (&it, wp_iterator_unref);

  g_print ("Playback device nodes:\n");

  it = wp_object_manager_iterate_filtered (om, WP_TYPE_NODE,
      WP_CONSTRAINT_TYPE_PW_PROPERTY, "media.class", "=s", "Audio/Sink",
      NULL);
  for (; wp_iterator_next (it, &val); g_value_unset (&val)) {
    WpProxy *node = g_value_get_object (&val);
    g_autoptr (WpProperties) props = wp_proxy_get_properties (node);

    g_print (" node id: %u\n", wp_proxy_get_bound_id (node));

    dict = wp_properties_peek_dict (props);
    spa_dict_for_each (item, dict) {
      g_print ("    %s = \"%s\"\n", item->key, item->value);
    }
    g_print ("\n");
  }

  g_main_loop_quit (d->loop);
}

static void
on_disconnected (WpCore *core, struct WpCliData * d)
{
  g_main_loop_quit (d->loop);
}

static const gchar * const usage_string =
    "Operations:\n"
    "  ls-endpoints\t\tLists all endpoints\n"
    "  set-default [id]\tSets [id] to be the default device endpoint of its kind (capture/playback)\n"
    "  set-volume [id] [vol]\tSets the volume of [id] to [vol] (floating point, 1.0 is 100%%)\n"
    "  device-node-props\tShows device node properties\n"
    "";

gint
main (gint argc, gchar **argv)
{
  struct WpCliData data = {0};
  g_autoptr (GOptionContext) context = NULL;
  g_autoptr (GError) error = NULL;
  g_autoptr (WpCore) core = NULL;
  g_autoptr (WpObjectManager) om = NULL;
  g_autoptr (GMainLoop) loop = NULL;
  GCallback func = NULL;

  wp_init (WP_INIT_ALL);

  context = g_option_context_new ("- PipeWire Session/Policy Manager Helper CLI");
  g_option_context_add_main_entries (context, entries, NULL);
  g_option_context_set_description (context, usage_string);
  if (!g_option_context_parse (context, &argc, &argv, &error)) {
    return 1;
  }

  data.loop = loop = g_main_loop_new (NULL, FALSE);
  data.core = core = wp_core_new (NULL, NULL);
  g_signal_connect (core, "disconnected", (GCallback) on_disconnected, &data);

  om = wp_object_manager_new ();

  /* ls-endpoints */
  if (argc == 2 && !g_strcmp0 (argv[1], "ls-endpoints")) {
    wp_object_manager_add_interest (om, WP_TYPE_SESSION, NULL);
    wp_object_manager_request_proxy_features (om, WP_TYPE_SESSION,
        WP_SESSION_FEATURES_STANDARD);
    func = (GCallback) list_endpoints;
  }
  /* set-default <id> */
  else if (argc == 3 && !g_strcmp0 (argv[1], "set-default")) {
    long id = strtol (argv[2], NULL, 10);
    if (id <= 0) {
      g_print ("%s: not a valid id\n", argv[2]);
      return 1;
    }

    data.params.set_default.id = id;
    wp_object_manager_add_interest (om, WP_TYPE_SESSION, NULL);
    wp_object_manager_add_interest (om, WP_TYPE_ENDPOINT, NULL);
    wp_object_manager_request_proxy_features (om, WP_TYPE_PROXY,
        WP_PROXY_FEATURES_STANDARD | WP_PROXY_FEATURE_CONTROLS);
    func = (GCallback) set_default;
  }
  /* set-volume <id> <vol> */
  else if (argc == 4 && !g_strcmp0 (argv[1], "set-volume")) {
    long id = strtol (argv[2], NULL, 10);
    float volume = strtof (argv[3], NULL);
    if (id <= 0) {
      g_print ("%s: not a valid id\n", argv[2]);
      return 1;
    }

    data.params.set_volume.id = id;
    data.params.set_volume.volume = volume;
    wp_object_manager_add_interest (om, WP_TYPE_ENDPOINT, NULL);
    wp_object_manager_request_proxy_features (om, WP_TYPE_ENDPOINT,
        WP_PROXY_FEATURES_STANDARD | WP_PROXY_FEATURE_CONTROLS);
    func = (GCallback) set_volume;
  }
  /* device-node-props */
  else if (argc == 2 && !g_strcmp0 (argv[1], "device-node-props")) {
    wp_object_manager_add_interest (om, WP_TYPE_NODE, NULL);
    wp_object_manager_request_proxy_features (om, WP_TYPE_NODE,
        WP_PROXY_FEATURES_STANDARD);
    func = (GCallback) device_node_props;
  }
  else {
    g_autofree gchar *help = g_option_context_get_help (context, TRUE, NULL);
    g_print ("%s", help);
    return 1;
  }

  if (!wp_core_connect (core))
    return 1;

  g_signal_connect (om, "installed", (GCallback) func, &data);
  wp_core_install_object_manager (core, om);

  g_main_loop_run (loop);
  return 0;
}