lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #include "PluginXml.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include <QRegExp>
lbajardsilogic@0: #include <QXmlAttributes>
lbajardsilogic@0: 
lbajardsilogic@0: #include <QDomDocument>
lbajardsilogic@0: #include <QDomElement>
lbajardsilogic@0: #include <QDomNamedNodeMap>
lbajardsilogic@0: #include <QDomAttr>
lbajardsilogic@0: 
lbajardsilogic@0: #include "vamp-sdk/PluginBase.h"
lbajardsilogic@0: #include "RealTimePluginInstance.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include <iostream>
lbajardsilogic@0: 
lbajardsilogic@0: PluginXml::PluginXml(Vamp::PluginBase *plugin) :
lbajardsilogic@0:     m_plugin(plugin)
lbajardsilogic@0: {
lbajardsilogic@0: }
lbajardsilogic@0: 
lbajardsilogic@0: PluginXml::~PluginXml() { }
lbajardsilogic@0: 
lbajardsilogic@0: QString
lbajardsilogic@0: PluginXml::encodeConfigurationChars(QString text)
lbajardsilogic@0: {
lbajardsilogic@0:     QString rv(text);
lbajardsilogic@0:     rv.replace(";", "[[SEMICOLON]]");
lbajardsilogic@0:     rv.replace("=", "[[EQUALS]]");
lbajardsilogic@0:     return rv;
lbajardsilogic@0: }
lbajardsilogic@0: 
lbajardsilogic@0: QString
lbajardsilogic@0: PluginXml::decodeConfigurationChars(QString text)
lbajardsilogic@0: {
lbajardsilogic@0:     QString rv(text);
lbajardsilogic@0:     rv.replace("[[SEMICOLON]]", ";");
lbajardsilogic@0:     rv.replace("[[EQUALS]]", "=");
lbajardsilogic@0:     return rv;
lbajardsilogic@0: }
lbajardsilogic@0:     
lbajardsilogic@0: QString
lbajardsilogic@0: PluginXml::toXmlString(QString indent, QString extraAttributes) const
lbajardsilogic@0: {
lbajardsilogic@0:     QString s;
lbajardsilogic@0:     s += indent;
lbajardsilogic@0: 
lbajardsilogic@0:     s += QString("<plugin identifier=\"%1\" name=\"%2\" description=\"%3\" maker=\"%4\" version=\"%5\" copyright=\"%6\" %7 ")
lbajardsilogic@0:         .arg(encodeEntities(QString(m_plugin->getIdentifier().c_str())))
lbajardsilogic@0:         .arg(encodeEntities(QString(m_plugin->getName().c_str())))
lbajardsilogic@0:         .arg(encodeEntities(QString(m_plugin->getDescription().c_str())))
lbajardsilogic@0:         .arg(encodeEntities(QString(m_plugin->getMaker().c_str())))
lbajardsilogic@0:         .arg(m_plugin->getPluginVersion())
lbajardsilogic@0:         .arg(encodeEntities(QString(m_plugin->getCopyright().c_str())))
lbajardsilogic@0:         .arg(extraAttributes);
lbajardsilogic@0: 
lbajardsilogic@0:     if (!m_plugin->getPrograms().empty()) {
lbajardsilogic@0:         s += QString("program=\"%1\" ")
lbajardsilogic@0:             .arg(encodeEntities(m_plugin->getCurrentProgram().c_str()));
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     Vamp::PluginBase::ParameterList parameters =
lbajardsilogic@0:         m_plugin->getParameterDescriptors();
lbajardsilogic@0: 
lbajardsilogic@0:     for (Vamp::PluginBase::ParameterList::const_iterator i = parameters.begin();
lbajardsilogic@0:          i != parameters.end(); ++i) {
lbajardsilogic@0: 
lbajardsilogic@0: //        std::cerr << "PluginXml::toXmlString: parameter name \""
lbajardsilogic@0: //                  << i->name.c_str() << "\" has value "
lbajardsilogic@0: //                  << m_plugin->getParameter(i->name) << std::endl;
lbajardsilogic@0: 
lbajardsilogic@0:         s += QString("param-%1=\"%2\" ")
lbajardsilogic@0:             .arg(stripInvalidParameterNameCharacters(QString(i->identifier.c_str())))
lbajardsilogic@0:             .arg(m_plugin->getParameter(i->identifier));
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     RealTimePluginInstance *rtpi =
lbajardsilogic@0:         dynamic_cast<RealTimePluginInstance *>(m_plugin);
lbajardsilogic@0:     if (rtpi) {
lbajardsilogic@0:         std::map<std::string, std::string> configurePairs =
lbajardsilogic@0:             rtpi->getConfigurePairs();
lbajardsilogic@0:         QString config;
lbajardsilogic@0:         for (std::map<std::string, std::string>::iterator i = configurePairs.begin();
lbajardsilogic@0:              i != configurePairs.end(); ++i) {
lbajardsilogic@0:             QString key = i->first.c_str();
lbajardsilogic@0:             QString value = i->second.c_str();
lbajardsilogic@0:             key = encodeConfigurationChars(key);
lbajardsilogic@0:             value = encodeConfigurationChars(value);
lbajardsilogic@0:             if (config != "") config += ";";
lbajardsilogic@0:             config += QString("%1=%2").arg(key).arg(value);
lbajardsilogic@0:         }
lbajardsilogic@0:         if (config != "") {
lbajardsilogic@0:             s += QString("configuration=\"%1\" ")
lbajardsilogic@0:                 .arg(encodeEntities(config));
lbajardsilogic@0:         }
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     s += "/>\n";
lbajardsilogic@0:     return s;
lbajardsilogic@0: }
lbajardsilogic@0: 
lbajardsilogic@0: #define CHECK_ATTRIBUTE(ATTRIBUTE, ACCESSOR) \
lbajardsilogic@0:     QString ATTRIBUTE = attrs.value(#ATTRIBUTE); \
lbajardsilogic@0:     if (ATTRIBUTE != "" && ATTRIBUTE != ACCESSOR().c_str()) { \
lbajardsilogic@0:         std::cerr << "WARNING: PluginXml::setParameters: Plugin " \
lbajardsilogic@0:                   << #ATTRIBUTE << " does not match (attributes have \"" \
lbajardsilogic@0:                   << ATTRIBUTE.toStdString() << "\", my " \
lbajardsilogic@0:                   << #ATTRIBUTE << " is \"" << ACCESSOR() << "\")" << std::endl; \
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0: void
lbajardsilogic@0: PluginXml::setParameters(const QXmlAttributes &attrs)
lbajardsilogic@0: {
lbajardsilogic@0:     CHECK_ATTRIBUTE(identifier, m_plugin->getIdentifier);
lbajardsilogic@0:     CHECK_ATTRIBUTE(name, m_plugin->getName);
lbajardsilogic@0:     CHECK_ATTRIBUTE(description, m_plugin->getDescription);
lbajardsilogic@0:     CHECK_ATTRIBUTE(maker, m_plugin->getMaker);
lbajardsilogic@0:     CHECK_ATTRIBUTE(copyright, m_plugin->getCopyright);
lbajardsilogic@0: 
lbajardsilogic@0:     bool ok;
lbajardsilogic@0:     int version = attrs.value("version").trimmed().toInt(&ok);
lbajardsilogic@0:     if (ok && version != m_plugin->getPluginVersion()) {
lbajardsilogic@0:         std::cerr << "WARNING: PluginXml::setParameters: Plugin version does not match (attributes have " << version << ", my version is " << m_plugin->getPluginVersion() << ")" << std::endl;
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     RealTimePluginInstance *rtpi =
lbajardsilogic@0:         dynamic_cast<RealTimePluginInstance *>(m_plugin);
lbajardsilogic@0:     if (rtpi) {
lbajardsilogic@0:         QString config = attrs.value("configuration");
lbajardsilogic@0:         if (config != "") {
lbajardsilogic@0:             QStringList configList = config.split(";");
lbajardsilogic@0:             for (QStringList::iterator i = configList.begin();
lbajardsilogic@0:                  i != configList.end(); ++i) {
lbajardsilogic@0:                 QStringList kv = i->split("=");
lbajardsilogic@0:                 if (kv.count() < 2) {
lbajardsilogic@0:                     std::cerr << "WARNING: PluginXml::setParameters: Malformed configure pair string: \"" << i->toStdString() << "\"" << std::endl;
lbajardsilogic@0:                     continue;
lbajardsilogic@0:                 }
lbajardsilogic@0:                 QString key(kv[0]), value(kv[1]);
lbajardsilogic@0:                 key = decodeConfigurationChars(key);
lbajardsilogic@0:                 value = decodeConfigurationChars(value);
lbajardsilogic@0:                 rtpi->configure(key.toStdString(), value.toStdString());
lbajardsilogic@0:             }
lbajardsilogic@0:         }
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     if (!m_plugin->getPrograms().empty()) {
lbajardsilogic@0:         m_plugin->selectProgram(attrs.value("program").toStdString());
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     Vamp::PluginBase::ParameterList parameters =
lbajardsilogic@0:         m_plugin->getParameterDescriptors();
lbajardsilogic@0: 
lbajardsilogic@0:     for (Vamp::PluginBase::ParameterList::const_iterator i =
lbajardsilogic@0:              parameters.begin(); i != parameters.end(); ++i) {
lbajardsilogic@0: 
lbajardsilogic@0:         QString pname = QString("param-%1")
lbajardsilogic@0:             .arg(stripInvalidParameterNameCharacters
lbajardsilogic@0:                  (QString(i->identifier.c_str())));
lbajardsilogic@0: 
lbajardsilogic@0:         if (attrs.value(pname) == "") {
lbajardsilogic@0: //            std::cerr << "PluginXml::setParameters: no parameter \"" << i->name << "\" (attribute \"" << name.toStdString() << "\")" << std::endl;
lbajardsilogic@0:             continue;
lbajardsilogic@0:         }
lbajardsilogic@0: 
lbajardsilogic@0:         bool ok;
lbajardsilogic@0:         float value = attrs.value(pname).trimmed().toFloat(&ok);
lbajardsilogic@0:         if (ok) {
lbajardsilogic@0: //            std::cerr << "PluginXml::setParameters: setting parameter \""
lbajardsilogic@0: //                      << i->identifier << "\" to value " << value << std::endl;
lbajardsilogic@0:             m_plugin->setParameter(i->identifier, value);
lbajardsilogic@0:         } else {
lbajardsilogic@0:             std::cerr << "WARNING: PluginXml::setParameters: Invalid value \"" << attrs.value(pname).toStdString() << "\" for parameter \"" << i->identifier << "\" (attribute \"" << pname.toStdString() << "\")" << std::endl;
lbajardsilogic@0:         }
lbajardsilogic@0:     }
lbajardsilogic@0: }
lbajardsilogic@0: 
lbajardsilogic@0: void
lbajardsilogic@0: PluginXml::setParametersFromXml(QString xml)
lbajardsilogic@0: {
lbajardsilogic@0:     QDomDocument doc;
lbajardsilogic@0: 
lbajardsilogic@0:     QString error;
lbajardsilogic@0:     int errorLine;
lbajardsilogic@0:     int errorColumn;
lbajardsilogic@0: 
lbajardsilogic@0: //    std::cerr << "PluginXml::setParametersFromXml: XML is \""
lbajardsilogic@0: //              << xml.toLocal8Bit().data() << "\"" << std::endl;
lbajardsilogic@0: 
lbajardsilogic@0:     if (!doc.setContent(xml, false, &error, &errorLine, &errorColumn)) {
lbajardsilogic@0:         std::cerr << "PluginXml::setParametersFromXml: Error in parsing XML: " << error.toStdString() << " at line " << errorLine << ", column " << errorColumn << std::endl;
lbajardsilogic@0:         std::cerr << "Input follows:" << std::endl;
lbajardsilogic@0:         std::cerr << xml.toStdString() << std::endl;
lbajardsilogic@0:         std::cerr << "Input ends." << std::endl;
lbajardsilogic@0:         return;
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     QDomElement pluginElt = doc.firstChildElement("plugin");
lbajardsilogic@0:     QDomNamedNodeMap attrNodes = pluginElt.attributes();
lbajardsilogic@0:     QXmlAttributes attrs;
lbajardsilogic@0: 
lbajardsilogic@0:     for (unsigned int i = 0; i < attrNodes.length(); ++i) {
lbajardsilogic@0:         QDomAttr attr = attrNodes.item(i).toAttr();
lbajardsilogic@0:         if (attr.isNull()) continue;
lbajardsilogic@0: //        std::cerr << "PluginXml::setParametersFromXml: Adding attribute \"" << attr.name().toStdString()
lbajardsilogic@0: //                  << "\" with value \"" << attr.value().toStdString() << "\"" << std::endl;
lbajardsilogic@0:         attrs.append(attr.name(), "", "", attr.value());
lbajardsilogic@0:     }
lbajardsilogic@0: 
lbajardsilogic@0:     setParameters(attrs);
lbajardsilogic@0: }
lbajardsilogic@0: 
lbajardsilogic@0: QString
lbajardsilogic@0: PluginXml::stripInvalidParameterNameCharacters(QString s) const
lbajardsilogic@0: {
lbajardsilogic@0:     s.replace(QRegExp("[^a-zA-Z0-9_]*"), "");
lbajardsilogic@0:     return s;
lbajardsilogic@0: }
lbajardsilogic@0: