Merge some cases to avoid duplicated logic
[ardour.git] / libs / ardour / luaproc.cc
1 /*
2     Copyright (C) 2016 Robin Gareus <robin@gareus.org>
3     Copyright (C) 2006 Paul Davis
4
5     This program is free software; you can redistribute it and/or modify it
6     under the terms of the GNU General Public License as published by the Free
7     Software Foundation; either version 2 of the License, or (at your option)
8     any later version.
9
10     This program is distributed in the hope that it will be useful, but WITHOUT
11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13     for more details.
14
15     You should have received a copy of the GNU General Public License along
16     with this program; if not, write to the Free Software Foundation, Inc.,
17     675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include <glib.h>
21 #include <glibmm/miscutils.h>
22 #include <glibmm/fileutils.h>
23
24 #include "pbd/gstdio_compat.h"
25 #include "pbd/locale_guard.h"
26 #include "pbd/pthread_utils.h"
27
28 #include "ardour/audio_buffer.h"
29 #include "ardour/buffer_set.h"
30 #include "ardour/filesystem_paths.h"
31 #include "ardour/luabindings.h"
32 #include "ardour/luaproc.h"
33 #include "ardour/luascripting.h"
34 #include "ardour/midi_buffer.h"
35 #include "ardour/plugin.h"
36 #include "ardour/session.h"
37
38 #include "LuaBridge/LuaBridge.h"
39
40 #include "pbd/i18n.h"
41
42 using namespace ARDOUR;
43 using namespace PBD;
44
45 LuaProc::LuaProc (AudioEngine& engine,
46                   Session& session,
47                   const std::string &script)
48         : Plugin (engine, session)
49         , _mempool ("LuaProc", 2097152)
50 #ifdef USE_TLSF
51         , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
52 #elif defined USE_MALLOC
53         , lua ()
54 #else
55         , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
56 #endif
57         , _lua_dsp (0)
58         , _script (script)
59         , _lua_does_channelmapping (false)
60         , _lua_has_inline_display (false)
61         , _designated_bypass_port (UINT32_MAX)
62         , _control_data (0)
63         , _shadow_data (0)
64         , _has_midi_input (false)
65         , _has_midi_output (false)
66 {
67         init ();
68
69         /* when loading a session, or pasing a processor,
70          * the script is set during set_state();
71          */
72         if (!_script.empty () && load_script ()) {
73                 throw failed_constructor ();
74         }
75 }
76
77 LuaProc::LuaProc (const LuaProc &other)
78         : Plugin (other)
79         , _mempool ("LuaProc", 2097152)
80 #ifdef USE_TLSF
81         , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
82 #elif defined USE_MALLOC
83         , lua ()
84 #else
85         , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
86 #endif
87         , _lua_dsp (0)
88         , _script (other.script ())
89         , _lua_does_channelmapping (false)
90         , _lua_has_inline_display (false)
91         , _designated_bypass_port (UINT32_MAX)
92         , _control_data (0)
93         , _shadow_data (0)
94         , _has_midi_input (false)
95         , _has_midi_output (false)
96 {
97         init ();
98
99         if (load_script ()) {
100                 throw failed_constructor ();
101         }
102
103         for (uint32_t i = 0; i < parameter_count (); ++i) {
104                 _control_data[i] = other._shadow_data[i];
105                 _shadow_data[i]  = other._shadow_data[i];
106         }
107 }
108
109 LuaProc::~LuaProc () {
110 #ifdef WITH_LUAPROC_STATS
111         if (_info && _stats_cnt > 0) {
112                 printf ("LuaProc: '%s' run()  avg: %.3f  max: %.3f [ms]\n",
113                                 _info->name.c_str (),
114                                 0.0001f * _stats_avg[0] / (float) _stats_cnt,
115                                 0.0001f * _stats_max[0]);
116                 printf ("LuaProc: '%s' gc()   avg: %.3f  max: %.3f [ms]\n",
117                                 _info->name.c_str (),
118                                 0.0001f * _stats_avg[1] / (float) _stats_cnt,
119                                 0.0001f * _stats_max[1]);
120         }
121 #endif
122         lua.do_command ("collectgarbage();");
123         delete (_lua_dsp);
124         delete [] _control_data;
125         delete [] _shadow_data;
126 }
127
128 void
129 LuaProc::init ()
130 {
131 #ifdef WITH_LUAPROC_STATS
132         _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
133 #endif
134
135         lua.tweak_rt_gc ();
136         lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
137         // register session object
138         lua_State* L = lua.getState ();
139         LuaBindings::stddef (L);
140         LuaBindings::common (L);
141         LuaBindings::dsp (L);
142
143         luabridge::getGlobalNamespace (L)
144                 .beginNamespace ("Ardour")
145                 .beginClass <LuaProc> ("LuaProc")
146                 .addFunction ("queue_draw", &LuaProc::queue_draw)
147                 .addFunction ("shmem", &LuaProc::instance_shm)
148                 .addFunction ("table", &LuaProc::instance_ref)
149                 .endClass ()
150                 .endNamespace ();
151
152         // add session to global lua namespace
153         luabridge::push <Session *> (L, &_session);
154         lua_setglobal (L, "Session");
155
156         // instance
157         luabridge::push <LuaProc *> (L, this);
158         lua_setglobal (L, "self");
159
160         // sandbox
161         lua.do_command ("io = nil os = nil loadfile = nil require = nil dofile = nil package = nil debug = nil");
162 #if 0
163         lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
164 #endif
165         lua.do_command ("function ardour () end");
166 }
167
168 void
169 LuaProc::lua_print (std::string s) {
170         std::cout <<"LuaProc: " << s << "\n";
171         PBD::error << "LuaProc: " << s << "\n";
172 }
173
174 bool
175 LuaProc::load_script ()
176 {
177         assert (!_lua_dsp); // don't allow to re-initialize
178         LuaPluginInfoPtr lpi;
179
180         // TODO: refine APIs; function arguments..
181         // - perform channel-map in ardour (silent/scratch buffers) ?
182         // - control-port API (explicit get/set functions ??)
183         // - latency reporting (global var? ctrl-port? set-function ?)
184         // - MIDI -> sparse table of events
185         //     { [sample] => { Event }, .. }
186         //   or  { { sample, Event }, .. }
187
188         try {
189                 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
190                 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
191                 assert (lpi);
192                 set_info (lpi);
193                 _mempool.set_name ("LuaProc: " + lsi->name);
194                 _docs = lsi->description;
195         } catch (failed_constructor& err) {
196                 return true;
197         }
198
199         lua_State* L = lua.getState ();
200         lua.do_command (_script);
201
202         // check if script has a DSP callback
203         luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
204         luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
205
206         if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
207                 return true;
208         }
209
210         if (lua_dsp_run.type () == LUA_TFUNCTION) {
211                 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
212         }
213         else if (lua_dsp_map.type () == LUA_TFUNCTION) {
214                 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
215                 _lua_does_channelmapping = true;
216         }
217         else {
218                 assert (0);
219         }
220
221         // initialize the DSP if needed
222         luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
223         if (lua_dsp_init.type () == LUA_TFUNCTION) {
224                 try {
225                         lua_dsp_init (_session.nominal_frame_rate ());
226                 } catch (luabridge::LuaException const& e) {
227                         ;
228                 }
229         }
230
231         // query midi i/o
232         luabridge::LuaRef lua_dsp_has_midi_in = luabridge::getGlobal (L, "dsp_has_midi_input");
233         if (lua_dsp_has_midi_in.type () == LUA_TFUNCTION) {
234                 try {
235                         _has_midi_input = lua_dsp_has_midi_in ();
236                 } catch (luabridge::LuaException const& e) {
237                         ;
238                 }
239         }
240
241         luabridge::LuaRef lua_dsp_has_midi_out = luabridge::getGlobal (L, "dsp_has_midi_output");
242         if (lua_dsp_has_midi_out.type () == LUA_TFUNCTION) {
243                 try {
244                         _has_midi_output = lua_dsp_has_midi_out ();
245                 } catch (luabridge::LuaException const& e) {
246                         ;
247                 }
248         }
249
250         _ctrl_params.clear ();
251
252         luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
253         if (lua_render.isFunction ()) {
254                 _lua_has_inline_display = true;
255         }
256
257         luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
258         if (lua_params.isFunction ()) {
259
260                 // call function // add try {} catch (luabridge::LuaException const& e)
261                 luabridge::LuaRef params = lua_params ();
262
263                 if (params.isTable ()) {
264
265                         for (luabridge::Iterator i (params); !i.isNil (); ++i) {
266                                 // required fields
267                                 if (!i.key ().isNumber ())           { return false; }
268                                 if (!i.value ().isTable ())          { return false; }
269                                 if (!i.value ()["type"].isString ()) { return false; }
270                                 if (!i.value ()["name"].isString ()) { return false; }
271                                 if (!i.value ()["min"].isNumber ())  { return false; }
272                                 if (!i.value ()["max"].isNumber ())  { return false; }
273
274                                 int pn = i.key ().cast<int> ();
275                                 std::string type = i.value ()["type"].cast<std::string> ();
276                                 if (type == "input") {
277                                         if (!i.value ()["default"].isNumber ()) { return false; }
278                                         _ctrl_params.push_back (std::make_pair (false, pn));
279                                 }
280                                 else if (type == "output") {
281                                         _ctrl_params.push_back (std::make_pair (true, pn));
282                                 } else {
283                                         return false;
284                                 }
285                                 assert (pn == (int) _ctrl_params.size ());
286
287                                 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
288                                 luabridge::LuaRef lr = i.value ();
289
290                                 if (type == "input") {
291                                         _param_desc[pn].normal     = lr["default"].cast<float> ();
292                                 } else {
293                                         _param_desc[pn].normal     = lr["min"].cast<float> (); // output-port, no default
294                                 }
295                                 _param_desc[pn].lower        = lr["min"].cast<float> ();
296                                 _param_desc[pn].upper        = lr["max"].cast<float> ();
297                                 _param_desc[pn].toggled      = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
298                                 _param_desc[pn].logarithmic  = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
299                                 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
300                                 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
301                                 _param_desc[pn].enumeration  = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
302
303                                 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
304                                         _designated_bypass_port = pn - 1; // lua table starts at 1.
305                                 }
306
307                                 if (lr["unit"].isString ()) {
308                                         std::string unit = lr["unit"].cast<std::string> ();
309                                         if (unit == "dB")             { _param_desc[pn].unit = ParameterDescriptor::DB; }
310                                         else if (unit == "Hz")        { _param_desc[pn].unit = ParameterDescriptor::HZ; }
311                                         else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
312                                 }
313                                 _param_desc[pn].label        = (lr["name"]).cast<std::string> ();
314                                 _param_desc[pn].scale_points = parse_scale_points (&lr);
315
316                                 luabridge::LuaRef doc = lr["doc"];
317                                 if (doc.isString ()) {
318                                         _param_doc[pn] = doc.cast<std::string> ();
319                                 } else {
320                                         _param_doc[pn] = "";
321                                 }
322                                 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
323                         }
324                 }
325         }
326
327         _control_data = new float[parameter_count ()];
328         _shadow_data  = new float[parameter_count ()];
329
330         for (uint32_t i = 0; i < parameter_count (); ++i) {
331                 if (parameter_is_input (i)) {
332                         _control_data[i] = _shadow_data[i] = default_value (i);
333                 }
334         }
335
336         // expose ctrl-ports to global lua namespace
337         luabridge::push <float *> (L, _control_data);
338         lua_setglobal (L, "CtrlPorts");
339
340         return false; // no error
341 }
342
343 bool
344 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
345 {
346         // caller must hold process lock (no concurrent calls to interpreter
347         _output_configs.clear ();
348
349         lua_State* L = lua.getState ();
350         luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
351         if (!ioconfig.isFunction ()) {
352                 return false;
353         }
354
355         luabridge::LuaRef *_iotable = NULL; // can't use reference :(
356         try {
357                 luabridge::LuaRef iotable = ioconfig ();
358                 if (iotable.isTable ()) {
359                         _iotable = new luabridge::LuaRef (iotable);
360                 }
361         } catch (luabridge::LuaException const& e) {
362                 return false;
363         }
364
365         if (!_iotable) {
366                 return false;
367         }
368
369         // now we can reference it.
370         luabridge::LuaRef iotable (*_iotable);
371         delete _iotable;
372
373         if ((iotable).length () < 1) {
374                 return false;
375         }
376
377         const int audio_in = in.n_audio ();
378         const int midi_in = in.n_midi ();
379
380         // preferred setting (provided by plugin_insert)
381         const int preferred_out = out.n_audio ();
382
383         int midi_out = _has_midi_output ? 1 : 0;
384         int audio_out = -1;
385         float penalty = 9999;
386         bool found = false;
387
388 #define FOUNDCFG(nch) {                            \
389   float p = fabsf ((float)(nch) - preferred_out);  \
390   _output_configs.insert (nch);                    \
391   if ((nch) > preferred_out) { p *= 1.1; }         \
392   if (p < penalty) {                               \
393     audio_out = (nch);                             \
394     penalty = p;                                   \
395     found = true;                                  \
396   }                                                \
397 }
398
399 #define ANYTHINGGOES                               \
400   _output_configs.insert (0);
401
402 #define UPTO(nch) {                                \
403   for (int n = 1; n < nch; ++n) {                  \
404     _output_configs.insert (n);                    \
405   }                                                \
406 }
407
408         for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
409                 luabridge::LuaRef io (i.value ());
410                 if (!io.isTable()) {
411                         continue;
412                 }
413
414                 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
415                 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
416                 int possible_midiin = _has_midi_input ? 1 : 0;
417
418                 if (midi_in > 0 && possible_midiin == 0 && !imprecise) {
419                         continue;
420                 }
421
422                 // exact match
423                 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
424                         _output_configs.insert (preferred_out);
425                         audio_out = preferred_out;
426                         /* Set penalty so low that this output configuration
427                          * will trump any other one */
428                         penalty = -1;
429                         found = true;
430                 }
431
432                 // "imprecise" matches
433                 if (possible_out == 0) {
434                         if (possible_in == 0) {
435                                 if (_has_midi_output && audio_in == 0) {
436                                         // special case midi filters & generators
437                                         audio_out = 0;
438                                         found = true;
439                                         break;
440                                 }
441                         }
442                         continue;
443                 }
444
445                 if (possible_in == 0) {
446                         /* no inputs, generators & instruments */
447                         if (possible_out == -1 || possible_out == -2) {
448                                 /* any output configuration possible
449                                  * out == -2 is invalid, interpreted as out == -1 */
450                                 FOUNDCFG (preferred_out);
451                                 ANYTHINGGOES;
452                         } else if (possible_out < -2) {
453                                 /* variable number of outputs up to -N, */
454                                 FOUNDCFG (min (-possible_out, preferred_out));
455                                 UPTO (-possible_out);
456                         } else {
457                                 /* exact number of outputs */
458                                 FOUNDCFG (possible_out);
459                         }
460                 }
461
462                 if (possible_in == -1 || possible_in == -2) {
463                         /* wildcard for input */
464                         if (possible_out == possible_in) {
465                                 /* either both -1 or both -2 (invalid and
466                                  * interpreted as both -1): out must match in */
467                                 FOUNDCFG (audio_in);
468                         } else if (possible_out == -3 - possible_in) {
469                                 /* one is -1, the other is -2: any output configuration
470                                  * possible, pick what the insert prefers */
471                                 FOUNDCFG (preferred_out);
472                                 ANYTHINGGOES;
473                         } else if (possible_out < -2) {
474                                 /* variable number of outputs up to -N,
475                                  * invalid if in == -2 but we accept it anyway */
476                                 FOUNDCFG (min (-possible_out, preferred_out));
477                                 UPTO (-possible_out)
478                         } else {
479                                 /* exact number of outputs */
480                                 FOUNDCFG (possible_out);
481                         }
482                 }
483
484                 if (possible_in < -2 || possible_in > 0) {
485                         /* specified number, exact or up to */
486                         if (possible_in < -2 && audio_in > -possible_in && !imprecise) {
487                                 /* request is too large */
488                         } else if (possible_in > 0 && audio_in != possible_in) {
489                                 /* this configuration needed exacty possible_in inputs */
490                         } else if (possible_out == -1 || possible_out == -2) {
491                                 /* any output configuration possible
492                                  * out == -2 is invalid, interpreted as out == -1 */
493                                 FOUNDCFG (preferred_out);
494                                 ANYTHINGGOES;
495                         } else if (possible_out < -2) {
496                                 /* variable number of outputs up to -N
497                                  * not specified if in > 0, but we accept it anyway */
498                                 FOUNDCFG (min (-possible_out, preferred_out));
499                                 UPTO (-possible_out)
500                         } else {
501                                 /* exact number of outputs */
502                                 FOUNDCFG (possible_out);
503                         }
504                 }
505
506         }
507
508         if (found && imprecise) {
509                 *imprecise = in;
510         }
511
512         if (!found && imprecise) {
513                 /* try harder */
514                 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
515                         luabridge::LuaRef io (i.value ());
516                         if (!io.isTable()) {
517                                 continue;
518                         }
519
520                         int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
521                         int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
522
523                         if (possible_out == 0 && possible_in == 0 && _has_midi_output) {
524                                 assert (audio_in > 0); // no input is handled above
525                                 // TODO hide audio input from plugin
526                                 imprecise->set (DataType::AUDIO, 0);
527                                 audio_out = 0;
528                                 found = true;
529                                 continue;
530                         }
531
532                         assert (possible_in > 0); // all other cases will have been matched above
533
534                         imprecise->set (DataType::AUDIO, possible_in);
535                         if (possible_out == -1 || possible_out == -2) {
536                                 FOUNDCFG (2);
537                         } else if (possible_out < -2) {
538                                 /* explicitly variable number of outputs, pick maximum */
539                                 FOUNDCFG (min (-possible_out, preferred_out));
540                         } else {
541                                 /* exact number of outputs */
542                                 FOUNDCFG (possible_out);
543                         }
544                         // ideally we'll also find the closest, best matching
545                         // input configuration with minimal output penalty...
546                 }
547         }
548
549         if (!found) {
550                 return false;
551         }
552
553         if (imprecise) {
554                 imprecise->set (DataType::MIDI, _has_midi_input ? 1 : 0);
555                 _selected_in = *imprecise;
556         } else {
557                 _selected_in = in;
558         }
559
560         out.set (DataType::MIDI, midi_out);
561         out.set (DataType::AUDIO, audio_out);
562         _selected_out = out;
563
564         return true;
565 }
566
567 bool
568 LuaProc::configure_io (ChanCount in, ChanCount out)
569 {
570         in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
571         out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
572
573         _info->n_inputs = _selected_in;
574         _info->n_outputs = _selected_out;
575
576         // configure the DSP if needed
577         if (in != _configured_in || out != _configured_out) {
578                 lua_State* L = lua.getState ();
579                 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
580                 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
581                         try {
582                                 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
583                                 if (io.isTable ()) {
584                                         ChanCount lin (_selected_in);
585                                         ChanCount lout (_selected_out);
586
587                                         if (io["audio_in"].type() == LUA_TNUMBER) {
588                                                 const int c = io["audio_in"].cast<int> ();
589                                                 if (c >= 0) {
590                                                         lin.set (DataType::AUDIO, c);
591                                                 }
592                                         }
593                                         if (io["audio_out"].type() == LUA_TNUMBER) {
594                                                 const int c = io["audio_out"].cast<int> ();
595                                                 if (c >= 0) {
596                                                         lout.set (DataType::AUDIO, c);
597                                                 }
598                                         }
599                                         if (io["midi_in"].type() == LUA_TNUMBER) {
600                                                 const int c = io["midi_in"].cast<int> ();
601                                                 if (c >= 0) {
602                                                         lin.set (DataType::MIDI, c);
603                                                 }
604                                         }
605                                         if (io["midi_out"].type() == LUA_TNUMBER) {
606                                                 const int c = io["midi_out"].cast<int> ();
607                                                 if (c >= 0) {
608                                                         lout.set (DataType::MIDI, c);
609                                                 }
610                                         }
611                                         _info->n_inputs = lin;
612                                         _info->n_outputs = lout;
613                                 }
614                         } catch (luabridge::LuaException const& e) {
615                                 PBD::error << "LuaException: " << e.what () << "\n";
616 #ifndef NDEBUG
617                                 std::cerr << "LuaException: " << e.what () << "\n";
618 #endif
619                                 return false;
620                         }
621                 }
622         }
623
624         _configured_in = in;
625         _configured_out = out;
626
627         return true;
628 }
629
630 int
631 LuaProc::connect_and_run (BufferSet& bufs,
632                 framepos_t start, framepos_t end, double speed,
633                 ChanMapping in, ChanMapping out,
634                 pframes_t nframes, framecnt_t offset)
635 {
636         if (!_lua_dsp) {
637                 return 0;
638         }
639
640         Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
641
642         // This is needed for ARDOUR::Session requests :(
643         if (! SessionEvent::has_per_thread_pool ()) {
644                 char name[64];
645                 snprintf (name, 64, "Proc-%p", this);
646                 pthread_set_name (name);
647                 SessionEvent::create_per_thread_pool (name, 64);
648                 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
649         }
650
651         uint32_t const n = parameter_count ();
652         for (uint32_t i = 0; i < n; ++i) {
653                 if (parameter_is_control (i) && parameter_is_input (i)) {
654                         _control_data[i] = _shadow_data[i];
655                 }
656         }
657
658 #ifdef WITH_LUAPROC_STATS
659         int64_t t0 = g_get_monotonic_time ();
660 #endif
661
662         try {
663                 if (_lua_does_channelmapping) {
664                         // run the DSP function
665                         (*_lua_dsp)(&bufs, in, out, nframes, offset);
666                 } else {
667                         // map buffers
668                         BufferSet& silent_bufs  = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
669                         BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
670
671                         lua_State* L = lua.getState ();
672                         luabridge::LuaRef in_map (luabridge::newTable (L));
673                         luabridge::LuaRef out_map (luabridge::newTable (L));
674
675                         const uint32_t audio_in = _configured_in.n_audio ();
676                         const uint32_t audio_out = _configured_out.n_audio ();
677                         const uint32_t midi_in = _configured_in.n_midi ();
678
679                         for (uint32_t ap = 0; ap < audio_in; ++ap) {
680                                 bool valid;
681                                 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
682                                 if (valid) {
683                                         in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
684                                 } else {
685                                         in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
686                                 }
687                         }
688                         for (uint32_t ap = 0; ap < audio_out; ++ap) {
689                                 bool valid;
690                                 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
691                                 if (valid) {
692                                         out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
693                                 } else {
694                                         out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
695                                 }
696                         }
697
698                         luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
699                         int e = 1; // > 1 port, we merge events (unsorted)
700                         for (uint32_t mp = 0; mp < midi_in; ++mp) {
701                                 bool valid;
702                                 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
703                                 if (valid) {
704                                         for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
705                                                         m != bufs.get_midi(idx).end(); ++m, ++e) {
706                                                 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
707                                                 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
708                                                 const uint8_t* data = ev.buffer();
709                                                 for (uint32_t i = 0; i < ev.size(); ++i) {
710                                                         lua_midi_data [i + 1] = data[i];
711                                                 }
712                                                 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
713                                                 lua_midi_event["time"] = 1 + (*m).time();
714                                                 lua_midi_event["data"] = lua_midi_data;
715                                                 lua_midi_src_tbl[e] = lua_midi_event;
716                                         }
717                                 }
718                         }
719
720                         if (_has_midi_input) {
721                                 // XXX TODO This needs a better solution than global namespace
722                                 luabridge::push (L, lua_midi_src_tbl);
723                                 lua_setglobal (L, "midiin");
724                         }
725
726                         luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
727                         if (_has_midi_output) {
728                                 luabridge::push (L, lua_midi_sink_tbl);
729                                 lua_setglobal (L, "midiout");
730                         }
731
732                         // run the DSP function
733                         (*_lua_dsp)(in_map, out_map, nframes);
734
735                         // copy back midi events
736                         if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
737                                 bool valid;
738                                 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
739                                 if (valid && bufs.count().n_midi() > idx) {
740                                         MidiBuffer& mbuf = bufs.get_midi(idx);
741                                         mbuf.silence(0, 0);
742                                         for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
743                                                 if (!i.key ().isNumber ()) { continue; }
744                                                 if (!i.value ()["time"].isNumber ()) { continue; }
745                                                 if (!i.value ()["data"].isTable ()) { continue; }
746                                                 luabridge::LuaRef data_tbl (i.value ()["data"]);
747                                                 framepos_t tme = i.value ()["time"];
748                                                 if (tme < 1 || tme > nframes) { continue; }
749                                                 uint8_t data[64];
750                                                 size_t size = 0;
751                                                 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
752                                                         data[size] = di.value ();
753                                                 }
754                                                 if (size > 0 && size < 64) {
755                                                         mbuf.push_back(tme - 1, size, data);
756                                                 }
757                                         }
758
759                                 }
760                         }
761                 }
762         } catch (luabridge::LuaException const& e) {
763                 PBD::error << "LuaException: " << e.what () << "\n";
764 #ifndef NDEBUG
765                 std::cerr << "LuaException: " << e.what () << "\n";
766 #endif
767                 return -1;
768         }
769 #ifdef WITH_LUAPROC_STATS
770         int64_t t1 = g_get_monotonic_time ();
771 #endif
772
773         lua.collect_garbage_step ();
774 #ifdef WITH_LUAPROC_STATS
775         ++_stats_cnt;
776         int64_t t2 = g_get_monotonic_time ();
777         int64_t ela0 = t1 - t0;
778         int64_t ela1 = t2 - t1;
779         if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
780         if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
781         _stats_avg[0] += ela0;
782         _stats_avg[1] += ela1;
783 #endif
784         return 0;
785 }
786
787
788 void
789 LuaProc::add_state (XMLNode* root) const
790 {
791         XMLNode*    child;
792         char        buf[32];
793         LocaleGuard lg;
794
795         gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
796         std::string b64s (b64);
797         g_free (b64);
798         XMLNode* script_node = new XMLNode (X_("script"));
799         script_node->add_property (X_("lua"), LUA_VERSION);
800         script_node->add_content (b64s);
801         root->add_child_nocopy (*script_node);
802
803         for (uint32_t i = 0; i < parameter_count(); ++i) {
804                 if (parameter_is_input(i) && parameter_is_control(i)) {
805                         child = new XMLNode("Port");
806                         snprintf(buf, sizeof(buf), "%u", i);
807                         child->add_property("id", std::string(buf));
808                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
809                         child->add_property("value", std::string(buf));
810                         root->add_child_nocopy(*child);
811                 }
812         }
813 }
814
815 int
816 LuaProc::set_script_from_state (const XMLNode& node)
817 {
818         XMLNode* child;
819         if (node.name () != state_node_name ()) {
820                 return -1;
821         }
822
823         if ((child = node.child (X_("script"))) != 0) {
824                 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
825                         if (!(*n)->is_content ()) { continue; }
826                         gsize size;
827                         guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
828                         _script = std::string ((const char*)buf, size);
829                         g_free (buf);
830                         if (load_script ()) {
831                                 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
832 #ifndef NDEBUG
833                                 std::cerr << "Failed Lua Script: " << _script << std::endl;
834 #endif
835                                 _script = "";
836                         }
837                         break;
838                 }
839         }
840         if (_script.empty ()) {
841                 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
842                 return -1;
843         }
844         if (!_lua_dsp) {
845                 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
846                 return -1;
847         }
848         return 0;
849 }
850
851 int
852 LuaProc::set_state (const XMLNode& node, int version)
853 {
854 #ifndef NO_PLUGIN_STATE
855         XMLNodeList nodes;
856         XMLProperty const * prop;
857         XMLNodeConstIterator iter;
858         XMLNode *child;
859         const char *value;
860         const char *port;
861         uint32_t port_id;
862 #endif
863         LocaleGuard lg;
864
865         if (_script.empty ()) {
866                 if (set_script_from_state (node)) {
867                         return -1;
868                 }
869         }
870
871 #ifndef NO_PLUGIN_STATE
872         if (node.name() != state_node_name()) {
873                 error << _("Bad node sent to LuaProc::set_state") << endmsg;
874                 return -1;
875         }
876
877         nodes = node.children ("Port");
878         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
879                 child = *iter;
880                 if ((prop = child->property("id")) != 0) {
881                         port = prop->value().c_str();
882                 } else {
883                         warning << _("LuaProc: port has no symbol, ignored") << endmsg;
884                         continue;
885                 }
886                 if ((prop = child->property("value")) != 0) {
887                         value = prop->value().c_str();
888                 } else {
889                         warning << _("LuaProc: port has no value, ignored") << endmsg;
890                         continue;
891                 }
892                 sscanf (port, "%" PRIu32, &port_id);
893                 set_parameter (port_id, atof(value));
894         }
895 #endif
896
897         return Plugin::set_state (node, version);
898 }
899
900 uint32_t
901 LuaProc::parameter_count () const
902 {
903         return _ctrl_params.size ();
904 }
905
906 float
907 LuaProc::default_value (uint32_t port)
908 {
909         if (_ctrl_params[port].first) {
910                 assert (0);
911                 return 0;
912         }
913         int lp = _ctrl_params[port].second;
914         return _param_desc[lp].normal;
915 }
916
917 void
918 LuaProc::set_parameter (uint32_t port, float val)
919 {
920         assert (port < parameter_count ());
921         if (get_parameter (port) == val) {
922                 return;
923         }
924         _shadow_data[port] = val;
925         Plugin::set_parameter (port, val);
926 }
927
928 float
929 LuaProc::get_parameter (uint32_t port) const
930 {
931         if (parameter_is_input (port)) {
932                 return _shadow_data[port];
933         } else {
934                 return _control_data[port];
935         }
936 }
937
938 int
939 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
940 {
941         assert (port <= parameter_count ());
942         int lp = _ctrl_params[port].second;
943         const ParameterDescriptor& d (_param_desc.find(lp)->second);
944
945         desc.lower        = d.lower;
946         desc.upper        = d.upper;
947         desc.normal       = d.normal;
948         desc.toggled      = d.toggled;
949         desc.logarithmic  = d.logarithmic;
950         desc.integer_step = d.integer_step;
951         desc.sr_dependent = d.sr_dependent;
952         desc.enumeration  = d.enumeration;
953         desc.unit         = d.unit;
954         desc.label        = d.label;
955         desc.scale_points = d.scale_points;
956
957         desc.update_steps ();
958         return 0;
959 }
960
961 std::string
962 LuaProc::get_parameter_docs (uint32_t port) const {
963         assert (port <= parameter_count ());
964         int lp = _ctrl_params[port].second;
965         return _param_doc.find(lp)->second;
966 }
967
968 uint32_t
969 LuaProc::nth_parameter (uint32_t port, bool& ok) const
970 {
971         if (port < _ctrl_params.size ()) {
972                 ok = true;
973                 return port;
974         }
975         ok = false;
976         return 0;
977 }
978
979 bool
980 LuaProc::parameter_is_input (uint32_t port) const
981 {
982         assert (port < _ctrl_params.size ());
983         return (!_ctrl_params[port].first);
984 }
985
986 bool
987 LuaProc::parameter_is_output (uint32_t port) const
988 {
989         assert (port < _ctrl_params.size ());
990         return (_ctrl_params[port].first);
991 }
992
993 std::set<Evoral::Parameter>
994 LuaProc::automatable () const
995 {
996         std::set<Evoral::Parameter> automatables;
997         for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
998                 if (parameter_is_input (i)) {
999                         automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
1000                 }
1001         }
1002         return automatables;
1003 }
1004
1005 std::string
1006 LuaProc::describe_parameter (Evoral::Parameter param)
1007 {
1008         if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
1009                 int lp = _ctrl_params[param.id ()].second;
1010                 return _param_desc[lp].label;
1011         }
1012         return "??";
1013 }
1014
1015 void
1016 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
1017 {
1018         if (buf && len) {
1019                 if (param < parameter_count ()) {
1020                         snprintf (buf, len, "%.3f", get_parameter (param));
1021                 } else {
1022                         strcat (buf, "0");
1023                 }
1024         }
1025 }
1026
1027 boost::shared_ptr<ScalePoints>
1028 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1029 {
1030         if (!(*lr)["scalepoints"].isTable()) {
1031                 return boost::shared_ptr<ScalePoints> ();
1032         }
1033
1034         int cnt = 0;
1035         boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1036         luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1037
1038         for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1039                 if (!i.key ().isString ())    { continue; }
1040                 if (!i.value ().isNumber ())  { continue; }
1041                 rv->insert(make_pair(i.key ().cast<std::string> (),
1042                                         i.value ().cast<float> ()));
1043                 ++cnt;
1044         }
1045
1046         if (rv->size() > 0) {
1047                 return rv;
1048         }
1049         return boost::shared_ptr<ScalePoints> ();
1050 }
1051
1052 boost::shared_ptr<ScalePoints>
1053 LuaProc::get_scale_points (uint32_t port) const
1054 {
1055         int lp = _ctrl_params[port].second;
1056         return _param_desc.find(lp)->second.scale_points;
1057 }
1058
1059 void
1060 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1061 {
1062         lua_State* LG = lua_gui->getState ();
1063         LuaBindings::stddef (LG);
1064         LuaBindings::common (LG);
1065         LuaBindings::dsp (LG);
1066
1067         lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1068         lua_gui->do_command ("function ardour () end");
1069         lua_gui->do_command (_script);
1070
1071         // TODO think: use a weak-pointer here ?
1072         // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1073         luabridge::getGlobalNamespace (LG)
1074                 .beginNamespace ("Ardour")
1075                 .beginClass <LuaProc> ("LuaProc")
1076                 .addFunction ("shmem", &LuaProc::instance_shm)
1077                 .addFunction ("table", &LuaProc::instance_ref)
1078                 .endClass ()
1079                 .endNamespace ();
1080
1081         luabridge::push <LuaProc *> (LG, this);
1082         lua_setglobal (LG, "self");
1083
1084         luabridge::push <float *> (LG, _shadow_data);
1085         lua_setglobal (LG, "CtrlPorts");
1086 }
1087 ////////////////////////////////////////////////////////////////////////////////
1088
1089 #include "ardour/search_paths.h"
1090 #include "sha1.c"
1091
1092 std::string
1093 LuaProc::preset_name_to_uri (const std::string& name) const
1094 {
1095         std::string uri ("urn:lua:");
1096         char hash[41];
1097         Sha1Digest s;
1098         sha1_init (&s);
1099         sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1100         sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1101         sha1_result_hash (&s, hash);
1102         return uri + hash;
1103 }
1104
1105 std::string
1106 LuaProc::presets_file () const
1107 {
1108         return string_compose ("lua-%1", _info->unique_id);
1109 }
1110
1111 XMLTree*
1112 LuaProc::presets_tree () const
1113 {
1114         XMLTree* t = new XMLTree;
1115         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1116
1117         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1118                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1119                         error << _("Unable to create LuaProc presets directory") << endmsg;
1120                 };
1121         }
1122
1123         p = Glib::build_filename (p, presets_file ());
1124
1125         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1126                 t->set_root (new XMLNode (X_("LuaPresets")));
1127                 return t;
1128         }
1129
1130         t->set_filename (p);
1131         if (!t->read ()) {
1132                 delete t;
1133                 return 0;
1134         }
1135         return t;
1136 }
1137
1138 bool
1139 LuaProc::load_preset (PresetRecord r)
1140 {
1141         boost::shared_ptr<XMLTree> t (presets_tree ());
1142         if (t == 0) {
1143                 return false;
1144         }
1145
1146         XMLNode* root = t->root ();
1147         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1148                 XMLProperty const * label = (*i)->property (X_("label"));
1149                 assert (label);
1150                 if (label->value() != r.label) {
1151                         continue;
1152                 }
1153
1154                 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1155                         if ((*j)->name() == X_("Parameter")) {
1156                                 XMLProperty const * index = (*j)->property (X_("index"));
1157                                 XMLProperty const * value = (*j)->property (X_("value"));
1158                                 assert (index);
1159                                 assert (value);
1160                                 LocaleGuard lg;
1161                                 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1162                         }
1163                 }
1164                 return Plugin::load_preset(r);
1165         }
1166         return false;
1167 }
1168
1169 std::string
1170 LuaProc::do_save_preset (std::string name) {
1171
1172         boost::shared_ptr<XMLTree> t (presets_tree ());
1173         if (t == 0) {
1174                 return "";
1175         }
1176
1177         std::string uri (preset_name_to_uri (name));
1178
1179         XMLNode* p = new XMLNode (X_("Preset"));
1180         p->add_property (X_("uri"), uri);
1181         p->add_property (X_("label"), name);
1182
1183         for (uint32_t i = 0; i < parameter_count(); ++i) {
1184                 if (parameter_is_input (i)) {
1185                         XMLNode* c = new XMLNode (X_("Parameter"));
1186                         c->add_property (X_("index"), string_compose ("%1", i));
1187                         c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1188                         p->add_child_nocopy (*c);
1189                 }
1190         }
1191         t->root()->add_child_nocopy (*p);
1192
1193         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1194         f = Glib::build_filename (f, presets_file ());
1195
1196         t->write (f);
1197         return uri;
1198 }
1199
1200 void
1201 LuaProc::do_remove_preset (std::string name)
1202 {
1203         boost::shared_ptr<XMLTree> t (presets_tree ());
1204         if (t == 0) {
1205                 return;
1206         }
1207         t->root()->remove_nodes_and_delete (X_("label"), name);
1208         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1209         f = Glib::build_filename (f, presets_file ());
1210         t->write (f);
1211 }
1212
1213 void
1214 LuaProc::find_presets ()
1215 {
1216         boost::shared_ptr<XMLTree> t (presets_tree ());
1217         if (t) {
1218                 XMLNode* root = t->root ();
1219                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1220
1221                         XMLProperty const * uri = (*i)->property (X_("uri"));
1222                         XMLProperty const * label = (*i)->property (X_("label"));
1223
1224                         assert (uri);
1225                         assert (label);
1226
1227                         PresetRecord r (uri->value(), label->value(), true);
1228                         _presets.insert (make_pair (r.uri, r));
1229                 }
1230         }
1231 }
1232
1233 ////////////////////////////////////////////////////////////////////////////////
1234
1235 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1236         if (lsi->type != LuaScriptInfo::DSP) {
1237                 throw failed_constructor ();
1238         }
1239
1240         path = lsi->path;
1241         name = lsi->name;
1242         creator = lsi->author;
1243         category = lsi->category;
1244         unique_id = lsi->unique_id;
1245
1246         n_inputs.set (DataType::AUDIO, 1);
1247         n_outputs.set (DataType::AUDIO, 1);
1248         type = Lua;
1249
1250         _is_instrument = category == "Instrument";
1251 }
1252
1253 PluginPtr
1254 LuaPluginInfo::load (Session& session)
1255 {
1256         std::string script = "";
1257         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1258                 return PluginPtr ();
1259         }
1260
1261         try {
1262                 script = Glib::file_get_contents (path);
1263         } catch (Glib::FileError err) {
1264                 return PluginPtr ();
1265         }
1266
1267         if (script.empty ()) {
1268                 return PluginPtr ();
1269         }
1270
1271         try {
1272                 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1273                 return plugin;
1274         } catch (failed_constructor& err) {
1275                 ;
1276         }
1277         return PluginPtr ();
1278 }
1279
1280 std::vector<Plugin::PresetRecord>
1281 LuaPluginInfo::get_presets (bool /*user_only*/) const
1282 {
1283         std::vector<Plugin::PresetRecord> p;
1284         XMLTree* t = new XMLTree;
1285         std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1286         if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1287                 t->set_filename (pf);
1288                 if (t->read ()) {
1289                         XMLNode* root = t->root ();
1290                         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1291                                 XMLProperty const * uri = (*i)->property (X_("uri"));
1292                                 XMLProperty const * label = (*i)->property (X_("label"));
1293                                 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));
1294                         }
1295                 }
1296         }
1297         delete t;
1298         return p;
1299 }