/* KWin - the KDE window manager This file is part of the KDE project. SPDX-FileCopyrightText: 2023 Aleix Pol Gonzalez SPDX-License-Identifier: GPL-2.0-or-later */ #include "compositor.h" #include "core/output.h" #include "generic_scene_opengl_test.h" #include "opengl/glplatform.h" #include "pointer_input.h" #include "scene/workspacescene.h" #include "wayland_server.h" #include "window.h" #include "workspace.h" #include #include #include #include #include #include #define QCOMPAREIMG(actual, expected, id) \ { \ if ((actual) != (expected)) { \ const auto actualFile = QStringLiteral("appium_artifact_actual_%1.png").arg(id); \ const auto expectedFile = QStringLiteral("appium_artifact_expected_%1.png").arg(id); \ (actual).save(actualFile); \ (expected).save(expectedFile); \ qDebug() << "Generated failed file" << actualFile << expectedFile; \ } \ QCOMPARE(actual, expected); \ } namespace KWin { static const QString s_socketName = QStringLiteral("wayland_test_buffer_size_change-0"); class ScreencastingTest : public GenericSceneOpenGLTest { Q_OBJECT public: ScreencastingTest() : GenericSceneOpenGLTest(QByteArrayLiteral("O2")) { auto wrap = [this](const QString &process, const QStringList &arguments = {}) { // Make sure PipeWire is running. If it's already running it will just exit QProcess *p = new QProcess(this); p->setProcessChannelMode(QProcess::MergedChannels); p->setArguments(arguments); connect(this, &QObject::destroyed, p, [p] { p->terminate(); p->waitForFinished(); p->kill(); }); connect(p, &QProcess::errorOccurred, p, [p](auto status) { qDebug() << "error" << status << p->program(); }); connect(p, &QProcess::finished, p, [p](int code, auto status) { if (code != 0) { qDebug() << p->readAll(); } qDebug() << "finished" << code << status << p->program(); }); p->setProgram(process); p->start(); }; // If I run this outside the CI, it breaks the system's pipewire if (qgetenv("KDECI_BUILD") == "TRUE") { wrap("pipewire"); wrap("dbus-launch", {"wireplumber"}); } } private Q_SLOTS: void init(); void testWindowCasting(); void testWindowWithPopup(); void testWindowWithPopupDynamic(); void testOutputCasting(); private: std::optional oneFrameAndClose(Test::ScreencastingStreamV1 *stream); }; void ScreencastingTest::init() { if (qgetenv("KDECI_BUILD") == "TRUE") { QSKIP("CI has pipewire 1.2 that has known process callback issues"); // TODO: Remove it later when CI ships pipewire 1.2 with the fix } QVERIFY(Test::setupWaylandConnection(Test::AdditionalWaylandInterface::ScreencastingV1 | Test::AdditionalWaylandInterface::PresentationTime)); QVERIFY(KWin::Test::screencasting()); Cursors::self()->hideCursor(); } std::optional ScreencastingTest::oneFrameAndClose(Test::ScreencastingStreamV1 *stream) { Q_ASSERT(stream); PipeWireSourceStream pwStream; qDebug() << "start" << stream; connect(stream, &Test::ScreencastingStreamV1::failed, qGuiApp, [](const QString &error) { qDebug() << "stream failed with error" << error; Q_ASSERT(false); }); connect(stream, &Test::ScreencastingStreamV1::closed, qGuiApp, [&pwStream] { pwStream.setActive(false); }); connect(stream, &Test::ScreencastingStreamV1::created, qGuiApp, [&pwStream](quint32 nodeId) { pwStream.createStream(nodeId, 0); }); std::optional img; connect(&pwStream, &PipeWireSourceStream::frameReceived, qGuiApp, [&img](const PipeWireFrame &frame) { if (frame.dataFrame) { img = frame.dataFrame->toImage(); } }); QSignalSpy spy(&pwStream, &PipeWireSourceStream::frameReceived); if (!spy.wait()) { qDebug() << "Did not receive any frames"; } pwStream.stopStreaming(); return img; } void ScreencastingTest::testWindowCasting() { QImage sourceImage(QSize(30, 10), QImage::Format_RGBA8888_Premultiplied); sourceImage.fill(Qt::red); Test::XdgToplevelWindow window; QVERIFY(window.show(sourceImage)); auto stream = KWin::Test::screencasting()->createWindowStream(window.m_window->internalId().toString(), QtWayland::zkde_screencast_unstable_v1::pointer_hidden); std::optional img = oneFrameAndClose(stream); QVERIFY(img); img->convertTo(sourceImage.format()); QCOMPAREIMG(*img, sourceImage, QLatin1String("window_cast")); } void ScreencastingTest::testWindowWithPopup() { QImage windowImage(QSize(30, 10), QImage::Format_RGBA8888_Premultiplied); windowImage.fill(Qt::red); Test::XdgToplevelWindow window; QVERIFY(window.show(windowImage)); QSize popupSize(5, 5); Rect anchoRect(0, 0, 1, 1); std::unique_ptr popupSurface(Test::createSurface()); std::unique_ptr positioner(Test::createXdgPositioner()); positioner->set_size(popupSize.width(), popupSize.height()); positioner->set_anchor_rect(anchoRect.x(), anchoRect.y(), anchoRect.width(), anchoRect.height()); positioner->set_gravity(Test::XdgPositioner::gravity_bottom_right); std::unique_ptr popup(Test::createXdgPopupSurface(popupSurface.get(), window.m_toplevel->xdgSurface(), positioner.get())); QImage popupImage(popupSize, QImage::Format_RGBA8888_Premultiplied); popupImage.fill(Qt::blue); auto popupWindow = Test::renderAndWaitForShown(popupSurface.get(), popupImage); QVERIFY(popupWindow); std::unique_ptr stream(KWin::Test::screencasting()->createWindowStream(window.m_window->internalId().toString(), Test::ScreencastingV1::pointer_hidden)); QImage expectedImage = windowImage; QPainter(&expectedImage).drawImage(anchoRect.bottomRight(), popupImage); std::optional img = oneFrameAndClose(stream.get()); QVERIFY(img); img->convertTo(expectedImage.format()); QCOMPAREIMG(*img, expectedImage, QLatin1String("window_popup")); } void ScreencastingTest::testWindowWithPopupDynamic() { QImage windowImage(QSize(30, 10), QImage::Format_RGBA8888_Premultiplied); windowImage.fill(Qt::red); Test::XdgToplevelWindow window; QVERIFY(window.show(windowImage)); std::unique_ptr stream(KWin::Test::screencasting()->createWindowStream(window.m_window->internalId().toString(), Test::ScreencastingV1::pointer_hidden)); PipeWireSourceStream pwStream; connect(stream.get(), &Test::ScreencastingStreamV1::failed, qGuiApp, [](const QString &error) { QFAIL("Creating stream failed: " + error.toUtf8()); }); connect(stream.get(), &Test::ScreencastingStreamV1::closed, qGuiApp, [&pwStream] { pwStream.setActive(false); }); QSignalSpy createdSpy(stream.get(), &Test::ScreencastingStreamV1::created); QVERIFY(createdSpy.wait()); pwStream.createStream(createdSpy.first().first().toUInt(), 0); auto fetchNextImageFrame = [&pwStream](QImage::Format format) { QSignalSpy frameSpy(&pwStream, &PipeWireSourceStream::frameReceived); if (!frameSpy.wait()) { Q_ASSERT_X(false, "", "no frame received"); return QImage(); } auto frame = frameSpy.first().first().value(); return frame.dataFrame->toImage().convertedTo(format); }; QImage expectedImage = windowImage; auto image = fetchNextImageFrame(expectedImage.format()); QCOMPAREIMG(image, expectedImage, "dynamic_initial"); QSize popupSize(5, 5); Rect anchoRect(0, 0, 1, 1); std::unique_ptr popupSurface(Test::createSurface()); std::unique_ptr positioner(Test::createXdgPositioner()); positioner->set_size(popupSize.width(), popupSize.height()); positioner->set_anchor_rect(anchoRect.x(), anchoRect.y(), anchoRect.width(), anchoRect.height()); positioner->set_gravity(Test::XdgPositioner::gravity_bottom_right); std::unique_ptr popup(Test::createXdgPopupSurface(popupSurface.get(), window.m_toplevel->xdgSurface(), positioner.get())); QImage popupImage(popupSize, QImage::Format_RGBA8888_Premultiplied); popupImage.fill(Qt::blue); auto popupWindow = Test::renderAndWaitForShown(popupSurface.get(), popupImage); QVERIFY(popupWindow); expectedImage = windowImage; QPainter(&expectedImage).drawImage(anchoRect.bottomRight(), popupImage); image = fetchNextImageFrame(expectedImage.format()); QCOMPAREIMG(image, expectedImage, "dynamic_popup"); popup.reset(); expectedImage = windowImage; image = fetchNextImageFrame(expectedImage.format()); QCOMPAREIMG(image, expectedImage, "dynamic_popup_closed"); } void ScreencastingTest::testOutputCasting() { auto theOutput = KWin::Test::waylandOutputs().constFirst(); Test::XdgToplevelWindow window{[theOutput](Test::XdgToplevel *toplevel) { toplevel->set_fullscreen(theOutput->output()); }}; QImage sourceImage(theOutput->pixelSize(), QImage::Format_RGBA8888_Premultiplied); sourceImage.fill(Qt::green); { QPainter p(&sourceImage); p.drawRect(100, 100, 100, 100); } QVERIFY(window.show(sourceImage)); QVERIFY(window.m_window->isFullScreen()); QCOMPARE(window.m_window->frameGeometry(), RectF(window.m_window->output()->geometry())); QVERIFY(window.presentWait()); auto stream = KWin::Test::screencasting()->createOutputStream(theOutput->output(), QtWayland::zkde_screencast_unstable_v1::pointer_hidden); std::optional img = oneFrameAndClose(stream); QVERIFY(img); img->convertTo(sourceImage.format()); QCOMPAREIMG(*img, sourceImage, QLatin1String("output_cast")); } } WAYLANDTEST_MAIN(KWin::ScreencastingTest) #include "screencasting_test.moc"