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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/* -*- 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-2007 Chris Cannam and QMUL.
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_TRANSFORM_DESCRIPTION_H
#define SV_TRANSFORM_DESCRIPTION_H
#include "Transform.h"
#include "plugin/Provider.h"
#include <QString>
#include <vector>
namespace sv {
/**
* Metadata associated with a transform.
*
* The transform ID is the same as that used in the Transform class.
* It is intended to be computer-referenceable and unique within the
* application.
*
* The name is intended to be human readable. In principle it doesn't
* have to be unique, but the factory that creates these objects
* should add suffixes to ensure that it is, all the same (just to
* avoid user confusion).
*
* The friendly name is a shorter version of the name.
*
* The type is also intended to be user-readable, for use in menus.
*
* To obtain these objects, use
* TransformFactory::getAllTransformDescriptions and
* TransformFactory::getTransformDescription.
*/
struct TransformDescription
{
enum Type {
Analysis, // e.g. vamp plugin output
Effects, // e.g. ladspa plugin with audio in and out
EffectsData, // e.g. control output of ladspa plugin
Generator, // e.g. audio out of ladspa plugin with no audio in
UnknownType
};
TransformDescription() :
type(UnknownType), configurable(false) { }
TransformDescription(Type _type, QString _category,
TransformId _identifier, QString _name,
QString _friendlyName, QString _description,
QString _longDescription, QString _pluginName,
QString _maker, QString _units, bool _configurable) :
type(_type), category(_category),
identifier(_identifier), name(_name),
friendlyName(_friendlyName), description(_description),
longDescription(_longDescription), pluginName(_pluginName),
maker(_maker), units(_units), configurable(_configurable) { }
Type type;
QString category; // e.g. time > onsets
TransformId identifier; // e.g. vamp:vamp-aubio:aubioonset
QString name; // plugin's name if 1 output, else "name: output"
QString friendlyName; // short text for layer name
QString description; // sentence describing transform
QString longDescription; // description "using" plugin name "by" maker
QString pluginName; // plugin name without adaptivity of "name"
QString maker;
Provider provider;
QString units;
bool configurable;
// User-visible strings (name, maker etc) should be sorted in a
// locale-aware way
static bool compareUserStrings(QString s1, QString s2) {
return QString::localeAwareCompare(s1, s2) < 0;
};
bool operator<(const TransformDescription &od) const {
if (name == od.name) {
return identifier < od.identifier;
} else {
return compareUserStrings(name, od.name);
}
};
};
typedef std::vector<TransformDescription> TransformList;
} // end namespace sv
#endif
|
