pipewire/pinos/client/introspect.h

/* Pinos
 * Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.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.
 */

#ifndef __PINOS_INTROSPECT_H__
#define __PINOS_INTROSPECT_H__

#include <gio/gio.h>
#include <glib-object.h>

G_BEGIN_DECLS

/**
 * PinosNodeState:
 * @PINOS_NODE_STATE_ERROR: the node is in error
 * @PINOS_NODE_STATE_SUSPENDED: the node is suspended, the device might
 *                             be closed
 * @PINOS_NODE_STATE_INITIALIZING: the node is initializing, the device is
 *                        being opened and the capabilities are queried
 * @PINOS_NODE_STATE_IDLE: the node is running but there is no active
 *                         port
 * @PINOS_NODE_STATE_RUNNING: the node is running
 *
 * The different node states
 */
typedef enum {
  PINOS_NODE_STATE_ERROR = -1,
  PINOS_NODE_STATE_SUSPENDED = 0,
  PINOS_NODE_STATE_INITIALIZING = 1,
  PINOS_NODE_STATE_IDLE = 2,
  PINOS_NODE_STATE_RUNNING = 3,
} PinosNodeState;

const gchar * pinos_node_state_as_string (PinosNodeState state);

/**
 * PinosDirection:
 * @PINOS_DIRECTION_INVALID: invalid direction
 * @PINOS_DIRECTION_INPUT: an input port
 * @PINOS_DIRECTION_OUTPUT: an output port
 *
 * The direction of a port
 */
typedef enum {
  PINOS_DIRECTION_INVALID = -1,
  PINOS_DIRECTION_INPUT = 0,
  PINOS_DIRECTION_OUTPUT = 1
} PinosDirection;

const gchar * pinos_direction_as_string (PinosDirection direction);

/**
 * PinosPortState:
 * @PINOS_PORT_STATE_ERROR: the port is in error
 * @PINOS_PORT_STATE_STOPPED: the port is stopped
 * @PINOS_PORT_STATE_STARTING: the port is starting
 * @PINOS_PORT_STATE_STREAMING: the port is streaming
 *
 * The different port states
 */
typedef enum {
  PINOS_PORT_STATE_ERROR = -1,
  PINOS_PORT_STATE_STOPPED = 0,
  PINOS_PORT_STATE_STARTING = 1,
  PINOS_PORT_STATE_STREAMING = 2,
} PinosPortState;

const gchar * pinos_port_state_as_string (PinosPortState state);

#include <pinos/client/context.h>
#include <pinos/client/properties.h>

gboolean         pinos_context_info_finish      (GObject      *object,
                                                 GAsyncResult *res,
                                                 GError      **error);

/**
 * PinosDaemonInfo:
 * @id: generic id of the daemon
 * @daemon-path: unique path of the daemon
 * @change_mask: bitfield of changed fields since last call
 * @user_name: name of the user that started the daemon
 * @host_name: name of the machine the daemon is running on
 * @version: version of the daemon
 * @name: name of the daemon
 * @cookie: a random cookie for identifying this instance of Pinos
 * @properties: extra properties
 *
 * The daemon information. Extra information can be added in later
 * versions.
 */
typedef struct {
  gpointer id;
  const char *daemon_path;
  guint64 change_mask;
  const char *user_name;
  const char *host_name;
  const char *version;
  const char *name;
  guint32 cookie;
  PinosProperties *properties;
} PinosDaemonInfo;

/**PinosDaemonInfoFlags:
 * @PINOS_DAEMON_INFO_FLAGS_NONE: no flags
 *
 * Extra flags that can be passed to pinos_context_get_daemon_info()
 */
typedef enum {
  PINOS_DAEMON_INFO_FLAGS_NONE            = 0,
} PinosDaemonInfoFlags;

/**
 * PinosDaemonInfoCallback:
 * @c: a #PinosContext
 * @info: a #PinosDaemonInfo
 * @user_data: user data
 *
 * Callback with information about the Pinos daemon in @info.
 */
typedef void (*PinosDaemonInfoCallback)  (PinosContext          *c,
                                          const PinosDaemonInfo *info,
                                          gpointer               user_data);

void            pinos_context_get_daemon_info (PinosContext *context,
                                               PinosDaemonInfoFlags flags,
                                               PinosDaemonInfoCallback cb,
                                               GCancellable *cancellable,
                                               GAsyncReadyCallback callback,
                                               gpointer user_data);

/**
 * PinosClientInfo:
 * @id: generic id of the client
 * @client_path: unique path of the client
 * @sender: sender of client
 * @change_mask: bitfield of changed fields since last call
 * @properties: extra properties
 *
 * The client information. Extra information can be added in later
 * versions.
 */
typedef struct {
  gpointer id;
  const char *client_path;
  const char *sender;
  guint64 change_mask;
  PinosProperties *properties;
} PinosClientInfo;

/**
 * PinosClientInfoFlags:
 * @PINOS_CLIENT_INFO_FLAGS_NONE: no flags
 *
 * Extra flags for pinos_context_list_client_info() and
 * pinos_context_get_client_info_by_id().
 */
typedef enum {
  PINOS_CLIENT_INFO_FLAGS_NONE            = 0,
} PinosClientInfoFlags;

/**
 * PinosClientInfoCallback:
 * @c: a #PinosContext
 * @info: a #PinosClientInfo
 * @user_data: user data
 *
 * Callback with information about the Pinos client in @info.
 */
typedef void (*PinosClientInfoCallback)  (PinosContext          *c,
                                          const PinosClientInfo *info,
                                          gpointer               user_data);

void            pinos_context_list_client_info      (PinosContext *context,
                                                     PinosClientInfoFlags flags,
                                                     PinosClientInfoCallback cb,
                                                     GCancellable *cancellable,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
void            pinos_context_get_client_info_by_id (PinosContext *context,
                                                     gpointer id,
                                                     PinosClientInfoFlags flags,
                                                     PinosClientInfoCallback cb,
                                                     GCancellable *cancellable,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);

/**
 * PinosNodeInfo:
 * @id: generic id of the node
 * @node_path: the unique path of the node
 * @owner: the unique name of the owner
 * @change_mask: bitfield of changed fields since last call
 * @name: name the node, suitable for display
 * @properties: the properties of the node
 * @state: the current state of the node
 *
 * The node information. Extra information can be added in later
 * versions.
 */
typedef struct {
  gpointer id;
  const char *node_path;
  const char *owner;
  guint64 change_mask;
  const char *name;
  PinosProperties *properties;
  PinosNodeState state;
} PinosNodeInfo;

/**
 * PinosNodeInfoFlags:
 * @PINOS_NODE_INFO_FLAGS_NONE: no flags
 *
 * Extra flags to pass to pinos_context_get_node_info_list.
 */
typedef enum {
  PINOS_NODE_INFO_FLAGS_NONE            = 0,
} PinosNodeInfoFlags;

/**
 * PinosNodeInfoCallback:
 * @c: a #PinosContext
 * @info: a #PinosNodeInfo
 * @user_data: user data
 *
 * Callback with information about the Pinos node in @info.
 */
typedef void (*PinosNodeInfoCallback)  (PinosContext        *c,
                                        const PinosNodeInfo *info,
                                        gpointer             user_data);

void            pinos_context_list_node_info        (PinosContext *context,
                                                     PinosNodeInfoFlags flags,
                                                     PinosNodeInfoCallback cb,
                                                     GCancellable *cancellable,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);
void            pinos_context_get_node_info_by_id   (PinosContext *context,
                                                     gpointer id,
                                                     PinosNodeInfoFlags flags,
                                                     PinosNodeInfoCallback cb,
                                                     GCancellable *cancellable,
                                                     GAsyncReadyCallback callback,
                                                     gpointer user_data);


/**
 * PinosPortInfo:
 * @id: generic id of the port
 * @port_path: the unique path of the port, suitable for connecting
 * @node_path: the node path of the port
 * @direction: the direction of the port
 * @change_mask: bitfield of changed fields since last call
 * @name: name the port, suitable for display
 * @peers: paths to peer ports
 * @properties: the properties of the port
 * @possible_formats: the possible formats this port can consume
 * @format: the current format on this port
 *
 * The port information. Extra information can be added in later
 * versions.
 */
typedef struct {
  gpointer id;
  const char *port_path;
  const char *node_path;
  PinosDirection direction;
  guint64 change_mask;
  const char *name;
  PinosProperties *properties;
  gchar **peers;
  GBytes *possible_formats;
  GBytes *format;
} PinosPortInfo;

/**
 * PinosPortInfoFlags:
 * @PINOS_PORT_INFO_FLAGS_NONE: no flags
 * @PINOS_PORT_INFO_FLAGS_FORMATS: include formats
 *
 * Extra flags to pass to pinos_context_get_port_info_list.
 */
typedef enum {
  PINOS_PORT_INFO_FLAGS_NONE            = 0,
  PINOS_PORT_INFO_FLAGS_FORMATS         = (1 << 0)
} PinosPortInfoFlags;

/**
 * PinosPortInfoCallback:
 * @c: a #PinosContext
 * @info: a #PinosPortInfo
 * @user_data: user data
 *
 * Callback with information about the Pinos port in @info.
 */
typedef void (*PinosPortInfoCallback)  (PinosContext        *c,
                                        const PinosPortInfo *info,
                                        gpointer             user_data);

void            pinos_context_list_port_info      (PinosContext *context,
                                                   PinosPortInfoFlags flags,
                                                   PinosPortInfoCallback cb,
                                                   GCancellable *cancellable,
                                                   GAsyncReadyCallback callback,
                                                   gpointer user_data);
void            pinos_context_get_port_info_by_id (PinosContext *context,
                                                   gpointer id,
                                                   PinosPortInfoFlags flags,
                                                   PinosPortInfoCallback cb,
                                                   GCancellable *cancellable,
                                                   GAsyncReadyCallback callback,
                                                   gpointer user_data);


/**
 * PinosChannelState:
 * @PINOS_CHANNEL_STATE_ERROR: the channel is in error
 * @PINOS_CHANNEL_STATE_STOPPED: the channel is stopped
 * @PINOS_CHANNEL_STATE_STARTING: the channel is starting
 * @PINOS_CHANNEL_STATE_STREAMING: the channel is streaming
 *
 * The different channel states
 */
typedef enum {
  PINOS_CHANNEL_STATE_ERROR = -1,
  PINOS_CHANNEL_STATE_STOPPED = 0,
  PINOS_CHANNEL_STATE_STARTING = 1,
  PINOS_CHANNEL_STATE_STREAMING = 2,
} PinosChannelState;

const gchar * pinos_channel_state_as_string (PinosChannelState state);

/**
 * PinosChannelInfo:
 * @id: generic id of the channel_
 * @channel_path: the unique path of the channel
 * @direction: the channel direction
 * @client_path: the owner client
 * @change_mask: bitfield of changed fields since last call
 * @port_path: the owner port
 * @properties: the properties of the channel
 * @state: the state
 * @possible_formats: the possible formats
 * @format: when streaming, the current format
 *
 * The channel information. Extra information can be added in later
 * versions.
 */
typedef struct {
  gpointer id;
  const char *channel_path;
  PinosDirection direction;
  const char *client_path;
  guint64 change_mask;
  const char *port_path;
  PinosProperties *properties;
  PinosChannelState state;
  GBytes *possible_formats;
  GBytes *format;
} PinosChannelInfo;

/**
 * PinosChannelInfoFlags:
 * @PINOS_CHANNEL_INFO_FLAGS_NONE: no flags
 * @PINOS_CHANNEL_INFO_FLAGS_NO_INPUT: don't list input channels
 * @PINOS_CHANNEL_INFO_FLAGS_NO_OUTPUT: don't list output channels
 *
 * Extra flags to pass to pinos_context_list_channel_info() and
 * pinos_context_get_channel_info_by_id().
 */
typedef enum {
  PINOS_CHANNEL_INFO_FLAGS_NONE            = 0,
  PINOS_CHANNEL_INFO_FLAGS_NO_INPUT       = (1 << 0),
  PINOS_CHANNEL_INFO_FLAGS_NO_OUTPUT      = (1 << 1),
} PinosChannelInfoFlags;


/**
 * PinosChannelInfoCallback:
 * @c: a #PinosContext
 * @info: a #PinosChannelInfo
 * @user_data: user data
 *
 * Callback with information about the Pinos channel in @info.
 */
typedef void (*PinosChannelInfoCallback)       (PinosContext           *c,
                                                const PinosChannelInfo *info,
                                                gpointer                user_data);

void            pinos_context_list_channel_info      (PinosContext *context,
                                                      PinosChannelInfoFlags flags,
                                                      PinosChannelInfoCallback cb,
                                                      GCancellable *cancellable,
                                                      GAsyncReadyCallback callback,
                                                      gpointer user_data);
void            pinos_context_get_channel_info_by_id (PinosContext *context,
                                                      gpointer id,
                                                      PinosChannelInfoFlags flags,
                                                      PinosChannelInfoCallback cb,
                                                      GCancellable *cancellable,
                                                      GAsyncReadyCallback callback,
                                                      gpointer user_data);

/**
 * PinosConnectionInfo:
 * @id: generic id of the connection
 * @connection_path: the unique path of the connection
 * @change_mask: bitfield of changed fields since last call
 * @source_port_path: the source port
 * @destination_port_path: the destination port
 *
 * The connection information. Extra information can be added in later
 * versions.
 */
typedef struct {
  gpointer id;
  const char *connection_path;
  guint64 change_mask;
  const char *source_port_path;
  const char *destination_port_path;
} PinosConnectionInfo;

/**
 * PinosConnectionInfoFlags:
 * @PINOS_CONNECTION_INFO_FLAGS_NONE: no flags
 *
 * Extra flags to pass to pinos_context_list_connection_info() and
 * pinos_context_get_connection_info_by_id().
 */
typedef enum {
  PINOS_CONNECTION_INFO_FLAGS_NONE            = 0,
} PinosConnectionInfoFlags;

/**
 * PinosConnectionInfoCallback:
 * @c: a #PinosContext
 * @info: a #PinosConnectionInfo
 * @user_data: user data
 *
 * Callback with information about the Pinos connection in @info.
 */
typedef void (*PinosConnectionInfoCallback)       (PinosContext              *c,
                                                   const PinosConnectionInfo *info,
                                                   gpointer                   user_data);

void            pinos_context_list_connection_info      (PinosContext *context,
                                                         PinosConnectionInfoFlags flags,
                                                         PinosConnectionInfoCallback cb,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
void            pinos_context_get_connection_info_by_id (PinosContext *context,
                                                         gpointer id,
                                                         PinosConnectionInfoFlags flags,
                                                         PinosConnectionInfoCallback cb,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
G_END_DECLS

#endif /* __PINOS_INTROSPECT_H__ */