add "custom" meter option which is the only option where the meter processor is visib...
[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         if (node.name() != state_node_name()) {
397                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
398                 return -1;
399         }
400
401         nodes = node.children ("Port");
402
403         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
404
405                 child = *iter;
406
407                 if ((prop = child->property("number")) != 0) {
408                         port = prop->value().c_str();
409                 } else {
410                         warning << _("LADSPA: no ladspa port number") << endmsg;
411                         continue;
412                 }
413                 if ((prop = child->property("value")) != 0) {
414                         data = prop->value().c_str();
415                 } else {
416                         warning << _("LADSPA: no ladspa port data") << endmsg;
417                         continue;
418                 }
419
420                 sscanf (port, "%" PRIu32, &port_id);
421                 set_parameter (port_id, atof(data));
422         }
423
424         latency_compute_run ();
425
426         return 0;
427 }
428
429 int
430 LadspaPlugin::set_state_2X (const XMLNode& node, int version)
431 {
432         XMLNodeList nodes;
433         XMLProperty *prop;
434         XMLNodeConstIterator iter;
435         XMLNode *child;
436         const char *port;
437         const char *data;
438         uint32_t port_id;
439         LocaleGuard lg (X_("POSIX"));
440
441         if (node.name() != state_node_name()) {
442                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
443                 return -1;
444         }
445
446         nodes = node.children ("port");
447
448         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
449
450                 child = *iter;
451
452                 if ((prop = child->property("number")) != 0) {
453                         port = prop->value().c_str();
454                 } else {
455                         warning << _("LADSPA: no ladspa port number") << endmsg;
456                         continue;
457                 }
458                 if ((prop = child->property("value")) != 0) {
459                         data = prop->value().c_str();
460                 } else {
461                         warning << _("LADSPA: no ladspa port data") << endmsg;
462                         continue;
463                 }
464
465                 sscanf (port, "%" PRIu32, &port_id);
466                 set_parameter (port_id, atof(data));
467         }
468
469         latency_compute_run ();
470
471         return 0;
472 }
473
474 int
475 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
476 {
477         LADSPA_PortRangeHint prh;
478
479         prh  = port_range_hints()[which];
480
481
482         if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
483                 desc.min_unbound = false;
484                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
485                         desc.lower = prh.LowerBound * _session.frame_rate();
486                 } else {
487                         desc.lower = prh.LowerBound;
488                 }
489         } else {
490                 desc.min_unbound = true;
491                 desc.lower = 0;
492         }
493
494
495         if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
496                 desc.max_unbound = false;
497                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
498                         desc.upper = prh.UpperBound * _session.frame_rate();
499                 } else {
500                         desc.upper = prh.UpperBound;
501                 }
502         } else {
503                 desc.max_unbound = true;
504                 desc.upper = 4; /* completely arbitrary */
505         }
506
507         if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
508                 desc.step = 1.0;
509                 desc.smallstep = 0.1;
510                 desc.largestep = 10.0;
511         } else {
512                 float delta = desc.upper - desc.lower;
513                 desc.step = delta / 1000.0f;
514                 desc.smallstep = delta / 10000.0f;
515                 desc.largestep = delta/10.0f;
516         }
517
518         desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
519         desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
520         desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
521         desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
522
523         desc.label = port_names()[which];
524
525         return 0;
526 }
527
528 string
529 LadspaPlugin::describe_parameter (Evoral::Parameter which)
530 {
531         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
532                 return port_names()[which.id()];
533         } else {
534                 return "??";
535         }
536 }
537
538 ARDOUR::nframes_t
539 LadspaPlugin::signal_latency () const
540 {
541         if (_user_latency) {
542                 return _user_latency;
543         }
544
545         if (_latency_control_port) {
546                 return (nframes_t) floor (*_latency_control_port);
547         } else {
548                 return 0;
549         }
550 }
551
552 set<Evoral::Parameter>
553 LadspaPlugin::automatable () const
554 {
555         set<Evoral::Parameter> ret;
556
557         for (uint32_t i = 0; i < parameter_count(); ++i){
558                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
559                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
560
561                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
562                 }
563         }
564
565         return ret;
566 }
567
568 int
569 LadspaPlugin::connect_and_run (BufferSet& bufs,
570                 ChanMapping in_map, ChanMapping out_map,
571                 nframes_t nframes, nframes_t offset)
572 {
573         cycles_t now;
574         cycles_t then = get_cycles ();
575
576         uint32_t audio_in_index  = 0;
577         uint32_t audio_out_index = 0;
578         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
579                 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
580                         if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
581                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
582                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
583                         } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
584                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
585                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
586                         }
587                 }
588         }
589
590         run_in_place (nframes);
591         now = get_cycles ();
592         set_cycles ((uint32_t) (now - then));
593
594         return 0;
595 }
596
597 bool
598 LadspaPlugin::parameter_is_control (uint32_t param) const
599 {
600         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
601 }
602
603 bool
604 LadspaPlugin::parameter_is_audio (uint32_t param) const
605 {
606         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
607 }
608
609 bool
610 LadspaPlugin::parameter_is_output (uint32_t param) const
611 {
612         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
613 }
614
615 bool
616 LadspaPlugin::parameter_is_input (uint32_t param) const
617 {
618         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
619 }
620
621 void
622 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
623 {
624         if (buf && len) {
625                 if (param < parameter_count()) {
626                         snprintf (buf, len, "%.3f", get_parameter (param));
627                 } else {
628                         strcat (buf, "0");
629                 }
630         }
631 }
632
633 void
634 LadspaPlugin::run_in_place (nframes_t nframes)
635 {
636         for (uint32_t i = 0; i < parameter_count(); ++i) {
637                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
638                         _control_data[i] = _shadow_data[i];
639                 }
640         }
641         _descriptor->run (_handle, nframes);
642 }
643
644 void
645 LadspaPlugin::latency_compute_run ()
646 {
647         if (!_latency_control_port) {
648                 return;
649         }
650
651         /* we need to run the plugin so that it can set its latency
652            parameter.
653         */
654
655         activate ();
656
657         uint32_t port_index = 0;
658         uint32_t in_index = 0;
659         uint32_t out_index = 0;
660         const nframes_t bufsize = 1024;
661         LADSPA_Data buffer[bufsize];
662
663         memset(buffer,0,sizeof(LADSPA_Data)*bufsize);
664
665         /* Note that we've already required that plugins
666            be able to handle in-place processing.
667         */
668
669         port_index = 0;
670
671         while (port_index < parameter_count()) {
672                 if (LADSPA_IS_PORT_AUDIO (port_descriptor (port_index))) {
673                         if (LADSPA_IS_PORT_INPUT (port_descriptor (port_index))) {
674                                 connect_port (port_index, buffer);
675                                 in_index++;
676                         } else if (LADSPA_IS_PORT_OUTPUT (port_descriptor (port_index))) {
677                                 connect_port (port_index, buffer);
678                                 out_index++;
679                         }
680                 }
681                 port_index++;
682         }
683
684         run_in_place (bufsize);
685         deactivate ();
686 }
687
688 PluginPtr
689 LadspaPluginInfo::load (Session& session)
690 {
691         try {
692                 PluginPtr plugin;
693                 void *module;
694
695                 if ((module = dlopen (path.c_str(), RTLD_NOW)) == 0) {
696                         error << string_compose(_("LADSPA: cannot load module from \"%1\""), path) << endmsg;
697                         error << dlerror() << endmsg;
698                 } else {
699                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
700                 }
701
702                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
703                 return plugin;
704         }
705
706         catch (failed_constructor &err) {
707                 return PluginPtr ((Plugin*) 0);
708         }
709 }