[spice v16 05/23] streaming: Add a GStreamer 1.0 MJPEG video encoder and use it by default

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This introduces a pared down GStreamer-based video encoder to serve as
the basis for later enhancements.
In this form the new encoder supports both regular and sized streams
but lacks any rate control. It should still work fine if bandwidth is
sufficient such as on LANs.

Signed-off-by: Francois Gouget <fgouget@xxxxxxxxxxxxxxx>
---
 configure.ac               |  23 ++
 server/Makefile.am         |   8 +
 server/gstreamer-encoder.c | 559 +++++++++++++++++++++++++++++++++++++++++++++
 server/stream.c            |  18 +-
 server/video-encoder.h     |   6 +-
 5 files changed, 611 insertions(+), 3 deletions(-)
 create mode 100644 server/gstreamer-encoder.c

diff --git a/configure.ac b/configure.ac
index c743875..79fe0b8 100644
--- a/configure.ac
+++ b/configure.ac
@@ -68,6 +68,28 @@ dnl =========================================================================
 dnl Check optional features
 SPICE_CHECK_SMARTCARD
 
+AC_ARG_ENABLE(gstreamer,
+              AS_HELP_STRING([--enable-gstreamer=@<:@auto/yes/no@:>@],
+                             [Enable GStreamer 1.0 support]),,
+              [enable_gstreamer="auto"])
+
+if test "x$enable_gstreamer" != "xno"; then
+    SPICE_CHECK_GSTREAMER(GSTREAMER_1_0, 1.0, [gstreamer-1.0 gstreamer-base-1.0 gstreamer-app-1.0 gstreamer-video-1.0],
+        [enable_gstreamer="yes"
+         SPICE_CHECK_GSTREAMER_ELEMENTS($GST_INSPECT_1_0, [gst-plugins-base 1.0], [appsrc videoconvert appsink])
+         SPICE_CHECK_GSTREAMER_ELEMENTS($GST_INSPECT_1_0, [gstreamer-libav 1.0], [avenc_mjpeg])
+         ],
+         [if test "x$enable_gstreamer" = "xyes"; then
+              AC_MSG_ERROR([GStreamer 1.0 support requested but not found. You may set GSTREAMER_1_0_CFLAGS and GSTREAMER_1_0_LIBS to avoid the need to call pkg-config.])
+          fi
+    ])
+fi
+AM_CONDITIONAL(HAVE_GSTREAMER_1_0, test "x$have_gstreamer_1_0" = "xyes")
+
+if test x"$gstreamer_missing" != x; then
+    SPICE_WARNING([The following GStreamer $enable_gstreamer tools/elements are missing:$gstreamer_missing. The GStreamer video encoder can be built but may not work.])
+fi
+
 AC_ARG_ENABLE([automated_tests],
               AS_HELP_STRING([--enable-automated-tests], [Enable automated tests using spicy-screenshot (part of spice-gtk)]),,
               [enable_automated_tests="no"])
@@ -240,6 +262,7 @@ AC_MSG_NOTICE([
 
         LZ4 support:              ${enable_lz4}
         Smartcard:                ${have_smartcard}
+        GStreamer 1.0:            ${have_gstreamer_1_0}
         SASL support:             ${have_sasl}
         Automated tests:          ${enable_automated_tests}
         Manual:                   ${have_asciidoc}
diff --git a/server/Makefile.am b/server/Makefile.am
index cca3b9b..ea3e2ff 100644
--- a/server/Makefile.am
+++ b/server/Makefile.am
@@ -12,6 +12,7 @@ AM_CPPFLAGS =					\
 	$(SASL_CFLAGS)				\
 	$(SLIRP_CFLAGS)				\
 	$(SMARTCARD_CFLAGS)			\
+	$(GSTREAMER_1_0_CFLAGS)			\
 	$(SPICE_PROTOCOL_CFLAGS)		\
 	$(SSL_CFLAGS)				\
 	$(VISIBILITY_HIDDEN_CFLAGS)		\
@@ -45,6 +46,7 @@ libserver_la_LIBADD =							\
 	$(PIXMAN_LIBS)							\
 	$(SASL_LIBS)							\
 	$(SLIRP_LIBS)							\
+	$(GSTREAMER_1_0_LIBS)						\
 	$(SSL_LIBS)							\
 	$(Z_LIBS)							\
 	$(SPICE_NONPKGCONFIG_LIBS)					\
@@ -157,6 +159,12 @@ libserver_la_SOURCES +=	\
 	$(NULL)
 endif
 
+if HAVE_GSTREAMER_1_0
+libserver_la_SOURCES +=	\
+	gstreamer-encoder.c			\
+	$(NULL)
+endif
+
 libspice_server_la_LIBADD = libserver.la
 libspice_server_la_SOURCES =
 
diff --git a/server/gstreamer-encoder.c b/server/gstreamer-encoder.c
new file mode 100644
index 0000000..c3db28f
--- /dev/null
+++ b/server/gstreamer-encoder.c
@@ -0,0 +1,559 @@
+/* -*- Mode: C; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+   Copyright (C) 2015 Jeremy White
+   Copyright (C) 2015-2016 Francois Gouget
+
+   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/>.
+*/
+#ifdef HAVE_CONFIG_H
+#include <config.h>
+#endif
+
+#include <gst/gst.h>
+#include <gst/app/gstappsrc.h>
+#include <gst/app/gstappsink.h>
+
+#include "red-common.h"
+#include "video-encoder.h"
+
+
+#define SPICE_GST_DEFAULT_FPS 30
+
+
+typedef struct {
+    SpiceBitmapFmt spice_format;
+    const char *format;
+    uint32_t bpp;
+} SpiceFormatForGStreamer;
+
+typedef struct SpiceGstEncoder {
+    VideoEncoder base;
+
+    /* Rate control callbacks */
+    VideoEncoderRateControlCbs cbs;
+
+    /* Spice's initial bit rate estimation in bits per second. */
+    uint64_t starting_bit_rate;
+
+    /* ---------- Video characteristics ---------- */
+
+    uint32_t width;
+    uint32_t height;
+    const SpiceFormatForGStreamer *format;
+    SpiceBitmapFmt spice_format;
+
+    /* ---------- GStreamer pipeline ---------- */
+
+    /* Pointers to the GStreamer pipeline elements. If pipeline is NULL the
+     * other pointers are invalid.
+     */
+    GstElement *pipeline;
+    GstAppSink *appsink;
+    GstAppSrc *appsrc;
+    GstCaps *src_caps;
+    GstElement *gstenc;
+
+    /* Pipeline parameters to modify before the next frame. */
+#   define SPICE_GST_VIDEO_PIPELINE_STATE    0x1
+#   define SPICE_GST_VIDEO_PIPELINE_BITRATE  0x2
+#   define SPICE_GST_VIDEO_PIPELINE_CAPS     0x4
+    uint32_t set_pipeline;
+
+    /* The bit rate target for the outgoing network stream. (bits per second) */
+    uint64_t bit_rate;
+
+    /* The minimum bit rate. */
+#   define SPICE_GST_MIN_BITRATE (128 * 1024)
+
+    /* The default bit rate. */
+#   define SPICE_GST_DEFAULT_BITRATE (8 * 1024 * 1024)
+} SpiceGstEncoder;
+
+
+/* ---------- Miscellaneous SpiceGstEncoder helpers ---------- */
+
+static inline double get_mbps(uint64_t bit_rate)
+{
+    return (double)bit_rate / 1024 / 1024;
+}
+
+/* Returns the source frame rate which may change at any time so don't store
+ * the result.
+ */
+static uint32_t get_source_fps(SpiceGstEncoder *encoder)
+{
+    return encoder->cbs.get_source_fps ?
+        encoder->cbs.get_source_fps(encoder->cbs.opaque) : SPICE_GST_DEFAULT_FPS;
+}
+
+static void set_pipeline_changes(SpiceGstEncoder *encoder, uint32_t flags)
+{
+    encoder->set_pipeline |= flags;
+}
+
+static void free_pipeline(SpiceGstEncoder *encoder)
+{
+    if (encoder->src_caps) {
+        gst_caps_unref(encoder->src_caps);
+        encoder->src_caps = NULL;
+    }
+    if (encoder->pipeline) {
+        gst_element_set_state(encoder->pipeline, GST_STATE_NULL);
+        gst_object_unref(encoder->appsrc);
+        gst_object_unref(encoder->gstenc);
+        gst_object_unref(encoder->appsink);
+        gst_object_unref(encoder->pipeline);
+        encoder->pipeline = NULL;
+    }
+}
+
+/* The maximum bit rate we will use for the current video.
+ *
+ * This is based on a 10x compression ratio which should be more than enough
+ * for even MJPEG to provide good quality.
+ */
+static uint64_t get_bit_rate_cap(SpiceGstEncoder *encoder)
+{
+    uint32_t raw_frame_bits = encoder->width * encoder->height * encoder->format->bpp;
+    return raw_frame_bits * get_source_fps(encoder) / 10;
+}
+
+static void adjust_bit_rate(SpiceGstEncoder *encoder)
+{
+    if (encoder->bit_rate == 0) {
+        /* Use the default value, */
+        encoder->bit_rate = SPICE_GST_DEFAULT_BITRATE;
+    } else if (encoder->bit_rate < SPICE_GST_MIN_BITRATE) {
+        /* don't let the bit rate go too low */
+        encoder->bit_rate = SPICE_GST_MIN_BITRATE;
+    } else {
+        /* or too high */
+        encoder->bit_rate = MIN(encoder->bit_rate, get_bit_rate_cap(encoder));
+    }
+    spice_debug("adjust_bit_rate(%.3fMbps)", get_mbps(encoder->bit_rate));
+}
+
+
+/* ---------- GStreamer pipeline ---------- */
+
+/* A helper for spice_gst_encoder_encode_frame() */
+static const SpiceFormatForGStreamer *map_format(SpiceBitmapFmt format)
+{
+    /* See GStreamer's part-mediatype-video-raw.txt and
+     * section-types-definitions.html documents.
+     */
+    static const SpiceFormatForGStreamer format_map[] =  {
+        {SPICE_BITMAP_FMT_RGBA, "BGRA", 32},
+        {SPICE_BITMAP_FMT_16BIT, "RGB15", 16},
+        /* TODO: Test the other formats */
+        {SPICE_BITMAP_FMT_32BIT, "BGRx", 32},
+        {SPICE_BITMAP_FMT_24BIT, "BGR", 24},
+    };
+
+    int i;
+    for (i = 0; i < G_N_ELEMENTS(format_map); i++) {
+        if (format_map[i].spice_format == format) {
+            if (i > 1) {
+                spice_warning("The %d format has not been tested yet", format);
+            }
+            return &format_map[i];
+        }
+    }
+
+    return NULL;
+}
+
+static void set_appsrc_caps(SpiceGstEncoder *encoder)
+{
+    if (encoder->src_caps) {
+        gst_caps_unref(encoder->src_caps);
+    }
+    encoder->src_caps = gst_caps_new_simple(
+        "video/x-raw",
+        "format", G_TYPE_STRING, encoder->format->format,
+        "width", G_TYPE_INT, encoder->width,
+        "height", G_TYPE_INT, encoder->height,
+        "framerate", GST_TYPE_FRACTION, get_source_fps(encoder), 1,
+        NULL);
+    gst_app_src_set_caps(encoder->appsrc, encoder->src_caps);
+}
+
+/* A helper for spice_gst_encoder_encode_frame() */
+static gboolean create_pipeline(SpiceGstEncoder *encoder)
+{
+    GError *err = NULL;
+    /* Set max-threads to ensure zero-frame latency */
+    const gchar *desc = "appsrc is-live=true format=time do-timestamp=true name=src ! videoconvert ! avenc_mjpeg max-threads=1 name=encoder ! appsink name=sink";
+    spice_debug("GStreamer pipeline: %s", desc);
+    encoder->pipeline = gst_parse_launch_full(desc, NULL, GST_PARSE_FLAG_FATAL_ERRORS, &err);
+    if (!encoder->pipeline || err) {
+        spice_warning("GStreamer error: %s", err->message);
+        g_clear_error(&err);
+        if (encoder->pipeline) {
+            gst_object_unref(encoder->pipeline);
+            encoder->pipeline = NULL;
+        }
+        return FALSE;
+    }
+    encoder->appsrc = GST_APP_SRC(gst_bin_get_by_name(GST_BIN(encoder->pipeline), "src"));
+    encoder->gstenc = gst_bin_get_by_name(GST_BIN(encoder->pipeline), "encoder");
+    encoder->appsink = GST_APP_SINK(gst_bin_get_by_name(GST_BIN(encoder->pipeline), "sink"));
+
+    /* See https://bugzilla.gnome.org/show_bug.cgi?id=753257 */
+    spice_debug("removing the pipeline clock");
+    gst_pipeline_use_clock(GST_PIPELINE(encoder->pipeline), NULL);
+
+    set_pipeline_changes(encoder, SPICE_GST_VIDEO_PIPELINE_STATE |
+                                  SPICE_GST_VIDEO_PIPELINE_BITRATE |
+                                  SPICE_GST_VIDEO_PIPELINE_CAPS);
+
+    return TRUE;
+}
+
+/* A helper for configure_pipeline() */
+static void set_gstenc_bitrate(SpiceGstEncoder *encoder)
+{
+    adjust_bit_rate(encoder);
+    g_object_set(G_OBJECT(encoder->gstenc),
+                 "bitrate", (gint)encoder->bit_rate, NULL);
+}
+
+/* A helper for spice_gst_encoder_encode_frame() */
+static gboolean configure_pipeline(SpiceGstEncoder *encoder)
+{
+    if (!encoder->pipeline && !create_pipeline(encoder)) {
+        return FALSE;
+    }
+    if (!encoder->set_pipeline) {
+        return TRUE;
+    }
+
+    /* If the pipeline state does not need to be changed it's because it is
+     * already in the PLAYING state. So first set it to the NULL state so it
+     * can be (re)configured.
+     */
+    if (!(encoder->set_pipeline & SPICE_GST_VIDEO_PIPELINE_STATE) &&
+        gst_element_set_state(encoder->pipeline, GST_STATE_NULL) == GST_STATE_CHANGE_FAILURE) {
+        spice_debug("GStreamer error: could not stop the pipeline");
+        free_pipeline(encoder);
+        return FALSE;
+    }
+
+    /* Configure the encoder bitrate */
+    if (encoder->set_pipeline & SPICE_GST_VIDEO_PIPELINE_BITRATE) {
+        set_gstenc_bitrate(encoder);
+    }
+
+    /* Set the source caps */
+    if (encoder->set_pipeline & SPICE_GST_VIDEO_PIPELINE_CAPS) {
+        set_appsrc_caps(encoder);
+    }
+
+    /* Start playing */
+    if (gst_element_set_state(encoder->pipeline, GST_STATE_PLAYING) == GST_STATE_CHANGE_FAILURE) {
+        spice_warning("GStreamer error: unable to set the pipeline to the playing state");
+        free_pipeline(encoder);
+        return FALSE;
+    }
+
+    encoder->set_pipeline = 0;
+    return TRUE;
+}
+
+/* A helper for the *_copy() functions */
+static int is_chunk_stride_aligned(const SpiceBitmap *bitmap, uint32_t index)
+{
+    SpiceChunks *chunks = bitmap->data;
+    if (chunks->chunk[index].len % bitmap->stride != 0) {
+        /* A line straddles two chunks. This is not supported */
+        spice_warning("chunk %d/%d contains an incomplete line, cannot copy",
+                      index, chunks->num_chunks);
+        return FALSE;
+    }
+    return TRUE;
+}
+
+/* A helper for push_raw_frame() */
+static inline int line_copy(SpiceGstEncoder *encoder, const SpiceBitmap *bitmap,
+                            uint32_t chunk_offset, uint32_t stream_stride,
+                            uint32_t height, uint8_t *buffer)
+{
+     uint8_t *dst = buffer;
+     SpiceChunks *chunks = bitmap->data;
+     uint32_t chunk_index = 0;
+     for (int l = 0; l < height; l++) {
+         /* We may have to move forward by more than one chunk the first
+          * time around. This also protects us against 0-byte chunks.
+          */
+         while (chunk_offset >= chunks->chunk[chunk_index].len) {
+             if (!is_chunk_stride_aligned(bitmap, chunk_index)) {
+                 return FALSE;
+             }
+             chunk_offset -= chunks->chunk[chunk_index].len;
+             chunk_index++;
+         }
+
+         /* Copy the line */
+         uint8_t *src = chunks->chunk[chunk_index].data + chunk_offset;
+         memcpy(dst, src, stream_stride);
+         dst += stream_stride;
+         chunk_offset += bitmap->stride;
+     }
+     spice_return_val_if_fail(dst - buffer == stream_stride * height, FALSE);
+     return TRUE;
+}
+
+/* A helper for push_raw_frame() */
+static inline int chunk_copy(SpiceGstEncoder *encoder, const SpiceBitmap *bitmap,
+                             uint32_t chunk_offset, uint32_t len, uint8_t *dst)
+{
+    SpiceChunks *chunks = bitmap->data;
+    uint32_t chunk_index = 0;
+    /* Skip chunks until we find the start of the frame */
+    while (chunk_index < chunks->num_chunks &&
+           chunk_offset >= chunks->chunk[chunk_index].len) {
+        if (!is_chunk_stride_aligned(bitmap, chunk_index)) {
+            return FALSE;
+        }
+        chunk_offset -= chunks->chunk[chunk_index].len;
+        chunk_index++;
+    }
+
+    /* We can copy the frame chunk by chunk */
+    while (len && chunk_index < chunks->num_chunks) {
+        if (!is_chunk_stride_aligned(bitmap, chunk_index)) {
+            return FALSE;
+        }
+        uint8_t *src = chunks->chunk[chunk_index].data + chunk_offset;
+        uint32_t thislen = MIN(chunks->chunk[chunk_index].len - chunk_offset, len);
+        memcpy(dst, src, thislen);
+        dst += thislen;
+        len -= thislen;
+        chunk_offset = 0;
+        chunk_index++;
+    }
+    spice_return_val_if_fail(len == 0, FALSE);
+    return TRUE;
+}
+
+/* A helper for spice_gst_encoder_encode_frame() */
+static int push_raw_frame(SpiceGstEncoder *encoder, const SpiceBitmap *bitmap,
+                          const SpiceRect *src, int top_down)
+{
+    uint32_t height = src->bottom - src->top;
+    uint32_t stream_stride = (src->right - src->left) * encoder->format->bpp / 8;
+    uint32_t len = stream_stride * height;
+    GstBuffer *buffer = gst_buffer_new_and_alloc(len);
+    GstMapInfo map;
+    gst_buffer_map(buffer, &map, GST_MAP_WRITE);
+    uint8_t *dst = map.data;
+
+    /* Note that we should not reorder the lines, even if top_down is false.
+     * It just changes the number of lines to skip at the start of the bitmap.
+     */
+    uint32_t skip_lines = top_down ? src->top : bitmap->y - (src->bottom - 0);
+    uint32_t chunk_offset = bitmap->stride * skip_lines;
+
+    if (stream_stride != bitmap->stride) {
+        /* We have to do a line-by-line copy because for each we have to
+         * leave out pixels on the left or right.
+         */
+        chunk_offset += src->left * encoder->format->bpp / 8;
+        if (!line_copy(encoder, bitmap, chunk_offset, stream_stride, height, dst)) {
+            gst_buffer_unmap(buffer, &map);
+            gst_buffer_unref(buffer);
+            return VIDEO_ENCODER_FRAME_UNSUPPORTED;
+        }
+    } else {
+        /* We can copy the bitmap chunk by chunk */
+        if (!chunk_copy(encoder, bitmap, chunk_offset, len, dst)) {
+            gst_buffer_unmap(buffer, &map);
+            gst_buffer_unref(buffer);
+            return VIDEO_ENCODER_FRAME_UNSUPPORTED;
+        }
+    }
+    gst_buffer_unmap(buffer, &map);
+
+    GstFlowReturn ret = gst_app_src_push_buffer(encoder->appsrc, buffer);
+    if (ret != GST_FLOW_OK) {
+        spice_warning("GStreamer error: unable to push source buffer (%d)", ret);
+        return VIDEO_ENCODER_FRAME_UNSUPPORTED;
+    }
+
+    return VIDEO_ENCODER_FRAME_ENCODE_DONE;
+}
+
+/* A helper for spice_gst_encoder_encode_frame() */
+static int pull_compressed_buffer(SpiceGstEncoder *encoder,
+                                  uint8_t **outbuf, size_t *outbuf_size,
+                                  uint32_t *data_size)
+{
+    spice_return_val_if_fail(outbuf && outbuf_size, VIDEO_ENCODER_FRAME_UNSUPPORTED);
+
+    GstSample *sample = gst_app_sink_pull_sample(encoder->appsink);
+    if (sample) {
+        GstMapInfo map;
+        GstBuffer *buffer = gst_sample_get_buffer(sample);
+        if (buffer && gst_buffer_map(buffer, &map, GST_MAP_READ)) {
+            gint size = gst_buffer_get_size(buffer);
+            if (!*outbuf || *outbuf_size < size) {
+                free(*outbuf);
+                *outbuf = spice_malloc(size);
+                *outbuf_size = size;
+            }
+            /* TODO Try to avoid this copy by changing the GstBuffer handling */
+            memcpy(*outbuf, map.data, size);
+            *data_size = size;
+            gst_buffer_unmap(buffer, &map);
+            gst_sample_unref(sample);
+            return VIDEO_ENCODER_FRAME_ENCODE_DONE;
+        }
+        gst_sample_unref(sample);
+    }
+    spice_debug("failed to pull the compressed buffer");
+    return VIDEO_ENCODER_FRAME_UNSUPPORTED;
+}
+
+
+/* ---------- VideoEncoder's public API ---------- */
+
+static void spice_gst_encoder_destroy(VideoEncoder *video_encoder)
+{
+    SpiceGstEncoder *encoder = (SpiceGstEncoder*)video_encoder;
+    free_pipeline(encoder);
+    free(encoder);
+}
+
+static int spice_gst_encoder_encode_frame(VideoEncoder *video_encoder,
+                                          uint32_t frame_mm_time,
+                                          const SpiceBitmap *bitmap,
+                                          const SpiceRect *src, int top_down,
+                                          uint8_t **outbuf, size_t *outbuf_size,
+                                          uint32_t *data_size)
+{
+    SpiceGstEncoder *encoder = (SpiceGstEncoder*)video_encoder;
+
+    uint32_t width = src->right - src->left;
+    uint32_t height = src->bottom - src->top;
+    if (width != encoder->width || height != encoder->height ||
+        encoder->spice_format != bitmap->format) {
+        spice_debug("video format change: width %d -> %d, height %d -> %d, format %d -> %d",
+                    encoder->width, width, encoder->height, height,
+                    encoder->spice_format, bitmap->format);
+        encoder->format = map_format(bitmap->format);
+        if (!encoder->format) {
+            spice_warning("unable to map format type %d", bitmap->format);
+            return VIDEO_ENCODER_FRAME_UNSUPPORTED;
+        }
+        encoder->spice_format = bitmap->format;
+        encoder->width = width;
+        encoder->height = height;
+        if (encoder->pipeline) {
+            set_pipeline_changes(encoder, SPICE_GST_VIDEO_PIPELINE_CAPS);
+        }
+    }
+
+    if (!configure_pipeline(encoder)) {
+        return VIDEO_ENCODER_FRAME_UNSUPPORTED;
+    }
+
+    int rc = push_raw_frame(encoder, bitmap, src, top_down);
+    if (rc == VIDEO_ENCODER_FRAME_ENCODE_DONE) {
+        rc = pull_compressed_buffer(encoder, outbuf, outbuf_size, data_size);
+        if (rc != VIDEO_ENCODER_FRAME_ENCODE_DONE) {
+            /* The input buffer will be stuck in the pipeline, preventing
+             * later ones from being processed. Furthermore something went
+             * wrong with this pipeline, so it may be safer to rebuild it
+             * from scratch.
+             */
+            free_pipeline(encoder);
+        }
+    }
+    return rc;
+}
+
+static void spice_gst_encoder_client_stream_report(VideoEncoder *video_encoder,
+                                             uint32_t num_frames,
+                                             uint32_t num_drops,
+                                             uint32_t start_frame_mm_time,
+                                             uint32_t end_frame_mm_time,
+                                             int32_t end_frame_delay,
+                                             uint32_t audio_delay)
+{
+    spice_debug("client report: #frames %u, #drops %d, duration %u video-delay %d audio-delay %u",
+                num_frames, num_drops,
+                end_frame_mm_time - start_frame_mm_time,
+                end_frame_delay, audio_delay);
+}
+
+static void spice_gst_encoder_notify_server_frame_drop(VideoEncoder *video_encoder)
+{
+    spice_debug("server report: getting frame drops...");
+}
+
+static uint64_t spice_gst_encoder_get_bit_rate(VideoEncoder *video_encoder)
+{
+    SpiceGstEncoder *encoder = (SpiceGstEncoder*)video_encoder;
+    return encoder->bit_rate;
+}
+
+static void spice_gst_encoder_get_stats(VideoEncoder *video_encoder,
+                                        VideoEncoderStats *stats)
+{
+    SpiceGstEncoder *encoder = (SpiceGstEncoder*)video_encoder;
+    uint64_t raw_bit_rate = encoder->width * encoder->height * (encoder->format ? encoder->format->bpp : 0) * get_source_fps(encoder);
+
+    spice_return_if_fail(stats != NULL);
+    stats->starting_bit_rate = encoder->starting_bit_rate;
+    stats->cur_bit_rate = encoder->bit_rate;
+
+    /* Use the compression level as a proxy for the quality */
+    stats->avg_quality = stats->cur_bit_rate ? 100.0 - raw_bit_rate / stats->cur_bit_rate : 0;
+    if (stats->avg_quality < 0) {
+        stats->avg_quality = 0;
+    }
+}
+
+VideoEncoder *gstreamer_encoder_new(uint64_t starting_bit_rate,
+                                    VideoEncoderRateControlCbs *cbs)
+{
+    GError *err = NULL;
+    if (!gst_init_check(NULL, NULL, &err)) {
+        spice_warning("GStreamer error: %s", err->message);
+        g_clear_error(&err);
+        return NULL;
+    }
+
+    SpiceGstEncoder *encoder = spice_new0(SpiceGstEncoder, 1);
+    encoder->base.destroy = spice_gst_encoder_destroy;
+    encoder->base.encode_frame = spice_gst_encoder_encode_frame;
+    encoder->base.client_stream_report = spice_gst_encoder_client_stream_report;
+    encoder->base.notify_server_frame_drop = spice_gst_encoder_notify_server_frame_drop;
+    encoder->base.get_bit_rate = spice_gst_encoder_get_bit_rate;
+    encoder->base.get_stats = spice_gst_encoder_get_stats;
+
+    if (cbs) {
+        encoder->cbs = *cbs;
+    }
+    encoder->starting_bit_rate = starting_bit_rate;
+
+    /* All the other fields are initialized to zero by spice_new0(). */
+
+    if (!create_pipeline(encoder)) {
+        /* Some GStreamer dependency is probably missing */
+        free(encoder);
+        encoder = NULL;
+    }
+    return (VideoEncoder*)encoder;
+}
diff --git a/server/stream.c b/server/stream.c
index e100a3c..27e4e80 100644
--- a/server/stream.c
+++ b/server/stream.c
@@ -706,6 +706,20 @@ static void update_client_playback_delay(void *opaque, uint32_t delay_ms)
                                         agent->dcc->streams_max_latency);
 }
 
+/* A helper for dcc_create_stream(). */
+static VideoEncoder* dcc_create_video_encoder(uint64_t starting_bit_rate,
+                                              VideoEncoderRateControlCbs *cbs)
+{
+#ifdef HAVE_GSTREAMER_1_0
+    VideoEncoder* video_encoder = gstreamer_encoder_new(starting_bit_rate, cbs);
+    if (video_encoder) {
+        return video_encoder;
+    }
+#endif
+    /* Use the builtin MJPEG video encoder as a fallback */
+    return mjpeg_encoder_new(starting_bit_rate, cbs);
+}
+
 void dcc_create_stream(DisplayChannelClient *dcc, Stream *stream)
 {
     StreamAgent *agent = &dcc->stream_agents[get_stream_id(DCC_TO_DC(dcc), stream)];
@@ -733,9 +747,9 @@ void dcc_create_stream(DisplayChannelClient *dcc, Stream *stream)
         video_cbs.update_client_playback_delay = update_client_playback_delay;
 
         initial_bit_rate = get_initial_bit_rate(dcc, stream);
-        agent->video_encoder = mjpeg_encoder_new(initial_bit_rate, &video_cbs);
+        agent->video_encoder = dcc_create_video_encoder(initial_bit_rate, &video_cbs);
     } else {
-        agent->video_encoder = mjpeg_encoder_new(0, NULL);
+        agent->video_encoder = dcc_create_video_encoder(0, NULL);
     }
     red_channel_client_pipe_add(RED_CHANNEL_CLIENT(dcc), stream_create_item_new(agent));
 
diff --git a/server/video-encoder.h b/server/video-encoder.h
index 7e06a13..708432b 100644
--- a/server/video-encoder.h
+++ b/server/video-encoder.h
@@ -45,7 +45,7 @@ struct VideoEncoder {
      *
      * @encoder:       The video encoder.
      * @frame_mm_time: The frame's mm-time timestamp in milliseconds.
-     * @bitmap:        The Spice screen.
+     * @bitmap:        A bitmap containing the source video frame.
      * @src:           A rectangle specifying the area occupied by the video.
      * @top_down:      If true the first video line is specified by src.top.
      * @outbuf:        The buffer for the compressed frame. This must either
@@ -160,5 +160,9 @@ typedef struct VideoEncoderRateControlCbs {
  */
 VideoEncoder* mjpeg_encoder_new(uint64_t starting_bit_rate,
                                 VideoEncoderRateControlCbs *cbs);
+#ifdef HAVE_GSTREAMER_1_0
+VideoEncoder* gstreamer_encoder_new(uint64_t starting_bit_rate,
+                                    VideoEncoderRateControlCbs *cbs);
+#endif
 
 #endif
-- 
2.8.1

_______________________________________________
Spice-devel mailing list
Spice-devel@xxxxxxxxxxxxxxxxxxxxx
https://lists.freedesktop.org/mailman/listinfo/spice-devel




[Index of Archives]     [Linux ARM Kernel]     [Linux ARM]     [Linux Omap]     [Fedora ARM]     [IETF Annouce]     [Security]     [Bugtraq]     [Linux]     [Linux OMAP]     [Linux MIPS]     [ECOS]     [Asterisk Internet PBX]     [Linux API]     [Monitors]