/** * FreeRDP: A Remote Desktop Protocol Implementation * Session Shadowing * * Copyright 2014 Marc-Andre Moreau * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef FREERDP_SERVER_SHADOW_H #define FREERDP_SERVER_SHADOW_H #include #include #include #include #include #include #include #include #include #include #if defined(CHANNEL_AUDIN_SERVER) #include #endif #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef struct rdp_shadow_client rdpShadowClient; typedef struct rdp_shadow_server rdpShadowServer; typedef struct rdp_shadow_screen rdpShadowScreen; typedef struct rdp_shadow_surface rdpShadowSurface; typedef struct rdp_shadow_encoder rdpShadowEncoder; typedef struct rdp_shadow_capture rdpShadowCapture; typedef struct rdp_shadow_subsystem rdpShadowSubsystem; typedef struct rdp_shadow_multiclient_event rdpShadowMultiClientEvent; typedef struct S_RDP_SHADOW_ENTRY_POINTS RDP_SHADOW_ENTRY_POINTS; typedef int (*pfnShadowSubsystemEntry)(RDP_SHADOW_ENTRY_POINTS* pEntryPoints); typedef rdpShadowSubsystem* (*pfnShadowSubsystemNew)(void); typedef void (*pfnShadowSubsystemFree)(rdpShadowSubsystem* subsystem); typedef int (*pfnShadowSubsystemInit)(rdpShadowSubsystem* subsystem); typedef int (*pfnShadowSubsystemUninit)(rdpShadowSubsystem* subsystem); typedef int (*pfnShadowSubsystemStart)(rdpShadowSubsystem* subsystem); typedef int (*pfnShadowSubsystemStop)(rdpShadowSubsystem* subsystem); typedef UINT32 (*pfnShadowEnumMonitors)(MONITOR_DEF* monitors, UINT32 maxMonitors); typedef int (*pfnShadowAuthenticate)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, const char* user, const char* domain, const char* password); typedef BOOL (*pfnShadowClientConnect)(rdpShadowSubsystem* subsystem, rdpShadowClient* client); typedef void (*pfnShadowClientDisconnect)(rdpShadowSubsystem* subsystem, rdpShadowClient* client); typedef BOOL (*pfnShadowClientCapabilities)(rdpShadowSubsystem* subsystem, rdpShadowClient* client); typedef BOOL (*pfnShadowSynchronizeEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, UINT32 flags); typedef BOOL (*pfnShadowKeyboardEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, UINT16 flags, UINT8 code); typedef BOOL (*pfnShadowUnicodeKeyboardEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, UINT16 flags, UINT16 code); typedef BOOL (*pfnShadowMouseEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, UINT16 flags, UINT16 x, UINT16 y); typedef BOOL (*pfnShadowExtendedMouseEvent)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, UINT16 flags, UINT16 x, UINT16 y); typedef BOOL (*pfnShadowChannelAudinServerReceiveSamples)(rdpShadowSubsystem* subsystem, rdpShadowClient* client, const AUDIO_FORMAT* format, wStream* data); struct rdp_shadow_client { rdpContext context; HANDLE thread; BOOL activated; BOOL first_frame; BOOL inLobby; BOOL mayView; BOOL mayInteract; BOOL suppressOutput; UINT16 surfaceId; wMessageQueue* MsgQueue; CRITICAL_SECTION lock; REGION16 invalidRegion; rdpShadowServer* server; rdpShadowEncoder* encoder; rdpShadowSubsystem* subsystem; UINT32 pointerX; UINT32 pointerY; HANDLE vcm; EncomspServerContext* encomsp; RemdeskServerContext* remdesk; RdpsndServerContext* rdpsnd; #if defined(CHANNEL_AUDIN_SERVER) audin_server_context* audin; #endif RdpgfxServerContext* rdpgfx; BOOL resizeRequested; UINT32 resizeWidth; UINT32 resizeHeight; BOOL areGfxCapsReady; }; struct rdp_shadow_server { void* ext; HANDLE thread; HANDLE StopEvent; wArrayList* clients; rdpSettings* settings; rdpShadowScreen* screen; rdpShadowSurface* surface; rdpShadowSurface* lobby; rdpShadowCapture* capture; rdpShadowSubsystem* subsystem; DWORD port; BOOL mayView; BOOL mayInteract; BOOL shareSubRect; BOOL authentication; UINT32 selectedMonitor; RECTANGLE_16 subRect; /* Codec settings */ RLGR_MODE rfxMode; H264_RATECONTROL_MODE h264RateControlMode; UINT32 h264BitRate; UINT32 h264FrameRate; UINT32 h264QP; char* ipcSocket; char* ConfigPath; char* CertificateFile; char* PrivateKeyFile; CRITICAL_SECTION lock; freerdp_listener* listener; size_t maxClientsConnected; }; struct rdp_shadow_surface { rdpShadowServer* server; UINT16 x; UINT16 y; UINT32 width; UINT32 height; UINT32 scanline; DWORD format; BYTE* data; CRITICAL_SECTION lock; REGION16 invalidRegion; }; struct S_RDP_SHADOW_ENTRY_POINTS { pfnShadowSubsystemNew New; pfnShadowSubsystemFree Free; pfnShadowSubsystemInit Init; pfnShadowSubsystemUninit Uninit; pfnShadowSubsystemStart Start; pfnShadowSubsystemStop Stop; pfnShadowEnumMonitors EnumMonitors; }; struct rdp_shadow_subsystem { RDP_SHADOW_ENTRY_POINTS ep; HANDLE event; UINT32 numMonitors; UINT32 captureFrameRate; UINT32 selectedMonitor; MONITOR_DEF monitors[16]; MONITOR_DEF virtualScreen; /* This event indicates that we have graphic change */ /* such as screen update and resize. It should not be */ /* used by subsystem implementation directly */ rdpShadowMultiClientEvent* updateEvent; wMessagePipe* MsgPipe; UINT32 pointerX; UINT32 pointerY; AUDIO_FORMAT* rdpsndFormats; size_t nRdpsndFormats; AUDIO_FORMAT* audinFormats; size_t nAudinFormats; pfnShadowSynchronizeEvent SynchronizeEvent; pfnShadowKeyboardEvent KeyboardEvent; pfnShadowUnicodeKeyboardEvent UnicodeKeyboardEvent; pfnShadowMouseEvent MouseEvent; pfnShadowExtendedMouseEvent ExtendedMouseEvent; pfnShadowChannelAudinServerReceiveSamples AudinServerReceiveSamples; pfnShadowAuthenticate Authenticate; pfnShadowClientConnect ClientConnect; pfnShadowClientDisconnect ClientDisconnect; pfnShadowClientCapabilities ClientCapabilities; rdpShadowServer* server; }; /* Definition of message between subsystem and clients */ #define SHADOW_MSG_IN_REFRESH_REQUEST_ID 1001 typedef struct S_SHADOW_MSG_OUT SHADOW_MSG_OUT; typedef void (*MSG_OUT_FREE_FN)(UINT32 id, SHADOW_MSG_OUT* msg); /* function to free SHADOW_MSG_OUT */ struct S_SHADOW_MSG_OUT { int refCount; MSG_OUT_FREE_FN Free; }; #define SHADOW_MSG_OUT_POINTER_POSITION_UPDATE_ID 2001 #define SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE_ID 2002 #define SHADOW_MSG_OUT_AUDIO_OUT_SAMPLES_ID 2003 #define SHADOW_MSG_OUT_AUDIO_OUT_VOLUME_ID 2004 typedef struct { SHADOW_MSG_OUT common; UINT32 xPos; UINT32 yPos; } SHADOW_MSG_OUT_POINTER_POSITION_UPDATE; typedef struct { SHADOW_MSG_OUT common; UINT32 xHot; UINT32 yHot; UINT32 width; UINT32 height; UINT32 lengthAndMask; UINT32 lengthXorMask; BYTE* xorMaskData; BYTE* andMaskData; } SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE; typedef struct { SHADOW_MSG_OUT common; AUDIO_FORMAT* audio_format; void* buf; size_t nFrames; UINT16 wTimestamp; } SHADOW_MSG_OUT_AUDIO_OUT_SAMPLES; typedef struct { SHADOW_MSG_OUT common; UINT16 left; UINT16 right; } SHADOW_MSG_OUT_AUDIO_OUT_VOLUME; FREERDP_API void shadow_subsystem_set_entry_builtin(const char* name); FREERDP_API void shadow_subsystem_set_entry(pfnShadowSubsystemEntry pEntry); FREERDP_API WINPR_DEPRECATED_VAR( "Use shadow_subsystem_pointer_convert_alpha_pointer_data_to_format instead", int shadow_subsystem_pointer_convert_alpha_pointer_data( const BYTE* WINPR_RESTRICT pixels, BOOL premultiplied, UINT32 width, UINT32 height, SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE* WINPR_RESTRICT pointerColor)); FREERDP_API int shadow_subsystem_pointer_convert_alpha_pointer_data_to_format( const BYTE* WINPR_RESTRICT pixels, UINT32 format, BOOL premultiplied, UINT32 width, UINT32 height, SHADOW_MSG_OUT_POINTER_ALPHA_UPDATE* WINPR_RESTRICT pointerColor); FREERDP_API int shadow_server_parse_command_line(rdpShadowServer* server, int argc, char** argv, COMMAND_LINE_ARGUMENT_A* cargs); FREERDP_API int shadow_server_command_line_status_print(rdpShadowServer* server, int argc, char** argv, int status, COMMAND_LINE_ARGUMENT_A* cargs); FREERDP_API int shadow_server_start(rdpShadowServer* server); FREERDP_API int shadow_server_stop(rdpShadowServer* server); FREERDP_API int shadow_server_init(rdpShadowServer* server); FREERDP_API int shadow_server_uninit(rdpShadowServer* server); FREERDP_API UINT32 shadow_enum_monitors(MONITOR_DEF* monitors, UINT32 maxMonitors); FREERDP_API void shadow_server_free(rdpShadowServer* server); WINPR_ATTR_MALLOC(shadow_server_free, 1) FREERDP_API rdpShadowServer* shadow_server_new(void); FREERDP_API int shadow_capture_align_clip_rect(RECTANGLE_16* rect, const RECTANGLE_16* clip); FREERDP_API WINPR_DEPRECATED_VAR( "Use shadow_capture_compare_with_format", int shadow_capture_compare(const BYTE* WINPR_RESTRICT pData1, UINT32 nStep1, UINT32 nWidth, UINT32 nHeight, const BYTE* WINPR_RESTRICT pData2, UINT32 nStep2, RECTANGLE_16* WINPR_RESTRICT rect)); FREERDP_API int shadow_capture_compare_with_format(const BYTE* WINPR_RESTRICT pData1, UINT32 format1, UINT32 nStep1, UINT32 nWidth, UINT32 nHeight, const BYTE* WINPR_RESTRICT pData2, UINT32 format2, UINT32 nStep2, RECTANGLE_16* WINPR_RESTRICT rect); FREERDP_API void shadow_subsystem_frame_update(rdpShadowSubsystem* subsystem); FREERDP_API BOOL shadow_client_post_msg(rdpShadowClient* client, void* context, UINT32 type, SHADOW_MSG_OUT* msg, void* lParam); FREERDP_API int shadow_client_boardcast_msg(rdpShadowServer* server, void* context, UINT32 type, SHADOW_MSG_OUT* msg, void* lParam); FREERDP_API int shadow_client_boardcast_quit(rdpShadowServer* server, int nExitCode); FREERDP_API UINT32 shadow_encoder_preferred_fps(rdpShadowEncoder* encoder); FREERDP_API UINT32 shadow_encoder_inflight_frames(rdpShadowEncoder* encoder); FREERDP_API BOOL shadow_screen_resize(rdpShadowScreen* screen); #ifdef __cplusplus } #endif #endif /* FREERDP_SERVER_SHADOW_H */