spice/server/dcc.h
Qiang Yu 4f94e844d7 dcc: use multi plane gl scanout message when possible
Signed-off-by: Qiang Yu <yuq825@gmail.com>
Acked-by: Frediano Ziglio <freddy77@gmail.com>
2025-04-25 08:26:37 +01:00

170 lines
8.3 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 <array>
#include "image-encoders.h"
#include "image-cache.h"
#include "pixmap-cache.h"
#include "display-limits.h"
#include "common-graphics-channel.h"
#include "utils.hpp"
#include "push-visibility.h"
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 void disconnect() override;
bool is_gl_client()
{
return red_stream_is_plain_unix(get_stream()) &&
(test_remote_cap(SPICE_DISPLAY_CAP_GL_SCANOUT) ||
test_remote_cap(SPICE_DISPLAY_CAP_GL_SCANOUT2));
}
protected:
virtual bool handle_message(uint16_t type, uint32_t size, void *msg) override;
virtual bool config_socket() override;
virtual void on_disconnect() override;
virtual void send_item(RedPipeItem *item) override;
virtual bool handle_migrate_data(uint32_t size, void *message) override;
virtual void migrate() override;
virtual void handle_migrate_flush_mark() override;
virtual bool handle_migrate_data_get_serial(uint32_t size, void *message, uint64_t &serial) override;
public:
red::unique_link<DisplayChannelClientPrivate> priv;
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;
struct RedSurface;
struct WaitForChannels {
SpiceMsgWaitForChannels header;
std::array<SpiceWaitForChannel, MAX_CACHE_CLIENTS> buf;
};
struct FreeList {
int res_size;
SpiceResourceList *res;
uint64_t sync[MAX_CACHE_CLIENTS];
WaitForChannels wait;
};
#define DCC_TO_DC(dcc) ((DisplayChannel*) dcc->get_channel())
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_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_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);
bool dcc_drawable_is_in_pipe (DisplayChannelClient *dcc,
Drawable *drawable);
int dcc_compress_image (DisplayChannelClient *dcc,
SpiceImage *dest, SpiceBitmap *src, Drawable *drawable,
int can_lossy,
compress_send_data_t* o_comp_data);
void dcc_create_surface(DisplayChannelClient *dcc, struct RedSurface *surface);
void dcc_push_surface_image(DisplayChannelClient *dcc, struct RedSurface *surface);
bool dcc_clear_surface_drawables_from_pipe(DisplayChannelClient *dcc,
RedSurface *surface, bool wait_if_used);
void dcc_add_surface_area_image(DisplayChannelClient *dcc, RedSurface *surface,
SpiceRect *area, RedChannelClient::Pipe::iterator pipe_item_pos,
int can_lossy);
RedPipeItemPtr dcc_gl_scanout_item_new(RedChannelClient *rcc, void *data, int num);
RedPipeItemPtr dcc_gl_draw_item_new(RedChannelClient *rcc, void *data, int num);
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);
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);
#include "pop-visibility.h"
#endif /* DCC_H_ */