GIT_SILENT made messages (after extraction)

Added a new page to config dialog: "Screen capture", allowing to choose a framebuffer plugin.
Added a brief description about xcb and qt plugins.
Changed an icon for first tab "Network" to more appropriate one.
Code is prepared to expect "x11" as preferredFramebufferPlugin and automatically change this setting to "xcb".
Do not hardcode possible list of framebuffer plugins in combobox, but instead find actual available plugins at runtime.
If preferred plugin has changed in settings, inform user that krfb needs to be restarted to apply changes.

Differential Revision: https://phabricator.kde.org/D6319

CMakeLists.txt

@@ -31,10 +31,21 @@ find_package(KF5 REQUIRED COMPONENTS
 
 find_package(X11 REQUIRED)
 
+find_package(XCB REQUIRED COMPONENTS
+    XCB
+    RENDER
+    SHAPE
+    XFIXES
+    DAMAGE
+    SHM
+    IMAGE
+)
+
 if(WIN32)
     set(CMAKE_REQUIRED_LIBRARIES ${KDEWIN32_LIBRARIES})
     set(CMAKE_REQUIRED_INCLUDES  ${KDEWIN32_INCLUDES})
 endif(WIN32)
+
 add_definitions(${QT_DEFINITIONS} ${QT_QTDBUS_DEFINITIONS})
 add_definitions(-DQT_USE_FAST_CONCATENATION -DQT_USE_FAST_OPERATOR_PLUS)
 include_directories(${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR} )
@@ -46,16 +57,6 @@ set(CMAKE_MODULE_PATH
 
 find_package(LibVNCServer REQUIRED)
 
-if (HAVE_XDAMAGE)
-set(X11_Xdamage_FOUND 1)
-else()
-set(X11_Xdamage_FOUND 0)
-endif()
-if (HAVE_XSHM)
-set(X11_XShm_FOUND 1)
-else()
-set(X11_XShm_FOUND 0)
-endif()
 
 include_directories ("${CMAKE_CURRENT_BINARY_DIR}/krfb"
                      "${CMAKE_CURRENT_SOURCE_DIR}/krfb"

framebuffers/CMakeLists.txt

@@ -1,3 +1,5 @@
 add_subdirectory (qt)
-add_subdirectory (x11)
 
+if (${XCB_DAMAGE_FOUND} AND ${XCB_SHM_FOUND} AND ${XCB_IMAGE_FOUND})
+add_subdirectory (xcb)
+endif()

framebuffers/qt/krfb_framebuffer_qt.json

@@ -8,6 +8,7 @@
         "Description[cs]": "Framebuffer založený na Qt pro KRfb.",
         "Description[da]": "Qt-baseret framebuffer til KRfb.",
         "Description[de]": "Qt-basierter Framebuffer für KRfb",
+        "Description[el]": "Μνήμη ανανέωσης βίντεο με βάση τhn Qt για το KRfb.",
         "Description[es]": "Framebuffer basado en Qt para KRfb.",
         "Description[et]": "KRfb Qt põhine kaadripuhver",
         "Description[fi]": "QT-perustainen Kehyspuskuri KRfb:lle",
@@ -44,6 +45,7 @@
         "Name[cs]": "Qt Framebuffer pro KRfb",
         "Name[da]": "Qt-framebuffer til KRfb",
         "Name[de]": "Qt-Framebuffer für KRfb",
+        "Name[el]": "Μνήμη ανανέωσης βίντεο Qt για το KRfb",
         "Name[es]": "Framebuffer de Qt para KRfb",
         "Name[et]": "KRfb Qt kaadripuhver",
         "Name[fi]": "QT-kehyspuskuri KRfb:lle",

framebuffers/x11/CMakeLists.txt

@@ -1,27 +0,0 @@
-include_directories (${CMAKE_CURRENT_SOURCE_DIR}
-                     ${CMAKE_CURRENT_BINARY_DIR}
-)
-
-set (krfb_framebuffer_x11_SRCS
-     x11framebuffer.cpp
-     x11framebufferplugin.cpp
-)
-
-add_library(krfb_framebuffer_x11
- MODULE 
-                 ${krfb_framebuffer_x11_SRCS}
-)
-
-target_link_libraries (krfb_framebuffer_x11
-                       Qt5::Core
-                       Qt5::Gui
-                       ${X11_X11_LIB}
-                       ${X11_Xdamage_LIB}
-                       ${X11_Xext_LIB}
-                       KF5::CoreAddons
-                       krfbprivate
-)
-
-install (TARGETS krfb_framebuffer_x11
-         DESTINATION ${PLUGIN_INSTALL_DIR}/krfb
-)

framebuffers/x11/x11framebuffer.cpp

@@ -1,389 +0,0 @@
-/* This file is part of the KDE project
-   Copyright (C) 2007 Alessandro Praduroux <pradu@pradu.it>
-
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-*/
-
-#include "x11framebuffer.h"
-#include "x11framebuffer.moc"
-
-#include <config-krfb.h>
-
-#include <QX11Info>
-#include <QApplication>
-#include <QDesktopWidget>
-
-#include <QDebug>
-
-#include <X11/Xlib.h>
-#include <X11/Xutil.h>
-
-#ifdef HAVE_XDAMAGE
-#include <X11/extensions/Xdamage.h>
-#endif
-
-#ifdef HAVE_XSHM
-#include <sys/ipc.h>
-#include <sys/shm.h>
-#include <X11/extensions/XShm.h>
-#endif
-
-class X11FrameBuffer::P
-{
-
-public:
-#ifdef HAVE_XDAMAGE
-    Damage damage;
-#endif
-#ifdef HAVE_XSHM
-    XShmSegmentInfo shminfo;
-#endif
-
-    XImage *framebufferImage;
-    XImage *updateTile;
-    EvWidget *ev;
-    bool useShm;
-    int xdamageBaseEvent;
-    bool running;
-};
-
-X11FrameBuffer::X11FrameBuffer(WId id, QObject *parent)
-    : FrameBuffer(id, parent), d(new X11FrameBuffer::P)
-{
-#ifdef HAVE_XSHM
-    d->useShm = XShmQueryExtension(QX11Info::display());
-    //qDebug() << "shm: " << d->useShm;
-#else
-    d->useShm = false;
-#endif
-    d->running = false;
-    d->framebufferImage = XGetImage(QX11Info::display(),
-                                    id,
-                                    0,
-                                    0,
-                                    QApplication::desktop()->width(), //arg, must get a widget ???
-                                    QApplication::desktop()->height(),
-                                    AllPlanes,
-                                    ZPixmap);
-
-    if (d->useShm) {
-#ifdef HAVE_XSHM
-        d->updateTile = XShmCreateImage(QX11Info::display(),
-                                        DefaultVisual(QX11Info::display(), 0),
-                                        d->framebufferImage->bits_per_pixel,
-                                        ZPixmap,
-                                        NULL,
-                                        &d->shminfo,
-                                        32,
-                                        32);
-        d->shminfo.shmid = shmget(IPC_PRIVATE,
-                                  d->updateTile->bytes_per_line * d->updateTile->height,
-                                  IPC_CREAT | 0777);
-
-        d->shminfo.shmaddr = d->updateTile->data = (char *)
-                             shmat(d->shminfo.shmid, 0, 0);
-        d->shminfo.readOnly = False;
-
-        XShmAttach(QX11Info::display(), &d->shminfo);
-#endif
-    } else {
-        ;
-    }
-
-    qDebug() << "Got image. bpp: " << d->framebufferImage->bits_per_pixel
-             << ", depth: " << d->framebufferImage->depth
-             << ", padded width: " << d->framebufferImage->bytes_per_line
-             << " (sent: " << d->framebufferImage->width * 4 << ")"
-             << endl;
-
-    fb = d->framebufferImage->data;
-#ifdef HAVE_XDAMAGE
-    d->ev = new EvWidget(this);
-    qApp->installX11EventFilter(d->ev);
-#endif
-}
-
-
-X11FrameBuffer::~X11FrameBuffer()
-{
-    XDestroyImage(d->framebufferImage);
-#ifdef HAVE_XDAMAGE
-    qApp->removeX11EventFilter(d->ev);
-#endif
-#ifdef HAVE_XSHM
-    XShmDetach(QX11Info::display(), &d->shminfo);
-    XDestroyImage(d->updateTile);
-    shmdt(d->shminfo.shmaddr);
-    shmctl(d->shminfo.shmid, IPC_RMID, 0);
-#endif
-    delete d;
-    fb = 0; // already deleted by XDestroyImage
-}
-
-
-int X11FrameBuffer::depth()
-{
-    return d->framebufferImage->depth;
-}
-
-int X11FrameBuffer::height()
-{
-    return d->framebufferImage->height;
-}
-
-int X11FrameBuffer::width()
-{
-    return d->framebufferImage->width;
-}
-
-int X11FrameBuffer::paddedWidth()
-{
-    return d->framebufferImage->bytes_per_line;
-}
-
-void X11FrameBuffer::getServerFormat(rfbPixelFormat &format)
-{
-    format.bitsPerPixel = d->framebufferImage->bits_per_pixel;
-    format.depth = d->framebufferImage->depth;
-    format.trueColour = true;
-    format.bigEndian = ((d->framebufferImage->bitmap_bit_order == MSBFirst) ? true : false);
-
-    if (format.bitsPerPixel == 8) {
-        format.redShift = 0;
-        format.greenShift = 3;
-        format.blueShift = 6;
-        format.redMax   = 7;
-        format.greenMax = 7;
-        format.blueMax  = 3;
-    } else {
-        format.redShift = 0;
-
-        if (d->framebufferImage->red_mask)
-            while (!(d->framebufferImage->red_mask & (1 << format.redShift))) {
-                format.redShift++;
-            }
-
-        format.greenShift = 0;
-
-        if (d->framebufferImage->green_mask)
-            while (!(d->framebufferImage->green_mask & (1 << format.greenShift))) {
-                format.greenShift++;
-            }
-
-        format.blueShift = 0;
-
-        if (d->framebufferImage->blue_mask)
-            while (!(d->framebufferImage->blue_mask & (1 << format.blueShift))) {
-                format.blueShift++;
-            }
-
-        format.redMax   = d->framebufferImage->red_mask   >> format.redShift;
-        format.greenMax = d->framebufferImage->green_mask >> format.greenShift;
-        format.blueMax  = d->framebufferImage->blue_mask  >> format.blueShift;
-    }
-}
-
-void X11FrameBuffer::handleXDamage(XEvent *event)
-{
-#ifdef HAVE_XDAMAGE
-    XDamageNotifyEvent *dev = (XDamageNotifyEvent *)event;
-    QRect r(dev->area.x, dev->area.y, dev->area.width, dev->area.height);
-    tiles.append(r);
-
-    /*if (!dev->more) {
-        XDamageSubtract(QX11Info::display(),d->damage, None, None);
-    }*/
-#endif
-}
-
-
-void X11FrameBuffer::cleanupRects()
-{
-
-    QList<QRect> cpy = tiles;
-    bool inserted = false;
-    tiles.clear();
-//     //qDebug() << "before cleanup: " << cpy.size();
-    foreach(const QRect & r, cpy) {
-        if (tiles.size() > 0) {
-            for (int i = 0; i < tiles.size(); i++) {
-                //             //qDebug() << r << tiles[i];
-                if (r.intersects(tiles[i])) {
-                    tiles[i] |= r;
-                    inserted = true;
-                    break;
-                    //                 //qDebug() << "merged into " << tiles[i];
-                }
-            }
-
-            if (!inserted) {
-                tiles.append(r);
-                //             //qDebug() << "appended " << r;
-            }
-        } else {
-            //         //qDebug() << "appended " << r;
-            tiles.append(r);
-        }
-    }
-
-    for (int i = 0; i < tiles.size(); i++) {
-        tiles[i].adjust(-30, -30, 30, 30);
-
-        if (tiles[i].top() < 0) {
-            tiles[i].setTop(0);
-        }
-
-        if (tiles[i].left() < 0) {
-            tiles[i].setLeft(0);
-        }
-
-        if (tiles[i].bottom() > d->framebufferImage->height) {
-            tiles[i].setBottom(d->framebufferImage->height);
-        }
-
-        if (tiles[i].right() > d->framebufferImage->width) {
-            tiles[i].setRight(d->framebufferImage->width);
-        }
-    }
-
-//     //qDebug() << "after cleanup: " << tiles.size();
-}
-
-void X11FrameBuffer::acquireEvents()
-{
-
-    XEvent ev;
-
-#ifdef HAVE_XDAMAGE
-    while (XCheckTypedEvent(QX11Info::display(), d->xdamageBaseEvent + XDamageNotify, &ev)) {
-        handleXDamage(&ev);
-    }
-
-    XDamageSubtract(QX11Info::display(), d->damage, None, None);
-#endif
-}
-
-QList< QRect > X11FrameBuffer::modifiedTiles()
-{
-    QList<QRect> ret;
-
-    if (!d->running) {
-        return ret;
-    }
-
-    qApp->processEvents(); // try to make sure every damage event goes trough;
-    cleanupRects();
-    QRect gl;
-
-    //d->useShm = false;
-    if (tiles.size()  > 0) {
-        if (d->useShm) {
-#ifdef HAVE_XSHM
-
-            foreach(const QRect & r, tiles) {
-//                 //qDebug() << r;
-                gl |= r;
-                int y = r.y();
-                int x = r.x();
-
-                while (x < r.right()) {
-                    while (y < r.bottom()) {
-                        if (y + d->updateTile->height > d->framebufferImage->height) {
-                            y = d->framebufferImage->height - d->updateTile->height;
-                        }
-
-                        if (x + d->updateTile->width > d->framebufferImage->width) {
-                            x = d->framebufferImage->width - d->updateTile->width;
-                        }
-
-//                         //qDebug() << "x: " << x << " (" << r.x() << ") y: " << y << " (" << r.y() << ") " << r;
-                        XShmGetImage(QX11Info::display(), win, d->updateTile, x, y, AllPlanes);
-                        int pxsize =  d->framebufferImage->bits_per_pixel / 8;
-                        char *dest = fb + ((d->framebufferImage->bytes_per_line * y) + (x * pxsize));
-                        char *src = d->updateTile->data;
-
-                        for (int i = 0; i < d->updateTile->height; i++) {
-                            memcpy(dest, src, d->updateTile->bytes_per_line);
-                            dest += d->framebufferImage->bytes_per_line;
-                            src += d->updateTile->bytes_per_line;
-                        }
-
-                        y += d->updateTile->height;
-                    }
-
-                    x += d->updateTile->width;
-                    y = r.y();
-                }
-            }
-#endif
-        } else {
-            foreach(const QRect & r, tiles) {
-                XGetSubImage(QX11Info::display(),
-                             win,
-                             r.left(),
-                             r.top(),
-                             r.width(),
-                             r.height(),
-                             AllPlanes,
-                             ZPixmap,
-                             d->framebufferImage,
-                             r.left(),
-                             r.top()
-                            );
-            }
-        }
-    }
-
-//     //qDebug() << "tot: " << gl;
-//     //qDebug() << tiles.size();
-    ret = tiles;
-    tiles.clear();
-    return ret;
-}
-
-void X11FrameBuffer::startMonitor()
-{
-    d->running = true;
-#ifdef HAVE_XDAMAGE
-    d->damage = XDamageCreate(QX11Info::display(), win, XDamageReportRawRectangles);
-    XDamageSubtract(QX11Info::display(), d->damage, None, None);
-#endif
-}
-
-void X11FrameBuffer::stopMonitor()
-{
-    d->running = false;
-#ifdef HAVE_XDAMAGE
-    XDamageDestroy(QX11Info::display(), d->damage);
-#endif
-}
-
-
-
-EvWidget::EvWidget(X11FrameBuffer *x11fb)
-    : QWidget(0), fb(x11fb)
-{
-#ifdef HAVE_XDAMAGE
-    int er;
-    XDamageQueryExtension(QX11Info::display(), &xdamageBaseEvent, &er);
-#endif
-}
-
-bool EvWidget::x11Event(XEvent *event)
-{
-#ifdef HAVE_XDAMAGE
-
-    if (event->type == xdamageBaseEvent + XDamageNotify) {
-        fb->handleXDamage(event);
-        return true;
-    }
-
-#endif
-    return false;
-}
-
-
-

framebuffers/x11/x11framebuffer.h

@@ -1,63 +0,0 @@
-/* This file is part of the KDE project
-   Copyright (C) 2007 Alessandro Praduroux <pradu@pradu.it>
-
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-*/
-#ifndef KRFB_FRAMEBUFFER_X11_X11FRAMEBUFFER_H
-#define KRFB_FRAMEBUFFER_X11_X11FRAMEBUFFER_H
-
-#include <framebuffer.h>
-#include <QWidget>
-
-class X11FrameBuffer;
-typedef union _XEvent XEvent;
-
-class EvWidget: public QWidget
-{
-    Q_OBJECT
-
-public:
-    EvWidget(X11FrameBuffer *x11fb);
-
-protected:
-    bool x11Event(XEvent *event);
-
-private:
-    X11FrameBuffer *fb;
-    int xdamageBaseEvent;
-};
-
-/**
-    @author Alessandro Praduroux <pradu@pradu.it>
-*/
-class X11FrameBuffer : public FrameBuffer
-{
-    Q_OBJECT
-public:
-    X11FrameBuffer(WId id, QObject *parent = 0);
-
-    ~X11FrameBuffer();
-
-    QList<QRect> modifiedTiles() override;
-    int depth() override;
-    int height() override;
-    int width() override;
-    int paddedWidth() override;
-    void getServerFormat(rfbPixelFormat &format) override;
-    void startMonitor() override;
-    void stopMonitor() override;
-
-
-    void handleXDamage(XEvent *event);
-private:
-    void cleanupRects();
-    void acquireEvents();
-
-    class P;
-    P *const d;
-};
-
-#endif

framebuffers/x11/x11framebufferplugin.cpp

@@ -1,45 +0,0 @@
-/* This file is part of the KDE project
-   Copyright (C) 2009 Collabora Ltd <info@collabora.co.uk>
-    @author George Goldberg <george.goldberg@collabora.co.uk>
-
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-
-   This program 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
-   General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; see the file COPYING.  If not, write to
-   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-   Boston, MA 02110-1301, USA.
-*/
-
-#include "x11framebufferplugin.h"
-
-#include "x11framebuffer.h"
-
-#include <KPluginFactory>
-
-K_PLUGIN_FACTORY_WITH_JSON(X11FrameBufferPluginFactory, "krfb_framebuffer_x11.json",
-			   registerPlugin<X11FrameBufferPlugin>();)
-
-X11FrameBufferPlugin::X11FrameBufferPlugin(QObject *parent, const QVariantList &args)
-    : FrameBufferPlugin(parent, args)
-{
-}
-
-X11FrameBufferPlugin::~X11FrameBufferPlugin()
-{
-}
-
-FrameBuffer *X11FrameBufferPlugin::frameBuffer(WId id)
-{
-    return new X11FrameBuffer(id);
-}
-
-#include "x11framebufferplugin.moc"
-

framebuffers/x11/x11framebufferplugin.h

@@ -1,46 +0,0 @@
-/* This file is part of the KDE project
-   Copyright (C) 2009 Collabora Ltd <info@collabora.co.uk>
-    @author George Goldberg <george.goldberg@collabora.co.uk>
-
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public
-   License as published by the Free Software Foundation; either
-   version 2 of the License, or (at your option) any later version.
-
-   This program 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
-   General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; see the file COPYING.  If not, write to
-   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-   Boston, MA 02110-1301, USA.
-*/
-
-#ifndef KRFB_FRAMEBUFFER_X11_X11FRAMEBUFFERPLUGIN_H
-#define KRFB_FRAMEBUFFER_X11_X11FRAMEBUFFERPLUGIN_H
-
-#include "framebufferplugin.h"
-
-#include <QWidget>
-
-class FrameBuffer;
-
-class X11FrameBufferPlugin : public FrameBufferPlugin
-{
-    Q_OBJECT
-
-public:
-    X11FrameBufferPlugin(QObject *parent, const QVariantList &args);
-    virtual ~X11FrameBufferPlugin();
-
-    FrameBuffer *frameBuffer(WId id) override;
-
-private:
-    Q_DISABLE_COPY(X11FrameBufferPlugin)
-};
-
-
-#endif  // Header guard
-

framebuffers/xcb/CMakeLists.txt

@@ -0,0 +1,28 @@
+include_directories (${CMAKE_CURRENT_SOURCE_DIR}
+                     ${CMAKE_CURRENT_BINARY_DIR}
+)
+
+set (krfb_framebuffer_xcb_SRCS
+      xcb_framebufferplugin.cpp
+      xcb_framebuffer.cpp
+)
+
+add_library(krfb_framebuffer_xcb MODULE ${krfb_framebuffer_xcb_SRCS})
+
+target_link_libraries (krfb_framebuffer_xcb
+                       Qt5::Core
+                       Qt5::Gui
+                       XCB::XCB
+                       XCB::RENDER
+                       XCB::SHAPE
+                       XCB::XFIXES
+                       XCB::DAMAGE
+                       XCB::SHM
+                       XCB::IMAGE
+                       KF5::CoreAddons
+                       krfbprivate
+)
+
+install (TARGETS krfb_framebuffer_xcb
+         DESTINATION ${PLUGIN_INSTALL_DIR}/krfb
+)

framebuffers/xcb/krfb_framebuffer_xcb.desktop

@@ -99,8 +99,8 @@ Name[zh_TW]=KRfb 的 X11 Framebuffer
 Type=Service
 ServiceTypes=krfb/framebuffer
 
-X-KDE-Library=krfb_framebuffer_x11
-X-KDE-PluginInfo-Name=x11
+X-KDE-Library=krfb_framebuffer_xcb
+X-KDE-PluginInfo-Name=xcb
 X-KDE-PluginInfo-Version=0.1
 X-KDE-PluginInfo-Website=http://www.kde.org
 X-KDE-PluginInfo-License=GPL

framebuffers/xcb/krfb_framebuffer_xcb.json

@@ -8,6 +8,7 @@
         "Description[cs]": "Framebuffer založený na X11 XDamage/XShm pro KRfb.",
         "Description[da]": "X11 XDamage/XShm-baseret framebuffer til KRfb.",
         "Description[de]": "X11 XDamage/XShm-basierter Framebuffer für KRfb.",
+        "Description[el]": "Μνήμη ανανέωσης βίντεο με βάση το X11 XDamage/XShm για το KRfb.",
         "Description[es]": "Framebuffer basado en XDamage/XShm de X11 para KRfb.",
         "Description[et]": "KRfb X11 XDamage/XShm põhine kaadripuhver",
         "Description[fi]": "X11 XDamage/XShm-perustainen kehyspuskui KRfb:lle.",
@@ -35,7 +36,7 @@
         "Description[zh_CN]": "KRfb 的基于 X11 XDamage/XShm 的帧缓冲。",
         "Description[zh_TW]": "KRfb 的 X11 XDamage/XShm based Framebuffer",
         "EnabledByDefault": true,
-        "Id": "x11",
+        "Id": "xcb",
         "License": "GPL",
         "Name": "X11 Framebuffer for KRfb",
         "Name[ast]": "Búfer de cuadros de X11 pa KRfb",
@@ -44,6 +45,7 @@
         "Name[cs]": "X11 Framebuffer pro KRfb",
         "Name[da]": "X11-framebuffer til KRfb",
         "Name[de]": "X11-Framebuffer für KRfb",
+        "Name[el]": "Μνήμη ανανέωσης βίντεο X11 για το KRfb.",
         "Name[es]": "Framebuffer X11 para KRfb",
         "Name[et]": "KRfb X11 kaadripuhver",
         "Name[fi]": "X11-kehyspuskuri KRfb:lle",

framebuffers/xcb/xcb_framebuffer.cpp

@@ -0,0 +1,685 @@
+/* This file is part of the KDE project
+   Copyright (C) 2017 Alexey Min <alexey.min@gmail.com>
+
+   This program is free software; you can redistribute it and/or
+   modify it under the terms of the GNU General Public
+   License as published by the Free Software Foundation; either
+   version 2 of the License, or (at your option) any later version.
+*/
+
+#include "xcb_framebuffer.h"
+#include "xcb_framebuffer.moc"
+
+#include <xcb/xcb.h>
+#include <xcb/xproto.h>
+#include <xcb/damage.h>
+#include <xcb/shm.h>
+#include <xcb/xcb_image.h>
+
+#include <sys/ipc.h>
+#include <sys/shm.h>
+
+#include <QX11Info>
+#include <QCoreApplication>
+#include <QGuiApplication>
+#include <QScreen>
+#include <QAbstractNativeEventFilter>
+#include <QDebug>
+
+
+class KrfbXCBEventFilter: public QAbstractNativeEventFilter
+{
+public:
+    KrfbXCBEventFilter(XCBFrameBuffer *owner);
+
+public:
+    virtual bool nativeEventFilter(const QByteArray &eventType, void *message, long *result);
+
+public:
+    int xdamageBaseEvent;
+    int xdamageBaseError;
+    int xshmBaseEvent;
+    int xshmBaseError;
+    bool xshmAvail;
+    XCBFrameBuffer *fb_owner;
+};
+
+
+
+KrfbXCBEventFilter::KrfbXCBEventFilter(XCBFrameBuffer *owner):
+    xdamageBaseEvent(0), xdamageBaseError(0),
+    xshmBaseEvent(0), xshmBaseError(0), xshmAvail(false),
+    fb_owner(owner)
+{
+    const xcb_query_extension_reply_t *xdamage_data = xcb_get_extension_data(
+                QX11Info::connection(), &xcb_damage_id);
+    if (xdamage_data) {
+        // also query extension version!
+        // ATTENTION: if we don't do that, xcb_damage_create() will always FAIL!
+        xcb_damage_query_version_reply_t *xdamage_version = xcb_damage_query_version_reply(
+                    QX11Info::connection(),
+                    xcb_damage_query_version(
+                        QX11Info::connection(),
+                        XCB_DAMAGE_MAJOR_VERSION,
+                        XCB_DAMAGE_MINOR_VERSION),
+                    NULL);
+        if (!xdamage_version) {
+            qWarning() << "xcb framebuffer: ERROR: Failed to get XDamage extension version!\n";
+            return;
+        }
+
+#ifdef _DEBUG
+        qDebug() << "xcb framebuffer: XDamage extension version:" <<
+               xdamage_version->major_version << "." << xdamage_version->minor_version;
+#endif
+
+        free(xdamage_version);
+
+        xdamageBaseEvent = xdamage_data->first_event;
+        xdamageBaseError = xdamage_data->first_error;
+
+        // XShm presence is optional. If it is present, all image getting
+        // operations will be faster, without XShm it will only be slower.
+        const xcb_query_extension_reply_t *xshm_data = xcb_get_extension_data(
+                    QX11Info::connection(), &xcb_shm_id);
+        if (xshm_data) {
+            xshmAvail = true;
+            xshmBaseEvent = xshm_data->first_event;
+            xshmBaseError = xshm_data->first_error;
+        } else {
+            xshmAvail = false;
+            qWarning() << "xcb framebuffer: WARNING: XSHM extension not available!";
+        }
+    } else {
+        // if there is no xdamage available, this plugin can be considered useless anyway.
+        // you can use just qt framebuffer plugin instead...
+        qWarning() << "xcb framebuffer: ERROR: no XDamage extension available. I am useless.";
+        qWarning() << "xcb framebuffer:        use qt framebuffer plugin instead.";
+    }
+}
+
+
+bool KrfbXCBEventFilter::nativeEventFilter(const QByteArray &eventType,
+                                           void *message, long *result) {
+    Q_UNUSED(result);  // "result" is only used on windows
+
+    if (xdamageBaseEvent == 0) return false;  // no xdamage extension
+
+    if (eventType == "xcb_generic_event_t") {
+        xcb_generic_event_t* ev = static_cast<xcb_generic_event_t *>(message);
+        if ((ev->response_type & 0x7F) == (xdamageBaseEvent + XCB_DAMAGE_NOTIFY)) {
+            // this is xdamage notification
+            this->fb_owner->handleXDamageNotify(ev);
+            return true;  // filter out this event, stop its processing
+        }
+    }
+
+    // continue event processing
+    return false;
+}
+
+
+class XCBFrameBuffer::P {
+public:
+    xcb_damage_damage_t     damage;
+    xcb_shm_segment_info_t  shminfo;
+    xcb_screen_t           *rootScreen;   // X screen info (all monitors)
+    xcb_image_t            *framebufferImage;
+    xcb_image_t            *updateTile;
+
+    KrfbXCBEventFilter     *x11EvtFilter;
+
+    bool                    running;
+
+    QRect                   area;  // capture area, primary monitor coordinates
+};
+
+
+static xcb_screen_t *get_xcb_screen(xcb_connection_t *conn, int screen_num) {
+    xcb_screen_t *screen = NULL;
+    xcb_screen_iterator_t screens_iter = xcb_setup_roots_iterator(xcb_get_setup(conn));
+    for (; screens_iter.rem; --screen_num, xcb_screen_next(&screens_iter))
+        if (screen_num == 0)
+            screen = screens_iter.data;
+    return screen;
+}
+
+
+
+XCBFrameBuffer::XCBFrameBuffer(WId winid, QObject *parent):
+    FrameBuffer(winid, parent), d(new XCBFrameBuffer::P)
+{
+    d->running = false;
+    d->damage = XCB_NONE;
+    d->framebufferImage = Q_NULLPTR;
+    d->shminfo.shmaddr = Q_NULLPTR;
+    d->shminfo.shmid = XCB_NONE;
+    d->shminfo.shmseg = XCB_NONE;
+    d->updateTile = Q_NULLPTR;
+    d->area.setRect(0, 0, 0, 0);
+    d->x11EvtFilter = new KrfbXCBEventFilter(this);
+    d->rootScreen = get_xcb_screen(QX11Info::connection(), QX11Info::appScreen());
+
+    this->fb = Q_NULLPTR;
+
+    QScreen *primaryScreen = QGuiApplication::primaryScreen();
+    if (primaryScreen) {
+        qDebug() << "xcb framebuffer: Primary screen: " << primaryScreen->name()
+                 << ", geometry: " << primaryScreen->geometry()
+                 << ", depth: " << primaryScreen->depth();
+        //
+        d->area = primaryScreen->geometry();
+    } else {
+        qWarning() << "xcb framebuffer: ERROR: Failed to get application's primary screen info!";
+        return;
+    }
+
+    d->framebufferImage = xcb_image_get(QX11Info::connection(),
+                                        this->win,
+                                        d->area.left(),
+                                        d->area.top(),
+                                        d->area.width(),
+                                        d->area.height(),
+                                        0xFFFFFFFF, // == Xlib: AllPlanes ((unsigned long)~0L)
+                                        XCB_IMAGE_FORMAT_Z_PIXMAP);
+    if (d->framebufferImage) {
+#ifdef _DEBUG
+        qDebug() << "xcb framebuffer: Got primary screen image. bpp: " << d->framebufferImage->bpp
+                 << ", size (" << d->framebufferImage->width << d->framebufferImage->height << ")"
+                 << ", depth: " << d->framebufferImage->depth
+                 << ", padded width: " << d->framebufferImage->stride;
+#endif
+        this->fb = (char *)d->framebufferImage->data;
+    } else {
+        qWarning() << "xcb framebuffer: ERROR: Failed to get primary screen image!";
+        return;
+    }
+
+    // all XShm operations should take place only if Xshm extension was loaded
+    if (d->x11EvtFilter->xshmAvail) {
+        // Create xcb_image_t structure, but do not automatically allocate memory
+        // for image data storage - it will be allocated as shared memory.
+        // "If base == 0 and bytes == ~0 and data == 0, no storage will be auto-allocated."
+        // Width and height of the image = size of the capture area.
+        d->updateTile = xcb_image_create_native(
+                    QX11Info::connection(),
+                    d->area.width(),            // width
+                    d->area.height(),           // height
+                    XCB_IMAGE_FORMAT_Z_PIXMAP,  // image format
+                    d->rootScreen->root_depth,  // depth
+                    NULL,                       // base address = 0
+                    (uint32_t)~0,               // bytes = 0xffffffff
+                    NULL);                      // data = 0
+        if (d->updateTile) {
+#ifdef _DEBUG
+            qDebug() << "xcb framebuffer: Successfully created new empty image in native format";
+            qDebug() << "    size: " << d->updateTile->width << "x" << d->updateTile->height
+                     << "(stride: " << d->updateTile->stride << ")";
+            qDebug() << "    bpp, depth:  " << d->updateTile->bpp << d->updateTile->depth; // 32, 24
+            qDebug() << "    addr of base, data:  " << d->updateTile->base << (void *)d->updateTile->data;
+            qDebug() << "    size:  " << d->updateTile->size;
+            qDebug() << "    image byte order = " << d->updateTile->byte_order;  // == 0 .._LSB_FIRST
+            qDebug() << "    image bit order = " << d->updateTile->bit_order;    // == 1 .._MSB_FIRST
+            qDebug() << "    image plane_mask = " << d->updateTile->plane_mask;  // == 16777215 == 0x00FFFFFF
+#endif
+
+            // allocate shared memory block only once, make its size large enough
+            // to fit whole capture area (d->area rect)
+            // so, we get as many bytes as needed for image (updateTile->size)
+            d->shminfo.shmid = shmget(IPC_PRIVATE, d->updateTile->size, IPC_CREAT | 0777);
+            // attached shared memory address is stored both in shminfo structure and in xcb_image_t->data
+            d->shminfo.shmaddr = (uint8_t *)shmat(d->shminfo.shmid, NULL, 0);
+            d->updateTile->data = d->shminfo.shmaddr;
+            // we keep updateTile->base == NULL here, so xcb_image_destroy() will not attempt
+            // to free this block, just in case.
+
+            // attach this shm segment also to X server
+            d->shminfo.shmseg = xcb_generate_id(QX11Info::connection());
+            xcb_shm_attach(QX11Info::connection(), d->shminfo.shmseg, d->shminfo.shmid, 0);
+
+#ifdef _DEBUG
+            qDebug() << "    shm id: " << d->shminfo.shmseg << ", addr: " << (void *)d->shminfo.shmaddr;
+#endif
+
+            // will return 1 on success (yes!)
+            int shmget_res = xcb_image_shm_get(
+                        QX11Info::connection(),
+                        this->win,
+                        d->updateTile,
+                        d->shminfo,
+                        d->area.left(), // x
+                        d->area.top(),  // y (size taken from image structure itself)?
+                        0xFFFFFFFF);
+
+            if (shmget_res == 0) {
+                // error! shared mem not working?
+                // will not use shared mem! detach and cleanup
+                xcb_shm_detach(QX11Info::connection(), d->shminfo.shmseg);
+                shmdt(d->shminfo.shmaddr);
+                shmctl(d->shminfo.shmid, IPC_RMID, 0); // mark shm segment as removed
+                d->x11EvtFilter->xshmAvail = false;
+                d->shminfo.shmaddr = Q_NULLPTR;
+                d->shminfo.shmid = XCB_NONE;
+                d->shminfo.shmseg = XCB_NONE;
+                qWarning() << "xcb framebuffer: ERROR: xcb_image_shm_get() result: " << shmget_res;
+            }
+
+            // image is freed, and recreated again for every new damage rectangle
+            // data was allocated manually and points to shared mem;
+            // tell xcb_image_destroy() do not free image data
+            d->updateTile->data = NULL;
+            xcb_image_destroy(d->updateTile);
+            d->updateTile = NULL;
+        }
+    }
+
+#ifdef _DEBUG
+    qDebug() << "xcb framebuffer: XCBFrameBuffer(), xshm base event = " << d->x11EvtFilter->xshmBaseEvent
+             << ", xshm base error = " << d->x11EvtFilter->xdamageBaseError
+             << ", xdamage base event = " << d->x11EvtFilter->xdamageBaseEvent
+             << ", xdamage base error = " << d->x11EvtFilter->xdamageBaseError;
+#endif
+
+    QCoreApplication::instance()->installNativeEventFilter(d->x11EvtFilter);
+}
+
+
+XCBFrameBuffer::~XCBFrameBuffer() {
+    // first - uninstall x11 event filter
+    QCoreApplication::instance()->removeNativeEventFilter(d->x11EvtFilter);
+    //
+    if (d->framebufferImage) {
+        xcb_image_destroy(d->framebufferImage);
+        fb = Q_NULLPTR;  // image data was already destroyed by above call
+    }
+    if (d->x11EvtFilter->xshmAvail) {
+        // detach shared memory
+        if (d->shminfo.shmseg != XCB_NONE)
+            xcb_shm_detach(QX11Info::connection(), d->shminfo.shmseg); // detach from X server
+        if (d->shminfo.shmaddr)
+            shmdt(d->shminfo.shmaddr); // detach addr from our address space
+        if (d->shminfo.shmid != XCB_NONE)
+            shmctl(d->shminfo.shmid, IPC_RMID, 0); // mark shm segment as removed
+    }
+    // and delete image used for shared mem
+    if (d->updateTile) {
+        d->updateTile->base = NULL;
+        d->updateTile->data = NULL;
+        xcb_image_destroy(d->updateTile);
+    }
+    // we don't use d->x11EvtFilter anymore, can delete it now
+    if (d->x11EvtFilter) {
+        delete d->x11EvtFilter;
+    }
+    delete d;
+}
+
+
+int XCBFrameBuffer::depth() {
+    if (d->framebufferImage) {
+        return d->framebufferImage->depth;
+    }
+    return 0;
+}
+
+
+int XCBFrameBuffer::height() {
+    if (d->framebufferImage) {
+        return d->framebufferImage->height;
+    }
+    return 0;
+}
+
+
+int XCBFrameBuffer::width() {
+    if (d->framebufferImage) {
+        return d->framebufferImage->width;
+    }
+    return 0;
+}
+
+int XCBFrameBuffer::paddedWidth() {
+    if (d->framebufferImage) {
+        return d->framebufferImage->stride;
+    }
+    return 0;
+}
+
+
+void XCBFrameBuffer::getServerFormat(rfbPixelFormat &format) {
+    if (!d->framebufferImage) return;
+
+    // get information about XCB visual params
+    xcb_visualtype_t *root_visualtype = NULL;  // visual info
+    if (d->rootScreen) {
+        xcb_visualid_t root_visual = d->rootScreen->root_visual;
+        xcb_depth_iterator_t depth_iter;
+        // To get the xcb_visualtype_t structure, it's a bit less easy.
+        // You have to get the xcb_screen_t structure that you want, get its
+        // root_visual member, then iterate over the xcb_depth_t's and the
+        // xcb_visualtype_t's, and compare the xcb_visualid_t of these
+        // xcb_visualtype_ts: with root_visual
+        depth_iter = xcb_screen_allowed_depths_iterator(d->rootScreen);
+        for (; depth_iter.rem; xcb_depth_next(&depth_iter)) {
+            xcb_visualtype_iterator_t visual_iter;
+            visual_iter = xcb_depth_visuals_iterator(depth_iter.data);
+            for (; visual_iter.rem; xcb_visualtype_next(&visual_iter)) {
+                if (root_visual == visual_iter.data->visual_id) {
+                    root_visualtype = visual_iter.data;
+                    break;
+                }
+            }
+        }
+    }
+
+
+    // fill in format common info
+    format.bitsPerPixel = d->framebufferImage->bpp;
+    format.depth = d->framebufferImage->depth;
+    format.trueColour = true;  // not using color palettes
+    format.bigEndian = false;  // always false for ZPIXMAP format!
+
+    // information about pixels layout
+
+    if (root_visualtype) {
+        uint16_t pixelmaxValue = (1 << root_visualtype->bits_per_rgb_value) - 1;
+
+#ifdef _DEBUG
+        qDebug("xcb framebuffer: Got info about root visual:\n"
+               "    bits per rgb value: %d\n"
+               "    red   mask: %08x\n"
+               "    green mask: %08x\n"
+               "    blue  mask: %08x\n"
+               "    pixelMaxValue = %d\n",
+               (int)root_visualtype->bits_per_rgb_value,
+               root_visualtype->red_mask,
+               root_visualtype->green_mask,
+               root_visualtype->blue_mask,
+               (int)pixelmaxValue);
+#endif
+
+        // calculate shifts
+        format.redShift = 0;
+        format.redMax = pixelmaxValue;
+        if (root_visualtype->red_mask) {
+            while (!(root_visualtype->red_mask & (1 << format.redShift))) {
+                format.redShift++;
+            }
+        }
+        format.greenShift = 0;
+        format.greenMax = pixelmaxValue;
+        if (root_visualtype->green_mask) {
+            while (!(root_visualtype->green_mask & (1 << format.greenShift))) {
+                format.greenShift++;
+            }
+        }
+        format.blueShift = 0;
+        format.blueMax = pixelmaxValue;
+        if (root_visualtype->blue_mask) {
+            while (!(root_visualtype->blue_mask & (1 << format.blueShift))) {
+                format.blueShift++;
+            }
+        }
+
+#ifdef _DEBUG
+        qDebug() << "    Calculated redShift   =" << (int)format.redShift;
+        qDebug() << "    Calculated greenShift =" << (int)format.greenShift;
+        qDebug() << "    Calculated blueShift  =" << (int)format.blueShift;
+#endif
+    } else {
+        // some kind of fallback (unlikely code execution will go this way)
+        // idea taken from qt framefuffer sources
+        if (format.bitsPerPixel == 8) {
+            format.redShift   = 0;
+            format.greenShift = 3;
+            format.blueShift  = 6;
+            format.redMax   = 7;
+            format.greenMax = 7;
+            format.blueMax  = 3;
+        } else if (format.bitsPerPixel == 16) {
+            // TODO: 16 bits per pixel format ??
+            // what format of pixels does X server use for 16-bpp?
+        } else if (format.bitsPerPixel == 32) {
+            format.redMax   = 0xff;
+            format.greenMax = 0xff;
+            format.blueMax  = 0xff;
+            if (format.bigEndian) {
+                format.redShift   = 0;
+                format.greenShift = 8;
+                format.blueShift  = 16;
+            } else {
+                format.redShift   = 16;
+                format.greenShift = 8;
+                format.blueShift  = 0;
+            }
+        }
+    }
+}
+
+
+/**
+ * This function contents was taken from X11 framebuffer source code.
+ * It simply several intersecting rectangles into one bigger rect.
+ * Non-intersecting rects are treated as different rects and exist
+ * separately in this->tiles QList.
+ */
+void XCBFrameBuffer::cleanupRects() {
+    QList<QRect> cpy = tiles;
+    bool inserted = false;
+    tiles.clear();
+
+    QListIterator<QRect> iter(cpy);
+    while (iter.hasNext()) {
+        const QRect &r = iter.next();
+        // skip rects not intersecting with primary monitor
+        if (!r.intersects(d->area)) continue;
+        // only take intersection of this rect with primary monitor rect
+        QRect ri = r.intersected(d->area);
+
+        if (tiles.size() > 0) {
+            for (int i = 0; i < tiles.size(); i++) {
+                // if current rect has intersection with tiles[i], unite them
+                if (ri.intersects(tiles[i])) {
+                    tiles[i] |= ri;
+                    inserted = true;
+                    break;
+                }
+            }
+
+            if (!inserted) {
+                // else, append to list as different rect
+                tiles.append(ri);
+            }
+        } else {
+            // tiles list is empty, append first item
+            tiles.append(ri);
+        }
+    }
+
+    // increase all rectangles size by 30 pixels each side.
+    // limit coordinates to primary monitor boundaries.
+    for (int i = 0; i < tiles.size(); i++) {
+        tiles[i].adjust(-30, -30, 30, 30);
+        if (tiles[i].top() < d->area.top()) {
+            tiles[i].setTop(d->area.top());
+        }
+        if (tiles[i].bottom() > d->area.bottom()) {
+            tiles[i].setBottom(d->area.bottom());
+        }
+        //
+        if (tiles[i].left() < d->area.left()) {
+            tiles[i].setLeft(d->area.left());
+        }
+        if (tiles[i].right() > d->area.right()) {
+            tiles[i].setRight(d->area.right());
+        }
+        // move update rects so that they are positioned relative to
+        //   framebuffer image, not whole screen
+        tiles[i].moveTo(tiles[i].left() - d->area.left(),
+                        tiles[i].top() - d->area.top());
+    }
+}
+
+
+/**
+ * This function is called by RfbServerManager::updateScreens()
+ * approximately every 50ms (!!), driven by QTimer to get all
+ * modified rectangles on the screen
+ */
+QList<QRect> XCBFrameBuffer::modifiedTiles() {
+    QList<QRect> ret;
+    if (!d->running) {
+        return ret;
+    }
+
+    cleanupRects();
+
+    if (tiles.size() > 0) {
+        if (d->x11EvtFilter->xshmAvail) {
+
+            // loop over all damage rectangles gathered up to this time
+            QListIterator<QRect> iter(tiles);
+            //foreach(const QRect &r, tiles) {
+            while (iter.hasNext()) {
+                const QRect &r = iter.next();
+
+                // get image data into shared memory segment
+                // now rects are positioned relative to framebufferImage,
+                // but we need to get image from the whole screen, so
+                // translate whe coordinates
+                xcb_shm_get_image_cookie_t sgi_cookie = xcb_shm_get_image(
+                            QX11Info::connection(),
+                            this->win,
+                            d->area.left() + r.left(),
+                            d->area.top()  + r.top(),
+                            r.width(),
+                            r.height(),
+                            0xFFFFFFFF,
+                            XCB_IMAGE_FORMAT_Z_PIXMAP,
+                            d->shminfo.shmseg,
+                            0);
+
+                xcb_shm_get_image_reply_t *sgi_reply = xcb_shm_get_image_reply(
+                            QX11Info::connection(), sgi_cookie, NULL);
+                if (sgi_reply) {
+                    // create temporary image to get update rect contents into
+                    d->updateTile = xcb_image_create_native(
+                                QX11Info::connection(),
+                                r.width(),
+                                r.height(),
+                                XCB_IMAGE_FORMAT_Z_PIXMAP,
+                                d->rootScreen->root_depth,
+                                NULL,         // base == 0
+                                (uint32_t)~0, // bytes == ~0
+                                NULL);
+
+                    if (d->updateTile) {
+                        d->updateTile->data = d->shminfo.shmaddr;
+
+                        // copy pixels from this damage rectangle image
+                        // to our total framebuffer image
+                        int pxsize =  d->framebufferImage->bpp / 8;
+                        char *dest = fb + ((d->framebufferImage->stride * r.top()) + (r.left() * pxsize));
+                        char *src = (char *)d->updateTile->data;
+                        for (int i = 0; i < d->updateTile->height; i++) {
+                            memcpy(dest, src, d->updateTile->stride);  // copy whole row of pixels
+                            dest += d->framebufferImage->stride;
+                            src += d->updateTile->stride;
+                        }
+
+                        // delete temporary image
+                        d->updateTile->data = NULL;
+                        xcb_image_destroy(d->updateTile);
+                        d->updateTile = NULL;
+                    }
+
+                    free(sgi_reply);
+                }
+            } // foreach
+        } else {
+            // not using shared memory
+            // will use just xcb_image_get() and copy pixels
+            foreach(const QRect &r, tiles) {
+                // I did not find XGetSubImage() analog in XCB!!
+                // need function that copies pixels from one image to another
+                xcb_image_t *damagedImage = xcb_image_get(
+                            QX11Info::connection(),
+                            this->win,
+                            r.left(),
+                            r.top(),
+                            r.width(),
+                            r.height(),
+                            0xFFFFFFFF, // AllPlanes
+                            XCB_IMAGE_FORMAT_Z_PIXMAP);
+                // manually copy pixels
+                int pxsize =  d->framebufferImage->bpp / 8;
+                char *dest = fb + ((d->framebufferImage->stride * r.top()) + (r.left() * pxsize));
+                char *src = (char *)damagedImage->data;
+                // loop every row in damaged image
+                for (int i = 0; i < damagedImage->height; i++) {
+                    // copy whole row of pixels from src image to dest
+                    memcpy(dest, src, damagedImage->stride);
+                    dest += d->framebufferImage->stride;  // move 1 row down in dest
+                    src += damagedImage->stride;          // move 1 row down in src
+                }
+                //
+                xcb_image_destroy(damagedImage);
+            }
+        }
+    } // if (tiles.size() > 0)
+
+    ret = tiles;
+    tiles.clear();
+    // ^^ If we clear here all our known "damage areas", then we can also clear
+    //    damaged area for xdamage? No, we don't need to in our case
+    //    (XCB_DAMAGE_REPORT_LEVEL_RAW_RECTANGLES report mode)
+    //xcb_damage_subtract(QX11Info::connection(), d->damage, XCB_NONE, XCB_NONE);
+
+    return ret;
+}
+
+
+void XCBFrameBuffer::startMonitor() {
+    if (d->running) return;
+
+    d->running = true;
+    d->damage = xcb_generate_id(QX11Info::connection());
+    xcb_damage_create(QX11Info::connection(), d->damage, this->win,
+            XCB_DAMAGE_REPORT_LEVEL_RAW_RECTANGLES);
+
+    // (currently) we do not call xcb_damage_subtract() EVER, because
+    // RAW rectangles are reported. every time some area of the screen
+    // was changed, we get only that rectangle
+    //xcb_damage_subtract(QX11Info::connection(), d->damage, XCB_NONE, XCB_NONE);
+}
+
+
+void XCBFrameBuffer::stopMonitor() {
+    if (!d->running) return;
+    d->running = false;
+    xcb_damage_destroy(QX11Info::connection(), d->damage);
+}
+
+
+// void XCBFrameBuffer::acquireEvents() {} // this function was totally unused
+// in X11 framebuffer, but it was the only function where XDamageSubtract() was called?
+// Also it had a blocking event loop like:
+//
+//     XEvent ev;
+//     while (XCheckTypedEvent(QX11Info::display(), d->xdamageBaseEvent + XDamageNotify, &ev)) {
+//         handleXDamage(&ev);
+//     }
+//     XDamageSubtract(QX11Info::display(), d->damage, None, None);
+//
+// This loop takes all available Xdamage events from queue, and ends if there are no
+// more such events in input queue.
+
+
+void XCBFrameBuffer::handleXDamageNotify(xcb_generic_event_t *xevent) {
+    xcb_damage_notify_event_t *xdevt = (xcb_damage_notify_event_t *)xevent;
+
+    QRect r((int)xdevt->area.x,     (int)xdevt->area.y,
+            (int)xdevt->area.width, (int)xdevt->area.height);
+    this->tiles.append(r);
+}
+

framebuffers/xcb/xcb_framebuffer.h

@@ -0,0 +1,48 @@
+/* This file is part of the KDE project
+   Copyright (C) 2017 Alexey Min <alexey.min@gmail.com>
+
+   This program is free software; you can redistribute it and/or
+   modify it under the terms of the GNU General Public
+   License as published by the Free Software Foundation; either
+   version 2 of the License, or (at your option) any later version.
+*/
+#ifndef KRFB_FRAMEBUFFER_XCB_XCB_FRAMEBUFFER_H
+#define KRFB_FRAMEBUFFER_XCB_XCB_FRAMEBUFFER_H
+
+#include "framebuffer.h"
+#include <QWidget>
+#include <xcb/xcb.h>
+
+
+
+/**
+    @author Alexey Min <alexey.min@gmail.com>
+*/
+class XCBFrameBuffer: public FrameBuffer
+{
+    Q_OBJECT
+public:
+    XCBFrameBuffer(WId winid, QObject *parent = 0);
+    ~XCBFrameBuffer();
+
+public:
+    QList<QRect> modifiedTiles() Q_DECL_OVERRIDE;
+    int  depth() Q_DECL_OVERRIDE;
+    int  height() Q_DECL_OVERRIDE;
+    int  width() Q_DECL_OVERRIDE;
+    int  paddedWidth() Q_DECL_OVERRIDE;
+    void getServerFormat(rfbPixelFormat &format) Q_DECL_OVERRIDE;
+    void startMonitor() Q_DECL_OVERRIDE;
+    void stopMonitor() Q_DECL_OVERRIDE;
+
+public:
+    void handleXDamageNotify(xcb_generic_event_t *xevent);
+
+private:
+    void cleanupRects();
+
+    class P;
+    P *const d;
+};
+
+#endif

framebuffers/xcb/xcb_framebufferplugin.cpp

@@ -0,0 +1,46 @@
+/* This file is part of the KDE project
+ @author Alexey Min <alexey.min@gmail.com>
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This program 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
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; see the file COPYING.  If not, write to
+ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
+*/
+
+
+#include "xcb_framebufferplugin.h"
+#include "xcb_framebuffer.h"
+#include <KPluginFactory>
+
+
+K_PLUGIN_FACTORY_WITH_JSON(XCBFrameBufferPluginFactory, "krfb_framebuffer_xcb.json",
+               registerPlugin<XCBFrameBufferPlugin>();)
+
+XCBFrameBufferPlugin::XCBFrameBufferPlugin(QObject *parent, const QVariantList &args)
+    : FrameBufferPlugin(parent, args)
+{
+}
+
+
+XCBFrameBufferPlugin::~XCBFrameBufferPlugin()
+{
+}
+
+
+FrameBuffer *XCBFrameBufferPlugin::frameBuffer(WId id)
+{
+    return new XCBFrameBuffer(id);
+}
+
+#include "xcb_framebufferplugin.moc"
+

framebuffers/xcb/xcb_framebufferplugin.h

@@ -0,0 +1,45 @@
+ /* This file is part of the KDE project
+  @author Alexey Min <alexey.min@gmail.com>
+
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public
+  License as published by the Free Software Foundation; either
+  version 2 of the License, or (at your option) any later version.
+
+  This program 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
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; see the file COPYING.  If not, write to
+  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+  Boston, MA 02110-1301, USA.
+*/
+
+#ifndef KRFB_FRAMEBUFFER_XCB_XCBFRAMEBUFFERPLUGIN_H
+#define KRFB_FRAMEBUFFER_XCB_XCBFRAMEBUFFERPLUGIN_H
+
+
+#include "framebufferplugin.h"
+#include <QWidget>
+
+
+class FrameBuffer;
+
+class XCBFrameBufferPlugin: public FrameBufferPlugin
+{
+   Q_OBJECT
+
+public:
+   XCBFrameBufferPlugin(QObject *parent, const QVariantList &args);
+   virtual ~XCBFrameBufferPlugin();
+
+   FrameBuffer *frameBuffer(WId id) override;
+
+private:
+   Q_DISABLE_COPY(XCBFrameBufferPlugin)
+};
+
+
+#endif  // Header guard

krfb/CMakeLists.txt

@@ -68,6 +68,7 @@ kconfig_add_kcfg_files (krfb_SRCS
 ki18n_wrap_ui (krfb_SRCS
                    ui/configtcp.ui
                    ui/configsecurity.ui
+                   ui/configframebuffer.ui
                    ui/connectionwidget.ui
                    ui/mainwidget.ui
 )

krfb/framebuffermanager.cpp

@@ -71,25 +71,25 @@ void FrameBufferManager::loadPlugins()
     i.toBack();
     QSet<QString> unique;
     while (i.hasPrevious()) {
-	KPluginMetaData data = i.previous();
+        const KPluginMetaData &data = i.previous();
         // only load plugins once, even if found multiple times!
         if (unique.contains(data.name()))
             continue;
-	KPluginFactory *factory = KPluginLoader(data.fileName()).factory();
-	
-	if (!factory) {
-		qDebug() << "KPluginFactory could not load the plugin:" << data.fileName();
-	} else {
-		qDebug() << "found plugin at " << data.fileName();
-	}
-	
-	FrameBufferPlugin *plugin = factory->create<FrameBufferPlugin>(this);
-	if (plugin) {
-		m_plugins.insert(data.pluginId(), plugin);
-		qDebug() << "Loaded plugin with name " << data.pluginId();
-	} else {
-		qDebug() << "unable to load pluign for " << data.fileName();
-	}
+        KPluginFactory *factory = KPluginLoader(data.fileName()).factory();
+
+        if (!factory) {
+            qDebug() << "KPluginFactory could not load the plugin:" << data.fileName();
+        } else {
+            qDebug() << "found plugin at " << data.fileName();
+        }
+
+        FrameBufferPlugin *plugin = factory->create<FrameBufferPlugin>(this);
+        if (plugin) {
+            m_plugins.insert(data.pluginId(), plugin);
+            qDebug() << "Loaded plugin with name " << data.pluginId();
+        } else {
+            qDebug() << "unable to load pluign for " << data.fileName();
+        }
         unique.insert (data.name());
     }
 }

krfb/krfb-framebuffer.desktop

@@ -19,7 +19,7 @@ Comment[eu]=Irteerako bideoaren pluginak KRfb-rentzako
 Comment[fi]=Kehyspuskuriliitännäinen kohteelle KRfb
 Comment[fr]=Modules externes de sortie vidéo pour Krfb
 Comment[ga]=Breiseáin Mhaoláin Fráma le haghaidh KRfb
-Comment[gl]=Engadido de frame buffer para KRfb
+Comment[gl]=Complemento de frame buffer para KRfb
 Comment[hr]=Priključci za međuspremnike okvira za KRfb
 Comment[hu]=Framebuffer bővítmények a Krfb-hez
 Comment[ia]=Plug-ins de Frame Buffer per KRfb

krfb/krfb-framebuffer.json

@@ -7,11 +7,12 @@
         "Description[cs]": "Moduly Frame bufferu pro KRfb",
         "Description[da]": "Framebuffer-plugins til KRfb",
         "Description[de]": "Framebuffer-Module für KRfb",
+        "Description[el]": "Πρόσθετα μνήμης ανανέωσης βίντεο καρέ για το KRfb",
         "Description[es]": "Complementos de framebuffer para KRfb",
         "Description[et]": "KRfb kaadripuhvri pluginad",
         "Description[fi]": "Kehyspuskuriliitännäinen kohteelle KRfb",
         "Description[fr]": "Modules de tampons d'image pour KRfb",
-        "Description[gl]": "Engadido de frame buffer para KRfb",
+        "Description[gl]": "Complemento de frame buffer para KRfb",
         "Description[ia]": "Plug-ins de Frame Buffer per KRfb",
         "Description[it]": "Estensioni del framebuffer per KRfb",
         "Description[ko]": "KRfb 프레임버퍼 플러그인",

krfb/krfb.kcfg

@@ -46,7 +46,7 @@
   <group name="FrameBuffer">
     <entry name="preferredFrameBufferPlugin" type="String">
       <label>Preferred Frame Buffer Plugin</label>
-      <default>qt</default>
+      <default>xcb</default>
     </entry>
   </group>
 </kcfg>

krfb/main.cpp

@@ -56,6 +56,21 @@ static bool checkX11Capabilities()
     return true;
 }
 
+
+static void checkOldX11PluginConfig() {
+    if (KrfbConfig::preferredFrameBufferPlugin() == QStringLiteral("x11")) {
+        qDebug() << "Detected deprecated configuration: preferredFrameBufferPlugin = x11";
+        KConfigSkeletonItem *config_item = KrfbConfig::self()->findItem(
+                    QStringLiteral("preferredFrameBufferPlugin"));
+        if (config_item) {
+            config_item->setProperty(QStringLiteral("xcb"));
+            KrfbConfig::self()->save();
+            qDebug() << "  Fixed preferredFrameBufferPlugin from x11 to xcb.";
+        }
+    }
+}
+
+
 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
@@ -109,6 +124,9 @@ int main(int argc, char *argv[])
         return 1;
     }
 
+    // upgrade the configuration
+    checkOldX11PluginConfig();
+
     //init the core
     InvitationsRfbServer::init();
 

krfb/mainwindow.cpp

@@ -13,6 +13,7 @@
 #include "krfbconfig.h"
 #include "ui_configtcp.h"
 #include "ui_configsecurity.h"
+#include "ui_configframebuffer.h"
 
 #include <KConfigDialog>
 #include <KLocalizedString>
@@ -21,12 +22,19 @@
 #include <KActionCollection>
 #include <KLineEdit>
 #include <KNewPasswordDialog>
+#include <KPluginLoader>
+#include <KPluginMetaData>
 
 #include <QIcon>
 #include <QWidget>
+#include <QLineEdit>
+#include <QComboBox>
 #include <QSizePolicy>
+#include <QVector>
+#include <QSet>
 #include <QtNetwork/QNetworkInterface>
 
+
 class TCP: public QWidget, public Ui::TCP
 {
 public:
@@ -43,6 +51,40 @@ public:
     }
 };
 
+class ConfigFramebuffer: public QWidget, public Ui::Framebuffer
+{
+public:
+    ConfigFramebuffer(QWidget *parent = 0) : QWidget(parent) {
+        setupUi(this);
+        // hide the line edit with framebuffer string
+        kcfg_preferredFrameBufferPlugin->hide();
+        // fill drop-down combo with a list of real existing plugins
+        this->fillFrameBuffersCombo();
+        // initialize combo with currently configured framebuffer plugin
+        cb_preferredFrameBufferPlugin->setCurrentText(KrfbConfig::preferredFrameBufferPlugin());
+        // connect signals between combo<->lineedit
+        // if we change selection in combo, lineedit is updated
+        QObject::connect(cb_preferredFrameBufferPlugin, &QComboBox::currentTextChanged,
+                         kcfg_preferredFrameBufferPlugin, &QLineEdit::setText);
+    }
+
+    void fillFrameBuffersCombo() {
+        const QVector<KPluginMetaData> plugins = KPluginLoader::findPlugins(
+                    QStringLiteral("krfb"), [](const KPluginMetaData & md) {
+            return md.serviceTypes().contains(QStringLiteral("krfb/framebuffer"));
+        });
+        QSet<QString> unique;
+        QVectorIterator<KPluginMetaData> i(plugins);
+        i.toBack();
+        while (i.hasPrevious()) {
+            const KPluginMetaData &metadata = i.previous();
+            if (unique.contains(metadata.pluginId())) continue;
+            cb_preferredFrameBufferPlugin->addItem(metadata.pluginId());
+            unique.insert(metadata.pluginId());
+        }
+    }
+};
+
 
 MainWindow::MainWindow(QWidget *parent)
     : KXmlGuiWindow(parent)
@@ -183,14 +225,28 @@ void MainWindow::aboutUnattendedMode()
 
 void MainWindow::showConfiguration()
 {
+    static QString s_prevFramebufferPlugin;
+    // ^^ needs to be static, because lambda will be called long time
+    //    after showConfiguration() ends, so auto variable would go out of scope
+    // save previously selected framebuffer plugin config
+    s_prevFramebufferPlugin = KrfbConfig::preferredFrameBufferPlugin();
+
     if (KConfigDialog::showDialog("settings")) {
         return;
     }
 
     KConfigDialog *dialog = new KConfigDialog(this, "settings", KrfbConfig::self());
-    dialog->addPage(new TCP, i18n("Network"), "network-workgroup");
+    dialog->addPage(new TCP, i18n("Network"), "network-wired");
     dialog->addPage(new Security, i18n("Security"), "security-high");
+    dialog->addPage(new ConfigFramebuffer, i18n("Screen capture"), "video-display");
     dialog->show();
+    connect(dialog, &KConfigDialog::settingsChanged, [this] () {
+        // check if framebuffer plugin config has changed
+        if (s_prevFramebufferPlugin != KrfbConfig::preferredFrameBufferPlugin()) {
+            KMessageBox::information(this, i18n("To apply framebuffer plugin setting, "
+                                                "you need to restart the program."));
+        }
+    });
 }
 
 void MainWindow::readProperties(const KConfigGroup& group)

krfb/org.kde.krfb.appdata.xml

@@ -2,14 +2,18 @@
 <component type="desktop">
   <id>org.kde.krfb.desktop</id>
   <metadata_license>CC0-1.0</metadata_license>
-  <project_license>GPL-2+</project_license>
+  <project_license>GPL-2.0+</project_license>
   <name>Krfb</name>
+  <name xml:lang="ast">Krfb</name>
   <name xml:lang="ca">Krfb</name>
   <name xml:lang="ca-valencia">Krfb</name>
   <name xml:lang="cs">Krfb</name>
   <name xml:lang="de">Krfb</name>
+  <name xml:lang="el">Krfb</name>
   <name xml:lang="en-GB">Krfb</name>
   <name xml:lang="es">Krfb</name>
+  <name xml:lang="fr">Krfb</name>
+  <name xml:lang="gl">Krfb</name>
   <name xml:lang="it">Krfb</name>
   <name xml:lang="nl">Krfb</name>
   <name xml:lang="pl">Krfb</name>
@@ -26,12 +30,16 @@
   <name xml:lang="x-test">xxKrfbxx</name>
   <name xml:lang="zh-CN">Krfb</name>
   <summary>Desktop sharing</summary>
+  <summary xml:lang="ast">Compartición d'escritoriu</summary>
   <summary xml:lang="ca">Compartició de l'escriptori</summary>
   <summary xml:lang="ca-valencia">Compartició de l'escriptori</summary>
   <summary xml:lang="cs">Sdílení pracovní plochy</summary>
   <summary xml:lang="de">Freigabe der Arbeitsfläche</summary>
+  <summary xml:lang="el">Κοινή χρήση επιφάνειας εργασίας</summary>
   <summary xml:lang="en-GB">Desktop sharing</summary>
   <summary xml:lang="es">Compartir el escritorio</summary>
+  <summary xml:lang="fr">Partage de bureau</summary>
+  <summary xml:lang="gl">Compartición do escritorio</summary>
   <summary xml:lang="it">Condivisione del desktop</summary>
   <summary xml:lang="nl">Bureaublad delen</summary>
   <summary xml:lang="pl">Współdzielenie pulpitu</summary>
@@ -52,8 +60,11 @@
     <p xml:lang="ca">El Krfb és una aplicació de servidor que permet compartir la vostra sessió actual amb un usuari en una altra màquina, la qual pot emprar un client VNC per veure o controlar l'escriptori.</p>
     <p xml:lang="ca-valencia">El Krfb és una aplicació de servidor que permet compartir la vostra sessió actual amb un usuari en una altra màquina, la qual pot emprar un client VNC per veure o controlar l'escriptori.</p>
     <p xml:lang="de">Krfb ist eine Serveranwendung, welche die gemeinsame Benutzung der aktuellen Sitzung mit einem Benutzer auf einem anderen Rechner ermöglicht, der mit Hilfe eines VNC-Programms den Bildschirminhalt sehen oder sogar die Arbeitsfläche bedienen kann.</p>
+    <p xml:lang="el">Η κοινή χρήση επιφάνειας εργασίας Krfb είναι μια εφαρμογή εξυπηρετητή που σας επιτρέπει να μοιράζεστε την τρέχουσα συνεδρία σας με έναν χρήστη σε άλλο μηχάνημα, ο οποίος μπορεί να χρησιμοποιεί έναν πελάτη VNC για να παρακολουθεί ή και να ελέγχει την επιφάνεια εργασίας σας.</p>
     <p xml:lang="en-GB">Krfb Desktop Sharing is a server application that allows you to share your current session with a user on another machine, who can use a VNC client to view or even control the desktop.</p>
     <p xml:lang="es">Krfb para compartir el escritorio es una aplicación de servidor que le permite compartir su sesión actual con un usuario de otra máquina, que puede usar un cliente VNC para ver e incluso controlar su escritorio.</p>
+    <p xml:lang="fr">Le partage de bureau Krfb est une application de serveur qui vous permet de partager votre session courante avec un utilisateur sur une autre machine, qui peut utiliser un client VNC pour afficher et même contrôler le bureau.</p>
+    <p xml:lang="gl">Krfb é un servizo que permite compartir a sesión actual cun usuario que está noutro equipo, que pode usar un cliente VNC para ver ou mesmo controlar o escritorio.</p>
     <p xml:lang="it">Condivisione del desktop Krfb è un'applicazione server che permette di condividere la sessione attuale con un utente su un'altra macchina, che potrà usare un client VNC per visualizzare ed anche controllare il desktop.</p>
     <p xml:lang="nl">Bureaublad delen is een server-applicatie die u in staat stelt uw huidige sessie te delen met een gebruiker op een andere machine, die een VNC-client kan gebruiken om uw bureaublad te bekijken of zelfs te besturen.</p>
     <p xml:lang="pl">Współdzielenie pulpitu Krfb jest aplikacją serwerową, która umożliwia współdzielenie twojej bieżącej sesji z użytkownikiem na innym komputerze, który może użyć klienta VNC do oglądania,a a nawet sterowania twoim pulpitem.</p>

krfb/ui/configframebuffer.ui

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Framebuffer</class>
+ <widget class="QWidget" name="Framebuffer">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>418</width>
+    <height>186</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Framebuffer</string>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <item>
+    <layout class="QHBoxLayout" name="horizontalLayout">
+     <item>
+      <widget class="QLabel" name="label">
+       <property name="text">
+        <string>Preferred frameb&amp;uffer plugin:</string>
+       </property>
+       <property name="buddy">
+        <cstring>cb_preferredFrameBufferPlugin</cstring>
+       </property>
+      </widget>
+     </item>
+     <item>
+      <widget class="QComboBox" name="cb_preferredFrameBufferPlugin">
+       <property name="editable">
+        <bool>false</bool>
+       </property>
+      </widget>
+     </item>
+     <item>
+      <widget class="QLineEdit" name="kcfg_preferredFrameBufferPlugin"/>
+     </item>
+    </layout>
+   </item>
+   <item>
+    <widget class="QLabel" name="helpText">
+     <property name="enabled">
+      <bool>true</bool>
+     </property>
+     <property name="text">
+      <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;When using x11, &lt;span style=&quot; font-weight:600;&quot;&gt;xcb&lt;/span&gt; plugin should be preferred, because it is more performant.&lt;br/&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;qt&lt;/span&gt; plugin is a safe fallback, if for some reason others don't work. But also it is very slow.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+     </property>
+     <property name="textFormat">
+      <enum>Qt::RichText</enum>
+     </property>
+     <property name="scaledContents">
+      <bool>false</bool>
+     </property>
+     <property name="alignment">
+      <set>Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter</set>
+     </property>
+     <property name="wordWrap">
+      <bool>true</bool>
+     </property>
+     <property name="margin">
+      <number>5</number>
+     </property>
+     <property name="textInteractionFlags">
+      <set>Qt::NoTextInteraction</set>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <spacer name="verticalSpacer">
+     <property name="orientation">
+      <enum>Qt::Vertical</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>20</width>
+       <height>63</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+  </layout>
+ </widget>
+ <tabstops>
+  <tabstop>cb_preferredFrameBufferPlugin</tabstop>
+  <tabstop>kcfg_preferredFrameBufferPlugin</tabstop>
+ </tabstops>
+ <resources/>
+ <connections/>
+</ui>