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