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