PluginManager.h

Go to the documentation of this file.

/***************************************************************************
            PluginManager.h  -  manager class for kwave's plugins
                             -------------------
    begin                : Sun Aug 27 2000
    copyright            : (C) 2000 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef PLUGIN_MANAGER_H
#define PLUGIN_MANAGER_H

#include "config.h"

#include <QtGlobal>
#include <QList>
#include <QListIterator>
#include <QMap>
#include <QMutableListIterator>
#include <QObject>
#include <QPointer>
#include <QWidget>

#include "libkwave/InsertMode.h"
#include "libkwave/Sample.h"
#include "libkwave/ViewManager.h"

class QLibrary;
class QString;
class QStringList;

class KPluginFactory;

namespace Kwave
{
    class PlaybackController;
    class PlaybackDeviceFactory;
    class PlayBackParam;
    class Plugin;
    class PluginContext;
    class SampleSink;
    class SignalManager;
    class Writer;

    class Q_DECL_EXPORT PluginManager: public QObject
    {
        Q_OBJECT

    public:

        PluginManager(QWidget *parent, Kwave::SignalManager &signal_manager);

        virtual ~PluginManager();

        bool loadAllPlugins();

        void stopAllPlugins();

        int executePlugin(const QString &name, QStringList *params);

        bool canClose();

        bool onePluginRunning();

        void sync();

        int setupPlugin(const QString &name, const QStringList &params);

        QStringList defaultParams(const QString &name);

        sample_index_t signalLength();

        double signalRate();

        sample_index_t selectionStart();

        sample_index_t selectionEnd();

        void selectRange(sample_index_t offset, sample_index_t length);

        Kwave::SampleSink *openMultiTrackPlayback(
            unsigned int tracks,
            const Kwave::PlayBackParam *playback_params = Q_NULLPTR
        );

        Kwave::PlaybackController &playbackController();

        inline void setParentWidget(QWidget *new_parent) {
            m_parent_widget = new_parent;
        }

        inline QPointer<QWidget> parentWidget()
        {
            return m_parent_widget;
        }

        inline Kwave::SignalManager &signalManager()
        {
            return m_signal_manager;
        }

        void insertView(Kwave::SignalView *view, QWidget *controls);

        void registerViewManager(Kwave::ViewManager *view_manager);

        void enqueueCommand(const QString &command);

        void searchPluginModules();

        typedef struct  {
            QString            m_name;        
            QString            m_author;      
            QString            m_description; 
            QString            m_version;     
            KPluginFactory    *m_factory;     
            int                m_use_count;   
        } PluginModule;

        const QList<PluginModule> pluginInfoList() const;

        void migratePluginToActiveContext(Kwave::Plugin *plugin);

        void setActive() { m_active_instance = this; }

    signals:

        void sigCommand(const QString &command);

        void sigClosed();

        void sigSignalNameChanged(const QString &name);

        void sigProgress(const QString &message);

    public slots:

        void signalClosed();

        void setSignalName(const QString &name);

    private slots:

        void pluginClosed(Kwave::Plugin *p);

        void pluginStarted(Kwave::Plugin *p);

        void pluginDone(Kwave::Plugin *p);

    private:

        typedef QPointer<Kwave::Plugin> KwavePluginPointer;

        typedef QList< KwavePluginPointer > PluginList;

        typedef QMutableListIterator< KwavePluginPointer >
            PluginListMutableIterator;

        typedef QListIterator< KwavePluginPointer >
            PluginListIterator;

    private:

        Kwave::Plugin *createPluginInstance(const QString &name);

        void savePluginDefaults(const QString &name,
                                QStringList &params);

        void connectPlugin(Kwave::Plugin *plugin);

        void disconnectPlugin(Kwave::Plugin *plugin);

    private:

        static Kwave::PluginManager *m_active_instance;

        static QMap<QString, PluginModule> m_plugin_modules;

        PluginList m_plugin_instances;

        PluginList m_running_plugins;

        QPointer<QWidget> m_parent_widget;

        Kwave::SignalManager &m_signal_manager;

        ViewManager *m_view_manager;

    };
}

#endif /* PLUGIN_MANAGER_H */

//***************************************************************************
//***************************************************************************