Manage attempts to save plugin presets with the same name. Helps with #2662.
[ardour.git] / libs / ardour / ladspa_plugin.cc
1 /*
2     Copyright (C) 2000-2006 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 <inttypes.h>
21
22 #include <vector>
23 #include <string>
24
25 #include <cstdlib>
26 #include <cstdio> // so libraptor doesn't complain
27 #include <cmath>
28 #include <dirent.h>
29 #include <sys/stat.h>
30 #include <cerrno>
31
32 #include <lrdf.h>
33
34 #include "pbd/compose.h"
35 #include "pbd/error.h"
36 #include "pbd/xml++.h"
37
38 #include "midi++/manager.h"
39
40 #include "ardour/ardour.h"
41 #include "ardour/session.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/ladspa_plugin.h"
44 #include "ardour/buffer_set.h"
45 #include "ardour/audio_buffer.h"
46
47 #include "pbd/stl_delete.h"
48
49 #include "i18n.h"
50 #include <locale.h>
51
52 using namespace std;
53 using namespace ARDOUR;
54 using namespace PBD;
55
56 LadspaPlugin::LadspaPlugin (void *mod, AudioEngine& e, Session& session, uint32_t index, framecnt_t rate)
57         : Plugin (e, session)
58 {
59         init (mod, index, rate);
60 }
61
62 LadspaPlugin::LadspaPlugin (const LadspaPlugin &other)
63         : Plugin (other)
64 {
65         init (other._module, other._index, other._sample_rate);
66
67         for (uint32_t i = 0; i < parameter_count(); ++i) {
68                 _control_data[i] = other._shadow_data[i];
69                 _shadow_data[i] = other._shadow_data[i];
70         }
71 }
72
73 void
74 LadspaPlugin::init (void *mod, uint32_t index, framecnt_t rate)
75 {
76         LADSPA_Descriptor_Function dfunc;
77         uint32_t i, port_cnt;
78         const char *errstr;
79
80         _module = mod;
81         _control_data = 0;
82         _shadow_data = 0;
83         _latency_control_port = 0;
84         _was_activated = false;
85
86         dfunc = (LADSPA_Descriptor_Function) dlsym (_module, "ladspa_descriptor");
87
88         if ((errstr = dlerror()) != NULL) {
89                 error << _("LADSPA: module has no descriptor function.") << endmsg;
90                 throw failed_constructor();
91         }
92
93         if ((_descriptor = dfunc (index)) == 0) {
94                 error << _("LADSPA: plugin has gone away since discovery!") << endmsg;
95                 throw failed_constructor();
96         }
97
98         _index = index;
99
100         if (LADSPA_IS_INPLACE_BROKEN(_descriptor->Properties)) {
101                 error << string_compose(_("LADSPA: \"%1\" cannot be used, since it cannot do inplace processing"), _descriptor->Name) << endmsg;
102                 throw failed_constructor();
103         }
104
105         _sample_rate = rate;
106
107         if (_descriptor->instantiate == 0) {
108                 throw failed_constructor();
109         }
110
111         if ((_handle = _descriptor->instantiate (_descriptor, rate)) == 0) {
112                 throw failed_constructor();
113         }
114
115         port_cnt = parameter_count();
116
117         _control_data = new LADSPA_Data[port_cnt];
118         _shadow_data = new LADSPA_Data[port_cnt];
119
120         for (i = 0; i < port_cnt; ++i) {
121                 if (LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
122                         connect_port (i, &_control_data[i]);
123
124                         if (LADSPA_IS_PORT_OUTPUT(port_descriptor (i)) &&
125                             strcmp (port_names()[i], X_("latency")) == 0) {
126                                 _latency_control_port = &_control_data[i];
127                                 *_latency_control_port = 0;
128                         }
129
130                         if (!LADSPA_IS_PORT_INPUT(port_descriptor (i))) {
131                                 continue;
132                         }
133
134                         _shadow_data[i] = default_value (i);
135                 }
136         }
137
138         latency_compute_run ();
139 }
140
141 LadspaPlugin::~LadspaPlugin ()
142 {
143         deactivate ();
144         cleanup ();
145
146         /* XXX who should close a plugin? */
147
148         // dlclose (module);
149
150         delete [] _control_data;
151         delete [] _shadow_data;
152 }
153
154 string
155 LadspaPlugin::unique_id() const
156 {
157         char buf[32];
158         snprintf (buf, sizeof (buf), "%lu", _descriptor->UniqueID);
159         return string (buf);
160 }
161
162 float
163 LadspaPlugin::default_value (uint32_t port)
164 {
165         const LADSPA_PortRangeHint *prh = port_range_hints();
166         float ret = 0.0f;
167         bool bounds_given = false;
168         bool sr_scaling = false;
169         bool earlier_hint = false;
170
171         /* defaults - case 1 */
172
173         if (LADSPA_IS_HINT_HAS_DEFAULT(prh[port].HintDescriptor)) {
174                 if (LADSPA_IS_HINT_DEFAULT_MINIMUM(prh[port].HintDescriptor)) {
175                         ret = prh[port].LowerBound;
176                         bounds_given = true;
177                         sr_scaling = true;
178                 }
179
180                 else if (LADSPA_IS_HINT_DEFAULT_LOW(prh[port].HintDescriptor)) {
181                         if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
182                                 ret = exp(log(prh[port].LowerBound) * 0.75f + log(prh[port].UpperBound) * 0.25f);
183                         }
184                         else {
185                                 ret = prh[port].LowerBound * 0.75f + prh[port].UpperBound * 0.25f;
186                         }
187                         bounds_given = true;
188                         sr_scaling = true;
189                 }
190                 else if (LADSPA_IS_HINT_DEFAULT_MIDDLE(prh[port].HintDescriptor)) {
191                         if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
192                                 ret = exp(log(prh[port].LowerBound) * 0.5f + log(prh[port].UpperBound) * 0.5f);
193                         }
194                         else {
195                                 ret = prh[port].LowerBound * 0.5f + prh[port].UpperBound * 0.5f;
196                         }
197                         bounds_given = true;
198                         sr_scaling = true;
199                 }
200                 else if (LADSPA_IS_HINT_DEFAULT_HIGH(prh[port].HintDescriptor)) {
201                         if (LADSPA_IS_HINT_LOGARITHMIC(prh[port].HintDescriptor)) {
202                                 ret = exp(log(prh[port].LowerBound) * 0.25f + log(prh[port].UpperBound) * 0.75f);
203                         }
204                         else {
205                                 ret = prh[port].LowerBound * 0.25f + prh[port].UpperBound * 0.75f;
206                         }
207                         bounds_given = true;
208                         sr_scaling = true;
209                 }
210                 else if (LADSPA_IS_HINT_DEFAULT_MAXIMUM(prh[port].HintDescriptor)) {
211                         ret = prh[port].UpperBound;
212                         bounds_given = true;
213                         sr_scaling = true;
214                 }
215                 else if (LADSPA_IS_HINT_DEFAULT_0(prh[port].HintDescriptor)) {
216                         ret = 0.0f;
217                         earlier_hint = true;
218                 }
219                 else if (LADSPA_IS_HINT_DEFAULT_1(prh[port].HintDescriptor)) {
220                         ret = 1.0f;
221                         earlier_hint = true;
222                 }
223                 else if (LADSPA_IS_HINT_DEFAULT_100(prh[port].HintDescriptor)) {
224                         ret = 100.0f;
225                         earlier_hint = true;
226                 }
227                 else if (LADSPA_IS_HINT_DEFAULT_440(prh[port].HintDescriptor)) {
228                         ret = 440.0f;
229                         earlier_hint = true;
230                 }
231                 else {
232                         /* no hint found */
233                         ret = 0.0f;
234                 }
235         }
236
237         /* defaults - case 2 */
238         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
239                  !LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
240
241                 if (prh[port].LowerBound < 0) {
242                         ret = 0.0f;
243                 } else {
244                         ret = prh[port].LowerBound;
245                 }
246
247                 bounds_given = true;
248                 sr_scaling = true;
249         }
250
251         /* defaults - case 3 */
252         else if (!LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
253                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
254
255                 if (prh[port].UpperBound > 0) {
256                         ret = 0.0f;
257                 } else {
258                         ret = prh[port].UpperBound;
259                 }
260
261                 bounds_given = true;
262                 sr_scaling = true;
263         }
264
265         /* defaults - case 4 */
266         else if (LADSPA_IS_HINT_BOUNDED_BELOW(prh[port].HintDescriptor) &&
267                  LADSPA_IS_HINT_BOUNDED_ABOVE(prh[port].HintDescriptor)) {
268
269                 if (prh[port].LowerBound < 0 && prh[port].UpperBound > 0) {
270                         ret = 0.0f;
271                 } else if (prh[port].LowerBound < 0 && prh[port].UpperBound < 0) {
272                         ret = prh[port].UpperBound;
273                 } else {
274                         ret = prh[port].LowerBound;
275                 }
276                 bounds_given = true;
277                 sr_scaling = true;
278         }
279
280         /* defaults - case 5 */
281
282         if (LADSPA_IS_HINT_SAMPLE_RATE(prh[port].HintDescriptor) && !earlier_hint) {
283                 if (bounds_given) {
284                         if (sr_scaling) {
285                                 ret *= _sample_rate;
286                         }
287                 } else {
288                         ret = _sample_rate;
289                 }
290         }
291
292         return ret;
293 }
294
295 void
296 LadspaPlugin::set_parameter (uint32_t which, float val)
297 {
298         if (which < _descriptor->PortCount) {
299                 _shadow_data[which] = (LADSPA_Data) val;
300 #if 0
301                 ParameterChanged (Parameter(PluginAutomation, 0, which), val); /* EMIT SIGNAL */
302
303                 if (which < parameter_count() && controls[which]) {
304                         controls[which]->Changed ();
305                 }
306 #endif
307
308         } else {
309                 warning << string_compose (_("illegal parameter number used with plugin \"%1\". This may"
310                                              "indicate a change in the plugin design, and presets may be"
311                                              "invalid"), name())
312                         << endmsg;
313         }
314 }
315
316 float
317 LadspaPlugin::get_parameter (uint32_t which) const
318 {
319         if (LADSPA_IS_PORT_INPUT(port_descriptor (which))) {
320                 return (float) _shadow_data[which];
321         } else {
322                 return (float) _control_data[which];
323         }
324 }
325
326 uint32_t
327 LadspaPlugin::nth_parameter (uint32_t n, bool& ok) const
328 {
329         uint32_t x, c;
330
331         ok = false;
332
333         for (c = 0, x = 0; x < _descriptor->PortCount; ++x) {
334                 if (LADSPA_IS_PORT_CONTROL (port_descriptor (x))) {
335                         if (c++ == n) {
336                                 ok = true;
337                                 return x;
338                         }
339                 }
340         }
341         return 0;
342 }
343
344 XMLNode&
345 LadspaPlugin::get_state()
346 {
347         XMLNode *root = new XMLNode(state_node_name());
348         XMLNode *child;
349         char buf[16];
350         LocaleGuard lg (X_("POSIX"));
351
352         for (uint32_t i = 0; i < parameter_count(); ++i){
353
354                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
355                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
356
357                         child = new XMLNode("Port");
358                         snprintf(buf, sizeof(buf), "%u", i);
359                         child->add_property("number", string(buf));
360                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
361                         child->add_property("value", string(buf));
362                         root->add_child_nocopy (*child);
363                 }
364         }
365
366         return *root;
367 }
368
369 bool
370 LadspaPlugin::save_preset (string name)
371 {
372         return Plugin::save_preset (name, "ladspa");
373 }
374
375 void
376 LadspaPlugin::remove_preset (string name)
377 {
378         return Plugin::remove_preset (name, "ladspa");
379 }
380
381 int
382 LadspaPlugin::set_state (const XMLNode& node, int version)
383 {
384         if (version < 3000) {
385                 return set_state_2X (node, version);
386         }
387         
388         XMLNodeList nodes;
389         XMLProperty *prop;
390         XMLNodeConstIterator iter;
391         XMLNode *child;
392         const char *port;
393         const char *data;
394         uint32_t port_id;
395         LocaleGuard lg (X_("POSIX"));
396
397         if (node.name() != state_node_name()) {
398                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
399                 return -1;
400         }
401
402         nodes = node.children ("Port");
403
404         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
405
406                 child = *iter;
407
408                 if ((prop = child->property("number")) != 0) {
409                         port = prop->value().c_str();
410                 } else {
411                         warning << _("LADSPA: no ladspa port number") << endmsg;
412                         continue;
413                 }
414                 if ((prop = child->property("value")) != 0) {
415                         data = prop->value().c_str();
416                 } else {
417                         warning << _("LADSPA: no ladspa port data") << endmsg;
418                         continue;
419                 }
420
421                 sscanf (port, "%" PRIu32, &port_id);
422                 set_parameter (port_id, atof(data));
423         }
424
425         latency_compute_run ();
426
427         return 0;
428 }
429
430 int
431 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
432 {
433         XMLNodeList nodes;
434         XMLProperty *prop;
435         XMLNodeConstIterator iter;
436         XMLNode *child;
437         const char *port;
438         const char *data;
439         uint32_t port_id;
440         LocaleGuard lg (X_("POSIX"));
441
442         if (node.name() != state_node_name()) {
443                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
444                 return -1;
445         }
446
447         nodes = node.children ("port");
448
449         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
450
451                 child = *iter;
452
453                 if ((prop = child->property("number")) != 0) {
454                         port = prop->value().c_str();
455                 } else {
456                         warning << _("LADSPA: no ladspa port number") << endmsg;
457                         continue;
458                 }
459                 if ((prop = child->property("value")) != 0) {
460                         data = prop->value().c_str();
461                 } else {
462                         warning << _("LADSPA: no ladspa port data") << endmsg;
463                         continue;
464                 }
465
466                 sscanf (port, "%" PRIu32, &port_id);
467                 set_parameter (port_id, atof(data));
468         }
469
470         latency_compute_run ();
471
472         return 0;
473 }
474
475 int
476 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
477 {
478         LADSPA_PortRangeHint prh;
479
480         prh  = port_range_hints()[which];
481
482
483         if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
484                 desc.min_unbound = false;
485                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
486                         desc.lower = prh.LowerBound * _session.frame_rate();
487                 } else {
488                         desc.lower = prh.LowerBound;
489                 }
490         } else {
491                 desc.min_unbound = true;
492                 desc.lower = 0;
493         }
494
495
496         if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
497                 desc.max_unbound = false;
498                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
499                         desc.upper = prh.UpperBound * _session.frame_rate();
500                 } else {
501                         desc.upper = prh.UpperBound;
502                 }
503         } else {
504                 desc.max_unbound = true;
505                 desc.upper = 4; /* completely arbitrary */
506         }
507
508         if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
509                 desc.step = 1.0;
510                 desc.smallstep = 0.1;
511                 desc.largestep = 10.0;
512         } else {
513                 float delta = desc.upper - desc.lower;
514                 desc.step = delta / 1000.0f;
515                 desc.smallstep = delta / 10000.0f;
516                 desc.largestep = delta/10.0f;
517         }
518
519         desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
520         desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
521         desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
522         desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
523
524         desc.label = port_names()[which];
525
526         return 0;
527 }
528
529 string
530 LadspaPlugin::describe_parameter (Evoral::Parameter which)
531 {
532         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
533                 return port_names()[which.id()];
534         } else {
535                 return "??";
536         }
537 }
538
539 ARDOUR::framecnt_t
540 LadspaPlugin::signal_latency () const
541 {
542         if (_user_latency) {
543                 return _user_latency;
544         }
545
546         if (_latency_control_port) {
547                 return (framecnt_t) floor (*_latency_control_port);
548         } else {
549                 return 0;
550         }
551 }
552
553 set<Evoral::Parameter>
554 LadspaPlugin::automatable () const
555 {
556         set<Evoral::Parameter> ret;
557
558         for (uint32_t i = 0; i < parameter_count(); ++i){
559                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
560                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
561
562                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
563                 }
564         }
565
566         return ret;
567 }
568
569 int
570 LadspaPlugin::connect_and_run (BufferSet& bufs,
571                 ChanMapping in_map, ChanMapping out_map,
572                 pframes_t nframes, framecnt_t offset)
573 {
574         cycles_t now;
575         cycles_t then = get_cycles ();
576
577         uint32_t audio_in_index  = 0;
578         uint32_t audio_out_index = 0;
579         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
580                 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
581                         if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
582                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
583                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
584                         } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
585                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
586                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
587                         }
588                 }
589         }
590
591         run_in_place (nframes);
592         now = get_cycles ();
593         set_cycles ((uint32_t) (now - then));
594
595         return 0;
596 }
597
598 bool
599 LadspaPlugin::parameter_is_control (uint32_t param) const
600 {
601         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
602 }
603
604 bool
605 LadspaPlugin::parameter_is_audio (uint32_t param) const
606 {
607         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
608 }
609
610 bool
611 LadspaPlugin::parameter_is_output (uint32_t param) const
612 {
613         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
614 }
615
616 bool
617 LadspaPlugin::parameter_is_input (uint32_t param) const
618 {
619         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
620 }
621
622 void
623 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
624 {
625         if (buf && len) {
626                 if (param < parameter_count()) {
627                         snprintf (buf, len, "%.3f", get_parameter (param));
628                 } else {
629                         strcat (buf, "0");
630                 }
631         }
632 }
633
634 void
635 LadspaPlugin::run_in_place (pframes_t nframes)
636 {
637         for (uint32_t i = 0; i < parameter_count(); ++i) {
638                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
639                         _control_data[i] = _shadow_data[i];
640                 }
641         }
642
643         assert (_was_activated);
644         
645         _descriptor->run (_handle, nframes);
646 }
647
648 void
649 LadspaPlugin::latency_compute_run ()
650 {
651         if (!_latency_control_port) {
652                 return;
653         }
654
655         /* we need to run the plugin so that it can set its latency
656            parameter.
657         */
658
659         activate ();
660
661         uint32_t port_index = 0;
662         uint32_t in_index = 0;
663         uint32_t out_index = 0;
664         const framecnt_t bufsize = 1024;
665         LADSPA_Data buffer[bufsize];
666
667         memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
668
669         /* Note that we've already required that plugins
670            be able to handle in-place processing.
671         */
672
673         port_index = 0;
674
675         while (port_index < parameter_count()) {
676                 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
677                         if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
678                                 connect_port (port_index, buffer);
679                                 in_index++;
680                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
681                                 connect_port (port_index, buffer);
682                                 out_index++;
683                         }
684                 }
685                 port_index++;
686         }
687
688         run_in_place (bufsize);
689         deactivate ();
690 }
691
692 PluginPtr
693 LadspaPluginInfo::load (Session& session)
694 {
695         try {
696                 PluginPtr plugin;
697                 void *module;
698
699                 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
700                         error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
701                         error << dlerror() << endmsg;
702                         return PluginPtr ((Plugin*) 0);
703                 } else {
704                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
705                 }
706
707                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
708                 return plugin;
709         }
710
711         catch (failed_constructor &err) {
712                 return PluginPtr ((Plugin*) 0);
713         }
714 }
715
716 LadspaPluginInfo::LadspaPluginInfo()
717 {
718        type = ARDOUR::LADSPA;
719 }