add support for VST default values (instantiation time value)
[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
26 #include "pbd/floating.h"
27 #include "pbd/locale_guard.h"
28
29 #include "ardour/vst_plugin.h"
30 #include "ardour/vestige/aeffectx.h"
31 #include "ardour/session.h"
32 #include "ardour/vst_types.h"
33 #include "ardour/filesystem_paths.h"
34 #include "ardour/audio_buffer.h"
35
36 #include "pbd/i18n.h"
37
38 using namespace std;
39 using namespace PBD;
40 using namespace ARDOUR;
41
42 VSTPlugin::VSTPlugin (AudioEngine& engine, Session& session, VSTHandle* handle)
43         : Plugin (engine, session)
44         , _handle (handle)
45         , _state (0)
46         , _plugin (0)
47         , _pi (0)
48         , _num (0)
49         , _transport_frame (0)
50         , _transport_speed (0.f)
51 {
52         memset (&_timeInfo, 0, sizeof(_timeInfo));
53 }
54
55 VSTPlugin::~VSTPlugin ()
56 {
57
58 }
59
60 void
61 VSTPlugin::set_plugin (AEffect* e)
62 {
63         _plugin = e;
64         _plugin->user = this;
65
66         /* set rate and blocksize */
67
68         _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) _session.frame_rate());
69         _plugin->dispatcher (_plugin, effSetBlockSize, 0, _session.get_block_size(), NULL, 0.0f);
70 }
71
72 void
73 VSTPlugin::deactivate ()
74 {
75         _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
76 }
77
78 void
79 VSTPlugin::activate ()
80 {
81         _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
82 }
83
84 int
85 VSTPlugin::set_block_size (pframes_t nframes)
86 {
87         deactivate ();
88         _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
89         activate ();
90         return 0;
91 }
92
93 float
94 VSTPlugin::default_value (uint32_t which)
95 {
96         return _parameter_defaults[which];
97 }
98
99 float
100 VSTPlugin::get_parameter (uint32_t which) const
101 {
102         return _plugin->getParameter (_plugin, which);
103 }
104
105 void
106 VSTPlugin::set_parameter (uint32_t which, float newval)
107 {
108         float oldval = get_parameter (which);
109
110         if (PBD::floateq (oldval, newval, 1)) {
111                 return;
112         }
113
114         _plugin->setParameter (_plugin, which, newval);
115
116         float curval = get_parameter (which);
117
118         if (!PBD::floateq (curval, oldval, 1)) {
119                 /* value has changed, follow rest of the notification path */
120                 Plugin::set_parameter (which, newval);
121         }
122 }
123
124 uint32_t
125 VSTPlugin::nth_parameter (uint32_t n, bool& ok) const
126 {
127         ok = true;
128         return n;
129 }
130
131 /** Get VST chunk as base64-encoded data.
132  *  @param single true for single program, false for all programs.
133  *  @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
134  */
135 gchar *
136 VSTPlugin::get_chunk (bool single) const
137 {
138         guchar* data;
139         int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
140         if (data_size == 0) {
141                 return 0;
142         }
143
144         return g_base64_encode (data, data_size);
145 }
146
147 /** Set VST chunk from base64-encoded data.
148  *  @param 0-terminated base64-encoded data.
149  *  @param single true for single program, false for all programs.
150  *  @return 0 on success, non-0 on failure
151  */
152 int
153 VSTPlugin::set_chunk (gchar const * data, bool single)
154 {
155         gsize size = 0;
156         guchar* raw_data = g_base64_decode (data, &size);
157         int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
158         g_free (raw_data);
159         return r;
160 }
161
162 void
163 VSTPlugin::add_state (XMLNode* root) const
164 {
165         LocaleGuard lg;
166
167         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
168
169                 gchar* data = get_chunk (false);
170                 if (data == 0) {
171                         return;
172                 }
173
174                 /* store information */
175
176                 XMLNode* chunk_node = new XMLNode (X_("chunk"));
177
178                 chunk_node->add_content (data);
179                 g_free (data);
180
181                 root->add_child_nocopy (*chunk_node);
182
183         } else {
184
185                 XMLNode* parameters = new XMLNode ("parameters");
186
187                 for (int32_t n = 0; n < _plugin->numParams; ++n) {
188                         char index[64];
189                         char val[32];
190                         snprintf (index, sizeof (index), "param-%d", n);
191                         snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
192                         parameters->add_property (index, val);
193                 }
194
195                 root->add_child_nocopy (*parameters);
196         }
197 }
198
199 int
200 VSTPlugin::set_state (const XMLNode& node, int version)
201 {
202         LocaleGuard lg;
203         int ret = -1;
204
205         if (node.name() != state_node_name()) {
206                 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
207                 return 0;
208         }
209
210 #ifndef NO_PLUGIN_STATE
211         XMLNode* child;
212
213         if ((child = find_named_node (node, X_("chunk"))) != 0) {
214
215                 XMLPropertyList::const_iterator i;
216                 XMLNodeList::const_iterator n;
217
218                 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
219                         if ((*n)->is_content ()) {
220                                 /* XXX: this may be dubious for the same reasons that we delay
221                                          execution of load_preset.
222                                          */
223                                 ret = set_chunk ((*n)->content().c_str(), false);
224                         }
225                 }
226
227         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
228
229                 XMLPropertyList::const_iterator i;
230
231                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
232                         int32_t param;
233                         float val;
234
235                         sscanf ((*i)->name().c_str(), "param-%d", &param);
236                         sscanf ((*i)->value().c_str(), "%f", &val);
237
238                         _plugin->setParameter (_plugin, param, val);
239                 }
240
241                 ret = 0;
242
243         }
244 #endif
245
246         Plugin::set_state (node, version);
247         return ret;
248 }
249
250
251 int
252 VSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
253 {
254         VstParameterProperties prop;
255
256         memset (&prop, 0, sizeof (VstParameterProperties));
257         desc.min_unbound = false;
258         desc.max_unbound = false;
259         prop.flags = 0;
260
261         if (_plugin->dispatcher (_plugin, effGetParameterProperties, which, 0, &prop, 0)) {
262
263                 /* i have yet to find or hear of a VST plugin that uses this */
264                 /* RG: faust2vsti does use this :) */
265
266                 if (prop.flags & kVstParameterUsesIntegerMinMax) {
267                         desc.lower = prop.minInteger;
268                         desc.upper = prop.maxInteger;
269                 } else {
270                         desc.lower = 0;
271                         desc.upper = 1.0;
272                 }
273
274                 if (prop.flags & kVstParameterUsesIntStep) {
275
276                         desc.step = prop.stepInteger;
277                         desc.smallstep = prop.stepInteger;
278                         desc.largestep = prop.stepInteger;
279
280                 } else if (prop.flags & kVstParameterUsesFloatStep) {
281
282                         desc.step = prop.stepFloat;
283                         desc.smallstep = prop.smallStepFloat;
284                         desc.largestep = prop.largeStepFloat;
285
286                 } else {
287
288                         float range = desc.upper - desc.lower;
289
290                         desc.step = range / 100.0f;
291                         desc.smallstep = desc.step / 2.0f;
292                         desc.largestep = desc.step * 10.0f;
293                 }
294
295                 if (strlen(prop.label) == 0) {
296                         _plugin->dispatcher (_plugin, effGetParamName, which, 0, prop.label, 0);
297                 }
298
299                 desc.toggled = prop.flags & kVstParameterIsSwitch;
300                 desc.logarithmic = false;
301                 desc.sr_dependent = false;
302                 desc.label = prop.label;
303
304         } else {
305
306                 /* old style */
307
308                 char label[64];
309                 /* some VST plugins expect this buffer to be zero-filled */
310                 memset (label, 0, sizeof (label));
311
312                 _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
313
314                 desc.label = label;
315                 desc.integer_step = false;
316                 desc.lower = 0.0f;
317                 desc.upper = 1.0f;
318                 desc.step = 0.01f;
319                 desc.smallstep = 0.005f;
320                 desc.largestep = 0.1f;
321                 desc.toggled = false;
322                 desc.logarithmic = false;
323                 desc.sr_dependent = false;
324         }
325
326         desc.normal = get_parameter (which);
327         _parameter_defaults[which] = desc.normal;
328
329         return 0;
330 }
331
332 bool
333 VSTPlugin::load_preset (PresetRecord r)
334 {
335         bool s;
336
337         if (r.user) {
338                 s = load_user_preset (r);
339         } else {
340                 s = load_plugin_preset (r);
341         }
342
343         if (s) {
344                 Plugin::load_preset (r);
345         }
346
347         return s;
348 }
349
350 bool
351 VSTPlugin::load_plugin_preset (PresetRecord r)
352 {
353         /* This is a plugin-provided preset.
354            We can't dispatch directly here; too many plugins expects only one GUI thread.
355         */
356
357         /* Extract the index of this preset from the URI */
358         int id;
359         int index;
360 #ifndef NDEBUG
361         int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
362         assert (p == 2);
363 #else
364         sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
365 #endif
366         _state->want_program = index;
367         return true;
368 }
369
370 bool
371 VSTPlugin::load_user_preset (PresetRecord r)
372 {
373         /* This is a user preset; we load it, and this code also knows about the
374            non-direct-dispatch thing.
375         */
376
377         boost::shared_ptr<XMLTree> t (presets_tree ());
378         if (t == 0) {
379                 return false;
380         }
381
382         XMLNode* root = t->root ();
383
384         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
385                 XMLProperty const * label = (*i)->property (X_("label"));
386
387                 assert (label);
388
389                 if (label->value() != r.label) {
390                         continue;
391                 }
392
393                 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
394
395                         /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
396
397                         if (_state->wanted_chunk) {
398                                 g_free (_state->wanted_chunk);
399                         }
400
401                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
402                                 if ((*j)->is_content ()) {
403                                         /* we can't dispatch directly here; too many plugins expect only one GUI thread */
404                                         gsize size = 0;
405                                         guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
406                                         _state->wanted_chunk = raw_data;
407                                         _state->wanted_chunk_size = size;
408                                         _state->want_chunk = 1;
409                                         return true;
410                                 }
411                         }
412
413                         return false;
414
415                 } else {
416
417                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
418                                 if ((*j)->name() == X_("Parameter")) {
419                                                 XMLProperty const * index = (*j)->property (X_("index"));
420                                                 XMLProperty const * value = (*j)->property (X_("value"));
421
422                                                 assert (index);
423                                                 assert (value);
424
425                                                 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
426                                 }
427                         }
428                         return true;
429                 }
430         }
431         return false;
432 }
433
434 string
435 VSTPlugin::do_save_preset (string name)
436 {
437         boost::shared_ptr<XMLTree> t (presets_tree ());
438         if (t == 0) {
439                 return "";
440         }
441
442         XMLNode* p = 0;
443         /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
444         string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
445
446         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
447
448                 p = new XMLNode (X_("ChunkPreset"));
449                 p->add_property (X_("uri"), uri);
450                 p->add_property (X_("label"), name);
451                 gchar* data = get_chunk (true);
452                 p->add_content (string (data));
453                 g_free (data);
454
455         } else {
456
457                 p = new XMLNode (X_("Preset"));
458                 p->add_property (X_("uri"), uri);
459                 p->add_property (X_("label"), name);
460
461                 for (uint32_t i = 0; i < parameter_count(); ++i) {
462                         if (parameter_is_input (i)) {
463                                 XMLNode* c = new XMLNode (X_("Parameter"));
464                                 c->add_property (X_("index"), string_compose ("%1", i));
465                                 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
466                                 p->add_child_nocopy (*c);
467                         }
468                 }
469         }
470
471         t->root()->add_child_nocopy (*p);
472
473         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
474         f = Glib::build_filename (f, presets_file ());
475
476         t->write (f);
477         return uri;
478 }
479
480 void
481 VSTPlugin::do_remove_preset (string name)
482 {
483         boost::shared_ptr<XMLTree> t (presets_tree ());
484         if (t == 0) {
485                 return;
486         }
487
488         t->root()->remove_nodes_and_delete (X_("label"), name);
489
490         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
491         f = Glib::build_filename (f, presets_file ());
492
493         t->write (f);
494 }
495
496 string
497 VSTPlugin::describe_parameter (Evoral::Parameter param)
498 {
499         char name[64];
500         memset (name, 0, sizeof (name));
501
502         /* some VST plugins expect this buffer to be zero-filled */
503
504         _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
505
506         if (name[0] == '\0') {
507                 strcpy (name, _("Unknown"));
508         }
509
510         return name;
511 }
512
513 framecnt_t
514 VSTPlugin::signal_latency () const
515 {
516         if (_user_latency) {
517                 return _user_latency;
518         }
519
520 #if ( defined(__x86_64__) || defined(_M_X64) )
521         return *((int32_t *) (((char *) &_plugin->flags) + 24)); /* initialDelay */
522 #else
523         return *((int32_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
524 #endif
525 }
526
527 set<Evoral::Parameter>
528 VSTPlugin::automatable () const
529 {
530         set<Evoral::Parameter> ret;
531
532         for (uint32_t i = 0; i < parameter_count(); ++i) {
533                 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
534         }
535
536         return ret;
537 }
538
539 int
540 VSTPlugin::connect_and_run (BufferSet& bufs,
541                 framepos_t start, framepos_t end, double speed,
542                 ChanMapping in_map, ChanMapping out_map,
543                 pframes_t nframes, framecnt_t offset)
544 {
545         Plugin::connect_and_run(bufs, start, end, speed, in_map, out_map, nframes, offset);
546
547         _transport_frame = start;
548         _transport_speed = speed;
549
550         ChanCount bufs_count;
551         bufs_count.set(DataType::AUDIO, 1);
552         bufs_count.set(DataType::MIDI, 1);
553         _midi_out_buf = 0;
554
555         BufferSet& silent_bufs  = _session.get_silent_buffers(bufs_count);
556         BufferSet& scratch_bufs = _session.get_scratch_buffers(bufs_count);
557
558         /* VC++ doesn't support the C99 extension that allows
559
560            typeName foo[variableDefiningSize];
561
562            Use alloca instead of dynamic array (rather than std::vector which
563            allocs on the heap) because this is realtime code.
564         */
565
566         float** ins = (float**)alloca(_plugin->numInputs*sizeof(float*));
567         float** outs = (float**)alloca(_plugin->numOutputs*sizeof(float*));
568
569         int32_t i;
570
571         uint32_t in_index = 0;
572         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
573                 uint32_t  index;
574                 bool      valid = false;
575                 index = in_map.get(DataType::AUDIO, in_index++, &valid);
576                 ins[i] = (valid)
577                                         ? bufs.get_audio(index).data(offset)
578                                         : silent_bufs.get_audio(0).data(offset);
579         }
580
581         uint32_t out_index = 0;
582         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
583                 uint32_t  index;
584                 bool      valid = false;
585                 index = out_map.get(DataType::AUDIO, out_index++, &valid);
586                 outs[i] = (valid)
587                         ? bufs.get_audio(index).data(offset)
588                         : scratch_bufs.get_audio(0).data(offset);
589         }
590
591         if (bufs.count().n_midi() > 0) {
592                 VstEvents* v = 0;
593                 bool valid = false;
594                 const uint32_t buf_index_in = in_map.get(DataType::MIDI, 0, &valid);
595                 if (valid) {
596                         v = bufs.get_vst_midi (buf_index_in);
597                 }
598                 valid = false;
599                 const uint32_t buf_index_out = out_map.get(DataType::MIDI, 0, &valid);
600                 if (valid) {
601                         _midi_out_buf = &bufs.get_midi(buf_index_out);
602                         _midi_out_buf->silence(0, 0);
603                 } else {
604                         _midi_out_buf = 0;
605                 }
606                 if (v) {
607                         _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
608                 }
609         }
610
611         /* we already know it can support processReplacing */
612         _plugin->processReplacing (_plugin, &ins[0], &outs[0], nframes);
613         _midi_out_buf = 0;
614
615         return 0;
616 }
617
618 string
619 VSTPlugin::unique_id () const
620 {
621         char buf[32];
622
623         snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
624
625         return string (buf);
626 }
627
628
629 const char *
630 VSTPlugin::name () const
631 {
632         if (!_info->name.empty ()) {
633                 return _info->name.c_str();
634         }
635         return _handle->name;
636 }
637
638 const char *
639 VSTPlugin::maker () const
640 {
641         return _info->creator.c_str();
642 }
643
644 const char *
645 VSTPlugin::label () const
646 {
647         return _handle->name;
648 }
649
650 uint32_t
651 VSTPlugin::parameter_count () const
652 {
653         return _plugin->numParams;
654 }
655
656 bool
657 VSTPlugin::has_editor () const
658 {
659         return _plugin->flags & effFlagsHasEditor;
660 }
661
662 void
663 VSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t /*len*/) const
664 {
665         char *first_nonws;
666
667         _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
668
669         if (buf[0] == '\0') {
670                 return;
671         }
672
673         first_nonws = buf;
674         while (*first_nonws && isspace (*first_nonws)) {
675                 first_nonws++;
676         }
677
678         if (*first_nonws == '\0') {
679                 return;
680         }
681
682         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
683 }
684
685 void
686 VSTPlugin::find_presets ()
687 {
688         /* Built-in presets */
689
690         int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
691         for (int i = 0; i < _plugin->numPrograms; ++i) {
692                 PresetRecord r (string_compose (X_("VST:%1:%2"), unique_id (), i), "", false);
693
694                 if (vst_version >= 2) {
695                         char buf[256];
696                         if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
697                                 r.label = buf;
698                         } else {
699                                 r.label = string_compose (_("Preset %1"), i);
700                         }
701                 } else {
702                         r.label = string_compose (_("Preset %1"), i);
703                 }
704
705                 _presets.insert (make_pair (r.uri, r));
706         }
707
708         /* User presets from our XML file */
709
710         boost::shared_ptr<XMLTree> t (presets_tree ());
711
712         if (t) {
713                 XMLNode* root = t->root ();
714                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
715
716                         XMLProperty const * uri = (*i)->property (X_("uri"));
717                         XMLProperty const * label = (*i)->property (X_("label"));
718
719                         assert (uri);
720                         assert (label);
721
722                         PresetRecord r (uri->value(), label->value(), true);
723                         _presets.insert (make_pair (r.uri, r));
724                 }
725         }
726
727 }
728
729 /** @return XMLTree with our user presets; could be a new one if no existing
730  *  one was found, or 0 if one was present but badly-formatted.
731  */
732 XMLTree *
733 VSTPlugin::presets_tree () const
734 {
735         XMLTree* t = new XMLTree;
736
737         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
738
739         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
740                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
741                         error << _("Unable to make VST presets directory") << endmsg;
742                 };
743         }
744
745         p = Glib::build_filename (p, presets_file ());
746
747         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
748                 t->set_root (new XMLNode (X_("VSTPresets")));
749                 return t;
750         }
751
752         t->set_filename (p);
753         if (!t->read ()) {
754                 delete t;
755                 return 0;
756         }
757
758         return t;
759 }
760
761 /** @return Index of the first user preset in our lists */
762 int
763 VSTPlugin::first_user_preset_index () const
764 {
765         return _plugin->numPrograms;
766 }
767
768 string
769 VSTPlugin::presets_file () const
770 {
771         return string_compose ("vst-%1", unique_id ());
772 }
773