comparison widgets/PluginParameterDialog.cpp @ 163:dd6dd983e8ef

* Tidy up plugin parameter dialog by switching it to a simple constructor
  with separate methods for passing in the additional options if necessary
* Fix sizing problem on advanced pane toggle in plugin parameter dialog
* Make a start on passing in list of candidate input models for transform

 #include <QMessageBox>
 #include <QComboBox>
 #include <QSettings>
 
 PluginParameterDialog::PluginParameterDialog(Vamp::PluginBase *plugin,
-                                             int sourceChannels,
-                                             int targetChannels,
-                                             int defaultChannel,
-                                             QString output,
-                                             bool showWindowSize,
-                                             bool showFrequencyDomainOptions,
 					     QWidget *parent) :
     QDialog(parent),
     m_plugin(plugin),
-    m_channel(defaultChannel),
+    m_channel(-1),
     m_stepSize(0),
     m_blockSize(0),
     m_windowType(HanningWindow),
     m_parameterBox(0)
 {

     nameLabel->setFont(font);
 
     QLabel *makerLabel = new QLabel(plugin->getMaker().c_str());
     makerLabel->setWordWrap(true);
 
+    QLabel *versionLabel = new QLabel(QString("%1")
+                                      .arg(plugin->getPluginVersion()));
+    versionLabel->setWordWrap(true);
+
+    QLabel *copyrightLabel = new QLabel(plugin->getCopyright().c_str());
+    copyrightLabel->setWordWrap(true);
+
+    QLabel *typeLabel = new QLabel(plugin->getType().c_str());
+    typeLabel->setWordWrap(true);
+    typeLabel->setFont(font);
+
+    int row = 0;
+
+    QLabel *label = new QLabel(tr("Name:"));
+    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+    subgrid->addWidget(label, row, 0);
+    subgrid->addWidget(nameLabel, row, 1);
+    row++;
+
+    label = new QLabel(tr("Type:"));
+    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+    subgrid->addWidget(label, row, 0);
+    subgrid->addWidget(typeLabel, row, 1);
+    row++;
+
+    m_outputLabel = new QLabel(tr("Output:"));
+    m_outputLabel->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+    subgrid->addWidget(m_outputLabel, row, 0);
+    m_outputValue = new QLabel;
+    subgrid->addWidget(m_outputValue, row, 1);
+    m_outputLabel->hide();
+    m_outputValue->hide();
+    row++;
+
+    label = new QLabel(tr("Maker:"));
+    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+    subgrid->addWidget(label, row, 0);
+    subgrid->addWidget(makerLabel, row, 1);
+    row++;
+
+    label = new QLabel(tr("Copyright:  "));
+    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+    subgrid->addWidget(label, row, 0);
+    subgrid->addWidget(copyrightLabel, row, 1);
+    row++;
+
+    label = new QLabel(tr("Version:"));
+    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+    subgrid->addWidget(label, row, 0);
+    subgrid->addWidget(versionLabel, row, 1);
+    row++;
+
+    subgrid->setColumnStretch(1, 2);
+
+    QGroupBox *paramBox = new QGroupBox;
+    paramBox->setTitle(tr("Plugin Parameters"));
+    grid->addWidget(paramBox, 1, 0);
+    grid->setRowStretch(1, 10);
+
+    QHBoxLayout *paramLayout = new QHBoxLayout;
+    paramLayout->setMargin(0);
+    paramBox->setLayout(paramLayout);
+
+    QScrollArea *scroll = new QScrollArea;
+    scroll->setWidgetResizable(true);
+    scroll->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
+    scroll->setFrameShape(QFrame::NoFrame);
+    paramLayout->addWidget(scroll);
+
+    m_parameterBox = new PluginParameterBox(m_plugin);
+    connect(m_parameterBox, SIGNAL(pluginConfigurationChanged(QString)),
+            this,  SIGNAL(pluginConfigurationChanged(QString)));
+    scroll->setWidget(m_parameterBox);
+
+    m_advanced = new QFrame;
+    QVBoxLayout *advancedLayout = new QVBoxLayout;
+    advancedLayout->setMargin(0);
+    m_advanced->setLayout(advancedLayout);
+    grid->addWidget(m_advanced, 2, 0);
+
+    bool haveAdvanced = false;
+
+    m_channelBox = new QGroupBox;
+    m_channelBox->setTitle(tr("Channels"));
+    advancedLayout->addWidget(m_channelBox);
+    m_channelBox->setVisible(false);
+    m_haveChannelBoxData = false;
+
+    m_windowBox = new QGroupBox;
+    m_windowBox->setTitle(tr("Processing"));
+    advancedLayout->addWidget(m_windowBox);
+    m_windowBox->setVisible(false);
+    m_haveWindowBoxData = false;
+
+    QHBoxLayout *hbox = new QHBoxLayout;
+    grid->addLayout(hbox, 4, 0);
+
+    m_advancedVisible = false;
+
+    m_advancedButton = new QPushButton(tr("Advanced >>"));
+    m_advancedButton->setCheckable(true);
+    connect(m_advancedButton, SIGNAL(clicked()), this, SLOT(advancedToggled()));
+        
+    QSettings settings;
+    settings.beginGroup("PluginParameterDialog");
+    m_advancedVisible = settings.value("advancedvisible", false).toBool();
+    settings.endGroup();
+    
+    m_advanced->setVisible(false);
+
+    hbox->addWidget(m_advancedButton);
+    m_advancedButton->hide();
+
+    QPushButton *ok = new QPushButton(tr("OK"));
+    QPushButton *cancel = new QPushButton(tr("Cancel"));
+    hbox->addStretch(10);
+    hbox->addWidget(ok);
+    hbox->addWidget(cancel);
+    connect(ok, SIGNAL(clicked()), this, SLOT(accept()));
+    connect(cancel, SIGNAL(clicked()), this, SLOT(reject()));
+
+    setAdvancedVisible(m_advancedVisible);
+}
+
+PluginParameterDialog::~PluginParameterDialog()
+{
+}
+
+
+void
+PluginParameterDialog::setOutputLabel(QString text)
+{
+    if (text == "") {
+        m_outputLabel->hide();
+        m_outputValue->hide();
+    } else {
+        m_outputValue->setText(text);
+        m_outputValue->setWordWrap(true);
+        m_outputLabel->show();
+        m_outputValue->show();
+    }
+/*
     QLabel *outputLabel = 0;
 
     if (output != "") {
 
         Vamp::PluginHostAdapter *fePlugin = dynamic_cast<Vamp::PluginHostAdapter *>(m_plugin);

                     }
                 }
             }
         }
     }
-
-    QLabel *versionLabel = new QLabel(QString("%1")
-                                      .arg(plugin->getPluginVersion()));
-    versionLabel->setWordWrap(true);
-
-    QLabel *copyrightLabel = new QLabel(plugin->getCopyright().c_str());
-    copyrightLabel->setWordWrap(true);
-
-    QLabel *typeLabel = new QLabel(plugin->getType().c_str());
-    typeLabel->setWordWrap(true);
-    typeLabel->setFont(font);
-
-    QLabel *label = new QLabel(tr("Name:"));
-    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
-    subgrid->addWidget(label, 0, 0);
-    subgrid->addWidget(nameLabel, 0, 1);
-
-    label = new QLabel(tr("Type:"));
-    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
-    subgrid->addWidget(label, 1, 0);
-    subgrid->addWidget(typeLabel, 1, 1);
-
-    int outputOffset = 0;
-    if (outputLabel) {
-        label = new QLabel(tr("Output:"));
-        label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
-        subgrid->addWidget(label, 2, 0);
-        subgrid->addWidget(outputLabel, 2, 1);
-        outputOffset = 1;
-    }
-
-    label = new QLabel(tr("Maker:"));
-    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
-    subgrid->addWidget(label, 2 + outputOffset, 0);
-    subgrid->addWidget(makerLabel, 2 + outputOffset, 1);
-
-    label = new QLabel(tr("Copyright:  "));
-    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
-    subgrid->addWidget(label, 3 + outputOffset, 0);
-    subgrid->addWidget(copyrightLabel, 3 + outputOffset, 1);
-
-    label = new QLabel(tr("Version:"));
-    label->setAlignment(Qt::AlignTop | Qt::AlignLeft);
-    subgrid->addWidget(label, 4 + outputOffset, 0);
-    subgrid->addWidget(versionLabel, 4 + outputOffset, 1);
-
-    subgrid->setColumnStretch(1, 2);
-
-    QGroupBox *paramBox = new QGroupBox;
-    paramBox->setTitle(tr("Plugin Parameters"));
-    grid->addWidget(paramBox, 1, 0);
-    grid->setRowStretch(1, 10);
-
-    QHBoxLayout *paramLayout = new QHBoxLayout;
-    paramLayout->setMargin(0);
-    paramBox->setLayout(paramLayout);
-
-    QScrollArea *scroll = new QScrollArea;
-    scroll->setWidgetResizable(true);
-    scroll->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
-    scroll->setFrameShape(QFrame::NoFrame);
-    paramLayout->addWidget(scroll);
-
-    m_parameterBox = new PluginParameterBox(m_plugin);
-    connect(m_parameterBox, SIGNAL(pluginConfigurationChanged(QString)),
-            this,  SIGNAL(pluginConfigurationChanged(QString)));
-    scroll->setWidget(m_parameterBox);
-
-    m_advanced = new QFrame;
-    QVBoxLayout *advancedLayout = new QVBoxLayout;
-    advancedLayout->setMargin(0);
-    m_advanced->setLayout(advancedLayout);
-    grid->addWidget(m_advanced, 2, 0);
-
-    bool haveAdvanced = false;
+*/
+}
+
+void
+PluginParameterDialog::setChannelArrangement(int sourceChannels,
+                                             int targetChannels,
+                                             int defaultChannel)
+{
+    m_channel = defaultChannel;
 
     if (sourceChannels != targetChannels) {
 
         // At the moment we can only cope with the case where
         // sourceChannels > targetChannels and targetChannels == 1
 
         if (sourceChannels < targetChannels) {
 
             QMessageBox::warning
-                (parent,
+                (parentWidget(),
                  tr("Channel mismatch"),
                  tr("This plugin requires at least %1 input channels, but only %2 %3 available.  The plugin probably will not work correctly.").arg(targetChannels).arg(sourceChannels).arg(sourceChannels != 1 ? tr("are") : tr("is")),
                  QMessageBox::Ok,
                  QMessageBox::NoButton);
 
         } else {
 
-            QGroupBox *channelBox = new QGroupBox;
-            channelBox->setTitle(tr("Channels"));
-            advancedLayout->addWidget(channelBox);
-            haveAdvanced = true;
+            if (m_haveChannelBoxData) {
+                std::cerr << "WARNING: PluginParameterDialog::setChannelArrangement: Calling more than once on same dialog is not currently implemented" << std::endl;
+                return;
+            }
             
             QVBoxLayout *channelLayout = new QVBoxLayout;
-            channelBox->setLayout(channelLayout);
+            m_channelBox->setLayout(channelLayout);
 
             if (targetChannels != 1) {
 
                 channelLayout->addWidget
                     (new QLabel(tr("This plugin accepts no more than %1 input channels,\nbut %2 are available.  Only the first %3 will be used.\n")

                 connect(channelCombo, SIGNAL(activated(int)),
                         this, SLOT(channelComboChanged(int)));
 
                 channelLayout->addWidget(channelCombo);
             }
-        }
+
+            m_channelBox->setVisible(true);
+            m_haveChannelBoxData = true;
+            m_advancedButton->show();
+        }
+    }
+
+    setAdvancedVisible(m_advancedVisible);
+}
+
+void
+PluginParameterDialog::setShowProcessingOptions(bool showWindowSize,
+                                                bool showFrequencyDomainOptions)
+{
+    if (m_haveWindowBoxData) {
+        std::cerr << "WARNING: PluginParameterDialog::setShowProcessingOptions: Calling more than once on same dialog is not currently implemented" << std::endl;
+        return;
     }
 
     if (showWindowSize) {
 
         Vamp::PluginHostAdapter *fePlugin = dynamic_cast<Vamp::PluginHostAdapter *>(m_plugin);

                     increment = size;
                 } else {
                     increment = size/2;
                 }
             }
-        } else {
-            std::cerr << "Plugin " << plugin << " is not a feature extraction plugin (it's a " << typeid(*plugin).name() << ")" << std::endl;//!!!
-        }
-
-        QGroupBox *windowBox = new QGroupBox;
-        windowBox->setTitle(tr("Processing"));
-        advancedLayout->addWidget(windowBox);
-        haveAdvanced = true;
+        }
 
         QGridLayout *windowLayout = new QGridLayout;
-        windowBox->setLayout(windowLayout);
+        m_windowBox->setLayout(windowLayout);
 
         if (showFrequencyDomainOptions) {
             windowLayout->addWidget(new QLabel(tr("Window size:")), 0, 0);
         } else {
             windowLayout->addWidget(new QLabel(tr("Audio frames per block:")), 0, 0);
         }
 
         std::cerr << "size: " << size << ", increment: " << increment << std::endl;
-
-        //!!! deal with block and step sizes (coming from the plugin's
-        // preferences) that don't fit into the default list
 
         QComboBox *blockSizeCombo = new QComboBox;
         blockSizeCombo->setEditable(true);
         bool found = false;
         for (int i = 0; i < 14; ++i) {

             WindowTypeSelector *windowTypeSelector = new WindowTypeSelector;
             connect(windowTypeSelector, SIGNAL(windowTypeChanged(WindowType type)),
                     this, SLOT(windowTypeChanged(type)));
             windowLayout->addWidget(windowTypeSelector, 2, 1);
         }
-    }
-
-    QHBoxLayout *hbox = new QHBoxLayout;
-    grid->addLayout(hbox, 4, 0);
-
-    bool advancedVisible = false;
-
-    if (haveAdvanced) {
-
-        m_advancedButton = new QPushButton(tr("Advanced >>"));
-        m_advancedButton->setCheckable(true);
-        connect(m_advancedButton, SIGNAL(clicked()), this, SLOT(advancedToggled()));
-        
-        QSettings settings;
-        settings.beginGroup("PluginParameterDialog");
-        advancedVisible = settings.value("advancedvisible", false).toBool();
-        settings.endGroup();
-
-        m_advanced->setVisible(false);
-
-        hbox->addWidget(m_advancedButton);
-    }
-
-    QPushButton *ok = new QPushButton(tr("OK"));
-    QPushButton *cancel = new QPushButton(tr("Cancel"));
-    hbox->addStretch(10);
-    hbox->addWidget(ok);
-    hbox->addWidget(cancel);
-    connect(ok, SIGNAL(clicked()), this, SLOT(accept()));
-    connect(cancel, SIGNAL(clicked()), this, SLOT(reject()));
-
-    if (advancedVisible) {
-        m_advancedButton->setChecked(true);
-        advancedToggled();
-    }
-}
-
-PluginParameterDialog::~PluginParameterDialog()
-{
+
+        m_windowBox->setVisible(true);
+        m_haveWindowBoxData = true;
+        m_advancedButton->show();
+    }
+
+    setAdvancedVisible(m_advancedVisible);
 }
 
 void
 PluginParameterDialog::getProcessingParameters(size_t &blockSize) const
 {

 }
 
 void
 PluginParameterDialog::advancedToggled()
 {
-    bool visible = !m_advanced->isVisible();
-
+    setAdvancedVisible(!m_advancedVisible);
+}
+
+void
+PluginParameterDialog::setAdvancedVisible(bool visible)
+{
     m_advanced->setVisible(visible);
 
-    if (visible) m_advancedButton->setText(tr("Advanced <<"));
-    else m_advancedButton->setText(tr("Advanced >>"));
+    if (visible) {
+        m_advancedButton->setText(tr("Advanced <<"));
+        m_advancedButton->setChecked(true);
+    } else {
+        m_advancedButton->setText(tr("Advanced >>"));
+        m_advancedButton->setChecked(false);
+    }
 
     QSettings settings;
     settings.beginGroup("PluginParameterDialog");
     settings.setValue("advancedvisible", visible);
     settings.endGroup();
 
     std::cerr << "resize to " << sizeHint().width() << " x " << sizeHint().height() << std::endl;
 
     setMinimumHeight(sizeHint().height());
-    if (visible) setMaximumHeight(sizeHint().height());
+    adjustSize();
+
+    m_advancedVisible = visible;
+
+//    if (visible) setMaximumHeight(sizeHint().height());
+//    adjustSize();
 }
 
 void
 PluginParameterDialog::channelComboChanged(int index)
 {