wireplumber/lib/wp/transition.h

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

#ifndef __WIREPLUMBER_TRANSITION_H__
#define __WIREPLUMBER_TRANSITION_H__

#include <gio/gio.h>
#include "defs.h"

G_BEGIN_DECLS

/*!
 * @memberof WpTransition
 *
 * @brief The [WpTransition](@ref transition_section)
 * <a href="https://developer.gnome.org/gobject/stable/gobject-Type-Information.html#GType">
 * GType</a>
 *
 * @code
 * #define WP_TYPE_TRANSITION (wp_transition_get_type ())
 * @endcode
 *
 */
#define WP_TYPE_TRANSITION (wp_transition_get_type ())
WP_API
G_DECLARE_DERIVABLE_TYPE (WpTransition, wp_transition, WP, TRANSITION, GObject)

/*!
 * @memberof WpTransition
 *
 * @section transition_step_section WpTransitionStep
 *
 * @brief
 * @em WP_TRANSITION_STEP_NONE: the initial and final step of the transition
 * @em WP_TRANSITION_STEP_ERROR: returned by
 * [WpTransitionClass](@ref transition_class_section).get_next_step() in
 *   case of an error
 * @em WP_TRANSITION_STEP_CUSTOM_START: starting value for steps defined in
 *   subclasses
 */
typedef enum {
  WP_TRANSITION_STEP_NONE = 0,
  WP_TRANSITION_STEP_ERROR,
  WP_TRANSITION_STEP_CUSTOM_START = 0x10
} WpTransitionStep;

/*!
 * @brief
 * @em get_next_step: See wp_transition_advance()
 * @em execute_step: See wp_transition_advance()
 */
struct _WpTransitionClass
{
  GObjectClass parent_class;

  guint (*get_next_step) (WpTransition * transition, guint step);
  void (*execute_step) (WpTransition * transition, guint step);
};

WP_API
WpTransition * wp_transition_new (GType type,
    gpointer source_object, GCancellable * cancellable,
    GAsyncReadyCallback callback, gpointer callback_data);

WP_API
WpTransition * wp_transition_new_closure (GType type,
    gpointer source_object, GCancellable * cancellable, GClosure * closure);

/* source object */

WP_API
gpointer wp_transition_get_source_object (WpTransition * self);

/* tag */

WP_API
gboolean wp_transition_is_tagged (WpTransition * self, gpointer tag);

WP_API
gpointer wp_transition_get_source_tag (WpTransition * self);

WP_API
void wp_transition_set_source_tag (WpTransition * self, gpointer tag);

/* task data */

WP_API
gpointer wp_transition_get_data (WpTransition * self);

WP_API
void wp_transition_set_data (WpTransition * self, gpointer data,
    GDestroyNotify data_destroy);

/* state machine */

WP_API
gboolean wp_transition_get_completed (WpTransition * self);

WP_API
gboolean wp_transition_had_error (WpTransition * self);

WP_API
void wp_transition_advance (WpTransition * self);

WP_API
void wp_transition_return_error (WpTransition * self, GError * error);

/* result */

WP_API
gboolean wp_transition_finish (GAsyncResult * res, GError ** error);

G_END_DECLS

#endif