client.h

Go to the documentation of this file.

/*
 * 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_CLIENT_H
#define _GUAC_CLIENT_H

#include "client-fntypes.h"
#include "client-types.h"
#include "client-constants.h"
#include "instruction-types.h"
#include "layer-types.h"
#include "object-types.h"
#include "pool-types.h"
#include "socket-types.h"
#include "stream-types.h"
#include "timestamp-types.h"

#include <cairo/cairo.h>
#include <stdarg.h>

struct guac_client_info {

    int optimal_width;

    int optimal_height;

    char** audio_mimetypes;

    char** video_mimetypes;

    char** image_mimetypes;

    int optimal_resolution;

};

struct guac_client {

    guac_socket* socket;

    guac_client_state state;

    guac_timestamp last_received_timestamp;

    guac_timestamp last_sent_timestamp;

    guac_client_info info;

    void* data;

    guac_client_handle_messages* handle_messages;

    guac_client_mouse_handler* mouse_handler;

    guac_client_key_handler* key_handler;

    guac_client_clipboard_handler* clipboard_handler;

    guac_client_size_handler* size_handler;

    guac_client_file_handler* file_handler;

    guac_client_pipe_handler* pipe_handler;

    guac_client_ack_handler* ack_handler;

    guac_client_blob_handler* blob_handler;

    guac_client_end_handler* end_handler;

    guac_client_free_handler* free_handler;

    guac_client_log_handler* log_handler;

    guac_client_get_handler* get_handler;

    guac_client_put_handler* put_handler;

    guac_pool* __buffer_pool;

    guac_pool* __layer_pool;

    guac_pool* __stream_pool;

    guac_stream* __output_streams;

    guac_stream* __input_streams;

    guac_pool* __object_pool;

    guac_object* __objects;

    char* connection_id;

};

guac_client* guac_client_alloc();

void guac_client_free(guac_client* client);

int guac_client_handle_instruction(guac_client* client,
        guac_instruction* instruction);

void guac_client_log(guac_client* client, guac_client_log_level level,
        const char* format, ...);

void vguac_client_log(guac_client* client, guac_client_log_level level,
        const char* format, va_list ap);

void guac_client_stop(guac_client* client);

void guac_client_abort(guac_client* client, guac_protocol_status status,
        const char* format, ...);

void vguac_client_abort(guac_client* client, guac_protocol_status status,
        const char* format, va_list ap);

guac_layer* guac_client_alloc_buffer(guac_client* client);

guac_layer* guac_client_alloc_layer(guac_client* client);

void guac_client_free_buffer(guac_client* client, guac_layer* layer);

void guac_client_free_layer(guac_client* client, guac_layer* layer);

guac_stream* guac_client_alloc_stream(guac_client* client);

void guac_client_free_stream(guac_client* client, guac_stream* stream);

guac_object* guac_client_alloc_object(guac_client* client);

void guac_client_free_object(guac_client* client, guac_object* object);

void guac_client_stream_png(guac_client* client, guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer, int x, int y,
        cairo_surface_t* surface);

void guac_client_stream_jpeg(guac_client* client, guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer, int x, int y,
        cairo_surface_t* surface, int quality);

void guac_client_stream_webp(guac_client* client, guac_socket* socket,
        guac_composite_mode mode, const guac_layer* layer, int x, int y,
        cairo_surface_t* surface, int quality, int lossless);

int guac_client_supports_webp(guac_client* client);

extern const guac_layer* GUAC_DEFAULT_LAYER;

#endif