1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
|
/*
SPDX-FileCopyrightText: 2022 Aleix Pol Gonzalez <aleixpol@kde.org>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#include <KSignalHandler>
#include <QCommandLineParser>
#include <QDebug>
#include <QGuiApplication>
#include <QScreen>
#include "screencasting.h"
#include "xdp_dbus_remotedesktop_interface.h"
#include "xdp_dbus_screencast_interface.h"
#include <DmaBufHandler>
#include <PipeWireEncodedStream>
#include <PipeWireSourceStream>
#include <QDBusArgument>
#include <unistd.h>
using namespace Qt::StringLiterals;
static bool s_encodedStream = false;
static std::optional<Fraction> s_framerate;
static std::optional<QByteArray> s_encoder;
static Screencasting::CursorMode s_cursorMode = Screencasting::Embedded;
static QString createHandleToken()
{
return QStringLiteral("kpipewireheadlesstest%1").arg(QRandomGenerator::global()->generate());
}
void createStream(int nodeId, std::optional<int> fd = {})
{
if (s_encodedStream) {
auto encoded = new PipeWireEncodedStream(qGuiApp);
encoded->setNodeId(nodeId);
if (fd) {
encoded->setFd(*fd);
}
if (s_framerate) {
encoded->setMaxFramerate(*s_framerate);
}
if (s_encoder) {
PipeWireBaseEncodedStream::Encoder enc = PipeWireBaseEncodedStream::NoEncoder;
if (s_encoder.value() == QByteArray("H264Main")) {
enc = PipeWireBaseEncodedStream::H264Main;
} else if (s_encoder.value() == QByteArray("H264Baseline")) {
enc = PipeWireBaseEncodedStream::H264Baseline;
} else if (s_encoder.value() == QByteArray("VP8")) {
enc = PipeWireBaseEncodedStream::VP8;
} else if (s_encoder.value() == QByteArray("VP9")) {
enc = PipeWireBaseEncodedStream::VP9;
}
encoded->setEncoder(enc);
}
encoded->start();
QObject::connect(encoded, &PipeWireEncodedStream::newPacket, qGuiApp, [](const PipeWireEncodedStream::Packet &packet) {
qDebug() << "packet received" << packet.data().size() << "key:" << packet.isKeyFrame();
});
QObject::connect(encoded, &PipeWireEncodedStream::cursorChanged, qGuiApp, [](const PipeWireCursor &cursor) {
qDebug() << "cursor received. position:" << cursor.position << "hotspot:" << cursor.hotspot << "image:" << cursor.texture;
});
QObject::connect(encoded, &PipeWireEncodedStream::stateChanged, qGuiApp, [encoded]() {
switch (encoded->state()) {
case PipeWireEncodedStream::Recording:
qDebug() << "Started recording";
break;
case PipeWireEncodedStream::Rendering:
qDebug() << "Stopped recording, flushing remaining frames";
break;
case PipeWireEncodedStream::Idle:
qDebug() << "Recording finished, quitting";
exit(0);
break;
}
});
QObject::connect(KSignalHandler::self(), &KSignalHandler::signalReceived, encoded, [encoded] {
encoded->stop();
});
return;
}
auto pwStream = new PipeWireSourceStream(qGuiApp);
pwStream->setAllowDmaBuf(false);
if (s_framerate) {
pwStream->setMaxFramerate(*s_framerate);
}
if (!pwStream->createStream(nodeId, 0)) {
qWarning() << "failed!" << pwStream->error();
exit(1);
}
auto handler = std::make_shared<DmaBufHandler>();
QObject::connect(pwStream, &PipeWireSourceStream::frameReceived, qGuiApp, [handler, pwStream](const PipeWireFrame &frame) {
if (frame.dmabuf) {
QImage qimage(pwStream->size(), QImage::Format_RGBA8888);
if (!handler->downloadFrame(qimage, frame)) {
qDebug() << "failed to download frame";
pwStream->renegotiateModifierFailed(frame.format, frame.dmabuf->modifier);
} else {
qDebug() << "dmabuf" << frame.format;
}
} else if (frame.dataFrame) {
qDebug() << "image" << frame.dataFrame->format << frame.format;
} else {
qDebug() << "no-frame";
}
});
QObject::connect(KSignalHandler::self(), &KSignalHandler::signalReceived, pwStream, [pwStream] {
pwStream->setActive(false);
});
}
void processStream(ScreencastingStream *stream)
{
QObject::connect(stream, &ScreencastingStream::created, qGuiApp, [](int nodeId) {
createStream(nodeId);
});
}
void checkPlasmaScreens()
{
auto screencasting = new Screencasting(qGuiApp);
for (auto screen : qGuiApp->screens()) {
auto stream = screencasting->createOutputStream(screen->name(), s_cursorMode);
processStream(stream);
}
}
void checkPlasmaWorkspace()
{
auto screencasting = new Screencasting(qGuiApp);
QRegion region;
for (auto screen : qGuiApp->screens()) {
region |= screen->geometry();
}
auto stream = screencasting->createRegionStream(region.boundingRect(), 1, s_cursorMode);
processStream(stream);
}
using Stream = struct {
uint nodeId;
QVariantMap map;
};
using Streams = QList<Stream>;
Q_DECLARE_METATYPE(Stream);
Q_DECLARE_METATYPE(Streams);
const QDBusArgument &operator>>(const QDBusArgument &arg, Stream &stream)
{
arg.beginStructure();
arg >> stream.nodeId;
arg.beginMap();
while (!arg.atEnd()) {
QString key;
QVariant map;
arg.beginMapEntry();
arg >> key >> map;
arg.endMapEntry();
stream.map.insert(key, map);
}
arg.endMap();
arg.endStructure();
return arg;
}
class XdpScreenCast : public QObject
{
Q_OBJECT
public:
XdpScreenCast(QObject *parent)
: QObject(parent)
{
initDbus();
}
void initDbus()
{
dbusXdpScreenCastService.reset(new OrgFreedesktopPortalScreenCastInterface(QStringLiteral("org.freedesktop.portal.Desktop"),
QStringLiteral("/org/freedesktop/portal/desktop"),
QDBusConnection::sessionBus()));
qInfo() << "Initializing D-Bus connectivity with XDG Desktop Portal" << dbusXdpScreenCastService->version();
Q_ASSERT(dbusXdpScreenCastService->isValid());
// create session
auto sessionParameters =
QVariantMap{{QStringLiteral("session_handle_token"), createHandleToken()}, {QStringLiteral("handle_token"), createHandleToken()}};
auto sessionReply = dbusXdpScreenCastService->CreateSession(sessionParameters);
sessionReply.waitForFinished();
if (!sessionReply.isValid()) {
qWarning() << "Couldn't initialize XDP-KDE screencast session" << sessionReply.error();
exit(1);
return;
}
qInfo() << "DBus session created: " << sessionReply.value().path()
<< QDBusConnection::sessionBus().connect(QString(),
sessionReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleSessionCreated(uint, QVariantMap)));
}
public Q_SLOTS:
void handleSessionCreated(quint32 code, const QVariantMap &results)
{
if (code != 0) {
qWarning() << "Failed to create session: " << code;
exit(1);
return;
}
sessionPath = QDBusObjectPath(results.value(QStringLiteral("session_handle")).toString());
// select sources for the session
const QVariantMap sourcesParameters = {{QLatin1String("handle_token"), createHandleToken()},
{QLatin1String("types"), dbusXdpScreenCastService->availableSourceTypes()},
{QLatin1String("multiple"), false},
{QLatin1String("cursor_mode"), uint(2 /*Embedded*/)}};
auto selectorReply = dbusXdpScreenCastService->SelectSources(sessionPath, sourcesParameters);
selectorReply.waitForFinished();
if (!selectorReply.isValid()) {
qWarning() << "Couldn't select devices for the remote-desktop session";
exit(1);
return;
}
QDBusConnection::sessionBus().connect(QString(),
selectorReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleSourcesSelected(uint, QVariantMap)));
}
void handleSourcesSelected(quint32 code, const QVariantMap &)
{
if (code != 0) {
qWarning() << "Failed to select sources: " << code;
exit(1);
return;
}
// start session
auto startParameters = QVariantMap{{QStringLiteral("handle_token"), createHandleToken()}};
auto startReply = dbusXdpScreenCastService->Start(sessionPath, QString(), startParameters);
startReply.waitForFinished();
QDBusConnection::sessionBus().connect(QString(),
startReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleRemoteDesktopStarted(uint, QVariantMap)));
}
void handleRemoteDesktopStarted(quint32 code, const QVariantMap &results)
{
if (code != 0) {
qWarning() << "Failed to start screencast: " << code;
exit(1);
return;
}
// there should be only one stream
const Streams streams = qdbus_cast<Streams>(results.value(QStringLiteral("streams")));
if (streams.isEmpty()) {
// maybe we should check deeper with qdbus_cast but this suffices for now
qWarning() << "Failed to get screencast streams";
exit(1);
return;
}
const QVariantMap startParameters = {
{ QLatin1String("handle_token"), createHandleToken() }
};
auto streamReply = dbusXdpScreenCastService->OpenPipeWireRemote(sessionPath, startParameters);
streamReply.waitForFinished();
if (!streamReply.isValid()) {
qWarning() << "Couldn't open pipewire remote for the screen-casting session";
exit(1);
return;
}
auto pipewireFd = streamReply.value();
if (!pipewireFd.isValid()) {
qWarning() << "Couldn't get pipewire connection file descriptor";
exit(1);
return;
}
const uint fd = pipewireFd.takeFileDescriptor();
for (auto x : streams) {
createStream(x.nodeId, fd);
}
}
private:
QScopedPointer<OrgFreedesktopPortalScreenCastInterface> dbusXdpScreenCastService;
QDBusObjectPath sessionPath;
};
class XdpRemoteDesktop : public QObject
{
Q_OBJECT
public:
XdpRemoteDesktop(QObject *parent)
: QObject(parent)
{
initDbus();
}
void initDbus()
{
dbusXdpScreenCastService.reset(new OrgFreedesktopPortalScreenCastInterface(QStringLiteral("org.freedesktop.portal.Desktop"),
QStringLiteral("/org/freedesktop/portal/desktop"),
QDBusConnection::sessionBus()));
dbusXdpRemoteDesktopService.reset(new OrgFreedesktopPortalRemoteDesktopInterface(QStringLiteral("org.freedesktop.portal.Desktop"),
QStringLiteral("/org/freedesktop/portal/desktop"),
QDBusConnection::sessionBus()));
qInfo() << "Initializing D-Bus connectivity with XDG Desktop Portal" << dbusXdpScreenCastService->version();
Q_ASSERT(dbusXdpScreenCastService->isValid());
Q_ASSERT(dbusXdpRemoteDesktopService->isValid());
// create session
auto sessionParameters =
QVariantMap{{QStringLiteral("session_handle_token"), createHandleToken()}, {QStringLiteral("handle_token"), createHandleToken()}};
auto sessionReply = dbusXdpRemoteDesktopService->CreateSession(sessionParameters);
sessionReply.waitForFinished();
if (!sessionReply.isValid()) {
qWarning() << "Couldn't initialize XDP-KDE screencast session" << sessionReply.error();
exit(1);
return;
}
qInfo() << "DBus session created: " << sessionReply.value().path()
<< QDBusConnection::sessionBus().connect(QString(),
sessionReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleSessionCreated(uint, QVariantMap)));
}
public Q_SLOTS:
void handleSessionCreated(quint32 code, const QVariantMap &results)
{
if (code != 0) {
qWarning() << "Failed to create session: " << code;
exit(1);
return;
}
sessionPath = QDBusObjectPath(results.value(QStringLiteral("session_handle")).toString());
// select sources for the session
auto selectionOptions = QVariantMap{// We have to specify it's an uint, otherwise xdg-desktop-portal will not forward it to backend implementation
{QStringLiteral("types"), QVariant::fromValue<uint>(7)}, // request all (KeyBoard, Pointer, TouchScreen)
{QStringLiteral("handle_token"), createHandleToken()}};
auto selectorReply = dbusXdpRemoteDesktopService->SelectDevices(sessionPath, selectionOptions);
selectorReply.waitForFinished();
if (!selectorReply.isValid()) {
qWarning() << "Couldn't select devices for the remote-desktop session";
exit(1);
return;
}
QDBusConnection::sessionBus().connect(QString(),
selectorReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleDevicesSelected(uint, QVariantMap)));
}
void handleDevicesSelected(quint32 code, const QVariantMap &results)
{
Q_UNUSED(results)
if (code != 0) {
qWarning() << "Failed to select devices: " << code;
exit(1);
return;
}
// select sources for the session
auto selectionOptions = QVariantMap{{QStringLiteral("types"), QVariant::fromValue<uint>(7)},
{QStringLiteral("multiple"), false},
{QStringLiteral("handle_token"), createHandleToken()}};
auto selectorReply = dbusXdpScreenCastService->SelectSources(sessionPath, selectionOptions);
selectorReply.waitForFinished();
if (!selectorReply.isValid()) {
qWarning() << "Couldn't select sources for the screen-casting session";
exit(1);
return;
}
QDBusConnection::sessionBus().connect(QString(),
selectorReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleSourcesSelected(uint, QVariantMap)));
}
void handleSourcesSelected(quint32 code, const QVariantMap &)
{
if (code != 0) {
qWarning() << "Failed to select sources: " << code;
exit(1);
return;
}
// start session
auto startParameters = QVariantMap{{QStringLiteral("handle_token"), createHandleToken()}};
auto startReply = dbusXdpRemoteDesktopService->Start(sessionPath, QString(), startParameters);
startReply.waitForFinished();
QDBusConnection::sessionBus().connect(QString(),
startReply.value().path(),
QStringLiteral("org.freedesktop.portal.Request"),
QStringLiteral("Response"),
this,
SLOT(handleRemoteDesktopStarted(uint, QVariantMap)));
}
void handleRemoteDesktopStarted(quint32 code, const QVariantMap &results)
{
if (code != 0) {
qWarning() << "Failed to start screencast: " << code;
exit(1);
return;
}
if (results.value(QStringLiteral("devices")).toUInt() == 0) {
qWarning() << "No devices were granted" << results;
exit(1);
return;
}
// there should be only one stream
const Streams streams = qdbus_cast<Streams>(results.value(QStringLiteral("streams")));
if (streams.isEmpty()) {
// maybe we should check deeper with qdbus_cast but this suffices for now
qWarning() << "Failed to get screencast streams";
exit(1);
return;
}
auto streamReply = dbusXdpScreenCastService->OpenPipeWireRemote(sessionPath, QVariantMap());
streamReply.waitForFinished();
if (!streamReply.isValid()) {
qWarning() << "Couldn't open pipewire remote for the screen-casting session";
exit(1);
return;
}
auto pipewireFd = streamReply.value();
if (!pipewireFd.isValid()) {
qWarning() << "Couldn't get pipewire connection file descriptor";
exit(1);
return;
}
const uint fd = pipewireFd.takeFileDescriptor();
for (auto x : streams) {
createStream(x.nodeId, fd);
}
}
private:
QScopedPointer<OrgFreedesktopPortalScreenCastInterface> dbusXdpScreenCastService;
QScopedPointer<OrgFreedesktopPortalRemoteDesktopInterface> dbusXdpRemoteDesktopService;
QDBusObjectPath sessionPath;
};
int main(int argc, char **argv)
{
QGuiApplication app(argc, argv);
{
QCommandLineParser parser;
const QMap<QString, Screencasting::CursorMode> cursorOptions = {
{QStringLiteral("hidden"), Screencasting::CursorMode::Hidden},
{QStringLiteral("embedded"), Screencasting::CursorMode::Embedded},
{QStringLiteral("metadata"), Screencasting::CursorMode::Metadata},
};
QCommandLineOption cursorOption(QStringLiteral("cursor"),
QStringList(cursorOptions.keys()).join(QStringLiteral(", ")),
QStringLiteral("mode"),
QStringLiteral("metadata"));
KSignalHandler::self()->watchSignal(SIGTERM);
KSignalHandler::self()->watchSignal(SIGINT);
QCommandLineOption useXdpRD(QStringLiteral("xdp-remotedesktop"), QStringLiteral("Uses the XDG Desktop Portal RemoteDesktop interface"));
parser.addOption(useXdpRD);
QCommandLineOption useXdpSC(QStringLiteral("xdp-screencast"), QStringLiteral("Uses the XDG Desktop Portal ScreenCast interface"));
parser.addOption(useXdpSC);
QCommandLineOption useWorkspace(QStringLiteral("workspace"), QStringLiteral("Uses the Plasma screencasting workspace feed"));
parser.addOption(useWorkspace);
QCommandLineOption encodedStream(QStringLiteral("encoded"), QStringLiteral("Reports encoded streams with PipeWireEncodedStream"));
parser.addOption(encodedStream);
QCommandLineOption streamEncoder(QStringLiteral("encoder"),
QStringLiteral("Which encoding to use with PipeWireEncodedStream"),
u"encoding"_s,
u"libvpx"_s);
parser.addOption(streamEncoder);
QCommandLineOption streamFramerate(QStringLiteral("framerate"),
QStringLiteral("Makes sure a framerate is requested (format 30/1 would mean 30fps)"),
QStringLiteral("num/denom"));
parser.addOption(streamFramerate);
parser.addOption(cursorOption);
parser.addHelpOption();
parser.process(app);
s_cursorMode = cursorOptions[parser.value(cursorOption).toLower()];
s_encodedStream = parser.isSet(encodedStream);
if (parser.isSet(streamEncoder)) {
s_encoder = parser.value(streamEncoder).toUtf8();
}
if (parser.isSet(streamFramerate)) {
const auto framerateString = parser.value(streamFramerate).split(u'/');
if (framerateString.count() != 2) {
qWarning() << "wrong framerate" << framerateString;
return 1;
}
s_framerate = {framerateString.constFirst().toUInt(), framerateString.constLast().toUInt()};
}
if (parser.isSet(useXdpRD)) {
new XdpRemoteDesktop(&app);
} else if (parser.isSet(useXdpSC)) {
new XdpScreenCast(&app);
} else if (parser.isSet(useWorkspace)) {
checkPlasmaWorkspace();
} else {
checkPlasmaScreens();
}
}
return app.exec();
}
#include "HeadlessTest.moc"
|
