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