annotate widgets/PluginParameterDialog.h @ 146:a1f7d265ac79

* More to do with passing around step/blocksize etc from plugin dialog to
  plugins.  Still some puzzling unresolved details.

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006 Chris Cannam.
    
    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.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _PLUGIN_PARAMETER_DIALOG_H_
#define _PLUGIN_PARAMETER_DIALOG_H_

#include <QDialog>

#include "base/Window.h"

namespace Vamp { class PluginBase; }
class PluginParameterBox;
class QWidget;
class QPushButton;

/**
 * A dialog for editing the parameters of a given plugin, using a
 * PluginParameterBox.  This dialog does not contain any mechanism for
 * selecting the plugin in the first place.  Note that the dialog
 * directly modifies the parameters of the plugin, so they will remain
 * modified even if the dialog is then cancelled.
 */

class PluginParameterDialog : public QDialog
{
    Q_OBJECT
    
public:
    PluginParameterDialog(Vamp::PluginBase *,
                          int sourceChannels,
                          int targetChannels,
                          int defaultChannel,
                          QString output = "",
                          bool showWindowSize = false,
                          bool showFrequencyDomainOptions = false,
                          QWidget *parent = 0);
    ~PluginParameterDialog();

    Vamp::PluginBase *getPlugin() { return m_plugin; }

    int getChannel() const { return m_channel; }

    //!!! merge with PluginTransform::ExecutionContext

    void getProcessingParameters(size_t &blockSize) const;
    void getProcessingParameters(size_t &stepSize, size_t &blockSize,
                                 WindowType &windowType) const;

signals:
    void pluginConfigurationChanged(QString);

protected slots:
    void channelComboChanged(int);
    void blockSizeComboChanged(QString);
    void incrementComboChanged(QString);
    void windowTypeChanged(WindowType type);
    void advancedToggled();

protected:
    Vamp::PluginBase *m_plugin;
    int m_channel;
    size_t m_stepSize;
    size_t m_blockSize;
    WindowType m_windowType;
    PluginParameterBox *m_parameterBox;
    QPushButton *m_advancedButton;
    QWidget *m_advanced;
};

#endif