Differential D11250 Diff 29945 mpris2/mprismediaplayer2player.h

Changeset View

Standalone View

mpris2/mprismediaplayer2player.h

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		#ifndef MPRISMEDIAPLAYER2PLAYER_H
11		#define MPRISMEDIAPLAYER2PLAYER_H
12
13		#include "dbusabstractadaptor.h"
14		#include <core/observer.h>
15		// Qt
16		#include <QVector>
17		#include <QBitArray>
18
19		class PresentationWidget;
20
21		class QDBusObjectPath;
22		class QTemporaryDir;
23		class QAction;
24		class QUrl;
25
26		namespace Okular
27		{
28		class Document;
29
30		class MprisDocumentObserver : public QObject, public DocumentObserver
31		{
32		Q_OBJECT
33		public:
34		MprisDocumentObserver();
35
36		public:
37		void notifyCurrentPageChanged(int previous, int current) override;
38		void notifyPageChanged(int page, int flags) override;
39
40		Q_SIGNALS:
41		void currentPageChanged(int current);
42		void pixmapAvailable(int page);
43		};
44
45		/**
46		* Manages thumbnails for the pages, with each thumbnail accessable to 3rd-party
47		* via the local filesystem.
48		* Removes all files and thumbnails on destruction.
49		*
50		* To assist 3rd-party which is caching thumbnails after loading from the filesystem,
51		* on an update of a thumbnail a new unique filename is created.
52		*/
53		class MprisThumbnailStore
54		{
55		public:
56		explicit MprisThumbnailStore(Document *document);
57		~MprisThumbnailStore();
58
59		public:
60		bool addThumbnail(const QPixmap& thumbnail, int pageNumber);
61		bool hasThumbnailForPage(int pageNumber) const;
62		/// Returns invalid url if there is no thumbnail
63		QUrl thumbnailUrlForPage(int pageNumber) const;
64
65		private:
66		QString thumbnailFilePath(int pageNumber, int version) const;
67
68		private:
69		QTemporaryDir *mThumbnailCacheDir;
70		// version 0 -> no thumbnail
71		QVector<int> mThumbnailVersion;
72		QBitArray mThumbnailForPageCreated;
73		int mThumbnailWidth;
74		int mThumbnailHeight;
75		};
76
77		// https://specifications.freedesktop.org/mpris-spec/latest/Player_Interface.html
78		class MprisMediaPlayer2Player : public DBusAbstractAdaptor
79		{
80		Q_OBJECT
81		Q_CLASSINFO("D-Bus Interface", "org.mpris.MediaPlayer2.Player")
82
83		Q_PROPERTY(QString PlaybackStatus READ playbackStatus)
84		Q_PROPERTY(double Rate READ rate WRITE setRate)
85		Q_PROPERTY(QVariantMap Metadata READ metadata)
86		Q_PROPERTY(double Volume READ volume WRITE setVolume)
87		Q_PROPERTY(qlonglong Position READ position)
88		Q_PROPERTY(double MinimumRate READ minimumRate CONSTANT)
89		Q_PROPERTY(double MaximumRate READ maximumRate CONSTANT)
90
91		Q_PROPERTY(bool CanControl READ canControl CONSTANT)
92		Q_PROPERTY(bool CanPlay READ canPlay)
93		Q_PROPERTY(bool CanPause READ canPause)
94		Q_PROPERTY(bool CanGoNext READ canGoNext)
95		Q_PROPERTY(bool CanGoPrevious READ canGoPrevious)
96		Q_PROPERTY(bool CanSeek READ canSeek CONSTANT)
97
98		public:
99		MprisMediaPlayer2Player(const QString &objectDBusPath,
100		Document *document,
	aacidUnsubmitted Not Done are this ugly uppercase tyied to the spec? Isn't there like a magic way in Qt to create the api from the xml spec? aacid: are this ugly uppercase tyied to the spec? Isn't there like a magic way in Qt to create the api…
	kossebauAuthorUnsubmitted Not Done Yes, needed due to using `sessionBus.registerObject(mediaPlayer2ObjectPath(), this, QDBusConnection::ExportAdaptors);`, and D-Bus methods should be Uppercase and so does MPRIS. I only know `qt5_add_dbus_interface()` for creating nice-Qt-style API for interfaces to be used with remote objects. For local actual implementations of interfaces I am not aware how to avoid that, the other code I saw doing MPRIS implementations did things the same way as here. Might have missed something, but done to my best knowledge. kossebau: Yes, needed due to using `sessionBus.registerObject(mediaPlayer2ObjectPath(), this…
101		QAction *togglePlayPauseAction,
102		QAction *previousAction,
103		QAction *nextAction,
104		PresentationWidget *presentationWidget,
105		QObject *parent);
106		~MprisMediaPlayer2Player() override;
107
108		public Q_SLOTS: // D-Bus API
109		void Next();
110		void Previous();
111		void Pause();
112		void PlayPause();
113		void Stop();
114		void Play();
115		void Seek(qlonglong Offset);
116		void SetPosition(const QDBusObjectPath &trackId, qlonglong pos);
117		void OpenUri(const QString &uri);
118
119		Q_SIGNALS: // D-Bus API
120		void Seeked(qlonglong Position) const;
121
122		private:
123		QString playbackStatus() const;
124		double rate() const;
125		QVariantMap metadata() const;
126		double volume() const;
127		qlonglong position() const;
128		double minimumRate() const;
129		double maximumRate() const;
130
131		bool canGoNext() const;
132		bool canGoPrevious() const;
133		bool canPlay() const;
134		bool canPause() const;
135		bool canSeek() const;
136		bool canControl() const;
137
138		void setRate(double newRate);
139		void setVolume(double volume);
140
141		private:
142		void onCurrentPageChanged(int currentPage);
143		void onPixmapAvailable(int page);
144
145		void onNextActionChanged();
146		void onPreviousActionChanged();
147		void onAdvancingSlidesChanged(bool isAdvancingSlides);
148
149		void updateMetaData();
150
151		private:
152		QAction *mTogglePlayPauseShowAction;
153		QAction *mPreviousAction;
154		QAction *mNextAction;
155		PresentationWidget *mPresentationWidget;
156		Document *mDocument;
157		MprisDocumentObserver mDocumentObserver;
158		MprisThumbnailStore mThumbnailStore;
159		int mThumbnailWidth;
160		int mThumbnailHeight;
161
162		bool mPreviousEnabled;
163		bool mNextEnabled;
164		QVariantMap mMetaData;
165		};
166
167		}
168
169		#endif