guacamole-spice-protocol/src/protocols/rdp/rdp_gdi.h

/*
 * Copyright (C) 2013 Glyptodon LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */


#ifndef _GUAC_RDP_RDP_GDI_H
#define _GUAC_RDP_RDP_GDI_H

#include "config.h"

#include <freerdp/freerdp.h>
#include <guacamole/protocol.h>

/**
 * Translates a standard RDP ROP3 value into a guac_composite_mode. Valid
 * ROP3 operations indexes are listed in the RDP protocol specifications:
 *
 * http://msdn.microsoft.com/en-us/library/cc241583.aspx
 *
 * @param client The guac_client associated with the current RDP session.
 * @param rop3 The ROP3 operation index to translate.
 *
 * @return
 *     The guac_composite_mode that equates to, or most closely approximates,
 *     the given ROP3 operation.
 */
guac_composite_mode guac_rdp_rop3_transfer_function(guac_client* client,
        int rop3);

/**
 * Handler for RDP DSTBLT update.
 *
 * @param context The rdpContext associated with the current RDP session.
 * @param dstblt The DSTBLT update to handle.
 */
void guac_rdp_gdi_dstblt(rdpContext* context, DSTBLT_ORDER* dstblt);

/**
 * Handler for RDP PATBLT update.
 *
 * @param context The rdpContext associated with the current RDP session.
 * @param patblt The PATBLT update to handle.
 */
void guac_rdp_gdi_patblt(rdpContext* context, PATBLT_ORDER* patblt);

/**
 * Handler for RDP SCRBLT update.
 *
 * @param context The rdpContext associated with the current RDP session.
 * @param scrblt The SCRBLT update to handle.
 */
void guac_rdp_gdi_scrblt(rdpContext* context, SCRBLT_ORDER* scrblt);

/**
 * Handler for RDP MEMBLT update.
 *
 * @param context The rdpContext associated with the current RDP session.
 * @param memblt The MEMBLT update to handle.
 */
void guac_rdp_gdi_memblt(rdpContext* context, MEMBLT_ORDER* memblt);

/**
 * Handler for RDP OPAQUE RECT update.
 *
 * @param context The rdpContext associated with the current RDP session.
 * @param opaque_rect The OPAQUE RECT update to handle.
 */
void guac_rdp_gdi_opaquerect(rdpContext* context,
        OPAQUE_RECT_ORDER* opaque_rect);

/**
 * Handler called when the remote color palette is changing.
 *
 * @param context The rdpContext associated with the current RDP session.
 * @param palette The PALETTE update containing the new palette.
 */
void guac_rdp_gdi_palette_update(rdpContext* context, PALETTE_UPDATE* palette);

/**
 * Handler called prior to calling the handlers for specific updates when
 * those updates are clipped by a bounding rectangle. This is not a true RDP
 * update, but is called by FreeRDP before and after any update involving
 * clipping.
 *
 * @param context The rdpContext associated with the current RDP session.
 *
 * @param bounds
 *     The clipping rectangle to set, or NULL to remove any applied clipping
 *     rectangle.
 */
void guac_rdp_gdi_set_bounds(rdpContext* context, rdpBounds* bounds);

/**
 * Handler called when a paint operation is complete. We don't actually
 * use this, but FreeRDP requires it. Calling this function has no effect.
 *
 * @param context The rdpContext associated with the current RDP session.
 */
void guac_rdp_gdi_end_paint(rdpContext* context);

/**
 * Handler called when the desktop dimensions change, either from a
 * true desktop resize event received by the RDP client, or due to
 * a revised size given by the server during initial connection
 * negotiation.
 *
 * The new screen size will be made available within the settings associated
 * with the given context.
 *
 * @param context The rdpContext associated with the current RDP session.
 */
void guac_rdp_gdi_desktop_resize(rdpContext* context);

#endif