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