mirror of
https://gitlab.uni-freiburg.de/opensourcevdi/spice
synced 2025-12-26 14:41:25 +00:00
97fcad82eb
The video encoders already have sophisticated bit rate control code that can react to both stream reports sent by the client, and server frame drop notifications. Furthermore they can adjust both the frame rate and the image quality to best match the network conditions. But if the client cannot send stream reports all this is bypassed and instead the streaming code performs its own primitive bit rate control that can only adjust the frame rate. So this patch removes the code duplication and lets the video encoders do their job. Signed-off-by: Francois Gouget <fgouget@codeweavers.com> Acked-by: Frediano Ziglio <fziglio@redhat.com>
211 lines
10 KiB
C
211 lines
10 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 <glib-object.h>
|
|
|
|
#include "image-encoders.h"
|
|
#include "image-cache.h"
|
|
#include "pixmap-cache.h"
|
|
#include "display-limits.h"
|
|
#include "red-channel-client.h"
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define TYPE_DISPLAY_CHANNEL_CLIENT display_channel_client_get_type()
|
|
|
|
#define DISPLAY_CHANNEL_CLIENT(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_DISPLAY_CHANNEL_CLIENT, DisplayChannelClient))
|
|
#define DISPLAY_CHANNEL_CLIENT_CLASS(klass) \
|
|
(G_TYPE_CHECK_CLASS_CAST((klass), TYPE_DISPLAY_CHANNEL_CLIENT, DisplayChannelClientClass))
|
|
#define IS_DISPLAY_CHANNEL_CLIENT(obj) \
|
|
(G_TYPE_CHECK_INSTANCE_TYPE((obj), TYPE_DISPLAY_CHANNEL_CLIENT))
|
|
#define IS_DISPLAY_CHANNEL_CLIENT_CLASS(klass) \
|
|
(G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_DISPLAY_CHANNEL_CLIENT))
|
|
#define DISPLAY_CHANNEL_CLIENT_GET_CLASS(obj) \
|
|
(G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_DISPLAY_CHANNEL_CLIENT, DisplayChannelClientClass))
|
|
|
|
typedef struct DisplayChannelClient DisplayChannelClient;
|
|
typedef struct DisplayChannelClientClass DisplayChannelClientClass;
|
|
typedef struct DisplayChannelClientPrivate DisplayChannelClientPrivate;
|
|
|
|
struct DisplayChannelClient
|
|
{
|
|
RedChannelClient parent;
|
|
|
|
int is_low_bandwidth;
|
|
|
|
DisplayChannelClientPrivate *priv;
|
|
};
|
|
|
|
struct DisplayChannelClientClass
|
|
{
|
|
RedChannelClientClass parent_class;
|
|
};
|
|
|
|
GType display_channel_client_get_type(void) G_GNUC_CONST;
|
|
|
|
#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
|
|
|
|
typedef struct DisplayChannel DisplayChannel;
|
|
typedef struct Stream Stream;
|
|
typedef struct StreamAgent StreamAgent;
|
|
|
|
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*)red_channel_client_get_channel((RedChannelClient*)dcc))
|
|
|
|
typedef struct RedSurfaceCreateItem {
|
|
RedPipeItem pipe_item;
|
|
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 dpi_pipe_item; /* link for the client's pipe itself */
|
|
Drawable *drawable;
|
|
DisplayChannelClient *dcc;
|
|
} RedDrawablePipeItem;
|
|
|
|
DisplayChannelClient* dcc_new (DisplayChannel *display,
|
|
RedClient *client,
|
|
RedsStream *stream,
|
|
int mig_target,
|
|
uint32_t *common_caps,
|
|
int num_common_caps,
|
|
uint32_t *caps,
|
|
int num_caps,
|
|
SpiceImageCompression image_compression,
|
|
spice_wan_compression_t jpeg_state,
|
|
spice_wan_compression_t zlib_glz_state);
|
|
void dcc_start (DisplayChannelClient *dcc);
|
|
void dcc_stop (DisplayChannelClient *dcc);
|
|
int dcc_handle_message (RedChannelClient *rcc,
|
|
uint32_t size,
|
|
uint16_t type, void *msg);
|
|
int 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_stream_agent_clip (DisplayChannelClient* dcc,
|
|
StreamAgent *agent);
|
|
void dcc_create_stream (DisplayChannelClient *dcc,
|
|
Stream *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);
|
|
int 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);
|
|
int dcc_clear_surface_drawables_from_pipe (DisplayChannelClient *dcc,
|
|
int surface_id,
|
|
int wait_if_used);
|
|
int 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);
|
|
|
|
StreamAgent * dcc_get_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);
|
|
int dcc_config_socket(RedChannelClient *rcc);
|
|
gboolean dcc_is_low_bandwidth(DisplayChannelClient *dcc);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* DCC_H_ */
|