Remove all use of nframes_t.
[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 int
376 LadspaPlugin::set_state (const XMLNode& node, int version)
377 {
378         if (version < 3000) {
379                 return set_state_2X (node, version);
380         }
381         
382         XMLNodeList nodes;
383         XMLProperty *prop;
384         XMLNodeConstIterator iter;
385         XMLNode *child;
386         const char *port;
387         const char *data;
388         uint32_t port_id;
389         LocaleGuard lg (X_("POSIX"));
390
391         if (node.name() != state_node_name()) {
392                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
393                 return -1;
394         }
395
396         nodes = node.children ("Port");
397
398         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
399
400                 child = *iter;
401
402                 if ((prop = child->property("number")) != 0) {
403                         port = prop->value().c_str();
404                 } else {
405                         warning << _("LADSPA: no ladspa port number") << endmsg;
406                         continue;
407                 }
408                 if ((prop = child->property("value")) != 0) {
409                         data = prop->value().c_str();
410                 } else {
411                         warning << _("LADSPA: no ladspa port data") << endmsg;
412                         continue;
413                 }
414
415                 sscanf (port, "%" PRIu32, &port_id);
416                 set_parameter (port_id, atof(data));
417         }
418
419         latency_compute_run ();
420
421         return 0;
422 }
423
424 int
425 LadspaPlugin::set_state_2X (const XMLNode& node, int /* version */)
426 {
427         XMLNodeList nodes;
428         XMLProperty *prop;
429         XMLNodeConstIterator iter;
430         XMLNode *child;
431         const char *port;
432         const char *data;
433         uint32_t port_id;
434         LocaleGuard lg (X_("POSIX"));
435
436         if (node.name() != state_node_name()) {
437                 error << _("Bad node sent to LadspaPlugin::set_state") << endmsg;
438                 return -1;
439         }
440
441         nodes = node.children ("port");
442
443         for(iter = nodes.begin(); iter != nodes.end(); ++iter){
444
445                 child = *iter;
446
447                 if ((prop = child->property("number")) != 0) {
448                         port = prop->value().c_str();
449                 } else {
450                         warning << _("LADSPA: no ladspa port number") << endmsg;
451                         continue;
452                 }
453                 if ((prop = child->property("value")) != 0) {
454                         data = prop->value().c_str();
455                 } else {
456                         warning << _("LADSPA: no ladspa port data") << endmsg;
457                         continue;
458                 }
459
460                 sscanf (port, "%" PRIu32, &port_id);
461                 set_parameter (port_id, atof(data));
462         }
463
464         latency_compute_run ();
465
466         return 0;
467 }
468
469 int
470 LadspaPlugin::get_parameter_descriptor (uint32_t which, ParameterDescriptor& desc) const
471 {
472         LADSPA_PortRangeHint prh;
473
474         prh  = port_range_hints()[which];
475
476
477         if (LADSPA_IS_HINT_BOUNDED_BELOW(prh.HintDescriptor)) {
478                 desc.min_unbound = false;
479                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
480                         desc.lower = prh.LowerBound * _session.frame_rate();
481                 } else {
482                         desc.lower = prh.LowerBound;
483                 }
484         } else {
485                 desc.min_unbound = true;
486                 desc.lower = 0;
487         }
488
489
490         if (LADSPA_IS_HINT_BOUNDED_ABOVE(prh.HintDescriptor)) {
491                 desc.max_unbound = false;
492                 if (LADSPA_IS_HINT_SAMPLE_RATE(prh.HintDescriptor)) {
493                         desc.upper = prh.UpperBound * _session.frame_rate();
494                 } else {
495                         desc.upper = prh.UpperBound;
496                 }
497         } else {
498                 desc.max_unbound = true;
499                 desc.upper = 4; /* completely arbitrary */
500         }
501
502         if (LADSPA_IS_HINT_INTEGER (prh.HintDescriptor)) {
503                 desc.step = 1.0;
504                 desc.smallstep = 0.1;
505                 desc.largestep = 10.0;
506         } else {
507                 float delta = desc.upper - desc.lower;
508                 desc.step = delta / 1000.0f;
509                 desc.smallstep = delta / 10000.0f;
510                 desc.largestep = delta/10.0f;
511         }
512
513         desc.toggled = LADSPA_IS_HINT_TOGGLED (prh.HintDescriptor);
514         desc.logarithmic = LADSPA_IS_HINT_LOGARITHMIC (prh.HintDescriptor);
515         desc.sr_dependent = LADSPA_IS_HINT_SAMPLE_RATE (prh.HintDescriptor);
516         desc.integer_step = LADSPA_IS_HINT_INTEGER (prh.HintDescriptor);
517
518         desc.label = port_names()[which];
519
520         return 0;
521 }
522
523 string
524 LadspaPlugin::describe_parameter (Evoral::Parameter which)
525 {
526         if (which.type() == PluginAutomation && which.id() < parameter_count()) {
527                 return port_names()[which.id()];
528         } else {
529                 return "??";
530         }
531 }
532
533 ARDOUR::framecnt_t
534 LadspaPlugin::signal_latency () const
535 {
536         if (_user_latency) {
537                 return _user_latency;
538         }
539
540         if (_latency_control_port) {
541                 return (framecnt_t) floor (*_latency_control_port);
542         } else {
543                 return 0;
544         }
545 }
546
547 set<Evoral::Parameter>
548 LadspaPlugin::automatable () const
549 {
550         set<Evoral::Parameter> ret;
551
552         for (uint32_t i = 0; i < parameter_count(); ++i){
553                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) &&
554                     LADSPA_IS_PORT_CONTROL(port_descriptor (i))){
555
556                         ret.insert (ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
557                 }
558         }
559
560         return ret;
561 }
562
563 int
564 LadspaPlugin::connect_and_run (BufferSet& bufs,
565                 ChanMapping in_map, ChanMapping out_map,
566                 pframes_t nframes, framecnt_t offset)
567 {
568         cycles_t now;
569         cycles_t then = get_cycles ();
570
571         uint32_t audio_in_index  = 0;
572         uint32_t audio_out_index = 0;
573         for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
574                 if (LADSPA_IS_PORT_AUDIO(port_descriptor(port_index))) {
575                         if (LADSPA_IS_PORT_INPUT(port_descriptor(port_index))) {
576                                 const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
577                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
578                         } else if (LADSPA_IS_PORT_OUTPUT(port_descriptor(port_index))) {
579                                 const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
580                                 connect_port(port_index, bufs.get_audio(buf_index).data(offset));
581                         }
582                 }
583         }
584
585         run_in_place (nframes);
586         now = get_cycles ();
587         set_cycles ((uint32_t) (now - then));
588
589         return 0;
590 }
591
592 bool
593 LadspaPlugin::parameter_is_control (uint32_t param) const
594 {
595         return LADSPA_IS_PORT_CONTROL(port_descriptor (param));
596 }
597
598 bool
599 LadspaPlugin::parameter_is_audio (uint32_t param) const
600 {
601         return LADSPA_IS_PORT_AUDIO(port_descriptor (param));
602 }
603
604 bool
605 LadspaPlugin::parameter_is_output (uint32_t param) const
606 {
607         return LADSPA_IS_PORT_OUTPUT(port_descriptor (param));
608 }
609
610 bool
611 LadspaPlugin::parameter_is_input (uint32_t param) const
612 {
613         return LADSPA_IS_PORT_INPUT(port_descriptor (param));
614 }
615
616 void
617 LadspaPlugin::print_parameter (uint32_t param, char *buf, uint32_t len) const
618 {
619         if (buf && len) {
620                 if (param < parameter_count()) {
621                         snprintf (buf, len, "%.3f", get_parameter (param));
622                 } else {
623                         strcat (buf, "0");
624                 }
625         }
626 }
627
628 void
629 LadspaPlugin::run_in_place (pframes_t nframes)
630 {
631         for (uint32_t i = 0; i < parameter_count(); ++i) {
632                 if (LADSPA_IS_PORT_INPUT(port_descriptor (i)) && LADSPA_IS_PORT_CONTROL(port_descriptor (i))) {
633                         _control_data[i] = _shadow_data[i];
634                 }
635         }
636
637         assert (_was_activated);
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 framecnt_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                         return PluginPtr ((Plugin*) 0);
697                 } else {
698                         plugin.reset (new LadspaPlugin (module, session.engine(), session, index, session.frame_rate()));
699                 }
700
701                 plugin->set_info(PluginInfoPtr(new LadspaPluginInfo(*this)));
702                 return plugin;
703         }
704
705         catch (failed_constructor &err) {
706                 return PluginPtr ((Plugin*) 0);
707         }
708 }
709
710 LadspaPluginInfo::LadspaPluginInfo()
711 {
712        type = ARDOUR::LADSPA;
713 }