screenshot.cpp 14.4 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);
Martin Flöser's avatar
Martin Flöser committed
71 72 73 74
    return img;
}
#endif

Martin Flöser's avatar
Martin Flöser committed
75
void ScreenShotEffect::postPaintScreen()
76
{
Martin Flöser's avatar
Martin Flöser committed
77
    effects->postPaintScreen();
78
    if (m_scheduledScreenshot) {
79 80 81 82 83 84 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
        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;
111
        bool validTarget = true;
112 113
        QScopedPointer<GLTexture> offscreenTexture;
        QScopedPointer<GLRenderTarget> target;
114
        if (effects->isOpenGLCompositing()) {
115
            offscreenTexture.reset(new GLTexture(GL_RGBA8, width, height));
116 117
            offscreenTexture->setFilter(GL_LINEAR);
            offscreenTexture->setWrapMode(GL_CLAMP_TO_EDGE);
118
            target.reset(new GLRenderTarget(*offscreenTexture));
119
            validTarget = target->valid();
120
        }
121
        if (validTarget) {
122 123
            d.setXTranslation(-m_scheduledScreenshot->x() - left);
            d.setYTranslation(-m_scheduledScreenshot->y() - top);
124

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

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

138
                effects->drawWindow(m_scheduledScreenshot, mask, infiniteRegion(), d);
139

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

158 159
            if (m_type & INCLUDE_CURSOR) {
                grabPointerImage(img, m_scheduledScreenshot->x() + left, m_scheduledScreenshot->y() + top);
Martin Flöser's avatar
Martin Flöser committed
160
            }
161

Martin Flöser's avatar
Martin Flöser committed
162
            const int depth = img.depth();
163 164
            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
165

166 167 168
            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
169
                        0, 0, 0, depth, img.byteCount(), img.constBits());
170 171
            xcb_free_gc(xcbConnection(), cid);
            xcb_flush(xcbConnection());
Martin Flöser's avatar
Martin Flöser committed
172 173 174 175
            emit screenshotCreated(xpix);
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
            if (xImage) {
                xcb_image_destroy(xImage);
176
            }
Martin Flöser's avatar
Martin Flöser committed
177
#endif
178
        }
Martin Flöser's avatar
Martin Flöser committed
179 180
        m_scheduledScreenshot = NULL;
    }
181 182 183 184 185

    if (!m_scheduledGeometry.isNull()) {
        m_replyConnection.send(m_replyMessage.createReply(blitScreenshot(m_scheduledGeometry)));
        m_scheduledGeometry = QRect();
    }
186
}
Martin Flöser's avatar
Martin Flöser committed
187

188
void ScreenShotEffect::screenshotWindowUnderCursor(int mask)
189
{
190 191
    m_type = (ScreenShotType)mask;
    const QPoint cursor = effects->cursorPos();
192 193 194 195 196 197 198 199 200
    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;
201 202
    }
    if (m_scheduledScreenshot) {
203
        m_scheduledScreenshot->addRepaintFull();
Martin Flöser's avatar
Martin Flöser committed
204
    }
205
}
206

207 208 209 210 211 212 213 214 215 216
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();
    }
}

217 218
QString ScreenShotEffect::screenshotFullscreen()
{
219 220 221 222 223 224 225 226 227 228 229 230 231
    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();
232 233 234 235
}

QString ScreenShotEffect::screenshotScreen(int screen)
{
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
    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();
253 254 255 256
}

QString ScreenShotEffect::screenshotArea(int x, int y, int width, int height)
{
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    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();
275 276 277 278
}

QString ScreenShotEffect::blitScreenshot(const QRect &geometry)
{
279
    QImage img;
280
    if (effects->isOpenGLCompositing())
281 282
    {
        if (!GLRenderTarget::blitSupported()) {
283
            qCDebug(KWINEFFECTS) << "Framebuffer Blit not supported";
284 285
            return QString();
        }
286
        GLTexture tex(GL_RGBA8, geometry.width(), geometry.height());
287 288 289 290 291
        GLRenderTarget target(tex);
        target.blitFromFramebuffer(geometry);
        // copy content from framebuffer into image
        tex.bind();
        img = QImage(geometry.size(), QImage::Format_ARGB32);
292 293 294 295 296
        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());
        }
297 298 299 300
        tex.unbind();
        ScreenShotEffect::convertFromGLImage(img, geometry.width(), geometry.height());
    }

Martin Flöser's avatar
Martin Flöser committed
301 302 303
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
    xcb_image_t *xImage = NULL;
#endif
304
    if (effects->compositingType() == XRenderCompositing) {
305
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
Martin Flöser's avatar
Martin Flöser committed
306
        img = xPictureToImage(effects->xrenderBufferPicture(), geometry, &xImage);
307
#endif
308 309
    }

310
    QTemporaryFile temp(QDir::tempPath() + QDir::separator() + QLatin1String("kwin_screenshot_XXXXXX.png"));
311 312 313 314 315
    temp.setAutoRemove(false);
    if (!temp.open()) {
        return QString();
    }
    img.save(&temp);
Martin Flöser's avatar
Martin Flöser committed
316 317 318 319 320
#ifdef KWIN_HAVE_XRENDER_COMPOSITING
    if (xImage) {
        xcb_image_destroy(xImage);
    }
#endif
321 322 323
    temp.close();
    return temp.fileName();
}
Martin Flöser's avatar
Martin Flöser committed
324

325
void ScreenShotEffect::grabPointerImage(QImage& snapshot, int offsetx, int offsety)
326 327
// Uses the X11_EXTENSIONS_XFIXES_H extension to grab the pointer image, and overlays it onto the snapshot.
{
Martin Flöser's avatar
Martin Flöser committed
328
    QScopedPointer<xcb_xfixes_get_cursor_image_reply_t, QScopedPointerPodDeleter> cursor(
329 330
        xcb_xfixes_get_cursor_image_reply(xcbConnection(),
                                          xcb_xfixes_get_cursor_image_unchecked(xcbConnection()),
Martin Flöser's avatar
Martin Flöser committed
331 332
                                          NULL));
    if (cursor.isNull())
333
        return;
334

Martin Flöser's avatar
Martin Flöser committed
335
    QImage qcursorimg((uchar *) xcb_xfixes_get_cursor_image_cursor_image(cursor.data()), cursor->width, cursor->height,
336
                      QImage::Format_ARGB32_Premultiplied);
337 338

    QPainter painter(&snapshot);
Martin Flöser's avatar
Martin Flöser committed
339
    painter.drawImage(QPointF(cursor->x - cursor->xhot - offsetx, cursor->y - cursor ->yhot - offsety), qcursorimg);
340 341
}

Martin Flöser's avatar
Martin Flöser committed
342 343 344 345 346 347 348 349
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();
350
        uint *end = p + w * h;
Martin Flöser's avatar
Martin Flöser committed
351 352 353 354 355 356 357 358 359
        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);
360
            for (int x = 0; x < w; ++x) {
Martin Flöser's avatar
Martin Flöser committed
361 362
                const uint pixel = *q;
                *q = ((pixel << 16) & 0xff0000) | ((pixel >> 16) & 0xff)
363
                     | (pixel & 0xff00ff00);
Martin Flöser's avatar
Martin Flöser committed
364 365 366 367 368 369 370 371 372

                q++;
            }
        }

    }
    img = img.mirrored();
}

373 374
bool ScreenShotEffect::isActive() const
{
375
    return (m_scheduledScreenshot != NULL || !m_scheduledGeometry.isNull()) && !effects->isScreenLocked();
376 377
}

378 379 380 381 382 383 384 385
void ScreenShotEffect::windowClosed( EffectWindow* w )
{
    if (w == m_scheduledScreenshot) {
        m_scheduledScreenshot = NULL;
        screenshotWindowUnderCursor(m_type);
    }
}

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