Implement resource policy plugin using libresourceqt.
authorRobin Burchell <robin.burchell@jollamobile.com>
Fri, 2 Aug 2013 22:27:40 +0000 (00:27 +0200)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Mon, 5 Aug 2013 16:08:53 +0000 (18:08 +0200)
This contains a new resource policy plugin, replacing the built-in
code that was deleted when the plugin interface was removed in
138242fb2dc19438a0ead34b36af848800e27190 (which unfortunately did not provide a
plugin).

Change-Id: Iae7ed6edc330c69ca0c72d50bde6c7e12b8cca4e
Reviewed-by: Andy Nichols <andy.nichols@digia.com>
src/plugins/plugins.pro
src/plugins/resourcepolicy/resourcepolicy.json [new file with mode: 0644]
src/plugins/resourcepolicy/resourcepolicy.pro [new file with mode: 0644]
src/plugins/resourcepolicy/resourcepolicyimpl.cpp [new file with mode: 0644]
src/plugins/resourcepolicy/resourcepolicyimpl.h [new file with mode: 0644]
src/plugins/resourcepolicy/resourcepolicyplugin.cpp [new file with mode: 0644]
src/plugins/resourcepolicy/resourcepolicyplugin.h [new file with mode: 0644]

index 8f751ae..8234e7e 100644 (file)
@@ -53,3 +53,7 @@ mac:!simulator {
     }
 }
 
+config_resourcepolicy {
+    SUBDIRS += resourcepolicy
+}
+
diff --git a/src/plugins/resourcepolicy/resourcepolicy.json b/src/plugins/resourcepolicy/resourcepolicy.json
new file mode 100644 (file)
index 0000000..d751b84
--- /dev/null
@@ -0,0 +1,4 @@
+{
+    "Keys": ["resourcepolicy"],
+    "Services": ["org.qt-project.qt.mediaplayerresourcesetfactory", "default"]
+}
diff --git a/src/plugins/resourcepolicy/resourcepolicy.pro b/src/plugins/resourcepolicy/resourcepolicy.pro
new file mode 100644 (file)
index 0000000..7aa1ced
--- /dev/null
@@ -0,0 +1,21 @@
+TARGET = resourceqt
+
+QT += multimedia-private
+CONFIG += no_private_qt_headers_warning link_pkgconfig
+PKGCONFIG += libresourceqt5
+
+PLUGIN_TYPE = resourcepolicy
+PLUGIN_CLASS_NAME = ResourceQtPolicyPlugin
+load(qt_plugin)
+
+INCLUDEPATH += $$PWD \
+    $${SOURCE_DIR}/src/multimedia
+
+HEADERS += \
+    $$PWD/resourcepolicyplugin.h \
+    $$PWD/resourcepolicyimpl.h
+
+SOURCES += \
+    $$PWD/resourcepolicyplugin.cpp \
+    $$PWD/resourcepolicyimpl.cpp
+
diff --git a/src/plugins/resourcepolicy/resourcepolicyimpl.cpp b/src/plugins/resourcepolicy/resourcepolicyimpl.cpp
new file mode 100644 (file)
index 0000000..26f7135
--- /dev/null
@@ -0,0 +1,137 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Jolla Ltd, author: <robin.burchell@jollamobile.com>
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <policy/resource.h>
+#include <policy/resources.h>
+#include <policy/resource-set.h>
+
+#include "resourcepolicyimpl.h"
+
+ResourcePolicyImpl::ResourcePolicyImpl(QObject *parent)
+    : QMediaPlayerResourceSetInterface(parent)
+{
+    m_resourceSet = new ResourcePolicy::ResourceSet("player", this);
+    m_resourceSet->setAlwaysReply();
+
+    ResourcePolicy::AudioResource *audioResource = new ResourcePolicy::AudioResource("player");
+    audioResource->setProcessID(QCoreApplication::applicationPid());
+    audioResource->setStreamTag("media.name", "*");
+    m_resourceSet->addResourceObject(audioResource);
+
+    m_resourceSet->addResource(ResourcePolicy::VideoPlaybackType);
+    m_resourceSet->update();
+
+    connect(m_resourceSet, SIGNAL(resourcesGranted(const QList<ResourcePolicy::ResourceType>)),
+            this, SLOT(handleResourcesGranted()));
+    connect(m_resourceSet, SIGNAL(resourcesDenied()),
+            this, SLOT(handleResourcesDenied()));
+    connect(m_resourceSet, SIGNAL(lostResources()),
+            this, SLOT(handleResourcesLost()));
+    connect(m_resourceSet, SIGNAL(resourcesReleasedByManager()),
+            this, SLOT(handleResourcesLost()));
+}
+
+bool ResourcePolicyImpl::isVideoEnabled() const
+{
+    return m_videoEnabled;
+}
+
+void ResourcePolicyImpl::setVideoEnabled(bool videoEnabled)
+{
+    if (m_videoEnabled != videoEnabled) {
+        m_videoEnabled = videoEnabled;
+
+        if (videoEnabled)
+            m_resourceSet->addResource(ResourcePolicy::VideoPlaybackType);
+        else
+            m_resourceSet->deleteResource(ResourcePolicy::VideoPlaybackType);
+
+        m_resourceSet->update();
+    }
+}
+
+void ResourcePolicyImpl::acquire()
+{
+    m_status = RequestedResource;
+    m_resourceSet->acquire();
+}
+
+void ResourcePolicyImpl::release()
+{
+    m_resourceSet->release();
+    m_status = Initial;
+}
+
+bool ResourcePolicyImpl::isGranted() const
+{
+    return m_status == GrantedResource;
+}
+
+bool ResourcePolicyImpl::isAvailable() const
+{
+    // TODO: is this used? what is it for?
+    qWarning() << Q_FUNC_INFO << "Stub";
+    return true;
+}
+
+void ResourcePolicyImpl::handleResourcesGranted()
+{
+    m_status = GrantedResource;
+    emit resourcesGranted();
+}
+
+void ResourcePolicyImpl::handleResourcesDenied()
+{
+    m_status = Initial;
+    emit resourcesDenied();
+}
+
+void ResourcePolicyImpl::handleResourcesLost()
+{
+    if (m_status != Initial) {
+        m_status = Initial;
+        emit resourcesLost();
+    }
+
+    m_resourceSet->release();
+}
+
diff --git a/src/plugins/resourcepolicy/resourcepolicyimpl.h b/src/plugins/resourcepolicy/resourcepolicyimpl.h
new file mode 100644 (file)
index 0000000..8680df8
--- /dev/null
@@ -0,0 +1,84 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Jolla Ltd, author: <robin.burchell@jollamobile.com>
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef RESOURCEPOLICYIMPL_H
+#define RESOURCEPOLICYIMPL_H
+
+#include <QObject>
+
+#include <private/qmediaresourceset_p.h>
+
+namespace ResourcePolicy {
+    class ResourceSet;
+};
+
+class ResourcePolicyImpl : public QMediaPlayerResourceSetInterface
+{
+    Q_OBJECT
+public:
+    ResourcePolicyImpl(QObject *parent = 0);
+
+    bool isVideoEnabled() const;
+    void setVideoEnabled(bool videoEnabled);
+    void acquire();
+    void release();
+    bool isGranted() const;
+    bool isAvailable() const;
+
+private slots:
+    void handleResourcesGranted();
+    void handleResourcesDenied();
+    void handleResourcesLost();
+
+private:
+    enum ResourceStatus {
+        Initial = 0,
+        RequestedResource,
+        GrantedResource
+    };
+
+    bool m_videoEnabled;
+    ResourcePolicy::ResourceSet *m_resourceSet;
+    ResourceStatus m_status;
+};
+
+#endif // RESOURCEPOLICYIMPL_H
diff --git a/src/plugins/resourcepolicy/resourcepolicyplugin.cpp b/src/plugins/resourcepolicy/resourcepolicyplugin.cpp
new file mode 100644 (file)
index 0000000..7fc69d3
--- /dev/null
@@ -0,0 +1,64 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Jolla Ltd, author: <robin.burchell@jollamobile.com>
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QDebug>
+
+#include "resourcepolicyplugin.h"
+#include "resourcepolicyimpl.h"
+
+ResourcePolicyPlugin::ResourcePolicyPlugin(QObject *parent)
+    : QMediaResourcePolicyPlugin(parent)
+{
+}
+
+QObject *ResourcePolicyPlugin::create(const QString &interfaceId)
+{
+    // TODO: what is interfaceId for?
+    return new ResourcePolicyImpl(this);
+}
+
+void ResourcePolicyPlugin::destroy(QObject *resourceSet)
+{
+    // TODO: do we need to do anything more elaborate here?
+    delete resourceSet;
+}
+
diff --git a/src/plugins/resourcepolicy/resourcepolicyplugin.h b/src/plugins/resourcepolicy/resourcepolicyplugin.h
new file mode 100644 (file)
index 0000000..f23641a
--- /dev/null
@@ -0,0 +1,61 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Jolla Ltd, author: <robin.burchell@jollamobile.com>
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef RESOURCEPOLICYPLUGIN_H
+#define RESOURCEPOLICYPLUGIN_H
+
+#include <private/qmediaresourcepolicyplugin_p.h>
+#include <QObject>
+
+class ResourcePolicyPlugin : public QMediaResourcePolicyPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.qt.mediaresourcesetfactory/5.0" FILE "resourcepolicy.json")
+    Q_INTERFACES(QMediaResourceSetFactoryInterface)
+public:
+    ResourcePolicyPlugin(QObject *parent = 0);
+
+    QObject *create(const QString &interfaceId);
+    void destroy(QObject *resourceSet);
+};
+
+#endif // RESOURCEPOLICYPLUGIN_H