FilterPlugin.h

Go to the documentation of this file.

/***************************************************************************
    FilterPlugin.h  -  generic class for filter plugins with setup
                             -------------------
    begin                : Sat Jun 07 2003
    copyright            : (C) 2003 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 FILTER_PLUGIN_H
#define FILTER_PLUGIN_H

#include "config.h"

#include <QtGlobal>
#include <QObject>
#include <QString>

#include "libkwave/Plugin.h"
#include "libkwave/PluginSetupDialog.h"

class QStringList;
class QWidget;

namespace Kwave
{

    class SampleSource;
    class SampleSink;

    class Q_DECL_EXPORT FilterPlugin: public Kwave::Plugin
    {
        Q_OBJECT
    public:

        FilterPlugin(QObject *parent, const QVariantList &args);

        virtual ~FilterPlugin() Q_DECL_OVERRIDE;

        virtual int interpreteParameters(QStringList & /* params */) = 0;

        virtual Kwave::PluginSetupDialog *createDialog(QWidget * /*parent*/) = 0;

        virtual Kwave::SampleSource *createFilter(unsigned int tracks) = 0;

        virtual QStringList *setup(QStringList &previous_params) Q_DECL_OVERRIDE;

        virtual void run(QStringList params) Q_DECL_OVERRIDE;

        virtual bool paramsChanged();

        virtual void updateFilter(Kwave::SampleSource *filter,
                                  bool force = false);

        virtual QString actionName() = 0;

        virtual QString progressText() Q_DECL_OVERRIDE;

    signals:

        void sigCancelPressed();

    protected slots:

        void startPreListen();

        void stopPreListen();

    private:
        QStringList m_params;

        bool m_listen;

        bool m_pause;

        Kwave::SampleSink *m_sink;

    };
}

#endif /* FILTER_PLUGIN_H */

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