screenshot.cpp 15.5 KB
Newer Older
Martin Flöser's avatar
Martin Flöser committed
1 2 3 4
/********************************************************************
 KWin - the KDE window manager
 This file is part of the KDE project.

5
 Copyright (C) 2010 Martin Gräßlin <mgraesslin@kde.org>
Martin Flöser's avatar
Martin Flöser committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)

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.  If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#include "screenshot.h"
22
#include <kwinglplatform.h>
Martin Flöser's avatar
Martin Flöser committed
23
#include <kwinglutils.h>
24
#include <kwinxrenderutils.h>
25 26
#include <QtCore/QTemporaryFile>
#include <QtCore/QDir>
27
#include <QtDBus/QDBusConnection>
28
#include <QVarLengthArray>
29
#include <QtGui/QPainter>
30
#include <QMatrix4x4>
Martin Flöser's avatar
Martin Flöser committed
31
#include <xcb/xcb_image.h>
Martin Flöser's avatar
Martin Flöser committed
32 33 34 35 36

namespace KWin
{

bool ScreenShotEffect::supported()
37
{
38
    return  effects->compositingType() == XRenderCompositing ||
39
            (effects->isOpenGLCompositing() && GLRenderTarget::supported());
40
}
Martin Flöser's avatar
Martin Flöser committed
41 42

ScreenShotEffect::ScreenShotEffect()
43
    : m_scheduledScreenshot(0)
44
    , m_replyConnection(QDBusConnection::sessionBus())
45
{
46
    connect ( effects, SIGNAL(windowClosed(KWin::EffectWindow*)), SLOT(windowClosed(KWin::EffectWindow*)) );
47 48
    QDBusConnection::sessionBus().registerObject(QStringLiteral("/Screenshot"), this, QDBusConnection::ExportScriptableContents);
    QDBusConnection::sessionBus().registerService(QStringLiteral("org.kde.kwin.Screenshot"));
49
}
Martin Flöser's avatar
Martin Flöser committed
50 51

ScreenShotEffect::~ScreenShotEffect()
52
{
53 54
    QDBusConnection::sessionBus().unregisterObject(QStringLiteral("/Screenshot"));
    QDBusConnection::sessionBus().unregisterService(QStringLiteral("org.kde.kwin.Screenshot"));
55
}
Martin Flöser's avatar
Martin Flöser committed
56 57 58 59

#ifdef KWIN_HAVE_XRENDER_COMPOSITING
static QImage xPictureToImage(xcb_render_picture_t srcPic, const QRect &geometry, xcb_image_t **xImage)
{
60 61 62
    xcb_connection_t *c = effects->xcbConnection();
    xcb_pixmap_t xpix = xcb_generate_id(c);
    xcb_create_pixmap(c, 32, xpix, effects->x11RootWindow(), geometry.width(), geometry.height());
Martin Flöser's avatar
Martin Flöser committed
63
    XRenderPicture pic(xpix, 32);
64
    xcb_render_composite(c, XCB_RENDER_PICT_OP_SRC, srcPic, XCB_RENDER_PICTURE_NONE, pic,
Martin Flöser's avatar
Martin Flöser committed
65
                         geometry.x(), geometry.y(), 0, 0, 0, 0, geometry.width(), geometry.height());
66 67
    xcb_flush(c);
    *xImage = xcb_image_get(c, xpix, 0, 0, geometry.width(), geometry.height(), ~0, XCB_IMAGE_FORMAT_Z_PIXMAP);
Martin Flöser's avatar
Martin Flöser committed
68 69
    QImage img((*xImage)->data, (*xImage)->width, (*xImage)->height, (*xImage)->stride, QImage::Format_ARGB32_Premultiplied);
    // TODO: byte order might need swapping
70
    xcb_free_pixmap(c, xpix);
71
    return img.copy();
Martin Flöser's avatar
Martin Flöser committed
72 73 74
}
#endif

75 76 77 78 79 80
void ScreenShotEffect::paintScreen(int mask, QRegion region, ScreenPaintData &data)
{
    m_cachedOutputGeometry = data.outputGeometry();
    effects->paintScreen(mask, region, data);
}

Martin Flöser's avatar
Martin Flöser committed
81
void ScreenShotEffect::postPaintScreen()
82
{
Martin Flöser's avatar
Martin Flöser committed
83
    effects->postPaintScreen();
84
    if (m_scheduledScreenshot) {
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
        WindowPaintData d(m_scheduledScreenshot);
        double left = 0;
        double top = 0;
        double right = m_scheduledScreenshot->width();
        double bottom = m_scheduledScreenshot->height();
        if (m_scheduledScreenshot->hasDecoration() && m_type & INCLUDE_DECORATION) {
            foreach (const WindowQuad & quad, d.quads) {
                // we need this loop to include the decoration padding
                left   = qMin(left, quad.left());
                top    = qMin(top, quad.top());
                right  = qMax(right, quad.right());
                bottom = qMax(bottom, quad.bottom());
            }
        } else if (m_scheduledScreenshot->hasDecoration()) {
            WindowQuadList newQuads;
            left = m_scheduledScreenshot->width();
            top = m_scheduledScreenshot->height();
            right = 0;
            bottom = 0;
            foreach (const WindowQuad & quad, d.quads) {
                if (quad.type() == WindowQuadContents) {
                    newQuads << quad;
                    left   = qMin(left, quad.left());
                    top    = qMin(top, quad.top());
                    right  = qMax(right, quad.right());
                    bottom = qMax(bottom, quad.bottom());
                }
            }
            d.quads = newQuads;
        }
        const int width = right - left;
        const int height = bottom - top;
117
        bool validTarget = true;
118 119
        QScopedPointer<GLTexture> offscreenTexture;
        QScopedPointer<GLRenderTarget> target;
120
        if (effects->isOpenGLCompositing()) {
121
            offscreenTexture.reset(new GLTexture(GL_RGBA8, width, height));
122 123
            offscreenTexture->setFilter(GL_LINEAR);
            offscreenTexture->setWrapMode(GL_CLAMP_TO_EDGE);
124
            target.reset(new GLRenderTarget(*offscreenTexture));
125
            validTarget = target->valid();
126
        }
127
        if (validTarget) {
128 129
            d.setXTranslation(-m_scheduledScreenshot->x() - left);
            d.setYTranslation(-m_scheduledScreenshot->y() - top);
130

Martin Flöser's avatar
Martin Flöser committed
131 132
            // render window into offscreen texture
            int mask = PAINT_WINDOW_TRANSFORMED | PAINT_WINDOW_TRANSLUCENT;
133
            QImage img;
134
            if (effects->isOpenGLCompositing()) {
135
                GLRenderTarget::pushRenderTarget(target.data());
136 137 138
                glClearColor(0.0, 0.0, 0.0, 0.0);
                glClear(GL_COLOR_BUFFER_BIT);
                glClearColor(0.0, 0.0, 0.0, 1.0);
139 140 141 142 143

                QMatrix4x4 projection;
                projection.ortho(QRect(0, 0, offscreenTexture->width(), offscreenTexture->height()));
                d.setProjectionMatrix(projection);

144
                effects->drawWindow(m_scheduledScreenshot, mask, infiniteRegion(), d);
145

146 147
                // copy content from framebuffer into image
                img = QImage(QSize(width, height), QImage::Format_ARGB32);
148
                glReadnPixels(0, 0, width, height, GL_RGBA, GL_UNSIGNED_BYTE, img.byteCount(), (GLvoid*)img.bits());
149 150 151
                GLRenderTarget::popRenderTarget();
                ScreenShotEffect::convertFromGLImage(img, width, height);
            }
152
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
Martin Flöser's avatar
Martin Flöser committed
153
            xcb_image_t *xImage = NULL;
154 155 156
            if (effects->compositingType() == XRenderCompositing) {
                setXRenderOffscreen(true);
                effects->drawWindow(m_scheduledScreenshot, mask, QRegion(0, 0, width, height), d);
157
                if (xRenderOffscreenTarget()) {
Martin Flöser's avatar
Martin Flöser committed
158
                    img = xPictureToImage(xRenderOffscreenTarget(), QRect(0, 0, width, height), &xImage);
159
                }
160 161
                setXRenderOffscreen(false);
            }
162
#endif
163

164 165
            if (m_type & INCLUDE_CURSOR) {
                grabPointerImage(img, m_scheduledScreenshot->x() + left, m_scheduledScreenshot->y() + top);
Martin Flöser's avatar
Martin Flöser committed
166
            }
167

Martin Flöser's avatar
Martin Flöser committed
168
            const int depth = img.depth();
169 170
            xcb_pixmap_t xpix = xcb_generate_id(xcbConnection());
            xcb_create_pixmap(xcbConnection(), depth, xpix, x11RootWindow(), img.width(), img.height());
Martin Flöser's avatar
Martin Flöser committed
171

172 173 174
            xcb_gcontext_t cid = xcb_generate_id(xcbConnection());
            xcb_create_gc(xcbConnection(), cid, xpix, 0, NULL);
            xcb_put_image(xcbConnection(), XCB_IMAGE_FORMAT_Z_PIXMAP, xpix, cid, img.width(), img.height(),
Martin Flöser's avatar
Martin Flöser committed
175
                        0, 0, 0, depth, img.byteCount(), img.constBits());
176 177
            xcb_free_gc(xcbConnection(), cid);
            xcb_flush(xcbConnection());
Martin Flöser's avatar
Martin Flöser committed
178 179 180 181
            emit screenshotCreated(xpix);
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
            if (xImage) {
                xcb_image_destroy(xImage);
182
            }
Martin Flöser's avatar
Martin Flöser committed
183
#endif
184
        }
Martin Flöser's avatar
Martin Flöser committed
185 186
        m_scheduledScreenshot = NULL;
    }
187 188

    if (!m_scheduledGeometry.isNull()) {
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
        if (!m_cachedOutputGeometry.isNull()) {
            // special handling for per-output geometry rendering
            const QRect intersection = m_scheduledGeometry.intersected(m_cachedOutputGeometry);
            if (intersection.isEmpty()) {
                // doesn't intersect, not going onto this screenshot
                return;
            }
            const QImage img = blitScreenshot(intersection);
            if (img.size() == m_scheduledGeometry.size()) {
                // we are done
                sendReplyImage(img);
                return;
            }
            if (m_multipleOutputsImage.isNull()) {
                m_multipleOutputsImage = QImage(m_scheduledGeometry.size(), QImage::Format_ARGB32);
                m_multipleOutputsImage.fill(Qt::transparent);
            }
            QPainter p;
            p.begin(&m_multipleOutputsImage);
            p.drawImage(intersection.topLeft() - m_scheduledGeometry.topLeft(), img);
            p.end();
            m_multipleOutputsRendered = m_multipleOutputsRendered.united(intersection);
            if (m_multipleOutputsRendered.boundingRect() == m_scheduledGeometry) {
                sendReplyImage(m_multipleOutputsImage);
            }

        } else {
            const QImage img = blitScreenshot(m_scheduledGeometry);
            sendReplyImage(img);
        }
219
    }
220
}
Martin Flöser's avatar
Martin Flöser committed
221

222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
void ScreenShotEffect::sendReplyImage(const QImage &img)
{
    m_replyConnection.send(m_replyMessage.createReply(saveTempImage(img)));
    m_scheduledGeometry = QRect();
    m_multipleOutputsImage = QImage();
    m_multipleOutputsRendered = QRegion();
}

QString ScreenShotEffect::saveTempImage(const QImage &img)
{
    if (img.isNull()) {
        return QString();
    }
    QTemporaryFile temp(QDir::tempPath() + QDir::separator() + QLatin1String("kwin_screenshot_XXXXXX.png"));
    temp.setAutoRemove(false);
    if (!temp.open()) {
        return QString();
    }
    img.save(&temp);
    temp.close();
    return temp.fileName();
}

245
void ScreenShotEffect::screenshotWindowUnderCursor(int mask)
246
{
247 248
    m_type = (ScreenShotType)mask;
    const QPoint cursor = effects->cursorPos();
249 250 251 252 253 254 255 256 257
    EffectWindowList order = effects->stackingOrder();
    EffectWindowList::const_iterator it = order.constEnd(), first = order.constBegin();
    while( it != first ) {
        m_scheduledScreenshot = *(--it);
        if (m_scheduledScreenshot->isOnCurrentDesktop() &&
            !m_scheduledScreenshot->isMinimized() && !m_scheduledScreenshot->isDeleted() &&
            m_scheduledScreenshot->geometry().contains(cursor))
            break;
        m_scheduledScreenshot = 0;
258 259
    }
    if (m_scheduledScreenshot) {
260
        m_scheduledScreenshot->addRepaintFull();
Martin Flöser's avatar
Martin Flöser committed
261
    }
262
}
263

264 265 266 267 268 269 270 271 272 273
void ScreenShotEffect::screenshotForWindow(qulonglong winid, int mask)
{
    m_type = (ScreenShotType) mask;
    EffectWindow* w = effects->findWindow(winid);
    if(w && !w->isMinimized() && !w->isDeleted()) {
        m_scheduledScreenshot = w;
        m_scheduledScreenshot->addRepaintFull();
    }
}

274 275
QString ScreenShotEffect::screenshotFullscreen()
{
276 277 278 279 280 281 282 283 284 285 286 287 288
    if (!calledFromDBus()) {
        return QString();
    }
    if (!m_scheduledGeometry.isNull()) {
        sendErrorReply(QDBusError::Failed, "A screenshot is already been taken");
        return QString();
    }
    m_replyConnection = connection();
    m_replyMessage = message();
    setDelayedReply(true);
    m_scheduledGeometry = effects->virtualScreenGeometry();
    effects->addRepaintFull();
    return QString();
289 290 291 292
}

QString ScreenShotEffect::screenshotScreen(int screen)
{
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    if (!calledFromDBus()) {
        return QString();
    }
    if (!m_scheduledGeometry.isNull()) {
        sendErrorReply(QDBusError::Failed, "A screenshot is already been taken");
        return QString();
    }
    m_scheduledGeometry = effects->clientArea(FullScreenArea, screen, 0);
    if (m_scheduledGeometry.isNull()) {
        sendErrorReply(QDBusError::Failed, "Invalid screen requested");
        return QString();
    }
    m_replyConnection = connection();
    m_replyMessage = message();
    setDelayedReply(true);
    effects->addRepaint(m_scheduledGeometry);
    return QString();
310 311 312 313
}

QString ScreenShotEffect::screenshotArea(int x, int y, int width, int height)
{
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    if (!calledFromDBus()) {
        return QString();
    }
    if (!m_scheduledGeometry.isNull()) {
        sendErrorReply(QDBusError::Failed, "A screenshot is already been taken");
        return QString();
    }
    m_scheduledGeometry = QRect(x, y, width, height);
    if (m_scheduledGeometry.isNull() || m_scheduledGeometry.isEmpty()) {
        m_scheduledGeometry = QRect();
        sendErrorReply(QDBusError::Failed, "Invalid area requested");
        return QString();
    }
    m_replyConnection = connection();
    m_replyMessage = message();
    setDelayedReply(true);
    effects->addRepaint(m_scheduledGeometry);
    return QString();
332 333
}

334
QImage ScreenShotEffect::blitScreenshot(const QRect &geometry)
335
{
336
    QImage img;
337
    if (effects->isOpenGLCompositing())
338 339
    {
        if (!GLRenderTarget::blitSupported()) {
340
            qCDebug(KWINEFFECTS) << "Framebuffer Blit not supported";
341
            return img;
342
        }
343
        GLTexture tex(GL_RGBA8, geometry.width(), geometry.height());
344 345 346 347 348
        GLRenderTarget target(tex);
        target.blitFromFramebuffer(geometry);
        // copy content from framebuffer into image
        tex.bind();
        img = QImage(geometry.size(), QImage::Format_ARGB32);
349 350 351 352 353
        if (GLPlatform::instance()->isGLES()) {
            glReadPixels(0, 0, img.width(), img.height(), GL_RGBA, GL_UNSIGNED_BYTE, (GLvoid*)img.bits());
        } else {
            glGetTexImage(GL_TEXTURE_2D, 0, GL_RGBA, GL_UNSIGNED_BYTE, (GLvoid*)img.bits());
        }
354 355 356 357
        tex.unbind();
        ScreenShotEffect::convertFromGLImage(img, geometry.width(), geometry.height());
    }

Martin Flöser's avatar
Martin Flöser committed
358
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
359
    if (effects->compositingType() == XRenderCompositing) {
360
    xcb_image_t *xImage = NULL;
Martin Flöser's avatar
Martin Flöser committed
361
        img = xPictureToImage(effects->xrenderBufferPicture(), geometry, &xImage);
362 363 364
        if (xImage) {
            xcb_image_destroy(xImage);
        }
Martin Flöser's avatar
Martin Flöser committed
365 366
    }
#endif
367 368

    return img;
369
}
Martin Flöser's avatar
Martin Flöser committed
370

371
void ScreenShotEffect::grabPointerImage(QImage& snapshot, int offsetx, int offsety)
372
{
373 374
    const auto cursor = effects->cursorImage();
    if (cursor.image().isNull())
375
        return;
376 377

    QPainter painter(&snapshot);
378
    painter.drawImage(effects->cursorPos() - cursor.hotSpot() - QPoint(offsetx, offsety), cursor.image());
379 380
}

Martin Flöser's avatar
Martin Flöser committed
381 382 383 384 385 386 387 388
void ScreenShotEffect::convertFromGLImage(QImage &img, int w, int h)
{
    // from QtOpenGL/qgl.cpp
    // Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
    // see http://qt.gitorious.org/qt/qt/blobs/master/src/opengl/qgl.cpp
    if (QSysInfo::ByteOrder == QSysInfo::BigEndian) {
        // OpenGL gives RGBA; Qt wants ARGB
        uint *p = (uint*)img.bits();
389
        uint *end = p + w * h;
Martin Flöser's avatar
Martin Flöser committed
390 391 392 393 394 395 396 397 398
        while (p < end) {
            uint a = *p << 24;
            *p = (*p >> 8) | a;
            p++;
        }
    } else {
        // OpenGL gives ABGR (i.e. RGBA backwards); Qt wants ARGB
        for (int y = 0; y < h; y++) {
            uint *q = (uint*)img.scanLine(y);
399
            for (int x = 0; x < w; ++x) {
Martin Flöser's avatar
Martin Flöser committed
400 401
                const uint pixel = *q;
                *q = ((pixel << 16) & 0xff0000) | ((pixel >> 16) & 0xff)
402
                     | (pixel & 0xff00ff00);
Martin Flöser's avatar
Martin Flöser committed
403 404 405 406 407 408 409 410 411

                q++;
            }
        }

    }
    img = img.mirrored();
}

412 413
bool ScreenShotEffect::isActive() const
{
414
    return (m_scheduledScreenshot != NULL || !m_scheduledGeometry.isNull()) && !effects->isScreenLocked();
415 416
}

417 418 419 420 421 422 423 424
void ScreenShotEffect::windowClosed( EffectWindow* w )
{
    if (w == m_scheduledScreenshot) {
        m_scheduledScreenshot = NULL;
        screenshotWindowUnderCursor(m_type);
    }
}

Martin Flöser's avatar
Martin Flöser committed
425
} // namespace