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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
/*
Copyright (C) 2008-2012 Paul Davis
Author: David Robillard
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; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __ardour_lv2_plugin_h__
#define __ardour_lv2_plugin_h__
#include <set>
#include <string>
#include <vector>
#include <boost/enable_shared_from_this.hpp>
#include "ardour/plugin.h"
#include "ardour/uri_map.h"
#include "ardour/worker.h"
#include "pbd/ringbuffer.h"
#ifndef PATH_MAX
#define PATH_MAX 1024
#endif
typedef struct LV2_Evbuf_Impl LV2_Evbuf;
namespace ARDOUR {
// a callback function for lilv_state_new_from_instance(). friend of LV2Plugin
// so we can pass an LV2Plugin* in user_data and access its private members.
const void* lv2plugin_get_port_value(const char* port_symbol,
void* user_data,
uint32_t* size,
uint32_t* type);
class AudioEngine;
class Session;
class LIBARDOUR_API LV2Plugin : public ARDOUR::Plugin, public ARDOUR::Workee
{
public:
LV2Plugin (ARDOUR::AudioEngine& engine,
ARDOUR::Session& session,
const void* c_plugin,
framecnt_t sample_rate);
LV2Plugin (const LV2Plugin &);
~LV2Plugin ();
std::string unique_id () const;
const char* uri () const;
const char* label () const;
const char* name () const;
const char* maker () const;
uint32_t num_ports () const;
uint32_t parameter_count () const;
float default_value (uint32_t port);
framecnt_t signal_latency () const;
void set_parameter (uint32_t port, float val);
float get_parameter (uint32_t port) const;
std::string get_docs() const;
std::string get_parameter_docs(uint32_t which) const;
int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
uint32_t nth_parameter (uint32_t port, bool& ok) const;
const void* extension_data (const char* uri) const;
const void* c_plugin();
const void* c_ui();
const void* c_ui_type();
bool is_external_ui () const;
bool is_external_kx () const;
bool ui_is_resizable () const;
const char* port_symbol (uint32_t port) const;
uint32_t port_index (const char* symbol) const;
const LV2_Feature* const* features () { return _features; }
std::set<Evoral::Parameter> automatable () const;
void activate ();
void deactivate ();
void cleanup ();
int set_block_size (pframes_t /*nframes*/) { return 0; }
int connect_and_run (BufferSet& bufs,
ChanMapping in, ChanMapping out,
pframes_t nframes, framecnt_t offset);
std::string describe_parameter (Evoral::Parameter);
std::string state_node_name () const { return "lv2"; }
void print_parameter (uint32_t param,
char* buf,
uint32_t len) const;
bool parameter_is_audio (uint32_t) const;
bool parameter_is_control (uint32_t) const;
bool parameter_is_event (uint32_t) const;
bool parameter_is_input (uint32_t) const;
bool parameter_is_output (uint32_t) const;
bool parameter_is_toggled (uint32_t) const;
boost::shared_ptr<ScalePoints>
get_scale_points(uint32_t port_index) const;
void set_insert_id(PBD::ID id);
int set_state (const XMLNode& node, int version);
bool save_preset (std::string uri);
void remove_preset (std::string uri);
bool load_preset (PresetRecord);
std::string current_preset () const;
bool has_editor () const;
bool has_message_output () const;
bool write_from_ui(uint32_t index,
uint32_t protocol,
uint32_t size,
const uint8_t* body);
typedef void UIMessageSink(void* controller,
uint32_t index,
uint32_t size,
uint32_t format,
const void* buffer);
void enable_ui_emission();
void emit_to_ui(void* controller, UIMessageSink sink);
Worker* worker() { return _worker; }
URIMap& uri_map() { return _uri_map; }
const URIMap& uri_map() const { return _uri_map; }
int work(uint32_t size, const void* data);
int work_response(uint32_t size, const void* data);
void set_property(uint32_t key, const Variant& value);
const PropertyDescriptors& get_supported_properties() const { return _property_descriptors; }
const ParameterDescriptor& get_property_descriptor(uint32_t id) const;
void announce_property_values();
private:
struct Impl;
Impl* _impl;
void* _module;
LV2_Feature** _features;
Worker* _worker;
framecnt_t _sample_rate;
float* _control_data;
float* _shadow_data;
float* _defaults;
LV2_Evbuf** _ev_buffers;
LV2_Evbuf** _atom_ev_buffers;
float* _bpm_control_port; ///< Special input set by ardour
float* _freewheel_control_port; ///< Special input set by ardour
float* _latency_control_port; ///< Special output set by ardour
framepos_t _next_cycle_start; ///< Expected start frame of next run cycle
double _next_cycle_speed; ///< Expected start frame of next run cycle
PBD::ID _insert_id;
uint32_t _patch_port_in_index;
uint32_t _patch_port_out_index;
URIMap& _uri_map;
friend const void* lv2plugin_get_port_value(const char* port_symbol,
void* user_data,
uint32_t* size,
uint32_t* type);
typedef enum {
PORT_INPUT = 1, ///< Input port
PORT_OUTPUT = 1 << 1, ///< Output port
PORT_AUDIO = 1 << 2, ///< Audio (buffer of float)
PORT_CONTROL = 1 << 3, ///< Control (single float)
PORT_EVENT = 1 << 4, ///< Old event API event port
PORT_SEQUENCE = 1 << 5, ///< New atom API event port
PORT_MIDI = 1 << 6, ///< Event port understands MIDI
PORT_POSITION = 1 << 7, ///< Event port understands position
PORT_PATCHMSG = 1 << 8 ///< Event port supports patch:Message
} PortFlag;
typedef unsigned PortFlags;
std::vector<PortFlags> _port_flags;
std::vector<size_t> _port_minimumSize;
std::map<std::string,uint32_t> _port_indices;
PropertyDescriptors _property_descriptors;
/// Message send to/from UI via ports
struct UIMessage {
uint32_t index;
uint32_t protocol;
uint32_t size;
};
bool write_to_ui(uint32_t index,
uint32_t protocol,
uint32_t size,
const uint8_t* body);
bool write_to(RingBuffer<uint8_t>* dest,
uint32_t index,
uint32_t protocol,
uint32_t size,
const uint8_t* body);
// Created on demand so the space is only consumed if necessary
RingBuffer<uint8_t>* _to_ui;
RingBuffer<uint8_t>* _from_ui;
typedef struct {
const void* (*extension_data) (const char* uri);
} LV2_DataAccess;
LV2_DataAccess _data_access_extension_data;
LV2_Feature _data_access_feature;
LV2_Feature _instance_access_feature;
LV2_Feature _make_path_feature;
LV2_Feature _log_feature;
LV2_Feature _work_schedule_feature;
LV2_Feature _options_feature;
LV2_Feature _def_state_feature;
// Options passed to plugin
int32_t _block_length;
int32_t _seq_size;
mutable unsigned _state_version;
bool _was_activated;
bool _has_state_interface;
const std::string plugin_dir () const;
const std::string scratch_dir () const;
const std::string file_dir () const;
const std::string state_dir (unsigned num) const;
static char* lv2_state_make_path (void* host_data,
const char* path);
void init (const void* c_plugin, framecnt_t rate);
void allocate_atom_event_buffers ();
void run (pframes_t nsamples);
void load_supported_properties(PropertyDescriptors& descs);
void latency_compute_run ();
std::string do_save_preset (std::string);
void do_remove_preset (std::string);
void find_presets ();
void add_state (XMLNode *) const;
};
class LIBARDOUR_API LV2PluginInfo : public PluginInfo , public boost::enable_shared_from_this<ARDOUR::LV2PluginInfo> {
public:
LV2PluginInfo (const char* plugin_uri);
~LV2PluginInfo ();
static PluginInfoList* discover ();
PluginPtr load (Session& session);
char * _plugin_uri;
};
typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
} // namespace ARDOUR
#endif /* __ardour_lv2_plugin_h__ */
|
