annotate transform/Transform.h @ 467:c9b055f84326

* make use of CachedFile (untested)
author Chris Cannam
date Mon, 27 Oct 2008 18:15:20 +0000 (2008-10-27)
parents 78dd9b35559b
children 4c000e196bf1
rev   line source
Chris@320 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@320 2
Chris@320 3 /*
Chris@320 4 Sonic Visualiser
Chris@320 5 An audio file viewer and annotation editor.
Chris@320 6 Centre for Digital Music, Queen Mary, University of London.
Chris@328 7 This file copyright 2006-2007 Chris Cannam and QMUL.
Chris@320 8
Chris@320 9 This program is free software; you can redistribute it and/or
Chris@320 10 modify it under the terms of the GNU General Public License as
Chris@320 11 published by the Free Software Foundation; either version 2 of the
Chris@320 12 License, or (at your option) any later version. See the file
Chris@320 13 COPYING included with this distribution for more information.
Chris@320 14 */
Chris@320 15
Chris@320 16 #ifndef _TRANSFORM_H_
Chris@320 17 #define _TRANSFORM_H_
Chris@320 18
Chris@328 19 #include "base/XmlExportable.h"
Chris@328 20 #include "base/Window.h"
Chris@350 21 #include "base/RealTime.h"
Chris@328 22
Chris@328 23 #include <QString>
Chris@320 24
Chris@400 25 #include <map>
Chris@400 26
Chris@320 27 typedef QString TransformId;
Chris@320 28
Chris@350 29 class QXmlAttributes;
Chris@350 30
Chris@328 31 namespace Vamp {
Chris@328 32 class PluginBase;
Chris@328 33 }
Chris@320 34
Chris@328 35 class Transform : public XmlExportable
Chris@320 36 {
Chris@320 37 public:
Chris@350 38 /**
Chris@350 39 * Construct a new Transform with default data and no identifier.
Chris@350 40 * The Transform object will be meaningless until some data and an
Chris@350 41 * identifier have been set on it.
Chris@350 42 *
Chris@350 43 * To construct a Transform for use with a particular transform
Chris@350 44 * identifier, use TransformFactory::getDefaultTransformFor.
Chris@350 45 */
Chris@328 46 Transform();
Chris@350 47
Chris@350 48 /**
Chris@350 49 * Construct a Transform by parsing the given XML data string.
Chris@350 50 * This is the inverse of toXml.
Chris@350 51 */
Chris@350 52 Transform(QString xml);
Chris@350 53
Chris@320 54 virtual ~Transform();
Chris@320 55
Chris@350 56 /**
Chris@350 57 * Compare two Transforms. They only compare equal if every data
Chris@350 58 * element matches.
Chris@350 59 */
Chris@400 60 bool operator==(const Transform &) const;
Chris@400 61
Chris@400 62 /**
Chris@400 63 * Order two Transforms, so that they can be used as keys in
Chris@400 64 * containers.
Chris@400 65 */
Chris@400 66 bool operator<(const Transform &) const;
Chris@350 67
Chris@350 68 void setIdentifier(TransformId id);
Chris@350 69 TransformId getIdentifier() const;
Chris@320 70
Chris@328 71 enum Type { FeatureExtraction, RealTimeEffect };
Chris@328 72
Chris@328 73 Type getType() const;
Chris@328 74 QString getPluginIdentifier() const;
Chris@328 75 QString getOutput() const;
Chris@353 76
Chris@353 77 void setPluginIdentifier(QString pluginIdentifier);
Chris@353 78 void setOutput(QString output);
Chris@353 79
Chris@353 80 // Turn a plugin ID and output name into a transform ID. Note
Chris@353 81 // that our pluginIdentifier is the same thing as the Vamp SDK's
Chris@353 82 // PluginLoader::PluginKey.
Chris@353 83 static TransformId getIdentifierForPluginOutput(QString pluginIdentifier,
Chris@353 84 QString output = "");
Chris@328 85
Chris@328 86 typedef std::map<QString, float> ParameterMap;
Chris@328 87
Chris@350 88 const ParameterMap &getParameters() const;
Chris@350 89 void setParameters(const ParameterMap &pm);
Chris@350 90 void setParameter(QString name, float value);
Chris@328 91
Chris@328 92 typedef std::map<QString, QString> ConfigurationMap;
Chris@328 93
Chris@350 94 const ConfigurationMap &getConfiguration() const;
Chris@350 95 void setConfiguration(const ConfigurationMap &cm);
Chris@350 96 void setConfigurationValue(QString name, QString value);
Chris@328 97
Chris@366 98 QString getPluginVersion() const;
Chris@366 99 void setPluginVersion(QString version);
Chris@366 100
Chris@350 101 QString getProgram() const;
Chris@350 102 void setProgram(QString program);
Chris@328 103
Chris@350 104 size_t getStepSize() const;
Chris@350 105 void setStepSize(size_t s);
Chris@328 106
Chris@350 107 size_t getBlockSize() const;
Chris@350 108 void setBlockSize(size_t s);
Chris@328 109
Chris@350 110 WindowType getWindowType() const;
Chris@350 111 void setWindowType(WindowType type);
Chris@350 112
Chris@350 113 RealTime getStartTime() const;
Chris@350 114 void setStartTime(RealTime t);
Chris@350 115
Chris@350 116 RealTime getDuration() const; // 0 -> all
Chris@350 117 void setDuration(RealTime d);
Chris@350 118
Chris@350 119 float getSampleRate() const; // 0 -> as input
Chris@350 120 void setSampleRate(float rate);
Chris@328 121
Chris@328 122 void toXml(QTextStream &stream, QString indent = "",
Chris@328 123 QString extraAttributes = "") const;
Chris@328 124
Chris@350 125 /**
Chris@350 126 * Set the main transform data from the given XML attributes.
Chris@350 127 * This does not set the parameters or configuration, which are
Chris@350 128 * exported to separate XML elements rather than attributes of the
Chris@350 129 * transform element.
Chris@366 130 *
Chris@366 131 * Note that this only sets those attributes which are actually
Chris@366 132 * present in the argument. Any attributes not defined in the
Chris@366 133 * attribute will remain unchanged in the Transform. If your aim
Chris@366 134 * is to create a transform exactly matching the given attributes,
Chris@366 135 * ensure you start from an empty transform rather than one that
Chris@366 136 * has already been configured.
Chris@350 137 */
Chris@350 138 void setFromXmlAttributes(const QXmlAttributes &);
Chris@320 139
Chris@320 140 protected:
Chris@328 141 TransformId m_id; // pluginid:output, that is type:soname:label:output
Chris@328 142
Chris@328 143 static QString createIdentifier
Chris@328 144 (QString type, QString soName, QString label, QString output);
Chris@320 145
Chris@328 146 static void parseIdentifier
Chris@328 147 (QString identifier,
Chris@328 148 QString &type, QString &soName, QString &label, QString &output);
Chris@328 149
Chris@400 150 template <typename A, typename B>
Chris@400 151 bool mapLessThan(const std::map<A, B> &a, const std::map<A, B> &b) const {
Chris@400 152 // Return true if a is "less than" b. Ordering doesn't have
Chris@400 153 // to be meaningful, just consistent.
Chris@400 154 typename std::map<A, B>::const_iterator i;
Chris@400 155 typename std::map<A, B>::const_iterator j;
Chris@400 156 for (i = a.begin(), j = b.begin(); i != a.end(); ++i) {
Chris@400 157 if (j == b.end()) return false; // a is longer than b
Chris@400 158 if (i->first != j->first) return i->first < j->first;
Chris@400 159 if (i->second != j->second) return i->second < j->second;
Chris@400 160 }
Chris@400 161 if (j != b.end()) return true; // a is shorter than b
Chris@400 162 return false; // equal
Chris@400 163 }
Chris@400 164
Chris@328 165 ParameterMap m_parameters;
Chris@328 166 ConfigurationMap m_configuration;
Chris@366 167 QString m_pluginVersion;
Chris@328 168 QString m_program;
Chris@328 169 size_t m_stepSize;
Chris@328 170 size_t m_blockSize;
Chris@328 171 WindowType m_windowType;
Chris@350 172 RealTime m_startTime;
Chris@350 173 RealTime m_duration;
Chris@328 174 float m_sampleRate;
Chris@320 175 };
Chris@320 176
Chris@320 177 #endif
Chris@328 178