wireplumber/lib/wp/base-endpoint.h

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

#ifndef __WIREPLUMBER_BASE_ENDPOINT_H__
#define __WIREPLUMBER_BASE_ENDPOINT_H__

#include <gio/gio.h>

#include "core.h"

G_BEGIN_DECLS

static const guint32 WP_STREAM_ID_NONE = 0xffffffff;
static const guint32 WP_CONTROL_ID_NONE = 0xffffffff;

#define WP_TYPE_BASE_ENDPOINT (wp_base_endpoint_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpBaseEndpoint, wp_base_endpoint,
                          WP, BASE_ENDPOINT, GObject)

#define WP_TYPE_BASE_ENDPOINT_LINK (wp_base_endpoint_link_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpBaseEndpointLink, wp_base_endpoint_link,
                          WP, BASE_ENDPOINT_LINK, GObject)

struct _WpBaseEndpointClass
{
  GObjectClass parent_class;

  WpProperties * (*get_properties) (WpBaseEndpoint * self);
  const char * (*get_role) (WpBaseEndpoint * self);
  guint32 (*get_global_id) (WpBaseEndpoint * self);

  GVariant * (*get_control_value) (WpBaseEndpoint * self, guint32 control_id);
  gboolean (*set_control_value) (WpBaseEndpoint * self, guint32 control_id,
      GVariant * value);

  gboolean (*prepare_link) (WpBaseEndpoint * self, guint32 stream_id,
      WpBaseEndpointLink * link, GVariant ** properties, GError ** error);
  void (*release_link) (WpBaseEndpoint * self, WpBaseEndpointLink * link);

  const gchar * (*get_endpoint_link_factory) (WpBaseEndpoint * self);

  void (*begin_fade) (WpBaseEndpoint * self, guint32 stream_id, guint duration,
    gfloat step, guint direction, guint type, GCancellable * cancellable,
    GAsyncReadyCallback callback, gpointer data);
};

WP_API
WpBaseEndpoint * wp_base_endpoint_new_finish (GObject *initable, GAsyncResult *res,
  GError **error);

WP_API
void wp_base_endpoint_register (WpBaseEndpoint * self);

WP_API
void wp_base_endpoint_unregister (WpBaseEndpoint * self);

WP_API
WpCore *wp_base_endpoint_get_core (WpBaseEndpoint * self);

WP_API
const gchar * wp_base_endpoint_get_name (WpBaseEndpoint * self);

WP_API
const gchar * wp_base_endpoint_get_media_class (WpBaseEndpoint * self);

WP_API
guint wp_base_endpoint_get_direction (WpBaseEndpoint * self);

WP_API
guint64 wp_base_endpoint_get_creation_time (WpBaseEndpoint * self);

WP_API
guint32 wp_base_endpoint_get_priority (WpBaseEndpoint * self);

WP_API
WpProperties * wp_base_endpoint_get_properties (WpBaseEndpoint * self);

WP_API
const char * wp_base_endpoint_get_role (WpBaseEndpoint * self);

WP_API
guint32 wp_base_endpoint_get_global_id (WpBaseEndpoint * self);

WP_API
void wp_base_endpoint_begin_fade (WpBaseEndpoint * self, guint32 stream_id,
    guint duration, gfloat step, guint direction, guint type,
    GCancellable * cancellable, GAsyncReadyCallback callback, gpointer data);

WP_API
void wp_base_endpoint_register_stream (WpBaseEndpoint * self, GVariant * stream);

WP_API
GVariant * wp_base_endpoint_get_stream (WpBaseEndpoint * self, guint32 stream_id);

WP_API
GVariant * wp_base_endpoint_list_streams (WpBaseEndpoint * self);

WP_API
guint32 wp_base_endpoint_find_stream (WpBaseEndpoint * self, const gchar * name);

WP_API
void wp_base_endpoint_register_control (WpBaseEndpoint * self, GVariant * control);

WP_API
GVariant * wp_base_endpoint_get_control (WpBaseEndpoint * self, guint32 control_id);

WP_API
GVariant * wp_base_endpoint_list_controls (WpBaseEndpoint * self);

WP_API
guint32 wp_base_endpoint_find_control (WpBaseEndpoint * self, guint32 stream_id,
    const gchar * name);

WP_API
GVariant * wp_base_endpoint_get_control_value (WpBaseEndpoint * self,
    guint32 control_id);

WP_API
gboolean wp_base_endpoint_set_control_value (WpBaseEndpoint * self,
    guint32 control_id, GVariant * value);

WP_API
void wp_base_endpoint_notify_control_value (WpBaseEndpoint * self,
    guint32 control_id);

WP_API
gboolean wp_base_endpoint_is_linked (WpBaseEndpoint * self);

WP_API
GPtrArray * wp_base_endpoint_get_links (WpBaseEndpoint * self);

WP_API
void wp_base_endpoint_unlink (WpBaseEndpoint * self);


struct _WpBaseEndpointLinkClass
{
  GObjectClass parent_class;

  gboolean (*create) (WpBaseEndpointLink * self, GVariant * src_data,
      GVariant * sink_data, GError ** error);
  void (*destroy) (WpBaseEndpointLink * self);
};

WP_API
WpBaseEndpoint * wp_base_endpoint_link_get_source_endpoint (
    WpBaseEndpointLink * self);

WP_API
guint32 wp_base_endpoint_link_get_source_stream (WpBaseEndpointLink * self);

WP_API
WpBaseEndpoint * wp_base_endpoint_link_get_sink_endpoint (
  WpBaseEndpointLink * self);

WP_API
guint32 wp_base_endpoint_link_get_sink_stream (WpBaseEndpointLink * self);

WP_API
gboolean wp_base_endpoint_link_is_kept (WpBaseEndpointLink * self);

WP_API
void wp_base_endpoint_link_new (WpCore * core, WpBaseEndpoint * src,
    guint32 src_stream, WpBaseEndpoint * sink, guint32 sink_stream,
    gboolean keep, GAsyncReadyCallback ready, gpointer data);

WP_API
WpBaseEndpointLink * wp_base_endpoint_link_new_finish (GObject *initable,
    GAsyncResult *res, GError **error);

WP_API
void wp_base_endpoint_link_destroy (WpBaseEndpointLink * self);

G_END_DECLS

#endif