/** * FreeRDP: A Remote Desktop Protocol Implementation * RemoteFX Codec * * Copyright 2011 Vic Lee * Copyright 2016 Armin Novak * Copyright 2016 Thincast Technologies GmbH * * 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_CODEC_REMOTEFX_H #define FREERDP_CODEC_REMOTEFX_H #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef enum { RLGR1, RLGR3 } RLGR_MODE; typedef struct { UINT16 x; UINT16 y; UINT16 width; UINT16 height; } RFX_RECT; typedef struct { UINT16 x; UINT16 y; UINT32 width; UINT32 height; BYTE* data; UINT32 scanline; BOOL allocated; BYTE quantIdxY; BYTE quantIdxCb; BYTE quantIdxCr; UINT16 xIdx; UINT16 yIdx; UINT16 YLen; UINT16 CbLen; UINT16 CrLen; BYTE* YData; BYTE* CbData; BYTE* CrData; BYTE* YCbCrData; } RFX_TILE; typedef struct S_RFX_MESSAGE_LIST RFX_MESSAGE_LIST; typedef struct S_RFX_MESSAGE RFX_MESSAGE; typedef struct S_RFX_CONTEXT RFX_CONTEXT; WINPR_ATTR_NODISCARD FREERDP_API BOOL rfx_process_message(RFX_CONTEXT* WINPR_RESTRICT context, const BYTE* WINPR_RESTRICT data, UINT32 length, UINT32 left, UINT32 top, BYTE* WINPR_RESTRICT dst, UINT32 dstFormat, UINT32 dstStride, UINT32 dstHeight, REGION16* WINPR_RESTRICT invalidRegion); WINPR_ATTR_NODISCARD FREERDP_API UINT32 rfx_message_get_frame_idx(const RFX_MESSAGE* WINPR_RESTRICT message); WINPR_ATTR_NODISCARD FREERDP_API const UINT32* rfx_message_get_quants(const RFX_MESSAGE* WINPR_RESTRICT message, UINT16* WINPR_RESTRICT numQuantVals); WINPR_ATTR_NODISCARD FREERDP_API const RFX_TILE** rfx_message_get_tiles(const RFX_MESSAGE* WINPR_RESTRICT message, UINT16* WINPR_RESTRICT numTiles); WINPR_ATTR_NODISCARD FREERDP_API UINT16 rfx_message_get_tile_count(const RFX_MESSAGE* WINPR_RESTRICT message); WINPR_ATTR_NODISCARD FREERDP_API const RFX_RECT* rfx_message_get_rects(const RFX_MESSAGE* WINPR_RESTRICT message, UINT16* WINPR_RESTRICT numRects); WINPR_ATTR_NODISCARD FREERDP_API UINT16 rfx_message_get_rect_count(const RFX_MESSAGE* WINPR_RESTRICT message); FREERDP_API void rfx_message_free(RFX_CONTEXT* WINPR_RESTRICT context, RFX_MESSAGE* WINPR_RESTRICT message); WINPR_ATTR_NODISCARD FREERDP_API BOOL rfx_compose_message(RFX_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s, const RFX_RECT* WINPR_RESTRICT rects, size_t numRects, const BYTE* WINPR_RESTRICT data, UINT32 width, UINT32 height, UINT32 scanline); WINPR_ATTR_MALLOC(rfx_message_free, 2) WINPR_ATTR_NODISCARD FREERDP_API RFX_MESSAGE* rfx_encode_message(RFX_CONTEXT* WINPR_RESTRICT context, const RFX_RECT* WINPR_RESTRICT rects, size_t numRects, const BYTE* WINPR_RESTRICT data, UINT32 width, UINT32 height, size_t scanline); FREERDP_API void rfx_message_list_free(RFX_MESSAGE_LIST* messages); WINPR_ATTR_MALLOC(rfx_message_list_free, 1) WINPR_ATTR_NODISCARD FREERDP_API RFX_MESSAGE_LIST* rfx_encode_messages(RFX_CONTEXT* WINPR_RESTRICT context, const RFX_RECT* WINPR_RESTRICT rects, size_t numRects, const BYTE* WINPR_RESTRICT data, UINT32 width, UINT32 height, UINT32 scanline, size_t* WINPR_RESTRICT numMessages, size_t maxDataSize); WINPR_ATTR_NODISCARD FREERDP_API const RFX_MESSAGE* rfx_message_list_get(const RFX_MESSAGE_LIST* WINPR_RESTRICT messages, size_t idx); WINPR_ATTR_NODISCARD FREERDP_API BOOL rfx_write_message(RFX_CONTEXT* WINPR_RESTRICT context, wStream* WINPR_RESTRICT s, const RFX_MESSAGE* WINPR_RESTRICT message); FREERDP_API void rfx_context_free(RFX_CONTEXT* context); WINPR_ATTR_MALLOC(rfx_context_free, 1) WINPR_ATTR_NODISCARD FREERDP_API RFX_CONTEXT* rfx_context_new_ex(BOOL encoder, UINT32 ThreadingFlags); WINPR_ATTR_MALLOC(rfx_context_free, 1) WINPR_ATTR_NODISCARD FREERDP_API RFX_CONTEXT* rfx_context_new(BOOL encoder); WINPR_ATTR_NODISCARD FREERDP_API BOOL rfx_context_reset(RFX_CONTEXT* WINPR_RESTRICT context, UINT32 width, UINT32 height); WINPR_ATTR_NODISCARD FREERDP_API BOOL rfx_context_set_mode(RFX_CONTEXT* WINPR_RESTRICT context, RLGR_MODE mode); /** Getter for RFX mode * @param context The RFX context to query * * @since version 3.0.0 * * @return The RFX mode that is currently in use */ WINPR_ATTR_NODISCARD FREERDP_API RLGR_MODE rfx_context_get_mode(RFX_CONTEXT* WINPR_RESTRICT context); FREERDP_API void rfx_context_set_pixel_format(RFX_CONTEXT* WINPR_RESTRICT context, UINT32 pixel_format); /** Getter for RFX pixel format * @param context The RFX context to query * * @since version 3.0.0 * * @return The RFX pixel format that is currently in use */ WINPR_ATTR_NODISCARD FREERDP_API UINT32 rfx_context_get_pixel_format(RFX_CONTEXT* WINPR_RESTRICT context); FREERDP_API void rfx_context_set_palette(RFX_CONTEXT* WINPR_RESTRICT context, const BYTE* WINPR_RESTRICT palette); /** Getter for RFX palette * @param context The RFX context to query * * @since version 3.0.0 * * @return The RFX palette that is currently in use or \b nullptr */ WINPR_ATTR_NODISCARD FREERDP_API const BYTE* rfx_context_get_palette(RFX_CONTEXT* WINPR_RESTRICT context); WINPR_ATTR_NODISCARD FREERDP_API UINT32 rfx_context_get_frame_idx(const RFX_CONTEXT* WINPR_RESTRICT context); /** Write a RFX message as simple progressive message to a stream. * * @param rfx The RFX codec context * @param s The stream to write to * @param msg The message to encode * * @since version 3.0.0 * @return \b TRUE in case of success, \b FALSE for any error */ WINPR_ATTR_NODISCARD FREERDP_API BOOL rfx_write_message_progressive_simple(RFX_CONTEXT* WINPR_RESTRICT rfx, wStream* WINPR_RESTRICT s, const RFX_MESSAGE* WINPR_RESTRICT msg); #ifdef __cplusplus } #endif #endif /* FREERDP_CODEC_REMOTEFX_H */