a few coding style (indentation etc.) cleanups to LX VST code
[ardour.git] / libs / ardour / lxvst_plugin.cc
1 /*
2     Copyright (C) 2004 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 /**********************************************************************/
21 /*Native linuxVST (LXVST) variant of vst_plugin.cc etc                */
22 /**********************************************************************/
23
24
25 #include <algorithm>
26 #include <vector>
27 #include <string>
28 #include <cctype>
29
30 #include <cstdlib>
31 #include <cstdio> // so libraptor doesn't complain
32 #include <cmath>
33 #include <dirent.h>
34 #include <cstring> // for memmove
35 #include <sys/stat.h>
36 #include <cerrno>
37
38 #include <glibmm/miscutils.h>
39
40 #include <lrdf.h>
41
42 /*Include for the new native vst engine - vstfx.h*/
43
44 #include <ardour/vstfx.h>
45
46 #include "pbd/compose.h"
47 #include "pbd/error.h"
48 #include "pbd/pathscanner.h"
49 #include "pbd/xml++.h"
50
51 #include "ardour/session.h"
52 #include "ardour/audioengine.h"
53 #include "ardour/filesystem_paths.h"
54 #include "ardour/lxvst_plugin.h"
55 #include "ardour/buffer_set.h"
56 #include "ardour/audio_buffer.h"
57 #include "ardour/midi_buffer.h"
58
59 #include "pbd/stl_delete.h"
60
61 #include "i18n.h"
62 #include <locale.h>
63
64 using namespace std;
65 using namespace ARDOUR;
66 using namespace PBD;
67 using std::min;
68 using std::max;
69
70 LXVSTPlugin::LXVSTPlugin (AudioEngine& e, Session& session, VSTFXHandle* h)
71         : Plugin (e, session)
72 {
73         handle = h;
74
75         /*Instantiate the plugin and return a VSTFX* */
76
77         if ((_vstfx = vstfx_instantiate (handle, Session::lxvst_callback, this)) == 0) {
78                 throw failed_constructor();
79         }
80
81         /* Call into vstfx to get a pointer to the instance of the VST plugin*/
82
83         _plugin = _vstfx->plugin;
84         _plugin->user = this;
85
86         /* set rate and blocksize */
87
88         _plugin->dispatcher (_plugin, effSetSampleRate, 0, 0, NULL, (float) session.frame_rate());
89         
90         _plugin->dispatcher (_plugin, effSetBlockSize, 0, session.get_block_size(), NULL, 0.0f);
91
92         /* set program to zero */
93
94         _plugin->dispatcher (_plugin, effSetProgram, 0, 0, NULL, 0.0f);
95
96         // Plugin::setup_controls ();
97 }
98
99 LXVSTPlugin::LXVSTPlugin (const LXVSTPlugin &other)
100         : Plugin (other)
101 {
102         handle = other.handle;
103
104         if ((_vstfx = vstfx_instantiate (handle, Session::lxvst_callback, this)) == 0) {
105                 throw failed_constructor();
106         }
107         _plugin = _vstfx->plugin;
108
109         // Plugin::setup_controls ();
110 }
111
112 LXVSTPlugin::~LXVSTPlugin ()
113 {
114         deactivate ();
115         vstfx_close (_vstfx);
116 }
117
118 int 
119 LXVSTPlugin::set_block_size (pframes_t nframes)
120 {
121         deactivate ();
122         _plugin->dispatcher (_plugin, effSetBlockSize, 0, nframes, NULL, 0.0f);
123         activate ();
124         return 0;
125 }
126
127 float 
128 LXVSTPlugin::default_value (uint32_t port)
129 {
130         return 0;
131 }
132
133 void 
134 LXVSTPlugin::set_parameter (uint32_t which, float val)
135 {
136         _plugin->setParameter (_plugin, which, val);
137         
138         if (_vstfx->want_program == -1 && _vstfx->want_chunk == 0) {
139                 /* Heinous hack: Plugin::set_parameter below updates the `modified' status of the
140                    current preset, but if _vstfx->want_program is not -1 then there is a preset
141                    setup pending or in progress, which we don't want any `modified' updates
142                    to happen for.  So we only do this if _vstfx->want_program is -1.
143                 */
144                 Plugin::set_parameter (which, val);
145         }
146 }
147
148 float 
149 LXVSTPlugin::get_parameter (uint32_t which) const
150 {
151         return _plugin->getParameter (_plugin, which);
152
153 }
154
155 uint32_t 
156 LXVSTPlugin::nth_parameter (uint32_t n, bool& ok) const
157 {
158         ok = true;
159         return n;
160 }
161
162 /** Get VST chunk as base64-encoded data.
163  *  @param single true for single program, false for all programs.
164  *  @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
165  */
166 gchar *LXVSTPlugin::get_chunk (bool single) const
167 {
168         guchar* data;
169         int32_t data_size = _plugin->dispatcher (_plugin, 23 /* effGetChunk */, single ? 1 : 0, 0, &data, 0);
170
171         if (data_size == 0) {
172                 return 0;
173         }
174
175         return g_base64_encode (data, data_size);
176 }
177
178 /** Set VST chunk from base64-encoded data.
179  *  @param 0-terminated base64-encoded data.
180  *  @param single true for single program, false for all programs.
181  *  @return 0 on success, non-0 on failure
182  */
183 int 
184 LXVSTPlugin::set_chunk (gchar const * data, bool single)
185 {
186         gsize size = 0;
187         guchar* raw_data = g_base64_decode (data, &size);
188         int const r = _plugin->dispatcher (_plugin, 24 /* effSetChunk */, single ? 1 : 0, size, raw_data, 0);
189         g_free (raw_data);
190         return r;
191 }
192
193 void 
194 LXVSTPlugin::add_state (XMLNode* root) const
195 {
196         LocaleGuard lg (X_("POSIX"));
197
198         if (_vstfx->current_program != -1) {
199                 char buf[32];
200                 snprintf (buf, sizeof (buf), "%d", _vstfx->current_program);
201                 root->add_property ("current-program", buf);
202         }
203
204         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
205                 gchar* data = get_chunk (false);
206
207                 if (data == 0) {
208                         return;
209                 }
210
211                 /* store information */
212
213                 XMLNode* chunk_node = new XMLNode (X_("chunk"));
214
215                 chunk_node->add_content (data);
216                 g_free (data);
217
218                 root->add_child_nocopy (*chunk_node);
219
220         } else {
221                 XMLNode* parameters = new XMLNode ("parameters");
222
223                 for (int32_t n = 0; n < _plugin->numParams; ++n) {
224                         char index[64];
225                         char val[32];
226                         snprintf (index, sizeof (index), "param_%d", n);
227                         snprintf (val, sizeof (val), "%.12g", _plugin->getParameter (_plugin, n));
228                         parameters->add_property (index, val);
229                 }
230
231                 root->add_child_nocopy (*parameters);
232         }
233 }
234
235 int 
236 LXVSTPlugin::set_state (const XMLNode& node, int version)
237 {
238         LocaleGuard lg (X_("POSIX"));
239
240         if (node.name() != state_node_name()) {
241                 error << _("Bad node sent to VSTPlugin::set_state") << endmsg;
242                 return 0;
243         }
244
245         const XMLProperty* prop;
246
247         if ((prop = node.property ("current-program")) != 0) {
248                 _vstfx->want_program = atoi (prop->value().c_str());
249         }
250
251         XMLNode* child;
252         int ret = -1;
253
254         if ((child = find_named_node (node, X_("chunk"))) != 0) {
255                 XMLPropertyList::const_iterator i;
256                 XMLNodeList::const_iterator n;
257                 int ret = -1;
258
259                 for (n = child->children ().begin (); n != child->children ().end (); ++n) {
260                         if ((*n)->is_content ()) {
261                                 /* XXX: this may be dubious for the same reasons that we delay
262                                    execution of load_preset.
263                                 */
264                                 ret = set_chunk ((*n)->content().c_str(), false);
265                         }
266                 }
267
268         } else if ((child = find_named_node (node, X_("parameters"))) != 0) {
269                 XMLPropertyList::const_iterator i;
270
271                 for (i = child->properties().begin(); i != child->properties().end(); ++i) {
272                         int32_t param;
273                         float val;
274
275                         sscanf ((*i)->name().c_str(), "param-%d", &param); //This was param_%d (from vst_plugin) which caused all sorts of odd behaviour
276                         sscanf ((*i)->value().c_str(), "%f", &val);
277
278                         _plugin->setParameter (_plugin, param, val);
279                 }
280
281                 /* program number is not knowable */
282
283                 _vstfx->current_program = -1;
284
285                 ret = 0;
286         }
287
288         Plugin::set_state (node, version);
289         return ret;
290 }
291
292 int 
293 LXVSTPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
294 {
295         VstParameterProperties prop;
296
297         desc.min_unbound = false;
298         desc.max_unbound = false;
299         prop.flags = 0;
300
301         /* old style */
302
303         char label[64];
304         label[0] = '\0';
305
306         _plugin->dispatcher (_plugin, effGetParamName, which, 0, label, 0);
307
308         desc.label = label;
309         desc.integer_step = false;
310         desc.lower = 0.0f;
311         desc.upper = 1.0f;
312         desc.step = 0.01f;
313         desc.smallstep = 0.005f;
314         desc.largestep = 0.1f;
315         desc.toggled = false;
316         desc.logarithmic = false;
317         desc.sr_dependent = false;
318         
319         return 0;
320 }
321
322 bool 
323 LXVSTPlugin::load_preset (PresetRecord r)
324 {
325         bool s;
326
327         if (r.user) {
328                 s = load_user_preset (r);
329         }
330         else {
331                 s = load_plugin_preset (r);
332         }
333
334         if (s) {
335                 Plugin::load_preset (r);
336         }
337
338         return s;
339 }
340
341 bool 
342 LXVSTPlugin::load_plugin_preset (PresetRecord r)
343 {
344         /* This is a plugin-provided preset.
345            We can't dispatch directly here; too many plugins expects only one GUI thread.
346         */
347
348         /* Extract the index of this preset from the URI */
349         int id;
350         int index;
351         int const p = sscanf (r.uri.c_str(), "VST:%d:%d", &id, &index);
352         assert (p == 2);
353
354         _vstfx->want_program = index;
355         return true;
356 }
357
358 bool 
359 LXVSTPlugin::load_user_preset (PresetRecord r)
360 {
361         /* This is a user preset; we load it, and this code also knows about the
362            non-direct-dispatch thing.
363         */
364
365         boost::shared_ptr<XMLTree> t (presets_tree ());
366         if (t == 0) {
367                 return false;
368         }
369
370         XMLNode* root = t->root ();
371
372         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
373                 XMLProperty* uri = (*i)->property (X_("uri"));
374                 XMLProperty* label = (*i)->property (X_("label"));
375
376                 assert (uri);
377                 assert (label);
378
379                 if (label->value() != r.label) {
380                         continue;
381                 }
382
383                 if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
384
385                         /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
386
387                         if (_vstfx->wanted_chunk) {
388                                 g_free (_vstfx->wanted_chunk);
389                         }
390
391                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
392                                 if ((*j)->is_content ()) {
393                                         /* we can't dispatch directly here; too many plugins expect only one GUI thread */
394                                         gsize size = 0;
395                                         guchar* raw_data = g_base64_decode ((*j)->content().c_str(), &size);
396                                         _vstfx->wanted_chunk = raw_data;
397                                         _vstfx->wanted_chunk_size = size;
398                                         _vstfx->want_chunk = 1;
399                                         return true;
400                                 }
401                         }
402
403                         return false;
404
405                 }
406                 else {
407                         for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
408                                 if ((*j)->name() == X_("Parameter")) {
409                                                 XMLProperty* index = (*j)->property (X_("index"));
410                                                 XMLProperty* value = (*j)->property (X_("value"));
411
412                                                 assert (index);
413                                                 assert (value);
414
415                                                 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
416                                 }
417                         }
418                         return true;
419                 }
420         }
421         return false;
422 }
423
424 string 
425 LXVSTPlugin::do_save_preset (string name)
426 {
427         boost::shared_ptr<XMLTree> t (presets_tree ());
428         if (t == 0) {
429                 return "";
430         }
431
432         XMLNode* p = 0;
433         /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
434         string const uri = string_compose (X_("VST:%1:%2"), unique_id (), _presets.size() + 1);
435
436         if (_plugin->flags & 32 /* effFlagsProgramsChunks */) {
437
438                 p = new XMLNode (X_("ChunkPreset"));
439                 p->add_property (X_("uri"), uri);
440                 p->add_property (X_("label"), name);
441                 gchar* data = get_chunk (true);
442                 p->add_content (string (data));
443                 g_free (data);
444
445         }
446         else {
447
448                 p = new XMLNode (X_("Preset"));
449                 p->add_property (X_("uri"), uri);
450                 p->add_property (X_("label"), name);
451
452                 for (uint32_t i = 0; i < parameter_count(); ++i) {
453                         if (parameter_is_input (i)) {
454                                 XMLNode* c = new XMLNode (X_("Parameter"));
455                                 c->add_property (X_("index"), string_compose ("%1", i));
456                                 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
457                                 p->add_child_nocopy (*c);
458                         }
459                 }
460         }
461
462         t->root()->add_child_nocopy (*p);
463
464         sys::path f = ARDOUR::user_config_directory ();
465         f /= "presets";
466         f /= presets_file ();
467
468         t->write (f.to_string ());
469         return uri;
470 }
471
472 void 
473 LXVSTPlugin::do_remove_preset (string name)
474 {
475         boost::shared_ptr<XMLTree> t (presets_tree ());
476         if (t == 0) {
477                 return;
478         }
479
480         t->root()->remove_nodes_and_delete (X_("label"), name);
481
482         sys::path f = ARDOUR::user_config_directory ();
483         f /= "presets";
484         f /= presets_file ();
485
486         t->write (f.to_string ());
487 }
488
489 string 
490 LXVSTPlugin::describe_parameter (Evoral::Parameter param)
491 {
492         char name[64] = "Unkown";
493         _plugin->dispatcher (_plugin, effGetParamName, param.id(), 0, name, 0);
494         return name;
495 }
496
497 framecnt_t 
498 LXVSTPlugin::signal_latency () const
499 {
500         if (_user_latency) {
501                 return _user_latency;
502         }
503
504 #ifdef VESTIGE_HEADER
505         return *((framecnt_t *) (((char *) &_plugin->flags) + 12)); /* initialDelay */
506 #else
507         return _plugin->initial_delay;
508 #endif
509 }
510
511 set<Evoral::Parameter> 
512 LXVSTPlugin::automatable () const
513 {
514         set<Evoral::Parameter> ret;
515
516         for (uint32_t i = 0; i < parameter_count(); ++i) {
517                 ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
518         }
519
520         return ret;
521 }
522
523 int
524 LXVSTPlugin::connect_and_run (BufferSet& bufs,
525                               ChanMapping in_map, ChanMapping out_map,
526                               pframes_t nframes, framecnt_t offset)
527 {
528         Plugin::connect_and_run (bufs, in_map, out_map, nframes, offset);
529
530         float *ins[_plugin->numInputs];
531         float *outs[_plugin->numOutputs];
532         int32_t i;
533
534         const uint32_t nbufs = bufs.count().n_audio();
535
536         int in_index = 0;
537         for (i = 0; i < (int32_t) _plugin->numInputs; ++i) {
538                 ins[i] = bufs.get_audio(min((uint32_t) in_index, nbufs - 1)).data() + offset;
539                 in_index++;
540         }
541
542         int out_index = 0;
543         for (i = 0; i < (int32_t) _plugin->numOutputs; ++i) {
544                 outs[i] = bufs.get_audio(min((uint32_t) out_index, nbufs - 1)).data() + offset;
545                 out_index++;
546         }
547
548         if (bufs.count().n_midi() > 0) {
549                 VstEvents* v = bufs.get_vst_midi (0);
550                 _plugin->dispatcher (_plugin, effProcessEvents, 0, 0, v, 0);
551         }
552
553         /* we already know it can support processReplacing */
554         
555 #ifdef LXVST_32BIT
556         _plugin->processReplacing (_plugin, ins, outs, nframes);
557 #endif
558
559 #if defined LXVST_64BIT && defined VESTIGE_HEADER
560
561         /* Vestige doesn't work for 64Bit - some of the AEffect struct member types
562            appear not to be correct which throws the data alignment.  We have two choices
563            
564            1) Fix Vestige - preferable from a technical standpoint, but perhaps
565            not viable without affecting its 'clean room' status
566            
567            2) Correct for the alignment error - a bit of a kludge, but it can work,
568            assuming the following data types / sizes on x86-64
569            
570            char         1Byte  : Byte aligned
571            int          4Bytes : 4Byte aligned
572            long         8Bytes : 8Byte aligned
573            pointers     8Bytes : 8Byte aligned
574            
575            This gives an offset of 8 Bytes - inclusive of padding
576            to translate to the correct address for processReplacing
577         */
578
579         ((AEffect*)(((char*)(_plugin)) + 8))->processReplacing(_plugin, ins, outs, nframes);
580         
581 #elif defined LXVST_64BIT
582
583         _plugin->processReplacing(_plugin, ins, outs, nframes);
584         
585 #endif
586
587         return 0;
588 }
589
590 void 
591 LXVSTPlugin::deactivate ()
592 {
593         _plugin->dispatcher (_plugin, effMainsChanged, 0, 0, NULL, 0.0f);
594 }
595
596 void 
597 LXVSTPlugin::activate ()
598 {
599         _plugin->dispatcher (_plugin, effMainsChanged, 0, 1, NULL, 0.0f);
600 }
601
602 string 
603 LXVSTPlugin::unique_id() const
604 {
605         char buf[32];
606         
607 #if defined LXVST_64BIT && defined VESTIGE_HEADER
608
609         /*The vestige header appears not to have correct data
610         alignment in AEffect struct for 64Bit, possibly due
611         to incorrect data types - see previous comments*/
612                 
613         snprintf (buf, sizeof (buf), "%d", *((int32_t*) &((AEffect*)(((char*)(_plugin)) + 12))->unused_id));
614
615 #elif defined LXVST_32BIT && defined VESTIGE_HEADER
616         
617         snprintf (buf, sizeof (buf), "%d", *((int32_t*) &_plugin->unused_id));
618         
619 #else
620         
621         snprintf (buf, sizeof (buf), "%d", _plugin->uniqueID);
622
623 #endif
624         
625         return string (buf);
626 }
627
628
629 const char * 
630 LXVSTPlugin::name () const
631 {
632         return handle->name;
633 }
634
635 const char * 
636 LXVSTPlugin::maker () const
637 {
638         return _info->creator.c_str();
639 }
640
641 const char * 
642 LXVSTPlugin::label () const
643 {
644         return handle->name;
645 }
646
647 uint32_t 
648 LXVSTPlugin::parameter_count() const
649 {
650         return _plugin->numParams;
651 }
652
653 bool 
654 LXVSTPlugin::has_editor () const
655 {
656         return _plugin->flags & effFlagsHasEditor;
657 }
658
659 void 
660 LXVSTPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
661 {
662         char *first_nonws;
663
664         _plugin->dispatcher (_plugin, 7 /* effGetParamDisplay */, param, 0, buf, 0);
665
666         if (buf[0] == '\0') {
667                 return;
668         }
669
670         first_nonws = buf;
671         while (*first_nonws && isspace (*first_nonws)) {
672                 first_nonws++;
673         }
674
675         if (*first_nonws == '\0') {
676                 return;
677         }
678
679         memmove (buf, first_nonws, strlen (buf) - (first_nonws - buf) + 1);
680 }
681
682 PluginPtr 
683 LXVSTPluginInfo::load (Session& session)
684 {
685         try {
686                 PluginPtr plugin;
687
688                 if (Config->get_use_lxvst()) {
689                         VSTFXHandle* handle;
690
691                         handle = vstfx_load(path.c_str());
692
693                         if (handle == NULL) {
694                                 error << string_compose(_("LXVST: cannot load module from \"%1\""), path) << endmsg;
695                         }
696                         else {
697                                 plugin.reset (new LXVSTPlugin (session.engine(), session, handle));
698                         }
699                 }
700                 else {
701                         error << _("You asked ardour to not use any LXVST plugins") << endmsg;
702                         return PluginPtr ((Plugin*) 0);
703                 }
704
705                 plugin->set_info(PluginInfoPtr(new LXVSTPluginInfo(*this)));
706                 return plugin;
707         }
708
709         catch (failed_constructor &err) {
710                 return PluginPtr ((Plugin*) 0);
711         }
712 }
713
714 void 
715 LXVSTPlugin::find_presets ()
716 {
717         /* Built-in presets */
718
719         int const vst_version = _plugin->dispatcher (_plugin, effGetVstVersion, 0, 0, NULL, 0);
720
721         for (int i = 0; i < _plugin->numPrograms; ++i) {
722                 PresetRecord r (string_compose (X_("LXVST:%1:%2"), unique_id (), i), "", false);
723
724                 if (vst_version >= 2) {
725                         char buf[256];
726                         if (_plugin->dispatcher (_plugin, 29, i, 0, buf, 0) == 1) {
727                                 r.label = buf;
728                         } else {
729                                 r.label = string_compose (_("Preset %1"), i);
730                         }
731                 } else {
732                         r.label = string_compose (_("Preset %1"), i);
733                 }
734
735                 _presets.insert (make_pair (r.uri, r));
736         }
737
738         /* User presets from our XML file */
739
740         boost::shared_ptr<XMLTree> t (presets_tree ());
741
742         if (t) {
743                 XMLNode* root = t->root ();
744                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
745                         XMLProperty* uri = (*i)->property (X_("uri"));
746                         XMLProperty* label = (*i)->property (X_("label"));
747
748                         assert (uri);
749                         assert (label);
750
751                         PresetRecord r (uri->value(), label->value(), true);
752                         _presets.insert (make_pair (r.uri, r));
753                 }
754         }
755 }
756
757 /** @return XMLTree with our user presets; could be a new one if no existing
758  *  one was found, or 0 if one was present but badly-formatted.
759  */
760 XMLTree * 
761 LXVSTPlugin::presets_tree () const
762 {
763         XMLTree* t = new XMLTree;
764
765         sys::path p = ARDOUR::user_config_directory ();
766         p /= "presets";
767
768         if (!is_directory (p)) {
769                 create_directory (p);
770         }
771
772         p /= presets_file ();
773
774         if (!exists (p)) {
775                 t->set_root (new XMLNode (X_("LXVSTPresets")));
776                 return t;
777         }
778
779         t->set_filename (p.to_string ());
780         if (!t->read ()) {
781                 delete t;
782                 return 0;
783         }
784
785         return t;
786 }
787
788 /** @return Index of the first user preset in our lists */
789 int 
790 LXVSTPlugin::first_user_preset_index () const
791 {
792         return _plugin->numPrograms;
793 }
794
795 string LXVSTPlugin::presets_file () const
796 {
797         return string_compose ("lxvst-%1", unique_id ());
798 }
799
800 LXVSTPluginInfo::LXVSTPluginInfo()
801 {
802        type = ARDOUR::LXVST;
803 }
804