mirror of
https://gitlab.uni-freiburg.de/opensourcevdi/spice
synced 2025-12-26 22:48:19 +00:00
Make all RedChannelClient hierarchy a C++ class. This allows to use virtual methods. Added a normal contructor instead or properties and g_object_new. As we remove GObject conversion macros I added a macro XXX_CAST to create a function to replace the old macro. They will be removed when more type safety is introduced. There's a new SPICE_CXX_GLIB_ALLOCATOR macro in red-common.h. This macro, added to a class define the class allocator allowing to use, in this case, GLib for allocation. This to avoid C++ library dependency and to initialize all structure to 0 (not all fields are manually initialized, will be improved with more encapsulation). Currently the methods are mainly public, access will be modified when more encapsulation (all functions in method) are done. Some classes are now defined in the header, C++ uses access to limit accessibility but for efficiency and type safety/inline and other features require types to be defined in the headers. Some fields were moved from XxxPrivate structure to class, C++ has accessibility. Many destructors are defined as protected to forbid the use of stack, this as these objects uses internal reference counting to have normal pointers. Maybe in the future pointers like std::shared_ptr could be used instead. Reference counting is now implemented very easily using atomic operations. Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
198 lines
9.6 KiB
C++
198 lines
9.6 KiB
C++
/* -*- Mode: C; c-basic-offset: 4; indent-tabs-mode: nil -*- */
|
|
/*
|
|
Copyright (C) 2009-2015 Red Hat, Inc.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef DCC_H_
|
|
#define DCC_H_
|
|
|
|
#include "image-encoders.h"
|
|
#include "image-cache.h"
|
|
#include "pixmap-cache.h"
|
|
#include "display-limits.h"
|
|
#include "common-graphics-channel.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
struct DisplayChannel;
|
|
struct DisplayChannelClientPrivate;
|
|
|
|
class DisplayChannelClient final: public CommonGraphicsChannelClient
|
|
{
|
|
protected:
|
|
~DisplayChannelClient();
|
|
public:
|
|
DisplayChannelClient(DisplayChannel *display,
|
|
RedClient *client, RedStream *stream,
|
|
RedChannelCapabilities *caps,
|
|
uint32_t id,
|
|
SpiceImageCompression image_compression,
|
|
spice_wan_compression_t jpeg_state,
|
|
spice_wan_compression_t zlib_glz_state);
|
|
|
|
virtual bool config_socket() override;
|
|
virtual void on_disconnect() override;
|
|
|
|
DisplayChannelClientPrivate *priv = nullptr;
|
|
|
|
int is_low_bandwidth;
|
|
};
|
|
|
|
#define PALETTE_CACHE_HASH_SHIFT 8
|
|
#define PALETTE_CACHE_HASH_SIZE (1 << PALETTE_CACHE_HASH_SHIFT)
|
|
#define PALETTE_CACHE_HASH_MASK (PALETTE_CACHE_HASH_SIZE - 1)
|
|
#define PALETTE_CACHE_HASH_KEY(id) ((id) & PALETTE_CACHE_HASH_MASK)
|
|
#define CLIENT_PALETTE_CACHE_SIZE 128
|
|
|
|
#define DISPLAY_CLIENT_MIGRATE_DATA_TIMEOUT (NSEC_PER_SEC * 10)
|
|
#define DISPLAY_CLIENT_RETRY_INTERVAL 10000 //micro
|
|
|
|
/* Each drawable can refer to at most 3 images: src, brush and mask */
|
|
#define MAX_DRAWABLE_PIXMAP_CACHE_ITEMS 3
|
|
|
|
#define WIDE_CLIENT_ACK_WINDOW 40
|
|
#define NARROW_CLIENT_ACK_WINDOW 20
|
|
|
|
#define MAX_PIPE_SIZE 50
|
|
|
|
struct DisplayChannel;
|
|
struct VideoStream;
|
|
struct VideoStreamAgent;
|
|
|
|
typedef struct WaitForChannels {
|
|
SpiceMsgWaitForChannels header;
|
|
SpiceWaitForChannel buf[MAX_CACHE_CLIENTS];
|
|
} WaitForChannels;
|
|
|
|
typedef struct FreeList {
|
|
int res_size;
|
|
SpiceResourceList *res;
|
|
uint64_t sync[MAX_CACHE_CLIENTS];
|
|
WaitForChannels wait;
|
|
} FreeList;
|
|
|
|
#define DCC_TO_DC(dcc) ((DisplayChannel*) dcc->get_channel())
|
|
|
|
typedef struct RedSurfaceCreateItem {
|
|
RedPipeItem base;
|
|
SpiceMsgSurfaceCreate surface_create;
|
|
} RedSurfaceCreateItem;
|
|
|
|
typedef struct RedGlScanoutUnixItem {
|
|
RedPipeItem base;
|
|
} RedGlScanoutUnixItem;
|
|
|
|
typedef struct RedGlDrawItem {
|
|
RedPipeItem base;
|
|
SpiceMsgDisplayGlDraw draw;
|
|
} RedGlDrawItem;
|
|
|
|
typedef struct RedImageItem {
|
|
RedPipeItem base;
|
|
SpicePoint pos;
|
|
int width;
|
|
int height;
|
|
int stride;
|
|
int top_down;
|
|
int surface_id;
|
|
int image_format;
|
|
uint32_t image_flags;
|
|
int can_lossy;
|
|
uint8_t data[0];
|
|
} RedImageItem;
|
|
|
|
typedef struct RedDrawablePipeItem {
|
|
RedPipeItem base;
|
|
Drawable *drawable;
|
|
DisplayChannelClient *dcc;
|
|
} RedDrawablePipeItem;
|
|
|
|
DisplayChannelClient* dcc_new (DisplayChannel *display,
|
|
RedClient *client,
|
|
RedStream *stream,
|
|
int mig_target,
|
|
RedChannelCapabilities *caps,
|
|
SpiceImageCompression image_compression,
|
|
spice_wan_compression_t jpeg_state,
|
|
spice_wan_compression_t zlib_glz_state);
|
|
void dcc_start (DisplayChannelClient *dcc);
|
|
bool dcc_handle_message (RedChannelClient *rcc,
|
|
uint16_t type,
|
|
uint32_t size, void *msg);
|
|
bool dcc_handle_migrate_data (DisplayChannelClient *dcc,
|
|
uint32_t size, void *message);
|
|
void dcc_push_monitors_config (DisplayChannelClient *dcc);
|
|
void dcc_destroy_surface (DisplayChannelClient *dcc,
|
|
uint32_t surface_id);
|
|
void dcc_video_stream_agent_clip (DisplayChannelClient* dcc,
|
|
VideoStreamAgent *agent);
|
|
void dcc_create_stream (DisplayChannelClient *dcc,
|
|
VideoStream *stream);
|
|
void dcc_create_surface (DisplayChannelClient *dcc,
|
|
int surface_id);
|
|
void dcc_push_surface_image (DisplayChannelClient *dcc,
|
|
int surface_id);
|
|
RedImageItem * dcc_add_surface_area_image (DisplayChannelClient *dcc,
|
|
int surface_id,
|
|
SpiceRect *area,
|
|
GList *pipe_item_pos,
|
|
int can_lossy);
|
|
void dcc_palette_cache_reset (DisplayChannelClient *dcc);
|
|
void dcc_palette_cache_palette (DisplayChannelClient *dcc,
|
|
SpicePalette *palette,
|
|
uint8_t *flags);
|
|
bool dcc_pixmap_cache_unlocked_add (DisplayChannelClient *dcc,
|
|
uint64_t id, uint32_t size, int lossy);
|
|
void dcc_prepend_drawable (DisplayChannelClient *dcc,
|
|
Drawable *drawable);
|
|
void dcc_append_drawable (DisplayChannelClient *dcc,
|
|
Drawable *drawable);
|
|
void dcc_add_drawable_after (DisplayChannelClient *dcc,
|
|
Drawable *drawable,
|
|
RedPipeItem *pos);
|
|
void dcc_send_item (RedChannelClient *dcc,
|
|
RedPipeItem *item);
|
|
bool dcc_clear_surface_drawables_from_pipe (DisplayChannelClient *dcc,
|
|
int surface_id,
|
|
int wait_if_used);
|
|
bool dcc_drawable_is_in_pipe (DisplayChannelClient *dcc,
|
|
Drawable *drawable);
|
|
RedPipeItem * dcc_gl_scanout_item_new (RedChannelClient *rcc,
|
|
void *data, int num);
|
|
RedPipeItem * dcc_gl_draw_item_new (RedChannelClient *rcc,
|
|
void *data, int num);
|
|
|
|
int dcc_compress_image (DisplayChannelClient *dcc,
|
|
SpiceImage *dest, SpiceBitmap *src, Drawable *drawable,
|
|
int can_lossy,
|
|
compress_send_data_t* o_comp_data);
|
|
|
|
VideoStreamAgent *dcc_get_video_stream_agent(DisplayChannelClient *dcc, int stream_id);
|
|
ImageEncoders *dcc_get_encoders(DisplayChannelClient *dcc);
|
|
spice_wan_compression_t dcc_get_jpeg_state (DisplayChannelClient *dcc);
|
|
spice_wan_compression_t dcc_get_zlib_glz_state (DisplayChannelClient *dcc);
|
|
uint32_t dcc_get_max_stream_latency(DisplayChannelClient *dcc);
|
|
void dcc_set_max_stream_latency(DisplayChannelClient *dcc, uint32_t latency);
|
|
uint64_t dcc_get_max_stream_bit_rate(DisplayChannelClient *dcc);
|
|
void dcc_set_max_stream_bit_rate(DisplayChannelClient *dcc, uint64_t rate);
|
|
gboolean dcc_is_low_bandwidth(DisplayChannelClient *dcc);
|
|
GArray *dcc_get_preferred_video_codecs_for_encoding(DisplayChannelClient *dcc);
|
|
void dcc_video_codecs_update(DisplayChannelClient *dcc);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* DCC_H_ */
|