Use XMLNode::get/set_property API in ARDOUR::RouteGroup
[ardour.git] / libs / ardour / vst_plugin.cc
1 /*
2     Copyright (C) 2010 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <glib.h>
21 #include "pbd/gstdio_compat.h"
22
23 #include <glibmm/fileutils.h>
24 #include <glibmm/miscutils.h>
25 #include <glibmm/convert.h>
26
27 #include "pbd/floating.h"
28 #include "pbd/locale_guard.h"
29
30 #include "ardour/vst_plugin.h"
31 #include "ardour/vestige/aeffectx.h"
32 #include "ardour/session.h"
33 #include "ardour/vst_types.h"
34 #include "ardour/filesystem_paths.h"
35 #include "ardour/audio_buffer.h"
36
37 #include "pbd/i18n.h"
38
39 using namespace std;
40 using namespace PBD;
41 using namespace ARDOUR;
42
43 VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
44         : Plugin (engine, session)
45         , _handle (handle)
46         , _state (0)
47         , _plugin (0)
48         , _pi (0)
49         , _num (0)
50         , _transport_frame (0)
51         , _transport_speed (0.f)
52         , _eff_bypassed (false)
53 {
54         memset (&_timeInfo, 0, sizeof(_timeInfo));
55 }
56
57 VSTPlugin::VSTPlugin (const VSTPlugin& other)
58         : Plugin (other)
59         , _handle (other._handle)
60         , _state (other._state)
61         , _plugin (other._plugin)
62         , _pi (other._pi)
63         , _num (other._num)
64         , _midi_out_buf (other._midi_out_buf)
65         , _transport_frame (0)
66         , _transport_speed (0.f)
67         , _parameter_defaults (other._parameter_defaults)
68         , _eff_bypassed (other._eff_bypassed)
69 {
70         memset (&_timeInfo, 0, sizeof(_timeInfo));
71 }
72
73 VSTPlugin::~VSTPlugin ()
74 {
75
76 }
77
78 void
79 VSTPlugin::open_plugin ()
80 {
81         _plugin = _state->plugin;
82         assert (_plugin->user == this); // should have been set by {mac_vst|fst|lxvst}_instantiate
83         _plugin->user = this;
84         _state->plugin->dispatcher (_plugin, effOpen, 0, 0, 0, 0);
85         _state->vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, 0, 0);
86 }
87
88 void
89 VSTPlugin::init_plugin ()
90 {
91         /* set rate and blocksize */
92         _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
93         _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
94 }
95
96
97 uint32_t
98 VSTPlugin::designated_bypass_port ()
99 {
100         if (_plugin->dispatcher (_plugin, effCanDo, 0, 0, const_cast<char*> ("bypass"), 0.0f) != 0) {
101 #ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also plugin_insert.cc
102                 return UINT32_MAX - 1; // emulate a port
103 #else
104                 /* check if plugin actually supports it,
105                  * e.g. u-he Presswerk  CanDo "bypass"  but calling effSetBypass is a NO-OP.
106                  * (presumably the plugin-author thinks hard-bypassing is a bad idea,
107                  * particularly since the plugin itself provides a bypass-port)
108                  */
109                 intptr_t value = 0; // not bypassed
110                 if (0 != _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0)) {
111                         cerr << "Emulate VST Bypass Port for " << name() << endl; // XXX DEBUG
112                         return UINT32_MAX - 1; // emulate a port
113                 } else {
114                         cerr << "Do *not* Emulate VST Bypass Port for " << name() << endl; // XXX DEBUG
115                 }
116 #endif
117         }
118         return UINT32_MAX;
119 }
120
121 void
122 VSTPlugin::deactivate ()
123 {
124         _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
125 }
126
127 void
128 VSTPlugin::activate ()
129 {
130         _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
131 }
132
133 int
134 VSTPlugin::set_block_size (pframes_t nframes)
135 {
136         deactivate ();
137         _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
138         activate ();
139         return 0;
140 }
141
142 float
143 VSTPlugin::default_value (uint32_t which)
144 {
145         return _parameter_defaults[which];
146 }
147
148 float
149 VSTPlugin::get_parameter (uint32_t which) const
150 {
151         if (which == UINT32_MAX - 1) {
152                 // ardour uses enable-semantics: 1: enabled, 0: bypassed
153                 return _eff_bypassed ? 0.f : 1.f;
154         }
155         return _plugin->getParameter (_plugin, which);
156 }
157
158 void
159 VSTPlugin::set_parameter (uint32_t which, float newval)
160 {
161         if (which == UINT32_MAX - 1) {
162                 // ardour uses enable-semantics: 1: enabled, 0: bypassed
163                 intptr_t value = (newval <= 0.f) ? 1 : 0;
164                 cerr << "effSetBypass " << value << endl; // XXX DEBUG
165                 int rv = _plugin->dispatcher (_plugin, 44 /*effSetBypass*/, 0, value, NULL, 0);
166                 if (0 != rv) {
167                         _eff_bypassed = (value == 1);
168                 } else {
169                         cerr << "effSetBypass failed rv=" << rv << endl; // XXX DEBUG
170 #ifdef ALLOW_VST_BYPASS_TO_FAIL // yet unused, see also vst_plugin.cc
171                         // emit signal.. hard un/bypass from here?!
172 #endif
173                 }
174                 return;
175         }
176
177         float oldval = get_parameter (which);
178
179         if (PBD::floateq (oldval, newval, 1)) {
180                 return;
181         }
182
183         _plugin->setParameter (_plugin, which, newval);
184
185         float curval = get_parameter (which);
186
187         if (!PBD::floateq (curval, oldval, 1)) {
188                 /* value has changed, follow rest of the notification path */
189                 Plugin::set_parameter (which, newval);
190         }
191 }
192
193 void
194 VSTPlugin::parameter_changed_externally (uint32_t which, float value )
195 {
196         ParameterChangedExternally (which, value); /* EMIT SIGNAL */
197         Plugin::set_parameter (which, value);
198 }
199
200
201 uint32_t
202 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
203 {
204         ok = true;
205         return n;
206 }
207
208 /** Get VST chunk as base64-encoded data.
209  *  @param single true for single program, false for all programs.
210  *  @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
211  */
212 gchar *
213 VSTPlugin::get_chunk (bool single) const
214 {
215         guchar* data;
216         int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
217         if (data_size == 0) {
218                 return 0;
219         }
220
221         return g_base64_encode (data, data_size);
222 }
223
224 /** Set VST chunk from base64-encoded data.
225  *  @param 0-terminated base64-encoded data.
226  *  @param single true for single program, false for all programs.
227  *  @return 0 on success, non-0 on failure
228  */
229 int
230 VSTPlugin::set_chunk (gchar const * data, bool single)
231 {
232         gsize size = 0;
233         int r = 0;
234         guchar* raw_data = g_base64_decode (data, &size);
235         {
236                 pthread_mutex_lock (&_state->state_lock);
237                 r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
238                 pthread_mutex_unlock (&_state->state_lock);
239         }
240         g_free (raw_data);
241         return r;
242 }
243
244 void
245 VSTPlugin::add_state (XMLNode* root) const
246 {
247         LocaleGuard lg;
248
249         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
250
251                 gchar* data = get_chunk (false);
252                 if (data == 0) {
253                         return;
254                 }
255
256                 /* store information */
257
258                 XMLNode* chunk_node = new XMLNode (X_("chunk"));
259
260                 chunk_node->add_content (data);
261                 g_free (data);
262
263                 root->add_child_nocopy (*chunk_node);
264
265         } else {
266
267                 XMLNode* parameters = new XMLNode ("parameters");
268
269                 for (int32_t n = 0; n < _plugin->numParams; ++n) {
270                         char index[64];
271                         snprintf (index, sizeof (index), "param-%d", n);
272                         parameters->set_property (index, _plugin->getParameter (_plugin, n));
273                 }
274
275                 root->add_child_nocopy (*parameters);
276         }
277 }
278
279 int
280 VSTPlugin::set_state (const XMLNode& node, int version)
281 {
282         LocaleGuard lg;
283         int ret = -1;
284
285         if (node.name() != state_node_name()) {
286                 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
287                 return 0;
288         }
289
290 #ifndef NO_PLUGIN_STATE
291         XMLNode* child;
292
293         if ((child = find_named_node (node, X_("chunk"))) != 0) {
294
295                 XMLPropertyList::const_iterator i;
296                 XMLNodeList::const_iterator n;
297
298                 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
299                         if ((*n)->is_content ()) {
300                                 /* XXX: this may be dubious for the same reasons that we delay
301                                          execution of load_preset.
302                                          */
303                                 ret = set_chunk ((*n)->content().c_str(), false);
304                         }
305                 }
306
307         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
308
309                 XMLPropertyList::const_iterator i;
310
311                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
312                         int32_t param;
313
314                         sscanf ((*i)->name().c_str(), "param-%d", &param);
315                         float value = string_to<float>((*i)->value());
316
317                         _plugin->setParameter (_plugin, param, value);
318                 }
319
320                 ret = 0;
321
322         }
323 #endif
324
325         Plugin::set_state (node, version);
326         return ret;
327 }
328
329
330 int
331 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
332 {
333         VstParameterProperties prop;
334
335         memset (&prop, 0, sizeof (VstParameterProperties));
336         desc.min_unbound = false;
337         desc.max_unbound = false;
338         prop.flags = 0;
339
340         if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
341
342                 /* i have yet to find or hear of a VST plugin that uses this */
343                 /* RG: faust2vsti does use this :) */
344
345                 if (prop.flags & kVstParameterUsesIntegerMinMax) {
346                         desc.lower = prop.minInteger;
347                         desc.upper = prop.maxInteger;
348                 } else {
349                         desc.lower = 0;
350                         desc.upper = 1.0;
351                 }
352
353                 if (prop.flags & kVstParameterUsesIntStep) {
354
355                         desc.step = prop.stepInteger;
356                         desc.smallstep = prop.stepInteger;
357                         desc.largestep = prop.stepInteger;
358
359                 } else if (prop.flags & kVstParameterUsesFloatStep) {
360
361                         desc.step = prop.stepFloat;
362                         desc.smallstep = prop.smallStepFloat;
363                         desc.largestep = prop.largeStepFloat;
364
365                 } else {
366
367                         float range = desc.upper - desc.lower;
368
369                         desc.step = range / 100.0f;
370                         desc.smallstep = desc.step / 2.0f;
371                         desc.largestep = desc.step * 10.0f;
372                 }
373
374                 if (strlen(prop.label) == 0) {
375                         _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
376                 }
377
378                 desc.toggled = prop.flags & kVstParameterIsSwitch;
379                 desc.logarithmic = false;
380                 desc.sr_dependent = false;
381                 desc.label = Glib::locale_to_utf8 (prop.label);
382
383         } else {
384
385                 /* old style */
386
387                 char label[64];
388                 /* some VST plugins expect this buffer to be zero-filled */
389                 memset (label, 0, sizeof (label));
390
391                 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
392
393                 desc.label = Glib::locale_to_utf8 (label);
394                 desc.integer_step = false;
395                 desc.lower = 0.0f;
396                 desc.upper = 1.0f;
397                 desc.step = 0.01f;
398                 desc.smallstep = 0.005f;
399                 desc.largestep = 0.1f;
400                 desc.toggled = false;
401                 desc.logarithmic = false;
402                 desc.sr_dependent = false;
403         }
404
405         desc.normal = get_parameter (which);
406         if (_parameter_defaults.find (which) == _parameter_defaults.end ()) {
407                 _parameter_defaults[which] = desc.normal;
408         }
409
410         return 0;
411 }
412
413 bool
414 VSTPlugin::load_preset (PresetRecord r)
415 {
416         bool s;
417
418         if (r.user) {
419                 s = load_user_preset (r);
420         } else {
421                 s = load_plugin_preset (r);
422         }
423
424         if (s) {
425                 Plugin::load_preset (r);
426         }
427
428         return s;
429 }
430
431 bool
432 VSTPlugin::load_plugin_preset (PresetRecord r)
433 {
434         /* This is a plugin-provided preset.
435            We can't dispatch directly here; too many plugins expects only one GUI thread.
436         */
437
438         /* Extract the index of this preset from the URI */
439         int id;
440         int index;
441 #ifndef NDEBUG
442         int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
443         assert (p == 2);
444 #else
445         sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
446 #endif
447         _state->want_program = index;
448         LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
449         return true;
450 }
451
452 bool
453 VSTPlugin::load_user_preset (PresetRecord r)
454 {
455         /* This is a user preset; we load it, and this code also knows about the
456            non-direct-dispatch thing.
457         */
458
459         boost::shared_ptr<XMLTree> t (presets_tree ());
460         if (t == 0) {
461                 return false;
462         }
463
464         XMLNode* root = t->root ();
465
466         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
467                 std::string label;
468                 (*i)->get_property (X_("label"), label);
469
470                 if (label != r.label) {
471                         continue;
472                 }
473
474                 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
475
476                         /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
477
478                         if (_state->wanted_chunk) {
479                                 g_free (_state->wanted_chunk);
480                         }
481
482                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
483                                 if ((*j)->is_content ()) {
484                                         /* we can't dispatch directly here; too many plugins expect only one GUI thread */
485                                         gsize size = 0;
486                                         guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
487                                         _state->wanted_chunk = raw_data;
488                                         _state->wanted_chunk_size = size;
489                                         _state->want_chunk = 1;
490                                         LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
491                                         return true;
492                                 }
493                         }
494
495                         return false;
496
497                 } else {
498
499                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
500                                 if ((*j)->name() == X_("Parameter")) {
501                                         uint32_t index;
502                                         float value;
503
504                                         if (!(*j)->get_property (X_("index"), index) ||
505                                             !(*j)->get_property (X_("value"), value)) {
506                                           // flag error and continue?
507                                                 assert (false);
508                                         }
509
510                                         set_parameter (index, value);
511                                         PresetPortSetValue (index, value); /* EMIT SIGNAL */
512                                 }
513                         }
514                         return true;
515                 }
516         }
517         return false;
518 }
519
520 #include "sha1.c"
521
522 string
523 VSTPlugin::do_save_preset (string name)
524 {
525         boost::shared_ptr<XMLTree> t (presets_tree ());
526         if (t == 0) {
527                 return "";
528         }
529
530         // prevent dups -- just in case
531         t->root()->remove_nodes_and_delete (X_("label"), name);
532
533         XMLNode* p = 0;
534
535         char tmp[32];
536         snprintf (tmp, 31, "%ld", _presets.size() + 1);
537         tmp[31] = 0;
538
539         char hash[41];
540         Sha1Digest s;
541         sha1_init (&s);
542         sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
543         sha1_write (&s, (const uint8_t *) tmp, strlen(tmp));
544         sha1_result_hash (&s, hash);
545
546         string const uri = string_compose (X_("VST:%1:x%2"), unique_id (), hash);
547
548         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
549
550                 p = new XMLNode (X_("ChunkPreset"));
551                 p->set_property (X_("uri"), uri);
552                 p->set_property (X_("label"), name);
553                 gchar* data = get_chunk (true);
554                 p->add_content (string (data));
555                 g_free (data);
556
557         } else {
558
559                 p = new XMLNode (X_("Preset"));
560                 p->set_property (X_("uri"), uri);
561                 p->set_property (X_("label"), name);
562
563                 for (uint32_t i = 0; i < parameter_count(); ++i) {
564                         if (parameter_is_input (i)) {
565                                 XMLNode* c = new XMLNode (X_("Parameter"));
566                                 c->set_property (X_("index"), i);
567                                 c->set_property (X_("value"), get_parameter (i));
568                                 p->add_child_nocopy (*c);
569                         }
570                 }
571         }
572
573         t->root()->add_child_nocopy (*p);
574
575         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
576         f = Glib::build_filename (f, presets_file ());
577
578         t->write (f);
579         return uri;
580 }
581
582 void
583 VSTPlugin::do_remove_preset (string name)
584 {
585         boost::shared_ptr<XMLTree> t (presets_tree ());
586         if (t == 0) {
587                 return;
588         }
589
590         t->root()->remove_nodes_and_delete (X_("label"), name);
591
592         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
593         f = Glib::build_filename (f, presets_file ());
594
595         t->write (f);
596 }
597
598 string
599 VSTPlugin::describe_parameter (Evoral::Parameter param)
600 {
601         char name[64];
602         if (param.id() == UINT32_MAX - 1) {
603                 strcpy (name, _("Plugin Enable"));
604                 return name;
605         }
606
607         memset (name, 0, sizeof (name));
608
609         /* some VST plugins expect this buffer to be zero-filled */
610
611         _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
612
613         if (name[0] == '\0') {
614                 strcpy (name, _("Unknown"));
615         }
616
617         return name;
618 }
619
620 framecnt_t
621 VSTPlugin::signal_latency () const
622 {
623         if (_user_latency) {
624                 return _user_latency;
625         }
626
627 #if ( defined(__x86_64__) || defined(_M_X64) )
628         return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
629 #else
630         return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
631 #endif
632 }
633
634 set<Evoral::Parameter>
635 VSTPlugin::automatable () const
636 {
637         set<Evoral::Parameter> ret;
638
639         for (uint32_t i = 0; i < parameter_count(); ++i) {
640                 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
641         }
642
643         return ret;
644 }
645
646 int
647 VSTPlugin::connect_and_run (BufferSet& bufs,
648                 framepos_t start, framepos_t end, double speed,
649                 ChanMapping in_map, ChanMapping out_map,
650                 pframes_t nframes, framecnt_t offset)
651 {
652         Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
653
654         if (pthread_mutex_trylock (&_state->state_lock)) {
655                 /* by convention 'effSetChunk' should not be called while processing
656                  * http://www.reaper.fm/sdk/vst/vst_ext.php
657                  *
658                  * All VSTs don't use in-place, PluginInsert::connect_and_run()
659                  * does clear output buffers, so we can just return.
660                  */
661                 return 0;
662         }
663
664         _transport_frame = start;
665         _transport_speed = speed;
666
667         ChanCount bufs_count;
668         bufs_count.set(DataType::AUDIO, 1);
669         bufs_count.set(DataType::MIDI, 1);
670         _midi_out_buf = 0;
671
672         BufferSet& silent_bufs  = _session.get_silent_buffers(bufs_count);
673         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
674
675         /* VC++ doesn't support the C99 extension that allows
676
677            typeName foo[variableDefiningSize];
678
679            Use alloca instead of dynamic array (rather than std::vector which
680            allocs on the heap) because this is realtime code.
681         */
682
683         float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
684         float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
685
686         int32_t i;
687
688         uint32_t in_index = 0;
689         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
690                 uint32_t  index;
691                 bool      valid = false;
692                 index = in_map.get(DataType::AUDIO, in_index++, &valid);
693                 ins[i] = (valid)
694                                         ? bufs.get_audio(index).data(offset)
695                                         : silent_bufs.get_audio(0).data(offset);
696         }
697
698         uint32_t out_index = 0;
699         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
700                 uint32_t  index;
701                 bool      valid = false;
702                 index = out_map.get(DataType::AUDIO, out_index++, &valid);
703                 outs[i] = (valid)
704                         ? bufs.get_audio(index).data(offset)
705                         : scratch_bufs.get_audio(0).data(offset);
706         }
707
708         if (bufs.count().n_midi() > 0) {
709                 VstEvents* v = 0;
710                 bool valid = false;
711                 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
712                 if (valid) {
713                         v = bufs.get_vst_midi (buf_index_in);
714                 }
715                 valid = false;
716                 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
717                 if (valid) {
718                         _midi_out_buf = &bufs.get_midi(buf_index_out);
719                         _midi_out_buf->silence(0, 0);
720                 } else {
721                         _midi_out_buf = 0;
722                 }
723                 if (v) {
724                         _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
725                 }
726         }
727
728         /* we already know it can support processReplacing */
729         _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
730         _midi_out_buf = 0;
731
732         pthread_mutex_unlock (&_state->state_lock);
733         return 0;
734 }
735
736 string
737 VSTPlugin::unique_id () const
738 {
739         char buf[32];
740
741         snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
742
743         return string (buf);
744 }
745
746
747 const char *
748 VSTPlugin::name () const
749 {
750         if (!_info->name.empty ()) {
751                 return _info->name.c_str();
752         }
753         return _handle->name;
754 }
755
756 const char *
757 VSTPlugin::maker () const
758 {
759         return _info->creator.c_str();
760 }
761
762 const char *
763 VSTPlugin::label () const
764 {
765         return _handle->name;
766 }
767
768 uint32_t
769 VSTPlugin::parameter_count () const
770 {
771         return _plugin->numParams;
772 }
773
774 bool
775 VSTPlugin::has_editor () const
776 {
777         return _plugin->flags & effFlagsHasEditor;
778 }
779
780 void
781 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
782 {
783         char *first_nonws;
784
785         _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
786
787         if (buf[0] == '\0') {
788                 return;
789         }
790
791         first_nonws = buf;
792         while (*first_nonws && isspace (*first_nonws)) {
793                 first_nonws++;
794         }
795
796         if (*first_nonws == '\0') {
797                 return;
798         }
799
800         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
801 }
802
803 void
804 VSTPlugin::find_presets ()
805 {
806         /* Built-in presets */
807
808         int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
809         for (int i = 0; i < _plugin->numPrograms; ++i) {
810                 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
811
812                 if (vst_version >= 2) {
813                         char buf[256];
814                         if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
815                                 r.label = buf;
816                         } else {
817                                 r.label = string_compose (_("Preset %1"), i);
818                         }
819                 } else {
820                         r.label = string_compose (_("Preset %1"), i);
821                 }
822
823                 _presets.insert (make_pair (r.uri, r));
824         }
825
826         /* User presets from our XML file */
827
828         boost::shared_ptr<XMLTree> t (presets_tree ());
829
830         if (t) {
831                 XMLNode* root = t->root ();
832                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
833                         std::string uri;
834                         std::string label;
835
836                         if (!(*i)->get_property (X_("uri"), uri) || !(*i)->get_property (X_("label"), label)) {
837                                 assert(false);
838                         }
839
840                         PresetRecord r (uri, label, true);
841                         _presets.insert (make_pair (r.uri, r));
842                 }
843         }
844
845 }
846
847 /** @return XMLTree with our user presets; could be a new one if no existing
848  *  one was found, or 0 if one was present but badly-formatted.
849  */
850 XMLTree *
851 VSTPlugin::presets_tree () const
852 {
853         XMLTree* t = new XMLTree;
854
855         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
856
857         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
858                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
859                         error << _("Unable to make VST presets directory") << endmsg;
860                 };
861         }
862
863         p = Glib::build_filename (p, presets_file ());
864
865         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
866                 t->set_root (new XMLNode (X_("VSTPresets")));
867                 return t;
868         }
869
870         t->set_filename (p);
871         if (!t->read ()) {
872                 delete t;
873                 return 0;
874         }
875
876         return t;
877 }
878
879 /** @return Index of the first user preset in our lists */
880 int
881 VSTPlugin::first_user_preset_index () const
882 {
883         return _plugin->numPrograms;
884 }
885
886 string
887 VSTPlugin::presets_file () const
888 {
889         return string_compose ("vst-%1", unique_id ());
890 }
891