Differential D11250 Diff 29945 mpris2/mprismediaplayer2player.cpp

Changeset View

Standalone View

View Options

mpris2/mprismediaplayer2player.cpp

  • This file was added.
1​/***************************************************************************
2​ * Copyright 2018 Friedrich W. H. Kossebau <kossebau@kde.org> *
3​ * *
4​ * This program is free software; you can redistribute it and/or modify *
5​ * it under the terms of the GNU General Public License as published by *
6​ * the Free Software Foundation; either version 2 of the License, or *
7​ * (at your option) any later version. *
8​ ***************************************************************************/
9​
10​#include "mprismediaplayer2player.h"
11​
12​// lib
13​#include <ui/presentationwidget.h>
14​#include <ui/priorities.h>
15​#include <ui/pagepainter.h>
16​#include <core/document.h>
17​#include <core/page.h>
18​#include <core/generator.h>
19​// KF
20​#include <KLocalizedString>
21​// Qt
22​#include <QDBusObjectPath>
23​#include <QAction>
24​#include <QTemporaryDir>
25​#include <QFile>
26​#include <QLinkedList>
27​#include <QPainter>
28​#include <QDebug>
29​
30​namespace Okular
31​{
32​
33​static const double MAX_RATE = 1.0;
34​static const double MIN_RATE = 1.0;
35​
36​
37​MprisDocumentObserver::MprisDocumentObserver()
38​{
39​}
40​
41​void MprisDocumentObserver::notifyCurrentPageChanged(int previous, int current)
42​{
43​ Q_UNUSED(previous);
44​
45​ emit currentPageChanged(current);
46​}
47​
48​void MprisDocumentObserver::notifyPageChanged(int page, int flags)
49​{
50​ if (flags & Pixmap) {
51​ // TODO: can we be sure about this?
aacidUnsubmitted
Not Done

Should be about right

aacid: Should be about right
52​ emit pixmapAvailable(page);
53​ }
54​}
55​
56​
57​MprisThumbnailStore::MprisThumbnailStore(Document *document)
58​ : mThumbnailCacheDir(new QTemporaryDir)
59​ // TODO: how to learn that the number of pages has changed?
aacidUnsubmitted
Not Done

No, you can not, file can change at any moment.

aacid: No, you can not, file can change at any moment.
kossebauAuthorUnsubmitted
Not Done

Also during presentation? Okay. Any change signal you would recommend to catch here? Would encode some thumbnail versioning then to ensure uniquness.

kossebau: Also during presentation? Okay. Any change signal you would recommend to catch here? Would…
60​ , mThumbnailVersion(document->pages(), 0)
61​{
62​}
63​
64​MprisThumbnailStore::~MprisThumbnailStore()
65​{
66​ delete mThumbnailCacheDir;
67​}
68​
69​bool MprisThumbnailStore::addThumbnail(const QPixmap& thumbnail, int pageNumber)
70​{
71​ Q_ASSERT(0 <= pageNumber && pageNumber < mThumbnailVersion.size());
72​ if (pageNumber < 0 || mThumbnailVersion.size() < pageNumber) {
73​ return false;
74​ }
75​
76​ int& version = mThumbnailVersion[pageNumber];
77​
78​ // TODO: do we need to protect against overflow? nobody would need 2^31 updates, right? ;)
79​ const int newVersion = (version + 1);
80​ const QString newThumbnailFilePath = thumbnailFilePath(pageNumber, newVersion);
81​
82​ const bool success = thumbnail.save(newThumbnailFilePath, "PNG");
83​ if (success) {
84​ const int oldVersion = version;
85​ version = newVersion;
86​ if (oldVersion > 0) {
87​ QFile::remove(thumbnailFilePath(pageNumber, oldVersion));
88​ }
89​ } else {
90​ qWarning() << "Could not save thumbbail to file" << newThumbnailFilePath;
91​ }
92​
93​ return success;
94​}
95​
96​bool MprisThumbnailStore::hasThumbnailForPage(int pageNumber) const
97​{
98​ Q_ASSERT(0 <= pageNumber && pageNumber < mThumbnailVersion.size());
99​ if (pageNumber < 0 || mThumbnailVersion.size() < pageNumber) {
100​ return false;
101​ }
102​
103​ return (mThumbnailVersion[pageNumber] > 0);
104​}
105​
106​QUrl MprisThumbnailStore::thumbnailUrlForPage(int pageNumber) const
107​{
108​ Q_ASSERT(0 <= pageNumber && pageNumber < mThumbnailVersion.size());
109​ if (pageNumber < 0 || mThumbnailVersion.size() < pageNumber) {
110​ return QUrl();
111​ }
112​
113​ const int version = mThumbnailVersion[pageNumber];
114​ if (version == 0) {
115​ return QUrl();
116​ }
117​
118​ return QUrl::fromLocalFile(thumbnailFilePath(pageNumber, version));
119​}
120​
121​QString MprisThumbnailStore::thumbnailFilePath(int pageNumber, int version) const
122​{
123​ const QString fileName = QString::number(pageNumber) + QLatin1Char('-') + QString::number(version) + QLatin1String(".png");
124​ return mThumbnailCacheDir->path() + QLatin1Char('/') + fileName;
125​}
126​
127​
128​static inline
129​QString playbackStatusFromAdvancingSlides(bool isAdvancingSlides)
130​{
131​ return isAdvancingSlides ? QStringLiteral("Playing") : QStringLiteral("Paused");
132​}
133​
134​
135​MprisMediaPlayer2Player::MprisMediaPlayer2Player(const QString &objectDBusPath,
136​ Document *document,
137​ QAction *togglePlayPauseAction,
138​ QAction *previousAction,
139​ QAction *nextAction,
140​ PresentationWidget *presentationWidget,
141​ QObject *parent)
142​ : DBusAbstractAdaptor(objectDBusPath, parent)
143​ , mTogglePlayPauseShowAction(togglePlayPauseAction)
144​ , mPreviousAction(previousAction)
145​ , mNextAction(nextAction)
146​ , mPresentationWidget(presentationWidget)
147​ , mDocument(document)
148​ , mThumbnailStore(document)
149​ , mThumbnailWidth(256)
150​ , mThumbnailHeight(256)
151​ , mPreviousEnabled(mPreviousAction->isEnabled())
152​ , mNextEnabled(mNextAction->isEnabled())
153​{
154​ mDocument->addObserver(&mDocumentObserver);
155​
156​ connect(&mDocumentObserver, &MprisDocumentObserver::currentPageChanged,
157​ this, &MprisMediaPlayer2Player::onCurrentPageChanged);
158​ connect(&mDocumentObserver, &MprisDocumentObserver::pixmapAvailable,
159​ this, &MprisMediaPlayer2Player::onPixmapAvailable);
160​
161​ connect(mNextAction, &QAction::changed,
162​ this, &MprisMediaPlayer2Player::onNextActionChanged);
163​ connect(mPreviousAction, &QAction::changed,
164​ this, &MprisMediaPlayer2Player::onPreviousActionChanged);
165​ connect(mPresentationWidget, &PresentationWidget::advancingSlidesChanged,
166​ this, &MprisMediaPlayer2Player::onAdvancingSlidesChanged);
167​
168​ onCurrentPageChanged(mDocument->currentPage());
169​}
170​
171​MprisMediaPlayer2Player::~MprisMediaPlayer2Player()
172​{
173​ mDocument->removeObserver(&mDocumentObserver);
174​}
175​
176​QString MprisMediaPlayer2Player::playbackStatus() const
177​{
178​ return playbackStatusFromAdvancingSlides(mPresentationWidget->isAdvancingSlides());
179​}
180​
181​bool MprisMediaPlayer2Player::canGoNext() const
182​{
183​ return mNextEnabled;
184​}
185​
186​void MprisMediaPlayer2Player::Next()
187​{
188​ mNextAction->trigger();
189​}
190​
191​
192​bool MprisMediaPlayer2Player::canGoPrevious() const
193​{
194​ return mPreviousEnabled;
195​}
196​
197​void MprisMediaPlayer2Player::Previous()
198​{
199​ mPreviousAction->trigger();
200​}
201​
202​bool MprisMediaPlayer2Player::canPause() const
203​{
204​ return true;
205​}
206​
207​void MprisMediaPlayer2Player::Pause()
208​{
209​ if (!mPresentationWidget->isAdvancingSlides()) {
210​ return;
211​ }
212​
213​ mTogglePlayPauseShowAction->trigger();
214​}
215​
216​void MprisMediaPlayer2Player::PlayPause()
217​{
218​ mTogglePlayPauseShowAction->trigger();
219​}
220​
221​void MprisMediaPlayer2Player::Stop()
222​{
223​ mPresentationWidget->close();
224​}
225​
226​bool MprisMediaPlayer2Player::canPlay() const
227​{
228​ return true;
229​}
230​
231​void MprisMediaPlayer2Player::Play()
232​{
233​ if (mPresentationWidget->isAdvancingSlides()) {
234​ return;
235​ }
236​
237​ mTogglePlayPauseShowAction->trigger();
238​}
239​
240​double MprisMediaPlayer2Player::volume() const
241​{
242​ // TODO: support any audio playing
243​ return 0;
244​}
245​
246​void MprisMediaPlayer2Player::setVolume(double volume)
247​{
248​ Q_UNUSED(volume);
249​ // TODO: support any audio playing
250​}
251​
252​QVariantMap MprisMediaPlayer2Player::metadata() const
253​{
254​ return mMetaData;
255​}
256​
257​qlonglong MprisMediaPlayer2Player::position() const
258​{
259​ return 0;
260​}
261​
262​double MprisMediaPlayer2Player::rate() const
263​{
264​ return 1.0;
265​}
266​
267​void MprisMediaPlayer2Player::setRate(double newRate)
268​{
269​ Q_UNUSED(newRate);
270​}
271​
272​double MprisMediaPlayer2Player::minimumRate() const
273​{
274​ return MIN_RATE;
275​}
276​
277​double MprisMediaPlayer2Player::maximumRate() const
278​{
279​ return MAX_RATE;
280​}
281​
282​
283​bool MprisMediaPlayer2Player::canSeek() const
284​{
285​ return false;
286​}
287​
288​bool MprisMediaPlayer2Player::canControl() const
289​{
290​ return true;
291​}
292​
293​void MprisMediaPlayer2Player::Seek(qlonglong offset)
294​{
295​ Q_UNUSED(offset);
296​}
297​
298​void MprisMediaPlayer2Player::SetPosition(const QDBusObjectPath& trackId, qlonglong pos)
299​{
300​ Q_UNUSED(trackId);
301​ Q_UNUSED(pos);
302​}
303​
304​void MprisMediaPlayer2Player::OpenUri(const QString &uri)
305​{
aacidUnsubmitted
Not Done

Why do you need that?

aacid: Why do you need that?
kossebauAuthorUnsubmitted
Not Done

To avoid creating repeated requests for the same pixmap.

Challenge I see: I need to get a thumbnail per page. To speed-up things, it will be done only for pages currently visited. But given the request is processed async, when a user switches pages while the requests are still on-going, when entering the same page multiple times multiple requests would be created, one per visit.

Is there some internal mechanism to squash such requests?

kossebau: To avoid creating repeated requests for the same pixmap. Challenge I see: I need to get a…
306​ Q_UNUSED(uri);
307​}
308​
309​
310​void MprisMediaPlayer2Player::onCurrentPageChanged(int currentPage)
311​{
312​ // trigger thumbnail generation
313​ QLinkedList<PixmapRequest*> thumbnailRequests;
314​
315​ // TODO: how to find out if there still is another pixmap request ongoing?
316​ // not a QObject, so cannot connect to destroyed signal
317​ if (!mThumbnailStore.hasThumbnailForPage(currentPage)) {
318​ PixmapRequest *currentPageRequest = new PixmapRequest(&mDocumentObserver, currentPage, mThumbnailWidth, mThumbnailHeight, THUMBNAILS_PRIO, PixmapRequest::Asynchronous);
319​ thumbnailRequests.append(currentPageRequest);
320​ }
321​
322​ // pregenerate thumbnail of one before & after
323​ // TODO: use okular memory settings to decide about generating all
324​ if (currentPage > 0) {
325​ const int previousPage = currentPage-1;
326​ if (!mThumbnailStore.hasThumbnailForPage(previousPage)) {
327​ PixmapRequest *previousPageRequest = new PixmapRequest(&mDocumentObserver, previousPage, mThumbnailWidth, mThumbnailHeight, THUMBNAILS_PRELOAD_PRIO, PixmapRequest::Asynchronous);
328​ thumbnailRequests.append(previousPageRequest);
329​ }
330​ }
331​ if (currentPage < (int)mDocument->pages()-1) {
332​ const int nextPage = currentPage + 1;
333​ if (!mThumbnailStore.hasThumbnailForPage(nextPage)) {
334​ PixmapRequest *nextPageRequest = new PixmapRequest(&mDocumentObserver, nextPage, mThumbnailWidth, mThumbnailHeight, THUMBNAILS_PRELOAD_PRIO, PixmapRequest::Asynchronous);
335​ thumbnailRequests.append(nextPageRequest);
336​ }
337​ }
338​
339​ if (!thumbnailRequests.isEmpty()) {
340​ mDocument->requestPixmaps(thumbnailRequests);
341​ }
342​
343​ updateMetaData();
344​}
345​
346​
347​void MprisMediaPlayer2Player::updateMetaData()
348​{
349​ const int currentPage = mDocument->currentPage();
350​
351​ QVariantMap updatedMetaData;
352​
353​ const QDBusObjectPath trackId(QLatin1String("/org/kde/okular/pagelist/") + QString::number(currentPage));
354​ updatedMetaData.insert(QStringLiteral("mpris:trackid"),
355​ QVariant::fromValue<QDBusObjectPath>(trackId));
356​
357​ // TODO: implement other MPRIS API for position
358​ // convert seconds in microseconds
359​ // const qlonglong duration = qlonglong(mSlideShow->interval() * 1000000);
360​ // updatedMetaData.insert(QStringLiteral("mpris:length"), duration);
361​
362​ updatedMetaData.insert(QStringLiteral("xesam:title"), i18n("Page %1", currentPage+1));
363​
364​ // slight bending of semantics :)
365​ const Okular::DocumentInfo info = mDocument->documentInfo(QSet<DocumentInfo::Key> {
366​ Okular::DocumentInfo::Title
367​ });
368​ const QString title = info.get(Okular::DocumentInfo::Title);
369​ if (!title.isEmpty()) {
370​ updatedMetaData.insert(QStringLiteral("xesam:album"), title);
371​ }
372​
373​ const QUrl thumbnailUrl = mThumbnailStore.thumbnailUrlForPage(currentPage);
374​ if (thumbnailUrl.isValid()) {
375​ updatedMetaData.insert(QStringLiteral("mpris:artUrl"), thumbnailUrl.toString());
376​ }
377​
378​ // consider export of other metadata where mapping works
379​
380​ if (updatedMetaData != mMetaData) {
381​ mMetaData = updatedMetaData;
382​
383​ signalPropertyChange("Metadata", mMetaData);
384​ }
385​}
386​
387​void MprisMediaPlayer2Player::onPixmapAvailable(int pageNumber)
388​{
389​ const Page *page = mDocument->page(pageNumber);
390​
391​ const float thumbnailRatio = (float)mThumbnailWidth / mThumbnailHeight;
392​ const float pageRatio = page->ratio();
393​ int pageWidth;
394​ int pageHeight;
395​ if (pageRatio > thumbnailRatio) {
396​ pageHeight = mThumbnailHeight;
397​ pageWidth = (int)((float)pageHeight / pageRatio);
398​ } else {
399​ pageWidth = mThumbnailWidth;
400​ pageHeight = (int)((float)pageWidth * pageRatio);
401​ }
402​
403​ const QRect rect(0, 0, pageWidth, pageHeight);
404​ QPixmap thumbnail(rect.size());
405​ QPainter painter(&thumbnail);
406​ const int flags = PagePainter::Accessibility | PagePainter::Highlights | PagePainter::Annotations;
407​ PagePainter::paintPageOnPainter(&painter, page, &mDocumentObserver, flags,
408​ pageWidth, pageHeight, rect);
409​
410​ const bool success = mThumbnailStore.addThumbnail(thumbnail, pageNumber);
411​ if (success && pageNumber == (int)mDocument->currentPage()) {
412​ updateMetaData();
413​ }
414​}
415​
416​void MprisMediaPlayer2Player::onNextActionChanged()
417​{
418​ const bool isEnabled = mNextAction->isEnabled();
419​ if (mNextEnabled == isEnabled) {
420​ return;
421​ }
422​
423​ mNextEnabled = isEnabled;
424​
425​ signalPropertyChange("CanGoNext", mNextEnabled);
426​}
427​
428​
429​void MprisMediaPlayer2Player::onPreviousActionChanged()
430​{
431​ const bool isEnabled = mPreviousAction->isEnabled();
432​ if (mPreviousEnabled == isEnabled) {
433​ return;
434​ }
435​
436​ mPreviousEnabled = isEnabled;
437​
438​ signalPropertyChange("CanGoPrevious", mPreviousEnabled);
439​}
440​
441​void MprisMediaPlayer2Player::onAdvancingSlidesChanged(bool isAdvancingSlides)
442​{
443​ signalPropertyChange("PlaybackStatus", playbackStatusFromAdvancingSlides(isAdvancingSlides));
444​}
445​
446​}