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