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