Collect plugin runtime profile statistics.
[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_sample (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_sample (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->ptr1 == this); // should have been set by {mac_vst|fst|lxvst}_instantiate
83         _plugin->ptr1 = 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.sample_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 #ifndef NO_PLUGIN_STATE
286         XMLNode* child;
287
288         if ((child = find_named_node (node, X_("chunk"))) != 0) {
289
290                 XMLPropertyList::const_iterator i;
291                 XMLNodeList::const_iterator n;
292
293                 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
294                         if ((*n)->is_content ()) {
295                                 /* XXX: this may be dubious for the same reasons that we delay
296                                          execution of load_preset.
297                                          */
298                                 ret = set_chunk ((*n)->content().c_str(), false);
299                         }
300                 }
301
302         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
303
304                 XMLPropertyList::const_iterator i;
305
306                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
307                         int32_t param;
308
309                         sscanf ((*i)->name().c_str(), "param-%d", &param);
310                         float value = string_to<float>((*i)->value());
311
312                         _plugin->setParameter (_plugin, param, value);
313                 }
314
315                 ret = 0;
316
317         }
318 #endif
319
320         Plugin::set_state (node, version);
321         return ret;
322 }
323
324 int
325 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
326 {
327         VstParameterProperties prop;
328
329         memset (&prop, 0, sizeof (VstParameterProperties));
330         prop.flags = 0;
331
332         if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
333
334                 /* i have yet to find or hear of a VST plugin that uses this */
335                 /* RG: faust2vsti does use this :) */
336
337                 if (prop.flags & kVstParameterUsesIntegerMinMax) {
338                         desc.lower = prop.minInteger;
339                         desc.upper = prop.maxInteger;
340                 } else {
341                         desc.lower = 0;
342                         desc.upper = 1.0;
343                 }
344
345                 const float range = desc.upper - desc.lower;
346
347                 if (prop.flags & kVstParameterUsesIntStep && prop.stepInteger < range) {
348                         desc.step = prop.stepInteger;
349                         desc.smallstep = prop.stepInteger;
350                         desc.largestep = prop.stepInteger;
351                         desc.integer_step = true;
352                         desc.rangesteps = 1 + ceilf (range / desc.step);
353                 } else if (prop.flags & kVstParameterUsesFloatStep && prop.stepFloat < range) {
354                         desc.step = prop.stepFloat;
355                         desc.smallstep = prop.smallStepFloat;
356                         desc.largestep = prop.largeStepFloat;
357                         desc.rangesteps = 1 + ceilf (range / desc.step);
358                 } else {
359                         desc.smallstep = desc.step = range / 300.0f;
360                         desc.largestep =  range / 30.0f;
361                 }
362
363                 if (strlen(prop.label) == 0) {
364                         _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
365                 }
366
367                 desc.toggled = prop.flags & kVstParameterIsSwitch;
368                 desc.label = Glib::locale_to_utf8 (prop.label);
369
370         } else {
371
372                 /* old style */
373
374                 char label[VestigeMaxLabelLen];
375                 /* some VST plugins expect this buffer to be zero-filled */
376                 memset (label, 0, sizeof (label));
377
378                 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
379
380                 desc.label = Glib::locale_to_utf8 (label);
381                 desc.lower = 0.0f;
382                 desc.upper = 1.0f;
383                 desc.smallstep = desc.step = 1.f / 300.f;
384                 desc.largestep = 1.f / 30.f;
385         }
386
387         /* TODO we should really call
388          *   desc.update_steps ()
389          * instead of manually assigning steps. Yet, VST prop is (again)
390          * the odd one out compared to other plugin formats.
391          */
392
393         if (_parameter_defaults.find (which) == _parameter_defaults.end ()) {
394                 _parameter_defaults[which] = get_parameter (which);
395         } else {
396                 desc.normal = _parameter_defaults[which];
397         }
398
399         return 0;
400 }
401
402 bool
403 VSTPlugin::load_preset (PresetRecord r)
404 {
405         bool s;
406
407         if (r.user) {
408                 s = load_user_preset (r);
409         } else {
410                 s = load_plugin_preset (r);
411         }
412
413         if (s) {
414                 Plugin::load_preset (r);
415         }
416
417         return s;
418 }
419
420 bool
421 VSTPlugin::load_plugin_preset (PresetRecord r)
422 {
423         /* This is a plugin-provided preset.
424            We can't dispatch directly here; too many plugins expects only one GUI thread.
425         */
426
427         /* Extract the index of this preset from the URI */
428         int id;
429         int index;
430 #ifndef NDEBUG
431         int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
432         assert (p == 2);
433 #else
434         sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
435 #endif
436         _state->want_program = index;
437         LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
438         return true;
439 }
440
441 bool
442 VSTPlugin::load_user_preset (PresetRecord r)
443 {
444         /* This is a user preset; we load it, and this code also knows about the
445            non-direct-dispatch thing.
446         */
447
448         boost::shared_ptr<XMLTree> t (presets_tree ());
449         if (t == 0) {
450                 return false;
451         }
452
453         XMLNode* root = t->root ();
454
455         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
456                 std::string label;
457                 (*i)->get_property (X_("label"), label);
458
459                 if (label != r.label) {
460                         continue;
461                 }
462
463                 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
464
465                         /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
466
467                         if (_state->wanted_chunk) {
468                                 g_free (_state->wanted_chunk);
469                         }
470
471                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
472                                 if ((*j)->is_content ()) {
473                                         /* we can't dispatch directly here; too many plugins expect only one GUI thread */
474                                         gsize size = 0;
475                                         guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
476                                         _state->wanted_chunk = raw_data;
477                                         _state->wanted_chunk_size = size;
478                                         _state->want_chunk = 1;
479                                         LoadPresetProgram (); /* EMIT SIGNAL */ /* used for macvst */
480                                         return true;
481                                 }
482                         }
483
484                         return false;
485
486                 } else {
487
488                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
489                                 if ((*j)->name() == X_("Parameter")) {
490                                         uint32_t index;
491                                         float value;
492
493                                         if (!(*j)->get_property (X_("index"), index) ||
494                                             !(*j)->get_property (X_("value"), value)) {
495                                           // flag error and continue?
496                                                 assert (false);
497                                         }
498
499                                         set_parameter (index, value);
500                                         PresetPortSetValue (index, value); /* EMIT SIGNAL */
501                                 }
502                         }
503                         return true;
504                 }
505         }
506         return false;
507 }
508
509 #include "sha1.c"
510
511 string
512 VSTPlugin::do_save_preset (string name)
513 {
514         boost::shared_ptr<XMLTree> t (presets_tree ());
515         if (t == 0) {
516                 return "";
517         }
518
519         // prevent dups -- just in case
520         t->root()->remove_nodes_and_delete (X_("label"), name);
521
522         XMLNode* p = 0;
523
524         char tmp[32];
525         snprintf (tmp, 31, "%ld", _presets.size() + 1);
526         tmp[31] = 0;
527
528         char hash[41];
529         Sha1Digest s;
530         sha1_init (&s);
531         sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
532         sha1_write (&s, (const uint8_t *) tmp, strlen(tmp));
533         sha1_result_hash (&s, hash);
534
535         string const uri = string_compose (X_("VST:%1:x%2"), unique_id (), hash);
536
537         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
538
539                 p = new XMLNode (X_("ChunkPreset"));
540                 p->set_property (X_("uri"), uri);
541                 p->set_property (X_("label"), name);
542                 gchar* data = get_chunk (true);
543                 p->add_content (string (data));
544                 g_free (data);
545
546         } else {
547
548                 p = new XMLNode (X_("Preset"));
549                 p->set_property (X_("uri"), uri);
550                 p->set_property (X_("label"), name);
551
552                 for (uint32_t i = 0; i < parameter_count(); ++i) {
553                         if (parameter_is_input (i)) {
554                                 XMLNode* c = new XMLNode (X_("Parameter"));
555                                 c->set_property (X_("index"), i);
556                                 c->set_property (X_("value"), get_parameter (i));
557                                 p->add_child_nocopy (*c);
558                         }
559                 }
560         }
561
562         t->root()->add_child_nocopy (*p);
563
564         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
565         f = Glib::build_filename (f, presets_file ());
566
567         t->write (f);
568         return uri;
569 }
570
571 void
572 VSTPlugin::do_remove_preset (string name)
573 {
574         boost::shared_ptr<XMLTree> t (presets_tree ());
575         if (t == 0) {
576                 return;
577         }
578
579         t->root()->remove_nodes_and_delete (X_("label"), name);
580
581         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
582         f = Glib::build_filename (f, presets_file ());
583
584         t->write (f);
585 }
586
587 string
588 VSTPlugin::describe_parameter (Evoral::Parameter param)
589 {
590         char name[VestigeMaxLabelLen];
591         if (param.id() == UINT32_MAX - 1) {
592                 strcpy (name, _("Plugin Enable"));
593                 return name;
594         }
595
596         memset (name, 0, sizeof (name));
597
598         /* some VST plugins expect this buffer to be zero-filled */
599
600         _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
601
602         if (name[0] == '\0') {
603                 strcpy (name, _("Unknown"));
604         }
605
606         return name;
607 }
608
609 samplecnt_t
610 VSTPlugin::signal_latency () const
611 {
612         if (_user_latency) {
613                 return _user_latency;
614         }
615
616 #if ( defined(__x86_64__) || defined(_M_X64) )
617         return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
618 #else
619         return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
620 #endif
621 }
622
623 set<Evoral::Parameter>
624 VSTPlugin::automatable () const
625 {
626         set<Evoral::Parameter> ret;
627
628         for (uint32_t i = 0; i < parameter_count(); ++i) {
629                 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
630         }
631
632         return ret;
633 }
634
635 int
636 VSTPlugin::connect_and_run (BufferSet& bufs,
637                 samplepos_t start, samplepos_t end, double speed,
638                 ChanMapping in_map, ChanMapping out_map,
639                 pframes_t nframes, samplecnt_t offset)
640 {
641         Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
642
643         if (pthread_mutex_trylock (&_state->state_lock)) {
644                 /* by convention 'effSetChunk' should not be called while processing
645                  * http://www.reaper.fm/sdk/vst/vst_ext.php
646                  *
647                  * All VSTs don't use in-place, PluginInsert::connect_and_run()
648                  * does clear output buffers, so we can just return.
649                  */
650                 return 0;
651         }
652
653         _transport_sample = start;
654         _transport_speed = speed;
655
656         ChanCount bufs_count;
657         bufs_count.set(DataType::AUDIO, 1);
658         bufs_count.set(DataType::MIDI, 1);
659         _midi_out_buf = 0;
660
661         BufferSet& silent_bufs  = _session.get_silent_buffers(bufs_count);
662         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
663
664         /* VC++ doesn't support the C99 extension that allows
665
666            typeName foo[variableDefiningSize];
667
668            Use alloca instead of dynamic array (rather than std::vector which
669            allocs on the heap) because this is realtime code.
670         */
671
672         float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
673         float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
674
675         int32_t i;
676
677         uint32_t in_index = 0;
678         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
679                 uint32_t  index;
680                 bool      valid = false;
681                 index = in_map.get(DataType::AUDIO, in_index++, &valid);
682                 ins[i] = (valid)
683                                         ? bufs.get_audio(index).data(offset)
684                                         : silent_bufs.get_audio(0).data(offset);
685         }
686
687         uint32_t out_index = 0;
688         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
689                 uint32_t  index;
690                 bool      valid = false;
691                 index = out_map.get(DataType::AUDIO, out_index++, &valid);
692                 outs[i] = (valid)
693                         ? bufs.get_audio(index).data(offset)
694                         : scratch_bufs.get_audio(0).data(offset);
695         }
696
697         if (bufs.count().n_midi() > 0) {
698                 VstEvents* v = 0;
699                 bool valid = false;
700                 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
701                 if (valid) {
702                         v = bufs.get_vst_midi (buf_index_in);
703                 }
704                 valid = false;
705                 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
706                 if (valid) {
707                         _midi_out_buf = &bufs.get_midi(buf_index_out);
708                         _midi_out_buf->silence(0, 0);
709                 } else {
710                         _midi_out_buf = 0;
711                 }
712                 if (v) {
713                         _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
714                 }
715         }
716
717         /* we already know it can support processReplacing */
718         _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
719         _midi_out_buf = 0;
720
721         pthread_mutex_unlock (&_state->state_lock);
722         return 0;
723 }
724
725 string
726 VSTPlugin::unique_id () const
727 {
728         char buf[32];
729
730         snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
731
732         return string (buf);
733 }
734
735
736 const char *
737 VSTPlugin::name () const
738 {
739         if (!_info->name.empty ()) {
740                 return _info->name.c_str();
741         }
742         return _handle->name;
743 }
744
745 const char *
746 VSTPlugin::maker () const
747 {
748         return _info->creator.c_str();
749 }
750
751 const char *
752 VSTPlugin::label () const
753 {
754         return _handle->name;
755 }
756
757 uint32_t
758 VSTPlugin::parameter_count () const
759 {
760         return _plugin->numParams;
761 }
762
763 bool
764 VSTPlugin::has_editor () const
765 {
766         return _plugin->flags & effFlagsHasEditor;
767 }
768
769 void
770 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
771 {
772         char *first_nonws;
773
774         _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
775
776         if (buf[0] == '\0') {
777                 return;
778         }
779
780         first_nonws = buf;
781         while (*first_nonws && isspace (*first_nonws)) {
782                 first_nonws++;
783         }
784
785         if (*first_nonws == '\0') {
786                 return;
787         }
788
789         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
790 }
791
792 void
793 VSTPlugin::find_presets ()
794 {
795         /* Built-in presets */
796
797         int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
798         for (int i = 0; i < _plugin->numPrograms; ++i) {
799                 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
800
801                 if (vst_version >= 2) {
802                         char buf[256];
803                         if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
804                                 r.label = buf;
805                         } else {
806                                 r.label = string_compose (_("Preset %1"), i);
807                         }
808                 } else {
809                         r.label = string_compose (_("Preset %1"), i);
810                 }
811
812                 _presets.insert (make_pair (r.uri, r));
813         }
814
815         /* User presets from our XML file */
816
817         boost::shared_ptr<XMLTree> t (presets_tree ());
818
819         if (t) {
820                 XMLNode* root = t->root ();
821                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
822                         std::string uri;
823                         std::string label;
824
825                         if (!(*i)->get_property (X_("uri"), uri) || !(*i)->get_property (X_("label"), label)) {
826                                 assert(false);
827                         }
828
829                         PresetRecord r (uri, label, true);
830                         _presets.insert (make_pair (r.uri, r));
831                 }
832         }
833
834 }
835
836 /** @return XMLTree with our user presets; could be a new one if no existing
837  *  one was found, or 0 if one was present but badly-formatted.
838  */
839 XMLTree *
840 VSTPlugin::presets_tree () const
841 {
842         XMLTree* t = new XMLTree;
843
844         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
845
846         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
847                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
848                         error << _("Unable to make VST presets directory") << endmsg;
849                 };
850         }
851
852         p = Glib::build_filename (p, presets_file ());
853
854         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
855                 t->set_root (new XMLNode (X_("VSTPresets")));
856                 return t;
857         }
858
859         t->set_filename (p);
860         if (!t->read ()) {
861                 delete t;
862                 return 0;
863         }
864
865         return t;
866 }
867
868 /** @return Index of the first user preset in our lists */
869 int
870 VSTPlugin::first_user_preset_index () const
871 {
872         return _plugin->numPrograms;
873 }
874
875 string
876 VSTPlugin::presets_file () const
877 {
878         return string("vst-") + unique_id ();
879 }
880