File: PluginXml.h

package info (click to toggle)
sonic-visualiser 5.2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 24,744 kB
  • sloc: cpp: 158,888; ansic: 11,920; sh: 1,785; makefile: 517; xml: 64; perl: 31
file content (67 lines) | stat: -rw-r--r-- 1,833 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/* -*- 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 SV_PLUGIN_XML_H
#define SV_PLUGIN_XML_H

#include "base/XmlExportable.h"
#include <vamp-hostsdk/PluginBase.h>

#include <memory>

#include <QMap>

namespace sv {

class PluginXml : public XmlExportable
{
public:
    PluginXml(std::shared_ptr<Vamp::PluginBase> plugin);
    virtual ~PluginXml();

    /**
     * Export plugin settings to XML.
     */
    void toXml(QTextStream &stream,
               QString indent = "",
               QString extraAttributes = "") const override;

    typedef QMap<QString, QString> Attributes;

    /**
     * Set the parameters and program of a plugin from a set of XML
     * attributes.  This is a partial inverse of toXml.
     */
    virtual void setParameters(const Attributes &);

    /**
     * Set the parameters and program of a plugin from an XML plugin
     * element as returned by toXml.  This is a partial inverse of
     * toXml.
     */
    virtual void setParametersFromXml(QString xml);

    static QString encodeConfigurationChars(QString text);
    static QString decodeConfigurationChars(QString text);

protected:
    QString stripInvalidParameterNameCharacters(QString) const;

    std::shared_ptr<Vamp::PluginBase> m_plugin;
};

} // end namespace sv

#endif