bc83e3e5feb0f7838a887b3383f68ea359b786ab
[ardour.git] / libs / ardour / lv2_plugin.cc
1 /*
2     Copyright (C) 2008-2011 Paul Davis
3     Author: David Robillard
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19 */
20
21 #include <string>
22 #include <vector>
23
24 #include <cmath>
25 #include <cstdlib>
26 #include <cstring>
27
28 #include <glibmm.h>
29
30 #include <boost/utility.hpp>
31
32 #include "pbd/compose.h"
33 #include "pbd/error.h"
34 #include "pbd/pathscanner.h"
35 #include "pbd/stl_delete.h"
36 #include "pbd/xml++.h"
37
38 #include "libardour-config.h"
39
40 #include "ardour/ardour.h"
41 #include "ardour/audio_buffer.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/debug.h"
44 #include "ardour/lv2_event_buffer.h"
45 #include "ardour/lv2_plugin.h"
46 #include "ardour/session.h"
47
48 #include "i18n.h"
49 #include <locale.h>
50
51 #include <slv2/slv2.h>
52
53 #include "lv2ext/lv2_files.h"
54 #include "lv2ext/lv2_persist.h"
55 #include "rdff.h"
56 #ifdef HAVE_SUIL
57 #include <suil/suil.h>
58 #endif
59
60 #define NS_DC   "http://dublincore.org/documents/dcmi-namespace/"
61 #define NS_LV2  "http://lv2plug.in/ns/lv2core#"
62 #define NS_PSET "http://lv2plug.in/ns/dev/presets#"
63 #define NS_UI   "http://lv2plug.in/ns/extensions/ui#"
64
65 using namespace std;
66 using namespace ARDOUR;
67 using namespace PBD;
68
69 URIMap LV2Plugin::_uri_map;
70 uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
71         "http://lv2plug.in/ns/ext/event",
72         "http://lv2plug.in/ns/ext/midi#MidiEvent");
73
74 class LV2World : boost::noncopyable {
75 public:
76         LV2World ();
77         ~LV2World ();
78
79         SLV2World world;
80         SLV2Value input_class; ///< Input port
81         SLV2Value output_class; ///< Output port
82         SLV2Value audio_class; ///< Audio port
83         SLV2Value control_class; ///< Control port
84         SLV2Value event_class; ///< Event port
85         SLV2Value midi_class; ///< MIDI event
86         SLV2Value in_place_broken;
87         SLV2Value integer;
88         SLV2Value toggled;
89         SLV2Value srate;
90         SLV2Value gtk_gui;
91         SLV2Value external_gui;
92         SLV2Value logarithmic;
93 };
94
95 static LV2World _world;
96
97 struct LV2Plugin::Impl {
98         Impl() : plugin(0), ui(0), ui_type(0), name(0), author(0), instance(0) {}
99         SLV2Plugin   plugin;
100         SLV2UI       ui;
101         SLV2Value    ui_type;
102         SLV2Value    name;
103         SLV2Value    author;
104         SLV2Instance instance;
105 };
106
107 LV2Plugin::LV2Plugin (AudioEngine& engine,
108                       Session&     session,
109                       void*        c_plugin,
110                       framecnt_t   rate)
111         : Plugin(engine, session)
112         , _impl(new Impl())
113         , _features(NULL)
114         , _insert_id("0")
115 {
116         init(c_plugin, rate);
117 }
118
119 LV2Plugin::LV2Plugin (const LV2Plugin& other)
120         : Plugin(other)
121         , _impl(new Impl())
122         , _features(NULL)
123         , _insert_id(other._insert_id)
124 {
125         init(other._impl->plugin, other._sample_rate);
126
127         for (uint32_t i = 0; i < parameter_count(); ++i) {
128                 _control_data[i] = other._shadow_data[i];
129                 _shadow_data[i]  = other._shadow_data[i];
130         }
131 }
132
133 void
134 LV2Plugin::init(void* c_plugin, framecnt_t rate)
135 {
136         DEBUG_TRACE(DEBUG::LV2, "init\n");
137
138         _impl->plugin          = (SLV2Plugin)c_plugin;
139         _impl->ui              = NULL;
140         _impl->ui_type         = NULL;
141         _control_data         = 0;
142         _shadow_data          = 0;
143         _latency_control_port = 0;
144         _was_activated        = false;
145
146         _instance_access_feature.URI  = "http://lv2plug.in/ns/ext/instance-access";
147         _data_access_feature.URI      = "http://lv2plug.in/ns/ext/data-access";
148         _path_support_feature.URI     = LV2_FILES_PATH_SUPPORT_URI;
149         _new_file_support_feature.URI = LV2_FILES_NEW_FILE_SUPPORT_URI;
150         _persist_feature.URI          = "http://lv2plug.in/ns/ext/persist";
151         _persist_feature.data         = NULL;
152
153         SLV2Plugin plugin = _impl->plugin;
154
155         SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
156         _supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
157         slv2_value_free(persist_uri);
158
159         _features    = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 7);
160         _features[0] = &_instance_access_feature;
161         _features[1] = &_data_access_feature;
162         _features[2] = &_path_support_feature;
163         _features[3] = &_new_file_support_feature;
164         _features[4] = &_persist_feature;
165         _features[5] = _uri_map.feature();
166         _features[6] = NULL;
167
168         LV2_Files_Path_Support* path_support = (LV2_Files_Path_Support*)malloc(
169                 sizeof(LV2_Files_Path_Support));
170         path_support->host_data = this;
171         path_support->abstract_path = &lv2_files_abstract_path;
172         path_support->absolute_path = &lv2_files_absolute_path;
173         _path_support_feature.data = path_support;
174
175         LV2_Files_New_File_Support* new_file_support = (LV2_Files_New_File_Support*)malloc(
176                 sizeof(LV2_Files_New_File_Support));
177         new_file_support->host_data = this;
178         new_file_support->new_file_path = &lv2_files_new_file_path;
179         _new_file_support_feature.data = new_file_support;
180
181         _impl->instance = slv2_plugin_instantiate(plugin, rate, _features);
182         _impl->name     = slv2_plugin_get_name(plugin);
183         _impl->author   = slv2_plugin_get_author_name(plugin);
184
185         if (_impl->instance == 0) {
186                 error << _("LV2: Failed to instantiate plugin ") << uri() << endmsg;
187                 throw failed_constructor();
188         }
189
190         _instance_access_feature.data              = (void*)_impl->instance->lv2_handle;
191         _data_access_extension_data.extension_data = _impl->instance->lv2_descriptor->extension_data;
192         _data_access_feature.data                  = &_data_access_extension_data;
193
194         if (slv2_plugin_has_feature(plugin, _world.in_place_broken)) {
195                 error << string_compose(
196                     _("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
197                     slv2_value_as_string(_impl->name)) << endmsg;
198                 slv2_value_free(_impl->name);
199                 slv2_value_free(_impl->author);
200                 throw failed_constructor();
201         }
202
203         _sample_rate = rate;
204
205         const uint32_t num_ports    = this->num_ports();
206         const bool     latent       = slv2_plugin_has_latency(plugin);
207         const uint32_t latency_port = (latent)
208             ? slv2_plugin_get_latency_port_index(plugin)
209                 : 0;
210
211         _control_data = new float[num_ports];
212         _shadow_data  = new float[num_ports];
213         _defaults     = new float[num_ports];
214
215         for (uint32_t i = 0; i < num_ports; ++i) {
216                 SLV2Port  port = slv2_plugin_get_port_by_index(plugin, i);
217                 SLV2Value sym  = slv2_port_get_symbol(plugin, port);
218
219                 // Store index in map so we can look up index by symbol
220                 _port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
221
222                 // Get range and default value if applicable
223                 if (parameter_is_control(i)) {
224                         SLV2Value def;
225                         slv2_port_get_range(plugin, port, &def, NULL, NULL);
226                         _defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
227                         slv2_value_free(def);
228
229                         slv2_instance_connect_port(_impl->instance, i, &_control_data[i]);
230
231                         if (latent && ( i == latency_port) ) {
232                                 _latency_control_port  = &_control_data[i];
233                                 *_latency_control_port = 0;
234                         }
235
236                         if (parameter_is_input(i)) {
237                                 _shadow_data[i] = default_value(i);
238                         }
239                 } else {
240                         _defaults[i] = 0.0f;
241                 }
242         }
243
244         SLV2UIs uis = slv2_plugin_get_uis(plugin);
245         if (slv2_uis_size(uis) > 0) {
246 #if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
247                 // Look for embeddable UI
248                 SLV2Value ui_type = NULL;
249                 SLV2_FOREACH(uis, u, uis) {
250                         SLV2UI    this_ui      = slv2_uis_get(uis, u);
251                         SLV2Value this_ui_type = NULL;
252                         if (slv2_ui_is_supported(this_ui,
253                                                  suil_ui_supported,
254                                                  _world.gtk_gui,
255                                                  &this_ui_type)) {
256                                 // TODO: Multiple UI support
257                                 _ui      = this_ui;
258                                 _ui_type = this_ui_type;
259                                 break;
260                         } 
261                 }
262 #else
263                 // Look for Gtk native UI
264                 for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
265                         SLV2UI ui = slv2_uis_get_at(uis, i);
266                         if (slv2_ui_is_a(ui, _world.gtk_gui)) {
267                                 _impl->ui      = ui;
268                                 _impl->ui_type = _world.gtk_gui;
269                                 break;
270                         }
271                 }
272 #endif
273
274                 // If Gtk UI is not available, try to find external UI
275                 if (!_impl->ui) {
276                         for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
277                                 SLV2UI ui = slv2_uis_get_at(uis, i);
278                                 if (slv2_ui_is_a(ui, _world.external_gui)) {
279                                         _impl->ui      = ui;
280                                         _impl->ui_type = _world.external_gui;
281                                         break;
282                                 }
283                         }
284                 }
285         }
286
287         latency_compute_run();
288 }
289
290 LV2Plugin::~LV2Plugin ()
291 {
292         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
293
294         deactivate();
295         cleanup();
296
297         slv2_instance_free(_impl->instance);
298         slv2_value_free(_impl->name);
299         slv2_value_free(_impl->author);
300 #if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
301         slv2_value_free(_impl->ui_type);
302 #else
303         /* _ui_type points to a global, so leave it alone */
304 #endif
305         delete [] _control_data;
306         delete [] _shadow_data;
307 }
308
309 bool
310 LV2Plugin::is_external_ui() const
311 {
312         if (!_impl->ui) {
313                 return false;
314         }
315         return slv2_ui_is_a(_impl->ui, _world.external_gui);
316 }
317
318 string
319 LV2Plugin::unique_id() const
320 {
321         return slv2_value_as_uri(slv2_plugin_get_uri(_impl->plugin));
322 }
323
324 const char*
325 LV2Plugin::uri() const
326 {
327         return slv2_value_as_uri(slv2_plugin_get_uri(_impl->plugin));
328 }
329
330 const char*
331 LV2Plugin::label() const
332 {
333         return slv2_value_as_string(_impl->name);
334 }
335
336 const char*
337 LV2Plugin::name() const
338 {
339         return slv2_value_as_string(_impl->name);
340 }
341
342 const char*
343 LV2Plugin::maker() const
344 {
345         return _impl->author ? slv2_value_as_string (_impl->author) : "Unknown";
346 }
347
348 uint32_t
349 LV2Plugin::num_ports() const
350 {
351         return slv2_plugin_get_num_ports(_impl->plugin);
352 }
353
354 uint32_t
355 LV2Plugin::parameter_count() const
356 {
357         return slv2_plugin_get_num_ports(_impl->plugin);
358 }
359
360 float
361 LV2Plugin::default_value(uint32_t port)
362 {
363         return _defaults[port];
364 }
365
366 const char*
367 LV2Plugin::port_symbol(uint32_t index) const
368 {
369         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, index);
370         if (!port) {
371                 error << name() << ": Invalid port index " << index << endmsg;
372         }
373
374         SLV2Value sym = slv2_port_get_symbol(_impl->plugin, port);
375         return slv2_value_as_string(sym);
376 }
377
378 void
379 LV2Plugin::set_parameter(uint32_t which, float val)
380 {
381         DEBUG_TRACE(DEBUG::LV2, string_compose(
382                             "%1 set parameter %2 to %3\n", name(), which, val));
383
384         if (which < slv2_plugin_get_num_ports(_impl->plugin)) {
385                 _shadow_data[which] = val;
386         } else {
387                 warning << string_compose(
388                     _("Illegal parameter number used with plugin \"%1\". "
389                       "This is a bug in either %2 or the LV2 plugin <%3>"),
390                     name(), PROGRAM_NAME, unique_id()) << endmsg;
391         }
392
393         Plugin::set_parameter(which, val);
394 }
395
396 float
397 LV2Plugin::get_parameter(uint32_t which) const
398 {
399         if (parameter_is_input(which)) {
400                 return (float)_shadow_data[which];
401         } else {
402                 return (float)_control_data[which];
403         }
404         return 0.0f;
405 }
406
407 uint32_t
408 LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
409 {
410         ok = false;
411         for (uint32_t c = 0, x = 0; x < slv2_plugin_get_num_ports(_impl->plugin); ++x) {
412                 if (parameter_is_control(x)) {
413                         if (c++ == n) {
414                                 ok = true;
415                                 return x;
416                         }
417                 }
418         }
419
420         return 0;
421 }
422
423 const void*
424 LV2Plugin::extension_data (const char* uri)
425 {
426         return _impl->instance->lv2_descriptor->extension_data (uri);
427 }
428
429 void*
430 LV2Plugin::c_plugin ()
431 {
432         return _impl->plugin;
433 }
434
435 void*
436 LV2Plugin::c_ui ()
437 {
438         return _impl->ui;
439 }
440
441 struct PersistValue {
442         inline PersistValue(uint32_t k, const void* v, size_t s, uint32_t t, uint32_t f)
443                 : key(k), value(v), size(s), type(t), flags(f)
444         {}
445
446         const uint32_t key;
447         const void*    value;
448         const size_t   size;
449         const uint32_t type;
450         const bool     flags;
451 };
452
453 struct PersistState {
454         PersistState(URIMap& map) : uri_map(map) {}
455
456         typedef std::map<uint32_t, std::string>  URIs;
457         typedef std::map<uint32_t, PersistValue> Values;
458
459         uint32_t file_id_to_runtime_id(uint32_t file_id) const {
460                 URIs::const_iterator i = uris.find(file_id);
461                 if (i == uris.end()) {
462                         error << "LV2 state refers to undefined URI ID" << endmsg;
463                         return 0;
464                 }
465                 return uri_map.uri_to_id(NULL, i->second.c_str());
466         }
467
468         int add_uri(uint32_t file_id, const char* str) {
469                 // TODO: check for clashes (invalid file)
470                 uris.insert(make_pair(file_id, str));
471                 return 0;
472         }
473
474         int add_value(uint32_t    file_key,
475                       const void* value,
476                       size_t      size,
477                       uint32_t    file_type,
478                       uint32_t    flags) {
479                 const uint32_t key  = file_id_to_runtime_id(file_key);
480                 const uint32_t type = file_id_to_runtime_id(file_type);
481                 if (!key || !type) {
482                         return 1;
483                 }
484
485                 Values::const_iterator i = values.find(key);
486                 if (i != values.end()) {
487                         error << "LV2 state contains duplicate keys" << endmsg;
488                         return 1;
489                 } else {
490                         void* value_copy = malloc(size);
491                         memcpy(value_copy, value, size); // FIXME: leak
492                         values.insert(
493                                 make_pair(key,
494                                           PersistValue(key, value_copy, size, type, flags)));
495                         return 0;
496                 }
497         }
498
499         URIMap& uri_map;
500         URIs    uris;
501         Values  values;
502 };
503
504 int
505 LV2Plugin::lv2_persist_store_callback(void*       host_data,
506                                       uint32_t    key,
507                                       const void* value,
508                                       size_t      size,
509                                       uint32_t    type,
510                                       uint32_t    flags)
511 {
512         DEBUG_TRACE(DEBUG::LV2, string_compose(
513                             "persist store %1 (size: %2, type: %3)\n",
514                             _uri_map.id_to_uri(NULL, key),
515                             size,
516                             _uri_map.id_to_uri(NULL, type)));
517
518         PersistState* state = (PersistState*)host_data;
519         state->add_uri(key,  _uri_map.id_to_uri(NULL, key)); 
520         state->add_uri(type, _uri_map.id_to_uri(NULL, type)); 
521         return state->add_value(key, value, size, type, flags);
522 }
523
524 const void*
525 LV2Plugin::lv2_persist_retrieve_callback(void*     host_data,
526                                          uint32_t  key,
527                                          size_t*   size,
528                                          uint32_t* type,
529                                          uint32_t* flags)
530 {
531         PersistState* state = (PersistState*)host_data;
532         PersistState::Values::const_iterator i = state->values.find(key);
533         if (i == state->values.end()) {
534                 warning << "LV2 plugin attempted to retrieve nonexistent key: "
535                         << _uri_map.id_to_uri(NULL, key) << endmsg;
536                 return NULL;
537         }
538         *size = i->second.size;
539         *type = i->second.type;
540         *flags = LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE; // FIXME
541         DEBUG_TRACE(DEBUG::LV2, string_compose(
542                             "persist retrieve %1 = %2 (size: %3, type: %4)\n",
543                             _uri_map.id_to_uri(NULL, key),
544                             i->second.value, *size, *type));
545         return i->second.value;
546 }
547
548 char*
549 LV2Plugin::lv2_files_abstract_path(LV2_Files_Host_Data host_data,
550                                    const char*         absolute_path)
551 {
552         LV2Plugin* me = (LV2Plugin*)host_data;
553         if (me->_insert_id == PBD::ID("0")) {
554                 return g_strdup(absolute_path);
555         }
556
557         const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
558                                                            me->_insert_id.to_s());
559
560         char* ret = NULL;
561         if (strncmp(absolute_path, state_dir.c_str(), state_dir.length())) {
562                 ret = g_strdup(absolute_path);
563         } else {
564                 const std::string path(absolute_path + state_dir.length() + 1);
565                 ret = g_strndup(path.c_str(), path.length());
566         }
567
568         DEBUG_TRACE(DEBUG::LV2, string_compose("abstract path %1 => %2\n",
569                                                absolute_path, ret));
570
571         return ret;
572 }
573
574 char*
575 LV2Plugin::lv2_files_absolute_path(LV2_Files_Host_Data host_data,
576                                    const char*         abstract_path)
577 {
578         LV2Plugin* me = (LV2Plugin*)host_data;
579         if (me->_insert_id == PBD::ID("0")) {
580                 return g_strdup(abstract_path);
581         }
582
583         char* ret = NULL;
584         if (g_path_is_absolute(abstract_path)) {
585                 ret = g_strdup(abstract_path);
586         } else {
587                 const std::string apath(abstract_path);
588                 const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
589                                                                    me->_insert_id.to_s());
590                 const std::string path = Glib::build_filename(state_dir,
591                                                               apath);
592                 ret = g_strndup(path.c_str(), path.length());
593         }
594
595         DEBUG_TRACE(DEBUG::LV2, string_compose("absolute path %1 => %2\n",
596                                                abstract_path, ret));
597
598         return ret;
599 }
600
601 char*
602 LV2Plugin::lv2_files_new_file_path(LV2_Files_Host_Data host_data,
603                                    const char*         relative_path)
604 {
605         LV2Plugin* me = (LV2Plugin*)host_data;
606         if (me->_insert_id == PBD::ID("0")) {
607                 return g_strdup(relative_path);
608         }
609
610         const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
611                                                            me->_insert_id.to_s());
612         const std::string path = Glib::build_filename(state_dir,
613                                                       relative_path);
614
615         char* dirname = g_path_get_dirname(path.c_str());
616         g_mkdir_with_parents(dirname, 0744);
617         free(dirname);
618
619         DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
620                                                relative_path, path));
621         
622         return g_strndup(path.c_str(), path.length());
623 }
624
625 void
626 LV2Plugin::add_state(XMLNode* root) const
627 {
628         assert(_insert_id != PBD::ID("0"));
629
630         XMLNode*    child;
631         char        buf[16];
632         LocaleGuard lg(X_("POSIX"));
633
634         for (uint32_t i = 0; i < parameter_count(); ++i) {
635                 if (parameter_is_input(i) && parameter_is_control(i)) {
636                         child = new XMLNode("Port");
637                         child->add_property("symbol", port_symbol(i));
638                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
639                         child->add_property("value", string(buf));
640                         root->add_child_nocopy(*child);
641                 }
642         }
643
644         if (_supports_persist) {
645                 // Create state directory for this plugin instance
646                 const std::string state_filename = _insert_id.to_s() + ".rdff";
647                 const std::string state_path     = Glib::build_filename(
648                         _session.plugins_dir(), state_filename);
649
650                 cout << "Saving LV2 plugin state to " << state_path << endl;
651
652                 // Get LV2 Persist extension data from plugin instance
653                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
654                         _impl->instance, "http://lv2plug.in/ns/ext/persist");
655                 if (!persist) {
656                         warning << string_compose(
657                             _("Plugin \"%1\% failed to return LV2 persist data"),
658                             unique_id());
659                         return;
660                 }
661
662                 // Save plugin state to state object
663                 PersistState state(_uri_map);
664                 persist->save(_impl->instance->lv2_handle,
665                               &LV2Plugin::lv2_persist_store_callback,
666                               &state);
667
668                 // Open state file
669                 RDFF file = rdff_open(state_path.c_str(), true);
670
671                 // Write all referenced URIs to state file
672                 for (PersistState::URIs::const_iterator i = state.uris.begin();
673                      i != state.uris.end(); ++i) {
674                         rdff_write_uri(file,
675                                        i->first,
676                                        i->second.length(),
677                                        i->second.c_str());
678                 }
679
680                 // Write all values to state file
681                 for (PersistState::Values::const_iterator i = state.values.begin();
682                      i != state.values.end(); ++i) {
683                         const uint32_t      key = i->first;
684                         const PersistValue& val = i->second;
685                         rdff_write_triple(file,
686                                           0,
687                                           key,
688                                           val.type,
689                                           val.size,
690                                           val.value);
691                 }
692
693                 // Close state file
694                 rdff_close(file);
695
696                 root->add_property("state-file", state_filename);
697         }
698 }
699
700 static inline SLV2Value
701 get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
702 {
703         SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
704         return vs ? slv2_values_get_at(vs, 0) : NULL;
705 }
706
707 void
708 LV2Plugin::find_presets()
709 {
710         SLV2Value dc_title       = slv2_value_new_uri(_world.world, NS_DC   "title");
711         SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
712
713         SLV2Values presets = slv2_plugin_get_value(_impl->plugin, pset_hasPreset);
714         for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
715                 SLV2Value preset = slv2_values_get_at(presets, i);
716                 SLV2Value name   = get_value(_impl->plugin, preset, dc_title);
717                 if (name) {
718                         _presets.insert(std::make_pair(slv2_value_as_string(preset),
719                                                        PresetRecord(
720                                                            slv2_value_as_string(preset),
721                                                            slv2_value_as_string(name))));
722                 } else {
723                         warning << string_compose(
724                             _("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
725                             unique_id(), slv2_value_as_string(preset));
726                 }
727         }
728         slv2_values_free(presets);
729
730         slv2_value_free(pset_hasPreset);
731         slv2_value_free(dc_title);
732 }
733
734 bool
735 LV2Plugin::load_preset(PresetRecord r)
736 {
737         Plugin::load_preset(r);
738
739 #ifdef HAVE_NEW_SLV2
740         // New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
741         // so querying ports is possible with the simple/fast API
742         SLV2Value lv2_port   = slv2_value_new_uri(_world.world, NS_LV2 "port");
743         SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
744         SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
745         SLV2Value preset     = slv2_value_new_uri(_world.world, r.uri.c_str());
746
747         SLV2Values ports = slv2_plugin_get_value_for_subject(_impl->plugin, preset, lv2_port);
748         for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
749                 SLV2Value port   = slv2_values_get_at(ports, i);
750                 SLV2Value symbol = get_value(_impl->plugin, port, lv2_symbol);
751                 SLV2Value value  = get_value(_impl->plugin, port, pset_value);
752                 if (value && slv2_value_is_float(value)) {
753                         set_parameter(_port_indices[slv2_value_as_string(symbol)],
754                                       slv2_value_as_float(value));
755                 }
756         }
757         slv2_values_free(ports);
758
759         slv2_value_free(preset);
760         slv2_value_free(pset_value);
761         slv2_value_free(lv2_symbol);
762         slv2_value_free(lv2_port);
763 #else
764         const string query = string(
765                 "PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
766                 "PREFIX dc:  <http://dublincore.org/documents/dcmi-namespace/>\n"
767                 "SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
768             " ?port lv2:symbol ?sym ; lv2p:value ?val . }";
769         SLV2Results values = slv2_plugin_query_sparql(_impl->plugin, query.c_str());
770         for (; !slv2_results_finished(values); slv2_results_next(values)) {
771                 SLV2Value sym = slv2_results_get_binding_value(values, 0);
772                 SLV2Value val = slv2_results_get_binding_value(values, 1);
773                 if (slv2_value_is_float(val)) {
774                         uint32_t index = _port_indices[slv2_value_as_string(sym)];
775                         set_parameter(index, slv2_value_as_float(val));
776                 }
777         }
778         slv2_results_free(values);
779 #endif
780         return true;
781 }
782
783 std::string
784 LV2Plugin::do_save_preset(string /*name*/)
785 {
786         return "";
787 }
788
789 void
790 LV2Plugin::do_remove_preset(string /*name*/)
791 {}
792
793 bool
794 LV2Plugin::has_editor() const
795 {
796         return _impl->ui != NULL;
797 }
798
799 void
800 LV2Plugin::set_insert_info(const PluginInsert* insert)
801 {
802         _insert_id = insert->id();
803 }
804
805 int
806 LV2Plugin::set_state(const XMLNode& node, int version)
807 {
808         XMLNodeList          nodes;
809         const XMLProperty*   prop;
810         XMLNodeConstIterator iter;
811         XMLNode*             child;
812         const char*          sym;
813         const char*          value;
814         uint32_t             port_id;
815         LocaleGuard          lg(X_("POSIX"));
816
817         if (node.name() != state_node_name()) {
818                 error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
819                 return -1;
820         }
821
822         if (version < 3000) {
823                 nodes = node.children("port");
824         } else {
825                 nodes = node.children("Port");
826         }
827
828         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
829
830                 child = *iter;
831
832                 if ((prop = child->property("symbol")) != 0) {
833                         sym = prop->value().c_str();
834                 } else {
835                         warning << _("LV2: port has no symbol, ignored") << endmsg;
836                         continue;
837                 }
838
839                 map<string, uint32_t>::iterator i = _port_indices.find(sym);
840
841                 if (i != _port_indices.end()) {
842                         port_id = i->second;
843                 } else {
844                         warning << _("LV2: port has unknown index, ignored") << endmsg;
845                         continue;
846                 }
847
848                 if ((prop = child->property("value")) != 0) {
849                         value = prop->value().c_str();
850                 } else {
851                         warning << _("LV2: port has no value, ignored") << endmsg;
852                         continue;
853                 }
854
855                 set_parameter(port_id, atof(value));
856         }
857
858         if ((prop = node.property("state-file")) != 0) {
859                 std::string state_path = Glib::build_filename(_session.plugins_dir(),
860                                                               prop->value());
861
862                 cout << "LV2 state path " << state_path << endl;
863
864                 // Get LV2 Persist extension data from plugin instance
865                 LV2_Persist* persist = (LV2_Persist*)slv2_instance_get_extension_data(
866                         _impl->instance, "http://lv2plug.in/ns/ext/persist");
867                 if (persist) {
868                         cout << "Loading LV2 state from " << state_path << endl;
869                         RDFF file = rdff_open(state_path.c_str(), false);
870
871                         PersistState state(_uri_map);
872
873                         // Load file into state object
874                         RDFFChunk* chunk = (RDFFChunk*)malloc(sizeof(RDFFChunk));
875                         chunk->size = 0;
876                         while (!rdff_read_chunk(file, &chunk)) {
877                                 if (rdff_chunk_is_uri(chunk)) {
878                                         RDFFURIChunk* body = (RDFFURIChunk*)chunk->data;
879                                         state.add_uri(body->id, body->uri);
880                                 } else if (rdff_chunk_is_triple(chunk)) {
881                                         RDFFTripleChunk* body = (RDFFTripleChunk*)chunk->data;
882                                         state.add_value(body->predicate,
883                                                         body->object,
884                                                         body->object_size,
885                                                         body->object_type,
886                                                         LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE);
887                                 }
888                         }
889                         free(chunk);
890                         
891                         persist->restore(_impl->instance->lv2_handle,
892                                          &LV2Plugin::lv2_persist_retrieve_callback,
893                                          &state);
894                         rdff_close(file);
895                 } else {
896                         warning << string_compose(
897                             _("Plugin \"%1\% failed to return LV2 persist data"),
898                             unique_id());
899                 }
900         }
901
902         latency_compute_run();
903
904         return Plugin::set_state(node, version);
905 }
906
907 int
908 LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
909 {
910         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, which);
911
912         SLV2Value def, min, max;
913         slv2_port_get_range(_impl->plugin, port, &def, &min, &max);
914
915         desc.integer_step = slv2_port_has_property(_impl->plugin, port, _world.integer);
916         desc.toggled      = slv2_port_has_property(_impl->plugin, port, _world.toggled);
917         desc.logarithmic  = slv2_port_has_property(_impl->plugin, port, _world.logarithmic);
918         desc.sr_dependent = slv2_port_has_property(_impl->plugin, port, _world.srate);
919         desc.label        = slv2_value_as_string(slv2_port_get_name(_impl->plugin, port));
920         desc.lower        = min ? slv2_value_as_float(min) : 0.0f;
921         desc.upper        = max ? slv2_value_as_float(max) : 1.0f;
922         desc.min_unbound  = false; // TODO: LV2 extension required
923         desc.max_unbound  = false; // TODO: LV2 extension required
924
925         if (desc.integer_step) {
926                 desc.step      = 1.0;
927                 desc.smallstep = 0.1;
928                 desc.largestep = 10.0;
929         } else {
930                 const float delta = desc.upper - desc.lower;
931                 desc.step      = delta / 1000.0f;
932                 desc.smallstep = delta / 10000.0f;
933                 desc.largestep = delta / 10.0f;
934         }
935
936         slv2_value_free(def);
937         slv2_value_free(min);
938         slv2_value_free(max);
939
940         return 0;
941 }
942
943 string
944 LV2Plugin::describe_parameter(Evoral::Parameter which)
945 {
946         if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
947                 SLV2Value name = slv2_port_get_name(_impl->plugin,
948                                                     slv2_plugin_get_port_by_index(_impl->plugin, which.id()));
949                 string ret(slv2_value_as_string(name));
950                 slv2_value_free(name);
951                 return ret;
952         } else {
953                 return "??";
954         }
955 }
956
957 framecnt_t
958 LV2Plugin::signal_latency() const
959 {
960         if (_latency_control_port) {
961                 return (framecnt_t)floor(*_latency_control_port);
962         } else {
963                 return 0;
964         }
965 }
966
967 set<Evoral::Parameter>
968 LV2Plugin::automatable() const
969 {
970         set<Evoral::Parameter> ret;
971
972         for (uint32_t i = 0; i < parameter_count(); ++i) {
973                 if (parameter_is_input(i) && parameter_is_control(i)) {
974                         ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
975                 }
976         }
977
978         return ret;
979 }
980
981 void
982 LV2Plugin::activate()
983 {
984         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
985
986         if (!_was_activated) {
987                 slv2_instance_activate(_impl->instance);
988                 _was_activated = true;
989         }
990 }
991
992 void
993 LV2Plugin::deactivate()
994 {
995         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
996
997         if (_was_activated) {
998                 slv2_instance_deactivate(_impl->instance);
999                 _was_activated = false;
1000         }
1001 }
1002
1003 void
1004 LV2Plugin::cleanup()
1005 {
1006         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
1007
1008         activate();
1009         deactivate();
1010         slv2_instance_free(_impl->instance);
1011         _impl->instance = NULL;
1012 }
1013
1014 int
1015 LV2Plugin::connect_and_run(BufferSet& bufs,
1016         ChanMapping in_map, ChanMapping out_map,
1017         pframes_t nframes, framecnt_t offset)
1018 {
1019         DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
1020         Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
1021
1022         cycles_t then = get_cycles();
1023
1024         uint32_t audio_in_index  = 0;
1025         uint32_t audio_out_index = 0;
1026         uint32_t midi_in_index   = 0;
1027         uint32_t midi_out_index  = 0;
1028         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
1029                 if (parameter_is_audio(port_index)) {
1030                         if (parameter_is_input(port_index)) {
1031                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
1032                                 slv2_instance_connect_port(_impl->instance, port_index,
1033                                                            bufs.get_audio(buf_index).data(offset));
1034                         } else if (parameter_is_output(port_index)) {
1035                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
1036                                 //cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
1037                                 slv2_instance_connect_port(_impl->instance, port_index,
1038                                                            bufs.get_audio(buf_index).data(offset));
1039                         }
1040                 } else if (parameter_is_midi(port_index)) {
1041                         if (parameter_is_input(port_index)) {
1042                                 const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
1043                                 slv2_instance_connect_port(_impl->instance, port_index,
1044                                                            bufs.get_lv2_midi(true, buf_index).data());
1045                         } else if (parameter_is_output(port_index)) {
1046                                 const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
1047                                 slv2_instance_connect_port(_impl->instance, port_index,
1048                                                            bufs.get_lv2_midi(false, buf_index).data());
1049                         }
1050                 } else if (!parameter_is_control(port_index)) {
1051                         // Optional port (it'd better be if we've made it this far...)
1052                         slv2_instance_connect_port(_impl->instance, port_index, NULL);
1053                 }
1054         }
1055
1056         run(nframes);
1057
1058         midi_out_index = 0;
1059         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
1060                 if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
1061                         const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
1062                         bufs.flush_lv2_midi(true, buf_index);
1063                 }
1064         }
1065
1066         cycles_t now = get_cycles();
1067         set_cycles((uint32_t)(now - then));
1068
1069         return 0;
1070 }
1071
1072 bool
1073 LV2Plugin::parameter_is_control(uint32_t param) const
1074 {
1075         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1076         return slv2_port_is_a(_impl->plugin, port, _world.control_class);
1077 }
1078
1079 bool
1080 LV2Plugin::parameter_is_audio(uint32_t param) const
1081 {
1082         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1083         return slv2_port_is_a(_impl->plugin, port, _world.audio_class);
1084 }
1085
1086 bool
1087 LV2Plugin::parameter_is_midi(uint32_t param) const
1088 {
1089         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1090         return slv2_port_is_a(_impl->plugin, port, _world.event_class);
1091         //      && slv2_port_supports_event(_impl->plugin, port, _world.midi_class);
1092 }
1093
1094 bool
1095 LV2Plugin::parameter_is_output(uint32_t param) const
1096 {
1097         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1098         return slv2_port_is_a(_impl->plugin, port, _world.output_class);
1099 }
1100
1101 bool
1102 LV2Plugin::parameter_is_input(uint32_t param) const
1103 {
1104         SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
1105         return slv2_port_is_a(_impl->plugin, port, _world.input_class);
1106 }
1107
1108 void
1109 LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
1110 {
1111         if (buf && len) {
1112                 if (param < parameter_count()) {
1113                         snprintf(buf, len, "%.3f", get_parameter(param));
1114                 } else {
1115                         strcat(buf, "0");
1116                 }
1117         }
1118 }
1119
1120 boost::shared_ptr<Plugin::ScalePoints>
1121 LV2Plugin::get_scale_points(uint32_t port_index) const
1122 {
1123         SLV2Port        port   = slv2_plugin_get_port_by_index(_impl->plugin, port_index);
1124         SLV2ScalePoints points = slv2_port_get_scale_points(_impl->plugin, port);
1125
1126         boost::shared_ptr<Plugin::ScalePoints> ret;
1127         if (!points) {
1128                 return ret;
1129         }
1130
1131         ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
1132
1133         for (unsigned i = 0; i < slv2_scale_points_size(points); ++i) {
1134                 SLV2ScalePoint p     = slv2_scale_points_get_at(points, i);
1135                 SLV2Value      label = slv2_scale_point_get_label(p);
1136                 SLV2Value      value = slv2_scale_point_get_value(p);
1137                 if (label && (slv2_value_is_float(value) || slv2_value_is_int(value))) {
1138                         ret->insert(make_pair(slv2_value_as_string(label),
1139                                               slv2_value_as_float(value)));
1140                 }
1141         }
1142
1143         slv2_scale_points_free(points);
1144         return ret;
1145 }
1146
1147 void
1148 LV2Plugin::run(pframes_t nframes)
1149 {
1150         for (uint32_t i = 0; i < parameter_count(); ++i) {
1151                 if (parameter_is_control(i) && parameter_is_input(i)) {
1152                         _control_data[i] = _shadow_data[i];
1153                 }
1154         }
1155
1156         slv2_instance_run(_impl->instance, nframes);
1157 }
1158
1159 void
1160 LV2Plugin::latency_compute_run()
1161 {
1162         if (!_latency_control_port) {
1163                 return;
1164         }
1165
1166         // Run the plugin so that it can set its latency parameter
1167
1168         activate();
1169
1170         uint32_t port_index = 0;
1171         uint32_t in_index   = 0;
1172         uint32_t out_index  = 0;
1173
1174         const framecnt_t bufsize = 1024;
1175         float            buffer[bufsize];
1176
1177         memset(buffer, 0, sizeof(float) * bufsize);
1178
1179         // FIXME: Ensure plugins can handle in-place processing
1180
1181         port_index = 0;
1182
1183         while (port_index < parameter_count()) {
1184                 if (parameter_is_audio(port_index)) {
1185                         if (parameter_is_input(port_index)) {
1186                                 slv2_instance_connect_port(_impl->instance, port_index, buffer);
1187                                 in_index++;
1188                         } else if (parameter_is_output(port_index)) {
1189                                 slv2_instance_connect_port(_impl->instance, port_index, buffer);
1190                                 out_index++;
1191                         }
1192                 }
1193                 port_index++;
1194         }
1195
1196         run(bufsize);
1197         deactivate();
1198 }
1199
1200 LV2World::LV2World()
1201         : world(slv2_world_new())
1202 {
1203         slv2_world_load_all(world);
1204         input_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
1205         output_class    = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
1206         control_class   = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
1207         audio_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
1208         event_class     = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
1209         midi_class      = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
1210         in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
1211         integer         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
1212         toggled         = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
1213         srate           = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
1214         gtk_gui         = slv2_value_new_uri(world, NS_UI "GtkUI");
1215         external_gui    = slv2_value_new_uri(world, NS_UI "external");
1216         logarithmic     = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
1217 }
1218
1219 LV2World::~LV2World()
1220 {
1221         slv2_value_free(input_class);
1222         slv2_value_free(output_class);
1223         slv2_value_free(control_class);
1224         slv2_value_free(audio_class);
1225         slv2_value_free(event_class);
1226         slv2_value_free(midi_class);
1227         slv2_value_free(in_place_broken);
1228 }
1229
1230 LV2PluginInfo::LV2PluginInfo (void* c_plugin)
1231         : _c_plugin(c_plugin)
1232 {
1233         type = ARDOUR::LV2;
1234 }
1235
1236 LV2PluginInfo::~LV2PluginInfo()
1237 {}
1238
1239 PluginPtr
1240 LV2PluginInfo::load(Session& session)
1241 {
1242         try {
1243                 PluginPtr plugin;
1244
1245                 plugin.reset(new LV2Plugin(session.engine(), session,
1246                                            (SLV2Plugin)_c_plugin,
1247                                            session.frame_rate()));
1248
1249                 plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
1250                 return plugin;
1251         } catch (failed_constructor& err) {
1252                 return PluginPtr((Plugin*)0);
1253         }
1254
1255         return PluginPtr();
1256 }
1257
1258 PluginInfoList*
1259 LV2PluginInfo::discover()
1260 {
1261         PluginInfoList* plugs   = new PluginInfoList;
1262         SLV2Plugins     plugins = slv2_world_get_all_plugins(_world.world);
1263
1264         cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
1265
1266         for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
1267                 SLV2Plugin       p = slv2_plugins_get_at(plugins, i);
1268                 LV2PluginInfoPtr info(new LV2PluginInfo(p));
1269
1270                 SLV2Value name = slv2_plugin_get_name(p);
1271
1272                 if (!name) {
1273                         cerr << "LV2: invalid plugin\n";
1274                         continue;
1275                 }
1276
1277                 info->type = LV2;
1278
1279                 info->name = string(slv2_value_as_string(name));
1280                 slv2_value_free(name);
1281
1282                 SLV2PluginClass pclass = slv2_plugin_get_class(p);
1283                 SLV2Value       label  = slv2_plugin_class_get_label(pclass);
1284                 info->category = slv2_value_as_string(label);
1285
1286                 SLV2Value author_name = slv2_plugin_get_author_name(p);
1287                 info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
1288                 slv2_value_free(author_name);
1289
1290                 info->path = "/NOPATH"; // Meaningless for LV2
1291
1292                 info->n_inputs.set_audio(
1293                         slv2_plugin_get_num_ports_of_class(
1294                                 p, _world.input_class, _world.audio_class, NULL));
1295                 info->n_inputs.set_midi(
1296                         slv2_plugin_get_num_ports_of_class(
1297                                 p, _world.input_class, _world.event_class, NULL));
1298
1299                 info->n_outputs.set_audio(
1300                         slv2_plugin_get_num_ports_of_class(
1301                                 p, _world.output_class, _world.audio_class, NULL));
1302                 info->n_outputs.set_midi(
1303                         slv2_plugin_get_num_ports_of_class(
1304                                 p, _world.output_class, _world.event_class, NULL));
1305
1306                 info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
1307                 info->index     = 0; // Meaningless for LV2
1308
1309                 plugs->push_back(info);
1310         }
1311
1312         cerr << "Done LV2 discovery" << endl;
1313
1314         return plugs;
1315 }