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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/*
* Plugin.h - class plugin, the base-class and generic interface for all plugins
*
* Copyright (c) 2005-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
*
* This file is part of LMMS - https://lmms.io
*
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program (see COPYING); if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
*/
#ifndef PLUGIN_H
#define PLUGIN_H
#include <QtCore/QStringList>
#include <QtCore/QMap>
#include <QtXml/QDomDocument>
#include "JournallingObject.h"
#include "Model.h"
#include "MemoryManager.h"
class QWidget;
class PixmapLoader;
class PluginView;
class AutomatableModel;
class EXPORT Plugin : public Model, public JournallingObject
{
MM_OPERATORS
Q_OBJECT
public:
enum PluginTypes
{
Instrument, // instrument being used in channel-track
Effect, // effect-plugin for effect-board
ImportFilter, // filter for importing a file
ExportFilter, // filter for exporting a file
Tool, // additional tool (level-meter etc)
Library, // simple library holding a code-base for
// several other plugins (e.g. VST-support)
Other,
Undefined = 255
} ;
// descriptor holds information about a plugin - every external plugin
// has to instantiate such a descriptor in an extern "C"-section so that
// the plugin-loader is able to access information about the plugin
struct Descriptor
{
const char * name;
const char * displayName;
const char * description;
const char * author;
int version;
PluginTypes type;
const PixmapLoader * logo;
const char * supportedFileTypes;
inline bool supportsFileType( const QString& extension ) const
{
return QString( supportedFileTypes ).split( QChar( ',' ) ).contains( extension );
}
class EXPORT SubPluginFeatures
{
public:
struct Key
{
typedef QMap<QString, QString> AttributeMap;
inline Key( const Plugin::Descriptor * desc = NULL,
const QString & name = QString(),
const AttributeMap & am = AttributeMap() )
:
desc( desc ),
name( name ),
attributes( am )
{
}
Key( const QDomElement & key );
QDomElement saveXML( QDomDocument & doc ) const;
inline bool isValid() const
{
return desc != NULL && name.isNull() == false;
}
const Plugin::Descriptor* desc;
QString name;
AttributeMap attributes;
} ;
typedef QList<Key> KeyList;
SubPluginFeatures( Plugin::PluginTypes type ) :
m_type( type )
{
}
virtual ~SubPluginFeatures()
{
}
virtual void fillDescriptionWidget( QWidget *, const Key * ) const
{
}
virtual void listSubPluginKeys( const Plugin::Descriptor *, KeyList & ) const
{
}
protected:
const Plugin::PluginTypes m_type;
} ;
SubPluginFeatures * subPluginFeatures;
} ;
// typedef a list so we can easily work with list of plugin descriptors
typedef QList<Descriptor*> DescriptorList;
// contructor of a plugin
Plugin( const Descriptor * descriptor, Model * parent );
virtual ~Plugin();
// returns display-name out of descriptor
virtual QString displayName() const
{
return Model::displayName().isEmpty()
? m_descriptor->displayName
: Model::displayName();
}
// return plugin-type
inline PluginTypes type( void ) const
{
return m_descriptor->type;
}
// return plugin-descriptor for further information
inline const Descriptor * descriptor() const
{
return m_descriptor;
}
// can be called if a file matching supportedFileTypes should be
// loaded/processed with the help of this plugin
virtual void loadFile( const QString & file );
// Called if external source needs to change something but we cannot
// reference the class header. Should return null if not key not found.
virtual AutomatableModel* childModel( const QString & modelName );
// returns an instance of a plugin whose name matches to given one
// if specified plugin couldn't be loaded, it creates a dummy-plugin
static Plugin * instantiate( const QString& pluginName, Model * parent, void * data );
// create a view for the model
PluginView * createView( QWidget * parent );
protected:
// create a view for the model
virtual PluginView* instantiateView( QWidget * ) = 0;
void collectErrorForUI( QString errMsg );
private:
const Descriptor * m_descriptor;
// pointer to instantiation-function in plugin
typedef Plugin * ( * InstantiationHook )( Model * , void * );
} ;
#endif
|
