Updated plugins to use new plugin architecture

Changed QMediaPluginLoader to use QFactoryLoader instead of QPluginLoader
and used metadata to get keys.
Removed QAudioPluginLoader and changed audio classes to use instead use
QMediaPluginLoader.
The plugins must include the Q_PLUGIN_METADATA macro, and no longer use
the Q_PLUGIN_EXPORT/Q_PLUGIN_EXPORT2 macros.
A json file has been added for each plugin which can contain metadata
which is available to the plugin loader before the plugin is actually
loaded, and is used to read the keys for the plugin, e.g. supported
services.
QFactoryInterface will be deprecated and has been removed from all
plugins.

Change-Id: I035b82f9c9c65717bebf704d560ea8f891df21da
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
Reviewed-by: Dmytro Poplavskiy <dmytro.poplavskiy@nokia.com>
This commit is contained in:
Jonas Rabbe
2012-03-14 13:02:32 +10:00
committed by Qt by Nokia
parent 61c09d1614
commit a8ba6e3c7f
61 changed files with 630 additions and 745 deletions

View File

@@ -16,7 +16,6 @@ PUBLIC_HEADERS += \
PRIVATE_HEADERS += \
audio/qaudiobuffer_p.h \
audio/qaudiodevicefactory_p.h \
audio/qaudiopluginloader_p.h \
audio/qwavedecoder_p.h \
audio/qsamplecache_p.h \
audio/qaudiodecoder_p.h
@@ -30,7 +29,6 @@ SOURCES += \
audio/qaudiosystemplugin.cpp \
audio/qaudiosystem.cpp \
audio/qaudiodevicefactory.cpp \
audio/qaudiopluginloader.cpp \
audio/qsoundeffect.cpp \
audio/qwavedecoder_p.cpp \
audio/qsamplecache_p.cpp \

View File

@@ -44,7 +44,7 @@
#include "qaudiosystem.h"
#include "qaudiosystemplugin.h"
#include "qaudiopluginloader_p.h"
#include "qmediapluginloader_p.h"
#include "qaudiodevicefactory_p.h"
#ifndef QT_NO_AUDIO_BACKEND
@@ -66,8 +66,8 @@
QT_BEGIN_NAMESPACE
#if !defined (QT_NO_LIBRARY) && !defined(QT_NO_SETTINGS)
Q_GLOBAL_STATIC_WITH_ARGS(QAudioPluginLoader, audioLoader,
(QAudioSystemFactoryInterface_iid, QLatin1String("/audio"), Qt::CaseInsensitive))
Q_GLOBAL_STATIC_WITH_ARGS(QMediaPluginLoader, audioLoader,
(QAudioSystemFactoryInterface_iid, QLatin1String("audio"), Qt::CaseInsensitive))
#endif
class QNullDeviceInfo : public QAbstractAudioDeviceInfo
@@ -142,15 +142,13 @@ QList<QAudioDeviceInfo> QAudioDeviceFactory::availableDevices(QAudio::Mode mode)
#endif
#if !defined (QT_NO_LIBRARY) && !defined(QT_NO_SETTINGS)
QAudioPluginLoader* l = audioLoader();
QMediaPluginLoader* l = audioLoader();
foreach (const QString& key, l->keys()) {
QAudioSystemFactoryInterface* plugin = qobject_cast<QAudioSystemFactoryInterface*>(l->instance(key));
if (plugin) {
foreach (QByteArray const& handle, plugin->availableDevices(mode))
devices << QAudioDeviceInfo(key, handle, mode);
}
delete plugin;
}
#endif

View File

@@ -1,176 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qaudiosystemplugin.h"
#include "qaudiopluginloader_p.h"
#include <QtCore/qcoreapplication.h>
#include <QtCore/qpluginloader.h>
#include <QtCore/qfactoryinterface.h>
#include <QtCore/qdir.h>
#include <QtCore/qdebug.h>
QT_BEGIN_NAMESPACE
QAudioPluginLoader::QAudioPluginLoader(const char *iid, const QString &location, Qt::CaseSensitivity):
m_iid(iid)
{
m_location = location + QLatin1Char('/');
load();
}
QAudioPluginLoader::~QAudioPluginLoader()
{
for (int i = 0; i < m_plugins.count(); i++ ) {
delete m_plugins.at(i);
}
}
QStringList QAudioPluginLoader::pluginList() const
{
#if !defined QT_NO_DEBUG
const bool showDebug = qgetenv("QT_DEBUG_PLUGINS").toInt() > 0;
#endif
QStringList paths = QCoreApplication::libraryPaths();
#ifdef QTM_PLUGIN_PATH
paths << QLatin1String(QTM_PLUGIN_PATH);
#endif
#if !defined QT_NO_DEBUG
if (showDebug)
qDebug() << "Plugin paths:" << paths;
#endif
//temp variable to avoid multiple identic path
QSet<QString> processed;
/* Discover a bunch o plugins */
QStringList plugins;
/* Enumerate our plugin paths */
for (int i=0; i < paths.count(); i++) {
if (processed.contains(paths.at(i)))
continue;
processed.insert(paths.at(i));
QDir pluginsDir(paths.at(i)+m_location);
if (!pluginsDir.exists())
continue;
QStringList files = pluginsDir.entryList(QDir::Files);
#if !defined QT_NO_DEBUG
if (showDebug)
qDebug()<<"Looking for plugins in "<<pluginsDir.path()<<files;
#endif
for (int j=0; j < files.count(); j++) {
const QString &file = files.at(j);
plugins << pluginsDir.absoluteFilePath(file);
}
}
return plugins;
}
QStringList QAudioPluginLoader::keys() const
{
QMutexLocker locker(const_cast<QMutex *>(&m_mutex));
QStringList list;
for (int i = 0; i < m_plugins.count(); i++) {
QAudioSystemPlugin* p = qobject_cast<QAudioSystemPlugin*>(m_plugins.at(i)->instance());
if (p) list << p->keys();
}
return list;
}
QObject* QAudioPluginLoader::instance(QString const &key)
{
QMutexLocker locker(&m_mutex);
for (int i = 0; i < m_plugins.count(); i++) {
QAudioSystemPlugin* p = qobject_cast<QAudioSystemPlugin*>(m_plugins.at(i)->instance());
if (p && p->keys().contains(key))
return m_plugins.at(i)->instance();
}
return 0;
}
QList<QObject*> QAudioPluginLoader::instances(QString const &key)
{
QMutexLocker locker(&m_mutex);
QList<QObject*> list;
for (int i = 0; i < m_plugins.count(); i++) {
QAudioSystemPlugin* p = qobject_cast<QAudioSystemPlugin*>(m_plugins.at(i)->instance());
if (p && p->keys().contains(key))
list << m_plugins.at(i)->instance();
}
return list;
}
void QAudioPluginLoader::load()
{
if (!m_plugins.isEmpty())
return;
#if !defined QT_NO_DEBUG
const bool showDebug = qgetenv("QT_DEBUG_PLUGINS").toInt() > 0;
#endif
QStringList plugins = pluginList();
for (int i=0; i < plugins.count(); i++) {
QPluginLoader* loader = new QPluginLoader(plugins.at(i));
QObject *o = loader->instance();
if (o != 0 && o->qt_metacast(m_iid) != 0) {
m_plugins.append(loader);
} else {
#if !defined QT_NO_DEBUG
if (showDebug)
qWarning() << "QAudioPluginLoader: Failed to load plugin: "
<< plugins.at(i) << loader->errorString();
#endif
delete o;
//we are not calling loader->unload here for it may cause problem on some device
delete loader;
}
}
}
QT_END_NAMESPACE

View File

@@ -1,100 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QAUDIOPLUGINLOADER_H
#define QAUDIOPLUGINLOADER_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <qtmultimediadefs.h>
#include <QObject>
#include <QtCore/qstring.h>
#include <QtCore/qmap.h>
#include <QtCore/qmutex.h>
#include <QtCore/qpluginloader.h>
QT_BEGIN_HEADER
QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
class QAudioPluginLoader
{
public:
QAudioPluginLoader(const char *iid,
const QString &suffix = QString(),
Qt::CaseSensitivity = Qt::CaseSensitive);
~QAudioPluginLoader();
QStringList keys() const;
QObject* instance(QString const &key);
QList<QObject*> instances(QString const &key);
private:
QStringList pluginList() const;
void load();
QMutex m_mutex;
QByteArray m_iid;
QString m_location;
QList<QPluginLoader*> m_plugins;
};
QT_END_NAMESPACE
QT_END_HEADER
#endif // QAUDIOPLUGINLOADER_H

View File

@@ -45,7 +45,6 @@
#include <QtCore/qstring.h>
#include <QtCore/qplugin.h>
#include <QtCore/qfactoryinterface.h>
#include <qtmultimediadefs.h>
#include <qtmedianamespace.h>
@@ -61,7 +60,7 @@ QT_BEGIN_NAMESPACE
QT_MODULE(Multimedia)
struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface : public QFactoryInterface
struct Q_MULTIMEDIA_EXPORT QAudioSystemFactoryInterface
{
virtual QList<QByteArray> availableDevices(QAudio::Mode) const = 0;
virtual QAbstractAudioInput* createInput(const QByteArray& device) = 0;
@@ -76,13 +75,12 @@ Q_DECLARE_INTERFACE(QAudioSystemFactoryInterface, QAudioSystemFactoryInterface_i
class Q_MULTIMEDIA_EXPORT QAudioSystemPlugin : public QObject, public QAudioSystemFactoryInterface
{
Q_OBJECT
Q_INTERFACES(QAudioSystemFactoryInterface:QFactoryInterface)
Q_INTERFACES(QAudioSystemFactoryInterface)
public:
QAudioSystemPlugin(QObject *parent = 0);
~QAudioSystemPlugin();
virtual QStringList keys() const = 0;
virtual QList<QByteArray> availableDevices(QAudio::Mode) const = 0;
virtual QAbstractAudioInput* createInput(const QByteArray& device) = 0;
virtual QAbstractAudioOutput* createOutput(const QByteArray& device) = 0;