/***************************************************************************
        NotchFilterPlugin.h  -  Plugin for simple notch filtering
                             -------------------
    begin                : Thu Jun 19 2003
    copyright            : (C) 2003 by Dave Flogeras
    email                : d.flogeras@unb.ca
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 NOTCH_FILTER_PLUGIN_H
#define NOTCH_FILTER_PLUGIN_H

#include "config.h"
#include <QObject>
#include <QString>
#include <QStringList>

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

#include "libgui/FilterPlugin.h"

class QStringList;
namespace Kwave
{

    class KwaveSampleSource;

    class NotchFilterPlugin: public Kwave::FilterPlugin
    {
        Q_OBJECT

    public:

        /**
         * Constructor
         * @param parent reference to our plugin manager
         * @param args argument list [unused]
         */
        NotchFilterPlugin(QObject *parent, const QVariantList &args);

        /** Destructor */
        virtual ~NotchFilterPlugin() Q_DECL_OVERRIDE;

        /** Creates the setup dialog and connects it's signals */
        virtual Kwave::PluginSetupDialog *createDialog(QWidget *parent)
            Q_DECL_OVERRIDE;

        /**
         * Creates a multi-track filter with the given number of tracks
         * @param tracks number of tracks that the filter should have
         * @return pointer to the filter or null if failed
         */
        virtual Kwave::SampleSource *createFilter(unsigned int tracks)
            Q_DECL_OVERRIDE;

        /**
         * Returns true if the parameters have changed during pre-listen.
         */
        virtual bool paramsChanged() Q_DECL_OVERRIDE;

        /**
         * Update the filter with new parameters if it has changed
         * changed during the pre-listen.
         * @param filter the Kwave::SampleSource to be updated, should be the
         *               same one as created with createFilter()
         * @param force if true, even update if no settings have changed
         */
        virtual void updateFilter(Kwave::SampleSource *filter,
                                  bool force = false) Q_DECL_OVERRIDE;

        /**
         * Returns a verbose name of the performed action. Used for giving
         * the undo action a readable name.
         */
        virtual QString actionName() Q_DECL_OVERRIDE;

    protected:

        /** Reads values from the parameter list */
        virtual int interpreteParameters(QStringList &params) Q_DECL_OVERRIDE;

    protected slots:

        /**
         * Called when the parameter changed during pre-listen
         * @param frequency the frequency parameter in Hz
         */
        void setFreqValue(double frequency);

        /**
         * set a new bandwidth
         * @param bw bandwidth [Hz]
         */
        void setBwValue(double bw);

    private:

        /** cutoff frequency [Hz] */
        double m_frequency;

        /** last value of m_frequency */
        double m_last_freq;

        /** bandwidth value [Hz] */
        double m_bw;

        /** last value of m_bw */
        double m_last_bw;

    };
}

#endif /* NOTCH_FILTER_PLUGIN_H */

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