Blame client/X11/xfreerdp.h

Packit 1fb8d4
/**
Packit 1fb8d4
 * FreeRDP: A Remote Desktop Protocol Implementation
Packit 1fb8d4
 * X11 Client
Packit 1fb8d4
 *
Packit 1fb8d4
 * Copyright 2011 Marc-Andre Moreau <marcandre.moreau@gmail.com>
Packit 1fb8d4
 * Copyright 2016 Thincast Technologies GmbH
Packit 1fb8d4
 * Copyright 2016 Armin Novak <armin.novak@thincast.com>
Packit 1fb8d4
 *
Packit 1fb8d4
 * Licensed under the Apache License, Version 2.0 (the "License");
Packit 1fb8d4
 * you may not use this file except in compliance with the License.
Packit 1fb8d4
 * You may obtain a copy of the License at
Packit 1fb8d4
 *
Packit 1fb8d4
 *     http://www.apache.org/licenses/LICENSE-2.0
Packit 1fb8d4
 *
Packit 1fb8d4
 * Unless required by applicable law or agreed to in writing, software
Packit 1fb8d4
 * distributed under the License is distributed on an "AS IS" BASIS,
Packit 1fb8d4
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Packit 1fb8d4
 * See the License for the specific language governing permissions and
Packit 1fb8d4
 * limitations under the License.
Packit 1fb8d4
 */
Packit 1fb8d4
Packit 1fb8d4
#ifndef FREERDP_CLIENT_X11_FREERDP_H
Packit 1fb8d4
#define FREERDP_CLIENT_X11_FREERDP_H
Packit 1fb8d4
Packit Service 5a9772
#ifdef HAVE_CONFIG_H
Packit Service 5a9772
#include "config.h"
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit 1fb8d4
typedef struct xf_context xfContext;
Packit 1fb8d4
Packit 1fb8d4
#include <freerdp/api.h>
Packit 1fb8d4
Packit 1fb8d4
#include "xf_window.h"
Packit 1fb8d4
#include "xf_monitor.h"
Packit 1fb8d4
#include "xf_channels.h"
Packit 1fb8d4
Packit Service 5a9772
#if defined(CHANNEL_TSMF_CLIENT)
Packit Service 5a9772
#include <freerdp/client/tsmf.h>
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit 1fb8d4
#include <freerdp/gdi/gdi.h>
Packit 1fb8d4
#include <freerdp/codec/rfx.h>
Packit 1fb8d4
#include <freerdp/codec/nsc.h>
Packit 1fb8d4
#include <freerdp/codec/clear.h>
Packit 1fb8d4
#include <freerdp/codec/color.h>
Packit 1fb8d4
#include <freerdp/codec/bitmap.h>
Packit 1fb8d4
#include <freerdp/codec/h264.h>
Packit 1fb8d4
#include <freerdp/codec/progressive.h>
Packit 1fb8d4
#include <freerdp/codec/region.h>
Packit 1fb8d4
Packit 1fb8d4
struct xf_FullscreenMonitors
Packit 1fb8d4
{
Packit 1fb8d4
	UINT32 top;
Packit 1fb8d4
	UINT32 bottom;
Packit 1fb8d4
	UINT32 left;
Packit 1fb8d4
	UINT32 right;
Packit 1fb8d4
};
Packit 1fb8d4
typedef struct xf_FullscreenMonitors xfFullscreenMonitors;
Packit 1fb8d4
Packit 1fb8d4
struct xf_WorkArea
Packit 1fb8d4
{
Packit 1fb8d4
	UINT32 x;
Packit 1fb8d4
	UINT32 y;
Packit 1fb8d4
	UINT32 width;
Packit 1fb8d4
	UINT32 height;
Packit 1fb8d4
};
Packit 1fb8d4
typedef struct xf_WorkArea xfWorkArea;
Packit 1fb8d4
Packit 1fb8d4
struct xf_pointer
Packit 1fb8d4
{
Packit 1fb8d4
	rdpPointer pointer;
Packit 1fb8d4
	Cursor cursor;
Packit 1fb8d4
};
Packit 1fb8d4
typedef struct xf_pointer xfPointer;
Packit 1fb8d4
Packit 1fb8d4
struct xf_bitmap
Packit 1fb8d4
{
Packit 1fb8d4
	rdpBitmap bitmap;
Packit 1fb8d4
	Pixmap pixmap;
Packit 1fb8d4
	XImage* image;
Packit 1fb8d4
};
Packit 1fb8d4
typedef struct xf_bitmap xfBitmap;
Packit 1fb8d4
Packit 1fb8d4
struct xf_glyph
Packit 1fb8d4
{
Packit 1fb8d4
	rdpGlyph glyph;
Packit 1fb8d4
	Pixmap pixmap;
Packit 1fb8d4
};
Packit 1fb8d4
typedef struct xf_glyph xfGlyph;
Packit 1fb8d4
Packit 1fb8d4
typedef struct xf_clipboard xfClipboard;
Packit 1fb8d4
typedef struct _xfDispContext xfDispContext;
Packit 1fb8d4
typedef struct _xfVideoContext xfVideoContext;
Packit 1fb8d4
typedef struct xf_rail_icon_cache xfRailIconCache;
Packit 1fb8d4
Packit 1fb8d4
/* Number of buttons that are mapped from X11 to RDP button events. */
Packit Service 5a9772
#define NUM_BUTTONS_MAPPED 11
Packit Service 5a9772
Packit Service 5a9772
typedef struct
Packit Service 5a9772
{
Packit Service 5a9772
	int button;
Packit Service 5a9772
	UINT16 flags;
Packit Service 5a9772
} button_map;
Packit 1fb8d4
Packit 1fb8d4
struct xf_context
Packit 1fb8d4
{
Packit 1fb8d4
	rdpContext context;
Packit 1fb8d4
	DEFINE_RDP_CLIENT_COMMON();
Packit 1fb8d4
Packit 1fb8d4
	GC gc;
Packit 1fb8d4
	int xfds;
Packit 1fb8d4
	int depth;
Packit 1fb8d4
Packit 1fb8d4
	GC gc_mono;
Packit 1fb8d4
	BOOL invert;
Packit 1fb8d4
	Screen* screen;
Packit 1fb8d4
	XImage* image;
Packit 1fb8d4
	Pixmap primary;
Packit 1fb8d4
	Pixmap drawing;
Packit 1fb8d4
	Visual* visual;
Packit 1fb8d4
	Display* display;
Packit 1fb8d4
	Drawable drawable;
Packit 1fb8d4
	Pixmap bitmap_mono;
Packit 1fb8d4
	Colormap colormap;
Packit 1fb8d4
	int screen_number;
Packit 1fb8d4
	int scanline_pad;
Packit 1fb8d4
	BOOL big_endian;
Packit 1fb8d4
	BOOL fullscreen;
Packit 1fb8d4
	BOOL decorations;
Packit 1fb8d4
	BOOL grab_keyboard;
Packit 1fb8d4
	BOOL unobscured;
Packit 1fb8d4
	BOOL debug;
Packit 1fb8d4
	HANDLE x11event;
Packit 1fb8d4
	xfWindow* window;
Packit 1fb8d4
	xfAppWindow* appWindow;
Packit 1fb8d4
	xfPointer* pointer;
Packit 1fb8d4
	xfWorkArea workArea;
Packit 1fb8d4
	xfFullscreenMonitors fullscreenMonitors;
Packit 1fb8d4
	int current_desktop;
Packit 1fb8d4
	BOOL remote_app;
Packit 1fb8d4
	HANDLE mutex;
Packit 1fb8d4
	BOOL UseXThreads;
Packit 1fb8d4
	BOOL cursorHidden;
Packit 1fb8d4
Packit 1fb8d4
	HGDI_DC hdc;
Packit 1fb8d4
	UINT32 bitmap_size;
Packit 1fb8d4
	BYTE* bitmap_buffer;
Packit 1fb8d4
Packit 1fb8d4
	BOOL frame_begin;
Packit 1fb8d4
	UINT16 frame_x1;
Packit 1fb8d4
	UINT16 frame_y1;
Packit 1fb8d4
	UINT16 frame_x2;
Packit 1fb8d4
	UINT16 frame_y2;
Packit 1fb8d4
Packit 1fb8d4
	int XInputOpcode;
Packit 1fb8d4
Packit 1fb8d4
	int savedWidth;
Packit 1fb8d4
	int savedHeight;
Packit 1fb8d4
	int savedPosX;
Packit 1fb8d4
	int savedPosY;
Packit 1fb8d4
Packit 1fb8d4
#ifdef WITH_XRENDER
Packit 1fb8d4
	int scaledWidth;
Packit 1fb8d4
	int scaledHeight;
Packit 1fb8d4
	int offset_x;
Packit 1fb8d4
	int offset_y;
Packit 1fb8d4
#endif
Packit 1fb8d4
Packit 1fb8d4
	BOOL focused;
Packit 1fb8d4
	BOOL use_xinput;
Packit 1fb8d4
	BOOL mouse_active;
Packit 1fb8d4
	BOOL fullscreen_toggle;
Packit 1fb8d4
	BOOL controlToggle;
Packit 1fb8d4
	UINT32 KeyboardLayout;
Packit 1fb8d4
	BOOL KeyboardState[256];
Packit 1fb8d4
	XModifierKeymap* modifierMap;
Packit 1fb8d4
	wArrayList* keyCombinations;
Packit 1fb8d4
	wArrayList* xevents;
Packit 1fb8d4
	BOOL actionScriptExists;
Packit 1fb8d4
Packit 1fb8d4
	XSetWindowAttributes attribs;
Packit 1fb8d4
	BOOL complex_regions;
Packit 1fb8d4
	VIRTUAL_SCREEN vscreen;
Packit Service 5a9772
#if defined(CHANNEL_TSMF_CLIENT)
Packit 1fb8d4
	void* xv_context;
Packit Service 5a9772
#endif
Packit 1fb8d4
Packit 1fb8d4
	Atom* supportedAtoms;
Packit 1fb8d4
	unsigned long supportedAtomCount;
Packit 1fb8d4
Packit 1fb8d4
	Atom UTF8_STRING;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_WM_ICON;
Packit 1fb8d4
	Atom _MOTIF_WM_HINTS;
Packit 1fb8d4
	Atom _NET_CURRENT_DESKTOP;
Packit 1fb8d4
	Atom _NET_WORKAREA;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_SUPPORTED;
Packit 1fb8d4
	ATOM _NET_SUPPORTING_WM_CHECK;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_WM_STATE;
Packit 1fb8d4
	Atom _NET_WM_STATE_FULLSCREEN;
Packit 1fb8d4
	Atom _NET_WM_STATE_MAXIMIZED_HORZ;
Packit 1fb8d4
	Atom _NET_WM_STATE_MAXIMIZED_VERT;
Packit 1fb8d4
	Atom _NET_WM_STATE_SKIP_TASKBAR;
Packit 1fb8d4
	Atom _NET_WM_STATE_SKIP_PAGER;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_WM_FULLSCREEN_MONITORS;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_WM_NAME;
Packit 1fb8d4
	Atom _NET_WM_PID;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE;
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE_NORMAL;
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE_DIALOG;
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE_UTILITY;
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE_POPUP;
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE_POPUP_MENU;
Packit 1fb8d4
	Atom _NET_WM_WINDOW_TYPE_DROPDOWN_MENU;
Packit 1fb8d4
Packit 1fb8d4
	Atom _NET_WM_MOVERESIZE;
Packit 1fb8d4
	Atom _NET_MOVERESIZE_WINDOW;
Packit 1fb8d4
Packit 1fb8d4
	Atom WM_STATE;
Packit 1fb8d4
	Atom WM_PROTOCOLS;
Packit 1fb8d4
	Atom WM_DELETE_WINDOW;
Packit 1fb8d4
Packit 1fb8d4
	/* Channels */
Packit Service 5a9772
#if defined(CHANNEL_TSMF_CLIENT)
Packit 1fb8d4
	TsmfClientContext* tsmf;
Packit Service 5a9772
#endif
Packit Service 5a9772
Packit 1fb8d4
	xfClipboard* clipboard;
Packit 1fb8d4
	CliprdrClientContext* cliprdr;
Packit 1fb8d4
	xfVideoContext* xfVideo;
Packit 1fb8d4
	RdpeiClientContext* rdpei;
Packit 1fb8d4
	EncomspClientContext* encomsp;
Packit 1fb8d4
	xfDispContext* xfDisp;
Packit 1fb8d4
Packit 1fb8d4
	RailClientContext* rail;
Packit 1fb8d4
	wHashTable* railWindows;
Packit 1fb8d4
	xfRailIconCache* railIconCache;
Packit 1fb8d4
Packit 1fb8d4
	BOOL xkbAvailable;
Packit 1fb8d4
	BOOL xrenderAvailable;
Packit 1fb8d4
Packit 1fb8d4
	/* value to be sent over wire for each logical client mouse button */
Packit Service 5a9772
	button_map button_map[NUM_BUTTONS_MAPPED];
Packit 1fb8d4
	BYTE savedMaximizedState;
Packit Service 5a9772
	UINT32 locked;
Packit 1fb8d4
};
Packit 1fb8d4
Packit 1fb8d4
BOOL xf_create_window(xfContext* xfc);
Packit 1fb8d4
void xf_toggle_fullscreen(xfContext* xfc);
Packit Service 5a9772
BOOL xf_toggle_control(xfContext* xfc);
Packit 1fb8d4
Packit 1fb8d4
void xf_encomsp_init(xfContext* xfc, EncomspClientContext* encomsp);
Packit 1fb8d4
void xf_encomsp_uninit(xfContext* xfc, EncomspClientContext* encomsp);
Packit 1fb8d4
Packit 1fb8d4
enum XF_EXIT_CODE
Packit 1fb8d4
{
Packit 1fb8d4
	/* section 0-15: protocol-independent codes */
Packit 1fb8d4
	XF_EXIT_SUCCESS = 0,
Packit 1fb8d4
	XF_EXIT_DISCONNECT = 1,
Packit 1fb8d4
	XF_EXIT_LOGOFF = 2,
Packit 1fb8d4
	XF_EXIT_IDLE_TIMEOUT = 3,
Packit 1fb8d4
	XF_EXIT_LOGON_TIMEOUT = 4,
Packit 1fb8d4
	XF_EXIT_CONN_REPLACED = 5,
Packit 1fb8d4
	XF_EXIT_OUT_OF_MEMORY = 6,
Packit 1fb8d4
	XF_EXIT_CONN_DENIED = 7,
Packit 1fb8d4
	XF_EXIT_CONN_DENIED_FIPS = 8,
Packit 1fb8d4
	XF_EXIT_USER_PRIVILEGES = 9,
Packit 1fb8d4
	XF_EXIT_FRESH_CREDENTIALS_REQUIRED = 10,
Packit 1fb8d4
	XF_EXIT_DISCONNECT_BY_USER = 11,
Packit 1fb8d4
Packit 1fb8d4
	/* section 16-31: license error set */
Packit 1fb8d4
	XF_EXIT_LICENSE_INTERNAL = 16,
Packit 1fb8d4
	XF_EXIT_LICENSE_NO_LICENSE_SERVER = 17,
Packit 1fb8d4
	XF_EXIT_LICENSE_NO_LICENSE = 18,
Packit 1fb8d4
	XF_EXIT_LICENSE_BAD_CLIENT_MSG = 19,
Packit 1fb8d4
	XF_EXIT_LICENSE_HWID_DOESNT_MATCH = 20,
Packit 1fb8d4
	XF_EXIT_LICENSE_BAD_CLIENT = 21,
Packit 1fb8d4
	XF_EXIT_LICENSE_CANT_FINISH_PROTOCOL = 22,
Packit 1fb8d4
	XF_EXIT_LICENSE_CLIENT_ENDED_PROTOCOL = 23,
Packit 1fb8d4
	XF_EXIT_LICENSE_BAD_CLIENT_ENCRYPTION = 24,
Packit 1fb8d4
	XF_EXIT_LICENSE_CANT_UPGRADE = 25,
Packit 1fb8d4
	XF_EXIT_LICENSE_NO_REMOTE_CONNECTIONS = 26,
Packit 1fb8d4
Packit 1fb8d4
	/* section 32-127: RDP protocol error set */
Packit 1fb8d4
	XF_EXIT_RDP = 32,
Packit 1fb8d4
Packit 1fb8d4
	/* section 128-254: xfreerdp specific exit codes */
Packit 1fb8d4
	XF_EXIT_PARSE_ARGUMENTS = 128,
Packit 1fb8d4
	XF_EXIT_MEMORY = 129,
Packit 1fb8d4
	XF_EXIT_PROTOCOL = 130,
Packit 1fb8d4
	XF_EXIT_CONN_FAILED = 131,
Packit 1fb8d4
	XF_EXIT_AUTH_FAILURE = 132,
Packit 1fb8d4
	XF_EXIT_NEGO_FAILURE = 133,
Packit 1fb8d4
Packit 1fb8d4
	XF_EXIT_UNKNOWN = 255,
Packit 1fb8d4
};
Packit 1fb8d4
Packit Service 5a9772
#define xf_lock_x11(xfc) xf_lock_x11_(xfc, __FUNCTION__);
Packit Service 5a9772
#define xf_unlock_x11(xfc) xf_unlock_x11_(xfc, __FUNCTION__);
Packit Service 5a9772
Packit Service 5a9772
void xf_lock_x11_(xfContext* xfc, const char* fkt);
Packit Service 5a9772
void xf_unlock_x11_(xfContext* xfc, const char* fkt);
Packit 1fb8d4
Packit 1fb8d4
BOOL xf_picture_transform_required(xfContext* xfc);
Packit Service 5a9772
Packit Service 5a9772
#define xf_draw_screen(_xfc, _x, _y, _w, _h) \
Packit Service 5a9772
	xf_draw_screen_((_xfc), (_x), (_y), (_w), (_h), __FUNCTION__, __FILE__, __LINE__)
Packit Service 5a9772
void xf_draw_screen_(xfContext* xfc, int x, int y, int w, int h, const char* fkt, const char* file,
Packit Service 5a9772
                     int line);
Packit 1fb8d4
Packit 1fb8d4
FREERDP_API DWORD xf_exit_code_from_disconnect_reason(DWORD reason);
Packit 1fb8d4
Packit 1fb8d4
#endif /* FREERDP_CLIENT_X11_FREERDP_H */