grd/grd-session.h

/*
 * Copyright (C) 2015 Red Hat Inc.
 * Copyright (C) 2020-2021 Pascal Nowack
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 *
 * Written by:
 *     Jonas Ådahl <jadahl@gmail.com>
 */

#pragma once

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

#include "grd-mime-type.h"
#include "grd-types.h"

#define GRD_TYPE_SESSION (grd_session_get_type ())
G_DECLARE_DERIVABLE_TYPE (GrdSession, grd_session, GRD, SESSION, GObject)

typedef enum _GrdScreenCastCursorMode
{
  GRD_SCREEN_CAST_CURSOR_MODE_HIDDEN = 0,
  GRD_SCREEN_CAST_CURSOR_MODE_EMBEDDED = 1,
  GRD_SCREEN_CAST_CURSOR_MODE_METADATA = 2,
} GrdScreenCastCursorMode;

typedef enum _GrdKeyState
{
  GRD_KEY_STATE_RELEASED,
  GRD_KEY_STATE_PRESSED
} GrdKeyState;

typedef enum _GrdButtonState
{
  GRD_BUTTON_STATE_RELEASED,
  GRD_BUTTON_STATE_PRESSED
} GrdButtonState;

typedef enum _GrdPointerAxisFlags
{
  GRD_POINTER_AXIS_FLAGS_FINISH = 1 << 0,
  GRD_POINTER_AXIS_FLAGS_SOURCE_WHEEL = 1 << 1,
  GRD_POINTER_AXIS_FLAGS_SOURCE_FINGER = 1 << 2,
  GRD_POINTER_AXIS_FLAGS_SOURCE_CONTINUOUS = 1 << 3,
} GrdPointerAxisFlags;

typedef enum _GrdPointerAxis
{
  GRD_POINTER_AXIS_VERTICAL,
  GRD_POINTER_AXIS_HORIZONTAL
} GrdPointerAxis;

typedef struct
{
  /* Size of the input region */
  uint32_t input_rect_width;
  uint32_t input_rect_height;

  /* Absolute pointer position in the input region */
  double x;
  double y;
} GrdEventMotionAbs;

struct _GrdSessionClass
{
  GObjectClass parent_class;

  void (*stop) (GrdSession *session);

  void (*on_stream_created) (GrdSession *session,
                             uint32_t    stream_id,
                             GrdStream  *stream);

  void (*on_caps_lock_state_changed) (GrdSession *session,
                                      gboolean    state);
  void (*on_num_lock_state_changed) (GrdSession *session,
                                     gboolean    state);
};

GrdContext *grd_session_get_context (GrdSession *session);

void grd_session_record_monitor (GrdSession              *session,
                                 uint32_t                 stream_id,
                                 const char              *connector,
                                 GrdScreenCastCursorMode  cursor_mode);

void grd_session_record_virtual (GrdSession              *session,
                                 uint32_t                 stream_id,
                                 GrdScreenCastCursorMode  cursor_mode,
                                 gboolean                 is_platform);

void grd_session_notify_keyboard_keycode (GrdSession  *session,
                                          uint32_t     keycode,
                                          GrdKeyState  state);

void grd_session_notify_keyboard_keysym (GrdSession  *session,
                                         uint32_t     keysym,
                                         GrdKeyState  state);

void grd_session_notify_pointer_button (GrdSession     *session,
                                        int32_t         button,
                                        GrdButtonState  state);

void grd_session_notify_pointer_axis (GrdSession          *session,
                                      double               dx,
                                      double               dy,
                                      GrdPointerAxisFlags  flags);

void grd_session_notify_pointer_axis_discrete (GrdSession     *session,
                                               GrdPointerAxis  axis,
                                               int             steps);

void grd_session_notify_pointer_motion (GrdSession *session,
                                        double      dx,
                                        double      dy);

void grd_session_notify_pointer_motion_absolute (GrdSession              *session,
                                                 GrdStream               *stream,
                                                 const GrdEventMotionAbs *motion_abs);

gboolean grd_session_has_touch_device (GrdSession *session);

GrdTouchContact *grd_session_acquire_touch_contact (GrdSession *session);

void grd_session_release_touch_contact (GrdSession      *session,
                                        GrdTouchContact *touch_contact);

void grd_session_notify_touch_down (GrdSession              *session,
                                    const GrdTouchContact   *touch_contact,
                                    GrdStream               *stream,
                                    const GrdEventMotionAbs *motion_abs);

void grd_session_notify_touch_motion (GrdSession              *session,
                                      const GrdTouchContact   *touch_contact,
                                      GrdStream               *stream,
                                      const GrdEventMotionAbs *motion_abs);

void grd_session_notify_touch_up (GrdSession      *session,
                                  GrdTouchContact *touch_contact);

void grd_session_notify_touch_cancel (GrdSession      *session,
                                      GrdTouchContact *touch_contact);

void grd_session_notify_touch_device_frame (GrdSession *session);

gboolean grd_session_enable_clipboard (GrdSession   *session,
                                       GrdClipboard *clipboard,
                                       GList        *mime_type_tables);

void grd_session_disable_clipboard (GrdSession *session);

void grd_session_set_selection (GrdSession *session,
                                GList      *mime_type_tables);

void grd_session_selection_write (GrdSession    *session,
                                  unsigned int   serial,
                                  const uint8_t *data,
                                  uint32_t       size);

int grd_session_selection_read (GrdSession  *session,
                                GrdMimeType  mime_type);

void grd_session_start (GrdSession *session);

void grd_session_stop (GrdSession *session);

gboolean grd_session_is_ready (GrdSession *session);

gboolean grd_session_flush_input_finish (GrdSession    *session,
                                         GAsyncResult  *result,
                                         GError       **error);

void grd_session_flush_input_async (GrdSession          *session,
                                    GCancellable        *cancellable,
                                    GAsyncReadyCallback  callback,
                                    gpointer             user_data);